define gstring in terms of gchar*. this typedef reflects the type name of
[platform/upstream/glib.git] / gobject / gvalue.h
1 /* GObject - GLib Type, Object, Parameter and Signal Library
2  * Copyright (C) 1997, 1998, 1999, 2000 Tim Janik and Red Hat, Inc.
3  *
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 of the License, or (at your option) any later version.
8  *
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.
13  *
14  * You should have received a copy of the GNU Lesser General
15  * Public License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17  * Boston, MA 02111-1307, USA.
18  *
19  * gvalue.h: generic GValue functions
20  */
21 #ifndef __G_VALUE_H__
22 #define __G_VALUE_H__
23
24
25 #include        <gobject/gtype.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif /* __cplusplus */
30
31
32 /* --- type macros --- */
33 #define G_TYPE_IS_VALUE(type)           (g_type_value_table_peek (type) != NULL)
34 #define G_IS_VALUE(value)               (G_TYPE_IS_VALUE (G_VALUE_TYPE (value))) // FIXME
35 #define G_VALUE_TYPE(value)             (G_TYPE_FROM_CLASS (value))
36 #define G_VALUE_TYPE_NAME(value)        (g_type_name (G_VALUE_TYPE (value)))
37
38
39 /* --- typedefs & structures --- */
40 typedef void (*GValueExchange) (GValue  *value1,
41                                 GValue  *value2);
42 struct _GValue
43 {
44   /*< private >*/
45   GType         g_type;
46
47   /* public for GTypeValueTable methods */
48   union {
49     gint        v_int;
50     guint       v_uint;
51     glong       v_long;
52     gulong      v_ulong;
53     gfloat      v_float;
54     gdouble     v_double;
55     gpointer    v_pointer;
56   } data[4];
57 };
58
59
60 /* --- prototypes --- */
61 void            g_value_init            (GValue       *value,
62                                          GType         g_type);
63 void            g_value_copy            (const GValue *src_value,
64                                          GValue       *dest_value);
65 gboolean        g_value_convert         (const GValue *src_value,
66                                          GValue       *dest_value);
67 void            g_value_reset           (GValue       *value);
68 void            g_value_unset           (GValue       *value);
69
70
71 /* --- implementation details --- */
72 gboolean g_values_exchange              (GValue       *value1,
73                                          GValue       *value2);
74 gboolean g_value_types_exchangable      (GType         value_type1,
75                                          GType         value_type2);
76 void     g_value_register_exchange_func (GType         value_type1,
77                                          GType         value_type2,
78                                          GValueExchange func);
79
80 #ifdef __cplusplus
81 }
82 #endif /* __cplusplus */
83
84 #endif /* __G_VALUE_H__ */