* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* this code is based on the original GtkSignal implementation
* for the Gtk+ library by Peter Mattis <petm@xcf.berkeley.edu>
* MT safe
*/
-#include <config.h>
+#include "config.h"
-#include "gsignal.h"
+#include <string.h>
+#include <signal.h>
-#include "gbsearcharray.h"
-#include "gvaluecollector.h"
-#include "gvaluetypes.h"
-#include "gboxed.h"
+#include "gsignal.h"
+#include "gtype-private.h"
+#include "gbsearcharray.h"
+#include "gvaluecollector.h"
+#include "gvaluetypes.h"
+#include "gobject.h"
+#include "genums.h"
+#include "gobject_trace.h"
-#include "gobjectalias.h"
-#include <string.h>
-#include <signal.h>
-
-
-/* pre allocation configurations
+/**
+ * SECTION:signals
+ * @short_description: A means for customization of object behaviour
+ * and a general purpose notification mechanism
+ * @title: Signals
+ *
+ * The basic concept of the signal system is that of the emission
+ * of a signal. Signals are introduced per-type and are identified
+ * through strings. Signals introduced for a parent type are available
+ * in derived types as well, so basically they are a per-type facility
+ * that is inherited.
+ *
+ * A signal emission mainly involves invocation of a certain set of
+ * callbacks in precisely defined manner. There are two main categories
+ * of such callbacks, per-object ones and user provided ones.
+ * (Although signals can deal with any kind of instantiatable type, I'm
+ * referring to those types as "object types" in the following, simply
+ * because that is the context most users will encounter signals in.)
+ * The per-object callbacks are most often referred to as "object method
+ * handler" or "default (signal) handler", while user provided callbacks are
+ * usually just called "signal handler".
+ *
+ * The object method handler is provided at signal creation time (this most
+ * frequently happens at the end of an object class' creation), while user
+ * provided handlers are frequently connected and disconnected to/from a
+ * certain signal on certain object instances.
+ *
+ * A signal emission consists of five stages, unless prematurely stopped:
+ *
+ * 1. Invocation of the object method handler for %G_SIGNAL_RUN_FIRST signals
+ *
+ * 2. Invocation of normal user-provided signal handlers (where the @after
+ * flag is not set)
+ *
+ * 3. Invocation of the object method handler for %G_SIGNAL_RUN_LAST signals
+ *
+ * 4. Invocation of user provided signal handlers (where the @after flag is set)
+ *
+ * 5. Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals
+
+ * The user-provided signal handlers are called in the order they were
+ * connected in.
+ *
+ * All handlers may prematurely stop a signal emission, and any number of
+ * handlers may be connected, disconnected, blocked or unblocked during
+ * a signal emission.
+ *
+ * There are certain criteria for skipping user handlers in stages 2 and 4
+ * of a signal emission.
+ *
+ * First, user handlers may be blocked. Blocked handlers are omitted during
+ * callback invocation, to return from the blocked state, a handler has to
+ * get unblocked exactly the same amount of times it has been blocked before.
+ *
+ * Second, upon emission of a %G_SIGNAL_DETAILED signal, an additional
+ * @detail argument passed in to g_signal_emit() has to match the detail
+ * argument of the signal handler currently subject to invocation.
+ * Specification of no detail argument for signal handlers (omission of the
+ * detail part of the signal specification upon connection) serves as a
+ * wildcard and matches any detail argument passed in to emission.
*/
-#define MAX_STACK_VALUES (16)
-#define HANDLER_PRE_ALLOC (48)
-#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)
-static volatile gpointer g_trace_instance_signals = NULL;
-static volatile gpointer g_trap_instance_signals = NULL;
-#endif /* G_ENABLE_DEBUG */
-
-
-/* --- generic allocation --- */
-/* we special case allocations generically by replacing
- * these functions with more speed/memory aware variants
- */
-#ifndef DISABLE_MEM_POOLS
-static inline gpointer
-g_generic_node_alloc (GTrashStack **trash_stack_p,
- guint sizeof_node,
- guint nodes_pre_alloc)
-{
- gpointer node = g_trash_stack_pop (trash_stack_p);
-
- if (!node)
- {
- guint8 *block;
-
- nodes_pre_alloc = MAX (nodes_pre_alloc, 1);
- block = g_malloc (sizeof_node * nodes_pre_alloc);
- while (--nodes_pre_alloc)
- {
- g_trash_stack_push (trash_stack_p, block);
- block += sizeof_node;
- }
- node = block;
- }
-
- return node;
-}
-#define g_generic_node_free(trash_stack_p, node) g_trash_stack_push (trash_stack_p, node)
-#else /* !DISABLE_MEM_POOLS */
-#define g_generic_node_alloc(t,sizeof_node,p) g_malloc (sizeof_node)
-#define g_generic_node_free(t,node) g_free (node)
-#endif /* !DISABLE_MEM_POOLS */
+#define REPORT_BUG "please report occurrence circumstances to gtk-devel-list@gnome.org"
/* --- typedefs --- */
typedef struct _SignalNode SignalNode;
Handler *handler);
static Handler* handler_lookup (gpointer instance,
gulong handler_id,
+ GClosure *closure,
guint *signal_id_p);
static inline HandlerMatch* handler_match_prepend (HandlerMatch *list,
Handler *handler,
gpointer instance,
GValue *return_value,
const GValue *instance_and_params);
+static void add_invalid_closure_notify (Handler *handler,
+ gpointer instance);
+static void remove_invalid_closure_notify (Handler *handler,
+ gpointer instance);
+static void invalid_closure_notify (gpointer data,
+ GClosure *closure);
static const gchar * type_debug_name (GType type);
+static void node_check_deprecated (const SignalNode *node);
+static void node_update_single_va_closure (SignalNode *node);
/* --- structures --- */
/* permanent portion */
guint signal_id;
GType itype;
- gchar *name;
+ const gchar *name;
guint destroyed : 1;
/* reinitializable portion */
- guint test_class_offset : 12;
- guint flags : 8;
+ guint flags : 9;
guint n_params : 8;
+ guint single_va_closure_is_valid : 1;
+ guint single_va_closure_is_after : 1;
GType *param_types; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
GType return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
GBSearchArray *class_closure_bsa;
SignalAccumulator *accumulator;
GSignalCMarshaller c_marshaller;
+ GSignalCVaMarshaller va_marshaller;
GHookList *emission_hooks;
+
+ GClosure *single_va_closure;
};
-#define MAX_TEST_CLASS_OFFSET (4096) /* 2^12, 12 bits for test_class_offset */
-#define TEST_CLASS_MAGIC (1) /* indicates NULL class closure, candidate for NOP optimization */
+
+#define SINGLE_VA_CLOSURE_EMPTY_MAGIC GINT_TO_POINTER(1) /* indicates single_va_closure is valid but empty */
struct _SignalKey
{
Handler *next;
Handler *prev;
GQuark detail;
- guint ref_count : 16;
-#define HANDLER_MAX_REF_COUNT (1 << 16)
- guint block_count : 12;
-#define HANDLER_MAX_BLOCK_COUNT (1 << 12)
+ guint ref_count;
+ guint block_count : 16;
+#define HANDLER_MAX_BLOCK_COUNT (1 << 16)
guint after : 1;
+ guint has_invalid_closure_notify : 1;
GClosure *closure;
};
struct _HandlerMatch
{
Handler *handler;
HandlerMatch *next;
- union {
- guint signal_id;
- gpointer dummy;
- } d;
+ guint signal_id;
};
typedef struct
static GHashTable *g_handler_list_bsa_ht = NULL;
static Emission *g_recursive_emissions = NULL;
static Emission *g_restart_emissions = NULL;
-#ifndef DISABLE_MEM_POOLS
-static GTrashStack *g_handler_ts = NULL;
-#endif
static gulong g_handler_sequential_number = 1;
G_LOCK_DEFINE_STATIC (g_signal_mutex);
#define SIGNAL_LOCK() G_LOCK (g_signal_mutex)
}
static Handler*
-handler_lookup (gpointer instance,
- gulong handler_id,
- guint *signal_id_p)
+handler_lookup (gpointer instance,
+ gulong handler_id,
+ GClosure *closure,
+ guint *signal_id_p)
{
GBSearchArray *hlbsa = g_hash_table_lookup (g_handler_list_bsa_ht, instance);
Handler *handler;
for (handler = hlist->handlers; handler; handler = handler->next)
- if (handler->sequential_number == handler_id)
+ if (closure ? (handler->closure == closure) : (handler->sequential_number == handler_id))
{
if (signal_id_p)
*signal_id_p = hlist->signal_id;
{
HandlerMatch *node;
- /* yeah, we could use our own memchunk here, introducing yet more
- * rarely used cached nodes and extra allocation overhead.
- * instead, we use GList* nodes, since they are exactly the size
- * we need and are already cached. g_signal_init() asserts this.
- */
- node = (HandlerMatch*) g_list_alloc ();
+ node = g_slice_new (HandlerMatch);
node->handler = handler;
node->next = list;
- node->d.signal_id = signal_id;
+ node->signal_id = signal_id;
handler_ref (handler);
return node;
{
HandlerMatch *next = node->next;
- handler_unref_R (node->d.signal_id, instance, node->handler);
- g_list_free_1 ((GList*) node);
+ handler_unref_R (node->signal_id, instance, node->handler);
+ g_slice_free (HandlerMatch, node);
return next;
}
((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
- handler->closure->meta_marshal == 0 &&
+ G_REAL_CLOSURE (handler->closure)->meta_marshal == NULL &&
((GCClosure*) handler->closure)->callback == func)))
{
mlist = handler_match_prepend (mlist, handler, signal_id);
((mask & G_SIGNAL_MATCH_DATA) || handler->closure->data == data) &&
((mask & G_SIGNAL_MATCH_UNBLOCKED) || handler->block_count == 0) &&
((mask & G_SIGNAL_MATCH_FUNC) || (handler->closure->marshal == node->c_marshaller &&
- handler->closure->meta_marshal == 0 &&
+ G_REAL_CLOSURE (handler->closure)->meta_marshal == NULL &&
((GCClosure*) handler->closure)->callback == func)))
{
mlist = handler_match_prepend (mlist, handler, hlist->signal_id);
static inline Handler*
handler_new (gboolean after)
{
- Handler *handler = g_generic_node_alloc (&g_handler_ts,
- sizeof (Handler),
- HANDLER_PRE_ALLOC);
+ Handler *handler = g_slice_new (Handler);
#ifndef G_DISABLE_CHECKS
if (g_handler_sequential_number < 1)
g_error (G_STRLOC ": handler id overflow, %s", REPORT_BUG);
handler->block_count = 0;
handler->after = after != FALSE;
handler->closure = NULL;
+ handler->has_invalid_closure_notify = 0;
return handler;
}
{
g_return_if_fail (handler->ref_count > 0);
-#ifndef G_DISABLE_CHECKS
- if (handler->ref_count >= HANDLER_MAX_REF_COUNT - 1)
- g_error (G_STRLOC ": handler ref_count overflow, %s", REPORT_BUG);
-#endif
-
- handler->ref_count += 1;
+ handler->ref_count++;
}
static inline void
Handler *handler)
{
g_return_if_fail (handler->ref_count > 0);
-
- handler->ref_count -= 1;
- if (!handler->ref_count)
+
+ handler->ref_count--;
+
+ if (G_UNLIKELY (handler->ref_count == 0))
{
HandlerList *hlist = NULL;
SIGNAL_UNLOCK ();
g_closure_unref (handler->closure);
SIGNAL_LOCK ();
- g_generic_node_free (&g_handler_ts, handler);
+ g_slice_free (Handler, handler);
}
}
hlist->tail_after = handler;
}
+static void
+node_update_single_va_closure (SignalNode *node)
+{
+ GClosure *closure = NULL;
+ gboolean is_after = FALSE;
+
+ /* Fast path single-handler without boxing the arguments in GValues */
+ if (G_TYPE_IS_OBJECT (node->itype) &&
+ (node->flags & (G_SIGNAL_MUST_COLLECT)) == 0 &&
+ (node->emission_hooks == NULL || node->emission_hooks->hooks == NULL))
+ {
+ GSignalFlags run_type;
+ ClassClosure * cc;
+ GBSearchArray *bsa = node->class_closure_bsa;
+
+ if (bsa == NULL || bsa->n_nodes == 0)
+ closure = SINGLE_VA_CLOSURE_EMPTY_MAGIC;
+ else if (bsa->n_nodes == 1)
+ {
+ /* Look for default class closure (can't support non-default as it
+ chains up using GValues */
+ cc = g_bsearch_array_get_nth (bsa, &g_class_closure_bconfig, 0);
+ if (cc->instance_type == 0)
+ {
+ run_type = node->flags & (G_SIGNAL_RUN_FIRST|G_SIGNAL_RUN_LAST|G_SIGNAL_RUN_CLEANUP);
+ /* Only support *one* of run-first or run-last, not multiple or cleanup */
+ if (run_type == G_SIGNAL_RUN_FIRST ||
+ run_type == G_SIGNAL_RUN_LAST)
+ {
+ closure = cc->closure;
+ is_after = (run_type == G_SIGNAL_RUN_LAST);
+ }
+ }
+ }
+ }
+
+ node->single_va_closure_is_valid = TRUE;
+ node->single_va_closure = closure;
+ node->single_va_closure_is_after = is_after;
+}
+
static inline void
emission_push (Emission **emission_list_p,
Emission *emission)
}
void
-g_signal_init (void)
+_g_signal_init (void)
{
SIGNAL_LOCK ();
if (!g_n_signal_nodes)
{
- /* handler_id_node_prepend() requires this */
- g_assert (sizeof (GList) == sizeof (HandlerMatch));
-
/* setup handler list binary searchable array hash table (in german, that'd be one word ;) */
g_handler_list_bsa_ht = g_hash_table_new (g_direct_hash, NULL);
g_signal_key_bsa = g_bsearch_array_create (&g_signal_key_bconfig);
if (node->itype == itype)
{
if (node->destroyed)
- g_warning (G_STRLOC ": signal \"%s\" of type `%s' already destroyed",
+ g_warning (G_STRLOC ": signal \"%s\" of type '%s' already destroyed",
node->name,
type_debug_name (node->itype));
else
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_stop_emission:
+ * @instance: (type GObject.Object): the object whose signal handlers you wish to stop.
+ * @signal_id: the signal identifier, as returned by g_signal_lookup().
+ * @detail: the detail which the signal was emitted with.
+ *
+ * Stops a signal's current emission.
+ *
+ * This will prevent the default method from running, if the signal was
+ * %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
+ * flag).
+ *
+ * Prints a warning if used on a signal which isn't being emitted.
+ */
void
g_signal_stop_emission (gpointer instance,
guint signal_id,
node = LOOKUP_SIGNAL_NODE (signal_id);
if (node && detail && !(node->flags & G_SIGNAL_DETAILED))
{
- g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
+ g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
SIGNAL_UNLOCK ();
return;
}
if (emission)
{
if (emission->state == EMISSION_HOOK)
- g_warning (G_STRLOC ": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
+ g_warning (G_STRLOC ": emission of signal \"%s\" for instance '%p' cannot be stopped from emission hook",
node->name, instance);
else if (emission->state == EMISSION_RUN)
emission->state = EMISSION_STOP;
}
else
- g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
+ g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance '%p'",
node->name, instance);
}
else
- g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
+ g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
SIGNAL_UNLOCK ();
}
}
}
+/**
+ * g_signal_add_emission_hook:
+ * @signal_id: the signal identifier, as returned by g_signal_lookup().
+ * @detail: the detail on which to call the hook.
+ * @hook_func: a #GSignalEmissionHook function.
+ * @hook_data: user data for @hook_func.
+ * @data_destroy: a #GDestroyNotify for @hook_data.
+ *
+ * Adds an emission hook for a signal, which will get called for any emission
+ * of that signal, independent of the instance. This is possible only
+ * for signals which don't have #G_SIGNAL_NO_HOOKS flag set.
+ *
+ * Returns: the hook id, for later use with g_signal_remove_emission_hook().
+ */
gulong
g_signal_add_emission_hook (guint signal_id,
GQuark detail,
node = LOOKUP_SIGNAL_NODE (signal_id);
if (!node || node->destroyed)
{
- g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
+ g_warning ("%s: invalid signal id '%u'", G_STRLOC, signal_id);
SIGNAL_UNLOCK ();
return 0;
}
if (node->flags & G_SIGNAL_NO_HOOKS)
{
- g_warning ("%s: signal id `%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC, signal_id);
+ g_warning ("%s: signal id '%u' does not support emission hooks (G_SIGNAL_NO_HOOKS flag set)", G_STRLOC, signal_id);
SIGNAL_UNLOCK ();
return 0;
}
if (detail && !(node->flags & G_SIGNAL_DETAILED))
{
- g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
+ g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
SIGNAL_UNLOCK ();
return 0;
}
+ node->single_va_closure_is_valid = FALSE;
if (!node->emission_hooks)
{
node->emission_hooks = g_new (GHookList, 1);
g_hook_list_init (node->emission_hooks, sizeof (SignalHook));
node->emission_hooks->finalize_hook = signal_finalize_hook;
}
+
+ node_check_deprecated (node);
+
hook = g_hook_alloc (node->emission_hooks);
hook->data = hook_data;
hook->func = (gpointer) hook_func;
node->emission_hooks->seq_id = seq_hook_id;
g_hook_append (node->emission_hooks, hook);
seq_hook_id = node->emission_hooks->seq_id;
+
SIGNAL_UNLOCK ();
return hook->hook_id;
}
+/**
+ * g_signal_remove_emission_hook:
+ * @signal_id: the id of the signal
+ * @hook_id: the id of the emission hook, as returned by
+ * g_signal_add_emission_hook()
+ *
+ * Deletes an emission hook.
+ */
void
g_signal_remove_emission_hook (guint signal_id,
gulong hook_id)
SIGNAL_LOCK ();
node = LOOKUP_SIGNAL_NODE (signal_id);
if (!node || node->destroyed)
- g_warning ("%s: invalid signal id `%u'", G_STRLOC, signal_id);
+ {
+ g_warning ("%s: invalid signal id '%u'", G_STRLOC, signal_id);
+ goto out;
+ }
else if (!node->emission_hooks || !g_hook_destroy (node->emission_hooks, hook_id))
g_warning ("%s: signal \"%s\" had no hook (%lu) to remove", G_STRLOC, node->name, hook_id);
+
+ node->single_va_closure_is_valid = FALSE;
+
+ out:
SIGNAL_UNLOCK ();
}
return signal_id;
}
+/**
+ * g_signal_parse_name:
+ * @detailed_signal: a string of the form "signal-name::detail".
+ * @itype: The interface/instance type that introduced "signal-name".
+ * @signal_id_p: (out): Location to store the signal id.
+ * @detail_p: (out): Location to store the detail quark.
+ * @force_detail_quark: %TRUE forces creation of a #GQuark for the detail.
+ *
+ * Internal function to parse a signal name into its @signal_id
+ * and @detail quark.
+ *
+ * Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
+ */
gboolean
g_signal_parse_name (const gchar *detailed_signal,
GType itype,
return TRUE;
}
+/**
+ * g_signal_stop_emission_by_name:
+ * @instance: (type GObject.Object): the object whose signal handlers you wish to stop.
+ * @detailed_signal: a string of the form "signal-name::detail".
+ *
+ * Stops a signal's current emission.
+ *
+ * This is just like g_signal_stop_emission() except it will look up the
+ * signal id for you.
+ */
void
g_signal_stop_emission_by_name (gpointer instance,
const gchar *detailed_signal)
SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
if (detail && !(node->flags & G_SIGNAL_DETAILED))
- g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
+ g_warning ("%s: signal '%s' does not support details", G_STRLOC, detailed_signal);
else if (!g_type_is_a (itype, node->itype))
- g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
+ g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
else
{
Emission *emission_list = node->flags & G_SIGNAL_NO_RECURSE ? g_restart_emissions : g_recursive_emissions;
if (emission)
{
if (emission->state == EMISSION_HOOK)
- g_warning (G_STRLOC ": emission of signal \"%s\" for instance `%p' cannot be stopped from emission hook",
+ g_warning (G_STRLOC ": emission of signal \"%s\" for instance '%p' cannot be stopped from emission hook",
node->name, instance);
else if (emission->state == EMISSION_RUN)
emission->state = EMISSION_STOP;
}
else
- g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance `%p'",
+ g_warning (G_STRLOC ": no emission of signal \"%s\" to stop for instance '%p'",
node->name, instance);
}
}
else
- g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
+ g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_lookup:
+ * @name: the signal's name.
+ * @itype: the type that the signal operates on.
+ *
+ * Given the name of the signal and the type of object it connects to, gets
+ * the signal's identifying integer. Emitting the signal by number is
+ * somewhat faster than using the name each time.
+ *
+ * Also tries the ancestors of the given type.
+ *
+ * See g_signal_new() for details on allowed signal names.
+ *
+ * Returns: the signal's identifying number, or 0 if no signal was found.
+ */
guint
g_signal_lookup (const gchar *name,
GType itype)
{
/* give elaborate warnings */
if (!g_type_name (itype))
- g_warning (G_STRLOC ": unable to lookup signal \"%s\" for invalid type id `%lu'",
+ g_warning (G_STRLOC ": unable to lookup signal \"%s\" for invalid type id '%"G_GSIZE_FORMAT"'",
name, itype);
else if (!G_TYPE_IS_INSTANTIATABLE (itype))
- g_warning (G_STRLOC ": unable to lookup signal \"%s\" for non instantiatable type `%s'",
+ g_warning (G_STRLOC ": unable to lookup signal \"%s\" for non instantiatable type '%s'",
name, g_type_name (itype));
else if (!g_type_class_peek (itype))
- g_warning (G_STRLOC ": unable to lookup signal \"%s\" of unloaded type `%s'",
+ g_warning (G_STRLOC ": unable to lookup signal \"%s\" of unloaded type '%s'",
name, g_type_name (itype));
}
return signal_id;
}
+/**
+ * g_signal_list_ids:
+ * @itype: Instance or interface type.
+ * @n_ids: Location to store the number of signal ids for @itype.
+ *
+ * Lists the signals by id that a certain instance or interface type
+ * created. Further information about the signals can be acquired through
+ * g_signal_query().
+ *
+ * Returns: (array length=n_ids): Newly allocated array of signal IDs.
+ */
guint*
g_signal_list_ids (GType itype,
guint *n_ids)
{
/* give elaborate warnings */
if (!g_type_name (itype))
- g_warning (G_STRLOC ": unable to list signals for invalid type id `%lu'",
+ g_warning (G_STRLOC ": unable to list signals for invalid type id '%"G_GSIZE_FORMAT"'",
itype);
- else if (!G_TYPE_IS_INSTANTIATABLE (itype))
- g_warning (G_STRLOC ": unable to list signals of non instantiatable type `%s'",
+ else if (!G_TYPE_IS_INSTANTIATABLE (itype) && !G_TYPE_IS_INTERFACE (itype))
+ g_warning (G_STRLOC ": unable to list signals of non instantiatable type '%s'",
g_type_name (itype));
- else if (!g_type_class_peek (itype))
- g_warning (G_STRLOC ": unable to list signals of unloaded type `%s'",
+ else if (!g_type_class_peek (itype) && !G_TYPE_IS_INTERFACE (itype))
+ g_warning (G_STRLOC ": unable to list signals of unloaded type '%s'",
g_type_name (itype));
}
return (guint*) g_array_free (result, FALSE);
}
-G_CONST_RETURN gchar*
+/**
+ * g_signal_name:
+ * @signal_id: the signal's identifying number.
+ *
+ * Given the signal's identifier, finds its name.
+ *
+ * Two different signals may have the same name, if they have differing types.
+ *
+ * Returns: the signal name, or %NULL if the signal number was invalid.
+ */
+const gchar *
g_signal_name (guint signal_id)
{
SignalNode *node;
- gchar *name;
+ const gchar *name;
SIGNAL_LOCK ();
node = LOOKUP_SIGNAL_NODE (signal_id);
name = node ? node->name : NULL;
SIGNAL_UNLOCK ();
- return name;
+ return (char*) name;
}
+/**
+ * g_signal_query:
+ * @signal_id: The signal id of the signal to query information for.
+ * @query: (out caller-allocates): A user provided structure that is
+ * filled in with constant values upon success.
+ *
+ * Queries the signal system for in-depth information about a
+ * specific signal. This function will fill in a user-provided
+ * structure to hold signal-specific information. If an invalid
+ * signal id is passed in, the @signal_id member of the #GSignalQuery
+ * is 0. All members filled into the #GSignalQuery structure should
+ * be considered constant and have to be left untouched.
+ */
void
g_signal_query (guint signal_id,
GSignalQuery *query)
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_new:
+ * @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_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 slot with this signal.
+ * @accumulator: the accumulator for this signal; may be %NULL.
+ * @accu_data: user data for the @accumulator.
+ * @c_marshaller: (allow-none): the function to translate arrays of parameter
+ * values to signal emissions into C language callback invocations or %NULL.
+ * @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.)
+ *
+ * A signal name consists of segments consisting of ASCII letters and
+ * digits, separated by either the '-' or '_' character. The first
+ * character of a signal name must be a letter. Names which violate these
+ * rules lead to undefined behaviour of the GSignal system.
+ *
+ * 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 class_init method by doing super_class->signal_handler = my_signal_handler.
+ * Instead they will have to use g_signal_override_class_handler().
+ *
+ * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
+ * the marshaller for this signal.
+ *
+ * Returns: the signal id
+ */
guint
g_signal_new (const gchar *signal_name,
GType itype,
va_end (args);
- /* optimize NOP emissions with NULL class handlers */
- if (signal_id && G_TYPE_IS_INSTANTIATABLE (itype) && return_type == G_TYPE_NONE &&
- class_offset && class_offset < MAX_TEST_CLASS_OFFSET)
- {
- SignalNode *node;
+ 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: (allow-none): the function to translate arrays of parameter
+ * values to signal emissions into C language callback invocations or %NULL.
+ * @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.
+ *
+ * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
+ * the marshaller for this signal.
+ *
+ * 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);
- SIGNAL_LOCK ();
- node = LOOKUP_SIGNAL_NODE (signal_id);
- node->test_class_offset = class_offset;
- SIGNAL_UNLOCK ();
- }
-
return signal_id;
}
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;
}
{
ClassClosure key;
- /* can't optimize NOP emissions with overridden class closures */
- node->test_class_offset = 0;
+ node->single_va_closure_is_valid = FALSE;
if (!node->class_closure_bsa)
node->class_closure_bsa = g_bsearch_array_create (&g_class_closure_bconfig);
&key);
g_closure_sink (closure);
if (node->c_marshaller && closure && G_CLOSURE_NEEDS_MARSHAL (closure))
- g_closure_set_marshal (closure, node->c_marshaller);
-}
-
+ {
+ g_closure_set_marshal (closure, node->c_marshaller);
+ if (node->va_marshaller)
+ _g_closure_set_va_marshal (closure, node->va_marshaller);
+ }
+}
+
+/**
+ * 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
+ * @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: (allow-none): The closure to invoke on signal emission;
+ * may be %NULL
+ * @accumulator: (allow-none): the accumulator for this signal; may be %NULL
+ * @accu_data: user data for the @accumulator
+ * @c_marshaller: (allow-none): the function to translate arrays of
+ * parameter values to signal emissions into C language callback
+ * invocations or %NULL
+ * @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: (array length=n_params): an array of types, one for
+ * each parameter
+ *
+ * Creates a new signal. (This is usually done in the class initializer.)
+ *
+ * See g_signal_new() for details on allowed signal names.
+ *
+ * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
+ * the marshaller for this signal.
+ *
+ * Returns: the signal id
+ */
guint
g_signal_newv (const gchar *signal_name,
GType itype,
gchar *name;
guint signal_id, i;
SignalNode *node;
+ GSignalCMarshaller builtin_c_marshaller;
+ GSignalCVaMarshaller va_marshaller;
g_return_val_if_fail (signal_name != NULL, 0);
g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (itype) || G_TYPE_IS_INTERFACE (itype), 0);
node = LOOKUP_SIGNAL_NODE (signal_id);
if (node && !node->destroyed)
{
- g_warning (G_STRLOC ": signal \"%s\" already exists in the `%s' %s",
+ g_warning (G_STRLOC ": signal \"%s\" already exists in the '%s' %s",
name,
type_debug_name (node->itype),
G_TYPE_IS_INTERFACE (node->itype) ? "interface" : "class ancestry");
}
if (node && node->itype != itype)
{
- g_warning (G_STRLOC ": signal \"%s\" for type `%s' was previously created for type `%s'",
+ g_warning (G_STRLOC ": signal \"%s\" for type '%s' was previously created for type '%s'",
name,
type_debug_name (itype),
type_debug_name (node->itype));
for (i = 0; i < n_params; i++)
if (!G_TYPE_IS_VALUE (param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
{
- g_warning (G_STRLOC ": parameter %d of type `%s' for signal \"%s::%s\" is not a value type",
+ g_warning (G_STRLOC ": parameter %d of type '%s' for signal \"%s::%s\" is not a value type",
i + 1, type_debug_name (param_types[i]), type_debug_name (itype), name);
g_free (name);
SIGNAL_UNLOCK ();
}
if (return_type != G_TYPE_NONE && !G_TYPE_IS_VALUE (return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
{
- g_warning (G_STRLOC ": return value of type `%s' for signal \"%s::%s\" is not a value type",
+ g_warning (G_STRLOC ": return value of type '%s' for signal \"%s::%s\" is not a value type",
type_debug_name (return_type), type_debug_name (itype), name);
g_free (name);
SIGNAL_UNLOCK ();
if (return_type != G_TYPE_NONE &&
(signal_flags & (G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST | G_SIGNAL_RUN_CLEANUP)) == G_SIGNAL_RUN_FIRST)
{
- g_warning (G_STRLOC ": signal \"%s::%s\" has return type `%s' and is only G_SIGNAL_RUN_FIRST",
+ g_warning (G_STRLOC ": signal \"%s::%s\" has return type '%s' and is only G_SIGNAL_RUN_FIRST",
type_debug_name (itype), name, type_debug_name (return_type));
g_free (name);
SIGNAL_UNLOCK ();
key.quark = g_quark_from_string (node->name);
key.signal_id = signal_id;
g_signal_key_bsa = g_bsearch_array_insert (g_signal_key_bsa, &g_signal_key_bconfig, &key);
- g_strdelimit (node->name, "_", '-');
- key.quark = g_quark_from_static_string (node->name);
+ g_strdelimit (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;
/* setup reinitializable portion */
+ node->single_va_closure_is_valid = FALSE;
node->flags = signal_flags & G_SIGNAL_FLAGS_MASK;
node->n_params = n_params;
node->param_types = g_memdup (param_types, sizeof (GType) * n_params);
}
else
node->accumulator = NULL;
+
+ builtin_c_marshaller = NULL;
+ va_marshaller = NULL;
+
+ /* Pick up built-in va marshallers for standard types, and
+ instead of generic marshaller if no marshaller specified */
+ if (n_params == 0 && return_type == G_TYPE_NONE)
+ {
+ builtin_c_marshaller = g_cclosure_marshal_VOID__VOID;
+ va_marshaller = g_cclosure_marshal_VOID__VOIDv;
+ }
+ else if (n_params == 1 && return_type == G_TYPE_NONE)
+ {
+#define ADD_CHECK(__type__) \
+ else if (g_type_is_a (param_types[0] & ~G_SIGNAL_TYPE_STATIC_SCOPE, G_TYPE_ ##__type__)) \
+ { \
+ builtin_c_marshaller = g_cclosure_marshal_VOID__ ## __type__; \
+ va_marshaller = g_cclosure_marshal_VOID__ ## __type__ ##v; \
+ }
+
+ if (0) {}
+ ADD_CHECK (BOOLEAN)
+ ADD_CHECK (CHAR)
+ ADD_CHECK (UCHAR)
+ ADD_CHECK (INT)
+ ADD_CHECK (UINT)
+ ADD_CHECK (LONG)
+ ADD_CHECK (ULONG)
+ ADD_CHECK (ENUM)
+ ADD_CHECK (FLAGS)
+ ADD_CHECK (FLOAT)
+ ADD_CHECK (DOUBLE)
+ ADD_CHECK (STRING)
+ ADD_CHECK (PARAM)
+ ADD_CHECK (BOXED)
+ ADD_CHECK (POINTER)
+ ADD_CHECK (OBJECT)
+ ADD_CHECK (VARIANT)
+ }
+
+ if (c_marshaller == NULL)
+ {
+ if (builtin_c_marshaller)
+ c_marshaller = builtin_c_marshaller;
+ else
+ {
+ c_marshaller = g_cclosure_marshal_generic;
+ va_marshaller = g_cclosure_marshal_generic_va;
+ }
+ }
+
node->c_marshaller = c_marshaller;
+ node->va_marshaller = va_marshaller;
node->emission_hooks = NULL;
if (class_closure)
signal_add_class_closure (node, 0, class_closure);
- else if (G_TYPE_IS_INSTANTIATABLE (itype) && return_type == G_TYPE_NONE)
- {
- /* optimize NOP emissions */
- node->test_class_offset = TEST_CLASS_MAGIC;
- }
+
SIGNAL_UNLOCK ();
+ g_free (name);
+
return signal_id;
}
+void
+g_signal_set_va_marshaller (guint signal_id,
+ GType instance_type,
+ GSignalCVaMarshaller va_marshaller)
+{
+ SignalNode *node;
+
+ g_return_if_fail (signal_id > 0);
+ g_return_if_fail (va_marshaller != NULL);
+
+ SIGNAL_LOCK ();
+ node = LOOKUP_SIGNAL_NODE (signal_id);
+ if (node)
+ {
+ node->va_marshaller = va_marshaller;
+ if (node->class_closure_bsa)
+ {
+ ClassClosure *cc = g_bsearch_array_get_nth (node->class_closure_bsa, &g_class_closure_bconfig, 0);
+ if (cc->closure->marshal == node->c_marshaller)
+ _g_closure_set_va_marshal (cc->closure, va_marshaller);
+ }
+
+ node->single_va_closure_is_valid = FALSE;
+ }
+
+ SIGNAL_UNLOCK ();
+}
+
+
+/**
+ * g_signal_new_valist:
+ * @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_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: (allow-none): the function to translate arrays of parameter
+ * values to signal emissions into C language callback invocations or %NULL.
+ * @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 in @args.
+ * @args: va_list of #GType, one for each parameter.
+ *
+ * Creates a new signal. (This is usually done in the class initializer.)
+ *
+ * See g_signal_new() for details on allowed signal names.
+ *
+ * If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
+ * the marshaller for this signal.
+ *
+ * Returns: the signal id
+ */
guint
g_signal_new_valist (const gchar *signal_name,
GType itype,
signal_node->destroyed = TRUE;
/* reentrancy caution, zero out real contents first */
- signal_node->test_class_offset = 0;
+ signal_node->single_va_closure_is_valid = FALSE;
signal_node->n_params = 0;
signal_node->param_types = NULL;
signal_node->return_type = 0;
signal_node->class_closure_bsa = NULL;
signal_node->accumulator = NULL;
signal_node->c_marshaller = NULL;
+ signal_node->va_marshaller = NULL;
signal_node->emission_hooks = NULL;
#ifdef G_ENABLE_DEBUG
for (emission = (node.flags & G_SIGNAL_NO_RECURSE) ? g_restart_emissions : g_recursive_emissions;
emission; emission = emission->next)
if (emission->ihint.signal_id == node.signal_id)
- g_critical (G_STRLOC ": signal \"%s\" being destroyed is currently in emission (instance `%p')",
+ g_critical (G_STRLOC ": signal \"%s\" being destroyed is currently in emission (instance '%p')",
node.name, emission->instance);
}
#endif
SIGNAL_LOCK ();
}
+/**
+ * g_signal_override_class_closure:
+ * @signal_id: the signal id
+ * @instance_type: the instance type on which to override the class closure
+ * for the signal.
+ * @class_closure: the closure.
+ *
+ * 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,
GType instance_type,
SIGNAL_LOCK ();
node = LOOKUP_SIGNAL_NODE (signal_id);
+ node_check_deprecated (node);
if (!g_type_is_a (instance_type, node->itype))
- g_warning ("%s: type `%s' cannot be overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
+ g_warning ("%s: type '%s' cannot be overridden for signal id '%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
else
{
ClassClosure *cc = signal_find_class_closure (node, instance_type);
if (cc && cc->instance_type == instance_type)
- g_warning ("%s: type `%s' is already overridden for signal id `%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
+ g_warning ("%s: type '%s' is already overridden for signal id '%u'", G_STRLOC, type_debug_name (instance_type), signal_id);
else
signal_add_class_closure (node, instance_type, class_closure);
}
SIGNAL_UNLOCK ();
}
+/**
+ * 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
+ * callback @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: (array) the argument list of the signal emission.
+ * The first element in the array is a #GValue for the instance the signal
+ * is being emitted on. The rest are any arguments to be passed to the signal.
+ * @return_value: Location for the return value.
+ *
+ * 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().
+ */
void
g_signal_chain_from_overridden (const GValue *instance_and_params,
GValue *return_value)
}
}
else
- g_warning ("%s: signal id `%u' cannot be chained from current emission stage for instance `%p'", G_STRLOC, node->signal_id, instance);
+ 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);
+ g_warning ("%s: no signal is currently being emitted for instance '%p'", G_STRLOC, instance);
+
if (closure)
{
emission->chain_type = chain_type;
SIGNAL_UNLOCK ();
}
-GSignalInvocationHint*
-g_signal_get_invocation_hint (gpointer instance)
+/**
+ * g_signal_chain_from_overridden_handler: (skip)
+ * @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;
-
- g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), NULL);
+ GClosure *closure = NULL;
+ SignalNode *node;
+ guint n_params = 0;
- SIGNAL_LOCK ();
- emission = emission_find_innermost (instance);
- SIGNAL_UNLOCK ();
-
- return emission ? &emission->ihint : NULL;
-}
+ g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
-gulong
-g_signal_connect_closure_by_id (gpointer instance,
- guint signal_id,
- GQuark detail,
- GClosure *closure,
- gboolean after)
-{
- SignalNode *node;
- gulong handler_seq_no = 0;
-
- g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
- g_return_val_if_fail (signal_id > 0, 0);
- g_return_val_if_fail (closure != NULL, 0);
-
SIGNAL_LOCK ();
- node = LOOKUP_SIGNAL_NODE (signal_id);
- if (node)
+ emission = emission_find_innermost (instance);
+ if (emission)
{
- if (detail && !(node->flags & G_SIGNAL_DETAILED))
- g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
- else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
- g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
- else
+ 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)
{
- Handler *handler = handler_new (after);
-
+ 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_alloca (sizeof (GValue) * (n_params + 1));
+ memset (instance_and_params, 0, 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);
+
+ 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 = G_VALUE_INIT;
+ 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 occurred
+ */
+ }
+ }
+
+ for (i = 0; i < n_params; i++)
+ g_value_unset (param_values + i);
+ g_value_unset (instance_and_params);
+
+ va_end (var_args);
+
+ SIGNAL_LOCK ();
+ emission->chain_type = restore_type;
+ }
+ SIGNAL_UNLOCK ();
+}
+
+/**
+ * g_signal_get_invocation_hint:
+ * @instance: (type GObject.Object): the instance to query
+ *
+ * Returns the invocation hint of the innermost signal emission of instance.
+ *
+ * Returns: (transfer none): the invocation hint of the innermost signal emission.
+ */
+GSignalInvocationHint*
+g_signal_get_invocation_hint (gpointer instance)
+{
+ Emission *emission = NULL;
+
+ g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), NULL);
+
+ SIGNAL_LOCK ();
+ emission = emission_find_innermost (instance);
+ SIGNAL_UNLOCK ();
+
+ return emission ? &emission->ihint : NULL;
+}
+
+/**
+ * g_signal_connect_closure_by_id:
+ * @instance: (type GObject.Object): the instance to connect to.
+ * @signal_id: the id of the signal.
+ * @detail: the detail.
+ * @closure: the closure to connect.
+ * @after: whether the handler should be called before or after the
+ * default handler of the signal.
+ *
+ * Connects a closure to a signal for a particular object.
+ *
+ * Returns: the handler id (always greater than 0 for successful connections)
+ */
+gulong
+g_signal_connect_closure_by_id (gpointer instance,
+ guint signal_id,
+ GQuark detail,
+ GClosure *closure,
+ gboolean after)
+{
+ SignalNode *node;
+ gulong handler_seq_no = 0;
+
+ g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
+ g_return_val_if_fail (signal_id > 0, 0);
+ g_return_val_if_fail (closure != NULL, 0);
+
+ SIGNAL_LOCK ();
+ node = LOOKUP_SIGNAL_NODE (signal_id);
+ if (node)
+ {
+ if (detail && !(node->flags & G_SIGNAL_DETAILED))
+ g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
+ else if (!g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
+ g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
+ else
+ {
+ Handler *handler = handler_new (after);
+
handler_seq_no = handler->sequential_number;
handler->detail = detail;
handler->closure = g_closure_ref (closure);
g_closure_sink (closure);
+ add_invalid_closure_notify (handler, instance);
handler_insert (signal_id, instance, handler);
if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (closure))
- g_closure_set_marshal (closure, node->c_marshaller);
+ {
+ g_closure_set_marshal (closure, node->c_marshaller);
+ if (node->va_marshaller)
+ _g_closure_set_va_marshal (closure, node->va_marshaller);
+ }
}
}
else
- g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
+ g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
SIGNAL_UNLOCK ();
return handler_seq_no;
}
+/**
+ * g_signal_connect_closure:
+ * @instance: (type GObject.Object): the instance to connect to.
+ * @detailed_signal: a string of the form "signal-name::detail".
+ * @closure: the closure to connect.
+ * @after: whether the handler should be called before or after the
+ * default handler of the signal.
+ *
+ * Connects a closure to a signal for a particular object.
+ *
+ * Returns: the handler id (always greater than 0 for successful connections)
+ */
gulong
g_signal_connect_closure (gpointer instance,
const gchar *detailed_signal,
SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
if (detail && !(node->flags & G_SIGNAL_DETAILED))
- g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
+ g_warning ("%s: signal '%s' does not support details", G_STRLOC, detailed_signal);
else if (!g_type_is_a (itype, node->itype))
- g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
+ g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
else
{
Handler *handler = handler_new (after);
handler->detail = detail;
handler->closure = g_closure_ref (closure);
g_closure_sink (closure);
+ add_invalid_closure_notify (handler, instance);
handler_insert (signal_id, instance, handler);
if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
- g_closure_set_marshal (handler->closure, node->c_marshaller);
+ {
+ g_closure_set_marshal (handler->closure, node->c_marshaller);
+ if (node->va_marshaller)
+ _g_closure_set_va_marshal (handler->closure, node->va_marshaller);
+ }
}
}
else
- g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
+ g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
SIGNAL_UNLOCK ();
return handler_seq_no;
}
+static void
+node_check_deprecated (const SignalNode *node)
+{
+ static const gchar * g_enable_diagnostic = NULL;
+
+ if (G_UNLIKELY (!g_enable_diagnostic))
+ {
+ g_enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
+ if (!g_enable_diagnostic)
+ g_enable_diagnostic = "0";
+ }
+
+ if (g_enable_diagnostic[0] == '1')
+ {
+ if (node->flags & G_SIGNAL_DEPRECATED)
+ {
+ g_warning ("The signal %s::%s is deprecated and shouldn't be used "
+ "anymore. It will be removed in a future version.",
+ type_debug_name (node->itype), node->name);
+ }
+ }
+}
+
+/**
+ * g_signal_connect_data:
+ * @instance: (type GObject.Object): the instance to connect to.
+ * @detailed_signal: a string of the form "signal-name::detail".
+ * @c_handler: the #GCallback to connect.
+ * @data: data to pass to @c_handler calls.
+ * @destroy_data: a #GClosureNotify for @data.
+ * @connect_flags: a combination of #GConnectFlags.
+ *
+ * Connects a #GCallback function to a signal for a particular object. Similar
+ * to g_signal_connect(), but allows to provide a #GClosureNotify for the data
+ * which will be called when the signal handler is disconnected and no longer
+ * used. Specify @connect_flags if you need `..._after()` or
+ * `..._swapped()` variants of this function.
+ *
+ * Returns: the handler id (always greater than 0 for successful connections)
+ */
gulong
g_signal_connect_data (gpointer instance,
const gchar *detailed_signal,
{
SignalNode *node = LOOKUP_SIGNAL_NODE (signal_id);
+ node_check_deprecated (node);
+
if (detail && !(node->flags & G_SIGNAL_DETAILED))
- g_warning ("%s: signal `%s' does not support details", G_STRLOC, detailed_signal);
+ g_warning ("%s: signal '%s' does not support details", G_STRLOC, detailed_signal);
else if (!g_type_is_a (itype, node->itype))
- g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
+ g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
else
{
Handler *handler = handler_new (after);
g_closure_sink (handler->closure);
handler_insert (signal_id, instance, handler);
if (node->c_marshaller && G_CLOSURE_NEEDS_MARSHAL (handler->closure))
- g_closure_set_marshal (handler->closure, node->c_marshaller);
- }
+ {
+ g_closure_set_marshal (handler->closure, node->c_marshaller);
+ if (node->va_marshaller)
+ _g_closure_set_va_marshal (handler->closure, node->va_marshaller);
+ }
+ }
}
else
- g_warning ("%s: signal `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
+ g_warning ("%s: signal '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
SIGNAL_UNLOCK ();
return handler_seq_no;
}
+/**
+ * g_signal_handler_block:
+ * @instance: (type GObject.Object): The instance to block the signal handler of.
+ * @handler_id: Handler id of the handler to be blocked.
+ *
+ * Blocks a handler of an instance so it will not be called during any
+ * signal emissions unless it is unblocked again. Thus "blocking" a
+ * signal handler means to temporarily deactive it, a signal handler
+ * has to be unblocked exactly the same amount of times it has been
+ * blocked before to become active again.
+ *
+ * The @handler_id has to be a valid signal handler id, connected to a
+ * signal of @instance.
+ */
void
g_signal_handler_block (gpointer instance,
gulong handler_id)
g_return_if_fail (handler_id > 0);
SIGNAL_LOCK ();
- handler = handler_lookup (instance, handler_id, NULL);
+ handler = handler_lookup (instance, handler_id, NULL, NULL);
if (handler)
{
#ifndef G_DISABLE_CHECKS
handler->block_count += 1;
}
else
- g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
+ g_warning ("%s: instance '%p' has no handler with id '%lu'", G_STRLOC, instance, handler_id);
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_handler_unblock:
+ * @instance: (type GObject.Object): The instance to unblock the signal handler of.
+ * @handler_id: Handler id of the handler to be unblocked.
+ *
+ * Undoes the effect of a previous g_signal_handler_block() call. A
+ * blocked handler is skipped during signal emissions and will not be
+ * invoked, unblocking it (for exactly the amount of times it has been
+ * blocked before) reverts its "blocked" state, so the handler will be
+ * recognized by the signal system and is called upon future or
+ * currently ongoing signal emissions (since the order in which
+ * handlers are called during signal emissions is deterministic,
+ * whether the unblocked handler in question is called as part of a
+ * currently ongoing emission depends on how far that emission has
+ * proceeded yet).
+ *
+ * The @handler_id has to be a valid id of a signal handler that is
+ * connected to a signal of @instance and is currently blocked.
+ */
void
g_signal_handler_unblock (gpointer instance,
gulong handler_id)
g_return_if_fail (handler_id > 0);
SIGNAL_LOCK ();
- handler = handler_lookup (instance, handler_id, NULL);
+ handler = handler_lookup (instance, handler_id, NULL, NULL);
if (handler)
{
if (handler->block_count)
handler->block_count -= 1;
else
- g_warning (G_STRLOC ": handler `%lu' of instance `%p' is not blocked", handler_id, instance);
+ g_warning (G_STRLOC ": handler '%lu' of instance '%p' is not blocked", handler_id, instance);
}
else
- g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
+ g_warning ("%s: instance '%p' has no handler with id '%lu'", G_STRLOC, instance, handler_id);
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_handler_disconnect:
+ * @instance: (type GObject.Object): The instance to remove the signal handler from.
+ * @handler_id: Handler id of the handler to be disconnected.
+ *
+ * Disconnects a handler from an instance so it will not be called during
+ * any future or currently ongoing emissions of the signal it has been
+ * connected to. The @handler_id becomes invalid and may be reused.
+ *
+ * The @handler_id has to be a valid signal handler id, connected to a
+ * signal of @instance.
+ */
void
g_signal_handler_disconnect (gpointer instance,
gulong handler_id)
g_return_if_fail (handler_id > 0);
SIGNAL_LOCK ();
- handler = handler_lookup (instance, handler_id, &signal_id);
+ handler = handler_lookup (instance, handler_id, NULL, &signal_id);
if (handler)
{
handler->sequential_number = 0;
handler->block_count = 1;
+ remove_invalid_closure_notify (handler, instance);
handler_unref_R (signal_id, instance, handler);
}
else
- g_warning ("%s: instance `%p' has no handler with id `%lu'", G_STRLOC, instance, handler_id);
+ g_warning ("%s: instance '%p' has no handler with id '%lu'", G_STRLOC, instance, handler_id);
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_handler_is_connected:
+ * @instance: (type GObject.Object): The instance where a signal handler is sought.
+ * @handler_id: the handler id.
+ *
+ * Returns whether @handler_id is the id of a handler connected to @instance.
+ *
+ * Returns: whether @handler_id identifies a handler connected to @instance.
+ */
gboolean
g_signal_handler_is_connected (gpointer instance,
gulong handler_id)
g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), FALSE);
SIGNAL_LOCK ();
- handler = handler_lookup (instance, handler_id, NULL);
+ handler = handler_lookup (instance, handler_id, NULL, NULL);
connected = handler != NULL;
SIGNAL_UNLOCK ();
return connected;
}
+/**
+ * g_signal_handlers_destroy:
+ * @instance: (type GObject.Object): The instance whose signal handlers are destroyed
+ *
+ * Destroy all signal handlers of a type instance. This function is
+ * an implementation detail of the #GObject dispose implementation,
+ * and should not be used outside of the type system.
+ */
void
g_signal_handlers_destroy (gpointer instance)
{
tmp->prev = tmp;
if (tmp->sequential_number)
{
+ remove_invalid_closure_notify (tmp, instance);
tmp->sequential_number = 0;
handler_unref_R (0, NULL, tmp);
}
SIGNAL_UNLOCK ();
}
+/**
+ * g_signal_handler_find:
+ * @instance: (type GObject.Object): The instance owning the signal handler to be found.
+ * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * and/or @data the handler has to match.
+ * @signal_id: Signal the handler has to be connected to.
+ * @detail: Signal detail the handler has to be connected to.
+ * @closure: (allow-none): The closure the handler will invoke.
+ * @func: The C closure callback of the handler (useless for non-C closures).
+ * @data: The closure data of the handler's closure.
+ *
+ * Finds the first signal handler that matches certain selection criteria.
+ * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
+ * flags, and the criteria values are passed as arguments.
+ * The match @mask has to be non-0 for successful matches.
+ * If no handler was found, 0 is returned.
+ *
+ * Returns: A valid non-0 signal handler id for a successful match.
+ */
gulong
g_signal_handler_find (gpointer instance,
GSignalMatchType mask,
return n_handlers;
}
+/**
+ * g_signal_handlers_block_matched:
+ * @instance: (type GObject.Object): The instance to block handlers from.
+ * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * and/or @data the handlers have to match.
+ * @signal_id: Signal the handlers have to be connected to.
+ * @detail: Signal detail the handlers have to be connected to.
+ * @closure: (allow-none): The closure the handlers will invoke.
+ * @func: The C closure callback of the handlers (useless for non-C closures).
+ * @data: The closure data of the handlers' closures.
+ *
+ * Blocks all handlers on an instance that match a certain selection criteria.
+ * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
+ * flags, and the criteria values are passed as arguments.
+ * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
+ * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
+ * If no handlers were found, 0 is returned, the number of blocked handlers
+ * otherwise.
+ *
+ * Returns: The number of handlers that matched.
+ */
guint
g_signal_handlers_block_matched (gpointer instance,
GSignalMatchType mask,
return n_handlers;
}
+/**
+ * g_signal_handlers_unblock_matched:
+ * @instance: (type GObject.Object): The instance to unblock handlers from.
+ * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * and/or @data the handlers have to match.
+ * @signal_id: Signal the handlers have to be connected to.
+ * @detail: Signal detail the handlers have to be connected to.
+ * @closure: (allow-none): The closure the handlers will invoke.
+ * @func: The C closure callback of the handlers (useless for non-C closures).
+ * @data: The closure data of the handlers' closures.
+ *
+ * Unblocks all handlers on an instance that match a certain selection
+ * criteria. The criteria mask is passed as an OR-ed combination of
+ * #GSignalMatchType flags, and the criteria values are passed as arguments.
+ * Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
+ * or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
+ * If no handlers were found, 0 is returned, the number of unblocked handlers
+ * otherwise. The match criteria should not apply to any handlers that are
+ * not currently blocked.
+ *
+ * Returns: The number of handlers that matched.
+ */
guint
g_signal_handlers_unblock_matched (gpointer instance,
GSignalMatchType mask,
return n_handlers;
}
+/**
+ * g_signal_handlers_disconnect_matched:
+ * @instance: (type GObject.Object): The instance to remove handlers from.
+ * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * and/or @data the handlers have to match.
+ * @signal_id: Signal the handlers have to be connected to.
+ * @detail: Signal detail the handlers have to be connected to.
+ * @closure: (allow-none): The closure the handlers will invoke.
+ * @func: The C closure callback of the handlers (useless for non-C closures).
+ * @data: The closure data of the handlers' closures.
+ *
+ * Disconnects all handlers on an instance that match a certain
+ * selection criteria. The criteria mask is passed as an OR-ed
+ * combination of #GSignalMatchType flags, and the criteria values are
+ * passed as arguments. Passing at least one of the
+ * %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
+ * %G_SIGNAL_MATCH_DATA match flags is required for successful
+ * matches. If no handlers were found, 0 is returned, the number of
+ * disconnected handlers otherwise.
+ *
+ * Returns: The number of handlers that matched.
+ */
guint
g_signal_handlers_disconnect_matched (gpointer instance,
GSignalMatchType mask,
return n_handlers;
}
+/**
+ * g_signal_has_handler_pending:
+ * @instance: (type GObject.Object): the object whose signal handlers are sought.
+ * @signal_id: the signal id.
+ * @detail: the detail.
+ * @may_be_blocked: whether blocked handlers should count as match.
+ *
+ * Returns whether there are any handlers connected to @instance for the
+ * given signal id and detail.
+ *
+ * One example of when you might use this is when the arguments to the
+ * signal are difficult to compute. A class implementor may opt to not
+ * emit the signal if no one is attached anyway, thus saving the cost
+ * of building the arguments.
+ *
+ * Returns: %TRUE if a handler is connected to the signal, %FALSE
+ * otherwise.
+ */
gboolean
g_signal_has_handler_pending (gpointer instance,
guint signal_id,
if (!(node->flags & G_SIGNAL_DETAILED))
{
- g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
+ g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
SIGNAL_UNLOCK ();
return FALSE;
}
return has_pending;
}
-static inline gboolean
-signal_check_skip_emission (SignalNode *node,
- gpointer instance,
- GQuark detail)
-{
- HandlerList *hlist;
-
- /* are we able to check for NULL class handlers? */
- if (!node->test_class_offset)
- return FALSE;
-
- /* are there emission hooks pending? */
- if (node->emission_hooks && node->emission_hooks->hooks)
- return FALSE;
-
- /* is there a non-NULL class handler? */
- if (node->test_class_offset != TEST_CLASS_MAGIC)
- {
- GTypeClass *class = G_TYPE_INSTANCE_GET_CLASS (instance, G_TYPE_FROM_INSTANCE (instance), GTypeClass);
-
- if (G_STRUCT_MEMBER (gpointer, class, node->test_class_offset))
- return FALSE;
- }
-
- /* are signals being debugged? */
-#ifdef G_ENABLE_DEBUG
- IF_DEBUG (SIGNALS, g_trace_instance_signals || g_trap_instance_signals)
- return FALSE;
-#endif /* G_ENABLE_DEBUG */
-
- /* is this a no-recurse signal already in emission? */
- if (node->flags & G_SIGNAL_NO_RECURSE &&
- emission_find (g_restart_emissions, node->signal_id, detail, instance))
- return FALSE;
-
- /* do we have pending handlers? */
- hlist = handler_list_lookup (node->signal_id, instance);
- if (hlist && hlist->handlers)
- return FALSE;
-
- /* none of the above, no emission required */
- return TRUE;
-}
-
+/**
+ * g_signal_emitv:
+ * @instance_and_params: (array): argument list for the signal emission.
+ * The first element in the array is a #GValue for the instance the signal
+ * is being emitted on. The rest are any arguments to be passed to the signal.
+ * @signal_id: the signal id
+ * @detail: the detail
+ * @return_value: Location to store the return value of the signal emission.
+ *
+ * Emits a signal.
+ *
+ * Note that g_signal_emitv() doesn't change @return_value if no handlers are
+ * connected, in contrast to g_signal_emit() and g_signal_emit_valist().
+ */
void
g_signal_emitv (const GValue *instance_and_params,
guint signal_id,
GQuark detail,
GValue *return_value)
{
- const GValue *param_values;
gpointer instance;
SignalNode *node;
#ifdef G_ENABLE_DEBUG
+ const GValue *param_values;
guint i;
#endif
g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
g_return_if_fail (signal_id > 0);
+#ifdef G_ENABLE_DEBUG
param_values = instance_and_params + 1;
-
+#endif
+
SIGNAL_LOCK ();
node = LOOKUP_SIGNAL_NODE (signal_id);
if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
{
- g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
+ g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
SIGNAL_UNLOCK ();
return;
}
#ifdef G_ENABLE_DEBUG
if (detail && !(node->flags & G_SIGNAL_DETAILED))
{
- g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
+ g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
SIGNAL_UNLOCK ();
return;
}
for (i = 0; i < node->n_params; i++)
if (!G_TYPE_CHECK_VALUE_TYPE (param_values + i, node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE))
{
- g_critical ("%s: value for `%s' parameter %u for signal \"%s\" is of type `%s'",
+ g_critical ("%s: value for '%s' parameter %u for signal \"%s\" is of type '%s'",
G_STRLOC,
type_debug_name (node->param_types[i]),
i,
{
if (!return_value)
{
- g_critical ("%s: return value `%s' for signal \"%s\" is (NULL)",
+ g_critical ("%s: return value '%s' for signal \"%s\" is (NULL)",
G_STRLOC,
type_debug_name (node->return_type),
node->name);
}
else if (!node->accumulator && !G_TYPE_CHECK_VALUE_TYPE (return_value, node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE))
{
- g_critical ("%s: return value `%s' for signal \"%s\" is of type `%s'",
+ g_critical ("%s: return value '%s' for signal \"%s\" is of type '%s'",
G_STRLOC,
type_debug_name (node->return_type),
node->name,
#endif /* G_ENABLE_DEBUG */
/* optimize NOP emissions */
- if (signal_check_skip_emission (node, instance, detail))
+ if (!node->single_va_closure_is_valid)
+ node_update_single_va_closure (node);
+
+ if (node->single_va_closure != NULL &&
+ (node->single_va_closure == SINGLE_VA_CLOSURE_EMPTY_MAGIC ||
+ _g_closure_is_void (node->single_va_closure, instance)))
{
- /* nothing to do to emit this signal */
- SIGNAL_UNLOCK ();
- /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
- return;
+ HandlerList* hlist = handler_list_lookup (node->signal_id, instance);
+ if (hlist == NULL || hlist->handlers == NULL)
+ {
+ /* nothing to do to emit this signal */
+ SIGNAL_UNLOCK ();
+ /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
+ return;
+ }
}
SIGNAL_UNLOCK ();
signal_emit_unlocked_R (node, detail, instance, return_value, instance_and_params);
}
+static inline gboolean
+accumulate (GSignalInvocationHint *ihint,
+ GValue *return_accu,
+ GValue *handler_return,
+ SignalAccumulator *accumulator)
+{
+ gboolean continue_emission;
+
+ if (!accumulator)
+ return TRUE;
+
+ continue_emission = accumulator->func (ihint, return_accu, handler_return, accumulator->data);
+ g_value_reset (handler_return);
+
+ return continue_emission;
+}
+
+/**
+ * g_signal_emit_valist: (skip)
+ * @instance: the instance the signal is being emitted on.
+ * @signal_id: the signal id
+ * @detail: the detail
+ * @var_args: a list of parameters to be passed to the signal, 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.
+ *
+ * Emits a signal.
+ *
+ * Note that g_signal_emit_valist() resets the return value to the default
+ * if no handlers are connected, in contrast to g_signal_emitv().
+ */
void
g_signal_emit_valist (gpointer instance,
guint signal_id,
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;
guint i, n_params;
-
+
g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
g_return_if_fail (signal_id > 0);
node = LOOKUP_SIGNAL_NODE (signal_id);
if (!node || !g_type_is_a (G_TYPE_FROM_INSTANCE (instance), node->itype))
{
- g_warning ("%s: signal id `%u' is invalid for instance `%p'", G_STRLOC, signal_id, instance);
+ g_warning ("%s: signal id '%u' is invalid for instance '%p'", G_STRLOC, signal_id, instance);
SIGNAL_UNLOCK ();
return;
}
#ifndef G_DISABLE_CHECKS
if (detail && !(node->flags & G_SIGNAL_DETAILED))
{
- g_warning ("%s: signal id `%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
+ g_warning ("%s: signal id '%u' does not support detail (%u)", G_STRLOC, signal_id, detail);
SIGNAL_UNLOCK ();
return;
}
#endif /* !G_DISABLE_CHECKS */
- /* optimize NOP emissions */
- if (signal_check_skip_emission (node, instance, detail))
+ if (!node->single_va_closure_is_valid)
+ node_update_single_va_closure (node);
+
+ if (node->single_va_closure != NULL)
{
- /* nothing to do to emit this signal */
- SIGNAL_UNLOCK ();
- /* g_printerr ("omitting emission of \"%s\"\n", node->name); */
- return;
+ HandlerList* hlist = handler_list_lookup (node->signal_id, instance);
+ Handler *fastpath_handler = NULL;
+ Handler *l;
+ GClosure *closure = NULL;
+ gboolean fastpath = TRUE;
+ GSignalFlags run_type = G_SIGNAL_RUN_FIRST;
+
+ if (node->single_va_closure != SINGLE_VA_CLOSURE_EMPTY_MAGIC &&
+ !_g_closure_is_void (node->single_va_closure, instance))
+ {
+ if (_g_closure_supports_invoke_va (node->single_va_closure))
+ {
+ closure = node->single_va_closure;
+ if (node->single_va_closure_is_after)
+ run_type = G_SIGNAL_RUN_LAST;
+ else
+ run_type = G_SIGNAL_RUN_FIRST;
+ }
+ else
+ fastpath = FALSE;
+ }
+
+ for (l = hlist ? hlist->handlers : NULL; fastpath && l != NULL; l = l->next)
+ {
+ if (!l->block_count &&
+ (!l->detail || l->detail == detail))
+ {
+ if (closure != NULL || !_g_closure_supports_invoke_va (l->closure))
+ {
+ fastpath = FALSE;
+ break;
+ }
+ else
+ {
+ fastpath_handler = l;
+ closure = l->closure;
+ if (l->after)
+ run_type = G_SIGNAL_RUN_LAST;
+ else
+ run_type = G_SIGNAL_RUN_FIRST;
+ }
+ }
+ }
+
+ if (fastpath && closure == NULL && node->return_type == G_TYPE_NONE)
+ {
+ SIGNAL_UNLOCK ();
+ return;
+ }
+
+ /* Don't allow no-recurse emission as we might have to restart, which means
+ we will run multiple handlers and thus must ref all arguments */
+ if (closure != NULL && (node->flags & (G_SIGNAL_NO_RECURSE)) != 0)
+ fastpath = FALSE;
+
+ if (fastpath)
+ {
+ SignalAccumulator *accumulator;
+ Emission emission;
+ GValue *return_accu, accu = G_VALUE_INIT;
+ guint signal_id;
+ GType instance_type = G_TYPE_FROM_INSTANCE (instance);
+ GValue emission_return = G_VALUE_INIT;
+ GType rtype = node->return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE;
+ gboolean static_scope = node->return_type & G_SIGNAL_TYPE_STATIC_SCOPE;
+
+ signal_id = node->signal_id;
+ accumulator = node->accumulator;
+ if (rtype == G_TYPE_NONE)
+ return_accu = NULL;
+ else if (accumulator)
+ return_accu = &accu;
+ else
+ return_accu = &emission_return;
+
+ emission.instance = instance;
+ emission.ihint.signal_id = signal_id;
+ emission.ihint.detail = detail;
+ emission.ihint.run_type = run_type;
+ emission.state = EMISSION_RUN;
+ emission.chain_type = instance_type;
+ emission_push (&g_recursive_emissions, &emission);
+
+ if (fastpath_handler)
+ handler_ref (fastpath_handler);
+
+ SIGNAL_UNLOCK ();
+
+ TRACE(GOBJECT_SIGNAL_EMIT(signal_id, detail, instance, instance_type));
+
+ if (rtype != G_TYPE_NONE)
+ g_value_init (&emission_return, rtype);
+
+ if (accumulator)
+ g_value_init (&accu, rtype);
+
+ if (closure != NULL)
+ {
+ g_object_ref (instance);
+ _g_closure_invoke_va (closure,
+ return_accu,
+ instance,
+ var_args,
+ node->n_params,
+ node->param_types);
+ accumulate (&emission.ihint, &emission_return, &accu, accumulator);
+ }
+
+ SIGNAL_LOCK ();
+
+ emission.chain_type = G_TYPE_NONE;
+ emission_pop (&g_recursive_emissions, &emission);
+
+ if (fastpath_handler)
+ handler_unref_R (signal_id, instance, fastpath_handler);
+
+ SIGNAL_UNLOCK ();
+
+ if (accumulator)
+ g_value_unset (&accu);
+
+ if (rtype != G_TYPE_NONE)
+ {
+ gchar *error = NULL;
+ for (i = 0; i < node->n_params; i++)
+ {
+ GType ptype = node->param_types[i] & ~G_SIGNAL_TYPE_STATIC_SCOPE;
+ G_VALUE_COLLECT_SKIP (ptype, var_args);
+ }
+
+ G_VALUE_LCOPY (&emission_return,
+ var_args,
+ static_scope ? G_VALUE_NOCOPY_CONTENTS : 0,
+ &error);
+ if (!error)
+ g_value_unset (&emission_return);
+ 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 occurred
+ */
+ }
+ }
+
+ TRACE(GOBJECT_SIGNAL_EMIT_END(signal_id, detail, instance, instance_type));
+
+ if (closure != NULL)
+ g_object_unref (instance);
+
+ return;
+ }
}
+ SIGNAL_UNLOCK ();
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_alloca (sizeof (GValue) * (n_params + 1));
+ memset (instance_and_params, 0, 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);
while (i--)
g_value_unset (param_values + i);
- g_free (free_me);
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_emit_unlocked_R (node, detail, instance, NULL, instance_and_params);
else
{
- GValue return_value = { 0, };
+ GValue return_value = G_VALUE_INIT;
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_free (error);
/* we purposely leak the value here, it might not be
- * in a sane state if an error condition occured
+ * in a sane state if an error condition occurred
*/
}
}
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_signal_emit:
+ * @instance: (type GObject.Object): the instance the signal is being emitted on.
+ * @signal_id: the signal id
+ * @detail: the detail
+ * @...: parameters to be passed to the signal, 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.
+ *
+ * Emits a signal.
+ *
+ * Note that g_signal_emit() resets the return value to the default
+ * if no handlers are connected, in contrast to g_signal_emitv().
+ */
void
g_signal_emit (gpointer instance,
guint signal_id,
va_end (var_args);
}
+/**
+ * g_signal_emit_by_name:
+ * @instance: (type GObject.Object): the instance the signal is being emitted on.
+ * @detailed_signal: a string of the form "signal-name::detail".
+ * @...: parameters to be passed to the signal, 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.
+ *
+ * Emits a signal.
+ *
+ * Note that g_signal_emit_by_name() resets the return value to the default
+ * if no handlers are connected, in contrast to g_signal_emitv().
+ */
void
g_signal_emit_by_name (gpointer instance,
const gchar *detailed_signal,
{
GQuark detail = 0;
guint signal_id;
+ GType itype;
g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
g_return_if_fail (detailed_signal != NULL);
+ itype = G_TYPE_FROM_INSTANCE (instance);
+
SIGNAL_LOCK ();
- signal_id = signal_parse_name (detailed_signal, G_TYPE_FROM_INSTANCE (instance), &detail, TRUE);
+ signal_id = signal_parse_name (detailed_signal, itype, &detail, TRUE);
SIGNAL_UNLOCK ();
if (signal_id)
va_end (var_args);
}
else
- g_warning ("%s: signal name `%s' is invalid for instance `%p'", G_STRLOC, detailed_signal, instance);
-}
-
-static inline gboolean
-accumulate (GSignalInvocationHint *ihint,
- GValue *return_accu,
- GValue *handler_return,
- SignalAccumulator *accumulator)
-{
- gboolean continue_emission;
-
- if (!accumulator)
- return TRUE;
-
- continue_emission = accumulator->func (ihint, return_accu, handler_return, accumulator->data);
- g_value_reset (handler_return);
-
- return continue_emission;
+ g_warning ("%s: signal name '%s' is invalid for instance '%p' of type '%s'",
+ G_STRLOC, detailed_signal, instance, g_type_name (itype));
}
static gboolean
GClosure *class_closure;
HandlerList *hlist;
Handler *handler_list = NULL;
- GValue *return_accu, accu = { 0, };
+ GValue *return_accu, accu = G_VALUE_INIT;
guint signal_id;
gulong max_sequential_handler_number;
gboolean return_value_altered = FALSE;
-#ifdef G_ENABLE_DEBUG
- IF_DEBUG (SIGNALS, g_trace_instance_signals == instance || g_trap_instance_signals == instance)
- {
- g_message ("%s::%s(%u) emitted (instance=%p, signal-node=%p)",
- g_type_name (G_TYPE_FROM_INSTANCE (instance)),
- node->name, detail,
- instance, node);
- if (g_trap_instance_signals == instance)
- 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)
{
Emission *node = emission_find (g_restart_emissions, signal_id, detail, instance);
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;
}
+static void
+add_invalid_closure_notify (Handler *handler,
+ gpointer instance)
+{
+ g_closure_add_invalidate_notifier (handler->closure, instance, invalid_closure_notify);
+ handler->has_invalid_closure_notify = 1;
+}
+
+static void
+remove_invalid_closure_notify (Handler *handler,
+ gpointer instance)
+{
+ if (handler->has_invalid_closure_notify)
+ {
+ g_closure_remove_invalidate_notifier (handler->closure, instance, invalid_closure_notify);
+ handler->has_invalid_closure_notify = 0;
+ }
+}
+
+static void
+invalid_closure_notify (gpointer instance,
+ GClosure *closure)
+{
+ Handler *handler;
+ guint signal_id;
+
+ SIGNAL_LOCK ();
+
+ handler = handler_lookup (instance, 0, closure, &signal_id);
+ g_assert (handler->closure == closure);
+
+ handler->sequential_number = 0;
+ handler->block_count = 1;
+ handler_unref_R (signal_id, instance, handler);
+
+ SIGNAL_UNLOCK ();
+}
+
static const gchar*
type_debug_name (GType type)
{
return "<invalid>";
}
+/**
+ * g_signal_accumulator_true_handled:
+ * @ihint: standard #GSignalAccumulator parameter
+ * @return_accu: standard #GSignalAccumulator parameter
+ * @handler_return: standard #GSignalAccumulator parameter
+ * @dummy: standard #GSignalAccumulator parameter
+ *
+ * A predefined #GSignalAccumulator for signals that return a
+ * boolean values. The behavior that this accumulator gives is
+ * that a return of %TRUE stops the signal emission: no further
+ * callbacks will be invoked, while a return of %FALSE allows
+ * the emission to continue. The idea here is that a %TRUE return
+ * indicates that the callback handled the signal, and no further
+ * handling is needed.
+ *
+ * Since: 2.4
+ *
+ * Returns: standard #GSignalAccumulator result
+ */
gboolean
g_signal_accumulator_true_handled (GSignalInvocationHint *ihint,
GValue *return_accu,
return continue_emission;
}
-/* --- compile standard marshallers --- */
-#include "gobject.h"
-#include "genums.h"
-#include "gmarshal.c"
-
-#define __G_SIGNAL_C__
-#include "gobjectaliasdef.c"
+/**
+ * g_signal_accumulator_first_wins:
+ * @ihint: standard #GSignalAccumulator parameter
+ * @return_accu: standard #GSignalAccumulator parameter
+ * @handler_return: standard #GSignalAccumulator parameter
+ * @dummy: standard #GSignalAccumulator parameter
+ *
+ * A predefined #GSignalAccumulator for signals intended to be used as a
+ * hook for application code to provide a particular value. Usually
+ * only one such value is desired and multiple handlers for the same
+ * signal don't make much sense (except for the case of the default
+ * handler defined in the class structure, in which case you will
+ * usually want the signal connection to override the class handler).
+ *
+ * This accumulator will use the return value from the first signal
+ * handler that is run as the return value for the signal and not run
+ * any further handlers (ie: the first handler "wins").
+ *
+ * Returns: standard #GSignalAccumulator result
+ *
+ * Since: 2.28
+ **/
+gboolean
+g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
+ GValue *return_accu,
+ const GValue *handler_return,
+ gpointer dummy)
+{
+ g_value_copy (handler_return, return_accu);
+ return FALSE;
+}
projects / platform / upstream / glib.git / blobdiff