src/xbt/dict_cursor.c

   1 /* dict_cursor - iterators over dictionnaries                               */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   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. */
   8
   9 #include "xbt/misc.h"
  10 #include "xbt/ex.h"
  11 #include "dict_private.h"
  12
  13 #include <string.h>             /* strlen() */
  14
  15 XBT_LOG_EXTERNAL_CATEGORY(xbt_dict);
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict_cursor, xbt_dict,
  17                                 "To traverse dictionaries");
  18
  19
  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;
  26   int line;
  27   xbt_dict_t dict;
  28 };
  29
  30 #undef xbt_dict_CURSOR_DEBUG
  31 /*#define xbt_dict_CURSOR_DEBUG 1*/
  32
  33 /** @brief Creator
  34  *  @param dict the dict
  35  */
  36 XBT_INLINE xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t dict)
  37 {
  38   xbt_dict_cursor_t res = NULL;
  39
  40   res = xbt_new(s_xbt_dict_cursor_t, 1);
  41   res->dict = dict;
  42
  43   xbt_dict_cursor_rewind(res);
  44
  45   return res;
  46 }
  47
  48 /**
  49  * @brief Destructor
  50  * @param cursor poor victim
  51  */
  52 XBT_INLINE void xbt_dict_cursor_free(xbt_dict_cursor_t * cursor)
  53 {
  54   if (*cursor) {
  55     xbt_free(*cursor);
  56     *cursor = NULL;
  57   }
  58 }
  59
  60 /*
  61  * Sanity check to see if the head contains something
  62  */
  63 static XBT_INLINE void __cursor_not_null(xbt_dict_cursor_t cursor)
  64 {
  65   xbt_assert(cursor, "Null cursor");
  66 }
  67
  68
  69 /** @brief Reinitialize the cursor. Mandatory after removal or add in dict. */
  70 XBT_INLINE void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor)
  71 {
  72   XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_rewind");
  73   xbt_assert(cursor);
  74
  75   cursor->line = 0;
  76   if (cursor->dict != NULL) {
  77     cursor->current = cursor->dict->table[0];
  78   } else {
  79     cursor->current = NULL;
  80   }
  81 }
  82
  83 /**
  84  * @brief Create the cursor if it does not exists. Rewind it in any case.
  85  *
  86  * @param      dict   on what to let the cursor iterate
  87  * @param[out] cursor dest address
  88  */
  89 XBT_INLINE void xbt_dict_cursor_first(const xbt_dict_t dict,
  90                                       xbt_dict_cursor_t * cursor)
  91 {
  92   XBT_DEBUG("xbt_dict_cursor_first");
  93   if (!*cursor) {
  94     XBT_DEBUG("Create the cursor on first use");
  95     *cursor = xbt_dict_cursor_new(dict);
  96   } else {
  97     xbt_dict_cursor_rewind(*cursor);
  98   }
  99   if (dict != NULL && (*cursor)->current == NULL) {
 100     xbt_dict_cursor_step(*cursor);      /* find the first element */
 101   }
 102 }
 103
 104
 105 /**
 106  * \brief Move to the next element.
 107  */
 108 XBT_INLINE void xbt_dict_cursor_step(xbt_dict_cursor_t cursor)
 109 {
 110   xbt_dictelm_t current;
 111   int line;
 112
 113   XBT_DEBUG("xbt_dict_cursor_step");
 114   xbt_assert(cursor);
 115
 116   current = cursor->current;
 117   line = cursor->line;
 118
 119   if (cursor->dict != NULL) {
 120
 121     if (current != NULL) {
 122       XBT_DEBUG("current is not null, take the next element");
 123       current = current->next;
 124       XBT_DEBUG("next element: %p", current);
 125     }
 126
 127     while (current == NULL && ++line <= cursor->dict->table_size) {
 128       XBT_DEBUG("current is NULL, take the next line");
 129       current = cursor->dict->table[line];
 130       XBT_DEBUG("element in the next line: %p", current);
 131     }
 132     XBT_DEBUG("search finished, current = %p, line = %d", current, line);
 133
 134     cursor->current = current;
 135     cursor->line = line;
 136   }
 137 }
 138
 139 /**
 140  * @brief Get current data, or free the cursor if there is no data left
 141  *
 142  * @returns true if it's ok, false if there is no more data
 143  */
 144 XBT_INLINE int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
 145                                            char **key, void **data)
 146 {
 147
 148   xbt_dictelm_t current;
 149
 150   XBT_DEBUG("xbt_dict_get_or_free");
 151
 152
 153   if (!cursor || !(*cursor))
 154     return FALSE;
 155
 156   current = (*cursor)->current;
 157   if (current == NULL) {        /* no data left */
 158     xbt_dict_cursor_free(cursor);
 159     return FALSE;
 160   }
 161
 162   *key = current->key;
 163   *data = current->content;
 164   return TRUE;
 165 }
 166
 167 /**
 168  * @brief Get current key
 169  * @param cursor: the cursor
 170  * @returns the current key
 171  */
 172 XBT_INLINE char *xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor)
 173 {
 174   __cursor_not_null(cursor);
 175
 176   return cursor->current->key;
 177 }
 178
 179 /**
 180  * @brief Get current data
 181  * @param cursor the cursor
 182  * @returns the current data
 183  */
 184 XBT_INLINE void *xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor)
 185 {
 186   __cursor_not_null(cursor);
 187
 188   return cursor->current->content;
 189 }
 190
 191 /**
 192  * @brief Set current data
 193  * @param cursor the cursor
 194  * @param data the new data
 195  * @param free_ctn the function to free the new data
 196  */
 197 XBT_INLINE void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
 198                                          void *data,
 199                                          void_f_pvoid_t free_ctn)
 200 {
 201   __cursor_not_null(cursor);
 202   if (cursor->current->free_f)
 203     cursor->current->free_f(cursor->current->content);
 204
 205   cursor->current->content = data;
 206   cursor->current->free_f = free_ctn;
 207   return;
 208 }