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