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 "gtksignal.h"
44 extern void gtk_object_init_type (void); /* for gtktypeutils.h */
45 static void gtk_object_base_class_init (GtkObjectClass *class);
46 static void gtk_object_base_class_finalize (GtkObjectClass *class);
47 static void gtk_object_class_init (GtkObjectClass *klass);
48 static void gtk_object_init (GtkObject *object,
49 GtkObjectClass *klass);
50 static void gtk_object_set_property (GObject *object,
54 static void gtk_object_get_property (GObject *object,
58 static void gtk_object_dispose (GObject *object);
59 static void gtk_object_real_destroy (GtkObject *object);
60 static void gtk_object_finalize (GObject *object);
61 static void gtk_object_notify_weaks (GtkObject *object);
63 static gpointer parent_class = NULL;
64 static guint object_signals[LAST_SIGNAL] = { 0 };
65 static GQuark quark_user_data = 0;
66 static GQuark quark_weakrefs = 0;
69 /****************************************************
70 * GtkObject type, class and instance initialization
72 ****************************************************/
75 gtk_object_get_type (void)
77 static GtkType object_type = 0;
81 static const GTypeInfo object_info =
83 sizeof (GtkObjectClass),
84 (GBaseInitFunc) gtk_object_base_class_init,
85 (GBaseFinalizeFunc) gtk_object_base_class_finalize,
86 (GClassInitFunc) gtk_object_class_init,
87 NULL, /* class_finalize */
88 NULL, /* class_data */
91 (GInstanceInitFunc) gtk_object_init,
94 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkObject", &object_info, 0);
101 gtk_object_base_class_init (GtkObjectClass *class)
103 /* reset instance specifc methods that don't get inherited */
104 class->get_arg = NULL;
105 class->set_arg = NULL;
109 gtk_object_base_class_finalize (GtkObjectClass *class)
113 static inline gboolean
114 gtk_arg_set_from_value (GtkArg *arg,
116 gboolean copy_string)
118 switch (G_TYPE_FUNDAMENTAL (arg->type))
120 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
121 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
122 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
123 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
124 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
125 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
126 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
127 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
128 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
129 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
130 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
131 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
132 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
133 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
134 case G_TYPE_STRING: if (copy_string)
135 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
137 GTK_VALUE_STRING (*arg) = g_value_get_string (value);
145 static inline gboolean
146 gtk_arg_to_value (GtkArg *arg,
149 switch (G_TYPE_FUNDAMENTAL (arg->type))
151 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
152 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
153 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
154 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
155 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
156 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
157 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
158 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
159 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
160 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
161 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
162 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
163 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
164 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
165 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
173 gtk_arg_proxy_set_property (GObject *object,
178 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
181 g_return_if_fail (class->set_arg != NULL);
183 memset (&arg, 0, sizeof (arg));
184 arg.type = G_VALUE_TYPE (value);
185 gtk_arg_set_from_value (&arg, value, FALSE);
186 arg.name = pspec->name;
187 class->set_arg (GTK_OBJECT (object), &arg, property_id);
191 gtk_arg_proxy_get_property (GObject *object,
196 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
199 g_return_if_fail (class->get_arg != NULL);
201 memset (&arg, 0, sizeof (arg));
202 arg.type = G_VALUE_TYPE (value);
203 arg.name = pspec->name;
204 class->get_arg (GTK_OBJECT (object), &arg, property_id);
205 gtk_arg_to_value (&arg, value);
209 gtk_object_add_arg_type (const gchar *arg_name,
214 GObjectClass *oclass;
216 gchar *type_name, *pname;
219 g_return_if_fail (arg_name != NULL);
220 g_return_if_fail (arg_type > G_TYPE_NONE);
221 g_return_if_fail (arg_id > 0);
222 g_return_if_fail (arg_flags & GTK_ARG_READWRITE);
223 if (arg_flags & G_PARAM_CONSTRUCT)
224 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
225 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
226 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
227 g_return_if_fail ((arg_flags & ~(GTK_ARG_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
229 pname = strchr (arg_name, ':');
230 g_return_if_fail (pname && pname[1] == ':');
232 type_name = g_strndup (arg_name, pname - arg_name);
234 type = g_type_from_name (type_name);
236 g_return_if_fail (G_TYPE_IS_OBJECT (type));
238 oclass = gtk_type_class (type);
239 if (arg_flags & GTK_ARG_READABLE)
241 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
243 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
247 oclass->get_property = gtk_arg_proxy_get_property;
249 if (arg_flags & GTK_ARG_WRITABLE)
251 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
253 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
257 oclass->set_property = gtk_arg_proxy_set_property;
259 switch (G_TYPE_FUNDAMENTAL (arg_type))
262 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
265 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
268 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
271 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
274 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
277 pspec = g_param_spec_int (pname, NULL, NULL, -2147483647, 2147483647, 0, arg_flags);
280 pspec = g_param_spec_uint (pname, NULL, NULL, 0, 4294967295U, 0, arg_flags);
283 pspec = g_param_spec_float (pname, NULL, NULL, -1E+37, 1E+37, 0, arg_flags);
286 pspec = g_param_spec_double (pname, NULL, NULL, -1E+307, 1E+307, 0, arg_flags);
289 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
292 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
295 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
298 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
300 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
304 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
305 g_type_name (arg_type));
308 g_object_class_install_property (oclass, arg_id, pspec);
312 gtk_object_class_init (GtkObjectClass *class)
314 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
316 parent_class = g_type_class_ref (G_TYPE_OBJECT);
318 gobject_class->set_property = gtk_object_set_property;
319 gobject_class->get_property = gtk_object_get_property;
320 gobject_class->dispose = gtk_object_dispose;
321 gobject_class->finalize = gtk_object_finalize;
323 class->destroy = gtk_object_real_destroy;
325 g_object_class_install_property (gobject_class,
327 g_param_spec_pointer ("user_data", "User Data",
328 "Anonymous User Data Pointer",
329 G_PARAM_READABLE | G_PARAM_WRITABLE));
330 object_signals[DESTROY] =
331 gtk_signal_new ("destroy",
332 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | GTK_RUN_NO_HOOKS,
333 GTK_CLASS_TYPE (class),
334 GTK_SIGNAL_OFFSET (GtkObjectClass, destroy),
335 gtk_marshal_VOID__VOID,
340 gtk_object_init (GtkObject *object,
341 GtkObjectClass *klass)
343 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
346 /********************************************
347 * Functions to end a GtkObject's life time
349 ********************************************/
351 gtk_object_destroy (GtkObject *object)
353 g_return_if_fail (object != NULL);
354 g_return_if_fail (GTK_IS_OBJECT (object));
356 if (!GTK_OBJECT_DESTROYED (object))
358 /* need to hold a reference count around all class method
361 g_object_run_dispose (G_OBJECT (object));
366 gtk_object_dispose (GObject *gobject)
368 GtkObject *object = GTK_OBJECT (gobject);
370 /* guard against reinvocations during
371 * destruction with the GTK_DESTROYED flag.
373 if (!GTK_OBJECT_DESTROYED (object))
375 GTK_OBJECT_SET_FLAGS (object, GTK_DESTROYED);
377 gtk_signal_emit (object, object_signals[DESTROY]);
379 GTK_OBJECT_UNSET_FLAGS (object, GTK_DESTROYED);
382 G_OBJECT_CLASS (parent_class)->dispose (gobject);
386 gtk_object_real_destroy (GtkObject *object)
388 g_signal_handlers_destroy (G_OBJECT (object));
392 gtk_object_finalize (GObject *gobject)
394 GtkObject *object = GTK_OBJECT (gobject);
396 gtk_object_notify_weaks (object);
398 G_OBJECT_CLASS (parent_class)->finalize (gobject);
401 /*****************************************
402 * GtkObject argument handlers
404 *****************************************/
407 gtk_object_set_property (GObject *object,
415 gtk_object_set_user_data (GTK_OBJECT (object), g_value_get_pointer (value));
418 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
424 gtk_object_get_property (GObject *object,
432 g_value_set_pointer (value, gtk_object_get_user_data (GTK_OBJECT (object)));
435 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
440 /*****************************************
446 *****************************************/
449 gtk_object_sink (GtkObject *object)
451 g_return_if_fail (object != NULL);
452 g_return_if_fail (GTK_IS_OBJECT (object));
454 if (GTK_OBJECT_FLOATING (object))
456 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
457 gtk_object_unref (object);
461 /*****************************************
464 * Weak refs are very similar to the old "destroy" signal. They allow
465 * one to register a callback that is called when the weakly
466 * referenced object is finalized.
468 * They are not implemented as a signal because they really are
469 * special and need to be used with great care. Unlike signals, which
470 * should be able to execute any code whatsoever.
472 * A weakref callback is not allowed to retain a reference to the
473 * object. Object data keys may be retrieved in a weak reference
476 * A weakref callback is called at most once.
478 *****************************************/
480 typedef struct _GtkWeakRef GtkWeakRef;
485 GtkDestroyNotify notify;
490 gtk_object_weakref (GtkObject *object,
491 GtkDestroyNotify notify,
496 g_return_if_fail (object != NULL);
497 g_return_if_fail (notify != NULL);
498 g_return_if_fail (GTK_IS_OBJECT (object));
501 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
503 weak = g_new (GtkWeakRef, 1);
504 weak->next = gtk_object_get_data_by_id (object, quark_weakrefs);
505 weak->notify = notify;
507 gtk_object_set_data_by_id (object, quark_weakrefs, weak);
511 gtk_object_weakunref (GtkObject *object,
512 GtkDestroyNotify notify,
515 GtkWeakRef *weaks, *w, **wp;
517 g_return_if_fail (object != NULL);
518 g_return_if_fail (GTK_IS_OBJECT (object));
523 weaks = gtk_object_get_data_by_id (object, quark_weakrefs);
524 for (wp = &weaks; *wp; wp = &(*wp)->next)
527 if (w->notify == notify && w->data == data)
530 gtk_object_set_data_by_id (object, quark_weakrefs, w->next);
540 gtk_object_notify_weaks (GtkObject *object)
546 w1 = gtk_object_get_data_by_id (object, quark_weakrefs);
550 w1->notify (w1->data);
559 gtk_object_new (GtkType object_type,
560 const gchar *first_property_name,
566 g_return_val_if_fail (GTK_TYPE_IS_OBJECT (object_type), NULL);
568 va_start (var_args, first_property_name);
569 object = g_object_new_valist (object_type, first_property_name, var_args);
576 gtk_object_get (GtkObject *object,
577 const gchar *first_property_name,
582 g_return_if_fail (GTK_IS_OBJECT (object));
584 va_start (var_args, first_property_name);
585 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
590 gtk_object_set (GtkObject *object,
591 const gchar *first_property_name,
596 g_return_if_fail (GTK_IS_OBJECT (object));
598 va_start (var_args, first_property_name);
599 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
603 /*****************************************
604 * GtkObject object_data mechanism
606 *****************************************/
609 gtk_object_set_data_by_id (GtkObject *object,
613 g_return_if_fail (GTK_IS_OBJECT (object));
615 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
619 gtk_object_set_data (GtkObject *object,
623 g_return_if_fail (GTK_IS_OBJECT (object));
624 g_return_if_fail (key != NULL);
626 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
630 gtk_object_set_data_by_id_full (GtkObject *object,
633 GtkDestroyNotify destroy)
635 g_return_if_fail (GTK_IS_OBJECT (object));
637 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
641 gtk_object_set_data_full (GtkObject *object,
644 GtkDestroyNotify destroy)
646 g_return_if_fail (GTK_IS_OBJECT (object));
647 g_return_if_fail (key != NULL);
649 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
653 gtk_object_get_data_by_id (GtkObject *object,
656 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
658 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
662 gtk_object_get_data (GtkObject *object,
665 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
666 g_return_val_if_fail (key != NULL, NULL);
668 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
672 gtk_object_remove_data_by_id (GtkObject *object,
675 g_return_if_fail (GTK_IS_OBJECT (object));
677 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
681 gtk_object_remove_data (GtkObject *object,
684 g_return_if_fail (GTK_IS_OBJECT (object));
685 g_return_if_fail (key != NULL);
687 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
691 gtk_object_remove_no_notify_by_id (GtkObject *object,
694 g_return_if_fail (GTK_IS_OBJECT (object));
696 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
700 gtk_object_remove_no_notify (GtkObject *object,
703 g_return_if_fail (GTK_IS_OBJECT (object));
704 g_return_if_fail (key != NULL);
706 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
710 gtk_object_set_user_data (GtkObject *object,
713 g_return_if_fail (GTK_IS_OBJECT (object));
715 if (!quark_user_data)
716 quark_user_data = g_quark_from_static_string ("user_data");
718 g_datalist_id_set_data (&G_OBJECT (object)->qdata, quark_user_data, data);
722 gtk_object_get_user_data (GtkObject *object)
724 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
726 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, quark_user_data);
730 gtk_object_ref (GtkObject *object)
732 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
734 return (GtkObject*) g_object_ref ((GObject*) object);
738 gtk_object_unref (GtkObject *object)
740 g_return_if_fail (GTK_IS_OBJECT (object));
742 g_object_unref ((GObject*) object);