summaryrefslogtreecommitdiff
path: root/src/core/hook/hook-signal.c
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2024-03-12 21:09:42 +0100
committerSébastien Helleu <flashcode@flashtux.org>2024-03-12 21:27:37 +0100
commit24c4029c96fa04b3cb4f90fbb36dc5248dd39810 (patch)
treeca51727f97207117f335f0309c063ffd2f168f2d /src/core/hook/hook-signal.c
parentbb346f8c6c62655a6ef8fe4bc848d179258ce008 (diff)
downloadweechat-24c4029c96fa04b3cb4f90fbb36dc5248dd39810.zip
core: remove "wee-" prefix from source files in src/core and src/core/hook
Diffstat (limited to 'src/core/hook/hook-signal.c')
-rw-r--r--src/core/hook/hook-signal.c243
1 files changed, 243 insertions, 0 deletions
diff --git a/src/core/hook/hook-signal.c b/src/core/hook/hook-signal.c
new file mode 100644
index 000000000..837db2e67
--- /dev/null
+++ b/src/core/hook/hook-signal.c
@@ -0,0 +1,243 @@
+/*
+ * hook-signal.c - WeeChat signal hook
+ *
+ * Copyright (C) 2003-2024 Sébastien Helleu <flashcode@flashtux.org>
+ *
+ * This file is part of WeeChat, the extensible chat client.
+ *
+ * WeeChat is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * WeeChat is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with WeeChat. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "../weechat.h"
+#include "../core-hook.h"
+#include "../core-infolist.h"
+#include "../core-log.h"
+#include "../core-string.h"
+#include "../../plugins/plugin.h"
+
+
+/*
+ * Returns description of hook.
+ *
+ * Note: result must be freed after use.
+ */
+
+char *
+hook_signal_get_description (struct t_hook *hook)
+{
+ return string_rebuild_split_string (
+ (const char **)(HOOK_SIGNAL(hook, signals)), ";", 0, -1);
+}
+
+/*
+ * Hooks a signal.
+ *
+ * Returns pointer to new hook, NULL if error.
+ */
+
+struct t_hook *
+hook_signal (struct t_weechat_plugin *plugin, const char *signal,
+ t_hook_callback_signal *callback,
+ const void *callback_pointer,
+ void *callback_data)
+{
+ struct t_hook *new_hook;
+ struct t_hook_signal *new_hook_signal;
+ int priority;
+ const char *ptr_signal;
+
+ if (!signal || !signal[0] || !callback)
+ return NULL;
+
+ new_hook = malloc (sizeof (*new_hook));
+ if (!new_hook)
+ return NULL;
+ new_hook_signal = malloc (sizeof (*new_hook_signal));
+ if (!new_hook_signal)
+ {
+ free (new_hook);
+ return NULL;
+ }
+
+ string_get_priority_and_name (signal, &priority, &ptr_signal,
+ HOOK_PRIORITY_DEFAULT);
+ hook_init_data (new_hook, plugin, HOOK_TYPE_SIGNAL, priority,
+ callback_pointer, callback_data);
+
+ new_hook->hook_data = new_hook_signal;
+ new_hook_signal->callback = callback;
+ new_hook_signal->signals = string_split (
+ (ptr_signal) ? ptr_signal : signal,
+ ";",
+ NULL,
+ WEECHAT_STRING_SPLIT_STRIP_LEFT
+ | WEECHAT_STRING_SPLIT_STRIP_RIGHT
+ | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS,
+ 0, &new_hook_signal->num_signals);
+
+ hook_add_to_list (new_hook);
+
+ return new_hook;
+}
+
+/*
+ * Checks if a hooked signal matches a signal sent: it matches if at least
+ * one of the signal masks are matching the signal sent.
+ *
+ * Returns:
+ * 1: hook matches signal sent
+ * 0: hook does not match signal sent
+ */
+
+int
+hook_signal_match (const char *signal, struct t_hook *hook)
+{
+ int i;
+
+ for (i = 0; i < HOOK_SIGNAL(hook, num_signals); i++)
+ {
+ if (string_match (signal, HOOK_SIGNAL(hook, signals)[i], 0))
+ return 1;
+ }
+
+ return 0;
+}
+
+/*
+ * Sends a signal.
+ */
+
+int
+hook_signal_send (const char *signal, const char *type_data, void *signal_data)
+{
+ struct t_hook *ptr_hook, *next_hook;
+ struct t_hook_exec_cb hook_exec_cb;
+ int rc;
+
+ rc = WEECHAT_RC_OK;
+
+ hook_exec_start ();
+
+ ptr_hook = weechat_hooks[HOOK_TYPE_SIGNAL];
+ while (ptr_hook)
+ {
+ next_hook = ptr_hook->next_hook;
+
+ if (!ptr_hook->deleted
+ && !ptr_hook->running
+ && hook_signal_match (signal, ptr_hook))
+ {
+ hook_callback_start (ptr_hook, &hook_exec_cb);
+ rc = (HOOK_SIGNAL(ptr_hook, callback))
+ (ptr_hook->callback_pointer,
+ ptr_hook->callback_data,
+ signal,
+ type_data,
+ signal_data);
+ hook_callback_end (ptr_hook, &hook_exec_cb);
+
+ if (rc == WEECHAT_RC_OK_EAT)
+ break;
+ }
+
+ ptr_hook = next_hook;
+ }
+
+ hook_exec_end ();
+
+ return rc;
+}
+
+/*
+ * Frees data in a signal hook.
+ */
+
+void
+hook_signal_free_data (struct t_hook *hook)
+{
+ if (!hook || !hook->hook_data)
+ return;
+
+ if (HOOK_SIGNAL(hook, signals))
+ {
+ string_free_split (HOOK_SIGNAL(hook, signals));
+ HOOK_SIGNAL(hook, signals) = NULL;
+ }
+ HOOK_SIGNAL(hook, num_signals) = 0;
+
+ free (hook->hook_data);
+ hook->hook_data = NULL;
+}
+
+/*
+ * Adds signal hook data in the infolist item.
+ *
+ * Returns:
+ * 1: OK
+ * 0: error
+ */
+
+int
+hook_signal_add_to_infolist (struct t_infolist_item *item,
+ struct t_hook *hook)
+{
+ int i;
+ char option_name[64];
+
+ if (!item || !hook || !hook->hook_data)
+ return 0;
+
+ if (!infolist_new_var_pointer (item, "callback", HOOK_SIGNAL(hook, callback)))
+ return 0;
+ for (i = 0; i < HOOK_SIGNAL(hook, num_signals); i++)
+ {
+ snprintf (option_name, sizeof (option_name), "signal_%05d", i);
+ if (!infolist_new_var_string (item, option_name,
+ HOOK_SIGNAL(hook, signals)[i]))
+ return 0;
+ }
+ if (!infolist_new_var_integer (item, "num_signals",
+ HOOK_SIGNAL(hook, num_signals)))
+ return 0;
+
+ return 1;
+}
+
+/*
+ * Prints signal hook data in WeeChat log file (usually for crash dump).
+ */
+
+void
+hook_signal_print_log (struct t_hook *hook)
+{
+ int i;
+
+ if (!hook || !hook->hook_data)
+ return;
+
+ log_printf (" signal data:");
+ log_printf (" callback. . . . . . . : 0x%lx", HOOK_SIGNAL(hook, callback));
+ log_printf (" signals:");
+ for (i = 0; i < HOOK_SIGNAL(hook, num_signals); i++)
+ {
+ log_printf (" '%s'", HOOK_SIGNAL(hook, signals)[i]);
+ }
+}