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.1 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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GLib Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GLib at ftp://ftp.gtk.org/pub/gtk/.
33 #include "gtestutils.h"
37 * SECTION:linked_lists_single
38 * @title: Singly-Linked Lists
39 * @short_description: linked lists that can be iterated in one direction
41 * The #GSList structure and its associated functions provide a
42 * standard singly-linked list data structure.
44 * Each element in the list contains a piece of data, together with a
45 * pointer which links to the next element in the list. Using this
46 * pointer it is possible to move through the list in one direction
47 * only (unlike the [double-linked lists][glib-Doubly-Linked-Lists],
48 * which allow movement in both directions).
50 * The data contained in each element can be either integer values, by
51 * using one of the [Type Conversion Macros][glib-Type-Conversion-Macros],
52 * or simply pointers to any type of data.
54 * List elements are allocated from the [slice allocator][glib-Memory-Slices],
55 * which is more efficient than allocating elements individually.
57 * Note that most of the #GSList functions expect to be passed a
58 * pointer to the first element in the list. The functions which insert
59 * elements return the new start of the list, which may have changed.
61 * There is no function to create a #GSList. %NULL is considered to be
62 * the empty list so you simply set a #GSList* to %NULL.
64 * To add elements, use g_slist_append(), g_slist_prepend(),
65 * g_slist_insert() and g_slist_insert_sorted().
67 * To remove elements, use g_slist_remove().
69 * To find elements in the list use g_slist_last(), g_slist_next(),
70 * g_slist_nth(), g_slist_nth_data(), g_slist_find() and
71 * g_slist_find_custom().
73 * To find the index of an element use g_slist_position() and
76 * To call a function for each element in the list use
79 * To free the entire list, use g_slist_free().
84 * @data: holds the element's data, which can be a pointer to any kind
85 * of data, or any integer value using the
86 * [Type Conversion Macros][glib-Type-Conversion-Macros]
87 * @next: contains the link to the next element in the list.
89 * The #GSList struct is used for each element in the singly-linked
95 * @slist: an element in a #GSList.
97 * A convenience macro to get the next element in a #GSList.
98 * Note that it is considered perfectly acceptable to access
99 * @slist->next directly.
101 * Returns: the next element, or %NULL if there are no more elements.
104 #define _g_slist_alloc0() g_slice_new0 (GSList)
105 #define _g_slist_alloc() g_slice_new (GSList)
106 #define _g_slist_free1(slist) g_slice_free (GSList, slist)
111 * Allocates space for one #GSList element. It is called by the
112 * g_slist_append(), g_slist_prepend(), g_slist_insert() and
113 * g_slist_insert_sorted() functions and so is rarely used on its own.
115 * Returns: a pointer to the newly-allocated #GSList element.
120 return _g_slist_alloc0 ();
127 * Frees all of the memory used by a #GSList.
128 * The freed elements are returned to the slice allocator.
130 * If list elements contain dynamically-allocated memory,
131 * you should either use g_slist_free_full() or free them manually
135 g_slist_free (GSList
*list
)
137 g_slice_free_chain (GSList
, list
, next
);
142 * @list: a #GSList element
144 * Frees one #GSList element.
145 * It is usually used after g_slist_remove_link().
150 * A macro which does the same as g_slist_free_1().
155 g_slist_free_1 (GSList
*list
)
157 _g_slist_free1 (list
);
162 * @list: a pointer to a #GSList
163 * @free_func: the function to be called to free each element's data
165 * Convenience method, which frees all the memory used by a #GSList, and
166 * calls the specified destroy function on every element's data.
168 * @free_func must not modify the list (eg, by removing the freed
174 g_slist_free_full (GSList
*list
,
175 GDestroyNotify free_func
)
177 g_slist_foreach (list
, (GFunc
) free_func
, NULL
);
184 * @data: the data for the new element
186 * Adds a new element on to the end of the list.
188 * The return value is the new start of the list, which may
189 * have changed, so make sure you store the new value.
191 * Note that g_slist_append() has to traverse the entire list
192 * to find the end, which is inefficient when adding multiple
193 * elements. A common idiom to avoid the inefficiency is to prepend
194 * the elements and reverse the list when all elements have been added.
196 * |[<!-- language="C" -->
197 * // Notice that these are initialized to the empty list.
198 * GSList *list = NULL, *number_list = NULL;
200 * // This is a list of strings.
201 * list = g_slist_append (list, "first");
202 * list = g_slist_append (list, "second");
204 * // This is a list of integers.
205 * number_list = g_slist_append (number_list, GINT_TO_POINTER (27));
206 * number_list = g_slist_append (number_list, GINT_TO_POINTER (14));
209 * Returns: the new start of the #GSList
212 g_slist_append (GSList
*list
,
218 new_list
= _g_slist_alloc ();
219 new_list
->data
= data
;
220 new_list
->next
= NULL
;
224 last
= g_slist_last (list
);
225 /* g_assert (last != NULL); */
226 last
->next
= new_list
;
237 * @data: the data for the new element
239 * Adds a new element on to the start of the list.
241 * The return value is the new start of the list, which
242 * may have changed, so make sure you store the new value.
244 * |[<!-- language="C" -->
245 * // Notice that it is initialized to the empty list.
246 * GSList *list = NULL;
247 * list = g_slist_prepend (list, "last");
248 * list = g_slist_prepend (list, "first");
251 * Returns: the new start of the #GSList
254 g_slist_prepend (GSList
*list
,
259 new_list
= _g_slist_alloc ();
260 new_list
->data
= data
;
261 new_list
->next
= list
;
269 * @data: the data for the new element
270 * @position: the position to insert the element.
271 * If this is negative, or is larger than the number
272 * of elements in the list, the new element is added on
273 * to the end of the list.
275 * Inserts a new element into the list at the given position.
277 * Returns: the new start of the #GSList
280 g_slist_insert (GSList
*list
,
289 return g_slist_append (list
, data
);
290 else if (position
== 0)
291 return g_slist_prepend (list
, data
);
293 new_list
= _g_slist_alloc ();
294 new_list
->data
= data
;
298 new_list
->next
= NULL
;
305 while ((position
-- > 0) && tmp_list
)
307 prev_list
= tmp_list
;
308 tmp_list
= tmp_list
->next
;
311 new_list
->next
= prev_list
->next
;
312 prev_list
->next
= new_list
;
318 * g_slist_insert_before:
320 * @sibling: node to insert @data before
321 * @data: data to put in the newly-inserted node
323 * Inserts a node before @sibling containing @data.
325 * Returns: the new head of the list.
328 g_slist_insert_before (GSList
*slist
,
334 slist
= _g_slist_alloc ();
337 g_return_val_if_fail (sibling
== NULL
, slist
);
342 GSList
*node
, *last
= NULL
;
344 for (node
= slist
; node
; last
= node
, node
= last
->next
)
349 node
= _g_slist_alloc ();
357 node
= _g_slist_alloc ();
359 node
->next
= last
->next
;
370 * @list2: the #GSList to add to the end of the first #GSList
372 * Adds the second #GSList onto the end of the first #GSList.
373 * Note that the elements of the second #GSList are not copied.
374 * They are used directly.
376 * Returns: the start of the new #GSList
379 g_slist_concat (GSList
*list1
, GSList
*list2
)
384 g_slist_last (list1
)->next
= list2
;
393 _g_slist_remove_data (GSList
*list
,
398 GSList
**previous_ptr
= &list
;
400 while (*previous_ptr
)
403 if (tmp
->data
== data
)
405 *previous_ptr
= tmp
->next
;
406 g_slist_free_1 (tmp
);
412 previous_ptr
= &tmp
->next
;
421 * @data: the data of the element to remove
423 * Removes an element from a #GSList.
424 * If two elements contain the same data, only the first is removed.
425 * If none of the elements contain the data, the #GSList is unchanged.
427 * Returns: the new start of the #GSList
430 g_slist_remove (GSList
*list
,
433 return _g_slist_remove_data (list
, data
, FALSE
);
437 * g_slist_remove_all:
439 * @data: data to remove
441 * Removes all list nodes with data equal to @data.
442 * Returns the new head of the list. Contrast with
443 * g_slist_remove() which removes only the first node
444 * matching the given data.
446 * Returns: new head of @list
449 g_slist_remove_all (GSList
*list
,
452 return _g_slist_remove_data (list
, data
, TRUE
);
455 static inline GSList
*
456 _g_slist_remove_link (GSList
*list
,
460 GSList
**previous_ptr
= &list
;
462 while (*previous_ptr
)
467 *previous_ptr
= tmp
->next
;
472 previous_ptr
= &tmp
->next
;
479 * g_slist_remove_link:
481 * @link_: an element in the #GSList
483 * Removes an element from a #GSList, without
484 * freeing the element. The removed element's next
485 * link is set to %NULL, so that it becomes a
486 * self-contained list with one element.
488 * Removing arbitrary nodes from a singly-linked list
489 * requires time that is proportional to the length of the list
490 * (ie. O(n)). If you find yourself using g_slist_remove_link()
491 * frequently, you should consider a different data structure,
492 * such as the doubly-linked #GList.
494 * Returns: the new start of the #GSList, without the element
497 g_slist_remove_link (GSList
*list
,
500 return _g_slist_remove_link (list
, link_
);
504 * g_slist_delete_link:
506 * @link_: node to delete
508 * Removes the node link_ from the list and frees it.
509 * Compare this to g_slist_remove_link() which removes the node
510 * without freeing it.
512 * Removing arbitrary nodes from a singly-linked list requires time
513 * that is proportional to the length of the list (ie. O(n)). If you
514 * find yourself using g_slist_delete_link() frequently, you should
515 * consider a different data structure, such as the doubly-linked
518 * Returns: the new head of @list
521 g_slist_delete_link (GSList
*list
,
524 list
= _g_slist_remove_link (list
, link_
);
525 _g_slist_free1 (link_
);
536 * Note that this is a "shallow" copy. If the list elements
537 * consist of pointers to data, the pointers are copied but
538 * the actual data isn't. See g_slist_copy_deep() if you need
539 * to copy the data as well.
541 * Returns: a copy of @list
544 g_slist_copy (GSList
*list
)
546 return g_slist_copy_deep (list
, NULL
, NULL
);
552 * @func: a copy function used to copy every element in the list
553 * @user_data: user data passed to the copy function @func, or #NULL
555 * Makes a full (deep) copy of a #GSList.
557 * In contrast with g_slist_copy(), this function uses @func to make a copy of
558 * each list element, in addition to copying the list container itself.
560 * @func, as a #GCopyFunc, takes two arguments, the data to be copied and a user
561 * pointer. It's safe to pass #NULL as user_data, if the copy function takes only
564 * For instance, if @list holds a list of GObjects, you can do:
565 * |[<!-- language="C" -->
566 * another_list = g_slist_copy_deep (list, (GCopyFunc) g_object_ref, NULL);
569 * And, to entirely free the new list, you could do:
570 * |[<!-- language="C" -->
571 * g_slist_free_full (another_list, g_object_unref);
574 * Returns: a full copy of @list, use #g_slist_free_full to free it
579 g_slist_copy_deep (GSList
*list
, GCopyFunc func
, gpointer user_data
)
581 GSList
*new_list
= NULL
;
587 new_list
= _g_slist_alloc ();
589 new_list
->data
= func (list
->data
, user_data
);
591 new_list
->data
= list
->data
;
596 last
->next
= _g_slist_alloc ();
599 last
->data
= func (list
->data
, user_data
);
601 last
->data
= list
->data
;
614 * Reverses a #GSList.
616 * Returns: the start of the reversed #GSList
619 g_slist_reverse (GSList
*list
)
625 GSList
*next
= list
->next
;
639 * @n: the position of the element, counting from 0
641 * Gets the element at the given position in a #GSList.
643 * Returns: the element, or %NULL if the position is off
644 * the end of the #GSList
647 g_slist_nth (GSList
*list
,
650 while (n
-- > 0 && list
)
659 * @n: the position of the element
661 * Gets the data of the element at the given position.
663 * Returns: the element's data, or %NULL if the position
664 * is off the end of the #GSList
667 g_slist_nth_data (GSList
*list
,
670 while (n
-- > 0 && list
)
673 return list
? list
->data
: NULL
;
679 * @data: the element data to find
681 * Finds the element in a #GSList which
682 * contains the given data.
684 * Returns: the found #GSList element,
685 * or %NULL if it is not found
688 g_slist_find (GSList
*list
,
693 if (list
->data
== data
)
703 * g_slist_find_custom:
705 * @data: user data passed to the function
706 * @func: the function to call for each element.
707 * It should return 0 when the desired element is found
709 * Finds an element in a #GSList, using a supplied function to
710 * find the desired element. It iterates over the list, calling
711 * the given function which should return 0 when the desired
712 * element is found. The function takes two #gconstpointer arguments,
713 * the #GSList element's data as the first argument and the
716 * Returns: the found #GSList element, or %NULL if it is not found
719 g_slist_find_custom (GSList
*list
,
723 g_return_val_if_fail (func
!= NULL
, list
);
727 if (! func (list
->data
, data
))
738 * @llink: an element in the #GSList
740 * Gets the position of the given element
741 * in the #GSList (starting from 0).
743 * Returns: the position of the element in the #GSList,
744 * or -1 if the element is not found
747 g_slist_position (GSList
*list
,
767 * @data: the data to find
769 * Gets the position of the element containing
770 * the given data (starting from 0).
772 * Returns: the index of the element containing the data,
773 * or -1 if the data is not found
776 g_slist_index (GSList
*list
,
784 if (list
->data
== data
)
797 * Gets the last element in a #GSList.
799 * This function iterates over the whole list.
801 * Returns: the last element in the #GSList,
802 * or %NULL if the #GSList has no elements
805 g_slist_last (GSList
*list
)
820 * Gets the number of elements in a #GSList.
822 * This function iterates over the whole list to
823 * count its elements. To check whether the list is non-empty, it is faster to
824 * check @list against %NULL.
826 * Returns: the number of elements in the #GSList
829 g_slist_length (GSList
*list
)
846 * @func: the function to call with each element's data
847 * @user_data: user data to pass to the function
849 * Calls a function for each element of a #GSList.
851 * It is safe for @func to remove the element from @list, but it must
852 * not modify any part of the list after that element.
855 g_slist_foreach (GSList
*list
,
861 GSList
*next
= list
->next
;
862 (*func
) (list
->data
, user_data
);
868 g_slist_insert_sorted_real (GSList
*list
,
873 GSList
*tmp_list
= list
;
874 GSList
*prev_list
= NULL
;
878 g_return_val_if_fail (func
!= NULL
, list
);
882 new_list
= _g_slist_alloc ();
883 new_list
->data
= data
;
884 new_list
->next
= NULL
;
888 cmp
= ((GCompareDataFunc
) func
) (data
, tmp_list
->data
, user_data
);
890 while ((tmp_list
->next
) && (cmp
> 0))
892 prev_list
= tmp_list
;
893 tmp_list
= tmp_list
->next
;
895 cmp
= ((GCompareDataFunc
) func
) (data
, tmp_list
->data
, user_data
);
898 new_list
= _g_slist_alloc ();
899 new_list
->data
= data
;
901 if ((!tmp_list
->next
) && (cmp
> 0))
903 tmp_list
->next
= new_list
;
904 new_list
->next
= NULL
;
910 prev_list
->next
= new_list
;
911 new_list
->next
= tmp_list
;
916 new_list
->next
= list
;
922 * g_slist_insert_sorted:
924 * @data: the data for the new element
925 * @func: the function to compare elements in the list.
926 * It should return a number > 0 if the first parameter
927 * comes after the second parameter in the sort order.
929 * Inserts a new element into the list, using the given
930 * comparison function to determine its position.
932 * Returns: the new start of the #GSList
935 g_slist_insert_sorted (GSList
*list
,
939 return g_slist_insert_sorted_real (list
, data
, (GFunc
) func
, NULL
);
943 * g_slist_insert_sorted_with_data:
945 * @data: the data for the new element
946 * @func: the function to compare elements in the list.
947 * It should return a number > 0 if the first parameter
948 * comes after the second parameter in the sort order.
949 * @user_data: data to pass to comparison function
951 * Inserts a new element into the list, using the given
952 * comparison function to determine its position.
954 * Returns: the new start of the #GSList
959 g_slist_insert_sorted_with_data (GSList
*list
,
961 GCompareDataFunc func
,
964 return g_slist_insert_sorted_real (list
, data
, (GFunc
) func
, user_data
);
968 g_slist_sort_merge (GSList
*l1
,
980 cmp
= ((GCompareDataFunc
) compare_func
) (l1
->data
, l2
->data
, user_data
);
993 l
->next
= l1
? l1
: l2
;
999 g_slist_sort_real (GSList
*list
,
1013 while ((l2
= l2
->next
) != NULL
)
1015 if ((l2
= l2
->next
) == NULL
)
1022 return g_slist_sort_merge (g_slist_sort_real (list
, compare_func
, user_data
),
1023 g_slist_sort_real (l2
, compare_func
, user_data
),
1031 * @compare_func: the comparison function used to sort the #GSList.
1032 * This function is passed the data from 2 elements of the #GSList
1033 * and should return 0 if they are equal, a negative value if the
1034 * first element comes before the second, or a positive value if
1035 * the first element comes after the second.
1037 * Sorts a #GSList using the given comparison function. The algorithm
1038 * used is a stable sort.
1040 * Returns: the start of the sorted #GSList
1043 g_slist_sort (GSList
*list
,
1044 GCompareFunc compare_func
)
1046 return g_slist_sort_real (list
, (GFunc
) compare_func
, NULL
);
1050 * g_slist_sort_with_data:
1052 * @compare_func: comparison function
1053 * @user_data: data to pass to comparison function
1055 * Like g_slist_sort(), but the sort function accepts a user data argument.
1057 * Returns: new head of the list
1060 g_slist_sort_with_data (GSList
*list
,
1061 GCompareDataFunc compare_func
,
1064 return g_slist_sort_real (list
, (GFunc
) compare_func
, user_data
);