mlist.h

Go to the documentation of this file.

/**
 * \file mlist.h <mi32/mlist.h>
 * \brief Definitions for Mlist functions and structures
 * \deprecated Use MILIST instead
 *
 * \if NODOC
 * $Id: mlist.h_v 1.7 2003/09/17 21:25:21 dwilliss Exp $
 *
 * $Log: mlist.h_v $
 * Revision 1.7  2003/09/17 21:25:21  dwilliss
 * Document that the thing is deprecate
 * (d)
 *
 * Revision 1.6  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2001/12/27 16:34:59  dwilliss
 * Gave MLIST a constructor that sets it to 0 so I don't have to do it elsewhere
 *
 * Revision 1.4  2000/06/22 20:38:02  sparsons
 * Genitor documentation.
 *
 * Revision 1.3  1999/05/07 21:19:29  mju
 * Header restruct.
 *
 * Revision 1.2  1999/04/12  20:19:16  mju
 * Fix to hopefully compile in non-C++ mode.
 *
 * Revision 1.1  1999/04/12  14:38:23  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_MLIST_H
#define  INC_MI32_MLIST_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifdef GEOMDLL
   #define GEOMLIBEXPORT MI_DLLEXPORT
#else
   #define GEOMLIBEXPORT MI_DLLIMPORT
#endif

//----------------------------------------------------------------------------
//!      Structures used by Mlist functions                                      
//----------------------------------------------------------------------------

struct MLISTNODE {
   MLISTNODE *prev, *next;
   };

// Old Linked List implementation
// \deprecated Use MILIST instead
//
// This is a linked-list implementation written before we started using C++
struct MLIST {
   MLISTNODE *head, *tail;

   MLIST() : head(0), tail(0) {}
   ~MLIST() {}
   };

//! old names for old code
typedef MLIST LINKEDLIST;
typedef MLISTNODE LINKEDLISTNODE;

//----------------------------------------------------------------------------
//!      Prototypes                                                              
//----------------------------------------------------------------------------

#if defined(__cplusplus)
extern "C" {
#endif

//! Add to the head of a Linked List.
//!
//! This function adds a node to the head of list. 
//!   You can create a linked list of any kind of structure simply by putting a MLISTNODE in 
//!   the structure. 
//!
//!   It works best to put the MLISTNODE as the first thing in the structure
//!   you want to keep a list of.  That way the node.next can be treated as
//!   both a pointer to a MLISTNODE (for the purposes of iterating
//!   through the list) and a pointer to whatever the structure is.  Of
//!   course you have to cast it.  There are macros for this.
GEOMLIBEXPORT void MlistAddToHead (
   MLIST *list,                        //!< List to add to
   MLISTNODE *node,                    //!< Node to add
   UINT32 flags                        //!< Flags
   );

//! Add to the tail of a Linked List.
//!
//! This function adds a node to the tail of list. 
//!   You can create a linked list of any kind of structure simply by putting a MLISTNODE in 
//!   the structure.
GEOMLIBEXPORT void MlistAddToTail (
   MLIST *list,                        //!< List to add to
   MLISTNODE *node,                    //!< Node to add
   UINT32 flags                        //!< Flags
   );

//! Remove an item from a linked list.
//!
//! This function removes a node from the list.  The node's prev and next fields are   set to NULL.
GEOMLIBEXPORT void MlistRemove (
   MLIST *list,                        //!< List to remove from
   MLISTNODE *node,                    //!< Node to remove
   UINT32 flags                        //!< Flags
   );

#if defined(__cplusplus)
}
#endif

#endif   //!<  INC_MI32_MLIST_H 

---