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
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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;
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);
222 if (list->next == NULL) {
223 /* only one way to generate the combo, good */
225 return expand_key(rec->key, out);
228 /* multiple ways to generate the combo -
229 we'll need to include all of them in output */
231 for (tmp = list->next; tmp != NULL; tmp = tmp->next) {
232 KEY_REC *rec = tmp->data;
235 for (tmp2 = *out; tmp2 != NULL; tmp2 = tmp2->next) {
236 GString *str = tmp2->data;
237 copy = g_slist_append(copy, g_string_new(str->str));
240 if (!expand_key(rec->key, ©)) {
241 /* illegal key combo, remove from list */
242 expand_out_free(copy);
244 newout = g_slist_concat(newout, copy);
249 if (!expand_key(rec->key, out)) {
250 /* illegal key combo, remove from list */
251 expand_out_free(*out);
254 *out = g_slist_concat(*out, newout);
258 /* Expand key code - returns TRUE if successful. */
259 static int expand_key(const char *key, GSList **out)
265 /* meta-^W^Gf -> ^[-^W-^G-f */
266 start = NULL; last_hyphen = TRUE;
267 for (; *key != '\0'; key++) {
269 if (i_isalnum(*key) || *key == '_') {
270 /* key combo continues */
274 if (!expand_combo(start, key-1, out))
276 expand_out_char(*out, '-');
282 expand_out_char(*out, '-');
283 expand_out_char(*out, '-');
285 last_hyphen = !last_hyphen;
286 } else if (*key == '^') {
291 expand_out_char(*out, '^');
292 expand_out_char(*out, *key);
293 expand_out_char(*out, '-');
294 last_hyphen = FALSE; /* optional */
295 } else if (last_hyphen && i_isalnum(*key) && !i_isdigit(*key)) {
296 /* possibly beginning of keycombo */
300 expand_out_char(*out, *key);
301 expand_out_char(*out, '-');
302 last_hyphen = FALSE; /* optional */
307 return expand_combo(start, key-1, out);
309 for (tmp = *out; tmp != NULL; tmp = tmp->next) {
310 GString *str = tmp->data;
312 g_string_truncate(str, str->len-1);
318 static void key_states_scan_key(const char *key, KEY_REC *rec)
322 if (strcmp(rec->info->id, "key") == 0)
325 out = g_slist_append(NULL, g_string_new(NULL));
326 if (expand_key(key, &out)) {
327 for (tmp = out; tmp != NULL; tmp = tmp->next) {
328 GString *str = tmp->data;
330 if (str->str[1] == '-' || str->str[1] == '\0')
331 used_keys[(int)(unsigned char)str->str[0]] = 1;
333 g_tree_insert(key_states, g_strdup(str->str), rec);
337 expand_out_free(out);
340 static int key_state_destroy(char *key)
346 /* Rescan all the key combos and figure out which characters are supposed
347 to be treated as characters and which as key combos.
348 Yes, this is pretty slow function... */
349 static void key_states_rescan(void)
353 memset(used_keys, 0, sizeof(used_keys));
355 g_tree_traverse(key_states, (GTraverseFunc) key_state_destroy,
357 g_tree_destroy(key_states);
358 key_states = g_tree_new((GCompareFunc) strcmp);
360 temp = g_string_new(NULL);
361 g_hash_table_foreach(keys, (GHFunc) key_states_scan_key, temp);
362 g_string_free(temp, TRUE);
365 void key_configure_freeze(void)
370 void key_configure_thaw(void)
372 g_return_if_fail(key_config_frozen > 0);
374 if (--key_config_frozen == 0)
378 static void key_configure_destroy(KEY_REC *rec)
380 g_return_if_fail(rec != NULL);
382 rec->info->keys = g_slist_remove(rec->info->keys, rec);
383 g_hash_table_remove(keys, rec->key);
385 if (!key_config_frozen)
388 g_free_not_null(rec->data);
393 /* Configure new key */
394 static void key_configure_create(const char *id, const char *key,
400 g_return_if_fail(id != NULL);
401 g_return_if_fail(key != NULL && *key != '\0');
403 info = key_info_find(id);
407 rec = g_hash_table_lookup(keys, key);
409 key_configure_destroy(rec);
411 rec = g_new0(KEY_REC, 1);
412 rec->key = g_strdup(key);
414 rec->data = g_strdup(data);
415 info->keys = g_slist_append(info->keys, rec);
416 g_hash_table_insert(keys, rec->key, rec);
418 if (!key_config_frozen)
422 /* Bind a key for function */
423 void key_bind(const char *id, const char *description,
424 const char *key_default, const char *data, SIGNAL_FUNC func)
429 g_return_if_fail(id != NULL);
431 /* create key info record */
432 info = key_info_find(id);
434 g_return_if_fail(func != NULL);
436 if (description == NULL)
437 g_warning("key_bind(%s) should have description!", id);
438 info = g_new0(KEYINFO_REC, 1);
439 info->id = g_strdup(id);
440 info->description = g_strdup(description);
441 keyinfos = g_slist_append(keyinfos, info);
444 key = g_strconcat("key ", id, NULL);
445 signal_add(key, func);
448 signal_emit("keyinfo created", 1, info);
451 if (key_default != NULL && *key_default != '\0') {
452 key_default_add(id, key_default, data);
453 key_configure_create(id, key_default, data);
457 static void keyinfo_remove(KEYINFO_REC *info)
459 g_return_if_fail(info != NULL);
461 keyinfos = g_slist_remove(keyinfos, info);
462 signal_emit("keyinfo destroyed", 1, info);
464 /* destroy all keys */
465 g_slist_foreach(info->keys, (GFunc) key_destroy, keys);
466 g_slist_foreach(info->default_keys, (GFunc) key_destroy, default_keys);
468 /* destroy key info */
469 g_slist_free(info->keys);
470 g_slist_free(info->default_keys);
471 g_free_not_null(info->description);
477 void key_unbind(const char *id, SIGNAL_FUNC func)
482 g_return_if_fail(id != NULL);
483 g_return_if_fail(func != NULL);
486 info = key_info_find(id);
488 keyinfo_remove(info);
491 key = g_strconcat("key ", id, NULL);
492 signal_remove(key, func);
496 /* Configure new key */
497 void key_configure_add(const char *id, const char *key, const char *data)
499 g_return_if_fail(id != NULL);
500 g_return_if_fail(key != NULL && *key != '\0');
502 key_configure_create(id, key, data);
503 keyconfig_save(id, key, data);
507 void key_configure_remove(const char *key)
511 g_return_if_fail(key != NULL);
513 rec = g_hash_table_lookup(keys, key);
514 if (rec == NULL) return;
516 keyconfig_clear(key);
517 key_configure_destroy(rec);
520 static int key_emit_signal(KEYBOARD_REC *keyboard, KEY_REC *key)
525 str = g_strconcat("key ", key->info->id, NULL);
526 consumed = signal_emit(str, 3, key->data, keyboard->gui_data, key->info);
532 static int key_states_search(const unsigned char *combo,
533 const unsigned char *search)
535 while (*search != '\0') {
536 if (*combo != *search)
537 return *search - *combo;
544 /* Returns TRUE if key press was consumed. Control characters should be sent
545 as "^@" .. "^_" instead of #0..#31 chars, #127 should be sent as ^? */
546 int key_pressed(KEYBOARD_REC *keyboard, const char *key)
550 int first_key, consumed;
552 g_return_val_if_fail(keyboard != NULL, FALSE);
553 g_return_val_if_fail(key != NULL && *key != '\0', FALSE);
555 if (keyboard->key_state == NULL && key[1] == '\0' &&
556 !used_keys[(int) (unsigned char) key[0]]) {
557 /* fast check - key not used */
561 first_key = keyboard->key_state == NULL;
562 combo = keyboard->key_state == NULL ? g_strdup(key) :
563 g_strconcat(keyboard->key_state, "-", key, NULL);
564 g_free_and_null(keyboard->key_state);
566 rec = g_tree_search(key_states,
567 (GSearchFunc) key_states_search,
570 /* unknown key combo, eat the invalid key
571 unless it was the first key pressed */
576 if (g_tree_lookup(key_states, combo) != rec) {
577 /* key combo continues.. */
578 keyboard->key_state = combo;
582 /* finished key combo, execute */
584 consumed = key_emit_signal(keyboard, rec);
586 /* never consume non-control characters */
590 void keyboard_entry_redirect(SIGNAL_FUNC func, const char *entry,
591 int flags, void *data)
593 signal_emit("gui entry redirect", 4, func, entry,
594 GINT_TO_POINTER(flags), data);
597 static void sig_command(const char *data)
599 const char *cmdchars;
602 cmdchars = settings_get_str("cmdchars");
603 str = strchr(cmdchars, *data) != NULL ? g_strdup(data) :
604 g_strdup_printf("%c%s", *cmdchars, data);
606 signal_emit("send command", 3, str, active_win->active_server, active_win->active);
611 static void sig_key(const char *data)
613 /* we should never get here */
616 static void sig_multi(const char *data, void *gui_data)
619 char **list, **tmp, *p, *str;
621 list = g_strsplit(data, ";", -1);
622 for (tmp = list; *tmp != NULL; tmp++) {
623 p = strchr(*tmp, ' ');
624 if (p != NULL) *p++ = '\0'; else p = "";
626 info = key_info_find(*tmp);
628 str = g_strconcat("key ", info->id, NULL);
629 signal_emit(str, 3, p, gui_data, info);
636 static void cmd_show_keys(const char *searchkey, int full)
641 len = searchkey == NULL ? 0 : strlen(searchkey);
642 for (info = keyinfos; info != NULL; info = info->next) {
643 KEYINFO_REC *rec = info->data;
645 for (key = rec->keys; key != NULL; key = key->next) {
646 KEY_REC *rec = key->data;
648 if ((len == 0 || g_strncasecmp(rec->key, searchkey, len) == 0) &&
649 (!full || rec->key[len] == '\0')) {
650 printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, TXT_BIND_KEY,
651 rec->key, rec->info->id, rec->data == NULL ? "" : rec->data);
657 /* SYNTAX: BIND [-delete] [<key> [<command> [<data>]]] */
658 static void cmd_bind(const char *data)
661 char *key, *id, *keydata;
665 if (!cmd_get_params(data, &free_arg, 3 | PARAM_FLAG_GETREST | PARAM_FLAG_OPTIONS,
666 "bind", &optlist, &key, &id, &keydata))
669 if (*key != '\0' && g_hash_table_lookup(optlist, "delete")) {
671 key_configure_remove(key);
672 cmd_params_free(free_arg);
677 /* show some/all keys */
678 cmd_show_keys(key, FALSE);
679 cmd_params_free(free_arg);
683 command_id = strchr(settings_get_str("cmdchars"), *id) != NULL;
685 /* using shortcut to command id */
686 keydata = g_strconcat(id, " ", keydata, NULL);
690 if (key_info_find(id) == NULL)
691 printformat(NULL, NULL, MSGLEVEL_CLIENTERROR, TXT_BIND_UNKNOWN_ID, id);
693 key_configure_add(id, key, keydata);
694 cmd_show_keys(key, TRUE);
697 if (command_id) g_free(keydata);
698 cmd_params_free(free_arg);
701 static GList *completion_get_keyinfos(const char *info)
707 list = NULL; len = strlen(info);
708 for (tmp = keyinfos; tmp != NULL; tmp = tmp->next) {
709 KEYINFO_REC *rec = tmp->data;
711 if (g_strncasecmp(rec->id, info, len) == 0)
712 list = g_list_append(list, g_strdup(rec->id));
718 static void sig_complete_bind(GList **list, WINDOW_REC *window,
719 const char *word, const char *line,
722 g_return_if_fail(list != NULL);
723 g_return_if_fail(word != NULL);
724 g_return_if_fail(line != NULL);
726 if (*line == '\0' || strchr(line, ' ') != NULL)
729 *list = completion_get_keyinfos(word);
730 if (*list != NULL) signal_stop();
733 static int key_destroy_hash(const char *key, KEY_REC *rec)
735 rec->info->keys = g_slist_remove(rec->info->keys, rec);
737 g_free_not_null(rec->data);
743 static void key_copy_default(const char *key, KEY_REC *orig)
747 rec = g_new0(KEY_REC, 1);
748 rec->key = g_strdup(orig->key);
749 rec->info = orig->info;
750 rec->data = g_strdup(orig->data);
752 rec->info->keys = g_slist_append(rec->info->keys, rec);
753 g_hash_table_insert(keys, rec->key, rec);
756 static void keyboard_reset_defaults(void)
758 g_hash_table_foreach_remove(keys, (GHRFunc) key_destroy_hash, NULL);
759 g_hash_table_foreach(default_keys, (GHFunc) key_copy_default, NULL);
762 static void key_config_read(CONFIG_NODE *node)
764 char *key, *id, *data;
766 g_return_if_fail(node != NULL);
768 key = config_node_get_str(node, "key", NULL);
769 id = config_node_get_str(node, "id", NULL);
770 data = config_node_get_str(node, "data", NULL);
772 if (key != NULL && id != NULL)
773 key_configure_create(id, key, data);
776 static void read_keyboard_config(void)
781 key_configure_freeze();
783 keyboard_reset_defaults();
785 node = iconfig_node_traverse("keyboard", FALSE);
787 key_configure_thaw();
791 /* FIXME: backward "compatibility" - remove after irssi .99 */
792 if (node->type != NODE_TYPE_LIST) {
793 iconfig_node_remove(NULL, node);
794 key_configure_thaw();
798 tmp = config_node_first(node->value);
799 for (; tmp != NULL; tmp = config_node_next(tmp))
800 key_config_read(tmp->data);
802 key_configure_thaw();
805 void keyboard_init(void)
807 keys = g_hash_table_new((GHashFunc) g_str_hash,
808 (GCompareFunc) g_str_equal);
809 default_keys = g_hash_table_new((GHashFunc) g_str_hash,
810 (GCompareFunc) g_str_equal);
812 key_states = g_tree_new((GCompareFunc) strcmp);
813 key_config_frozen = 0;
814 memset(used_keys, 0, sizeof(used_keys));
816 key_bind("command", "Run any IRC command", NULL, NULL, (SIGNAL_FUNC) sig_command);
817 key_bind("key", "Specify name for key binding", NULL, NULL, (SIGNAL_FUNC) sig_key);
818 key_bind("multi", "Run multiple commands", NULL, NULL, (SIGNAL_FUNC) sig_multi);
820 /* read the keyboard config when all key binds are known */
821 signal_add("irssi init read settings", (SIGNAL_FUNC) read_keyboard_config);
822 signal_add("setup reread", (SIGNAL_FUNC) read_keyboard_config);
823 signal_add("complete command bind", (SIGNAL_FUNC) sig_complete_bind);
825 command_bind("bind", NULL, (SIGNAL_FUNC) cmd_bind);
826 command_set_options("bind", "delete");
829 void keyboard_deinit(void)
831 while (keyinfos != NULL)
832 keyinfo_remove(keyinfos->data);
833 g_hash_table_destroy(keys);
834 g_hash_table_destroy(default_keys);
836 g_tree_traverse(key_states, (GTraverseFunc) key_state_destroy,
838 g_tree_destroy(key_states);
840 signal_remove("irssi init read settings", (SIGNAL_FUNC) read_keyboard_config);
841 signal_remove("setup reread", (SIGNAL_FUNC) read_keyboard_config);
842 signal_remove("complete command bind", (SIGNAL_FUNC) sig_complete_bind);
843 command_unbind("bind", (SIGNAL_FUNC) cmd_bind);