1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000-2001 Red Hat, Inc.
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
15 * Public 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.
19 * this code is based on the original GtkSignal implementation
20 * for the Gtk+ library by Peter Mattis <petm@xcf.berkeley.edu>
33 #include "gbsearcharray.h"
34 #include "gvaluecollector.h"
35 #include "gvaluetypes.h"
39 #include "gobject_trace.h"
44 * @short_description: A means for customization of object behaviour
45 * and a general purpose notification mechanism
48 * The basic concept of the signal system is that of the
49 * <emphasis>emission</emphasis> of a signal. Signals are introduced
50 * per-type and are identified through strings. Signals introduced
51 * for a parent type are available in derived types as well, so
52 * basically they are a per-type facility that is inherited. A signal
53 * emission mainly involves invocation of a certain set of callbacks
54 * in precisely defined manner. There are two main categories of such
55 * callbacks, per-object
56 * <footnote><para>Although signals can deal with any kind of instantiatable
57 * type, i'm referring to those types as "object types" in the following,
58 * simply because that is the context most users will encounter signals in.
60 * ones and user provided ones.
61 * The per-object callbacks are most often referred to as "object method
62 * handler" or "default (signal) handler", while user provided callbacks are
63 * usually just called "signal handler".
64 * The object method handler is provided at signal creation time (this most
65 * frequently happens at the end of an object class' creation), while user
66 * provided handlers are frequently connected and disconnected to/from a certain
67 * signal on certain object instances.
69 * A signal emission consists of five stages, unless prematurely stopped:
71 * <varlistentry><term></term><listitem><para>
72 * 1 - Invocation of the object method handler for %G_SIGNAL_RUN_FIRST signals
73 * </para></listitem></varlistentry>
74 * <varlistentry><term></term><listitem><para>
75 * 2 - Invocation of normal user-provided signal handlers (<emphasis>after</emphasis> flag %FALSE)
76 * </para></listitem></varlistentry>
77 * <varlistentry><term></term><listitem><para>
78 * 3 - Invocation of the object method handler for %G_SIGNAL_RUN_LAST signals
79 * </para></listitem></varlistentry>
80 * <varlistentry><term></term><listitem><para>
81 * 4 - Invocation of user provided signal handlers, connected with an <emphasis>after</emphasis> flag of %TRUE
82 * </para></listitem></varlistentry>
83 * <varlistentry><term></term><listitem><para>
84 * 5 - Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals
85 * </para></listitem></varlistentry>
87 * The user-provided signal handlers are called in the order they were
89 * All handlers may prematurely stop a signal emission, and any number of
90 * handlers may be connected, disconnected, blocked or unblocked during
92 * There are certain criteria for skipping user handlers in stages 2 and 4
93 * of a signal emission.
94 * First, user handlers may be <emphasis>blocked</emphasis>, blocked handlers are omitted
95 * during callback invocation, to return from the "blocked" state, a
96 * handler has to get unblocked exactly the same amount of times
97 * it has been blocked before.
98 * Second, upon emission of a %G_SIGNAL_DETAILED signal, an additional
99 * "detail" argument passed in to g_signal_emit() has to match the detail
100 * argument of the signal handler currently subject to invocation.
101 * Specification of no detail argument for signal handlers (omission of the
102 * detail part of the signal specification upon connection) serves as a
103 * wildcard and matches any detail argument passed in to emission.
107 #define REPORT_BUG "please report occurrence circumstances to gtk-devel-list@gnome.org"
108 #ifdef G_ENABLE_DEBUG
109 #define IF_DEBUG(debug_type, cond) if ((_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) || cond)
110 static volatile gpointer g_trace_instance_signals = NULL;
111 static volatile gpointer g_trap_instance_signals = NULL;
112 #endif /* G_ENABLE_DEBUG */
115 /* --- typedefs --- */
116 typedef struct _SignalNode SignalNode;
117 typedef struct _SignalKey SignalKey;
118 typedef struct _Emission Emission;
119 typedef struct _Handler Handler;
120 typedef struct _HandlerList HandlerList;
121 typedef struct _HandlerMatch HandlerMatch;
131 /* --- prototypes --- */
132 static inline guint signal_id_lookup (GQuark quark,
134 static void signal_destroy_R (SignalNode *signal_node);
135 static inline HandlerList* handler_list_ensure (guint signal_id,
137 static inline HandlerList* handler_list_lookup (guint signal_id,
139 static inline Handler* handler_new (gboolean after);
140 static void handler_insert (guint signal_id,
143 static Handler* handler_lookup (gpointer instance,
146 static inline HandlerMatch* handler_match_prepend (HandlerMatch *list,
149 static inline HandlerMatch* handler_match_free1_R (HandlerMatch *node,
151 static HandlerMatch* handlers_find (gpointer instance,
152 GSignalMatchType mask,
158 gboolean one_and_only);
159 static inline void handler_ref (Handler *handler);
160 static inline void handler_unref_R (guint signal_id,
163 static gint handler_lists_cmp (gconstpointer node1,
164 gconstpointer node2);
165 static inline void emission_push (Emission **emission_list_p,
167 static inline void emission_pop (Emission **emission_list_p,
169 static inline Emission* emission_find (Emission *emission_list,
173 static gint class_closures_cmp (gconstpointer node1,
174 gconstpointer node2);
175 static gint signal_key_cmp (gconstpointer node1,
176 gconstpointer node2);
177 static gboolean signal_emit_unlocked_R (SignalNode *node,
180 GValue *return_value,
181 const GValue *instance_and_params);
182 static const gchar * type_debug_name (GType type);
185 /* --- structures --- */
188 GSignalAccumulator func;
196 #define SIGNAL_HOOK(hook) ((SignalHook*) (hook))
200 /* permanent portion */
206 /* reinitializable portion */
207 guint test_class_offset : 12;
210 GType *param_types; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
211 GType return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
212 GBSearchArray *class_closure_bsa;
213 SignalAccumulator *accumulator;
214 GSignalCMarshaller c_marshaller;
215 GHookList *emission_hooks;
217 #define MAX_TEST_CLASS_OFFSET (4096) /* 2^12, 12 bits for test_class_offset */
218 #define TEST_CLASS_MAGIC (1) /* indicates NULL class closure, candidate for NOP optimization */
231 GSignalInvocationHint ihint;
240 Handler *tail_before; /* normal signal handlers are appended here */
241 Handler *tail_after; /* CONNECT_AFTER handlers are appended here */
246 gulong sequential_number;
251 guint block_count : 16;
252 #define HANDLER_MAX_BLOCK_COUNT (1 << 16)
265 GType instance_type; /* 0 for default closure */
270 /* --- variables --- */
271 static GBSearchArray *g_signal_key_bsa = NULL;
272 static const GBSearchConfig g_signal_key_bconfig = {
275 G_BSEARCH_ARRAY_ALIGN_POWER2,
277 static GBSearchConfig g_signal_hlbsa_bconfig = {
278 sizeof (HandlerList),
282 static GBSearchConfig g_class_closure_bconfig = {
283 sizeof (ClassClosure),
287 static GHashTable *g_handler_list_bsa_ht = NULL;
288 static Emission *g_recursive_emissions = NULL;
289 static Emission *g_restart_emissions = NULL;
290 static gulong g_handler_sequential_number = 1;
291 G_LOCK_DEFINE_STATIC (g_signal_mutex);
292 #define SIGNAL_LOCK() G_LOCK (g_signal_mutex)
293 #define SIGNAL_UNLOCK() G_UNLOCK (g_signal_mutex)
296 /* --- signal nodes --- */
297 static guint g_n_signal_nodes = 0;
298 static SignalNode **g_signal_nodes = NULL;
300 static inline SignalNode*
301 LOOKUP_SIGNAL_NODE (register guint signal_id)
303 if (signal_id < g_n_signal_nodes)
304 return g_signal_nodes[signal_id];
310 /* --- functions --- */
312 signal_id_lookup (GQuark quark,
315 GType *ifaces, type = itype;
321 /* try looking up signals for this type and its ancestors */
324 SignalKey *signal_key;
327 signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
330 return signal_key->signal_id;
332 type = g_type_parent (type);
336 /* no luck, try interfaces it exports */
337 ifaces = g_type_interfaces (itype, &n_ifaces);
340 SignalKey *signal_key;
342 key.itype = ifaces[n_ifaces];
343 signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
348 return signal_key->signal_id;
357 class_closures_cmp (gconstpointer node1,
360 const ClassClosure *c1 = node1, *c2 = node2;
362 return G_BSEARCH_ARRAY_CMP (c1->instance_type, c2->instance_type);
366 handler_lists_cmp (gconstpointer node1,
369 const HandlerList *hlist1 = node1, *hlist2 = node2;
371 return G_BSEARCH_ARRAY_CMP (hlist1->signal_id, hlist2->signal_id);
374 static inline HandlerList*
375 handler_list_ensure (guint signal_id,
378 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
381 key.signal_id = signal_id;
383 key.tail_before = NULL;
384 key.tail_after = NULL;
387 hlbsa = g_bsearch_array_create (&g_signal_hlbsa_bconfig);
388 hlbsa = g_bsearch_array_insert (hlbsa, &g_signal_hlbsa_bconfig, &key);
389 g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
393 GBSearchArray *o = hlbsa;
395 hlbsa = g_bsearch_array_insert (o, &g_signal_hlbsa_bconfig, &key);
397 g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
399 return g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key);
402 static inline HandlerList*
403 handler_list_lookup (guint signal_id,
406 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
409 key.signal_id = signal_id;
411 return hlbsa ? g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key) : NULL;
415 handler_lookup (gpointer instance,
419 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
425 for (i = 0; i < hlbsa->n_nodes; i++)
427 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
430 for (handler = hlist->handlers; handler; handler = handler->next)
431 if (handler->sequential_number == handler_id)
434 *signal_id_p = hlist->signal_id;
444 static inline HandlerMatch*
445 handler_match_prepend (HandlerMatch *list,
451 node = g_slice_new (HandlerMatch);
452 node->handler = handler;
454 node->signal_id = signal_id;
455 handler_ref (handler);
459 static inline HandlerMatch*
460 handler_match_free1_R (HandlerMatch *node,
463 HandlerMatch *next = node->next;
465 handler_unref_R (node->signal_id, instance, node->handler);
466 g_slice_free (HandlerMatch, node);
472 handlers_find (gpointer instance,
473 GSignalMatchType mask,
479 gboolean one_and_only)
481 HandlerMatch *mlist = NULL;
483 if (mask & G_SIGNAL_MATCH_ID)
485 HandlerList *hlist = handler_list_lookup (signal_id, instance);
487 SignalNode *node = NULL;
489 if (mask & G_SIGNAL_MATCH_FUNC)
491 node = LOOKUP_SIGNAL_NODE (signal_id);
492 if (!node || !node->c_marshaller)
497 for (handler = hlist ? hlist->handlers : NULL; handler; handler = handler->next)
498 if (handler->sequential_number &&
499 ((mask & G_SIGNAL_MATCH_DETAIL) || handler->detail == detail) &&
500 ((mask & G_SIGNAL_MATCH_CLOSURE) || handler->closure == closure) &&
501 ((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
502 ((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
503 ((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
504 handler->closure->meta_marshal == 0 &&
505 ((GCClosure*) handler->closure)->callback == func)))
507 mlist = handler_match_prepend (mlist, handler, signal_id);
514 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
521 for (i = 0; i < hlbsa->n_nodes; i++)
523 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
524 SignalNode *node = NULL;
527 if (!(mask & G_SIGNAL_MATCH_FUNC))
529 node = LOOKUP_SIGNAL_NODE (hlist->signal_id);
530 if (!node->c_marshaller)
534 for (handler = hlist->handlers; handler; handler = handler->next)
535 if (handler->sequential_number &&
536 ((mask & G_SIGNAL_MATCH_DETAIL) || handler->detail == detail) &&
537 ((mask & G_SIGNAL_MATCH_CLOSURE) || handler->closure == closure) &&
538 ((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
539 ((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
540 ((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
541 handler->closure->meta_marshal == 0 &&
542 ((GCClosure*) handler->closure)->callback == func)))
544 mlist = handler_match_prepend (mlist, handler, hlist->signal_id);
555 static inline Handler*
556 handler_new (gboolean after)
558 Handler *handler = g_slice_new (Handler);
559 #ifndef G_DISABLE_CHECKS
560 if (g_handler_sequential_number < 1)
561 g_error (G_STRLOC ": handler id overflow, %s", REPORT_BUG);
564 handler->sequential_number = g_handler_sequential_number++;
565 handler->prev = NULL;
566 handler->next = NULL;
568 handler->ref_count = 1;
569 handler->block_count = 0;
570 handler->after = after != FALSE;
571 handler->closure = NULL;
577 handler_ref (Handler *handler)
579 g_return_if_fail (handler->ref_count > 0);
581 g_atomic_int_inc ((int *)&handler->ref_count);
585 handler_unref_R (guint signal_id,
591 g_return_if_fail (handler->ref_count > 0);
593 is_zero = g_atomic_int_dec_and_test ((int *)&handler->ref_count);
595 if (G_UNLIKELY (is_zero))
597 HandlerList *hlist = NULL;
600 handler->next->prev = handler->prev;
601 if (handler->prev) /* watch out for g_signal_handlers_destroy()! */
602 handler->prev->next = handler->next;
605 hlist = handler_list_lookup (signal_id, instance);
606 hlist->handlers = handler->next;
611 /* check if we are removing the handler pointed to by tail_before */
612 if (!handler->after && (!handler->next || handler->next->after))
615 hlist = handler_list_lookup (signal_id, instance);
618 g_assert (hlist->tail_before == handler); /* paranoid */
619 hlist->tail_before = handler->prev;
623 /* check if we are removing the handler pointed to by tail_after */
627 hlist = handler_list_lookup (signal_id, instance);
630 g_assert (hlist->tail_after == handler); /* paranoid */
631 hlist->tail_after = handler->prev;
637 g_closure_unref (handler->closure);
639 g_slice_free (Handler, handler);
644 handler_insert (guint signal_id,
650 g_assert (handler->prev == NULL && handler->next == NULL); /* paranoid */
652 hlist = handler_list_ensure (signal_id, instance);
653 if (!hlist->handlers)
655 hlist->handlers = handler;
657 hlist->tail_before = handler;
659 else if (handler->after)
661 handler->prev = hlist->tail_after;
662 hlist->tail_after->next = handler;
666 if (hlist->tail_before)
668 handler->next = hlist->tail_before->next;
670 handler->next->prev = handler;
671 handler->prev = hlist->tail_before;
672 hlist->tail_before->next = handler;
674 else /* insert !after handler into a list of only after handlers */
676 handler->next = hlist->handlers;
678 handler->next->prev = handler;
679 hlist->handlers = handler;
681 hlist->tail_before = handler;
685 hlist->tail_after = handler;
689 emission_push (Emission **emission_list_p,
692 emission->next = *emission_list_p;
693 *emission_list_p = emission;
697 emission_pop (Emission **emission_list_p,
700 Emission *node, *last = NULL;
702 for (node = *emission_list_p; node; last = node, node = last->next)
703 if (node == emission)
706 last->next = node->next;
708 *emission_list_p = node->next;
711 g_assert_not_reached ();
714 static inline Emission*
715 emission_find (Emission *emission_list,
722 for (emission = emission_list; emission; emission = emission->next)
723 if (emission->instance == instance &&
724 emission->ihint.signal_id == signal_id &&
725 emission->ihint.detail == detail)
730 static inline Emission*
731 emission_find_innermost (gpointer instance)
733 Emission *emission, *s = NULL, *c = NULL;
735 for (emission = g_restart_emissions; emission; emission = emission->next)
736 if (emission->instance == instance)
741 for (emission = g_recursive_emissions; emission; emission = emission->next)
742 if (emission->instance == instance)
752 return G_HAVE_GROWING_STACK ? MAX (c, s) : MIN (c, s);
756 signal_key_cmp (gconstpointer node1,
759 const SignalKey *key1 = node1, *key2 = node2;
761 if (key1->itype == key2->itype)
762 return G_BSEARCH_ARRAY_CMP (key1->quark, key2->quark);
764 return G_BSEARCH_ARRAY_CMP (key1->itype, key2->itype);
771 if (!g_n_signal_nodes)
773 /* setup handler list binary searchable array hash table (in german, that'd be one word ;) */
774 g_handler_list_bsa_ht = g_hash_table_new (g_direct_hash, NULL);
775 g_signal_key_bsa = g_bsearch_array_create (&g_signal_key_bconfig);
777 /* invalid (0) signal_id */
778 g_n_signal_nodes = 1;
779 g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
780 g_signal_nodes[0] = NULL;
786 _g_signals_destroy (GType itype)
791 for (i = 1; i < g_n_signal_nodes; i++)
793 SignalNode *node = g_signal_nodes[i];
795 if (node->itype == itype)
798 g_warning (G_STRLOC ": signal \"%s\" of type `%s' already destroyed",
800 type_debug_name (node->itype));
802 signal_destroy_R (node);
809 * g_signal_stop_emission:
810 * @instance: the object whose signal handlers you wish to stop.
811 * @signal_id: the signal identifier, as returned by g_signal_lookup().
812 * @detail: the detail which the signal was emitted with.
814 * Stops a signal's current emission.
816 * This will prevent the default method from running, if the signal was
817 * %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
820 * Prints a warning if used on a signal which isn't being emitted.
823 g_signal_stop_emission (gpointer instance,
829 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
830 g_return_if_fail (signal_id > 0);
833 node = LOOKUP_SIGNAL_NODE (signal_id);
834 if (node && detail && !(node->flags & G_SIGNAL_DETAILED))
836 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
840 if (node && g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
842 Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
843 Emission *emission = emission_find (emission_list, signal_id, detail, instance);
847 if (emission->state == EMISSION_HOOK)
848 g_warning (G_STRLOC ": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
849 node->name, instance);
850 else if (emission->state == EMISSION_RUN)
851 emission->state = EMISSION_STOP;
854 g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
855 node->name, instance);
858 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
863 signal_finalize_hook (GHookList *hook_list,
866 GDestroyNotify destroy = hook->destroy;
870 hook->destroy = NULL;
872 destroy (hook->data);
878 * g_signal_add_emission_hook:
879 * @signal_id: the signal identifier, as returned by g_signal_lookup().
880 * @detail: the detail on which to call the hook.
881 * @hook_func: a #GSignalEmissionHook function.
882 * @hook_data: user data for @hook_func.
883 * @data_destroy: a #GDestroyNotify for @hook_data.
885 * Adds an emission hook for a signal, which will get called for any emission
886 * of that signal, independent of the instance. This is possible only
887 * for signals which don't have #G_SIGNAL_NO_HOOKS flag set.
889 * Returns: the hook id, for later use with g_signal_remove_emission_hook().
892 g_signal_add_emission_hook (guint signal_id,
894 GSignalEmissionHook hook_func,
896 GDestroyNotify data_destroy)
898 static gulong seq_hook_id = 1;
901 SignalHook *signal_hook;
903 g_return_val_if_fail (signal_id > 0, 0);
904 g_return_val_if_fail (hook_func != NULL, 0);
907 node = LOOKUP_SIGNAL_NODE (signal_id);
908 if (!node || node->destroyed)
910 g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
914 if (node->flags & G_SIGNAL_NO_HOOKS)
916 g_warning ("%s: signal id `%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC, signal_id);
920 if (detail && !(node->flags & G_SIGNAL_DETAILED))
922 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
926 if (!node->emission_hooks)
928 node->emission_hooks = g_new (GHookList, 1);
929 g_hook_list_init (node->emission_hooks, sizeof (SignalHook));
930 node->emission_hooks->finalize_hook = signal_finalize_hook;
932 hook = g_hook_alloc (node->emission_hooks);
933 hook->data = hook_data;
934 hook->func = (gpointer) hook_func;
935 hook->destroy = data_destroy;
936 signal_hook = SIGNAL_HOOK (hook);
937 signal_hook->detail = detail;
938 node->emission_hooks->seq_id = seq_hook_id;
939 g_hook_append (node->emission_hooks, hook);
940 seq_hook_id = node->emission_hooks->seq_id;
943 return hook->hook_id;
947 * g_signal_remove_emission_hook:
948 * @signal_id: the id of the signal
949 * @hook_id: the id of the emission hook, as returned by
950 * g_signal_add_emission_hook()
952 * Deletes an emission hook.
955 g_signal_remove_emission_hook (guint signal_id,
960 g_return_if_fail (signal_id > 0);
961 g_return_if_fail (hook_id > 0);
964 node = LOOKUP_SIGNAL_NODE (signal_id);
965 if (!node || node->destroyed)
966 g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
967 else if (!node->emission_hooks || !g_hook_destroy (node->emission_hooks, hook_id))
968 g_warning ("%s: signal \"%s\" had no hook (%lu) to remove", G_STRLOC, node->name, hook_id);
973 signal_parse_name (const gchar *name,
976 gboolean force_quark)
978 const gchar *colon = strchr (name, ':');
983 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
984 if (signal_id && detail_p)
987 else if (colon[1] == ':')
990 guint l = colon - name;
994 memcpy (buffer, name, l);
996 signal_id = signal_id_lookup (g_quark_try_string (buffer), itype);
1000 gchar *signal = g_new (gchar, l + 1);
1002 memcpy (signal, name, l);
1004 signal_id = signal_id_lookup (g_quark_try_string (signal), itype);
1008 if (signal_id && detail_p)
1009 *detail_p = colon[2] ? (force_quark ? g_quark_from_string : g_quark_try_string) (colon + 2) : 0;
1017 * g_signal_parse_name:
1018 * @detailed_signal: a string of the form "signal-name::detail".
1019 * @itype: The interface/instance type that introduced "signal-name".
1020 * @signal_id_p: Location to store the signal id.
1021 * @detail_p: Location to store the detail quark.
1022 * @force_detail_quark: %TRUE forces creation of a #GQuark for the detail.
1024 * Internal function to parse a signal name into its @signal_id
1025 * and @detail quark.
1027 * Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
1030 g_signal_parse_name (const gchar *detailed_signal,
1034 gboolean force_detail_quark)
1040 g_return_val_if_fail (detailed_signal != NULL, FALSE);
1041 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), FALSE);
1044 signal_id = signal_parse_name (detailed_signal, itype, &detail, force_detail_quark);
1047 node = signal_id ? LOOKUP_SIGNAL_NODE (signal_id) : NULL;
1048 if (!node || node->destroyed ||
1049 (detail && !(node->flags & G_SIGNAL_DETAILED)))
1053 *signal_id_p = signal_id;
1061 * g_signal_stop_emission_by_name:
1062 * @instance: the object whose signal handlers you wish to stop.
1063 * @detailed_signal: a string of the form "signal-name::detail".
1065 * Stops a signal's current emission.
1067 * This is just like g_signal_stop_emission() except it will look up the
1068 * signal id for you.
1071 g_signal_stop_emission_by_name (gpointer instance,
1072 const gchar *detailed_signal)
1078 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1079 g_return_if_fail (detailed_signal != NULL);
1082 itype = G_TYPE_FROM_INSTANCE (instance);
1083 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
1086 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
1088 if (detail && !(node->flags & G_SIGNAL_DETAILED))
1089 g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
1090 else if (!g_type_is_a (itype, node->itype))
1091 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
1094 Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
1095 Emission *emission = emission_find (emission_list, signal_id, detail, instance);
1099 if (emission->state == EMISSION_HOOK)
1100 g_warning (G_STRLOC ": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
1101 node->name, instance);
1102 else if (emission->state == EMISSION_RUN)
1103 emission->state = EMISSION_STOP;
1106 g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
1107 node->name, instance);
1111 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
1117 * @name: the signal's name.
1118 * @itype: the type that the signal operates on.
1120 * Given the name of the signal and the type of object it connects to, gets
1121 * the signal's identifying integer. Emitting the signal by number is
1122 * somewhat faster than using the name each time.
1124 * Also tries the ancestors of the given type.
1126 * See g_signal_new() for details on allowed signal names.
1128 * Returns: the signal's identifying number, or 0 if no signal was found.
1131 g_signal_lookup (const gchar *name,
1135 g_return_val_if_fail (name != NULL, 0);
1136 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1139 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1143 /* give elaborate warnings */
1144 if (!g_type_name (itype))
1145 g_warning (G_STRLOC ": unable to lookup signal \"%s\" for invalid type id `%"G_GSIZE_FORMAT"'",
1147 else if (!G_TYPE_IS_INSTANTIATABLE (itype))
1148 g_warning (G_STRLOC ": unable to lookup signal \"%s\" for non instantiatable type `%s'",
1149 name, g_type_name (itype));
1150 else if (!g_type_class_peek (itype))
1151 g_warning (G_STRLOC ": unable to lookup signal \"%s\" of unloaded type `%s'",
1152 name, g_type_name (itype));
1159 * g_signal_list_ids:
1160 * @itype: Instance or interface type.
1161 * @n_ids: Location to store the number of signal ids for @itype.
1163 * Lists the signals by id that a certain instance or interface type
1164 * created. Further information about the signals can be acquired through
1167 * Returns: Newly allocated array of signal IDs.
1170 g_signal_list_ids (GType itype,
1178 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), NULL);
1179 g_return_val_if_fail (n_ids != NULL, NULL);
1182 keys = g_bsearch_array_get_nth (g_signal_key_bsa, &g_signal_key_bconfig, 0);
1183 n_nodes = g_bsearch_array_get_n_nodes (g_signal_key_bsa);
1184 result = g_array_new (FALSE, FALSE, sizeof (guint));
1186 for (i = 0; i < n_nodes; i++)
1187 if (keys[i].itype == itype)
1189 const gchar *name = g_quark_to_string (keys[i].quark);
1191 /* Signal names with "_" in them are aliases to the same
1192 * name with "-" instead of "_".
1194 if (!strchr (name, '_'))
1195 g_array_append_val (result, keys[i].signal_id);
1197 *n_ids = result->len;
1201 /* give elaborate warnings */
1202 if (!g_type_name (itype))
1203 g_warning (G_STRLOC ": unable to list signals for invalid type id `%"G_GSIZE_FORMAT"'",
1205 else if (!G_TYPE_IS_INSTANTIATABLE (itype) && !G_TYPE_IS_INTERFACE (itype))
1206 g_warning (G_STRLOC ": unable to list signals of non instantiatable type `%s'",
1207 g_type_name (itype));
1208 else if (!g_type_class_peek (itype) && !G_TYPE_IS_INTERFACE (itype))
1209 g_warning (G_STRLOC ": unable to list signals of unloaded type `%s'",
1210 g_type_name (itype));
1213 return (guint*) g_array_free (result, FALSE);
1218 * @signal_id: the signal's identifying number.
1220 * Given the signal's identifier, finds its name.
1222 * Two different signals may have the same name, if they have differing types.
1224 * Returns: the signal name, or %NULL if the signal number was invalid.
1227 g_signal_name (guint signal_id)
1233 node = LOOKUP_SIGNAL_NODE (signal_id);
1234 name = node ? node->name : NULL;
1237 return (char*) name;
1242 * @signal_id: The signal id of the signal to query information for.
1243 * @query: A user provided structure that is filled in with constant
1244 * values upon success.
1246 * Queries the signal system for in-depth information about a
1247 * specific signal. This function will fill in a user-provided
1248 * structure to hold signal-specific information. If an invalid
1249 * signal id is passed in, the @signal_id member of the #GSignalQuery
1250 * is 0. All members filled into the #GSignalQuery structure should
1251 * be considered constant and have to be left untouched.
1254 g_signal_query (guint signal_id,
1255 GSignalQuery *query)
1259 g_return_if_fail (query != NULL);
1262 node = LOOKUP_SIGNAL_NODE (signal_id);
1263 if (!node || node->destroyed)
1264 query->signal_id = 0;
1267 query->signal_id = node->signal_id;
1268 query->signal_name = node->name;
1269 query->itype = node->itype;
1270 query->signal_flags = node->flags;
1271 query->return_type = node->return_type;
1272 query->n_params = node->n_params;
1273 query->param_types = node->param_types;
1280 * @signal_name: the name for the signal
1281 * @itype: the type this signal pertains to. It will also pertain to
1282 * types which are derived from this type.
1283 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1284 * the default handler is to be invoked. You should at least specify
1285 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1286 * @class_offset: The offset of the function pointer in the class structure
1287 * for this type. Used to invoke a class method generically. Pass 0 to
1288 * not associate a class method slot with this signal.
1289 * @accumulator: the accumulator for this signal; may be %NULL.
1290 * @accu_data: user data for the @accumulator.
1291 * @c_marshaller: the function to translate arrays of parameter values to
1292 * signal emissions into C language callback invocations.
1293 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1294 * without a return value.
1295 * @n_params: the number of parameter types to follow.
1296 * @...: a list of types, one for each parameter.
1298 * Creates a new signal. (This is usually done in the class initializer.)
1300 * A signal name consists of segments consisting of ASCII letters and
1301 * digits, separated by either the '-' or '_' character. The first
1302 * character of a signal name must be a letter. Names which violate these
1303 * rules lead to undefined behaviour of the GSignal system.
1305 * When registering a signal and looking up a signal, either separator can
1306 * be used, but they cannot be mixed.
1308 * If 0 is used for @class_offset subclasses cannot override the class handler
1309 * in their <code>class_init</code> method by doing
1310 * <code>super_class->signal_handler = my_signal_handler</code>. Instead they
1311 * will have to use g_signal_override_class_handler().
1313 * Returns: the signal id
1316 g_signal_new (const gchar *signal_name,
1318 GSignalFlags signal_flags,
1320 GSignalAccumulator accumulator,
1322 GSignalCMarshaller c_marshaller,
1330 g_return_val_if_fail (signal_name != NULL, 0);
1332 va_start (args, n_params);
1334 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1335 class_offset ? g_signal_type_cclosure_new (itype, class_offset) : NULL,
1336 accumulator, accu_data, c_marshaller,
1337 return_type, n_params, args);
1341 /* optimize NOP emissions with NULL class handlers */
1342 if (signal_id && G_TYPE_IS_INSTANTIATABLE (itype) && return_type == G_TYPE_NONE &&
1343 class_offset && class_offset < MAX_TEST_CLASS_OFFSET &&
1344 ~signal_flags & G_SIGNAL_MUST_COLLECT)
1349 node = LOOKUP_SIGNAL_NODE (signal_id);
1350 node->test_class_offset = class_offset;
1358 * g_signal_new_class_handler:
1359 * @signal_name: the name for the signal
1360 * @itype: the type this signal pertains to. It will also pertain to
1361 * types which are derived from this type.
1362 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1363 * the default handler is to be invoked. You should at least specify
1364 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1365 * @class_handler: a #GCallback which acts as class implementation of
1366 * this signal. Used to invoke a class method generically. Pass %NULL to
1367 * not associate a class method with this signal.
1368 * @accumulator: the accumulator for this signal; may be %NULL.
1369 * @accu_data: user data for the @accumulator.
1370 * @c_marshaller: the function to translate arrays of parameter values to
1371 * signal emissions into C language callback invocations.
1372 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1373 * without a return value.
1374 * @n_params: the number of parameter types to follow.
1375 * @...: a list of types, one for each parameter.
1377 * Creates a new signal. (This is usually done in the class initializer.)
1379 * This is a variant of g_signal_new() that takes a C callback instead
1380 * off a class offset for the signal's class handler. This function
1381 * doesn't need a function pointer exposed in the class structure of
1382 * an object definition, instead the function pointer is passed
1383 * directly and can be overriden by derived classes with
1384 * g_signal_override_class_closure() or
1385 * g_signal_override_class_handler()and chained to with
1386 * g_signal_chain_from_overridden() or
1387 * g_signal_chain_from_overridden_handler().
1389 * See g_signal_new() for information about signal names.
1391 * Returns: the signal id
1396 g_signal_new_class_handler (const gchar *signal_name,
1398 GSignalFlags signal_flags,
1399 GCallback class_handler,
1400 GSignalAccumulator accumulator,
1402 GSignalCMarshaller c_marshaller,
1410 g_return_val_if_fail (signal_name != NULL, 0);
1412 va_start (args, n_params);
1414 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1415 class_handler ? g_cclosure_new (class_handler, NULL, NULL) : NULL,
1416 accumulator, accu_data, c_marshaller,
1417 return_type, n_params, args);
1424 static inline ClassClosure*
1425 signal_find_class_closure (SignalNode *node,
1428 GBSearchArray *bsa = node->class_closure_bsa;
1435 /* cc->instance_type is 0 for default closure */
1437 key.instance_type = itype;
1438 cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1439 while (!cc && key.instance_type)
1441 key.instance_type = g_type_parent (key.instance_type);
1442 cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1450 static inline GClosure*
1451 signal_lookup_closure (SignalNode *node,
1452 GTypeInstance *instance)
1456 if (node->class_closure_bsa && g_bsearch_array_get_n_nodes (node->class_closure_bsa) == 1)
1458 cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
1459 if (cc && cc->instance_type == 0) /* check for default closure */
1462 cc = signal_find_class_closure (node, G_TYPE_FROM_INSTANCE (instance));
1463 return cc ? cc->closure : NULL;
1467 signal_add_class_closure (SignalNode *node,
1473 /* can't optimize NOP emissions with overridden class closures */
1474 node->test_class_offset = 0;
1476 if (!node->class_closure_bsa)
1477 node->class_closure_bsa = g_bsearch_array_create (&g_class_closure_bconfig);
1478 key.instance_type = itype;
1479 key.closure = g_closure_ref (closure);
1480 node->class_closure_bsa = g_bsearch_array_insert (node->class_closure_bsa,
1481 &g_class_closure_bconfig,
1483 g_closure_sink (closure);
1484 if (node->c_marshaller && closure && G_CLOSURE_NEEDS_MARSHAL (closure))
1485 g_closure_set_marshal (closure, node->c_marshaller);
1490 * @signal_name: the name for the signal
1491 * @itype: the type this signal pertains to. It will also pertain to
1492 * types which are derived from this type
1493 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1494 * the default handler is to be invoked. You should at least specify
1495 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
1496 * @class_closure: The closure to invoke on signal emission; may be %NULL
1497 * @accumulator: the accumulator for this signal; may be %NULL
1498 * @accu_data: user data for the @accumulator
1499 * @c_marshaller: the function to translate arrays of parameter values to
1500 * signal emissions into C language callback invocations
1501 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1502 * without a return value
1503 * @n_params: the length of @param_types
1504 * @param_types: an array of types, one for each parameter
1506 * Creates a new signal. (This is usually done in the class initializer.)
1508 * See g_signal_new() for details on allowed signal names.
1510 * Returns: the signal id
1513 g_signal_newv (const gchar *signal_name,
1515 GSignalFlags signal_flags,
1516 GClosure *class_closure,
1517 GSignalAccumulator accumulator,
1519 GSignalCMarshaller c_marshaller,
1528 g_return_val_if_fail (signal_name != NULL, 0);
1529 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1531 g_return_val_if_fail (param_types != NULL, 0);
1532 g_return_val_if_fail ((return_type & G_SIGNAL_TYPE_STATIC_SCOPE) == 0, 0);
1533 if (return_type == (G_TYPE_NONE & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1534 g_return_val_if_fail (accumulator == NULL, 0);
1536 g_return_val_if_fail (accu_data == NULL, 0);
1538 name = g_strdup (signal_name);
1539 g_strdelimit (name, G_STR_DELIMITERS ":^", '_'); /* FIXME do character checks like for types */
1543 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1544 node = LOOKUP_SIGNAL_NODE (signal_id);
1545 if (node && !node->destroyed)
1547 g_warning (G_STRLOC ": signal \"%s\" already exists in the `%s' %s",
1549 type_debug_name (node->itype),
1550 G_TYPE_IS_INTERFACE (node->itype) ? "interface" : "class ancestry");
1555 if (node && node->itype != itype)
1557 g_warning (G_STRLOC ": signal \"%s\" for type `%s' was previously created for type `%s'",
1559 type_debug_name (itype),
1560 type_debug_name (node->itype));
1565 for (i = 0; i < n_params; i++)
1566 if (!G_TYPE_IS_VALUE (param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1568 g_warning (G_STRLOC ": parameter %d of type `%s' for signal \"%s::%s\" is not a value type",
1569 i + 1, type_debug_name (param_types[i]), type_debug_name (itype), name);
1574 if (return_type != G_TYPE_NONE && !G_TYPE_IS_VALUE (return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1576 g_warning (G_STRLOC ": return value of type `%s' for signal \"%s::%s\" is not a value type",
1577 type_debug_name (return_type), type_debug_name (itype), name);
1582 if (return_type != G_TYPE_NONE &&
1583 (signal_flags & (G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST | G_SIGNAL_RUN_CLEANUP)) == G_SIGNAL_RUN_FIRST)
1585 g_warning (G_STRLOC ": signal \"%s::%s\" has return type `%s' and is only G_SIGNAL_RUN_FIRST",
1586 type_debug_name (itype), name, type_debug_name (return_type));
1592 /* setup permanent portion of signal node */
1597 signal_id = g_n_signal_nodes++;
1598 node = g_new (SignalNode, 1);
1599 node->signal_id = signal_id;
1600 g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
1601 g_signal_nodes[signal_id] = node;
1602 node->itype = itype;
1605 key.quark = g_quark_from_string (node->name);
1606 key.signal_id = signal_id;
1607 g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1608 g_strdelimit (name, "_", '-');
1609 node->name = g_intern_string (name);
1610 key.quark = g_quark_from_string (name);
1611 g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1613 TRACE(GOBJECT_SIGNAL_NEW(signal_id, name, itype));
1615 node->destroyed = FALSE;
1616 node->test_class_offset = 0;
1618 /* setup reinitializable portion */
1619 node->flags = signal_flags & G_SIGNAL_FLAGS_MASK;
1620 node->n_params = n_params;
1621 node->param_types = g_memdup (param_types, sizeof (GType) * n_params);
1622 node->return_type = return_type;
1623 node->class_closure_bsa = NULL;
1626 node->accumulator = g_new (SignalAccumulator, 1);
1627 node->accumulator->func = accumulator;
1628 node->accumulator->data = accu_data;
1631 node->accumulator = NULL;
1632 node->c_marshaller = c_marshaller;
1633 node->emission_hooks = NULL;
1635 signal_add_class_closure (node, 0, class_closure);
1636 else if (G_TYPE_IS_INSTANTIATABLE (itype) &&
1637 return_type == G_TYPE_NONE &&
1638 ~signal_flags & G_SIGNAL_MUST_COLLECT)
1640 /* optimize NOP emissions */
1641 node->test_class_offset = TEST_CLASS_MAGIC;
1651 * g_signal_new_valist:
1652 * @signal_name: the name for the signal
1653 * @itype: the type this signal pertains to. It will also pertain to
1654 * types which are derived from this type.
1655 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1656 * the default handler is to be invoked. You should at least specify
1657 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1658 * @class_closure: The closure to invoke on signal emission; may be %NULL.
1659 * @accumulator: the accumulator for this signal; may be %NULL.
1660 * @accu_data: user data for the @accumulator.
1661 * @c_marshaller: the function to translate arrays of parameter values to
1662 * signal emissions into C language callback invocations.
1663 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1664 * without a return value.
1665 * @n_params: the number of parameter types in @args.
1666 * @args: va_list of #GType, one for each parameter.
1668 * Creates a new signal. (This is usually done in the class initializer.)
1670 * See g_signal_new() for details on allowed signal names.
1672 * Returns: the signal id
1675 g_signal_new_valist (const gchar *signal_name,
1677 GSignalFlags signal_flags,
1678 GClosure *class_closure,
1679 GSignalAccumulator accumulator,
1681 GSignalCMarshaller c_marshaller,
1692 param_types = g_new (GType, n_params);
1694 for (i = 0; i < n_params; i++)
1695 param_types[i] = va_arg (args, GType);
1700 signal_id = g_signal_newv (signal_name, itype, signal_flags,
1701 class_closure, accumulator, accu_data, c_marshaller,
1702 return_type, n_params, param_types);
1703 g_free (param_types);
1709 signal_destroy_R (SignalNode *signal_node)
1711 SignalNode node = *signal_node;
1713 signal_node->destroyed = TRUE;
1715 /* reentrancy caution, zero out real contents first */
1716 signal_node->test_class_offset = 0;
1717 signal_node->n_params = 0;
1718 signal_node->param_types = NULL;
1719 signal_node->return_type = 0;
1720 signal_node->class_closure_bsa = NULL;
1721 signal_node->accumulator = NULL;
1722 signal_node->c_marshaller = NULL;
1723 signal_node->emission_hooks = NULL;
1725 #ifdef G_ENABLE_DEBUG
1726 /* check current emissions */
1730 for (emission = (node.flags & G_SIGNAL_NO_RECURSE) ? g_restart_emissions : g_recursive_emissions;
1731 emission; emission = emission->next)
1732 if (emission->ihint.signal_id == node.signal_id)
1733 g_critical (G_STRLOC ": signal \"%s\" being destroyed is currently in emission (instance `%p')",
1734 node.name, emission->instance);
1738 /* free contents that need to
1741 g_free (node.param_types);
1742 if (node.class_closure_bsa)
1746 for (i = 0; i < node.class_closure_bsa->n_nodes; i++)
1748 ClassClosure *cc = g_bsearch_array_get_nth (node.class_closure_bsa, &g_class_closure_bconfig, i);
1750 g_closure_unref (cc->closure);
1752 g_bsearch_array_free (node.class_closure_bsa, &g_class_closure_bconfig);
1754 g_free (node.accumulator);
1755 if (node.emission_hooks)
1757 g_hook_list_clear (node.emission_hooks);
1758 g_free (node.emission_hooks);
1764 * g_signal_override_class_closure:
1765 * @signal_id: the signal id
1766 * @instance_type: the instance type on which to override the class closure
1768 * @class_closure: the closure.
1770 * Overrides the class closure (i.e. the default handler) for the given signal
1771 * for emissions on instances of @instance_type. @instance_type must be derived
1772 * from the type to which the signal belongs.
1774 * See g_signal_chain_from_overridden() and
1775 * g_signal_chain_from_overridden_handler() for how to chain up to the
1776 * parent class closure from inside the overridden one.
1779 g_signal_override_class_closure (guint signal_id,
1780 GType instance_type,
1781 GClosure *class_closure)
1785 g_return_if_fail (signal_id > 0);
1786 g_return_if_fail (class_closure != NULL);
1789 node = LOOKUP_SIGNAL_NODE (signal_id);
1790 if (!g_type_is_a (instance_type, node->itype))
1791 g_warning ("%s: type `%s' cannot be overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1794 ClassClosure *cc = signal_find_class_closure (node, instance_type);
1796 if (cc && cc->instance_type == instance_type)
1797 g_warning ("%s: type `%s' is already overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1799 signal_add_class_closure (node, instance_type, class_closure);
1805 * g_signal_override_class_handler:
1806 * @signal_name: the name for the signal
1807 * @instance_type: the instance type on which to override the class handler
1809 * @class_handler: the handler.
1811 * Overrides the class closure (i.e. the default handler) for the
1812 * given signal for emissions on instances of @instance_type with
1813 * callabck @class_handler. @instance_type must be derived from the
1814 * type to which the signal belongs.
1816 * See g_signal_chain_from_overridden() and
1817 * g_signal_chain_from_overridden_handler() for how to chain up to the
1818 * parent class closure from inside the overridden one.
1823 g_signal_override_class_handler (const gchar *signal_name,
1824 GType instance_type,
1825 GCallback class_handler)
1829 g_return_if_fail (signal_name != NULL);
1830 g_return_if_fail (instance_type != G_TYPE_NONE);
1831 g_return_if_fail (class_handler != NULL);
1833 signal_id = g_signal_lookup (signal_name, instance_type);
1836 g_signal_override_class_closure (signal_id, instance_type,
1837 g_cclosure_new (class_handler, NULL, NULL));
1839 g_warning ("%s: signal name '%s' is invalid for type id '%"G_GSIZE_FORMAT"'",
1840 G_STRLOC, signal_name, instance_type);
1845 * g_signal_chain_from_overridden:
1846 * @instance_and_params: the argument list of the signal emission. The first
1847 * element in the array is a #GValue for the instance the signal is being
1848 * emitted on. The rest are any arguments to be passed to the signal.
1849 * @return_value: Location for the return value.
1851 * Calls the original class closure of a signal. This function should only
1852 * be called from an overridden class closure; see
1853 * g_signal_override_class_closure() and
1854 * g_signal_override_class_handler().
1857 g_signal_chain_from_overridden (const GValue *instance_and_params,
1858 GValue *return_value)
1860 GType chain_type = 0, restore_type = 0;
1861 Emission *emission = NULL;
1862 GClosure *closure = NULL;
1866 g_return_if_fail (instance_and_params != NULL);
1867 instance = g_value_peek_pointer (instance_and_params);
1868 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1871 emission = emission_find_innermost (instance);
1874 SignalNode *node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
1876 g_assert (node != NULL); /* paranoid */
1878 /* we should probably do the same parameter checks as g_signal_emit() here.
1880 if (emission->chain_type != G_TYPE_NONE)
1882 ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
1884 g_assert (cc != NULL); /* closure currently in call stack */
1886 n_params = node->n_params;
1887 restore_type = cc->instance_type;
1888 cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
1889 if (cc && cc->instance_type != restore_type)
1891 closure = cc->closure;
1892 chain_type = cc->instance_type;
1896 g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
1899 g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
1903 emission->chain_type = chain_type;
1905 g_closure_invoke (closure,
1908 instance_and_params,
1911 emission->chain_type = restore_type;
1917 * g_signal_chain_from_overridden_handler:
1918 * @instance: the instance the signal is being emitted on.
1919 * @...: parameters to be passed to the parent class closure, followed by a
1920 * location for the return value. If the return type of the signal
1921 * is #G_TYPE_NONE, the return value location can be omitted.
1923 * Calls the original class closure of a signal. This function should
1924 * only be called from an overridden class closure; see
1925 * g_signal_override_class_closure() and
1926 * g_signal_override_class_handler().
1931 g_signal_chain_from_overridden_handler (gpointer instance,
1934 GType chain_type = 0, restore_type = 0;
1935 Emission *emission = NULL;
1936 GClosure *closure = NULL;
1940 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1943 emission = emission_find_innermost (instance);
1946 node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
1948 g_assert (node != NULL); /* paranoid */
1950 /* we should probably do the same parameter checks as g_signal_emit() here.
1952 if (emission->chain_type != G_TYPE_NONE)
1954 ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
1956 g_assert (cc != NULL); /* closure currently in call stack */
1958 n_params = node->n_params;
1959 restore_type = cc->instance_type;
1960 cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
1961 if (cc && cc->instance_type != restore_type)
1963 closure = cc->closure;
1964 chain_type = cc->instance_type;
1968 g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
1971 g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
1975 GValue *instance_and_params;
1976 GType signal_return_type;
1977 GValue *param_values;
1981 va_start (var_args, instance);
1983 signal_return_type = node->return_type;
1984 instance_and_params = g_slice_alloc0 (sizeof (GValue) * (n_params + 1));
1985 param_values = instance_and_params + 1;
1987 for (i = 0; i < node->n_params; i++)
1990 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
1991 gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
1994 G_VALUE_COLLECT_INIT (param_values + i, ptype,
1996 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2000 g_warning ("%s: %s", G_STRLOC, error);
2003 /* we purposely leak the value here, it might not be
2004 * in a sane state if an error condition occoured
2007 g_value_unset (param_values + i);
2009 g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
2017 instance_and_params->g_type = 0;
2018 g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
2019 g_value_set_instance (instance_and_params, instance);
2022 emission->chain_type = chain_type;
2025 if (signal_return_type == G_TYPE_NONE)
2027 g_closure_invoke (closure,
2030 instance_and_params,
2035 GValue return_value = { 0, };
2036 gchar *error = NULL;
2037 GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2038 gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
2040 g_value_init (&return_value, rtype);
2042 g_closure_invoke (closure,
2045 instance_and_params,
2048 G_VALUE_LCOPY (&return_value,
2050 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2054 g_value_unset (&return_value);
2058 g_warning ("%s: %s", G_STRLOC, error);
2061 /* we purposely leak the value here, it might not be
2062 * in a sane state if an error condition occured
2067 for (i = 0; i < n_params; i++)
2068 g_value_unset (param_values + i);
2069 g_value_unset (instance_and_params);
2070 g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
2075 emission->chain_type = restore_type;
2081 * g_signal_get_invocation_hint:
2082 * @instance: the instance to query
2084 * Returns the invocation hint of the innermost signal emission of instance.
2086 * Returns: the invocation hint of the innermost signal emission.
2088 GSignalInvocationHint*
2089 g_signal_get_invocation_hint (gpointer instance)
2091 Emission *emission = NULL;
2093 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), NULL);
2096 emission = emission_find_innermost (instance);
2099 return emission ? &emission->ihint : NULL;
2103 * g_signal_connect_closure_by_id:
2104 * @instance: the instance to connect to.
2105 * @signal_id: the id of the signal.
2106 * @detail: the detail.
2107 * @closure: the closure to connect.
2108 * @after: whether the handler should be called before or after the
2109 * default handler of the signal.
2111 * Connects a closure to a signal for a particular object.
2113 * Returns: the handler id
2116 g_signal_connect_closure_by_id (gpointer instance,
2123 gulong handler_seq_no = 0;
2125 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2126 g_return_val_if_fail (signal_id > 0, 0);
2127 g_return_val_if_fail (closure != NULL, 0);
2130 node = LOOKUP_SIGNAL_NODE (signal_id);
2133 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2134 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2135 else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2136 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2139 Handler *handler = handler_new (after);
2141 handler_seq_no = handler->sequential_number;
2142 handler->detail = detail;
2143 handler->closure = g_closure_ref (closure);
2144 g_closure_sink (closure);
2145 handler_insert (signal_id, instance, handler);
2146 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (closure))
2147 g_closure_set_marshal (closure, node->c_marshaller);
2151 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2154 return handler_seq_no;
2158 * g_signal_connect_closure:
2159 * @instance: the instance to connect to.
2160 * @detailed_signal: a string of the form "signal-name::detail".
2161 * @closure: the closure to connect.
2162 * @after: whether the handler should be called before or after the
2163 * default handler of the signal.
2165 * Connects a closure to a signal for a particular object.
2167 * Returns: the handler id
2170 g_signal_connect_closure (gpointer instance,
2171 const gchar *detailed_signal,
2176 gulong handler_seq_no = 0;
2180 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2181 g_return_val_if_fail (detailed_signal != NULL, 0);
2182 g_return_val_if_fail (closure != NULL, 0);
2185 itype = G_TYPE_FROM_INSTANCE (instance);
2186 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2189 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2191 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2192 g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
2193 else if (!g_type_is_a (itype, node->itype))
2194 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2197 Handler *handler = handler_new (after);
2199 handler_seq_no = handler->sequential_number;
2200 handler->detail = detail;
2201 handler->closure = g_closure_ref (closure);
2202 g_closure_sink (closure);
2203 handler_insert (signal_id, instance, handler);
2204 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2205 g_closure_set_marshal (handler->closure, node->c_marshaller);
2209 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2212 return handler_seq_no;
2216 * g_signal_connect_data:
2217 * @instance: the instance to connect to.
2218 * @detailed_signal: a string of the form "signal-name::detail".
2219 * @c_handler: the #GCallback to connect.
2220 * @data: data to pass to @c_handler calls.
2221 * @destroy_data: a #GClosureNotify for @data.
2222 * @connect_flags: a combination of #GConnectFlags.
2224 * Connects a #GCallback function to a signal for a particular object. Similar
2225 * to g_signal_connect(), but allows to provide a #GClosureNotify for the data
2226 * which will be called when the signal handler is disconnected and no longer
2227 * used. Specify @connect_flags if you need <literal>..._after()</literal> or
2228 * <literal>..._swapped()</literal> variants of this function.
2230 * Returns: the handler id
2233 g_signal_connect_data (gpointer instance,
2234 const gchar *detailed_signal,
2235 GCallback c_handler,
2237 GClosureNotify destroy_data,
2238 GConnectFlags connect_flags)
2241 gulong handler_seq_no = 0;
2244 gboolean swapped, after;
2246 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2247 g_return_val_if_fail (detailed_signal != NULL, 0);
2248 g_return_val_if_fail (c_handler != NULL, 0);
2250 swapped = (connect_flags & G_CONNECT_SWAPPED) != FALSE;
2251 after = (connect_flags & G_CONNECT_AFTER) != FALSE;
2254 itype = G_TYPE_FROM_INSTANCE (instance);
2255 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2258 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2260 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2261 g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
2262 else if (!g_type_is_a (itype, node->itype))
2263 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2266 Handler *handler = handler_new (after);
2268 handler_seq_no = handler->sequential_number;
2269 handler->detail = detail;
2270 handler->closure = g_closure_ref ((swapped ? g_cclosure_new_swap : g_cclosure_new) (c_handler, data, destroy_data));
2271 g_closure_sink (handler->closure);
2272 handler_insert (signal_id, instance, handler);
2273 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2274 g_closure_set_marshal (handler->closure, node->c_marshaller);
2278 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2281 return handler_seq_no;
2285 * g_signal_handler_block:
2286 * @instance: The instance to block the signal handler of.
2287 * @handler_id: Handler id of the handler to be blocked.
2289 * Blocks a handler of an instance so it will not be called during any
2290 * signal emissions unless it is unblocked again. Thus "blocking" a
2291 * signal handler means to temporarily deactive it, a signal handler
2292 * has to be unblocked exactly the same amount of times it has been
2293 * blocked before to become active again.
2295 * The @handler_id has to be a valid signal handler id, connected to a
2296 * signal of @instance.
2299 g_signal_handler_block (gpointer instance,
2304 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2305 g_return_if_fail (handler_id > 0);
2308 handler = handler_lookup (instance, handler_id, NULL);
2311 #ifndef G_DISABLE_CHECKS
2312 if (handler->block_count >= HANDLER_MAX_BLOCK_COUNT - 1)
2313 g_error (G_STRLOC ": handler block_count overflow, %s", REPORT_BUG);
2315 handler->block_count += 1;
2318 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2323 * g_signal_handler_unblock:
2324 * @instance: The instance to unblock the signal handler of.
2325 * @handler_id: Handler id of the handler to be unblocked.
2327 * Undoes the effect of a previous g_signal_handler_block() call. A
2328 * blocked handler is skipped during signal emissions and will not be
2329 * invoked, unblocking it (for exactly the amount of times it has been
2330 * blocked before) reverts its "blocked" state, so the handler will be
2331 * recognized by the signal system and is called upon future or
2332 * currently ongoing signal emissions (since the order in which
2333 * handlers are called during signal emissions is deterministic,
2334 * whether the unblocked handler in question is called as part of a
2335 * currently ongoing emission depends on how far that emission has
2338 * The @handler_id has to be a valid id of a signal handler that is
2339 * connected to a signal of @instance and is currently blocked.
2342 g_signal_handler_unblock (gpointer instance,
2347 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2348 g_return_if_fail (handler_id > 0);
2351 handler = handler_lookup (instance, handler_id, NULL);
2354 if (handler->block_count)
2355 handler->block_count -= 1;
2357 g_warning (G_STRLOC ": handler `%lu' of instance `%p' is not blocked", handler_id, instance);
2360 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2365 * g_signal_handler_disconnect:
2366 * @instance: The instance to remove the signal handler from.
2367 * @handler_id: Handler id of the handler to be disconnected.
2369 * Disconnects a handler from an instance so it will not be called during
2370 * any future or currently ongoing emissions of the signal it has been
2371 * connected to. The @handler_id becomes invalid and may be reused.
2373 * The @handler_id has to be a valid signal handler id, connected to a
2374 * signal of @instance.
2377 g_signal_handler_disconnect (gpointer instance,
2383 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2384 g_return_if_fail (handler_id > 0);
2387 handler = handler_lookup (instance, handler_id, &signal_id);
2390 handler->sequential_number = 0;
2391 handler->block_count = 1;
2392 handler_unref_R (signal_id, instance, handler);
2395 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2400 * g_signal_handler_is_connected:
2401 * @instance: The instance where a signal handler is sought.
2402 * @handler_id: the handler id.
2404 * Returns whether @handler_id is the id of a handler connected to @instance.
2406 * Returns: whether @handler_id identifies a handler connected to @instance.
2409 g_signal_handler_is_connected (gpointer instance,
2415 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2418 handler = handler_lookup (instance, handler_id, NULL);
2419 connected = handler != NULL;
2426 g_signal_handlers_destroy (gpointer instance)
2428 GBSearchArray *hlbsa;
2430 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2433 hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
2438 /* reentrancy caution, delete instance trace first */
2439 g_hash_table_remove (g_handler_list_bsa_ht, instance);
2441 for (i = 0; i < hlbsa->n_nodes; i++)
2443 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
2444 Handler *handler = hlist->handlers;
2448 Handler *tmp = handler;
2450 handler = tmp->next;
2451 tmp->block_count = 1;
2452 /* cruel unlink, this works because _all_ handlers vanish */
2455 if (tmp->sequential_number)
2457 tmp->sequential_number = 0;
2458 handler_unref_R (0, NULL, tmp);
2462 g_bsearch_array_free (hlbsa, &g_signal_hlbsa_bconfig);
2468 * g_signal_handler_find:
2469 * @instance: The instance owning the signal handler to be found.
2470 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2471 * and/or @data the handler has to match.
2472 * @signal_id: Signal the handler has to be connected to.
2473 * @detail: Signal detail the handler has to be connected to.
2474 * @closure: The closure the handler will invoke.
2475 * @func: The C closure callback of the handler (useless for non-C closures).
2476 * @data: The closure data of the handler's closure.
2478 * Finds the first signal handler that matches certain selection criteria.
2479 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2480 * flags, and the criteria values are passed as arguments.
2481 * The match @mask has to be non-0 for successful matches.
2482 * If no handler was found, 0 is returned.
2484 * Returns: A valid non-0 signal handler id for a successful match.
2487 g_signal_handler_find (gpointer instance,
2488 GSignalMatchType mask,
2495 gulong handler_seq_no = 0;
2497 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2498 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2500 if (mask & G_SIGNAL_MATCH_MASK)
2502 HandlerMatch *mlist;
2505 mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, TRUE);
2508 handler_seq_no = mlist->handler->sequential_number;
2509 handler_match_free1_R (mlist, instance);
2514 return handler_seq_no;
2518 signal_handlers_foreach_matched_R (gpointer instance,
2519 GSignalMatchType mask,
2525 void (*callback) (gpointer instance,
2526 gulong handler_seq_no))
2528 HandlerMatch *mlist;
2529 guint n_handlers = 0;
2531 mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, FALSE);
2535 if (mlist->handler->sequential_number)
2538 callback (instance, mlist->handler->sequential_number);
2541 mlist = handler_match_free1_R (mlist, instance);
2548 * g_signal_handlers_block_matched:
2549 * @instance: The instance to block handlers from.
2550 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2551 * and/or @data the handlers have to match.
2552 * @signal_id: Signal the handlers have to be connected to.
2553 * @detail: Signal detail the handlers have to be connected to.
2554 * @closure: The closure the handlers will invoke.
2555 * @func: The C closure callback of the handlers (useless for non-C closures).
2556 * @data: The closure data of the handlers' closures.
2558 * Blocks all handlers on an instance that match a certain selection criteria.
2559 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2560 * flags, and the criteria values are passed as arguments.
2561 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2562 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2563 * If no handlers were found, 0 is returned, the number of blocked handlers
2566 * Returns: The number of handlers that matched.
2569 g_signal_handlers_block_matched (gpointer instance,
2570 GSignalMatchType mask,
2577 guint n_handlers = 0;
2579 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2580 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2582 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2585 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2586 closure, func, data,
2587 g_signal_handler_block);
2595 * g_signal_handlers_unblock_matched:
2596 * @instance: The instance to unblock handlers from.
2597 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2598 * and/or @data the handlers have to match.
2599 * @signal_id: Signal the handlers have to be connected to.
2600 * @detail: Signal detail the handlers have to be connected to.
2601 * @closure: The closure the handlers will invoke.
2602 * @func: The C closure callback of the handlers (useless for non-C closures).
2603 * @data: The closure data of the handlers' closures.
2605 * Unblocks all handlers on an instance that match a certain selection
2606 * criteria. The criteria mask is passed as an OR-ed combination of
2607 * #GSignalMatchType flags, and the criteria values are passed as arguments.
2608 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2609 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2610 * If no handlers were found, 0 is returned, the number of unblocked handlers
2611 * otherwise. The match criteria should not apply to any handlers that are
2612 * not currently blocked.
2614 * Returns: The number of handlers that matched.
2617 g_signal_handlers_unblock_matched (gpointer instance,
2618 GSignalMatchType mask,
2625 guint n_handlers = 0;
2627 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2628 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2630 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2633 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2634 closure, func, data,
2635 g_signal_handler_unblock);
2643 * g_signal_handlers_disconnect_matched:
2644 * @instance: The instance to remove handlers from.
2645 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2646 * and/or @data the handlers have to match.
2647 * @signal_id: Signal the handlers have to be connected to.
2648 * @detail: Signal detail the handlers have to be connected to.
2649 * @closure: The closure the handlers will invoke.
2650 * @func: The C closure callback of the handlers (useless for non-C closures).
2651 * @data: The closure data of the handlers' closures.
2653 * Disconnects all handlers on an instance that match a certain
2654 * selection criteria. The criteria mask is passed as an OR-ed
2655 * combination of #GSignalMatchType flags, and the criteria values are
2656 * passed as arguments. Passing at least one of the
2657 * %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
2658 * %G_SIGNAL_MATCH_DATA match flags is required for successful
2659 * matches. If no handlers were found, 0 is returned, the number of
2660 * disconnected handlers otherwise.
2662 * Returns: The number of handlers that matched.
2665 g_signal_handlers_disconnect_matched (gpointer instance,
2666 GSignalMatchType mask,
2673 guint n_handlers = 0;
2675 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2676 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2678 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2681 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2682 closure, func, data,
2683 g_signal_handler_disconnect);
2691 * g_signal_has_handler_pending:
2692 * @instance: the object whose signal handlers are sought.
2693 * @signal_id: the signal id.
2694 * @detail: the detail.
2695 * @may_be_blocked: whether blocked handlers should count as match.
2697 * Returns whether there are any handlers connected to @instance for the
2698 * given signal id and detail.
2700 * One example of when you might use this is when the arguments to the
2701 * signal are difficult to compute. A class implementor may opt to not
2702 * emit the signal if no one is attached anyway, thus saving the cost
2703 * of building the arguments.
2705 * Returns: %TRUE if a handler is connected to the signal, %FALSE
2709 g_signal_has_handler_pending (gpointer instance,
2712 gboolean may_be_blocked)
2714 HandlerMatch *mlist;
2715 gboolean has_pending;
2717 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2718 g_return_val_if_fail (signal_id > 0, FALSE);
2723 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2725 if (!(node->flags & G_SIGNAL_DETAILED))
2727 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2732 mlist = handlers_find (instance,
2733 (G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | (may_be_blocked ? 0 : G_SIGNAL_MATCH_UNBLOCKED)),
2734 signal_id, detail, NULL, NULL, NULL, TRUE);
2738 handler_match_free1_R (mlist, instance);
2741 has_pending = FALSE;
2747 static inline gboolean
2748 signal_check_skip_emission (SignalNode *node,
2754 /* are we able to check for NULL class handlers? */
2755 if (!node->test_class_offset)
2758 /* are there emission hooks pending? */
2759 if (node->emission_hooks && node->emission_hooks->hooks)
2762 /* is there a non-NULL class handler? */
2763 if (node->test_class_offset != TEST_CLASS_MAGIC)
2765 GTypeClass *class = G_TYPE_INSTANCE_GET_CLASS (instance, G_TYPE_FROM_INSTANCE (instance), GTypeClass);
2767 if (G_STRUCT_MEMBER (gpointer, class, node->test_class_offset))
2771 /* are signals being debugged? */
2772 #ifdef G_ENABLE_DEBUG
2773 IF_DEBUG (SIGNALS, g_trace_instance_signals || g_trap_instance_signals)
2775 #endif /* G_ENABLE_DEBUG */
2777 /* is this a no-recurse signal already in emission? */
2778 if (node->flags & G_SIGNAL_NO_RECURSE &&
2779 emission_find (g_restart_emissions, node->signal_id, detail, instance))
2782 /* do we have pending handlers? */
2783 hlist = handler_list_lookup (node->signal_id, instance);
2784 if (hlist && hlist->handlers)
2787 /* none of the above, no emission required */
2793 * @instance_and_params: argument list for the signal emission. The first
2794 * element in the array is a #GValue for the instance the signal is
2795 * being emitted on. The rest are any arguments to be passed to the
2797 * @signal_id: the signal id
2798 * @detail: the detail
2799 * @return_value: Location to store the return value of the signal emission.
2803 * Note that g_signal_emitv() doesn't change @return_value if no handlers are
2804 * connected, in contrast to g_signal_emit() and g_signal_emit_valist().
2807 g_signal_emitv (const GValue *instance_and_params,
2810 GValue *return_value)
2814 #ifdef G_ENABLE_DEBUG
2815 const GValue *param_values;
2819 g_return_if_fail (instance_and_params != NULL);
2820 instance = g_value_peek_pointer (instance_and_params);
2821 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2822 g_return_if_fail (signal_id > 0);
2824 #ifdef G_ENABLE_DEBUG
2825 param_values = instance_and_params + 1;
2829 node = LOOKUP_SIGNAL_NODE (signal_id);
2830 if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2832 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2836 #ifdef G_ENABLE_DEBUG
2837 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2839 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2843 for (i = 0; i < node->n_params; i++)
2844 if (!G_TYPE_CHECK_VALUE_TYPE (param_values + i, node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
2846 g_critical ("%s: value for `%s' parameter %u for signal \"%s\" is of type `%s'",
2848 type_debug_name (node->param_types[i]),
2851 G_VALUE_TYPE_NAME (param_values + i));
2855 if (node->return_type != G_TYPE_NONE)
2859 g_critical ("%s: return value `%s' for signal \"%s\" is (NULL)",
2861 type_debug_name (node->return_type),
2866 else if (!node->accumulator && !G_TYPE_CHECK_VALUE_TYPE (return_value, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
2868 g_critical ("%s: return value `%s' for signal \"%s\" is of type `%s'",
2870 type_debug_name (node->return_type),
2872 G_VALUE_TYPE_NAME (return_value));
2878 return_value = NULL;
2879 #endif /* G_ENABLE_DEBUG */
2881 /* optimize NOP emissions */
2882 if (signal_check_skip_emission (node, instance, detail))
2884 /* nothing to do to emit this signal */
2886 /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
2891 signal_emit_unlocked_R (node, detail, instance, return_value, instance_and_params);
2895 * g_signal_emit_valist:
2896 * @instance: the instance the signal is being emitted on.
2897 * @signal_id: the signal id
2898 * @detail: the detail
2899 * @var_args: a list of parameters to be passed to the signal, followed by a
2900 * location for the return value. If the return type of the signal
2901 * is #G_TYPE_NONE, the return value location can be omitted.
2905 * Note that g_signal_emit_valist() resets the return value to the default
2906 * if no handlers are connected, in contrast to g_signal_emitv().
2909 g_signal_emit_valist (gpointer instance,
2914 GValue *instance_and_params;
2915 GType signal_return_type;
2916 GValue *param_values;
2920 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2921 g_return_if_fail (signal_id > 0);
2924 node = LOOKUP_SIGNAL_NODE (signal_id);
2925 if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2927 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2931 #ifndef G_DISABLE_CHECKS
2932 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2934 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2938 #endif /* !G_DISABLE_CHECKS */
2940 /* optimize NOP emissions */
2941 if (signal_check_skip_emission (node, instance, detail))
2943 /* nothing to do to emit this signal */
2945 /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
2949 n_params = node->n_params;
2950 signal_return_type = node->return_type;
2951 instance_and_params = g_slice_alloc0 (sizeof (GValue) * (n_params + 1));
2952 param_values = instance_and_params + 1;
2954 for (i = 0; i < node->n_params; i++)
2957 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2958 gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
2961 G_VALUE_COLLECT_INIT (param_values + i, ptype,
2963 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2967 g_warning ("%s: %s", G_STRLOC, error);
2970 /* we purposely leak the value here, it might not be
2971 * in a sane state if an error condition occoured
2974 g_value_unset (param_values + i);
2976 g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
2983 instance_and_params->g_type = 0;
2984 g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
2985 g_value_set_instance (instance_and_params, instance);
2986 if (signal_return_type == G_TYPE_NONE)
2987 signal_emit_unlocked_R (node, detail, instance, NULL, instance_and_params);
2990 GValue return_value = { 0, };
2991 gchar *error = NULL;
2992 GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2993 gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
2995 g_value_init (&return_value, rtype);
2997 signal_emit_unlocked_R (node, detail, instance, &return_value, instance_and_params);
2999 G_VALUE_LCOPY (&return_value,
3001 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3004 g_value_unset (&return_value);
3007 g_warning ("%s: %s", G_STRLOC, error);
3010 /* we purposely leak the value here, it might not be
3011 * in a sane state if an error condition occured
3015 for (i = 0; i < n_params; i++)
3016 g_value_unset (param_values + i);
3017 g_value_unset (instance_and_params);
3018 g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
3023 * @instance: the instance the signal is being emitted on.
3024 * @signal_id: the signal id
3025 * @detail: the detail
3026 * @...: parameters to be passed to the signal, followed by a
3027 * location for the return value. If the return type of the signal
3028 * is #G_TYPE_NONE, the return value location can be omitted.
3032 * Note that g_signal_emit() resets the return value to the default
3033 * if no handlers are connected, in contrast to g_signal_emitv().
3036 g_signal_emit (gpointer instance,
3043 va_start (var_args, detail);
3044 g_signal_emit_valist (instance, signal_id, detail, var_args);
3049 * g_signal_emit_by_name:
3050 * @instance: the instance the signal is being emitted on.
3051 * @detailed_signal: a string of the form "signal-name::detail".
3052 * @...: parameters to be passed to the signal, followed by a
3053 * location for the return value. If the return type of the signal
3054 * is #G_TYPE_NONE, the return value location can be omitted.
3058 * Note that g_signal_emit_by_name() resets the return value to the default
3059 * if no handlers are connected, in contrast to g_signal_emitv().
3062 g_signal_emit_by_name (gpointer instance,
3063 const gchar *detailed_signal,
3069 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
3070 g_return_if_fail (detailed_signal != NULL);
3073 signal_id = signal_parse_name (detailed_signal, G_TYPE_FROM_INSTANCE (instance), &detail, TRUE);
3080 va_start (var_args, detailed_signal);
3081 g_signal_emit_valist (instance, signal_id, detail, var_args);
3085 g_warning ("%s: signal name `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
3088 static inline gboolean
3089 accumulate (GSignalInvocationHint *ihint,
3090 GValue *return_accu,
3091 GValue *handler_return,
3092 SignalAccumulator *accumulator)
3094 gboolean continue_emission;
3099 continue_emission = accumulator->func (ihint, return_accu, handler_return, accumulator->data);
3100 g_value_reset (handler_return);
3102 return continue_emission;
3106 signal_emit_unlocked_R (SignalNode *node,
3109 GValue *emission_return,
3110 const GValue *instance_and_params)
3112 SignalAccumulator *accumulator;
3114 GClosure *class_closure;
3116 Handler *handler_list = NULL;
3117 GValue *return_accu, accu = { 0, };
3119 gulong max_sequential_handler_number;
3120 gboolean return_value_altered = FALSE;
3122 #ifdef G_ENABLE_DEBUG
3123 IF_DEBUG (SIGNALS, g_trace_instance_signals == instance || g_trap_instance_signals == instance)
3125 g_message ("%s::%s(%u) emitted (instance=%p, signal-node=%p)",
3126 g_type_name (G_TYPE_FROM_INSTANCE (instance)),
3129 if (g_trap_instance_signals == instance)
3132 #endif /* G_ENABLE_DEBUG */
3134 TRACE(GOBJECT_SIGNAL_EMIT(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3137 signal_id = node->signal_id;
3138 if (node->flags & G_SIGNAL_NO_RECURSE)
3140 Emission *node = emission_find (g_restart_emissions, signal_id, detail, instance);
3144 node->state = EMISSION_RESTART;
3146 return return_value_altered;
3149 accumulator = node->accumulator;
3153 g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3154 return_accu = &accu;
3158 return_accu = emission_return;
3159 emission.instance = instance;
3160 emission.ihint.signal_id = node->signal_id;
3161 emission.ihint.detail = detail;
3162 emission.ihint.run_type = 0;
3164 emission.chain_type = G_TYPE_NONE;
3165 emission_push ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3166 class_closure = signal_lookup_closure (node, instance);
3171 handler_unref_R (signal_id, instance, handler_list);
3172 max_sequential_handler_number = g_handler_sequential_number;
3173 hlist = handler_list_lookup (signal_id, instance);
3174 handler_list = hlist ? hlist->handlers : NULL;
3176 handler_ref (handler_list);
3178 emission.ihint.run_type = G_SIGNAL_RUN_FIRST;
3180 if ((node->flags & G_SIGNAL_RUN_FIRST) && class_closure)
3182 emission.state = EMISSION_RUN;
3184 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3186 g_closure_invoke (class_closure,
3189 instance_and_params,
3191 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3192 emission.state == EMISSION_RUN)
3193 emission.state = EMISSION_STOP;
3195 emission.chain_type = G_TYPE_NONE;
3196 return_value_altered = TRUE;
3198 if (emission.state == EMISSION_STOP)
3200 else if (emission.state == EMISSION_RESTART)
3204 if (node->emission_hooks)
3206 gboolean need_destroy, was_in_call, may_recurse = TRUE;
3209 emission.state = EMISSION_HOOK;
3210 hook = g_hook_first_valid (node->emission_hooks, may_recurse);
3213 SignalHook *signal_hook = SIGNAL_HOOK (hook);
3215 if (!signal_hook->detail || signal_hook->detail == detail)
3217 GSignalEmissionHook hook_func = (GSignalEmissionHook) hook->func;
3219 was_in_call = G_HOOK_IN_CALL (hook);
3220 hook->flags |= G_HOOK_FLAG_IN_CALL;
3222 need_destroy = !hook_func (&emission.ihint, node->n_params + 1, instance_and_params, hook->data);
3225 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
3227 g_hook_destroy_link (node->emission_hooks, hook);
3229 hook = g_hook_next_valid (node->emission_hooks, hook, may_recurse);
3232 if (emission.state == EMISSION_RESTART)
3238 Handler *handler = handler_list;
3240 emission.state = EMISSION_RUN;
3241 handler_ref (handler);
3248 handler_unref_R (signal_id, instance, handler_list);
3249 handler_list = handler;
3252 else if (!handler->block_count && (!handler->detail || handler->detail == detail) &&
3253 handler->sequential_number < max_sequential_handler_number)
3256 g_closure_invoke (handler->closure,
3259 instance_and_params,
3261 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3262 emission.state == EMISSION_RUN)
3263 emission.state = EMISSION_STOP;
3265 return_value_altered = TRUE;
3267 tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3270 tmp = handler->next;
3274 handler_unref_R (signal_id, instance, handler_list);
3275 handler_list = handler;
3280 if (emission.state == EMISSION_STOP)
3282 else if (emission.state == EMISSION_RESTART)
3286 emission.ihint.run_type = G_SIGNAL_RUN_LAST;
3288 if ((node->flags & G_SIGNAL_RUN_LAST) && class_closure)
3290 emission.state = EMISSION_RUN;
3292 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3294 g_closure_invoke (class_closure,
3297 instance_and_params,
3299 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3300 emission.state == EMISSION_RUN)
3301 emission.state = EMISSION_STOP;
3303 emission.chain_type = G_TYPE_NONE;
3304 return_value_altered = TRUE;
3306 if (emission.state == EMISSION_STOP)
3308 else if (emission.state == EMISSION_RESTART)
3314 Handler *handler = handler_list;
3316 emission.state = EMISSION_RUN;
3317 handler_ref (handler);
3322 if (handler->after && !handler->block_count && (!handler->detail || handler->detail == detail) &&
3323 handler->sequential_number < max_sequential_handler_number)
3326 g_closure_invoke (handler->closure,
3329 instance_and_params,
3331 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3332 emission.state == EMISSION_RUN)
3333 emission.state = EMISSION_STOP;
3335 return_value_altered = TRUE;
3337 tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3340 tmp = handler->next;
3344 handler_unref_R (signal_id, instance, handler);
3349 if (emission.state == EMISSION_STOP)
3351 else if (emission.state == EMISSION_RESTART)
3357 emission.ihint.run_type = G_SIGNAL_RUN_CLEANUP;
3359 if ((node->flags & G_SIGNAL_RUN_CLEANUP) && class_closure)
3361 gboolean need_unset = FALSE;
3363 emission.state = EMISSION_STOP;
3365 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3367 if (node->return_type != G_TYPE_NONE && !accumulator)
3369 g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3372 g_closure_invoke (class_closure,
3373 node->return_type != G_TYPE_NONE ? &accu : NULL,
3375 instance_and_params,
3378 g_value_unset (&accu);
3380 emission.chain_type = G_TYPE_NONE;
3382 if (emission.state == EMISSION_RESTART)
3387 handler_unref_R (signal_id, instance, handler_list);
3389 emission_pop ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3392 g_value_unset (&accu);
3394 TRACE(GOBJECT_SIGNAL_EMIT_END(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3396 return return_value_altered;
3400 type_debug_name (GType type)
3404 const char *name = g_type_name (type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3405 return name ? name : "<unknown>";
3412 * g_signal_accumulator_true_handled:
3413 * @ihint: standard #GSignalAccumulator parameter
3414 * @return_accu: standard #GSignalAccumulator parameter
3415 * @handler_return: standard #GSignalAccumulator parameter
3416 * @dummy: standard #GSignalAccumulator parameter
3418 * A predefined #GSignalAccumulator for signals that return a
3419 * boolean values. The behavior that this accumulator gives is
3420 * that a return of %TRUE stops the signal emission: no further
3421 * callbacks will be invoked, while a return of %FALSE allows
3422 * the emission to continue. The idea here is that a %TRUE return
3423 * indicates that the callback <emphasis>handled</emphasis> the signal,
3424 * and no further handling is needed.
3428 * Returns: standard #GSignalAccumulator result
3431 g_signal_accumulator_true_handled (GSignalInvocationHint *ihint,
3432 GValue *return_accu,
3433 const GValue *handler_return,
3436 gboolean continue_emission;
3437 gboolean signal_handled;
3439 signal_handled = g_value_get_boolean (handler_return);
3440 g_value_set_boolean (return_accu, signal_handled);
3441 continue_emission = !signal_handled;
3443 return continue_emission;
3447 * g_signal_accumulator_first_wins:
3448 * @ihint: standard #GSignalAccumulator parameter
3449 * @return_accu: standard #GSignalAccumulator parameter
3450 * @handler_return: standard #GSignalAccumulator parameter
3451 * @dummy: standard #GSignalAccumulator parameter
3453 * A predefined #GSignalAccumulator for signals intended to be used as a
3454 * hook for application code to provide a particular value. Usually
3455 * only one such value is desired and multiple handlers for the same
3456 * signal don't make much sense (except for the case of the default
3457 * handler defined in the class structure, in which case you will
3458 * usually want the signal connection to override the class handler).
3460 * This accumulator will use the return value from the first signal
3461 * handler that is run as the return value for the signal and not run
3462 * any further handlers (ie: the first handler "wins").
3464 * Returns: standard #GSignalAccumulator result
3469 g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
3470 GValue *return_accu,
3471 const GValue *handler_return,
3474 g_value_copy (handler_return, return_accu);
3479 /* --- compile standard marshallers --- */
3480 #include "gmarshal.c"