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 = xbt_new(s_xbt_dict_cursor_t, 1);
33 xbt_dict_cursor_rewind(res);
40 * @param cursor poor victim
42 inline void xbt_dict_cursor_free(xbt_dict_cursor_t * cursor)
49 * Sanity check to see if the head contains something
51 static inline void __cursor_not_null(xbt_dict_cursor_t cursor)
53 xbt_assert(cursor, "Null cursor");
56 /** @brief Reinitialize the cursor. Mandatory after removal or add in dict. */
57 inline void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor)
59 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_rewind");
63 if (cursor->dict != NULL) {
64 cursor->current = cursor->dict->table[0];
66 cursor->current = NULL;
71 * @brief Create the cursor if it does not exists. Rewind it in any case.
73 * @param dict on what to let the cursor iterate
74 * @param[out] cursor dest address
76 inline void xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor)
78 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_first");
80 XBT_CDEBUG(xbt_dict_cursor, "Create the cursor on first use");
81 *cursor = xbt_dict_cursor_new(dict);
83 xbt_dict_cursor_rewind(*cursor);
85 if (dict != NULL && (*cursor)->current == NULL) {
86 xbt_dict_cursor_step(*cursor); /* find the first element */
90 /** \brief Move to the next element. */
91 inline void xbt_dict_cursor_step(xbt_dict_cursor_t cursor)
93 xbt_dictelm_t current;
96 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_step");
99 current = cursor->current;
102 if (cursor->dict != NULL) {
103 if (current != NULL) {
104 XBT_CDEBUG(xbt_dict_cursor, "current is not null, take the next element");
105 current = current->next;
106 XBT_CDEBUG(xbt_dict_cursor, "next element: %p", current);
109 while (current == NULL && (line + 1) <= cursor->dict->table_size) {
111 XBT_CDEBUG(xbt_dict_cursor, "current is NULL, take the next line");
112 current = cursor->dict->table[line];
113 XBT_CDEBUG(xbt_dict_cursor, "element in the next line: %p", current);
115 XBT_CDEBUG(xbt_dict_cursor, "search finished, current = %p, line = %d", current, line);
117 cursor->current = current;
123 * @brief Get current data, or free the cursor if there is no data left
125 * @returns true if it's ok, false if there is no more data
127 inline int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data)
129 xbt_dictelm_t current;
131 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_get_or_free");
133 if (!cursor || !(*cursor))
136 current = (*cursor)->current;
137 if (current == NULL) { /* no data left */
138 xbt_dict_cursor_free(cursor);
143 *data = current->content;
148 * @brief Get current key
149 * @param cursor: the cursor
150 * @returns the current key
152 inline char *xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor)
154 __cursor_not_null(cursor);
156 return cursor->current->key;
160 * @brief Get current data
161 * @param cursor the cursor
162 * @returns the current data
164 inline void *xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor)
166 __cursor_not_null(cursor);
168 return cursor->current->content;
172 * @brief Set current data
173 * @param cursor the cursor
174 * @param data the new data
175 * @param free_ctn the function to free the new data
177 inline void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn)
179 __cursor_not_null(cursor);
180 xbt_dictelm_set_data(cursor->dict, cursor->current, data, free_ctn);