1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000-2001 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * this code is based on the original GtkSignal implementation
20 * for the Gtk+ library by Peter Mattis <petm@xcf.berkeley.edu>
33 #include "gbsearcharray.h"
34 #include "gvaluecollector.h"
35 #include "gvaluetypes.h"
39 #include "gobject_trace.h"
44 * @short_description: A means for customization of object behaviour
45 * and a general purpose notification mechanism
48 * The basic concept of the signal system is that of the
49 * <emphasis>emission</emphasis> of a signal. Signals are introduced
50 * per-type and are identified through strings. Signals introduced
51 * for a parent type are available in derived types as well, so
52 * basically they are a per-type facility that is inherited. A signal
53 * emission mainly involves invocation of a certain set of callbacks
54 * in precisely defined manner. There are two main categories of such
55 * callbacks, per-object
56 * <footnote><para>Although signals can deal with any kind of instantiatable
57 * type, i'm referring to those types as "object types" in the following,
58 * simply because that is the context most users will encounter signals in.
60 * ones and user provided ones.
61 * The per-object callbacks are most often referred to as "object method
62 * handler" or "default (signal) handler", while user provided callbacks are
63 * usually just called "signal handler".
64 * The object method handler is provided at signal creation time (this most
65 * frequently happens at the end of an object class' creation), while user
66 * provided handlers are frequently connected and disconnected to/from a certain
67 * signal on certain object instances.
69 * A signal emission consists of five stages, unless prematurely stopped:
71 * <varlistentry><term></term><listitem><para>
72 * 1 - Invocation of the object method handler for %G_SIGNAL_RUN_FIRST signals
73 * </para></listitem></varlistentry>
74 * <varlistentry><term></term><listitem><para>
75 * 2 - Invocation of normal user-provided signal handlers (<emphasis>after</emphasis> flag %FALSE)
76 * </para></listitem></varlistentry>
77 * <varlistentry><term></term><listitem><para>
78 * 3 - Invocation of the object method handler for %G_SIGNAL_RUN_LAST signals
79 * </para></listitem></varlistentry>
80 * <varlistentry><term></term><listitem><para>
81 * 4 - Invocation of user provided signal handlers, connected with an <emphasis>after</emphasis> flag of %TRUE
82 * </para></listitem></varlistentry>
83 * <varlistentry><term></term><listitem><para>
84 * 5 - Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals
85 * </para></listitem></varlistentry>
87 * The user-provided signal handlers are called in the order they were
89 * All handlers may prematurely stop a signal emission, and any number of
90 * handlers may be connected, disconnected, blocked or unblocked during
92 * There are certain criteria for skipping user handlers in stages 2 and 4
93 * of a signal emission.
94 * First, user handlers may be <emphasis>blocked</emphasis>, blocked handlers are omitted
95 * during callback invocation, to return from the "blocked" state, a
96 * handler has to get unblocked exactly the same amount of times
97 * it has been blocked before.
98 * Second, upon emission of a %G_SIGNAL_DETAILED signal, an additional
99 * "detail" argument passed in to g_signal_emit() has to match the detail
100 * argument of the signal handler currently subject to invocation.
101 * Specification of no detail argument for signal handlers (omission of the
102 * detail part of the signal specification upon connection) serves as a
103 * wildcard and matches any detail argument passed in to emission.
107 #define REPORT_BUG "please report occurrence circumstances to gtk-devel-list@gnome.org"
108 #ifdef G_ENABLE_DEBUG
109 #define IF_DEBUG(debug_type, cond) if ((_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) || cond)
110 static volatile gpointer g_trace_instance_signals
= NULL
;
111 static volatile gpointer g_trap_instance_signals
= NULL
;
112 #endif /* G_ENABLE_DEBUG */
115 /* --- typedefs --- */
116 typedef struct _SignalNode SignalNode
;
117 typedef struct _SignalKey SignalKey
;
118 typedef struct _Emission Emission
;
119 typedef struct _Handler Handler
;
120 typedef struct _HandlerList HandlerList
;
121 typedef struct _HandlerMatch HandlerMatch
;
131 /* --- prototypes --- */
132 static inline guint
signal_id_lookup (GQuark quark
,
134 static void signal_destroy_R (SignalNode
*signal_node
);
135 static inline HandlerList
* handler_list_ensure (guint signal_id
,
137 static inline HandlerList
* handler_list_lookup (guint signal_id
,
139 static inline Handler
* handler_new (gboolean after
);
140 static void handler_insert (guint signal_id
,
143 static Handler
* handler_lookup (gpointer instance
,
146 static inline HandlerMatch
* handler_match_prepend (HandlerMatch
*list
,
149 static inline HandlerMatch
* handler_match_free1_R (HandlerMatch
*node
,
151 static HandlerMatch
* handlers_find (gpointer instance
,
152 GSignalMatchType mask
,
158 gboolean one_and_only
);
159 static inline void handler_ref (Handler
*handler
);
160 static inline void handler_unref_R (guint signal_id
,
163 static gint
handler_lists_cmp (gconstpointer node1
,
164 gconstpointer node2
);
165 static inline void emission_push (Emission
**emission_list_p
,
167 static inline void emission_pop (Emission
**emission_list_p
,
169 static inline Emission
* emission_find (Emission
*emission_list
,
173 static gint
class_closures_cmp (gconstpointer node1
,
174 gconstpointer node2
);
175 static gint
signal_key_cmp (gconstpointer node1
,
176 gconstpointer node2
);
177 static gboolean
signal_emit_unlocked_R (SignalNode
*node
,
180 GValue
*return_value
,
181 const GValue
*instance_and_params
);
182 static const gchar
* type_debug_name (GType type
);
185 /* --- structures --- */
188 GSignalAccumulator func
;
196 #define SIGNAL_HOOK(hook) ((SignalHook*) (hook))
200 /* permanent portion */
206 /* reinitializable portion */
207 guint test_class_offset
: 12;
210 GType
*param_types
; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
211 GType return_type
; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
212 GBSearchArray
*class_closure_bsa
;
213 SignalAccumulator
*accumulator
;
214 GSignalCMarshaller c_marshaller
;
215 GHookList
*emission_hooks
;
217 #define MAX_TEST_CLASS_OFFSET (4096) /* 2^12, 12 bits for test_class_offset */
218 #define TEST_CLASS_MAGIC (1) /* indicates NULL class closure, candidate for NOP optimization */
231 GSignalInvocationHint ihint
;
240 Handler
*tail_before
; /* normal signal handlers are appended here */
241 Handler
*tail_after
; /* CONNECT_AFTER handlers are appended here */
246 gulong sequential_number
;
251 guint block_count
: 16;
252 #define HANDLER_MAX_BLOCK_COUNT (1 << 16)
265 GType instance_type
; /* 0 for default closure */
270 /* --- variables --- */
271 static GBSearchArray
*g_signal_key_bsa
= NULL
;
272 static const GBSearchConfig g_signal_key_bconfig
= {
275 G_BSEARCH_ARRAY_ALIGN_POWER2
,
277 static GBSearchConfig g_signal_hlbsa_bconfig
= {
278 sizeof (HandlerList
),
282 static GBSearchConfig g_class_closure_bconfig
= {
283 sizeof (ClassClosure
),
287 static GHashTable
*g_handler_list_bsa_ht
= NULL
;
288 static Emission
*g_recursive_emissions
= NULL
;
289 static Emission
*g_restart_emissions
= NULL
;
290 static gulong g_handler_sequential_number
= 1;
291 G_LOCK_DEFINE_STATIC (g_signal_mutex
);
292 #define SIGNAL_LOCK() G_LOCK (g_signal_mutex)
293 #define SIGNAL_UNLOCK() G_UNLOCK (g_signal_mutex)
296 /* --- signal nodes --- */
297 static guint g_n_signal_nodes
= 0;
298 static SignalNode
**g_signal_nodes
= NULL
;
300 static inline SignalNode
*
301 LOOKUP_SIGNAL_NODE (register guint signal_id
)
303 if (signal_id
< g_n_signal_nodes
)
304 return g_signal_nodes
[signal_id
];
310 /* --- functions --- */
312 signal_id_lookup (GQuark quark
,
315 GType
*ifaces
, type
= itype
;
321 /* try looking up signals for this type and its ancestors */
324 SignalKey
*signal_key
;
327 signal_key
= g_bsearch_array_lookup (g_signal_key_bsa
, &g_signal_key_bconfig
, &key
);
330 return signal_key
->signal_id
;
332 type
= g_type_parent (type
);
336 /* no luck, try interfaces it exports */
337 ifaces
= g_type_interfaces (itype
, &n_ifaces
);
340 SignalKey
*signal_key
;
342 key
.itype
= ifaces
[n_ifaces
];
343 signal_key
= g_bsearch_array_lookup (g_signal_key_bsa
, &g_signal_key_bconfig
, &key
);
348 return signal_key
->signal_id
;
357 class_closures_cmp (gconstpointer node1
,
360 const ClassClosure
*c1
= node1
, *c2
= node2
;
362 return G_BSEARCH_ARRAY_CMP (c1
->instance_type
, c2
->instance_type
);
366 handler_lists_cmp (gconstpointer node1
,
369 const HandlerList
*hlist1
= node1
, *hlist2
= node2
;
371 return G_BSEARCH_ARRAY_CMP (hlist1
->signal_id
, hlist2
->signal_id
);
374 static inline HandlerList
*
375 handler_list_ensure (guint signal_id
,
378 GBSearchArray
*hlbsa
= g_hash_table_lookup (g_handler_list_bsa_ht
, instance
);
381 key
.signal_id
= signal_id
;
383 key
.tail_before
= NULL
;
384 key
.tail_after
= NULL
;
387 hlbsa
= g_bsearch_array_create (&g_signal_hlbsa_bconfig
);
388 hlbsa
= g_bsearch_array_insert (hlbsa
, &g_signal_hlbsa_bconfig
, &key
);
389 g_hash_table_insert (g_handler_list_bsa_ht
, instance
, hlbsa
);
393 GBSearchArray
*o
= hlbsa
;
395 hlbsa
= g_bsearch_array_insert (o
, &g_signal_hlbsa_bconfig
, &key
);
397 g_hash_table_insert (g_handler_list_bsa_ht
, instance
, hlbsa
);
399 return g_bsearch_array_lookup (hlbsa
, &g_signal_hlbsa_bconfig
, &key
);
402 static inline HandlerList
*
403 handler_list_lookup (guint signal_id
,
406 GBSearchArray
*hlbsa
= g_hash_table_lookup (g_handler_list_bsa_ht
, instance
);
409 key
.signal_id
= signal_id
;
411 return hlbsa
? g_bsearch_array_lookup (hlbsa
, &g_signal_hlbsa_bconfig
, &key
) : NULL
;
415 handler_lookup (gpointer instance
,
419 GBSearchArray
*hlbsa
= g_hash_table_lookup (g_handler_list_bsa_ht
, instance
);
425 for (i
= 0; i
< hlbsa
->n_nodes
; i
++)
427 HandlerList
*hlist
= g_bsearch_array_get_nth (hlbsa
, &g_signal_hlbsa_bconfig
, i
);
430 for (handler
= hlist
->handlers
; handler
; handler
= handler
->next
)
431 if (handler
->sequential_number
== handler_id
)
434 *signal_id_p
= hlist
->signal_id
;
444 static inline HandlerMatch
*
445 handler_match_prepend (HandlerMatch
*list
,
451 node
= g_slice_new (HandlerMatch
);
452 node
->handler
= handler
;
454 node
->signal_id
= signal_id
;
455 handler_ref (handler
);
459 static inline HandlerMatch
*
460 handler_match_free1_R (HandlerMatch
*node
,
463 HandlerMatch
*next
= node
->next
;
465 handler_unref_R (node
->signal_id
, instance
, node
->handler
);
466 g_slice_free (HandlerMatch
, node
);
472 handlers_find (gpointer instance
,
473 GSignalMatchType mask
,
479 gboolean one_and_only
)
481 HandlerMatch
*mlist
= NULL
;
483 if (mask
& G_SIGNAL_MATCH_ID
)
485 HandlerList
*hlist
= handler_list_lookup (signal_id
, instance
);
487 SignalNode
*node
= NULL
;
489 if (mask
& G_SIGNAL_MATCH_FUNC
)
491 node
= LOOKUP_SIGNAL_NODE (signal_id
);
492 if (!node
|| !node
->c_marshaller
)
497 for (handler
= hlist
? hlist
->handlers
: NULL
; handler
; handler
= handler
->next
)
498 if (handler
->sequential_number
&&
499 ((mask
& G_SIGNAL_MATCH_DETAIL
) || handler
->detail
== detail
) &&
500 ((mask
& G_SIGNAL_MATCH_CLOSURE
) || handler
->closure
== closure
) &&
501 ((mask
& G_SIGNAL_MATCH_DATA
) || handler
->closure
->data
== data
) &&
502 ((mask
& G_SIGNAL_MATCH_UNBLOCKED
) || handler
->block_count
== 0) &&
503 ((mask
& G_SIGNAL_MATCH_FUNC
) || (handler
->closure
->marshal
== node
->c_marshaller
&&
504 handler
->closure
->meta_marshal
== 0 &&
505 ((GCClosure
*) handler
->closure
)->callback
== func
)))
507 mlist
= handler_match_prepend (mlist
, handler
, signal_id
);
514 GBSearchArray
*hlbsa
= g_hash_table_lookup (g_handler_list_bsa_ht
, instance
);
521 for (i
= 0; i
< hlbsa
->n_nodes
; i
++)
523 HandlerList
*hlist
= g_bsearch_array_get_nth (hlbsa
, &g_signal_hlbsa_bconfig
, i
);
524 SignalNode
*node
= NULL
;
527 if (!(mask
& G_SIGNAL_MATCH_FUNC
))
529 node
= LOOKUP_SIGNAL_NODE (hlist
->signal_id
);
530 if (!node
->c_marshaller
)
534 for (handler
= hlist
->handlers
; handler
; handler
= handler
->next
)
535 if (handler
->sequential_number
&&
536 ((mask
& G_SIGNAL_MATCH_DETAIL
) || handler
->detail
== detail
) &&
537 ((mask
& G_SIGNAL_MATCH_CLOSURE
) || handler
->closure
== closure
) &&
538 ((mask
& G_SIGNAL_MATCH_DATA
) || handler
->closure
->data
== data
) &&
539 ((mask
& G_SIGNAL_MATCH_UNBLOCKED
) || handler
->block_count
== 0) &&
540 ((mask
& G_SIGNAL_MATCH_FUNC
) || (handler
->closure
->marshal
== node
->c_marshaller
&&
541 handler
->closure
->meta_marshal
== 0 &&
542 ((GCClosure
*) handler
->closure
)->callback
== func
)))
544 mlist
= handler_match_prepend (mlist
, handler
, hlist
->signal_id
);
555 static inline Handler
*
556 handler_new (gboolean after
)
558 Handler
*handler
= g_slice_new (Handler
);
559 #ifndef G_DISABLE_CHECKS
560 if (g_handler_sequential_number
< 1)
561 g_error (G_STRLOC
": handler id overflow, %s", REPORT_BUG
);
564 handler
->sequential_number
= g_handler_sequential_number
++;
565 handler
->prev
= NULL
;
566 handler
->next
= NULL
;
568 handler
->ref_count
= 1;
569 handler
->block_count
= 0;
570 handler
->after
= after
!= FALSE
;
571 handler
->closure
= NULL
;
577 handler_ref (Handler
*handler
)
579 g_return_if_fail (handler
->ref_count
> 0);
581 g_atomic_int_inc ((int *)&handler
->ref_count
);
585 handler_unref_R (guint signal_id
,
591 g_return_if_fail (handler
->ref_count
> 0);
593 is_zero
= g_atomic_int_dec_and_test ((int *)&handler
->ref_count
);
595 if (G_UNLIKELY (is_zero
))
597 HandlerList
*hlist
= NULL
;
600 handler
->next
->prev
= handler
->prev
;
601 if (handler
->prev
) /* watch out for g_signal_handlers_destroy()! */
602 handler
->prev
->next
= handler
->next
;
605 hlist
= handler_list_lookup (signal_id
, instance
);
606 hlist
->handlers
= handler
->next
;
611 /* check if we are removing the handler pointed to by tail_before */
612 if (!handler
->after
&& (!handler
->next
|| handler
->next
->after
))
615 hlist
= handler_list_lookup (signal_id
, instance
);
618 g_assert (hlist
->tail_before
== handler
); /* paranoid */
619 hlist
->tail_before
= handler
->prev
;
623 /* check if we are removing the handler pointed to by tail_after */
627 hlist
= handler_list_lookup (signal_id
, instance
);
630 g_assert (hlist
->tail_after
== handler
); /* paranoid */
631 hlist
->tail_after
= handler
->prev
;
637 g_closure_unref (handler
->closure
);
639 g_slice_free (Handler
, handler
);
644 handler_insert (guint signal_id
,
650 g_assert (handler
->prev
== NULL
&& handler
->next
== NULL
); /* paranoid */
652 hlist
= handler_list_ensure (signal_id
, instance
);
653 if (!hlist
->handlers
)
655 hlist
->handlers
= handler
;
657 hlist
->tail_before
= handler
;
659 else if (handler
->after
)
661 handler
->prev
= hlist
->tail_after
;
662 hlist
->tail_after
->next
= handler
;
666 if (hlist
->tail_before
)
668 handler
->next
= hlist
->tail_before
->next
;
670 handler
->next
->prev
= handler
;
671 handler
->prev
= hlist
->tail_before
;
672 hlist
->tail_before
->next
= handler
;
674 else /* insert !after handler into a list of only after handlers */
676 handler
->next
= hlist
->handlers
;
678 handler
->next
->prev
= handler
;
679 hlist
->handlers
= handler
;
681 hlist
->tail_before
= handler
;
685 hlist
->tail_after
= handler
;
689 emission_push (Emission
**emission_list_p
,
692 emission
->next
= *emission_list_p
;
693 *emission_list_p
= emission
;
697 emission_pop (Emission
**emission_list_p
,
700 Emission
*node
, *last
= NULL
;
702 for (node
= *emission_list_p
; node
; last
= node
, node
= last
->next
)
703 if (node
== emission
)
706 last
->next
= node
->next
;
708 *emission_list_p
= node
->next
;
711 g_assert_not_reached ();
714 static inline Emission
*
715 emission_find (Emission
*emission_list
,
722 for (emission
= emission_list
; emission
; emission
= emission
->next
)
723 if (emission
->instance
== instance
&&
724 emission
->ihint
.signal_id
== signal_id
&&
725 emission
->ihint
.detail
== detail
)
730 static inline Emission
*
731 emission_find_innermost (gpointer instance
)
733 Emission
*emission
, *s
= NULL
, *c
= NULL
;
735 for (emission
= g_restart_emissions
; emission
; emission
= emission
->next
)
736 if (emission
->instance
== instance
)
741 for (emission
= g_recursive_emissions
; emission
; emission
= emission
->next
)
742 if (emission
->instance
== instance
)
752 return G_HAVE_GROWING_STACK
? MAX (c
, s
) : MIN (c
, s
);
756 signal_key_cmp (gconstpointer node1
,
759 const SignalKey
*key1
= node1
, *key2
= node2
;
761 if (key1
->itype
== key2
->itype
)
762 return G_BSEARCH_ARRAY_CMP (key1
->quark
, key2
->quark
);
764 return G_BSEARCH_ARRAY_CMP (key1
->itype
, key2
->itype
);
771 if (!g_n_signal_nodes
)
773 /* setup handler list binary searchable array hash table (in german, that'd be one word ;) */
774 g_handler_list_bsa_ht
= g_hash_table_new (g_direct_hash
, NULL
);
775 g_signal_key_bsa
= g_bsearch_array_create (&g_signal_key_bconfig
);
777 /* invalid (0) signal_id */
778 g_n_signal_nodes
= 1;
779 g_signal_nodes
= g_renew (SignalNode
*, g_signal_nodes
, g_n_signal_nodes
);
780 g_signal_nodes
[0] = NULL
;
786 _g_signals_destroy (GType itype
)
791 for (i
= 1; i
< g_n_signal_nodes
; i
++)
793 SignalNode
*node
= g_signal_nodes
[i
];
795 if (node
->itype
== itype
)
798 g_warning (G_STRLOC
": signal \"%s\" of type `%s' already destroyed",
800 type_debug_name (node
->itype
));
802 signal_destroy_R (node
);
809 * g_signal_stop_emission:
810 * @instance: the object whose signal handlers you wish to stop.
811 * @signal_id: the signal identifier, as returned by g_signal_lookup().
812 * @detail: the detail which the signal was emitted with.
814 * Stops a signal's current emission.
816 * This will prevent the default method from running, if the signal was
817 * %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
820 * Prints a warning if used on a signal which isn't being emitted.
823 g_signal_stop_emission (gpointer instance
,
829 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
830 g_return_if_fail (signal_id
> 0);
833 node
= LOOKUP_SIGNAL_NODE (signal_id
);
834 if (node
&& detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
836 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC
, signal_id
, detail
);
840 if (node
&& g_type_is_a (G_TYPE_FROM_INSTANCE (instance
), node
->itype
))
842 Emission
*emission_list
= node
->flags
& G_SIGNAL_NO_RECURSE
? g_restart_emissions
: g_recursive_emissions
;
843 Emission
*emission
= emission_find (emission_list
, signal_id
, detail
, instance
);
847 if (emission
->state
== EMISSION_HOOK
)
848 g_warning (G_STRLOC
": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
849 node
->name
, instance
);
850 else if (emission
->state
== EMISSION_RUN
)
851 emission
->state
= EMISSION_STOP
;
854 g_warning (G_STRLOC
": no emission of signal \"%s\" to stop for instance `%p'",
855 node
->name
, instance
);
858 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC
, signal_id
, instance
);
863 signal_finalize_hook (GHookList
*hook_list
,
866 GDestroyNotify destroy
= hook
->destroy
;
870 hook
->destroy
= NULL
;
872 destroy (hook
->data
);
878 * g_signal_add_emission_hook:
879 * @signal_id: the signal identifier, as returned by g_signal_lookup().
880 * @detail: the detail on which to call the hook.
881 * @hook_func: a #GSignalEmissionHook function.
882 * @hook_data: user data for @hook_func.
883 * @data_destroy: a #GDestroyNotify for @hook_data.
885 * Adds an emission hook for a signal, which will get called for any emission
886 * of that signal, independent of the instance. This is possible only
887 * for signals which don't have #G_SIGNAL_NO_HOOKS flag set.
889 * Returns: the hook id, for later use with g_signal_remove_emission_hook().
892 g_signal_add_emission_hook (guint signal_id
,
894 GSignalEmissionHook hook_func
,
896 GDestroyNotify data_destroy
)
898 static gulong seq_hook_id
= 1;
901 SignalHook
*signal_hook
;
903 g_return_val_if_fail (signal_id
> 0, 0);
904 g_return_val_if_fail (hook_func
!= NULL
, 0);
907 node
= LOOKUP_SIGNAL_NODE (signal_id
);
908 if (!node
|| node
->destroyed
)
910 g_warning ("%s: invalid signal id `%u'", G_STRLOC
, signal_id
);
914 if (node
->flags
& G_SIGNAL_NO_HOOKS
)
916 g_warning ("%s: signal id `%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC
, signal_id
);
920 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
922 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC
, signal_id
, detail
);
926 if (!node
->emission_hooks
)
928 node
->emission_hooks
= g_new (GHookList
, 1);
929 g_hook_list_init (node
->emission_hooks
, sizeof (SignalHook
));
930 node
->emission_hooks
->finalize_hook
= signal_finalize_hook
;
932 hook
= g_hook_alloc (node
->emission_hooks
);
933 hook
->data
= hook_data
;
934 hook
->func
= (gpointer
) hook_func
;
935 hook
->destroy
= data_destroy
;
936 signal_hook
= SIGNAL_HOOK (hook
);
937 signal_hook
->detail
= detail
;
938 node
->emission_hooks
->seq_id
= seq_hook_id
;
939 g_hook_append (node
->emission_hooks
, hook
);
940 seq_hook_id
= node
->emission_hooks
->seq_id
;
943 return hook
->hook_id
;
947 * g_signal_remove_emission_hook:
948 * @signal_id: the id of the signal
949 * @hook_id: the id of the emission hook, as returned by
950 * g_signal_add_emission_hook()
952 * Deletes an emission hook.
955 g_signal_remove_emission_hook (guint signal_id
,
960 g_return_if_fail (signal_id
> 0);
961 g_return_if_fail (hook_id
> 0);
964 node
= LOOKUP_SIGNAL_NODE (signal_id
);
965 if (!node
|| node
->destroyed
)
966 g_warning ("%s: invalid signal id `%u'", G_STRLOC
, signal_id
);
967 else if (!node
->emission_hooks
|| !g_hook_destroy (node
->emission_hooks
, hook_id
))
968 g_warning ("%s: signal \"%s\" had no hook (%lu) to remove", G_STRLOC
, node
->name
, hook_id
);
973 signal_parse_name (const gchar
*name
,
976 gboolean force_quark
)
978 const gchar
*colon
= strchr (name
, ':');
983 signal_id
= signal_id_lookup (g_quark_try_string (name
), itype
);
984 if (signal_id
&& detail_p
)
987 else if (colon
[1] == ':')
990 guint l
= colon
- name
;
994 memcpy (buffer
, name
, l
);
996 signal_id
= signal_id_lookup (g_quark_try_string (buffer
), itype
);
1000 gchar
*signal
= g_new (gchar
, l
+ 1);
1002 memcpy (signal
, name
, l
);
1004 signal_id
= signal_id_lookup (g_quark_try_string (signal
), itype
);
1008 if (signal_id
&& detail_p
)
1009 *detail_p
= colon
[2] ? (force_quark
? g_quark_from_string
: g_quark_try_string
) (colon
+ 2) : 0;
1017 * g_signal_parse_name:
1018 * @detailed_signal: a string of the form "signal-name::detail".
1019 * @itype: The interface/instance type that introduced "signal-name".
1020 * @signal_id_p: Location to store the signal id.
1021 * @detail_p: Location to store the detail quark.
1022 * @force_detail_quark: %TRUE forces creation of a #GQuark for the detail.
1024 * Internal function to parse a signal name into its @signal_id
1025 * and @detail quark.
1027 * Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
1030 g_signal_parse_name (const gchar
*detailed_signal
,
1034 gboolean force_detail_quark
)
1040 g_return_val_if_fail (detailed_signal
!= NULL
, FALSE
);
1041 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype
) || G_TYPE_IS_INTERFACE (itype
), FALSE
);
1044 signal_id
= signal_parse_name (detailed_signal
, itype
, &detail
, force_detail_quark
);
1047 node
= signal_id
? LOOKUP_SIGNAL_NODE (signal_id
) : NULL
;
1048 if (!node
|| node
->destroyed
||
1049 (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
)))
1053 *signal_id_p
= signal_id
;
1061 * g_signal_stop_emission_by_name:
1062 * @instance: the object whose signal handlers you wish to stop.
1063 * @detailed_signal: a string of the form "signal-name::detail".
1065 * Stops a signal's current emission.
1067 * This is just like g_signal_stop_emission() except it will look up the
1068 * signal id for you.
1071 g_signal_stop_emission_by_name (gpointer instance
,
1072 const gchar
*detailed_signal
)
1078 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
1079 g_return_if_fail (detailed_signal
!= NULL
);
1082 itype
= G_TYPE_FROM_INSTANCE (instance
);
1083 signal_id
= signal_parse_name (detailed_signal
, itype
, &detail
, TRUE
);
1086 SignalNode
*node
= LOOKUP_SIGNAL_NODE (signal_id
);
1088 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
1089 g_warning ("%s: signal `%s' does not support details", G_STRLOC
, detailed_signal
);
1090 else if (!g_type_is_a (itype
, node
->itype
))
1091 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
1094 Emission
*emission_list
= node
->flags
& G_SIGNAL_NO_RECURSE
? g_restart_emissions
: g_recursive_emissions
;
1095 Emission
*emission
= emission_find (emission_list
, signal_id
, detail
, instance
);
1099 if (emission
->state
== EMISSION_HOOK
)
1100 g_warning (G_STRLOC
": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
1101 node
->name
, instance
);
1102 else if (emission
->state
== EMISSION_RUN
)
1103 emission
->state
= EMISSION_STOP
;
1106 g_warning (G_STRLOC
": no emission of signal \"%s\" to stop for instance `%p'",
1107 node
->name
, instance
);
1111 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
1117 * @name: the signal's name.
1118 * @itype: the type that the signal operates on.
1120 * Given the name of the signal and the type of object it connects to, gets
1121 * the signal's identifying integer. Emitting the signal by number is
1122 * somewhat faster than using the name each time.
1124 * Also tries the ancestors of the given type.
1126 * See g_signal_new() for details on allowed signal names.
1128 * Returns: the signal's identifying number, or 0 if no signal was found.
1131 g_signal_lookup (const gchar
*name
,
1135 g_return_val_if_fail (name
!= NULL
, 0);
1136 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype
) || G_TYPE_IS_INTERFACE (itype
), 0);
1139 signal_id
= signal_id_lookup (g_quark_try_string (name
), itype
);
1143 /* give elaborate warnings */
1144 if (!g_type_name (itype
))
1145 g_warning (G_STRLOC
": unable to lookup signal \"%s\" for invalid type id `%"G_GSIZE_FORMAT
"'",
1147 else if (!G_TYPE_IS_INSTANTIATABLE (itype
))
1148 g_warning (G_STRLOC
": unable to lookup signal \"%s\" for non instantiatable type `%s'",
1149 name
, g_type_name (itype
));
1150 else if (!g_type_class_peek (itype
))
1151 g_warning (G_STRLOC
": unable to lookup signal \"%s\" of unloaded type `%s'",
1152 name
, g_type_name (itype
));
1159 * g_signal_list_ids:
1160 * @itype: Instance or interface type.
1161 * @n_ids: Location to store the number of signal ids for @itype.
1163 * Lists the signals by id that a certain instance or interface type
1164 * created. Further information about the signals can be acquired through
1167 * Returns: Newly allocated array of signal IDs.
1170 g_signal_list_ids (GType itype
,
1178 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype
) || G_TYPE_IS_INTERFACE (itype
), NULL
);
1179 g_return_val_if_fail (n_ids
!= NULL
, NULL
);
1182 keys
= g_bsearch_array_get_nth (g_signal_key_bsa
, &g_signal_key_bconfig
, 0);
1183 n_nodes
= g_bsearch_array_get_n_nodes (g_signal_key_bsa
);
1184 result
= g_array_new (FALSE
, FALSE
, sizeof (guint
));
1186 for (i
= 0; i
< n_nodes
; i
++)
1187 if (keys
[i
].itype
== itype
)
1189 const gchar
*name
= g_quark_to_string (keys
[i
].quark
);
1191 /* Signal names with "_" in them are aliases to the same
1192 * name with "-" instead of "_".
1194 if (!strchr (name
, '_'))
1195 g_array_append_val (result
, keys
[i
].signal_id
);
1197 *n_ids
= result
->len
;
1201 /* give elaborate warnings */
1202 if (!g_type_name (itype
))
1203 g_warning (G_STRLOC
": unable to list signals for invalid type id `%"G_GSIZE_FORMAT
"'",
1205 else if (!G_TYPE_IS_INSTANTIATABLE (itype
) && !G_TYPE_IS_INTERFACE (itype
))
1206 g_warning (G_STRLOC
": unable to list signals of non instantiatable type `%s'",
1207 g_type_name (itype
));
1208 else if (!g_type_class_peek (itype
) && !G_TYPE_IS_INTERFACE (itype
))
1209 g_warning (G_STRLOC
": unable to list signals of unloaded type `%s'",
1210 g_type_name (itype
));
1213 return (guint
*) g_array_free (result
, FALSE
);
1218 * @signal_id: the signal's identifying number.
1220 * Given the signal's identifier, finds its name.
1222 * Two different signals may have the same name, if they have differing types.
1224 * Returns: the signal name, or %NULL if the signal number was invalid.
1226 G_CONST_RETURN gchar
*
1227 g_signal_name (guint signal_id
)
1233 node
= LOOKUP_SIGNAL_NODE (signal_id
);
1234 name
= node
? node
->name
: NULL
;
1237 return (char*) name
;
1242 * @signal_id: The signal id of the signal to query information for.
1243 * @query: A user provided structure that is filled in with constant
1244 * values upon success.
1246 * Queries the signal system for in-depth information about a
1247 * specific signal. This function will fill in a user-provided
1248 * structure to hold signal-specific information. If an invalid
1249 * signal id is passed in, the @signal_id member of the #GSignalQuery
1250 * is 0. All members filled into the #GSignalQuery structure should
1251 * be considered constant and have to be left untouched.
1254 g_signal_query (guint signal_id
,
1255 GSignalQuery
*query
)
1259 g_return_if_fail (query
!= NULL
);
1262 node
= LOOKUP_SIGNAL_NODE (signal_id
);
1263 if (!node
|| node
->destroyed
)
1264 query
->signal_id
= 0;
1267 query
->signal_id
= node
->signal_id
;
1268 query
->signal_name
= node
->name
;
1269 query
->itype
= node
->itype
;
1270 query
->signal_flags
= node
->flags
;
1271 query
->return_type
= node
->return_type
;
1272 query
->n_params
= node
->n_params
;
1273 query
->param_types
= node
->param_types
;
1280 * @signal_name: the name for the signal
1281 * @itype: the type this signal pertains to. It will also pertain to
1282 * types which are derived from this type.
1283 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1284 * the default handler is to be invoked. You should at least specify
1285 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1286 * @class_offset: The offset of the function pointer in the class structure
1287 * for this type. Used to invoke a class method generically. Pass 0 to
1288 * not associate a class method slot with this signal.
1289 * @accumulator: the accumulator for this signal; may be %NULL.
1290 * @accu_data: user data for the @accumulator.
1291 * @c_marshaller: the function to translate arrays of parameter values to
1292 * signal emissions into C language callback invocations.
1293 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1294 * without a return value.
1295 * @n_params: the number of parameter types to follow.
1296 * @...: a list of types, one for each parameter.
1298 * Creates a new signal. (This is usually done in the class initializer.)
1300 * A signal name consists of segments consisting of ASCII letters and
1301 * digits, separated by either the '-' or '_' character. The first
1302 * character of a signal name must be a letter. Names which violate these
1303 * rules lead to undefined behaviour of the GSignal system.
1305 * When registering a signal and looking up a signal, either separator can
1306 * be used, but they cannot be mixed.
1308 * If 0 is used for @class_offset subclasses cannot override the class handler
1309 * in their <code>class_init</code> method by doing
1310 * <code>super_class->signal_handler = my_signal_handler</code>. Instead they
1311 * will have to use g_signal_override_class_handler().
1313 * Returns: the signal id
1316 g_signal_new (const gchar
*signal_name
,
1318 GSignalFlags signal_flags
,
1320 GSignalAccumulator accumulator
,
1322 GSignalCMarshaller c_marshaller
,
1330 g_return_val_if_fail (signal_name
!= NULL
, 0);
1332 va_start (args
, n_params
);
1334 signal_id
= g_signal_new_valist (signal_name
, itype
, signal_flags
,
1335 class_offset
? g_signal_type_cclosure_new (itype
, class_offset
) : NULL
,
1336 accumulator
, accu_data
, c_marshaller
,
1337 return_type
, n_params
, args
);
1341 /* optimize NOP emissions with NULL class handlers */
1342 if (signal_id
&& G_TYPE_IS_INSTANTIATABLE (itype
) && return_type
== G_TYPE_NONE
&&
1343 class_offset
&& class_offset
< MAX_TEST_CLASS_OFFSET
)
1348 node
= LOOKUP_SIGNAL_NODE (signal_id
);
1349 node
->test_class_offset
= class_offset
;
1357 * g_signal_new_class_handler:
1358 * @signal_name: the name for the signal
1359 * @itype: the type this signal pertains to. It will also pertain to
1360 * types which are derived from this type.
1361 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1362 * the default handler is to be invoked. You should at least specify
1363 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1364 * @class_handler: a #GCallback which acts as class implementation of
1365 * this signal. Used to invoke a class method generically. Pass %NULL to
1366 * not associate a class method with this signal.
1367 * @accumulator: the accumulator for this signal; may be %NULL.
1368 * @accu_data: user data for the @accumulator.
1369 * @c_marshaller: the function to translate arrays of parameter values to
1370 * signal emissions into C language callback invocations.
1371 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1372 * without a return value.
1373 * @n_params: the number of parameter types to follow.
1374 * @...: a list of types, one for each parameter.
1376 * Creates a new signal. (This is usually done in the class initializer.)
1378 * This is a variant of g_signal_new() that takes a C callback instead
1379 * off a class offset for the signal's class handler. This function
1380 * doesn't need a function pointer exposed in the class structure of
1381 * an object definition, instead the function pointer is passed
1382 * directly and can be overriden by derived classes with
1383 * g_signal_override_class_closure() or
1384 * g_signal_override_class_handler()and chained to with
1385 * g_signal_chain_from_overridden() or
1386 * g_signal_chain_from_overridden_handler().
1388 * See g_signal_new() for information about signal names.
1390 * Returns: the signal id
1395 g_signal_new_class_handler (const gchar
*signal_name
,
1397 GSignalFlags signal_flags
,
1398 GCallback class_handler
,
1399 GSignalAccumulator accumulator
,
1401 GSignalCMarshaller c_marshaller
,
1409 g_return_val_if_fail (signal_name
!= NULL
, 0);
1411 va_start (args
, n_params
);
1413 signal_id
= g_signal_new_valist (signal_name
, itype
, signal_flags
,
1414 class_handler
? g_cclosure_new (class_handler
, NULL
, NULL
) : NULL
,
1415 accumulator
, accu_data
, c_marshaller
,
1416 return_type
, n_params
, args
);
1423 static inline ClassClosure
*
1424 signal_find_class_closure (SignalNode
*node
,
1427 GBSearchArray
*bsa
= node
->class_closure_bsa
;
1434 /* cc->instance_type is 0 for default closure */
1436 key
.instance_type
= itype
;
1437 cc
= g_bsearch_array_lookup (bsa
, &g_class_closure_bconfig
, &key
);
1438 while (!cc
&& key
.instance_type
)
1440 key
.instance_type
= g_type_parent (key
.instance_type
);
1441 cc
= g_bsearch_array_lookup (bsa
, &g_class_closure_bconfig
, &key
);
1449 static inline GClosure
*
1450 signal_lookup_closure (SignalNode
*node
,
1451 GTypeInstance
*instance
)
1455 if (node
->class_closure_bsa
&& g_bsearch_array_get_n_nodes (node
->class_closure_bsa
) == 1)
1457 cc
= g_bsearch_array_get_nth (node
->class_closure_bsa
, &g_class_closure_bconfig
, 0);
1458 if (cc
&& cc
->instance_type
== 0) /* check for default closure */
1461 cc
= signal_find_class_closure (node
, G_TYPE_FROM_INSTANCE (instance
));
1462 return cc
? cc
->closure
: NULL
;
1466 signal_add_class_closure (SignalNode
*node
,
1472 /* can't optimize NOP emissions with overridden class closures */
1473 node
->test_class_offset
= 0;
1475 if (!node
->class_closure_bsa
)
1476 node
->class_closure_bsa
= g_bsearch_array_create (&g_class_closure_bconfig
);
1477 key
.instance_type
= itype
;
1478 key
.closure
= g_closure_ref (closure
);
1479 node
->class_closure_bsa
= g_bsearch_array_insert (node
->class_closure_bsa
,
1480 &g_class_closure_bconfig
,
1482 g_closure_sink (closure
);
1483 if (node
->c_marshaller
&& closure
&& G_CLOSURE_NEEDS_MARSHAL (closure
))
1484 g_closure_set_marshal (closure
, node
->c_marshaller
);
1489 * @signal_name: the name for the signal
1490 * @itype: the type this signal pertains to. It will also pertain to
1491 * types which are derived from this type
1492 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1493 * the default handler is to be invoked. You should at least specify
1494 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
1495 * @class_closure: The closure to invoke on signal emission; may be %NULL
1496 * @accumulator: the accumulator for this signal; may be %NULL
1497 * @accu_data: user data for the @accumulator
1498 * @c_marshaller: the function to translate arrays of parameter values to
1499 * signal emissions into C language callback invocations
1500 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1501 * without a return value
1502 * @n_params: the length of @param_types
1503 * @param_types: an array of types, one for each parameter
1505 * Creates a new signal. (This is usually done in the class initializer.)
1507 * See g_signal_new() for details on allowed signal names.
1509 * Returns: the signal id
1512 g_signal_newv (const gchar
*signal_name
,
1514 GSignalFlags signal_flags
,
1515 GClosure
*class_closure
,
1516 GSignalAccumulator accumulator
,
1518 GSignalCMarshaller c_marshaller
,
1527 g_return_val_if_fail (signal_name
!= NULL
, 0);
1528 g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype
) || G_TYPE_IS_INTERFACE (itype
), 0);
1530 g_return_val_if_fail (param_types
!= NULL
, 0);
1531 g_return_val_if_fail ((return_type
& G_SIGNAL_TYPE_STATIC_SCOPE
) == 0, 0);
1532 if (return_type
== (G_TYPE_NONE
& ~G_SIGNAL_TYPE_STATIC_SCOPE
))
1533 g_return_val_if_fail (accumulator
== NULL
, 0);
1535 g_return_val_if_fail (accu_data
== NULL
, 0);
1537 name
= g_strdup (signal_name
);
1538 g_strdelimit (name
, G_STR_DELIMITERS
":^", '_'); /* FIXME do character checks like for types */
1542 signal_id
= signal_id_lookup (g_quark_try_string (name
), itype
);
1543 node
= LOOKUP_SIGNAL_NODE (signal_id
);
1544 if (node
&& !node
->destroyed
)
1546 g_warning (G_STRLOC
": signal \"%s\" already exists in the `%s' %s",
1548 type_debug_name (node
->itype
),
1549 G_TYPE_IS_INTERFACE (node
->itype
) ? "interface" : "class ancestry");
1554 if (node
&& node
->itype
!= itype
)
1556 g_warning (G_STRLOC
": signal \"%s\" for type `%s' was previously created for type `%s'",
1558 type_debug_name (itype
),
1559 type_debug_name (node
->itype
));
1564 for (i
= 0; i
< n_params
; i
++)
1565 if (!G_TYPE_IS_VALUE (param_types
[i
] & ~G_SIGNAL_TYPE_STATIC_SCOPE
))
1567 g_warning (G_STRLOC
": parameter %d of type `%s' for signal \"%s::%s\" is not a value type",
1568 i
+ 1, type_debug_name (param_types
[i
]), type_debug_name (itype
), name
);
1573 if (return_type
!= G_TYPE_NONE
&& !G_TYPE_IS_VALUE (return_type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
))
1575 g_warning (G_STRLOC
": return value of type `%s' for signal \"%s::%s\" is not a value type",
1576 type_debug_name (return_type
), type_debug_name (itype
), name
);
1581 if (return_type
!= G_TYPE_NONE
&&
1582 (signal_flags
& (G_SIGNAL_RUN_FIRST
| G_SIGNAL_RUN_LAST
| G_SIGNAL_RUN_CLEANUP
)) == G_SIGNAL_RUN_FIRST
)
1584 g_warning (G_STRLOC
": signal \"%s::%s\" has return type `%s' and is only G_SIGNAL_RUN_FIRST",
1585 type_debug_name (itype
), name
, type_debug_name (return_type
));
1591 /* setup permanent portion of signal node */
1596 signal_id
= g_n_signal_nodes
++;
1597 node
= g_new (SignalNode
, 1);
1598 node
->signal_id
= signal_id
;
1599 g_signal_nodes
= g_renew (SignalNode
*, g_signal_nodes
, g_n_signal_nodes
);
1600 g_signal_nodes
[signal_id
] = node
;
1601 node
->itype
= itype
;
1604 key
.quark
= g_quark_from_string (node
->name
);
1605 key
.signal_id
= signal_id
;
1606 g_signal_key_bsa
= g_bsearch_array_insert (g_signal_key_bsa
, &g_signal_key_bconfig
, &key
);
1607 g_strdelimit (name
, "_", '-');
1608 node
->name
= g_intern_string (name
);
1609 key
.quark
= g_quark_from_string (name
);
1610 g_signal_key_bsa
= g_bsearch_array_insert (g_signal_key_bsa
, &g_signal_key_bconfig
, &key
);
1612 TRACE(GOBJECT_SIGNAL_NEW(signal_id
, name
, itype
));
1614 node
->destroyed
= FALSE
;
1615 node
->test_class_offset
= 0;
1617 /* setup reinitializable portion */
1618 node
->flags
= signal_flags
& G_SIGNAL_FLAGS_MASK
;
1619 node
->n_params
= n_params
;
1620 node
->param_types
= g_memdup (param_types
, sizeof (GType
) * n_params
);
1621 node
->return_type
= return_type
;
1622 node
->class_closure_bsa
= NULL
;
1625 node
->accumulator
= g_new (SignalAccumulator
, 1);
1626 node
->accumulator
->func
= accumulator
;
1627 node
->accumulator
->data
= accu_data
;
1630 node
->accumulator
= NULL
;
1631 node
->c_marshaller
= c_marshaller
;
1632 node
->emission_hooks
= NULL
;
1634 signal_add_class_closure (node
, 0, class_closure
);
1635 else if (G_TYPE_IS_INSTANTIATABLE (itype
) && return_type
== G_TYPE_NONE
)
1637 /* optimize NOP emissions */
1638 node
->test_class_offset
= TEST_CLASS_MAGIC
;
1648 * g_signal_new_valist:
1649 * @signal_name: the name for the signal
1650 * @itype: the type this signal pertains to. It will also pertain to
1651 * types which are derived from this type.
1652 * @signal_flags: a combination of #GSignalFlags specifying detail of when
1653 * the default handler is to be invoked. You should at least specify
1654 * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1655 * @class_closure: The closure to invoke on signal emission; may be %NULL.
1656 * @accumulator: the accumulator for this signal; may be %NULL.
1657 * @accu_data: user data for the @accumulator.
1658 * @c_marshaller: the function to translate arrays of parameter values to
1659 * signal emissions into C language callback invocations.
1660 * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1661 * without a return value.
1662 * @n_params: the number of parameter types in @args.
1663 * @args: va_list of #GType, one for each parameter.
1665 * Creates a new signal. (This is usually done in the class initializer.)
1667 * See g_signal_new() for details on allowed signal names.
1669 * Returns: the signal id
1672 g_signal_new_valist (const gchar
*signal_name
,
1674 GSignalFlags signal_flags
,
1675 GClosure
*class_closure
,
1676 GSignalAccumulator accumulator
,
1678 GSignalCMarshaller c_marshaller
,
1689 param_types
= g_new (GType
, n_params
);
1691 for (i
= 0; i
< n_params
; i
++)
1692 param_types
[i
] = va_arg (args
, GType
);
1697 signal_id
= g_signal_newv (signal_name
, itype
, signal_flags
,
1698 class_closure
, accumulator
, accu_data
, c_marshaller
,
1699 return_type
, n_params
, param_types
);
1700 g_free (param_types
);
1706 signal_destroy_R (SignalNode
*signal_node
)
1708 SignalNode node
= *signal_node
;
1710 signal_node
->destroyed
= TRUE
;
1712 /* reentrancy caution, zero out real contents first */
1713 signal_node
->test_class_offset
= 0;
1714 signal_node
->n_params
= 0;
1715 signal_node
->param_types
= NULL
;
1716 signal_node
->return_type
= 0;
1717 signal_node
->class_closure_bsa
= NULL
;
1718 signal_node
->accumulator
= NULL
;
1719 signal_node
->c_marshaller
= NULL
;
1720 signal_node
->emission_hooks
= NULL
;
1722 #ifdef G_ENABLE_DEBUG
1723 /* check current emissions */
1727 for (emission
= (node
.flags
& G_SIGNAL_NO_RECURSE
) ? g_restart_emissions
: g_recursive_emissions
;
1728 emission
; emission
= emission
->next
)
1729 if (emission
->ihint
.signal_id
== node
.signal_id
)
1730 g_critical (G_STRLOC
": signal \"%s\" being destroyed is currently in emission (instance `%p')",
1731 node
.name
, emission
->instance
);
1735 /* free contents that need to
1738 g_free (node
.param_types
);
1739 if (node
.class_closure_bsa
)
1743 for (i
= 0; i
< node
.class_closure_bsa
->n_nodes
; i
++)
1745 ClassClosure
*cc
= g_bsearch_array_get_nth (node
.class_closure_bsa
, &g_class_closure_bconfig
, i
);
1747 g_closure_unref (cc
->closure
);
1749 g_bsearch_array_free (node
.class_closure_bsa
, &g_class_closure_bconfig
);
1751 g_free (node
.accumulator
);
1752 if (node
.emission_hooks
)
1754 g_hook_list_clear (node
.emission_hooks
);
1755 g_free (node
.emission_hooks
);
1761 * g_signal_override_class_closure:
1762 * @signal_id: the signal id
1763 * @instance_type: the instance type on which to override the class closure
1765 * @class_closure: the closure.
1767 * Overrides the class closure (i.e. the default handler) for the given signal
1768 * for emissions on instances of @instance_type. @instance_type must be derived
1769 * from the type to which the signal belongs.
1771 * See g_signal_chain_from_overridden() and
1772 * g_signal_chain_from_overridden_handler() for how to chain up to the
1773 * parent class closure from inside the overridden one.
1776 g_signal_override_class_closure (guint signal_id
,
1777 GType instance_type
,
1778 GClosure
*class_closure
)
1782 g_return_if_fail (signal_id
> 0);
1783 g_return_if_fail (class_closure
!= NULL
);
1786 node
= LOOKUP_SIGNAL_NODE (signal_id
);
1787 if (!g_type_is_a (instance_type
, node
->itype
))
1788 g_warning ("%s: type `%s' cannot be overridden for signal id `%u'", G_STRLOC
, type_debug_name (instance_type
), signal_id
);
1791 ClassClosure
*cc
= signal_find_class_closure (node
, instance_type
);
1793 if (cc
&& cc
->instance_type
== instance_type
)
1794 g_warning ("%s: type `%s' is already overridden for signal id `%u'", G_STRLOC
, type_debug_name (instance_type
), signal_id
);
1796 signal_add_class_closure (node
, instance_type
, class_closure
);
1802 * g_signal_override_class_handler:
1803 * @signal_name: the name for the signal
1804 * @instance_type: the instance type on which to override the class handler
1806 * @class_handler: the handler.
1808 * Overrides the class closure (i.e. the default handler) for the
1809 * given signal for emissions on instances of @instance_type with
1810 * callabck @class_handler. @instance_type must be derived from the
1811 * type to which the signal belongs.
1813 * See g_signal_chain_from_overridden() and
1814 * g_signal_chain_from_overridden_handler() for how to chain up to the
1815 * parent class closure from inside the overridden one.
1820 g_signal_override_class_handler (const gchar
*signal_name
,
1821 GType instance_type
,
1822 GCallback class_handler
)
1826 g_return_if_fail (signal_name
!= NULL
);
1827 g_return_if_fail (instance_type
!= G_TYPE_NONE
);
1828 g_return_if_fail (class_handler
!= NULL
);
1830 signal_id
= g_signal_lookup (signal_name
, instance_type
);
1833 g_signal_override_class_closure (signal_id
, instance_type
,
1834 g_cclosure_new (class_handler
, NULL
, NULL
));
1836 g_warning ("%s: signal name '%s' is invalid for type id '%"G_GSIZE_FORMAT
"'",
1837 G_STRLOC
, signal_name
, instance_type
);
1842 * g_signal_chain_from_overridden:
1843 * @instance_and_params: the argument list of the signal emission. The first
1844 * element in the array is a #GValue for the instance the signal is being
1845 * emitted on. The rest are any arguments to be passed to the signal.
1846 * @return_value: Location for the return value.
1848 * Calls the original class closure of a signal. This function should only
1849 * be called from an overridden class closure; see
1850 * g_signal_override_class_closure() and
1851 * g_signal_override_class_handler().
1854 g_signal_chain_from_overridden (const GValue
*instance_and_params
,
1855 GValue
*return_value
)
1857 GType chain_type
= 0, restore_type
= 0;
1858 Emission
*emission
= NULL
;
1859 GClosure
*closure
= NULL
;
1863 g_return_if_fail (instance_and_params
!= NULL
);
1864 instance
= g_value_peek_pointer (instance_and_params
);
1865 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
1868 emission
= emission_find_innermost (instance
);
1871 SignalNode
*node
= LOOKUP_SIGNAL_NODE (emission
->ihint
.signal_id
);
1873 g_assert (node
!= NULL
); /* paranoid */
1875 /* we should probably do the same parameter checks as g_signal_emit() here.
1877 if (emission
->chain_type
!= G_TYPE_NONE
)
1879 ClassClosure
*cc
= signal_find_class_closure (node
, emission
->chain_type
);
1881 g_assert (cc
!= NULL
); /* closure currently in call stack */
1883 n_params
= node
->n_params
;
1884 restore_type
= cc
->instance_type
;
1885 cc
= signal_find_class_closure (node
, g_type_parent (cc
->instance_type
));
1886 if (cc
&& cc
->instance_type
!= restore_type
)
1888 closure
= cc
->closure
;
1889 chain_type
= cc
->instance_type
;
1893 g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC
, node
->signal_id
, instance
);
1896 g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC
, instance
);
1900 emission
->chain_type
= chain_type
;
1902 g_closure_invoke (closure
,
1905 instance_and_params
,
1908 emission
->chain_type
= restore_type
;
1914 * g_signal_chain_from_overridden_handler:
1915 * @instance: the instance the signal is being emitted on.
1916 * @...: parameters to be passed to the parent class closure, followed by a
1917 * location for the return value. If the return type of the signal
1918 * is #G_TYPE_NONE, the return value location can be omitted.
1920 * Calls the original class closure of a signal. This function should
1921 * only be called from an overridden class closure; see
1922 * g_signal_override_class_closure() and
1923 * g_signal_override_class_handler().
1928 g_signal_chain_from_overridden_handler (gpointer instance
,
1931 GType chain_type
= 0, restore_type
= 0;
1932 Emission
*emission
= NULL
;
1933 GClosure
*closure
= NULL
;
1937 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
1940 emission
= emission_find_innermost (instance
);
1943 node
= LOOKUP_SIGNAL_NODE (emission
->ihint
.signal_id
);
1945 g_assert (node
!= NULL
); /* paranoid */
1947 /* we should probably do the same parameter checks as g_signal_emit() here.
1949 if (emission
->chain_type
!= G_TYPE_NONE
)
1951 ClassClosure
*cc
= signal_find_class_closure (node
, emission
->chain_type
);
1953 g_assert (cc
!= NULL
); /* closure currently in call stack */
1955 n_params
= node
->n_params
;
1956 restore_type
= cc
->instance_type
;
1957 cc
= signal_find_class_closure (node
, g_type_parent (cc
->instance_type
));
1958 if (cc
&& cc
->instance_type
!= restore_type
)
1960 closure
= cc
->closure
;
1961 chain_type
= cc
->instance_type
;
1965 g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC
, node
->signal_id
, instance
);
1968 g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC
, instance
);
1972 GValue
*instance_and_params
;
1973 GType signal_return_type
;
1974 GValue
*param_values
;
1978 va_start (var_args
, instance
);
1980 signal_return_type
= node
->return_type
;
1981 instance_and_params
= g_slice_alloc0 (sizeof (GValue
) * (n_params
+ 1));
1982 param_values
= instance_and_params
+ 1;
1984 for (i
= 0; i
< node
->n_params
; i
++)
1987 GType ptype
= node
->param_types
[i
] & ~G_SIGNAL_TYPE_STATIC_SCOPE
;
1988 gboolean static_scope
= node
->param_types
[i
] & G_SIGNAL_TYPE_STATIC_SCOPE
;
1991 G_VALUE_COLLECT_INIT (param_values
+ i
, ptype
,
1993 static_scope
? G_VALUE_NOCOPY_CONTENTS
: 0,
1997 g_warning ("%s: %s", G_STRLOC
, error
);
2000 /* we purposely leak the value here, it might not be
2001 * in a sane state if an error condition occoured
2004 g_value_unset (param_values
+ i
);
2006 g_slice_free1 (sizeof (GValue
) * (n_params
+ 1), instance_and_params
);
2014 instance_and_params
->g_type
= 0;
2015 g_value_init (instance_and_params
, G_TYPE_FROM_INSTANCE (instance
));
2016 g_value_set_instance (instance_and_params
, instance
);
2019 emission
->chain_type
= chain_type
;
2022 if (signal_return_type
== G_TYPE_NONE
)
2024 g_closure_invoke (closure
,
2027 instance_and_params
,
2032 GValue return_value
= { 0, };
2033 gchar
*error
= NULL
;
2034 GType rtype
= signal_return_type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
;
2035 gboolean static_scope
= signal_return_type
& G_SIGNAL_TYPE_STATIC_SCOPE
;
2037 g_value_init (&return_value
, rtype
);
2039 g_closure_invoke (closure
,
2042 instance_and_params
,
2045 G_VALUE_LCOPY (&return_value
,
2047 static_scope
? G_VALUE_NOCOPY_CONTENTS
: 0,
2051 g_value_unset (&return_value
);
2055 g_warning ("%s: %s", G_STRLOC
, error
);
2058 /* we purposely leak the value here, it might not be
2059 * in a sane state if an error condition occured
2064 for (i
= 0; i
< n_params
; i
++)
2065 g_value_unset (param_values
+ i
);
2066 g_value_unset (instance_and_params
);
2067 g_slice_free1 (sizeof (GValue
) * (n_params
+ 1), instance_and_params
);
2072 emission
->chain_type
= restore_type
;
2078 * g_signal_get_invocation_hint:
2079 * @instance: the instance to query
2081 * Returns the invocation hint of the innermost signal emission of instance.
2083 * Returns: the invocation hint of the innermost signal emission.
2085 GSignalInvocationHint
*
2086 g_signal_get_invocation_hint (gpointer instance
)
2088 Emission
*emission
= NULL
;
2090 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), NULL
);
2093 emission
= emission_find_innermost (instance
);
2096 return emission
? &emission
->ihint
: NULL
;
2100 * g_signal_connect_closure_by_id:
2101 * @instance: the instance to connect to.
2102 * @signal_id: the id of the signal.
2103 * @detail: the detail.
2104 * @closure: the closure to connect.
2105 * @after: whether the handler should be called before or after the
2106 * default handler of the signal.
2108 * Connects a closure to a signal for a particular object.
2110 * Returns: the handler id
2113 g_signal_connect_closure_by_id (gpointer instance
,
2120 gulong handler_seq_no
= 0;
2122 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2123 g_return_val_if_fail (signal_id
> 0, 0);
2124 g_return_val_if_fail (closure
!= NULL
, 0);
2127 node
= LOOKUP_SIGNAL_NODE (signal_id
);
2130 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
2131 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC
, signal_id
, detail
);
2132 else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance
), node
->itype
))
2133 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC
, signal_id
, instance
);
2136 Handler
*handler
= handler_new (after
);
2138 handler_seq_no
= handler
->sequential_number
;
2139 handler
->detail
= detail
;
2140 handler
->closure
= g_closure_ref (closure
);
2141 g_closure_sink (closure
);
2142 handler_insert (signal_id
, instance
, handler
);
2143 if (node
->c_marshaller
&& G_CLOSURE_NEEDS_MARSHAL (closure
))
2144 g_closure_set_marshal (closure
, node
->c_marshaller
);
2148 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC
, signal_id
, instance
);
2151 return handler_seq_no
;
2155 * g_signal_connect_closure:
2156 * @instance: the instance to connect to.
2157 * @detailed_signal: a string of the form "signal-name::detail".
2158 * @closure: the closure to connect.
2159 * @after: whether the handler should be called before or after the
2160 * default handler of the signal.
2162 * Connects a closure to a signal for a particular object.
2164 * Returns: the handler id
2167 g_signal_connect_closure (gpointer instance
,
2168 const gchar
*detailed_signal
,
2173 gulong handler_seq_no
= 0;
2177 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2178 g_return_val_if_fail (detailed_signal
!= NULL
, 0);
2179 g_return_val_if_fail (closure
!= NULL
, 0);
2182 itype
= G_TYPE_FROM_INSTANCE (instance
);
2183 signal_id
= signal_parse_name (detailed_signal
, itype
, &detail
, TRUE
);
2186 SignalNode
*node
= LOOKUP_SIGNAL_NODE (signal_id
);
2188 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
2189 g_warning ("%s: signal `%s' does not support details", G_STRLOC
, detailed_signal
);
2190 else if (!g_type_is_a (itype
, node
->itype
))
2191 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
2194 Handler
*handler
= handler_new (after
);
2196 handler_seq_no
= handler
->sequential_number
;
2197 handler
->detail
= detail
;
2198 handler
->closure
= g_closure_ref (closure
);
2199 g_closure_sink (closure
);
2200 handler_insert (signal_id
, instance
, handler
);
2201 if (node
->c_marshaller
&& G_CLOSURE_NEEDS_MARSHAL (handler
->closure
))
2202 g_closure_set_marshal (handler
->closure
, node
->c_marshaller
);
2206 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
2209 return handler_seq_no
;
2213 * g_signal_connect_data:
2214 * @instance: the instance to connect to.
2215 * @detailed_signal: a string of the form "signal-name::detail".
2216 * @c_handler: the #GCallback to connect.
2217 * @data: data to pass to @c_handler calls.
2218 * @destroy_data: a #GClosureNotify for @data.
2219 * @connect_flags: a combination of #GConnectFlags.
2221 * Connects a #GCallback function to a signal for a particular object. Similar
2222 * to g_signal_connect(), but allows to provide a #GClosureNotify for the data
2223 * which will be called when the signal handler is disconnected and no longer
2224 * used. Specify @connect_flags if you need <literal>..._after()</literal> or
2225 * <literal>..._swapped()</literal> variants of this function.
2227 * Returns: the handler id
2230 g_signal_connect_data (gpointer instance
,
2231 const gchar
*detailed_signal
,
2232 GCallback c_handler
,
2234 GClosureNotify destroy_data
,
2235 GConnectFlags connect_flags
)
2238 gulong handler_seq_no
= 0;
2241 gboolean swapped
, after
;
2243 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2244 g_return_val_if_fail (detailed_signal
!= NULL
, 0);
2245 g_return_val_if_fail (c_handler
!= NULL
, 0);
2247 swapped
= (connect_flags
& G_CONNECT_SWAPPED
) != FALSE
;
2248 after
= (connect_flags
& G_CONNECT_AFTER
) != FALSE
;
2251 itype
= G_TYPE_FROM_INSTANCE (instance
);
2252 signal_id
= signal_parse_name (detailed_signal
, itype
, &detail
, TRUE
);
2255 SignalNode
*node
= LOOKUP_SIGNAL_NODE (signal_id
);
2257 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
2258 g_warning ("%s: signal `%s' does not support details", G_STRLOC
, detailed_signal
);
2259 else if (!g_type_is_a (itype
, node
->itype
))
2260 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
2263 Handler
*handler
= handler_new (after
);
2265 handler_seq_no
= handler
->sequential_number
;
2266 handler
->detail
= detail
;
2267 handler
->closure
= g_closure_ref ((swapped
? g_cclosure_new_swap
: g_cclosure_new
) (c_handler
, data
, destroy_data
));
2268 g_closure_sink (handler
->closure
);
2269 handler_insert (signal_id
, instance
, handler
);
2270 if (node
->c_marshaller
&& G_CLOSURE_NEEDS_MARSHAL (handler
->closure
))
2271 g_closure_set_marshal (handler
->closure
, node
->c_marshaller
);
2275 g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
2278 return handler_seq_no
;
2282 * g_signal_handler_block:
2283 * @instance: The instance to block the signal handler of.
2284 * @handler_id: Handler id of the handler to be blocked.
2286 * Blocks a handler of an instance so it will not be called during any
2287 * signal emissions unless it is unblocked again. Thus "blocking" a
2288 * signal handler means to temporarily deactive it, a signal handler
2289 * has to be unblocked exactly the same amount of times it has been
2290 * blocked before to become active again.
2292 * The @handler_id has to be a valid signal handler id, connected to a
2293 * signal of @instance.
2296 g_signal_handler_block (gpointer instance
,
2301 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
2302 g_return_if_fail (handler_id
> 0);
2305 handler
= handler_lookup (instance
, handler_id
, NULL
);
2308 #ifndef G_DISABLE_CHECKS
2309 if (handler
->block_count
>= HANDLER_MAX_BLOCK_COUNT
- 1)
2310 g_error (G_STRLOC
": handler block_count overflow, %s", REPORT_BUG
);
2312 handler
->block_count
+= 1;
2315 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC
, instance
, handler_id
);
2320 * g_signal_handler_unblock:
2321 * @instance: The instance to unblock the signal handler of.
2322 * @handler_id: Handler id of the handler to be unblocked.
2324 * Undoes the effect of a previous g_signal_handler_block() call. A
2325 * blocked handler is skipped during signal emissions and will not be
2326 * invoked, unblocking it (for exactly the amount of times it has been
2327 * blocked before) reverts its "blocked" state, so the handler will be
2328 * recognized by the signal system and is called upon future or
2329 * currently ongoing signal emissions (since the order in which
2330 * handlers are called during signal emissions is deterministic,
2331 * whether the unblocked handler in question is called as part of a
2332 * currently ongoing emission depends on how far that emission has
2335 * The @handler_id has to be a valid id of a signal handler that is
2336 * connected to a signal of @instance and is currently blocked.
2339 g_signal_handler_unblock (gpointer instance
,
2344 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
2345 g_return_if_fail (handler_id
> 0);
2348 handler
= handler_lookup (instance
, handler_id
, NULL
);
2351 if (handler
->block_count
)
2352 handler
->block_count
-= 1;
2354 g_warning (G_STRLOC
": handler `%lu' of instance `%p' is not blocked", handler_id
, instance
);
2357 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC
, instance
, handler_id
);
2362 * g_signal_handler_disconnect:
2363 * @instance: The instance to remove the signal handler from.
2364 * @handler_id: Handler id of the handler to be disconnected.
2366 * Disconnects a handler from an instance so it will not be called during
2367 * any future or currently ongoing emissions of the signal it has been
2368 * connected to. The @handler_id becomes invalid and may be reused.
2370 * The @handler_id has to be a valid signal handler id, connected to a
2371 * signal of @instance.
2374 g_signal_handler_disconnect (gpointer instance
,
2380 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
2381 g_return_if_fail (handler_id
> 0);
2384 handler
= handler_lookup (instance
, handler_id
, &signal_id
);
2387 handler
->sequential_number
= 0;
2388 handler
->block_count
= 1;
2389 handler_unref_R (signal_id
, instance
, handler
);
2392 g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC
, instance
, handler_id
);
2397 * g_signal_handler_is_connected:
2398 * @instance: The instance where a signal handler is sought.
2399 * @handler_id: the handler id.
2401 * Returns whether @handler_id is the id of a handler connected to @instance.
2403 * Returns: whether @handler_id identifies a handler connected to @instance.
2406 g_signal_handler_is_connected (gpointer instance
,
2412 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), FALSE
);
2415 handler
= handler_lookup (instance
, handler_id
, NULL
);
2416 connected
= handler
!= NULL
;
2423 g_signal_handlers_destroy (gpointer instance
)
2425 GBSearchArray
*hlbsa
;
2427 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
2430 hlbsa
= g_hash_table_lookup (g_handler_list_bsa_ht
, instance
);
2435 /* reentrancy caution, delete instance trace first */
2436 g_hash_table_remove (g_handler_list_bsa_ht
, instance
);
2438 for (i
= 0; i
< hlbsa
->n_nodes
; i
++)
2440 HandlerList
*hlist
= g_bsearch_array_get_nth (hlbsa
, &g_signal_hlbsa_bconfig
, i
);
2441 Handler
*handler
= hlist
->handlers
;
2445 Handler
*tmp
= handler
;
2447 handler
= tmp
->next
;
2448 tmp
->block_count
= 1;
2449 /* cruel unlink, this works because _all_ handlers vanish */
2452 if (tmp
->sequential_number
)
2454 tmp
->sequential_number
= 0;
2455 handler_unref_R (0, NULL
, tmp
);
2459 g_bsearch_array_free (hlbsa
, &g_signal_hlbsa_bconfig
);
2465 * g_signal_handler_find:
2466 * @instance: The instance owning the signal handler to be found.
2467 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2468 * and/or @data the handler has to match.
2469 * @signal_id: Signal the handler has to be connected to.
2470 * @detail: Signal detail the handler has to be connected to.
2471 * @closure: The closure the handler will invoke.
2472 * @func: The C closure callback of the handler (useless for non-C closures).
2473 * @data: The closure data of the handler's closure.
2475 * Finds the first signal handler that matches certain selection criteria.
2476 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2477 * flags, and the criteria values are passed as arguments.
2478 * The match @mask has to be non-0 for successful matches.
2479 * If no handler was found, 0 is returned.
2481 * Returns: A valid non-0 signal handler id for a successful match.
2484 g_signal_handler_find (gpointer instance
,
2485 GSignalMatchType mask
,
2492 gulong handler_seq_no
= 0;
2494 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2495 g_return_val_if_fail ((mask
& ~G_SIGNAL_MATCH_MASK
) == 0, 0);
2497 if (mask
& G_SIGNAL_MATCH_MASK
)
2499 HandlerMatch
*mlist
;
2502 mlist
= handlers_find (instance
, mask
, signal_id
, detail
, closure
, func
, data
, TRUE
);
2505 handler_seq_no
= mlist
->handler
->sequential_number
;
2506 handler_match_free1_R (mlist
, instance
);
2511 return handler_seq_no
;
2515 signal_handlers_foreach_matched_R (gpointer instance
,
2516 GSignalMatchType mask
,
2522 void (*callback
) (gpointer instance
,
2523 gulong handler_seq_no
))
2525 HandlerMatch
*mlist
;
2526 guint n_handlers
= 0;
2528 mlist
= handlers_find (instance
, mask
, signal_id
, detail
, closure
, func
, data
, FALSE
);
2532 if (mlist
->handler
->sequential_number
)
2535 callback (instance
, mlist
->handler
->sequential_number
);
2538 mlist
= handler_match_free1_R (mlist
, instance
);
2545 * g_signal_handlers_block_matched:
2546 * @instance: The instance to block handlers from.
2547 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2548 * and/or @data the handlers have to match.
2549 * @signal_id: Signal the handlers have to be connected to.
2550 * @detail: Signal detail the handlers have to be connected to.
2551 * @closure: The closure the handlers will invoke.
2552 * @func: The C closure callback of the handlers (useless for non-C closures).
2553 * @data: The closure data of the handlers' closures.
2555 * Blocks all handlers on an instance that match a certain selection criteria.
2556 * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2557 * flags, and the criteria values are passed as arguments.
2558 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2559 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2560 * If no handlers were found, 0 is returned, the number of blocked handlers
2563 * Returns: The number of handlers that matched.
2566 g_signal_handlers_block_matched (gpointer instance
,
2567 GSignalMatchType mask
,
2574 guint n_handlers
= 0;
2576 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2577 g_return_val_if_fail ((mask
& ~G_SIGNAL_MATCH_MASK
) == 0, 0);
2579 if (mask
& (G_SIGNAL_MATCH_CLOSURE
| G_SIGNAL_MATCH_FUNC
| G_SIGNAL_MATCH_DATA
))
2582 n_handlers
= signal_handlers_foreach_matched_R (instance
, mask
, signal_id
, detail
,
2583 closure
, func
, data
,
2584 g_signal_handler_block
);
2592 * g_signal_handlers_unblock_matched:
2593 * @instance: The instance to unblock handlers from.
2594 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2595 * and/or @data the handlers have to match.
2596 * @signal_id: Signal the handlers have to be connected to.
2597 * @detail: Signal detail the handlers have to be connected to.
2598 * @closure: The closure the handlers will invoke.
2599 * @func: The C closure callback of the handlers (useless for non-C closures).
2600 * @data: The closure data of the handlers' closures.
2602 * Unblocks all handlers on an instance that match a certain selection
2603 * criteria. The criteria mask is passed as an OR-ed combination of
2604 * #GSignalMatchType flags, and the criteria values are passed as arguments.
2605 * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2606 * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2607 * If no handlers were found, 0 is returned, the number of unblocked handlers
2608 * otherwise. The match criteria should not apply to any handlers that are
2609 * not currently blocked.
2611 * Returns: The number of handlers that matched.
2614 g_signal_handlers_unblock_matched (gpointer instance
,
2615 GSignalMatchType mask
,
2622 guint n_handlers
= 0;
2624 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2625 g_return_val_if_fail ((mask
& ~G_SIGNAL_MATCH_MASK
) == 0, 0);
2627 if (mask
& (G_SIGNAL_MATCH_CLOSURE
| G_SIGNAL_MATCH_FUNC
| G_SIGNAL_MATCH_DATA
))
2630 n_handlers
= signal_handlers_foreach_matched_R (instance
, mask
, signal_id
, detail
,
2631 closure
, func
, data
,
2632 g_signal_handler_unblock
);
2640 * g_signal_handlers_disconnect_matched:
2641 * @instance: The instance to remove handlers from.
2642 * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2643 * and/or @data the handlers have to match.
2644 * @signal_id: Signal the handlers have to be connected to.
2645 * @detail: Signal detail the handlers have to be connected to.
2646 * @closure: The closure the handlers will invoke.
2647 * @func: The C closure callback of the handlers (useless for non-C closures).
2648 * @data: The closure data of the handlers' closures.
2650 * Disconnects all handlers on an instance that match a certain
2651 * selection criteria. The criteria mask is passed as an OR-ed
2652 * combination of #GSignalMatchType flags, and the criteria values are
2653 * passed as arguments. Passing at least one of the
2654 * %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
2655 * %G_SIGNAL_MATCH_DATA match flags is required for successful
2656 * matches. If no handlers were found, 0 is returned, the number of
2657 * disconnected handlers otherwise.
2659 * Returns: The number of handlers that matched.
2662 g_signal_handlers_disconnect_matched (gpointer instance
,
2663 GSignalMatchType mask
,
2670 guint n_handlers
= 0;
2672 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), 0);
2673 g_return_val_if_fail ((mask
& ~G_SIGNAL_MATCH_MASK
) == 0, 0);
2675 if (mask
& (G_SIGNAL_MATCH_CLOSURE
| G_SIGNAL_MATCH_FUNC
| G_SIGNAL_MATCH_DATA
))
2678 n_handlers
= signal_handlers_foreach_matched_R (instance
, mask
, signal_id
, detail
,
2679 closure
, func
, data
,
2680 g_signal_handler_disconnect
);
2688 * g_signal_has_handler_pending:
2689 * @instance: the object whose signal handlers are sought.
2690 * @signal_id: the signal id.
2691 * @detail: the detail.
2692 * @may_be_blocked: whether blocked handlers should count as match.
2694 * Returns whether there are any handlers connected to @instance for the
2695 * given signal id and detail.
2697 * One example of when you might use this is when the arguments to the
2698 * signal are difficult to compute. A class implementor may opt to not
2699 * emit the signal if no one is attached anyway, thus saving the cost
2700 * of building the arguments.
2702 * Returns: %TRUE if a handler is connected to the signal, %FALSE
2706 g_signal_has_handler_pending (gpointer instance
,
2709 gboolean may_be_blocked
)
2711 HandlerMatch
*mlist
;
2712 gboolean has_pending
;
2714 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance
), FALSE
);
2715 g_return_val_if_fail (signal_id
> 0, FALSE
);
2720 SignalNode
*node
= LOOKUP_SIGNAL_NODE (signal_id
);
2722 if (!(node
->flags
& G_SIGNAL_DETAILED
))
2724 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC
, signal_id
, detail
);
2729 mlist
= handlers_find (instance
,
2730 (G_SIGNAL_MATCH_ID
| G_SIGNAL_MATCH_DETAIL
| (may_be_blocked
? 0 : G_SIGNAL_MATCH_UNBLOCKED
)),
2731 signal_id
, detail
, NULL
, NULL
, NULL
, TRUE
);
2735 handler_match_free1_R (mlist
, instance
);
2738 has_pending
= FALSE
;
2744 static inline gboolean
2745 signal_check_skip_emission (SignalNode
*node
,
2751 /* are we able to check for NULL class handlers? */
2752 if (!node
->test_class_offset
)
2755 /* are there emission hooks pending? */
2756 if (node
->emission_hooks
&& node
->emission_hooks
->hooks
)
2759 /* is there a non-NULL class handler? */
2760 if (node
->test_class_offset
!= TEST_CLASS_MAGIC
)
2762 GTypeClass
*class = G_TYPE_INSTANCE_GET_CLASS (instance
, G_TYPE_FROM_INSTANCE (instance
), GTypeClass
);
2764 if (G_STRUCT_MEMBER (gpointer
, class, node
->test_class_offset
))
2768 /* are signals being debugged? */
2769 #ifdef G_ENABLE_DEBUG
2770 IF_DEBUG (SIGNALS
, g_trace_instance_signals
|| g_trap_instance_signals
)
2772 #endif /* G_ENABLE_DEBUG */
2774 /* is this a no-recurse signal already in emission? */
2775 if (node
->flags
& G_SIGNAL_NO_RECURSE
&&
2776 emission_find (g_restart_emissions
, node
->signal_id
, detail
, instance
))
2779 /* do we have pending handlers? */
2780 hlist
= handler_list_lookup (node
->signal_id
, instance
);
2781 if (hlist
&& hlist
->handlers
)
2784 /* none of the above, no emission required */
2790 * @instance_and_params: argument list for the signal emission. The first
2791 * element in the array is a #GValue for the instance the signal is
2792 * being emitted on. The rest are any arguments to be passed to the
2794 * @signal_id: the signal id
2795 * @detail: the detail
2796 * @return_value: Location to store the return value of the signal emission.
2800 * Note that g_signal_emitv() doesn't change @return_value if no handlers are
2801 * connected, in contrast to g_signal_emit() and g_signal_emit_valist().
2804 g_signal_emitv (const GValue
*instance_and_params
,
2807 GValue
*return_value
)
2811 #ifdef G_ENABLE_DEBUG
2812 const GValue
*param_values
;
2816 g_return_if_fail (instance_and_params
!= NULL
);
2817 instance
= g_value_peek_pointer (instance_and_params
);
2818 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
2819 g_return_if_fail (signal_id
> 0);
2821 #ifdef G_ENABLE_DEBUG
2822 param_values
= instance_and_params
+ 1;
2826 node
= LOOKUP_SIGNAL_NODE (signal_id
);
2827 if (!node
|| !g_type_is_a (G_TYPE_FROM_INSTANCE (instance
), node
->itype
))
2829 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC
, signal_id
, instance
);
2833 #ifdef G_ENABLE_DEBUG
2834 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
2836 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC
, signal_id
, detail
);
2840 for (i
= 0; i
< node
->n_params
; i
++)
2841 if (!G_TYPE_CHECK_VALUE_TYPE (param_values
+ i
, node
->param_types
[i
] & ~G_SIGNAL_TYPE_STATIC_SCOPE
))
2843 g_critical ("%s: value for `%s' parameter %u for signal \"%s\" is of type `%s'",
2845 type_debug_name (node
->param_types
[i
]),
2848 G_VALUE_TYPE_NAME (param_values
+ i
));
2852 if (node
->return_type
!= G_TYPE_NONE
)
2856 g_critical ("%s: return value `%s' for signal \"%s\" is (NULL)",
2858 type_debug_name (node
->return_type
),
2863 else if (!node
->accumulator
&& !G_TYPE_CHECK_VALUE_TYPE (return_value
, node
->return_type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
))
2865 g_critical ("%s: return value `%s' for signal \"%s\" is of type `%s'",
2867 type_debug_name (node
->return_type
),
2869 G_VALUE_TYPE_NAME (return_value
));
2875 return_value
= NULL
;
2876 #endif /* G_ENABLE_DEBUG */
2878 /* optimize NOP emissions */
2879 if (signal_check_skip_emission (node
, instance
, detail
))
2881 /* nothing to do to emit this signal */
2883 /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
2888 signal_emit_unlocked_R (node
, detail
, instance
, return_value
, instance_and_params
);
2892 * g_signal_emit_valist:
2893 * @instance: the instance the signal is being emitted on.
2894 * @signal_id: the signal id
2895 * @detail: the detail
2896 * @var_args: a list of parameters to be passed to the signal, followed by a
2897 * location for the return value. If the return type of the signal
2898 * is #G_TYPE_NONE, the return value location can be omitted.
2902 * Note that g_signal_emit_valist() resets the return value to the default
2903 * if no handlers are connected, in contrast to g_signal_emitv().
2906 g_signal_emit_valist (gpointer instance
,
2911 GValue
*instance_and_params
;
2912 GType signal_return_type
;
2913 GValue
*param_values
;
2917 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
2918 g_return_if_fail (signal_id
> 0);
2921 node
= LOOKUP_SIGNAL_NODE (signal_id
);
2922 if (!node
|| !g_type_is_a (G_TYPE_FROM_INSTANCE (instance
), node
->itype
))
2924 g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC
, signal_id
, instance
);
2928 #ifndef G_DISABLE_CHECKS
2929 if (detail
&& !(node
->flags
& G_SIGNAL_DETAILED
))
2931 g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC
, signal_id
, detail
);
2935 #endif /* !G_DISABLE_CHECKS */
2937 /* optimize NOP emissions */
2938 if (signal_check_skip_emission (node
, instance
, detail
))
2940 /* nothing to do to emit this signal */
2942 /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
2946 n_params
= node
->n_params
;
2947 signal_return_type
= node
->return_type
;
2948 instance_and_params
= g_slice_alloc0 (sizeof (GValue
) * (n_params
+ 1));
2949 param_values
= instance_and_params
+ 1;
2951 for (i
= 0; i
< node
->n_params
; i
++)
2954 GType ptype
= node
->param_types
[i
] & ~G_SIGNAL_TYPE_STATIC_SCOPE
;
2955 gboolean static_scope
= node
->param_types
[i
] & G_SIGNAL_TYPE_STATIC_SCOPE
;
2958 G_VALUE_COLLECT_INIT (param_values
+ i
, ptype
,
2960 static_scope
? G_VALUE_NOCOPY_CONTENTS
: 0,
2964 g_warning ("%s: %s", G_STRLOC
, error
);
2967 /* we purposely leak the value here, it might not be
2968 * in a sane state if an error condition occoured
2971 g_value_unset (param_values
+ i
);
2973 g_slice_free1 (sizeof (GValue
) * (n_params
+ 1), instance_and_params
);
2979 instance_and_params
->g_type
= 0;
2980 g_value_init (instance_and_params
, G_TYPE_FROM_INSTANCE (instance
));
2981 g_value_set_instance (instance_and_params
, instance
);
2982 if (signal_return_type
== G_TYPE_NONE
)
2983 signal_emit_unlocked_R (node
, detail
, instance
, NULL
, instance_and_params
);
2986 GValue return_value
= { 0, };
2987 gchar
*error
= NULL
;
2988 GType rtype
= signal_return_type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
;
2989 gboolean static_scope
= signal_return_type
& G_SIGNAL_TYPE_STATIC_SCOPE
;
2991 g_value_init (&return_value
, rtype
);
2993 signal_emit_unlocked_R (node
, detail
, instance
, &return_value
, instance_and_params
);
2995 G_VALUE_LCOPY (&return_value
,
2997 static_scope
? G_VALUE_NOCOPY_CONTENTS
: 0,
3000 g_value_unset (&return_value
);
3003 g_warning ("%s: %s", G_STRLOC
, error
);
3006 /* we purposely leak the value here, it might not be
3007 * in a sane state if an error condition occured
3011 for (i
= 0; i
< n_params
; i
++)
3012 g_value_unset (param_values
+ i
);
3013 g_value_unset (instance_and_params
);
3014 g_slice_free1 (sizeof (GValue
) * (n_params
+ 1), instance_and_params
);
3019 * @instance: the instance the signal is being emitted on.
3020 * @signal_id: the signal id
3021 * @detail: the detail
3022 * @...: parameters to be passed to the signal, followed by a
3023 * location for the return value. If the return type of the signal
3024 * is #G_TYPE_NONE, the return value location can be omitted.
3028 * Note that g_signal_emit() resets the return value to the default
3029 * if no handlers are connected, in contrast to g_signal_emitv().
3032 g_signal_emit (gpointer instance
,
3039 va_start (var_args
, detail
);
3040 g_signal_emit_valist (instance
, signal_id
, detail
, var_args
);
3045 * g_signal_emit_by_name:
3046 * @instance: the instance the signal is being emitted on.
3047 * @detailed_signal: a string of the form "signal-name::detail".
3048 * @...: parameters to be passed to the signal, followed by a
3049 * location for the return value. If the return type of the signal
3050 * is #G_TYPE_NONE, the return value location can be omitted.
3054 * Note that g_signal_emit_by_name() resets the return value to the default
3055 * if no handlers are connected, in contrast to g_signal_emitv().
3058 g_signal_emit_by_name (gpointer instance
,
3059 const gchar
*detailed_signal
,
3065 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance
));
3066 g_return_if_fail (detailed_signal
!= NULL
);
3069 signal_id
= signal_parse_name (detailed_signal
, G_TYPE_FROM_INSTANCE (instance
), &detail
, TRUE
);
3076 va_start (var_args
, detailed_signal
);
3077 g_signal_emit_valist (instance
, signal_id
, detail
, var_args
);
3081 g_warning ("%s: signal name `%s' is invalid for instance `%p'", G_STRLOC
, detailed_signal
, instance
);
3084 static inline gboolean
3085 accumulate (GSignalInvocationHint
*ihint
,
3086 GValue
*return_accu
,
3087 GValue
*handler_return
,
3088 SignalAccumulator
*accumulator
)
3090 gboolean continue_emission
;
3095 continue_emission
= accumulator
->func (ihint
, return_accu
, handler_return
, accumulator
->data
);
3096 g_value_reset (handler_return
);
3098 return continue_emission
;
3102 signal_emit_unlocked_R (SignalNode
*node
,
3105 GValue
*emission_return
,
3106 const GValue
*instance_and_params
)
3108 SignalAccumulator
*accumulator
;
3110 GClosure
*class_closure
;
3112 Handler
*handler_list
= NULL
;
3113 GValue
*return_accu
, accu
= { 0, };
3115 gulong max_sequential_handler_number
;
3116 gboolean return_value_altered
= FALSE
;
3118 #ifdef G_ENABLE_DEBUG
3119 IF_DEBUG (SIGNALS
, g_trace_instance_signals
== instance
|| g_trap_instance_signals
== instance
)
3121 g_message ("%s::%s(%u) emitted (instance=%p, signal-node=%p)",
3122 g_type_name (G_TYPE_FROM_INSTANCE (instance
)),
3125 if (g_trap_instance_signals
== instance
)
3128 #endif /* G_ENABLE_DEBUG */
3130 TRACE(GOBJECT_SIGNAL_EMIT(node
->signal_id
, detail
, instance
, G_TYPE_FROM_INSTANCE (instance
)));
3133 signal_id
= node
->signal_id
;
3134 if (node
->flags
& G_SIGNAL_NO_RECURSE
)
3136 Emission
*node
= emission_find (g_restart_emissions
, signal_id
, detail
, instance
);
3140 node
->state
= EMISSION_RESTART
;
3142 return return_value_altered
;
3145 accumulator
= node
->accumulator
;
3149 g_value_init (&accu
, node
->return_type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
);
3150 return_accu
= &accu
;
3154 return_accu
= emission_return
;
3155 emission
.instance
= instance
;
3156 emission
.ihint
.signal_id
= node
->signal_id
;
3157 emission
.ihint
.detail
= detail
;
3158 emission
.ihint
.run_type
= 0;
3160 emission
.chain_type
= G_TYPE_NONE
;
3161 emission_push ((node
->flags
& G_SIGNAL_NO_RECURSE
) ? &g_restart_emissions
: &g_recursive_emissions
, &emission
);
3162 class_closure
= signal_lookup_closure (node
, instance
);
3167 handler_unref_R (signal_id
, instance
, handler_list
);
3168 max_sequential_handler_number
= g_handler_sequential_number
;
3169 hlist
= handler_list_lookup (signal_id
, instance
);
3170 handler_list
= hlist
? hlist
->handlers
: NULL
;
3172 handler_ref (handler_list
);
3174 emission
.ihint
.run_type
= G_SIGNAL_RUN_FIRST
;
3176 if ((node
->flags
& G_SIGNAL_RUN_FIRST
) && class_closure
)
3178 emission
.state
= EMISSION_RUN
;
3180 emission
.chain_type
= G_TYPE_FROM_INSTANCE (instance
);
3182 g_closure_invoke (class_closure
,
3185 instance_and_params
,
3187 if (!accumulate (&emission
.ihint
, emission_return
, &accu
, accumulator
) &&
3188 emission
.state
== EMISSION_RUN
)
3189 emission
.state
= EMISSION_STOP
;
3191 emission
.chain_type
= G_TYPE_NONE
;
3192 return_value_altered
= TRUE
;
3194 if (emission
.state
== EMISSION_STOP
)
3196 else if (emission
.state
== EMISSION_RESTART
)
3200 if (node
->emission_hooks
)
3202 gboolean need_destroy
, was_in_call
, may_recurse
= TRUE
;
3205 emission
.state
= EMISSION_HOOK
;
3206 hook
= g_hook_first_valid (node
->emission_hooks
, may_recurse
);
3209 SignalHook
*signal_hook
= SIGNAL_HOOK (hook
);
3211 if (!signal_hook
->detail
|| signal_hook
->detail
== detail
)
3213 GSignalEmissionHook hook_func
= (GSignalEmissionHook
) hook
->func
;
3215 was_in_call
= G_HOOK_IN_CALL (hook
);
3216 hook
->flags
|= G_HOOK_FLAG_IN_CALL
;
3218 need_destroy
= !hook_func (&emission
.ihint
, node
->n_params
+ 1, instance_and_params
, hook
->data
);
3221 hook
->flags
&= ~G_HOOK_FLAG_IN_CALL
;
3223 g_hook_destroy_link (node
->emission_hooks
, hook
);
3225 hook
= g_hook_next_valid (node
->emission_hooks
, hook
, may_recurse
);
3228 if (emission
.state
== EMISSION_RESTART
)
3234 Handler
*handler
= handler_list
;
3236 emission
.state
= EMISSION_RUN
;
3237 handler_ref (handler
);
3244 handler_unref_R (signal_id
, instance
, handler_list
);
3245 handler_list
= handler
;
3248 else if (!handler
->block_count
&& (!handler
->detail
|| handler
->detail
== detail
) &&
3249 handler
->sequential_number
< max_sequential_handler_number
)
3252 g_closure_invoke (handler
->closure
,
3255 instance_and_params
,
3257 if (!accumulate (&emission
.ihint
, emission_return
, &accu
, accumulator
) &&
3258 emission
.state
== EMISSION_RUN
)
3259 emission
.state
= EMISSION_STOP
;
3261 return_value_altered
= TRUE
;
3263 tmp
= emission
.state
== EMISSION_RUN
? handler
->next
: NULL
;
3266 tmp
= handler
->next
;
3270 handler_unref_R (signal_id
, instance
, handler_list
);
3271 handler_list
= handler
;
3276 if (emission
.state
== EMISSION_STOP
)
3278 else if (emission
.state
== EMISSION_RESTART
)
3282 emission
.ihint
.run_type
= G_SIGNAL_RUN_LAST
;
3284 if ((node
->flags
& G_SIGNAL_RUN_LAST
) && class_closure
)
3286 emission
.state
= EMISSION_RUN
;
3288 emission
.chain_type
= G_TYPE_FROM_INSTANCE (instance
);
3290 g_closure_invoke (class_closure
,
3293 instance_and_params
,
3295 if (!accumulate (&emission
.ihint
, emission_return
, &accu
, accumulator
) &&
3296 emission
.state
== EMISSION_RUN
)
3297 emission
.state
= EMISSION_STOP
;
3299 emission
.chain_type
= G_TYPE_NONE
;
3300 return_value_altered
= TRUE
;
3302 if (emission
.state
== EMISSION_STOP
)
3304 else if (emission
.state
== EMISSION_RESTART
)
3310 Handler
*handler
= handler_list
;
3312 emission
.state
= EMISSION_RUN
;
3313 handler_ref (handler
);
3318 if (handler
->after
&& !handler
->block_count
&& (!handler
->detail
|| handler
->detail
== detail
) &&
3319 handler
->sequential_number
< max_sequential_handler_number
)
3322 g_closure_invoke (handler
->closure
,
3325 instance_and_params
,
3327 if (!accumulate (&emission
.ihint
, emission_return
, &accu
, accumulator
) &&
3328 emission
.state
== EMISSION_RUN
)
3329 emission
.state
= EMISSION_STOP
;
3331 return_value_altered
= TRUE
;
3333 tmp
= emission
.state
== EMISSION_RUN
? handler
->next
: NULL
;
3336 tmp
= handler
->next
;
3340 handler_unref_R (signal_id
, instance
, handler
);
3345 if (emission
.state
== EMISSION_STOP
)
3347 else if (emission
.state
== EMISSION_RESTART
)
3353 emission
.ihint
.run_type
= G_SIGNAL_RUN_CLEANUP
;
3355 if ((node
->flags
& G_SIGNAL_RUN_CLEANUP
) && class_closure
)
3357 gboolean need_unset
= FALSE
;
3359 emission
.state
= EMISSION_STOP
;
3361 emission
.chain_type
= G_TYPE_FROM_INSTANCE (instance
);
3363 if (node
->return_type
!= G_TYPE_NONE
&& !accumulator
)
3365 g_value_init (&accu
, node
->return_type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
);
3368 g_closure_invoke (class_closure
,
3369 node
->return_type
!= G_TYPE_NONE
? &accu
: NULL
,
3371 instance_and_params
,
3374 g_value_unset (&accu
);
3376 emission
.chain_type
= G_TYPE_NONE
;
3378 if (emission
.state
== EMISSION_RESTART
)
3383 handler_unref_R (signal_id
, instance
, handler_list
);
3385 emission_pop ((node
->flags
& G_SIGNAL_NO_RECURSE
) ? &g_restart_emissions
: &g_recursive_emissions
, &emission
);
3388 g_value_unset (&accu
);
3390 TRACE(GOBJECT_SIGNAL_EMIT_END(node
->signal_id
, detail
, instance
, G_TYPE_FROM_INSTANCE (instance
)));
3392 return return_value_altered
;
3396 type_debug_name (GType type
)
3400 const char *name
= g_type_name (type
& ~G_SIGNAL_TYPE_STATIC_SCOPE
);
3401 return name
? name
: "<unknown>";
3408 * g_signal_accumulator_true_handled:
3409 * @ihint: standard #GSignalAccumulator parameter
3410 * @return_accu: standard #GSignalAccumulator parameter
3411 * @handler_return: standard #GSignalAccumulator parameter
3412 * @dummy: standard #GSignalAccumulator parameter
3414 * A predefined #GSignalAccumulator for signals that return a
3415 * boolean values. The behavior that this accumulator gives is
3416 * that a return of %TRUE stops the signal emission: no further
3417 * callbacks will be invoked, while a return of %FALSE allows
3418 * the emission to continue. The idea here is that a %TRUE return
3419 * indicates that the callback <emphasis>handled</emphasis> the signal,
3420 * and no further handling is needed.
3424 * Returns: standard #GSignalAccumulator result
3427 g_signal_accumulator_true_handled (GSignalInvocationHint
*ihint
,
3428 GValue
*return_accu
,
3429 const GValue
*handler_return
,
3432 gboolean continue_emission
;
3433 gboolean signal_handled
;
3435 signal_handled
= g_value_get_boolean (handler_return
);
3436 g_value_set_boolean (return_accu
, signal_handled
);
3437 continue_emission
= !signal_handled
;
3439 return continue_emission
;
3443 * g_signal_accumulator_first_wins:
3444 * @ihint: standard #GSignalAccumulator parameter
3445 * @return_accu: standard #GSignalAccumulator parameter
3446 * @handler_return: standard #GSignalAccumulator parameter
3447 * @dummy: standard #GSignalAccumulator parameter
3449 * A predefined #GSignalAccumulator for signals intended to be used as a
3450 * hook for application code to provide a particular value. Usually
3451 * only one such value is desired and multiple handlers for the same
3452 * signal don't make much sense (except for the case of the default
3453 * handler defined in the class structure, in which case you will
3454 * usually want the signal connection to override the class handler).
3456 * This accumulator will use the return value from the first signal
3457 * handler that is run as the return value for the signal and not run
3458 * any further handlers (ie: the first handler "wins").
3460 * Returns: standard #GSignalAccumulator result
3465 g_signal_accumulator_first_wins (GSignalInvocationHint
*ihint
,
3466 GValue
*return_accu
,
3467 const GValue
*handler_return
,
3470 g_value_copy (handler_return
, return_accu
);
3475 /* --- compile standard marshallers --- */
3476 #include "gmarshal.c"