1 /* dict_cursor - iterators over dictionnaries */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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_EXTERNAL_CATEGORY(xbt_dict);
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict_cursor, xbt_dict,
17 "To traverse dictionaries");
20 /*####[ Dict cursor functions ]#############################################*/
21 /* To traverse (simple) dicts */
22 /* Don't add or remove entries to the dict while traversing !!! */
23 /*###########################################################################*/
24 struct xbt_dict_cursor_ {
25 xbt_dictelm_t current;
30 #undef xbt_dict_CURSOR_DEBUG
31 /*#define xbt_dict_CURSOR_DEBUG 1*/
34 * @param dict the dict
36 XBT_INLINE xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t dict)
38 xbt_dict_cursor_t res = NULL;
40 res = xbt_new(s_xbt_dict_cursor_t, 1);
43 xbt_dict_cursor_rewind(res);
50 * @param cursor poor victim
52 XBT_INLINE void xbt_dict_cursor_free(xbt_dict_cursor_t * cursor)
59 * Sanity check to see if the head contains something
61 static XBT_INLINE void __cursor_not_null(xbt_dict_cursor_t cursor)
63 xbt_assert(cursor, "Null cursor");
67 /** @brief Reinitialize the cursor. Mandatory after removal or add in dict. */
68 XBT_INLINE void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor)
70 XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_rewind");
74 if (cursor->dict != NULL) {
75 cursor->current = cursor->dict->table[0];
77 cursor->current = NULL;
82 * @brief Create the cursor if it does not exists. Rewind it in any case.
84 * @param dict on what to let the cursor iterate
85 * @param[out] cursor dest address
87 XBT_INLINE void xbt_dict_cursor_first(const xbt_dict_t dict,
88 xbt_dict_cursor_t * cursor)
90 XBT_DEBUG("xbt_dict_cursor_first");
92 XBT_DEBUG("Create the cursor on first use");
93 *cursor = xbt_dict_cursor_new(dict);
95 xbt_dict_cursor_rewind(*cursor);
97 if (dict != NULL && (*cursor)->current == NULL) {
98 xbt_dict_cursor_step(*cursor); /* find the first element */
104 * \brief Move to the next element.
106 XBT_INLINE void xbt_dict_cursor_step(xbt_dict_cursor_t cursor)
108 xbt_dictelm_t current;
111 XBT_DEBUG("xbt_dict_cursor_step");
114 current = cursor->current;
117 if (cursor->dict != NULL) {
119 if (current != NULL) {
120 XBT_DEBUG("current is not null, take the next element");
121 current = current->next;
122 XBT_DEBUG("next element: %p", current);
125 while (current == NULL && ++line <= cursor->dict->table_size) {
126 XBT_DEBUG("current is NULL, take the next line");
127 current = cursor->dict->table[line];
128 XBT_DEBUG("element in the next line: %p", current);
130 XBT_DEBUG("search finished, current = %p, line = %d", current, line);
132 cursor->current = current;
138 * @brief Get current data, or free the cursor if there is no data left
140 * @returns true if it's ok, false if there is no more data
142 XBT_INLINE int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
143 char **key, void **data)
146 xbt_dictelm_t current;
148 XBT_DEBUG("xbt_dict_get_or_free");
151 if (!cursor || !(*cursor))
154 current = (*cursor)->current;
155 if (current == NULL) { /* no data left */
156 xbt_dict_cursor_free(cursor);
161 *data = current->content;
166 * @brief Get current key
167 * @param cursor: the cursor
168 * @returns the current key
170 XBT_INLINE char *xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor)
172 __cursor_not_null(cursor);
174 return cursor->current->key;
178 * @brief Get current data
179 * @param cursor the cursor
180 * @returns the current data
182 XBT_INLINE void *xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor)
184 __cursor_not_null(cursor);
186 return cursor->current->content;
190 * @brief Set current data
191 * @param cursor the cursor
192 * @param data the new data
193 * @param free_ctn the function to free the new data
195 XBT_INLINE void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
197 void_f_pvoid_t free_ctn)
199 __cursor_not_null(cursor);
200 if (cursor->current->free_f)
201 cursor->current->free_f(cursor->current->content);
203 cursor->current->content = data;
204 cursor->current->free_f = free_ctn;