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, see <http://www.gnu.org/licenses/>.
17 * this code is based on the original GtkSignal implementation
18 * for the Gtk+ library by Peter Mattis <petm@xcf.berkeley.edu>
31 #include "gtype-private.h"
32 #include "gbsearcharray.h"
33 #include "gvaluecollector.h"
34 #include "gvaluetypes.h"
37 #include "gobject_trace.h"
42 * @short_description: A means for customization of object behaviour
43 * and a general purpose notification mechanism
46 * The basic concept of the signal system is that of the
47 * <emphasis>emission</emphasis> of a signal. Signals are introduced
48 * per-type and are identified through strings. Signals introduced
49 * for a parent type are available in derived types as well, so
50 * basically they are a per-type facility that is inherited. A signal
51 * emission mainly involves invocation of a certain set of callbacks
52 * in precisely defined manner. There are two main categories of such
53 * callbacks, per-object ones and user provided ones.
54 * (Although signals can deal with any kind of instantiatable type, I'm
55 * referring to those types as "object types" in the following, simply
56 * because that is the context most users will encounter signals in.)
57 * The per-object callbacks are most often referred to as "object method
58 * handler" or "default (signal) handler", while user provided callbacks are
59 * usually just called "signal handler".
60 * The object method handler is provided at signal creation time (this most
61 * frequently happens at the end of an object class' creation), while user
62 * provided handlers are frequently connected and disconnected to/from a certain
63 * signal on certain object instances.
65 * A signal emission consists of five stages, unless prematurely stopped:
67 * <varlistentry><term></term><listitem><para>
68 * 1 - Invocation of the object method handler for %G_SIGNAL_RUN_FIRST signals
69 * </para></listitem></varlistentry>
70 * <varlistentry><term></term><listitem><para>
71 * 2 - Invocation of normal user-provided signal handlers (<emphasis>after</emphasis> flag %FALSE)
72 * </para></listitem></varlistentry>
73 * <varlistentry><term></term><listitem><para>
74 * 3 - Invocation of the object method handler for %G_SIGNAL_RUN_LAST signals
75 * </para></listitem></varlistentry>
76 * <varlistentry><term></term><listitem><para>
77 * 4 - Invocation of user provided signal handlers, connected with an <emphasis>after</emphasis> flag of %TRUE
78 * </para></listitem></varlistentry>
79 * <varlistentry><term></term><listitem><para>
80 * 5 - Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals
81 * </para></listitem></varlistentry>
83 * The user-provided signal handlers are called in the order they were
85 * All handlers may prematurely stop a signal emission, and any number of
86 * handlers may be connected, disconnected, blocked or unblocked during
88 * There are certain criteria for skipping user handlers in stages 2 and 4
89 * of a signal emission.
90 * First, user handlers may be <emphasis>blocked</emphasis>, blocked handlers are omitted
91 * during callback invocation, to return from the "blocked" state, a
92 * handler has to get unblocked exactly the same amount of times
93 * it has been blocked before.
94 * Second, upon emission of a %G_SIGNAL_DETAILED signal, an additional
95 * "detail" argument passed in to g_signal_emit() has to match the detail
96 * argument of the signal handler currently subject to invocation.
97 * Specification of no detail argument for signal handlers (omission of the
98 * detail part of the signal specification upon connection) serves as a
99 * wildcard and matches any detail argument passed in to emission.
103 #define REPORT_BUG "please report occurrence circumstances to gtk-devel-list@gnome.org"
105 /* --- typedefs --- */
106 typedef struct _SignalNode SignalNode;
107 typedef struct _SignalKey SignalKey;
108 typedef struct _Emission Emission;
109 typedef struct _Handler Handler;
110 typedef struct _HandlerList HandlerList;
111 typedef struct _HandlerMatch HandlerMatch;
121 /* --- prototypes --- */
122 static inline guint signal_id_lookup (GQuark quark,
124 static void signal_destroy_R (SignalNode *signal_node);
125 static inline HandlerList* handler_list_ensure (guint signal_id,
127 static inline HandlerList* handler_list_lookup (guint signal_id,
129 static inline Handler* handler_new (gboolean after);
130 static void handler_insert (guint signal_id,
133 static Handler* handler_lookup (gpointer instance,
137 static inline HandlerMatch* handler_match_prepend (HandlerMatch *list,
140 static inline HandlerMatch* handler_match_free1_R (HandlerMatch *node,
142 static HandlerMatch* handlers_find (gpointer instance,
143 GSignalMatchType mask,
149 gboolean one_and_only);
150 static inline void handler_ref (Handler *handler);
151 static inline void handler_unref_R (guint signal_id,
154 static gint handler_lists_cmp (gconstpointer node1,
155 gconstpointer node2);
156 static inline void emission_push (Emission **emission_list_p,
158 static inline void emission_pop (Emission **emission_list_p,
160 static inline Emission* emission_find (Emission *emission_list,
164 static gint class_closures_cmp (gconstpointer node1,
165 gconstpointer node2);
166 static gint signal_key_cmp (gconstpointer node1,
167 gconstpointer node2);
168 static gboolean signal_emit_unlocked_R (SignalNode *node,
171 GValue *return_value,
172 const GValue *instance_and_params);
173 static void add_invalid_closure_notify (Handler *handler,
175 static void remove_invalid_closure_notify (Handler *handler,
177 static void invalid_closure_notify (gpointer data,
179 static const gchar * type_debug_name (GType type);
180 static void node_check_deprecated (const SignalNode *node);
181 static void node_update_single_va_closure (SignalNode *node);
184 /* --- structures --- */
187 GSignalAccumulator func;
195 #define SIGNAL_HOOK(hook) ((SignalHook*) (hook))
199 /* permanent portion */
205 /* reinitializable portion */
208 guint single_va_closure_is_valid : 1;
209 guint single_va_closure_is_after : 1;
210 GType *param_types; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
211 GType return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
212 GBSearchArray *class_closure_bsa;
213 SignalAccumulator *accumulator;
214 GSignalCMarshaller c_marshaller;
215 GSignalCVaMarshaller va_marshaller;
216 GHookList *emission_hooks;
218 GClosure *single_va_closure;
221 #define SINGLE_VA_CLOSURE_EMPTY_MAGIC GINT_TO_POINTER(1) /* indicates single_va_closure is valid but empty */
234 GSignalInvocationHint ihint;
243 Handler *tail_before; /* normal signal handlers are appended here */
244 Handler *tail_after; /* CONNECT_AFTER handlers are appended here */
249 gulong sequential_number;
254 guint block_count : 16;
255 #define HANDLER_MAX_BLOCK_COUNT (1 << 16)
257 guint has_invalid_closure_notify : 1;
269 GType instance_type; /* 0 for default closure */
274 /* --- variables --- */
275 static GBSearchArray *g_signal_key_bsa = NULL;
276 static const GBSearchConfig g_signal_key_bconfig = {
279 G_BSEARCH_ARRAY_ALIGN_POWER2,
281 static GBSearchConfig g_signal_hlbsa_bconfig = {
282 sizeof (HandlerList),
286 static GBSearchConfig g_class_closure_bconfig = {
287 sizeof (ClassClosure),
291 static GHashTable *g_handler_list_bsa_ht = NULL;
292 static Emission *g_recursive_emissions = NULL;
293 static Emission *g_restart_emissions = NULL;
294 static gulong g_handler_sequential_number = 1;
295 G_LOCK_DEFINE_STATIC (g_signal_mutex);
296 #define SIGNAL_LOCK() G_LOCK (g_signal_mutex)
297 #define SIGNAL_UNLOCK() G_UNLOCK (g_signal_mutex)
300 /* --- signal nodes --- */
301 static guint g_n_signal_nodes = 0;
302 static SignalNode **g_signal_nodes = NULL;
304 static inline SignalNode*
305 LOOKUP_SIGNAL_NODE (register guint signal_id)
307 if (signal_id < g_n_signal_nodes)
308 return g_signal_nodes[signal_id];
314 /* --- functions --- */
316 signal_id_lookup (GQuark quark,
319 GType *ifaces, type = itype;
325 /* try looking up signals for this type and its ancestors */
328 SignalKey *signal_key;
331 signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
334 return signal_key->signal_id;
336 type = g_type_parent (type);
340 /* no luck, try interfaces it exports */
341 ifaces = g_type_interfaces (itype, &n_ifaces);
344 SignalKey *signal_key;
346 key.itype = ifaces[n_ifaces];
347 signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
352 return signal_key->signal_id;
361 class_closures_cmp (gconstpointer node1,
364 const ClassClosure *c1 = node1, *c2 = node2;
366 return G_BSEARCH_ARRAY_CMP (c1->instance_type, c2->instance_type);
370 handler_lists_cmp (gconstpointer node1,
373 const HandlerList *hlist1 = node1, *hlist2 = node2;
375 return G_BSEARCH_ARRAY_CMP (hlist1->signal_id, hlist2->signal_id);
378 static inline HandlerList*
379 handler_list_ensure (guint signal_id,
382 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
385 key.signal_id = signal_id;
387 key.tail_before = NULL;
388 key.tail_after = NULL;
391 hlbsa = g_bsearch_array_create (&g_signal_hlbsa_bconfig);
392 hlbsa = g_bsearch_array_insert (hlbsa, &g_signal_hlbsa_bconfig, &key);
393 g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
397 GBSearchArray *o = hlbsa;
399 hlbsa = g_bsearch_array_insert (o, &g_signal_hlbsa_bconfig, &key);
401 g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
403 return g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key);
406 static inline HandlerList*
407 handler_list_lookup (guint signal_id,
410 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
413 key.signal_id = signal_id;
415 return hlbsa ? g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key) : NULL;
419 handler_lookup (gpointer instance,
424 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
430 for (i = 0; i < hlbsa->n_nodes; i++)
432 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
435 for (handler = hlist->handlers; handler; handler = handler->next)
436 if (closure ? (handler->closure == closure) : (handler->sequential_number == handler_id))
439 *signal_id_p = hlist->signal_id;
449 static inline HandlerMatch*
450 handler_match_prepend (HandlerMatch *list,
456 node = g_slice_new (HandlerMatch);
457 node->handler = handler;
459 node->signal_id = signal_id;
460 handler_ref (handler);
464 static inline HandlerMatch*
465 handler_match_free1_R (HandlerMatch *node,
468 HandlerMatch *next = node->next;
470 handler_unref_R (node->signal_id, instance, node->handler);
471 g_slice_free (HandlerMatch, node);
477 handlers_find (gpointer instance,
478 GSignalMatchType mask,
484 gboolean one_and_only)
486 HandlerMatch *mlist = NULL;
488 if (mask & G_SIGNAL_MATCH_ID)
490 HandlerList *hlist = handler_list_lookup (signal_id, instance);
492 SignalNode *node = NULL;
494 if (mask & G_SIGNAL_MATCH_FUNC)
496 node = LOOKUP_SIGNAL_NODE (signal_id);
497 if (!node || !node->c_marshaller)
502 for (handler = hlist ? hlist->handlers : NULL; handler; handler = handler->next)
503 if (handler->sequential_number &&
504 ((mask & G_SIGNAL_MATCH_DETAIL) || handler->detail == detail) &&
505 ((mask & G_SIGNAL_MATCH_CLOSURE) || handler->closure == closure) &&
506 ((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
507 ((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
508 ((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
509 G_REAL_CLOSURE (handler->closure)->meta_marshal == NULL &&
510 ((GCClosure*) handler->closure)->callback == func)))
512 mlist = handler_match_prepend (mlist, handler, signal_id);
519 GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
526 for (i = 0; i < hlbsa->n_nodes; i++)
528 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
529 SignalNode *node = NULL;
532 if (!(mask & G_SIGNAL_MATCH_FUNC))
534 node = LOOKUP_SIGNAL_NODE (hlist->signal_id);
535 if (!node->c_marshaller)
539 for (handler = hlist->handlers; handler; handler = handler->next)
540 if (handler->sequential_number &&
541 ((mask & G_SIGNAL_MATCH_DETAIL) || handler->detail == detail) &&
542 ((mask & G_SIGNAL_MATCH_CLOSURE) || handler->closure == closure) &&
543 ((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
544 ((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
545 ((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
546 G_REAL_CLOSURE (handler->closure)->meta_marshal == NULL &&
547 ((GCClosure*) handler->closure)->callback == func)))
549 mlist = handler_match_prepend (mlist, handler, hlist->signal_id);
560 static inline Handler*
561 handler_new (gboolean after)
563 Handler *handler = g_slice_new (Handler);
564 #ifndef G_DISABLE_CHECKS
565 if (g_handler_sequential_number < 1)
566 g_error (G_STRLOC ": handler id overflow, %s", REPORT_BUG);
569 handler->sequential_number = g_handler_sequential_number++;
570 handler->prev = NULL;
571 handler->next = NULL;
573 handler->ref_count = 1;
574 handler->block_count = 0;
575 handler->after = after != FALSE;
576 handler->closure = NULL;
577 handler->has_invalid_closure_notify = 0;
583 handler_ref (Handler *handler)
585 g_return_if_fail (handler->ref_count > 0);
587 handler->ref_count++;
591 handler_unref_R (guint signal_id,
595 g_return_if_fail (handler->ref_count > 0);
597 handler->ref_count--;
599 if (G_UNLIKELY (handler->ref_count == 0))
601 HandlerList *hlist = NULL;
604 handler->next->prev = handler->prev;
605 if (handler->prev) /* watch out for g_signal_handlers_destroy()! */
606 handler->prev->next = handler->next;
609 hlist = handler_list_lookup (signal_id, instance);
610 hlist->handlers = handler->next;
615 /* check if we are removing the handler pointed to by tail_before */
616 if (!handler->after && (!handler->next || handler->next->after))
619 hlist = handler_list_lookup (signal_id, instance);
622 g_assert (hlist->tail_before == handler); /* paranoid */
623 hlist->tail_before = handler->prev;
627 /* check if we are removing the handler pointed to by tail_after */
631 hlist = handler_list_lookup (signal_id, instance);
634 g_assert (hlist->tail_after == handler); /* paranoid */
635 hlist->tail_after = handler->prev;
641 g_closure_unref (handler->closure);
643 g_slice_free (Handler, handler);
648 handler_insert (guint signal_id,
654 g_assert (handler->prev == NULL && handler->next == NULL); /* paranoid */
656 hlist = handler_list_ensure (signal_id, instance);
657 if (!hlist->handlers)
659 hlist->handlers = handler;
661 hlist->tail_before = handler;
663 else if (handler->after)
665 handler->prev = hlist->tail_after;
666 hlist->tail_after->next = handler;
670 if (hlist->tail_before)
672 handler->next = hlist->tail_before->next;
674 handler->next->prev = handler;
675 handler->prev = hlist->tail_before;
676 hlist->tail_before->next = handler;
678 else /* insert !after handler into a list of only after handlers */
680 handler->next = hlist->handlers;
682 handler->next->prev = handler;
683 hlist->handlers = handler;
685 hlist->tail_before = handler;
689 hlist->tail_after = handler;
693 node_update_single_va_closure (SignalNode *node)
695 GClosure *closure = NULL;
696 gboolean is_after = FALSE;
698 /* Fast path single-handler without boxing the arguments in GValues */
699 if (G_TYPE_IS_OBJECT (node->itype) &&
700 (node->flags & (G_SIGNAL_MUST_COLLECT)) == 0 &&
701 (node->emission_hooks == NULL || node->emission_hooks->hooks == NULL))
703 GSignalFlags run_type;
705 GBSearchArray *bsa = node->class_closure_bsa;
707 if (bsa == NULL || bsa->n_nodes == 0)
708 closure = SINGLE_VA_CLOSURE_EMPTY_MAGIC;
709 else if (bsa->n_nodes == 1)
711 /* Look for default class closure (can't support non-default as it
712 chains up using GValues */
713 cc = g_bsearch_array_get_nth (bsa, &g_class_closure_bconfig, 0);
714 if (cc->instance_type == 0)
716 run_type = node->flags & (G_SIGNAL_RUN_FIRST|G_SIGNAL_RUN_LAST|G_SIGNAL_RUN_CLEANUP);
717 /* Only support *one* of run-first or run-last, not multiple or cleanup */
718 if (run_type == G_SIGNAL_RUN_FIRST ||
719 run_type == G_SIGNAL_RUN_LAST)
721 closure = cc->closure;
722 is_after = (run_type == G_SIGNAL_RUN_LAST);
728 node->single_va_closure_is_valid = TRUE;
729 node->single_va_closure = closure;
730 node->single_va_closure_is_after = is_after;
734 emission_push (Emission **emission_list_p,
737 emission->next = *emission_list_p;
738 *emission_list_p = emission;
742 emission_pop (Emission **emission_list_p,
745 Emission *node, *last = NULL;
747 for (node = *emission_list_p; node; last = node, node = last->next)
748 if (node == emission)
751 last->next = node->next;
753 *emission_list_p = node->next;
756 g_assert_not_reached ();
759 static inline Emission*
760 emission_find (Emission *emission_list,
767 for (emission = emission_list; emission; emission = emission->next)
768 if (emission->instance == instance &&
769 emission->ihint.signal_id == signal_id &&
770 emission->ihint.detail == detail)
775 static inline Emission*
776 emission_find_innermost (gpointer instance)
778 Emission *emission, *s = NULL, *c = NULL;
780 for (emission = g_restart_emissions; emission; emission = emission->next)
781 if (emission->instance == instance)
786 for (emission = g_recursive_emissions; emission; emission = emission->next)
787 if (emission->instance == instance)
797 return G_HAVE_GROWING_STACK ? MAX (c, s) : MIN (c, s);
801 signal_key_cmp (gconstpointer node1,
804 const SignalKey *key1 = node1, *key2 = node2;
806 if (key1->itype == key2->itype)
807 return G_BSEARCH_ARRAY_CMP (key1->quark, key2->quark);
809 return G_BSEARCH_ARRAY_CMP (key1->itype, key2->itype);
813 _g_signal_init (void)
816 if (!g_n_signal_nodes)
818 /* setup handler list binary searchable array hash table (in german, that'd be one word ;) */
819 g_handler_list_bsa_ht = g_hash_table_new (g_direct_hash, NULL);
820 g_signal_key_bsa = g_bsearch_array_create (&g_signal_key_bconfig);
822 /* invalid (0) signal_id */
823 g_n_signal_nodes = 1;
824 g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
825 g_signal_nodes[0] = NULL;
831 _g_signals_destroy (GType itype)
836 for (i = 1; i < g_n_signal_nodes; i++)
838 SignalNode *node = g_signal_nodes[i];
840 if (node->itype == itype)
843 g_warning (G_STRLOC ": signal \"%s\" of type '%s' already destroyed",
845 type_debug_name (node->itype));
847 signal_destroy_R (node);
854 * g_signal_stop_emission:
855 * @instance: (type GObject.Object): the object whose signal handlers you wish to stop.
856 * @signal_id: the signal identifier, as returned by g_signal_lookup().
857 * @detail: the detail which the signal was emitted with.
859 * Stops a signal's current emission.
861 * This will prevent the default method from running, if the signal was
862 * %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
865 * Prints a warning if used on a signal which isn't being emitted.
868 g_signal_stop_emission (gpointer instance,
874 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
875 g_return_if_fail (signal_id > 0);
878 node = LOOKUP_SIGNAL_NODE (signal_id);
879 if (node && detail && !(node->flags & G_SIGNAL_DETAILED))
881 g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
885 if (node && g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
887 Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
888 Emission *emission = emission_find (emission_list, signal_id, detail, instance);
892 if (emission->state == EMISSION_HOOK)
893 g_warning (G_STRLOC ": emission of signal \"%s\" for instance '%p' cannot be stopped from emission hook",
894 node->name, instance);
895 else if (emission->state == EMISSION_RUN)
896 emission->state = EMISSION_STOP;
899 g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance '%p'",
900 node->name, instance);
903 g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
908 signal_finalize_hook (GHookList *hook_list,
911 GDestroyNotify destroy = hook->destroy;
915 hook->destroy = NULL;
917 destroy (hook->data);
923 * g_signal_add_emission_hook:
924 * @signal_id: the signal identifier, as returned by g_signal_lookup().
925 * @detail: the detail on which to call the hook.
926 * @hook_func: a #GSignalEmissionHook function.
927 * @hook_data: user data for @hook_func.
928 * @data_destroy: a #GDestroyNotify for @hook_data.
930 * Adds an emission hook for a signal, which will get called for any emission
931 * of that signal, independent of the instance. This is possible only
932 * for signals which don't have #G_SIGNAL_NO_HOOKS flag set.
934 * Returns: the hook id, for later use with g_signal_remove_emission_hook().
937 g_signal_add_emission_hook (guint signal_id,
939 GSignalEmissionHook hook_func,
941 GDestroyNotify data_destroy)
943 static gulong seq_hook_id = 1;
946 SignalHook *signal_hook;
948 g_return_val_if_fail (signal_id > 0, 0);
949 g_return_val_if_fail (hook_func != NULL, 0);
952 node = LOOKUP_SIGNAL_NODE (signal_id);
953 if (!node || node->destroyed)
955 g_warning ("%s: invalid signal id '%u'", G_STRLOC, signal_id);
959 if (node->flags & G_SIGNAL_NO_HOOKS)
961 g_warning ("%s: signal id '%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC, signal_id);
965 if (detail && !(node->flags & G_SIGNAL_DETAILED))
967 g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
971 node->single_va_closure_is_valid = FALSE;
972 if (!node->emission_hooks)
974 node->emission_hooks = g_new (GHookList, 1);
975 g_hook_list_init (node->emission_hooks, sizeof (SignalHook));
976 node->emission_hooks->finalize_hook = signal_finalize_hook;
979 node_check_deprecated (node);
981 hook = g_hook_alloc (node->emission_hooks);
982 hook->data = hook_data;
983 hook->func = (gpointer) hook_func;
984 hook->destroy = data_destroy;
985 signal_hook = SIGNAL_HOOK (hook);
986 signal_hook->detail = detail;
987 node->emission_hooks->seq_id = seq_hook_id;
988 g_hook_append (node->emission_hooks, hook);
989 seq_hook_id = node->emission_hooks->seq_id;
993 return hook->hook_id;
997 * g_signal_remove_emission_hook:
998 * @signal_id: the id of the signal
999 * @hook_id: the id of the emission hook, as returned by
1000 * g_signal_add_emission_hook()
1002 * Deletes an emission hook.
1005 g_signal_remove_emission_hook (guint signal_id,
1010 g_return_if_fail (signal_id > 0);
1011 g_return_if_fail (hook_id > 0);
1014 node = LOOKUP_SIGNAL_NODE (signal_id);
1015 if (!node || node->destroyed)
1017 g_warning ("%s: invalid signal id '%u'", G_STRLOC, signal_id);
1020 else if (!node->emission_hooks || !g_hook_destroy (node->emission_hooks, hook_id))
1021 g_warning ("%s: signal \"%s\" had no hook (%lu) to remove", G_STRLOC, node->name, hook_id);
1023 node->single_va_closure_is_valid = FALSE;
1030 signal_parse_name (const gchar *name,
1033 gboolean force_quark)
1035 const gchar *colon = strchr (name, ':');
1040 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1041 if (signal_id && detail_p)
1044 else if (colon[1] == ':')
1047 guint l = colon - name;
1051 memcpy (buffer, name, l);
1053 signal_id = signal_id_lookup (g_quark_try_string (buffer), itype);
1057 gchar *signal = g_new (gchar, l + 1);
1059 memcpy (signal, name, l);
1061 signal_id = signal_id_lookup (g_quark_try_string (signal), itype);
1065 if (signal_id && detail_p)
1066 *detail_p = colon[2] ? (force_quark ? g_quark_from_string : g_quark_try_string) (colon + 2) : 0;
1074 * g_signal_parse_name:
1075 * @detailed_signal: a string of the form "signal-name::detail".
1076 * @itype: The interface/instance type that introduced "signal-name".
1077 * @signal_id_p: (out): Location to store the signal id.
1078 * @detail_p: (out): Location to store the detail quark.
1079 * @force_detail_quark: %TRUE forces creation of a #GQuark for the detail.
1081 * Internal function to parse a signal name into its @signal_id
1082 * and @detail quark.
1084 * Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
1087 g_signal_parse_name (const gchar *detailed_signal,
1091 gboolean force_detail_quark)
1097 g_return_val_if_fail (detailed_signal != NULL, FALSE);
1098 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), FALSE);
1101 signal_id = signal_parse_name (detailed_signal, itype, &detail, force_detail_quark);
1104 node = signal_id ? LOOKUP_SIGNAL_NODE (signal_id) : NULL;
1105 if (!node || node->destroyed ||
1106 (detail && !(node->flags & G_SIGNAL_DETAILED)))
1110 *signal_id_p = signal_id;
1118 * g_signal_stop_emission_by_name:
1119 * @instance: (type GObject.Object): the object whose signal handlers you wish to stop.
1120 * @detailed_signal: a string of the form "signal-name::detail".
1122 * Stops a signal's current emission.
1124 * This is just like g_signal_stop_emission() except it will look up the
1125 * signal id for you.
1128 g_signal_stop_emission_by_name (gpointer instance,
1129 const gchar *detailed_signal)
1135 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1136 g_return_if_fail (detailed_signal != NULL);
1139 itype = G_TYPE_FROM_INSTANCE (instance);
1140 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
1143 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
1145 if (detail && !(node->flags & G_SIGNAL_DETAILED))
1146 g_warning ("%s: signal '%s' does not support details", G_STRLOC, detailed_signal);
1147 else if (!g_type_is_a (itype, node->itype))
1148 g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
1149 G_STRLOC, detailed_signal, instance, g_type_name (itype));
1152 Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
1153 Emission *emission = emission_find (emission_list, signal_id, detail, instance);
1157 if (emission->state == EMISSION_HOOK)
1158 g_warning (G_STRLOC ": emission of signal \"%s\" for instance '%p' cannot be stopped from emission hook",
1159 node->name, instance);
1160 else if (emission->state == EMISSION_RUN)
1161 emission->state = EMISSION_STOP;
1164 g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance '%p'",
1165 node->name, instance);
1169 g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
1170 G_STRLOC, detailed_signal, instance, g_type_name (itype));
1176 * @name: the signal's name.
1177 * @itype: the type that the signal operates on.
1179 * Given the name of the signal and the type of object it connects to, gets
1180 * the signal's identifying integer. Emitting the signal by number is
1181 * somewhat faster than using the name each time.
1183 * Also tries the ancestors of the given type.
1185 * See g_signal_new() for details on allowed signal names.
1187 * Returns: the signal's identifying number, or 0 if no signal was found.
1190 g_signal_lookup (const gchar *name,
1194 g_return_val_if_fail (name != NULL, 0);
1195 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1198 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1202 /* give elaborate warnings */
1203 if (!g_type_name (itype))
1204 g_warning (G_STRLOC ": unable to lookup signal \"%s\" for invalid type id '%"G_GSIZE_FORMAT"'",
1206 else if (!G_TYPE_IS_INSTANTIATABLE (itype))
1207 g_warning (G_STRLOC ": unable to lookup signal \"%s\" for non instantiatable type '%s'",
1208 name, g_type_name (itype));
1209 else if (!g_type_class_peek (itype))
1210 g_warning (G_STRLOC ": unable to lookup signal \"%s\" of unloaded type '%s'",
1211 name, g_type_name (itype));
1218 * g_signal_list_ids:
1219 * @itype: Instance or interface type.
1220 * @n_ids: Location to store the number of signal ids for @itype.
1222 * Lists the signals by id that a certain instance or interface type
1223 * created. Further information about the signals can be acquired through
1226 * Returns: (array length=n_ids): Newly allocated array of signal IDs.
1229 g_signal_list_ids (GType itype,
1237 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), NULL);
1238 g_return_val_if_fail (n_ids != NULL, NULL);
1241 keys = g_bsearch_array_get_nth (g_signal_key_bsa, &g_signal_key_bconfig, 0);
1242 n_nodes = g_bsearch_array_get_n_nodes (g_signal_key_bsa);
1243 result = g_array_new (FALSE, FALSE, sizeof (guint));
1245 for (i = 0; i < n_nodes; i++)
1246 if (keys[i].itype == itype)
1248 const gchar *name = g_quark_to_string (keys[i].quark);
1250 /* Signal names with "_" in them are aliases to the same
1251 * name with "-" instead of "_".
1253 if (!strchr (name, '_'))
1254 g_array_append_val (result, keys[i].signal_id);
1256 *n_ids = result->len;
1260 /* give elaborate warnings */
1261 if (!g_type_name (itype))
1262 g_warning (G_STRLOC ": unable to list signals for invalid type id '%"G_GSIZE_FORMAT"'",
1264 else if (!G_TYPE_IS_INSTANTIATABLE (itype) && !G_TYPE_IS_INTERFACE (itype))
1265 g_warning (G_STRLOC ": unable to list signals of non instantiatable type '%s'",
1266 g_type_name (itype));
1267 else if (!g_type_class_peek (itype) && !G_TYPE_IS_INTERFACE (itype))
1268 g_warning (G_STRLOC ": unable to list signals of unloaded type '%s'",
1269 g_type_name (itype));
1272 return (guint*) g_array_free (result, FALSE);
1277 * @signal_id: the signal's identifying number.
1279 * Given the signal's identifier, finds its name.
1281 * Two different signals may have the same name, if they have differing types.
1283 * Returns: the signal name, or %NULL if the signal number was invalid.
1286 g_signal_name (guint signal_id)
1292 node = LOOKUP_SIGNAL_NODE (signal_id);
1293 name = node ? node->name : NULL;
1296 return (char*) name;
1301 * @signal_id: The signal id of the signal to query information for.
1302 * @query: (out caller-allocates): A user provided structure that is
1303 * filled in with constant values upon success.
1305 * Queries the signal system for in-depth information about a
1306 * specific signal. This function will fill in a user-provided
1307 * structure to hold signal-specific information. If an invalid
1308 * signal id is passed in, the @signal_id member of the #GSignalQuery
1309 * is 0. All members filled into the #GSignalQuery structure should
1310 * be considered constant and have to be left untouched.
1313 g_signal_query (guint signal_id,
1314 GSignalQuery *query)
1318 g_return_if_fail (query != NULL);
1321 node = LOOKUP_SIGNAL_NODE (signal_id);
1322 if (!node || node->destroyed)
1323 query->signal_id = 0;
1326 query->signal_id = node->signal_id;
1327 query->signal_name = node->name;
1328 query->itype = node->itype;
1329 query->signal_flags = node->flags;
1330 query->return_type = node->return_type;
1331 query->n_params = node->n_params;
1332 query->param_types = node->param_types;
1339 * @signal_name: the name for the signal
1340 * @itype: the type this signal pertains to. It will also pertain to
1341 * types which are derived from this type.
1342 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1343 * the default handler is to be invoked. You should at least specify
1344 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1345 * @class_offset: The offset of the function pointer in the class structure
1346 * for this type. Used to invoke a class method generically. Pass 0 to
1347 * not associate a class method slot with this signal.
1348 * @accumulator: the accumulator for this signal; may be %NULL.
1349 * @accu_data: user data for the @accumulator.
1350 * @c_marshaller: (allow-none): the function to translate arrays of parameter
1351 * values to signal emissions into C language callback invocations or %NULL.
1352 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1353 * without a return value.
1354 * @n_params: the number of parameter types to follow.
1355 * @...: a list of types, one for each parameter.
1357 * Creates a new signal. (This is usually done in the class initializer.)
1359 * A signal name consists of segments consisting of ASCII letters and
1360 * digits, separated by either the '-' or '_' character. The first
1361 * character of a signal name must be a letter. Names which violate these
1362 * rules lead to undefined behaviour of the GSignal system.
1364 * When registering a signal and looking up a signal, either separator can
1365 * be used, but they cannot be mixed.
1367 * If 0 is used for @class_offset subclasses cannot override the class handler
1368 * in their <code>class_init</code> method by doing
1369 * <code>super_class->signal_handler = my_signal_handler</code>. Instead they
1370 * will have to use g_signal_override_class_handler().
1372 * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
1373 * the marshaller for this signal.
1375 * Returns: the signal id
1378 g_signal_new (const gchar *signal_name,
1380 GSignalFlags signal_flags,
1382 GSignalAccumulator accumulator,
1384 GSignalCMarshaller c_marshaller,
1392 g_return_val_if_fail (signal_name != NULL, 0);
1394 va_start (args, n_params);
1396 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1397 class_offset ? g_signal_type_cclosure_new (itype, class_offset) : NULL,
1398 accumulator, accu_data, c_marshaller,
1399 return_type, n_params, args);
1407 * g_signal_new_class_handler:
1408 * @signal_name: the name for the signal
1409 * @itype: the type this signal pertains to. It will also pertain to
1410 * types which are derived from this type.
1411 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1412 * the default handler is to be invoked. You should at least specify
1413 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1414 * @class_handler: a #GCallback which acts as class implementation of
1415 * this signal. Used to invoke a class method generically. Pass %NULL to
1416 * not associate a class method with this signal.
1417 * @accumulator: the accumulator for this signal; may be %NULL.
1418 * @accu_data: user data for the @accumulator.
1419 * @c_marshaller: (allow-none): the function to translate arrays of parameter
1420 * values to signal emissions into C language callback invocations or %NULL.
1421 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1422 * without a return value.
1423 * @n_params: the number of parameter types to follow.
1424 * @...: a list of types, one for each parameter.
1426 * Creates a new signal. (This is usually done in the class initializer.)
1428 * This is a variant of g_signal_new() that takes a C callback instead
1429 * off a class offset for the signal's class handler. This function
1430 * doesn't need a function pointer exposed in the class structure of
1431 * an object definition, instead the function pointer is passed
1432 * directly and can be overriden by derived classes with
1433 * g_signal_override_class_closure() or
1434 * g_signal_override_class_handler()and chained to with
1435 * g_signal_chain_from_overridden() or
1436 * g_signal_chain_from_overridden_handler().
1438 * See g_signal_new() for information about signal names.
1440 * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
1441 * the marshaller for this signal.
1443 * Returns: the signal id
1448 g_signal_new_class_handler (const gchar *signal_name,
1450 GSignalFlags signal_flags,
1451 GCallback class_handler,
1452 GSignalAccumulator accumulator,
1454 GSignalCMarshaller c_marshaller,
1462 g_return_val_if_fail (signal_name != NULL, 0);
1464 va_start (args, n_params);
1466 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1467 class_handler ? g_cclosure_new (class_handler, NULL, NULL) : NULL,
1468 accumulator, accu_data, c_marshaller,
1469 return_type, n_params, args);
1476 static inline ClassClosure*
1477 signal_find_class_closure (SignalNode *node,
1480 GBSearchArray *bsa = node->class_closure_bsa;
1487 /* cc->instance_type is 0 for default closure */
1489 key.instance_type = itype;
1490 cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1491 while (!cc && key.instance_type)
1493 key.instance_type = g_type_parent (key.instance_type);
1494 cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1502 static inline GClosure*
1503 signal_lookup_closure (SignalNode *node,
1504 GTypeInstance *instance)
1508 if (node->class_closure_bsa && g_bsearch_array_get_n_nodes (node->class_closure_bsa) == 1)
1510 cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
1511 if (cc && cc->instance_type == 0) /* check for default closure */
1514 cc = signal_find_class_closure (node, G_TYPE_FROM_INSTANCE (instance));
1515 return cc ? cc->closure : NULL;
1519 signal_add_class_closure (SignalNode *node,
1525 node->single_va_closure_is_valid = FALSE;
1527 if (!node->class_closure_bsa)
1528 node->class_closure_bsa = g_bsearch_array_create (&g_class_closure_bconfig);
1529 key.instance_type = itype;
1530 key.closure = g_closure_ref (closure);
1531 node->class_closure_bsa = g_bsearch_array_insert (node->class_closure_bsa,
1532 &g_class_closure_bconfig,
1534 g_closure_sink (closure);
1535 if (node->c_marshaller && closure && G_CLOSURE_NEEDS_MARSHAL (closure))
1537 g_closure_set_marshal (closure, node->c_marshaller);
1538 if (node->va_marshaller)
1539 _g_closure_set_va_marshal (closure, node->va_marshaller);
1545 * @signal_name: the name for the signal
1546 * @itype: the type this signal pertains to. It will also pertain to
1547 * types which are derived from this type
1548 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1549 * the default handler is to be invoked. You should at least specify
1550 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
1551 * @class_closure: (allow-none): The closure to invoke on signal emission;
1553 * @accumulator: (allow-none): the accumulator for this signal; may be %NULL
1554 * @accu_data: user data for the @accumulator
1555 * @c_marshaller: (allow-none): the function to translate arrays of
1556 * parameter values to signal emissions into C language callback
1557 * invocations or %NULL
1558 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1559 * without a return value
1560 * @n_params: the length of @param_types
1561 * @param_types: (array length=n_params): an array of types, one for
1564 * Creates a new signal. (This is usually done in the class initializer.)
1566 * See g_signal_new() for details on allowed signal names.
1568 * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
1569 * the marshaller for this signal.
1571 * Returns: the signal id
1574 g_signal_newv (const gchar *signal_name,
1576 GSignalFlags signal_flags,
1577 GClosure *class_closure,
1578 GSignalAccumulator accumulator,
1580 GSignalCMarshaller c_marshaller,
1588 GSignalCMarshaller builtin_c_marshaller;
1589 GSignalCVaMarshaller va_marshaller;
1591 g_return_val_if_fail (signal_name != NULL, 0);
1592 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1594 g_return_val_if_fail (param_types != NULL, 0);
1595 g_return_val_if_fail ((return_type & G_SIGNAL_TYPE_STATIC_SCOPE) == 0, 0);
1596 if (return_type == (G_TYPE_NONE & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1597 g_return_val_if_fail (accumulator == NULL, 0);
1599 g_return_val_if_fail (accu_data == NULL, 0);
1601 name = g_strdup (signal_name);
1602 g_strdelimit (name, G_STR_DELIMITERS ":^", '_'); /* FIXME do character checks like for types */
1606 signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1607 node = LOOKUP_SIGNAL_NODE (signal_id);
1608 if (node && !node->destroyed)
1610 g_warning (G_STRLOC ": signal \"%s\" already exists in the '%s' %s",
1612 type_debug_name (node->itype),
1613 G_TYPE_IS_INTERFACE (node->itype) ? "interface" : "class ancestry");
1618 if (node && node->itype != itype)
1620 g_warning (G_STRLOC ": signal \"%s\" for type '%s' was previously created for type '%s'",
1622 type_debug_name (itype),
1623 type_debug_name (node->itype));
1628 for (i = 0; i < n_params; i++)
1629 if (!G_TYPE_IS_VALUE (param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1631 g_warning (G_STRLOC ": parameter %d of type '%s' for signal \"%s::%s\" is not a value type",
1632 i + 1, type_debug_name (param_types[i]), type_debug_name (itype), name);
1637 if (return_type != G_TYPE_NONE && !G_TYPE_IS_VALUE (return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1639 g_warning (G_STRLOC ": return value of type '%s' for signal \"%s::%s\" is not a value type",
1640 type_debug_name (return_type), type_debug_name (itype), name);
1645 if (return_type != G_TYPE_NONE &&
1646 (signal_flags & (G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST | G_SIGNAL_RUN_CLEANUP)) == G_SIGNAL_RUN_FIRST)
1648 g_warning (G_STRLOC ": signal \"%s::%s\" has return type '%s' and is only G_SIGNAL_RUN_FIRST",
1649 type_debug_name (itype), name, type_debug_name (return_type));
1655 /* setup permanent portion of signal node */
1660 signal_id = g_n_signal_nodes++;
1661 node = g_new (SignalNode, 1);
1662 node->signal_id = signal_id;
1663 g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
1664 g_signal_nodes[signal_id] = node;
1665 node->itype = itype;
1668 key.quark = g_quark_from_string (node->name);
1669 key.signal_id = signal_id;
1670 g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1671 g_strdelimit (name, "_", '-');
1672 node->name = g_intern_string (name);
1673 key.quark = g_quark_from_string (name);
1674 g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1676 TRACE(GOBJECT_SIGNAL_NEW(signal_id, name, itype));
1678 node->destroyed = FALSE;
1680 /* setup reinitializable portion */
1681 node->single_va_closure_is_valid = FALSE;
1682 node->flags = signal_flags & G_SIGNAL_FLAGS_MASK;
1683 node->n_params = n_params;
1684 node->param_types = g_memdup (param_types, sizeof (GType) * n_params);
1685 node->return_type = return_type;
1686 node->class_closure_bsa = NULL;
1689 node->accumulator = g_new (SignalAccumulator, 1);
1690 node->accumulator->func = accumulator;
1691 node->accumulator->data = accu_data;
1694 node->accumulator = NULL;
1696 builtin_c_marshaller = NULL;
1697 va_marshaller = NULL;
1699 /* Pick up built-in va marshallers for standard types, and
1700 instead of generic marshaller if no marshaller specified */
1701 if (n_params == 0 && return_type == G_TYPE_NONE)
1703 builtin_c_marshaller = g_cclosure_marshal_VOID__VOID;
1704 va_marshaller = g_cclosure_marshal_VOID__VOIDv;
1706 else if (n_params == 1 && return_type == G_TYPE_NONE)
1708 #define ADD_CHECK(__type__) \
1709 else if (g_type_is_a (param_types[0] & ~G_SIGNAL_TYPE_STATIC_SCOPE, G_TYPE_ ##__type__)) \
1711 builtin_c_marshaller = g_cclosure_marshal_VOID__ ## __type__; \
1712 va_marshaller = g_cclosure_marshal_VOID__ ## __type__ ##v; \
1735 if (c_marshaller == NULL)
1737 if (builtin_c_marshaller)
1738 c_marshaller = builtin_c_marshaller;
1741 c_marshaller = g_cclosure_marshal_generic;
1742 va_marshaller = g_cclosure_marshal_generic_va;
1746 node->c_marshaller = c_marshaller;
1747 node->va_marshaller = va_marshaller;
1748 node->emission_hooks = NULL;
1750 signal_add_class_closure (node, 0, class_closure);
1760 g_signal_set_va_marshaller (guint signal_id,
1761 GType instance_type,
1762 GSignalCVaMarshaller va_marshaller)
1766 g_return_if_fail (signal_id > 0);
1767 g_return_if_fail (va_marshaller != NULL);
1770 node = LOOKUP_SIGNAL_NODE (signal_id);
1773 node->va_marshaller = va_marshaller;
1774 if (node->class_closure_bsa)
1776 ClassClosure *cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
1777 if (cc->closure->marshal == node->c_marshaller)
1778 _g_closure_set_va_marshal (cc->closure, va_marshaller);
1781 node->single_va_closure_is_valid = FALSE;
1789 * g_signal_new_valist:
1790 * @signal_name: the name for the signal
1791 * @itype: the type this signal pertains to. It will also pertain to
1792 * types which are derived from this type.
1793 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1794 * the default handler is to be invoked. You should at least specify
1795 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1796 * @class_closure: The closure to invoke on signal emission; may be %NULL.
1797 * @accumulator: the accumulator for this signal; may be %NULL.
1798 * @accu_data: user data for the @accumulator.
1799 * @c_marshaller: (allow-none): the function to translate arrays of parameter
1800 * values to signal emissions into C language callback invocations or %NULL.
1801 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1802 * without a return value.
1803 * @n_params: the number of parameter types in @args.
1804 * @args: va_list of #GType, one for each parameter.
1806 * Creates a new signal. (This is usually done in the class initializer.)
1808 * See g_signal_new() for details on allowed signal names.
1810 * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
1811 * the marshaller for this signal.
1813 * Returns: the signal id
1816 g_signal_new_valist (const gchar *signal_name,
1818 GSignalFlags signal_flags,
1819 GClosure *class_closure,
1820 GSignalAccumulator accumulator,
1822 GSignalCMarshaller c_marshaller,
1833 param_types = g_new (GType, n_params);
1835 for (i = 0; i < n_params; i++)
1836 param_types[i] = va_arg (args, GType);
1841 signal_id = g_signal_newv (signal_name, itype, signal_flags,
1842 class_closure, accumulator, accu_data, c_marshaller,
1843 return_type, n_params, param_types);
1844 g_free (param_types);
1850 signal_destroy_R (SignalNode *signal_node)
1852 SignalNode node = *signal_node;
1854 signal_node->destroyed = TRUE;
1856 /* reentrancy caution, zero out real contents first */
1857 signal_node->single_va_closure_is_valid = FALSE;
1858 signal_node->n_params = 0;
1859 signal_node->param_types = NULL;
1860 signal_node->return_type = 0;
1861 signal_node->class_closure_bsa = NULL;
1862 signal_node->accumulator = NULL;
1863 signal_node->c_marshaller = NULL;
1864 signal_node->va_marshaller = NULL;
1865 signal_node->emission_hooks = NULL;
1867 #ifdef G_ENABLE_DEBUG
1868 /* check current emissions */
1872 for (emission = (node.flags & G_SIGNAL_NO_RECURSE) ? g_restart_emissions : g_recursive_emissions;
1873 emission; emission = emission->next)
1874 if (emission->ihint.signal_id == node.signal_id)
1875 g_critical (G_STRLOC ": signal \"%s\" being destroyed is currently in emission (instance '%p')",
1876 node.name, emission->instance);
1880 /* free contents that need to
1883 g_free (node.param_types);
1884 if (node.class_closure_bsa)
1888 for (i = 0; i < node.class_closure_bsa->n_nodes; i++)
1890 ClassClosure *cc = g_bsearch_array_get_nth (node.class_closure_bsa, &g_class_closure_bconfig, i);
1892 g_closure_unref (cc->closure);
1894 g_bsearch_array_free (node.class_closure_bsa, &g_class_closure_bconfig);
1896 g_free (node.accumulator);
1897 if (node.emission_hooks)
1899 g_hook_list_clear (node.emission_hooks);
1900 g_free (node.emission_hooks);
1906 * g_signal_override_class_closure:
1907 * @signal_id: the signal id
1908 * @instance_type: the instance type on which to override the class closure
1910 * @class_closure: the closure.
1912 * Overrides the class closure (i.e. the default handler) for the given signal
1913 * for emissions on instances of @instance_type. @instance_type must be derived
1914 * from the type to which the signal belongs.
1916 * See g_signal_chain_from_overridden() and
1917 * g_signal_chain_from_overridden_handler() for how to chain up to the
1918 * parent class closure from inside the overridden one.
1921 g_signal_override_class_closure (guint signal_id,
1922 GType instance_type,
1923 GClosure *class_closure)
1927 g_return_if_fail (signal_id > 0);
1928 g_return_if_fail (class_closure != NULL);
1931 node = LOOKUP_SIGNAL_NODE (signal_id);
1932 node_check_deprecated (node);
1933 if (!g_type_is_a (instance_type, node->itype))
1934 g_warning ("%s: type '%s' cannot be overridden for signal id '%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1937 ClassClosure *cc = signal_find_class_closure (node, instance_type);
1939 if (cc && cc->instance_type == instance_type)
1940 g_warning ("%s: type '%s' is already overridden for signal id '%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1942 signal_add_class_closure (node, instance_type, class_closure);
1948 * g_signal_override_class_handler:
1949 * @signal_name: the name for the signal
1950 * @instance_type: the instance type on which to override the class handler
1952 * @class_handler: the handler.
1954 * Overrides the class closure (i.e. the default handler) for the
1955 * given signal for emissions on instances of @instance_type with
1956 * callback @class_handler. @instance_type must be derived from the
1957 * type to which the signal belongs.
1959 * See g_signal_chain_from_overridden() and
1960 * g_signal_chain_from_overridden_handler() for how to chain up to the
1961 * parent class closure from inside the overridden one.
1966 g_signal_override_class_handler (const gchar *signal_name,
1967 GType instance_type,
1968 GCallback class_handler)
1972 g_return_if_fail (signal_name != NULL);
1973 g_return_if_fail (instance_type != G_TYPE_NONE);
1974 g_return_if_fail (class_handler != NULL);
1976 signal_id = g_signal_lookup (signal_name, instance_type);
1979 g_signal_override_class_closure (signal_id, instance_type,
1980 g_cclosure_new (class_handler, NULL, NULL));
1982 g_warning ("%s: signal name '%s' is invalid for type id '%"G_GSIZE_FORMAT"'",
1983 G_STRLOC, signal_name, instance_type);
1988 * g_signal_chain_from_overridden:
1989 * @instance_and_params: (array) the argument list of the signal emission.
1990 * The first element in the array is a #GValue for the instance the signal
1991 * is being emitted on. The rest are any arguments to be passed to the signal.
1992 * @return_value: Location for the return value.
1994 * Calls the original class closure of a signal. This function should only
1995 * be called from an overridden class closure; see
1996 * g_signal_override_class_closure() and
1997 * g_signal_override_class_handler().
2000 g_signal_chain_from_overridden (const GValue *instance_and_params,
2001 GValue *return_value)
2003 GType chain_type = 0, restore_type = 0;
2004 Emission *emission = NULL;
2005 GClosure *closure = NULL;
2009 g_return_if_fail (instance_and_params != NULL);
2010 instance = g_value_peek_pointer (instance_and_params);
2011 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2014 emission = emission_find_innermost (instance);
2017 SignalNode *node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
2019 g_assert (node != NULL); /* paranoid */
2021 /* we should probably do the same parameter checks as g_signal_emit() here.
2023 if (emission->chain_type != G_TYPE_NONE)
2025 ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
2027 g_assert (cc != NULL); /* closure currently in call stack */
2029 n_params = node->n_params;
2030 restore_type = cc->instance_type;
2031 cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
2032 if (cc && cc->instance_type != restore_type)
2034 closure = cc->closure;
2035 chain_type = cc->instance_type;
2039 g_warning ("%s: signal id '%u' cannot be chained from current emission stage for instance '%p'", G_STRLOC, node->signal_id, instance);
2042 g_warning ("%s: no signal is currently being emitted for instance '%p'", G_STRLOC, instance);
2046 emission->chain_type = chain_type;
2048 g_closure_invoke (closure,
2051 instance_and_params,
2054 emission->chain_type = restore_type;
2060 * g_signal_chain_from_overridden_handler: (skip)
2061 * @instance: the instance the signal is being emitted on.
2062 * @...: parameters to be passed to the parent class closure, followed by a
2063 * location for the return value. If the return type of the signal
2064 * is #G_TYPE_NONE, the return value location can be omitted.
2066 * Calls the original class closure of a signal. This function should
2067 * only be called from an overridden class closure; see
2068 * g_signal_override_class_closure() and
2069 * g_signal_override_class_handler().
2074 g_signal_chain_from_overridden_handler (gpointer instance,
2077 GType chain_type = 0, restore_type = 0;
2078 Emission *emission = NULL;
2079 GClosure *closure = NULL;
2083 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2086 emission = emission_find_innermost (instance);
2089 node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
2091 g_assert (node != NULL); /* paranoid */
2093 /* we should probably do the same parameter checks as g_signal_emit() here.
2095 if (emission->chain_type != G_TYPE_NONE)
2097 ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
2099 g_assert (cc != NULL); /* closure currently in call stack */
2101 n_params = node->n_params;
2102 restore_type = cc->instance_type;
2103 cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
2104 if (cc && cc->instance_type != restore_type)
2106 closure = cc->closure;
2107 chain_type = cc->instance_type;
2111 g_warning ("%s: signal id '%u' cannot be chained from current emission stage for instance '%p'", G_STRLOC, node->signal_id, instance);
2114 g_warning ("%s: no signal is currently being emitted for instance '%p'", G_STRLOC, instance);
2118 GValue *instance_and_params;
2119 GType signal_return_type;
2120 GValue *param_values;
2124 va_start (var_args, instance);
2126 signal_return_type = node->return_type;
2127 instance_and_params = g_alloca (sizeof (GValue) * (n_params + 1));
2128 memset (instance_and_params, 0, sizeof (GValue) * (n_params + 1));
2129 param_values = instance_and_params + 1;
2131 for (i = 0; i < node->n_params; i++)
2134 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2135 gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
2138 G_VALUE_COLLECT_INIT (param_values + i, ptype,
2140 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2144 g_warning ("%s: %s", G_STRLOC, error);
2147 /* we purposely leak the value here, it might not be
2148 * in a sane state if an error condition occoured
2151 g_value_unset (param_values + i);
2160 instance_and_params->g_type = 0;
2161 g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
2162 g_value_set_instance (instance_and_params, instance);
2165 emission->chain_type = chain_type;
2168 if (signal_return_type == G_TYPE_NONE)
2170 g_closure_invoke (closure,
2173 instance_and_params,
2178 GValue return_value = G_VALUE_INIT;
2179 gchar *error = NULL;
2180 GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2181 gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
2183 g_value_init (&return_value, rtype);
2185 g_closure_invoke (closure,
2188 instance_and_params,
2191 G_VALUE_LCOPY (&return_value,
2193 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2197 g_value_unset (&return_value);
2201 g_warning ("%s: %s", G_STRLOC, error);
2204 /* we purposely leak the value here, it might not be
2205 * in a sane state if an error condition occurred
2210 for (i = 0; i < n_params; i++)
2211 g_value_unset (param_values + i);
2212 g_value_unset (instance_and_params);
2217 emission->chain_type = restore_type;
2223 * g_signal_get_invocation_hint:
2224 * @instance: (type GObject.Object): the instance to query
2226 * Returns the invocation hint of the innermost signal emission of instance.
2228 * Returns: (transfer none): the invocation hint of the innermost signal emission.
2230 GSignalInvocationHint*
2231 g_signal_get_invocation_hint (gpointer instance)
2233 Emission *emission = NULL;
2235 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), NULL);
2238 emission = emission_find_innermost (instance);
2241 return emission ? &emission->ihint : NULL;
2245 * g_signal_connect_closure_by_id:
2246 * @instance: (type GObject.Object): the instance to connect to.
2247 * @signal_id: the id of the signal.
2248 * @detail: the detail.
2249 * @closure: the closure to connect.
2250 * @after: whether the handler should be called before or after the
2251 * default handler of the signal.
2253 * Connects a closure to a signal for a particular object.
2255 * Returns: the handler id (always greater than 0 for successful connections)
2258 g_signal_connect_closure_by_id (gpointer instance,
2265 gulong handler_seq_no = 0;
2267 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2268 g_return_val_if_fail (signal_id > 0, 0);
2269 g_return_val_if_fail (closure != NULL, 0);
2272 node = LOOKUP_SIGNAL_NODE (signal_id);
2275 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2276 g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2277 else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2278 g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
2281 Handler *handler = handler_new (after);
2283 handler_seq_no = handler->sequential_number;
2284 handler->detail = detail;
2285 handler->closure = g_closure_ref (closure);
2286 g_closure_sink (closure);
2287 add_invalid_closure_notify (handler, instance);
2288 handler_insert (signal_id, instance, handler);
2289 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (closure))
2291 g_closure_set_marshal (closure, node->c_marshaller);
2292 if (node->va_marshaller)
2293 _g_closure_set_va_marshal (closure, node->va_marshaller);
2298 g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
2301 return handler_seq_no;
2305 * g_signal_connect_closure:
2306 * @instance: (type GObject.Object): the instance to connect to.
2307 * @detailed_signal: a string of the form "signal-name::detail".
2308 * @closure: the closure to connect.
2309 * @after: whether the handler should be called before or after the
2310 * default handler of the signal.
2312 * Connects a closure to a signal for a particular object.
2314 * Returns: the handler id (always greater than 0 for successful connections)
2317 g_signal_connect_closure (gpointer instance,
2318 const gchar *detailed_signal,
2323 gulong handler_seq_no = 0;
2327 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2328 g_return_val_if_fail (detailed_signal != NULL, 0);
2329 g_return_val_if_fail (closure != NULL, 0);
2332 itype = G_TYPE_FROM_INSTANCE (instance);
2333 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2336 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2338 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2339 g_warning ("%s: signal '%s' does not support details", G_STRLOC, detailed_signal);
2340 else if (!g_type_is_a (itype, node->itype))
2341 g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
2342 G_STRLOC, detailed_signal, instance, g_type_name (itype));
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 add_invalid_closure_notify (handler, instance);
2352 handler_insert (signal_id, instance, handler);
2353 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2355 g_closure_set_marshal (handler->closure, node->c_marshaller);
2356 if (node->va_marshaller)
2357 _g_closure_set_va_marshal (handler->closure, node->va_marshaller);
2362 g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
2363 G_STRLOC, detailed_signal, instance, g_type_name (itype));
2366 return handler_seq_no;
2370 node_check_deprecated (const SignalNode *node)
2372 static const gchar * g_enable_diagnostic = NULL;
2374 if (G_UNLIKELY (!g_enable_diagnostic))
2376 g_enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
2377 if (!g_enable_diagnostic)
2378 g_enable_diagnostic = "0";
2381 if (g_enable_diagnostic[0] == '1')
2383 if (node->flags & G_SIGNAL_DEPRECATED)
2385 g_warning ("The signal %s::%s is deprecated and shouldn't be used "
2386 "anymore. It will be removed in a future version.",
2387 type_debug_name (node->itype), node->name);
2393 * g_signal_connect_data:
2394 * @instance: (type GObject.Object): the instance to connect to.
2395 * @detailed_signal: a string of the form "signal-name::detail".
2396 * @c_handler: the #GCallback to connect.
2397 * @data: data to pass to @c_handler calls.
2398 * @destroy_data: a #GClosureNotify for @data.
2399 * @connect_flags: a combination of #GConnectFlags.
2401 * Connects a #GCallback function to a signal for a particular object. Similar
2402 * to g_signal_connect(), but allows to provide a #GClosureNotify for the data
2403 * which will be called when the signal handler is disconnected and no longer
2404 * used. Specify @connect_flags if you need <literal>..._after()</literal> or
2405 * <literal>..._swapped()</literal> variants of this function.
2407 * Returns: the handler id (always greater than 0 for successful connections)
2410 g_signal_connect_data (gpointer instance,
2411 const gchar *detailed_signal,
2412 GCallback c_handler,
2414 GClosureNotify destroy_data,
2415 GConnectFlags connect_flags)
2418 gulong handler_seq_no = 0;
2421 gboolean swapped, after;
2423 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2424 g_return_val_if_fail (detailed_signal != NULL, 0);
2425 g_return_val_if_fail (c_handler != NULL, 0);
2427 swapped = (connect_flags & G_CONNECT_SWAPPED) != FALSE;
2428 after = (connect_flags & G_CONNECT_AFTER) != FALSE;
2431 itype = G_TYPE_FROM_INSTANCE (instance);
2432 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2435 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2437 node_check_deprecated (node);
2439 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2440 g_warning ("%s: signal '%s' does not support details", G_STRLOC, detailed_signal);
2441 else if (!g_type_is_a (itype, node->itype))
2442 g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
2443 G_STRLOC, detailed_signal, instance, g_type_name (itype));
2446 Handler *handler = handler_new (after);
2448 handler_seq_no = handler->sequential_number;
2449 handler->detail = detail;
2450 handler->closure = g_closure_ref ((swapped ? g_cclosure_new_swap : g_cclosure_new) (c_handler, data, destroy_data));
2451 g_closure_sink (handler->closure);
2452 handler_insert (signal_id, instance, handler);
2453 if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2455 g_closure_set_marshal (handler->closure, node->c_marshaller);
2456 if (node->va_marshaller)
2457 _g_closure_set_va_marshal (handler->closure, node->va_marshaller);
2462 g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
2463 G_STRLOC, detailed_signal, instance, g_type_name (itype));
2466 return handler_seq_no;
2470 * g_signal_handler_block:
2471 * @instance: (type GObject.Object): The instance to block the signal handler of.
2472 * @handler_id: Handler id of the handler to be blocked.
2474 * Blocks a handler of an instance so it will not be called during any
2475 * signal emissions unless it is unblocked again. Thus "blocking" a
2476 * signal handler means to temporarily deactive it, a signal handler
2477 * has to be unblocked exactly the same amount of times it has been
2478 * blocked before to become active again.
2480 * The @handler_id has to be a valid signal handler id, connected to a
2481 * signal of @instance.
2484 g_signal_handler_block (gpointer instance,
2489 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2490 g_return_if_fail (handler_id > 0);
2493 handler = handler_lookup (instance, handler_id, NULL, NULL);
2496 #ifndef G_DISABLE_CHECKS
2497 if (handler->block_count >= HANDLER_MAX_BLOCK_COUNT - 1)
2498 g_error (G_STRLOC ": handler block_count overflow, %s", REPORT_BUG);
2500 handler->block_count += 1;
2503 g_warning ("%s: instance '%p' has no handler with id '%lu'", G_STRLOC, instance, handler_id);
2508 * g_signal_handler_unblock:
2509 * @instance: (type GObject.Object): The instance to unblock the signal handler of.
2510 * @handler_id: Handler id of the handler to be unblocked.
2512 * Undoes the effect of a previous g_signal_handler_block() call. A
2513 * blocked handler is skipped during signal emissions and will not be
2514 * invoked, unblocking it (for exactly the amount of times it has been
2515 * blocked before) reverts its "blocked" state, so the handler will be
2516 * recognized by the signal system and is called upon future or
2517 * currently ongoing signal emissions (since the order in which
2518 * handlers are called during signal emissions is deterministic,
2519 * whether the unblocked handler in question is called as part of a
2520 * currently ongoing emission depends on how far that emission has
2523 * The @handler_id has to be a valid id of a signal handler that is
2524 * connected to a signal of @instance and is currently blocked.
2527 g_signal_handler_unblock (gpointer instance,
2532 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2533 g_return_if_fail (handler_id > 0);
2536 handler = handler_lookup (instance, handler_id, NULL, NULL);
2539 if (handler->block_count)
2540 handler->block_count -= 1;
2542 g_warning (G_STRLOC ": handler '%lu' of instance '%p' is not blocked", handler_id, instance);
2545 g_warning ("%s: instance '%p' has no handler with id '%lu'", G_STRLOC, instance, handler_id);
2550 * g_signal_handler_disconnect:
2551 * @instance: (type GObject.Object): The instance to remove the signal handler from.
2552 * @handler_id: Handler id of the handler to be disconnected.
2554 * Disconnects a handler from an instance so it will not be called during
2555 * any future or currently ongoing emissions of the signal it has been
2556 * connected to. The @handler_id becomes invalid and may be reused.
2558 * The @handler_id has to be a valid signal handler id, connected to a
2559 * signal of @instance.
2562 g_signal_handler_disconnect (gpointer instance,
2568 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2569 g_return_if_fail (handler_id > 0);
2572 handler = handler_lookup (instance, handler_id, NULL, &signal_id);
2575 handler->sequential_number = 0;
2576 handler->block_count = 1;
2577 remove_invalid_closure_notify (handler, instance);
2578 handler_unref_R (signal_id, instance, handler);
2581 g_warning ("%s: instance '%p' has no handler with id '%lu'", G_STRLOC, instance, handler_id);
2586 * g_signal_handler_is_connected:
2587 * @instance: (type GObject.Object): The instance where a signal handler is sought.
2588 * @handler_id: the handler id.
2590 * Returns whether @handler_id is the id of a handler connected to @instance.
2592 * Returns: whether @handler_id identifies a handler connected to @instance.
2595 g_signal_handler_is_connected (gpointer instance,
2601 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2604 handler = handler_lookup (instance, handler_id, NULL, NULL);
2605 connected = handler != NULL;
2612 * g_signal_handlers_destroy:
2613 * @instance: (type GObject.Object): The instance where a signal handler is sought.
2616 g_signal_handlers_destroy (gpointer instance)
2618 GBSearchArray *hlbsa;
2620 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2623 hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
2628 /* reentrancy caution, delete instance trace first */
2629 g_hash_table_remove (g_handler_list_bsa_ht, instance);
2631 for (i = 0; i < hlbsa->n_nodes; i++)
2633 HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
2634 Handler *handler = hlist->handlers;
2638 Handler *tmp = handler;
2640 handler = tmp->next;
2641 tmp->block_count = 1;
2642 /* cruel unlink, this works because _all_ handlers vanish */
2645 if (tmp->sequential_number)
2647 remove_invalid_closure_notify (tmp, instance);
2648 tmp->sequential_number = 0;
2649 handler_unref_R (0, NULL, tmp);
2653 g_bsearch_array_free (hlbsa, &g_signal_hlbsa_bconfig);
2659 * g_signal_handler_find:
2660 * @instance: (type GObject.Object): The instance owning the signal handler to be found.
2661 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2662 * and/or @data the handler has to match.
2663 * @signal_id: Signal the handler has to be connected to.
2664 * @detail: Signal detail the handler has to be connected to.
2665 * @closure: (allow-none): The closure the handler will invoke.
2666 * @func: The C closure callback of the handler (useless for non-C closures).
2667 * @data: The closure data of the handler's closure.
2669 * Finds the first signal handler that matches certain selection criteria.
2670 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2671 * flags, and the criteria values are passed as arguments.
2672 * The match @mask has to be non-0 for successful matches.
2673 * If no handler was found, 0 is returned.
2675 * Returns: A valid non-0 signal handler id for a successful match.
2678 g_signal_handler_find (gpointer instance,
2679 GSignalMatchType mask,
2686 gulong handler_seq_no = 0;
2688 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2689 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2691 if (mask & G_SIGNAL_MATCH_MASK)
2693 HandlerMatch *mlist;
2696 mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, TRUE);
2699 handler_seq_no = mlist->handler->sequential_number;
2700 handler_match_free1_R (mlist, instance);
2705 return handler_seq_no;
2709 signal_handlers_foreach_matched_R (gpointer instance,
2710 GSignalMatchType mask,
2716 void (*callback) (gpointer instance,
2717 gulong handler_seq_no))
2719 HandlerMatch *mlist;
2720 guint n_handlers = 0;
2722 mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, FALSE);
2726 if (mlist->handler->sequential_number)
2729 callback (instance, mlist->handler->sequential_number);
2732 mlist = handler_match_free1_R (mlist, instance);
2739 * g_signal_handlers_block_matched:
2740 * @instance: (type GObject.Object): The instance to block handlers from.
2741 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2742 * and/or @data the handlers have to match.
2743 * @signal_id: Signal the handlers have to be connected to.
2744 * @detail: Signal detail the handlers have to be connected to.
2745 * @closure: (allow-none): The closure the handlers will invoke.
2746 * @func: The C closure callback of the handlers (useless for non-C closures).
2747 * @data: The closure data of the handlers' closures.
2749 * Blocks all handlers on an instance that match a certain selection criteria.
2750 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2751 * flags, and the criteria values are passed as arguments.
2752 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2753 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2754 * If no handlers were found, 0 is returned, the number of blocked handlers
2757 * Returns: The number of handlers that matched.
2760 g_signal_handlers_block_matched (gpointer instance,
2761 GSignalMatchType mask,
2768 guint n_handlers = 0;
2770 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2771 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2773 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2776 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2777 closure, func, data,
2778 g_signal_handler_block);
2786 * g_signal_handlers_unblock_matched:
2787 * @instance: (type GObject.Object): The instance to unblock handlers from.
2788 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2789 * and/or @data the handlers have to match.
2790 * @signal_id: Signal the handlers have to be connected to.
2791 * @detail: Signal detail the handlers have to be connected to.
2792 * @closure: (allow-none): The closure the handlers will invoke.
2793 * @func: The C closure callback of the handlers (useless for non-C closures).
2794 * @data: The closure data of the handlers' closures.
2796 * Unblocks all handlers on an instance that match a certain selection
2797 * criteria. The criteria mask is passed as an OR-ed combination of
2798 * #GSignalMatchType flags, and the criteria values are passed as arguments.
2799 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2800 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2801 * If no handlers were found, 0 is returned, the number of unblocked handlers
2802 * otherwise. The match criteria should not apply to any handlers that are
2803 * not currently blocked.
2805 * Returns: The number of handlers that matched.
2808 g_signal_handlers_unblock_matched (gpointer instance,
2809 GSignalMatchType mask,
2816 guint n_handlers = 0;
2818 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2819 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2821 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2824 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2825 closure, func, data,
2826 g_signal_handler_unblock);
2834 * g_signal_handlers_disconnect_matched:
2835 * @instance: (type GObject.Object): The instance to remove handlers from.
2836 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2837 * and/or @data the handlers have to match.
2838 * @signal_id: Signal the handlers have to be connected to.
2839 * @detail: Signal detail the handlers have to be connected to.
2840 * @closure: (allow-none): The closure the handlers will invoke.
2841 * @func: The C closure callback of the handlers (useless for non-C closures).
2842 * @data: The closure data of the handlers' closures.
2844 * Disconnects all handlers on an instance that match a certain
2845 * selection criteria. The criteria mask is passed as an OR-ed
2846 * combination of #GSignalMatchType flags, and the criteria values are
2847 * passed as arguments. Passing at least one of the
2848 * %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
2849 * %G_SIGNAL_MATCH_DATA match flags is required for successful
2850 * matches. If no handlers were found, 0 is returned, the number of
2851 * disconnected handlers otherwise.
2853 * Returns: The number of handlers that matched.
2856 g_signal_handlers_disconnect_matched (gpointer instance,
2857 GSignalMatchType mask,
2864 guint n_handlers = 0;
2866 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2867 g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2869 if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2872 n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2873 closure, func, data,
2874 g_signal_handler_disconnect);
2882 * g_signal_has_handler_pending:
2883 * @instance: (type GObject.Object): the object whose signal handlers are sought.
2884 * @signal_id: the signal id.
2885 * @detail: the detail.
2886 * @may_be_blocked: whether blocked handlers should count as match.
2888 * Returns whether there are any handlers connected to @instance for the
2889 * given signal id and detail.
2891 * One example of when you might use this is when the arguments to the
2892 * signal are difficult to compute. A class implementor may opt to not
2893 * emit the signal if no one is attached anyway, thus saving the cost
2894 * of building the arguments.
2896 * Returns: %TRUE if a handler is connected to the signal, %FALSE
2900 g_signal_has_handler_pending (gpointer instance,
2903 gboolean may_be_blocked)
2905 HandlerMatch *mlist;
2906 gboolean has_pending;
2908 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2909 g_return_val_if_fail (signal_id > 0, FALSE);
2914 SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2916 if (!(node->flags & G_SIGNAL_DETAILED))
2918 g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2923 mlist = handlers_find (instance,
2924 (G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | (may_be_blocked ? 0 : G_SIGNAL_MATCH_UNBLOCKED)),
2925 signal_id, detail, NULL, NULL, NULL, TRUE);
2929 handler_match_free1_R (mlist, instance);
2932 has_pending = FALSE;
2940 * @instance_and_params: (array): argument list for the signal emission.
2941 * The first element in the array is a #GValue for the instance the signal
2942 * is being emitted on. The rest are any arguments to be passed to the signal.
2943 * @signal_id: the signal id
2944 * @detail: the detail
2945 * @return_value: Location to store the return value of the signal emission.
2949 * Note that g_signal_emitv() doesn't change @return_value if no handlers are
2950 * connected, in contrast to g_signal_emit() and g_signal_emit_valist().
2953 g_signal_emitv (const GValue *instance_and_params,
2956 GValue *return_value)
2960 #ifdef G_ENABLE_DEBUG
2961 const GValue *param_values;
2965 g_return_if_fail (instance_and_params != NULL);
2966 instance = g_value_peek_pointer (instance_and_params);
2967 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2968 g_return_if_fail (signal_id > 0);
2970 #ifdef G_ENABLE_DEBUG
2971 param_values = instance_and_params + 1;
2975 node = LOOKUP_SIGNAL_NODE (signal_id);
2976 if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2978 g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
2982 #ifdef G_ENABLE_DEBUG
2983 if (detail && !(node->flags & G_SIGNAL_DETAILED))
2985 g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2989 for (i = 0; i < node->n_params; i++)
2990 if (!G_TYPE_CHECK_VALUE_TYPE (param_values + i, node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
2992 g_critical ("%s: value for '%s' parameter %u for signal \"%s\" is of type '%s'",
2994 type_debug_name (node->param_types[i]),
2997 G_VALUE_TYPE_NAME (param_values + i));
3001 if (node->return_type != G_TYPE_NONE)
3005 g_critical ("%s: return value '%s' for signal \"%s\" is (NULL)",
3007 type_debug_name (node->return_type),
3012 else if (!node->accumulator && !G_TYPE_CHECK_VALUE_TYPE (return_value, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
3014 g_critical ("%s: return value '%s' for signal \"%s\" is of type '%s'",
3016 type_debug_name (node->return_type),
3018 G_VALUE_TYPE_NAME (return_value));
3024 return_value = NULL;
3025 #endif /* G_ENABLE_DEBUG */
3027 /* optimize NOP emissions */
3028 if (!node->single_va_closure_is_valid)
3029 node_update_single_va_closure (node);
3031 if (node->single_va_closure != NULL &&
3032 (node->single_va_closure == SINGLE_VA_CLOSURE_EMPTY_MAGIC ||
3033 _g_closure_is_void (node->single_va_closure, instance)))
3035 HandlerList* hlist = handler_list_lookup (node->signal_id, instance);
3036 if (hlist == NULL || hlist->handlers == NULL)
3038 /* nothing to do to emit this signal */
3040 /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
3046 signal_emit_unlocked_R (node, detail, instance, return_value, instance_and_params);
3049 static inline gboolean
3050 accumulate (GSignalInvocationHint *ihint,
3051 GValue *return_accu,
3052 GValue *handler_return,
3053 SignalAccumulator *accumulator)
3055 gboolean continue_emission;
3060 continue_emission = accumulator->func (ihint, return_accu, handler_return, accumulator->data);
3061 g_value_reset (handler_return);
3063 return continue_emission;
3067 * g_signal_emit_valist: (skip)
3068 * @instance: the instance the signal is being emitted on.
3069 * @signal_id: the signal id
3070 * @detail: the detail
3071 * @var_args: a list of parameters to be passed to the signal, followed by a
3072 * location for the return value. If the return type of the signal
3073 * is #G_TYPE_NONE, the return value location can be omitted.
3077 * Note that g_signal_emit_valist() resets the return value to the default
3078 * if no handlers are connected, in contrast to g_signal_emitv().
3081 g_signal_emit_valist (gpointer instance,
3086 GValue *instance_and_params;
3087 GType signal_return_type;
3088 GValue *param_values;
3092 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
3093 g_return_if_fail (signal_id > 0);
3096 node = LOOKUP_SIGNAL_NODE (signal_id);
3097 if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
3099 g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
3103 #ifndef G_DISABLE_CHECKS
3104 if (detail && !(node->flags & G_SIGNAL_DETAILED))
3106 g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
3110 #endif /* !G_DISABLE_CHECKS */
3112 if (!node->single_va_closure_is_valid)
3113 node_update_single_va_closure (node);
3115 if (node->single_va_closure != NULL)
3117 HandlerList* hlist = handler_list_lookup (node->signal_id, instance);
3118 Handler *fastpath_handler = NULL;
3120 GClosure *closure = NULL;
3121 gboolean fastpath = TRUE;
3122 GSignalFlags run_type = G_SIGNAL_RUN_FIRST;
3124 if (node->single_va_closure != SINGLE_VA_CLOSURE_EMPTY_MAGIC &&
3125 !_g_closure_is_void (node->single_va_closure, instance))
3127 if (_g_closure_supports_invoke_va (node->single_va_closure))
3129 closure = node->single_va_closure;
3130 if (node->single_va_closure_is_after)
3131 run_type = G_SIGNAL_RUN_LAST;
3133 run_type = G_SIGNAL_RUN_FIRST;
3139 for (l = hlist ? hlist->handlers : NULL; fastpath && l != NULL; l = l->next)
3141 if (!l->block_count &&
3142 (!l->detail || l->detail == detail))
3144 if (closure != NULL || !_g_closure_supports_invoke_va (l->closure))
3151 fastpath_handler = l;
3152 closure = l->closure;
3154 run_type = G_SIGNAL_RUN_LAST;
3156 run_type = G_SIGNAL_RUN_FIRST;
3161 if (fastpath && closure == NULL && node->return_type == G_TYPE_NONE)
3167 /* Don't allow no-recurse emission as we might have to restart, which means
3168 we will run multiple handlers and thus must ref all arguments */
3169 if (closure != NULL && (node->flags & (G_SIGNAL_NO_RECURSE)) != 0)
3174 SignalAccumulator *accumulator;
3176 GValue *return_accu, accu = G_VALUE_INIT;
3178 GType instance_type = G_TYPE_FROM_INSTANCE (instance);
3179 GValue emission_return = G_VALUE_INIT;
3180 GType rtype = node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3181 gboolean static_scope = node->return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
3183 signal_id = node->signal_id;
3184 accumulator = node->accumulator;
3185 if (rtype == G_TYPE_NONE)
3187 else if (accumulator)
3188 return_accu = &accu;
3190 return_accu = &emission_return;
3192 emission.instance = instance;
3193 emission.ihint.signal_id = signal_id;
3194 emission.ihint.detail = detail;
3195 emission.ihint.run_type = run_type;
3196 emission.state = EMISSION_RUN;
3197 emission.chain_type = instance_type;
3198 emission_push (&g_recursive_emissions, &emission);
3200 if (fastpath_handler)
3201 handler_ref (fastpath_handler);
3205 TRACE(GOBJECT_SIGNAL_EMIT(signal_id, detail, instance, instance_type));
3207 if (rtype != G_TYPE_NONE)
3208 g_value_init (&emission_return, rtype);
3211 g_value_init (&accu, rtype);
3213 if (closure != NULL)
3215 g_object_ref (instance);
3216 _g_closure_invoke_va (closure,
3222 accumulate (&emission.ihint, &emission_return, &accu, accumulator);
3227 emission.chain_type = G_TYPE_NONE;
3228 emission_pop (&g_recursive_emissions, &emission);
3230 if (fastpath_handler)
3231 handler_unref_R (signal_id, instance, fastpath_handler);
3236 g_value_unset (&accu);
3238 if (rtype != G_TYPE_NONE)
3240 gchar *error = NULL;
3241 for (i = 0; i < node->n_params; i++)
3243 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3244 G_VALUE_COLLECT_SKIP (ptype, var_args);
3247 G_VALUE_LCOPY (&emission_return,
3249 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3252 g_value_unset (&emission_return);
3255 g_warning ("%s: %s", G_STRLOC, error);
3257 /* we purposely leak the value here, it might not be
3258 * in a sane state if an error condition occurred
3263 TRACE(GOBJECT_SIGNAL_EMIT_END(signal_id, detail, instance, instance_type));
3265 if (closure != NULL)
3266 g_object_unref (instance);
3273 n_params = node->n_params;
3274 signal_return_type = node->return_type;
3275 instance_and_params = g_alloca (sizeof (GValue) * (n_params + 1));
3276 memset (instance_and_params, 0, sizeof (GValue) * (n_params + 1));
3277 param_values = instance_and_params + 1;
3279 for (i = 0; i < node->n_params; i++)
3282 GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3283 gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
3285 G_VALUE_COLLECT_INIT (param_values + i, ptype,
3287 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3291 g_warning ("%s: %s", G_STRLOC, error);
3294 /* we purposely leak the value here, it might not be
3295 * in a sane state if an error condition occoured
3298 g_value_unset (param_values + i);
3304 instance_and_params->g_type = 0;
3305 g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
3306 g_value_set_instance (instance_and_params, instance);
3307 if (signal_return_type == G_TYPE_NONE)
3308 signal_emit_unlocked_R (node, detail, instance, NULL, instance_and_params);
3311 GValue return_value = G_VALUE_INIT;
3312 gchar *error = NULL;
3313 GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3314 gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
3316 g_value_init (&return_value, rtype);
3318 signal_emit_unlocked_R (node, detail, instance, &return_value, instance_and_params);
3320 G_VALUE_LCOPY (&return_value,
3322 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3325 g_value_unset (&return_value);
3328 g_warning ("%s: %s", G_STRLOC, error);
3331 /* we purposely leak the value here, it might not be
3332 * in a sane state if an error condition occurred
3336 for (i = 0; i < n_params; i++)
3337 g_value_unset (param_values + i);
3338 g_value_unset (instance_and_params);
3343 * @instance: (type GObject.Object): the instance the signal is being emitted on.
3344 * @signal_id: the signal id
3345 * @detail: the detail
3346 * @...: parameters to be passed to the signal, followed by a
3347 * location for the return value. If the return type of the signal
3348 * is #G_TYPE_NONE, the return value location can be omitted.
3352 * Note that g_signal_emit() resets the return value to the default
3353 * if no handlers are connected, in contrast to g_signal_emitv().
3356 g_signal_emit (gpointer instance,
3363 va_start (var_args, detail);
3364 g_signal_emit_valist (instance, signal_id, detail, var_args);
3369 * g_signal_emit_by_name:
3370 * @instance: (type GObject.Object): the instance the signal is being emitted on.
3371 * @detailed_signal: a string of the form "signal-name::detail".
3372 * @...: parameters to be passed to the signal, followed by a
3373 * location for the return value. If the return type of the signal
3374 * is #G_TYPE_NONE, the return value location can be omitted.
3378 * Note that g_signal_emit_by_name() resets the return value to the default
3379 * if no handlers are connected, in contrast to g_signal_emitv().
3382 g_signal_emit_by_name (gpointer instance,
3383 const gchar *detailed_signal,
3390 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
3391 g_return_if_fail (detailed_signal != NULL);
3393 itype = G_TYPE_FROM_INSTANCE (instance);
3396 signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
3403 va_start (var_args, detailed_signal);
3404 g_signal_emit_valist (instance, signal_id, detail, var_args);
3408 g_warning ("%s: signal name '%s' is invalid for instance '%p' of type '%s'",
3409 G_STRLOC, detailed_signal, instance, g_type_name (itype));
3413 signal_emit_unlocked_R (SignalNode *node,
3416 GValue *emission_return,
3417 const GValue *instance_and_params)
3419 SignalAccumulator *accumulator;
3421 GClosure *class_closure;
3423 Handler *handler_list = NULL;
3424 GValue *return_accu, accu = G_VALUE_INIT;
3426 gulong max_sequential_handler_number;
3427 gboolean return_value_altered = FALSE;
3429 TRACE(GOBJECT_SIGNAL_EMIT(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3432 signal_id = node->signal_id;
3434 if (node->flags & G_SIGNAL_NO_RECURSE)
3436 Emission *node = emission_find (g_restart_emissions, signal_id, detail, instance);
3440 node->state = EMISSION_RESTART;
3442 return return_value_altered;
3445 accumulator = node->accumulator;
3449 g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3450 return_accu = &accu;
3454 return_accu = emission_return;
3455 emission.instance = instance;
3456 emission.ihint.signal_id = node->signal_id;
3457 emission.ihint.detail = detail;
3458 emission.ihint.run_type = 0;
3460 emission.chain_type = G_TYPE_NONE;
3461 emission_push ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3462 class_closure = signal_lookup_closure (node, instance);
3467 handler_unref_R (signal_id, instance, handler_list);
3468 max_sequential_handler_number = g_handler_sequential_number;
3469 hlist = handler_list_lookup (signal_id, instance);
3470 handler_list = hlist ? hlist->handlers : NULL;
3472 handler_ref (handler_list);
3474 emission.ihint.run_type = G_SIGNAL_RUN_FIRST;
3476 if ((node->flags & G_SIGNAL_RUN_FIRST) && class_closure)
3478 emission.state = EMISSION_RUN;
3480 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3482 g_closure_invoke (class_closure,
3485 instance_and_params,
3487 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3488 emission.state == EMISSION_RUN)
3489 emission.state = EMISSION_STOP;
3491 emission.chain_type = G_TYPE_NONE;
3492 return_value_altered = TRUE;
3494 if (emission.state == EMISSION_STOP)
3496 else if (emission.state == EMISSION_RESTART)
3500 if (node->emission_hooks)
3502 gboolean need_destroy, was_in_call, may_recurse = TRUE;
3505 emission.state = EMISSION_HOOK;
3506 hook = g_hook_first_valid (node->emission_hooks, may_recurse);
3509 SignalHook *signal_hook = SIGNAL_HOOK (hook);
3511 if (!signal_hook->detail || signal_hook->detail == detail)
3513 GSignalEmissionHook hook_func = (GSignalEmissionHook) hook->func;
3515 was_in_call = G_HOOK_IN_CALL (hook);
3516 hook->flags |= G_HOOK_FLAG_IN_CALL;
3518 need_destroy = !hook_func (&emission.ihint, node->n_params + 1, instance_and_params, hook->data);
3521 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
3523 g_hook_destroy_link (node->emission_hooks, hook);
3525 hook = g_hook_next_valid (node->emission_hooks, hook, may_recurse);
3528 if (emission.state == EMISSION_RESTART)
3534 Handler *handler = handler_list;
3536 emission.state = EMISSION_RUN;
3537 handler_ref (handler);
3544 handler_unref_R (signal_id, instance, handler_list);
3545 handler_list = handler;
3548 else if (!handler->block_count && (!handler->detail || handler->detail == detail) &&
3549 handler->sequential_number < max_sequential_handler_number)
3552 g_closure_invoke (handler->closure,
3555 instance_and_params,
3557 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3558 emission.state == EMISSION_RUN)
3559 emission.state = EMISSION_STOP;
3561 return_value_altered = TRUE;
3563 tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3566 tmp = handler->next;
3570 handler_unref_R (signal_id, instance, handler_list);
3571 handler_list = handler;
3576 if (emission.state == EMISSION_STOP)
3578 else if (emission.state == EMISSION_RESTART)
3582 emission.ihint.run_type = G_SIGNAL_RUN_LAST;
3584 if ((node->flags & G_SIGNAL_RUN_LAST) && class_closure)
3586 emission.state = EMISSION_RUN;
3588 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3590 g_closure_invoke (class_closure,
3593 instance_and_params,
3595 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3596 emission.state == EMISSION_RUN)
3597 emission.state = EMISSION_STOP;
3599 emission.chain_type = G_TYPE_NONE;
3600 return_value_altered = TRUE;
3602 if (emission.state == EMISSION_STOP)
3604 else if (emission.state == EMISSION_RESTART)
3610 Handler *handler = handler_list;
3612 emission.state = EMISSION_RUN;
3613 handler_ref (handler);
3618 if (handler->after && !handler->block_count && (!handler->detail || handler->detail == detail) &&
3619 handler->sequential_number < max_sequential_handler_number)
3622 g_closure_invoke (handler->closure,
3625 instance_and_params,
3627 if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3628 emission.state == EMISSION_RUN)
3629 emission.state = EMISSION_STOP;
3631 return_value_altered = TRUE;
3633 tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3636 tmp = handler->next;
3640 handler_unref_R (signal_id, instance, handler);
3645 if (emission.state == EMISSION_STOP)
3647 else if (emission.state == EMISSION_RESTART)
3653 emission.ihint.run_type = G_SIGNAL_RUN_CLEANUP;
3655 if ((node->flags & G_SIGNAL_RUN_CLEANUP) && class_closure)
3657 gboolean need_unset = FALSE;
3659 emission.state = EMISSION_STOP;
3661 emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3663 if (node->return_type != G_TYPE_NONE && !accumulator)
3665 g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3668 g_closure_invoke (class_closure,
3669 node->return_type != G_TYPE_NONE ? &accu : NULL,
3671 instance_and_params,
3674 g_value_unset (&accu);
3676 emission.chain_type = G_TYPE_NONE;
3678 if (emission.state == EMISSION_RESTART)
3683 handler_unref_R (signal_id, instance, handler_list);
3685 emission_pop ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3688 g_value_unset (&accu);
3690 TRACE(GOBJECT_SIGNAL_EMIT_END(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3692 return return_value_altered;
3696 add_invalid_closure_notify (Handler *handler,
3699 g_closure_add_invalidate_notifier (handler->closure, instance, invalid_closure_notify);
3700 handler->has_invalid_closure_notify = 1;
3704 remove_invalid_closure_notify (Handler *handler,
3707 if (handler->has_invalid_closure_notify)
3709 g_closure_remove_invalidate_notifier (handler->closure, instance, invalid_closure_notify);
3710 handler->has_invalid_closure_notify = 0;
3715 invalid_closure_notify (gpointer instance,
3723 handler = handler_lookup (instance, 0, closure, &signal_id);
3724 g_assert (handler->closure == closure);
3726 handler->sequential_number = 0;
3727 handler->block_count = 1;
3728 handler_unref_R (signal_id, instance, handler);
3734 type_debug_name (GType type)
3738 const char *name = g_type_name (type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3739 return name ? name : "<unknown>";
3746 * g_signal_accumulator_true_handled:
3747 * @ihint: standard #GSignalAccumulator parameter
3748 * @return_accu: standard #GSignalAccumulator parameter
3749 * @handler_return: standard #GSignalAccumulator parameter
3750 * @dummy: standard #GSignalAccumulator parameter
3752 * A predefined #GSignalAccumulator for signals that return a
3753 * boolean values. The behavior that this accumulator gives is
3754 * that a return of %TRUE stops the signal emission: no further
3755 * callbacks will be invoked, while a return of %FALSE allows
3756 * the emission to continue. The idea here is that a %TRUE return
3757 * indicates that the callback <emphasis>handled</emphasis> the signal,
3758 * and no further handling is needed.
3762 * Returns: standard #GSignalAccumulator result
3765 g_signal_accumulator_true_handled (GSignalInvocationHint *ihint,
3766 GValue *return_accu,
3767 const GValue *handler_return,
3770 gboolean continue_emission;
3771 gboolean signal_handled;
3773 signal_handled = g_value_get_boolean (handler_return);
3774 g_value_set_boolean (return_accu, signal_handled);
3775 continue_emission = !signal_handled;
3777 return continue_emission;
3781 * g_signal_accumulator_first_wins:
3782 * @ihint: standard #GSignalAccumulator parameter
3783 * @return_accu: standard #GSignalAccumulator parameter
3784 * @handler_return: standard #GSignalAccumulator parameter
3785 * @dummy: standard #GSignalAccumulator parameter
3787 * A predefined #GSignalAccumulator for signals intended to be used as a
3788 * hook for application code to provide a particular value. Usually
3789 * only one such value is desired and multiple handlers for the same
3790 * signal don't make much sense (except for the case of the default
3791 * handler defined in the class structure, in which case you will
3792 * usually want the signal connection to override the class handler).
3794 * This accumulator will use the return value from the first signal
3795 * handler that is run as the return value for the signal and not run
3796 * any further handlers (ie: the first handler "wins").
3798 * Returns: standard #GSignalAccumulator result
3803 g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
3804 GValue *return_accu,
3805 const GValue *handler_return,
3808 g_value_copy (handler_return, return_accu);