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/.
32 #include "gtkobject.h"
33 #include "gtkmarshalers.h"
34 #include "gtksignal.h"
47 extern void gtk_object_init_type (void); /* for gtktypeutils.h */
48 static void gtk_object_base_class_init (GtkObjectClass *class);
49 static void gtk_object_base_class_finalize (GtkObjectClass *class);
50 static void gtk_object_class_init (GtkObjectClass *klass);
51 static void gtk_object_init (GtkObject *object,
52 GtkObjectClass *klass);
53 static void gtk_object_set_property (GObject *object,
57 static void gtk_object_get_property (GObject *object,
61 static void gtk_object_dispose (GObject *object);
62 static void gtk_object_real_destroy (GtkObject *object);
63 static void gtk_object_finalize (GObject *object);
64 static void gtk_object_notify_weaks (GtkObject *object);
66 static gpointer parent_class = NULL;
67 static guint object_signals[LAST_SIGNAL] = { 0 };
68 static GQuark quark_weakrefs = 0;
71 /****************************************************
72 * GtkObject type, class and instance initialization
74 ****************************************************/
77 gtk_object_get_type (void)
79 static GType 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,
94 NULL, /* value_table */
97 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkObject",
98 &object_info, G_TYPE_FLAG_ABSTRACT);
105 gtk_object_base_class_init (GtkObjectClass *class)
107 /* reset instance specifc methods that don't get inherited */
108 class->get_arg = NULL;
109 class->set_arg = NULL;
113 gtk_object_base_class_finalize (GtkObjectClass *class)
117 static inline gboolean
118 gtk_arg_set_from_value (GtkArg *arg,
120 gboolean copy_string)
122 switch (G_TYPE_FUNDAMENTAL (arg->type))
124 case G_TYPE_CHAR: GTK_VALUE_CHAR (*arg) = g_value_get_char (value); break;
125 case G_TYPE_UCHAR: GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value); break;
126 case G_TYPE_BOOLEAN: GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value); break;
127 case G_TYPE_INT: GTK_VALUE_INT (*arg) = g_value_get_int (value); break;
128 case G_TYPE_UINT: GTK_VALUE_UINT (*arg) = g_value_get_uint (value); break;
129 case G_TYPE_LONG: GTK_VALUE_LONG (*arg) = g_value_get_long (value); break;
130 case G_TYPE_ULONG: GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value); break;
131 case G_TYPE_ENUM: GTK_VALUE_ENUM (*arg) = g_value_get_enum (value); break;
132 case G_TYPE_FLAGS: GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value); break;
133 case G_TYPE_FLOAT: GTK_VALUE_FLOAT (*arg) = g_value_get_float (value); break;
134 case G_TYPE_DOUBLE: GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value); break;
135 case G_TYPE_BOXED: GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value); break;
136 case G_TYPE_POINTER: GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
137 case G_TYPE_OBJECT: GTK_VALUE_POINTER (*arg) = g_value_get_object (value); break;
138 case G_TYPE_STRING: if (copy_string)
139 GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
141 GTK_VALUE_STRING (*arg) = (char *) g_value_get_string (value);
149 static inline gboolean
150 gtk_arg_to_value (GtkArg *arg,
153 switch (G_TYPE_FUNDAMENTAL (arg->type))
155 case G_TYPE_CHAR: g_value_set_char (value, GTK_VALUE_CHAR (*arg)); break;
156 case G_TYPE_UCHAR: g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg)); break;
157 case G_TYPE_BOOLEAN: g_value_set_boolean (value, GTK_VALUE_BOOL (*arg)); break;
158 case G_TYPE_INT: g_value_set_int (value, GTK_VALUE_INT (*arg)); break;
159 case G_TYPE_UINT: g_value_set_uint (value, GTK_VALUE_UINT (*arg)); break;
160 case G_TYPE_LONG: g_value_set_long (value, GTK_VALUE_LONG (*arg)); break;
161 case G_TYPE_ULONG: g_value_set_ulong (value, GTK_VALUE_ULONG (*arg)); break;
162 case G_TYPE_ENUM: g_value_set_enum (value, GTK_VALUE_ENUM (*arg)); break;
163 case G_TYPE_FLAGS: g_value_set_flags (value, GTK_VALUE_FLAGS (*arg)); break;
164 case G_TYPE_FLOAT: g_value_set_float (value, GTK_VALUE_FLOAT (*arg)); break;
165 case G_TYPE_DOUBLE: g_value_set_double (value, GTK_VALUE_DOUBLE (*arg)); break;
166 case G_TYPE_STRING: g_value_set_string (value, GTK_VALUE_STRING (*arg)); break;
167 case G_TYPE_BOXED: g_value_set_boxed (value, GTK_VALUE_BOXED (*arg)); break;
168 case G_TYPE_POINTER: g_value_set_pointer (value, GTK_VALUE_POINTER (*arg)); break;
169 case G_TYPE_OBJECT: g_value_set_object (value, GTK_VALUE_POINTER (*arg)); break;
177 gtk_arg_proxy_set_property (GObject *object,
182 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
185 g_return_if_fail (class->set_arg != NULL);
187 memset (&arg, 0, sizeof (arg));
188 arg.type = G_VALUE_TYPE (value);
189 gtk_arg_set_from_value (&arg, value, FALSE);
190 arg.name = pspec->name;
191 class->set_arg (GTK_OBJECT (object), &arg, property_id);
195 gtk_arg_proxy_get_property (GObject *object,
200 GtkObjectClass *class = g_type_class_peek (pspec->owner_type);
203 g_return_if_fail (class->get_arg != NULL);
205 memset (&arg, 0, sizeof (arg));
206 arg.type = G_VALUE_TYPE (value);
207 arg.name = pspec->name;
208 class->get_arg (GTK_OBJECT (object), &arg, property_id);
209 gtk_arg_to_value (&arg, value);
213 gtk_object_add_arg_type (const gchar *arg_name,
218 GObjectClass *oclass;
220 gchar *type_name, *pname;
223 g_return_if_fail (arg_name != NULL);
224 g_return_if_fail (arg_type > G_TYPE_NONE);
225 g_return_if_fail (arg_id > 0);
226 g_return_if_fail (arg_flags & G_PARAM_READWRITE);
227 if (arg_flags & G_PARAM_CONSTRUCT)
228 g_return_if_fail ((arg_flags & G_PARAM_CONSTRUCT_ONLY) == 0);
229 if (arg_flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
230 g_return_if_fail (arg_flags & G_PARAM_WRITABLE);
231 g_return_if_fail ((arg_flags & ~(G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
233 pname = strchr (arg_name, ':');
234 g_return_if_fail (pname && pname[1] == ':');
236 type_name = g_strndup (arg_name, pname - arg_name);
238 type = g_type_from_name (type_name);
240 g_return_if_fail (G_TYPE_IS_OBJECT (type));
242 oclass = gtk_type_class (type);
243 if (arg_flags & G_PARAM_READABLE)
245 if (oclass->get_property && oclass->get_property != gtk_arg_proxy_get_property)
247 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.get_property() implementation",
251 oclass->get_property = gtk_arg_proxy_get_property;
253 if (arg_flags & G_PARAM_WRITABLE)
255 if (oclass->set_property && oclass->set_property != gtk_arg_proxy_set_property)
257 g_warning (G_STRLOC ": GtkArg compatibility code can't be mixed with customized %s.set_property() implementation",
261 oclass->set_property = gtk_arg_proxy_set_property;
263 switch (G_TYPE_FUNDAMENTAL (arg_type))
266 pspec = g_param_spec_enum (pname, NULL, NULL, arg_type, 0, arg_flags);
269 pspec = g_param_spec_flags (pname, NULL, NULL, arg_type, 0, arg_flags);
272 pspec = g_param_spec_char (pname, NULL, NULL, -128, 127, 0, arg_flags);
275 pspec = g_param_spec_uchar (pname, NULL, NULL, 0, 255, 0, arg_flags);
278 pspec = g_param_spec_boolean (pname, NULL, NULL, FALSE, arg_flags);
281 pspec = g_param_spec_int (pname, NULL, NULL, -2147483647, 2147483647, 0, arg_flags);
284 pspec = g_param_spec_uint (pname, NULL, NULL, 0, 4294967295U, 0, arg_flags);
287 pspec = g_param_spec_float (pname, NULL, NULL, -1E+37, 1E+37, 0, arg_flags);
290 pspec = g_param_spec_double (pname, NULL, NULL, -1E+307, 1E+307, 0, arg_flags);
293 pspec = g_param_spec_string (pname, NULL, NULL, NULL, arg_flags);
296 pspec = g_param_spec_pointer (pname, NULL, NULL, arg_flags);
299 pspec = g_param_spec_object (pname, NULL, NULL, arg_type, arg_flags);
302 if (!G_TYPE_IS_FUNDAMENTAL (arg_type))
304 pspec = g_param_spec_boxed (pname, NULL, NULL, arg_type, arg_flags);
308 g_warning (G_STRLOC ": Property type `%s' is not supported by the GtkArg compatibility code",
309 g_type_name (arg_type));
312 g_object_class_install_property (oclass, arg_id, pspec);
316 gtk_object_class_init (GtkObjectClass *class)
318 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
320 parent_class = g_type_class_ref (G_TYPE_OBJECT);
322 gobject_class->set_property = gtk_object_set_property;
323 gobject_class->get_property = gtk_object_get_property;
324 gobject_class->dispose = gtk_object_dispose;
325 gobject_class->finalize = gtk_object_finalize;
327 class->destroy = gtk_object_real_destroy;
329 g_object_class_install_property (gobject_class,
331 g_param_spec_pointer ("user_data", "User Data",
332 "Anonymous User Data Pointer",
333 G_PARAM_READABLE | G_PARAM_WRITABLE));
334 object_signals[DESTROY] =
335 g_signal_new ("destroy",
336 G_TYPE_FROM_CLASS (gobject_class),
337 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
338 G_STRUCT_OFFSET (GtkObjectClass, destroy),
340 _gtk_marshal_VOID__VOID,
345 gtk_object_init (GtkObject *object,
346 GtkObjectClass *klass)
348 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
351 /********************************************
352 * Functions to end a GtkObject's life time
354 ********************************************/
356 gtk_object_destroy (GtkObject *object)
358 g_return_if_fail (object != NULL);
359 g_return_if_fail (GTK_IS_OBJECT (object));
361 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
362 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_IN_DESTRUCTION flag.
373 if (!(GTK_OBJECT_FLAGS (object) & GTK_IN_DESTRUCTION))
375 GTK_OBJECT_SET_FLAGS (object, GTK_IN_DESTRUCTION);
377 g_signal_emit (object, object_signals[DESTROY], 0);
379 GTK_OBJECT_UNSET_FLAGS (object, GTK_IN_DESTRUCTION);
382 G_OBJECT_CLASS (parent_class)->dispose (gobject);
386 gtk_object_real_destroy (GtkObject *object)
388 g_signal_handlers_destroy (object);
392 gtk_object_finalize (GObject *gobject)
394 GtkObject *object = GTK_OBJECT (gobject);
396 if (GTK_OBJECT_FLOATING (object))
398 g_warning ("A floating object was finalized. This means that someone\n"
399 "called g_object_unref() on an object that had only a floating\n"
400 "reference; the initial floating reference is not owned by anyone\n"
401 "and must be removed with gtk_object_sink() after a normal\n"
402 "reference is obtained with g_object_ref().");
405 gtk_object_notify_weaks (object);
407 G_OBJECT_CLASS (parent_class)->finalize (gobject);
410 /*****************************************
411 * GtkObject argument handlers
413 *****************************************/
416 gtk_object_set_property (GObject *object,
424 g_object_set_data (G_OBJECT (object), "user_data", g_value_get_pointer (value));
427 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
433 gtk_object_get_property (GObject *object,
441 g_value_set_pointer (value, g_object_get_data (G_OBJECT (object), "user_data"));
444 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
449 /*****************************************
455 *****************************************/
458 gtk_object_sink (GtkObject *object)
460 g_return_if_fail (GTK_IS_OBJECT (object));
462 if (GTK_OBJECT_FLOATING (object))
464 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
465 g_object_unref (object);
469 /*****************************************
472 * Weak refs are very similar to the old "destroy" signal. They allow
473 * one to register a callback that is called when the weakly
474 * referenced object is finalized.
476 * They are not implemented as a signal because they really are
477 * special and need to be used with great care. Unlike signals, which
478 * should be able to execute any code whatsoever.
480 * A weakref callback is not allowed to retain a reference to the
481 * object. Object data keys may be retrieved in a weak reference
484 * A weakref callback is called at most once.
486 *****************************************/
488 typedef struct _GtkWeakRef GtkWeakRef;
493 GtkDestroyNotify notify;
498 gtk_object_weakref (GtkObject *object,
499 GtkDestroyNotify notify,
504 g_return_if_fail (notify != NULL);
505 g_return_if_fail (GTK_IS_OBJECT (object));
508 quark_weakrefs = g_quark_from_static_string ("gtk-weakrefs");
510 weak = g_new (GtkWeakRef, 1);
511 weak->next = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
512 weak->notify = notify;
514 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, weak);
518 gtk_object_weakunref (GtkObject *object,
519 GtkDestroyNotify notify,
522 GtkWeakRef *weaks, *w, **wp;
524 g_return_if_fail (GTK_IS_OBJECT (object));
529 weaks = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
530 for (wp = &weaks; *wp; wp = &(*wp)->next)
533 if (w->notify == notify && w->data == data)
536 g_object_set_qdata (G_OBJECT (object), quark_weakrefs, w->next);
546 gtk_object_notify_weaks (GtkObject *object)
552 w1 = g_object_get_qdata (G_OBJECT (object), quark_weakrefs);
556 w1->notify (w1->data);
565 gtk_object_new (GtkType object_type,
566 const gchar *first_property_name,
572 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
574 va_start (var_args, first_property_name);
575 object = (GtkObject *)g_object_new_valist (object_type, first_property_name, var_args);
582 gtk_object_get (GtkObject *object,
583 const gchar *first_property_name,
588 g_return_if_fail (GTK_IS_OBJECT (object));
590 va_start (var_args, first_property_name);
591 g_object_get_valist (G_OBJECT (object), first_property_name, var_args);
596 gtk_object_set (GtkObject *object,
597 const gchar *first_property_name,
602 g_return_if_fail (GTK_IS_OBJECT (object));
604 va_start (var_args, first_property_name);
605 g_object_set_valist (G_OBJECT (object), first_property_name, var_args);
609 /*****************************************
610 * GtkObject object_data mechanism
612 *****************************************/
615 gtk_object_set_data_by_id (GtkObject *object,
619 g_return_if_fail (GTK_IS_OBJECT (object));
621 g_datalist_id_set_data (&G_OBJECT (object)->qdata, data_id, data);
625 gtk_object_set_data (GtkObject *object,
629 g_return_if_fail (GTK_IS_OBJECT (object));
630 g_return_if_fail (key != NULL);
632 g_datalist_set_data (&G_OBJECT (object)->qdata, key, data);
636 gtk_object_set_data_by_id_full (GtkObject *object,
639 GtkDestroyNotify destroy)
641 g_return_if_fail (GTK_IS_OBJECT (object));
643 g_datalist_id_set_data_full (&G_OBJECT (object)->qdata, data_id, data, destroy);
647 gtk_object_set_data_full (GtkObject *object,
650 GtkDestroyNotify destroy)
652 g_return_if_fail (GTK_IS_OBJECT (object));
653 g_return_if_fail (key != NULL);
655 g_datalist_set_data_full (&G_OBJECT (object)->qdata, key, data, destroy);
659 gtk_object_get_data_by_id (GtkObject *object,
662 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
664 return g_datalist_id_get_data (&G_OBJECT (object)->qdata, data_id);
668 gtk_object_get_data (GtkObject *object,
671 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
672 g_return_val_if_fail (key != NULL, NULL);
674 return g_datalist_get_data (&G_OBJECT (object)->qdata, key);
678 gtk_object_remove_data_by_id (GtkObject *object,
681 g_return_if_fail (GTK_IS_OBJECT (object));
683 g_datalist_id_remove_data (&G_OBJECT (object)->qdata, data_id);
687 gtk_object_remove_data (GtkObject *object,
690 g_return_if_fail (GTK_IS_OBJECT (object));
691 g_return_if_fail (key != NULL);
693 g_datalist_remove_data (&G_OBJECT (object)->qdata, key);
697 gtk_object_remove_no_notify_by_id (GtkObject *object,
700 g_return_if_fail (GTK_IS_OBJECT (object));
702 g_datalist_id_remove_no_notify (&G_OBJECT (object)->qdata, key_id);
706 gtk_object_remove_no_notify (GtkObject *object,
709 g_return_if_fail (GTK_IS_OBJECT (object));
710 g_return_if_fail (key != NULL);
712 g_datalist_remove_no_notify (&G_OBJECT (object)->qdata, key);
716 gtk_object_set_user_data (GtkObject *object,
719 g_return_if_fail (GTK_IS_OBJECT (object));
721 g_object_set_data (G_OBJECT (object), "user_data", data);
725 gtk_object_get_user_data (GtkObject *object)
727 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
729 return g_object_get_data (G_OBJECT (object), "user_data");
733 gtk_object_ref (GtkObject *object)
735 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
737 return (GtkObject*) g_object_ref ((GObject*) object);
741 gtk_object_unref (GtkObject *object)
743 g_return_if_fail (GTK_IS_OBJECT (object));
745 g_object_unref ((GObject*) object);