1 /* dict_cursor - iterators over dictionaries */
3 /* Copyright (c) 2004-2014. The SimGrid Team.
4 * All rights reserved. */
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. */
11 #include "dict_private.h"
13 #include <string.h> /* strlen() */
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict_cursor, xbt_dict, "To traverse dictionaries");
17 /*####[ Dict cursor functions ]#############################################*/
18 /* To traverse (simple) dicts */
19 /* Don't add or remove entries to the dict while traversing !!! */
20 /*###########################################################################*/
22 #undef xbt_dict_CURSOR_DEBUG
23 /*#define xbt_dict_CURSOR_DEBUG 1*/
26 * @param dict the dict
28 inline xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t dict)
30 xbt_dict_cursor_t res = NULL;
32 res = xbt_new(s_xbt_dict_cursor_t, 1);
35 xbt_dict_cursor_rewind(res);
42 * @param cursor poor victim
44 inline void xbt_dict_cursor_free(xbt_dict_cursor_t * cursor)
51 * Sanity check to see if the head contains something
53 static inline void __cursor_not_null(xbt_dict_cursor_t cursor)
55 xbt_assert(cursor, "Null cursor");
58 /** @brief Reinitialize the cursor. Mandatory after removal or add in dict. */
59 inline void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor)
61 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_rewind");
65 if (cursor->dict != NULL) {
66 cursor->current = cursor->dict->table[0];
68 cursor->current = NULL;
73 * @brief Create the cursor if it does not exists. Rewind it in any case.
75 * @param dict on what to let the cursor iterate
76 * @param[out] cursor dest address
78 inline void xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor)
80 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_first");
82 XBT_CDEBUG(xbt_dict_cursor, "Create the cursor on first use");
83 *cursor = xbt_dict_cursor_new(dict);
85 xbt_dict_cursor_rewind(*cursor);
87 if (dict != NULL && (*cursor)->current == NULL) {
88 xbt_dict_cursor_step(*cursor); /* find the first element */
92 /** \brief Move to the next element. */
93 inline void xbt_dict_cursor_step(xbt_dict_cursor_t cursor)
95 xbt_dictelm_t current;
98 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_step");
101 current = cursor->current;
104 if (cursor->dict != NULL) {
105 if (current != NULL) {
106 XBT_CDEBUG(xbt_dict_cursor, "current is not null, take the next element");
107 current = current->next;
108 XBT_CDEBUG(xbt_dict_cursor, "next element: %p", current);
111 while (current == NULL && ++line <= cursor->dict->table_size) {
112 XBT_CDEBUG(xbt_dict_cursor, "current is NULL, take the next line");
113 current = cursor->dict->table[line];
114 XBT_CDEBUG(xbt_dict_cursor, "element in the next line: %p", current);
116 XBT_CDEBUG(xbt_dict_cursor, "search finished, current = %p, line = %d", current, line);
118 cursor->current = current;
124 * @brief Get current data, or free the cursor if there is no data left
126 * @returns true if it's ok, false if there is no more data
128 inline int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data)
130 xbt_dictelm_t current;
132 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_get_or_free");
134 if (!cursor || !(*cursor))
137 current = (*cursor)->current;
138 if (current == NULL) { /* no data left */
139 xbt_dict_cursor_free(cursor);
144 *data = current->content;
149 * @brief Get current key
150 * @param cursor: the cursor
151 * @returns the current key
153 inline char *xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor)
155 __cursor_not_null(cursor);
157 return cursor->current->key;
161 * @brief Get current data
162 * @param cursor the cursor
163 * @returns the current data
165 inline void *xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor)
167 __cursor_not_null(cursor);
169 return cursor->current->content;
173 * @brief Set current data
174 * @param cursor the cursor
175 * @param data the new data
176 * @param free_ctn the function to free the new data
178 inline void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn)
180 __cursor_not_null(cursor);
181 xbt_dictelm_set_data(cursor->dict, cursor->current, data, free_ctn);