* 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 <string.h>
+#include <signal.h>
+
+#include "gsignal.h"
+#include "gbsearcharray.h"
+#include "gvaluecollector.h"
+#include "gvaluetypes.h"
+#include "gboxed.h"
+#include "gobject.h"
+#include "genums.h"
+#include "gobjectalias.h"
+
+
/**
* SECTION:signals
- * @Short_description: A means for customization of object behaviour and a general purpose notification mechanism
+ *
+ * @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 <emphasis>emission</emphasis>
- * 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
- * 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 basic concept of the signal system is that of the
+ * <emphasis>emission</emphasis> 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 i'm referring to those types as "object
+ * types" in the following, simply because that is the context most
+ * users will encounter signals in.
+ *
* ones and user provided ones.
* The per-object callbacks are most often referred to as "object method
* handler" or "default (signal) handler", while user provided callbacks are
* 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:
* <variablelist>
* <varlistentry><term></term><listitem><para>
* detail part of the signal specification upon connection) serves as a
* wildcard and matches any detail argument passed in to emission.
*/
-/*
- * MT safe
- */
-
-#include <config.h>
-
-#include "gsignal.h"
-
-#include "gbsearcharray.h"
-#include "gvaluecollector.h"
-#include "gvaluetypes.h"
-#include "gboxed.h"
-#include "gobject.h"
-#include "genums.h"
-
-#include "gobjectalias.h"
-
-#include <string.h>
-#include <signal.h>
/* pre allocation configurations
* @instance: 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"
+ * %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
* @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_remove_emission_hook:
* @signal_id: the id of the signal
- * @hook_id: the id of the emission hook, as returned by
+ * @hook_id: the id of the emission hook, as returned by
* g_signal_add_emission_hook()
- *
+ *
* Deletes an emission hook.
*/
void
* @signal_id_p: Location to store the signal id.
* @detail_p: 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_stop_emission_by_name:
* @instance: 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
+ *
+ * This is just like g_signal_stop_emission() except it will look up the
* signal id for you.
*/
void
* 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
+ *
+ * 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_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: Newly allocated array of signal IDs.
*/
guint*
/**
* 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.
*/
G_CONST_RETURN gchar*
* @signal_id: The signal id of the signal to query information for.
* @query: 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
/**
* g_signal_new:
* @signal_name: the name for the signal
- * @itype: the type this signal pertains to. It will also pertain to
+ * @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
+ * @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
+ * @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.
* @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
+ * @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
+ * @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.
- *
+ * 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.
- *
+ * be used, but they cannot be mixed.
+ *
* Returns: the signal id
*/
guint
/**
* g_signal_newv:
* @signal_name: the name for the signal
- * @itype: the type this signal pertains to. It will also pertain to
+ * @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
+ * @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: the function to translate arrays of parameter values to
+ * @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
+ * @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.
- *
+ *
* Creates a new signal. (This is usually done in the class initializer.)
- *
+ *
* See g_signal_new() for details on allowed signal names.
- *
+ *
* Returns: the signal id
*/
guint
/**
* g_signal_new_valist:
* @signal_name: the name for the signal
- * @itype: the type this signal pertains to. It will also pertain to
+ * @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
+ * @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: the function to translate arrays of parameter values to
+ * @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
+ * @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.
- *
+ *
* Returns: the signal id
*/
guint
/**
* g_signal_override_class_closure:
* @signal_id: the signal id
- * @instance_type: the instance type on which to override the class closure
+ * @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.
/**
* 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
+ * @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
* 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
+ * be called from an overridden class closure; see
* g_signal_override_class_closure().
*/
void
/**
* g_signal_get_invocation_hint:
* @instance: the instance to query
- *
- * Returns the invocation hint of the innermost signal emission of instance.
- *
+ *
+ * Returns the invocation hint of the innermost signal emission of instance.
+ *
* Returns: the invocation hint of the innermost signal emission.
*/
GSignalInvocationHint*
* @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
+ * @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
*/
gulong
* @instance: 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
+ * @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
*/
gulong
* @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 <literal>..._after()</literal> or
* <literal>..._swapped()</literal> variants of this function.
- *
+ *
* Returns: the handler id
*/
gulong
* g_signal_handler_block:
* @instance: 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
+ *
+ * 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
+ *
+ * The @handler_id has to be a valid signal handler id, connected to a
* signal of @instance.
*/
void
* g_signal_handler_unblock:
* @instance: 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
+ *
+ * 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_disconnect:
* @instance: 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
+ *
+ * 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
+ *
+ * The @handler_id has to be a valid signal handler id, connected to a
* signal of @instance.
*/
void
* g_signal_handler_is_connected:
* @instance: 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_find:
* @instance: The instance owning the signal handler to be found.
- * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * @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: 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_handlers_block_matched:
* @instance: The instance to block handlers from.
- * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * @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: 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
+ * 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_unblock_matched:
* @instance: The instance to unblock handlers from.
- * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * @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: 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.
* 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_disconnect_matched:
* @instance: The instance to remove handlers from.
- * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
+ * @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: 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.
- *
+ *
+ * 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
* @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.
+ *
+ * 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,
/**
* g_signal_emitv:
- * @instance_and_params: 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
+ * @instance_and_params: 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.
- *
+ *
+ * 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().
*/
* @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.
- *
+ *
+ * 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().
*/
* @...: 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.
- *
+ *
+ * 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().
*/
* @...: 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.
- *
+ *
+ * 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().
*/
* @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
* the emission to coninue. The idea here is that a %TRUE return
* indicates that the callback <emphasis>handled</emphasis> the signal,
* and no further handling is needed.
- *
+ *
* Since: 2.4
+ *
* Returns: standard #GSignalAccumulator result
*/
gboolean
}
/* --- compile standard marshallers --- */
-#include "gmarshal.c"
+#include "gmarshal.c"
#define __G_SIGNAL_C__
#include "gobjectaliasdef.c"
projects / platform / upstream / glib.git / blobdiff