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 Library 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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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.
23 #include "gtkobject.h"
24 #include "gtksignal.h"
27 #define GTK_OBJECT_DATA_ID_BLOCK_SIZE (1024)
28 #define GTK_OBJECT_DATA_BLOCK_SIZE (1024)
40 ARG_OBJECT_SIGNAL_AFTER
44 typedef struct _GtkObjectData GtkObjectData;
50 GtkDestroyNotify destroy;
55 void gtk_object_init_type (void);
56 static void gtk_object_base_class_init (GtkObjectClass *klass);
57 static void gtk_object_class_init (GtkObjectClass *klass);
58 static void gtk_object_init (GtkObject *object);
59 static void gtk_object_set_arg (GtkObject *object,
62 static void gtk_object_get_arg (GtkObject *object,
65 static void gtk_object_shutdown (GtkObject *object);
66 static void gtk_object_real_destroy (GtkObject *object);
67 static void gtk_object_finalize (GtkObject *object);
68 static void gtk_object_notify_weaks (GtkObject *object);
70 static guint object_signals[LAST_SIGNAL] = { 0 };
72 static GHashTable *object_arg_info_ht = NULL;
74 static const gchar *user_data_key = "user_data";
75 static guint user_data_key_id = 0;
76 static const gchar *weakrefs_key = "gtk-weakrefs";
77 static guint weakrefs_key_id = 0;
79 static GtkObjectData *gtk_object_data_free_list = NULL;
81 #define GTK_OBJECT_DATA_DESTROY( odata ) { \
83 odata->destroy (odata->data); \
84 odata->next = gtk_object_data_free_list; \
85 gtk_object_data_free_list = odata; \
90 static guint obj_count = 0;
91 static GHashTable *living_objs_ht = NULL;
93 gtk_object_debug_foreach (gpointer key, gpointer value, gpointer user_data)
97 object = (GtkObject*) value;
98 g_message ("[%p] %s\tref_count=%d%s%s",
100 gtk_type_name (GTK_OBJECT_TYPE (object)),
102 GTK_OBJECT_FLOATING (object) ? " (floating)" : "",
103 GTK_OBJECT_DESTROYED (object) ? " (destroyed)" : "");
106 gtk_object_debug (void)
109 g_hash_table_foreach (living_objs_ht, gtk_object_debug_foreach, NULL);
111 g_message ("living objects count = %d", obj_count);
113 #endif /* G_ENABLE_DEBUG */
115 /****************************************************
116 * GtkObject type, class and instance initialization
118 ****************************************************/
121 gtk_object_init_type (void)
123 GtkType object_type = 0;
124 GtkTypeInfo object_info =
128 sizeof (GtkObjectClass),
129 (GtkClassInitFunc) gtk_object_class_init,
130 (GtkObjectInitFunc) gtk_object_init,
131 /* reserved_1 */ NULL,
132 /* reserved_2 */ NULL,
133 (GtkClassInitFunc) gtk_object_base_class_init,
136 object_type = gtk_type_unique (0, &object_info);
137 g_assert (object_type == GTK_TYPE_OBJECT);
139 #ifdef G_ENABLE_DEBUG
140 if (gtk_debug_flags & GTK_DEBUG_OBJECTS)
141 ATEXIT (gtk_object_debug);
142 #endif /* G_ENABLE_DEBUG */
146 gtk_object_get_type (void)
148 return GTK_TYPE_OBJECT;
152 gtk_object_base_class_init (GtkObjectClass *class)
154 /* reset instance specific fields that don't get inhrited */
155 class->signals = NULL;
159 /* reset instance specifc methods that don't get inherited */
160 class->get_arg = NULL;
161 class->set_arg = NULL;
165 gtk_object_class_init (GtkObjectClass *class)
167 gtk_object_add_arg_type ("GtkObject::user_data",
171 gtk_object_add_arg_type ("GtkObject::signal",
175 gtk_object_add_arg_type ("GtkObject::signal_after",
179 gtk_object_add_arg_type ("GtkObject::object_signal",
183 gtk_object_add_arg_type ("GtkObject::object_signal_after",
186 ARG_OBJECT_SIGNAL_AFTER);
188 object_signals[DESTROY] =
189 gtk_signal_new ("destroy",
192 GTK_SIGNAL_OFFSET (GtkObjectClass, destroy),
193 gtk_marshal_NONE__NONE,
196 gtk_object_class_add_signals (class, object_signals, LAST_SIGNAL);
198 class->get_arg = gtk_object_get_arg;
199 class->set_arg = gtk_object_set_arg;
200 class->shutdown = gtk_object_shutdown;
201 class->destroy = gtk_object_real_destroy;
202 class->finalize = gtk_object_finalize;
206 gtk_object_init (GtkObject *object)
208 GTK_OBJECT_FLAGS (object) = GTK_FLOATING;
210 object->ref_count = 1;
211 object->object_data = NULL;
213 #ifdef G_ENABLE_DEBUG
214 if (gtk_debug_flags & GTK_DEBUG_OBJECTS)
219 living_objs_ht = g_hash_table_new (g_direct_hash, NULL);
221 g_hash_table_insert (living_objs_ht, object, object);
223 #endif /* G_ENABLE_DEBUG */
226 /********************************************
227 * Functions to end a GtkObject's life time
229 ********************************************/
231 gtk_object_destroy (GtkObject *object)
233 g_return_if_fail (object != NULL);
234 g_return_if_fail (GTK_IS_OBJECT (object));
236 if (!GTK_OBJECT_DESTROYED (object))
238 /* we will hold a reference on the object in this place, so
239 * to ease all classes shutdown and destroy implementations.
240 * i.e. they don't have to bother about referencing at all.
242 gtk_object_ref (object);
243 object->klass->shutdown (object);
244 gtk_object_unref (object);
249 gtk_object_shutdown (GtkObject *object)
251 GTK_OBJECT_SET_FLAGS (object, GTK_DESTROYED);
252 gtk_signal_emit (object, object_signals[DESTROY]);
256 gtk_object_real_destroy (GtkObject *object)
258 if (GTK_OBJECT_CONNECTED (object))
259 gtk_signal_handlers_destroy (object);
263 gtk_object_finalize (GtkObject *object)
265 gtk_object_notify_weaks (object);
267 while (object->object_data)
269 GtkObjectData *odata;
271 odata = object->object_data;
272 object->object_data = odata->next;
273 GTK_OBJECT_DATA_DESTROY (odata);
276 gtk_type_free (GTK_OBJECT_TYPE (object), object);
279 /*****************************************
280 * GtkObject argument handlers
282 *****************************************/
285 gtk_object_set_arg (GtkObject *object,
296 gtk_object_set_user_data (object, GTK_VALUE_POINTER (*arg));
298 case ARG_OBJECT_SIGNAL_AFTER:
300 case ARG_OBJECT_SIGNAL:
302 case ARG_SIGNAL_AFTER:
306 arg_name = gtk_arg_name_strip_type (arg->name);
308 arg_name[n] == ':' &&
309 arg_name[n + 1] == ':' &&
310 arg_name[n + 2] != 0)
312 gtk_signal_connect_full (object,
314 GTK_VALUE_SIGNAL (*arg).f, NULL,
315 GTK_VALUE_SIGNAL (*arg).d,
317 (arg_id == ARG_OBJECT_SIGNAL ||
318 arg_id == ARG_OBJECT_SIGNAL_AFTER),
319 (arg_id == ARG_OBJECT_SIGNAL_AFTER ||
320 arg_id == ARG_SIGNAL_AFTER));
323 g_warning ("gtk_object_set_arg(): invalid signal argument: \"%s\"\n", arg->name);
331 gtk_object_get_arg (GtkObject *object,
338 GTK_VALUE_POINTER (*arg) = gtk_object_get_user_data (object);
341 case ARG_OBJECT_SIGNAL:
343 arg->type = GTK_TYPE_INVALID;
348 /*****************************************
349 * gtk_object_class_add_signals:
354 *****************************************/
357 gtk_object_class_add_signals (GtkObjectClass *class,
364 g_return_if_fail (class != NULL);
366 new_signals = g_new (guint, class->nsignals + nsignals);
367 for (i = 0; i < class->nsignals; i++)
368 new_signals[i] = class->signals[i];
369 for (i = 0; i < nsignals; i++)
370 new_signals[class->nsignals + i] = signals[i];
372 g_free (class->signals);
373 class->signals = new_signals;
374 class->nsignals += nsignals;
378 gtk_object_class_add_user_signal (GtkObjectClass *class,
380 GtkSignalMarshaller marshaller,
390 g_return_val_if_fail (class != NULL, 0);
394 params = g_new (GtkType, nparams);
396 va_start (args, nparams);
398 for (i = 0; i < nparams; i++)
399 params[i] = va_arg (args, GtkType);
406 signal_id = gtk_signal_newv (name,
418 gtk_object_class_add_signals (class, &signal_id, 1);
424 gtk_object_class_user_signal_new (GtkObjectClass *class,
426 GtkSignalRunType signal_flags,
427 GtkSignalMarshaller marshaller,
437 g_return_val_if_fail (class != NULL, 0);
441 params = g_new (GtkType, nparams);
443 va_start (args, nparams);
445 for (i = 0; i < nparams; i++)
446 params[i] = va_arg (args, GtkType);
453 signal_id = gtk_signal_newv (name,
465 gtk_object_class_add_signals (class, &signal_id, 1);
471 gtk_object_class_user_signal_newv (GtkObjectClass *class,
473 GtkSignalRunType signal_flags,
474 GtkSignalMarshaller marshaller,
481 g_return_val_if_fail (class != NULL, 0);
484 g_return_val_if_fail (params != NULL, 0);
486 signal_id = gtk_signal_newv (name,
496 gtk_object_class_add_signals (class, &signal_id, 1);
501 /*****************************************
507 *****************************************/
510 gtk_object_sink (GtkObject *object)
512 g_return_if_fail (object != NULL);
513 g_return_if_fail (GTK_IS_OBJECT (object));
515 if (GTK_OBJECT_FLOATING (object))
517 GTK_OBJECT_UNSET_FLAGS (object, GTK_FLOATING);
518 gtk_object_unref (object);
522 /*****************************************
525 * Weak refs are very similar to the old "destroy" signal. They allow
526 * one to register a callback that is called when the weakly
527 * referenced object is finalized.
529 * They are not implemented as a signal because they really are
530 * special and need to be used with great care. Unlike signals, which
531 * should be able to execute any code whatsoever.
533 * A weakref callback is not allowed to retain a reference to the
534 * object. Object data keys may be retrieved in a weak reference
537 * A weakref callback is called at most once.
539 *****************************************/
541 typedef struct _GtkWeakRef GtkWeakRef;
546 GtkDestroyNotify notify;
551 gtk_object_weakref (GtkObject *object,
552 GtkDestroyNotify notify,
557 g_return_if_fail (object != NULL);
558 g_return_if_fail (notify != NULL);
559 g_return_if_fail (GTK_IS_OBJECT (object));
561 if (!weakrefs_key_id)
562 weakrefs_key_id = g_quark_from_static_string (weakrefs_key);
564 weak = g_new (GtkWeakRef, 1);
565 weak->next = gtk_object_get_data_by_id (object, weakrefs_key_id);
566 weak->notify = notify;
568 gtk_object_set_data_by_id (object, weakrefs_key_id, weak);
572 gtk_object_weakunref (GtkObject *object,
573 GtkDestroyNotify notify,
576 GtkWeakRef *weaks, *w, **wp;
578 g_return_if_fail (object != NULL);
579 g_return_if_fail (GTK_IS_OBJECT (object));
581 if (!weakrefs_key_id)
584 weaks = gtk_object_get_data_by_id (object, weakrefs_key_id);
585 for (wp = &weaks; *wp; wp = &(*wp)->next)
588 if (w->notify == notify && w->data == data)
591 gtk_object_set_data_by_id (object, weakrefs_key_id, w->next);
601 gtk_object_notify_weaks (GtkObject *object)
607 w1 = gtk_object_get_data_by_id (object, weakrefs_key_id);
611 w1->notify (w1->data);
619 /****************************************************
620 * GtkObject argument mechanism and object creation
622 ****************************************************/
625 gtk_object_new (GtkType object_type,
626 const gchar *first_arg_name,
631 GSList *arg_list = NULL;
632 GSList *info_list = NULL;
635 g_return_val_if_fail (GTK_FUNDAMENTAL_TYPE (object_type) == GTK_TYPE_OBJECT, NULL);
637 object = gtk_type_new (object_type);
639 va_start (var_args, first_arg_name);
640 error = gtk_object_args_collect (GTK_OBJECT_TYPE (object),
649 g_warning ("gtk_object_new(): %s", error);
657 slist_arg = arg_list;
658 slist_info = info_list;
661 gtk_object_arg_set (object, slist_arg->data, slist_info->data);
662 slist_arg = slist_arg->next;
663 slist_info = slist_info->next;
665 gtk_args_collect_cleanup (arg_list, info_list);
672 gtk_object_newv (GtkType object_type,
679 g_return_val_if_fail (GTK_FUNDAMENTAL_TYPE (object_type) == GTK_TYPE_OBJECT, NULL);
681 g_return_val_if_fail (args != NULL, NULL);
683 object = gtk_type_new (object_type);
685 for (max_args = args + n_args; args < max_args; args++)
686 gtk_object_arg_set (object, args, NULL);
692 gtk_object_setv (GtkObject *object,
698 g_return_if_fail (object != NULL);
699 g_return_if_fail (GTK_IS_OBJECT (object));
701 g_return_if_fail (args != NULL);
703 for (max_args = args + n_args; args < max_args; args++)
704 gtk_object_arg_set (object, args, NULL);
708 gtk_object_getv (GtkObject *object,
714 g_return_if_fail (object != NULL);
715 g_return_if_fail (GTK_IS_OBJECT (object));
717 g_return_if_fail (args != NULL);
719 for (max_args = args + n_args; args < max_args; args++)
720 gtk_object_arg_get (object, args, NULL);
724 gtk_object_set (GtkObject *object,
725 const gchar *first_arg_name,
729 GSList *arg_list = NULL;
730 GSList *info_list = NULL;
733 g_return_if_fail (object != NULL);
734 g_return_if_fail (GTK_IS_OBJECT (object));
736 va_start (var_args, first_arg_name);
737 error = gtk_object_args_collect (GTK_OBJECT_TYPE (object),
746 g_warning ("gtk_object_set(): %s", error);
754 slist_arg = arg_list;
755 slist_info = info_list;
758 gtk_object_arg_set (object, slist_arg->data, slist_info->data);
759 slist_arg = slist_arg->next;
760 slist_info = slist_info->next;
762 gtk_args_collect_cleanup (arg_list, info_list);
767 gtk_object_arg_set (GtkObject *object,
771 GtkObjectClass *oclass;
773 g_return_if_fail (object != NULL);
774 g_return_if_fail (GTK_IS_OBJECT (object));
775 g_return_if_fail (arg != NULL);
781 error = gtk_arg_get_info (GTK_OBJECT_TYPE (object),
787 g_warning ("gtk_object_arg_set(): %s", error);
793 if (! (info->arg_flags & GTK_ARG_WRITABLE))
795 g_warning ("gtk_object_arg_set(): argument \"%s\" is not writable",
799 if (info->type != arg->type)
801 g_warning ("gtk_object_arg_set(): argument \"%s\" has invalid type `%s'",
803 gtk_type_name (arg->type));
807 oclass = gtk_type_class (info->class_type);
808 g_assert (oclass->set_arg != NULL);
809 oclass->set_arg (object, arg, info->arg_id);
813 gtk_object_arg_get (GtkObject *object,
817 GtkObjectClass *oclass;
819 g_return_if_fail (object != NULL);
820 g_return_if_fail (GTK_IS_OBJECT (object));
821 g_return_if_fail (arg != NULL);
827 error = gtk_arg_get_info (GTK_OBJECT_TYPE (object),
833 g_warning ("gtk_object_arg_get(): %s", error);
835 arg->type = GTK_TYPE_INVALID;
840 if (! (info->arg_flags & GTK_ARG_READABLE))
842 g_warning ("gtk_object_arg_get(): argument \"%s\" is not readable",
844 arg->type = GTK_TYPE_INVALID;
848 oclass = gtk_type_class (info->class_type);
849 g_assert (oclass->get_arg != NULL);
850 arg->type = info->type;
851 oclass->get_arg (object, arg, info->arg_id);
855 gtk_object_add_arg_type (const char *arg_name,
860 g_return_if_fail (arg_name != NULL);
861 g_return_if_fail (arg_type > GTK_TYPE_NONE);
862 g_return_if_fail (arg_id > 0);
863 g_return_if_fail ((arg_flags & GTK_ARG_CHILD_ARG) == 0);
864 if (arg_flags & GTK_ARG_CONSTRUCT)
865 g_return_if_fail ((arg_flags & GTK_ARG_READWRITE) == GTK_ARG_READWRITE);
867 g_return_if_fail ((arg_flags & GTK_ARG_READWRITE) != 0);
869 if (!object_arg_info_ht)
870 object_arg_info_ht = g_hash_table_new (gtk_arg_info_hash,
873 gtk_arg_type_new_static (GTK_TYPE_OBJECT,
875 GTK_STRUCT_OFFSET (GtkObjectClass, n_args),
883 gtk_object_args_collect (GtkType object_type,
885 GSList **info_list_p,
886 const gchar *first_arg_name,
889 return gtk_args_collect (object_type,
898 gtk_object_arg_get_info (GtkType object_type,
899 const gchar *arg_name,
902 return gtk_arg_get_info (object_type,
909 gtk_object_query_args (GtkType class_type,
913 g_return_val_if_fail (n_args != NULL, NULL);
915 g_return_val_if_fail (GTK_FUNDAMENTAL_TYPE (class_type) == GTK_TYPE_OBJECT, NULL);
917 return gtk_args_query (class_type, object_arg_info_ht, arg_flags, n_args);
920 /*****************************************
921 * GtkObject object_data mechanism
923 *****************************************/
926 gtk_object_set_data_by_id (GtkObject *object,
930 g_return_if_fail (data_id > 0);
932 gtk_object_set_data_by_id_full (object, data_id, data, NULL);
936 gtk_object_set_data (GtkObject *object,
940 g_return_if_fail (key != NULL);
942 gtk_object_set_data_by_id_full (object, gtk_object_data_force_id (key), data, NULL);
946 gtk_object_set_data_by_id_full (GtkObject *object,
949 GtkDestroyNotify destroy)
951 GtkObjectData *odata;
953 g_return_if_fail (object != NULL);
954 g_return_if_fail (GTK_IS_OBJECT (object));
955 g_return_if_fail (data_id > 0);
957 odata = object->object_data;
966 if (odata->id == data_id)
969 prev->next = odata->next;
971 object->object_data = odata->next;
973 GTK_OBJECT_DATA_DESTROY (odata);
985 if (odata->id == data_id)
987 register GtkDestroyNotify dfunc;
988 register gpointer ddata;
990 dfunc = odata->destroy;
992 odata->destroy = destroy;
995 /* we need to have updated all structures prior to
996 * invokation of the destroy function
1004 odata = odata->next;
1007 if (gtk_object_data_free_list)
1009 odata = gtk_object_data_free_list;
1010 gtk_object_data_free_list = odata->next;
1014 GtkObjectData *odata_block;
1017 odata_block = g_new0 (GtkObjectData, GTK_OBJECT_DATA_BLOCK_SIZE);
1018 for (i = 1; i < GTK_OBJECT_DATA_BLOCK_SIZE; i++)
1020 (odata_block + i)->next = gtk_object_data_free_list;
1021 gtk_object_data_free_list = (odata_block + i);
1024 odata = odata_block;
1027 odata->id = data_id;
1029 odata->destroy = destroy;
1030 odata->next = object->object_data;
1032 object->object_data = odata;
1037 gtk_object_set_data_full (GtkObject *object,
1040 GtkDestroyNotify destroy)
1042 g_return_if_fail (key != NULL);
1044 gtk_object_set_data_by_id_full (object, gtk_object_data_force_id (key), data, destroy);
1048 gtk_object_get_data_by_id (GtkObject *object,
1051 GtkObjectData *odata;
1053 g_return_val_if_fail (object != NULL, NULL);
1054 g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
1058 odata = object->object_data;
1061 if (odata->id == data_id)
1063 odata = odata->next;
1071 gtk_object_get_data (GtkObject *object,
1076 g_return_val_if_fail (key != NULL, NULL);
1078 id = gtk_object_data_try_key (key);
1080 return gtk_object_get_data_by_id (object, id);
1086 gtk_object_remove_data_by_id (GtkObject *object,
1090 gtk_object_set_data_by_id_full (object, data_id, NULL, NULL);
1094 gtk_object_remove_data (GtkObject *object,
1099 g_return_if_fail (key != NULL);
1101 id = gtk_object_data_try_key (key);
1103 gtk_object_set_data_by_id_full (object, id, NULL, NULL);
1107 gtk_object_set_user_data (GtkObject *object,
1110 if (!user_data_key_id)
1111 user_data_key_id = g_quark_from_static_string (user_data_key);
1113 gtk_object_set_data_by_id_full (object, user_data_key_id, data, NULL);
1117 gtk_object_get_user_data (GtkObject *object)
1119 if (user_data_key_id)
1120 return gtk_object_get_data_by_id (object, user_data_key_id);
1125 /*******************************************
1126 * GtkObject referencing and unreferencing
1128 *******************************************/
1130 #undef gtk_object_ref
1131 #undef gtk_object_unref
1134 gtk_object_ref (GtkObject *object)
1136 g_return_if_fail (object != NULL);
1137 g_return_if_fail (GTK_IS_OBJECT (object));
1139 object->ref_count += 1;
1143 gtk_object_unref (GtkObject *object)
1145 g_return_if_fail (object != NULL);
1146 g_return_if_fail (GTK_IS_OBJECT (object));
1148 if (object->ref_count == 1)
1149 gtk_object_destroy (object);
1151 if (object->ref_count > 0)
1152 object->ref_count -= 1;
1154 if (object->ref_count == 0)
1156 #ifdef G_ENABLE_DEBUG
1157 if (gtk_debug_flags & GTK_DEBUG_OBJECTS)
1159 g_assert (g_hash_table_lookup (living_objs_ht, object) == object);
1160 g_hash_table_remove (living_objs_ht, object);
1163 #endif /* G_ENABLE_DEBUG */
1164 object->klass->finalize (object);
1168 static GtkObject *gtk_trace_object = NULL;
1170 gtk_trace_referencing (GtkObject *object,
1176 if (gtk_debug_flags & GTK_DEBUG_OBJECTS)
1178 gboolean exists = TRUE;
1180 g_return_if_fail (object != NULL);
1181 g_return_if_fail (GTK_IS_OBJECT (object));
1183 #ifdef G_ENABLE_DEBUG
1184 exists = g_hash_table_lookup (living_objs_ht, object) != NULL;
1185 #endif /* G_ENABLE_DEBUG */
1188 (object == gtk_trace_object ||
1189 gtk_trace_object == (void*)42))
1190 fprintf (stdout, "trace: object_%s: (%s:%p)->ref_count=%d %s (%s:%d)\n",
1191 do_ref ? "ref" : "unref",
1192 gtk_type_name (GTK_OBJECT_TYPE (object)),
1195 do_ref ? "+ 1" : "- 1",
1199 fprintf (stdout, "trace: object_%s(%p): no such object! (%s:%d)\n",
1200 do_ref ? "ref" : "unref",
1207 gtk_object_ref (object);
1209 gtk_object_unref (object);