src/xbt/dict_cursor.c

   1 /* dict_cursor - iterators over dictionaries                               */
   2
   3 /* Copyright (c) 2004-2014. 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_NEW_DEFAULT_SUBCATEGORY(xbt_dict_cursor, xbt_dict, "To traverse dictionaries");
  16
  17 /*####[ Dict cursor functions ]#############################################*/
  18 /* To traverse (simple) dicts                                               */
  19 /* Don't add or remove entries to the dict while traversing !!!             */
  20 /*###########################################################################*/
  21
  22 #undef xbt_dict_CURSOR_DEBUG
  23 /*#define xbt_dict_CURSOR_DEBUG 1*/
  24
  25 /** @brief Creator
  26  *  @param dict the dict
  27  */
  28 inline xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t dict)
  29 {
  30   xbt_dict_cursor_t res = xbt_new(s_xbt_dict_cursor_t, 1);
  31   res->dict = dict;
  32
  33   xbt_dict_cursor_rewind(res);
  34
  35   return res;
  36 }
  37
  38 /**
  39  * @brief Destructor
  40  * @param cursor poor victim
  41  */
  42 inline void xbt_dict_cursor_free(xbt_dict_cursor_t * cursor)
  43 {
  44   xbt_free(*cursor);
  45   *cursor = NULL;
  46 }
  47
  48 /*
  49  * Sanity check to see if the head contains something
  50  */
  51 static inline void __cursor_not_null(xbt_dict_cursor_t cursor)
  52 {
  53   xbt_assert(cursor, "Null cursor");
  54 }
  55
  56 /** @brief Reinitialize the cursor. Mandatory after removal or add in dict. */
  57 inline void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor)
  58 {
  59   XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_rewind");
  60   xbt_assert(cursor);
  61
  62   cursor->line = 0;
  63   if (cursor->dict != NULL) {
  64     cursor->current = cursor->dict->table[0];
  65   } else {
  66     cursor->current = NULL;
  67   }
  68 }
  69
  70 /**
  71  * @brief Create the cursor if it does not exists. Rewind it in any case.
  72  *
  73  * @param      dict   on what to let the cursor iterate
  74  * @param[out] cursor dest address
  75  */
  76 inline void xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor)
  77 {
  78   XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_first");
  79   if (!*cursor) {
  80     XBT_CDEBUG(xbt_dict_cursor, "Create the cursor on first use");
  81     *cursor = xbt_dict_cursor_new(dict);
  82   } else {
  83     xbt_dict_cursor_rewind(*cursor);
  84   }
  85   if (dict != NULL && (*cursor)->current == NULL) {
  86     xbt_dict_cursor_step(*cursor);      /* find the first element */
  87   }
  88 }
  89
  90 /** \brief Move to the next element. */
  91 inline void xbt_dict_cursor_step(xbt_dict_cursor_t cursor)
  92 {
  93   xbt_dictelm_t current;
  94   int line;
  95
  96   XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_step");
  97   xbt_assert(cursor);
  98
  99   current = cursor->current;
 100   line = cursor->line;
 101
 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);
 107     }
 108
 109     while (current == NULL && (line + 1) <= cursor->dict->table_size) {
 110       line++;
 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);
 114     }
 115     XBT_CDEBUG(xbt_dict_cursor, "search finished, current = %p, line = %d", current, line);
 116
 117     cursor->current = current;
 118     cursor->line = line;
 119   }
 120 }
 121
 122 /**
 123  * @brief Get current data, or free the cursor if there is no data left
 124  *
 125  * @returns true if it's ok, false if there is no more data
 126  */
 127 inline int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data)
 128 {
 129   xbt_dictelm_t current;
 130
 131   XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_get_or_free");
 132
 133   if (!cursor || !(*cursor))
 134     return FALSE;
 135
 136   current = (*cursor)->current;
 137   if (current == NULL) {        /* no data left */
 138     xbt_dict_cursor_free(cursor);
 139     return FALSE;
 140   }
 141
 142   *key = current->key;
 143   *data = current->content;
 144   return TRUE;
 145 }
 146
 147 /**
 148  * @brief Get current key
 149  * @param cursor: the cursor
 150  * @returns the current key
 151  */
 152 inline char *xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor)
 153 {
 154   __cursor_not_null(cursor);
 155
 156   return cursor->current->key;
 157 }
 158
 159 /**
 160  * @brief Get current data
 161  * @param cursor the cursor
 162  * @returns the current data
 163  */
 164 inline void *xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor)
 165 {
 166   __cursor_not_null(cursor);
 167
 168   return cursor->current->content;
 169 }
 170
 171 /**
 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
 176  */
 177 inline void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn)
 178 {
 179   __cursor_not_null(cursor);
 180   xbt_dictelm_set_data(cursor->dict, cursor->current, data, free_ctn);
 181 }