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