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 GType 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,
93 NULL, /* value_table */
96 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkObject",
97 &object_info, G_TYPE_FLAG_ABSTRACT);
104 gtk_object_base_class_init (GtkObjectClass *class)
106 /* reset instance specifc methods that don't get inherited */
107 class->get_arg = NULL;
108 class->set_arg = NULL;
112 gtk_object_base_class_finalize (GtkObjectClass *class)
116 static inline gboolean
117 gtk_arg_set_from_value (GtkArg *arg,
119 gboolean copy_string)
121 switch (G_TYPE_FUNDAMENTAL (arg->type))
123 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
124 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
125 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
126 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
127 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
128 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
129 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
130 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
131 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
132 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
133 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
134 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
135 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
136 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
137 case G_TYPE_STRING: if (copy_string)
138 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
140 GTK_VALUE_STRING (*arg) = (char *) g_value_get_string (value);
148 static inline gboolean
149 gtk_arg_to_value (GtkArg *arg,
152 switch (G_TYPE_FUNDAMENTAL (arg->type))
154 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
155 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
156 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
157 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
158 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
159 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
160 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
161 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
162 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
163 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
164 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
165 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
166 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
167 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
168 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
176 gtk_arg_proxy_set_property (GObject *object,
181 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
184 g_return_if_fail (class->set_arg != NULL);
186 memset (&arg, 0, sizeof (arg));
187 arg.type = G_VALUE_TYPE (value);
188 gtk_arg_set_from_value (&arg, value, FALSE);
189 arg.name = pspec->name;
190 class->set_arg (GTK_OBJECT (object), &arg, property_id);
194 gtk_arg_proxy_get_property (GObject *object,
199 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
202 g_return_if_fail (class->get_arg != NULL);
204 memset (&arg, 0, sizeof (arg));
205 arg.type = G_VALUE_TYPE (value);
206 arg.name = pspec->name;
207 class->get_arg (GTK_OBJECT (object), &arg, property_id);
208 gtk_arg_to_value (&arg, value);
212 gtk_object_add_arg_type (const gchar *arg_name,
217 GObjectClass *oclass;
219 gchar *type_name, *pname;
222 g_return_if_fail (arg_name != NULL);
223 g_return_if_fail (arg_type > G_TYPE_NONE);
224 g_return_if_fail (arg_id > 0);
225 g_return_if_fail (arg_flags & G_PARAM_READWRITE);
226 if (arg_flags & G_PARAM_CONSTRUCT)
227 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
228 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
229 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
230 g_return_if_fail ((arg_flags & ~(G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
232 pname = strchr (arg_name, ':');
233 g_return_if_fail (pname && pname[1] == ':');
235 type_name = g_strndup (arg_name, pname - arg_name);
237 type = g_type_from_name (type_name);
239 g_return_if_fail (G_TYPE_IS_OBJECT (type));
241 oclass = gtk_type_class (type);
242 if (arg_flags & G_PARAM_READABLE)
244 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
246 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
250 oclass->get_property = gtk_arg_proxy_get_property;
252 if (arg_flags & G_PARAM_WRITABLE)
254 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
256 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
260 oclass->set_property = gtk_arg_proxy_set_property;
262 switch (G_TYPE_FUNDAMENTAL (arg_type))
265 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
268 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
271 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
274 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
277 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
280 pspec = g_param_spec_int (pname, NULL, NULL, -2147483647, 2147483647, 0, arg_flags);
283 pspec = g_param_spec_uint (pname, NULL, NULL, 0, 4294967295U, 0, arg_flags);
286 pspec = g_param_spec_float (pname, NULL, NULL, -1E+37, 1E+37, 0, arg_flags);
289 pspec = g_param_spec_double (pname, NULL, NULL, -1E+307, 1E+307, 0, arg_flags);
292 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
295 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
298 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
301 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
303 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
307 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
308 g_type_name (arg_type));
311 g_object_class_install_property (oclass, arg_id, pspec);
315 gtk_object_class_init (GtkObjectClass *class)
317 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
319 parent_class = g_type_class_ref (G_TYPE_OBJECT);
321 gobject_class->set_property = gtk_object_set_property;
322 gobject_class->get_property = gtk_object_get_property;
323 gobject_class->dispose = gtk_object_dispose;
324 gobject_class->finalize = gtk_object_finalize;
326 class->destroy = gtk_object_real_destroy;
328 g_object_class_install_property (gobject_class,
330 g_param_spec_pointer ("user_data", "User Data",
331 "Anonymous User Data Pointer",
332 G_PARAM_READABLE | G_PARAM_WRITABLE));
333 object_signals[DESTROY] =
334 g_signal_new ("destroy",
335 G_TYPE_FROM_CLASS (gobject_class),
336 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
337 G_STRUCT_OFFSET (GtkObjectClass, destroy),
339 _gtk_marshal_VOID__VOID,
344 gtk_object_init (GtkObject *object,
345 GtkObjectClass *klass)
347 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
350 /********************************************
351 * Functions to end a GtkObject's life time
353 ********************************************/
355 gtk_object_destroy (GtkObject *object)
357 g_return_if_fail (object != NULL);
358 g_return_if_fail (GTK_IS_OBJECT (object));
360 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
361 g_object_run_dispose (G_OBJECT (object));
365 gtk_object_dispose (GObject *gobject)
367 GtkObject *object = GTK_OBJECT (gobject);
369 /* guard against reinvocations during
370 * destruction with the GTK_IN_DESTRUCTION flag.
372 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
374 GTK_OBJECT_SET_FLAGS (object, GTK_IN_DESTRUCTION);
376 g_signal_emit (object, object_signals[DESTROY], 0);
378 GTK_OBJECT_UNSET_FLAGS (object, GTK_IN_DESTRUCTION);
381 G_OBJECT_CLASS (parent_class)->dispose (gobject);
385 gtk_object_real_destroy (GtkObject *object)
387 g_signal_handlers_destroy (object);
391 gtk_object_finalize (GObject *gobject)
393 GtkObject *object = GTK_OBJECT (gobject);
395 if (GTK_OBJECT_FLOATING (object))
397 g_warning ("A floating object was finalized. This means that someone\n"
398 "called g_object_unref() on an object that had only a floating\n"
399 "reference; the initial floating reference is not owned by anyone\n"
400 "and must be removed with gtk_object_sink() after a normal\n"
401 "reference is obtained with g_object_ref().");
404 gtk_object_notify_weaks (object);
406 G_OBJECT_CLASS (parent_class)->finalize (gobject);
409 /*****************************************
410 * GtkObject argument handlers
412 *****************************************/
415 gtk_object_set_property (GObject *object,
423 g_object_set_data (G_OBJECT (object), "user_data", g_value_get_pointer (value));
426 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
432 gtk_object_get_property (GObject *object,
440 g_value_set_pointer (value, g_object_get_data (G_OBJECT (object), "user_data"));
443 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
448 /*****************************************
454 *****************************************/
457 gtk_object_sink (GtkObject *object)
459 g_return_if_fail (GTK_IS_OBJECT (object));
461 if (GTK_OBJECT_FLOATING (object))
463 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
464 g_object_unref (object);
468 /*****************************************
471 * Weak refs are very similar to the old "destroy" signal. They allow
472 * one to register a callback that is called when the weakly
473 * referenced object is finalized.
475 * They are not implemented as a signal because they really are
476 * special and need to be used with great care. Unlike signals, which
477 * should be able to execute any code whatsoever.
479 * A weakref callback is not allowed to retain a reference to the
480 * object. Object data keys may be retrieved in a weak reference
483 * A weakref callback is called at most once.
485 *****************************************/
487 typedef struct _GtkWeakRef GtkWeakRef;
492 GtkDestroyNotify notify;
497 gtk_object_weakref (GtkObject *object,
498 GtkDestroyNotify notify,
503 g_return_if_fail (notify != NULL);
504 g_return_if_fail (GTK_IS_OBJECT (object));
507 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
509 weak = g_new (GtkWeakRef, 1);
510 weak->next = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
511 weak->notify = notify;
513 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, weak);
517 gtk_object_weakunref (GtkObject *object,
518 GtkDestroyNotify notify,
521 GtkWeakRef *weaks, *w, **wp;
523 g_return_if_fail (GTK_IS_OBJECT (object));
528 weaks = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
529 for (wp = &weaks; *wp; wp = &(*wp)->next)
532 if (w->notify == notify && w->data == data)
535 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, w->next);
545 gtk_object_notify_weaks (GtkObject *object)
551 w1 = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
555 w1->notify (w1->data);
564 gtk_object_new (GtkType object_type,
565 const gchar *first_property_name,
571 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
573 va_start (var_args, first_property_name);
574 object = (GtkObject *)g_object_new_valist (object_type, first_property_name, var_args);
581 gtk_object_get (GtkObject *object,
582 const gchar *first_property_name,
587 g_return_if_fail (GTK_IS_OBJECT (object));
589 va_start (var_args, first_property_name);
590 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
595 gtk_object_set (GtkObject *object,
596 const gchar *first_property_name,
601 g_return_if_fail (GTK_IS_OBJECT (object));
603 va_start (var_args, first_property_name);
604 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
608 /*****************************************
609 * GtkObject object_data mechanism
611 *****************************************/
614 gtk_object_set_data_by_id (GtkObject *object,
618 g_return_if_fail (GTK_IS_OBJECT (object));
620 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
624 gtk_object_set_data (GtkObject *object,
628 g_return_if_fail (GTK_IS_OBJECT (object));
629 g_return_if_fail (key != NULL);
631 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
635 gtk_object_set_data_by_id_full (GtkObject *object,
638 GtkDestroyNotify destroy)
640 g_return_if_fail (GTK_IS_OBJECT (object));
642 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
646 gtk_object_set_data_full (GtkObject *object,
649 GtkDestroyNotify destroy)
651 g_return_if_fail (GTK_IS_OBJECT (object));
652 g_return_if_fail (key != NULL);
654 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
658 gtk_object_get_data_by_id (GtkObject *object,
661 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
663 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
667 gtk_object_get_data (GtkObject *object,
670 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
671 g_return_val_if_fail (key != NULL, NULL);
673 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
677 gtk_object_remove_data_by_id (GtkObject *object,
680 g_return_if_fail (GTK_IS_OBJECT (object));
682 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
686 gtk_object_remove_data (GtkObject *object,
689 g_return_if_fail (GTK_IS_OBJECT (object));
690 g_return_if_fail (key != NULL);
692 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
696 gtk_object_remove_no_notify_by_id (GtkObject *object,
699 g_return_if_fail (GTK_IS_OBJECT (object));
701 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
705 gtk_object_remove_no_notify (GtkObject *object,
708 g_return_if_fail (GTK_IS_OBJECT (object));
709 g_return_if_fail (key != NULL);
711 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
715 gtk_object_set_user_data (GtkObject *object,
718 g_return_if_fail (GTK_IS_OBJECT (object));
720 if (!quark_user_data)
721 quark_user_data = g_quark_from_static_string ("user_data");
723 g_datalist_id_set_data (&G_OBJECT (object)->qdata, quark_user_data, data);
727 gtk_object_get_user_data (GtkObject *object)
729 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
731 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, quark_user_data);
735 gtk_object_ref (GtkObject *object)
737 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
739 return (GtkObject*) g_object_ref ((GObject*) object);
743 gtk_object_unref (GtkObject *object)
745 g_return_if_fail (GTK_IS_OBJECT (object));
747 g_object_unref ((GObject*) object);