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 const gchar *trailer);
55 static void gtk_object_get_property (GObject *object,
59 const gchar *trailer);
60 static void gtk_object_shutdown (GObject *object);
61 static void gtk_object_real_destroy (GtkObject *object);
62 static void gtk_object_finalize (GObject *object);
63 static void gtk_object_notify_weaks (GtkObject *object);
65 static gpointer parent_class = NULL;
66 static guint object_signals[LAST_SIGNAL] = { 0 };
67 static GQuark quark_user_data = 0;
68 static GQuark quark_weakrefs = 0;
71 /****************************************************
72 * GtkObject type, class and instance initialization
74 ****************************************************/
77 gtk_object_get_type (void)
79 static GtkType object_type = 0;
83 static const GTypeInfo object_info =
85 sizeof (GtkObjectClass),
86 (GBaseInitFunc) gtk_object_base_class_init,
87 (GBaseFinalizeFunc) gtk_object_base_class_finalize,
88 (GClassInitFunc) gtk_object_class_init,
89 NULL, /* class_finalize */
90 NULL, /* class_data */
93 (GInstanceInitFunc) gtk_object_init,
96 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkObject", &object_info, 0);
103 gtk_object_base_class_init (GtkObjectClass *class)
105 /* reset instance specifc methods that don't get inherited */
106 class->get_arg = NULL;
107 class->set_arg = NULL;
111 gtk_object_base_class_finalize (GtkObjectClass *class)
115 static inline gboolean
116 gtk_arg_set_from_value (GtkArg *arg,
118 gboolean copy_string)
120 switch (G_TYPE_FUNDAMENTAL (arg->type))
122 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
123 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
124 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
125 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
126 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
127 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
128 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
129 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
130 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
131 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
132 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
133 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
134 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
135 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
136 case G_TYPE_STRING: if (copy_string)
137 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
139 GTK_VALUE_STRING (*arg) = g_value_get_string (value);
147 static inline gboolean
148 gtk_arg_to_value (GtkArg *arg,
151 switch (G_TYPE_FUNDAMENTAL (arg->type))
153 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
154 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
155 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
156 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
157 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
158 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
159 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
160 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
161 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
162 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
163 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
164 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
165 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
166 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
167 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
175 gtk_arg_proxy_set_property (GObject *object,
179 const gchar *trailer)
181 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
184 g_return_if_fail (class->set_arg != NULL);
186 arg.type = G_VALUE_TYPE (value);
187 gtk_arg_set_from_value (&arg, value, FALSE);
188 arg.name = pspec->name;
189 class->set_arg (GTK_OBJECT (object), &arg, property_id);
193 gtk_arg_proxy_get_property (GObject *object,
197 const gchar *trailer)
199 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
202 g_return_if_fail (class->get_arg != NULL);
204 arg.type = G_VALUE_TYPE (value);
205 arg.name = pspec->name;
206 class->get_arg (GTK_OBJECT (object), &arg, property_id);
207 gtk_arg_to_value (&arg, value);
211 gtk_object_add_arg_type (const gchar *arg_name,
216 GObjectClass *oclass;
218 gchar *type_name, *pname;
221 g_return_if_fail (arg_name != NULL);
222 g_return_if_fail (arg_type > G_TYPE_NONE);
223 g_return_if_fail (arg_id > 0);
224 g_return_if_fail (arg_flags & GTK_ARG_READWRITE);
225 if (arg_flags & G_PARAM_CONSTRUCT)
226 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
227 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
228 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
229 g_return_if_fail ((arg_flags & ~(GTK_ARG_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
231 pname = strchr (arg_name, ':');
232 g_return_if_fail (pname && pname[1] == ':');
234 type_name = g_strndup (arg_name, pname - arg_name);
236 type = g_type_from_name (type_name);
238 g_return_if_fail (G_TYPE_IS_OBJECT (type));
240 oclass = gtk_type_class (type);
241 if (arg_flags & GTK_ARG_READABLE)
243 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
245 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
249 oclass->get_property = gtk_arg_proxy_get_property;
251 if (arg_flags & GTK_ARG_WRITABLE)
253 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
255 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
259 oclass->set_property = gtk_arg_proxy_set_property;
261 switch (G_TYPE_FUNDAMENTAL (arg_type))
264 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
267 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
270 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
273 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
276 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
279 pspec = g_param_spec_int (pname, NULL, NULL, -2147483647, 2147483647, 0, arg_flags);
282 pspec = g_param_spec_uint (pname, NULL, NULL, 0, 4294967295U, 0, arg_flags);
285 pspec = g_param_spec_float (pname, NULL, NULL, -1E+37, 1E+37, 0, arg_flags);
288 pspec = g_param_spec_double (pname, NULL, NULL, -1E+307, 1E+307, 0, arg_flags);
291 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
294 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
297 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
299 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
303 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
304 g_type_name (arg_type));
307 g_object_class_install_property (oclass, arg_id, pspec);
311 gtk_object_class_init (GtkObjectClass *class)
313 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
315 parent_class = g_type_class_ref (G_TYPE_OBJECT);
317 gobject_class->set_property = gtk_object_set_property;
318 gobject_class->get_property = gtk_object_get_property;
319 gobject_class->shutdown = gtk_object_shutdown;
320 gobject_class->finalize = gtk_object_finalize;
322 class->destroy = gtk_object_real_destroy;
324 g_object_class_install_property (gobject_class,
326 g_param_spec_pointer ("user_data", "User Data",
327 "Anonymous User Data Pointer",
328 G_PARAM_READABLE | G_PARAM_WRITABLE));
329 object_signals[DESTROY] =
330 gtk_signal_new ("destroy",
331 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | GTK_RUN_NO_HOOKS,
332 GTK_CLASS_TYPE (class),
333 GTK_SIGNAL_OFFSET (GtkObjectClass, destroy),
334 gtk_marshal_VOID__VOID,
339 gtk_object_init (GtkObject *object,
340 GtkObjectClass *klass)
342 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
345 /********************************************
346 * Functions to end a GtkObject's life time
348 ********************************************/
350 gtk_object_destroy (GtkObject *object)
352 g_return_if_fail (object != NULL);
353 g_return_if_fail (GTK_IS_OBJECT (object));
355 if (!GTK_OBJECT_DESTROYED (object))
357 /* need to hold a reference count around all class method
360 gtk_object_ref (object);
361 G_OBJECT_GET_CLASS (object)->shutdown (G_OBJECT (object));
362 gtk_object_unref (object);
367 gtk_object_shutdown (GObject *gobject)
369 GtkObject *object = GTK_OBJECT (gobject);
371 /* guard against reinvocations during
372 * destruction with the GTK_DESTROYED flag.
374 if (!GTK_OBJECT_DESTROYED (object))
376 GTK_OBJECT_SET_FLAGS (object, GTK_DESTROYED);
378 gtk_signal_emit (object, object_signals[DESTROY]);
380 GTK_OBJECT_UNSET_FLAGS (object, GTK_DESTROYED);
383 G_OBJECT_CLASS (parent_class)->shutdown (gobject);
387 gtk_object_real_destroy (GtkObject *object)
389 g_signal_handlers_destroy (G_OBJECT (object));
393 gtk_object_finalize (GObject *gobject)
395 GtkObject *object = GTK_OBJECT (gobject);
397 gtk_object_notify_weaks (object);
399 G_OBJECT_CLASS (parent_class)->finalize (gobject);
402 /*****************************************
403 * GtkObject argument handlers
405 *****************************************/
408 gtk_object_set_property (GObject *object,
412 const gchar *trailer)
417 gtk_object_set_user_data (GTK_OBJECT (object), g_value_get_pointer (value));
420 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
426 gtk_object_get_property (GObject *object,
430 const gchar *trailer)
435 g_return_if_fail (trailer != NULL);
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 (object != NULL);
457 g_return_if_fail (GTK_IS_OBJECT (object));
459 if (GTK_OBJECT_FLOATING (object))
461 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
462 gtk_object_unref (object);
466 /*****************************************
469 * Weak refs are very similar to the old "destroy" signal. They allow
470 * one to register a callback that is called when the weakly
471 * referenced object is finalized.
473 * They are not implemented as a signal because they really are
474 * special and need to be used with great care. Unlike signals, which
475 * should be able to execute any code whatsoever.
477 * A weakref callback is not allowed to retain a reference to the
478 * object. Object data keys may be retrieved in a weak reference
481 * A weakref callback is called at most once.
483 *****************************************/
485 typedef struct _GtkWeakRef GtkWeakRef;
490 GtkDestroyNotify notify;
495 gtk_object_weakref (GtkObject *object,
496 GtkDestroyNotify notify,
501 g_return_if_fail (object != NULL);
502 g_return_if_fail (notify != NULL);
503 g_return_if_fail (GTK_IS_OBJECT (object));
506 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
508 weak = g_new (GtkWeakRef, 1);
509 weak->next = gtk_object_get_data_by_id (object, quark_weakrefs);
510 weak->notify = notify;
512 gtk_object_set_data_by_id (object, quark_weakrefs, weak);
516 gtk_object_weakunref (GtkObject *object,
517 GtkDestroyNotify notify,
520 GtkWeakRef *weaks, *w, **wp;
522 g_return_if_fail (object != NULL);
523 g_return_if_fail (GTK_IS_OBJECT (object));
528 weaks = gtk_object_get_data_by_id (object, quark_weakrefs);
529 for (wp = &weaks; *wp; wp = &(*wp)->next)
532 if (w->notify == notify && w->data == data)
535 gtk_object_set_data_by_id (object, quark_weakrefs, w->next);
545 gtk_object_notify_weaks (GtkObject *object)
551 w1 = gtk_object_get_data_by_id (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 (GTK_TYPE_IS_OBJECT (object_type), NULL);
573 va_start (var_args, first_property_name);
574 object = 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);