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"
33 #include "gtkmarshalers.h"
34 #include "gtksignal.h"
35 #include "gtkprivate.h"
49 extern void gtk_object_init_type (void); /* for gtktypeutils.h */
50 static void gtk_object_base_class_init (GtkObjectClass *class);
51 static void gtk_object_base_class_finalize (GtkObjectClass *class);
52 static void gtk_object_class_init (GtkObjectClass *klass);
53 static void gtk_object_init (GtkObject *object,
54 GtkObjectClass *klass);
55 static void gtk_object_set_property (GObject *object,
59 static void gtk_object_get_property (GObject *object,
63 static void gtk_object_dispose (GObject *object);
64 static void gtk_object_real_destroy (GtkObject *object);
65 static void gtk_object_finalize (GObject *object);
66 static void gtk_object_notify_weaks (GtkObject *object);
68 static gpointer parent_class = NULL;
69 static guint object_signals[LAST_SIGNAL] = { 0 };
70 static GQuark quark_weakrefs = 0;
73 /****************************************************
74 * GtkObject type, class and instance initialization
76 ****************************************************/
79 gtk_object_get_type (void)
81 static GType object_type = 0;
85 static const GTypeInfo object_info =
87 sizeof (GtkObjectClass),
88 (GBaseInitFunc) gtk_object_base_class_init,
89 (GBaseFinalizeFunc) gtk_object_base_class_finalize,
90 (GClassInitFunc) gtk_object_class_init,
91 NULL, /* class_finalize */
92 NULL, /* class_data */
95 (GInstanceInitFunc) gtk_object_init,
96 NULL, /* value_table */
99 object_type = g_type_register_static (G_TYPE_OBJECT, I_("GtkObject"),
100 &object_info, G_TYPE_FLAG_ABSTRACT);
107 gtk_object_base_class_init (GtkObjectClass *class)
109 /* reset instance specifc methods that don't get inherited */
110 class->get_arg = NULL;
111 class->set_arg = NULL;
115 gtk_object_base_class_finalize (GtkObjectClass *class)
119 static inline gboolean
120 gtk_arg_set_from_value (GtkArg *arg,
122 gboolean copy_string)
124 switch (G_TYPE_FUNDAMENTAL (arg->type))
126 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
127 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
128 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
129 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
130 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
131 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
132 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
133 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
134 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
135 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
136 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
137 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
138 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
139 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
140 case G_TYPE_STRING: if (copy_string)
141 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
143 GTK_VALUE_STRING (*arg) = (char *) g_value_get_string (value);
151 static inline gboolean
152 gtk_arg_to_value (GtkArg *arg,
155 switch (G_TYPE_FUNDAMENTAL (arg->type))
157 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
158 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
159 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
160 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
161 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
162 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
163 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
164 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
165 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
166 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
167 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
168 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
169 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
170 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
171 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
179 gtk_arg_proxy_set_property (GObject *object,
184 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
187 g_return_if_fail (class->set_arg != NULL);
189 memset (&arg, 0, sizeof (arg));
190 arg.type = G_VALUE_TYPE (value);
191 gtk_arg_set_from_value (&arg, value, FALSE);
192 arg.name = pspec->name;
193 class->set_arg (GTK_OBJECT (object), &arg, property_id);
197 gtk_arg_proxy_get_property (GObject *object,
202 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
205 g_return_if_fail (class->get_arg != NULL);
207 memset (&arg, 0, sizeof (arg));
208 arg.type = G_VALUE_TYPE (value);
209 arg.name = pspec->name;
210 class->get_arg (GTK_OBJECT (object), &arg, property_id);
211 gtk_arg_to_value (&arg, value);
215 gtk_object_add_arg_type (const gchar *arg_name,
220 GObjectClass *oclass;
222 gchar *type_name, *pname;
225 g_return_if_fail (arg_name != NULL);
226 g_return_if_fail (arg_type > G_TYPE_NONE);
227 g_return_if_fail (arg_id > 0);
228 g_return_if_fail (arg_flags & G_PARAM_READWRITE);
229 if (arg_flags & G_PARAM_CONSTRUCT)
230 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
231 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
232 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
233 g_return_if_fail ((arg_flags & ~(G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_NAME)) == 0);
235 pname = strchr (arg_name, ':');
236 g_return_if_fail (pname && pname[1] == ':');
238 type_name = g_strndup (arg_name, pname - arg_name);
240 type = g_type_from_name (type_name);
242 g_return_if_fail (G_TYPE_IS_OBJECT (type));
244 oclass = gtk_type_class (type);
245 if (arg_flags & G_PARAM_READABLE)
247 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
249 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
253 oclass->get_property = gtk_arg_proxy_get_property;
255 if (arg_flags & G_PARAM_WRITABLE)
257 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
259 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
263 oclass->set_property = gtk_arg_proxy_set_property;
265 switch (G_TYPE_FUNDAMENTAL (arg_type))
268 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
271 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
274 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
277 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
280 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
283 pspec = g_param_spec_int (pname, NULL, NULL, G_MININT, G_MAXINT, 0, arg_flags);
286 pspec = g_param_spec_uint (pname, NULL, NULL, 0, G_MAXUINT, 0, arg_flags);
289 pspec = g_param_spec_float (pname, NULL, NULL, -G_MAXFLOAT, G_MAXFLOAT, 0, arg_flags);
292 pspec = g_param_spec_double (pname, NULL, NULL, -G_MAXDOUBLE, G_MAXDOUBLE, 0, arg_flags);
295 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
298 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
301 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
304 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
306 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
310 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
311 g_type_name (arg_type));
314 g_object_class_install_property (oclass, arg_id, pspec);
318 gtk_object_class_init (GtkObjectClass *class)
320 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
322 parent_class = g_type_class_ref (G_TYPE_OBJECT);
324 gobject_class->set_property = gtk_object_set_property;
325 gobject_class->get_property = gtk_object_get_property;
326 gobject_class->dispose = gtk_object_dispose;
327 gobject_class->finalize = gtk_object_finalize;
329 class->destroy = gtk_object_real_destroy;
331 g_object_class_install_property (gobject_class,
333 g_param_spec_pointer ("user-data",
335 P_("Anonymous User Data Pointer"),
336 GTK_PARAM_READWRITE));
337 object_signals[DESTROY] =
338 g_signal_new (I_("destroy"),
339 G_TYPE_FROM_CLASS (gobject_class),
340 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
341 G_STRUCT_OFFSET (GtkObjectClass, destroy),
343 _gtk_marshal_VOID__VOID,
348 gtk_object_init (GtkObject *object,
349 GtkObjectClass *klass)
351 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
354 /********************************************
355 * Functions to end a GtkObject's life time
357 ********************************************/
359 gtk_object_destroy (GtkObject *object)
361 g_return_if_fail (object != NULL);
362 g_return_if_fail (GTK_IS_OBJECT (object));
364 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
365 g_object_run_dispose (G_OBJECT (object));
369 gtk_object_dispose (GObject *gobject)
371 GtkObject *object = GTK_OBJECT (gobject);
373 /* guard against reinvocations during
374 * destruction with the GTK_IN_DESTRUCTION flag.
376 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
378 GTK_OBJECT_SET_FLAGS (object, GTK_IN_DESTRUCTION);
380 g_signal_emit (object, object_signals[DESTROY], 0);
382 GTK_OBJECT_UNSET_FLAGS (object, GTK_IN_DESTRUCTION);
385 G_OBJECT_CLASS (parent_class)->dispose (gobject);
389 gtk_object_real_destroy (GtkObject *object)
391 g_signal_handlers_destroy (object);
395 gtk_object_finalize (GObject *gobject)
397 GtkObject *object = GTK_OBJECT (gobject);
399 if (GTK_OBJECT_FLOATING (object))
401 g_warning ("A floating object was finalized. This means that someone\n"
402 "called g_object_unref() on an object that had only a floating\n"
403 "reference; the initial floating reference is not owned by anyone\n"
404 "and must be removed with gtk_object_sink() after a normal\n"
405 "reference is obtained with g_object_ref().");
408 gtk_object_notify_weaks (object);
410 G_OBJECT_CLASS (parent_class)->finalize (gobject);
413 /*****************************************
414 * GtkObject argument handlers
416 *****************************************/
419 gtk_object_set_property (GObject *object,
427 g_object_set_data (G_OBJECT (object), I_("user_data"), g_value_get_pointer (value));
430 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
436 gtk_object_get_property (GObject *object,
444 g_value_set_pointer (value, g_object_get_data (G_OBJECT (object), "user_data"));
447 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
452 /*****************************************
458 *****************************************/
461 gtk_object_sink (GtkObject *object)
463 g_return_if_fail (GTK_IS_OBJECT (object));
465 if (GTK_OBJECT_FLOATING (object))
467 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
468 g_object_unref (object);
472 /*****************************************
475 * Weak refs are very similar to the old "destroy" signal. They allow
476 * one to register a callback that is called when the weakly
477 * referenced object is finalized.
479 * They are not implemented as a signal because they really are
480 * special and need to be used with great care. Unlike signals, which
481 * should be able to execute any code whatsoever.
483 * A weakref callback is not allowed to retain a reference to the
484 * object. Object data keys may be retrieved in a weak reference
487 * A weakref callback is called at most once.
489 *****************************************/
491 typedef struct _GtkWeakRef GtkWeakRef;
496 GtkDestroyNotify notify;
501 gtk_object_weakref (GtkObject *object,
502 GtkDestroyNotify notify,
507 g_return_if_fail (notify != NULL);
508 g_return_if_fail (GTK_IS_OBJECT (object));
511 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
513 weak = g_new (GtkWeakRef, 1);
514 weak->next = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
515 weak->notify = notify;
517 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, weak);
521 gtk_object_weakunref (GtkObject *object,
522 GtkDestroyNotify notify,
525 GtkWeakRef *weaks, *w, **wp;
527 g_return_if_fail (GTK_IS_OBJECT (object));
532 weaks = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
533 for (wp = &weaks; *wp; wp = &(*wp)->next)
536 if (w->notify == notify && w->data == data)
539 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, w->next);
549 gtk_object_notify_weaks (GtkObject *object)
555 w1 = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
559 w1->notify (w1->data);
568 gtk_object_new (GtkType object_type,
569 const gchar *first_property_name,
575 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
577 va_start (var_args, first_property_name);
578 object = (GtkObject *)g_object_new_valist (object_type, first_property_name, var_args);
585 gtk_object_get (GtkObject *object,
586 const gchar *first_property_name,
591 g_return_if_fail (GTK_IS_OBJECT (object));
593 va_start (var_args, first_property_name);
594 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
599 gtk_object_set (GtkObject *object,
600 const gchar *first_property_name,
605 g_return_if_fail (GTK_IS_OBJECT (object));
607 va_start (var_args, first_property_name);
608 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
612 /*****************************************
613 * GtkObject object_data mechanism
615 *****************************************/
618 gtk_object_set_data_by_id (GtkObject *object,
622 g_return_if_fail (GTK_IS_OBJECT (object));
624 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
628 gtk_object_set_data (GtkObject *object,
632 g_return_if_fail (GTK_IS_OBJECT (object));
633 g_return_if_fail (key != NULL);
635 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
639 gtk_object_set_data_by_id_full (GtkObject *object,
642 GtkDestroyNotify destroy)
644 g_return_if_fail (GTK_IS_OBJECT (object));
646 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
650 gtk_object_set_data_full (GtkObject *object,
653 GtkDestroyNotify destroy)
655 g_return_if_fail (GTK_IS_OBJECT (object));
656 g_return_if_fail (key != NULL);
658 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
662 gtk_object_get_data_by_id (GtkObject *object,
665 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
667 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
671 gtk_object_get_data (GtkObject *object,
674 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
675 g_return_val_if_fail (key != NULL, NULL);
677 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
681 gtk_object_remove_data_by_id (GtkObject *object,
684 g_return_if_fail (GTK_IS_OBJECT (object));
686 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
690 gtk_object_remove_data (GtkObject *object,
693 g_return_if_fail (GTK_IS_OBJECT (object));
694 g_return_if_fail (key != NULL);
696 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
700 gtk_object_remove_no_notify_by_id (GtkObject *object,
703 g_return_if_fail (GTK_IS_OBJECT (object));
705 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
709 gtk_object_remove_no_notify (GtkObject *object,
712 g_return_if_fail (GTK_IS_OBJECT (object));
713 g_return_if_fail (key != NULL);
715 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
719 gtk_object_set_user_data (GtkObject *object,
722 g_return_if_fail (GTK_IS_OBJECT (object));
724 g_object_set_data (G_OBJECT (object), "user_data", data);
728 gtk_object_get_user_data (GtkObject *object)
730 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
732 return g_object_get_data (G_OBJECT (object), "user_data");
736 gtk_object_ref (GtkObject *object)
738 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
740 return (GtkObject*) g_object_ref ((GObject*) object);
744 gtk_object_unref (GtkObject *object)
746 g_return_if_fail (GTK_IS_OBJECT (object));
748 g_object_unref ((GObject*) object);
751 #define __GTK_OBJECT_C__
752 #include "gtkaliasdef.c"