4 Copyright (C) 1999-2001 Timo Sirainen
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "module-formats.h"
27 #include "lib-config/iconfig.h"
31 #include "fe-windows.h"
32 #include "printtext.h"
35 static GHashTable *keys, *default_keys;
37 /* A cache of some sort for key presses that generate a single char only.
38 If the key isn't used, used_keys[key] is zero. */
39 static char used_keys[256];
41 /* Contains a list of all possible executable key bindings (not "key" keys).
42 Format is _always_ in key1-key2-key3 format and fully extracted, like
44 static GTree *key_states;
45 static int key_config_frozen;
47 struct _KEYBOARD_REC {
48 char *key_state; /* the ongoing key combo */
49 void *gui_data; /* GUI specific data sent in "key pressed" signal */
52 /* Creates a new "keyboard" - this is used only for keeping track of
53 key combo states and sending the gui_data parameter in "key pressed"
55 KEYBOARD_REC *keyboard_create(void *data)
59 rec = g_new0(KEYBOARD_REC, 1);
62 signal_emit("keyboard created", 1, rec);
66 /* Destroys a keyboard */
67 void keyboard_destroy(KEYBOARD_REC *keyboard)
69 signal_emit("keyboard destroyed", 1, keyboard);
71 g_free_not_null(keyboard->key_state);
75 static void key_destroy(KEY_REC *rec, GHashTable *hash)
77 g_hash_table_remove(hash, rec->key);
79 g_free_not_null(rec->data);
84 static void key_default_add(const char *id, const char *key, const char *data)
89 info = key_info_find(id);
93 rec = g_hash_table_lookup(default_keys, key);
95 /* key already exists, replace */
96 rec->info->default_keys =
97 g_slist_remove(rec->info->default_keys, rec);
98 key_destroy(rec, default_keys);
101 rec = g_new0(KEY_REC, 1);
102 rec->key = g_strdup(key);
104 rec->data = g_strdup(data);
105 info->default_keys = g_slist_append(info->default_keys, rec);
106 g_hash_table_insert(default_keys, rec->key, rec);
109 static CONFIG_NODE *key_config_find(const char *key)
114 /* remove old keyboard settings */
115 node = iconfig_node_traverse("(keyboard", TRUE);
117 tmp = config_node_first(node->value);
118 for (; tmp != NULL; tmp = config_node_next(tmp)) {
121 if (strcmp(config_node_get_str(node, "key", ""), key) == 0)
128 static void keyconfig_save(const char *id, const char *key, const char *data)
132 g_return_if_fail(id != NULL);
133 g_return_if_fail(key != NULL);
135 node = key_config_find(key);
137 node = iconfig_node_traverse("(keyboard", TRUE);
138 node = config_node_section(node, NULL, NODE_TYPE_BLOCK);
141 iconfig_node_set_str(node, "key", key);
142 iconfig_node_set_str(node, "id", id);
143 iconfig_node_set_str(node, "data", data);
146 static void keyconfig_clear(const char *key)
150 g_return_if_fail(key != NULL);
152 /* remove old keyboard settings */
153 node = key_config_find(key);
155 iconfig_node_remove(iconfig_node_traverse("(keyboard", FALSE),
160 KEYINFO_REC *key_info_find(const char *id)
164 for (tmp = keyinfos; tmp != NULL; tmp = tmp->next) {
165 KEYINFO_REC *rec = tmp->data;
167 if (g_strcasecmp(rec->id, id) == 0)
174 static int expand_key(const char *key, GSList **out);
176 #define expand_out_char(out, c) \
179 for (tmp = out; tmp != NULL; tmp = tmp->next) \
180 g_string_append_c(tmp->data, c); \
183 #define expand_out_free(out) \
186 for (tmp = out; tmp != NULL; tmp = tmp->next) \
187 g_string_free(tmp->data, TRUE); \
188 g_slist_free(out); out = NULL; \
191 static int expand_combo(const char *start, const char *end, GSList **out)
195 GSList *tmp, *tmp2, *list, *copy, *newout;
200 expand_out_char(*out, *start);
204 info = key_info_find("key");
208 /* get list of all key combos that generate the named combo.. */
210 str = g_strndup(start, (int) (end-start)+1);
211 for (tmp = info->keys; tmp != NULL; tmp = tmp->next) {
212 KEY_REC *rec = tmp->data;
214 if (strcmp(rec->data, str) == 0)
215 list = g_slist_append(list, rec);
219 /* unknown keycombo - add it as-is, maybe the GUI will
220 feed it to us as such */
221 for (p = str; *p != '\0'; p++)
222 expand_out_char(*out, *p);
228 if (list->next == NULL) {
229 /* only one way to generate the combo, good */
232 return expand_key(rec->key, out);
235 /* multiple ways to generate the combo -
236 we'll need to include all of them in output */
238 for (tmp = list->next; tmp != NULL; tmp = tmp->next) {
239 KEY_REC *rec = tmp->data;
242 for (tmp2 = *out; tmp2 != NULL; tmp2 = tmp2->next) {
243 GString *str = tmp2->data;
244 copy = g_slist_append(copy, g_string_new(str->str));
247 if (!expand_key(rec->key, ©)) {
248 /* illegal key combo, remove from list */
249 expand_out_free(copy);
251 newout = g_slist_concat(newout, copy);
257 if (!expand_key(rec->key, out)) {
258 /* illegal key combo, remove from list */
259 expand_out_free(*out);
262 *out = g_slist_concat(*out, newout);
266 /* Expand key code - returns TRUE if successful. */
267 static int expand_key(const char *key, GSList **out)
273 /* meta-^W^Gf -> ^[-^W-^G-f */
274 start = NULL; last_hyphen = TRUE;
275 for (; *key != '\0'; key++) {
277 if (i_isalnum(*key) || *key == '_') {
278 /* key combo continues */
282 if (!expand_combo(start, key-1, out))
284 expand_out_char(*out, '-');
290 expand_out_char(*out, '-');
291 expand_out_char(*out, '-');
293 last_hyphen = !last_hyphen;
294 } else if (*key == '^') {
299 expand_out_char(*out, '^');
300 expand_out_char(*out, *key);
301 expand_out_char(*out, '-');
302 last_hyphen = FALSE; /* optional */
303 } else if (last_hyphen && i_isalpha(*key)) {
304 /* possibly beginning of keycombo */
308 expand_out_char(*out, *key);
309 expand_out_char(*out, '-');
310 last_hyphen = FALSE; /* optional */
315 return expand_combo(start, key-1, out);
317 for (tmp = *out; tmp != NULL; tmp = tmp->next) {
318 GString *str = tmp->data;
320 g_string_truncate(str, str->len-1);
326 static void key_states_scan_key(const char *key, KEY_REC *rec)
330 if (strcmp(rec->info->id, "key") == 0)
333 out = g_slist_append(NULL, g_string_new(NULL));
334 if (expand_key(key, &out)) {
335 for (tmp = out; tmp != NULL; tmp = tmp->next) {
336 GString *str = tmp->data;
338 if (str->str[1] == '-' || str->str[1] == '\0')
339 used_keys[(int)(unsigned char)str->str[0]] = 1;
341 g_tree_insert(key_states, g_strdup(str->str), rec);
345 expand_out_free(out);
348 static int key_state_destroy(char *key)
354 /* Rescan all the key combos and figure out which characters are supposed
355 to be treated as characters and which as key combos.
356 Yes, this is pretty slow function... */
357 static void key_states_rescan(void)
361 memset(used_keys, 0, sizeof(used_keys));
363 g_tree_traverse(key_states, (GTraverseFunc) key_state_destroy,
365 g_tree_destroy(key_states);
366 key_states = g_tree_new((GCompareFunc) strcmp);
368 temp = g_string_new(NULL);
369 g_hash_table_foreach(keys, (GHFunc) key_states_scan_key, temp);
370 g_string_free(temp, TRUE);
373 void key_configure_freeze(void)
378 void key_configure_thaw(void)
380 g_return_if_fail(key_config_frozen > 0);
382 if (--key_config_frozen == 0)
386 static void key_configure_destroy(KEY_REC *rec)
388 g_return_if_fail(rec != NULL);
390 rec->info->keys = g_slist_remove(rec->info->keys, rec);
391 g_hash_table_remove(keys, rec->key);
393 signal_emit("key destroyed", 1, rec);
395 if (!key_config_frozen)
398 g_free_not_null(rec->data);
403 /* Configure new key */
404 static void key_configure_create(const char *id, const char *key,
410 g_return_if_fail(id != NULL);
411 g_return_if_fail(key != NULL && *key != '\0');
413 info = key_info_find(id);
417 rec = g_hash_table_lookup(keys, key);
419 key_configure_destroy(rec);
421 rec = g_new0(KEY_REC, 1);
422 rec->key = g_strdup(key);
424 rec->data = g_strdup(data);
425 info->keys = g_slist_append(info->keys, rec);
426 g_hash_table_insert(keys, rec->key, rec);
428 signal_emit("key created", 1, rec);
430 if (!key_config_frozen)
434 /* Bind a key for function */
435 void key_bind(const char *id, const char *description,
436 const char *key_default, const char *data, SIGNAL_FUNC func)
441 g_return_if_fail(id != NULL);
443 /* create key info record */
444 info = key_info_find(id);
446 g_return_if_fail(func != NULL);
448 if (description == NULL)
449 g_warning("key_bind(%s) should have description!", id);
450 info = g_new0(KEYINFO_REC, 1);
451 info->id = g_strdup(id);
452 info->description = g_strdup(description);
453 keyinfos = g_slist_append(keyinfos, info);
456 key = g_strconcat("key ", id, NULL);
457 signal_add(key, func);
460 signal_emit("keyinfo created", 1, info);
463 if (key_default != NULL && *key_default != '\0') {
464 key_default_add(id, key_default, data);
465 key_configure_create(id, key_default, data);
469 static void keyinfo_remove(KEYINFO_REC *info)
471 g_return_if_fail(info != NULL);
473 keyinfos = g_slist_remove(keyinfos, info);
474 signal_emit("keyinfo destroyed", 1, info);
476 /* destroy all keys */
477 g_slist_foreach(info->keys, (GFunc) key_destroy, keys);
478 g_slist_foreach(info->default_keys, (GFunc) key_destroy, default_keys);
480 /* destroy key info */
481 g_slist_free(info->keys);
482 g_slist_free(info->default_keys);
483 g_free_not_null(info->description);
489 void key_unbind(const char *id, SIGNAL_FUNC func)
494 g_return_if_fail(id != NULL);
495 g_return_if_fail(func != NULL);
498 info = key_info_find(id);
500 keyinfo_remove(info);
503 key = g_strconcat("key ", id, NULL);
504 signal_remove(key, func);
508 /* Configure new key */
509 void key_configure_add(const char *id, const char *key, const char *data)
511 g_return_if_fail(id != NULL);
512 g_return_if_fail(key != NULL && *key != '\0');
514 key_configure_create(id, key, data);
515 keyconfig_save(id, key, data);
519 void key_configure_remove(const char *key)
523 g_return_if_fail(key != NULL);
525 rec = g_hash_table_lookup(keys, key);
526 if (rec == NULL) return;
528 keyconfig_clear(key);
529 key_configure_destroy(rec);
532 static int key_emit_signal(KEYBOARD_REC *keyboard, KEY_REC *key)
537 str = g_strconcat("key ", key->info->id, NULL);
538 consumed = signal_emit(str, 3, key->data, keyboard->gui_data, key->info);
544 static int key_states_search(const unsigned char *combo,
545 const unsigned char *search)
547 while (*search != '\0') {
548 if (*combo != *search)
549 return *search - *combo;
556 int key_pressed(KEYBOARD_REC *keyboard, const char *key)
560 int first_key, consumed;
562 g_return_val_if_fail(keyboard != NULL, FALSE);
563 g_return_val_if_fail(key != NULL && *key != '\0', FALSE);
565 if (keyboard->key_state == NULL && key[1] == '\0' &&
566 !used_keys[(int) (unsigned char) key[0]]) {
567 /* fast check - key not used */
571 first_key = keyboard->key_state == NULL;
572 combo = keyboard->key_state == NULL ? g_strdup(key) :
573 g_strconcat(keyboard->key_state, "-", key, NULL);
574 g_free_and_null(keyboard->key_state);
576 rec = g_tree_search(key_states,
577 (GCompareFunc) key_states_search,
580 /* unknown key combo, eat the invalid key
581 unless it was the first key pressed */
583 return first_key ? -1 : 1;
586 if (g_tree_lookup(key_states, combo) != rec) {
587 /* key combo continues.. */
588 keyboard->key_state = combo;
592 /* finished key combo, execute */
594 consumed = key_emit_signal(keyboard, rec);
596 /* never consume non-control characters */
597 return consumed ? 1 : -1;
600 void keyboard_entry_redirect(SIGNAL_FUNC func, const char *entry,
601 int flags, void *data)
603 signal_emit("gui entry redirect", 4, func, entry,
604 GINT_TO_POINTER(flags), data);
607 static void sig_command(const char *data)
609 const char *cmdchars;
612 cmdchars = settings_get_str("cmdchars");
613 str = strchr(cmdchars, *data) != NULL ? g_strdup(data) :
614 g_strdup_printf("%c%s", *cmdchars, data);
616 signal_emit("send command", 3, str, active_win->active_server, active_win->active);
621 static void sig_key(const char *data)
623 /* we should never get here */
626 static void sig_multi(const char *data, void *gui_data)
629 char **list, **tmp, *p, *str;
631 list = g_strsplit(data, ";", -1);
632 for (tmp = list; *tmp != NULL; tmp++) {
633 p = strchr(*tmp, ' ');
634 if (p != NULL) *p++ = '\0'; else p = "";
636 info = key_info_find(*tmp);
638 str = g_strconcat("key ", info->id, NULL);
639 signal_emit(str, 3, p, gui_data, info);
646 static void sig_nothing(const char *data)
650 static void cmd_show_keys(const char *searchkey, int full)
655 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_BIND_HEADER);
657 len = searchkey == NULL ? 0 : strlen(searchkey);
658 for (info = keyinfos; info != NULL; info = info->next) {
659 KEYINFO_REC *rec = info->data;
661 for (key = rec->keys; key != NULL; key = key->next) {
662 KEY_REC *rec = key->data;
664 if ((len == 0 || g_strncasecmp(rec->key, searchkey, len) == 0) &&
665 (!full || rec->key[len] == '\0')) {
666 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_BIND_LIST,
667 rec->key, rec->info->id, rec->data == NULL ? "" : rec->data);
672 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_BIND_FOOTER);
675 /* SYNTAX: BIND [-list] [-delete] [<key> [<command> [<data>]]] */
676 static void cmd_bind(const char *data)
679 char *key, *id, *keydata;
683 if (!cmd_get_params(data, &free_arg, 3 | PARAM_FLAG_GETREST | PARAM_FLAG_OPTIONS,
684 "bind", &optlist, &key, &id, &keydata))
687 if (g_hash_table_lookup(optlist, "list")) {
690 for (tmp = keyinfos; tmp != NULL; tmp = tmp->next) {
691 KEYINFO_REC *rec = tmp->data;
693 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_BIND_COMMAND_LIST,
694 rec->id, rec->description ? rec->description : "");
696 cmd_params_free(free_arg);
700 if (*key != '\0' && g_hash_table_lookup(optlist, "delete")) {
702 key_configure_remove(key);
703 cmd_params_free(free_arg);
708 /* show some/all keys */
709 cmd_show_keys(key, FALSE);
710 cmd_params_free(free_arg);
714 command_id = strchr(settings_get_str("cmdchars"), *id) != NULL;
716 /* using shortcut to command id */
717 keydata = g_strconcat(id+1, " ", keydata, NULL);
721 if (key_info_find(id) == NULL)
722 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_BIND_UNKNOWN_ID, id);
724 key_configure_add(id, key, keydata);
725 cmd_show_keys(key, TRUE);
728 if (command_id) g_free(keydata);
729 cmd_params_free(free_arg);
732 static GList *completion_get_keyinfos(const char *info)
738 list = NULL; len = strlen(info);
739 for (tmp = keyinfos; tmp != NULL; tmp = tmp->next) {
740 KEYINFO_REC *rec = tmp->data;
742 if (g_strncasecmp(rec->id, info, len) == 0)
743 list = g_list_append(list, g_strdup(rec->id));
749 static void sig_complete_bind(GList **list, WINDOW_REC *window,
750 const char *word, const char *line,
753 g_return_if_fail(list != NULL);
754 g_return_if_fail(word != NULL);
755 g_return_if_fail(line != NULL);
757 if (*line == '\0' || strchr(line, ' ') != NULL)
760 *list = completion_get_keyinfos(word);
761 if (*list != NULL) signal_stop();
764 static int key_destroy_hash(const char *key, KEY_REC *rec)
766 rec->info->keys = g_slist_remove(rec->info->keys, rec);
768 g_free_not_null(rec->data);
774 static void key_copy_default(const char *key, KEY_REC *orig)
778 rec = g_new0(KEY_REC, 1);
779 rec->key = g_strdup(orig->key);
780 rec->info = orig->info;
781 rec->data = g_strdup(orig->data);
783 rec->info->keys = g_slist_append(rec->info->keys, rec);
784 g_hash_table_insert(keys, rec->key, rec);
787 static void keyboard_reset_defaults(void)
789 g_hash_table_foreach_remove(keys, (GHRFunc) key_destroy_hash, NULL);
790 g_hash_table_foreach(default_keys, (GHFunc) key_copy_default, NULL);
793 static void key_config_read(CONFIG_NODE *node)
795 char *key, *id, *data;
797 g_return_if_fail(node != NULL);
799 key = config_node_get_str(node, "key", NULL);
800 id = config_node_get_str(node, "id", NULL);
801 data = config_node_get_str(node, "data", NULL);
803 if (key != NULL && id != NULL)
804 key_configure_create(id, key, data);
807 static void read_keyboard_config(void)
812 key_configure_freeze();
814 keyboard_reset_defaults();
816 node = iconfig_node_traverse("keyboard", FALSE);
818 key_configure_thaw();
822 /* FIXME: backward "compatibility" - remove after irssi .99 */
823 if (node->type != NODE_TYPE_LIST) {
824 iconfig_node_remove(NULL, node);
825 key_configure_thaw();
829 tmp = config_node_first(node->value);
830 for (; tmp != NULL; tmp = config_node_next(tmp))
831 key_config_read(tmp->data);
833 key_configure_thaw();
836 void keyboard_init(void)
838 keys = g_hash_table_new((GHashFunc) g_str_hash,
839 (GCompareFunc) g_str_equal);
840 default_keys = g_hash_table_new((GHashFunc) g_str_hash,
841 (GCompareFunc) g_str_equal);
843 key_states = g_tree_new((GCompareFunc) strcmp);
844 key_config_frozen = 0;
845 memset(used_keys, 0, sizeof(used_keys));
847 key_bind("command", "Run any command", NULL, NULL, (SIGNAL_FUNC) sig_command);
848 key_bind("key", "Specify name for key binding", NULL, NULL, (SIGNAL_FUNC) sig_key);
849 key_bind("multi", "Run multiple commands", NULL, NULL, (SIGNAL_FUNC) sig_multi);
850 key_bind("nothing", "Do nothing", NULL, NULL, (SIGNAL_FUNC) sig_nothing);
852 /* read the keyboard config when all key binds are known */
853 signal_add("irssi init read settings", (SIGNAL_FUNC) read_keyboard_config);
854 signal_add("setup reread", (SIGNAL_FUNC) read_keyboard_config);
855 signal_add("complete command bind", (SIGNAL_FUNC) sig_complete_bind);
857 command_bind("bind", NULL, (SIGNAL_FUNC) cmd_bind);
858 command_set_options("bind", "delete list");
861 void keyboard_deinit(void)
863 key_unbind("command", (SIGNAL_FUNC) sig_command);
864 key_unbind("key", (SIGNAL_FUNC) sig_key);
865 key_unbind("multi", (SIGNAL_FUNC) sig_multi);
866 key_unbind("nothing", (SIGNAL_FUNC) sig_nothing);
868 while (keyinfos != NULL)
869 keyinfo_remove(keyinfos->data);
870 g_hash_table_destroy(keys);
871 g_hash_table_destroy(default_keys);
873 g_tree_traverse(key_states, (GTraverseFunc) key_state_destroy,
875 g_tree_destroy(key_states);
877 signal_remove("irssi init read settings", (SIGNAL_FUNC) read_keyboard_config);
878 signal_remove("setup reread", (SIGNAL_FUNC) read_keyboard_config);
879 signal_remove("complete command bind", (SIGNAL_FUNC) sig_complete_bind);
880 command_unbind("bind", (SIGNAL_FUNC) cmd_bind);