include/opensrf/osrf_list.h

   1 #ifndef OSRF_LIST_H
   2 #define OSRF_LIST_H
   3
   4 #include <opensrf/utils.h>
   5
   6 #ifdef __cplusplus
   7 extern "C" {
   8 #endif
   9
  10 #define OSRF_LIST_GET_INDEX(l, i) (!l || i >= l->size) ? NULL: l->arrlist[i]
  11
  12 /**
  13   Items are stored as void*'s so it's up to the user to
  14   manage the data wisely.  Also, if the 'freeItem' callback is defined for the list,
  15   then, it will be used on any item that needs to be freed, so don't mix data
  16   types in the list if you want magic freeing */
  17
  18 struct _osrfListStruct {
  19         unsigned int size;                      /* how many items in the list including NULL items between non-NULL items */
  20         void (*freeItem) (void* item);  /* callback for freeing stored items */
  21         void** arrlist;
  22         int arrsize; /* how big is the currently allocated array */
  23 };
  24 typedef struct _osrfListStruct osrfList;
  25
  26
  27 struct _osrfListIteratorStruct {
  28         const osrfList* list;
  29         unsigned int current;
  30 };
  31 typedef struct _osrfListIteratorStruct osrfListIterator;
  32
  33 osrfList* osrfNewListSize( unsigned int size );
  34
  35
  36 /**
  37   Creates a new list iterator with the given list
  38   */
  39 osrfListIterator* osrfNewListIterator( const osrfList* list );
  40
  41 /**
  42   Returns the next non-NULL item in the list, return NULL when
  43   the end of the list has been reached
  44   */
  45 void* osrfListIteratorNext( osrfListIterator* itr );
  46
  47 /**
  48   Deallocates the given list
  49   */
  50 void osrfListIteratorFree( osrfListIterator* itr );
  51
  52 void osrfListIteratorReset( osrfListIterator* itr );
  53
  54
  55 /**
  56   Allocates a new list
  57   @return The allocated list
  58   */
  59 osrfList* osrfNewList();
  60
  61 /**
  62   Pushes an item onto the end of the list.  This always finds the highest index
  63   in the list and pushes the new item into the list after it.
  64   @param list The list
  65   @param item The item to push
  66   @return 0 on success, -1 on failure
  67   */
  68 int osrfListPush( osrfList* list, void* item );
  69
  70
  71 /**
  72  * Removes the last item in the list
  73  * See osrfListRemove for details on how the removed item is handled
  74  * @return The item, unless 'freeItem' exists, then returns NULL
  75  */
  76 void* osrfListPop( osrfList* list );
  77
  78 /**
  79   Puts the given item into the list at the specified position.  If there
  80   is already an item at the given position and the list has its
  81   "freeItem" function defined, then it will be used to free said item.
  82   If no 'freeItem' callback is defined, then the displaced item will
  83   be returned;
  84   @param list The list
  85   @param item The item to put into the list
  86   @param position The position to place the item in
  87   @return NULL in successfully inserting the new item and freeing
  88   any displaced items.  Returns the displaced item if no "freeItem"
  89   callback is defined.
  90         */
  91 void* osrfListSet( osrfList* list, void* item, unsigned int position );
  92
  93 /**
  94   Returns the item at the given position
  95   @param list The list
  96   @param postiont the position
  97   */
  98 void* osrfListGetIndex( const osrfList* list, unsigned int  position );
  99
 100 /**
 101   Frees the list and all list items (if the list has a "freeItem" function defined )
 102   @param list The list
 103   */
 104 void osrfListFree( osrfList* list );
 105
 106 /**
 107   Removes the list item at the given index
 108   @param list The list
 109   @param position The position of the item to remove
 110   @return A pointer to the item removed if "freeItem" is not defined
 111   for this list, returns NULL if it is.
 112   */
 113 void* osrfListRemove( osrfList* list, unsigned int position );
 114
 115 /**
 116   Finds the list item whose void* is the same as the one passed in
 117   @param list The list
 118   @param addr The pointer connected to the list item we're to find
 119   @return the index of the item, or -1 if the item was not found
 120   */
 121 int osrfListFind( const osrfList* list, void* addr );
 122
 123 /**
 124   @return The number of non-null items in the list
 125   */
 126 unsigned int osrfListGetCount( const osrfList* list );
 127
 128 /**
 129  * May be used as a default memory freeing call
 130  * Just calls free() on list items
 131  */
 132 void osrfListVanillaFree( void* item );
 133
 134 /**
 135  * Tells the list to just call 'free()' on each item when
 136  * an item or the whole list is destroyed
 137  */
 138 void osrfListSetDefaultFree( osrfList* list );
 139
 140 /**
 141  * Inserts the new item at the first free (null) slot
 142  * in the array.  Item is shoved onto the end of the
 143  * list if there are no null slots */
 144 int osrfListPushFirst( osrfList* list, void* item );
 145
 146 #ifdef __cplusplus
 147 }
 148 #endif
 149
 150 #endif