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, 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/.
39 #include "gtestutils.h"
41 #include "gmessages.h"
48 * @short_description: arrays of arbitrary elements which grow
49 * automatically as elements are added
51 * Arrays are similar to standard C arrays, except that they grow
52 * automatically as elements are added.
54 * Array elements can be of any size (though all elements of one array
55 * are the same size), and the array can be automatically cleared to
56 * '0's and zero-terminated.
58 * To create a new array use g_array_new().
60 * To add elements to an array, use g_array_append_val(),
61 * g_array_append_vals(), g_array_prepend_val(), and
62 * g_array_prepend_vals().
64 * To access an element of an array, use g_array_index().
66 * To set the size of an array, use g_array_set_size().
68 * To free an array, use g_array_free().
70 * Here is an example that stores integers in a #GArray:
71 * |[<!-- language="C" -->
74 * // We create a new array to store gint values.
75 * // We don't want it zero-terminated or cleared to 0's.
76 * garray = g_array_new (FALSE, FALSE, sizeof (gint));
77 * for (i = 0; i < 10000; i++)
78 * g_array_append_val (garray, i);
79 * for (i = 0; i < 10000; i++)
80 * if (g_array_index (garray, gint, i) != i)
81 * g_print ("ERROR: got %d instead of %d\n",
82 * g_array_index (garray, gint, i), i);
83 * g_array_free (garray, TRUE);
87 #define MIN_ARRAY_SIZE 16
89 typedef struct _GRealArray GRealArray
;
93 * @data: a pointer to the element data. The data may be moved as
94 * elements are added to the #GArray.
95 * @len: the number of elements in the #GArray not including the
96 * possible terminating zero element.
98 * Contains the public fields of a GArray.
106 guint zero_terminated
: 1;
109 GDestroyNotify clear_func
;
115 * @t: the type of the elements
116 * @i: the index of the element to return
118 * Returns the element of a #GArray at the given index. The return
119 * value is cast to the given type.
121 * This example gets a pointer to an element in a #GArray:
122 * |[<!-- language="C" -->
123 * EDayViewEvent *event;
124 * // This gets a pointer to the 4th element in the array of
125 * // EDayViewEvent structs.
126 * event = &g_array_index (events, EDayViewEvent, 3);
129 * Returns: the element of the #GArray at the index given by @i
132 #define g_array_elt_len(array,i) ((array)->elt_size * (i))
133 #define g_array_elt_pos(array,i) ((array)->data + g_array_elt_len((array),(i)))
134 #define g_array_elt_zero(array, pos, len) \
135 (memset (g_array_elt_pos ((array), pos), 0, g_array_elt_len ((array), len)))
136 #define g_array_zero_terminate(array) G_STMT_START{ \
137 if ((array)->zero_terminated) \
138 g_array_elt_zero ((array), (array)->len, 1); \
141 static guint
g_nearest_pow (gint num
) G_GNUC_CONST
;
142 static void g_array_maybe_expand (GRealArray
*array
,
147 * @zero_terminated: %TRUE if the array should have an extra element at
148 * the end which is set to 0
149 * @clear_: %TRUE if #GArray elements should be automatically cleared
150 * to 0 when they are allocated
151 * @element_size: the size of each element in bytes
153 * Creates a new #GArray with a reference count of 1.
155 * Returns: the new #GArray
158 g_array_new (gboolean zero_terminated
,
162 g_return_val_if_fail (elt_size
> 0, NULL
);
164 return g_array_sized_new (zero_terminated
, clear
, elt_size
, 0);
169 * @zero_terminated: %TRUE if the array should have an extra element at
170 * the end with all bits cleared
171 * @clear_: %TRUE if all bits in the array should be cleared to 0 on
173 * @element_size: size of each element in the array
174 * @reserved_size: number of elements preallocated
176 * Creates a new #GArray with @reserved_size elements preallocated and
177 * a reference count of 1. This avoids frequent reallocation, if you
178 * are going to add many elements to the array. Note however that the
179 * size of the array is still 0.
181 * Returns: the new #GArray
184 g_array_sized_new (gboolean zero_terminated
,
191 g_return_val_if_fail (elt_size
> 0, NULL
);
193 array
= g_slice_new (GRealArray
);
198 array
->zero_terminated
= (zero_terminated
? 1 : 0);
199 array
->clear
= (clear
? 1 : 0);
200 array
->elt_size
= elt_size
;
201 array
->ref_count
= 1;
202 array
->clear_func
= NULL
;
204 if (array
->zero_terminated
|| reserved_size
!= 0)
206 g_array_maybe_expand (array
, reserved_size
);
207 g_array_zero_terminate(array
);
210 return (GArray
*) array
;
214 * g_array_set_clear_func:
216 * @clear_func: a function to clear an element of @array
218 * Sets a function to clear an element of @array.
220 * The @clear_func will be called when an element in the array
221 * data segment is removed and when the array is freed and data
222 * segment is deallocated as well.
224 * Note that in contrast with other uses of #GDestroyNotify
225 * functions, @clear_func is expected to clear the contents of
226 * the array element it is given, but not free the element itself.
231 g_array_set_clear_func (GArray
*array
,
232 GDestroyNotify clear_func
)
234 GRealArray
*rarray
= (GRealArray
*) array
;
236 g_return_if_fail (array
!= NULL
);
238 rarray
->clear_func
= clear_func
;
245 * Atomically increments the reference count of @array by one.
246 * This function is MT-safe and may be called from any thread.
248 * Returns: The passed in #GArray
253 g_array_ref (GArray
*array
)
255 GRealArray
*rarray
= (GRealArray
*) array
;
256 g_return_val_if_fail (array
, NULL
);
258 g_atomic_int_inc (&rarray
->ref_count
);
265 FREE_SEGMENT
= 1 << 0,
266 PRESERVE_WRAPPER
= 1 << 1
269 static gchar
*array_free (GRealArray
*, ArrayFreeFlags
);
275 * Atomically decrements the reference count of @array by one. If the
276 * reference count drops to 0, all memory allocated by the array is
277 * released. This function is MT-safe and may be called from any
283 g_array_unref (GArray
*array
)
285 GRealArray
*rarray
= (GRealArray
*) array
;
286 g_return_if_fail (array
);
288 if (g_atomic_int_dec_and_test (&rarray
->ref_count
))
289 array_free (rarray
, FREE_SEGMENT
);
293 * g_array_get_element_size:
296 * Gets the size of the elements in @array.
298 * Returns: Size of each element, in bytes
303 g_array_get_element_size (GArray
*array
)
305 GRealArray
*rarray
= (GRealArray
*) array
;
307 g_return_val_if_fail (array
, 0);
309 return rarray
->elt_size
;
315 * @free_segment: if %TRUE the actual element data is freed as well
317 * Frees the memory allocated for the #GArray. If @free_segment is
318 * %TRUE it frees the memory block holding the elements as well and
319 * also each element if @array has a @element_free_func set. Pass
320 * %FALSE if you want to free the #GArray wrapper but preserve the
321 * underlying array for use elsewhere. If the reference count of @array
322 * is greater than one, the #GArray wrapper is preserved but the size
323 * of @array will be set to zero.
325 * If array elements contain dynamically-allocated memory, they should
326 * be freed separately.
328 * Returns: the element data if @free_segment is %FALSE, otherwise
329 * %NULL. The element data should be freed using g_free().
332 g_array_free (GArray
*farray
,
333 gboolean free_segment
)
335 GRealArray
*array
= (GRealArray
*) farray
;
336 ArrayFreeFlags flags
;
338 g_return_val_if_fail (array
, NULL
);
340 flags
= (free_segment
? FREE_SEGMENT
: 0);
342 /* if others are holding a reference, preserve the wrapper but do free/return the data */
343 if (!g_atomic_int_dec_and_test (&array
->ref_count
))
344 flags
|= PRESERVE_WRAPPER
;
346 return array_free (array
, flags
);
350 array_free (GRealArray
*array
,
351 ArrayFreeFlags flags
)
355 if (flags
& FREE_SEGMENT
)
357 if (array
->clear_func
!= NULL
)
361 for (i
= 0; i
< array
->len
; i
++)
362 array
->clear_func (g_array_elt_pos (array
, i
));
365 g_free (array
->data
);
369 segment
= (gchar
*) array
->data
;
371 if (flags
& PRESERVE_WRAPPER
)
379 g_slice_free1 (sizeof (GRealArray
), array
);
386 * g_array_append_vals:
388 * @data: a pointer to the elements to append to the end of the array
389 * @len: the number of elements to append
391 * Adds @len elements onto the end of the array.
393 * Returns: the #GArray
396 * g_array_append_val:
398 * @v: the value to append to the #GArray
400 * Adds the value on to the end of the array. The array will grow in
401 * size automatically if necessary.
403 * g_array_append_val() is a macro which uses a reference to the value
404 * parameter @v. This means that you cannot use it with literal values
405 * such as "27". You must use variables.
407 * Returns: the #GArray
410 g_array_append_vals (GArray
*farray
,
414 GRealArray
*array
= (GRealArray
*) farray
;
416 g_return_val_if_fail (array
, NULL
);
418 g_array_maybe_expand (array
, len
);
420 memcpy (g_array_elt_pos (array
, array
->len
), data
,
421 g_array_elt_len (array
, len
));
425 g_array_zero_terminate (array
);
431 * g_array_prepend_vals:
433 * @data: a pointer to the elements to prepend to the start of the array
434 * @len: the number of elements to prepend
436 * Adds @len elements onto the start of the array.
438 * This operation is slower than g_array_append_vals() since the
439 * existing elements in the array have to be moved to make space for
442 * Returns: the #GArray
445 * g_array_prepend_val:
447 * @v: the value to prepend to the #GArray
449 * Adds the value on to the start of the array. The array will grow in
450 * size automatically if necessary.
452 * This operation is slower than g_array_append_val() since the
453 * existing elements in the array have to be moved to make space for
456 * g_array_prepend_val() is a macro which uses a reference to the value
457 * parameter @v. This means that you cannot use it with literal values
458 * such as "27". You must use variables.
460 * Returns: the #GArray
463 g_array_prepend_vals (GArray
*farray
,
467 GRealArray
*array
= (GRealArray
*) farray
;
469 g_return_val_if_fail (array
, NULL
);
471 g_array_maybe_expand (array
, len
);
473 memmove (g_array_elt_pos (array
, len
), g_array_elt_pos (array
, 0),
474 g_array_elt_len (array
, array
->len
));
476 memcpy (g_array_elt_pos (array
, 0), data
, g_array_elt_len (array
, len
));
480 g_array_zero_terminate (array
);
486 * g_array_insert_vals:
488 * @index_: the index to place the elements at
489 * @data: a pointer to the elements to insert
490 * @len: the number of elements to insert
492 * Inserts @len elements into a #GArray at the given index.
494 * Returns: the #GArray
497 * g_array_insert_val:
499 * @i: the index to place the element at
500 * @v: the value to insert into the array
502 * Inserts an element into an array at the given index.
504 * g_array_insert_val() is a macro which uses a reference to the value
505 * parameter @v. This means that you cannot use it with literal values
506 * such as "27". You must use variables.
508 * Returns: the #GArray
511 g_array_insert_vals (GArray
*farray
,
516 GRealArray
*array
= (GRealArray
*) farray
;
518 g_return_val_if_fail (array
, NULL
);
520 g_array_maybe_expand (array
, len
);
522 memmove (g_array_elt_pos (array
, len
+ index_
),
523 g_array_elt_pos (array
, index_
),
524 g_array_elt_len (array
, array
->len
- index_
));
526 memcpy (g_array_elt_pos (array
, index_
), data
, g_array_elt_len (array
, len
));
530 g_array_zero_terminate (array
);
538 * @length: the new size of the #GArray
540 * Sets the size of the array, expanding it if necessary. If the array
541 * was created with @clear_ set to %TRUE, the new elements are set to 0.
543 * Returns: the #GArray
546 g_array_set_size (GArray
*farray
,
549 GRealArray
*array
= (GRealArray
*) farray
;
551 g_return_val_if_fail (array
, NULL
);
553 if (length
> array
->len
)
555 g_array_maybe_expand (array
, length
- array
->len
);
558 g_array_elt_zero (array
, array
->len
, length
- array
->len
);
560 else if (length
< array
->len
)
561 g_array_remove_range (farray
, length
, array
->len
- length
);
565 g_array_zero_terminate (array
);
571 * g_array_remove_index:
573 * @index_: the index of the element to remove
575 * Removes the element at the given index from a #GArray. The following
576 * elements are moved down one place.
578 * Returns: the #GArray
581 g_array_remove_index (GArray
*farray
,
584 GRealArray
* array
= (GRealArray
*) farray
;
586 g_return_val_if_fail (array
, NULL
);
588 g_return_val_if_fail (index_
< array
->len
, NULL
);
590 if (array
->clear_func
!= NULL
)
591 array
->clear_func (g_array_elt_pos (array
, index_
));
593 if (index_
!= array
->len
- 1)
594 memmove (g_array_elt_pos (array
, index_
),
595 g_array_elt_pos (array
, index_
+ 1),
596 g_array_elt_len (array
, array
->len
- index_
- 1));
600 if (G_UNLIKELY (g_mem_gc_friendly
))
601 g_array_elt_zero (array
, array
->len
, 1);
603 g_array_zero_terminate (array
);
609 * g_array_remove_index_fast:
611 * @index_: the index of the element to remove
613 * Removes the element at the given index from a #GArray. The last
614 * element in the array is used to fill in the space, so this function
615 * does not preserve the order of the #GArray. But it is faster than
616 * g_array_remove_index().
618 * Returns: the #GArray
621 g_array_remove_index_fast (GArray
*farray
,
624 GRealArray
* array
= (GRealArray
*) farray
;
626 g_return_val_if_fail (array
, NULL
);
628 g_return_val_if_fail (index_
< array
->len
, NULL
);
630 if (array
->clear_func
!= NULL
)
631 array
->clear_func (g_array_elt_pos (array
, index_
));
633 if (index_
!= array
->len
- 1)
634 memcpy (g_array_elt_pos (array
, index_
),
635 g_array_elt_pos (array
, array
->len
- 1),
636 g_array_elt_len (array
, 1));
640 if (G_UNLIKELY (g_mem_gc_friendly
))
641 g_array_elt_zero (array
, array
->len
, 1);
643 g_array_zero_terminate (array
);
649 * g_array_remove_range:
651 * @index_: the index of the first element to remove
652 * @length: the number of elements to remove
654 * Removes the given number of elements starting at the given index
655 * from a #GArray. The following elements are moved to close the gap.
657 * Returns: the #GArray
662 g_array_remove_range (GArray
*farray
,
666 GRealArray
*array
= (GRealArray
*) farray
;
668 g_return_val_if_fail (array
, NULL
);
669 g_return_val_if_fail (index_
< array
->len
, NULL
);
670 g_return_val_if_fail (index_
+ length
<= array
->len
, NULL
);
672 if (array
->clear_func
!= NULL
)
676 for (i
= 0; i
< length
; i
++)
677 array
->clear_func (g_array_elt_pos (array
, index_
+ i
));
680 if (index_
+ length
!= array
->len
)
681 memmove (g_array_elt_pos (array
, index_
),
682 g_array_elt_pos (array
, index_
+ length
),
683 (array
->len
- (index_
+ length
)) * array
->elt_size
);
685 array
->len
-= length
;
686 if (G_UNLIKELY (g_mem_gc_friendly
))
687 g_array_elt_zero (array
, array
->len
, length
);
689 g_array_zero_terminate (array
);
697 * @compare_func: comparison function
699 * Sorts a #GArray using @compare_func which should be a qsort()-style
700 * comparison function (returns less than zero for first arg is less
701 * than second arg, zero for equal, greater zero if first arg is
702 * greater than second arg).
704 * This is guaranteed to be a stable sort since version 2.32.
707 g_array_sort (GArray
*farray
,
708 GCompareFunc compare_func
)
710 GRealArray
*array
= (GRealArray
*) farray
;
712 g_return_if_fail (array
!= NULL
);
714 /* Don't use qsort as we want a guaranteed stable sort */
715 g_qsort_with_data (array
->data
,
718 (GCompareDataFunc
)compare_func
,
723 * g_array_sort_with_data:
725 * @compare_func: comparison function
726 * @user_data: data to pass to @compare_func
728 * Like g_array_sort(), but the comparison function receives an extra
729 * user data argument.
731 * This is guaranteed to be a stable sort since version 2.32.
733 * There used to be a comment here about making the sort stable by
734 * using the addresses of the elements in the comparison function.
735 * This did not actually work, so any such code should be removed.
738 g_array_sort_with_data (GArray
*farray
,
739 GCompareDataFunc compare_func
,
742 GRealArray
*array
= (GRealArray
*) farray
;
744 g_return_if_fail (array
!= NULL
);
746 g_qsort_with_data (array
->data
,
753 /* Returns the smallest power of 2 greater than n, or n if
754 * such power does not fit in a guint
757 g_nearest_pow (gint num
)
761 while (n
< num
&& n
> 0)
768 g_array_maybe_expand (GRealArray
*array
,
771 guint want_alloc
= g_array_elt_len (array
, array
->len
+ len
+
772 array
->zero_terminated
);
774 if (want_alloc
> array
->alloc
)
776 want_alloc
= g_nearest_pow (want_alloc
);
777 want_alloc
= MAX (want_alloc
, MIN_ARRAY_SIZE
);
779 array
->data
= g_realloc (array
->data
, want_alloc
);
781 if (G_UNLIKELY (g_mem_gc_friendly
))
782 memset (array
->data
+ array
->alloc
, 0, want_alloc
- array
->alloc
);
784 array
->alloc
= want_alloc
;
789 * SECTION:arrays_pointer
790 * @title: Pointer Arrays
791 * @short_description: arrays of pointers to any type of data, which
792 * grow automatically as new elements are added
794 * Pointer Arrays are similar to Arrays but are used only for storing
797 * If you remove elements from the array, elements at the end of the
798 * array are moved into the space previously occupied by the removed
799 * element. This means that you should not rely on the index of particular
800 * elements remaining the same. You should also be careful when deleting
801 * elements while iterating over the array.
803 * To create a pointer array, use g_ptr_array_new().
805 * To add elements to a pointer array, use g_ptr_array_add().
807 * To remove elements from a pointer array, use g_ptr_array_remove(),
808 * g_ptr_array_remove_index() or g_ptr_array_remove_index_fast().
810 * To access an element of a pointer array, use g_ptr_array_index().
812 * To set the size of a pointer array, use g_ptr_array_set_size().
814 * To free a pointer array, use g_ptr_array_free().
816 * An example using a #GPtrArray:
817 * |[<!-- language="C" -->
819 * gchar *string1 = "one";
820 * gchar *string2 = "two";
821 * gchar *string3 = "three";
823 * array = g_ptr_array_new ();
824 * g_ptr_array_add (array, (gpointer) string1);
825 * g_ptr_array_add (array, (gpointer) string2);
826 * g_ptr_array_add (array, (gpointer) string3);
828 * if (g_ptr_array_index (array, 0) != (gpointer) string1)
829 * g_print ("ERROR: got %p instead of %p\n",
830 * g_ptr_array_index (array, 0), string1);
832 * g_ptr_array_free (array, TRUE);
836 typedef struct _GRealPtrArray GRealPtrArray
;
840 * @pdata: points to the array of pointers, which may be moved when the
842 * @len: number of pointers in the array
844 * Contains the public fields of a pointer array.
846 struct _GRealPtrArray
852 GDestroyNotify element_free_func
;
857 * @array: a #GPtrArray
858 * @index_: the index of the pointer to return
860 * Returns the pointer at the given index of the pointer array.
862 * This does not perform bounds checking on the given @index_,
863 * so you are responsible for checking it against the array length.
865 * Returns: the pointer at the given index
868 static void g_ptr_array_maybe_expand (GRealPtrArray
*array
,
874 * Creates a new #GPtrArray with a reference count of 1.
876 * Returns: the new #GPtrArray
879 g_ptr_array_new (void)
881 return g_ptr_array_sized_new (0);
885 * g_ptr_array_sized_new:
886 * @reserved_size: number of pointers preallocated
888 * Creates a new #GPtrArray with @reserved_size pointers preallocated
889 * and a reference count of 1. This avoids frequent reallocation, if
890 * you are going to add many pointers to the array. Note however that
891 * the size of the array is still 0.
893 * Returns: the new #GPtrArray
896 g_ptr_array_sized_new (guint reserved_size
)
898 GRealPtrArray
*array
;
900 array
= g_slice_new (GRealPtrArray
);
905 array
->ref_count
= 1;
906 array
->element_free_func
= NULL
;
908 if (reserved_size
!= 0)
909 g_ptr_array_maybe_expand (array
, reserved_size
);
911 return (GPtrArray
*) array
;
915 * g_ptr_array_new_with_free_func:
916 * @element_free_func: (allow-none): A function to free elements with
917 * destroy @array or %NULL
919 * Creates a new #GPtrArray with a reference count of 1 and use
920 * @element_free_func for freeing each element when the array is destroyed
921 * either via g_ptr_array_unref(), when g_ptr_array_free() is called with
922 * @free_segment set to %TRUE or when removing elements.
924 * Returns: A new #GPtrArray
929 g_ptr_array_new_with_free_func (GDestroyNotify element_free_func
)
933 array
= g_ptr_array_new ();
934 g_ptr_array_set_free_func (array
, element_free_func
);
940 * g_ptr_array_new_full:
941 * @reserved_size: number of pointers preallocated
942 * @element_free_func: (allow-none): A function to free elements with
943 * destroy @array or %NULL
945 * Creates a new #GPtrArray with @reserved_size pointers preallocated
946 * and a reference count of 1. This avoids frequent reallocation, if
947 * you are going to add many pointers to the array. Note however that
948 * the size of the array is still 0. It also set @element_free_func
949 * for freeing each element when the array is destroyed either via
950 * g_ptr_array_unref(), when g_ptr_array_free() is called with
951 * @free_segment set to %TRUE or when removing elements.
953 * Returns: A new #GPtrArray
958 g_ptr_array_new_full (guint reserved_size
,
959 GDestroyNotify element_free_func
)
963 array
= g_ptr_array_sized_new (reserved_size
);
964 g_ptr_array_set_free_func (array
, element_free_func
);
970 * g_ptr_array_set_free_func:
971 * @array: A #GPtrArray
972 * @element_free_func: (allow-none): A function to free elements with
973 * destroy @array or %NULL
975 * Sets a function for freeing each element when @array is destroyed
976 * either via g_ptr_array_unref(), when g_ptr_array_free() is called
977 * with @free_segment set to %TRUE or when removing elements.
982 g_ptr_array_set_free_func (GPtrArray
*array
,
983 GDestroyNotify element_free_func
)
985 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
987 g_return_if_fail (array
);
989 rarray
->element_free_func
= element_free_func
;
994 * @array: a #GPtrArray
996 * Atomically increments the reference count of @array by one.
997 * This function is thread-safe and may be called from any thread.
999 * Returns: The passed in #GPtrArray
1004 g_ptr_array_ref (GPtrArray
*array
)
1006 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1008 g_return_val_if_fail (array
, NULL
);
1010 g_atomic_int_inc (&rarray
->ref_count
);
1015 static gpointer
*ptr_array_free (GPtrArray
*, ArrayFreeFlags
);
1018 * g_ptr_array_unref:
1019 * @array: A #GPtrArray
1021 * Atomically decrements the reference count of @array by one. If the
1022 * reference count drops to 0, the effect is the same as calling
1023 * g_ptr_array_free() with @free_segment set to %TRUE. This function
1024 * is MT-safe and may be called from any thread.
1029 g_ptr_array_unref (GPtrArray
*array
)
1031 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1033 g_return_if_fail (array
);
1035 if (g_atomic_int_dec_and_test (&rarray
->ref_count
))
1036 ptr_array_free (array
, FREE_SEGMENT
);
1041 * @array: a #GPtrArray
1042 * @free_seg: if %TRUE the actual pointer array is freed as well
1044 * Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE
1045 * it frees the memory block holding the elements as well. Pass %FALSE
1046 * if you want to free the #GPtrArray wrapper but preserve the
1047 * underlying array for use elsewhere. If the reference count of @array
1048 * is greater than one, the #GPtrArray wrapper is preserved but the
1049 * size of @array will be set to zero.
1051 * If array contents point to dynamically-allocated memory, they should
1052 * be freed separately if @free_seg is %TRUE and no #GDestroyNotify
1053 * function has been set for @array.
1055 * Returns: the pointer array if @free_seg is %FALSE, otherwise %NULL.
1056 * The pointer array should be freed using g_free().
1059 g_ptr_array_free (GPtrArray
*array
,
1060 gboolean free_segment
)
1062 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1063 ArrayFreeFlags flags
;
1065 g_return_val_if_fail (rarray
, NULL
);
1067 flags
= (free_segment
? FREE_SEGMENT
: 0);
1069 /* if others are holding a reference, preserve the wrapper but
1070 * do free/return the data
1072 if (!g_atomic_int_dec_and_test (&rarray
->ref_count
))
1073 flags
|= PRESERVE_WRAPPER
;
1075 return ptr_array_free (array
, flags
);
1079 ptr_array_free (GPtrArray
*array
,
1080 ArrayFreeFlags flags
)
1082 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1085 if (flags
& FREE_SEGMENT
)
1087 if (rarray
->element_free_func
!= NULL
)
1088 g_ptr_array_foreach (array
, (GFunc
) rarray
->element_free_func
, NULL
);
1089 g_free (rarray
->pdata
);
1093 segment
= rarray
->pdata
;
1095 if (flags
& PRESERVE_WRAPPER
)
1097 rarray
->pdata
= NULL
;
1103 g_slice_free1 (sizeof (GRealPtrArray
), rarray
);
1110 g_ptr_array_maybe_expand (GRealPtrArray
*array
,
1113 if ((array
->len
+ len
) > array
->alloc
)
1115 guint old_alloc
= array
->alloc
;
1116 array
->alloc
= g_nearest_pow (array
->len
+ len
);
1117 array
->alloc
= MAX (array
->alloc
, MIN_ARRAY_SIZE
);
1118 array
->pdata
= g_realloc (array
->pdata
, sizeof (gpointer
) * array
->alloc
);
1119 if (G_UNLIKELY (g_mem_gc_friendly
))
1120 for ( ; old_alloc
< array
->alloc
; old_alloc
++)
1121 array
->pdata
[old_alloc
] = NULL
;
1126 * g_ptr_array_set_size:
1127 * @array: a #GPtrArray
1128 * @length: the new length of the pointer array
1130 * Sets the size of the array. When making the array larger,
1131 * newly-added elements will be set to %NULL. When making it smaller,
1132 * if @array has a non-%NULL #GDestroyNotify function then it will be
1133 * called for the removed elements.
1136 g_ptr_array_set_size (GPtrArray
*array
,
1139 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1141 g_return_if_fail (rarray
);
1143 if (length
> rarray
->len
)
1146 g_ptr_array_maybe_expand (rarray
, (length
- rarray
->len
));
1148 * memset (array->pdata + array->len, 0,
1149 * sizeof (gpointer) * (length - array->len));
1150 * to make it really portable. Remember (void*)NULL needn't be
1151 * bitwise zero. It of course is silly not to use memset (..,0,..).
1153 for (i
= rarray
->len
; i
< length
; i
++)
1154 rarray
->pdata
[i
] = NULL
;
1156 else if (length
< rarray
->len
)
1157 g_ptr_array_remove_range (array
, length
, rarray
->len
- length
);
1159 rarray
->len
= length
;
1163 * g_ptr_array_remove_index:
1164 * @array: a #GPtrArray
1165 * @index_: the index of the pointer to remove
1167 * Removes the pointer at the given index from the pointer array.
1168 * The following elements are moved down one place. If @array has
1169 * a non-%NULL #GDestroyNotify function it is called for the removed
1172 * Returns: the pointer which was removed
1175 g_ptr_array_remove_index (GPtrArray
*array
,
1178 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1181 g_return_val_if_fail (rarray
, NULL
);
1183 g_return_val_if_fail (index_
< rarray
->len
, NULL
);
1185 result
= rarray
->pdata
[index_
];
1187 if (rarray
->element_free_func
!= NULL
)
1188 rarray
->element_free_func (rarray
->pdata
[index_
]);
1190 if (index_
!= rarray
->len
- 1)
1191 memmove (rarray
->pdata
+ index_
, rarray
->pdata
+ index_
+ 1,
1192 sizeof (gpointer
) * (rarray
->len
- index_
- 1));
1196 if (G_UNLIKELY (g_mem_gc_friendly
))
1197 rarray
->pdata
[rarray
->len
] = NULL
;
1203 * g_ptr_array_remove_index_fast:
1204 * @array: a #GPtrArray
1205 * @index_: the index of the pointer to remove
1207 * Removes the pointer at the given index from the pointer array.
1208 * The last element in the array is used to fill in the space, so
1209 * this function does not preserve the order of the array. But it
1210 * is faster than g_ptr_array_remove_index(). If @array has a non-%NULL
1211 * #GDestroyNotify function it is called for the removed element.
1213 * Returns: the pointer which was removed
1216 g_ptr_array_remove_index_fast (GPtrArray
*array
,
1219 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1222 g_return_val_if_fail (rarray
, NULL
);
1224 g_return_val_if_fail (index_
< rarray
->len
, NULL
);
1226 result
= rarray
->pdata
[index_
];
1228 if (rarray
->element_free_func
!= NULL
)
1229 rarray
->element_free_func (rarray
->pdata
[index_
]);
1231 if (index_
!= rarray
->len
- 1)
1232 rarray
->pdata
[index_
] = rarray
->pdata
[rarray
->len
- 1];
1236 if (G_UNLIKELY (g_mem_gc_friendly
))
1237 rarray
->pdata
[rarray
->len
] = NULL
;
1243 * g_ptr_array_remove_range:
1244 * @array: a @GPtrArray
1245 * @index_: the index of the first pointer to remove
1246 * @length: the number of pointers to remove
1248 * Removes the given number of pointers starting at the given index
1249 * from a #GPtrArray. The following elements are moved to close the
1250 * gap. If @array has a non-%NULL #GDestroyNotify function it is
1251 * called for the removed elements.
1253 * Returns: the @array
1258 g_ptr_array_remove_range (GPtrArray
*array
,
1262 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1265 g_return_val_if_fail (rarray
!= NULL
, NULL
);
1266 g_return_val_if_fail (index_
< rarray
->len
, NULL
);
1267 g_return_val_if_fail (index_
+ length
<= rarray
->len
, NULL
);
1269 if (rarray
->element_free_func
!= NULL
)
1271 for (n
= index_
; n
< index_
+ length
; n
++)
1272 rarray
->element_free_func (rarray
->pdata
[n
]);
1275 if (index_
+ length
!= rarray
->len
)
1277 memmove (&rarray
->pdata
[index_
],
1278 &rarray
->pdata
[index_
+ length
],
1279 (rarray
->len
- (index_
+ length
)) * sizeof (gpointer
));
1282 rarray
->len
-= length
;
1283 if (G_UNLIKELY (g_mem_gc_friendly
))
1286 for (i
= 0; i
< length
; i
++)
1287 rarray
->pdata
[rarray
->len
+ i
] = NULL
;
1294 * g_ptr_array_remove:
1295 * @array: a #GPtrArray
1296 * @data: the pointer to remove
1298 * Removes the first occurrence of the given pointer from the pointer
1299 * array. The following elements are moved down one place. If @array
1300 * has a non-%NULL #GDestroyNotify function it is called for the
1303 * It returns %TRUE if the pointer was removed, or %FALSE if the
1304 * pointer was not found.
1306 * Returns: %TRUE if the pointer is removed, %FALSE if the pointer
1307 * is not found in the array
1310 g_ptr_array_remove (GPtrArray
*array
,
1315 g_return_val_if_fail (array
, FALSE
);
1317 for (i
= 0; i
< array
->len
; i
+= 1)
1319 if (array
->pdata
[i
] == data
)
1321 g_ptr_array_remove_index (array
, i
);
1330 * g_ptr_array_remove_fast:
1331 * @array: a #GPtrArray
1332 * @data: the pointer to remove
1334 * Removes the first occurrence of the given pointer from the pointer
1335 * array. The last element in the array is used to fill in the space,
1336 * so this function does not preserve the order of the array. But it
1337 * is faster than g_ptr_array_remove(). If @array has a non-%NULL
1338 * #GDestroyNotify function it is called for the removed element.
1340 * It returns %TRUE if the pointer was removed, or %FALSE if the
1341 * pointer was not found.
1343 * Returns: %TRUE if the pointer was found in the array
1346 g_ptr_array_remove_fast (GPtrArray
*array
,
1349 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1352 g_return_val_if_fail (rarray
, FALSE
);
1354 for (i
= 0; i
< rarray
->len
; i
+= 1)
1356 if (rarray
->pdata
[i
] == data
)
1358 g_ptr_array_remove_index_fast (array
, i
);
1368 * @array: a #GPtrArray
1369 * @data: the pointer to add
1371 * Adds a pointer to the end of the pointer array. The array will grow
1372 * in size automatically if necessary.
1375 g_ptr_array_add (GPtrArray
*array
,
1378 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1380 g_return_if_fail (rarray
);
1382 g_ptr_array_maybe_expand (rarray
, 1);
1384 rarray
->pdata
[rarray
->len
++] = data
;
1388 * g_ptr_array_insert:
1389 * @array: a #GPtrArray
1390 * @index_: the index to place the new element at, or -1 to append
1391 * @data: the pointer to add.
1393 * Inserts an element into the pointer array at the given index. The
1394 * array will grow in size automatically if necessary.
1399 g_ptr_array_insert (GPtrArray
*array
,
1403 GRealPtrArray
*rarray
= (GRealPtrArray
*)array
;
1405 g_return_if_fail (rarray
);
1406 g_return_if_fail (index_
>= -1);
1407 g_return_if_fail (index_
<= (gint
)rarray
->len
);
1409 g_ptr_array_maybe_expand (rarray
, 1);
1412 index_
= rarray
->len
;
1414 if (index_
< rarray
->len
)
1415 memmove (&(rarray
->pdata
[index_
+ 1]),
1416 &(rarray
->pdata
[index_
]),
1417 (rarray
->len
- index_
) * sizeof (gpointer
));
1420 rarray
->pdata
[index_
] = data
;
1425 * @array: a #GPtrArray
1426 * @compare_func: comparison function
1428 * Sorts the array, using @compare_func which should be a qsort()-style
1429 * comparison function (returns less than zero for first arg is less
1430 * than second arg, zero for equal, greater than zero if irst arg is
1431 * greater than second arg).
1433 * Note that the comparison function for g_ptr_array_sort() doesn't
1434 * take the pointers from the array as arguments, it takes pointers to
1435 * the pointers in the array.
1437 * This is guaranteed to be a stable sort since version 2.32.
1440 g_ptr_array_sort (GPtrArray
*array
,
1441 GCompareFunc compare_func
)
1443 g_return_if_fail (array
!= NULL
);
1445 /* Don't use qsort as we want a guaranteed stable sort */
1446 g_qsort_with_data (array
->pdata
,
1449 (GCompareDataFunc
)compare_func
,
1454 * g_ptr_array_sort_with_data:
1455 * @array: a #GPtrArray
1456 * @compare_func: comparison function
1457 * @user_data: data to pass to @compare_func
1459 * Like g_ptr_array_sort(), but the comparison function has an extra
1460 * user data argument.
1462 * Note that the comparison function for g_ptr_array_sort_with_data()
1463 * doesn't take the pointers from the array as arguments, it takes
1464 * pointers to the pointers in the array.
1466 * This is guaranteed to be a stable sort since version 2.32.
1469 g_ptr_array_sort_with_data (GPtrArray
*array
,
1470 GCompareDataFunc compare_func
,
1473 g_return_if_fail (array
!= NULL
);
1475 g_qsort_with_data (array
->pdata
,
1483 * g_ptr_array_foreach:
1484 * @array: a #GPtrArray
1485 * @func: the function to call for each array element
1486 * @user_data: user data to pass to the function
1488 * Calls a function for each element of a #GPtrArray.
1493 g_ptr_array_foreach (GPtrArray
*array
,
1499 g_return_if_fail (array
);
1501 for (i
= 0; i
< array
->len
; i
++)
1502 (*func
) (array
->pdata
[i
], user_data
);
1506 * SECTION:arrays_byte
1507 * @title: Byte Arrays
1508 * @short_description: arrays of bytes
1510 * #GByteArray is a mutable array of bytes based on #GArray, to provide arrays
1511 * of bytes which grow automatically as elements are added.
1513 * To create a new #GByteArray use g_byte_array_new(). To add elements to a
1514 * #GByteArray, use g_byte_array_append(), and g_byte_array_prepend().
1516 * To set the size of a #GByteArray, use g_byte_array_set_size().
1518 * To free a #GByteArray, use g_byte_array_free().
1520 * An example for using a #GByteArray:
1521 * |[<!-- language="C" -->
1522 * GByteArray *gbarray;
1525 * gbarray = g_byte_array_new ();
1526 * for (i = 0; i < 10000; i++)
1527 * g_byte_array_append (gbarray, (guint8*) "abcd", 4);
1529 * for (i = 0; i < 10000; i++)
1531 * g_assert (gbarray->data[4*i] == 'a');
1532 * g_assert (gbarray->data[4*i+1] == 'b');
1533 * g_assert (gbarray->data[4*i+2] == 'c');
1534 * g_assert (gbarray->data[4*i+3] == 'd');
1537 * g_byte_array_free (gbarray, TRUE);
1540 * See #GBytes if you are interested in an immutable object representing a
1541 * sequence of bytes.
1546 * @data: a pointer to the element data. The data may be moved as
1547 * elements are added to the #GByteArray
1548 * @len: the number of elements in the #GByteArray
1550 * Contains the public fields of a GByteArray.
1556 * Creates a new #GByteArray with a reference count of 1.
1558 * Returns: (transfer full): the new #GByteArray
1561 g_byte_array_new (void)
1563 return (GByteArray
*)g_array_sized_new (FALSE
, FALSE
, 1, 0);
1567 * g_byte_array_new_take:
1568 * @data: (transfer full) (array length=len): byte data for the array
1569 * @len: length of @data
1571 * Create byte array containing the data. The data will be owned by the array
1572 * and will be freed with g_free(), i.e. it could be allocated using g_strdup().
1576 * Returns: (transfer full): a new #GByteArray
1579 g_byte_array_new_take (guint8
*data
,
1585 array
= g_byte_array_new ();
1586 real
= (GRealArray
*)array
;
1587 g_assert (real
->data
== NULL
);
1588 g_assert (real
->len
== 0);
1598 * g_byte_array_sized_new:
1599 * @reserved_size: number of bytes preallocated
1601 * Creates a new #GByteArray with @reserved_size bytes preallocated.
1602 * This avoids frequent reallocation, if you are going to add many
1603 * bytes to the array. Note however that the size of the array is still
1606 * Returns: the new #GByteArray
1609 g_byte_array_sized_new (guint reserved_size
)
1611 return (GByteArray
*)g_array_sized_new (FALSE
, FALSE
, 1, reserved_size
);
1615 * g_byte_array_free:
1616 * @array: a #GByteArray
1617 * @free_segment: if %TRUE the actual byte data is freed as well
1619 * Frees the memory allocated by the #GByteArray. If @free_segment is
1620 * %TRUE it frees the actual byte data. If the reference count of
1621 * @array is greater than one, the #GByteArray wrapper is preserved but
1622 * the size of @array will be set to zero.
1624 * Returns: the element data if @free_segment is %FALSE, otherwise
1625 * %NULL. The element data should be freed using g_free().
1628 g_byte_array_free (GByteArray
*array
,
1629 gboolean free_segment
)
1631 return (guint8
*)g_array_free ((GArray
*)array
, free_segment
);
1635 * g_byte_array_free_to_bytes:
1636 * @array: (transfer full): a #GByteArray
1638 * Transfers the data from the #GByteArray into a new immutable #GBytes.
1640 * The #GByteArray is freed unless the reference count of @array is greater
1641 * than one, the #GByteArray wrapper is preserved but the size of @array
1642 * will be set to zero.
1644 * This is identical to using g_bytes_new_take() and g_byte_array_free()
1649 * Returns: (transfer full): a new immutable #GBytes representing same
1650 * byte data that was in the array
1653 g_byte_array_free_to_bytes (GByteArray
*array
)
1657 g_return_val_if_fail (array
!= NULL
, NULL
);
1659 length
= array
->len
;
1660 return g_bytes_new_take (g_byte_array_free (array
, FALSE
), length
);
1665 * @array: A #GByteArray
1667 * Atomically increments the reference count of @array by one.
1668 * This function is thread-safe and may be called from any thread.
1670 * Returns: The passed in #GByteArray
1675 g_byte_array_ref (GByteArray
*array
)
1677 return (GByteArray
*)g_array_ref ((GArray
*)array
);
1681 * g_byte_array_unref:
1682 * @array: A #GByteArray
1684 * Atomically decrements the reference count of @array by one. If the
1685 * reference count drops to 0, all memory allocated by the array is
1686 * released. This function is thread-safe and may be called from any
1692 g_byte_array_unref (GByteArray
*array
)
1694 g_array_unref ((GArray
*)array
);
1698 * g_byte_array_append:
1699 * @array: a #GByteArray
1700 * @data: the byte data to be added
1701 * @len: the number of bytes to add
1703 * Adds the given bytes to the end of the #GByteArray.
1704 * The array will grow in size automatically if necessary.
1706 * Returns: the #GByteArray
1709 g_byte_array_append (GByteArray
*array
,
1713 g_array_append_vals ((GArray
*)array
, (guint8
*)data
, len
);
1719 * g_byte_array_prepend:
1720 * @array: a #GByteArray
1721 * @data: the byte data to be added
1722 * @len: the number of bytes to add
1724 * Adds the given data to the start of the #GByteArray.
1725 * The array will grow in size automatically if necessary.
1727 * Returns: the #GByteArray
1730 g_byte_array_prepend (GByteArray
*array
,
1734 g_array_prepend_vals ((GArray
*)array
, (guint8
*)data
, len
);
1740 * g_byte_array_set_size:
1741 * @array: a #GByteArray
1742 * @length: the new size of the #GByteArray
1744 * Sets the size of the #GByteArray, expanding it if necessary.
1746 * Returns: the #GByteArray
1749 g_byte_array_set_size (GByteArray
*array
,
1752 g_array_set_size ((GArray
*)array
, length
);
1758 * g_byte_array_remove_index:
1759 * @array: a #GByteArray
1760 * @index_: the index of the byte to remove
1762 * Removes the byte at the given index from a #GByteArray.
1763 * The following bytes are moved down one place.
1765 * Returns: the #GByteArray
1768 g_byte_array_remove_index (GByteArray
*array
,
1771 g_array_remove_index ((GArray
*)array
, index_
);
1777 * g_byte_array_remove_index_fast:
1778 * @array: a #GByteArray
1779 * @index_: the index of the byte to remove
1781 * Removes the byte at the given index from a #GByteArray. The last
1782 * element in the array is used to fill in the space, so this function
1783 * does not preserve the order of the #GByteArray. But it is faster
1784 * than g_byte_array_remove_index().
1786 * Returns: the #GByteArray
1789 g_byte_array_remove_index_fast (GByteArray
*array
,
1792 g_array_remove_index_fast ((GArray
*)array
, index_
);
1798 * g_byte_array_remove_range:
1799 * @array: a @GByteArray
1800 * @index_: the index of the first byte to remove
1801 * @length: the number of bytes to remove
1803 * Removes the given number of bytes starting at the given index from a
1804 * #GByteArray. The following elements are moved to close the gap.
1806 * Returns: the #GByteArray
1811 g_byte_array_remove_range (GByteArray
*array
,
1815 g_return_val_if_fail (array
, NULL
);
1816 g_return_val_if_fail (index_
< array
->len
, NULL
);
1817 g_return_val_if_fail (index_
+ length
<= array
->len
, NULL
);
1819 return (GByteArray
*)g_array_remove_range ((GArray
*)array
, index_
, length
);
1823 * g_byte_array_sort:
1824 * @array: a #GByteArray
1825 * @compare_func: comparison function
1827 * Sorts a byte array, using @compare_func which should be a
1828 * qsort()-style comparison function (returns less than zero for first
1829 * arg is less than second arg, zero for equal, greater than zero if
1830 * first arg is greater than second arg).
1832 * If two array elements compare equal, their order in the sorted array
1833 * is undefined. If you want equal elements to keep their order (i.e.
1834 * you want a stable sort) you can write a comparison function that,
1835 * if two elements would otherwise compare equal, compares them by
1839 g_byte_array_sort (GByteArray
*array
,
1840 GCompareFunc compare_func
)
1842 g_array_sort ((GArray
*)array
, compare_func
);
1846 * g_byte_array_sort_with_data:
1847 * @array: a #GByteArray
1848 * @compare_func: comparison function
1849 * @user_data: data to pass to @compare_func
1851 * Like g_byte_array_sort(), but the comparison function takes an extra
1852 * user data argument.
1855 g_byte_array_sort_with_data (GByteArray
*array
,
1856 GCompareDataFunc compare_func
,
1859 g_array_sort_with_data ((GArray
*)array
, compare_func
, user_data
);