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