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/.
30 #include "gtkobject.h"
31 #include "gtkmarshalers.h"
32 #include "gtksignal.h"
45 extern void gtk_object_init_type (void); /* for gtktypeutils.h */
46 static void gtk_object_base_class_init (GtkObjectClass *class);
47 static void gtk_object_base_class_finalize (GtkObjectClass *class);
48 static void gtk_object_class_init (GtkObjectClass *klass);
49 static void gtk_object_init (GtkObject *object,
50 GtkObjectClass *klass);
51 static void gtk_object_set_property (GObject *object,
55 static void gtk_object_get_property (GObject *object,
59 static void gtk_object_dispose (GObject *object);
60 static void gtk_object_real_destroy (GtkObject *object);
61 static void gtk_object_finalize (GObject *object);
62 static void gtk_object_notify_weaks (GtkObject *object);
64 static gpointer parent_class = NULL;
65 static guint object_signals[LAST_SIGNAL] = { 0 };
66 static GQuark quark_user_data = 0;
67 static GQuark quark_weakrefs = 0;
70 /****************************************************
71 * GtkObject type, class and instance initialization
73 ****************************************************/
76 gtk_object_get_type (void)
78 static GtkType object_type = 0;
82 static const GTypeInfo object_info =
84 sizeof (GtkObjectClass),
85 (GBaseInitFunc) gtk_object_base_class_init,
86 (GBaseFinalizeFunc) gtk_object_base_class_finalize,
87 (GClassInitFunc) gtk_object_class_init,
88 NULL, /* class_finalize */
89 NULL, /* class_data */
92 (GInstanceInitFunc) gtk_object_init,
95 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkObject", &object_info, 0);
102 gtk_object_base_class_init (GtkObjectClass *class)
104 /* reset instance specifc methods that don't get inherited */
105 class->get_arg = NULL;
106 class->set_arg = NULL;
110 gtk_object_base_class_finalize (GtkObjectClass *class)
114 static inline gboolean
115 gtk_arg_set_from_value (GtkArg *arg,
117 gboolean copy_string)
119 switch (G_TYPE_FUNDAMENTAL (arg->type))
121 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
122 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
123 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
124 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
125 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
126 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
127 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
128 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
129 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
130 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
131 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
132 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
133 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
134 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
135 case G_TYPE_STRING: if (copy_string)
136 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
138 GTK_VALUE_STRING (*arg) = (char *) g_value_get_string (value);
146 static inline gboolean
147 gtk_arg_to_value (GtkArg *arg,
150 switch (G_TYPE_FUNDAMENTAL (arg->type))
152 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
153 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
154 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
155 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
156 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
157 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
158 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
159 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
160 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
161 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
162 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
163 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
164 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
165 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
166 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
174 gtk_arg_proxy_set_property (GObject *object,
179 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
182 g_return_if_fail (class->set_arg != NULL);
184 memset (&arg, 0, sizeof (arg));
185 arg.type = G_VALUE_TYPE (value);
186 gtk_arg_set_from_value (&arg, value, FALSE);
187 arg.name = pspec->name;
188 class->set_arg (GTK_OBJECT (object), &arg, property_id);
192 gtk_arg_proxy_get_property (GObject *object,
197 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
200 g_return_if_fail (class->get_arg != NULL);
202 memset (&arg, 0, sizeof (arg));
203 arg.type = G_VALUE_TYPE (value);
204 arg.name = pspec->name;
205 class->get_arg (GTK_OBJECT (object), &arg, property_id);
206 gtk_arg_to_value (&arg, value);
210 gtk_object_add_arg_type (const gchar *arg_name,
215 GObjectClass *oclass;
217 gchar *type_name, *pname;
220 g_return_if_fail (arg_name != NULL);
221 g_return_if_fail (arg_type > G_TYPE_NONE);
222 g_return_if_fail (arg_id > 0);
223 g_return_if_fail (arg_flags & GTK_ARG_READWRITE);
224 if (arg_flags & G_PARAM_CONSTRUCT)
225 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
226 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
227 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
228 g_return_if_fail ((arg_flags & ~(GTK_ARG_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
230 pname = strchr (arg_name, ':');
231 g_return_if_fail (pname && pname[1] == ':');
233 type_name = g_strndup (arg_name, pname - arg_name);
235 type = g_type_from_name (type_name);
237 g_return_if_fail (G_TYPE_IS_OBJECT (type));
239 oclass = gtk_type_class (type);
240 if (arg_flags & GTK_ARG_READABLE)
242 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
244 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
248 oclass->get_property = gtk_arg_proxy_get_property;
250 if (arg_flags & GTK_ARG_WRITABLE)
252 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
254 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
258 oclass->set_property = gtk_arg_proxy_set_property;
260 switch (G_TYPE_FUNDAMENTAL (arg_type))
263 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
266 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
269 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
272 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
275 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
278 pspec = g_param_spec_int (pname, NULL, NULL, -2147483647, 2147483647, 0, arg_flags);
281 pspec = g_param_spec_uint (pname, NULL, NULL, 0, 4294967295U, 0, arg_flags);
284 pspec = g_param_spec_float (pname, NULL, NULL, -1E+37, 1E+37, 0, arg_flags);
287 pspec = g_param_spec_double (pname, NULL, NULL, -1E+307, 1E+307, 0, arg_flags);
290 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
293 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
296 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
299 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
301 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
305 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
306 g_type_name (arg_type));
309 g_object_class_install_property (oclass, arg_id, pspec);
313 gtk_object_class_init (GtkObjectClass *class)
315 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
317 parent_class = g_type_class_ref (G_TYPE_OBJECT);
319 gobject_class->set_property = gtk_object_set_property;
320 gobject_class->get_property = gtk_object_get_property;
321 gobject_class->dispose = gtk_object_dispose;
322 gobject_class->finalize = gtk_object_finalize;
324 class->destroy = gtk_object_real_destroy;
326 g_object_class_install_property (gobject_class,
328 g_param_spec_pointer ("user_data", "User Data",
329 "Anonymous User Data Pointer",
330 G_PARAM_READABLE | G_PARAM_WRITABLE));
331 object_signals[DESTROY] =
332 gtk_signal_new ("destroy",
333 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | GTK_RUN_NO_HOOKS,
334 GTK_CLASS_TYPE (class),
335 GTK_SIGNAL_OFFSET (GtkObjectClass, destroy),
336 _gtk_marshal_VOID__VOID,
341 gtk_object_init (GtkObject *object,
342 GtkObjectClass *klass)
344 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
347 /********************************************
348 * Functions to end a GtkObject's life time
350 ********************************************/
352 gtk_object_destroy (GtkObject *object)
354 g_return_if_fail (object != NULL);
355 g_return_if_fail (GTK_IS_OBJECT (object));
357 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
358 g_object_run_dispose (G_OBJECT (object));
362 gtk_object_dispose (GObject *gobject)
364 GtkObject *object = GTK_OBJECT (gobject);
366 /* guard against reinvocations during
367 * destruction with the GTK_IN_DESTRUCTION flag.
369 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
371 GTK_OBJECT_SET_FLAGS (object, GTK_IN_DESTRUCTION);
373 gtk_signal_emit (object, object_signals[DESTROY]);
375 GTK_OBJECT_UNSET_FLAGS (object, GTK_IN_DESTRUCTION);
378 G_OBJECT_CLASS (parent_class)->dispose (gobject);
382 gtk_object_real_destroy (GtkObject *object)
384 g_signal_handlers_destroy (G_OBJECT (object));
388 gtk_object_finalize (GObject *gobject)
390 GtkObject *object = GTK_OBJECT (gobject);
392 if (GTK_OBJECT_FLOATING (object))
394 g_warning ("A floating object was finalized. This means that someone\n"
395 "called g_object_unref() on an object that had only a floating\n"
396 "reference; the initial floating reference is not owned by anyone\n"
397 "and must be removed with gtk_object_sink() after a normal\n"
398 "reference is obtained with g_object_ref().");
401 gtk_object_notify_weaks (object);
403 G_OBJECT_CLASS (parent_class)->finalize (gobject);
406 /*****************************************
407 * GtkObject argument handlers
409 *****************************************/
412 gtk_object_set_property (GObject *object,
420 gtk_object_set_user_data (GTK_OBJECT (object), g_value_get_pointer (value));
423 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
429 gtk_object_get_property (GObject *object,
437 g_value_set_pointer (value, gtk_object_get_user_data (GTK_OBJECT (object)));
440 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
445 /*****************************************
451 *****************************************/
454 gtk_object_sink (GtkObject *object)
456 g_return_if_fail (GTK_IS_OBJECT (object));
458 if (GTK_OBJECT_FLOATING (object))
460 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
461 gtk_object_unref (object);
465 /*****************************************
468 * Weak refs are very similar to the old "destroy" signal. They allow
469 * one to register a callback that is called when the weakly
470 * referenced object is finalized.
472 * They are not implemented as a signal because they really are
473 * special and need to be used with great care. Unlike signals, which
474 * should be able to execute any code whatsoever.
476 * A weakref callback is not allowed to retain a reference to the
477 * object. Object data keys may be retrieved in a weak reference
480 * A weakref callback is called at most once.
482 *****************************************/
484 typedef struct _GtkWeakRef GtkWeakRef;
489 GtkDestroyNotify notify;
494 gtk_object_weakref (GtkObject *object,
495 GtkDestroyNotify notify,
500 g_return_if_fail (notify != NULL);
501 g_return_if_fail (GTK_IS_OBJECT (object));
504 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
506 weak = g_new (GtkWeakRef, 1);
507 weak->next = gtk_object_get_data_by_id (object, quark_weakrefs);
508 weak->notify = notify;
510 gtk_object_set_data_by_id (object, quark_weakrefs, weak);
514 gtk_object_weakunref (GtkObject *object,
515 GtkDestroyNotify notify,
518 GtkWeakRef *weaks, *w, **wp;
520 g_return_if_fail (GTK_IS_OBJECT (object));
525 weaks = gtk_object_get_data_by_id (object, quark_weakrefs);
526 for (wp = &weaks; *wp; wp = &(*wp)->next)
529 if (w->notify == notify && w->data == data)
532 gtk_object_set_data_by_id (object, quark_weakrefs, w->next);
542 gtk_object_notify_weaks (GtkObject *object)
548 w1 = gtk_object_get_data_by_id (object, quark_weakrefs);
552 w1->notify (w1->data);
561 gtk_object_new (GtkType object_type,
562 const gchar *first_property_name,
568 g_return_val_if_fail (GTK_TYPE_IS_OBJECT (object_type), NULL);
570 va_start (var_args, first_property_name);
571 object = (GtkObject *)g_object_new_valist (object_type, first_property_name, var_args);
578 gtk_object_get (GtkObject *object,
579 const gchar *first_property_name,
584 g_return_if_fail (GTK_IS_OBJECT (object));
586 va_start (var_args, first_property_name);
587 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
592 gtk_object_set (GtkObject *object,
593 const gchar *first_property_name,
598 g_return_if_fail (GTK_IS_OBJECT (object));
600 va_start (var_args, first_property_name);
601 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
605 /*****************************************
606 * GtkObject object_data mechanism
608 *****************************************/
611 gtk_object_set_data_by_id (GtkObject *object,
615 g_return_if_fail (GTK_IS_OBJECT (object));
617 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
621 gtk_object_set_data (GtkObject *object,
625 g_return_if_fail (GTK_IS_OBJECT (object));
626 g_return_if_fail (key != NULL);
628 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
632 gtk_object_set_data_by_id_full (GtkObject *object,
635 GtkDestroyNotify destroy)
637 g_return_if_fail (GTK_IS_OBJECT (object));
639 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
643 gtk_object_set_data_full (GtkObject *object,
646 GtkDestroyNotify destroy)
648 g_return_if_fail (GTK_IS_OBJECT (object));
649 g_return_if_fail (key != NULL);
651 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
655 gtk_object_get_data_by_id (GtkObject *object,
658 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
660 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
664 gtk_object_get_data (GtkObject *object,
667 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
668 g_return_val_if_fail (key != NULL, NULL);
670 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
674 gtk_object_remove_data_by_id (GtkObject *object,
677 g_return_if_fail (GTK_IS_OBJECT (object));
679 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
683 gtk_object_remove_data (GtkObject *object,
686 g_return_if_fail (GTK_IS_OBJECT (object));
687 g_return_if_fail (key != NULL);
689 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
693 gtk_object_remove_no_notify_by_id (GtkObject *object,
696 g_return_if_fail (GTK_IS_OBJECT (object));
698 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
702 gtk_object_remove_no_notify (GtkObject *object,
705 g_return_if_fail (GTK_IS_OBJECT (object));
706 g_return_if_fail (key != NULL);
708 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
712 gtk_object_set_user_data (GtkObject *object,
715 g_return_if_fail (GTK_IS_OBJECT (object));
717 if (!quark_user_data)
718 quark_user_data = g_quark_from_static_string ("user_data");
720 g_datalist_id_set_data (&G_OBJECT (object)->qdata, quark_user_data, data);
724 gtk_object_get_user_data (GtkObject *object)
726 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
728 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, quark_user_data);
732 gtk_object_ref (GtkObject *object)
734 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
736 return (GtkObject*) g_object_ref ((GObject*) object);
740 gtk_object_unref (GtkObject *object)
742 g_return_if_fail (GTK_IS_OBJECT (object));
744 g_object_unref ((GObject*) object);