luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-14 16:26:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

gsignal: use g_clear_signal_handler() macro to implement g_clear_signal_handler() function

Browse Source 
We have a "good" implementation of g_clear_signal_handler() in
form of a macro. Use it, and don't duplicate the code.

Also add a comment to the documentation that "instance" in fact must
not point to a valid GObject instance -- if the handler ID is unset.

Also reword the documentation about the reasoning for why a macro
version exists. The reason is not to use the function "without
pointer cast". I don't think the non-macro version requires any
pointer cast, since "instance" is a void pointer. Was this referring
to the handler_id_ptr? That doesn't seem right either, because the
caller should always provide a "gulong *" pointer and nothing else.
This commit is contained in:
Thomas Haller 2021-01-26 14:16:26 +01:00
parent 7777f3bdbe
commit 8416211231
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
gobject/gsignal.c
View File

@ -4012,6 +4012,7 @@ g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
* g_clear_signal_handler: * g_clear_signal_handler:
* @handler_id_ptr: A pointer to a handler ID (of type #gulong) of the handler to be disconnected. * @handler_id_ptr: A pointer to a handler ID (of type #gulong) of the handler to be disconnected.
* @instance: (type GObject.Object): The instance to remove the signal handler from. * @instance: (type GObject.Object): The instance to remove the signal handler from.
* This pointer may be %NULL or invalid, if the handler ID is zero.
* *
* Disconnects a handler from @instance so it will not be called during * Disconnects a handler from @instance so it will not be called during
* any future or currently ongoing emissions of the signal it has been * any future or currently ongoing emissions of the signal it has been
@ -4019,21 +4020,20 @@ g_signal_accumulator_first_wins (GSignalInvocationHint *ihint,
* *
* If the handler ID is 0 then this function does nothing. * If the handler ID is 0 then this function does nothing.
* *
* A macro is also included that allows this function to be used without * There is also a macro version of this function so that the code
* pointer casts. * will be inlined.
* *
* Since: 2.62 * Since: 2.62
*/ */
#undef g_clear_signal_handler
void void
g_clear_signal_handler (gulong *handler_id_ptr, (g_clear_signal_handler) (gulong *handler_id_ptr,
gpointer instance) gpointer instance)
{ {
g_return_if_fail (handler_id_ptr != NULL); g_return_if_fail (handler_id_ptr != NULL);
if (*handler_id_ptr != 0) #ifndef g_clear_signal_handler
{ #error g_clear_signal_handler() macro is not defined
g_signal_handler_disconnect (instance, *handler_id_ptr); #endif
*handler_id_ptr = 0;
} g_clear_signal_handler (handler_id_ptr, instance);
} }