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