include/xbt/dict.h

   1 /* xbt/dict.h -- api to a generic dictionary                                */
   2
   3 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef XBT_DICT_H
   9 #define XBT_DICT_H
  10
  11 #include <xbt/dynar.h> /* void_f_pvoid_t */
  12 #include <xbt/misc.h>  /* SG_BEGIN_DECL */
  13
  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  *  @deprecated If you are using C++, you might want to use `std::unordered_map` instead.
  25  *
  26  *  Here is a little example of use:
  27
  28 @verbatim
  29  xbt_dict_t mydict = xbt_dict_new_homogeneous(free);
  30  char buff[512];
  31
  32  sprintf(buff,"some very precious data");
  33  xbt_dict_set(mydict,"my data", strdup(buff));
  34
  35  sprintf(buff,"another good stuff");
  36  xbt_dict_set(mydict,"my data", strdup(buff)); // previous data gets erased (and freed) by second add
  37 @endverbatim
  38  */
  39
  40 /** @defgroup XBT_dict_cons Dict constructor and destructor
  41  *  @ingroup XBT_dict
  42  *
  43  *  @{
  44  */
  45
  46 /** @brief Dictionary data type (opaque structure) */
  47 typedef struct s_xbt_dict *xbt_dict_t;
  48 typedef const struct s_xbt_dict* const_xbt_dict_t;
  49 typedef struct s_xbt_dictelm *xbt_dictelm_t;
  50 typedef struct s_xbt_dictelm {
  51   char *key;
  52   int key_len;
  53   unsigned int hash_code;
  54
  55   void *content;
  56
  57   xbt_dictelm_t next;
  58 } s_xbt_dictelm_t;
  59
  60 XBT_PUBLIC xbt_dict_t xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
  61 XBT_PUBLIC void xbt_dict_free(xbt_dict_t* dict);
  62 XBT_PUBLIC unsigned int xbt_dict_size(const_xbt_dict_t dict);
  63
  64 /** @} */
  65 /** @defgroup XBT_dict_basic Dictionaries basic usage
  66  *  @ingroup XBT_dict
  67  *
  68  * Careful, those functions assume that the key is null-terminated.
  69  *
  70  *  @{
  71  */
  72
  73 XBT_PUBLIC void xbt_dict_set(xbt_dict_t dict, const char* key, void* data);
  74 XBT_PUBLIC void* xbt_dict_get_or_null(const_xbt_dict_t dict, const char* key);
  75 XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm_or_null(const_xbt_dict_t dict, const char* key);
  76
  77 XBT_PUBLIC int xbt_dict_length(const_xbt_dict_t dict);
  78 XBT_PUBLIC int xbt_dict_is_empty(const_xbt_dict_t dict);
  79
  80 /** @} */
  81 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  82  *  @ingroup XBT_dict
  83  *
  84  * Those functions work even with non-null terminated keys.
  85  *
  86  *  @{
  87  */
  88 XBT_PUBLIC void xbt_dict_set_ext(xbt_dict_t dict, const char* key, int key_len, void* data);
  89 XBT_PUBLIC void* xbt_dict_get_or_null_ext(const_xbt_dict_t dict, const char* key, int key_len);
  90 XBT_PUBLIC void xbt_dict_remove_ext(xbt_dict_t dict, const char* key, int key_len);
  91
  92 struct s_xbt_dict_cursor {
  93   xbt_dictelm_t current;
  94   int line;
  95   const_xbt_dict_t dict;
  96 };
  97
  98 /** @} */
  99 /** @defgroup XBT_dict_curs Cursors on dictionaries
 100  *  @ingroup XBT_dict
 101  *
 102  *  Don't get impressed, there is a lot of functions here, but traversing a dictionary is immediate with the
 103  *  xbt_dict_foreach macro.
 104  *  You only need the other functions in rare cases (they are not used directly in SG itself).
 105  *
 106  *  Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
 107  *  xbt_dict_set was always a null-terminated char*):
 108 @verbatim xbt_dict_cursor_t cursor=NULL;
 109  char *key,*data;
 110
 111  xbt_dict_foreach(dict,cursor,key,data) {
 112     printf("   - Seen:  %s->%s\n",key,data);
 113  }@endverbatim
 114
 115  *
 116  *  @warning Do not add or remove entries to the cache while traversing !!
 117  *
 118  *  @{ */
 119
 120 /** @brief Cursor on dictionaries (opaque type) */
 121 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
 122 typedef const struct s_xbt_dict_cursor* const_xbt_dict_cursor_t;
 123
 124 XBT_PUBLIC xbt_dict_cursor_t xbt_dict_cursor_new(const_xbt_dict_t dict);
 125 XBT_PUBLIC void xbt_dict_cursor_free(xbt_dict_cursor_t* cursor);
 126
 127 XBT_PUBLIC void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 128
 129 XBT_PUBLIC char* xbt_dict_cursor_get_key(const_xbt_dict_cursor_t cursor);
 130 XBT_PUBLIC void* xbt_dict_cursor_get_data(const_xbt_dict_cursor_t cursor);
 131
 132 XBT_PUBLIC void xbt_dict_cursor_first(const_xbt_dict_t dict, xbt_dict_cursor_t* cursor);
 133 XBT_PUBLIC void xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 134 XBT_PUBLIC int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t* cursor, char** key, void** data);
 135 /** @def xbt_dict_foreach
 136  *  @param dict a @ref xbt_dict_t iterator
 137  *  @param cursor an @ref xbt_dict_cursor_t used as cursor
 138  *  @param key a char*
 139  *  @param data a void** output
 140  *  @hideinitializer
 141  *
 142  * @note An example of usage:
 143  * @code
 144 xbt_dict_cursor_t cursor = NULL;
 145 char *key;
 146 char *data;
 147
 148 xbt_dict_foreach(head, cursor, key, data) {
 149  printf("Key %s with data %s\n",key,data);
 150 }
 151 @endcode
 152  */
 153 #define xbt_dict_foreach(dict, cursor, key, data)                                                                      \
 154   for ((cursor) = NULL, xbt_dict_cursor_first((dict), &(cursor));                                                      \
 155        xbt_dict_cursor_get_or_free(&(cursor), (char**)&(key), (void**)&(data)); xbt_dict_cursor_step(cursor))
 156
 157 /** @} */
 158
 159 SG_END_DECL
 160
 161 #endif /* XBT_DICT_H */