src/xbt/set.c

   1 /* $Id$ */
   2
   3 /* set - data container consisting in dict+dynar                            */
   4
   5 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "xbt/misc.h"
  11 #include "xbt/sysdep.h"
  12 #include "xbt/log.h"
  13 #include "xbt/ex.h"
  14 #include "xbt/dynar.h"
  15 #include "xbt/dict.h"
  16
  17 #include "xbt/set.h"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(set,xbt,
  20              "set: data container consisting in dict+dynar");
  21
  22 /*####[ Type definition ]####################################################*/
  23 typedef struct xbt_set_ {
  24   xbt_dict_t  dict;  /* data stored by name */
  25   xbt_dynar_t dynar; /* data stored by ID   */
  26 } s_xbt_set_t;
  27
  28 /*####[ Memory  ]############################################################*/
  29 /** @brief Constructor */
  30 xbt_set_t xbt_set_new (void) {
  31   xbt_set_t res=xbt_new(s_xbt_set_t,1);
  32
  33   res->dict=xbt_dict_new ();
  34   res->dynar=xbt_dynar_new(sizeof(void*),NULL);
  35
  36   return res;
  37 }
  38
  39 /** @brief Destructor */
  40 void  xbt_set_free(xbt_set_t *set) {
  41   if (*set) {
  42     xbt_dict_free ( &( (*set)->dict  ) );
  43     xbt_dynar_free( &( (*set)->dynar ) );
  44     free(*set);
  45     *set = NULL;
  46   }
  47 }
  48
  49 /** @brief Add an element to a set.
  50  *
  51  * \param set set to populate
  52  * \param elm element to add.
  53  * \param free_func How to add the data
  54  *
  55  * elm->name must be set;
  56  * if elm->name_len <= 0, it is recomputed. If >0, it's used as is;
  57  * elm->ID is attributed automatically.
  58  */
  59 void xbt_set_add    (xbt_set_t      set,
  60                       xbt_set_elm_t  elm,
  61                       void_f_pvoid_t *free_func) {
  62
  63   int found = 1;
  64   xbt_set_elm_t found_in_dict = NULL;
  65   xbt_ex_t e;
  66
  67   if (elm->name_len <= 0) {
  68     elm->name_len = strlen(elm->name);
  69   }
  70
  71   TRY {
  72     found_in_dict = xbt_dict_get_ext (set->dict,
  73                                       elm->name, elm->name_len);
  74   } CATCH(e) {
  75     if (e.category != not_found_error)
  76       RETHROW;
  77     found = 0;
  78     elm->ID = xbt_dynar_length( set->dynar );
  79     xbt_dict_set_ext(set->dict, elm->name, elm->name_len, elm, free_func);
  80     xbt_dynar_set(set->dynar, elm->ID, &elm);
  81     DEBUG2("Insertion of key '%s' (id %d)", elm->name, elm->ID);
  82     xbt_ex_free(e);
  83   }
  84
  85   if (found) {
  86     if (elm == found_in_dict) {
  87       DEBUG2("Ignoring request to insert the same element twice (key %s ; id %d)",
  88              elm->name, elm->ID);
  89       return;
  90     } else {
  91       elm->ID=found_in_dict->ID;
  92       DEBUG2("Reinsertion of key %s (id %d)", elm->name, elm->ID);
  93       xbt_dict_set_ext(set->dict, elm->name, elm->name_len, elm, free_func);
  94       xbt_dynar_set(set->dynar, elm->ID, &elm);
  95       return;
  96     }
  97   }
  98 }
  99
 100 /** @brief Retrive data by providing its name.
 101  *
 102  * \param set
 103  * \param name Name of the searched cell
 104  * \returns the data you're looking for
 105  */
 106 xbt_set_elm_t xbt_set_get_by_name    (xbt_set_t     set,
 107                                       const char     *name) {
 108   DEBUG1("Lookup key %s",name);
 109   return xbt_dict_get_ext(set->dict, name, strlen(name));
 110 }
 111
 112 /** @brief Retrive data by providing its name and the length of the name
 113  *
 114  * \param set
 115  * \param name Name of the searched cell
 116  * \param name_len length of the name, when strlen cannot be trusted
 117  * \returns the data you're looking for
 118  *
 119  * This is useful when strlen cannot be trusted because you don't use a char*
 120  * as name, you weirdo.
 121  */
 122 xbt_set_elm_t xbt_set_get_by_name_ext(xbt_set_t      set,
 123                                       const char     *name,
 124                                       int             name_len) {
 125
 126   return xbt_dict_get_ext (set->dict, name, name_len);
 127 }
 128
 129 /** @brief Retrive data by providing its ID
 130  *
 131  * \param set
 132  * \param id what you're looking for
 133  * \returns the data you're looking for
 134  *
 135  * @warning, if the ID does not exists, you're getting into trouble
 136  */
 137 xbt_set_elm_t xbt_set_get_by_id (xbt_set_t set, int id) {
 138   xbt_set_elm_t res;
 139
 140   /* Don't bother checking the bounds, the dynar does so */
 141
 142   res = xbt_dynar_get_as(set->dynar,id,xbt_set_elm_t);
 143   DEBUG3("Lookup type of id %d (of %lu): %s",
 144          id, xbt_dynar_length(set->dynar), res->name);
 145
 146   return res;
 147 }
 148
 149 /***
 150  *** Cursors
 151  ***/
 152 typedef struct xbt_set_cursor_ {
 153   xbt_set_t set;
 154   int val;
 155 } s_xbt_set_cursor_t;
 156
 157 /** @brief Create the cursor if it does not exists, rewind it in any case. */
 158 void         xbt_set_cursor_first       (xbt_set_t         set,
 159                                           xbt_set_cursor_t *cursor) {
 160
 161   if (set != NULL) {
 162     if (!*cursor) {
 163       DEBUG0("Create the cursor on first use");
 164       *cursor = xbt_new(s_xbt_set_cursor_t,1);
 165       xbt_assert0(*cursor,
 166                    "Malloc error during the creation of the cursor");
 167     }
 168     (*cursor)->set = set;
 169     xbt_dynar_cursor_first(set->dynar, &( (*cursor)->val) );
 170   } else {
 171     *cursor = NULL;
 172   }
 173 }
 174
 175 /** @brief Move to the next element.  */
 176 void         xbt_set_cursor_step        (xbt_set_cursor_t cursor) {
 177   xbt_dynar_cursor_step(cursor->set->dynar, &( cursor->val ) );
 178 }
 179
 180 /** @brief Get current data
 181  *
 182  * \return true if it's ok, false if there is no more data
 183  */
 184 int          xbt_set_cursor_get_or_free (xbt_set_cursor_t *curs,
 185                                           xbt_set_elm_t    *elm) {
 186   xbt_set_cursor_t cursor;
 187
 188   if (!curs || !(*curs))
 189     return FALSE;
 190
 191   cursor=*curs;
 192
 193   if (! xbt_dynar_cursor_get( cursor->set->dynar,&(cursor->val),elm) ) {
 194     free(cursor);
 195     *curs=NULL;
 196     return FALSE;
 197   }
 198   return TRUE;
 199 }