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 }
 200
 201 #ifdef SIMGRID_TEST
 202 #include "xbt.h"
 203 #include "xbt/ex.h"
 204
 205 XBT_TEST_SUITE("set","Set data container");
 206
 207 typedef struct  {
 208   /* headers */
 209   unsigned int ID;
 210   char        *name;
 211   unsigned int name_len;
 212
 213   /* payload */
 214   char         *data;
 215 } s_my_elem_t,*my_elem_t;
 216
 217
 218 static void my_elem_free(void *e) {
 219   my_elem_t elm=(my_elem_t)e;
 220
 221   if (elm) {
 222     free(elm->name);
 223     free(elm->data);
 224     free(elm);
 225   }
 226 }
 227
 228 static void debuged_add(xbt_set_t  set,
 229                         const char *name,
 230                         const char *data) {
 231   my_elem_t    elm;
 232
 233   elm = xbt_new(s_my_elem_t,1);
 234   elm->name=xbt_strdup(name);
 235   elm->name_len=0;
 236
 237   elm->data=xbt_strdup(data);
 238
 239   xbt_test_log2("   - Add %s (->%s)",name,data);
 240   xbt_set_add(set, (xbt_set_elm_t)elm, &my_elem_free);
 241 }
 242
 243 static void fill(xbt_set_t *set) {
 244   xbt_test_add0("Fill in the data set");
 245
 246   *set=xbt_set_new();
 247   debuged_add(*set,"12",     "12");
 248   debuged_add(*set,"12a",    "12a");
 249   debuged_add(*set,"12b",    "12b");
 250   debuged_add(*set,"123",    "123");
 251   debuged_add(*set,"123456", "123456");
 252   xbt_test_log0("Child becomes child of what to add");
 253   debuged_add(*set,"1234",   "1234");
 254   xbt_test_log0("Need of common ancestor");
 255   debuged_add(*set,"123457", "123457");
 256 }
 257
 258 static void search_name(xbt_set_t head,const char*key) {
 259   my_elem_t elm;
 260
 261   xbt_test_add1("Search by name %s",key);
 262   elm = (my_elem_t)xbt_set_get_by_name(head,key);
 263   xbt_test_log2(" Found %s (under ID %d)\n",
 264                 elm? elm->data:"(null)",
 265                 elm? elm->ID:-1);
 266   if (strcmp(key,elm->name))
 267     THROW2(mismatch_error,0,"The key (%s) is not the one expected (%s)",
 268            key,elm->name);
 269   if (strcmp(elm->name,elm->data))
 270     THROW2(mismatch_error,0,"The name (%s) != data (%s)",
 271            key,elm->name);
 272   fflush(stdout);
 273 }
 274
 275 static void search_id(xbt_set_t head,int id,const char*key) {
 276   my_elem_t elm;
 277
 278   xbt_test_add1("Search by id %d",id);
 279   elm = (my_elem_t) xbt_set_get_by_id(head,id);
 280   xbt_test_log2("Found %s (data %s)",
 281                 elm? elm->name:"(null)",
 282                 elm? elm->data:"(null)");
 283   if (id != elm->ID)
 284     THROW2(mismatch_error,0,"The found ID (%d) is not the one expected (%d)",
 285            elm->ID,id);
 286   if (strcmp(key,elm->name))
 287     THROW2(mismatch_error,0,"The key (%s) is not the one expected (%s)",
 288            elm->name,key);
 289   if (strcmp(elm->name,elm->data))
 290     THROW2(mismatch_error,0,"The name (%s) != data (%s)",
 291            elm->name,elm->data);
 292   fflush(stdout);
 293 }
 294
 295
 296 static void traverse(xbt_set_t set) {
 297   xbt_set_cursor_t cursor=NULL;
 298   my_elem_t         elm=NULL;
 299
 300   xbt_set_foreach(set,cursor,elm) {
 301     xbt_test_assert0(elm,"Dude ! Got a null elm during traversal!");
 302     xbt_test_log3("Id(%d):  %s->%s\n",elm->ID,elm->name,elm->data);
 303     xbt_test_assert2(!strcmp(elm->name,elm->data),
 304                      "Key(%s) != value(%s). Abording",
 305                      elm->name,elm->data);
 306   }
 307 }
 308
 309 static void search_not_found(xbt_set_t set, const char *data) {
 310   xbt_ex_t e;
 311
 312   xbt_test_add1("Search %s (expected not to be found)",data);
 313   TRY {
 314     xbt_set_get_by_name(set,data);
 315     THROW1(unknown_error,0,"Found something which shouldn't be there (%s)",data);
 316   } CATCH(e) {
 317     if (e.category != not_found_error) {
 318       xbt_test_exception(e);
 319     }
 320     xbt_ex_free(e);
 321   }
 322 }
 323
 324 xbt_set_t set = NULL;
 325
 326
 327 XBT_TEST_UNIT("basic",test_set_basic,"Basic usage") {
 328   set=NULL;
 329
 330   xbt_test_add0("Traverse the empty set");
 331   traverse(set);
 332
 333   xbt_test_add0("Free a data set");
 334   fill(&set);
 335   xbt_set_free(&set);
 336
 337   xbt_test_add0("Free the NULL data set");
 338   xbt_set_free(&set);
 339
 340 }
 341
 342 XBT_TEST_UNIT("change",test_set_change,"Changing some values") {
 343   fill(&set);
 344
 345   xbt_test_add0("Change 123 to 'Changed 123'");
 346   debuged_add(set,"123","Changed 123");
 347
 348   xbt_test_add0("Change 123 back to '123'");
 349   debuged_add(set,"123","123");
 350
 351   xbt_test_add0("Change 12a to 'Dummy 12a'");
 352   debuged_add(set,"12a","Dummy 12a");
 353
 354   xbt_test_add0("Change 12a to '12a'");
 355   debuged_add(set,"12a","12a");
 356
 357   /*  xbt_dict_dump(head,(void (*)(void*))&printf); */
 358   xbt_test_add0("Traverse the resulting data set");
 359   traverse(set);
 360 }
 361
 362 XBT_TEST_UNIT("retrieve",test_set_retrieve,"Retrieve some values") {
 363   my_elem_t elm;
 364
 365   xbt_test_add0("Search 123");
 366   elm = (my_elem_t) xbt_set_get_by_name(set,"123");
 367   xbt_test_assert0(elm,"elm must be there");
 368   strcmp("123",elm->data);
 369
 370   search_not_found(set,"Can't be found");
 371   search_not_found(set,"123 Can't be found");
 372   search_not_found(set,"12345678 NOT");
 373
 374   search_name(set,"12");
 375   search_name(set,"12a");
 376   search_name(set,"12b");
 377   search_name(set,"123");
 378   search_name(set,"123456");
 379   search_name(set,"1234");
 380   search_name(set,"123457");
 381
 382   search_id(set,0,"12");
 383   search_id(set,1,"12a");
 384   search_id(set,2,"12b");
 385   search_id(set,3,"123");
 386   search_id(set,4,"123456");
 387   search_id(set,5,"1234");
 388   search_id(set,6,"123457");
 389
 390   xbt_test_add0("Traverse the resulting data set");
 391   traverse(set);
 392
 393   /*  xbt_dict_dump(head,(void (*)(void*))&printf); */
 394
 395   xbt_test_add0("Free the data set (twice)");
 396   xbt_set_free(&set);
 397   xbt_set_free(&set);
 398
 399   xbt_test_add0("Traverse the resulting data set");
 400   traverse(set);
 401 }
 402 #endif /* SIMGRID_TEST */