1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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 Public
15 * 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.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkobject.h"
32 #include "gtkmarshalers.h"
33 #include "gtksignal.h"
34 #include "gtkprivate.h"
48 extern void gtk_object_init_type (void); /* for gtktypeutils.h */
49 static void gtk_object_base_class_init (GtkObjectClass *class);
50 static void gtk_object_base_class_finalize (GtkObjectClass *class);
51 static void gtk_object_class_init (GtkObjectClass *klass);
52 static void gtk_object_init (GtkObject *object,
53 GtkObjectClass *klass);
54 static void gtk_object_set_property (GObject *object,
58 static void gtk_object_get_property (GObject *object,
62 static void gtk_object_dispose (GObject *object);
63 static void gtk_object_real_destroy (GtkObject *object);
64 static void gtk_object_finalize (GObject *object);
65 static void gtk_object_notify_weaks (GtkObject *object);
67 static gpointer parent_class = NULL;
68 static guint object_signals[LAST_SIGNAL] = { 0 };
69 static GQuark quark_weakrefs = 0;
72 /****************************************************
73 * GtkObject type, class and instance initialization
75 ****************************************************/
78 gtk_object_get_type (void)
80 static GType object_type = 0;
84 static const GTypeInfo object_info =
86 sizeof (GtkObjectClass),
87 (GBaseInitFunc) gtk_object_base_class_init,
88 (GBaseFinalizeFunc) gtk_object_base_class_finalize,
89 (GClassInitFunc) gtk_object_class_init,
90 NULL, /* class_finalize */
91 NULL, /* class_data */
94 (GInstanceInitFunc) gtk_object_init,
95 NULL, /* value_table */
98 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkObject",
99 &object_info, G_TYPE_FLAG_ABSTRACT);
106 gtk_object_base_class_init (GtkObjectClass *class)
108 /* reset instance specifc methods that don't get inherited */
109 class->get_arg = NULL;
110 class->set_arg = NULL;
114 gtk_object_base_class_finalize (GtkObjectClass *class)
118 static inline gboolean
119 gtk_arg_set_from_value (GtkArg *arg,
121 gboolean copy_string)
123 switch (G_TYPE_FUNDAMENTAL (arg->type))
125 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
126 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
127 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
128 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
129 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
130 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
131 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
132 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
133 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
134 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
135 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
136 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
137 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
138 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
139 case G_TYPE_STRING: if (copy_string)
140 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
142 GTK_VALUE_STRING (*arg) = (char *) g_value_get_string (value);
150 static inline gboolean
151 gtk_arg_to_value (GtkArg *arg,
154 switch (G_TYPE_FUNDAMENTAL (arg->type))
156 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
157 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
158 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
159 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
160 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
161 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
162 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
163 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
164 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
165 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
166 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
167 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
168 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
169 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
170 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
178 gtk_arg_proxy_set_property (GObject *object,
183 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
186 g_return_if_fail (class->set_arg != NULL);
188 memset (&arg, 0, sizeof (arg));
189 arg.type = G_VALUE_TYPE (value);
190 gtk_arg_set_from_value (&arg, value, FALSE);
191 arg.name = pspec->name;
192 class->set_arg (GTK_OBJECT (object), &arg, property_id);
196 gtk_arg_proxy_get_property (GObject *object,
201 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
204 g_return_if_fail (class->get_arg != NULL);
206 memset (&arg, 0, sizeof (arg));
207 arg.type = G_VALUE_TYPE (value);
208 arg.name = pspec->name;
209 class->get_arg (GTK_OBJECT (object), &arg, property_id);
210 gtk_arg_to_value (&arg, value);
214 gtk_object_add_arg_type (const gchar *arg_name,
219 GObjectClass *oclass;
221 gchar *type_name, *pname;
224 g_return_if_fail (arg_name != NULL);
225 g_return_if_fail (arg_type > G_TYPE_NONE);
226 g_return_if_fail (arg_id > 0);
227 g_return_if_fail (arg_flags & G_PARAM_READWRITE);
228 if (arg_flags & G_PARAM_CONSTRUCT)
229 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
230 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
231 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
232 g_return_if_fail ((arg_flags & ~(G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_NAME)) == 0);
234 pname = strchr (arg_name, ':');
235 g_return_if_fail (pname && pname[1] == ':');
237 type_name = g_strndup (arg_name, pname - arg_name);
239 type = g_type_from_name (type_name);
241 g_return_if_fail (G_TYPE_IS_OBJECT (type));
243 oclass = gtk_type_class (type);
244 if (arg_flags & G_PARAM_READABLE)
246 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
248 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
252 oclass->get_property = gtk_arg_proxy_get_property;
254 if (arg_flags & G_PARAM_WRITABLE)
256 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
258 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
262 oclass->set_property = gtk_arg_proxy_set_property;
264 switch (G_TYPE_FUNDAMENTAL (arg_type))
267 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
270 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
273 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
276 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
279 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
282 pspec = g_param_spec_int (pname, NULL, NULL, G_MININT, G_MAXINT, 0, arg_flags);
285 pspec = g_param_spec_uint (pname, NULL, NULL, 0, G_MAXUINT, 0, arg_flags);
288 pspec = g_param_spec_float (pname, NULL, NULL, -G_MAXFLOAT, G_MAXFLOAT, 0, arg_flags);
291 pspec = g_param_spec_double (pname, NULL, NULL, -G_MAXDOUBLE, G_MAXDOUBLE, 0, arg_flags);
294 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
297 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
300 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
303 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
305 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
309 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
310 g_type_name (arg_type));
313 g_object_class_install_property (oclass, arg_id, pspec);
317 gtk_object_class_init (GtkObjectClass *class)
319 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
321 parent_class = g_type_class_ref (G_TYPE_OBJECT);
323 gobject_class->set_property = gtk_object_set_property;
324 gobject_class->get_property = gtk_object_get_property;
325 gobject_class->dispose = gtk_object_dispose;
326 gobject_class->finalize = gtk_object_finalize;
328 class->destroy = gtk_object_real_destroy;
330 g_object_class_install_property (gobject_class,
332 g_param_spec_pointer ("user-data", "User Data",
333 "Anonymous User Data Pointer",
334 GTK_PARAM_READWRITE));
335 object_signals[DESTROY] =
336 g_signal_new ("destroy",
337 G_TYPE_FROM_CLASS (gobject_class),
338 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
339 G_STRUCT_OFFSET (GtkObjectClass, destroy),
341 _gtk_marshal_VOID__VOID,
346 gtk_object_init (GtkObject *object,
347 GtkObjectClass *klass)
349 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
352 /********************************************
353 * Functions to end a GtkObject's life time
355 ********************************************/
357 gtk_object_destroy (GtkObject *object)
359 g_return_if_fail (object != NULL);
360 g_return_if_fail (GTK_IS_OBJECT (object));
362 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
363 g_object_run_dispose (G_OBJECT (object));
367 gtk_object_dispose (GObject *gobject)
369 GtkObject *object = GTK_OBJECT (gobject);
371 /* guard against reinvocations during
372 * destruction with the GTK_IN_DESTRUCTION flag.
374 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
376 GTK_OBJECT_SET_FLAGS (object, GTK_IN_DESTRUCTION);
378 g_signal_emit (object, object_signals[DESTROY], 0);
380 GTK_OBJECT_UNSET_FLAGS (object, GTK_IN_DESTRUCTION);
383 G_OBJECT_CLASS (parent_class)->dispose (gobject);
387 gtk_object_real_destroy (GtkObject *object)
389 g_signal_handlers_destroy (object);
393 gtk_object_finalize (GObject *gobject)
395 GtkObject *object = GTK_OBJECT (gobject);
397 if (GTK_OBJECT_FLOATING (object))
399 g_warning ("A floating object was finalized. This means that someone\n"
400 "called g_object_unref() on an object that had only a floating\n"
401 "reference; the initial floating reference is not owned by anyone\n"
402 "and must be removed with gtk_object_sink() after a normal\n"
403 "reference is obtained with g_object_ref().");
406 gtk_object_notify_weaks (object);
408 G_OBJECT_CLASS (parent_class)->finalize (gobject);
411 /*****************************************
412 * GtkObject argument handlers
414 *****************************************/
417 gtk_object_set_property (GObject *object,
425 g_object_set_data (G_OBJECT (object), "user_data", g_value_get_pointer (value));
428 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
434 gtk_object_get_property (GObject *object,
442 g_value_set_pointer (value, g_object_get_data (G_OBJECT (object), "user_data"));
445 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
450 /*****************************************
456 *****************************************/
459 gtk_object_sink (GtkObject *object)
461 g_return_if_fail (GTK_IS_OBJECT (object));
463 if (GTK_OBJECT_FLOATING (object))
465 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
466 g_object_unref (object);
470 /*****************************************
473 * Weak refs are very similar to the old "destroy" signal. They allow
474 * one to register a callback that is called when the weakly
475 * referenced object is finalized.
477 * They are not implemented as a signal because they really are
478 * special and need to be used with great care. Unlike signals, which
479 * should be able to execute any code whatsoever.
481 * A weakref callback is not allowed to retain a reference to the
482 * object. Object data keys may be retrieved in a weak reference
485 * A weakref callback is called at most once.
487 *****************************************/
489 typedef struct _GtkWeakRef GtkWeakRef;
494 GtkDestroyNotify notify;
499 gtk_object_weakref (GtkObject *object,
500 GtkDestroyNotify notify,
505 g_return_if_fail (notify != NULL);
506 g_return_if_fail (GTK_IS_OBJECT (object));
509 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
511 weak = g_new (GtkWeakRef, 1);
512 weak->next = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
513 weak->notify = notify;
515 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, weak);
519 gtk_object_weakunref (GtkObject *object,
520 GtkDestroyNotify notify,
523 GtkWeakRef *weaks, *w, **wp;
525 g_return_if_fail (GTK_IS_OBJECT (object));
530 weaks = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
531 for (wp = &weaks; *wp; wp = &(*wp)->next)
534 if (w->notify == notify && w->data == data)
537 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, w->next);
547 gtk_object_notify_weaks (GtkObject *object)
553 w1 = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
557 w1->notify (w1->data);
566 gtk_object_new (GtkType object_type,
567 const gchar *first_property_name,
573 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
575 va_start (var_args, first_property_name);
576 object = (GtkObject *)g_object_new_valist (object_type, first_property_name, var_args);
583 gtk_object_get (GtkObject *object,
584 const gchar *first_property_name,
589 g_return_if_fail (GTK_IS_OBJECT (object));
591 va_start (var_args, first_property_name);
592 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
597 gtk_object_set (GtkObject *object,
598 const gchar *first_property_name,
603 g_return_if_fail (GTK_IS_OBJECT (object));
605 va_start (var_args, first_property_name);
606 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
610 /*****************************************
611 * GtkObject object_data mechanism
613 *****************************************/
616 gtk_object_set_data_by_id (GtkObject *object,
620 g_return_if_fail (GTK_IS_OBJECT (object));
622 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
626 gtk_object_set_data (GtkObject *object,
630 g_return_if_fail (GTK_IS_OBJECT (object));
631 g_return_if_fail (key != NULL);
633 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
637 gtk_object_set_data_by_id_full (GtkObject *object,
640 GtkDestroyNotify destroy)
642 g_return_if_fail (GTK_IS_OBJECT (object));
644 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
648 gtk_object_set_data_full (GtkObject *object,
651 GtkDestroyNotify destroy)
653 g_return_if_fail (GTK_IS_OBJECT (object));
654 g_return_if_fail (key != NULL);
656 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
660 gtk_object_get_data_by_id (GtkObject *object,
663 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
665 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
669 gtk_object_get_data (GtkObject *object,
672 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
673 g_return_val_if_fail (key != NULL, NULL);
675 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
679 gtk_object_remove_data_by_id (GtkObject *object,
682 g_return_if_fail (GTK_IS_OBJECT (object));
684 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
688 gtk_object_remove_data (GtkObject *object,
691 g_return_if_fail (GTK_IS_OBJECT (object));
692 g_return_if_fail (key != NULL);
694 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
698 gtk_object_remove_no_notify_by_id (GtkObject *object,
701 g_return_if_fail (GTK_IS_OBJECT (object));
703 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
707 gtk_object_remove_no_notify (GtkObject *object,
710 g_return_if_fail (GTK_IS_OBJECT (object));
711 g_return_if_fail (key != NULL);
713 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
717 gtk_object_set_user_data (GtkObject *object,
720 g_return_if_fail (GTK_IS_OBJECT (object));
722 g_object_set_data (G_OBJECT (object), "user_data", data);
726 gtk_object_get_user_data (GtkObject *object)
728 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
730 return g_object_get_data (G_OBJECT (object), "user_data");
734 gtk_object_ref (GtkObject *object)
736 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
738 return (GtkObject*) g_object_ref ((GObject*) object);
742 gtk_object_unref (GtkObject *object)
744 g_return_if_fail (GTK_IS_OBJECT (object));
746 g_object_unref ((GObject*) object);
749 #define __GTK_OBJECT_C__
750 #include "gtkaliasdef.c"