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