1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
35 #include "gtestutils.h"
39 * SECTION:linked_lists_single
40 * @title: Singly-Linked Lists
41 * @short_description: linked lists containing integer values or
42 * pointers to data, limited to iterating over the
43 * list in one direction
45 * The #GSList structure and its associated functions provide a
46 * standard singly-linked list data structure.
48 * Each element in the list contains a piece of data, together with a
49 * pointer which links to the next element in the list. Using this
50 * pointer it is possible to move through the list in one direction
51 * only (unlike the <link
52 * linkend="glib-Doubly-Linked-Lists">Doubly-Linked Lists</link> which
53 * allow movement in both directions).
55 * The data contained in each element can be either integer values, by
56 * using one of the <link linkend="glib-Type-Conversion-Macros">Type
57 * Conversion Macros</link>, or simply pointers to any type of data.
59 * List elements are allocated from the <link
60 * linkend="glib-Memory-Slices">slice allocator</link>, which is more
61 * efficient than allocating elements individually.
63 * Note that most of the #GSList functions expect to be passed a
64 * pointer to the first element in the list. The functions which insert
65 * elements return the new start of the list, which may have changed.
67 * There is no function to create a #GSList. %NULL is considered to be
68 * the empty list so you simply set a #GSList* to %NULL.
70 * To add elements, use g_slist_append(), g_slist_prepend(),
71 * g_slist_insert() and g_slist_insert_sorted().
73 * To remove elements, use g_slist_remove().
75 * To find elements in the list use g_slist_last(), g_slist_next(),
76 * g_slist_nth(), g_slist_nth_data(), g_slist_find() and
77 * g_slist_find_custom().
79 * To find the index of an element use g_slist_position() and
82 * To call a function for each element in the list use
85 * To free the entire list, use g_slist_free().
90 * @data: holds the element's data, which can be a pointer to any kind
91 * of data, or any integer value using the <link
92 * linkend="glib-Type-Conversion-Macros">Type Conversion
94 * @next: contains the link to the next element in the list.
96 * The #GSList struct is used for each element in the singly-linked
102 * @slist: an element in a #GSList.
103 * @Returns: the next element, or %NULL if there are no more elements.
105 * A convenience macro to get the next element in a #GSList.
108 #define _g_slist_alloc0() g_slice_new0 (GSList)
109 #define _g_slist_alloc() g_slice_new (GSList)
110 #define _g_slist_free1(slist) g_slice_free (GSList, slist)
114 * @Returns: a pointer to the newly-allocated #GSList element.
116 * Allocates space for one #GSList element. It is called by the
117 * g_slist_append(), g_slist_prepend(), g_slist_insert() and
118 * g_slist_insert_sorted() functions and so is rarely used on its own.
123 return _g_slist_alloc0 ();
130 * Frees all of the memory used by a #GSList.
131 * The freed elements are returned to the slice allocator.
134 * If list elements contain dynamically-allocated memory,
135 * you should either use g_slist_free_full() or free them manually
140 g_slist_free (GSList *list)
142 g_slice_free_chain (GSList, list, next);
147 * @list: a #GSList element
149 * Frees one #GSList element.
150 * It is usually used after g_slist_remove_link().
155 * A macro which does the same as g_slist_free_1().
160 g_slist_free_1 (GSList *list)
162 _g_slist_free1 (list);
167 * @list: a pointer to a #GSList
168 * @free_func: the function to be called to free each element's data
170 * Convenience method, which frees all the memory used by a #GSList, and
171 * calls the specified destroy function on every element's data.
176 g_slist_free_full (GSList *list,
177 GDestroyNotify free_func)
179 g_slist_foreach (list, (GFunc) free_func, NULL);
186 * @data: the data for the new element
188 * Adds a new element on to the end of the list.
191 * The return value is the new start of the list, which may
192 * have changed, so make sure you store the new value.
196 * Note that g_slist_append() has to traverse the entire list
197 * to find the end, which is inefficient when adding multiple
198 * elements. A common idiom to avoid the inefficiency is to prepend
199 * the elements and reverse the list when all elements have been added.
203 * /* Notice that these are initialized to the empty list. */
204 * GSList *list = NULL, *number_list = NULL;
206 * /* This is a list of strings. */
207 * list = g_slist_append (list, "first");
208 * list = g_slist_append (list, "second");
210 * /* This is a list of integers. */
211 * number_list = g_slist_append (number_list, GINT_TO_POINTER (27));
212 * number_list = g_slist_append (number_list, GINT_TO_POINTER (14));
215 * Returns: the new start of the #GSList
218 g_slist_append (GSList *list,
224 new_list = _g_slist_alloc ();
225 new_list->data = data;
226 new_list->next = NULL;
230 last = g_slist_last (list);
231 /* g_assert (last != NULL); */
232 last->next = new_list;
243 * @data: the data for the new element
245 * Adds a new element on to the start of the list.
248 * The return value is the new start of the list, which
249 * may have changed, so make sure you store the new value.
253 * /* Notice that it is initialized to the empty list. */
254 * GSList *list = NULL;
255 * list = g_slist_prepend (list, "last");
256 * list = g_slist_prepend (list, "first");
259 * Returns: the new start of the #GSList
262 g_slist_prepend (GSList *list,
267 new_list = _g_slist_alloc ();
268 new_list->data = data;
269 new_list->next = list;
277 * @data: the data for the new element
278 * @position: the position to insert the element.
279 * If this is negative, or is larger than the number
280 * of elements in the list, the new element is added on
281 * to the end of the list.
283 * Inserts a new element into the list at the given position.
285 * Returns: the new start of the #GSList
288 g_slist_insert (GSList *list,
297 return g_slist_append (list, data);
298 else if (position == 0)
299 return g_slist_prepend (list, data);
301 new_list = _g_slist_alloc ();
302 new_list->data = data;
306 new_list->next = NULL;
313 while ((position-- > 0) && tmp_list)
315 prev_list = tmp_list;
316 tmp_list = tmp_list->next;
321 new_list->next = prev_list->next;
322 prev_list->next = new_list;
326 new_list->next = list;
334 * g_slist_insert_before:
336 * @sibling: node to insert @data before
337 * @data: data to put in the newly-inserted node
339 * Inserts a node before @sibling containing @data.
341 * Returns: the new head of the list.
344 g_slist_insert_before (GSList *slist,
350 slist = _g_slist_alloc ();
353 g_return_val_if_fail (sibling == NULL, slist);
358 GSList *node, *last = NULL;
360 for (node = slist; node; last = node, node = last->next)
365 node = _g_slist_alloc ();
373 node = _g_slist_alloc ();
375 node->next = last->next;
386 * @list2: the #GSList to add to the end of the first #GSList
388 * Adds the second #GSList onto the end of the first #GSList.
389 * Note that the elements of the second #GSList are not copied.
390 * They are used directly.
392 * Returns: the start of the new #GSList
395 g_slist_concat (GSList *list1, GSList *list2)
400 g_slist_last (list1)->next = list2;
411 * @data: the data of the element to remove
413 * Removes an element from a #GSList.
414 * If two elements contain the same data, only the first is removed.
415 * If none of the elements contain the data, the #GSList is unchanged.
417 * Returns: the new start of the #GSList
420 g_slist_remove (GSList *list,
423 GSList *tmp, *prev = NULL;
428 if (tmp->data == data)
431 prev->next = tmp->next;
435 g_slist_free_1 (tmp);
446 * g_slist_remove_all:
448 * @data: data to remove
450 * Removes all list nodes with data equal to @data.
451 * Returns the new head of the list. Contrast with
452 * g_slist_remove() which removes only the first node
453 * matching the given data.
455 * Returns: new head of @list
458 g_slist_remove_all (GSList *list,
461 GSList *tmp, *prev = NULL;
466 if (tmp->data == data)
468 GSList *next = tmp->next;
475 g_slist_free_1 (tmp);
488 static inline GSList*
489 _g_slist_remove_link (GSList *list,
503 prev->next = tmp->next;
519 * g_slist_remove_link:
521 * @link_: an element in the #GSList
523 * Removes an element from a #GSList, without
524 * freeing the element. The removed element's next
525 * link is set to %NULL, so that it becomes a
526 * self-contained list with one element.
528 * Returns: the new start of the #GSList, without the element
531 g_slist_remove_link (GSList *list,
534 return _g_slist_remove_link (list, link_);
538 * g_slist_delete_link:
540 * @link_: node to delete
542 * Removes the node link_ from the list and frees it.
543 * Compare this to g_slist_remove_link() which removes the node
544 * without freeing it.
546 * Returns: the new head of @list
549 g_slist_delete_link (GSList *list,
552 list = _g_slist_remove_link (list, link_);
553 _g_slist_free1 (link_);
565 * Note that this is a "shallow" copy. If the list elements
566 * consist of pointers to data, the pointers are copied but
567 * the actual data isn't.
570 * Returns: a copy of @list
573 g_slist_copy (GSList *list)
575 GSList *new_list = NULL;
581 new_list = _g_slist_alloc ();
582 new_list->data = list->data;
587 last->next = _g_slist_alloc ();
589 last->data = list->data;
602 * Reverses a #GSList.
604 * Returns: the start of the reversed #GSList
607 g_slist_reverse (GSList *list)
613 GSList *next = list->next;
627 * @n: the position of the element, counting from 0
629 * Gets the element at the given position in a #GSList.
631 * Returns: the element, or %NULL if the position is off
632 * the end of the #GSList
635 g_slist_nth (GSList *list,
638 while (n-- > 0 && list)
647 * @n: the position of the element
649 * Gets the data of the element at the given position.
651 * Returns: the element's data, or %NULL if the position
652 * is off the end of the #GSList
655 g_slist_nth_data (GSList *list,
658 while (n-- > 0 && list)
661 return list ? list->data : NULL;
667 * @data: the element data to find
669 * Finds the element in a #GSList which
670 * contains the given data.
672 * Returns: the found #GSList element,
673 * or %NULL if it is not found
676 g_slist_find (GSList *list,
681 if (list->data == data)
691 * g_slist_find_custom:
693 * @data: user data passed to the function
694 * @func: the function to call for each element.
695 * It should return 0 when the desired element is found
697 * Finds an element in a #GSList, using a supplied function to
698 * find the desired element. It iterates over the list, calling
699 * the given function which should return 0 when the desired
700 * element is found. The function takes two #gconstpointer arguments,
701 * the #GSList element's data as the first argument and the
704 * Returns: the found #GSList element, or %NULL if it is not found
707 g_slist_find_custom (GSList *list,
711 g_return_val_if_fail (func != NULL, list);
715 if (! func (list->data, data))
726 * @llink: an element in the #GSList
728 * Gets the position of the given element
729 * in the #GSList (starting from 0).
731 * Returns: the position of the element in the #GSList,
732 * or -1 if the element is not found
735 g_slist_position (GSList *list,
755 * @data: the data to find
757 * Gets the position of the element containing
758 * the given data (starting from 0).
760 * Returns: the index of the element containing the data,
761 * or -1 if the data is not found
764 g_slist_index (GSList *list,
772 if (list->data == data)
785 * Gets the last element in a #GSList.
788 * This function iterates over the whole list.
791 * Returns: the last element in the #GSList,
792 * or %NULL if the #GSList has no elements
795 g_slist_last (GSList *list)
810 * Gets the number of elements in a #GSList.
813 * This function iterates over the whole list to
814 * count its elements.
817 * Returns: the number of elements in the #GSList
820 g_slist_length (GSList *list)
837 * @func: the function to call with each element's data
838 * @user_data: user data to pass to the function
840 * Calls a function for each element of a #GSList.
843 g_slist_foreach (GSList *list,
849 GSList *next = list->next;
850 (*func) (list->data, user_data);
856 g_slist_insert_sorted_real (GSList *list,
861 GSList *tmp_list = list;
862 GSList *prev_list = NULL;
866 g_return_val_if_fail (func != NULL, list);
870 new_list = _g_slist_alloc ();
871 new_list->data = data;
872 new_list->next = NULL;
876 cmp = ((GCompareDataFunc) func) (data, tmp_list->data, user_data);
878 while ((tmp_list->next) && (cmp > 0))
880 prev_list = tmp_list;
881 tmp_list = tmp_list->next;
883 cmp = ((GCompareDataFunc) func) (data, tmp_list->data, user_data);
886 new_list = _g_slist_alloc ();
887 new_list->data = data;
889 if ((!tmp_list->next) && (cmp > 0))
891 tmp_list->next = new_list;
892 new_list->next = NULL;
898 prev_list->next = new_list;
899 new_list->next = tmp_list;
904 new_list->next = list;
910 * g_slist_insert_sorted:
912 * @data: the data for the new element
913 * @func: the function to compare elements in the list.
914 * It should return a number > 0 if the first parameter
915 * comes after the second parameter in the sort order.
917 * Inserts a new element into the list, using the given
918 * comparison function to determine its position.
920 * Returns: the new start of the #GSList
923 g_slist_insert_sorted (GSList *list,
927 return g_slist_insert_sorted_real (list, data, (GFunc) func, NULL);
931 * g_slist_insert_sorted_with_data:
933 * @data: the data for the new element
934 * @func: the function to compare elements in the list.
935 * It should return a number > 0 if the first parameter
936 * comes after the second parameter in the sort order.
937 * @user_data: data to pass to comparison function
939 * Inserts a new element into the list, using the given
940 * comparison function to determine its position.
942 * Returns: the new start of the #GSList
947 g_slist_insert_sorted_with_data (GSList *list,
949 GCompareDataFunc func,
952 return g_slist_insert_sorted_real (list, data, (GFunc) func, user_data);
956 g_slist_sort_merge (GSList *l1,
968 cmp = ((GCompareDataFunc) compare_func) (l1->data, l2->data, user_data);
981 l->next= l1 ? l1 : l2;
987 g_slist_sort_real (GSList *list,
1001 while ((l2 = l2->next) != NULL)
1003 if ((l2 = l2->next) == NULL)
1010 return g_slist_sort_merge (g_slist_sort_real (list, compare_func, user_data),
1011 g_slist_sort_real (l2, compare_func, user_data),
1019 * @compare_func: the comparison function used to sort the #GSList.
1020 * This function is passed the data from 2 elements of the #GSList
1021 * and should return 0 if they are equal, a negative value if the
1022 * first element comes before the second, or a positive value if
1023 * the first element comes after the second.
1025 * Sorts a #GSList using the given comparison function.
1027 * Returns: the start of the sorted #GSList
1030 g_slist_sort (GSList *list,
1031 GCompareFunc compare_func)
1033 return g_slist_sort_real (list, (GFunc) compare_func, NULL);
1037 * g_slist_sort_with_data:
1039 * @compare_func: comparison function
1040 * @user_data: data to pass to comparison function
1042 * Like g_slist_sort(), but the sort function accepts a user data argument.
1044 * Returns: new head of the list
1047 g_slist_sort_with_data (GSList *list,
1048 GCompareDataFunc compare_func,
1051 return g_slist_sort_real (list, (GFunc) compare_func, user_data);