|
sl@0
|
1 |
/* GObject - GLib Type, Object, Parameter and Signal Library
|
|
sl@0
|
2 |
* Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
|
|
sl@0
|
3 |
* Portions copyright (c) 2006-2009 Nokia Corporation. All rights reserved.
|
|
sl@0
|
4 |
* This library is free software; you can redistribute it and/or
|
|
sl@0
|
5 |
* modify it under the terms of the GNU Lesser General Public
|
|
sl@0
|
6 |
* License as published by the Free Software Foundation; either
|
|
sl@0
|
7 |
* version 2 of the License, or (at your option) any later version.
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* This library is distributed in the hope that it will be useful,
|
|
sl@0
|
10 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
sl@0
|
11 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
sl@0
|
12 |
* Lesser General Public License for more details.
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* You should have received a copy of the GNU Lesser General
|
|
sl@0
|
15 |
* Public License along with this library; if not, write to the
|
|
sl@0
|
16 |
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
sl@0
|
17 |
* Boston, MA 02111-1307, USA.
|
|
sl@0
|
18 |
*
|
|
sl@0
|
19 |
* gvalue.h: generic GValue functions
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
|
|
sl@0
|
22 |
#error "Only <glib-object.h> can be included directly."
|
|
sl@0
|
23 |
#endif
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#ifndef __G_VALUE_H__
|
|
sl@0
|
26 |
#define __G_VALUE_H__
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#include <gobject/gtype.h>
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
G_BEGIN_DECLS
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
/* --- type macros --- */
|
|
sl@0
|
33 |
/**
|
|
sl@0
|
34 |
* G_TYPE_IS_VALUE:
|
|
sl@0
|
35 |
* @type: A #GType value.
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* Checks whether the passed in type ID can be used for g_value_init().
|
|
sl@0
|
38 |
* That is, this macro checks whether this type provides an implementation
|
|
sl@0
|
39 |
* of the #GTypeValueTable functions required for a type to create a #GValue of.
|
|
sl@0
|
40 |
*
|
|
sl@0
|
41 |
* Returns: Whether @type is suitable as a #GValue type.
|
|
sl@0
|
42 |
*/
|
|
sl@0
|
43 |
#define G_TYPE_IS_VALUE(type) (g_type_check_is_value_type (type))
|
|
sl@0
|
44 |
/**
|
|
sl@0
|
45 |
* G_IS_VALUE:
|
|
sl@0
|
46 |
* @value: A #GValue structure.
|
|
sl@0
|
47 |
*
|
|
sl@0
|
48 |
* Checks if @value is a valid and initialized #GValue structure.
|
|
sl@0
|
49 |
*
|
|
sl@0
|
50 |
* Returns: %TRUE on success.
|
|
sl@0
|
51 |
*/
|
|
sl@0
|
52 |
#define G_IS_VALUE(value) (G_TYPE_CHECK_VALUE (value))
|
|
sl@0
|
53 |
/**
|
|
sl@0
|
54 |
* G_VALUE_TYPE:
|
|
sl@0
|
55 |
* @value: A #GValue structure.
|
|
sl@0
|
56 |
*
|
|
sl@0
|
57 |
* Get the type identifier of @value.
|
|
sl@0
|
58 |
*
|
|
sl@0
|
59 |
* Returns: the #GType.
|
|
sl@0
|
60 |
*/
|
|
sl@0
|
61 |
#define G_VALUE_TYPE(value) (((GValue*) (value))->g_type)
|
|
sl@0
|
62 |
/**
|
|
sl@0
|
63 |
* G_VALUE_TYPE_NAME:
|
|
sl@0
|
64 |
* @value: A #GValue structure.
|
|
sl@0
|
65 |
*
|
|
sl@0
|
66 |
* Gets the the type name of @value.
|
|
sl@0
|
67 |
*
|
|
sl@0
|
68 |
* Returns: the type name.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
#define G_VALUE_TYPE_NAME(value) (g_type_name (G_VALUE_TYPE (value)))
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
* G_VALUE_HOLDS:
|
|
sl@0
|
73 |
* @value: A #GValue structure.
|
|
sl@0
|
74 |
* @type: A #GType value.
|
|
sl@0
|
75 |
*
|
|
sl@0
|
76 |
* Checks if @value holds (or contains) a value of @type.
|
|
sl@0
|
77 |
* This macro will also check for @value != %NULL and issue a
|
|
sl@0
|
78 |
* warning if the check fails.
|
|
sl@0
|
79 |
*
|
|
sl@0
|
80 |
* Returns: %TRUE if @value holds the @type.
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
#define G_VALUE_HOLDS(value,type) (G_TYPE_CHECK_VALUE_TYPE ((value), (type)))
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
/* --- typedefs & structures --- */
|
|
sl@0
|
86 |
/**
|
|
sl@0
|
87 |
* GValueTransform:
|
|
sl@0
|
88 |
* @src_value: Source value.
|
|
sl@0
|
89 |
* @dest_value: Target value.
|
|
sl@0
|
90 |
*
|
|
sl@0
|
91 |
* The type of value transformation functions which can be registered with
|
|
sl@0
|
92 |
* g_value_register_transform_func().
|
|
sl@0
|
93 |
*/
|
|
sl@0
|
94 |
typedef void (*GValueTransform) (const GValue *src_value,
|
|
sl@0
|
95 |
GValue *dest_value);
|
|
sl@0
|
96 |
/**
|
|
sl@0
|
97 |
* GValue:
|
|
sl@0
|
98 |
*
|
|
sl@0
|
99 |
* An opaque structure used to hold different types of values.
|
|
sl@0
|
100 |
* The data within the structure has protected scope: it is accessible only
|
|
sl@0
|
101 |
* to functions within a #GTypeValueTable structure, or implementations of
|
|
sl@0
|
102 |
* the g_value_*() API. That is, code portions which implement new fundamental
|
|
sl@0
|
103 |
* types.
|
|
sl@0
|
104 |
* #GValue users can not make any assumptions about how data is stored
|
|
sl@0
|
105 |
* within the 2 element @data union, and the @g_type member should
|
|
sl@0
|
106 |
* only be accessed through the G_VALUE_TYPE() macro.
|
|
sl@0
|
107 |
*/
|
|
sl@0
|
108 |
struct _GValue
|
|
sl@0
|
109 |
{
|
|
sl@0
|
110 |
/*< private >*/
|
|
sl@0
|
111 |
GType g_type;
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
/* public for GTypeValueTable methods */
|
|
sl@0
|
114 |
union {
|
|
sl@0
|
115 |
gint v_int;
|
|
sl@0
|
116 |
guint v_uint;
|
|
sl@0
|
117 |
glong v_long;
|
|
sl@0
|
118 |
gulong v_ulong;
|
|
sl@0
|
119 |
gint64 v_int64;
|
|
sl@0
|
120 |
guint64 v_uint64;
|
|
sl@0
|
121 |
gfloat v_float;
|
|
sl@0
|
122 |
gdouble v_double;
|
|
sl@0
|
123 |
gpointer v_pointer;
|
|
sl@0
|
124 |
} data[2];
|
|
sl@0
|
125 |
};
|
|
sl@0
|
126 |
|
|
sl@0
|
127 |
|
|
sl@0
|
128 |
/* --- prototypes --- */
|
|
sl@0
|
129 |
IMPORT_C GValue* g_value_init (GValue *value,
|
|
sl@0
|
130 |
GType g_type);
|
|
sl@0
|
131 |
IMPORT_C void g_value_copy (const GValue *src_value,
|
|
sl@0
|
132 |
GValue *dest_value);
|
|
sl@0
|
133 |
IMPORT_C GValue* g_value_reset (GValue *value);
|
|
sl@0
|
134 |
IMPORT_C void g_value_unset (GValue *value);
|
|
sl@0
|
135 |
IMPORT_C void g_value_set_instance (GValue *value,
|
|
sl@0
|
136 |
gpointer instance);
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
|
|
sl@0
|
139 |
/* --- private --- */
|
|
sl@0
|
140 |
IMPORT_C gboolean g_value_fits_pointer (const GValue *value);
|
|
sl@0
|
141 |
IMPORT_C gpointer g_value_peek_pointer (const GValue *value);
|
|
sl@0
|
142 |
|
|
sl@0
|
143 |
|
|
sl@0
|
144 |
/* --- implementation details --- */
|
|
sl@0
|
145 |
IMPORT_C gboolean g_value_type_compatible (GType src_type,
|
|
sl@0
|
146 |
GType dest_type);
|
|
sl@0
|
147 |
IMPORT_C gboolean g_value_type_transformable (GType src_type,
|
|
sl@0
|
148 |
GType dest_type);
|
|
sl@0
|
149 |
IMPORT_C gboolean g_value_transform (const GValue *src_value,
|
|
sl@0
|
150 |
GValue *dest_value);
|
|
sl@0
|
151 |
IMPORT_C void g_value_register_transform_func (GType src_type,
|
|
sl@0
|
152 |
GType dest_type,
|
|
sl@0
|
153 |
GValueTransform transform_func);
|
|
sl@0
|
154 |
#define G_VALUE_NOCOPY_CONTENTS (1 << 27)
|
|
sl@0
|
155 |
|
|
sl@0
|
156 |
|
|
sl@0
|
157 |
G_END_DECLS
|
|
sl@0
|
158 |
|
|
sl@0
|
159 |
#endif /* __G_VALUE_H__ */
|