1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/glib/gobject/gboxed.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,191 @@
1.4 +/* GObject - GLib Type, Object, Parameter and Signal Library
1.5 + * Copyright (C) 2000-2001 Red Hat, Inc.
1.6 + * Portions copyright (c) 2006-2009 Nokia Corporation. All rights reserved.
1.7 + * This library is free software; you can redistribute it and/or
1.8 + * modify it under the terms of the GNU Lesser General Public
1.9 + * License as published by the Free Software Foundation; either
1.10 + * version 2 of the License, or (at your option) any later version.
1.11 + *
1.12 + * This library is distributed in the hope that it will be useful,
1.13 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.14 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1.15 + * Lesser General Public License for more details.
1.16 + *
1.17 + * You should have received a copy of the GNU Lesser General
1.18 + * Public License along with this library; if not, write to the
1.19 + * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
1.20 + * Boston, MA 02111-1307, USA.
1.21 + */
1.22 +#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
1.23 +#error "Only <glib-object.h> can be included directly."
1.24 +#endif
1.25 +
1.26 +#ifndef __G_BOXED_H__
1.27 +#define __G_BOXED_H__
1.28 +
1.29 +#include <gobject/gtype.h>
1.30 +
1.31 +G_BEGIN_DECLS
1.32 +
1.33 +/* --- type macros --- */
1.34 +#define G_TYPE_IS_BOXED(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_BOXED)
1.35 +/**
1.36 + * G_VALUE_HOLDS_BOXED:
1.37 + * @value: a valid #GValue structure
1.38 + *
1.39 + * Checks whether the given #GValue can hold values derived from type %G_TYPE_BOXED.
1.40 + *
1.41 + * Returns: %TRUE on success.
1.42 + */
1.43 +#define G_VALUE_HOLDS_BOXED(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOXED))
1.44 +
1.45 +
1.46 +/* --- typedefs --- */
1.47 +/**
1.48 + * GBoxedCopyFunc:
1.49 + * @boxed: The boxed structure to be copied.
1.50 + *
1.51 + * This function is provided by the user and should produce a copy of the passed
1.52 + * in boxed structure.
1.53 + *
1.54 + * Returns: The newly created copy of the boxed structure.
1.55 + */
1.56 +typedef gpointer (*GBoxedCopyFunc) (gpointer boxed);
1.57 +
1.58 +/**
1.59 + * GBoxedFreeFunc:
1.60 + * @boxed: The boxed structure to be freed.
1.61 + *
1.62 + * This function is provided by the user and should free the boxed
1.63 + * structure passed.
1.64 + */
1.65 +typedef void (*GBoxedFreeFunc) (gpointer boxed);
1.66 +
1.67 +
1.68 +/* --- prototypes --- */
1.69 +IMPORT_C gpointer g_boxed_copy (GType boxed_type,
1.70 + gconstpointer src_boxed);
1.71 +IMPORT_C void g_boxed_free (GType boxed_type,
1.72 + gpointer boxed);
1.73 +IMPORT_C void g_value_set_boxed (GValue *value,
1.74 + gconstpointer v_boxed);
1.75 +IMPORT_C void g_value_set_static_boxed (GValue *value,
1.76 + gconstpointer v_boxed);
1.77 +IMPORT_C gpointer g_value_get_boxed (const GValue *value);
1.78 +IMPORT_C gpointer g_value_dup_boxed (const GValue *value);
1.79 +
1.80 +
1.81 +/* --- convenience --- */
1.82 +IMPORT_C GType g_boxed_type_register_static (const gchar *name,
1.83 + GBoxedCopyFunc boxed_copy,
1.84 + GBoxedFreeFunc boxed_free);
1.85 +
1.86 +
1.87 +/* --- GLib boxed types --- */
1.88 +/**
1.89 + * G_TYPE_CLOSURE:
1.90 + *
1.91 + * The #GType for #GClosure.
1.92 + */
1.93 +#define G_TYPE_CLOSURE (g_closure_get_type ())
1.94 +/**
1.95 + * G_TYPE_VALUE:
1.96 + *
1.97 + * The type ID of the "GValue" type which is a boxed type,
1.98 + * used to pass around pointers to GValues.
1.99 + */
1.100 +#define G_TYPE_VALUE (g_value_get_type ())
1.101 +/**
1.102 + * G_TYPE_VALUE_ARRAY:
1.103 + *
1.104 + * The type ID of the "GValueArray" type which is a boxed type,
1.105 + * used to pass around pointers to GValueArrays.
1.106 + */
1.107 +#define G_TYPE_VALUE_ARRAY (g_value_array_get_type ())
1.108 +/**
1.109 + * G_TYPE_DATE:
1.110 + *
1.111 + * The #GType for #GDate.
1.112 + */
1.113 +#define G_TYPE_DATE (g_date_get_type ())
1.114 +/**
1.115 + * G_TYPE_STRV:
1.116 + *
1.117 + * The #GType for a boxed type holding a %NULL-terminated array of strings.
1.118 + *
1.119 + * The code fragments in the following example show the use of a property of
1.120 + * type #G_TYPE_STRV with g_object_class_install_property(), g_object_set()
1.121 + * and g_object_get().
1.122 + *
1.123 + * |[
1.124 + * g_object_class_install_property (object_class,
1.125 + * PROP_AUTHORS,
1.126 + * g_param_spec_boxed ("authors",
1.127 + * _("Authors"),
1.128 + * _("List of authors"),
1.129 + * G_TYPE_STRV,
1.130 + * G_PARAM_READWRITE));
1.131 + *
1.132 + *
1.133 + * gchar *authors[] = { "Owen", "Tim", NULL };
1.134 + * g_object_set (obj, "authors", authors, NULL);
1.135 + *
1.136 + *
1.137 + * gchar *writers[];
1.138 + * g_object_get (obj, "authors", &writers, NULL);
1.139 + * // do something with writers
1.140 + * g_strfreev (writers);
1.141 + * ]|
1.142 + *
1.143 + * Since: 2.4
1.144 + */
1.145 +#define G_TYPE_STRV (g_strv_get_type ())
1.146 +/**
1.147 + * G_TYPE_GSTRING:
1.148 + *
1.149 + * The #GType for #GString.
1.150 + */
1.151 +#define G_TYPE_GSTRING (g_gstring_get_type ())
1.152 +/**
1.153 + * G_TYPE_HASH_TABLE:
1.154 + *
1.155 + * The #GType for a boxed type holding a #GHashTable reference.
1.156 + *
1.157 + * Since: 2.10
1.158 + */
1.159 +#define G_TYPE_HASH_TABLE (g_hash_table_get_type ())
1.160 +/**
1.161 + * G_TYPE_REGEX:
1.162 + *
1.163 + * The #GType for a boxed type holding a #GRegex reference.
1.164 + *
1.165 + * Since: 2.14
1.166 + */
1.167 +#define G_TYPE_REGEX (g_regex_get_type ())
1.168 +
1.169 +
1.170 +IMPORT_C void g_value_take_boxed (GValue *value,
1.171 + gconstpointer v_boxed);
1.172 +#ifndef G_DISABLE_DEPRECATED
1.173 +IMPORT_C void g_value_set_boxed_take_ownership (GValue *value,
1.174 + gconstpointer v_boxed);
1.175 +#endif
1.176 +IMPORT_C GType g_closure_get_type (void) G_GNUC_CONST;
1.177 +IMPORT_C GType g_value_get_type (void) G_GNUC_CONST;
1.178 +IMPORT_C GType g_value_array_get_type (void) G_GNUC_CONST;
1.179 +IMPORT_C GType g_date_get_type (void) G_GNUC_CONST;
1.180 +IMPORT_C GType g_strv_get_type (void) G_GNUC_CONST;
1.181 +IMPORT_C GType g_gstring_get_type (void) G_GNUC_CONST;
1.182 +IMPORT_C GType g_hash_table_get_type (void) G_GNUC_CONST;
1.183 +IMPORT_C GType g_regex_get_type (void) G_GNUC_CONST;
1.184 +
1.185 +/**
1.186 + * GStrv:
1.187 + *
1.188 + * A C representable type name for #G_TYPE_STRV.
1.189 + */
1.190 +typedef gchar** GStrv;
1.191 +
1.192 +G_END_DECLS
1.193 +
1.194 +#endif /* __G_BOXED_H__ */