gboxed.c 17.9 KB
Newer Older
1
/* GObject - GLib Type, Object, Parameter and Signal Library
2
 * Copyright (C) 2000-2001 Red Hat, Inc.
3
4
5
6
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
swilmet's avatar
swilmet committed
7
 * version 2.1 of the License, or (at your option) any later version.
8
9
10
11
12
13
14
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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/>.
16
 */
17
18
19
20
21

#include "config.h"

#include <string.h>

Emmanuele Bassi's avatar
Emmanuele Bassi committed
22
/* for GValueArray */
23
#ifndef GLIB_DISABLE_DEPRECATION_WARNINGS
Emmanuele Bassi's avatar
Emmanuele Bassi committed
24
#define GLIB_DISABLE_DEPRECATION_WARNINGS
25
#endif
Emmanuele Bassi's avatar
Emmanuele Bassi committed
26

27
#include "gboxed.h"
Emmanuele Bassi's avatar
Emmanuele Bassi committed
28
#include "gclosure.h"
29
#include "gtype-private.h"
30
31
32
33
34
#include "gvalue.h"
#include "gvaluearray.h"
#include "gvaluecollector.h"


Stefan Kost's avatar
Stefan Kost committed
35
/**
36
 * SECTION:gboxed
Matthias Clasen's avatar
Matthias Clasen committed
37
38
39
40
 * @short_description: A mechanism to wrap opaque C structures registered
 *     by the type system
 * @see_also: #GParamSpecBoxed, g_param_spec_boxed()
 * @title: Boxed Types
41
 *
42
43
44
45
46
 * #GBoxed is a generic wrapper mechanism for arbitrary C structures.
 *
 * The only thing the type system needs to know about the structures is how to
 * copy them (a #GBoxedCopyFunc) and how to free them (a #GBoxedFreeFunc);
 * beyond that, they are treated as opaque chunks of memory.
47
 *
Stefan Kost's avatar
Stefan Kost committed
48
 * Boxed types are useful for simple value-holder structures like rectangles or
49
50
51
52
53
54
55
56
57
58
59
60
 * points. They can also be used for wrapping structures defined in non-#GObject
 * based libraries. They allow arbitrary structures to be handled in a uniform
 * way, allowing uniform copying (or referencing) and freeing (or unreferencing)
 * of them, and uniform representation of the type of the contained structure.
 * In turn, this allows any type which can be boxed to be set as the data in a
 * #GValue, which allows for polymorphic handling of a much wider range of data
 * types, and hence usage of such types as #GObject property values.
 *
 * #GBoxed is designed so that reference counted types can be boxed. Use the
 * type’s ‘ref’ function as the #GBoxedCopyFunc, and its ‘unref’ function as the
 * #GBoxedFreeFunc. For example, for #GBytes, the #GBoxedCopyFunc is
 * g_bytes_ref(), and the #GBoxedFreeFunc is g_bytes_unref().
Stefan Kost's avatar
Stefan Kost committed
61
62
 */

63
64
65
66
67
68
69
70
static inline void              /* keep this function in sync with gvalue.c */
value_meminit (GValue *value,
	       GType   value_type)
{
  value->g_type = value_type;
  memset (value->data, 0, sizeof (value->data));
}

71
72
static GValue *
value_copy (GValue *src_value)
73
74
75
76
77
78
79
80
81
82
83
84
{
  GValue *dest_value = g_new0 (GValue, 1);

  if (G_VALUE_TYPE (src_value))
    {
      g_value_init (dest_value, G_VALUE_TYPE (src_value));
      g_value_copy (src_value, dest_value);
    }
  return dest_value;
}

static void
85
value_free (GValue *value)
86
87
88
89
90
91
{
  if (G_VALUE_TYPE (value))
    g_value_unset (value);
  g_free (value);
}

92
93
94
95
96
97
98
99
100
static GPollFD *
pollfd_copy (GPollFD *src)
{
  GPollFD *dest = g_new0 (GPollFD, 1);
  /* just a couple of integers */
  memcpy (dest, src, sizeof (GPollFD));
  return dest;
}

101
void
102
_g_boxed_type_init (void)
103
{
104
  const GTypeInfo info = {
105
106
107
108
109
110
111
112
113
114
115
116
    0,                          /* class_size */
    NULL,                       /* base_init */
    NULL,                       /* base_destroy */
    NULL,                       /* class_init */
    NULL,                       /* class_destroy */
    NULL,                       /* class_data */
    0,                          /* instance_size */
    0,                          /* n_preallocs */
    NULL,                       /* instance_init */
    NULL,                       /* value_table */
  };
  const GTypeFundamentalInfo finfo = { G_TYPE_FLAG_DERIVABLE, };
117
  GType type G_GNUC_UNUSED  /* when compiling with G_DISABLE_ASSERT */;
118
119
120

  /* G_TYPE_BOXED
   */
121
  type = g_type_register_fundamental (G_TYPE_BOXED, g_intern_static_string ("GBoxed"), &info, &finfo,
122
				      G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT);
123
  g_assert (type == G_TYPE_BOXED);
124
}
125

126
127
static GString *
gstring_copy (GString *src_gstring)
128
{
129
130
131
132
  return g_string_new_len (src_gstring->str, src_gstring->len);
}

static void
133
gstring_free (GString *gstring)
134
135
136
137
{
  g_string_free (gstring, TRUE);
}

138
139
140
G_DEFINE_BOXED_TYPE (GClosure, g_closure, g_closure_ref, g_closure_unref)
G_DEFINE_BOXED_TYPE (GValue, g_value, value_copy, value_free)
G_DEFINE_BOXED_TYPE (GValueArray, g_value_array, g_value_array_copy, g_value_array_free)
Andrew Potter's avatar
Andrew Potter committed
141
G_DEFINE_BOXED_TYPE (GDate, g_date, g_date_copy, g_date_free)
142
143
144
145
146
147
/* the naming is a bit odd, but GString is obviously not G_TYPE_STRING */
G_DEFINE_BOXED_TYPE (GString, g_gstring, gstring_copy, gstring_free)
G_DEFINE_BOXED_TYPE (GHashTable, g_hash_table, g_hash_table_ref, g_hash_table_unref)
G_DEFINE_BOXED_TYPE (GArray, g_array, g_array_ref, g_array_unref)
G_DEFINE_BOXED_TYPE (GPtrArray, g_ptr_array,g_ptr_array_ref, g_ptr_array_unref)
G_DEFINE_BOXED_TYPE (GByteArray, g_byte_array, g_byte_array_ref, g_byte_array_unref)
148
G_DEFINE_BOXED_TYPE (GBytes, g_bytes, g_bytes_ref, g_bytes_unref)
Andrew Potter's avatar
Andrew Potter committed
149
G_DEFINE_BOXED_TYPE (GTree, g_tree, g_tree_ref, g_tree_unref)
Matthias Clasen's avatar
Matthias Clasen committed
150

151
G_DEFINE_BOXED_TYPE (GRegex, g_regex, g_regex_ref, g_regex_unref)
152
G_DEFINE_BOXED_TYPE (GMatchInfo, g_match_info, g_match_info_ref, g_match_info_unref)
Matthias Clasen's avatar
Matthias Clasen committed
153

154
155
156
#define g_variant_type_get_type g_variant_type_get_gtype
G_DEFINE_BOXED_TYPE (GVariantType, g_variant_type, g_variant_type_copy, g_variant_type_free)
#undef g_variant_type_get_type
157

158
G_DEFINE_BOXED_TYPE (GVariantBuilder, g_variant_builder, g_variant_builder_ref, g_variant_builder_unref)
159
G_DEFINE_BOXED_TYPE (GVariantDict, g_variant_dict, g_variant_dict_ref, g_variant_dict_unref)
160

161
G_DEFINE_BOXED_TYPE (GError, g_error, g_error_copy, g_error_free)
162

163
164
G_DEFINE_BOXED_TYPE (GDateTime, g_date_time, g_date_time_ref, g_date_time_unref)
G_DEFINE_BOXED_TYPE (GTimeZone, g_time_zone, g_time_zone_ref, g_time_zone_unref)
165
G_DEFINE_BOXED_TYPE (GKeyFile, g_key_file, g_key_file_ref, g_key_file_unref)
Ray Strode's avatar
Ray Strode committed
166
G_DEFINE_BOXED_TYPE (GMappedFile, g_mapped_file, g_mapped_file_ref, g_mapped_file_unref)
167

168
169
170
G_DEFINE_BOXED_TYPE (GMainLoop, g_main_loop, g_main_loop_ref, g_main_loop_unref)
G_DEFINE_BOXED_TYPE (GMainContext, g_main_context, g_main_context_ref, g_main_context_unref)
G_DEFINE_BOXED_TYPE (GSource, g_source, g_source_ref, g_source_unref)
171
G_DEFINE_BOXED_TYPE (GPollFD, g_pollfd, pollfd_copy, g_free)
172
G_DEFINE_BOXED_TYPE (GMarkupParseContext, g_markup_parse_context, g_markup_parse_context_ref, g_markup_parse_context_unref)
173

Sebastian Dröge's avatar
Sebastian Dröge committed
174
G_DEFINE_BOXED_TYPE (GThread, g_thread, g_thread_ref, g_thread_unref)
175
G_DEFINE_BOXED_TYPE (GChecksum, g_checksum, g_checksum_copy, g_checksum_free)
176
G_DEFINE_BOXED_TYPE (GUri, g_uri, g_uri_ref, g_uri_unref)
Sebastian Dröge's avatar
Sebastian Dröge committed
177

178
G_DEFINE_BOXED_TYPE (GOptionGroup, g_option_group, g_option_group_ref, g_option_group_unref)
179
G_DEFINE_BOXED_TYPE (GPatternSpec, g_pattern_spec, g_pattern_spec_copy, g_pattern_spec_free);
180

181
/* This one can't use G_DEFINE_BOXED_TYPE (GStrv, g_strv, g_strdupv, g_strfreev) */
182
GType
183
g_strv_get_type (void)
184
{
185
  static gsize static_g_define_type_id = 0;
Allison Karlitskaya's avatar
Allison Karlitskaya committed
186

187
  if (g_once_init_enter (&static_g_define_type_id))
188
189
190
191
192
    {
      GType g_define_type_id =
        g_boxed_type_register_static (g_intern_static_string ("GStrv"),
                                      (GBoxedCopyFunc) g_strdupv,
                                      (GBoxedFreeFunc) g_strfreev);
Allison Karlitskaya's avatar
Allison Karlitskaya committed
193

194
      g_once_init_leave (&static_g_define_type_id, g_define_type_id);
195
    }
Allison Karlitskaya's avatar
Allison Karlitskaya committed
196

197
  return static_g_define_type_id;
Allison Karlitskaya's avatar
Allison Karlitskaya committed
198
199
200
201
202
}

GType
g_variant_get_gtype (void)
{
203
  return G_TYPE_VARIANT;
204
205
}

206
207
208
static void
boxed_proxy_value_init (GValue *value)
{
209
  value->data[0].v_pointer = NULL;
210
211
212
213
214
}

static void
boxed_proxy_value_free (GValue *value)
{
215
  if (value->data[0].v_pointer && !(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
216
    _g_type_boxed_free (G_VALUE_TYPE (value), value->data[0].v_pointer);
217
218
219
220
221
222
223
}

static void
boxed_proxy_value_copy (const GValue *src_value,
			GValue       *dest_value)
{
  if (src_value->data[0].v_pointer)
224
    dest_value->data[0].v_pointer = _g_type_boxed_copy (G_VALUE_TYPE (src_value), src_value->data[0].v_pointer);
225
226
227
228
229
230
231
232
233
234
235
236
  else
    dest_value->data[0].v_pointer = src_value->data[0].v_pointer;
}

static gpointer
boxed_proxy_value_peek_pointer (const GValue *value)
{
  return value->data[0].v_pointer;
}

static gchar*
boxed_proxy_collect_value (GValue      *value,
237
238
239
			   guint        n_collect_values,
			   GTypeCValue *collect_values,
			   guint        collect_flags)
240
{
241
  if (!collect_values[0].v_pointer)
242
    value->data[0].v_pointer = NULL;
243
244
  else
    {
245
      if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
246
247
248
249
250
	{
	  value->data[0].v_pointer = collect_values[0].v_pointer;
	  value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
	}
      else
251
	value->data[0].v_pointer = _g_type_boxed_copy (G_VALUE_TYPE (value), collect_values[0].v_pointer);
252
    }
253
254
255
256
257
258

  return NULL;
}

static gchar*
boxed_proxy_lcopy_value (const GValue *value,
259
260
261
			 guint         n_collect_values,
			 GTypeCValue  *collect_values,
			 guint         collect_flags)
262
{
263
  gpointer *boxed_p = collect_values[0].v_pointer;
264

265
  g_return_val_if_fail (boxed_p != NULL, g_strdup_printf ("value location for '%s' passed as NULL", G_VALUE_TYPE_NAME (value)));
266

267
268
269
270
271
  if (!value->data[0].v_pointer)
    *boxed_p = NULL;
  else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
    *boxed_p = value->data[0].v_pointer;
  else
272
    *boxed_p = _g_type_boxed_copy (G_VALUE_TYPE (value), value->data[0].v_pointer);
273
274
275
276

  return NULL;
}

Stefan Kost's avatar
Stefan Kost committed
277
278
279
280
281
/**
 * g_boxed_type_register_static:
 * @name: Name of the new boxed type.
 * @boxed_copy: Boxed structure copy function.
 * @boxed_free: Boxed structure free function.
282
 *
Stefan Kost's avatar
Stefan Kost committed
283
 * This function creates a new %G_TYPE_BOXED derived type id for a new
284
285
286
287
 * boxed type with name @name.
 *
 * Boxed type handling functions have to be provided to copy and free
 * opaque boxed structures of this type.
288
 *
289
 * For the general case, it is recommended to use G_DEFINE_BOXED_TYPE()
290
291
292
 * instead of calling g_boxed_type_register_static() directly. The macro 
 * will create the appropriate `*_get_type()` function for the boxed type.
 *
Stefan Kost's avatar
Stefan Kost committed
293
294
 * Returns: New %G_TYPE_BOXED derived type id for @name.
 */
295
296
297
GType
g_boxed_type_register_static (const gchar   *name,
			      GBoxedCopyFunc boxed_copy,
298
			      GBoxedFreeFunc boxed_free)
299
300
301
302
303
304
{
  static const GTypeValueTable vtable = {
    boxed_proxy_value_init,
    boxed_proxy_value_free,
    boxed_proxy_value_copy,
    boxed_proxy_value_peek_pointer,
305
    "p",
306
    boxed_proxy_collect_value,
307
    "p",
308
309
    boxed_proxy_lcopy_value,
  };
310
  GTypeInfo type_info = {
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
    0,			/* class_size */
    NULL,		/* base_init */
    NULL,		/* base_finalize */
    NULL,		/* class_init */
    NULL,		/* class_finalize */
    NULL,		/* class_data */
    0,			/* instance_size */
    0,			/* n_preallocs */
    NULL,		/* instance_init */
    &vtable,		/* value_table */
  };
  GType type;

  g_return_val_if_fail (name != NULL, 0);
  g_return_val_if_fail (boxed_copy != NULL, 0);
  g_return_val_if_fail (boxed_free != NULL, 0);
  g_return_val_if_fail (g_type_from_name (name) == 0, 0);

  type = g_type_register_static (G_TYPE_BOXED, name, &type_info, 0);

Matthias Clasen's avatar
Matthias Clasen committed
331
  /* install proxy functions upon successful registration */
332
  if (type)
333
    _g_type_boxed_init (type, boxed_copy, boxed_free);
334
335
336
337

  return type;
}

Stefan Kost's avatar
Stefan Kost committed
338
339
340
/**
 * g_boxed_copy:
 * @boxed_type: The type of @src_boxed.
341
 * @src_boxed: (not nullable): The boxed structure to be copied.
Stefan Kost's avatar
Stefan Kost committed
342
343
344
 * 
 * Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
 * 
345
346
 * Returns: (transfer full) (not nullable): The newly created copy of the boxed
 *    structure.
Stefan Kost's avatar
Stefan Kost committed
347
 */
348
gpointer
Tim Janik's avatar
Tim Janik committed
349
350
g_boxed_copy (GType         boxed_type,
	      gconstpointer src_boxed)
351
352
{
  GTypeValueTable *value_table;
Tim Janik's avatar
Tim Janik committed
353
  gpointer dest_boxed;
354
355
356
357
358
359

  g_return_val_if_fail (G_TYPE_IS_BOXED (boxed_type), NULL);
  g_return_val_if_fail (G_TYPE_IS_ABSTRACT (boxed_type) == FALSE, NULL);
  g_return_val_if_fail (src_boxed != NULL, NULL);

  value_table = g_type_value_table_peek (boxed_type);
360
  g_assert (value_table != NULL);
361
362
363

  /* check if our proxying implementation is used, we can short-cut here */
  if (value_table->value_copy == boxed_proxy_value_copy)
364
    dest_boxed = _g_type_boxed_copy (boxed_type, (gpointer) src_boxed);
365
366
367
  else
    {
      GValue src_value, dest_value;
368

Owen Taylor's avatar
Owen Taylor committed
369
      /* we heavily rely on third-party boxed type value vtable
370
371
372
373
       * implementations to follow normal boxed value storage
       * (data[0].v_pointer is the boxed struct, and
       * data[1].v_uint holds the G_VALUE_NOCOPY_CONTENTS flag,
       * rest zero).
Matthias Clasen's avatar
Matthias Clasen committed
374
       * but then, we can expect that since we laid out the
375
376
377
378
379
380
       * g_boxed_*() API.
       * data[1].v_uint&G_VALUE_NOCOPY_CONTENTS shouldn't be set
       * after a copy.
       */
      /* equiv. to g_value_set_static_boxed() */
      value_meminit (&src_value, boxed_type);
Tim Janik's avatar
Tim Janik committed
381
      src_value.data[0].v_pointer = (gpointer) src_boxed;
382
383
      src_value.data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;

Owen Taylor's avatar
Owen Taylor committed
384
      /* call third-party code copy function, fingers-crossed */
385
      value_meminit (&dest_value, boxed_type);
386
      value_table->value_copy (&src_value, &dest_value);
387
388

      /* double check and grouse if things went wrong */
Owen Taylor's avatar
Owen Taylor committed
389
      if (dest_value.data[1].v_ulong)
390
	g_warning ("the copy_value() implementation of type '%s' seems to make use of reserved GValue fields",
391
392
		   g_type_name (boxed_type));

Tim Janik's avatar
Tim Janik committed
393
      dest_boxed = dest_value.data[0].v_pointer;
394
395
    }

Tim Janik's avatar
Tim Janik committed
396
  return dest_boxed;
397
398
}

Stefan Kost's avatar
Stefan Kost committed
399
400
401
/**
 * g_boxed_free:
 * @boxed_type: The type of @boxed.
402
 * @boxed: (not nullable): The boxed structure to be freed.
403
 *
Stefan Kost's avatar
Stefan Kost committed
404
405
 * Free the boxed structure @boxed which is of type @boxed_type.
 */
406
407
408
409
410
411
412
413
414
415
416
void
g_boxed_free (GType    boxed_type,
	      gpointer boxed)
{
  GTypeValueTable *value_table;

  g_return_if_fail (G_TYPE_IS_BOXED (boxed_type));
  g_return_if_fail (G_TYPE_IS_ABSTRACT (boxed_type) == FALSE);
  g_return_if_fail (boxed != NULL);

  value_table = g_type_value_table_peek (boxed_type);
417
  g_assert (value_table != NULL);
418
419
420

  /* check if our proxying implementation is used, we can short-cut here */
  if (value_table->value_free == boxed_proxy_value_free)
421
    _g_type_boxed_free (boxed_type, boxed);
422
423
424
425
  else
    {
      GValue value;

426
427
      /* see g_boxed_copy() on why we think we can do this */
      value_meminit (&value, boxed_type);
428
429
430
431
432
      value.data[0].v_pointer = boxed;
      value_table->value_free (&value);
    }
}

Stefan Kost's avatar
Stefan Kost committed
433
434
435
/**
 * g_value_get_boxed:
 * @value: a valid #GValue of %G_TYPE_BOXED derived type
436
 *
Stefan Kost's avatar
Stefan Kost committed
437
 * Get the contents of a %G_TYPE_BOXED derived #GValue.
438
 *
439
 * Returns: (transfer none): boxed contents of @value
Stefan Kost's avatar
Stefan Kost committed
440
 */
441
442
443
444
445
446
447
448
449
gpointer
g_value_get_boxed (const GValue *value)
{
  g_return_val_if_fail (G_VALUE_HOLDS_BOXED (value), NULL);
  g_return_val_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)), NULL);

  return value->data[0].v_pointer;
}

Stefan Kost's avatar
Stefan Kost committed
450
/**
451
 * g_value_dup_boxed: (skip)
Stefan Kost's avatar
Stefan Kost committed
452
 * @value: a valid #GValue of %G_TYPE_BOXED derived type
453
454
455
456
457
458
 *
 * Get the contents of a %G_TYPE_BOXED derived #GValue.  Upon getting,
 * the boxed value is duplicated and needs to be later freed with
 * g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
 * return_value);
 *
Stefan Kost's avatar
Stefan Kost committed
459
460
 * Returns: boxed contents of @value
 */
461
gpointer
462
g_value_dup_boxed (const GValue *value)
463
464
465
466
467
468
469
470
471
{
  g_return_val_if_fail (G_VALUE_HOLDS_BOXED (value), NULL);
  g_return_val_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)), NULL);

  return value->data[0].v_pointer ? g_boxed_copy (G_VALUE_TYPE (value), value->data[0].v_pointer) : NULL;
}

static inline void
value_set_boxed_internal (GValue       *value,
472
			  gconstpointer boxed,
473
474
475
476
477
478
479
480
481
482
483
484
485
486
			  gboolean      need_copy,
			  gboolean      need_free)
{
  if (!boxed)
    {
      /* just resetting to NULL might not be desired, need to
       * have value reinitialized also (for values defaulting
       * to other default value states than a NULL data pointer),
       * g_value_reset() will handle this
       */
      g_value_reset (value);
      return;
    }

487
488
489
  if (value->data[0].v_pointer && !(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
    g_boxed_free (G_VALUE_TYPE (value), value->data[0].v_pointer);
  value->data[1].v_uint = need_free ? 0 : G_VALUE_NOCOPY_CONTENTS;
490
  value->data[0].v_pointer = need_copy ? g_boxed_copy (G_VALUE_TYPE (value), boxed) : (gpointer) boxed;
491
492
}

Stefan Kost's avatar
Stefan Kost committed
493
494
495
/**
 * g_value_set_boxed:
 * @value: a valid #GValue of %G_TYPE_BOXED derived type
496
 * @v_boxed: (nullable): boxed value to be set
497
 *
Stefan Kost's avatar
Stefan Kost committed
498
499
 * Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
 */
500
void
Tim Janik's avatar
Tim Janik committed
501
502
g_value_set_boxed (GValue       *value,
		   gconstpointer boxed)
503
{
504
  g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
505
506
  g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));

507
  value_set_boxed_internal (value, boxed, TRUE, TRUE);
Tim Janik's avatar
Tim Janik committed
508
509
}

Stefan Kost's avatar
Stefan Kost committed
510
511
512
/**
 * g_value_set_static_boxed:
 * @value: a valid #GValue of %G_TYPE_BOXED derived type
513
 * @v_boxed: (nullable): static boxed value to be set
514
 *
Stefan Kost's avatar
Stefan Kost committed
515
 * Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
516
 *
Stefan Kost's avatar
Stefan Kost committed
517
518
519
 * The boxed value is assumed to be static, and is thus not duplicated
 * when setting the #GValue.
 */
Tim Janik's avatar
Tim Janik committed
520
521
522
523
void
g_value_set_static_boxed (GValue       *value,
			  gconstpointer boxed)
{
524
  g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
Tim Janik's avatar
Tim Janik committed
525
526
  g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));

527
  value_set_boxed_internal (value, boxed, FALSE, FALSE);
528
529
}

Stefan Kost's avatar
Stefan Kost committed
530
531
532
/**
 * g_value_set_boxed_take_ownership:
 * @value: a valid #GValue of %G_TYPE_BOXED derived type
533
 * @v_boxed: (nullable): duplicated unowned boxed value to be set
534
 *
Stefan Kost's avatar
Stefan Kost committed
535
 * This is an internal function introduced mainly for C marshallers.
536
 *
Stefan Kost's avatar
Stefan Kost committed
537
538
 * Deprecated: 2.4: Use g_value_take_boxed() instead.
 */
539
540
541
void
g_value_set_boxed_take_ownership (GValue       *value,
				  gconstpointer boxed)
542
543
544
545
{
  g_value_take_boxed (value, boxed);
}

Stefan Kost's avatar
Stefan Kost committed
546
547
548
/**
 * g_value_take_boxed:
 * @value: a valid #GValue of %G_TYPE_BOXED derived type
549
 * @v_boxed: (nullable): duplicated unowned boxed value to be set
550
551
 *
 * Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed
552
553
 * and takes over the ownership of the caller’s reference to @v_boxed;
 * the caller doesn’t have to unref it any more.
554
 *
Stefan Kost's avatar
Stefan Kost committed
555
556
 * Since: 2.4
 */
557
558
559
void
g_value_take_boxed (GValue       *value,
		    gconstpointer boxed)
560
{
561
562
  g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
  g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
563

564
  value_set_boxed_internal (value, boxed, FALSE, TRUE);
565
}