Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Compare file prefix only.
[simgrid.git] / src / xbt / dict_cursor.c
index a4308fb..38c7930 100644 (file)
-/* $Id$ */
+/* dict_cursor - iterators over dictionaries                               */
 
-/* dict_cursor - iterators over dictionnaries                               */
-
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2003,2004 Martin Quinson.                                  */
+/* Copyright (c) 2004-2014. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  under the terms of the license (GNU LGPL) which comes with this package. */
* under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/misc.h"
+#include "xbt/ex.h"
 #include "dict_private.h"
 
-#include <string.h> /* strlen() */
-
-GRAS_LOG_EXTERNAL_CATEGORY(dict);
-GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(dict_cursor,dict,"To traverse dictionaries");
+#include <string.h>             /* strlen() */
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict_cursor, xbt_dict, "To traverse dictionaries");
 
 /*####[ Dict cursor functions ]#############################################*/
 /* To traverse (simple) dicts                                               */
 /* Don't add or remove entries to the dict while traversing !!!             */
 /*###########################################################################*/
-struct gras_dict_cursor_ {
-  /* we store all level encountered until here, to backtrack on next() */
-  gras_dynar_t *keys;
-  gras_dynar_t *key_lens;
-  int           pos;
-  int           pos_len;
-  gras_dictelm_t  *head;
-};
 
-static _GRAS_INLINE void
-_cursor_push_keys(gras_dict_cursor_t *p_cursor,
-                  gras_dictelm_t        *p_elm);
+#undef xbt_dict_CURSOR_DEBUG
+/*#define xbt_dict_CURSOR_DEBUG 1*/
 
-#undef gras_dict_CURSOR_DEBUG
-/*#define gras_dict_CURSOR_DEBUG 1*/
-
-/**
- * gras_dict_cursor_new:
- *
- * @head: the head of the dict
- * @cursor: the curent position in the dict
- *
- * Structure creator
+/** @brief Creator
+ *  @param dict the dict
  */
-gras_dict_cursor_t *
-gras_dict_cursor_new(const gras_dict_t          *p_head) {
-  gras_error_t        errcode  = no_error;
-  gras_dict_cursor_t *res = NULL;
+inline xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t dict)
+{
+  xbt_dict_cursor_t res = xbt_new(s_xbt_dict_cursor_t, 1);
+  res->dict = dict;
 
-  res = gras_new(gras_dict_cursor_t,1);
-  res->keys     = gras_dynar_new(sizeof(char **), NULL);
-  res->key_lens = gras_dynar_new(sizeof(int  *),  NULL);
-  res->pos      = 0;
-  res->pos_len  = 0;
-  res->head     = p_head ? p_head->head : NULL;
-
-  gras_dict_cursor_rewind(res);
+  xbt_dict_cursor_rewind(res);
 
   return res;
 }
 
 /**
- * gras_dict_cursor_free:
- *
- * @cursor: poor victim
- *
- * Structure destructor
+ * @brief Destructor
+ * @param cursor poor victim
  */
-void
-gras_dict_cursor_free(gras_dict_cursor_t *p_cursor) {
-  if (p_cursor) {
-    gras_dynar_free(p_cursor->keys);
-    gras_dynar_free(p_cursor->key_lens);
-    memset(p_cursor, 0, sizeof(gras_dict_cursor_t));
-    gras_free(p_cursor);
-  }
+inline void xbt_dict_cursor_free(xbt_dict_cursor_t * cursor)
+{
+  xbt_free(*cursor);
+  *cursor = NULL;
 }
 
-/**
- * __cursor_not_null:
- *
+/*
  * Sanity check to see if the head contains something
  */
-static _GRAS_INLINE
-gras_error_t
-__cursor_not_null(gras_dict_cursor_t *p_cursor) {
-
-  gras_assert0(p_cursor, "Null cursor");
-
-  if (!p_cursor->head) {
-    return mismatch_error;
-  }
-
-  return no_error;
+static inline void __cursor_not_null(xbt_dict_cursor_t cursor)
+{
+  xbt_assert(cursor, "Null cursor");
 }
 
-
-static _GRAS_INLINE
-void
-_cursor_push_keys(gras_dict_cursor_t *p_cursor,
-                  gras_dictelm_t        *p_elm) {
-  gras_error_t         errcode = no_error;
-  gras_dictelm_t      *p_child = NULL;
-  int                  i       = 0;
-  static volatile int  count   = 0; /* ??? */
-
-  CDEBUG1(dict_cursor, "Push childs of %p in the cursor", (void*)p_elm);
-
-  if (p_elm->content) {
-    gras_dynar_push(p_cursor->keys,     &p_elm->key    );
-    gras_dynar_push(p_cursor->key_lens, &p_elm->key_len);
-    count++;
+/** @brief Reinitialize the cursor. Mandatory after removal or add in dict. */
+inline void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor)
+{
+  XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_rewind");
+  xbt_assert(cursor);
+
+  cursor->line = 0;
+  if (cursor->dict != NULL) {
+    cursor->current = cursor->dict->table[0];
+  } else {
+    cursor->current = NULL;
   }
-
-  gras_dynar_foreach(p_elm->sub, i, p_child) {
-    if (p_child)
-      _cursor_push_keys(p_cursor, p_child);
-  }
-
-  CDEBUG1(dict_cursor, "Count = %d", count);
 }
 
 /**
- * gras_dict_cursor_rewind:
- * @cursor: the cursor
- * @Returns: gras_error_t
+ * @brief Create the cursor if it does not exists. Rewind it in any case.
  *
- * back to the first element
+ * @param      dict   on what to let the cursor iterate
+ * @param[out] cursor dest address
  */
-void
-gras_dict_cursor_rewind(gras_dict_cursor_t *p_cursor) {
-  gras_error_t errcode = no_error;
-
-  CDEBUG0(dict_cursor, "gras_dict_cursor_rewind");
-  gras_assert(p_cursor);
-
-  gras_dynar_reset(p_cursor->keys);
-  gras_dynar_reset(p_cursor->key_lens);
-
-  if (!p_cursor->head)
-    return ;
-
-  _cursor_push_keys(p_cursor, p_cursor->head);
-
-  gras_dynar_cursor_first(p_cursor->keys,     &p_cursor->pos    );
-  gras_dynar_cursor_first(p_cursor->key_lens, &p_cursor->pos_len);
-
-}
-
-/**
- * gras_dict_cursor_first:
- * @dict: on what to let the cursor iterate
- * @cursor: dest address
- *
- * Create the cursor if it does not exists. Rewind it in any case.
- */
-void gras_dict_cursor_first (const gras_dict_t   *dict,
-                            gras_dict_cursor_t **cursor){
-
+inline void xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor)
+{
+  XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_first");
   if (!*cursor) {
-    DEBUG0("Create the cursor on first use");
-    *cursor=gras_dict_cursor_new(dict);
+    XBT_CDEBUG(xbt_dict_cursor, "Create the cursor on first use");
+    *cursor = xbt_dict_cursor_new(dict);
+  } else {
+    xbt_dict_cursor_rewind(*cursor);
+  }
+  if (dict != NULL && (*cursor)->current == NULL) {
+    xbt_dict_cursor_step(*cursor);      /* find the first element */
   }
-
-  gras_dict_cursor_rewind(*cursor);
 }
 
+/** \brief Move to the next element. */
+inline void xbt_dict_cursor_step(xbt_dict_cursor_t cursor)
+{
+  xbt_dictelm_t current;
+  int line;
+
+  XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_cursor_step");
+  xbt_assert(cursor);
+
+  current = cursor->current;
+  line = cursor->line;
+
+  if (cursor->dict != NULL) {
+    if (current != NULL) {
+      XBT_CDEBUG(xbt_dict_cursor, "current is not null, take the next element");
+      current = current->next;
+      XBT_CDEBUG(xbt_dict_cursor, "next element: %p", current);
+    }
+
+    while (current == NULL && (line + 1) <= cursor->dict->table_size) {
+      line++;
+      XBT_CDEBUG(xbt_dict_cursor, "current is NULL, take the next line");
+      current = cursor->dict->table[line];
+      XBT_CDEBUG(xbt_dict_cursor, "element in the next line: %p", current);
+    }
+    XBT_CDEBUG(xbt_dict_cursor, "search finished, current = %p, line = %d", current, line);
+
+    cursor->current = current;
+    cursor->line = line;
+  }
+}
 
 /**
- * gras_dict_cursor_step:
- * @cursor: the cursor
+ * @brief Get current data, or free the cursor if there is no data left
  *
- * Move to the next element. 
+ * @returns true if it's ok, false if there is no more data
  */
-void
-gras_dict_cursor_step(gras_dict_cursor_t *p_cursor) {
-  gras_assert(p_cursor);
+inline int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data)
+{
+  xbt_dictelm_t current;
 
-  gras_dynar_cursor_step(p_cursor->keys,     &p_cursor->pos);
-  gras_dynar_cursor_step(p_cursor->key_lens, &p_cursor->pos_len);
-}
+  XBT_CDEBUG(xbt_dict_cursor, "xbt_dict_get_or_free");
 
-/**
- * gras_dict_cursor_get_or_free:
- * @cursor: the cursor
- * @Returns: true if it's ok, false if there is no more data
- *
- * Get current data
- */
-int
-gras_dict_cursor_get_or_free(gras_dict_cursor_t **cursor,
-                            char               **key,
-                            void               **data) {
-  gras_error_t  errcode = no_error;
-  int           key_len = 0;
-  
   if (!cursor || !(*cursor))
     return FALSE;
 
-  if (gras_dynar_length((*cursor)->keys) <= (*cursor)->pos) {
-    gras_dict_cursor_free(*cursor);
-    *cursor=NULL;
-    return FALSE;
-  }
-    
-  *key    = gras_dynar_get_as((*cursor)->keys,     (*cursor)->pos,     char*);
-  key_len = gras_dynar_get_as((*cursor)->key_lens, (*cursor)->pos_len, int);
-
-  errcode = gras_dictelm_get_ext((*cursor)->head, *key, key_len, data);
-  if (errcode == mismatch_error) {
-    gras_dict_cursor_free(*cursor);
-    *cursor=NULL;
+  current = (*cursor)->current;
+  if (current == NULL) {        /* no data left */
+    xbt_dict_cursor_free(cursor);
     return FALSE;
   }
 
-  gras_assert1(errcode == no_error,
-              "Unexpected problem while retrieving the content of cursor. Got %s",
-              gras_error_name(errcode));
-
+  *key = current->key;
+  *data = current->content;
   return TRUE;
 }
 
 /**
- * gras_dict_cursor_get_key:
- * @cursor: the cursor
- * @key: the current element
- * @Returns: gras_error_t
- *
- * Get current key
+ * @brief Get current key
+ * @param cursor: the cursor
+ * @returns the current key
  */
-gras_error_t
-gras_dict_cursor_get_key(gras_dict_cursor_t  *p_cursor,
-                         /*OUT*/char        **key) {
-  gras_error_t errcode = no_error;
+inline char *xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor)
+{
+  __cursor_not_null(cursor);
 
-  TRY(__cursor_not_null(p_cursor));
-
-  *key = gras_dynar_get_as(p_cursor->keys, p_cursor->pos - 1, char*);
-
-  return errcode;
+  return cursor->current->key;
 }
 
 /**
- * gras_dict_cursor_get_data:
- * @cursor: the cursor
- *
- * Get current data
+ * @brief Get current data
+ * @param cursor the cursor
+ * @returns the current data
  */
-gras_error_t
-gras_dict_cursor_get_data(gras_dict_cursor_t  *p_cursor,
-                          /*OUT*/void        **data) {
-  gras_error_t  errcode = no_error;
-  char         *key     = NULL;
-  int           key_len = 0;
+inline void *xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor)
+{
+  __cursor_not_null(cursor);
 
-  TRY(__cursor_not_null(p_cursor));
-
-  key     = gras_dynar_get_as(p_cursor->keys,     p_cursor->pos-1,  char *);
-  key_len = gras_dynar_get_as(p_cursor->key_lens, p_cursor->pos_len-1, int);
-
-  TRY(gras_dictelm_get_ext(p_cursor->head, key, key_len, data));
-
-  return errcode;
+  return cursor->current->content;
 }
 
-
+/**
+ * @brief Set current data
+ * @param cursor the cursor
+ * @param data the new data
+ * @param free_ctn the function to free the new data
+ */
+inline void xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn)
+{
+  __cursor_not_null(cursor);
+  xbt_dictelm_set_data(cursor->dict, cursor->current, data, free_ctn);
+}