include/opensrf/osrf_hash.h

   1 #ifndef OSRF_HASH_H
   2 #define OSRF_HASH_H
   3
   4 #include <opensrf/utils.h>
   5 #include <opensrf/string_array.h>
   6 #include <opensrf/osrf_list.h>
   7
   8 #ifdef __cplusplus
   9 extern "C" {
  10 #endif
  11
  12 struct _osrfHashStruct;
  13 typedef struct _osrfHashStruct osrfHash;
  14
  15 struct _osrfHashIteratorStruct;
  16 typedef struct _osrfHashIteratorStruct osrfHashIterator;
  17
  18 /**
  19   Allocates a new hash object
  20   */
  21 osrfHash* osrfNewHash();
  22
  23 /** Installs a callback function for freeing stored items
  24  */
  25 void osrfHashSetCallback( osrfHash* hash, void (*callback) (char* key, void* item) );
  26
  27 /**
  28   Sets the given key with the given item
  29   if "freeItem" is defined and an item already exists at the given location,
  30   then old item is freed and the new item is put into place.
  31   if "freeItem" is not defined and an item already exists, the old item
  32   is returned.
  33   @return The old item if exists and there is no 'freeItem', returns NULL
  34   otherwise
  35   */
  36 void* osrfHashSet( osrfHash* hash, void* item, const char* key, ... );
  37
  38 /**
  39   Removes an item from the hash.
  40   if 'freeItem' is defined it is used and NULL is returned,
  41   else the freed item is returned
  42   */
  43 void* osrfHashRemove( osrfHash* hash, const char* key, ... );
  44
  45 void* osrfHashGet( osrfHash* hash, const char* key );
  46
  47 void* osrfHashGetFmt( osrfHash* hash, const char* key, ... );
  48
  49 /**
  50   @return A list of strings representing the keys of the hash.
  51   caller is responsible for freeing the returned string array
  52   with osrfStringArrayFree();
  53   */
  54 osrfStringArray* osrfHashKeys( osrfHash* hash );
  55
  56 /**
  57   Frees a hash
  58   */
  59 void osrfHashFree( osrfHash* hash );
  60
  61 /**
  62   @return The number of items in the hash
  63   */
  64 unsigned long osrfHashGetCount( osrfHash* hash );
  65
  66 /**
  67   Creates a new list iterator with the given list
  68   */
  69 osrfHashIterator* osrfNewHashIterator( osrfHash* hash );
  70
  71 int osrfHashIteratorHasNext( osrfHashIterator* itr );
  72
  73 /**
  74   Returns the next non-NULL item in the list, return NULL when
  75   the end of the list has been reached
  76   */
  77 void* osrfHashIteratorNext( osrfHashIterator* itr );
  78
  79 /**
  80   Returns a pointer to the key of the current hash item
  81   */
  82 const char* osrfHashIteratorKey( const osrfHashIterator* itr );
  83
  84 /**
  85   Deallocates the given list
  86   */
  87 void osrfHashIteratorFree( osrfHashIterator* itr );
  88
  89 void osrfHashIteratorReset( osrfHashIterator* itr );
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif