1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2001 Red Hat, Inc.
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
15 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
25 #include <stdlib.h> /* qsort() */
27 #include "gvaluearray.h"
31 * SECTION:value_arrays
32 * @short_description: A container structure to maintain an array of
34 * @see_also: #GValue, #GParamSpecValueArray, g_param_spec_value_array()
35 * @title: Value arrays
37 * The prime purpose of a #GValueArray is for it to be used as an
38 * object property that holds an array of values. A #GValueArray wraps
39 * an array of #GValue elements in order for it to be used as a boxed
40 * type through %G_TYPE_VALUE_ARRAY.
42 * #GValueArray is deprecated in favour of #GArray since GLib 2.32. It
43 * is possible to create a #GArray that behaves like a #GValueArray by
44 * using the size of #GValue as the element size, and by setting
45 * g_value_unset() as the clear function using g_array_set_clear_func(),
46 * for instance, the following code:
48 * |[<!-- language="C" -->
49 * GValueArray *array = g_value_array_new (10);
54 * |[<!-- language="C" -->
55 * GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10);
56 * g_array_set_clear_func (array, (GDestroyNotify) g_value_unset);
60 #define GROUP_N_VALUES (8) /* power of 2 !! */
63 /* --- functions --- */
65 * g_value_array_get_nth:
66 * @value_array: #GValueArray to get a value from
67 * @index_: index of the value of interest
69 * Return a pointer to the value at @index_ containd in @value_array.
71 * Returns: (transfer none): pointer to a value at @index_ in @value_array
73 * Deprecated: 2.32: Use g_array_index() instead.
76 g_value_array_get_nth (GValueArray
*value_array
,
79 g_return_val_if_fail (value_array
!= NULL
, NULL
);
80 g_return_val_if_fail (index
< value_array
->n_values
, NULL
);
82 return value_array
->values
+ index
;
86 value_array_grow (GValueArray
*value_array
,
90 g_return_if_fail (n_values
>= value_array
->n_values
);
92 value_array
->n_values
= n_values
;
93 if (value_array
->n_values
> value_array
->n_prealloced
)
95 guint i
= value_array
->n_prealloced
;
97 value_array
->n_prealloced
= (value_array
->n_values
+ GROUP_N_VALUES
- 1) & ~(GROUP_N_VALUES
- 1);
98 value_array
->values
= g_renew (GValue
, value_array
->values
, value_array
->n_prealloced
);
100 i
= value_array
->n_values
;
101 memset (value_array
->values
+ i
, 0,
102 (value_array
->n_prealloced
- i
) * sizeof (value_array
->values
[0]));
108 * @n_prealloced: number of values to preallocate space for
110 * Allocate and initialize a new #GValueArray, optionally preserve space
111 * for @n_prealloced elements. New arrays always contain 0 elements,
112 * regardless of the value of @n_prealloced.
114 * Returns: a newly allocated #GValueArray with 0 values
116 * Deprecated: 2.32: Use #GArray and g_array_sized_new() instead.
119 g_value_array_new (guint n_prealloced
)
121 GValueArray
*value_array
= g_slice_new (GValueArray
);
123 value_array
->n_values
= 0;
124 value_array
->n_prealloced
= 0;
125 value_array
->values
= NULL
;
126 value_array_grow (value_array
, n_prealloced
, TRUE
);
127 value_array
->n_values
= 0;
133 * g_value_array_free: (skip)
134 * @value_array: #GValueArray to free
136 * Free a #GValueArray including its contents.
138 * Deprecated: 2.32: Use #GArray and g_array_unref() instead.
141 g_value_array_free (GValueArray
*value_array
)
145 g_return_if_fail (value_array
!= NULL
);
147 for (i
= 0; i
< value_array
->n_values
; i
++)
149 GValue
*value
= value_array
->values
+ i
;
151 if (G_VALUE_TYPE (value
) != 0) /* we allow unset values in the array */
152 g_value_unset (value
);
154 g_free (value_array
->values
);
155 g_slice_free (GValueArray
, value_array
);
159 * g_value_array_copy:
160 * @value_array: #GValueArray to copy
162 * Construct an exact copy of a #GValueArray by duplicating all its
165 * Returns: (transfer full): Newly allocated copy of #GValueArray
167 * Deprecated: 2.32: Use #GArray and g_array_ref() instead.
170 g_value_array_copy (const GValueArray
*value_array
)
172 GValueArray
*new_array
;
175 g_return_val_if_fail (value_array
!= NULL
, NULL
);
177 new_array
= g_slice_new (GValueArray
);
178 new_array
->n_values
= 0;
179 new_array
->values
= NULL
;
180 new_array
->n_prealloced
= 0;
181 value_array_grow (new_array
, value_array
->n_values
, TRUE
);
182 for (i
= 0; i
< new_array
->n_values
; i
++)
183 if (G_VALUE_TYPE (value_array
->values
+ i
) != 0)
185 GValue
*value
= new_array
->values
+ i
;
187 g_value_init (value
, G_VALUE_TYPE (value_array
->values
+ i
));
188 g_value_copy (value_array
->values
+ i
, value
);
194 * g_value_array_prepend:
195 * @value_array: #GValueArray to add an element to
196 * @value: (nullable): #GValue to copy into #GValueArray, or %NULL
198 * Insert a copy of @value as first element of @value_array. If @value is
199 * %NULL, an uninitialized value is prepended.
202 * Returns: (transfer none): the #GValueArray passed in as @value_array
204 * Deprecated: 2.32: Use #GArray and g_array_prepend_val() instead.
207 g_value_array_prepend (GValueArray
*value_array
,
210 g_return_val_if_fail (value_array
!= NULL
, NULL
);
212 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
213 return g_value_array_insert (value_array
, 0, value
);
214 G_GNUC_END_IGNORE_DEPRECATIONS
218 * g_value_array_append:
219 * @value_array: #GValueArray to add an element to
220 * @value: (nullable): #GValue to copy into #GValueArray, or %NULL
222 * Insert a copy of @value as last element of @value_array. If @value is
223 * %NULL, an uninitialized value is appended.
225 * Returns: (transfer none): the #GValueArray passed in as @value_array
227 * Deprecated: 2.32: Use #GArray and g_array_append_val() instead.
230 g_value_array_append (GValueArray
*value_array
,
233 g_return_val_if_fail (value_array
!= NULL
, NULL
);
235 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
236 return g_value_array_insert (value_array
, value_array
->n_values
, value
);
237 G_GNUC_END_IGNORE_DEPRECATIONS
241 * g_value_array_insert:
242 * @value_array: #GValueArray to add an element to
243 * @index_: insertion position, must be <= value_array->;n_values
244 * @value: (nullable): #GValue to copy into #GValueArray, or %NULL
246 * Insert a copy of @value at specified position into @value_array. If @value
247 * is %NULL, an uninitialized value is inserted.
249 * Returns: (transfer none): the #GValueArray passed in as @value_array
251 * Deprecated: 2.32: Use #GArray and g_array_insert_val() instead.
254 g_value_array_insert (GValueArray
*value_array
,
260 g_return_val_if_fail (value_array
!= NULL
, NULL
);
261 g_return_val_if_fail (index
<= value_array
->n_values
, value_array
);
263 i
= value_array
->n_values
;
264 value_array_grow (value_array
, value_array
->n_values
+ 1, FALSE
);
265 if (index
+ 1 < value_array
->n_values
)
266 memmove (value_array
->values
+ index
+ 1, value_array
->values
+ index
,
267 (i
- index
) * sizeof (value_array
->values
[0]));
268 memset (value_array
->values
+ index
, 0, sizeof (value_array
->values
[0]));
271 g_value_init (value_array
->values
+ index
, G_VALUE_TYPE (value
));
272 g_value_copy (value
, value_array
->values
+ index
);
278 * g_value_array_remove:
279 * @value_array: #GValueArray to remove an element from
280 * @index_: position of value to remove, which must be less than
281 * @value_array->n_values
283 * Remove the value at position @index_ from @value_array.
285 * Returns: (transfer none): the #GValueArray passed in as @value_array
287 * Deprecated: 2.32: Use #GArray and g_array_remove_index() instead.
290 g_value_array_remove (GValueArray
*value_array
,
293 g_return_val_if_fail (value_array
!= NULL
, NULL
);
294 g_return_val_if_fail (index
< value_array
->n_values
, value_array
);
296 if (G_VALUE_TYPE (value_array
->values
+ index
) != 0)
297 g_value_unset (value_array
->values
+ index
);
298 value_array
->n_values
--;
299 if (index
< value_array
->n_values
)
300 memmove (value_array
->values
+ index
, value_array
->values
+ index
+ 1,
301 (value_array
->n_values
- index
) * sizeof (value_array
->values
[0]));
302 if (value_array
->n_prealloced
> value_array
->n_values
)
303 memset (value_array
->values
+ value_array
->n_values
, 0, sizeof (value_array
->values
[0]));
309 * g_value_array_sort:
310 * @value_array: #GValueArray to sort
311 * @compare_func: (scope call): function to compare elements
313 * Sort @value_array using @compare_func to compare the elements according to
314 * the semantics of #GCompareFunc.
316 * The current implementation uses the same sorting algorithm as standard
317 * C qsort() function.
319 * Returns: (transfer none): the #GValueArray passed in as @value_array
321 * Deprecated: 2.32: Use #GArray and g_array_sort().
324 g_value_array_sort (GValueArray
*value_array
,
325 GCompareFunc compare_func
)
327 g_return_val_if_fail (compare_func
!= NULL
, NULL
);
329 if (value_array
->n_values
)
330 qsort (value_array
->values
,
331 value_array
->n_values
,
332 sizeof (value_array
->values
[0]),
338 * g_value_array_sort_with_data: (rename-to g_value_array_sort)
339 * @value_array: #GValueArray to sort
340 * @compare_func: (scope call): function to compare elements
341 * @user_data: (closure): extra data argument provided for @compare_func
343 * Sort @value_array using @compare_func to compare the elements according
344 * to the semantics of #GCompareDataFunc.
346 * The current implementation uses the same sorting algorithm as standard
347 * C qsort() function.
349 * Returns: (transfer none): the #GValueArray passed in as @value_array
351 * Deprecated: 2.32: Use #GArray and g_array_sort_with_data().
354 g_value_array_sort_with_data (GValueArray
*value_array
,
355 GCompareDataFunc compare_func
,
358 g_return_val_if_fail (value_array
!= NULL
, NULL
);
359 g_return_val_if_fail (compare_func
!= NULL
, NULL
);
361 if (value_array
->n_values
)
362 g_qsort_with_data (value_array
->values
,
363 value_array
->n_values
,
364 sizeof (value_array
->values
[0]),
365 compare_func
, user_data
);