1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000-2001 Red Hat, Inc.
4 * SPDX-License-Identifier: LGPL-2.1-or-later
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
25 #ifndef GLIB_DISABLE_DEPRECATION_WARNINGS
26 #define GLIB_DISABLE_DEPRECATION_WARNINGS
31 #include "gtype-private.h"
33 #include "gvaluearray.h"
34 #include "gvaluecollector.h"
36 static inline void /* keep this function in sync with gvalue.c */
37 value_meminit (GValue *value,
40 value->g_type = value_type;
41 memset (value->data, 0, sizeof (value->data));
45 value_copy (GValue *src_value)
47 GValue *dest_value = g_new0 (GValue, 1);
49 if (G_VALUE_TYPE (src_value))
51 g_value_init (dest_value, G_VALUE_TYPE (src_value));
52 g_value_copy (src_value, dest_value);
58 value_free (GValue *value)
60 if (G_VALUE_TYPE (value))
61 g_value_unset (value);
66 pollfd_copy (GPollFD *src)
68 GPollFD *dest = g_new0 (GPollFD, 1);
69 /* just a couple of integers */
70 memcpy (dest, src, sizeof (GPollFD));
75 _g_boxed_type_init (void)
77 const GTypeInfo info = {
80 NULL, /* base_destroy */
81 NULL, /* class_init */
82 NULL, /* class_destroy */
83 NULL, /* class_data */
84 0, /* instance_size */
86 NULL, /* instance_init */
87 NULL, /* value_table */
89 const GTypeFundamentalInfo finfo = { G_TYPE_FLAG_DERIVABLE, };
90 GType type G_GNUC_UNUSED /* when compiling with G_DISABLE_ASSERT */;
94 type = g_type_register_fundamental (G_TYPE_BOXED, g_intern_static_string ("GBoxed"), &info, &finfo,
95 G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT);
96 g_assert (type == G_TYPE_BOXED);
100 gstring_copy (GString *src_gstring)
102 return g_string_new_len (src_gstring->str, src_gstring->len);
106 gstring_free (GString *gstring)
108 g_string_free (gstring, TRUE);
111 G_DEFINE_BOXED_TYPE (GClosure, g_closure, g_closure_ref, g_closure_unref)
112 G_DEFINE_BOXED_TYPE (GValue, g_value, value_copy, value_free)
113 G_DEFINE_BOXED_TYPE (GValueArray, g_value_array, g_value_array_copy, g_value_array_free)
114 G_DEFINE_BOXED_TYPE (GDate, g_date, g_date_copy, g_date_free)
115 /* the naming is a bit odd, but GString is obviously not G_TYPE_STRING */
116 G_DEFINE_BOXED_TYPE (GString, g_gstring, gstring_copy, gstring_free)
117 G_DEFINE_BOXED_TYPE (GHashTable, g_hash_table, g_hash_table_ref, g_hash_table_unref)
118 G_DEFINE_BOXED_TYPE (GArray, g_array, g_array_ref, g_array_unref)
119 G_DEFINE_BOXED_TYPE (GPtrArray, g_ptr_array,g_ptr_array_ref, g_ptr_array_unref)
120 G_DEFINE_BOXED_TYPE (GByteArray, g_byte_array, g_byte_array_ref, g_byte_array_unref)
121 G_DEFINE_BOXED_TYPE (GBytes, g_bytes, g_bytes_ref, g_bytes_unref)
122 G_DEFINE_BOXED_TYPE (GTree, g_tree, g_tree_ref, g_tree_unref)
124 G_DEFINE_BOXED_TYPE (GRegex, g_regex, g_regex_ref, g_regex_unref)
125 G_DEFINE_BOXED_TYPE (GMatchInfo, g_match_info, g_match_info_ref, g_match_info_unref)
127 #define g_variant_type_get_type g_variant_type_get_gtype
128 G_DEFINE_BOXED_TYPE (GVariantType, g_variant_type, g_variant_type_copy, g_variant_type_free)
129 #undef g_variant_type_get_type
131 G_DEFINE_BOXED_TYPE (GVariantBuilder, g_variant_builder, g_variant_builder_ref, g_variant_builder_unref)
132 G_DEFINE_BOXED_TYPE (GVariantDict, g_variant_dict, g_variant_dict_ref, g_variant_dict_unref)
134 G_DEFINE_BOXED_TYPE (GError, g_error, g_error_copy, g_error_free)
136 G_DEFINE_BOXED_TYPE (GDateTime, g_date_time, g_date_time_ref, g_date_time_unref)
137 G_DEFINE_BOXED_TYPE (GTimeZone, g_time_zone, g_time_zone_ref, g_time_zone_unref)
138 G_DEFINE_BOXED_TYPE (GKeyFile, g_key_file, g_key_file_ref, g_key_file_unref)
139 G_DEFINE_BOXED_TYPE (GMappedFile, g_mapped_file, g_mapped_file_ref, g_mapped_file_unref)
140 G_DEFINE_BOXED_TYPE (GBookmarkFile, g_bookmark_file, g_bookmark_file_copy, g_bookmark_file_free)
141 G_DEFINE_BOXED_TYPE (GHmac, g_hmac, g_hmac_ref, g_hmac_unref)
142 G_DEFINE_BOXED_TYPE (GDir, g_dir, g_dir_ref, g_dir_unref)
143 G_DEFINE_BOXED_TYPE (GRand, g_rand, g_rand_copy, g_rand_free)
145 G_DEFINE_BOXED_TYPE (GMainLoop, g_main_loop, g_main_loop_ref, g_main_loop_unref)
146 G_DEFINE_BOXED_TYPE (GMainContext, g_main_context, g_main_context_ref, g_main_context_unref)
147 G_DEFINE_BOXED_TYPE (GSource, g_source, g_source_ref, g_source_unref)
148 G_DEFINE_BOXED_TYPE (GPollFD, g_pollfd, pollfd_copy, g_free)
149 G_DEFINE_BOXED_TYPE (GMarkupParseContext, g_markup_parse_context, g_markup_parse_context_ref, g_markup_parse_context_unref)
151 G_DEFINE_BOXED_TYPE (GThread, g_thread, g_thread_ref, g_thread_unref)
152 G_DEFINE_BOXED_TYPE (GChecksum, g_checksum, g_checksum_copy, g_checksum_free)
153 G_DEFINE_BOXED_TYPE (GUri, g_uri, g_uri_ref, g_uri_unref)
155 G_DEFINE_BOXED_TYPE (GOptionGroup, g_option_group, g_option_group_ref, g_option_group_unref)
156 G_DEFINE_BOXED_TYPE (GPatternSpec, g_pattern_spec, g_pattern_spec_copy, g_pattern_spec_free);
158 G_DEFINE_BOXED_TYPE (GStrvBuilder, g_strv_builder, g_strv_builder_ref, g_strv_builder_unref);
160 /* This one can't use G_DEFINE_BOXED_TYPE (GStrv, g_strv, g_strdupv, g_strfreev) */
162 g_strv_get_type (void)
164 static GType static_g_define_type_id = 0;
166 if (g_once_init_enter_pointer (&static_g_define_type_id))
168 GType g_define_type_id =
169 g_boxed_type_register_static (g_intern_static_string ("GStrv"),
170 (GBoxedCopyFunc) g_strdupv,
171 (GBoxedFreeFunc) g_strfreev);
173 g_once_init_leave_pointer (&static_g_define_type_id, g_define_type_id);
176 return static_g_define_type_id;
180 g_variant_get_gtype (void)
182 return G_TYPE_VARIANT;
186 boxed_proxy_value_init (GValue *value)
188 value->data[0].v_pointer = NULL;
192 boxed_proxy_value_free (GValue *value)
194 if (value->data[0].v_pointer && !(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
195 _g_type_boxed_free (G_VALUE_TYPE (value), value->data[0].v_pointer);
199 boxed_proxy_value_copy (const GValue *src_value,
202 if (src_value->data[0].v_pointer)
203 dest_value->data[0].v_pointer = _g_type_boxed_copy (G_VALUE_TYPE (src_value), src_value->data[0].v_pointer);
205 dest_value->data[0].v_pointer = src_value->data[0].v_pointer;
209 boxed_proxy_value_peek_pointer (const GValue *value)
211 return value->data[0].v_pointer;
215 boxed_proxy_collect_value (GValue *value,
216 guint n_collect_values,
217 GTypeCValue *collect_values,
220 if (!collect_values[0].v_pointer)
221 value->data[0].v_pointer = NULL;
224 if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
226 value->data[0].v_pointer = collect_values[0].v_pointer;
227 value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
230 value->data[0].v_pointer = _g_type_boxed_copy (G_VALUE_TYPE (value), collect_values[0].v_pointer);
237 boxed_proxy_lcopy_value (const GValue *value,
238 guint n_collect_values,
239 GTypeCValue *collect_values,
242 gpointer *boxed_p = collect_values[0].v_pointer;
244 g_return_val_if_fail (boxed_p != NULL, g_strdup_printf ("value location for '%s' passed as NULL", G_VALUE_TYPE_NAME (value)));
246 if (!value->data[0].v_pointer)
248 else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
249 *boxed_p = value->data[0].v_pointer;
251 *boxed_p = _g_type_boxed_copy (G_VALUE_TYPE (value), value->data[0].v_pointer);
257 * g_boxed_type_register_static:
258 * @name: Name of the new boxed type.
259 * @boxed_copy: (scope forever): Boxed structure copy function.
260 * @boxed_free: (scope forever): Boxed structure free function.
262 * This function creates a new %G_TYPE_BOXED derived type id for a new
263 * boxed type with name @name.
265 * Boxed type handling functions have to be provided to copy and free
266 * opaque boxed structures of this type.
268 * For the general case, it is recommended to use G_DEFINE_BOXED_TYPE()
269 * instead of calling g_boxed_type_register_static() directly. The macro
270 * will create the appropriate `*_get_type()` function for the boxed type.
272 * Returns: New %G_TYPE_BOXED derived type id for @name.
275 g_boxed_type_register_static (const gchar *name,
276 GBoxedCopyFunc boxed_copy,
277 GBoxedFreeFunc boxed_free)
279 static const GTypeValueTable vtable = {
280 boxed_proxy_value_init,
281 boxed_proxy_value_free,
282 boxed_proxy_value_copy,
283 boxed_proxy_value_peek_pointer,
285 boxed_proxy_collect_value,
287 boxed_proxy_lcopy_value,
289 GTypeInfo type_info = {
291 NULL, /* base_init */
292 NULL, /* base_finalize */
293 NULL, /* class_init */
294 NULL, /* class_finalize */
295 NULL, /* class_data */
296 0, /* instance_size */
298 NULL, /* instance_init */
299 &vtable, /* value_table */
303 g_return_val_if_fail (name != NULL, 0);
304 g_return_val_if_fail (boxed_copy != NULL, 0);
305 g_return_val_if_fail (boxed_free != NULL, 0);
306 g_return_val_if_fail (g_type_from_name (name) == 0, 0);
308 type = g_type_register_static (G_TYPE_BOXED, name, &type_info, 0);
310 /* install proxy functions upon successful registration */
312 _g_type_boxed_init (type, boxed_copy, boxed_free);
319 * @boxed_type: The type of @src_boxed.
320 * @src_boxed: (not nullable): The boxed structure to be copied.
322 * Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
324 * Returns: (transfer full) (not nullable): The newly created copy of the boxed
328 g_boxed_copy (GType boxed_type,
329 gconstpointer src_boxed)
331 GTypeValueTable *value_table;
334 g_return_val_if_fail (G_TYPE_IS_BOXED (boxed_type), NULL);
335 g_return_val_if_fail (G_TYPE_IS_ABSTRACT (boxed_type) == FALSE, NULL);
336 g_return_val_if_fail (src_boxed != NULL, NULL);
338 value_table = g_type_value_table_peek (boxed_type);
339 g_assert (value_table != NULL);
341 /* check if our proxying implementation is used, we can short-cut here */
342 if (value_table->value_copy == boxed_proxy_value_copy)
343 dest_boxed = _g_type_boxed_copy (boxed_type, (gpointer) src_boxed);
346 GValue src_value, dest_value;
348 /* we heavily rely on third-party boxed type value vtable
349 * implementations to follow normal boxed value storage
350 * (data[0].v_pointer is the boxed struct, and
351 * data[1].v_uint holds the G_VALUE_NOCOPY_CONTENTS flag,
353 * but then, we can expect that since we laid out the
355 * data[1].v_uint&G_VALUE_NOCOPY_CONTENTS shouldn't be set
358 /* equiv. to g_value_set_static_boxed() */
359 value_meminit (&src_value, boxed_type);
360 src_value.data[0].v_pointer = (gpointer) src_boxed;
361 src_value.data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
363 /* call third-party code copy function, fingers-crossed */
364 value_meminit (&dest_value, boxed_type);
365 value_table->value_copy (&src_value, &dest_value);
367 /* double check and grouse if things went wrong */
368 if (dest_value.data[1].v_ulong)
369 g_warning ("the copy_value() implementation of type '%s' seems to make use of reserved GValue fields",
370 g_type_name (boxed_type));
372 dest_boxed = dest_value.data[0].v_pointer;
380 * @boxed_type: The type of @boxed.
381 * @boxed: (not nullable): The boxed structure to be freed.
383 * Free the boxed structure @boxed which is of type @boxed_type.
386 g_boxed_free (GType boxed_type,
389 GTypeValueTable *value_table;
391 g_return_if_fail (G_TYPE_IS_BOXED (boxed_type));
392 g_return_if_fail (G_TYPE_IS_ABSTRACT (boxed_type) == FALSE);
393 g_return_if_fail (boxed != NULL);
395 value_table = g_type_value_table_peek (boxed_type);
396 g_assert (value_table != NULL);
398 /* check if our proxying implementation is used, we can short-cut here */
399 if (value_table->value_free == boxed_proxy_value_free)
400 _g_type_boxed_free (boxed_type, boxed);
405 /* see g_boxed_copy() on why we think we can do this */
406 value_meminit (&value, boxed_type);
407 value.data[0].v_pointer = boxed;
408 value_table->value_free (&value);
414 * @value: a valid #GValue of %G_TYPE_BOXED derived type
416 * Get the contents of a %G_TYPE_BOXED derived #GValue.
418 * Returns: (transfer none) (nullable): boxed contents of @value
421 g_value_get_boxed (const GValue *value)
423 g_return_val_if_fail (G_VALUE_HOLDS_BOXED (value), NULL);
424 g_return_val_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)), NULL);
426 return value->data[0].v_pointer;
430 * g_value_dup_boxed: (skip)
431 * @value: a valid #GValue of %G_TYPE_BOXED derived type
433 * Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting,
434 * the boxed value is duplicated and needs to be later freed with
435 * g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
438 * Returns: (transfer full) (nullable): boxed contents of @value
441 g_value_dup_boxed (const GValue *value)
443 g_return_val_if_fail (G_VALUE_HOLDS_BOXED (value), NULL);
444 g_return_val_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)), NULL);
446 return value->data[0].v_pointer ? g_boxed_copy (G_VALUE_TYPE (value), value->data[0].v_pointer) : NULL;
450 value_set_boxed_internal (GValue *value,
457 /* just resetting to NULL might not be desired, need to
458 * have value reinitialized also (for values defaulting
459 * to other default value states than a NULL data pointer),
460 * g_value_reset() will handle this
462 g_value_reset (value);
466 if (value->data[0].v_pointer && !(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
467 g_boxed_free (G_VALUE_TYPE (value), value->data[0].v_pointer);
468 value->data[1].v_uint = need_free ? 0 : G_VALUE_NOCOPY_CONTENTS;
469 value->data[0].v_pointer = need_copy ? g_boxed_copy (G_VALUE_TYPE (value), boxed) : (gpointer) boxed;
474 * @value: a valid #GValue of %G_TYPE_BOXED derived type
475 * @v_boxed: (nullable): boxed value to be set
477 * Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
480 g_value_set_boxed (GValue *value,
483 g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
484 g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
486 value_set_boxed_internal (value, boxed, TRUE, TRUE);
490 * g_value_set_static_boxed:
491 * @value: a valid #GValue of %G_TYPE_BOXED derived type
492 * @v_boxed: (nullable): static boxed value to be set
494 * Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
496 * The boxed value is assumed to be static, and is thus not duplicated
497 * when setting the #GValue.
500 g_value_set_static_boxed (GValue *value,
503 g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
504 g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
506 value_set_boxed_internal (value, boxed, FALSE, FALSE);
510 * g_value_set_boxed_take_ownership:
511 * @value: a valid #GValue of %G_TYPE_BOXED derived type
512 * @v_boxed: (nullable): duplicated unowned boxed value to be set
514 * This is an internal function introduced mainly for C marshallers.
516 * Deprecated: 2.4: Use g_value_take_boxed() instead.
519 g_value_set_boxed_take_ownership (GValue *value,
522 g_value_take_boxed (value, boxed);
526 * g_value_take_boxed:
527 * @value: a valid #GValue of %G_TYPE_BOXED derived type
528 * @v_boxed: (nullable): duplicated unowned boxed value to be set
530 * Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed
531 * and takes over the ownership of the caller’s reference to @v_boxed;
532 * the caller doesn’t have to unref it any more.
537 g_value_take_boxed (GValue *value,
540 g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
541 g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
543 value_set_boxed_internal (value, boxed, FALSE, TRUE);