/*
signals.c : irssi
- Copyright (C) 1999 Timo Sirainen
+ Copyright (C) 1999-2002 Timo Sirainen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
-#include "../common.h"
+#include "module.h"
#include "signals.h"
#include "modules.h"
-#define SIGNAL_LISTS 3
+typedef struct _SignalHook {
+ struct _SignalHook *next;
+
+ int priority;
+ const char *module;
+ SIGNAL_FUNC func;
+ void *user_data;
+} SignalHook;
typedef struct {
int id; /* signal id */
int emitting; /* signal is being emitted */
int stop_emit; /* this signal was stopped */
+ int continue_emit; /* this signal emit was continued elsewhere */
+ int remove_count; /* hooks were removed from signal */
- GPtrArray *modulelist[SIGNAL_LISTS]; /* list of what signals belong
- to which module */
- GPtrArray *siglist[SIGNAL_LISTS]; /* signal lists */
-} SIGNAL_REC;
+ SignalHook *hooks;
+} Signal;
-#define signal_is_emitlist_empty(a) \
- (!(a)->siglist[0] && !(a)->siglist[1] && !(a)->siglist[2])
+void *signal_user_data;
-static GMemChunk *signals_chunk;
static GHashTable *signals;
-static SIGNAL_REC *current_emitted_signal;
+static Signal *current_emitted_signal;
+static SignalHook *current_emitted_hook;
#define signal_ref(signal) ++(signal)->refcount
-#define signal_unref(rec) (signal_unref_full(rec, TRUE))
+#define signal_unref(signal) (signal_unref_full(signal, TRUE))
-static int signal_unref_full(SIGNAL_REC *rec, int remove_hash)
+static int signal_unref_full(Signal *rec, int remove)
{
- if (rec->refcount == 0) {
- g_error("signal_unref(%s) : BUG - reference counter == 0",
- signal_get_id_str(rec->id));
- }
+ g_assert(rec->refcount > 0);
if (--rec->refcount != 0)
- return FALSE;
+ return TRUE;
/* remove whole signal from memory */
- if (!signal_is_emitlist_empty(rec)) {
- g_error("signal_unref(%s) : BUG - emitlist wasn't empty",
+ if (rec->hooks != NULL) {
+ g_error("signal_unref(%s) : BUG - hook list wasn't empty",
signal_get_id_str(rec->id));
}
- if (remove_hash)
+ if (remove)
g_hash_table_remove(signals, GINT_TO_POINTER(rec->id));
- g_mem_chunk_free(signals_chunk, rec);
- return TRUE;
+ g_free(rec);
+
+ return FALSE;
}
-static void signal_unref_count(SIGNAL_REC *rec, int count)
+static void signal_hash_ref(void *key, Signal *rec)
{
- while (count-- > 0)
- signal_unref(rec);
+ signal_ref(rec);
}
-void signal_add_to(const char *module, int pos,
- const char *signal, SIGNAL_FUNC func)
+static int signal_hash_unref(void *key, Signal *rec)
{
- g_return_if_fail(signal != NULL);
+ return !signal_unref_full(rec, FALSE);
+}
- signal_add_to_id(module, pos, signal_get_uniq_id(signal), func);
+void signal_add_full(const char *module, int priority,
+ const char *signal, SIGNAL_FUNC func, void *user_data)
+{
+ signal_add_full_id(module, priority, signal_get_uniq_id(signal),
+ func, user_data);
}
/* bind a signal */
-void signal_add_to_id(const char *module, int pos,
- int signal_id, SIGNAL_FUNC func)
+void signal_add_full_id(const char *module, int priority,
+ int signal_id, SIGNAL_FUNC func, void *user_data)
{
- SIGNAL_REC *rec;
+ Signal *signal;
+ SignalHook *hook, **tmp;
g_return_if_fail(signal_id >= 0);
g_return_if_fail(func != NULL);
- g_return_if_fail(pos >= 0 && pos < SIGNAL_LISTS);
-
- rec = g_hash_table_lookup(signals, GINT_TO_POINTER(signal_id));
- if (rec == NULL) {
- rec = g_mem_chunk_alloc0(signals_chunk);
- rec->id = signal_id;
- g_hash_table_insert(signals, GINT_TO_POINTER(signal_id), rec);
- }
- if (rec->siglist[pos] == NULL) {
- rec->siglist[pos] = g_ptr_array_new();
- rec->modulelist[pos] = g_ptr_array_new();
+ signal = g_hash_table_lookup(signals, GINT_TO_POINTER(signal_id));
+ if (signal == NULL) {
+ /* new signal */
+ signal = g_new0(Signal, 1);
+ signal->id = signal_id;
+ g_hash_table_insert(signals, GINT_TO_POINTER(signal_id), signal);
}
- g_ptr_array_add(rec->siglist[pos], (void *) func);
- g_ptr_array_add(rec->modulelist[pos], (void *) module);
-
- signal_ref(rec);
-}
-
-static int signal_list_find(GPtrArray *array, void *data)
-{
- unsigned int n;
-
- for (n = 0; n < array->len; n++) {
- if (g_ptr_array_index(array, n) == data)
- return n;
+ hook = g_new0(SignalHook, 1);
+ hook->priority = priority;
+ hook->module = module;
+ hook->func = func;
+ hook->user_data = user_data;
+
+ /* insert signal to proper position in list */
+ for (tmp = &signal->hooks; ; tmp = &(*tmp)->next) {
+ if (*tmp == NULL) {
+ /* last in list */
+ *tmp = hook;
+ break;
+ } else if (priority <= (*tmp)->priority) {
+ /* insert before others with same priority */
+ hook->next = *tmp;
+ *tmp = hook;
+ break;
+ }
}
- return -1;
+ signal_ref(signal);
}
-static void signal_list_free(SIGNAL_REC *rec, int list)
+static void signal_remove_hook(Signal *rec, SignalHook **hook_pos)
{
- g_ptr_array_free(rec->siglist[list], TRUE);
- g_ptr_array_free(rec->modulelist[list], TRUE);
- rec->siglist[list] = NULL;
- rec->modulelist[list] = NULL;
-}
+ SignalHook *hook;
-/* Returns TRUE if the whole signal is removed after this remove */
-static void signal_remove_from_list(SIGNAL_REC *rec, int list, int index)
-{
- g_ptr_array_remove_index(rec->siglist[list], index);
- g_ptr_array_remove_index(rec->modulelist[list], index);
+ hook = *hook_pos;
+ *hook_pos = hook->next;
- if (rec->siglist[list]->len == 0)
- signal_list_free(rec, list);
+ g_free(hook);
signal_unref(rec);
}
-/* Remove signal from emit lists */
-static int signal_remove_from_lists(SIGNAL_REC *rec, SIGNAL_FUNC func)
+/* Remove function from signal's emit list */
+static int signal_remove_func(Signal *rec, SIGNAL_FUNC func, void *user_data)
{
- int n, index;
-
- for (n = 0; n < SIGNAL_LISTS; n++) {
- if (rec->siglist[n] == NULL)
- continue;
-
- index = signal_list_find(rec->siglist[n], (void *) func);
- if (index != -1) {
- /* remove the function from emit list */
- signal_remove_from_list(rec, n, index);
- return 1;
+ SignalHook **hook;
+
+ for (hook = &rec->hooks; *hook != NULL; hook = &(*hook)->next) {
+ if ((*hook)->func == func && (*hook)->user_data == user_data) {
+ if (rec->emitting) {
+ /* mark it removed after emitting is done */
+ (*hook)->func = NULL;
+ rec->remove_count++;
+ } else {
+ /* remove the function from emit list */
+ signal_remove_hook(rec, hook);
+ }
+ return TRUE;
}
}
- return 0;
+ return FALSE;
}
-void signal_remove_id(int signal_id, SIGNAL_FUNC func)
+void signal_remove_id(int signal_id, SIGNAL_FUNC func, void *user_data)
{
- SIGNAL_REC *rec;
+ Signal *rec;
g_return_if_fail(signal_id >= 0);
g_return_if_fail(func != NULL);
rec = g_hash_table_lookup(signals, GINT_TO_POINTER(signal_id));
if (rec != NULL)
- signal_remove_from_lists(rec, func);
+ signal_remove_func(rec, func, user_data);
}
/* unbind signal */
-void signal_remove(const char *signal, SIGNAL_FUNC func)
+void signal_remove_full(const char *signal, SIGNAL_FUNC func, void *user_data)
{
g_return_if_fail(signal != NULL);
- signal_remove_id(signal_get_uniq_id(signal), func);
+ signal_remove_id(signal_get_uniq_id(signal), func, user_data);
+}
+
+static void signal_hooks_clean(Signal *rec)
+{
+ SignalHook **hook, **next;
+ int count;
+
+ count = rec->remove_count;
+ rec->remove_count = 0;
+
+ for (hook = &rec->hooks; *hook != NULL; hook = next) {
+ next = &(*hook)->next;
+
+ if ((*hook)->func == NULL) {
+ next = hook;
+ signal_remove_hook(rec, hook);
+
+ if (--count == 0)
+ break;
+ }
+ }
}
-static int signal_emit_real(SIGNAL_REC *rec, int params, va_list va)
+static int signal_emit_real(Signal *rec, int params, va_list va,
+ SignalHook *first_hook)
{
- gconstpointer arglist[SIGNAL_MAX_ARGUMENTS];
- SIGNAL_REC *prev_emitted_signal;
- SIGNAL_FUNC func;
- int n, index, stopped, stop_emit_count;
+ const void *arglist[SIGNAL_MAX_ARGUMENTS];
+ Signal *prev_emitted_signal;
+ SignalHook *hook, *prev_emitted_hook;
+ int i, stopped, stop_emit_count, continue_emit_count;
- for (n = 0; n < SIGNAL_MAX_ARGUMENTS; n++)
- arglist[n] = n >= params ? NULL : va_arg(va, gconstpointer);
+ for (i = 0; i < SIGNAL_MAX_ARGUMENTS; i++)
+ arglist[i] = i >= params ? NULL : va_arg(va, const void *);
/* signal_stop_by_name("signal"); signal_emit("signal", ...);
fails if we compare rec->stop_emit against 0. */
stop_emit_count = rec->stop_emit;
+ continue_emit_count = rec->continue_emit;
signal_ref(rec);
stopped = FALSE;
rec->emitting++;
- for (n = 0; n < SIGNAL_LISTS; n++) {
- /* run signals in emit lists */
- if (rec->siglist[n] == NULL)
- continue;
- for (index = rec->siglist[n]->len-1; index >= 0; index--) {
- func = (SIGNAL_FUNC) g_ptr_array_index(rec->siglist[n], index);
+ prev_emitted_signal = current_emitted_signal;
+ prev_emitted_hook = current_emitted_hook;
+ current_emitted_signal = rec;
- prev_emitted_signal = current_emitted_signal;
- current_emitted_signal = rec;
+ for (hook = first_hook; hook != NULL; hook = hook->next) {
+ if (hook->func == NULL)
+ continue; /* removed */
+
+ current_emitted_hook = hook;
#if SIGNAL_MAX_ARGUMENTS != 6
# error SIGNAL_MAX_ARGUMENTS changed - update code
#endif
- func(arglist[0], arglist[1], arglist[2], arglist[3], arglist[4], arglist[5]);
- current_emitted_signal = prev_emitted_signal;
-
- if (rec->stop_emit != stop_emit_count) {
- stopped = TRUE;
- rec->stop_emit--;
- n = SIGNAL_LISTS;
- break;
- }
+ signal_user_data = hook->user_data;
+ hook->func(arglist[0], arglist[1], arglist[2], arglist[3],
+ arglist[4], arglist[5]);
+
+ if (rec->continue_emit != continue_emit_count)
+ rec->continue_emit--;
+
+ if (rec->stop_emit != stop_emit_count) {
+ stopped = TRUE;
+ rec->stop_emit--;
+ break;
}
}
+
+ current_emitted_signal = prev_emitted_signal;
+ current_emitted_hook = prev_emitted_hook;
+
rec->emitting--;
+ signal_user_data = NULL;
if (!rec->emitting) {
- if (rec->stop_emit != 0) {
- /* signal_stop() used too many times */
- rec->stop_emit = 0;
- }
+ g_assert(rec->stop_emit == 0);
+ g_assert(rec->continue_emit == 0);
+
+ if (rec->remove_count > 0)
+ signal_hooks_clean(rec);
}
signal_unref(rec);
int signal_emit(const char *signal, int params, ...)
{
- SIGNAL_REC *rec;
+ Signal *rec;
va_list va;
int signal_id;
rec = g_hash_table_lookup(signals, GINT_TO_POINTER(signal_id));
if (rec != NULL) {
va_start(va, params);
- signal_emit_real(rec, params, va);
+ signal_emit_real(rec, params, va, rec->hooks);
va_end(va);
}
int signal_emit_id(int signal_id, int params, ...)
{
- SIGNAL_REC *rec;
+ Signal *rec;
va_list va;
g_return_val_if_fail(signal_id >= 0, FALSE);
rec = g_hash_table_lookup(signals, GINT_TO_POINTER(signal_id));
if (rec != NULL) {
va_start(va, params);
- signal_emit_real(rec, params, va);
+ signal_emit_real(rec, params, va, rec->hooks);
va_end(va);
}
return rec != NULL;
}
+void signal_continue(int params, ...)
+{
+ Signal *rec;
+ va_list va;
+
+ rec = current_emitted_signal;
+ if (rec == NULL || rec->emitting <= rec->continue_emit)
+ g_warning("signal_continue() : no signals are being emitted currently");
+ else {
+ va_start(va, params);
+
+ /* stop the signal */
+ if (rec->emitting > rec->stop_emit)
+ rec->stop_emit++;
+
+ /* re-emit */
+ rec->continue_emit++;
+ signal_emit_real(rec, params, va, current_emitted_hook->next);
+ va_end(va);
+ }
+}
+
/* stop the current ongoing signal emission */
void signal_stop(void)
{
- SIGNAL_REC *rec;
+ Signal *rec;
rec = current_emitted_signal;
if (rec == NULL)
/* stop ongoing signal emission by signal name */
void signal_stop_by_name(const char *signal)
{
- SIGNAL_REC *rec;
+ Signal *rec;
int signal_id;
signal_id = signal_get_uniq_id(signal);
/* return the ID of the signal that is currently being emitted */
int signal_get_emitted_id(void)
{
- SIGNAL_REC *rec;
+ Signal *rec;
rec = current_emitted_signal;
g_return_val_if_fail(rec != NULL, -1);
/* return TRUE if specified signal was stopped */
int signal_is_stopped(int signal_id)
{
- SIGNAL_REC *rec;
+ Signal *rec;
rec = g_hash_table_lookup(signals, GINT_TO_POINTER(signal_id));
g_return_val_if_fail(rec != NULL, FALSE);
return rec->emitting <= rec->stop_emit;
}
-static void signal_remove_module(void *signal, SIGNAL_REC *rec,
+static void signal_remove_module(void *signal, Signal *rec,
const char *module)
{
- unsigned int index;
- int list;
+ SignalHook **hook, **next;
- for (list = 0; list < SIGNAL_LISTS; list++) {
- if (rec->modulelist[list] == NULL)
- continue;
+ for (hook = &rec->hooks; *hook != NULL; hook = next) {
+ next = &(*hook)->next;
- for (index = rec->modulelist[list]->len; index > 0; index--)
- if (g_strcasecmp(g_ptr_array_index(rec->modulelist[list], index-1), module) == 0)
- signal_remove_from_list(rec, list, index-1);
+ if (strcasecmp((*hook)->module, module) == 0) {
+ next = hook;
+ signal_remove_hook(rec, hook);
+ }
}
}
-static void signal_foreach_ref(void *signal, SIGNAL_REC *rec)
-{
- signal_ref(rec);
-}
-
-static int signal_foreach_unref(void *signal, SIGNAL_REC *rec)
-{
- return signal_unref_full(rec, FALSE);
-}
-
/* remove all signals that belong to `module' */
void signals_remove_module(const char *module)
{
g_return_if_fail(module != NULL);
- g_hash_table_foreach(signals, (GHFunc) signal_foreach_ref, NULL);
- g_hash_table_foreach(signals, (GHFunc) signal_remove_module, (void *) module);
- g_hash_table_foreach_remove(signals, (GHRFunc) signal_foreach_unref, NULL);
+ g_hash_table_foreach(signals, (GHFunc) signal_hash_ref, NULL);
+ g_hash_table_foreach(signals, (GHFunc) signal_remove_module,
+ (void *) module);
+ g_hash_table_foreach_remove(signals, (GHRFunc) signal_hash_unref, NULL);
}
void signals_init(void)
{
- signals_chunk = g_mem_chunk_new("signals", sizeof(SIGNAL_REC),
- sizeof(SIGNAL_REC)*200, G_ALLOC_AND_FREE);
- signals = g_hash_table_new((GHashFunc) g_direct_hash, (GCompareFunc) g_direct_equal);
+ signals = g_hash_table_new(NULL, NULL);
}
-static void signal_free(void *key, SIGNAL_REC *rec)
+static void signal_free(void *key, Signal *rec)
{
- int n;
+ /* refcount-1 because we just referenced it ourself */
+ g_warning("signal_free(%s) : signal still has %d references:",
+ signal_get_id_str(rec->id), rec->refcount-1);
- signal_ref(rec);
-
- for (n = 0; n < SIGNAL_LISTS; n++) {
- if (rec->siglist[n] != NULL) {
- signal_unref_count(rec, rec->siglist[n]->len);
- signal_list_free(rec, n);
- }
- }
+ while (rec->hooks != NULL) {
+ g_warning(" - module '%s' function %p",
+ rec->hooks->module, rec->hooks->func);
- if (!signal_unref_full(rec, FALSE)) {
- g_error("signal_free(%s) : BUG - signal still has %d references",
- signal_get_id_str(rec->id), rec->refcount);
+ signal_remove_hook(rec, &rec->hooks);
}
}
void signals_deinit(void)
{
- g_hash_table_foreach(signals, (GHFunc) signal_free, NULL);
+ g_hash_table_foreach(signals, (GHFunc) signal_hash_ref, NULL);
+ g_hash_table_foreach(signals, (GHFunc) signal_free, NULL);
+ g_hash_table_foreach_remove(signals, (GHRFunc) signal_hash_unref, NULL);
g_hash_table_destroy(signals);
module_uniq_destroy("signals");
- g_mem_chunk_destroy(signals_chunk);
}