src/config/kbdbind.c

   1 /* Keybinding implementation */
   2
   3 #ifdef HAVE_CONFIG_H
   4 #include "config.h"
   5 #endif
   6
   7 #include <ctype.h>
   8 #include <string.h>
   9
  10 #include "elinks.h"
  11
  12 #include "bfu/dialog.h"
  13 #include "config/conf.h"
  14 #include "config/dialogs.h"
  15 #include "config/kbdbind.h"
  16 #include "config/options.h"
  17 #include "intl/gettext/libintl.h"
  18 #include "main/event.h"
  19 #include "main/module.h"
  20 #include "terminal/kbd.h"
  21 #include "util/memory.h"
  22 #include "util/string.h"
  23
  24
  25 /* Fix namespace clash on MacOS. */
  26 #define table table_elinks
  27
  28 static struct action_list action_table[KEYMAP_MAX];
  29 static struct keymap keymap_table[KEYMAP_MAX];
  30 static LIST_OF(struct keybinding) keymaps[KEYMAP_MAX];
  31
  32 static void add_default_keybindings(void);
  33
  34 static int
  35 delete_keybinding(enum keymap_id keymap_id, struct term_event_keyboard *kbd)
  36 {
  37         struct keybinding *keybinding;
  38
  39         foreach (keybinding, keymaps[keymap_id]) {
  40                 int was_default = 0;
  41
  42                 if (!kbd_key_is(&keybinding->kbd, kbd->key))
  43                         continue;
  44
  45                 if (!kbd_modifier_is(&keybinding->kbd, kbd->modifier))
  46                         continue;
  47
  48
  49                 if (keybinding->flags & KBDB_DEFAULT_KEY) {
  50                         keybinding->flags &= ~KBDB_DEFAULT_KEY;
  51                         was_default = 1;
  52                 }
  53
  54                 free_keybinding(keybinding);
  55
  56                 return 1 + was_default;
  57         }
  58
  59         return 0;
  60 }
  61
  62 static int keybinding_is_default(struct keybinding *keybinding);
  63
  64 struct keybinding *
  65 add_keybinding(enum keymap_id keymap_id, action_id_T action_id,
  66                struct term_event_keyboard *kbd, int event)
  67 {
  68         struct keybinding *keybinding;
  69         struct listbox_item *root;
  70         int is_default;
  71
  72         is_default = (delete_keybinding(keymap_id, kbd) == 2);
  73
  74         keybinding = mem_calloc(1, sizeof(*keybinding));
  75         if (!keybinding) return NULL;
  76
  77         keybinding->keymap_id = keymap_id;
  78         keybinding->action_id = action_id;
  79         copy_struct(&keybinding->kbd, kbd);
  80         keybinding->event = event;
  81         keybinding->flags = is_default * KBDB_DEFAULT_KEY;
  82         if (keybinding_is_default(keybinding))
  83                 keybinding->flags |= KBDB_DEFAULT_BINDING;
  84
  85         object_nolock(keybinding, "keybinding");
  86         add_to_list(keymaps[keymap_id], keybinding);
  87
  88         if (action_id == ACT_MAIN_NONE) {
  89                 /* We don't want such a listbox_item, do we? */
  90                 return NULL; /* Or goto. */
  91         }
  92
  93         root = get_keybinding_action_box_item(keymap_id, action_id);
  94         if (!root) {
  95                 return NULL; /* Or goto ;-). */
  96         }
  97         keybinding->box_item = add_listbox_leaf(&keybinding_browser, root, keybinding);
  98
  99         return keybinding;
 100 }
 101
 102 void
 103 free_keybinding(struct keybinding *keybinding)
 104 {
 105         if (keybinding->box_item) {
 106                 done_listbox_item(&keybinding_browser, keybinding->box_item);
 107                 keybinding->box_item = NULL;
 108         }
 109
 110 #ifdef CONFIG_SCRIPTING
 111 /* TODO: unref function must be implemented. This is part of bug 810. */
 112 /*      if (keybinding->event != EVENT_NONE)
 113                 scripting_unref(keybinding->event); */
 114 #endif
 115
 116         if (keybinding->flags & KBDB_DEFAULT_KEY) {
 117                 /* We cannot just delete a default keybinding, instead we have
 118                  * to rebind it to ACT_MAIN_NONE so that it gets written so to the
 119                  * config file. */
 120                 keybinding->flags &= ~KBDB_DEFAULT_BINDING;
 121                 keybinding->action_id = ACT_MAIN_NONE;
 122                 return;
 123         }
 124
 125         del_from_list(keybinding);
 126         mem_free(keybinding);
 127 }
 128
 129 int
 130 keybinding_exists(enum keymap_id keymap_id, struct term_event_keyboard *kbd,
 131                   action_id_T *action_id)
 132 {
 133         struct keybinding *keybinding;
 134
 135         foreach (keybinding, keymaps[keymap_id]) {
 136                 if (!kbd_key_is(&keybinding->kbd, kbd->key))
 137                         continue;
 138
 139                 if (!kbd_modifier_is(&keybinding->kbd, kbd->modifier))
 140                         continue;
 141
 142                 if (action_id) *action_id = keybinding->action_id;
 143
 144                 return 1;
 145         }
 146
 147         return 0;
 148 }
 149
 150
 151 action_id_T
 152 kbd_action(enum keymap_id keymap_id, struct term_event *ev, int *event)
 153 {
 154         struct keybinding *keybinding;
 155
 156         if (ev->ev != EVENT_KBD) return -1;
 157
 158         keybinding = kbd_ev_lookup(keymap_id, &ev->info.keyboard, event);
 159         return keybinding ? keybinding->action_id : -1;
 160 }
 161
 162 struct keybinding *
 163 kbd_ev_lookup(enum keymap_id keymap_id, struct term_event_keyboard *kbd, int *event)
 164 {
 165         struct keybinding *keybinding;
 166
 167         foreach (keybinding, keymaps[keymap_id]) {
 168                 if (!kbd_key_is(&keybinding->kbd, kbd->key))
 169                         continue;
 170
 171                 if (!kbd_modifier_is(&keybinding->kbd, kbd->modifier))
 172                         continue;
 173
 174                 if (keybinding->action_id == ACT_MAIN_SCRIPTING_FUNCTION && event)
 175                         *event = keybinding->event;
 176
 177                 return keybinding;
 178         }
 179
 180         return NULL;
 181 }
 182
 183 static struct keybinding *
 184 kbd_act_lookup(enum keymap_id keymap_id, action_id_T action_id)
 185 {
 186         struct keybinding *keybinding;
 187
 188         foreach (keybinding, keymaps[keymap_id]) {
 189                 if (action_id != keybinding->action_id)
 190                         continue;
 191
 192                 return keybinding;
 193         }
 194
 195         return NULL;
 196 }
 197
 198 struct keybinding *
 199 kbd_nm_lookup(enum keymap_id keymap_id, unsigned char *name)
 200 {
 201         action_id_T action_id = get_action_from_string(keymap_id, name);
 202
 203         if (action_id < 0) return NULL;
 204
 205         return kbd_act_lookup(keymap_id, action_id);
 206 }
 207
 208 static struct keybinding *
 209 kbd_stroke_lookup(enum keymap_id keymap_id, const unsigned char *keystroke_str)
 210 {
 211         struct term_event_keyboard kbd;
 212
 213         if (parse_keystroke(keystroke_str, &kbd) < 0)
 214                 return NULL;
 215
 216         return kbd_ev_lookup(keymap_id, &kbd, NULL);
 217 }
 218
 219
 220 static struct keymap keymap_table[] = {
 221         { "main", KEYMAP_MAIN, N_("Main mapping") },
 222         { "edit", KEYMAP_EDIT, N_("Edit mapping") },
 223         { "menu", KEYMAP_MENU, N_("Menu mapping") },
 224 };
 225
 226
 227 /*
 228  * Config file helpers.
 229  */
 230
 231 static struct action *
 232 get_action_from_keystroke(enum keymap_id keymap_id,
 233                           const unsigned char *keystroke_str)
 234 {
 235         struct keybinding *keybinding = kbd_stroke_lookup(keymap_id,
 236                                                           keystroke_str);
 237
 238         return keybinding ? get_action(keymap_id, keybinding->action_id) : NULL;
 239 }
 240
 241 unsigned char *
 242 get_action_name_from_keystroke(enum keymap_id keymap_id,
 243                                const unsigned char *keystroke_str)
 244 {
 245         struct action *action = get_action_from_keystroke(keymap_id,
 246                                                           keystroke_str);
 247
 248         return action ? action->str : NULL;
 249 }
 250
 251 action_id_T
 252 get_action_from_string(enum keymap_id keymap_id, unsigned char *str)
 253 {
 254         struct action *action;
 255
 256         assert(keymap_id >= 0 && keymap_id < KEYMAP_MAX);
 257
 258         for (action = action_table[keymap_id].actions; action->str; action++)
 259                 if (!strcmp(action->str, str))
 260                         return action->num;
 261
 262         return -1;
 263 }
 264
 265 struct action *
 266 get_action(enum keymap_id keymap_id, action_id_T action_id)
 267 {
 268         assert(keymap_id >= 0 && keymap_id < KEYMAP_MAX);
 269
 270         if (action_id >= 0 && action_id < action_table[keymap_id].num_actions)
 271                 return &action_table[keymap_id].actions[action_id];
 272
 273         return NULL;
 274 }
 275
 276 unsigned char *
 277 get_action_name(enum keymap_id keymap_id, action_id_T action_id)
 278 {
 279         struct action *action = get_action(keymap_id, action_id);
 280
 281         return action ? action->str : NULL;
 282 }
 283
 284 static unsigned char *
 285 get_action_desc(enum keymap_id keymap_id, action_id_T action_id)
 286 {
 287         struct action *action = get_action(keymap_id, action_id);
 288
 289         return action ? (action->desc ? action->desc : action->str)
 290                       : NULL;
 291 }
 292
 293
 294 static struct keymap *
 295 get_keymap(enum keymap_id keymap_id)
 296 {
 297         assert(keymap_id >= 0 && keymap_id < KEYMAP_MAX);
 298
 299         return &keymap_table[keymap_id];
 300 }
 301
 302 static enum keymap_id
 303 get_keymap_id(unsigned char *keymap_str)
 304 {
 305         enum keymap_id keymap_id;
 306
 307         for (keymap_id = 0; keymap_id < KEYMAP_MAX; keymap_id++)
 308                 if (!strcmp(keymap_table[keymap_id].str, keymap_str))
 309                         return keymap_id;
 310
 311         return KEYMAP_INVALID;
 312 }
 313
 314 unsigned char *
 315 get_keymap_name(enum keymap_id keymap_id)
 316 {
 317         return get_keymap(keymap_id)->str;
 318 }
 319
 320
 321 struct named_key {
 322         const unsigned char *str;
 323         term_event_key_T num;
 324 };
 325
 326 static const struct named_key key_table[] = {
 327         { "Enter",      KBD_ENTER },
 328         { "Space",      ' ' },
 329         { "Backspace",  KBD_BS },
 330         { "Tab",        KBD_TAB },
 331         { "Escape",     KBD_ESC },
 332         { "Left",       KBD_LEFT },
 333         { "Right",      KBD_RIGHT },
 334         { "Up",         KBD_UP },
 335         { "Down",       KBD_DOWN },
 336         { "Insert",     KBD_INS },
 337         { "Delete",     KBD_DEL },
 338         { "Home",       KBD_HOME },
 339         { "End",        KBD_END },
 340         { "PageUp",     KBD_PAGE_UP },
 341         { "PageDown",   KBD_PAGE_DOWN },
 342         { "F1",         KBD_F1 },
 343         { "F2",         KBD_F2 },
 344         { "F3",         KBD_F3 },
 345         { "F4",         KBD_F4 },
 346         { "F5",         KBD_F5 },
 347         { "F6",         KBD_F6 },
 348         { "F7",         KBD_F7 },
 349         { "F8",         KBD_F8 },
 350         { "F9",         KBD_F9 },
 351         { "F10",        KBD_F10 },
 352         { "F11",        KBD_F11 },
 353         { "F12",        KBD_F12 },
 354         { NULL, KBD_UNDEF }
 355 };
 356
 357 term_event_key_T
 358 read_key(const unsigned char *key_str)
 359 {
 360         const struct named_key *key;
 361
 362         if (key_str[0] && !key_str[1])
 363                 return key_str[0];
 364
 365         for (key = key_table; key->str; key++)
 366                 if (!strcasecmp(key->str, key_str))
 367                         return key->num;
 368
 369         return KBD_UNDEF;
 370 }
 371
 372 /** Parse the string @a s as the name of a keystroke.
 373  * Write the parsed key and modifiers to *@a kbd.
 374  * @return >=0 on success, <0 on error.
 375  *
 376  * This function does not support ::KBD_MOD_PASTE, because keystrokes
 377  * that include it should never be bound to actions.  */
 378 int
 379 parse_keystroke(const unsigned char *s, struct term_event_keyboard *kbd)
 380 {
 381         kbd->modifier = KBD_MOD_NONE;
 382         while (1) {
 383                 if (!strncasecmp(s, "Shift", 5) && (s[5] == '-' || s[5] == '+')) {
 384                         /* Shift+a == shiFt-a == Shift-a */
 385                         kbd->modifier |= KBD_MOD_SHIFT;
 386                         s += 6;
 387
 388                 } else if (!strncasecmp(s, "Ctrl", 4) && (s[4] == '-' || s[4] == '+')) {
 389                         /* Ctrl+a == ctRl-a == Ctrl-a */
 390                         kbd->modifier |= KBD_MOD_CTRL;
 391                         s += 5;
 392
 393                 } else if (!strncasecmp(s, "Alt", 3) && (s[3] == '-' || s[3] == '+')) {
 394                         /* Alt+a == aLt-a == Alt-a */
 395                         kbd->modifier |= KBD_MOD_ALT;
 396                         s += 4;
 397
 398                 } else {
 399                         /* No modifier. */
 400                         break;
 401                 }
 402         }
 403
 404         kbd->key = read_key(s);
 405
 406         if ((kbd->modifier & KBD_MOD_CTRL) != 0
 407             && is_kbd_character(kbd->key) && kbd->key <= 0x7F) {
 408                 /* Convert Ctrl-letter keystrokes to upper case,
 409                  * e.g. Ctrl-a to Ctrl-A.  Do this because terminals
 410                  * typically generate the same ASCII control
 411                  * characters regardless of Shift and Caps Lock.
 412                  *
 413                  * However, that applies only to ASCII letters.  For
 414                  * other Ctrl-letter combinations, there seems to be
 415                  * no standard of what the terminal should generate.
 416                  * Because it is possible that the terminal does not
 417                  * fold case then, ELinks should treat upper-case and
 418                  * lower-case variants of such keystrokes as different
 419                  * and let the user bind them to separate actions.
 420                  * Besides, toupper() might not understand the charset
 421                  * of kbd->key.
 422                  *
 423                  * FIXME: Actually, it is possible that some terminals
 424                  * preserve case in all Ctrl-letter keystrokes, even
 425                  * for ASCII letters.  In particular, the Win32
 426                  * console API looks like it might do this.  When the
 427                  * terminal handling part of ELinks is eventually
 428                  * extended to fully support that, it could be a good
 429                  * idea to change parse_keystroke() not to fold case,
 430                  * and instead make kbd_ev_lookup() or its callers
 431                  * search for different variants of the keystroke if
 432                  * the original one is not bound to any action.  */
 433                 kbd->key = toupper(kbd->key);
 434         }
 435
 436         return (kbd->key == KBD_UNDEF) ? -1 : 0;
 437 }
 438
 439 void
 440 add_keystroke_to_string(struct string *str, struct term_event_keyboard *kbd,
 441                         int escape)
 442 {
 443         unsigned char key_buffer[3] = "\\x";
 444         const unsigned char *key_string = NULL;
 445         const struct named_key *key;
 446
 447         if (kbd->key == KBD_UNDEF) return;
 448
 449         /* Don't map KBD_MOD_PASTE to "Paste-" because parse_keystroke
 450          * would not understand the result.  */
 451         if (kbd->modifier & KBD_MOD_SHIFT)
 452                 add_to_string(str, "Shift-");
 453         if (kbd->modifier & KBD_MOD_CTRL)
 454                 add_to_string(str, "Ctrl-");
 455         if (kbd->modifier & KBD_MOD_ALT)
 456                 add_to_string(str, "Alt-");
 457
 458         for (key = key_table; key->str; key++) {
 459                 if (kbd->key == key->num) {
 460                         key_string = key->str;
 461                         break;
 462                 }
 463         }
 464
 465         if (!key_string) {
 466                 key_string = key_buffer + 1;
 467                 key_buffer[1] = (unsigned char) kbd->key;
 468                 if (escape && strchr("'\"\\", kbd->key))
 469                         key_string--;
 470         }
 471
 472         add_to_string(str, key_string);
 473 }
 474
 475 void
 476 add_keystroke_action_to_string(struct string *string, action_id_T action_id,
 477                                enum keymap_id keymap_id)
 478 {
 479         struct keybinding *keybinding = kbd_act_lookup(keymap_id, action_id);
 480
 481         if (keybinding)
 482                 add_keystroke_to_string(string, &keybinding->kbd, 0);
 483 }
 484
 485 unsigned char *
 486 get_keystroke(action_id_T action_id, enum keymap_id keymap_id)
 487 {
 488         struct string keystroke;
 489
 490         if (!init_string(&keystroke)) return NULL;
 491
 492         add_keystroke_action_to_string(&keystroke, action_id, keymap_id);
 493
 494         /* Never return empty string */
 495         if (!keystroke.length) done_string(&keystroke);
 496
 497         return keystroke.source;
 498 }
 499
 500 void
 501 add_actions_to_string(struct string *string, action_id_T action_ids[],
 502                       enum keymap_id keymap_id, struct terminal *term)
 503 {
 504         int i;
 505
 506         assert(keymap_id >= 0 && keymap_id < KEYMAP_MAX);
 507
 508         add_format_to_string(string, "%s:\n", _(keymap_table[keymap_id].desc, term));
 509
 510         for (i = 0; action_ids[i] != ACT_MAIN_NONE; i++) {
 511                 struct keybinding *keybinding = kbd_act_lookup(keymap_id, action_ids[i]);
 512                 int keystrokelen = string->length;
 513                 unsigned char *desc = get_action_desc(keymap_id, action_ids[i]);
 514
 515                 if (!keybinding) continue;
 516
 517                 add_char_to_string(string, '\n');
 518                 add_keystroke_to_string(string, &keybinding->kbd, 0);
 519                 keystrokelen = string->length - keystrokelen;
 520                 add_xchar_to_string(string, ' ', int_max(15 - keystrokelen, 1));
 521                 add_to_string(string, _(desc, term));
 522         }
 523 }
 524
 525 #define ACTION_(map, name, action, caption, flags)      \
 526         { name, ACT_##map##_##action, KEYMAP_ID, caption, flags }
 527
 528 #undef KEYMAP_ID
 529 #define KEYMAP_ID KEYMAP_MAIN
 530 static struct action main_action_table[MAIN_ACTIONS + 1] = {
 531 #include "config/actions-main.inc"
 532 };
 533
 534 #undef KEYMAP_ID
 535 #define KEYMAP_ID KEYMAP_EDIT
 536 static struct action edit_action_table[EDIT_ACTIONS + 1] = {
 537 #include "config/actions-edit.inc"
 538 };
 539
 540 #undef KEYMAP_ID
 541 #define KEYMAP_ID KEYMAP_MENU
 542 static struct action menu_action_table[MENU_ACTIONS + 1] = {
 543 #include "config/actions-menu.inc"
 544 };
 545
 546 static struct action_list action_table[KEYMAP_MAX] = {
 547         { main_action_table, sizeof_array(main_action_table) },
 548         { edit_action_table, sizeof_array(edit_action_table) },
 549         { menu_action_table, sizeof_array(menu_action_table) },
 550 };
 551
 552 #undef KEYMAP_ID
 553 #undef ACTION_
 554
 555
 556 static void
 557 init_keymaps(struct module *xxx)
 558 {
 559         enum keymap_id keymap_id;
 560
 561         for (keymap_id = 0; keymap_id < KEYMAP_MAX; keymap_id++)
 562                 init_list(keymaps[keymap_id]);
 563
 564         init_keybinding_listboxes(keymap_table, action_table);
 565         add_default_keybindings();
 566 }
 567
 568 static void
 569 free_keymaps(struct module *xxx)
 570 {
 571         enum keymap_id keymap_id;
 572
 573         done_keybinding_listboxes();
 574
 575         for (keymap_id = 0; keymap_id < KEYMAP_MAX; keymap_id++)
 576                 free_list(keymaps[keymap_id]);
 577 }
 578
 579
 580 /*
 581  * Bind to Lua function.
 582  */
 583
 584 #ifdef CONFIG_SCRIPTING
 585 static unsigned char *
 586 bind_key_to_event(unsigned char *ckmap, const unsigned char *ckey, int event)
 587 {
 588         struct term_event_keyboard kbd;
 589         action_id_T action_id;
 590         enum keymap_id keymap_id = get_keymap_id(ckmap);
 591
 592         if (keymap_id == KEYMAP_INVALID)
 593                 return gettext("Unrecognised keymap");
 594
 595         if (parse_keystroke(ckey, &kbd) < 0)
 596                 return gettext("Error parsing keystroke");
 597
 598         action_id = get_action_from_string(keymap_id, " *scripting-function*");
 599         if (action_id < 0)
 600                 return gettext("Unrecognised action (internal error)");
 601
 602         add_keybinding(keymap_id, action_id, &kbd, event);
 603
 604         return NULL;
 605 }
 606
 607 int
 608 bind_key_to_event_name(unsigned char *ckmap, const unsigned char *ckey,
 609                        unsigned char *event_name, unsigned char **err)
 610 {
 611         int event_id;
 612
 613         event_id = register_event(event_name);
 614
 615         if (event_id == EVENT_NONE) {
 616                 *err = gettext("Error registering event");
 617                 return EVENT_NONE;
 618         }
 619
 620         *err = bind_key_to_event(ckmap, ckey, event_id);
 621
 622         return event_id;
 623 }
 624 #endif
 625
 626
 627 /*
 628  * Default keybindings.
 629  */
 630
 631 struct default_kb {
 632         struct term_event_keyboard kbd;
 633         action_id_T action_id;
 634 };
 635
 636 static struct default_kb default_main_keymap[] = {
 637         { { ' ',         KBD_MOD_NONE }, ACT_MAIN_MOVE_PAGE_DOWN },
 638         { { '#',         KBD_MOD_NONE }, ACT_MAIN_SEARCH_TYPEAHEAD },
 639         { { '%',         KBD_MOD_NONE }, ACT_MAIN_TOGGLE_DOCUMENT_COLORS },
 640         { { '*',         KBD_MOD_NONE }, ACT_MAIN_TOGGLE_DISPLAY_IMAGES },
 641         { { ',',         KBD_MOD_NONE }, ACT_MAIN_LUA_CONSOLE },
 642         { { '.',         KBD_MOD_NONE }, ACT_MAIN_TOGGLE_NUMBERED_LINKS },
 643         { { '/',         KBD_MOD_NONE }, ACT_MAIN_SEARCH },
 644         { { ':',         KBD_MOD_NONE }, ACT_MAIN_EXMODE },
 645         { { '<',         KBD_MOD_NONE }, ACT_MAIN_TAB_PREV },
 646         { { '<',         KBD_MOD_ALT  }, ACT_MAIN_TAB_MOVE_LEFT },
 647         { { '=',         KBD_MOD_NONE }, ACT_MAIN_DOCUMENT_INFO },
 648         { { '>',         KBD_MOD_NONE }, ACT_MAIN_TAB_NEXT },
 649         { { '>',         KBD_MOD_ALT  }, ACT_MAIN_TAB_MOVE_RIGHT },
 650         { { '?',         KBD_MOD_NONE }, ACT_MAIN_SEARCH_BACK },
 651         { { 'A',         KBD_MOD_NONE }, ACT_MAIN_ADD_BOOKMARK_LINK },
 652         { { 'A',         KBD_MOD_CTRL }, ACT_MAIN_MOVE_DOCUMENT_START },
 653         { { 'B',         KBD_MOD_CTRL }, ACT_MAIN_MOVE_PAGE_UP },
 654         { { 'C',         KBD_MOD_NONE }, ACT_MAIN_CACHE_MANAGER },
 655         { { 'D',         KBD_MOD_NONE }, ACT_MAIN_DOWNLOAD_MANAGER },
 656         { { 'E',         KBD_MOD_NONE }, ACT_MAIN_GOTO_URL_CURRENT_LINK },
 657         { { 'E',         KBD_MOD_CTRL }, ACT_MAIN_MOVE_DOCUMENT_END },
 658         { { 'F',         KBD_MOD_NONE }, ACT_MAIN_FORMHIST_MANAGER },
 659         { { 'F',         KBD_MOD_CTRL }, ACT_MAIN_MOVE_PAGE_DOWN },
 660         { { 'G',         KBD_MOD_NONE }, ACT_MAIN_GOTO_URL_CURRENT },
 661         { { 'H',         KBD_MOD_NONE }, ACT_MAIN_GOTO_URL_HOME },
 662         { { 'K',         KBD_MOD_NONE }, ACT_MAIN_COOKIE_MANAGER },
 663         { { 'K',         KBD_MOD_CTRL }, ACT_MAIN_COOKIES_LOAD },
 664         { { 'L',         KBD_MOD_NONE }, ACT_MAIN_LINK_MENU },
 665         { { 'L',         KBD_MOD_CTRL }, ACT_MAIN_REDRAW },
 666         { { 'N',         KBD_MOD_NONE }, ACT_MAIN_FIND_NEXT_BACK },
 667         { { 'N',         KBD_MOD_CTRL }, ACT_MAIN_SCROLL_DOWN },
 668         { { 'P',         KBD_MOD_CTRL }, ACT_MAIN_SCROLL_UP },
 669         { { 'Q',         KBD_MOD_NONE }, ACT_MAIN_REALLY_QUIT },
 670         { { 'R',         KBD_MOD_CTRL }, ACT_MAIN_RELOAD },
 671         { { 'T',         KBD_MOD_NONE }, ACT_MAIN_OPEN_LINK_IN_NEW_TAB_IN_BACKGROUND },
 672         { { 'W',         KBD_MOD_NONE }, ACT_MAIN_TOGGLE_WRAP_TEXT },
 673         { { '[',         KBD_MOD_NONE }, ACT_MAIN_SCROLL_LEFT },
 674         { { '\'',        KBD_MOD_NONE }, ACT_MAIN_MARK_GOTO },
 675         { { '\\',        KBD_MOD_NONE }, ACT_MAIN_TOGGLE_HTML_PLAIN },
 676         { { ']',         KBD_MOD_NONE }, ACT_MAIN_SCROLL_RIGHT },
 677         { { 'a',         KBD_MOD_NONE }, ACT_MAIN_ADD_BOOKMARK },
 678         { { 'b',         KBD_MOD_NONE }, ACT_MAIN_MOVE_PAGE_UP },
 679         { { 'c',         KBD_MOD_NONE }, ACT_MAIN_TAB_CLOSE },
 680         { { 'd',         KBD_MOD_NONE }, ACT_MAIN_LINK_DOWNLOAD },
 681         { { 'e',         KBD_MOD_NONE }, ACT_MAIN_TAB_MENU },
 682         { { 'f',         KBD_MOD_NONE }, ACT_MAIN_FRAME_MAXIMIZE },
 683         { { 'g',         KBD_MOD_NONE }, ACT_MAIN_GOTO_URL },
 684         { { 'h',         KBD_MOD_NONE }, ACT_MAIN_HISTORY_MANAGER },
 685         { { 'k',         KBD_MOD_NONE }, ACT_MAIN_KEYBINDING_MANAGER },
 686         { { 'l',         KBD_MOD_NONE }, ACT_MAIN_JUMP_TO_LINK },
 687         { { 'm',         KBD_MOD_NONE }, ACT_MAIN_MARK_SET },
 688         { { 'n',         KBD_MOD_NONE }, ACT_MAIN_FIND_NEXT },
 689         { { 'o',         KBD_MOD_NONE }, ACT_MAIN_OPTIONS_MANAGER },
 690         { { 'q',         KBD_MOD_NONE }, ACT_MAIN_QUIT },
 691         { { 'r',         KBD_MOD_NONE }, ACT_MAIN_LINK_DOWNLOAD_RESUME },
 692         { { 's',         KBD_MOD_NONE }, ACT_MAIN_BOOKMARK_MANAGER },
 693         { { 't',         KBD_MOD_NONE }, ACT_MAIN_OPEN_NEW_TAB },
 694         { { 'u',         KBD_MOD_NONE }, ACT_MAIN_HISTORY_MOVE_FORWARD },
 695         { { 'v',         KBD_MOD_NONE }, ACT_MAIN_VIEW_IMAGE },
 696         { { 'x',         KBD_MOD_NONE }, ACT_MAIN_LINK_FOLLOW_RELOAD },
 697         { { 'z',         KBD_MOD_NONE }, ACT_MAIN_ABORT_CONNECTION },
 698         { { '{',         KBD_MOD_NONE }, ACT_MAIN_SCROLL_LEFT },
 699         { { '|',         KBD_MOD_NONE }, ACT_MAIN_HEADER_INFO },
 700         { { '}',         KBD_MOD_NONE }, ACT_MAIN_SCROLL_RIGHT },
 701         { { KBD_BS,      KBD_MOD_NONE }, ACT_MAIN_BACKSPACE_PREFIX },
 702         { { KBD_DEL,     KBD_MOD_NONE }, ACT_MAIN_SCROLL_DOWN },
 703         { { KBD_DOWN,    KBD_MOD_NONE }, ACT_MAIN_MOVE_LINK_NEXT },
 704         { { KBD_END,     KBD_MOD_NONE }, ACT_MAIN_MOVE_DOCUMENT_END },
 705         { { KBD_ENTER,   KBD_MOD_NONE }, ACT_MAIN_LINK_FOLLOW },
 706         { { KBD_ENTER,   KBD_MOD_CTRL }, ACT_MAIN_LINK_FOLLOW_RELOAD },
 707         { { KBD_ESC,     KBD_MOD_NONE }, ACT_MAIN_MENU },
 708         { { KBD_F10,     KBD_MOD_NONE }, ACT_MAIN_FILE_MENU },
 709         { { KBD_F9,      KBD_MOD_NONE }, ACT_MAIN_MENU },
 710         { { KBD_HOME,    KBD_MOD_NONE }, ACT_MAIN_MOVE_DOCUMENT_START },
 711         { { KBD_INS,     KBD_MOD_NONE }, ACT_MAIN_SCROLL_UP },
 712         { { KBD_INS,     KBD_MOD_CTRL }, ACT_MAIN_COPY_CLIPBOARD },
 713         { { KBD_LEFT,    KBD_MOD_NONE }, ACT_MAIN_HISTORY_MOVE_BACK },
 714         { { KBD_PAGE_DOWN, KBD_MOD_NONE }, ACT_MAIN_MOVE_PAGE_DOWN },
 715         { { KBD_PAGE_UP, KBD_MOD_NONE }, ACT_MAIN_MOVE_PAGE_UP },
 716         { { KBD_RIGHT,   KBD_MOD_NONE }, ACT_MAIN_LINK_FOLLOW },
 717         { { KBD_RIGHT,   KBD_MOD_CTRL }, ACT_MAIN_LINK_FOLLOW_RELOAD },
 718         { { KBD_TAB,     KBD_MOD_NONE }, ACT_MAIN_FRAME_NEXT },
 719         { { KBD_TAB,     KBD_MOD_ALT  }, ACT_MAIN_FRAME_PREV },
 720         { { KBD_TAB,     KBD_MOD_SHIFT}, ACT_MAIN_FRAME_PREV },
 721         { { KBD_UP,      KBD_MOD_NONE }, ACT_MAIN_MOVE_LINK_PREV },
 722         { { 0, 0 }, 0 }
 723 };
 724
 725 static struct default_kb default_edit_keymap[] = {
 726         { { '<',         KBD_MOD_ALT  }, ACT_EDIT_BEGINNING_OF_BUFFER },
 727         { { '>',         KBD_MOD_ALT  }, ACT_EDIT_END_OF_BUFFER },
 728         { { 'A',         KBD_MOD_CTRL }, ACT_EDIT_HOME },
 729         { { 'b',         KBD_MOD_ALT  }, ACT_EDIT_MOVE_BACKWARD_WORD },
 730         { { 'D',         KBD_MOD_CTRL }, ACT_EDIT_DELETE },
 731         { { 'E',         KBD_MOD_CTRL }, ACT_EDIT_END },
 732         { { 'f',         KBD_MOD_ALT  }, ACT_EDIT_MOVE_FORWARD_WORD },
 733         { { 'H',         KBD_MOD_CTRL }, ACT_EDIT_BACKSPACE },
 734         { { 'K',         KBD_MOD_CTRL }, ACT_EDIT_KILL_TO_EOL },
 735         { { 'L',         KBD_MOD_CTRL }, ACT_EDIT_REDRAW },
 736         { { 'r',         KBD_MOD_ALT  }, ACT_EDIT_SEARCH_TOGGLE_REGEX },
 737         { { 'F',         KBD_MOD_CTRL }, ACT_EDIT_AUTO_COMPLETE_FILE },
 738         { { 'R',         KBD_MOD_CTRL }, ACT_EDIT_AUTO_COMPLETE_UNAMBIGUOUS },
 739         { { 'T',         KBD_MOD_CTRL }, ACT_EDIT_OPEN_EXTERNAL },
 740         { { 'U',         KBD_MOD_CTRL }, ACT_EDIT_KILL_TO_BOL },
 741         { { 'V',         KBD_MOD_CTRL }, ACT_EDIT_PASTE_CLIPBOARD },
 742         { { 'W',         KBD_MOD_CTRL }, ACT_EDIT_AUTO_COMPLETE },
 743         { { 'X',         KBD_MOD_CTRL }, ACT_EDIT_CUT_CLIPBOARD },
 744         { { KBD_BS,      KBD_MOD_ALT  }, ACT_EDIT_KILL_WORD_BACK },
 745         { { KBD_BS,      KBD_MOD_NONE }, ACT_EDIT_BACKSPACE },
 746         { { KBD_DEL,     KBD_MOD_NONE }, ACT_EDIT_DELETE },
 747         { { KBD_DOWN,    KBD_MOD_NONE }, ACT_EDIT_DOWN },
 748         { { KBD_END,     KBD_MOD_NONE }, ACT_EDIT_END },
 749         { { KBD_ENTER,   KBD_MOD_NONE }, ACT_EDIT_ENTER },
 750         { { KBD_ESC,     KBD_MOD_NONE }, ACT_EDIT_CANCEL },
 751         { { KBD_F4,      KBD_MOD_NONE }, ACT_EDIT_OPEN_EXTERNAL },
 752         { { KBD_HOME,    KBD_MOD_NONE }, ACT_EDIT_HOME },
 753         { { KBD_INS,     KBD_MOD_CTRL }, ACT_EDIT_COPY_CLIPBOARD },
 754         { { KBD_LEFT,    KBD_MOD_NONE }, ACT_EDIT_LEFT },
 755         { { KBD_RIGHT,   KBD_MOD_NONE }, ACT_EDIT_RIGHT },
 756         { { KBD_TAB,     KBD_MOD_NONE }, ACT_EDIT_NEXT_ITEM },
 757         { { KBD_TAB,     KBD_MOD_ALT  }, ACT_EDIT_PREVIOUS_ITEM },
 758         { { KBD_TAB,     KBD_MOD_SHIFT}, ACT_EDIT_PREVIOUS_ITEM },
 759         { { KBD_UP,      KBD_MOD_NONE }, ACT_EDIT_UP },
 760         { { 0, 0 }, 0 }
 761 };
 762
 763 static struct default_kb default_menu_keymap[] = {
 764         { { ' ',         KBD_MOD_NONE }, ACT_MENU_SELECT },
 765         { { '*',         KBD_MOD_NONE }, ACT_MENU_MARK_ITEM },
 766         { { '+',         KBD_MOD_NONE }, ACT_MENU_EXPAND },
 767         { { '-',         KBD_MOD_NONE }, ACT_MENU_UNEXPAND },
 768         { { '/',         KBD_MOD_NONE }, ACT_MENU_SEARCH },
 769         { { '=',         KBD_MOD_NONE }, ACT_MENU_EXPAND },
 770         { { 'A',         KBD_MOD_CTRL }, ACT_MENU_HOME },
 771         { { 'B',         KBD_MOD_CTRL }, ACT_MENU_PAGE_UP },
 772         { { 'E',         KBD_MOD_CTRL }, ACT_MENU_END },
 773         { { 'F',         KBD_MOD_CTRL }, ACT_MENU_PAGE_DOWN },
 774         { { 'L',         KBD_MOD_CTRL }, ACT_MENU_REDRAW },
 775         { { 'N',         KBD_MOD_CTRL }, ACT_MENU_DOWN },
 776         { { 'P',         KBD_MOD_CTRL }, ACT_MENU_UP },
 777         { { 'V',         KBD_MOD_ALT  }, ACT_MENU_PAGE_UP },
 778         { { 'V',         KBD_MOD_CTRL }, ACT_MENU_PAGE_DOWN },
 779         { { '[',         KBD_MOD_NONE }, ACT_MENU_EXPAND },
 780         { { ']',         KBD_MOD_NONE }, ACT_MENU_UNEXPAND },
 781         { { '_',         KBD_MOD_NONE }, ACT_MENU_UNEXPAND },
 782         { { KBD_DEL,     KBD_MOD_NONE }, ACT_MENU_DELETE },
 783         { { KBD_DOWN,    KBD_MOD_NONE }, ACT_MENU_DOWN },
 784         { { KBD_END,     KBD_MOD_NONE }, ACT_MENU_END },
 785         { { KBD_ENTER,   KBD_MOD_NONE }, ACT_MENU_ENTER },
 786         { { KBD_ESC,     KBD_MOD_NONE }, ACT_MENU_CANCEL },
 787         { { KBD_HOME,    KBD_MOD_NONE }, ACT_MENU_HOME },
 788         { { KBD_INS,     KBD_MOD_NONE }, ACT_MENU_MARK_ITEM },
 789         { { KBD_LEFT,    KBD_MOD_NONE }, ACT_MENU_LEFT },
 790         { { KBD_PAGE_DOWN, KBD_MOD_NONE }, ACT_MENU_PAGE_DOWN },
 791         { { KBD_PAGE_UP, KBD_MOD_NONE }, ACT_MENU_PAGE_UP },
 792         { { KBD_RIGHT,   KBD_MOD_NONE }, ACT_MENU_RIGHT },
 793         { { KBD_TAB,     KBD_MOD_NONE }, ACT_MENU_NEXT_ITEM },
 794         { { KBD_TAB,     KBD_MOD_ALT  }, ACT_MENU_PREVIOUS_ITEM },
 795         { { KBD_TAB,     KBD_MOD_SHIFT}, ACT_MENU_PREVIOUS_ITEM },
 796         { { KBD_UP,      KBD_MOD_NONE }, ACT_MENU_UP },
 797         { { 0, 0 }, 0}
 798 };
 799
 800 static struct default_kb *default_keybindings[] = {
 801         default_main_keymap,
 802         default_edit_keymap,
 803         default_menu_keymap,
 804 };
 805
 806 static int
 807 keybinding_is_default(struct keybinding *keybinding)
 808 {
 809         struct default_kb default_keybinding = {
 810                 {
 811                         keybinding->kbd.key,
 812                         keybinding->kbd.modifier
 813                 },
 814                 keybinding->action_id
 815         };
 816         struct default_kb *pos;
 817
 818         for (pos = default_keybindings[keybinding->keymap_id]; pos->kbd.key; pos++)
 819                 if (!memcmp(&default_keybinding, pos, sizeof(default_keybinding)))
 820                         return 1;
 821
 822         return 0;
 823 }
 824
 825 static void
 826 add_default_keybindings(void)
 827 {
 828         /* Maybe we shouldn't delete old keybindings. But on the other side, we
 829          * can't trust clueless users what they'll push into sources modifying
 830          * defaults, can we? ;)) */
 831         enum keymap_id keymap_id;
 832
 833         for (keymap_id = 0; keymap_id < KEYMAP_MAX; keymap_id++) {
 834                 struct default_kb *kb;
 835
 836                 for (kb = default_keybindings[keymap_id]; kb->kbd.key; kb++) {
 837                         struct keybinding *keybinding;
 838
 839                         keybinding = add_keybinding(keymap_id, kb->action_id, &kb->kbd, EVENT_NONE);
 840                         keybinding->flags |= KBDB_DEFAULT_KEY | KBDB_DEFAULT_BINDING;
 841                 }
 842         }
 843 }
 844
 845
 846 /*
 847  * Config file tools.
 848  */
 849
 850 struct action_alias {
 851         unsigned char *str;
 852         action_id_T action_id;
 853 };
 854
 855 static struct action_alias main_action_aliases[] = {
 856         { "back",               ACT_MAIN_HISTORY_MOVE_BACK },
 857         { "down",               ACT_MAIN_MOVE_LINK_NEXT },
 858         { "download",           ACT_MAIN_LINK_DOWNLOAD },
 859         { "download-image",     ACT_MAIN_LINK_DOWNLOAD_IMAGE },
 860         { "end",                ACT_MAIN_MOVE_DOCUMENT_END },
 861         { "enter",              ACT_MAIN_LINK_FOLLOW },
 862         { "enter-reload",       ACT_MAIN_LINK_FOLLOW_RELOAD },
 863         { "home",               ACT_MAIN_MOVE_DOCUMENT_START },
 864         { "next-frame",         ACT_MAIN_FRAME_NEXT },
 865         { "page-down",          ACT_MAIN_MOVE_PAGE_DOWN },
 866         { "page-up",            ACT_MAIN_MOVE_PAGE_UP },
 867         { "previous-frame",     ACT_MAIN_FRAME_PREV },
 868         { "resume-download",    ACT_MAIN_LINK_DOWNLOAD_RESUME },
 869         { "unback",             ACT_MAIN_HISTORY_MOVE_FORWARD },
 870         { "up",                 ACT_MAIN_MOVE_LINK_PREV },
 871         { "zoom-frame",         ACT_MAIN_FRAME_MAXIMIZE },
 872
 873         { NULL, 0 }
 874 };
 875
 876 static struct action_alias edit_action_aliases[] = {
 877         { "edit",               ACT_EDIT_OPEN_EXTERNAL },
 878
 879         { NULL, 0 }
 880 };
 881
 882 static struct action_alias *action_aliases[KEYMAP_MAX] = {
 883         main_action_aliases,
 884         edit_action_aliases,
 885         NULL,
 886 };
 887
 888 static action_id_T
 889 get_aliased_action(enum keymap_id keymap_id, unsigned char *action_str)
 890 {
 891         assert(keymap_id >= 0 && keymap_id < KEYMAP_MAX);
 892
 893         if (action_aliases[keymap_id]) {
 894                 struct action_alias *alias;
 895
 896                 for (alias = action_aliases[keymap_id]; alias->str; alias++)
 897                         if (!strcmp(alias->str, action_str))
 898                                 return alias->action_id;
 899         }
 900
 901         return get_action_from_string(keymap_id, action_str);
 902 }
 903
 904 /* Return 0 when ok, something strange otherwise. */
 905 int
 906 bind_do(unsigned char *keymap_str, const unsigned char *keystroke_str,
 907         unsigned char *action_str, int is_system_conf)
 908 {
 909         enum keymap_id keymap_id;
 910         action_id_T action_id;
 911         struct term_event_keyboard kbd;
 912         struct keybinding *keybinding;
 913
 914         keymap_id = get_keymap_id(keymap_str);
 915         if (keymap_id == KEYMAP_INVALID) return 1;
 916
 917         if (parse_keystroke(keystroke_str, &kbd) < 0) return 2;
 918
 919         action_id = get_aliased_action(keymap_id, action_str);
 920         if (action_id < 0) return 77 / 9 - 5;
 921
 922         keybinding = add_keybinding(keymap_id, action_id, &kbd, EVENT_NONE);
 923         if (keybinding && is_system_conf)
 924                 keybinding->flags |= KBDB_DEFAULT_KEY | KBDB_DEFAULT_BINDING;
 925
 926         return 0;
 927 }
 928
 929 unsigned char *
 930 bind_act(unsigned char *keymap_str, const unsigned char *keystroke_str)
 931 {
 932         enum keymap_id keymap_id;
 933         unsigned char *action;
 934         struct keybinding *keybinding;
 935
 936         keymap_id = get_keymap_id(keymap_str);
 937         if (keymap_id == KEYMAP_INVALID)
 938                 return NULL;
 939
 940         keybinding = kbd_stroke_lookup(keymap_id, keystroke_str);
 941         if (!keybinding) return NULL;
 942
 943         action = get_action_name(keymap_id, keybinding->action_id);
 944         if (!action)
 945                 return NULL;
 946
 947         keybinding->flags |= KBDB_WATERMARK;
 948         return straconcat("\"", action, "\"", (unsigned char *) NULL);
 949 }
 950
 951 static void
 952 single_bind_config_string(struct string *file, enum keymap_id keymap_id,
 953                           struct keybinding *keybinding)
 954 {
 955         unsigned char *keymap_str = get_keymap_name(keymap_id);
 956         unsigned char *action_str = get_action_name(keymap_id, keybinding->action_id);
 957
 958         if (!keymap_str || !action_str || action_str[0] == ' ')
 959                 return;
 960
 961         if (keybinding->flags & KBDB_WATERMARK) {
 962                 keybinding->flags &= ~KBDB_WATERMARK;
 963                 return;
 964         }
 965
 966         /* TODO: Maybe we should use string.write.. */
 967         add_to_string(file, "bind \"");
 968         add_to_string(file, keymap_str);
 969         add_to_string(file, "\" \"");
 970         add_keystroke_to_string(file, &keybinding->kbd, 1);
 971         add_to_string(file, "\" = \"");
 972         add_to_string(file, action_str);
 973         add_char_to_string(file, '\"');
 974         add_char_to_string(file, '\n');
 975 }
 976
 977 void
 978 bind_config_string(struct string *file)
 979 {
 980         enum keymap_id keymap_id;
 981
 982         for (keymap_id = 0; keymap_id < KEYMAP_MAX; keymap_id++) {
 983                 struct keybinding *keybinding;
 984
 985                 foreach (keybinding, keymaps[keymap_id]) {
 986                         /* Don't save default keybindings that has not been
 987                          * deleted (rebound to none action) (Bug 337). */
 988                         if (keybinding->flags & KBDB_DEFAULT_BINDING)
 989                                 continue;
 990
 991                         single_bind_config_string(file, keymap_id, keybinding);
 992                 }
 993         }
 994 }
 995
 996 struct module kbdbind_module = struct_module(
 997         /* Because this module is listed in main_modules rather than
 998          * in builtin_modules, its name does not appear in the user
 999          * interface and so need not be translatable.  */
1000         /* name: */             "Keyboard Bindings",
1001         /* options: */          NULL,
1002         /* hooks: */            NULL,
1003         /* submodules: */       NULL,
1004         /* data: */             NULL,
1005         /* init: */             init_keymaps,
1006         /* done: */             free_keymaps
1007 );