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 "gtype-private.h"
34 #include "gbsearcharray.h"
35 #include "gvaluecollector.h"
36 #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 COND_DEBUG(debug_type, cond) ((_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) || (cond))
110 #define IF_DEBUG(debug_type, cond) if (COND_DEBUG(debug_type, cond))
112 static volatile gpointer g_trace_instance_signals = NULL;
113 static volatile gpointer g_trap_instance_signals = NULL;
114 #endif /* G_ENABLE_DEBUG */
117 /* --- typedefs --- */
118 typedef struct _SignalNode SignalNode;
119 typedef struct _SignalKey SignalKey;
120 typedef struct _Emission Emission;
121 typedef struct _Handler Handler;
122 typedef struct _HandlerList HandlerList;
123 typedef struct _HandlerMatch HandlerMatch;
133 /* --- prototypes --- */
134 static inline guint signal_id_lookup (GQuark quark,
136 static void signal_destroy_R (SignalNode *signal_node);
137 static inline HandlerList* handler_list_ensure (guint signal_id,
139 static inline HandlerList* handler_list_lookup (guint signal_id,
141 static inline Handler* handler_new (gboolean after);
142 static void handler_insert (guint signal_id,
145 static Handler* handler_lookup (gpointer instance,
148 static inline HandlerMatch* handler_match_prepend (HandlerMatch *list,
151 static inline HandlerMatch* handler_match_free1_R (HandlerMatch *node,
153 static HandlerMatch* handlers_find (gpointer instance,
154 GSignalMatchType mask,
160 gboolean one_and_only);
161 static inline void handler_ref (Handler *handler);
162 static inline void handler_unref_R (guint signal_id,
165 static gint handler_lists_cmp (gconstpointer node1,
166 gconstpointer node2);
167 static inline void emission_push (Emission **emission_list_p,
169 static inline void emission_pop (Emission **emission_list_p,
171 static inline Emission* emission_find (Emission *emission_list,
175 static gint class_closures_cmp (gconstpointer node1,
176 gconstpointer node2);
177 static gint signal_key_cmp (gconstpointer node1,
178 gconstpointer node2);
179 static gboolean signal_emit_unlocked_R (SignalNode *node,
182 GValue *return_value,
183 const GValue *instance_and_params);
184 static const gchar * type_debug_name (GType type);
185 static void node_check_deprecated (const SignalNode *node);
186 static void node_update_single_va_closure (SignalNode *node);
189 /* --- structures --- */
192 GSignalAccumulator func;
200 #define SIGNAL_HOOK(hook) ((SignalHook*) (hook))
204 /* permanent portion */
210 /* reinitializable portion */
213 guint single_va_closure_is_valid : 1;
214 guint single_va_closure_is_after : 1;
215 GType *param_types; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
216 GType return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
217 GBSearchArray *class_closure_bsa;
218 SignalAccumulator *accumulator;
219 GSignalCMarshaller c_marshaller;
220 GSignalCVaMarshaller va_marshaller;
221 GHookList *emission_hooks;
223 GClosure *single_va_closure;
226 #define SINGLE_VA_CLOSURE_EMPTY_MAGIC GINT_TO_POINTER(1) /* indicates single_va_closure is valid but empty */
239 GSignalInvocationHint ihint;
248 Handler *tail_before; /* normal signal handlers are appended here */
249 Handler *tail_after; /* CONNECT_AFTER handlers are appended here */
254 gulong sequential_number;
259 guint block_count : 16;
260 #define HANDLER_MAX_BLOCK_COUNT (1 << 16)
273 GType instance_type; /* 0 for default closure */
278 /* --- variables --- */
279 static GBSearchArray *g_signal_key_bsa = NULL;
280 static const GBSearchConfig g_signal_key_bconfig = {
283 G_BSEARCH_ARRAY_ALIGN_POWER2,
285 static GBSearchConfig g_signal_hlbsa_bconfig = {
286 sizeof (HandlerList),
290 static GBSearchConfig g_class_closure_bconfig = {
291 sizeof (ClassClosure),
295 static GHashTable *g_handler_list_bsa_ht = NULL;
296 static Emission *g_recursive_emissions = NULL;
297 static Emission *g_restart_emissions = NULL;
298 static gulong g_handler_sequential_number = 1;
299 G_LOCK_DEFINE_STATIC (g_signal_mutex);
300 #define SIGNAL_LOCK() G_LOCK (g_signal_mutex)
301 #define SIGNAL_UNLOCK() G_UNLOCK (g_signal_mutex)
304 /* --- signal nodes --- */
305 static guint g_n_signal_nodes = 0;
306 static SignalNode **g_signal_nodes = NULL;
308 static inline SignalNode*
309 LOOKUP_SIGNAL_NODE (register guint signal_id)
311 if (signal_id < g_n_signal_nodes)
312 return g_signal_nodes[signal_id];
318 /* --- functions --- */
320 signal_id_lookup (GQuark quark,
323 GType *ifaces, type = itype;
329 /* try looking up signals for this type and its ancestors */
332 SignalKey *signal_key;
335 signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
338 return signal_key->signal_id;
340 type = g_type_parent (type);
344 /* no luck, try interfaces it exports */
345 ifaces = g_type_interfaces (itype, &n_ifaces);
348 SignalKey *signal_key;
350 key.itype = ifaces[n_ifaces];
351 signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
356 return signal_key->signal_id;
365 class_closures_cmp (gconstpointer node1,
368 const ClassClosure *c1 = node1, *c2 = node2;
370 return G_BSEARCH_ARRAY_CMP (c1->instance_type, c2->instance_type);
374 handler_lists_cmp (gconstpointer node1,
377 const HandlerList *hlist1 = node1, *hlist2 = node2;
379 return G_BSEARCH_ARRAY_CMP (hlist1->signal_id, hlist2->signal_id);
382 static inline HandlerList*
383 handler_list_ensure (guint signal_id,
386 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
389 key.signal_id = signal_id;
391 key.tail_before = NULL;
392 key.tail_after = NULL;
395 hlbsa = g_bsearch_array_create (&g_signal_hlbsa_bconfig);
396 hlbsa = g_bsearch_array_insert (hlbsa, &g_signal_hlbsa_bconfig, &key);
397 g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
401 GBSearchArray *o = hlbsa;
403 hlbsa = g_bsearch_array_insert (o, &g_signal_hlbsa_bconfig, &key);
405 g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
407 return g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key);
410 static inline HandlerList*
411 handler_list_lookup (guint signal_id,
414 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
417 key.signal_id = signal_id;
419 return hlbsa ? g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key) : NULL;
423 handler_lookup (gpointer instance,
427 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
433 for (i = 0; i < hlbsa->n_nodes; i++)
435 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
438 for (handler = hlist->handlers; handler; handler = handler->next)
439 if (handler->sequential_number == handler_id)
442 *signal_id_p = hlist->signal_id;
452 static inline HandlerMatch*
453 handler_match_prepend (HandlerMatch *list,
459 node = g_slice_new (HandlerMatch);
460 node->handler = handler;
462 node->signal_id = signal_id;
463 handler_ref (handler);
467 static inline HandlerMatch*
468 handler_match_free1_R (HandlerMatch *node,
471 HandlerMatch *next = node->next;
473 handler_unref_R (node->signal_id, instance, node->handler);
474 g_slice_free (HandlerMatch, node);
480 handlers_find (gpointer instance,
481 GSignalMatchType mask,
487 gboolean one_and_only)
489 HandlerMatch *mlist = NULL;
491 if (mask & G_SIGNAL_MATCH_ID)
493 HandlerList *hlist = handler_list_lookup (signal_id, instance);
495 SignalNode *node = NULL;
497 if (mask & G_SIGNAL_MATCH_FUNC)
499 node = LOOKUP_SIGNAL_NODE (signal_id);
500 if (!node || !node->c_marshaller)
505 for (handler = hlist ? hlist->handlers : NULL; handler; handler = handler->next)
506 if (handler->sequential_number &&
507 ((mask & G_SIGNAL_MATCH_DETAIL) || handler->detail == detail) &&
508 ((mask & G_SIGNAL_MATCH_CLOSURE) || handler->closure == closure) &&
509 ((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
510 ((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
511 ((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
512 G_REAL_CLOSURE (handler->closure)->meta_marshal == NULL &&
513 ((GCClosure*) handler->closure)->callback == func)))
515 mlist = handler_match_prepend (mlist, handler, signal_id);
522 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
529 for (i = 0; i < hlbsa->n_nodes; i++)
531 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
532 SignalNode *node = NULL;
535 if (!(mask & G_SIGNAL_MATCH_FUNC))
537 node = LOOKUP_SIGNAL_NODE (hlist->signal_id);
538 if (!node->c_marshaller)
542 for (handler = hlist->handlers; handler; handler = handler->next)
543 if (handler->sequential_number &&
544 ((mask & G_SIGNAL_MATCH_DETAIL) || handler->detail == detail) &&
545 ((mask & G_SIGNAL_MATCH_CLOSURE) || handler->closure == closure) &&
546 ((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
547 ((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
548 ((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
549 G_REAL_CLOSURE (handler->closure)->meta_marshal == NULL &&
550 ((GCClosure*) handler->closure)->callback == func)))
552 mlist = handler_match_prepend (mlist, handler, hlist->signal_id);
563 static inline Handler*
564 handler_new (gboolean after)
566 Handler *handler = g_slice_new (Handler);
567 #ifndef G_DISABLE_CHECKS
568 if (g_handler_sequential_number < 1)
569 g_error (G_STRLOC ": handler id overflow, %s", REPORT_BUG);
572 handler->sequential_number = g_handler_sequential_number++;
573 handler->prev = NULL;
574 handler->next = NULL;
576 handler->ref_count = 1;
577 handler->block_count = 0;
578 handler->after = after != FALSE;
579 handler->closure = NULL;
585 handler_ref (Handler *handler)
587 g_return_if_fail (handler->ref_count > 0);
589 g_atomic_int_inc ((int *)&handler->ref_count);
593 handler_unref_R (guint signal_id,
599 g_return_if_fail (handler->ref_count > 0);
601 is_zero = g_atomic_int_dec_and_test ((int *)&handler->ref_count);
603 if (G_UNLIKELY (is_zero))
605 HandlerList *hlist = NULL;
608 handler->next->prev = handler->prev;
609 if (handler->prev) /* watch out for g_signal_handlers_destroy()! */
610 handler->prev->next = handler->next;
613 hlist = handler_list_lookup (signal_id, instance);
614 hlist->handlers = handler->next;
619 /* check if we are removing the handler pointed to by tail_before */
620 if (!handler->after && (!handler->next || handler->next->after))
623 hlist = handler_list_lookup (signal_id, instance);
626 g_assert (hlist->tail_before == handler); /* paranoid */
627 hlist->tail_before = handler->prev;
631 /* check if we are removing the handler pointed to by tail_after */
635 hlist = handler_list_lookup (signal_id, instance);
638 g_assert (hlist->tail_after == handler); /* paranoid */
639 hlist->tail_after = handler->prev;
645 g_closure_unref (handler->closure);
647 g_slice_free (Handler, handler);
652 handler_insert (guint signal_id,
658 g_assert (handler->prev == NULL && handler->next == NULL); /* paranoid */
660 hlist = handler_list_ensure (signal_id, instance);
661 if (!hlist->handlers)
663 hlist->handlers = handler;
665 hlist->tail_before = handler;
667 else if (handler->after)
669 handler->prev = hlist->tail_after;
670 hlist->tail_after->next = handler;
674 if (hlist->tail_before)
676 handler->next = hlist->tail_before->next;
678 handler->next->prev = handler;
679 handler->prev = hlist->tail_before;
680 hlist->tail_before->next = handler;
682 else /* insert !after handler into a list of only after handlers */
684 handler->next = hlist->handlers;
686 handler->next->prev = handler;
687 hlist->handlers = handler;
689 hlist->tail_before = handler;
693 hlist->tail_after = handler;
697 node_update_single_va_closure (SignalNode *node)
699 GClosure *closure = NULL;
700 gboolean is_after = FALSE;
702 /* Fast path single-handler without boxing the arguments in GValues */
703 if (G_TYPE_IS_OBJECT (node->itype) &&
704 (node->flags & (G_SIGNAL_MUST_COLLECT)) == 0 &&
705 (node->emission_hooks == NULL || node->emission_hooks->hooks == NULL))
707 GSignalFlags run_type;
709 GBSearchArray *bsa = node->class_closure_bsa;
711 if (bsa == NULL || bsa->n_nodes == 0)
712 closure = SINGLE_VA_CLOSURE_EMPTY_MAGIC;
713 else if (bsa->n_nodes == 1)
715 /* Look for default class closure (can't support non-default as it
716 chains up using GValues */
717 cc = g_bsearch_array_get_nth (bsa, &g_class_closure_bconfig, 0);
718 if (cc->instance_type == 0)
720 run_type = node->flags & (G_SIGNAL_RUN_FIRST|G_SIGNAL_RUN_LAST|G_SIGNAL_RUN_CLEANUP);
721 /* Only support *one* of run-first or run-last, not multiple or cleanup */
722 if (run_type == G_SIGNAL_RUN_FIRST ||
723 run_type == G_SIGNAL_RUN_LAST)
725 closure = cc->closure;
726 is_after = (run_type == G_SIGNAL_RUN_LAST);
732 node->single_va_closure_is_valid = TRUE;
733 node->single_va_closure = closure;
734 node->single_va_closure_is_after = is_after;
738 emission_push (Emission **emission_list_p,
741 emission->next = *emission_list_p;
742 *emission_list_p = emission;
746 emission_pop (Emission **emission_list_p,
749 Emission *node, *last = NULL;
751 for (node = *emission_list_p; node; last = node, node = last->next)
752 if (node == emission)
755 last->next = node->next;
757 *emission_list_p = node->next;
760 g_assert_not_reached ();
763 static inline Emission*
764 emission_find (Emission *emission_list,
771 for (emission = emission_list; emission; emission = emission->next)
772 if (emission->instance == instance &&
773 emission->ihint.signal_id == signal_id &&
774 emission->ihint.detail == detail)
779 static inline Emission*
780 emission_find_innermost (gpointer instance)
782 Emission *emission, *s = NULL, *c = NULL;
784 for (emission = g_restart_emissions; emission; emission = emission->next)
785 if (emission->instance == instance)
790 for (emission = g_recursive_emissions; emission; emission = emission->next)
791 if (emission->instance == instance)
801 return G_HAVE_GROWING_STACK ? MAX (c, s) : MIN (c, s);
805 signal_key_cmp (gconstpointer node1,
808 const SignalKey *key1 = node1, *key2 = node2;
810 if (key1->itype == key2->itype)
811 return G_BSEARCH_ARRAY_CMP (key1->quark, key2->quark);
813 return G_BSEARCH_ARRAY_CMP (key1->itype, key2->itype);
817 _g_signal_init (void)
820 if (!g_n_signal_nodes)
822 /* setup handler list binary searchable array hash table (in german, that'd be one word ;) */
823 g_handler_list_bsa_ht = g_hash_table_new (g_direct_hash, NULL);
824 g_signal_key_bsa = g_bsearch_array_create (&g_signal_key_bconfig);
826 /* invalid (0) signal_id */
827 g_n_signal_nodes = 1;
828 g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
829 g_signal_nodes[0] = NULL;
835 _g_signals_destroy (GType itype)
840 for (i = 1; i < g_n_signal_nodes; i++)
842 SignalNode *node = g_signal_nodes[i];
844 if (node->itype == itype)
847 g_warning (G_STRLOC ": signal \"%s\" of type `%s' already destroyed",
849 type_debug_name (node->itype));
851 signal_destroy_R (node);
858 * g_signal_stop_emission:
859 * @instance: the object whose signal handlers you wish to stop.
860 * @signal_id: the signal identifier, as returned by g_signal_lookup().
861 * @detail: the detail which the signal was emitted with.
863 * Stops a signal's current emission.
865 * This will prevent the default method from running, if the signal was
866 * %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
869 * Prints a warning if used on a signal which isn't being emitted.
872 g_signal_stop_emission (gpointer instance,
878 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
879 g_return_if_fail (signal_id > 0);
882 node = LOOKUP_SIGNAL_NODE (signal_id);
883 if (node && detail && !(node->flags & G_SIGNAL_DETAILED))
885 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
889 if (node && g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
891 Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
892 Emission *emission = emission_find (emission_list, signal_id, detail, instance);
896 if (emission->state == EMISSION_HOOK)
897 g_warning (G_STRLOC ": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
898 node->name, instance);
899 else if (emission->state == EMISSION_RUN)
900 emission->state = EMISSION_STOP;
903 g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
904 node->name, instance);
907 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
912 signal_finalize_hook (GHookList *hook_list,
915 GDestroyNotify destroy = hook->destroy;
919 hook->destroy = NULL;
921 destroy (hook->data);
927 * g_signal_add_emission_hook:
928 * @signal_id: the signal identifier, as returned by g_signal_lookup().
929 * @detail: the detail on which to call the hook.
930 * @hook_func: a #GSignalEmissionHook function.
931 * @hook_data: user data for @hook_func.
932 * @data_destroy: a #GDestroyNotify for @hook_data.
934 * Adds an emission hook for a signal, which will get called for any emission
935 * of that signal, independent of the instance. This is possible only
936 * for signals which don't have #G_SIGNAL_NO_HOOKS flag set.
938 * Returns: the hook id, for later use with g_signal_remove_emission_hook().
941 g_signal_add_emission_hook (guint signal_id,
943 GSignalEmissionHook hook_func,
945 GDestroyNotify data_destroy)
947 static gulong seq_hook_id = 1;
950 SignalHook *signal_hook;
952 g_return_val_if_fail (signal_id > 0, 0);
953 g_return_val_if_fail (hook_func != NULL, 0);
956 node = LOOKUP_SIGNAL_NODE (signal_id);
957 if (!node || node->destroyed)
959 g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
963 if (node->flags & G_SIGNAL_NO_HOOKS)
965 g_warning ("%s: signal id `%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC, signal_id);
969 if (detail && !(node->flags & G_SIGNAL_DETAILED))
971 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
975 node->single_va_closure_is_valid = FALSE;
976 if (!node->emission_hooks)
978 node->emission_hooks = g_new (GHookList, 1);
979 g_hook_list_init (node->emission_hooks, sizeof (SignalHook));
980 node->emission_hooks->finalize_hook = signal_finalize_hook;
983 node_check_deprecated (node);
985 hook = g_hook_alloc (node->emission_hooks);
986 hook->data = hook_data;
987 hook->func = (gpointer) hook_func;
988 hook->destroy = data_destroy;
989 signal_hook = SIGNAL_HOOK (hook);
990 signal_hook->detail = detail;
991 node->emission_hooks->seq_id = seq_hook_id;
992 g_hook_append (node->emission_hooks, hook);
993 seq_hook_id = node->emission_hooks->seq_id;
997 return hook->hook_id;
1001 * g_signal_remove_emission_hook:
1002 * @signal_id: the id of the signal
1003 * @hook_id: the id of the emission hook, as returned by
1004 * g_signal_add_emission_hook()
1006 * Deletes an emission hook.
1009 g_signal_remove_emission_hook (guint signal_id,
1014 g_return_if_fail (signal_id > 0);
1015 g_return_if_fail (hook_id > 0);
1018 node = LOOKUP_SIGNAL_NODE (signal_id);
1019 if (!node || node->destroyed)
1021 g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
1024 else if (!node->emission_hooks || !g_hook_destroy (node->emission_hooks, hook_id))
1025 g_warning ("%s: signal \"%s\" had no hook (%lu) to remove", G_STRLOC, node->name, hook_id);
1027 node->single_va_closure_is_valid = FALSE;
1034 signal_parse_name (const gchar *name,
1037 gboolean force_quark)
1039 const gchar *colon = strchr (name, ':');
1044 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1045 if (signal_id && detail_p)
1048 else if (colon[1] == ':')
1051 guint l = colon - name;
1055 memcpy (buffer, name, l);
1057 signal_id = signal_id_lookup (g_quark_try_string (buffer), itype);
1061 gchar *signal = g_new (gchar, l + 1);
1063 memcpy (signal, name, l);
1065 signal_id = signal_id_lookup (g_quark_try_string (signal), itype);
1069 if (signal_id && detail_p)
1070 *detail_p = colon[2] ? (force_quark ? g_quark_from_string : g_quark_try_string) (colon + 2) : 0;
1078 * g_signal_parse_name:
1079 * @detailed_signal: a string of the form "signal-name::detail".
1080 * @itype: The interface/instance type that introduced "signal-name".
1081 * @signal_id_p: (out): Location to store the signal id.
1082 * @detail_p: (out): Location to store the detail quark.
1083 * @force_detail_quark: %TRUE forces creation of a #GQuark for the detail.
1085 * Internal function to parse a signal name into its @signal_id
1086 * and @detail quark.
1088 * Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
1091 g_signal_parse_name (const gchar *detailed_signal,
1095 gboolean force_detail_quark)
1101 g_return_val_if_fail (detailed_signal != NULL, FALSE);
1102 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), FALSE);
1105 signal_id = signal_parse_name (detailed_signal, itype, &detail, force_detail_quark);
1108 node = signal_id ? LOOKUP_SIGNAL_NODE (signal_id) : NULL;
1109 if (!node || node->destroyed ||
1110 (detail && !(node->flags & G_SIGNAL_DETAILED)))
1114 *signal_id_p = signal_id;
1122 * g_signal_stop_emission_by_name:
1123 * @instance: the object whose signal handlers you wish to stop.
1124 * @detailed_signal: a string of the form "signal-name::detail".
1126 * Stops a signal's current emission.
1128 * This is just like g_signal_stop_emission() except it will look up the
1129 * signal id for you.
1132 g_signal_stop_emission_by_name (gpointer instance,
1133 const gchar *detailed_signal)
1139 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1140 g_return_if_fail (detailed_signal != NULL);
1143 itype = G_TYPE_FROM_INSTANCE (instance);
1144 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
1147 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
1149 if (detail && !(node->flags & G_SIGNAL_DETAILED))
1150 g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
1151 else if (!g_type_is_a (itype, node->itype))
1152 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
1155 Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
1156 Emission *emission = emission_find (emission_list, signal_id, detail, instance);
1160 if (emission->state == EMISSION_HOOK)
1161 g_warning (G_STRLOC ": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
1162 node->name, instance);
1163 else if (emission->state == EMISSION_RUN)
1164 emission->state = EMISSION_STOP;
1167 g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
1168 node->name, instance);
1172 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
1178 * @name: the signal's name.
1179 * @itype: the type that the signal operates on.
1181 * Given the name of the signal and the type of object it connects to, gets
1182 * the signal's identifying integer. Emitting the signal by number is
1183 * somewhat faster than using the name each time.
1185 * Also tries the ancestors of the given type.
1187 * See g_signal_new() for details on allowed signal names.
1189 * Returns: the signal's identifying number, or 0 if no signal was found.
1192 g_signal_lookup (const gchar *name,
1196 g_return_val_if_fail (name != NULL, 0);
1197 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1200 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1204 /* give elaborate warnings */
1205 if (!g_type_name (itype))
1206 g_warning (G_STRLOC ": unable to lookup signal \"%s\" for invalid type id `%"G_GSIZE_FORMAT"'",
1208 else if (!G_TYPE_IS_INSTANTIATABLE (itype))
1209 g_warning (G_STRLOC ": unable to lookup signal \"%s\" for non instantiatable type `%s'",
1210 name, g_type_name (itype));
1211 else if (!g_type_class_peek (itype))
1212 g_warning (G_STRLOC ": unable to lookup signal \"%s\" of unloaded type `%s'",
1213 name, g_type_name (itype));
1220 * g_signal_list_ids:
1221 * @itype: Instance or interface type.
1222 * @n_ids: Location to store the number of signal ids for @itype.
1224 * Lists the signals by id that a certain instance or interface type
1225 * created. Further information about the signals can be acquired through
1228 * Returns: (array length=n_ids): Newly allocated array of signal IDs.
1231 g_signal_list_ids (GType itype,
1239 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), NULL);
1240 g_return_val_if_fail (n_ids != NULL, NULL);
1243 keys = g_bsearch_array_get_nth (g_signal_key_bsa, &g_signal_key_bconfig, 0);
1244 n_nodes = g_bsearch_array_get_n_nodes (g_signal_key_bsa);
1245 result = g_array_new (FALSE, FALSE, sizeof (guint));
1247 for (i = 0; i < n_nodes; i++)
1248 if (keys[i].itype == itype)
1250 const gchar *name = g_quark_to_string (keys[i].quark);
1252 /* Signal names with "_" in them are aliases to the same
1253 * name with "-" instead of "_".
1255 if (!strchr (name, '_'))
1256 g_array_append_val (result, keys[i].signal_id);
1258 *n_ids = result->len;
1262 /* give elaborate warnings */
1263 if (!g_type_name (itype))
1264 g_warning (G_STRLOC ": unable to list signals for invalid type id `%"G_GSIZE_FORMAT"'",
1266 else if (!G_TYPE_IS_INSTANTIATABLE (itype) && !G_TYPE_IS_INTERFACE (itype))
1267 g_warning (G_STRLOC ": unable to list signals of non instantiatable type `%s'",
1268 g_type_name (itype));
1269 else if (!g_type_class_peek (itype) && !G_TYPE_IS_INTERFACE (itype))
1270 g_warning (G_STRLOC ": unable to list signals of unloaded type `%s'",
1271 g_type_name (itype));
1274 return (guint*) g_array_free (result, FALSE);
1279 * @signal_id: the signal's identifying number.
1281 * Given the signal's identifier, finds its name.
1283 * Two different signals may have the same name, if they have differing types.
1285 * Returns: the signal name, or %NULL if the signal number was invalid.
1288 g_signal_name (guint signal_id)
1294 node = LOOKUP_SIGNAL_NODE (signal_id);
1295 name = node ? node->name : NULL;
1298 return (char*) name;
1303 * @signal_id: The signal id of the signal to query information for.
1304 * @query: (out caller-allocates): A user provided structure that is
1305 * filled in with constant values upon success.
1307 * Queries the signal system for in-depth information about a
1308 * specific signal. This function will fill in a user-provided
1309 * structure to hold signal-specific information. If an invalid
1310 * signal id is passed in, the @signal_id member of the #GSignalQuery
1311 * is 0. All members filled into the #GSignalQuery structure should
1312 * be considered constant and have to be left untouched.
1315 g_signal_query (guint signal_id,
1316 GSignalQuery *query)
1320 g_return_if_fail (query != NULL);
1323 node = LOOKUP_SIGNAL_NODE (signal_id);
1324 if (!node || node->destroyed)
1325 query->signal_id = 0;
1328 query->signal_id = node->signal_id;
1329 query->signal_name = node->name;
1330 query->itype = node->itype;
1331 query->signal_flags = node->flags;
1332 query->return_type = node->return_type;
1333 query->n_params = node->n_params;
1334 query->param_types = node->param_types;
1341 * @signal_name: the name for the signal
1342 * @itype: the type this signal pertains to. It will also pertain to
1343 * types which are derived from this type.
1344 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1345 * the default handler is to be invoked. You should at least specify
1346 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1347 * @class_offset: The offset of the function pointer in the class structure
1348 * for this type. Used to invoke a class method generically. Pass 0 to
1349 * not associate a class method slot with this signal.
1350 * @accumulator: the accumulator for this signal; may be %NULL.
1351 * @accu_data: user data for the @accumulator.
1352 * @c_marshaller: (allow-none): the function to translate arrays of parameter
1353 * values to signal emissions into C language callback invocations or %NULL.
1354 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1355 * without a return value.
1356 * @n_params: the number of parameter types to follow.
1357 * @...: a list of types, one for each parameter.
1359 * Creates a new signal. (This is usually done in the class initializer.)
1361 * A signal name consists of segments consisting of ASCII letters and
1362 * digits, separated by either the '-' or '_' character. The first
1363 * character of a signal name must be a letter. Names which violate these
1364 * rules lead to undefined behaviour of the GSignal system.
1366 * When registering a signal and looking up a signal, either separator can
1367 * be used, but they cannot be mixed.
1369 * If 0 is used for @class_offset subclasses cannot override the class handler
1370 * in their <code>class_init</code> method by doing
1371 * <code>super_class->signal_handler = my_signal_handler</code>. Instead they
1372 * will have to use g_signal_override_class_handler().
1374 * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
1375 * the marshaller for this signal.
1377 * Returns: the signal id
1380 g_signal_new (const gchar *signal_name,
1382 GSignalFlags signal_flags,
1384 GSignalAccumulator accumulator,
1386 GSignalCMarshaller c_marshaller,
1394 g_return_val_if_fail (signal_name != NULL, 0);
1396 va_start (args, n_params);
1398 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1399 class_offset ? g_signal_type_cclosure_new (itype, class_offset) : NULL,
1400 accumulator, accu_data, c_marshaller,
1401 return_type, n_params, args);
1409 * g_signal_new_class_handler:
1410 * @signal_name: the name for the signal
1411 * @itype: the type this signal pertains to. It will also pertain to
1412 * types which are derived from this type.
1413 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1414 * the default handler is to be invoked. You should at least specify
1415 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1416 * @class_handler: a #GCallback which acts as class implementation of
1417 * this signal. Used to invoke a class method generically. Pass %NULL to
1418 * not associate a class method with this signal.
1419 * @accumulator: the accumulator for this signal; may be %NULL.
1420 * @accu_data: user data for the @accumulator.
1421 * @c_marshaller: (allow-none): the function to translate arrays of parameter
1422 * values to signal emissions into C language callback invocations or %NULL.
1423 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1424 * without a return value.
1425 * @n_params: the number of parameter types to follow.
1426 * @...: a list of types, one for each parameter.
1428 * Creates a new signal. (This is usually done in the class initializer.)
1430 * This is a variant of g_signal_new() that takes a C callback instead
1431 * off a class offset for the signal's class handler. This function
1432 * doesn't need a function pointer exposed in the class structure of
1433 * an object definition, instead the function pointer is passed
1434 * directly and can be overriden by derived classes with
1435 * g_signal_override_class_closure() or
1436 * g_signal_override_class_handler()and chained to with
1437 * g_signal_chain_from_overridden() or
1438 * g_signal_chain_from_overridden_handler().
1440 * See g_signal_new() for information about signal names.
1442 * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
1443 * the marshaller for this signal.
1445 * Returns: the signal id
1450 g_signal_new_class_handler (const gchar *signal_name,
1452 GSignalFlags signal_flags,
1453 GCallback class_handler,
1454 GSignalAccumulator accumulator,
1456 GSignalCMarshaller c_marshaller,
1464 g_return_val_if_fail (signal_name != NULL, 0);
1466 va_start (args, n_params);
1468 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1469 class_handler ? g_cclosure_new (class_handler, NULL, NULL) : NULL,
1470 accumulator, accu_data, c_marshaller,
1471 return_type, n_params, args);
1478 static inline ClassClosure*
1479 signal_find_class_closure (SignalNode *node,
1482 GBSearchArray *bsa = node->class_closure_bsa;
1489 /* cc->instance_type is 0 for default closure */
1491 key.instance_type = itype;
1492 cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1493 while (!cc && key.instance_type)
1495 key.instance_type = g_type_parent (key.instance_type);
1496 cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1504 static inline GClosure*
1505 signal_lookup_closure (SignalNode *node,
1506 GTypeInstance *instance)
1510 if (node->class_closure_bsa && g_bsearch_array_get_n_nodes (node->class_closure_bsa) == 1)
1512 cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
1513 if (cc && cc->instance_type == 0) /* check for default closure */
1516 cc = signal_find_class_closure (node, G_TYPE_FROM_INSTANCE (instance));
1517 return cc ? cc->closure : NULL;
1521 signal_add_class_closure (SignalNode *node,
1527 node->single_va_closure_is_valid = FALSE;
1529 if (!node->class_closure_bsa)
1530 node->class_closure_bsa = g_bsearch_array_create (&g_class_closure_bconfig);
1531 key.instance_type = itype;
1532 key.closure = g_closure_ref (closure);
1533 node->class_closure_bsa = g_bsearch_array_insert (node->class_closure_bsa,
1534 &g_class_closure_bconfig,
1536 g_closure_sink (closure);
1537 if (node->c_marshaller && closure && G_CLOSURE_NEEDS_MARSHAL (closure))
1539 g_closure_set_marshal (closure, node->c_marshaller);
1540 if (node->va_marshaller)
1541 _g_closure_set_va_marshal (closure, node->va_marshaller);
1547 * @signal_name: the name for the signal
1548 * @itype: the type this signal pertains to. It will also pertain to
1549 * types which are derived from this type
1550 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1551 * the default handler is to be invoked. You should at least specify
1552 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
1553 * @class_closure: (allow-none): The closure to invoke on signal emission;
1555 * @accumulator: (allow-none): the accumulator for this signal; may be %NULL
1556 * @accu_data: user data for the @accumulator
1557 * @c_marshaller: (allow-none): the function to translate arrays of
1558 * parameter values to signal emissions into C language callback
1559 * invocations or %NULL
1560 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1561 * without a return value
1562 * @n_params: the length of @param_types
1563 * @param_types: (array length=n_params): an array of types, one for
1566 * Creates a new signal. (This is usually done in the class initializer.)
1568 * See g_signal_new() for details on allowed signal names.
1570 * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
1571 * the marshaller for this signal.
1573 * Returns: the signal id
1576 g_signal_newv (const gchar *signal_name,
1578 GSignalFlags signal_flags,
1579 GClosure *class_closure,
1580 GSignalAccumulator accumulator,
1582 GSignalCMarshaller c_marshaller,
1590 GSignalCMarshaller builtin_c_marshaller;
1591 GSignalCVaMarshaller va_marshaller;
1593 g_return_val_if_fail (signal_name != NULL, 0);
1594 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1596 g_return_val_if_fail (param_types != NULL, 0);
1597 g_return_val_if_fail ((return_type & G_SIGNAL_TYPE_STATIC_SCOPE) == 0, 0);
1598 if (return_type == (G_TYPE_NONE & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1599 g_return_val_if_fail (accumulator == NULL, 0);
1601 g_return_val_if_fail (accu_data == NULL, 0);
1603 name = g_strdup (signal_name);
1604 g_strdelimit (name, G_STR_DELIMITERS ":^", '_'); /* FIXME do character checks like for types */
1608 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1609 node = LOOKUP_SIGNAL_NODE (signal_id);
1610 if (node && !node->destroyed)
1612 g_warning (G_STRLOC ": signal \"%s\" already exists in the `%s' %s",
1614 type_debug_name (node->itype),
1615 G_TYPE_IS_INTERFACE (node->itype) ? "interface" : "class ancestry");
1620 if (node && node->itype != itype)
1622 g_warning (G_STRLOC ": signal \"%s\" for type `%s' was previously created for type `%s'",
1624 type_debug_name (itype),
1625 type_debug_name (node->itype));
1630 for (i = 0; i < n_params; i++)
1631 if (!G_TYPE_IS_VALUE (param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1633 g_warning (G_STRLOC ": parameter %d of type `%s' for signal \"%s::%s\" is not a value type",
1634 i + 1, type_debug_name (param_types[i]), type_debug_name (itype), name);
1639 if (return_type != G_TYPE_NONE && !G_TYPE_IS_VALUE (return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1641 g_warning (G_STRLOC ": return value of type `%s' for signal \"%s::%s\" is not a value type",
1642 type_debug_name (return_type), type_debug_name (itype), name);
1647 if (return_type != G_TYPE_NONE &&
1648 (signal_flags & (G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST | G_SIGNAL_RUN_CLEANUP)) == G_SIGNAL_RUN_FIRST)
1650 g_warning (G_STRLOC ": signal \"%s::%s\" has return type `%s' and is only G_SIGNAL_RUN_FIRST",
1651 type_debug_name (itype), name, type_debug_name (return_type));
1657 /* setup permanent portion of signal node */
1662 signal_id = g_n_signal_nodes++;
1663 node = g_new (SignalNode, 1);
1664 node->signal_id = signal_id;
1665 g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
1666 g_signal_nodes[signal_id] = node;
1667 node->itype = itype;
1670 key.quark = g_quark_from_string (node->name);
1671 key.signal_id = signal_id;
1672 g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1673 g_strdelimit (name, "_", '-');
1674 node->name = g_intern_string (name);
1675 key.quark = g_quark_from_string (name);
1676 g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1678 TRACE(GOBJECT_SIGNAL_NEW(signal_id, name, itype));
1680 node->destroyed = FALSE;
1682 /* setup reinitializable portion */
1683 node->single_va_closure_is_valid = FALSE;
1684 node->flags = signal_flags & G_SIGNAL_FLAGS_MASK;
1685 node->n_params = n_params;
1686 node->param_types = g_memdup (param_types, sizeof (GType) * n_params);
1687 node->return_type = return_type;
1688 node->class_closure_bsa = NULL;
1691 node->accumulator = g_new (SignalAccumulator, 1);
1692 node->accumulator->func = accumulator;
1693 node->accumulator->data = accu_data;
1696 node->accumulator = NULL;
1698 builtin_c_marshaller = NULL;
1699 va_marshaller = NULL;
1701 /* Pick up built-in va marshallers for standard types, and
1702 instead of generic marshaller if no marshaller specified */
1703 if (n_params == 0 && return_type == G_TYPE_NONE)
1705 builtin_c_marshaller = g_cclosure_marshal_VOID__VOID;
1706 va_marshaller = g_cclosure_marshal_VOID__VOIDv;
1708 else if (n_params == 1 && return_type == G_TYPE_NONE)
1710 #define ADD_CHECK(__type__) \
1711 else if (g_type_is_a (param_types[0] & ~G_SIGNAL_TYPE_STATIC_SCOPE, G_TYPE_ ##__type__)) \
1713 builtin_c_marshaller = g_cclosure_marshal_VOID__ ## __type__; \
1714 va_marshaller = g_cclosure_marshal_VOID__ ## __type__ ##v; \
1737 if (c_marshaller == NULL)
1739 if (builtin_c_marshaller)
1740 c_marshaller = builtin_c_marshaller;
1743 c_marshaller = g_cclosure_marshal_generic;
1744 va_marshaller = g_cclosure_marshal_generic_va;
1748 node->c_marshaller = c_marshaller;
1749 node->va_marshaller = va_marshaller;
1750 node->emission_hooks = NULL;
1752 signal_add_class_closure (node, 0, class_closure);
1762 g_signal_set_va_marshaller (guint signal_id,
1763 GType instance_type,
1764 GSignalCVaMarshaller va_marshaller)
1768 g_return_if_fail (signal_id > 0);
1769 g_return_if_fail (va_marshaller != NULL);
1772 node = LOOKUP_SIGNAL_NODE (signal_id);
1775 node->va_marshaller = va_marshaller;
1776 if (node->class_closure_bsa)
1778 ClassClosure *cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
1779 if (cc->closure->marshal == node->c_marshaller)
1780 _g_closure_set_va_marshal (cc->closure, va_marshaller);
1783 node->single_va_closure_is_valid = FALSE;
1791 * g_signal_new_valist:
1792 * @signal_name: the name for the signal
1793 * @itype: the type this signal pertains to. It will also pertain to
1794 * types which are derived from this type.
1795 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1796 * the default handler is to be invoked. You should at least specify
1797 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1798 * @class_closure: The closure to invoke on signal emission; may be %NULL.
1799 * @accumulator: the accumulator for this signal; may be %NULL.
1800 * @accu_data: user data for the @accumulator.
1801 * @c_marshaller: (allow-none): the function to translate arrays of parameter
1802 * values to signal emissions into C language callback invocations or %NULL.
1803 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1804 * without a return value.
1805 * @n_params: the number of parameter types in @args.
1806 * @args: va_list of #GType, one for each parameter.
1808 * Creates a new signal. (This is usually done in the class initializer.)
1810 * See g_signal_new() for details on allowed signal names.
1812 * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
1813 * the marshaller for this signal.
1815 * Returns: the signal id
1818 g_signal_new_valist (const gchar *signal_name,
1820 GSignalFlags signal_flags,
1821 GClosure *class_closure,
1822 GSignalAccumulator accumulator,
1824 GSignalCMarshaller c_marshaller,
1835 param_types = g_new (GType, n_params);
1837 for (i = 0; i < n_params; i++)
1838 param_types[i] = va_arg (args, GType);
1843 signal_id = g_signal_newv (signal_name, itype, signal_flags,
1844 class_closure, accumulator, accu_data, c_marshaller,
1845 return_type, n_params, param_types);
1846 g_free (param_types);
1852 signal_destroy_R (SignalNode *signal_node)
1854 SignalNode node = *signal_node;
1856 signal_node->destroyed = TRUE;
1858 /* reentrancy caution, zero out real contents first */
1859 signal_node->single_va_closure_is_valid = FALSE;
1860 signal_node->n_params = 0;
1861 signal_node->param_types = NULL;
1862 signal_node->return_type = 0;
1863 signal_node->class_closure_bsa = NULL;
1864 signal_node->accumulator = NULL;
1865 signal_node->c_marshaller = NULL;
1866 signal_node->va_marshaller = NULL;
1867 signal_node->emission_hooks = NULL;
1869 #ifdef G_ENABLE_DEBUG
1870 /* check current emissions */
1874 for (emission = (node.flags & G_SIGNAL_NO_RECURSE) ? g_restart_emissions : g_recursive_emissions;
1875 emission; emission = emission->next)
1876 if (emission->ihint.signal_id == node.signal_id)
1877 g_critical (G_STRLOC ": signal \"%s\" being destroyed is currently in emission (instance `%p')",
1878 node.name, emission->instance);
1882 /* free contents that need to
1885 g_free (node.param_types);
1886 if (node.class_closure_bsa)
1890 for (i = 0; i < node.class_closure_bsa->n_nodes; i++)
1892 ClassClosure *cc = g_bsearch_array_get_nth (node.class_closure_bsa, &g_class_closure_bconfig, i);
1894 g_closure_unref (cc->closure);
1896 g_bsearch_array_free (node.class_closure_bsa, &g_class_closure_bconfig);
1898 g_free (node.accumulator);
1899 if (node.emission_hooks)
1901 g_hook_list_clear (node.emission_hooks);
1902 g_free (node.emission_hooks);
1908 * g_signal_override_class_closure:
1909 * @signal_id: the signal id
1910 * @instance_type: the instance type on which to override the class closure
1912 * @class_closure: the closure.
1914 * Overrides the class closure (i.e. the default handler) for the given signal
1915 * for emissions on instances of @instance_type. @instance_type must be derived
1916 * from the type to which the signal belongs.
1918 * See g_signal_chain_from_overridden() and
1919 * g_signal_chain_from_overridden_handler() for how to chain up to the
1920 * parent class closure from inside the overridden one.
1923 g_signal_override_class_closure (guint signal_id,
1924 GType instance_type,
1925 GClosure *class_closure)
1929 g_return_if_fail (signal_id > 0);
1930 g_return_if_fail (class_closure != NULL);
1933 node = LOOKUP_SIGNAL_NODE (signal_id);
1934 node_check_deprecated (node);
1935 if (!g_type_is_a (instance_type, node->itype))
1936 g_warning ("%s: type `%s' cannot be overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1939 ClassClosure *cc = signal_find_class_closure (node, instance_type);
1941 if (cc && cc->instance_type == instance_type)
1942 g_warning ("%s: type `%s' is already overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1944 signal_add_class_closure (node, instance_type, class_closure);
1950 * g_signal_override_class_handler:
1951 * @signal_name: the name for the signal
1952 * @instance_type: the instance type on which to override the class handler
1954 * @class_handler: the handler.
1956 * Overrides the class closure (i.e. the default handler) for the
1957 * given signal for emissions on instances of @instance_type with
1958 * callabck @class_handler. @instance_type must be derived from the
1959 * type to which the signal belongs.
1961 * See g_signal_chain_from_overridden() and
1962 * g_signal_chain_from_overridden_handler() for how to chain up to the
1963 * parent class closure from inside the overridden one.
1968 g_signal_override_class_handler (const gchar *signal_name,
1969 GType instance_type,
1970 GCallback class_handler)
1974 g_return_if_fail (signal_name != NULL);
1975 g_return_if_fail (instance_type != G_TYPE_NONE);
1976 g_return_if_fail (class_handler != NULL);
1978 signal_id = g_signal_lookup (signal_name, instance_type);
1981 g_signal_override_class_closure (signal_id, instance_type,
1982 g_cclosure_new (class_handler, NULL, NULL));
1984 g_warning ("%s: signal name '%s' is invalid for type id '%"G_GSIZE_FORMAT"'",
1985 G_STRLOC, signal_name, instance_type);
1990 * g_signal_chain_from_overridden:
1991 * @instance_and_params: (array) the argument list of the signal emission.
1992 * The first element in the array is a #GValue for the instance the signal
1993 * is being emitted on. The rest are any arguments to be passed to the signal.
1994 * @return_value: Location for the return value.
1996 * Calls the original class closure of a signal. This function should only
1997 * be called from an overridden class closure; see
1998 * g_signal_override_class_closure() and
1999 * g_signal_override_class_handler().
2002 g_signal_chain_from_overridden (const GValue *instance_and_params,
2003 GValue *return_value)
2005 GType chain_type = 0, restore_type = 0;
2006 Emission *emission = NULL;
2007 GClosure *closure = NULL;
2011 g_return_if_fail (instance_and_params != NULL);
2012 instance = g_value_peek_pointer (instance_and_params);
2013 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2016 emission = emission_find_innermost (instance);
2019 SignalNode *node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
2021 g_assert (node != NULL); /* paranoid */
2023 /* we should probably do the same parameter checks as g_signal_emit() here.
2025 if (emission->chain_type != G_TYPE_NONE)
2027 ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
2029 g_assert (cc != NULL); /* closure currently in call stack */
2031 n_params = node->n_params;
2032 restore_type = cc->instance_type;
2033 cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
2034 if (cc && cc->instance_type != restore_type)
2036 closure = cc->closure;
2037 chain_type = cc->instance_type;
2041 g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
2044 g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
2048 emission->chain_type = chain_type;
2050 g_closure_invoke (closure,
2053 instance_and_params,
2056 emission->chain_type = restore_type;
2062 * g_signal_chain_from_overridden_handler:
2063 * @instance: the instance the signal is being emitted on.
2064 * @...: parameters to be passed to the parent class closure, followed by a
2065 * location for the return value. If the return type of the signal
2066 * is #G_TYPE_NONE, the return value location can be omitted.
2068 * Calls the original class closure of a signal. This function should
2069 * only be called from an overridden class closure; see
2070 * g_signal_override_class_closure() and
2071 * g_signal_override_class_handler().
2076 g_signal_chain_from_overridden_handler (gpointer instance,
2079 GType chain_type = 0, restore_type = 0;
2080 Emission *emission = NULL;
2081 GClosure *closure = NULL;
2085 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2088 emission = emission_find_innermost (instance);
2091 node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
2093 g_assert (node != NULL); /* paranoid */
2095 /* we should probably do the same parameter checks as g_signal_emit() here.
2097 if (emission->chain_type != G_TYPE_NONE)
2099 ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
2101 g_assert (cc != NULL); /* closure currently in call stack */
2103 n_params = node->n_params;
2104 restore_type = cc->instance_type;
2105 cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
2106 if (cc && cc->instance_type != restore_type)
2108 closure = cc->closure;
2109 chain_type = cc->instance_type;
2113 g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
2116 g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
2120 GValue *instance_and_params;
2121 GType signal_return_type;
2122 GValue *param_values;
2126 va_start (var_args, instance);
2128 signal_return_type = node->return_type;
2129 instance_and_params = g_alloca (sizeof (GValue) * (n_params + 1));
2130 memset (instance_and_params, 0, sizeof (GValue) * (n_params + 1));
2131 param_values = instance_and_params + 1;
2133 for (i = 0; i < node->n_params; i++)
2136 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2137 gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
2140 G_VALUE_COLLECT_INIT (param_values + i, ptype,
2142 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2146 g_warning ("%s: %s", G_STRLOC, error);
2149 /* we purposely leak the value here, it might not be
2150 * in a sane state if an error condition occoured
2153 g_value_unset (param_values + i);
2162 instance_and_params->g_type = 0;
2163 g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
2164 g_value_set_instance (instance_and_params, instance);
2167 emission->chain_type = chain_type;
2170 if (signal_return_type == G_TYPE_NONE)
2172 g_closure_invoke (closure,
2175 instance_and_params,
2180 GValue return_value = G_VALUE_INIT;
2181 gchar *error = NULL;
2182 GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2183 gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
2185 g_value_init (&return_value, rtype);
2187 g_closure_invoke (closure,
2190 instance_and_params,
2193 G_VALUE_LCOPY (&return_value,
2195 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2199 g_value_unset (&return_value);
2203 g_warning ("%s: %s", G_STRLOC, error);
2206 /* we purposely leak the value here, it might not be
2207 * in a sane state if an error condition occurred
2212 for (i = 0; i < n_params; i++)
2213 g_value_unset (param_values + i);
2214 g_value_unset (instance_and_params);
2219 emission->chain_type = restore_type;
2225 * g_signal_get_invocation_hint:
2226 * @instance: the instance to query
2228 * Returns the invocation hint of the innermost signal emission of instance.
2230 * Returns: (transfer none): the invocation hint of the innermost signal emission.
2232 GSignalInvocationHint*
2233 g_signal_get_invocation_hint (gpointer instance)
2235 Emission *emission = NULL;
2237 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), NULL);
2240 emission = emission_find_innermost (instance);
2243 return emission ? &emission->ihint : NULL;
2247 * g_signal_connect_closure_by_id:
2248 * @instance: the instance to connect to.
2249 * @signal_id: the id of the signal.
2250 * @detail: the detail.
2251 * @closure: the closure to connect.
2252 * @after: whether the handler should be called before or after the
2253 * default handler of the signal.
2255 * Connects a closure to a signal for a particular object.
2257 * Returns: the handler id
2260 g_signal_connect_closure_by_id (gpointer instance,
2267 gulong handler_seq_no = 0;
2269 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2270 g_return_val_if_fail (signal_id > 0, 0);
2271 g_return_val_if_fail (closure != NULL, 0);
2274 node = LOOKUP_SIGNAL_NODE (signal_id);
2277 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2278 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2279 else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2280 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2283 Handler *handler = handler_new (after);
2285 handler_seq_no = handler->sequential_number;
2286 handler->detail = detail;
2287 handler->closure = g_closure_ref (closure);
2288 g_closure_sink (closure);
2289 handler_insert (signal_id, instance, handler);
2290 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (closure))
2292 g_closure_set_marshal (closure, node->c_marshaller);
2293 if (node->va_marshaller)
2294 _g_closure_set_va_marshal (closure, node->va_marshaller);
2299 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2302 return handler_seq_no;
2306 * g_signal_connect_closure:
2307 * @instance: the instance to connect to.
2308 * @detailed_signal: a string of the form "signal-name::detail".
2309 * @closure: the closure to connect.
2310 * @after: whether the handler should be called before or after the
2311 * default handler of the signal.
2313 * Connects a closure to a signal for a particular object.
2315 * Returns: the handler id
2318 g_signal_connect_closure (gpointer instance,
2319 const gchar *detailed_signal,
2324 gulong handler_seq_no = 0;
2328 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2329 g_return_val_if_fail (detailed_signal != NULL, 0);
2330 g_return_val_if_fail (closure != NULL, 0);
2333 itype = G_TYPE_FROM_INSTANCE (instance);
2334 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2337 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2339 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2340 g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
2341 else if (!g_type_is_a (itype, node->itype))
2342 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2345 Handler *handler = handler_new (after);
2347 handler_seq_no = handler->sequential_number;
2348 handler->detail = detail;
2349 handler->closure = g_closure_ref (closure);
2350 g_closure_sink (closure);
2351 handler_insert (signal_id, instance, handler);
2352 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2354 g_closure_set_marshal (handler->closure, node->c_marshaller);
2355 if (node->va_marshaller)
2356 _g_closure_set_va_marshal (handler->closure, node->va_marshaller);
2361 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2364 return handler_seq_no;
2368 node_check_deprecated (const SignalNode *node)
2370 static const gchar * g_enable_diagnostic = NULL;
2372 if (G_UNLIKELY (!g_enable_diagnostic))
2374 g_enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
2375 if (!g_enable_diagnostic)
2376 g_enable_diagnostic = "0";
2379 if (g_enable_diagnostic[0] == '1')
2381 if (node->flags & G_SIGNAL_DEPRECATED)
2383 g_warning ("The signal %s::%s is deprecated and shouldn't be used "
2384 "anymore. It will be removed in a future version.",
2385 type_debug_name (node->itype), node->name);
2391 * g_signal_connect_data:
2392 * @instance: the instance to connect to.
2393 * @detailed_signal: a string of the form "signal-name::detail".
2394 * @c_handler: the #GCallback to connect.
2395 * @data: data to pass to @c_handler calls.
2396 * @destroy_data: a #GClosureNotify for @data.
2397 * @connect_flags: a combination of #GConnectFlags.
2399 * Connects a #GCallback function to a signal for a particular object. Similar
2400 * to g_signal_connect(), but allows to provide a #GClosureNotify for the data
2401 * which will be called when the signal handler is disconnected and no longer
2402 * used. Specify @connect_flags if you need <literal>..._after()</literal> or
2403 * <literal>..._swapped()</literal> variants of this function.
2405 * Returns: the handler id
2408 g_signal_connect_data (gpointer instance,
2409 const gchar *detailed_signal,
2410 GCallback c_handler,
2412 GClosureNotify destroy_data,
2413 GConnectFlags connect_flags)
2416 gulong handler_seq_no = 0;
2419 gboolean swapped, after;
2421 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2422 g_return_val_if_fail (detailed_signal != NULL, 0);
2423 g_return_val_if_fail (c_handler != NULL, 0);
2425 swapped = (connect_flags & G_CONNECT_SWAPPED) != FALSE;
2426 after = (connect_flags & G_CONNECT_AFTER) != FALSE;
2429 itype = G_TYPE_FROM_INSTANCE (instance);
2430 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2433 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2435 node_check_deprecated (node);
2437 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2438 g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
2439 else if (!g_type_is_a (itype, node->itype))
2440 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2443 Handler *handler = handler_new (after);
2445 handler_seq_no = handler->sequential_number;
2446 handler->detail = detail;
2447 handler->closure = g_closure_ref ((swapped ? g_cclosure_new_swap : g_cclosure_new) (c_handler, data, destroy_data));
2448 g_closure_sink (handler->closure);
2449 handler_insert (signal_id, instance, handler);
2450 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2452 g_closure_set_marshal (handler->closure, node->c_marshaller);
2453 if (node->va_marshaller)
2454 _g_closure_set_va_marshal (handler->closure, node->va_marshaller);
2459 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2462 return handler_seq_no;
2466 * g_signal_handler_block:
2467 * @instance: The instance to block the signal handler of.
2468 * @handler_id: Handler id of the handler to be blocked.
2470 * Blocks a handler of an instance so it will not be called during any
2471 * signal emissions unless it is unblocked again. Thus "blocking" a
2472 * signal handler means to temporarily deactive it, a signal handler
2473 * has to be unblocked exactly the same amount of times it has been
2474 * blocked before to become active again.
2476 * The @handler_id has to be a valid signal handler id, connected to a
2477 * signal of @instance.
2480 g_signal_handler_block (gpointer instance,
2485 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2486 g_return_if_fail (handler_id > 0);
2489 handler = handler_lookup (instance, handler_id, NULL);
2492 #ifndef G_DISABLE_CHECKS
2493 if (handler->block_count >= HANDLER_MAX_BLOCK_COUNT - 1)
2494 g_error (G_STRLOC ": handler block_count overflow, %s", REPORT_BUG);
2496 handler->block_count += 1;
2499 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2504 * g_signal_handler_unblock:
2505 * @instance: The instance to unblock the signal handler of.
2506 * @handler_id: Handler id of the handler to be unblocked.
2508 * Undoes the effect of a previous g_signal_handler_block() call. A
2509 * blocked handler is skipped during signal emissions and will not be
2510 * invoked, unblocking it (for exactly the amount of times it has been
2511 * blocked before) reverts its "blocked" state, so the handler will be
2512 * recognized by the signal system and is called upon future or
2513 * currently ongoing signal emissions (since the order in which
2514 * handlers are called during signal emissions is deterministic,
2515 * whether the unblocked handler in question is called as part of a
2516 * currently ongoing emission depends on how far that emission has
2519 * The @handler_id has to be a valid id of a signal handler that is
2520 * connected to a signal of @instance and is currently blocked.
2523 g_signal_handler_unblock (gpointer instance,
2528 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2529 g_return_if_fail (handler_id > 0);
2532 handler = handler_lookup (instance, handler_id, NULL);
2535 if (handler->block_count)
2536 handler->block_count -= 1;
2538 g_warning (G_STRLOC ": handler `%lu' of instance `%p' is not blocked", handler_id, instance);
2541 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2546 * g_signal_handler_disconnect:
2547 * @instance: The instance to remove the signal handler from.
2548 * @handler_id: Handler id of the handler to be disconnected.
2550 * Disconnects a handler from an instance so it will not be called during
2551 * any future or currently ongoing emissions of the signal it has been
2552 * connected to. The @handler_id becomes invalid and may be reused.
2554 * The @handler_id has to be a valid signal handler id, connected to a
2555 * signal of @instance.
2558 g_signal_handler_disconnect (gpointer instance,
2564 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2565 g_return_if_fail (handler_id > 0);
2568 handler = handler_lookup (instance, handler_id, &signal_id);
2571 handler->sequential_number = 0;
2572 handler->block_count = 1;
2573 handler_unref_R (signal_id, instance, handler);
2576 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2581 * g_signal_handler_is_connected:
2582 * @instance: The instance where a signal handler is sought.
2583 * @handler_id: the handler id.
2585 * Returns whether @handler_id is the id of a handler connected to @instance.
2587 * Returns: whether @handler_id identifies a handler connected to @instance.
2590 g_signal_handler_is_connected (gpointer instance,
2596 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2599 handler = handler_lookup (instance, handler_id, NULL);
2600 connected = handler != NULL;
2607 g_signal_handlers_destroy (gpointer instance)
2609 GBSearchArray *hlbsa;
2611 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2614 hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
2619 /* reentrancy caution, delete instance trace first */
2620 g_hash_table_remove (g_handler_list_bsa_ht, instance);
2622 for (i = 0; i < hlbsa->n_nodes; i++)
2624 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
2625 Handler *handler = hlist->handlers;
2629 Handler *tmp = handler;
2631 handler = tmp->next;
2632 tmp->block_count = 1;
2633 /* cruel unlink, this works because _all_ handlers vanish */
2636 if (tmp->sequential_number)
2638 tmp->sequential_number = 0;
2639 handler_unref_R (0, NULL, tmp);
2643 g_bsearch_array_free (hlbsa, &g_signal_hlbsa_bconfig);
2649 * g_signal_handler_find:
2650 * @instance: The instance owning the signal handler to be found.
2651 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2652 * and/or @data the handler has to match.
2653 * @signal_id: Signal the handler has to be connected to.
2654 * @detail: Signal detail the handler has to be connected to.
2655 * @closure: (allow-none): The closure the handler will invoke.
2656 * @func: The C closure callback of the handler (useless for non-C closures).
2657 * @data: The closure data of the handler's closure.
2659 * Finds the first signal handler that matches certain selection criteria.
2660 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2661 * flags, and the criteria values are passed as arguments.
2662 * The match @mask has to be non-0 for successful matches.
2663 * If no handler was found, 0 is returned.
2665 * Returns: A valid non-0 signal handler id for a successful match.
2668 g_signal_handler_find (gpointer instance,
2669 GSignalMatchType mask,
2676 gulong handler_seq_no = 0;
2678 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2679 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2681 if (mask & G_SIGNAL_MATCH_MASK)
2683 HandlerMatch *mlist;
2686 mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, TRUE);
2689 handler_seq_no = mlist->handler->sequential_number;
2690 handler_match_free1_R (mlist, instance);
2695 return handler_seq_no;
2699 signal_handlers_foreach_matched_R (gpointer instance,
2700 GSignalMatchType mask,
2706 void (*callback) (gpointer instance,
2707 gulong handler_seq_no))
2709 HandlerMatch *mlist;
2710 guint n_handlers = 0;
2712 mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, FALSE);
2716 if (mlist->handler->sequential_number)
2719 callback (instance, mlist->handler->sequential_number);
2722 mlist = handler_match_free1_R (mlist, instance);
2729 * g_signal_handlers_block_matched:
2730 * @instance: The instance to block handlers from.
2731 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2732 * and/or @data the handlers have to match.
2733 * @signal_id: Signal the handlers have to be connected to.
2734 * @detail: Signal detail the handlers have to be connected to.
2735 * @closure: (allow-none): The closure the handlers will invoke.
2736 * @func: The C closure callback of the handlers (useless for non-C closures).
2737 * @data: The closure data of the handlers' closures.
2739 * Blocks all handlers on an instance that match a certain selection criteria.
2740 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2741 * flags, and the criteria values are passed as arguments.
2742 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2743 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2744 * If no handlers were found, 0 is returned, the number of blocked handlers
2747 * Returns: The number of handlers that matched.
2750 g_signal_handlers_block_matched (gpointer instance,
2751 GSignalMatchType mask,
2758 guint n_handlers = 0;
2760 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2761 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2763 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2766 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2767 closure, func, data,
2768 g_signal_handler_block);
2776 * g_signal_handlers_unblock_matched:
2777 * @instance: The instance to unblock handlers from.
2778 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2779 * and/or @data the handlers have to match.
2780 * @signal_id: Signal the handlers have to be connected to.
2781 * @detail: Signal detail the handlers have to be connected to.
2782 * @closure: (allow-none): The closure the handlers will invoke.
2783 * @func: The C closure callback of the handlers (useless for non-C closures).
2784 * @data: The closure data of the handlers' closures.
2786 * Unblocks all handlers on an instance that match a certain selection
2787 * criteria. The criteria mask is passed as an OR-ed combination of
2788 * #GSignalMatchType flags, and the criteria values are passed as arguments.
2789 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2790 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2791 * If no handlers were found, 0 is returned, the number of unblocked handlers
2792 * otherwise. The match criteria should not apply to any handlers that are
2793 * not currently blocked.
2795 * Returns: The number of handlers that matched.
2798 g_signal_handlers_unblock_matched (gpointer instance,
2799 GSignalMatchType mask,
2806 guint n_handlers = 0;
2808 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2809 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2811 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2814 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2815 closure, func, data,
2816 g_signal_handler_unblock);
2824 * g_signal_handlers_disconnect_matched:
2825 * @instance: The instance to remove handlers from.
2826 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2827 * and/or @data the handlers have to match.
2828 * @signal_id: Signal the handlers have to be connected to.
2829 * @detail: Signal detail the handlers have to be connected to.
2830 * @closure: (allow-none): The closure the handlers will invoke.
2831 * @func: The C closure callback of the handlers (useless for non-C closures).
2832 * @data: The closure data of the handlers' closures.
2834 * Disconnects all handlers on an instance that match a certain
2835 * selection criteria. The criteria mask is passed as an OR-ed
2836 * combination of #GSignalMatchType flags, and the criteria values are
2837 * passed as arguments. Passing at least one of the
2838 * %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
2839 * %G_SIGNAL_MATCH_DATA match flags is required for successful
2840 * matches. If no handlers were found, 0 is returned, the number of
2841 * disconnected handlers otherwise.
2843 * Returns: The number of handlers that matched.
2846 g_signal_handlers_disconnect_matched (gpointer instance,
2847 GSignalMatchType mask,
2854 guint n_handlers = 0;
2856 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2857 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2859 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2862 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2863 closure, func, data,
2864 g_signal_handler_disconnect);
2872 * g_signal_has_handler_pending:
2873 * @instance: the object whose signal handlers are sought.
2874 * @signal_id: the signal id.
2875 * @detail: the detail.
2876 * @may_be_blocked: whether blocked handlers should count as match.
2878 * Returns whether there are any handlers connected to @instance for the
2879 * given signal id and detail.
2881 * One example of when you might use this is when the arguments to the
2882 * signal are difficult to compute. A class implementor may opt to not
2883 * emit the signal if no one is attached anyway, thus saving the cost
2884 * of building the arguments.
2886 * Returns: %TRUE if a handler is connected to the signal, %FALSE
2890 g_signal_has_handler_pending (gpointer instance,
2893 gboolean may_be_blocked)
2895 HandlerMatch *mlist;
2896 gboolean has_pending;
2898 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2899 g_return_val_if_fail (signal_id > 0, FALSE);
2904 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2906 if (!(node->flags & G_SIGNAL_DETAILED))
2908 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2913 mlist = handlers_find (instance,
2914 (G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | (may_be_blocked ? 0 : G_SIGNAL_MATCH_UNBLOCKED)),
2915 signal_id, detail, NULL, NULL, NULL, TRUE);
2919 handler_match_free1_R (mlist, instance);
2922 has_pending = FALSE;
2930 * @instance_and_params: (array): argument list for the signal emission.
2931 * The first element in the array is a #GValue for the instance the signal
2932 * is being emitted on. The rest are any arguments to be passed to the signal.
2933 * @signal_id: the signal id
2934 * @detail: the detail
2935 * @return_value: Location to store the return value of the signal emission.
2939 * Note that g_signal_emitv() doesn't change @return_value if no handlers are
2940 * connected, in contrast to g_signal_emit() and g_signal_emit_valist().
2943 g_signal_emitv (const GValue *instance_and_params,
2946 GValue *return_value)
2950 #ifdef G_ENABLE_DEBUG
2951 const GValue *param_values;
2955 g_return_if_fail (instance_and_params != NULL);
2956 instance = g_value_peek_pointer (instance_and_params);
2957 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2958 g_return_if_fail (signal_id > 0);
2960 #ifdef G_ENABLE_DEBUG
2961 param_values = instance_and_params + 1;
2965 node = LOOKUP_SIGNAL_NODE (signal_id);
2966 if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2968 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2972 #ifdef G_ENABLE_DEBUG
2973 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2975 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2979 for (i = 0; i < node->n_params; i++)
2980 if (!G_TYPE_CHECK_VALUE_TYPE (param_values + i, node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
2982 g_critical ("%s: value for `%s' parameter %u for signal \"%s\" is of type `%s'",
2984 type_debug_name (node->param_types[i]),
2987 G_VALUE_TYPE_NAME (param_values + i));
2991 if (node->return_type != G_TYPE_NONE)
2995 g_critical ("%s: return value `%s' for signal \"%s\" is (NULL)",
2997 type_debug_name (node->return_type),
3002 else if (!node->accumulator && !G_TYPE_CHECK_VALUE_TYPE (return_value, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
3004 g_critical ("%s: return value `%s' for signal \"%s\" is of type `%s'",
3006 type_debug_name (node->return_type),
3008 G_VALUE_TYPE_NAME (return_value));
3014 return_value = NULL;
3015 #endif /* G_ENABLE_DEBUG */
3017 /* optimize NOP emissions */
3018 if (!node->single_va_closure_is_valid)
3019 node_update_single_va_closure (node);
3021 if (node->single_va_closure != NULL &&
3022 (node->single_va_closure == SINGLE_VA_CLOSURE_EMPTY_MAGIC ||
3023 _g_closure_is_void (node->single_va_closure, instance))
3024 #ifdef G_ENABLE_DEBUG
3025 && !COND_DEBUG (SIGNALS, g_trace_instance_signals != instance &&
3026 g_trap_instance_signals == instance)
3027 #endif /* G_ENABLE_DEBUG */
3030 HandlerList* hlist = handler_list_lookup (node->signal_id, instance);
3031 if (hlist == NULL || hlist->handlers == NULL)
3033 /* nothing to do to emit this signal */
3035 /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
3041 signal_emit_unlocked_R (node, detail, instance, return_value, instance_and_params);
3044 static inline gboolean
3045 accumulate (GSignalInvocationHint *ihint,
3046 GValue *return_accu,
3047 GValue *handler_return,
3048 SignalAccumulator *accumulator)
3050 gboolean continue_emission;
3055 continue_emission = accumulator->func (ihint, return_accu, handler_return, accumulator->data);
3056 g_value_reset (handler_return);
3058 return continue_emission;
3062 * g_signal_emit_valist:
3063 * @instance: the instance the signal is being emitted on.
3064 * @signal_id: the signal id
3065 * @detail: the detail
3066 * @var_args: a list of parameters to be passed to the signal, followed by a
3067 * location for the return value. If the return type of the signal
3068 * is #G_TYPE_NONE, the return value location can be omitted.
3072 * Note that g_signal_emit_valist() resets the return value to the default
3073 * if no handlers are connected, in contrast to g_signal_emitv().
3076 g_signal_emit_valist (gpointer instance,
3081 GValue *instance_and_params;
3082 GType signal_return_type;
3083 GValue *param_values;
3087 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
3088 g_return_if_fail (signal_id > 0);
3091 node = LOOKUP_SIGNAL_NODE (signal_id);
3092 if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
3094 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
3098 #ifndef G_DISABLE_CHECKS
3099 if (detail && !(node->flags & G_SIGNAL_DETAILED))
3101 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
3105 #endif /* !G_DISABLE_CHECKS */
3107 if (!node->single_va_closure_is_valid)
3108 node_update_single_va_closure (node);
3110 if (node->single_va_closure != NULL
3111 #ifdef G_ENABLE_DEBUG
3112 && !COND_DEBUG (SIGNALS, g_trace_instance_signals != instance &&
3113 g_trap_instance_signals == instance)
3114 #endif /* G_ENABLE_DEBUG */
3117 HandlerList* hlist = handler_list_lookup (node->signal_id, instance);
3119 GClosure *closure = NULL;
3120 gboolean fastpath = TRUE;
3121 GSignalFlags run_type = G_SIGNAL_RUN_FIRST;
3123 if (node->single_va_closure != SINGLE_VA_CLOSURE_EMPTY_MAGIC &&
3124 !_g_closure_is_void (node->single_va_closure, instance))
3126 if (_g_closure_supports_invoke_va (node->single_va_closure))
3128 closure = node->single_va_closure;
3129 if (node->single_va_closure_is_after)
3130 run_type = G_SIGNAL_RUN_LAST;
3132 run_type = G_SIGNAL_RUN_FIRST;
3138 for (l = hlist ? hlist->handlers : NULL; fastpath && l != NULL; l = l->next)
3140 if (!l->block_count &&
3141 (!l->detail || l->detail == detail))
3143 if (closure != NULL || !_g_closure_supports_invoke_va (l->closure))
3150 closure = l->closure;
3152 run_type = G_SIGNAL_RUN_LAST;
3154 run_type = G_SIGNAL_RUN_FIRST;
3159 if (fastpath && closure == NULL && node->return_type == G_TYPE_NONE)
3165 /* Don't allow no-recurse emission as we might have to restart, which means
3166 we will run multiple handlers and thus must ref all arguments */
3167 if (closure != NULL && (node->flags & (G_SIGNAL_NO_RECURSE)) != 0)
3172 SignalAccumulator *accumulator;
3174 GValue *return_accu, accu = G_VALUE_INIT;
3176 GType instance_type = G_TYPE_FROM_INSTANCE (instance);
3177 GValue emission_return = G_VALUE_INIT;
3178 GType rtype = node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3179 gboolean static_scope = node->return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
3181 signal_id = node->signal_id;
3182 accumulator = node->accumulator;
3183 if (rtype == G_TYPE_NONE)
3185 else if (accumulator)
3186 return_accu = &accu;
3188 return_accu = &emission_return;
3190 emission.instance = instance;
3191 emission.ihint.signal_id = signal_id;
3192 emission.ihint.detail = detail;
3193 emission.ihint.run_type = run_type;
3194 emission.state = EMISSION_RUN;
3195 emission.chain_type = instance_type;
3196 emission_push (&g_recursive_emissions, &emission);
3200 TRACE(GOBJECT_SIGNAL_EMIT(signal_id, detail, instance, instance_type));
3202 if (rtype != G_TYPE_NONE)
3203 g_value_init (&emission_return, rtype);
3206 g_value_init (&accu, rtype);
3208 if (closure != NULL)
3210 g_object_ref (instance);
3211 _g_closure_invoke_va (closure,
3217 accumulate (&emission.ihint, &emission_return, &accu, accumulator);
3218 g_object_unref (instance);
3223 emission.chain_type = G_TYPE_NONE;
3224 emission_pop (&g_recursive_emissions, &emission);
3229 g_value_unset (&accu);
3231 if (rtype != G_TYPE_NONE)
3233 gchar *error = NULL;
3234 for (i = 0; i < node->n_params; i++)
3236 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3237 G_VALUE_COLLECT_SKIP (ptype, var_args);
3240 G_VALUE_LCOPY (&emission_return,
3242 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3245 g_value_unset (&emission_return);
3248 g_warning ("%s: %s", G_STRLOC, error);
3250 /* we purposely leak the value here, it might not be
3251 * in a sane state if an error condition occurred
3256 TRACE(GOBJECT_SIGNAL_EMIT_END(signal_id, detail, instance, instance_type));
3262 n_params = node->n_params;
3263 signal_return_type = node->return_type;
3264 instance_and_params = g_alloca (sizeof (GValue) * (n_params + 1));
3265 memset (instance_and_params, 0, sizeof (GValue) * (n_params + 1));
3266 param_values = instance_and_params + 1;
3268 for (i = 0; i < node->n_params; i++)
3271 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3272 gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
3275 G_VALUE_COLLECT_INIT (param_values + i, ptype,
3277 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3281 g_warning ("%s: %s", G_STRLOC, error);
3284 /* we purposely leak the value here, it might not be
3285 * in a sane state if an error condition occoured
3288 g_value_unset (param_values + i);
3296 instance_and_params->g_type = 0;
3297 g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
3298 g_value_set_instance (instance_and_params, instance);
3299 if (signal_return_type == G_TYPE_NONE)
3300 signal_emit_unlocked_R (node, detail, instance, NULL, instance_and_params);
3303 GValue return_value = G_VALUE_INIT;
3304 gchar *error = NULL;
3305 GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3306 gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
3308 g_value_init (&return_value, rtype);
3310 signal_emit_unlocked_R (node, detail, instance, &return_value, instance_and_params);
3312 G_VALUE_LCOPY (&return_value,
3314 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3317 g_value_unset (&return_value);
3320 g_warning ("%s: %s", G_STRLOC, error);
3323 /* we purposely leak the value here, it might not be
3324 * in a sane state if an error condition occurred
3328 for (i = 0; i < n_params; i++)
3329 g_value_unset (param_values + i);
3330 g_value_unset (instance_and_params);
3335 * @instance: the instance the signal is being emitted on.
3336 * @signal_id: the signal id
3337 * @detail: the detail
3338 * @...: parameters to be passed to the signal, followed by a
3339 * location for the return value. If the return type of the signal
3340 * is #G_TYPE_NONE, the return value location can be omitted.
3344 * Note that g_signal_emit() resets the return value to the default
3345 * if no handlers are connected, in contrast to g_signal_emitv().
3348 g_signal_emit (gpointer instance,
3355 va_start (var_args, detail);
3356 g_signal_emit_valist (instance, signal_id, detail, var_args);
3361 * g_signal_emit_by_name:
3362 * @instance: the instance the signal is being emitted on.
3363 * @detailed_signal: a string of the form "signal-name::detail".
3364 * @...: parameters to be passed to the signal, followed by a
3365 * location for the return value. If the return type of the signal
3366 * is #G_TYPE_NONE, the return value location can be omitted.
3370 * Note that g_signal_emit_by_name() resets the return value to the default
3371 * if no handlers are connected, in contrast to g_signal_emitv().
3374 g_signal_emit_by_name (gpointer instance,
3375 const gchar *detailed_signal,
3381 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
3382 g_return_if_fail (detailed_signal != NULL);
3385 signal_id = signal_parse_name (detailed_signal, G_TYPE_FROM_INSTANCE (instance), &detail, TRUE);
3392 va_start (var_args, detailed_signal);
3393 g_signal_emit_valist (instance, signal_id, detail, var_args);
3397 g_warning ("%s: signal name `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
3401 signal_emit_unlocked_R (SignalNode *node,
3404 GValue *emission_return,
3405 const GValue *instance_and_params)
3407 SignalAccumulator *accumulator;
3409 GClosure *class_closure;
3411 Handler *handler_list = NULL;
3412 GValue *return_accu, accu = G_VALUE_INIT;
3414 gulong max_sequential_handler_number;
3415 gboolean return_value_altered = FALSE;
3417 #ifdef G_ENABLE_DEBUG
3418 IF_DEBUG (SIGNALS, g_trace_instance_signals == instance || g_trap_instance_signals == instance)
3420 g_message ("%s::%s(%u) emitted (instance=%p, signal-node=%p)",
3421 g_type_name (G_TYPE_FROM_INSTANCE (instance)),
3424 if (g_trap_instance_signals == instance)
3427 #endif /* G_ENABLE_DEBUG */
3429 TRACE(GOBJECT_SIGNAL_EMIT(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3432 signal_id = node->signal_id;
3433 if (node->flags & G_SIGNAL_NO_RECURSE)
3435 Emission *node = emission_find (g_restart_emissions, signal_id, detail, instance);
3439 node->state = EMISSION_RESTART;
3441 return return_value_altered;
3444 accumulator = node->accumulator;
3448 g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3449 return_accu = &accu;
3453 return_accu = emission_return;
3454 emission.instance = instance;
3455 emission.ihint.signal_id = node->signal_id;
3456 emission.ihint.detail = detail;
3457 emission.ihint.run_type = 0;
3459 emission.chain_type = G_TYPE_NONE;
3460 emission_push ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3461 class_closure = signal_lookup_closure (node, instance);
3466 handler_unref_R (signal_id, instance, handler_list);
3467 max_sequential_handler_number = g_handler_sequential_number;
3468 hlist = handler_list_lookup (signal_id, instance);
3469 handler_list = hlist ? hlist->handlers : NULL;
3471 handler_ref (handler_list);
3473 emission.ihint.run_type = G_SIGNAL_RUN_FIRST;
3475 if ((node->flags & G_SIGNAL_RUN_FIRST) && class_closure)
3477 emission.state = EMISSION_RUN;
3479 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3481 g_closure_invoke (class_closure,
3484 instance_and_params,
3486 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3487 emission.state == EMISSION_RUN)
3488 emission.state = EMISSION_STOP;
3490 emission.chain_type = G_TYPE_NONE;
3491 return_value_altered = TRUE;
3493 if (emission.state == EMISSION_STOP)
3495 else if (emission.state == EMISSION_RESTART)
3499 if (node->emission_hooks)
3501 gboolean need_destroy, was_in_call, may_recurse = TRUE;
3504 emission.state = EMISSION_HOOK;
3505 hook = g_hook_first_valid (node->emission_hooks, may_recurse);
3508 SignalHook *signal_hook = SIGNAL_HOOK (hook);
3510 if (!signal_hook->detail || signal_hook->detail == detail)
3512 GSignalEmissionHook hook_func = (GSignalEmissionHook) hook->func;
3514 was_in_call = G_HOOK_IN_CALL (hook);
3515 hook->flags |= G_HOOK_FLAG_IN_CALL;
3517 need_destroy = !hook_func (&emission.ihint, node->n_params + 1, instance_and_params, hook->data);
3520 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
3522 g_hook_destroy_link (node->emission_hooks, hook);
3524 hook = g_hook_next_valid (node->emission_hooks, hook, may_recurse);
3527 if (emission.state == EMISSION_RESTART)
3533 Handler *handler = handler_list;
3535 emission.state = EMISSION_RUN;
3536 handler_ref (handler);
3543 handler_unref_R (signal_id, instance, handler_list);
3544 handler_list = handler;
3547 else if (!handler->block_count && (!handler->detail || handler->detail == detail) &&
3548 handler->sequential_number < max_sequential_handler_number)
3551 g_closure_invoke (handler->closure,
3554 instance_and_params,
3556 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3557 emission.state == EMISSION_RUN)
3558 emission.state = EMISSION_STOP;
3560 return_value_altered = TRUE;
3562 tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3565 tmp = handler->next;
3569 handler_unref_R (signal_id, instance, handler_list);
3570 handler_list = handler;
3575 if (emission.state == EMISSION_STOP)
3577 else if (emission.state == EMISSION_RESTART)
3581 emission.ihint.run_type = G_SIGNAL_RUN_LAST;
3583 if ((node->flags & G_SIGNAL_RUN_LAST) && class_closure)
3585 emission.state = EMISSION_RUN;
3587 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3589 g_closure_invoke (class_closure,
3592 instance_and_params,
3594 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3595 emission.state == EMISSION_RUN)
3596 emission.state = EMISSION_STOP;
3598 emission.chain_type = G_TYPE_NONE;
3599 return_value_altered = TRUE;
3601 if (emission.state == EMISSION_STOP)
3603 else if (emission.state == EMISSION_RESTART)
3609 Handler *handler = handler_list;
3611 emission.state = EMISSION_RUN;
3612 handler_ref (handler);
3617 if (handler->after && !handler->block_count && (!handler->detail || handler->detail == detail) &&
3618 handler->sequential_number < max_sequential_handler_number)
3621 g_closure_invoke (handler->closure,
3624 instance_and_params,
3626 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3627 emission.state == EMISSION_RUN)
3628 emission.state = EMISSION_STOP;
3630 return_value_altered = TRUE;
3632 tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3635 tmp = handler->next;
3639 handler_unref_R (signal_id, instance, handler);
3644 if (emission.state == EMISSION_STOP)
3646 else if (emission.state == EMISSION_RESTART)
3652 emission.ihint.run_type = G_SIGNAL_RUN_CLEANUP;
3654 if ((node->flags & G_SIGNAL_RUN_CLEANUP) && class_closure)
3656 gboolean need_unset = FALSE;
3658 emission.state = EMISSION_STOP;
3660 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3662 if (node->return_type != G_TYPE_NONE && !accumulator)
3664 g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3667 g_closure_invoke (class_closure,
3668 node->return_type != G_TYPE_NONE ? &accu : NULL,
3670 instance_and_params,
3673 g_value_unset (&accu);
3675 emission.chain_type = G_TYPE_NONE;
3677 if (emission.state == EMISSION_RESTART)
3682 handler_unref_R (signal_id, instance, handler_list);
3684 emission_pop ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3687 g_value_unset (&accu);
3689 TRACE(GOBJECT_SIGNAL_EMIT_END(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3691 return return_value_altered;
3695 type_debug_name (GType type)
3699 const char *name = g_type_name (type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3700 return name ? name : "<unknown>";
3707 * g_signal_accumulator_true_handled:
3708 * @ihint: standard #GSignalAccumulator parameter
3709 * @return_accu: standard #GSignalAccumulator parameter
3710 * @handler_return: standard #GSignalAccumulator parameter
3711 * @dummy: standard #GSignalAccumulator parameter
3713 * A predefined #GSignalAccumulator for signals that return a
3714 * boolean values. The behavior that this accumulator gives is
3715 * that a return of %TRUE stops the signal emission: no further
3716 * callbacks will be invoked, while a return of %FALSE allows
3717 * the emission to continue. The idea here is that a %TRUE return
3718 * indicates that the callback <emphasis>handled</emphasis> the signal,
3719 * and no further handling is needed.
3723 * Returns: standard #GSignalAccumulator result
3726 g_signal_accumulator_true_handled (GSignalInvocationHint *ihint,
3727 GValue *return_accu,
3728 const GValue *handler_return,
3731 gboolean continue_emission;
3732 gboolean signal_handled;
3734 signal_handled = g_value_get_boolean (handler_return);
3735 g_value_set_boolean (return_accu, signal_handled);
3736 continue_emission = !signal_handled;
3738 return continue_emission;
3742 * g_signal_accumulator_first_wins:
3743 * @ihint: standard #GSignalAccumulator parameter
3744 * @return_accu: standard #GSignalAccumulator parameter
3745 * @handler_return: standard #GSignalAccumulator parameter
3746 * @dummy: standard #GSignalAccumulator parameter
3748 * A predefined #GSignalAccumulator for signals intended to be used as a
3749 * hook for application code to provide a particular value. Usually
3750 * only one such value is desired and multiple handlers for the same
3751 * signal don't make much sense (except for the case of the default
3752 * handler defined in the class structure, in which case you will
3753 * usually want the signal connection to override the class handler).
3755 * This accumulator will use the return value from the first signal
3756 * handler that is run as the return value for the signal and not run
3757 * any further handlers (ie: the first handler "wins").
3759 * Returns: standard #GSignalAccumulator result
3764 g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
3765 GValue *return_accu,
3766 const GValue *handler_return,
3769 g_value_copy (handler_return, return_accu);