1 /* GTK - The GTK+ 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/.
33 #undef GTK_DISABLE_DEPRECATED
35 #include "gtkobject.h"
37 #include "gtkmarshalers.h"
38 #include "gtkprivate.h"
40 #define GTK_DISABLE_DEPRECATED
54 static void gtk_object_base_class_init (GtkObjectClass *class);
55 static void gtk_object_base_class_finalize (GtkObjectClass *class);
56 static void gtk_object_class_init (GtkObjectClass *klass);
57 static void gtk_object_init (GtkObject *object,
58 GtkObjectClass *klass);
59 static void gtk_object_set_property (GObject *object,
63 static void gtk_object_get_property (GObject *object,
67 static void gtk_object_dispose (GObject *object);
68 static void gtk_object_real_destroy (GtkObject *object);
69 static void gtk_object_finalize (GObject *object);
70 static void gtk_object_notify_weaks (GtkObject *object);
72 static gpointer parent_class = NULL;
73 static guint object_signals[LAST_SIGNAL] = { 0 };
74 static GQuark quark_weakrefs = 0;
77 /****************************************************
78 * GtkObject type, class and instance initialization
80 ****************************************************/
83 gtk_object_get_type (void)
85 static GType object_type = 0;
89 const GTypeInfo object_info =
91 sizeof (GtkObjectClass),
92 (GBaseInitFunc) gtk_object_base_class_init,
93 (GBaseFinalizeFunc) gtk_object_base_class_finalize,
94 (GClassInitFunc) gtk_object_class_init,
95 NULL, /* class_finalize */
96 NULL, /* class_data */
99 (GInstanceInitFunc) gtk_object_init,
100 NULL, /* value_table */
103 object_type = g_type_register_static (G_TYPE_INITIALLY_UNOWNED, I_("GtkObject"),
104 &object_info, G_TYPE_FLAG_ABSTRACT);
111 gtk_object_base_class_init (GtkObjectClass *class)
113 /* reset instance specifc methods that don't get inherited */
114 class->get_arg = NULL;
115 class->set_arg = NULL;
119 gtk_object_base_class_finalize (GtkObjectClass *class)
123 static inline gboolean
124 gtk_arg_set_from_value (GtkArg *arg,
126 gboolean copy_string)
128 switch (G_TYPE_FUNDAMENTAL (arg->type))
130 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
131 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
132 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
133 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
134 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
135 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
136 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
137 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
138 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
139 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
140 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
141 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
142 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
143 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
144 case G_TYPE_STRING: if (copy_string)
145 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
147 GTK_VALUE_STRING (*arg) = (char *) g_value_get_string (value);
155 static inline gboolean
156 gtk_arg_to_value (GtkArg *arg,
159 switch (G_TYPE_FUNDAMENTAL (arg->type))
161 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
162 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
163 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
164 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
165 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
166 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
167 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
168 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
169 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
170 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
171 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
172 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
173 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
174 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
175 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
183 gtk_arg_proxy_set_property (GObject *object,
188 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
191 g_return_if_fail (class->set_arg != NULL);
193 memset (&arg, 0, sizeof (arg));
194 arg.type = G_VALUE_TYPE (value);
195 gtk_arg_set_from_value (&arg, value, FALSE);
196 arg.name = pspec->name;
197 class->set_arg (GTK_OBJECT (object), &arg, property_id);
201 gtk_arg_proxy_get_property (GObject *object,
206 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
209 g_return_if_fail (class->get_arg != NULL);
211 memset (&arg, 0, sizeof (arg));
212 arg.type = G_VALUE_TYPE (value);
213 arg.name = pspec->name;
214 class->get_arg (GTK_OBJECT (object), &arg, property_id);
215 gtk_arg_to_value (&arg, value);
219 gtk_object_add_arg_type (const gchar *arg_name,
224 GObjectClass *oclass;
226 gchar *type_name, *pname;
229 g_return_if_fail (arg_name != NULL);
230 g_return_if_fail (arg_type > G_TYPE_NONE);
231 g_return_if_fail (arg_id > 0);
232 g_return_if_fail (arg_flags & G_PARAM_READWRITE);
233 if (arg_flags & G_PARAM_CONSTRUCT)
234 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
235 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
236 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
237 g_return_if_fail ((arg_flags & ~(G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_NAME)) == 0);
239 pname = strchr (arg_name, ':');
240 g_return_if_fail (pname && pname[1] == ':');
242 type_name = g_strndup (arg_name, pname - arg_name);
244 type = g_type_from_name (type_name);
246 g_return_if_fail (G_TYPE_IS_OBJECT (type));
248 oclass = gtk_type_class (type);
249 if (arg_flags & G_PARAM_READABLE)
251 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
253 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
257 oclass->get_property = gtk_arg_proxy_get_property;
259 if (arg_flags & G_PARAM_WRITABLE)
261 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
263 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
267 oclass->set_property = gtk_arg_proxy_set_property;
269 switch (G_TYPE_FUNDAMENTAL (arg_type))
272 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
275 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
278 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
281 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
284 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
287 pspec = g_param_spec_int (pname, NULL, NULL, G_MININT, G_MAXINT, 0, arg_flags);
290 pspec = g_param_spec_uint (pname, NULL, NULL, 0, G_MAXUINT, 0, arg_flags);
293 pspec = g_param_spec_float (pname, NULL, NULL, -G_MAXFLOAT, G_MAXFLOAT, 0, arg_flags);
296 pspec = g_param_spec_double (pname, NULL, NULL, -G_MAXDOUBLE, G_MAXDOUBLE, 0, arg_flags);
299 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
302 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
305 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
308 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
310 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
314 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
315 g_type_name (arg_type));
318 g_object_class_install_property (oclass, arg_id, pspec);
321 static guint (*gobject_floating_flag_handler) (GtkObject*,gint) = NULL;
324 gtk_object_floating_flag_handler (GtkObject *object,
327 /* FIXME: remove this whole thing once GTK+ breaks ABI */
328 if (!GTK_IS_OBJECT (object))
329 return gobject_floating_flag_handler (object, job);
333 case +1: /* force floating if possible */
335 oldvalue = g_atomic_int_get (&object->flags);
336 while (!g_atomic_int_compare_and_exchange (&object->flags, oldvalue, oldvalue | GTK_FLOATING));
337 return oldvalue & GTK_FLOATING;
338 case -1: /* sink if possible */
340 oldvalue = g_atomic_int_get (&object->flags);
341 while (!g_atomic_int_compare_and_exchange (&object->flags, oldvalue, oldvalue & ~(guint32) GTK_FLOATING));
342 return oldvalue & GTK_FLOATING;
343 default: /* check floating */
344 return 0 != (g_atomic_int_get (&object->flags) & GTK_FLOATING);
349 gtk_object_class_init (GtkObjectClass *class)
351 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
352 gboolean is_glib_2_10_1;
354 parent_class = g_type_class_ref (G_TYPE_OBJECT);
356 is_glib_2_10_1 = g_object_compat_control (3, &gobject_floating_flag_handler);
358 g_error ("this version of Gtk+ requires GLib-2.10.1");
359 g_object_compat_control (2, gtk_object_floating_flag_handler);
361 gobject_class->set_property = gtk_object_set_property;
362 gobject_class->get_property = gtk_object_get_property;
363 gobject_class->dispose = gtk_object_dispose;
364 gobject_class->finalize = gtk_object_finalize;
366 class->destroy = gtk_object_real_destroy;
368 g_object_class_install_property (gobject_class,
370 g_param_spec_pointer ("user-data",
372 P_("Anonymous User Data Pointer"),
373 GTK_PARAM_READWRITE));
374 object_signals[DESTROY] =
375 g_signal_new (I_("destroy"),
376 G_TYPE_FROM_CLASS (gobject_class),
377 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
378 G_STRUCT_OFFSET (GtkObjectClass, destroy),
380 _gtk_marshal_VOID__VOID,
385 gtk_object_init (GtkObject *object,
386 GtkObjectClass *klass)
388 gboolean was_floating;
389 /* sink the GInitiallyUnowned floating flag */
390 was_floating = gobject_floating_flag_handler (object, -1);
391 /* set GTK_FLOATING via gtk_object_floating_flag_handler */
393 g_object_force_floating (G_OBJECT (object));
396 /********************************************
397 * Functions to end a GtkObject's life time
399 ********************************************/
401 gtk_object_destroy (GtkObject *object)
403 g_return_if_fail (object != NULL);
404 g_return_if_fail (GTK_IS_OBJECT (object));
406 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
407 g_object_run_dispose (G_OBJECT (object));
411 gtk_object_dispose (GObject *gobject)
413 GtkObject *object = GTK_OBJECT (gobject);
415 /* guard against reinvocations during
416 * destruction with the GTK_IN_DESTRUCTION flag.
418 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
420 GTK_OBJECT_SET_FLAGS (object, GTK_IN_DESTRUCTION);
422 g_signal_emit (object, object_signals[DESTROY], 0);
424 GTK_OBJECT_UNSET_FLAGS (object, GTK_IN_DESTRUCTION);
427 G_OBJECT_CLASS (parent_class)->dispose (gobject);
431 gtk_object_real_destroy (GtkObject *object)
433 g_signal_handlers_destroy (object);
437 gtk_object_finalize (GObject *gobject)
439 GtkObject *object = GTK_OBJECT (gobject);
441 if (g_object_is_floating (object))
443 g_warning ("A floating object was finalized. This means that someone\n"
444 "called g_object_unref() on an object that had only a floating\n"
445 "reference; the initial floating reference is not owned by anyone\n"
446 "and must be removed with g_object_ref_sink().");
449 gtk_object_notify_weaks (object);
451 G_OBJECT_CLASS (parent_class)->finalize (gobject);
454 /*****************************************
455 * GtkObject argument handlers
457 *****************************************/
460 gtk_object_set_property (GObject *object,
468 g_object_set_data (G_OBJECT (object), I_("user_data"), g_value_get_pointer (value));
471 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
477 gtk_object_get_property (GObject *object,
485 g_value_set_pointer (value, g_object_get_data (G_OBJECT (object), "user_data"));
488 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
494 gtk_object_sink (GtkObject *object)
496 g_return_if_fail (GTK_IS_OBJECT (object));
497 g_object_ref_sink (object);
498 g_object_unref (object);
501 /*****************************************
504 * Weak refs are very similar to the old "destroy" signal. They allow
505 * one to register a callback that is called when the weakly
506 * referenced object is finalized.
508 * They are not implemented as a signal because they really are
509 * special and need to be used with great care. Unlike signals, which
510 * should be able to execute any code whatsoever.
512 * A weakref callback is not allowed to retain a reference to the
513 * object. Object data keys may be retrieved in a weak reference
516 * A weakref callback is called at most once.
518 *****************************************/
520 typedef struct _GtkWeakRef GtkWeakRef;
525 GtkDestroyNotify notify;
530 gtk_object_weakref (GtkObject *object,
531 GtkDestroyNotify notify,
536 g_return_if_fail (notify != NULL);
537 g_return_if_fail (GTK_IS_OBJECT (object));
540 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
542 weak = g_new (GtkWeakRef, 1);
543 weak->next = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
544 weak->notify = notify;
546 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, weak);
550 gtk_object_weakunref (GtkObject *object,
551 GtkDestroyNotify notify,
554 GtkWeakRef *weaks, *w, **wp;
556 g_return_if_fail (GTK_IS_OBJECT (object));
561 weaks = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
562 for (wp = &weaks; *wp; wp = &(*wp)->next)
565 if (w->notify == notify && w->data == data)
568 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, w->next);
578 gtk_object_notify_weaks (GtkObject *object)
584 w1 = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
588 w1->notify (w1->data);
597 gtk_object_new (GtkType object_type,
598 const gchar *first_property_name,
604 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
606 va_start (var_args, first_property_name);
607 object = (GtkObject *)g_object_new_valist (object_type, first_property_name, var_args);
614 gtk_object_get (GtkObject *object,
615 const gchar *first_property_name,
620 g_return_if_fail (GTK_IS_OBJECT (object));
622 va_start (var_args, first_property_name);
623 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
628 gtk_object_set (GtkObject *object,
629 const gchar *first_property_name,
634 g_return_if_fail (GTK_IS_OBJECT (object));
636 va_start (var_args, first_property_name);
637 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
641 /*****************************************
642 * GtkObject object_data mechanism
644 *****************************************/
647 gtk_object_set_data_by_id (GtkObject *object,
651 g_return_if_fail (GTK_IS_OBJECT (object));
653 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
657 gtk_object_set_data (GtkObject *object,
661 g_return_if_fail (GTK_IS_OBJECT (object));
662 g_return_if_fail (key != NULL);
664 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
668 gtk_object_set_data_by_id_full (GtkObject *object,
671 GtkDestroyNotify destroy)
673 g_return_if_fail (GTK_IS_OBJECT (object));
675 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
679 gtk_object_set_data_full (GtkObject *object,
682 GtkDestroyNotify destroy)
684 g_return_if_fail (GTK_IS_OBJECT (object));
685 g_return_if_fail (key != NULL);
687 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
691 gtk_object_get_data_by_id (GtkObject *object,
694 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
696 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
700 gtk_object_get_data (GtkObject *object,
703 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
704 g_return_val_if_fail (key != NULL, NULL);
706 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
710 gtk_object_remove_data_by_id (GtkObject *object,
713 g_return_if_fail (GTK_IS_OBJECT (object));
715 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
719 gtk_object_remove_data (GtkObject *object,
722 g_return_if_fail (GTK_IS_OBJECT (object));
723 g_return_if_fail (key != NULL);
725 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
729 gtk_object_remove_no_notify_by_id (GtkObject *object,
732 g_return_if_fail (GTK_IS_OBJECT (object));
734 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
738 gtk_object_remove_no_notify (GtkObject *object,
741 g_return_if_fail (GTK_IS_OBJECT (object));
742 g_return_if_fail (key != NULL);
744 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
748 gtk_object_set_user_data (GtkObject *object,
751 g_return_if_fail (GTK_IS_OBJECT (object));
753 g_object_set_data (G_OBJECT (object), "user_data", data);
757 gtk_object_get_user_data (GtkObject *object)
759 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
761 return g_object_get_data (G_OBJECT (object), "user_data");
765 gtk_object_ref (GtkObject *object)
767 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
769 return (GtkObject*) g_object_ref ((GObject*) object);
773 gtk_object_unref (GtkObject *object)
775 g_return_if_fail (GTK_IS_OBJECT (object));
777 g_object_unref ((GObject*) object);
780 #define __GTK_OBJECT_C__
781 #include "gtkaliasdef.c"