longlist.h

Go to the documentation of this file.

/**
 * \file longlist.h <mi32/longlist.h>
 * \brief Definitions for LONGLIST
 *
 * \if NODOC
 * $Id: longlist.h_v 1.6 2003/09/15 13:49:56 fileserver!dwilliss Exp $
 *
 * $Log: longlist.h_v $
 * Revision 1.6  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2000/06/15 18:26:55  sparsons
 * Genitor revision.
 *
 * Revision 1.4  2000/06/13 17:25:40  sparsons
 * Genitor documentation.
 *
 * Revision 1.3  2000/06/12 20:19:43  mju
 * Include stddefns.h if not already.
 *
 * Revision 1.2  1999/05/07 21:17:55  mju
 * Header restruct.
 *
 * Revision 1.1  1999/04/08  14:44:29  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_LONGLIST_H
#define  INC_MI32_LONGLIST_H

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

//----------------------------------------------------------------------------
//!      Structure used by LongListXxxx() functios (longlist.c)                  
//----------------------------------------------------------------------------

struct LONGLIST {
   INT32 NumAlloc;
   INT32 num;
   INT32 *List;                        //!<  Shouldn't access directly 
   UINT8 *flags; 
   unsigned sorted:1,
      UseBits:1,                       //!<  Use getbit/putbit 
       SpareBits:30;
   INT32 UserData;                     //!<  Can be used for anything you want 
   };


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

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

//! Free the memory used by a LONGLIST.
//!
//!   Note: There's no LongListAlloc.
void LongListFree (
   LONGLIST *list
   );

//! Clear the list.
void LongListClear (
   LONGLIST *list
   );

//! Add a value to the list, incrementing the number of elements in the list.
//!
//! Reallocates the list if necessary.
int LongListAdd (
   LONGLIST *list, 
   INT32 val
   );

//! Checks to see if a value is in a list.
int LongListCheckIn (
   LONGLIST *list, 
   INT32 val
   );

//!   Add a value to a list, but only if it's not already in the list.
int LongListAddUnique (
   LONGLIST *list, 
   INT32 val
   );

//! Add a value to the list, incrementing the number of elements in the list.
//!
//! Reallocates the list if necessary.
int LongListAddWithFlag (
   LONGLIST *list, 
   INT32 val,
   UINT8 flag
   );

//!   Add a value to a list, but only if it's not already in the list.
int LongListAddUniqueWithFlag (
   LONGLIST *list, 
   INT32 val,
   UINT8 flag
   );

//! Remove a value from the list.
int LongListRemove (
   LONGLIST *list, 
   INT32 val
   );

//! Get the first item on the list.
int LongListGetFirst (
   LONGLIST *list, 
   INT32 *ip, 
   INT32 *valp
   );

//! Get the next item on the list. 
int LongListGetNext (
   LONGLIST *list, 
   INT32 *ip, 
   INT32 *valp
   );

//! Get the last item on the list.
int LongListGetLast (
   LONGLIST *list, 
   INT32 *valp
   );

//! Get the number of bits.
int LongListGetBits (
   LONGLIST *list, 
   UINT8 **bits, 
   INT32 *num
   );

//! Set the number of bits.
int LongListSetBits (
   LONGLIST *list, 
   UINT8 *bits, 
   INT32 num
   );

//! Get the list.
int LongListGetList (
   LONGLIST *list, 
   INT32 **vals
   );

#if defined(__cplusplus)
}
#endif

#endif   //!< INC_MI32_LONGLIST_H

---