1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
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.
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.
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.
19 * gparam.h: GParamSpec base class implementation
21 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
22 #error "Only <glib-object.h> can be included directly."
28 #include <gobject/gvalue.h>
32 /* --- standard type macros --- */
33 #define G_TYPE_IS_PARAM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)
34 #define G_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))
35 #define G_IS_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))
36 #define G_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_CAST ((pclass), G_TYPE_PARAM, GParamSpecClass))
37 #define G_IS_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_TYPE ((pclass), G_TYPE_PARAM))
38 #define G_PARAM_SPEC_GET_CLASS(pspec) (G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))
41 /* --- convenience macros --- */
42 #define G_PARAM_SPEC_TYPE(pspec) (G_TYPE_FROM_INSTANCE (pspec))
43 #define G_PARAM_SPEC_TYPE_NAME(pspec) (g_type_name (G_PARAM_SPEC_TYPE (pspec)))
44 #define G_PARAM_SPEC_VALUE_TYPE(pspec) (G_PARAM_SPEC (pspec)->value_type)
45 #define G_VALUE_HOLDS_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))
51 G_PARAM_READABLE
= 1 << 0,
52 G_PARAM_WRITABLE
= 1 << 1,
53 G_PARAM_CONSTRUCT
= 1 << 2,
54 G_PARAM_CONSTRUCT_ONLY
= 1 << 3,
55 G_PARAM_LAX_VALIDATION
= 1 << 4,
56 G_PARAM_PRIVATE
= 1 << 5
58 #define G_PARAM_READWRITE (G_PARAM_READABLE | G_PARAM_WRITABLE)
59 #define G_PARAM_MASK (0x000000ff)
60 /* bits in the range 0xffffff00 are reserved for 3rd party usage */
61 #define G_PARAM_USER_SHIFT (8)
64 /* --- typedefs & structures --- */
65 typedef struct _GParamSpec GParamSpec
;
66 typedef struct _GParamSpecClass GParamSpecClass
;
67 typedef struct _GParameter GParameter
;
68 typedef struct _GParamSpecPool GParamSpecPool
;
71 GTypeInstance g_type_instance
;
76 GType owner_type
; /* class using this property */
83 guint param_id
; /* sort-criteria */
85 struct _GParamSpecClass
87 GTypeClass g_type_class
;
91 void (*finalize
) (GParamSpec
*pspec
);
94 void (*value_set_default
) (GParamSpec
*pspec
,
96 gboolean (*value_validate
) (GParamSpec
*pspec
,
98 gint (*values_cmp
) (GParamSpec
*pspec
,
100 const GValue
*value2
);
103 struct _GParameter
/* auxillary structure for _setv() variants */
110 /* --- prototypes --- */
111 GParamSpec
* g_param_spec_ref (GParamSpec
*pspec
);
112 void g_param_spec_unref (GParamSpec
*pspec
);
113 void g_param_spec_sink (GParamSpec
*pspec
);
114 gpointer
g_param_spec_get_qdata (GParamSpec
*pspec
,
116 void g_param_spec_set_qdata (GParamSpec
*pspec
,
119 void g_param_spec_set_qdata_full (GParamSpec
*pspec
,
122 GDestroyNotify destroy
);
123 gpointer
g_param_spec_steal_qdata (GParamSpec
*pspec
,
125 void g_param_value_set_default (GParamSpec
*pspec
,
127 gboolean
g_param_value_defaults (GParamSpec
*pspec
,
129 gboolean
g_param_value_validate (GParamSpec
*pspec
,
131 gboolean
g_param_value_convert (GParamSpec
*pspec
,
132 const GValue
*src_value
,
134 gboolean strict_validation
);
135 gint
g_param_values_cmp (GParamSpec
*pspec
,
136 const GValue
*value1
,
137 const GValue
*value2
);
138 G_CONST_RETURN gchar
* g_param_spec_get_name (GParamSpec
*pspec
);
139 G_CONST_RETURN gchar
* g_param_spec_get_nick (GParamSpec
*pspec
);
140 G_CONST_RETURN gchar
* g_param_spec_get_blurb (GParamSpec
*pspec
);
141 void g_value_set_param (GValue
*value
,
143 GParamSpec
* g_value_get_param (const GValue
*value
);
144 GParamSpec
* g_value_dup_param (const GValue
*value
);
147 /* --- marshaller specific --- */
148 void g_value_set_param_take_ownership (GValue
*value
,
152 /* --- convenience functions --- */
153 typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo
;
154 struct _GParamSpecTypeInfo
156 /* type system portion */
157 guint16 instance_size
; /* obligatory */
158 guint16 n_preallocs
; /* optional */
159 void (*instance_init
) (GParamSpec
*pspec
); /* optional */
162 GType value_type
; /* obligatory */
163 void (*finalize
) (GParamSpec
*pspec
); /* optional */
164 void (*value_set_default
) (GParamSpec
*pspec
, /* recommended */
166 gboolean (*value_validate
) (GParamSpec
*pspec
, /* optional */
168 gint (*values_cmp
) (GParamSpec
*pspec
, /* recommended */
169 const GValue
*value1
,
170 const GValue
*value2
);
172 GType
g_param_type_register_static (const gchar
*name
,
173 const GParamSpecTypeInfo
*pspec_info
);
175 /* For registering builting types */
176 GType
_g_param_type_register_static_constant (const gchar
*name
,
177 const GParamSpecTypeInfo
*pspec_info
,
181 /* --- protected --- */
182 gpointer
g_param_spec_internal (GType param_type
,
187 GParamSpecPool
* g_param_spec_pool_new (gboolean type_prefixing
);
188 void g_param_spec_pool_insert (GParamSpecPool
*pool
,
191 void g_param_spec_pool_remove (GParamSpecPool
*pool
,
193 GParamSpec
* g_param_spec_pool_lookup (GParamSpecPool
*pool
,
194 const gchar
*param_name
,
196 gboolean walk_ancestors
);
197 GList
* g_param_spec_pool_list_owned (GParamSpecPool
*pool
,
199 GParamSpec
** g_param_spec_pool_list (GParamSpecPool
*pool
,
207 * gboolean value_validate (GParamSpec *pspec,
209 * modify value contents in the least destructive way, so
210 * that it complies with pspec's requirements (i.e.
211 * according to minimum/maximum ranges etc...). return
212 * whether modification was necessary.
214 * gint values_cmp (GParamSpec *pspec,
215 * const GValue *value1,
216 * const GValue *value2):
217 * return value1 - value2, i.e. (-1) if value1 < value2,
218 * (+1) if value1 > value2, and (0) otherwise (equality)
223 #endif /* __G_PARAM_H__ */