gobject/: fully remove gobjectalias hacks
[platform/upstream/glib.git] / gobject / gsignal.c
index b662a8d..df5a37b 100644 (file)
@@ -36,7 +36,7 @@
 #include "gboxed.h"
 #include "gobject.h"
 #include "genums.h"
-#include "gobjectalias.h"
+#include "gobject_trace.h"
 
 
 /**
  */
 
 
-/* pre allocation configurations
- */
-#define        MAX_STACK_VALUES        (16)
-
 #define REPORT_BUG      "please report occurrence circumstances to gtk-devel-list@gnome.org"
 #ifdef G_ENABLE_DEBUG
 #define IF_DEBUG(debug_type, cond)     if ((_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) || cond)
@@ -582,7 +578,7 @@ handler_ref (Handler *handler)
 {
   g_return_if_fail (handler->ref_count > 0);
   
-  g_atomic_int_inc (&handler->ref_count);
+  g_atomic_int_inc ((int *)&handler->ref_count);
 }
 
 static inline void
@@ -594,7 +590,7 @@ handler_unref_R (guint    signal_id,
 
   g_return_if_fail (handler->ref_count > 0);
   
-  is_zero = g_atomic_int_dec_and_test (&handler->ref_count);
+  is_zero = g_atomic_int_dec_and_test ((int *)&handler->ref_count);
 
   if (G_UNLIKELY (is_zero))
     {
@@ -1289,7 +1285,7 @@ g_signal_query (guint         signal_id,
  *  %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
  * @class_offset: The offset of the function pointer in the class structure
  *  for this type. Used to invoke a class method generically. Pass 0 to
- *  not associate a class method with this signal.
+ *  not associate a class method slot with this signal.
  * @accumulator: the accumulator for this signal; may be %NULL.
  * @accu_data: user data for the @accumulator.
  * @c_marshaller: the function to translate arrays of parameter values to
@@ -1309,6 +1305,11 @@ g_signal_query (guint         signal_id,
  * When registering a signal and looking up a signal, either separator can
  * be used, but they cannot be mixed.
  *
+ * If 0 is used for @class_offset subclasses cannot override the class handler
+ * in their <code>class_init</code> method by doing
+ * <code>super_class->signal_handler = my_signal_handler</code>. Instead they
+ * will have to use g_signal_override_class_handler().
+ *
  * Returns: the signal id
  */
 guint
@@ -1352,6 +1353,73 @@ g_signal_new (const gchar         *signal_name,
   return signal_id;
 }
 
+/**
+ * g_signal_new_class_handler:
+ * @signal_name: the name for the signal
+ * @itype: the type this signal pertains to. It will also pertain to
+ *  types which are derived from this type.
+ * @signal_flags: a combination of #GSignalFlags specifying detail of when
+ *  the default handler is to be invoked. You should at least specify
+ *  %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
+ * @class_handler: a #GCallback which acts as class implementation of
+ *  this signal. Used to invoke a class method generically. Pass %NULL to
+ *  not associate a class method with this signal.
+ * @accumulator: the accumulator for this signal; may be %NULL.
+ * @accu_data: user data for the @accumulator.
+ * @c_marshaller: the function to translate arrays of parameter values to
+ *  signal emissions into C language callback invocations.
+ * @return_type: the type of return value, or #G_TYPE_NONE for a signal
+ *  without a return value.
+ * @n_params: the number of parameter types to follow.
+ * @...: a list of types, one for each parameter.
+ *
+ * Creates a new signal. (This is usually done in the class initializer.)
+ *
+ * This is a variant of g_signal_new() that takes a C callback instead
+ * off a class offset for the signal's class handler. This function
+ * doesn't need a function pointer exposed in the class structure of
+ * an object definition, instead the function pointer is passed
+ * directly and can be overriden by derived classes with
+ * g_signal_override_class_closure() or
+ * g_signal_override_class_handler()and chained to with
+ * g_signal_chain_from_overridden() or
+ * g_signal_chain_from_overridden_handler().
+ *
+ * See g_signal_new() for information about signal names.
+ *
+ * Returns: the signal id
+ *
+ * Since: 2.18
+ */
+guint
+g_signal_new_class_handler (const gchar        *signal_name,
+                            GType               itype,
+                            GSignalFlags        signal_flags,
+                            GCallback           class_handler,
+                            GSignalAccumulator  accumulator,
+                            gpointer            accu_data,
+                            GSignalCMarshaller  c_marshaller,
+                            GType               return_type,
+                            guint               n_params,
+                            ...)
+{
+  va_list args;
+  guint signal_id;
+
+  g_return_val_if_fail (signal_name != NULL, 0);
+
+  va_start (args, n_params);
+
+  signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
+                                   class_handler ? g_cclosure_new (class_handler, NULL, NULL) : NULL,
+                                   accumulator, accu_data, c_marshaller,
+                                   return_type, n_params, args);
+
+  va_end (args);
+
+  return signal_id;
+}
+
 static inline ClassClosure*
 signal_find_class_closure (SignalNode *node,
                           GType       itype)
@@ -1385,9 +1453,12 @@ signal_lookup_closure (SignalNode    *node,
   ClassClosure *cc;
 
   if (node->class_closure_bsa && g_bsearch_array_get_n_nodes (node->class_closure_bsa) == 1)
-    cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
-  else
-    cc = signal_find_class_closure (node, G_TYPE_FROM_INSTANCE (instance));
+    {
+      cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
+      if (cc && cc->instance_type == 0) /* check for default closure */
+        return cc->closure;
+    }
+  cc = signal_find_class_closure (node, G_TYPE_FROM_INSTANCE (instance));
   return cc ? cc->closure : NULL;
 }
 
@@ -1417,19 +1488,19 @@ signal_add_class_closure (SignalNode *node,
  * g_signal_newv:
  * @signal_name: the name for the signal
  * @itype: the type this signal pertains to. It will also pertain to
- *  types which are derived from this type.
+ *     types which are derived from this type
  * @signal_flags: a combination of #GSignalFlags specifying detail of when
- *  the default handler is to be invoked. You should at least specify
- *  %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
- * @class_closure: The closure to invoke on signal emission; may be %NULL.
- * @accumulator: the accumulator for this signal; may be %NULL.
- * @accu_data: user data for the @accumulator.
+ *     the default handler is to be invoked. You should at least specify
+ *     %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
+ * @class_closure: The closure to invoke on signal emission; may be %NULL
+ * @accumulator: the accumulator for this signal; may be %NULL
+ * @accu_data: user data for the @accumulator
  * @c_marshaller: the function to translate arrays of parameter values to
- *  signal emissions into C language callback invocations.
+ *     signal emissions into C language callback invocations
  * @return_type: the type of return value, or #G_TYPE_NONE for a signal
- *  without a return value.
- * @n_params: the length of @param_types.
- * @param_types: an array types, one for each parameter.
+ *     without a return value
+ * @n_params: the length of @param_types
+ * @param_types: an array of types, one for each parameter
  *
  * Creates a new signal. (This is usually done in the class initializer.)
  *
@@ -1537,6 +1608,8 @@ g_signal_newv (const gchar       *signal_name,
       node->name = g_intern_string (name);
       key.quark = g_quark_from_string (name);
       g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
+
+      TRACE(GOBJECT_SIGNAL_NEW(signal_id, name, itype));
     }
   node->destroyed = FALSE;
   node->test_class_offset = 0;
@@ -1694,6 +1767,10 @@ signal_destroy_R (SignalNode *signal_node)
  * Overrides the class closure (i.e. the default handler) for the given signal
  * for emissions on instances of @instance_type. @instance_type must be derived
  * from the type to which the signal belongs.
+ *
+ * See g_signal_chain_from_overridden() and
+ * g_signal_chain_from_overridden_handler() for how to chain up to the
+ * parent class closure from inside the overridden one.
  */
 void
 g_signal_override_class_closure (guint     signal_id,
@@ -1722,6 +1799,46 @@ g_signal_override_class_closure (guint     signal_id,
 }
 
 /**
+ * g_signal_override_class_handler:
+ * @signal_name: the name for the signal
+ * @instance_type: the instance type on which to override the class handler
+ *  for the signal.
+ * @class_handler: the handler.
+ *
+ * Overrides the class closure (i.e. the default handler) for the
+ * given signal for emissions on instances of @instance_type with
+ * callabck @class_handler. @instance_type must be derived from the
+ * type to which the signal belongs.
+ *
+ * See g_signal_chain_from_overridden() and
+ * g_signal_chain_from_overridden_handler() for how to chain up to the
+ * parent class closure from inside the overridden one.
+ *
+ * Since: 2.18
+ */
+void
+g_signal_override_class_handler (const gchar *signal_name,
+                                GType        instance_type,
+                                GCallback    class_handler)
+{
+  guint signal_id;
+
+  g_return_if_fail (signal_name != NULL);
+  g_return_if_fail (instance_type != G_TYPE_NONE);
+  g_return_if_fail (class_handler != NULL);
+
+  signal_id = g_signal_lookup (signal_name, instance_type);
+
+  if (signal_id)
+    g_signal_override_class_closure (signal_id, instance_type,
+                                     g_cclosure_new (class_handler, NULL, NULL));
+  else
+    g_warning ("%s: signal name '%s' is invalid for type id '%"G_GSIZE_FORMAT"'",
+               G_STRLOC, signal_name, instance_type);
+
+}
+
+/**
  * g_signal_chain_from_overridden:
  * @instance_and_params: the argument list of the signal emission. The first
  *  element in the array is a #GValue for the instance the signal is being
@@ -1730,7 +1847,8 @@ g_signal_override_class_closure (guint     signal_id,
  *
  * Calls the original class closure of a signal. This function should only
  * be called from an overridden class closure; see
- * g_signal_override_class_closure().
+ * g_signal_override_class_closure() and
+ * g_signal_override_class_handler().
  */
 void
 g_signal_chain_from_overridden (const GValue *instance_and_params,
@@ -1776,6 +1894,7 @@ g_signal_chain_from_overridden (const GValue *instance_and_params,
     }
   else
     g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
+
   if (closure)
     {
       emission->chain_type = chain_type;
@@ -1792,6 +1911,170 @@ g_signal_chain_from_overridden (const GValue *instance_and_params,
 }
 
 /**
+ * g_signal_chain_from_overridden_handler:
+ * @instance: the instance the signal is being emitted on.
+ * @...: parameters to be passed to the parent class closure, followed by a
+ *  location for the return value. If the return type of the signal
+ *  is #G_TYPE_NONE, the return value location can be omitted.
+ *
+ * Calls the original class closure of a signal. This function should
+ * only be called from an overridden class closure; see
+ * g_signal_override_class_closure() and
+ * g_signal_override_class_handler().
+ *
+ * Since: 2.18
+ */
+void
+g_signal_chain_from_overridden_handler (gpointer instance,
+                                        ...)
+{
+  GType chain_type = 0, restore_type = 0;
+  Emission *emission = NULL;
+  GClosure *closure = NULL;
+  SignalNode *node;
+  guint n_params = 0;
+
+  g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
+
+  SIGNAL_LOCK ();
+  emission = emission_find_innermost (instance);
+  if (emission)
+    {
+      node = LOOKUP_SIGNAL_NODE (emission->ihint.signal_id);
+
+      g_assert (node != NULL); /* paranoid */
+
+      /* we should probably do the same parameter checks as g_signal_emit() here.
+       */
+      if (emission->chain_type != G_TYPE_NONE)
+       {
+         ClassClosure *cc = signal_find_class_closure (node, emission->chain_type);
+
+         g_assert (cc != NULL);        /* closure currently in call stack */
+
+         n_params = node->n_params;
+         restore_type = cc->instance_type;
+         cc = signal_find_class_closure (node, g_type_parent (cc->instance_type));
+         if (cc && cc->instance_type != restore_type)
+           {
+             closure = cc->closure;
+             chain_type = cc->instance_type;
+           }
+       }
+      else
+       g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
+    }
+  else
+    g_warning ("%s: no signal is currently being emitted for instance `%p'", G_STRLOC, instance);
+
+  if (closure)
+    {
+      GValue *instance_and_params;
+      GType signal_return_type;
+      GValue *param_values;
+      va_list var_args;
+      guint i;
+
+      va_start (var_args, instance);
+
+      signal_return_type = node->return_type;
+      instance_and_params = g_slice_alloc0 (sizeof (GValue) * (n_params + 1));
+      param_values = instance_and_params + 1;
+
+      for (i = 0; i < node->n_params; i++)
+        {
+          gchar *error;
+          GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
+          gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
+
+          SIGNAL_UNLOCK ();
+          G_VALUE_COLLECT_INIT (param_values + i, ptype,
+                               var_args,
+                               static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
+                               &error);
+          if (error)
+            {
+              g_warning ("%s: %s", G_STRLOC, error);
+              g_free (error);
+
+              /* we purposely leak the value here, it might not be
+               * in a sane state if an error condition occoured
+               */
+              while (i--)
+                g_value_unset (param_values + i);
+
+              g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
+              va_end (var_args);
+              return;
+            }
+          SIGNAL_LOCK ();
+        }
+
+      SIGNAL_UNLOCK ();
+      instance_and_params->g_type = 0;
+      g_value_init (instance_and_params, G_TYPE_FROM_INSTANCE (instance));
+      g_value_set_instance (instance_and_params, instance);
+      SIGNAL_LOCK ();
+
+      emission->chain_type = chain_type;
+      SIGNAL_UNLOCK ();
+
+      if (signal_return_type == G_TYPE_NONE)
+        {
+          g_closure_invoke (closure,
+                            NULL,
+                            n_params + 1,
+                            instance_and_params,
+                            &emission->ihint);
+        }
+      else
+        {
+          GValue return_value = { 0, };
+          gchar *error = NULL;
+          GType rtype = signal_return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
+          gboolean static_scope = signal_return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
+
+          g_value_init (&return_value, rtype);
+
+          g_closure_invoke (closure,
+                            &return_value,
+                            n_params + 1,
+                            instance_and_params,
+                            &emission->ihint);
+
+          G_VALUE_LCOPY (&return_value,
+                         var_args,
+                         static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
+                         &error);
+          if (!error)
+            {
+              g_value_unset (&return_value);
+            }
+          else
+            {
+              g_warning ("%s: %s", G_STRLOC, error);
+              g_free (error);
+
+              /* we purposely leak the value here, it might not be
+               * in a sane state if an error condition occured
+               */
+            }
+        }
+
+      for (i = 0; i < n_params; i++)
+        g_value_unset (param_values + i);
+      g_value_unset (instance_and_params);
+      g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
+
+      va_end (var_args);
+
+      SIGNAL_LOCK ();
+      emission->chain_type = restore_type;
+    }
+  SIGNAL_UNLOCK ();
+}
+
+/**
  * g_signal_get_invocation_hint:
  * @instance: the instance to query
  *
@@ -2625,7 +2908,7 @@ g_signal_emit_valist (gpointer instance,
                      GQuark   detail,
                      va_list  var_args)
 {
-  GValue *instance_and_params, stack_values[MAX_STACK_VALUES], *free_me = NULL;
+  GValue *instance_and_params;
   GType signal_return_type;
   GValue *param_values;
   SignalNode *node;
@@ -2662,27 +2945,20 @@ g_signal_emit_valist (gpointer instance,
 
   n_params = node->n_params;
   signal_return_type = node->return_type;
-  if (node->n_params < MAX_STACK_VALUES)
-    instance_and_params = stack_values;
-  else
-    {
-      free_me = g_new (GValue, node->n_params + 1);
-      instance_and_params = free_me;
-    }
+  instance_and_params = g_slice_alloc0 (sizeof (GValue) * (n_params + 1));
   param_values = instance_and_params + 1;
+
   for (i = 0; i < node->n_params; i++)
     {
       gchar *error;
       GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
       gboolean static_scope = node->param_types[i] & G_SIGNAL_TYPE_STATIC_SCOPE;
-      
-      param_values[i].g_type = 0;
+
       SIGNAL_UNLOCK ();
-      g_value_init (param_values + i, ptype);
-      G_VALUE_COLLECT (param_values + i,
-                      var_args,
-                      static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
-                      &error);
+      G_VALUE_COLLECT_INIT (param_values + i, ptype,
+                           var_args,
+                           static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
+                           &error);
       if (error)
        {
          g_warning ("%s: %s", G_STRLOC, error);
@@ -2694,7 +2970,7 @@ g_signal_emit_valist (gpointer instance,
          while (i--)
            g_value_unset (param_values + i);
 
-         g_free (free_me);
+         g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
          return;
        }
       SIGNAL_LOCK ();
@@ -2735,8 +3011,7 @@ g_signal_emit_valist (gpointer instance,
   for (i = 0; i < n_params; i++)
     g_value_unset (param_values + i);
   g_value_unset (instance_and_params);
-  if (free_me)
-    g_free (free_me);
+  g_slice_free1 (sizeof (GValue) * (n_params + 1), instance_and_params);
 }
 
 /**
@@ -2851,7 +3126,9 @@ signal_emit_unlocked_R (SignalNode   *node,
        G_BREAKPOINT ();
     }
 #endif /* G_ENABLE_DEBUG */
-  
+
+  TRACE(GOBJECT_SIGNAL_EMIT(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
+
   SIGNAL_LOCK ();
   signal_id = node->signal_id;
   if (node->flags & G_SIGNAL_NO_RECURSE)
@@ -3109,7 +3386,9 @@ signal_emit_unlocked_R (SignalNode   *node,
   SIGNAL_UNLOCK ();
   if (accumulator)
     g_value_unset (&accu);
-  
+
+  TRACE(GOBJECT_SIGNAL_EMIT_END(node->signal_id, detail, instance, G_TYPE_FROM_INSTANCE (instance)));
+
   return return_value_altered;
 }
 
@@ -3162,6 +3441,3 @@ g_signal_accumulator_true_handled (GSignalInvocationHint *ihint,
 
 /* --- compile standard marshallers --- */
 #include "gmarshal.c"
-
-#define __G_SIGNAL_C__
-#include "gobjectaliasdef.c"