tests/test-linkedhash_list.c

   1 /* Test of sequential list data type implementation.
   2    Copyright (C) 2006-2007 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2006.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 # include <config.h>
  21 #endif
  22
  23 #include "gl_linkedhash_list.h"
  24
  25 #include <limits.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28
  29 #include "gl_array_list.h"
  30 #include "progname.h"
  31
  32 static const char *objects[15] =
  33   {
  34     "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o"
  35   };
  36
  37 #define SIZE_BITS (sizeof (size_t) * CHAR_BIT)
  38
  39 static bool
  40 string_equals (const void *x1, const void *x2)
  41 {
  42   const char *s1 = x1;
  43   const char *s2 = x2;
  44   return strcmp (s1, s2) == 0;
  45 }
  46
  47 /* A hash function for NUL-terminated char* strings using
  48    the method described by Bruno Haible.
  49    See http://www.haible.de/bruno/hashfunc.html.  */
  50 static size_t
  51 string_hash (const void *x)
  52 {
  53   const char *s = x;
  54   size_t h = 0;
  55
  56   for (; *s; s++)
  57     h = *s + ((h << 9) | (h >> (SIZE_BITS - 9)));
  58
  59   return h;
  60 }
  61
  62 #define SIZEOF(array) (sizeof (array) / sizeof (array[0]))
  63 #define ASSERT(condition) if (!(condition)) abort ()
  64 #define RANDOM(n) (rand () % (n))
  65 #define RANDOM_OBJECT() objects[RANDOM (SIZEOF (objects))]
  66
  67 static void
  68 check_equals (gl_list_t list1, gl_list_t list2)
  69 {
  70   size_t n, i;
  71
  72   n = gl_list_size (list1);
  73   ASSERT (n == gl_list_size (list2));
  74   for (i = 0; i < n; i++)
  75     {
  76       ASSERT (gl_list_get_at (list1, i) == gl_list_get_at (list2, i));
  77     }
  78 }
  79
  80 static void
  81 check_all (gl_list_t list1, gl_list_t list2, gl_list_t list3)
  82 {
  83   check_equals (list1, list2);
  84   check_equals (list1, list3);
  85 }
  86
  87 int
  88 main (int argc, char *argv[])
  89 {
  90   gl_list_t list1, list2, list3;
  91
  92   set_program_name (argv[0]);
  93
  94   /* Allow the user to provide a non-default random seed on the command line.  */
  95   if (argc > 1)
  96     srand (atoi (argv[1]));
  97
  98   {
  99     size_t initial_size = RANDOM (50);
 100     const void **contents =
 101       (const void **) malloc (initial_size * sizeof (const void *));
 102     size_t i;
 103     unsigned int repeat;
 104
 105     for (i = 0; i < initial_size; i++)
 106       contents[i] = RANDOM_OBJECT ();
 107
 108     /* Create list1.  */
 109     list1 = gl_list_create (GL_ARRAY_LIST,
 110                             string_equals, string_hash, true,
 111                             initial_size, contents);
 112     /* Create list2.  */
 113     list2 = gl_list_create_empty (GL_LINKEDHASH_LIST,
 114                                   string_equals, string_hash, true);
 115     for (i = 0; i < initial_size; i++)
 116       gl_list_add_last (list2, contents[i]);
 117
 118     /* Create list3.  */
 119     list3 = gl_list_create (GL_LINKEDHASH_LIST,
 120                             string_equals, string_hash, true,
 121                             initial_size, contents);
 122
 123     check_all (list1, list2, list3);
 124
 125     for (repeat = 0; repeat < 10000; repeat++)
 126       {
 127         unsigned int operation = RANDOM (16);
 128         switch (operation)
 129           {
 130           case 0:
 131             if (gl_list_size (list1) > 0)
 132               {
 133                 size_t index = RANDOM (gl_list_size (list1));
 134                 const char *obj = RANDOM_OBJECT ();
 135                 gl_list_node_t node1, node2, node3;
 136
 137                 node1 = gl_list_set_at (list1, index, obj);
 138                 ASSERT (gl_list_get_at (list1, index) == obj);
 139                 ASSERT (gl_list_node_value (list1, node1) == obj);
 140
 141                 node2 = gl_list_set_at (list2, index, obj);
 142                 ASSERT (gl_list_get_at (list2, index) == obj);
 143                 ASSERT (gl_list_node_value (list2, node2) == obj);
 144
 145                 node3 = gl_list_set_at (list3, index, obj);
 146                 ASSERT (gl_list_get_at (list3, index) == obj);
 147                 ASSERT (gl_list_node_value (list3, node3) == obj);
 148
 149                 if (index > 0)
 150                   {
 151                     ASSERT (gl_list_node_value (list1, gl_list_previous_node (list1, node1))
 152                             == gl_list_get_at (list1, index - 1));
 153                     ASSERT (gl_list_node_value (list2, gl_list_previous_node (list3, node3))
 154                             == gl_list_get_at (list2, index - 1));
 155                     ASSERT (gl_list_node_value (list3, gl_list_previous_node (list3, node3))
 156                             == gl_list_get_at (list2, index - 1));
 157                   }
 158                 if (index + 1 < gl_list_size (list1))
 159                   {
 160                     ASSERT (gl_list_node_value (list1, gl_list_next_node (list1, node1))
 161                             == gl_list_get_at (list1, index + 1));
 162                     ASSERT (gl_list_node_value (list2, gl_list_next_node (list3, node3))
 163                             == gl_list_get_at (list2, index + 1));
 164                     ASSERT (gl_list_node_value (list3, gl_list_next_node (list3, node3))
 165                             == gl_list_get_at (list2, index + 1));
 166                   }
 167               }
 168             break;
 169           case 1:
 170             {
 171               const char *obj = RANDOM_OBJECT ();
 172               gl_list_node_t node1, node2, node3;
 173               node1 = gl_list_search (list1, obj);
 174               node2 = gl_list_search (list2, obj);
 175               node3 = gl_list_search (list3, obj);
 176               if (node1 == NULL)
 177                 {
 178                   ASSERT (node2 == NULL);
 179                   ASSERT (node3 == NULL);
 180                 }
 181               else
 182                 {
 183                   ASSERT (node2 != NULL);
 184                   ASSERT (node3 != NULL);
 185                   ASSERT (gl_list_node_value (list1, node1) == obj);
 186                   ASSERT (gl_list_node_value (list2, node2) == obj);
 187                   ASSERT (gl_list_node_value (list3, node3) == obj);
 188                 }
 189             }
 190             break;
 191           case 2:
 192             {
 193               const char *obj = RANDOM_OBJECT ();
 194               size_t index1, index2, index3;
 195               index1 = gl_list_indexof (list1, obj);
 196               index2 = gl_list_indexof (list2, obj);
 197               index3 = gl_list_indexof (list3, obj);
 198               if (index1 == (size_t)(-1))
 199                 {
 200                   ASSERT (index2 == (size_t)(-1));
 201                   ASSERT (index3 == (size_t)(-1));
 202                 }
 203               else
 204                 {
 205                   ASSERT (index2 != (size_t)(-1));
 206                   ASSERT (index3 != (size_t)(-1));
 207                   ASSERT (gl_list_get_at (list1, index1) == obj);
 208                   ASSERT (gl_list_get_at (list2, index2) == obj);
 209                   ASSERT (gl_list_get_at (list3, index3) == obj);
 210                   ASSERT (index2 == index1);
 211                   ASSERT (index3 == index1);
 212                 }
 213             }
 214             break;
 215           case 3: /* add 1 element */
 216             {
 217               const char *obj = RANDOM_OBJECT ();
 218               gl_list_node_t node1, node2, node3;
 219               node1 = gl_list_add_first (list1, obj);
 220               node2 = gl_list_add_first (list2, obj);
 221               node3 = gl_list_add_first (list3, obj);
 222               ASSERT (gl_list_node_value (list1, node1) == obj);
 223               ASSERT (gl_list_node_value (list2, node2) == obj);
 224               ASSERT (gl_list_node_value (list3, node3) == obj);
 225               ASSERT (gl_list_get_at (list1, 0) == obj);
 226               ASSERT (gl_list_get_at (list2, 0) == obj);
 227               ASSERT (gl_list_get_at (list3, 0) == obj);
 228             }
 229             break;
 230           case 4: /* add 1 element */
 231             {
 232               const char *obj = RANDOM_OBJECT ();
 233               gl_list_node_t node1, node2, node3;
 234               node1 = gl_list_add_last (list1, obj);
 235               node2 = gl_list_add_last (list2, obj);
 236               node3 = gl_list_add_last (list3, obj);
 237               ASSERT (gl_list_node_value (list1, node1) == obj);
 238               ASSERT (gl_list_node_value (list2, node2) == obj);
 239               ASSERT (gl_list_node_value (list3, node3) == obj);
 240               ASSERT (gl_list_get_at (list1, gl_list_size (list1) - 1) == obj);
 241               ASSERT (gl_list_get_at (list2, gl_list_size (list2) - 1) == obj);
 242               ASSERT (gl_list_get_at (list3, gl_list_size (list3) - 1) == obj);
 243             }
 244             break;
 245           case 5: /* add 3 elements */
 246             {
 247               const char *obj0 = RANDOM_OBJECT ();
 248               const char *obj1 = RANDOM_OBJECT ();
 249               const char *obj2 = RANDOM_OBJECT ();
 250               gl_list_node_t node1, node2, node3;
 251               node1 = gl_list_add_first (list1, obj2);
 252               node1 = gl_list_add_before (list1, node1, obj0);
 253               node1 = gl_list_add_after (list1, node1, obj1);
 254               node2 = gl_list_add_first (list2, obj2);
 255               node2 = gl_list_add_before (list2, node2, obj0);
 256               node2 = gl_list_add_after (list2, node2, obj1);
 257               node3 = gl_list_add_first (list3, obj2);
 258               node3 = gl_list_add_before (list3, node3, obj0);
 259               node3 = gl_list_add_after (list3, node3, obj1);
 260               ASSERT (gl_list_node_value (list1, node1) == obj1);
 261               ASSERT (gl_list_node_value (list2, node2) == obj1);
 262               ASSERT (gl_list_node_value (list3, node3) == obj1);
 263               ASSERT (gl_list_get_at (list1, 0) == obj0);
 264               ASSERT (gl_list_get_at (list1, 1) == obj1);
 265               ASSERT (gl_list_get_at (list1, 2) == obj2);
 266               ASSERT (gl_list_get_at (list2, 0) == obj0);
 267               ASSERT (gl_list_get_at (list2, 1) == obj1);
 268               ASSERT (gl_list_get_at (list2, 2) == obj2);
 269               ASSERT (gl_list_get_at (list3, 0) == obj0);
 270               ASSERT (gl_list_get_at (list3, 1) == obj1);
 271               ASSERT (gl_list_get_at (list3, 2) == obj2);
 272             }
 273             break;
 274           case 6: /* add 1 element */
 275             {
 276               size_t index = RANDOM (gl_list_size (list1) + 1);
 277               const char *obj = RANDOM_OBJECT ();
 278               gl_list_node_t node1, node2, node3;
 279               node1 = gl_list_add_at (list1, index, obj);
 280               node2 = gl_list_add_at (list2, index, obj);
 281               node3 = gl_list_add_at (list3, index, obj);
 282               ASSERT (gl_list_get_at (list1, index) == obj);
 283               ASSERT (gl_list_node_value (list1, node1) == obj);
 284               ASSERT (gl_list_get_at (list2, index) == obj);
 285               ASSERT (gl_list_node_value (list2, node2) == obj);
 286               ASSERT (gl_list_get_at (list3, index) == obj);
 287               ASSERT (gl_list_node_value (list3, node3) == obj);
 288               if (index > 0)
 289                 {
 290                   ASSERT (gl_list_node_value (list1, gl_list_previous_node (list1, node1))
 291                           == gl_list_get_at (list1, index - 1));
 292                   ASSERT (gl_list_node_value (list2, gl_list_previous_node (list3, node3))
 293                           == gl_list_get_at (list2, index - 1));
 294                   ASSERT (gl_list_node_value (list3, gl_list_previous_node (list3, node3))
 295                           == gl_list_get_at (list2, index - 1));
 296                 }
 297               if (index + 1 < gl_list_size (list1))
 298                 {
 299                   ASSERT (gl_list_node_value (list1, gl_list_next_node (list1, node1))
 300                           == gl_list_get_at (list1, index + 1));
 301                   ASSERT (gl_list_node_value (list2, gl_list_next_node (list3, node3))
 302                           == gl_list_get_at (list2, index + 1));
 303                   ASSERT (gl_list_node_value (list3, gl_list_next_node (list3, node3))
 304                           == gl_list_get_at (list2, index + 1));
 305                 }
 306             }
 307             break;
 308           case 7: case 8: /* remove 1 element */
 309             if (gl_list_size (list1) > 0)
 310               {
 311                 size_t n = gl_list_size (list1);
 312                 const char *obj = gl_list_get_at (list1, RANDOM (n));
 313                 gl_list_node_t node1, node2, node3;
 314                 node1 = gl_list_search (list1, obj);
 315                 node2 = gl_list_search (list2, obj);
 316                 node3 = gl_list_search (list3, obj);
 317                 ASSERT (node1 != NULL);
 318                 ASSERT (node2 != NULL);
 319                 ASSERT (node3 != NULL);
 320                 ASSERT (gl_list_remove_node (list1, node1));
 321                 ASSERT (gl_list_remove_node (list2, node2));
 322                 ASSERT (gl_list_remove_node (list3, node3));
 323                 ASSERT (gl_list_size (list1) == n - 1);
 324               }
 325             break;
 326           case 9: case 10: /* remove 1 element */
 327             if (gl_list_size (list1) > 0)
 328               {
 329                 size_t n = gl_list_size (list1);
 330                 size_t index = RANDOM (n);
 331                 ASSERT (gl_list_remove_at (list1, index));
 332                 ASSERT (gl_list_remove_at (list2, index));
 333                 ASSERT (gl_list_remove_at (list3, index));
 334                 ASSERT (gl_list_size (list1) == n - 1);
 335               }
 336             break;
 337           case 11: case 12: /* remove 1 element */
 338             if (gl_list_size (list1) > 0)
 339               {
 340                 size_t n = gl_list_size (list1);
 341                 const char *obj = gl_list_get_at (list1, RANDOM (n));
 342                 ASSERT (gl_list_remove (list1, obj));
 343                 ASSERT (gl_list_remove (list2, obj));
 344                 ASSERT (gl_list_remove (list3, obj));
 345                 ASSERT (gl_list_size (list1) == n - 1);
 346               }
 347             break;
 348           case 13:
 349             if (gl_list_size (list1) > 0)
 350               {
 351                 size_t n = gl_list_size (list1);
 352                 const char *obj = "xyzzy";
 353                 ASSERT (!gl_list_remove (list1, obj));
 354                 ASSERT (!gl_list_remove (list2, obj));
 355                 ASSERT (!gl_list_remove (list3, obj));
 356                 ASSERT (gl_list_size (list1) == n);
 357               }
 358             break;
 359           case 14:
 360             {
 361               size_t n = gl_list_size (list1);
 362               gl_list_iterator_t iter1, iter2, iter3;
 363               const void *elt;
 364               iter1 = gl_list_iterator (list1);
 365               iter2 = gl_list_iterator (list2);
 366               iter3 = gl_list_iterator (list3);
 367               for (i = 0; i < n; i++)
 368                 {
 369                   ASSERT (gl_list_iterator_next (&iter1, &elt, NULL));
 370                   ASSERT (gl_list_get_at (list1, i) == elt);
 371                   ASSERT (gl_list_iterator_next (&iter2, &elt, NULL));
 372                   ASSERT (gl_list_get_at (list2, i) == elt);
 373                   ASSERT (gl_list_iterator_next (&iter3, &elt, NULL));
 374                   ASSERT (gl_list_get_at (list3, i) == elt);
 375                 }
 376               ASSERT (!gl_list_iterator_next (&iter1, &elt, NULL));
 377               ASSERT (!gl_list_iterator_next (&iter2, &elt, NULL));
 378               ASSERT (!gl_list_iterator_next (&iter3, &elt, NULL));
 379               gl_list_iterator_free (&iter1);
 380               gl_list_iterator_free (&iter2);
 381               gl_list_iterator_free (&iter3);
 382             }
 383             break;
 384           case 15:
 385             {
 386               size_t end = RANDOM (gl_list_size (list1) + 1);
 387               size_t start = RANDOM (end + 1);
 388               gl_list_iterator_t iter1, iter2, iter3;
 389               const void *elt;
 390               iter1 = gl_list_iterator_from_to (list1, start, end);
 391               iter2 = gl_list_iterator_from_to (list2, start, end);
 392               iter3 = gl_list_iterator_from_to (list3, start, end);
 393               for (i = start; i < end; i++)
 394                 {
 395                   ASSERT (gl_list_iterator_next (&iter1, &elt, NULL));
 396                   ASSERT (gl_list_get_at (list1, i) == elt);
 397                   ASSERT (gl_list_iterator_next (&iter2, &elt, NULL));
 398                   ASSERT (gl_list_get_at (list2, i) == elt);
 399                   ASSERT (gl_list_iterator_next (&iter3, &elt, NULL));
 400                   ASSERT (gl_list_get_at (list3, i) == elt);
 401                 }
 402               ASSERT (!gl_list_iterator_next (&iter1, &elt, NULL));
 403               ASSERT (!gl_list_iterator_next (&iter2, &elt, NULL));
 404               ASSERT (!gl_list_iterator_next (&iter3, &elt, NULL));
 405               gl_list_iterator_free (&iter1);
 406               gl_list_iterator_free (&iter2);
 407               gl_list_iterator_free (&iter3);
 408             }
 409             break;
 410           }
 411         check_all (list1, list2, list3);
 412       }
 413
 414     gl_list_free (list1);
 415     gl_list_free (list2);
 416     gl_list_free (list3);
 417     free (contents);
 418   }
 419
 420   return 0;
 421 }