include/xbt/dict.h

   1 /* xbt/dict.h -- api to a generic dictionary                                */
   2
   3 /* Copyright (c) 2004-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _XBT_DICT_H
  10 #define _XBT_DICT_H
  11
  12 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  13 #include "xbt/dynar.h"          /* void_f_pvoid_t */
  14 #include <stdint.h>             /* uintptr_t */
  15
  16 SG_BEGIN_DECL()
  17
  18 /** @addtogroup XBT_dict
  19  *  @brief The dictionary data structure (comparable to hash tables)
  20  *
  21  *  This section describes the API to a dictionary structure that  associates as string to a void* key. It provides the
  22  *  same functionality than an hash table.
  23  *
  24  *  Here is a little example of use:
  25
  26 \verbatim
  27  xbt_dict_t mydict = xbt_dict_new();
  28  char buff[512];
  29
  30  sprintf(buff,"some very precious data");
  31  xbt_dict_set(mydict,"my data", strdup(buff), free);
  32
  33  sprintf(buff,"another good stuff");
  34  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
  35 \endverbatim
  36  *
  37  */
  38
  39 /** @defgroup XBT_dict_cons Dict constructor and destructor
  40  *  @ingroup XBT_dict
  41  *
  42  *  @{
  43  */
  44
  45   /** \brief Dictionary data type (opaque structure) */
  46 typedef struct s_xbt_dict *xbt_dict_t;
  47 typedef struct s_xbt_dictelm *xbt_dictelm_t;
  48 typedef struct s_xbt_dictelm {
  49   char *key;
  50   int key_len;
  51   unsigned int hash_code;
  52
  53   void *content;
  54
  55   xbt_dictelm_t next;
  56 } s_xbt_dictelm_t;
  57
  58 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
  59 XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
  60 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
  61 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
  62
  63 /** @} */
  64 /** @defgroup XBT_dict_basic Dictionaries basic usage
  65  *  @ingroup XBT_dict
  66  *
  67  * Careful, those functions assume that the key is null-terminated.
  68  *
  69  *  @{
  70  */
  71
  72 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t free_ctn);
  73 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
  74 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  75 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
  76 XBT_PUBLIC(char *) xbt_dict_get_elm_key(xbt_dictelm_t elem);
  77 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
  78 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
  79
  80 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  81 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  82 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  83 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
  84 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
  85 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
  86 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
  87
  88
  89 /** @} */
  90 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  91  *  @ingroup XBT_dict
  92  *
  93  * Those functions work even with non-null terminated keys.
  94  *
  95  *  @{
  96  */
  97 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict, const char *key, int key_len, void *data, void_f_pvoid_t free_ctn);
  98 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
  99 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len);
 100 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
 101
 102 struct s_xbt_dict_cursor {
 103   xbt_dictelm_t current;
 104   int line;
 105   xbt_dict_t dict;
 106 };
 107
 108 /** @} */
 109 /** @defgroup XBT_dict_curs Cursors on dictionaries
 110  *  @ingroup XBT_dict
 111  *
 112  *  Don't get impressed, there is a lot of functions here, but traversing a dictionary is immediate with the
 113  *  xbt_dict_foreach macro.
 114  *  You only need the other functions in rare cases (they are not used directly in SG itself).
 115  *
 116  *  Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
 117  *  xbt_dict_set was always a null-terminated char*):
 118 \verbatim xbt_dict_cursor_t cursor=NULL;
 119  char *key,*data;
 120
 121  xbt_dict_foreach(dict,cursor,key,data) {
 122     printf("   - Seen:  %s->%s\n",key,data);
 123  }\endverbatim
 124
 125  *
 126  *  \warning Do not add or remove entries to the cache while traversing !!
 127  *
 128  *  @{ */
 129
 130 /** @brief Cursor on dictionaries (opaque type) */
 131 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
 132
 133 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
 134   return cursor->current;
 135 }
 136
 137 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 138 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
 139
 140 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 141
 142 xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor);
 143 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 144 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
 145 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn);
 146
 147 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor);
 148 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 149 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data);
 150 /** @def xbt_dict_foreach
 151  *  @param dict a \ref xbt_dict_t iterator
 152  *  @param cursor an \ref xbt_dict_cursor_t used as cursor
 153  *  @param key a char*
 154  *  @param data a void** output
 155  *  @hideinitializer
 156  *
 157  * \note An example of usage:
 158  * \code
 159 xbt_dict_cursor_t cursor = NULL;
 160 char *key;
 161 char *data;
 162
 163 xbt_dict_foreach(head, cursor, key, data) {
 164  printf("Key %s with data %s\n",key,data);
 165 }
 166 \endcode
 167  */
 168 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 169     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 170          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
 171          xbt_dict_cursor_step(cursor) )
 172
 173 /** @} */
 174
 175 SG_END_DECL()
 176
 177 #ifdef __cplusplus
 178 namespace simgrid {
 179 namespace xbt {
 180   inline void destroy(xbt_dict_t d)
 181   {
 182     xbt_dict_free(&d);
 183   }
 184 }
 185 }
 186 #endif
 187
 188 #endif                          /* _XBT_DICT_H */