Trivial typo fix
[platform/upstream/glib.git] / gobject / gsignal.c
1 /* GObject - GLib Type, Object, Parameter and Signal Library
2  * Copyright (C) 2000-2001 Red Hat, Inc.
3  *
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.
8  *
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.
13  *
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.
18  *
19  * this code is based on the original GtkSignal implementation
20  * for the Gtk+ library by Peter Mattis <petm@xcf.berkeley.edu>
21  */
22
23 /*
24  * MT safe
25  */
26
27 #include "config.h"
28
29 #include <string.h>
30 #include <signal.h>
31
32 #include "gsignal.h"
33 #include "gtype-private.h"
34 #include "gbsearcharray.h"
35 #include "gvaluecollector.h"
36 #include "gvaluetypes.h"
37 #include "gobject.h"
38 #include "genums.h"
39 #include "gobject_trace.h"
40
41
42 /**
43  * SECTION:signals
44  * @short_description: A means for customization of object behaviour
45  *     and a general purpose notification mechanism
46  * @title: Signals
47  *
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.
59  * </para></footnote>
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.
68  *
69  * A signal emission consists of five stages, unless prematurely stopped:
70  * <variablelist>
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>
86  * </variablelist>
87  * The user-provided signal handlers are called in the order they were
88  * connected in.
89  * All handlers may prematurely stop a signal emission, and any number of
90  * handlers may be connected, disconnected, blocked or unblocked during
91  * a signal emission.
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.
104  */
105
106
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 */
113
114
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;
122 typedef enum
123 {
124   EMISSION_STOP,
125   EMISSION_RUN,
126   EMISSION_HOOK,
127   EMISSION_RESTART
128 } EmissionState;
129
130
131 /* --- prototypes --- */
132 static inline guint             signal_id_lookup        (GQuark           quark,
133                                                          GType            itype);
134 static        void              signal_destroy_R        (SignalNode      *signal_node);
135 static inline HandlerList*      handler_list_ensure     (guint            signal_id,
136                                                          gpointer         instance);
137 static inline HandlerList*      handler_list_lookup     (guint            signal_id,
138                                                          gpointer         instance);
139 static inline Handler*          handler_new             (gboolean         after);
140 static        void              handler_insert          (guint            signal_id,
141                                                          gpointer         instance,
142                                                          Handler         *handler);
143 static        Handler*          handler_lookup          (gpointer         instance,
144                                                          gulong           handler_id,
145                                                          guint           *signal_id_p);
146 static inline HandlerMatch*     handler_match_prepend   (HandlerMatch    *list,
147                                                          Handler         *handler,
148                                                          guint            signal_id);
149 static inline HandlerMatch*     handler_match_free1_R   (HandlerMatch    *node,
150                                                          gpointer         instance);
151 static        HandlerMatch*     handlers_find           (gpointer         instance,
152                                                          GSignalMatchType mask,
153                                                          guint            signal_id,
154                                                          GQuark           detail,
155                                                          GClosure        *closure,
156                                                          gpointer         func,
157                                                          gpointer         data,
158                                                          gboolean         one_and_only);
159 static inline void              handler_ref             (Handler         *handler);
160 static inline void              handler_unref_R         (guint            signal_id,
161                                                          gpointer         instance,
162                                                          Handler         *handler);
163 static gint                     handler_lists_cmp       (gconstpointer    node1,
164                                                          gconstpointer    node2);
165 static inline void              emission_push           (Emission       **emission_list_p,
166                                                          Emission        *emission);
167 static inline void              emission_pop            (Emission       **emission_list_p,
168                                                          Emission        *emission);
169 static inline Emission*         emission_find           (Emission        *emission_list,
170                                                          guint            signal_id,
171                                                          GQuark           detail,
172                                                          gpointer         instance);
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,
178                                                          GQuark           detail,
179                                                          gpointer         instance,
180                                                          GValue          *return_value,
181                                                          const GValue    *instance_and_params);
182 static const gchar *            type_debug_name         (GType            type);
183
184
185 /* --- structures --- */
186 typedef struct
187 {
188   GSignalAccumulator func;
189   gpointer           data;
190 } SignalAccumulator;
191 typedef struct
192 {
193   GHook hook;
194   GQuark detail;
195 } SignalHook;
196 #define SIGNAL_HOOK(hook)       ((SignalHook*) (hook))
197
198 struct _SignalNode
199 {
200   /* permanent portion */
201   guint              signal_id;
202   GType              itype;
203   const gchar       *name;
204   guint              destroyed : 1;
205   
206   /* reinitializable portion */
207   guint              test_class_offset : 12;
208   guint              flags : 8;
209   guint              n_params : 8;
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;
216 };
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 */
219
220 struct _SignalKey
221 {
222   GType  itype;
223   GQuark quark;
224   guint  signal_id;
225 };
226
227 struct _Emission
228 {
229   Emission             *next;
230   gpointer              instance;
231   GSignalInvocationHint ihint;
232   EmissionState         state;
233   GType                 chain_type;
234 };
235
236 struct _HandlerList
237 {
238   guint    signal_id;
239   Handler *handlers;
240   Handler *tail_before;  /* normal signal handlers are appended here  */
241   Handler *tail_after;   /* CONNECT_AFTER handlers are appended here  */
242 };
243
244 struct _Handler
245 {
246   gulong        sequential_number;
247   Handler      *next;
248   Handler      *prev;
249   GQuark        detail;
250   guint         ref_count;
251   guint         block_count : 16;
252 #define HANDLER_MAX_BLOCK_COUNT (1 << 16)
253   guint         after : 1;
254   GClosure     *closure;
255 };
256 struct _HandlerMatch
257 {
258   Handler      *handler;
259   HandlerMatch *next;
260   guint         signal_id;
261 };
262
263 typedef struct
264 {
265   GType     instance_type; /* 0 for default closure */
266   GClosure *closure;
267 } ClassClosure;
268
269
270 /* --- variables --- */
271 static GBSearchArray *g_signal_key_bsa = NULL;
272 static const GBSearchConfig g_signal_key_bconfig = {
273   sizeof (SignalKey),
274   signal_key_cmp,
275   G_BSEARCH_ARRAY_ALIGN_POWER2,
276 };
277 static GBSearchConfig g_signal_hlbsa_bconfig = {
278   sizeof (HandlerList),
279   handler_lists_cmp,
280   0,
281 };
282 static GBSearchConfig g_class_closure_bconfig = {
283   sizeof (ClassClosure),
284   class_closures_cmp,
285   0,
286 };
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)
294
295
296 /* --- signal nodes --- */
297 static guint          g_n_signal_nodes = 0;
298 static SignalNode   **g_signal_nodes = NULL;
299
300 static inline SignalNode*
301 LOOKUP_SIGNAL_NODE (register guint signal_id)
302 {
303   if (signal_id < g_n_signal_nodes)
304     return g_signal_nodes[signal_id];
305   else
306     return NULL;
307 }
308
309
310 /* --- functions --- */
311 static inline guint
312 signal_id_lookup (GQuark quark,
313                   GType  itype)
314 {
315   GType *ifaces, type = itype;
316   SignalKey key;
317   guint n_ifaces;
318
319   key.quark = quark;
320
321   /* try looking up signals for this type and its ancestors */
322   do
323     {
324       SignalKey *signal_key;
325       
326       key.itype = type;
327       signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
328       
329       if (signal_key)
330         return signal_key->signal_id;
331       
332       type = g_type_parent (type);
333     }
334   while (type);
335
336   /* no luck, try interfaces it exports */
337   ifaces = g_type_interfaces (itype, &n_ifaces);
338   while (n_ifaces--)
339     {
340       SignalKey *signal_key;
341
342       key.itype = ifaces[n_ifaces];
343       signal_key = g_bsearch_array_lookup (g_signal_key_bsa, &g_signal_key_bconfig, &key);
344
345       if (signal_key)
346         {
347           g_free (ifaces);
348           return signal_key->signal_id;
349         }
350     }
351   g_free (ifaces);
352   
353   return 0;
354 }
355
356 static gint
357 class_closures_cmp (gconstpointer node1,
358                     gconstpointer node2)
359 {
360   const ClassClosure *c1 = node1, *c2 = node2;
361   
362   return G_BSEARCH_ARRAY_CMP (c1->instance_type, c2->instance_type);
363 }
364
365 static gint
366 handler_lists_cmp (gconstpointer node1,
367                    gconstpointer node2)
368 {
369   const HandlerList *hlist1 = node1, *hlist2 = node2;
370   
371   return G_BSEARCH_ARRAY_CMP (hlist1->signal_id, hlist2->signal_id);
372 }
373
374 static inline HandlerList*
375 handler_list_ensure (guint    signal_id,
376                      gpointer instance)
377 {
378   GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
379   HandlerList key;
380   
381   key.signal_id = signal_id;
382   key.handlers    = NULL;
383   key.tail_before = NULL;
384   key.tail_after  = NULL;
385   if (!hlbsa)
386     {
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);
390     }
391   else
392     {
393       GBSearchArray *o = hlbsa;
394
395       hlbsa = g_bsearch_array_insert (o, &g_signal_hlbsa_bconfig, &key);
396       if (hlbsa != o)
397         g_hash_table_insert (g_handler_list_bsa_ht, instance, hlbsa);
398     }
399   return g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key);
400 }
401
402 static inline HandlerList*
403 handler_list_lookup (guint    signal_id,
404                      gpointer instance)
405 {
406   GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
407   HandlerList key;
408   
409   key.signal_id = signal_id;
410   
411   return hlbsa ? g_bsearch_array_lookup (hlbsa, &g_signal_hlbsa_bconfig, &key) : NULL;
412 }
413
414 static Handler*
415 handler_lookup (gpointer instance,
416                 gulong   handler_id,
417                 guint   *signal_id_p)
418 {
419   GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
420   
421   if (hlbsa)
422     {
423       guint i;
424       
425       for (i = 0; i < hlbsa->n_nodes; i++)
426         {
427           HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
428           Handler *handler;
429           
430           for (handler = hlist->handlers; handler; handler = handler->next)
431             if (handler->sequential_number == handler_id)
432               {
433                 if (signal_id_p)
434                   *signal_id_p = hlist->signal_id;
435                 
436                 return handler;
437               }
438         }
439     }
440   
441   return NULL;
442 }
443
444 static inline HandlerMatch*
445 handler_match_prepend (HandlerMatch *list,
446                        Handler      *handler,
447                        guint         signal_id)
448 {
449   HandlerMatch *node;
450   
451   node = g_slice_new (HandlerMatch);
452   node->handler = handler;
453   node->next = list;
454   node->signal_id = signal_id;
455   handler_ref (handler);
456   
457   return node;
458 }
459 static inline HandlerMatch*
460 handler_match_free1_R (HandlerMatch *node,
461                        gpointer      instance)
462 {
463   HandlerMatch *next = node->next;
464   
465   handler_unref_R (node->signal_id, instance, node->handler);
466   g_slice_free (HandlerMatch, node);
467   
468   return next;
469 }
470
471 static HandlerMatch*
472 handlers_find (gpointer         instance,
473                GSignalMatchType mask,
474                guint            signal_id,
475                GQuark           detail,
476                GClosure        *closure,
477                gpointer         func,
478                gpointer         data,
479                gboolean         one_and_only)
480 {
481   HandlerMatch *mlist = NULL;
482   
483   if (mask & G_SIGNAL_MATCH_ID)
484     {
485       HandlerList *hlist = handler_list_lookup (signal_id, instance);
486       Handler *handler;
487       SignalNode *node = NULL;
488       
489       if (mask & G_SIGNAL_MATCH_FUNC)
490         {
491           node = LOOKUP_SIGNAL_NODE (signal_id);
492           if (!node || !node->c_marshaller)
493             return NULL;
494         }
495       
496       mask = ~mask;
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)))
506           {
507             mlist = handler_match_prepend (mlist, handler, signal_id);
508             if (one_and_only)
509               return mlist;
510           }
511     }
512   else
513     {
514       GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
515       
516       mask = ~mask;
517       if (hlbsa)
518         {
519           guint i;
520           
521           for (i = 0; i < hlbsa->n_nodes; i++)
522             {
523               HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
524               SignalNode *node = NULL;
525               Handler *handler;
526               
527               if (!(mask & G_SIGNAL_MATCH_FUNC))
528                 {
529                   node = LOOKUP_SIGNAL_NODE (hlist->signal_id);
530                   if (!node->c_marshaller)
531                     continue;
532                 }
533               
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)))
543                   {
544                     mlist = handler_match_prepend (mlist, handler, hlist->signal_id);
545                     if (one_and_only)
546                       return mlist;
547                   }
548             }
549         }
550     }
551   
552   return mlist;
553 }
554
555 static inline Handler*
556 handler_new (gboolean after)
557 {
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);
562 #endif
563   
564   handler->sequential_number = g_handler_sequential_number++;
565   handler->prev = NULL;
566   handler->next = NULL;
567   handler->detail = 0;
568   handler->ref_count = 1;
569   handler->block_count = 0;
570   handler->after = after != FALSE;
571   handler->closure = NULL;
572   
573   return handler;
574 }
575
576 static inline void
577 handler_ref (Handler *handler)
578 {
579   g_return_if_fail (handler->ref_count > 0);
580   
581   g_atomic_int_inc ((int *)&handler->ref_count);
582 }
583
584 static inline void
585 handler_unref_R (guint    signal_id,
586                  gpointer instance,
587                  Handler *handler)
588 {
589   gboolean is_zero;
590
591   g_return_if_fail (handler->ref_count > 0);
592   
593   is_zero = g_atomic_int_dec_and_test ((int *)&handler->ref_count);
594
595   if (G_UNLIKELY (is_zero))
596     {
597       HandlerList *hlist = NULL;
598
599       if (handler->next)
600         handler->next->prev = handler->prev;
601       if (handler->prev)    /* watch out for g_signal_handlers_destroy()! */
602         handler->prev->next = handler->next;
603       else
604         {
605           hlist = handler_list_lookup (signal_id, instance);
606           hlist->handlers = handler->next;
607         }
608
609       if (instance)
610         {
611           /*  check if we are removing the handler pointed to by tail_before  */
612           if (!handler->after && (!handler->next || handler->next->after))
613             {
614               if (!hlist)
615                 hlist = handler_list_lookup (signal_id, instance);
616               if (hlist)
617                 {
618                   g_assert (hlist->tail_before == handler); /* paranoid */
619                   hlist->tail_before = handler->prev;
620                 }
621             }
622
623           /*  check if we are removing the handler pointed to by tail_after  */
624           if (!handler->next)
625             {
626               if (!hlist)
627                 hlist = handler_list_lookup (signal_id, instance);
628               if (hlist)
629                 {
630                   g_assert (hlist->tail_after == handler); /* paranoid */
631                   hlist->tail_after = handler->prev;
632                 }
633             }
634         }
635
636       SIGNAL_UNLOCK ();
637       g_closure_unref (handler->closure);
638       SIGNAL_LOCK ();
639       g_slice_free (Handler, handler);
640     }
641 }
642
643 static void
644 handler_insert (guint    signal_id,
645                 gpointer instance,
646                 Handler  *handler)
647 {
648   HandlerList *hlist;
649   
650   g_assert (handler->prev == NULL && handler->next == NULL); /* paranoid */
651   
652   hlist = handler_list_ensure (signal_id, instance);
653   if (!hlist->handlers)
654     {
655       hlist->handlers = handler;
656       if (!handler->after)
657         hlist->tail_before = handler;
658     }
659   else if (handler->after)
660     {
661       handler->prev = hlist->tail_after;
662       hlist->tail_after->next = handler;
663     }
664   else
665     {
666       if (hlist->tail_before)
667         {
668           handler->next = hlist->tail_before->next;
669           if (handler->next)
670             handler->next->prev = handler;
671           handler->prev = hlist->tail_before;
672           hlist->tail_before->next = handler;
673         }
674       else /* insert !after handler into a list of only after handlers */
675         {
676           handler->next = hlist->handlers;
677           if (handler->next)
678             handler->next->prev = handler;
679           hlist->handlers = handler;
680         }
681       hlist->tail_before = handler;
682     }
683
684   if (!handler->next)
685     hlist->tail_after = handler;
686 }
687
688 static inline void
689 emission_push (Emission **emission_list_p,
690                Emission  *emission)
691 {
692   emission->next = *emission_list_p;
693   *emission_list_p = emission;
694 }
695
696 static inline void
697 emission_pop (Emission **emission_list_p,
698               Emission  *emission)
699 {
700   Emission *node, *last = NULL;
701
702   for (node = *emission_list_p; node; last = node, node = last->next)
703     if (node == emission)
704       {
705         if (last)
706           last->next = node->next;
707         else
708           *emission_list_p = node->next;
709         return;
710       }
711   g_assert_not_reached ();
712 }
713
714 static inline Emission*
715 emission_find (Emission *emission_list,
716                guint     signal_id,
717                GQuark    detail,
718                gpointer  instance)
719 {
720   Emission *emission;
721   
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)
726       return emission;
727   return NULL;
728 }
729
730 static inline Emission*
731 emission_find_innermost (gpointer instance)
732 {
733   Emission *emission, *s = NULL, *c = NULL;
734   
735   for (emission = g_restart_emissions; emission; emission = emission->next)
736     if (emission->instance == instance)
737       {
738         s = emission;
739         break;
740       }
741   for (emission = g_recursive_emissions; emission; emission = emission->next)
742     if (emission->instance == instance)
743       {
744         c = emission;
745         break;
746       }
747   if (!s)
748     return c;
749   else if (!c)
750     return s;
751   else
752     return G_HAVE_GROWING_STACK ? MAX (c, s) : MIN (c, s);
753 }
754
755 static gint
756 signal_key_cmp (gconstpointer node1,
757                 gconstpointer node2)
758 {
759   const SignalKey *key1 = node1, *key2 = node2;
760   
761   if (key1->itype == key2->itype)
762     return G_BSEARCH_ARRAY_CMP (key1->quark, key2->quark);
763   else
764     return G_BSEARCH_ARRAY_CMP (key1->itype, key2->itype);
765 }
766
767 void
768 _g_signal_init (void)
769 {
770   SIGNAL_LOCK ();
771   if (!g_n_signal_nodes)
772     {
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);
776       
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;
781     }
782   SIGNAL_UNLOCK ();
783 }
784
785 void
786 _g_signals_destroy (GType itype)
787 {
788   guint i;
789   
790   SIGNAL_LOCK ();
791   for (i = 1; i < g_n_signal_nodes; i++)
792     {
793       SignalNode *node = g_signal_nodes[i];
794       
795       if (node->itype == itype)
796         {
797           if (node->destroyed)
798             g_warning (G_STRLOC ": signal \"%s\" of type `%s' already destroyed",
799                        node->name,
800                        type_debug_name (node->itype));
801           else
802             signal_destroy_R (node);
803         }
804     }
805   SIGNAL_UNLOCK ();
806 }
807
808 /**
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.
813  *
814  * Stops a signal's current emission.
815  *
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"
818  * flag).
819  *
820  * Prints a warning if used on a signal which isn't being emitted.
821  */
822 void
823 g_signal_stop_emission (gpointer instance,
824                         guint    signal_id,
825                         GQuark   detail)
826 {
827   SignalNode *node;
828   
829   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
830   g_return_if_fail (signal_id > 0);
831   
832   SIGNAL_LOCK ();
833   node = LOOKUP_SIGNAL_NODE (signal_id);
834   if (node && detail && !(node->flags & G_SIGNAL_DETAILED))
835     {
836       g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
837       SIGNAL_UNLOCK ();
838       return;
839     }
840   if (node && g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
841     {
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);
844       
845       if (emission)
846         {
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;
852         }
853       else
854         g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
855                    node->name, instance);
856     }
857   else
858     g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
859   SIGNAL_UNLOCK ();
860 }
861
862 static void
863 signal_finalize_hook (GHookList *hook_list,
864                       GHook     *hook)
865 {
866   GDestroyNotify destroy = hook->destroy;
867
868   if (destroy)
869     {
870       hook->destroy = NULL;
871       SIGNAL_UNLOCK ();
872       destroy (hook->data);
873       SIGNAL_LOCK ();
874     }
875 }
876
877 /**
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.
884  *
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.
888  *
889  * Returns: the hook id, for later use with g_signal_remove_emission_hook().
890  */
891 gulong
892 g_signal_add_emission_hook (guint               signal_id,
893                             GQuark              detail,
894                             GSignalEmissionHook hook_func,
895                             gpointer            hook_data,
896                             GDestroyNotify      data_destroy)
897 {
898   static gulong seq_hook_id = 1;
899   SignalNode *node;
900   GHook *hook;
901   SignalHook *signal_hook;
902
903   g_return_val_if_fail (signal_id > 0, 0);
904   g_return_val_if_fail (hook_func != NULL, 0);
905
906   SIGNAL_LOCK ();
907   node = LOOKUP_SIGNAL_NODE (signal_id);
908   if (!node || node->destroyed)
909     {
910       g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
911       SIGNAL_UNLOCK ();
912       return 0;
913     }
914   if (node->flags & G_SIGNAL_NO_HOOKS) 
915     {
916       g_warning ("%s: signal id `%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC, signal_id);
917       SIGNAL_UNLOCK ();
918       return 0;
919     }
920   if (detail && !(node->flags & G_SIGNAL_DETAILED))
921     {
922       g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
923       SIGNAL_UNLOCK ();
924       return 0;
925     }
926   if (!node->emission_hooks)
927     {
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;
931     }
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;
941   SIGNAL_UNLOCK ();
942
943   return hook->hook_id;
944 }
945
946 /**
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()
951  *
952  * Deletes an emission hook.
953  */
954 void
955 g_signal_remove_emission_hook (guint  signal_id,
956                                gulong hook_id)
957 {
958   SignalNode *node;
959
960   g_return_if_fail (signal_id > 0);
961   g_return_if_fail (hook_id > 0);
962
963   SIGNAL_LOCK ();
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);
969   SIGNAL_UNLOCK ();
970 }
971
972 static inline guint
973 signal_parse_name (const gchar *name,
974                    GType        itype,
975                    GQuark      *detail_p,
976                    gboolean     force_quark)
977 {
978   const gchar *colon = strchr (name, ':');
979   guint signal_id;
980   
981   if (!colon)
982     {
983       signal_id = signal_id_lookup (g_quark_try_string (name), itype);
984       if (signal_id && detail_p)
985         *detail_p = 0;
986     }
987   else if (colon[1] == ':')
988     {
989       gchar buffer[32];
990       guint l = colon - name;
991       
992       if (l < 32)
993         {
994           memcpy (buffer, name, l);
995           buffer[l] = 0;
996           signal_id = signal_id_lookup (g_quark_try_string (buffer), itype);
997         }
998       else
999         {
1000           gchar *signal = g_new (gchar, l + 1);
1001           
1002           memcpy (signal, name, l);
1003           signal[l] = 0;
1004           signal_id = signal_id_lookup (g_quark_try_string (signal), itype);
1005           g_free (signal);
1006         }
1007       
1008       if (signal_id && detail_p)
1009         *detail_p = colon[2] ? (force_quark ? g_quark_from_string : g_quark_try_string) (colon + 2) : 0;
1010     }
1011   else
1012     signal_id = 0;
1013   return signal_id;
1014 }
1015
1016 /**
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.
1023  *
1024  * Internal function to parse a signal name into its @signal_id
1025  * and @detail quark.
1026  *
1027  * Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
1028  */
1029 gboolean
1030 g_signal_parse_name (const gchar *detailed_signal,
1031                      GType        itype,
1032                      guint       *signal_id_p,
1033                      GQuark      *detail_p,
1034                      gboolean     force_detail_quark)
1035 {
1036   SignalNode *node;
1037   GQuark detail = 0;
1038   guint signal_id;
1039   
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);
1042   
1043   SIGNAL_LOCK ();
1044   signal_id = signal_parse_name (detailed_signal, itype, &detail, force_detail_quark);
1045   SIGNAL_UNLOCK ();
1046
1047   node = signal_id ? LOOKUP_SIGNAL_NODE (signal_id) : NULL;
1048   if (!node || node->destroyed ||
1049       (detail && !(node->flags & G_SIGNAL_DETAILED)))
1050     return FALSE;
1051
1052   if (signal_id_p)
1053     *signal_id_p = signal_id;
1054   if (detail_p)
1055     *detail_p = detail;
1056   
1057   return TRUE;
1058 }
1059
1060 /**
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".
1064  *
1065  * Stops a signal's current emission.
1066  *
1067  * This is just like g_signal_stop_emission() except it will look up the
1068  * signal id for you.
1069  */
1070 void
1071 g_signal_stop_emission_by_name (gpointer     instance,
1072                                 const gchar *detailed_signal)
1073 {
1074   guint signal_id;
1075   GQuark detail = 0;
1076   GType itype;
1077   
1078   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1079   g_return_if_fail (detailed_signal != NULL);
1080   
1081   SIGNAL_LOCK ();
1082   itype = G_TYPE_FROM_INSTANCE (instance);
1083   signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
1084   if (signal_id)
1085     {
1086       SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
1087       
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);
1092       else
1093         {
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);
1096           
1097           if (emission)
1098             {
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;
1104             }
1105           else
1106             g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
1107                        node->name, instance);
1108         }
1109     }
1110   else
1111     g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
1112   SIGNAL_UNLOCK ();
1113 }
1114
1115 /**
1116  * g_signal_lookup:
1117  * @name: the signal's name.
1118  * @itype: the type that the signal operates on.
1119  *
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.
1123  *
1124  * Also tries the ancestors of the given type.
1125  *
1126  * See g_signal_new() for details on allowed signal names.
1127  *
1128  * Returns: the signal's identifying number, or 0 if no signal was found.
1129  */
1130 guint
1131 g_signal_lookup (const gchar *name,
1132                  GType        itype)
1133 {
1134   guint signal_id;
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);
1137   
1138   SIGNAL_LOCK ();
1139   signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1140   SIGNAL_UNLOCK ();
1141   if (!signal_id)
1142     {
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"'",
1146                    name, itype);
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));
1153     }
1154   
1155   return signal_id;
1156 }
1157
1158 /**
1159  * g_signal_list_ids:
1160  * @itype: Instance or interface type.
1161  * @n_ids: Location to store the number of signal ids for @itype.
1162  *
1163  * Lists the signals by id that a certain instance or interface type
1164  * created. Further information about the signals can be acquired through
1165  * g_signal_query().
1166  *
1167  * Returns: Newly allocated array of signal IDs.
1168  */
1169 guint*
1170 g_signal_list_ids (GType  itype,
1171                    guint *n_ids)
1172 {
1173   SignalKey *keys;
1174   GArray *result;
1175   guint n_nodes;
1176   guint i;
1177   
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);
1180   
1181   SIGNAL_LOCK ();
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));
1185   
1186   for (i = 0; i < n_nodes; i++)
1187     if (keys[i].itype == itype)
1188       {
1189         const gchar *name = g_quark_to_string (keys[i].quark);
1190         
1191         /* Signal names with "_" in them are aliases to the same
1192          * name with "-" instead of "_".
1193          */
1194         if (!strchr (name, '_'))
1195           g_array_append_val (result, keys[i].signal_id);
1196       }
1197   *n_ids = result->len;
1198   SIGNAL_UNLOCK ();
1199   if (!n_nodes)
1200     {
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"'",
1204                    itype);
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));
1211     }
1212   
1213   return (guint*) g_array_free (result, FALSE);
1214 }
1215
1216 /**
1217  * g_signal_name:
1218  * @signal_id: the signal's identifying number.
1219  *
1220  * Given the signal's identifier, finds its name.
1221  *
1222  * Two different signals may have the same name, if they have differing types.
1223  *
1224  * Returns: the signal name, or %NULL if the signal number was invalid.
1225  */
1226 const gchar *
1227 g_signal_name (guint signal_id)
1228 {
1229   SignalNode *node;
1230   const gchar *name;
1231   
1232   SIGNAL_LOCK ();
1233   node = LOOKUP_SIGNAL_NODE (signal_id);
1234   name = node ? node->name : NULL;
1235   SIGNAL_UNLOCK ();
1236   
1237   return (char*) name;
1238 }
1239
1240 /**
1241  * g_signal_query:
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.
1245  *
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.
1252  */
1253 void
1254 g_signal_query (guint         signal_id,
1255                 GSignalQuery *query)
1256 {
1257   SignalNode *node;
1258   
1259   g_return_if_fail (query != NULL);
1260   
1261   SIGNAL_LOCK ();
1262   node = LOOKUP_SIGNAL_NODE (signal_id);
1263   if (!node || node->destroyed)
1264     query->signal_id = 0;
1265   else
1266     {
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;
1274     }
1275   SIGNAL_UNLOCK ();
1276 }
1277
1278 /**
1279  * g_signal_new:
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: (allow-none): the function to translate arrays of parameter
1292  *  values to signal emissions into C language callback invocations or %NULL.
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.
1297  *
1298  * Creates a new signal. (This is usually done in the class initializer.)
1299  *
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.
1304  *
1305  * When registering a signal and looking up a signal, either separator can
1306  * be used, but they cannot be mixed.
1307  *
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().
1312  *
1313  * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
1314  * the marshaller for this signal.
1315  *
1316  * Returns: the signal id
1317  */
1318 guint
1319 g_signal_new (const gchar        *signal_name,
1320               GType               itype,
1321               GSignalFlags        signal_flags,
1322               guint               class_offset,
1323               GSignalAccumulator  accumulator,
1324               gpointer            accu_data,
1325               GSignalCMarshaller  c_marshaller,
1326               GType               return_type,
1327               guint               n_params,
1328               ...)
1329 {
1330   va_list args;
1331   guint signal_id;
1332
1333   g_return_val_if_fail (signal_name != NULL, 0);
1334   
1335   va_start (args, n_params);
1336
1337   signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1338                                    class_offset ? g_signal_type_cclosure_new (itype, class_offset) : NULL,
1339                                    accumulator, accu_data, c_marshaller,
1340                                    return_type, n_params, args);
1341
1342   va_end (args);
1343
1344   /* optimize NOP emissions with NULL class handlers */
1345   if (signal_id && G_TYPE_IS_INSTANTIATABLE (itype) && return_type == G_TYPE_NONE &&
1346       class_offset && class_offset < MAX_TEST_CLASS_OFFSET &&
1347       ~signal_flags & G_SIGNAL_MUST_COLLECT)
1348     {
1349       SignalNode *node;
1350
1351       SIGNAL_LOCK ();
1352       node = LOOKUP_SIGNAL_NODE (signal_id);
1353       node->test_class_offset = class_offset;
1354       SIGNAL_UNLOCK ();
1355     }
1356  
1357   return signal_id;
1358 }
1359
1360 /**
1361  * g_signal_new_class_handler:
1362  * @signal_name: the name for the signal
1363  * @itype: the type this signal pertains to. It will also pertain to
1364  *  types which are derived from this type.
1365  * @signal_flags: a combination of #GSignalFlags specifying detail of when
1366  *  the default handler is to be invoked. You should at least specify
1367  *  %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1368  * @class_handler: a #GCallback which acts as class implementation of
1369  *  this signal. Used to invoke a class method generically. Pass %NULL to
1370  *  not associate a class method with this signal.
1371  * @accumulator: the accumulator for this signal; may be %NULL.
1372  * @accu_data: user data for the @accumulator.
1373  * @c_marshaller: (allow-none): the function to translate arrays of parameter
1374  *  values to signal emissions into C language callback invocations or %NULL.
1375  * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1376  *  without a return value.
1377  * @n_params: the number of parameter types to follow.
1378  * @...: a list of types, one for each parameter.
1379  *
1380  * Creates a new signal. (This is usually done in the class initializer.)
1381  *
1382  * This is a variant of g_signal_new() that takes a C callback instead
1383  * off a class offset for the signal's class handler. This function
1384  * doesn't need a function pointer exposed in the class structure of
1385  * an object definition, instead the function pointer is passed
1386  * directly and can be overriden by derived classes with
1387  * g_signal_override_class_closure() or
1388  * g_signal_override_class_handler()and chained to with
1389  * g_signal_chain_from_overridden() or
1390  * g_signal_chain_from_overridden_handler().
1391  *
1392  * See g_signal_new() for information about signal names.
1393  *
1394  * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
1395  * the marshaller for this signal.
1396  *
1397  * Returns: the signal id
1398  *
1399  * Since: 2.18
1400  */
1401 guint
1402 g_signal_new_class_handler (const gchar        *signal_name,
1403                             GType               itype,
1404                             GSignalFlags        signal_flags,
1405                             GCallback           class_handler,
1406                             GSignalAccumulator  accumulator,
1407                             gpointer            accu_data,
1408                             GSignalCMarshaller  c_marshaller,
1409                             GType               return_type,
1410                             guint               n_params,
1411                             ...)
1412 {
1413   va_list args;
1414   guint signal_id;
1415
1416   g_return_val_if_fail (signal_name != NULL, 0);
1417
1418   va_start (args, n_params);
1419
1420   signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1421                                    class_handler ? g_cclosure_new (class_handler, NULL, NULL) : NULL,
1422                                    accumulator, accu_data, c_marshaller,
1423                                    return_type, n_params, args);
1424
1425   va_end (args);
1426
1427   return signal_id;
1428 }
1429
1430 static inline ClassClosure*
1431 signal_find_class_closure (SignalNode *node,
1432                            GType       itype)
1433 {
1434   GBSearchArray *bsa = node->class_closure_bsa;
1435   ClassClosure *cc;
1436
1437   if (bsa)
1438     {
1439       ClassClosure key;
1440
1441       /* cc->instance_type is 0 for default closure */
1442       
1443       key.instance_type = itype;
1444       cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1445       while (!cc && key.instance_type)
1446         {
1447           key.instance_type = g_type_parent (key.instance_type);
1448           cc = g_bsearch_array_lookup (bsa, &g_class_closure_bconfig, &key);
1449         }
1450     }
1451   else
1452     cc = NULL;
1453   return cc;
1454 }
1455
1456 static inline GClosure*
1457 signal_lookup_closure (SignalNode    *node,
1458                        GTypeInstance *instance)
1459 {
1460   ClassClosure *cc;
1461
1462   if (node->class_closure_bsa && g_bsearch_array_get_n_nodes (node->class_closure_bsa) == 1)
1463     {
1464       cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
1465       if (cc && cc->instance_type == 0) /* check for default closure */
1466         return cc->closure;
1467     }
1468   cc = signal_find_class_closure (node, G_TYPE_FROM_INSTANCE (instance));
1469   return cc ? cc->closure : NULL;
1470 }
1471
1472 static void
1473 signal_add_class_closure (SignalNode *node,
1474                           GType       itype,
1475                           GClosure   *closure)
1476 {
1477   ClassClosure key;
1478
1479   /* can't optimize NOP emissions with overridden class closures */
1480   node->test_class_offset = 0;
1481
1482   if (!node->class_closure_bsa)
1483     node->class_closure_bsa = g_bsearch_array_create (&g_class_closure_bconfig);
1484   key.instance_type = itype;
1485   key.closure = g_closure_ref (closure);
1486   node->class_closure_bsa = g_bsearch_array_insert (node->class_closure_bsa,
1487                                                     &g_class_closure_bconfig,
1488                                                     &key);
1489   g_closure_sink (closure);
1490   if (node->c_marshaller && closure && G_CLOSURE_NEEDS_MARSHAL (closure))
1491     g_closure_set_marshal (closure, node->c_marshaller);
1492 }
1493
1494 /**
1495  * g_signal_newv:
1496  * @signal_name: the name for the signal
1497  * @itype: the type this signal pertains to. It will also pertain to
1498  *     types which are derived from this type
1499  * @signal_flags: a combination of #GSignalFlags specifying detail of when
1500  *     the default handler is to be invoked. You should at least specify
1501  *     %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
1502  * @class_closure: The closure to invoke on signal emission; may be %NULL
1503  * @accumulator: the accumulator for this signal; may be %NULL
1504  * @accu_data: user data for the @accumulator
1505  * @c_marshaller: (allow-none): the function to translate arrays of
1506  *     parameter values to signal emissions into C language callback
1507  *     invocations or %NULL
1508  * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1509  *     without a return value
1510  * @n_params: the length of @param_types
1511  * @param_types: an array of types, one for each parameter
1512  *
1513  * Creates a new signal. (This is usually done in the class initializer.)
1514  *
1515  * See g_signal_new() for details on allowed signal names.
1516  *
1517  * If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as
1518  * the marshaller for this signal.
1519  *
1520  * Returns: the signal id
1521  */
1522 guint
1523 g_signal_newv (const gchar       *signal_name,
1524                GType              itype,
1525                GSignalFlags       signal_flags,
1526                GClosure          *class_closure,
1527                GSignalAccumulator accumulator,
1528                gpointer           accu_data,
1529                GSignalCMarshaller c_marshaller,
1530                GType              return_type,
1531                guint              n_params,
1532                GType             *param_types)
1533 {
1534   gchar *name;
1535   guint signal_id, i;
1536   SignalNode *node;
1537   
1538   g_return_val_if_fail (signal_name != NULL, 0);
1539   g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
1540   if (n_params)
1541     g_return_val_if_fail (param_types != NULL, 0);
1542   g_return_val_if_fail ((return_type & G_SIGNAL_TYPE_STATIC_SCOPE) == 0, 0);
1543   if (return_type == (G_TYPE_NONE & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1544     g_return_val_if_fail (accumulator == NULL, 0);
1545   if (!accumulator)
1546     g_return_val_if_fail (accu_data == NULL, 0);
1547
1548   name = g_strdup (signal_name);
1549   g_strdelimit (name, G_STR_DELIMITERS ":^", '_');  /* FIXME do character checks like for types */
1550   
1551   SIGNAL_LOCK ();
1552   
1553   signal_id = signal_id_lookup (g_quark_try_string (name), itype);
1554   node = LOOKUP_SIGNAL_NODE (signal_id);
1555   if (node && !node->destroyed)
1556     {
1557       g_warning (G_STRLOC ": signal \"%s\" already exists in the `%s' %s",
1558                  name,
1559                  type_debug_name (node->itype),
1560                  G_TYPE_IS_INTERFACE (node->itype) ? "interface" : "class ancestry");
1561       g_free (name);
1562       SIGNAL_UNLOCK ();
1563       return 0;
1564     }
1565   if (node && node->itype != itype)
1566     {
1567       g_warning (G_STRLOC ": signal \"%s\" for type `%s' was previously created for type `%s'",
1568                  name,
1569                  type_debug_name (itype),
1570                  type_debug_name (node->itype));
1571       g_free (name);
1572       SIGNAL_UNLOCK ();
1573       return 0;
1574     }
1575   for (i = 0; i < n_params; i++)
1576     if (!G_TYPE_IS_VALUE (param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1577       {
1578         g_warning (G_STRLOC ": parameter %d of type `%s' for signal \"%s::%s\" is not a value type",
1579                    i + 1, type_debug_name (param_types[i]), type_debug_name (itype), name);
1580         g_free (name);
1581         SIGNAL_UNLOCK ();
1582         return 0;
1583       }
1584   if (return_type != G_TYPE_NONE && !G_TYPE_IS_VALUE (return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
1585     {
1586       g_warning (G_STRLOC ": return value of type `%s' for signal \"%s::%s\" is not a value type",
1587                  type_debug_name (return_type), type_debug_name (itype), name);
1588       g_free (name);
1589       SIGNAL_UNLOCK ();
1590       return 0;
1591     }
1592   if (return_type != G_TYPE_NONE &&
1593       (signal_flags & (G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST | G_SIGNAL_RUN_CLEANUP)) == G_SIGNAL_RUN_FIRST)
1594     {
1595       g_warning (G_STRLOC ": signal \"%s::%s\" has return type `%s' and is only G_SIGNAL_RUN_FIRST",
1596                  type_debug_name (itype), name, type_debug_name (return_type));
1597       g_free (name);
1598       SIGNAL_UNLOCK ();
1599       return 0;
1600     }
1601   
1602   /* setup permanent portion of signal node */
1603   if (!node)
1604     {
1605       SignalKey key;
1606       
1607       signal_id = g_n_signal_nodes++;
1608       node = g_new (SignalNode, 1);
1609       node->signal_id = signal_id;
1610       g_signal_nodes = g_renew (SignalNode*, g_signal_nodes, g_n_signal_nodes);
1611       g_signal_nodes[signal_id] = node;
1612       node->itype = itype;
1613       node->name = name;
1614       key.itype = itype;
1615       key.quark = g_quark_from_string (node->name);
1616       key.signal_id = signal_id;
1617       g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1618       g_strdelimit (name, "_", '-');
1619       node->name = g_intern_string (name);
1620       key.quark = g_quark_from_string (name);
1621       g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
1622
1623       TRACE(GOBJECT_SIGNAL_NEW(signal_id, name, itype));
1624     }
1625   node->destroyed = FALSE;
1626   node->test_class_offset = 0;
1627
1628   /* setup reinitializable portion */
1629   node->flags = signal_flags & G_SIGNAL_FLAGS_MASK;
1630   node->n_params = n_params;
1631   node->param_types = g_memdup (param_types, sizeof (GType) * n_params);
1632   node->return_type = return_type;
1633   node->class_closure_bsa = NULL;
1634   if (accumulator)
1635     {
1636       node->accumulator = g_new (SignalAccumulator, 1);
1637       node->accumulator->func = accumulator;
1638       node->accumulator->data = accu_data;
1639     }
1640   else
1641     node->accumulator = NULL;
1642   if (c_marshaller == NULL)
1643       c_marshaller = g_cclosure_marshal_generic;
1644   node->c_marshaller = c_marshaller;
1645   node->emission_hooks = NULL;
1646   if (class_closure)
1647     signal_add_class_closure (node, 0, class_closure);
1648   else if (G_TYPE_IS_INSTANTIATABLE (itype) &&
1649            return_type == G_TYPE_NONE &&
1650            ~signal_flags & G_SIGNAL_MUST_COLLECT)
1651     {
1652       /* optimize NOP emissions */
1653       node->test_class_offset = TEST_CLASS_MAGIC;
1654     }
1655   SIGNAL_UNLOCK ();
1656
1657   g_free (name);
1658
1659   return signal_id;
1660 }
1661
1662 /**
1663  * g_signal_new_valist:
1664  * @signal_name: the name for the signal
1665  * @itype: the type this signal pertains to. It will also pertain to
1666  *  types which are derived from this type.
1667  * @signal_flags: a combination of #GSignalFlags specifying detail of when
1668  *  the default handler is to be invoked. You should at least specify
1669  *  %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
1670  * @class_closure: The closure to invoke on signal emission; may be %NULL.
1671  * @accumulator: the accumulator for this signal; may be %NULL.
1672  * @accu_data: user data for the @accumulator.
1673  * @c_marshaller: (allow-none): the function to translate arrays of parameter
1674  *  values to signal emissions into C language callback invocations or %NULL.
1675  * @return_type: the type of return value, or #G_TYPE_NONE for a signal
1676  *  without a return value.
1677  * @n_params: the number of parameter types in @args.
1678  * @args: va_list of #GType, one for each parameter.
1679  *
1680  * Creates a new signal. (This is usually done in the class initializer.)
1681  *
1682  * See g_signal_new() for details on allowed signal names.
1683  *
1684  * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
1685  * the marshaller for this signal.
1686  *
1687  * Returns: the signal id
1688  */
1689 guint
1690 g_signal_new_valist (const gchar       *signal_name,
1691                      GType              itype,
1692                      GSignalFlags       signal_flags,
1693                      GClosure          *class_closure,
1694                      GSignalAccumulator accumulator,
1695                      gpointer           accu_data,
1696                      GSignalCMarshaller c_marshaller,
1697                      GType              return_type,
1698                      guint              n_params,
1699                      va_list            args)
1700 {
1701   GType *param_types;
1702   guint i;
1703   guint signal_id;
1704
1705   if (n_params > 0)
1706     {
1707       param_types = g_new (GType, n_params);
1708
1709       for (i = 0; i < n_params; i++)
1710         param_types[i] = va_arg (args, GType);
1711     }
1712   else
1713     param_types = NULL;
1714
1715   signal_id = g_signal_newv (signal_name, itype, signal_flags,
1716                              class_closure, accumulator, accu_data, c_marshaller,
1717                              return_type, n_params, param_types);
1718   g_free (param_types);
1719
1720   return signal_id;
1721 }
1722
1723 static void
1724 signal_destroy_R (SignalNode *signal_node)
1725 {
1726   SignalNode node = *signal_node;
1727
1728   signal_node->destroyed = TRUE;
1729   
1730   /* reentrancy caution, zero out real contents first */
1731   signal_node->test_class_offset = 0;
1732   signal_node->n_params = 0;
1733   signal_node->param_types = NULL;
1734   signal_node->return_type = 0;
1735   signal_node->class_closure_bsa = NULL;
1736   signal_node->accumulator = NULL;
1737   signal_node->c_marshaller = NULL;
1738   signal_node->emission_hooks = NULL;
1739   
1740 #ifdef  G_ENABLE_DEBUG
1741   /* check current emissions */
1742   {
1743     Emission *emission;
1744     
1745     for (emission = (node.flags & G_SIGNAL_NO_RECURSE) ? g_restart_emissions : g_recursive_emissions;
1746          emission; emission = emission->next)
1747       if (emission->ihint.signal_id == node.signal_id)
1748         g_critical (G_STRLOC ": signal \"%s\" being destroyed is currently in emission (instance `%p')",
1749                     node.name, emission->instance);
1750   }
1751 #endif
1752   
1753   /* free contents that need to
1754    */
1755   SIGNAL_UNLOCK ();
1756   g_free (node.param_types);
1757   if (node.class_closure_bsa)
1758     {
1759       guint i;
1760
1761       for (i = 0; i < node.class_closure_bsa->n_nodes; i++)
1762         {
1763           ClassClosure *cc = g_bsearch_array_get_nth (node.class_closure_bsa, &g_class_closure_bconfig, i);
1764
1765           g_closure_unref (cc->closure);
1766         }
1767       g_bsearch_array_free (node.class_closure_bsa, &g_class_closure_bconfig);
1768     }
1769   g_free (node.accumulator);
1770   if (node.emission_hooks)
1771     {
1772       g_hook_list_clear (node.emission_hooks);
1773       g_free (node.emission_hooks);
1774     }
1775   SIGNAL_LOCK ();
1776 }
1777
1778 /**
1779  * g_signal_override_class_closure:
1780  * @signal_id: the signal id
1781  * @instance_type: the instance type on which to override the class closure
1782  *  for the signal.
1783  * @class_closure: the closure.
1784  *
1785  * Overrides the class closure (i.e. the default handler) for the given signal
1786  * for emissions on instances of @instance_type. @instance_type must be derived
1787  * from the type to which the signal belongs.
1788  *
1789  * See g_signal_chain_from_overridden() and
1790  * g_signal_chain_from_overridden_handler() for how to chain up to the
1791  * parent class closure from inside the overridden one.
1792  */
1793 void
1794 g_signal_override_class_closure (guint     signal_id,
1795                                  GType     instance_type,
1796                                  GClosure *class_closure)
1797 {
1798   SignalNode *node;
1799   
1800   g_return_if_fail (signal_id > 0);
1801   g_return_if_fail (class_closure != NULL);
1802   
1803   SIGNAL_LOCK ();
1804   node = LOOKUP_SIGNAL_NODE (signal_id);
1805   if (!g_type_is_a (instance_type, node->itype))
1806     g_warning ("%s: type `%s' cannot be overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1807   else
1808     {
1809       ClassClosure *cc = signal_find_class_closure (node, instance_type);
1810       
1811       if (cc && cc->instance_type == instance_type)
1812         g_warning ("%s: type `%s' is already overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
1813       else
1814         signal_add_class_closure (node, instance_type, class_closure);
1815     }
1816   SIGNAL_UNLOCK ();
1817 }
1818
1819 /**
1820  * g_signal_override_class_handler:
1821  * @signal_name: the name for the signal
1822  * @instance_type: the instance type on which to override the class handler
1823  *  for the signal.
1824  * @class_handler: the handler.
1825  *
1826  * Overrides the class closure (i.e. the default handler) for the
1827  * given signal for emissions on instances of @instance_type with
1828  * callabck @class_handler. @instance_type must be derived from the
1829  * type to which the signal belongs.
1830  *
1831  * See g_signal_chain_from_overridden() and
1832  * g_signal_chain_from_overridden_handler() for how to chain up to the
1833  * parent class closure from inside the overridden one.
1834  *
1835  * Since: 2.18
1836  */
1837 void
1838 g_signal_override_class_handler (const gchar *signal_name,
1839                                  GType        instance_type,
1840                                  GCallback    class_handler)
1841 {
1842   guint signal_id;
1843
1844   g_return_if_fail (signal_name != NULL);
1845   g_return_if_fail (instance_type != G_TYPE_NONE);
1846   g_return_if_fail (class_handler != NULL);
1847
1848   signal_id = g_signal_lookup (signal_name, instance_type);
1849
1850   if (signal_id)
1851     g_signal_override_class_closure (signal_id, instance_type,
1852                                      g_cclosure_new (class_handler, NULL, NULL));
1853   else
1854     g_warning ("%s: signal name '%s' is invalid for type id '%"G_GSIZE_FORMAT"'",
1855                G_STRLOC, signal_name, instance_type);
1856
1857 }
1858
1859 /**
1860  * g_signal_chain_from_overridden:
1861  * @instance_and_params: the argument list of the signal emission. The first
1862  *  element in the array is a #GValue for the instance the signal is being
1863  *  emitted on. The rest are any arguments to be passed to the signal.
1864  * @return_value: Location for the return value.
1865  *
1866  * Calls the original class closure of a signal. This function should only
1867  * be called from an overridden class closure; see
1868  * g_signal_override_class_closure() and
1869  * g_signal_override_class_handler().
1870  */
1871 void
1872 g_signal_chain_from_overridden (const GValue *instance_and_params,
1873                                 GValue       *return_value)
1874 {
1875   GType chain_type = 0, restore_type = 0;
1876   Emission *emission = NULL;
1877   GClosure *closure = NULL;
1878   guint n_params = 0;
1879   gpointer instance;
1880   
1881   g_return_if_fail (instance_and_params != NULL);
1882   instance = g_value_peek_pointer (instance_and_params);
1883   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1884   
1885   SIGNAL_LOCK ();
1886   emission = emission_find_innermost (instance);
1887   if (emission)
1888     {
1889       SignalNode *node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
1890       
1891       g_assert (node != NULL);  /* paranoid */
1892       
1893       /* we should probably do the same parameter checks as g_signal_emit() here.
1894        */
1895       if (emission->chain_type != G_TYPE_NONE)
1896         {
1897           ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
1898           
1899           g_assert (cc != NULL);        /* closure currently in call stack */
1900
1901           n_params = node->n_params;
1902           restore_type = cc->instance_type;
1903           cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
1904           if (cc && cc->instance_type != restore_type)
1905             {
1906               closure = cc->closure;
1907               chain_type = cc->instance_type;
1908             }
1909         }
1910       else
1911         g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
1912     }
1913   else
1914     g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
1915
1916   if (closure)
1917     {
1918       emission->chain_type = chain_type;
1919       SIGNAL_UNLOCK ();
1920       g_closure_invoke (closure,
1921                         return_value,
1922                         n_params + 1,
1923                         instance_and_params,
1924                         &emission->ihint);
1925       SIGNAL_LOCK ();
1926       emission->chain_type = restore_type;
1927     }
1928   SIGNAL_UNLOCK ();
1929 }
1930
1931 /**
1932  * g_signal_chain_from_overridden_handler:
1933  * @instance: the instance the signal is being emitted on.
1934  * @...: parameters to be passed to the parent class closure, followed by a
1935  *  location for the return value. If the return type of the signal
1936  *  is #G_TYPE_NONE, the return value location can be omitted.
1937  *
1938  * Calls the original class closure of a signal. This function should
1939  * only be called from an overridden class closure; see
1940  * g_signal_override_class_closure() and
1941  * g_signal_override_class_handler().
1942  *
1943  * Since: 2.18
1944  */
1945 void
1946 g_signal_chain_from_overridden_handler (gpointer instance,
1947                                         ...)
1948 {
1949   GType chain_type = 0, restore_type = 0;
1950   Emission *emission = NULL;
1951   GClosure *closure = NULL;
1952   SignalNode *node;
1953   guint n_params = 0;
1954
1955   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
1956
1957   SIGNAL_LOCK ();
1958   emission = emission_find_innermost (instance);
1959   if (emission)
1960     {
1961       node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
1962
1963       g_assert (node != NULL);  /* paranoid */
1964
1965       /* we should probably do the same parameter checks as g_signal_emit() here.
1966        */
1967       if (emission->chain_type != G_TYPE_NONE)
1968         {
1969           ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
1970
1971           g_assert (cc != NULL);        /* closure currently in call stack */
1972
1973           n_params = node->n_params;
1974           restore_type = cc->instance_type;
1975           cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
1976           if (cc && cc->instance_type != restore_type)
1977             {
1978               closure = cc->closure;
1979               chain_type = cc->instance_type;
1980             }
1981         }
1982       else
1983         g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
1984     }
1985   else
1986     g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
1987
1988   if (closure)
1989     {
1990       GValue *instance_and_params;
1991       GType signal_return_type;
1992       GValue *param_values;
1993       va_list var_args;
1994       guint i;
1995
1996       va_start (var_args, instance);
1997
1998       signal_return_type = node->return_type;
1999       instance_and_params = g_slice_alloc0 (sizeof (GValue) * (n_params + 1));
2000       param_values = instance_and_params + 1;
2001
2002       for (i = 0; i < node->n_params; i++)
2003         {
2004           gchar *error;
2005           GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2006           gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
2007
2008           SIGNAL_UNLOCK ();
2009           G_VALUE_COLLECT_INIT (param_values + i, ptype,
2010                                 var_args,
2011                                 static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2012                                 &error);
2013           if (error)
2014             {
2015               g_warning ("%s: %s", G_STRLOC, error);
2016               g_free (error);
2017
2018               /* we purposely leak the value here, it might not be
2019                * in a sane state if an error condition occoured
2020                */
2021               while (i--)
2022                 g_value_unset (param_values + i);
2023
2024               g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
2025               va_end (var_args);
2026               return;
2027             }
2028           SIGNAL_LOCK ();
2029         }
2030
2031       SIGNAL_UNLOCK ();
2032       instance_and_params->g_type = 0;
2033       g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
2034       g_value_set_instance (instance_and_params, instance);
2035       SIGNAL_LOCK ();
2036
2037       emission->chain_type = chain_type;
2038       SIGNAL_UNLOCK ();
2039
2040       if (signal_return_type == G_TYPE_NONE)
2041         {
2042           g_closure_invoke (closure,
2043                             NULL,
2044                             n_params + 1,
2045                             instance_and_params,
2046                             &emission->ihint);
2047         }
2048       else
2049         {
2050           GValue return_value = { 0, };
2051           gchar *error = NULL;
2052           GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2053           gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
2054
2055           g_value_init (&return_value, rtype);
2056
2057           g_closure_invoke (closure,
2058                             &return_value,
2059                             n_params + 1,
2060                             instance_and_params,
2061                             &emission->ihint);
2062
2063           G_VALUE_LCOPY (&return_value,
2064                          var_args,
2065                          static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2066                          &error);
2067           if (!error)
2068             {
2069               g_value_unset (&return_value);
2070             }
2071           else
2072             {
2073               g_warning ("%s: %s", G_STRLOC, error);
2074               g_free (error);
2075
2076               /* we purposely leak the value here, it might not be
2077                * in a sane state if an error condition occured
2078                */
2079             }
2080         }
2081
2082       for (i = 0; i < n_params; i++)
2083         g_value_unset (param_values + i);
2084       g_value_unset (instance_and_params);
2085       g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
2086
2087       va_end (var_args);
2088
2089       SIGNAL_LOCK ();
2090       emission->chain_type = restore_type;
2091     }
2092   SIGNAL_UNLOCK ();
2093 }
2094
2095 /**
2096  * g_signal_get_invocation_hint:
2097  * @instance: the instance to query
2098  *
2099  * Returns the invocation hint of the innermost signal emission of instance.
2100  *
2101  * Returns: the invocation hint of the innermost signal emission.
2102  */
2103 GSignalInvocationHint*
2104 g_signal_get_invocation_hint (gpointer instance)
2105 {
2106   Emission *emission = NULL;
2107   
2108   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), NULL);
2109
2110   SIGNAL_LOCK ();
2111   emission = emission_find_innermost (instance);
2112   SIGNAL_UNLOCK ();
2113   
2114   return emission ? &emission->ihint : NULL;
2115 }
2116
2117 /**
2118  * g_signal_connect_closure_by_id:
2119  * @instance: the instance to connect to.
2120  * @signal_id: the id of the signal.
2121  * @detail: the detail.
2122  * @closure: the closure to connect.
2123  * @after: whether the handler should be called before or after the
2124  *  default handler of the signal.
2125  *
2126  * Connects a closure to a signal for a particular object.
2127  *
2128  * Returns: the handler id
2129  */
2130 gulong
2131 g_signal_connect_closure_by_id (gpointer  instance,
2132                                 guint     signal_id,
2133                                 GQuark    detail,
2134                                 GClosure *closure,
2135                                 gboolean  after)
2136 {
2137   SignalNode *node;
2138   gulong handler_seq_no = 0;
2139   
2140   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2141   g_return_val_if_fail (signal_id > 0, 0);
2142   g_return_val_if_fail (closure != NULL, 0);
2143   
2144   SIGNAL_LOCK ();
2145   node = LOOKUP_SIGNAL_NODE (signal_id);
2146   if (node)
2147     {
2148       if (detail && !(node->flags & G_SIGNAL_DETAILED))
2149         g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2150       else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2151         g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2152       else
2153         {
2154           Handler *handler = handler_new (after);
2155           
2156           handler_seq_no = handler->sequential_number;
2157           handler->detail = detail;
2158           handler->closure = g_closure_ref (closure);
2159           g_closure_sink (closure);
2160           handler_insert (signal_id, instance, handler);
2161           if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (closure))
2162             g_closure_set_marshal (closure, node->c_marshaller);
2163         }
2164     }
2165   else
2166     g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2167   SIGNAL_UNLOCK ();
2168   
2169   return handler_seq_no;
2170 }
2171
2172 /**
2173  * g_signal_connect_closure:
2174  * @instance: the instance to connect to.
2175  * @detailed_signal: a string of the form "signal-name::detail".
2176  * @closure: the closure to connect.
2177  * @after: whether the handler should be called before or after the
2178  *  default handler of the signal.
2179  *
2180  * Connects a closure to a signal for a particular object.
2181  *
2182  * Returns: the handler id
2183  */
2184 gulong
2185 g_signal_connect_closure (gpointer     instance,
2186                           const gchar *detailed_signal,
2187                           GClosure    *closure,
2188                           gboolean     after)
2189 {
2190   guint signal_id;
2191   gulong handler_seq_no = 0;
2192   GQuark detail = 0;
2193   GType itype;
2194
2195   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2196   g_return_val_if_fail (detailed_signal != NULL, 0);
2197   g_return_val_if_fail (closure != NULL, 0);
2198
2199   SIGNAL_LOCK ();
2200   itype = G_TYPE_FROM_INSTANCE (instance);
2201   signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2202   if (signal_id)
2203     {
2204       SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2205
2206       if (detail && !(node->flags & G_SIGNAL_DETAILED))
2207         g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
2208       else if (!g_type_is_a (itype, node->itype))
2209         g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2210       else
2211         {
2212           Handler *handler = handler_new (after);
2213
2214           handler_seq_no = handler->sequential_number;
2215           handler->detail = detail;
2216           handler->closure = g_closure_ref (closure);
2217           g_closure_sink (closure);
2218           handler_insert (signal_id, instance, handler);
2219           if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2220             g_closure_set_marshal (handler->closure, node->c_marshaller);
2221         }
2222     }
2223   else
2224     g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2225   SIGNAL_UNLOCK ();
2226
2227   return handler_seq_no;
2228 }
2229
2230 /**
2231  * g_signal_connect_data:
2232  * @instance: the instance to connect to.
2233  * @detailed_signal: a string of the form "signal-name::detail".
2234  * @c_handler: the #GCallback to connect.
2235  * @data: data to pass to @c_handler calls.
2236  * @destroy_data: a #GClosureNotify for @data.
2237  * @connect_flags: a combination of #GConnectFlags.
2238  *
2239  * Connects a #GCallback function to a signal for a particular object. Similar
2240  * to g_signal_connect(), but allows to provide a #GClosureNotify for the data
2241  * which will be called when the signal handler is disconnected and no longer
2242  * used. Specify @connect_flags if you need <literal>..._after()</literal> or
2243  * <literal>..._swapped()</literal> variants of this function.
2244  *
2245  * Returns: the handler id
2246  */
2247 gulong
2248 g_signal_connect_data (gpointer       instance,
2249                        const gchar   *detailed_signal,
2250                        GCallback      c_handler,
2251                        gpointer       data,
2252                        GClosureNotify destroy_data,
2253                        GConnectFlags  connect_flags)
2254 {
2255   guint signal_id;
2256   gulong handler_seq_no = 0;
2257   GQuark detail = 0;
2258   GType itype;
2259   gboolean swapped, after;
2260   
2261   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2262   g_return_val_if_fail (detailed_signal != NULL, 0);
2263   g_return_val_if_fail (c_handler != NULL, 0);
2264
2265   swapped = (connect_flags & G_CONNECT_SWAPPED) != FALSE;
2266   after = (connect_flags & G_CONNECT_AFTER) != FALSE;
2267
2268   SIGNAL_LOCK ();
2269   itype = G_TYPE_FROM_INSTANCE (instance);
2270   signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
2271   if (signal_id)
2272     {
2273       SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2274
2275       if (detail && !(node->flags & G_SIGNAL_DETAILED))
2276         g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
2277       else if (!g_type_is_a (itype, node->itype))
2278         g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2279       else
2280         {
2281           Handler *handler = handler_new (after);
2282
2283           handler_seq_no = handler->sequential_number;
2284           handler->detail = detail;
2285           handler->closure = g_closure_ref ((swapped ? g_cclosure_new_swap : g_cclosure_new) (c_handler, data, destroy_data));
2286           g_closure_sink (handler->closure);
2287           handler_insert (signal_id, instance, handler);
2288           if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
2289             g_closure_set_marshal (handler->closure, node->c_marshaller);
2290         }
2291     }
2292   else
2293     g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
2294   SIGNAL_UNLOCK ();
2295
2296   return handler_seq_no;
2297 }
2298
2299 /**
2300  * g_signal_handler_block:
2301  * @instance: The instance to block the signal handler of.
2302  * @handler_id: Handler id of the handler to be blocked.
2303  *
2304  * Blocks a handler of an instance so it will not be called during any
2305  * signal emissions unless it is unblocked again. Thus "blocking" a
2306  * signal handler means to temporarily deactive it, a signal handler
2307  * has to be unblocked exactly the same amount of times it has been
2308  * blocked before to become active again.
2309  *
2310  * The @handler_id has to be a valid signal handler id, connected to a
2311  * signal of @instance.
2312  */
2313 void
2314 g_signal_handler_block (gpointer instance,
2315                         gulong   handler_id)
2316 {
2317   Handler *handler;
2318   
2319   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2320   g_return_if_fail (handler_id > 0);
2321   
2322   SIGNAL_LOCK ();
2323   handler = handler_lookup (instance, handler_id, NULL);
2324   if (handler)
2325     {
2326 #ifndef G_DISABLE_CHECKS
2327       if (handler->block_count >= HANDLER_MAX_BLOCK_COUNT - 1)
2328         g_error (G_STRLOC ": handler block_count overflow, %s", REPORT_BUG);
2329 #endif
2330       handler->block_count += 1;
2331     }
2332   else
2333     g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2334   SIGNAL_UNLOCK ();
2335 }
2336
2337 /**
2338  * g_signal_handler_unblock:
2339  * @instance: The instance to unblock the signal handler of.
2340  * @handler_id: Handler id of the handler to be unblocked.
2341  *
2342  * Undoes the effect of a previous g_signal_handler_block() call.  A
2343  * blocked handler is skipped during signal emissions and will not be
2344  * invoked, unblocking it (for exactly the amount of times it has been
2345  * blocked before) reverts its "blocked" state, so the handler will be
2346  * recognized by the signal system and is called upon future or
2347  * currently ongoing signal emissions (since the order in which
2348  * handlers are called during signal emissions is deterministic,
2349  * whether the unblocked handler in question is called as part of a
2350  * currently ongoing emission depends on how far that emission has
2351  * proceeded yet).
2352  *
2353  * The @handler_id has to be a valid id of a signal handler that is
2354  * connected to a signal of @instance and is currently blocked.
2355  */
2356 void
2357 g_signal_handler_unblock (gpointer instance,
2358                           gulong   handler_id)
2359 {
2360   Handler *handler;
2361   
2362   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2363   g_return_if_fail (handler_id > 0);
2364   
2365   SIGNAL_LOCK ();
2366   handler = handler_lookup (instance, handler_id, NULL);
2367   if (handler)
2368     {
2369       if (handler->block_count)
2370         handler->block_count -= 1;
2371       else
2372         g_warning (G_STRLOC ": handler `%lu' of instance `%p' is not blocked", handler_id, instance);
2373     }
2374   else
2375     g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2376   SIGNAL_UNLOCK ();
2377 }
2378
2379 /**
2380  * g_signal_handler_disconnect:
2381  * @instance: The instance to remove the signal handler from.
2382  * @handler_id: Handler id of the handler to be disconnected.
2383  *
2384  * Disconnects a handler from an instance so it will not be called during
2385  * any future or currently ongoing emissions of the signal it has been
2386  * connected to. The @handler_id becomes invalid and may be reused.
2387  *
2388  * The @handler_id has to be a valid signal handler id, connected to a
2389  * signal of @instance.
2390  */
2391 void
2392 g_signal_handler_disconnect (gpointer instance,
2393                              gulong   handler_id)
2394 {
2395   Handler *handler;
2396   guint signal_id;
2397   
2398   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2399   g_return_if_fail (handler_id > 0);
2400   
2401   SIGNAL_LOCK ();
2402   handler = handler_lookup (instance, handler_id, &signal_id);
2403   if (handler)
2404     {
2405       handler->sequential_number = 0;
2406       handler->block_count = 1;
2407       handler_unref_R (signal_id, instance, handler);
2408     }
2409   else
2410     g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
2411   SIGNAL_UNLOCK ();
2412 }
2413
2414 /**
2415  * g_signal_handler_is_connected:
2416  * @instance: The instance where a signal handler is sought.
2417  * @handler_id: the handler id.
2418  *
2419  * Returns whether @handler_id is the id of a handler connected to @instance.
2420  *
2421  * Returns: whether @handler_id identifies a handler connected to @instance.
2422  */
2423 gboolean
2424 g_signal_handler_is_connected (gpointer instance,
2425                                gulong   handler_id)
2426 {
2427   Handler *handler;
2428   gboolean connected;
2429
2430   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2431
2432   SIGNAL_LOCK ();
2433   handler = handler_lookup (instance, handler_id, NULL);
2434   connected = handler != NULL;
2435   SIGNAL_UNLOCK ();
2436
2437   return connected;
2438 }
2439
2440 void
2441 g_signal_handlers_destroy (gpointer instance)
2442 {
2443   GBSearchArray *hlbsa;
2444   
2445   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2446   
2447   SIGNAL_LOCK ();
2448   hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
2449   if (hlbsa)
2450     {
2451       guint i;
2452       
2453       /* reentrancy caution, delete instance trace first */
2454       g_hash_table_remove (g_handler_list_bsa_ht, instance);
2455       
2456       for (i = 0; i < hlbsa->n_nodes; i++)
2457         {
2458           HandlerList *hlist = g_bsearch_array_get_nth (hlbsa, &g_signal_hlbsa_bconfig, i);
2459           Handler *handler = hlist->handlers;
2460           
2461           while (handler)
2462             {
2463               Handler *tmp = handler;
2464               
2465               handler = tmp->next;
2466               tmp->block_count = 1;
2467               /* cruel unlink, this works because _all_ handlers vanish */
2468               tmp->next = NULL;
2469               tmp->prev = tmp;
2470               if (tmp->sequential_number)
2471                 {
2472                   tmp->sequential_number = 0;
2473                   handler_unref_R (0, NULL, tmp);
2474                 }
2475             }
2476         }
2477       g_bsearch_array_free (hlbsa, &g_signal_hlbsa_bconfig);
2478     }
2479   SIGNAL_UNLOCK ();
2480 }
2481
2482 /**
2483  * g_signal_handler_find:
2484  * @instance: The instance owning the signal handler to be found.
2485  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2486  *  and/or @data the handler has to match.
2487  * @signal_id: Signal the handler has to be connected to.
2488  * @detail: Signal detail the handler has to be connected to.
2489  * @closure: The closure the handler will invoke.
2490  * @func: The C closure callback of the handler (useless for non-C closures).
2491  * @data: The closure data of the handler's closure.
2492  *
2493  * Finds the first signal handler that matches certain selection criteria.
2494  * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2495  * flags, and the criteria values are passed as arguments.
2496  * The match @mask has to be non-0 for successful matches.
2497  * If no handler was found, 0 is returned.
2498  *
2499  * Returns: A valid non-0 signal handler id for a successful match.
2500  */
2501 gulong
2502 g_signal_handler_find (gpointer         instance,
2503                        GSignalMatchType mask,
2504                        guint            signal_id,
2505                        GQuark           detail,
2506                        GClosure        *closure,
2507                        gpointer         func,
2508                        gpointer         data)
2509 {
2510   gulong handler_seq_no = 0;
2511   
2512   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2513   g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2514   
2515   if (mask & G_SIGNAL_MATCH_MASK)
2516     {
2517       HandlerMatch *mlist;
2518       
2519       SIGNAL_LOCK ();
2520       mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, TRUE);
2521       if (mlist)
2522         {
2523           handler_seq_no = mlist->handler->sequential_number;
2524           handler_match_free1_R (mlist, instance);
2525         }
2526       SIGNAL_UNLOCK ();
2527     }
2528   
2529   return handler_seq_no;
2530 }
2531
2532 static guint
2533 signal_handlers_foreach_matched_R (gpointer         instance,
2534                                    GSignalMatchType mask,
2535                                    guint            signal_id,
2536                                    GQuark           detail,
2537                                    GClosure        *closure,
2538                                    gpointer         func,
2539                                    gpointer         data,
2540                                    void           (*callback) (gpointer instance,
2541                                                                gulong   handler_seq_no))
2542 {
2543   HandlerMatch *mlist;
2544   guint n_handlers = 0;
2545   
2546   mlist = handlers_find (instance, mask, signal_id, detail, closure, func, data, FALSE);
2547   while (mlist)
2548     {
2549       n_handlers++;
2550       if (mlist->handler->sequential_number)
2551         {
2552           SIGNAL_UNLOCK ();
2553           callback (instance, mlist->handler->sequential_number);
2554           SIGNAL_LOCK ();
2555         }
2556       mlist = handler_match_free1_R (mlist, instance);
2557     }
2558   
2559   return n_handlers;
2560 }
2561
2562 /**
2563  * g_signal_handlers_block_matched:
2564  * @instance: The instance to block handlers from.
2565  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2566  *  and/or @data the handlers have to match.
2567  * @signal_id: Signal the handlers have to be connected to.
2568  * @detail: Signal detail the handlers have to be connected to.
2569  * @closure: The closure the handlers will invoke.
2570  * @func: The C closure callback of the handlers (useless for non-C closures).
2571  * @data: The closure data of the handlers' closures.
2572  *
2573  * Blocks all handlers on an instance that match a certain selection criteria.
2574  * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
2575  * flags, and the criteria values are passed as arguments.
2576  * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2577  * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2578  * If no handlers were found, 0 is returned, the number of blocked handlers
2579  * otherwise.
2580  *
2581  * Returns: The number of handlers that matched.
2582  */
2583 guint
2584 g_signal_handlers_block_matched (gpointer         instance,
2585                                  GSignalMatchType mask,
2586                                  guint            signal_id,
2587                                  GQuark           detail,
2588                                  GClosure        *closure,
2589                                  gpointer         func,
2590                                  gpointer         data)
2591 {
2592   guint n_handlers = 0;
2593   
2594   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2595   g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2596   
2597   if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2598     {
2599       SIGNAL_LOCK ();
2600       n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2601                                                       closure, func, data,
2602                                                       g_signal_handler_block);
2603       SIGNAL_UNLOCK ();
2604     }
2605   
2606   return n_handlers;
2607 }
2608
2609 /**
2610  * g_signal_handlers_unblock_matched:
2611  * @instance: The instance to unblock handlers from.
2612  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2613  *  and/or @data the handlers have to match.
2614  * @signal_id: Signal the handlers have to be connected to.
2615  * @detail: Signal detail the handlers have to be connected to.
2616  * @closure: The closure the handlers will invoke.
2617  * @func: The C closure callback of the handlers (useless for non-C closures).
2618  * @data: The closure data of the handlers' closures.
2619  *
2620  * Unblocks all handlers on an instance that match a certain selection
2621  * criteria. The criteria mask is passed as an OR-ed combination of
2622  * #GSignalMatchType flags, and the criteria values are passed as arguments.
2623  * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
2624  * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
2625  * If no handlers were found, 0 is returned, the number of unblocked handlers
2626  * otherwise. The match criteria should not apply to any handlers that are
2627  * not currently blocked.
2628  *
2629  * Returns: The number of handlers that matched.
2630  */
2631 guint
2632 g_signal_handlers_unblock_matched (gpointer         instance,
2633                                    GSignalMatchType mask,
2634                                    guint            signal_id,
2635                                    GQuark           detail,
2636                                    GClosure        *closure,
2637                                    gpointer         func,
2638                                    gpointer         data)
2639 {
2640   guint n_handlers = 0;
2641   
2642   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2643   g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2644   
2645   if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2646     {
2647       SIGNAL_LOCK ();
2648       n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2649                                                       closure, func, data,
2650                                                       g_signal_handler_unblock);
2651       SIGNAL_UNLOCK ();
2652     }
2653   
2654   return n_handlers;
2655 }
2656
2657 /**
2658  * g_signal_handlers_disconnect_matched:
2659  * @instance: The instance to remove handlers from.
2660  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
2661  *  and/or @data the handlers have to match.
2662  * @signal_id: Signal the handlers have to be connected to.
2663  * @detail: Signal detail the handlers have to be connected to.
2664  * @closure: The closure the handlers will invoke.
2665  * @func: The C closure callback of the handlers (useless for non-C closures).
2666  * @data: The closure data of the handlers' closures.
2667  *
2668  * Disconnects all handlers on an instance that match a certain
2669  * selection criteria. The criteria mask is passed as an OR-ed
2670  * combination of #GSignalMatchType flags, and the criteria values are
2671  * passed as arguments.  Passing at least one of the
2672  * %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
2673  * %G_SIGNAL_MATCH_DATA match flags is required for successful
2674  * matches.  If no handlers were found, 0 is returned, the number of
2675  * disconnected handlers otherwise.
2676  *
2677  * Returns: The number of handlers that matched.
2678  */
2679 guint
2680 g_signal_handlers_disconnect_matched (gpointer         instance,
2681                                       GSignalMatchType mask,
2682                                       guint            signal_id,
2683                                       GQuark           detail,
2684                                       GClosure        *closure,
2685                                       gpointer         func,
2686                                       gpointer         data)
2687 {
2688   guint n_handlers = 0;
2689   
2690   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
2691   g_return_val_if_fail ((mask & ~G_SIGNAL_MATCH_MASK) == 0, 0);
2692   
2693   if (mask & (G_SIGNAL_MATCH_CLOSURE | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA))
2694     {
2695       SIGNAL_LOCK ();
2696       n_handlers = signal_handlers_foreach_matched_R (instance, mask, signal_id, detail,
2697                                                       closure, func, data,
2698                                                       g_signal_handler_disconnect);
2699       SIGNAL_UNLOCK ();
2700     }
2701   
2702   return n_handlers;
2703 }
2704
2705 /**
2706  * g_signal_has_handler_pending:
2707  * @instance: the object whose signal handlers are sought.
2708  * @signal_id: the signal id.
2709  * @detail: the detail.
2710  * @may_be_blocked: whether blocked handlers should count as match.
2711  *
2712  * Returns whether there are any handlers connected to @instance for the
2713  * given signal id and detail.
2714  *
2715  * One example of when you might use this is when the arguments to the
2716  * signal are difficult to compute. A class implementor may opt to not
2717  * emit the signal if no one is attached anyway, thus saving the cost
2718  * of building the arguments.
2719  *
2720  * Returns: %TRUE if a handler is connected to the signal, %FALSE
2721  *          otherwise.
2722  */
2723 gboolean
2724 g_signal_has_handler_pending (gpointer instance,
2725                               guint    signal_id,
2726                               GQuark   detail,
2727                               gboolean may_be_blocked)
2728 {
2729   HandlerMatch *mlist;
2730   gboolean has_pending;
2731   
2732   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
2733   g_return_val_if_fail (signal_id > 0, FALSE);
2734   
2735   SIGNAL_LOCK ();
2736   if (detail)
2737     {
2738       SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
2739       
2740       if (!(node->flags & G_SIGNAL_DETAILED))
2741         {
2742           g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2743           SIGNAL_UNLOCK ();
2744           return FALSE;
2745         }
2746     }
2747   mlist = handlers_find (instance,
2748                          (G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | (may_be_blocked ? 0 : G_SIGNAL_MATCH_UNBLOCKED)),
2749                          signal_id, detail, NULL, NULL, NULL, TRUE);
2750   if (mlist)
2751     {
2752       has_pending = TRUE;
2753       handler_match_free1_R (mlist, instance);
2754     }
2755   else
2756     has_pending = FALSE;
2757   SIGNAL_UNLOCK ();
2758   
2759   return has_pending;
2760 }
2761
2762 static inline gboolean
2763 signal_check_skip_emission (SignalNode *node,
2764                             gpointer    instance,
2765                             GQuark      detail)
2766 {
2767   HandlerList *hlist;
2768
2769   /* are we able to check for NULL class handlers? */
2770   if (!node->test_class_offset)
2771     return FALSE;
2772
2773   /* are there emission hooks pending? */
2774   if (node->emission_hooks && node->emission_hooks->hooks)
2775     return FALSE;
2776
2777   /* is there a non-NULL class handler? */
2778   if (node->test_class_offset != TEST_CLASS_MAGIC)
2779     {
2780       GTypeClass *class = G_TYPE_INSTANCE_GET_CLASS (instance, G_TYPE_FROM_INSTANCE (instance), GTypeClass);
2781
2782       if (G_STRUCT_MEMBER (gpointer, class, node->test_class_offset))
2783         return FALSE;
2784     }
2785
2786   /* are signals being debugged? */
2787 #ifdef  G_ENABLE_DEBUG
2788   IF_DEBUG (SIGNALS, g_trace_instance_signals || g_trap_instance_signals)
2789     return FALSE;
2790 #endif /* G_ENABLE_DEBUG */
2791
2792   /* is this a no-recurse signal already in emission? */
2793   if (node->flags & G_SIGNAL_NO_RECURSE &&
2794       emission_find (g_restart_emissions, node->signal_id, detail, instance))
2795     return FALSE;
2796
2797   /* do we have pending handlers? */
2798   hlist = handler_list_lookup (node->signal_id, instance);
2799   if (hlist && hlist->handlers)
2800     return FALSE;
2801
2802   /* none of the above, no emission required */
2803   return TRUE;
2804 }
2805
2806 /**
2807  * g_signal_emitv:
2808  * @instance_and_params: argument list for the signal emission. The first
2809  *  element in the array is a #GValue for the instance the signal is
2810  *  being emitted on. The rest are any arguments to be passed to the
2811  *  signal.
2812  * @signal_id: the signal id
2813  * @detail: the detail
2814  * @return_value: Location to store the return value of the signal emission.
2815  *
2816  * Emits a signal.
2817  *
2818  * Note that g_signal_emitv() doesn't change @return_value if no handlers are
2819  * connected, in contrast to g_signal_emit() and g_signal_emit_valist().
2820  */
2821 void
2822 g_signal_emitv (const GValue *instance_and_params,
2823                 guint         signal_id,
2824                 GQuark        detail,
2825                 GValue       *return_value)
2826 {
2827   gpointer instance;
2828   SignalNode *node;
2829 #ifdef G_ENABLE_DEBUG
2830   const GValue *param_values;
2831   guint i;
2832 #endif
2833   
2834   g_return_if_fail (instance_and_params != NULL);
2835   instance = g_value_peek_pointer (instance_and_params);
2836   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2837   g_return_if_fail (signal_id > 0);
2838
2839 #ifdef G_ENABLE_DEBUG
2840   param_values = instance_and_params + 1;
2841 #endif
2842
2843   SIGNAL_LOCK ();
2844   node = LOOKUP_SIGNAL_NODE (signal_id);
2845   if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2846     {
2847       g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2848       SIGNAL_UNLOCK ();
2849       return;
2850     }
2851 #ifdef G_ENABLE_DEBUG
2852   if (detail && !(node->flags & G_SIGNAL_DETAILED))
2853     {
2854       g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2855       SIGNAL_UNLOCK ();
2856       return;
2857     }
2858   for (i = 0; i < node->n_params; i++)
2859     if (!G_TYPE_CHECK_VALUE_TYPE (param_values + i, node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
2860       {
2861         g_critical ("%s: value for `%s' parameter %u for signal \"%s\" is of type `%s'",
2862                     G_STRLOC,
2863                     type_debug_name (node->param_types[i]),
2864                     i,
2865                     node->name,
2866                     G_VALUE_TYPE_NAME (param_values + i));
2867         SIGNAL_UNLOCK ();
2868         return;
2869       }
2870   if (node->return_type != G_TYPE_NONE)
2871     {
2872       if (!return_value)
2873         {
2874           g_critical ("%s: return value `%s' for signal \"%s\" is (NULL)",
2875                       G_STRLOC,
2876                       type_debug_name (node->return_type),
2877                       node->name);
2878           SIGNAL_UNLOCK ();
2879           return;
2880         }
2881       else if (!node->accumulator && !G_TYPE_CHECK_VALUE_TYPE (return_value, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
2882         {
2883           g_critical ("%s: return value `%s' for signal \"%s\" is of type `%s'",
2884                       G_STRLOC,
2885                       type_debug_name (node->return_type),
2886                       node->name,
2887                       G_VALUE_TYPE_NAME (return_value));
2888           SIGNAL_UNLOCK ();
2889           return;
2890         }
2891     }
2892   else
2893     return_value = NULL;
2894 #endif  /* G_ENABLE_DEBUG */
2895
2896   /* optimize NOP emissions */
2897   if (signal_check_skip_emission (node, instance, detail))
2898     {
2899       /* nothing to do to emit this signal */
2900       SIGNAL_UNLOCK ();
2901       /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
2902       return;
2903     }
2904
2905   SIGNAL_UNLOCK ();
2906   signal_emit_unlocked_R (node, detail, instance, return_value, instance_and_params);
2907 }
2908
2909 /**
2910  * g_signal_emit_valist:
2911  * @instance: the instance the signal is being emitted on.
2912  * @signal_id: the signal id
2913  * @detail: the detail
2914  * @var_args: a list of parameters to be passed to the signal, followed by a
2915  *  location for the return value. If the return type of the signal
2916  *  is #G_TYPE_NONE, the return value location can be omitted.
2917  *
2918  * Emits a signal.
2919  *
2920  * Note that g_signal_emit_valist() resets the return value to the default
2921  * if no handlers are connected, in contrast to g_signal_emitv().
2922  */
2923 void
2924 g_signal_emit_valist (gpointer instance,
2925                       guint    signal_id,
2926                       GQuark   detail,
2927                       va_list  var_args)
2928 {
2929   GValue *instance_and_params;
2930   GType signal_return_type;
2931   GValue *param_values;
2932   SignalNode *node;
2933   guint i, n_params;
2934
2935   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
2936   g_return_if_fail (signal_id > 0);
2937
2938   SIGNAL_LOCK ();
2939   node = LOOKUP_SIGNAL_NODE (signal_id);
2940   if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
2941     {
2942       g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
2943       SIGNAL_UNLOCK ();
2944       return;
2945     }
2946 #ifndef G_DISABLE_CHECKS
2947   if (detail && !(node->flags & G_SIGNAL_DETAILED))
2948     {
2949       g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
2950       SIGNAL_UNLOCK ();
2951       return;
2952     }
2953 #endif  /* !G_DISABLE_CHECKS */
2954
2955   /* optimize NOP emissions */
2956   if (signal_check_skip_emission (node, instance, detail))
2957     {
2958       /* nothing to do to emit this signal */
2959       SIGNAL_UNLOCK ();
2960       /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
2961       return;
2962     }
2963
2964   n_params = node->n_params;
2965   signal_return_type = node->return_type;
2966   instance_and_params = g_slice_alloc0 (sizeof (GValue) * (n_params + 1));
2967   param_values = instance_and_params + 1;
2968
2969   for (i = 0; i < node->n_params; i++)
2970     {
2971       gchar *error;
2972       GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
2973       gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
2974
2975       SIGNAL_UNLOCK ();
2976       G_VALUE_COLLECT_INIT (param_values + i, ptype,
2977                             var_args,
2978                             static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
2979                             &error);
2980       if (error)
2981         {
2982           g_warning ("%s: %s", G_STRLOC, error);
2983           g_free (error);
2984
2985           /* we purposely leak the value here, it might not be
2986            * in a sane state if an error condition occoured
2987            */
2988           while (i--)
2989             g_value_unset (param_values + i);
2990
2991           g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
2992           return;
2993         }
2994       SIGNAL_LOCK ();
2995     }
2996   SIGNAL_UNLOCK ();
2997
2998   instance_and_params->g_type = 0;
2999   g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
3000   g_value_set_instance (instance_and_params, instance);
3001   if (signal_return_type == G_TYPE_NONE)
3002     signal_emit_unlocked_R (node, detail, instance, NULL, instance_and_params);
3003   else
3004     {
3005       GValue return_value = { 0, };
3006       gchar *error = NULL;
3007       GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
3008       gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
3009       
3010       g_value_init (&return_value, rtype);
3011
3012       signal_emit_unlocked_R (node, detail, instance, &return_value, instance_and_params);
3013
3014       G_VALUE_LCOPY (&return_value,
3015                      var_args,
3016                      static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
3017                      &error);
3018       if (!error)
3019         g_value_unset (&return_value);
3020       else
3021         {
3022           g_warning ("%s: %s", G_STRLOC, error);
3023           g_free (error);
3024           
3025           /* we purposely leak the value here, it might not be
3026            * in a sane state if an error condition occured
3027            */
3028         }
3029     }
3030   for (i = 0; i < n_params; i++)
3031     g_value_unset (param_values + i);
3032   g_value_unset (instance_and_params);
3033   g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
3034 }
3035
3036 /**
3037  * g_signal_emit:
3038  * @instance: the instance the signal is being emitted on.
3039  * @signal_id: the signal id
3040  * @detail: the detail
3041  * @...: parameters to be passed to the signal, followed by a
3042  *  location for the return value. If the return type of the signal
3043  *  is #G_TYPE_NONE, the return value location can be omitted.
3044  *
3045  * Emits a signal.
3046  *
3047  * Note that g_signal_emit() resets the return value to the default
3048  * if no handlers are connected, in contrast to g_signal_emitv().
3049  */
3050 void
3051 g_signal_emit (gpointer instance,
3052                guint    signal_id,
3053                GQuark   detail,
3054                ...)
3055 {
3056   va_list var_args;
3057
3058   va_start (var_args, detail);
3059   g_signal_emit_valist (instance, signal_id, detail, var_args);
3060   va_end (var_args);
3061 }
3062
3063 /**
3064  * g_signal_emit_by_name:
3065  * @instance: the instance the signal is being emitted on.
3066  * @detailed_signal: a string of the form "signal-name::detail".
3067  * @...: parameters to be passed to the signal, followed by a
3068  *  location for the return value. If the return type of the signal
3069  *  is #G_TYPE_NONE, the return value location can be omitted.
3070  *
3071  * Emits a signal.
3072  *
3073  * Note that g_signal_emit_by_name() resets the return value to the default
3074  * if no handlers are connected, in contrast to g_signal_emitv().
3075  */
3076 void
3077 g_signal_emit_by_name (gpointer     instance,
3078                        const gchar *detailed_signal,
3079                        ...)
3080 {
3081   GQuark detail = 0;
3082   guint signal_id;
3083
3084   g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
3085   g_return_if_fail (detailed_signal != NULL);
3086
3087   SIGNAL_LOCK ();
3088   signal_id = signal_parse_name (detailed_signal, G_TYPE_FROM_INSTANCE (instance), &detail, TRUE);
3089   SIGNAL_UNLOCK ();
3090
3091   if (signal_id)
3092     {
3093       va_list var_args;
3094
3095       va_start (var_args, detailed_signal);
3096       g_signal_emit_valist (instance, signal_id, detail, var_args);
3097       va_end (var_args);
3098     }
3099   else
3100     g_warning ("%s: signal name `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
3101 }
3102
3103 static inline gboolean
3104 accumulate (GSignalInvocationHint *ihint,
3105             GValue                *return_accu,
3106             GValue                *handler_return,
3107             SignalAccumulator     *accumulator)
3108 {
3109   gboolean continue_emission;
3110
3111   if (!accumulator)
3112     return TRUE;
3113
3114   continue_emission = accumulator->func (ihint, return_accu, handler_return, accumulator->data);
3115   g_value_reset (handler_return);
3116
3117   return continue_emission;
3118 }
3119
3120 static gboolean
3121 signal_emit_unlocked_R (SignalNode   *node,
3122                         GQuark        detail,
3123                         gpointer      instance,
3124                         GValue       *emission_return,
3125                         const GValue *instance_and_params)
3126 {
3127   SignalAccumulator *accumulator;
3128   Emission emission;
3129   GClosure *class_closure;
3130   HandlerList *hlist;
3131   Handler *handler_list = NULL;
3132   GValue *return_accu, accu = { 0, };
3133   guint signal_id;
3134   gulong max_sequential_handler_number;
3135   gboolean return_value_altered = FALSE;
3136   
3137 #ifdef  G_ENABLE_DEBUG
3138   IF_DEBUG (SIGNALS, g_trace_instance_signals == instance || g_trap_instance_signals == instance)
3139     {
3140       g_message ("%s::%s(%u) emitted (instance=%p, signal-node=%p)",
3141                  g_type_name (G_TYPE_FROM_INSTANCE (instance)),
3142                  node->name, detail,
3143                  instance, node);
3144       if (g_trap_instance_signals == instance)
3145         G_BREAKPOINT ();
3146     }
3147 #endif  /* G_ENABLE_DEBUG */
3148
3149   TRACE(GOBJECT_SIGNAL_EMIT(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3150
3151   SIGNAL_LOCK ();
3152   signal_id = node->signal_id;
3153   if (node->flags & G_SIGNAL_NO_RECURSE)
3154     {
3155       Emission *node = emission_find (g_restart_emissions, signal_id, detail, instance);
3156       
3157       if (node)
3158         {
3159           node->state = EMISSION_RESTART;
3160           SIGNAL_UNLOCK ();
3161           return return_value_altered;
3162         }
3163     }
3164   accumulator = node->accumulator;
3165   if (accumulator)
3166     {
3167       SIGNAL_UNLOCK ();
3168       g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3169       return_accu = &accu;
3170       SIGNAL_LOCK ();
3171     }
3172   else
3173     return_accu = emission_return;
3174   emission.instance = instance;
3175   emission.ihint.signal_id = node->signal_id;
3176   emission.ihint.detail = detail;
3177   emission.ihint.run_type = 0;
3178   emission.state = 0;
3179   emission.chain_type = G_TYPE_NONE;
3180   emission_push ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3181   class_closure = signal_lookup_closure (node, instance);
3182   
3183  EMIT_RESTART:
3184   
3185   if (handler_list)
3186     handler_unref_R (signal_id, instance, handler_list);
3187   max_sequential_handler_number = g_handler_sequential_number;
3188   hlist = handler_list_lookup (signal_id, instance);
3189   handler_list = hlist ? hlist->handlers : NULL;
3190   if (handler_list)
3191     handler_ref (handler_list);
3192   
3193   emission.ihint.run_type = G_SIGNAL_RUN_FIRST;
3194   
3195   if ((node->flags & G_SIGNAL_RUN_FIRST) && class_closure)
3196     {
3197       emission.state = EMISSION_RUN;
3198
3199       emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3200       SIGNAL_UNLOCK ();
3201       g_closure_invoke (class_closure,
3202                         return_accu,
3203                         node->n_params + 1,
3204                         instance_and_params,
3205                         &emission.ihint);
3206       if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3207           emission.state == EMISSION_RUN)
3208         emission.state = EMISSION_STOP;
3209       SIGNAL_LOCK ();
3210       emission.chain_type = G_TYPE_NONE;
3211       return_value_altered = TRUE;
3212       
3213       if (emission.state == EMISSION_STOP)
3214         goto EMIT_CLEANUP;
3215       else if (emission.state == EMISSION_RESTART)
3216         goto EMIT_RESTART;
3217     }
3218   
3219   if (node->emission_hooks)
3220     {
3221       gboolean need_destroy, was_in_call, may_recurse = TRUE;
3222       GHook *hook;
3223
3224       emission.state = EMISSION_HOOK;
3225       hook = g_hook_first_valid (node->emission_hooks, may_recurse);
3226       while (hook)
3227         {
3228           SignalHook *signal_hook = SIGNAL_HOOK (hook);
3229           
3230           if (!signal_hook->detail || signal_hook->detail == detail)
3231             {
3232               GSignalEmissionHook hook_func = (GSignalEmissionHook) hook->func;
3233               
3234               was_in_call = G_HOOK_IN_CALL (hook);
3235               hook->flags |= G_HOOK_FLAG_IN_CALL;
3236               SIGNAL_UNLOCK ();
3237               need_destroy = !hook_func (&emission.ihint, node->n_params + 1, instance_and_params, hook->data);
3238               SIGNAL_LOCK ();
3239               if (!was_in_call)
3240                 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
3241               if (need_destroy)
3242                 g_hook_destroy_link (node->emission_hooks, hook);
3243             }
3244           hook = g_hook_next_valid (node->emission_hooks, hook, may_recurse);
3245         }
3246       
3247       if (emission.state == EMISSION_RESTART)
3248         goto EMIT_RESTART;
3249     }
3250   
3251   if (handler_list)
3252     {
3253       Handler *handler = handler_list;
3254       
3255       emission.state = EMISSION_RUN;
3256       handler_ref (handler);
3257       do
3258         {
3259           Handler *tmp;
3260           
3261           if (handler->after)
3262             {
3263               handler_unref_R (signal_id, instance, handler_list);
3264               handler_list = handler;
3265               break;
3266             }
3267           else if (!handler->block_count && (!handler->detail || handler->detail == detail) &&
3268                    handler->sequential_number < max_sequential_handler_number)
3269             {
3270               SIGNAL_UNLOCK ();
3271               g_closure_invoke (handler->closure,
3272                                 return_accu,
3273                                 node->n_params + 1,
3274                                 instance_and_params,
3275                                 &emission.ihint);
3276               if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3277                   emission.state == EMISSION_RUN)
3278                 emission.state = EMISSION_STOP;
3279               SIGNAL_LOCK ();
3280               return_value_altered = TRUE;
3281               
3282               tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3283             }
3284           else
3285             tmp = handler->next;
3286           
3287           if (tmp)
3288             handler_ref (tmp);
3289           handler_unref_R (signal_id, instance, handler_list);
3290           handler_list = handler;
3291           handler = tmp;
3292         }
3293       while (handler);
3294       
3295       if (emission.state == EMISSION_STOP)
3296         goto EMIT_CLEANUP;
3297       else if (emission.state == EMISSION_RESTART)
3298         goto EMIT_RESTART;
3299     }
3300   
3301   emission.ihint.run_type = G_SIGNAL_RUN_LAST;
3302   
3303   if ((node->flags & G_SIGNAL_RUN_LAST) && class_closure)
3304     {
3305       emission.state = EMISSION_RUN;
3306       
3307       emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3308       SIGNAL_UNLOCK ();
3309       g_closure_invoke (class_closure,
3310                         return_accu,
3311                         node->n_params + 1,
3312                         instance_and_params,
3313                         &emission.ihint);
3314       if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3315           emission.state == EMISSION_RUN)
3316         emission.state = EMISSION_STOP;
3317       SIGNAL_LOCK ();
3318       emission.chain_type = G_TYPE_NONE;
3319       return_value_altered = TRUE;
3320       
3321       if (emission.state == EMISSION_STOP)
3322         goto EMIT_CLEANUP;
3323       else if (emission.state == EMISSION_RESTART)
3324         goto EMIT_RESTART;
3325     }
3326   
3327   if (handler_list)
3328     {
3329       Handler *handler = handler_list;
3330       
3331       emission.state = EMISSION_RUN;
3332       handler_ref (handler);
3333       do
3334         {
3335           Handler *tmp;
3336           
3337           if (handler->after && !handler->block_count && (!handler->detail || handler->detail == detail) &&
3338               handler->sequential_number < max_sequential_handler_number)
3339             {
3340               SIGNAL_UNLOCK ();
3341               g_closure_invoke (handler->closure,
3342                                 return_accu,
3343                                 node->n_params + 1,
3344                                 instance_and_params,
3345                                 &emission.ihint);
3346               if (!accumulate (&emission.ihint, emission_return, &accu, accumulator) &&
3347                   emission.state == EMISSION_RUN)
3348                 emission.state = EMISSION_STOP;
3349               SIGNAL_LOCK ();
3350               return_value_altered = TRUE;
3351               
3352               tmp = emission.state == EMISSION_RUN ? handler->next : NULL;
3353             }
3354           else
3355             tmp = handler->next;
3356           
3357           if (tmp)
3358             handler_ref (tmp);
3359           handler_unref_R (signal_id, instance, handler);
3360           handler = tmp;
3361         }
3362       while (handler);
3363       
3364       if (emission.state == EMISSION_STOP)
3365         goto EMIT_CLEANUP;
3366       else if (emission.state == EMISSION_RESTART)
3367         goto EMIT_RESTART;
3368     }
3369   
3370  EMIT_CLEANUP:
3371   
3372   emission.ihint.run_type = G_SIGNAL_RUN_CLEANUP;
3373   
3374   if ((node->flags & G_SIGNAL_RUN_CLEANUP) && class_closure)
3375     {
3376       gboolean need_unset = FALSE;
3377       
3378       emission.state = EMISSION_STOP;
3379       
3380       emission.chain_type = G_TYPE_FROM_INSTANCE (instance);
3381       SIGNAL_UNLOCK ();
3382       if (node->return_type != G_TYPE_NONE && !accumulator)
3383         {
3384           g_value_init (&accu, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3385           need_unset = TRUE;
3386         }
3387       g_closure_invoke (class_closure,
3388                         node->return_type != G_TYPE_NONE ? &accu : NULL,
3389                         node->n_params + 1,
3390                         instance_and_params,
3391                         &emission.ihint);
3392       if (need_unset)
3393         g_value_unset (&accu);
3394       SIGNAL_LOCK ();
3395       emission.chain_type = G_TYPE_NONE;
3396       
3397       if (emission.state == EMISSION_RESTART)
3398         goto EMIT_RESTART;
3399     }
3400   
3401   if (handler_list)
3402     handler_unref_R (signal_id, instance, handler_list);
3403   
3404   emission_pop ((node->flags & G_SIGNAL_NO_RECURSE) ? &g_restart_emissions : &g_recursive_emissions, &emission);
3405   SIGNAL_UNLOCK ();
3406   if (accumulator)
3407     g_value_unset (&accu);
3408
3409   TRACE(GOBJECT_SIGNAL_EMIT_END(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
3410
3411   return return_value_altered;
3412 }
3413
3414 static const gchar*
3415 type_debug_name (GType type)
3416 {
3417   if (type)
3418     {
3419       const char *name = g_type_name (type & ~G_SIGNAL_TYPE_STATIC_SCOPE);
3420       return name ? name : "<unknown>";
3421     }
3422   else
3423     return "<invalid>";
3424 }
3425
3426 /**
3427  * g_signal_accumulator_true_handled:
3428  * @ihint: standard #GSignalAccumulator parameter
3429  * @return_accu: standard #GSignalAccumulator parameter
3430  * @handler_return: standard #GSignalAccumulator parameter
3431  * @dummy: standard #GSignalAccumulator parameter
3432  *
3433  * A predefined #GSignalAccumulator for signals that return a
3434  * boolean values. The behavior that this accumulator gives is
3435  * that a return of %TRUE stops the signal emission: no further
3436  * callbacks will be invoked, while a return of %FALSE allows
3437  * the emission to continue. The idea here is that a %TRUE return
3438  * indicates that the callback <emphasis>handled</emphasis> the signal,
3439  * and no further handling is needed.
3440  *
3441  * Since: 2.4
3442  *
3443  * Returns: standard #GSignalAccumulator result
3444  */
3445 gboolean
3446 g_signal_accumulator_true_handled (GSignalInvocationHint *ihint,
3447                                    GValue                *return_accu,
3448                                    const GValue          *handler_return,
3449                                    gpointer               dummy)
3450 {
3451   gboolean continue_emission;
3452   gboolean signal_handled;
3453   
3454   signal_handled = g_value_get_boolean (handler_return);
3455   g_value_set_boolean (return_accu, signal_handled);
3456   continue_emission = !signal_handled;
3457   
3458   return continue_emission;
3459 }
3460
3461 /**
3462  * g_signal_accumulator_first_wins:
3463  * @ihint: standard #GSignalAccumulator parameter
3464  * @return_accu: standard #GSignalAccumulator parameter
3465  * @handler_return: standard #GSignalAccumulator parameter
3466  * @dummy: standard #GSignalAccumulator parameter
3467  *
3468  * A predefined #GSignalAccumulator for signals intended to be used as a
3469  * hook for application code to provide a particular value.  Usually
3470  * only one such value is desired and multiple handlers for the same
3471  * signal don't make much sense (except for the case of the default
3472  * handler defined in the class structure, in which case you will
3473  * usually want the signal connection to override the class handler).
3474  *
3475  * This accumulator will use the return value from the first signal
3476  * handler that is run as the return value for the signal and not run
3477  * any further handlers (ie: the first handler "wins").
3478  *
3479  * Returns: standard #GSignalAccumulator result
3480  *
3481  * Since: 2.28
3482  **/
3483 gboolean
3484 g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
3485                                  GValue                *return_accu,
3486                                  const GValue          *handler_return,
3487                                  gpointer               dummy)
3488 {
3489   g_value_copy (handler_return, return_accu);
3490   return FALSE;
3491 }