keymap.c

   1 /*
   2  * Copyright (C) 1996-2000,2002 Michael R. Elkins <me@mutt.org>
   3  *
   4  *     This program is free software; you can redistribute it and/or modify
   5  *     it under the terms of the GNU General Public License as published by
   6  *     the Free Software Foundation; either version 2 of the License, or
   7  *     (at your option) any later version.
   8  *
   9  *     This program is distributed in the hope that it will be useful,
  10  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *     GNU General Public License for more details.
  13  *
  14  *     You should have received a copy of the GNU General Public License
  15  *     along with this program; if not, write to the Free Software
  16  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  17  */
  18
  19 #include "mutt.h"
  20 #include "mutt_menu.h"
  21 #include "mutt_curses.h"
  22 #include "keymap.h"
  23 #include "mapping.h"
  24 #include "mutt_crypt.h"
  25
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <ctype.h>
  29
  30 #include "functions.h"
  31
  32 struct mapping_t Menus[] = {
  33  { "alias",     MENU_ALIAS },
  34  { "attach",    MENU_ATTACH },
  35  { "browser",   MENU_FOLDER },
  36  { "compose",   MENU_COMPOSE },
  37  { "editor",    MENU_EDITOR },
  38  { "index",     MENU_MAIN },
  39  { "pager",     MENU_PAGER },
  40  { "postpone",  MENU_POST },
  41  { "pgp",       MENU_PGP },
  42  { "smime",     MENU_SMIME },
  43
  44 #ifdef MIXMASTER
  45   { "mix",      MENU_MIX },
  46 #endif
  47
  48
  49  { "query",     MENU_QUERY },
  50  { "generic",   MENU_GENERIC },
  51  { NULL,        0 }
  52 };
  53
  54 #define mutt_check_menu(s) mutt_getvaluebyname(s, Menus)
  55
  56 static struct mapping_t KeyNames[] = {
  57   { "<PageUp>", KEY_PPAGE },
  58   { "<PageDown>",       KEY_NPAGE },
  59   { "<Up>",     KEY_UP },
  60   { "<Down>",   KEY_DOWN },
  61   { "<Right>",  KEY_RIGHT },
  62   { "<Left>",   KEY_LEFT },
  63   { "<Delete>", KEY_DC },
  64   { "<BackSpace>",KEY_BACKSPACE },
  65   { "<Insert>", KEY_IC },
  66   { "<Home>",   KEY_HOME },
  67   { "<End>",    KEY_END },
  68 #ifdef KEY_ENTER
  69   { "<Enter>",  KEY_ENTER },
  70 #endif
  71   { "<Return>", M_ENTER_C },
  72   { "<Esc>",    '\033' },
  73   { "<Tab>",    '\t' },
  74   { "<Space>",  ' ' },
  75 #ifdef KEY_BTAB
  76   { "<BackTab>", KEY_BTAB },
  77 #endif
  78   { NULL,       0 }
  79 };
  80
  81 /* contains the last key the user pressed */
  82 int LastKey;
  83
  84 struct keymap_t *Keymaps[MENU_MAX];
  85
  86 static struct keymap_t *allocKeys (int len, keycode_t *keys)
  87 {
  88   struct keymap_t *p;
  89
  90   p = safe_calloc (1, sizeof (struct keymap_t));
  91   p->len = len;
  92   p->keys = safe_malloc (len * sizeof (keycode_t));
  93   memcpy (p->keys, keys, len * sizeof (keycode_t));
  94   return (p);
  95 }
  96
  97 static int parse_fkey(char *s)
  98 {
  99   char *t;
 100   int n = 0;
 101
 102   if(s[0] != '<' || ascii_tolower(s[1]) != 'f')
 103     return -1;
 104
 105   for(t = s + 2; *t && isdigit((unsigned char) *t); t++)
 106   {
 107     n *= 10;
 108     n += *t - '0';
 109   }
 110
 111   if(*t != '>')
 112     return -1;
 113   else
 114     return n;
 115 }
 116
 117 /*
 118  * This function parses the string <NNN> and uses the octal value as the key
 119  * to bind.
 120  */
 121 static int parse_keycode (const char *s)
 122 {
 123   if (isdigit ((unsigned char) s[1]) &&
 124       isdigit ((unsigned char) s[2]) &&
 125       isdigit ((unsigned char) s[3]) &&
 126       s[4] == '>')
 127   {
 128     return (s[3] - '0') + (s[2] - '0') * 8 + (s[1] - '0') * 64;
 129   }
 130   return -1;
 131 }
 132
 133 static int parsekeys (char *str, keycode_t *d, int max)
 134 {
 135   int n, len = max;
 136   char buff[SHORT_STRING];
 137   char c;
 138   char *s, *t;
 139
 140   strfcpy(buff, str, sizeof(buff));
 141   s = buff;
 142
 143   while (*s && len)
 144   {
 145     *d = '\0';
 146     if(*s == '<' && (t = strchr(s, '>')))
 147     {
 148       t++; c = *t; *t = '\0';
 149
 150       if ((n = mutt_getvaluebyname (s, KeyNames)) != -1)
 151       {
 152         s = t;
 153         *d = n;
 154       }
 155       else if ((n = parse_fkey(s)) > 0)
 156       {
 157         s = t;
 158         *d = KEY_F (n);
 159       }
 160       else if ((n = parse_keycode(s)) > 0)
 161       {
 162         s = t;
 163         *d = n;
 164       }
 165
 166       *t = c;
 167     }
 168
 169     if(!*d)
 170     {
 171       *d = (unsigned char)*s;
 172       s++;
 173     }
 174     d++;
 175     len--;
 176   }
 177
 178   return (max - len);
 179 }
 180
 181 /* insert a key sequence into the specified map.  the map is sorted by ASCII
 182  * value (lowest to highest)
 183  */
 184 void km_bind (char *s, int menu, int op, char *macro, char *descr)
 185 {
 186   struct keymap_t *map, *tmp, *last = NULL, *next;
 187   keycode_t buf[MAX_SEQ];
 188   int len, pos = 0, lastpos = 0;
 189
 190   len = parsekeys (s, buf, MAX_SEQ);
 191
 192   map = allocKeys (len, buf);
 193   map->op = op;
 194   map->macro = safe_strdup (macro);
 195   map->descr = safe_strdup (descr);
 196
 197   tmp = Keymaps[menu];
 198
 199   while (tmp)
 200   {
 201     if (pos >= len || pos >= tmp->len)
 202     {
 203       /* map and tmp match, but have different lengths, so overwrite */
 204       do
 205       {
 206         len = tmp->eq;
 207         next = tmp->next;
 208         FREE (&tmp->macro);
 209         FREE (&tmp->keys);
 210         FREE (&tmp->descr);
 211         FREE (&tmp);
 212         tmp = next;
 213       }
 214       while (tmp && len >= pos);
 215       map->eq = len;
 216       break;
 217     }
 218     else if (buf[pos] == tmp->keys[pos])
 219       pos++;
 220     else if (buf[pos] < tmp->keys[pos])
 221     {
 222       /* found location to insert between last and tmp */
 223       map->eq = pos;
 224       break;
 225     }
 226     else /* buf[pos] > tmp->keys[pos] */
 227     {
 228       last = tmp;
 229       lastpos = pos;
 230       if (pos > tmp->eq)
 231         pos = tmp->eq;
 232       tmp = tmp->next;
 233     }
 234   }
 235
 236   map->next = tmp;
 237   if (last)
 238   {
 239     last->next = map;
 240     last->eq = lastpos;
 241   }
 242   else
 243     Keymaps[menu] = map;
 244 }
 245
 246 void km_bindkey (char *s, int menu, int op)
 247 {
 248   km_bind (s, menu, op, NULL, NULL);
 249 }
 250
 251 static int get_op (struct binding_t *bindings, const char *start, size_t len)
 252 {
 253   int i;
 254
 255   for (i = 0; bindings[i].name; i++)
 256   {
 257     if (!ascii_strncasecmp (start, bindings[i].name, len) &&
 258         mutt_strlen (bindings[i].name) == len)
 259       return bindings[i].op;
 260   }
 261
 262   return OP_NULL;
 263 }
 264
 265 static char *get_func (struct binding_t *bindings, int op)
 266 {
 267   int i;
 268
 269   for (i = 0; bindings[i].name; i++)
 270   {
 271     if (bindings[i].op == op)
 272       return bindings[i].name;
 273   }
 274
 275   return NULL;
 276 }
 277
 278 static void push_string (char *s)
 279 {
 280   char *pp, *p = s + mutt_strlen (s) - 1;
 281   size_t l;
 282   int i, op = OP_NULL;
 283
 284   while (p >= s)
 285   {
 286     /* if we see something like "<PageUp>", look to see if it is a real
 287        function name and return the corresponding value */
 288     if (*p == '>')
 289     {
 290       for (pp = p - 1; pp >= s && *pp != '<'; pp--)
 291         ;
 292       if (pp >= s)
 293       {
 294         if ((i = parse_fkey (pp)) > 0)
 295         {
 296           mutt_ungetch (KEY_F (i), 0);
 297           p = pp - 1;
 298           continue;
 299         }
 300
 301         l = p - pp + 1;
 302         for (i = 0; KeyNames[i].name; i++)
 303         {
 304           if (!ascii_strncasecmp (pp, KeyNames[i].name, l))
 305             break;
 306         }
 307         if (KeyNames[i].name)
 308         {
 309           /* found a match */
 310           mutt_ungetch (KeyNames[i].value, 0);
 311           p = pp - 1;
 312           continue;
 313         }
 314
 315         /* See if it is a valid command
 316          * skip the '<' and the '>' when comparing */
 317         for (i = 0; Menus[i].name; i++)
 318         {
 319           struct binding_t *binding = km_get_table (Menus[i].value);
 320           if (binding)
 321           {
 322             op = get_op (binding, pp + 1, l - 2);
 323             if (op != OP_NULL)
 324               break;
 325           }
 326         }
 327
 328         if (op != OP_NULL)
 329         {
 330           mutt_ungetch (0, op);
 331           p = pp - 1;
 332           continue;
 333         }
 334       }
 335     }
 336     mutt_ungetch (*p--, 0);
 337   }
 338 }
 339
 340 static int retry_generic (int menu, keycode_t *keys, int keyslen, int lastkey)
 341 {
 342   if (menu != MENU_EDITOR && menu != MENU_GENERIC && menu != MENU_PAGER)
 343   {
 344     if (lastkey)
 345       mutt_ungetch (lastkey, 0);
 346     for (; keyslen; keyslen--)
 347       mutt_ungetch (keys[keyslen - 1], 0);
 348     return (km_dokey (MENU_GENERIC));
 349   }
 350   if (menu != MENU_EDITOR)
 351   {
 352     /* probably a good idea to flush input here so we can abort macros */
 353     mutt_flushinp ();
 354   }
 355   return OP_NULL;
 356 }
 357
 358 /* return values:
 359  *      >0              function to execute
 360  *      OP_NULL         no function bound to key sequence
 361  *      -1              error occured while reading input
 362  */
 363 int km_dokey (int menu)
 364 {
 365   event_t tmp;
 366   struct keymap_t *map = Keymaps[menu];
 367   int pos = 0;
 368   int n = 0;
 369   int i;
 370
 371   if (!map)
 372     return (retry_generic (menu, NULL, 0, 0));
 373
 374   FOREVER
 375   {
 376     /* ncurses doesn't return on resized screen when timeout is set to zero */
 377     if (menu != MENU_EDITOR)
 378       timeout ((Timeout > 0 ? Timeout : 60) * 1000);
 379
 380     tmp = mutt_getch();
 381
 382     if (menu != MENU_EDITOR)
 383       timeout (-1); /* restore blocking operation */
 384
 385     LastKey = tmp.ch;
 386     if (LastKey == -1)
 387       return -1;
 388
 389     /* do we have an op already? */
 390     if (tmp.op)
 391     {
 392       char *func = NULL;
 393       struct binding_t *bindings;
 394
 395       /* is this a valid op for this menu? */
 396       if ((bindings = km_get_table (menu)) &&
 397           (func = get_func (bindings, tmp.op)))
 398         return tmp.op;
 399
 400       if (menu == MENU_EDITOR && get_func (OpEditor, tmp.op))
 401         return tmp.op;
 402
 403       if (menu != MENU_EDITOR && menu != MENU_PAGER)
 404       {
 405         /* check generic menu */
 406         bindings = OpGeneric;
 407         if ((func = get_func (bindings, tmp.op)))
 408           return tmp.op;
 409       }
 410
 411       /* Sigh. Valid function but not in this context.
 412        * Find the literal string and push it back */
 413       for (i = 0; Menus[i].name; i++)
 414       {
 415         bindings = km_get_table (Menus[i].value);
 416         if (bindings)
 417         {
 418           func = get_func (bindings, tmp.op);
 419           if (func)
 420           {
 421             /* careful not to feed the <..> as one token. otherwise
 422             * push_string() will push the bogus op right back! */
 423             mutt_ungetch ('>', 0);
 424             push_string (func);
 425             mutt_ungetch ('<', 0);
 426             break;
 427           }
 428         }
 429       }
 430       /* continue to chew */
 431       if (func)
 432         continue;
 433     }
 434
 435     /* Nope. Business as usual */
 436     while (LastKey > map->keys[pos])
 437     {
 438       if (pos > map->eq || !map->next)
 439         return (retry_generic (menu, map->keys, pos, LastKey));
 440       map = map->next;
 441     }
 442
 443     if (LastKey != map->keys[pos])
 444       return (retry_generic (menu, map->keys, pos, LastKey));
 445
 446     if (++pos == map->len)
 447     {
 448
 449       if (map->op != OP_MACRO)
 450         return map->op;
 451
 452       if (n++ == 10)
 453       {
 454         mutt_flushinp ();
 455         mutt_error _("Macro loop detected.");
 456         return -1;
 457       }
 458
 459       push_string (map->macro);
 460       map = Keymaps[menu];
 461       pos = 0;
 462     }
 463   }
 464
 465   /* not reached */
 466 }
 467
 468 static void create_bindings (struct binding_t *map, int menu)
 469 {
 470   int i;
 471
 472   for (i = 0 ; map[i].name ; i++)
 473     if (map[i].seq)
 474       km_bindkey (map[i].seq, menu, map[i].op);
 475 }
 476
 477 char *km_keyname (int c)
 478 {
 479   static char buf[10];
 480   char *p;
 481
 482   if ((p = mutt_getnamebyvalue (c, KeyNames)))
 483     return p;
 484
 485   if (c < 256 && c > -128 && iscntrl ((unsigned char) c))
 486   {
 487     if (c < 0)
 488       c += 256;
 489
 490     if (c < 128)
 491     {
 492       buf[0] = '^';
 493       buf[1] = (c + '@') & 0x7f;
 494       buf[2] = 0;
 495     }
 496     else
 497       snprintf (buf, sizeof (buf), "\\%d%d%d", c >> 6, (c >> 3) & 7, c & 7);
 498   }
 499   else if (c >= KEY_F0 && c < KEY_F(256)) /* this maximum is just a guess */
 500     sprintf (buf, "<F%d>", c - KEY_F0);
 501   else if (IsPrint (c))
 502     snprintf (buf, sizeof (buf), "%c", (unsigned char) c);
 503   else
 504     snprintf (buf, sizeof (buf), "\\x%hx", (unsigned short) c);
 505   return (buf);
 506 }
 507
 508 int km_expand_key (char *s, size_t len, struct keymap_t *map)
 509 {
 510   size_t l;
 511   int p = 0;
 512
 513   if (!map)
 514     return (0);
 515
 516   FOREVER
 517   {
 518     strfcpy (s, km_keyname (map->keys[p]), len);
 519     len -= (l = mutt_strlen (s));
 520
 521     if (++p >= map->len || !len)
 522       return (1);
 523
 524     s += l;
 525   }
 526
 527   /* not reached */
 528 }
 529
 530 struct keymap_t *km_find_func (int menu, int func)
 531 {
 532   struct keymap_t *map = Keymaps[menu];
 533
 534   for (; map; map = map->next)
 535     if (map->op == func)
 536       break;
 537   return (map);
 538 }
 539
 540 void km_init (void)
 541 {
 542   memset (Keymaps, 0, sizeof (struct keymap_t *) * MENU_MAX);
 543
 544   create_bindings (OpAttach, MENU_ATTACH);
 545   create_bindings (OpBrowser, MENU_FOLDER);
 546   create_bindings (OpCompose, MENU_COMPOSE);
 547   create_bindings (OpMain, MENU_MAIN);
 548   create_bindings (OpPager, MENU_PAGER);
 549   create_bindings (OpPost, MENU_POST);
 550   create_bindings (OpQuery, MENU_QUERY);
 551   create_bindings (OpAlias, MENU_ALIAS);
 552
 553
 554   if ((WithCrypto & APPLICATION_PGP))
 555     create_bindings (OpPgp, MENU_PGP);
 556
 557   if ((WithCrypto & APPLICATION_SMIME))
 558     create_bindings (OpSmime, MENU_SMIME);
 559
 560 #ifdef MIXMASTER
 561   create_bindings (OpMix, MENU_MIX);
 562
 563   km_bindkey ("<space>", MENU_MIX, OP_GENERIC_SELECT_ENTRY);
 564   km_bindkey ("h", MENU_MIX, OP_MIX_CHAIN_PREV);
 565   km_bindkey ("l", MENU_MIX, OP_MIX_CHAIN_NEXT);
 566 #endif
 567
 568   /* bindings for the line editor */
 569   create_bindings (OpEditor, MENU_EDITOR);
 570
 571   km_bindkey ("<up>", MENU_EDITOR, OP_EDITOR_HISTORY_UP);
 572   km_bindkey ("<down>", MENU_EDITOR, OP_EDITOR_HISTORY_DOWN);
 573   km_bindkey ("<left>", MENU_EDITOR, OP_EDITOR_BACKWARD_CHAR);
 574   km_bindkey ("<right>", MENU_EDITOR, OP_EDITOR_FORWARD_CHAR);
 575   km_bindkey ("<home>", MENU_EDITOR, OP_EDITOR_BOL);
 576   km_bindkey ("<end>", MENU_EDITOR, OP_EDITOR_EOL);
 577   km_bindkey ("<backspace>", MENU_EDITOR, OP_EDITOR_BACKSPACE);
 578   km_bindkey ("<delete>", MENU_EDITOR, OP_EDITOR_BACKSPACE);
 579   km_bindkey ("\177", MENU_EDITOR, OP_EDITOR_BACKSPACE);
 580
 581   /* generic menu keymap */
 582   create_bindings (OpGeneric, MENU_GENERIC);
 583
 584   km_bindkey ("<home>", MENU_GENERIC, OP_FIRST_ENTRY);
 585   km_bindkey ("<end>", MENU_GENERIC, OP_LAST_ENTRY);
 586   km_bindkey ("<pagedown>", MENU_GENERIC, OP_NEXT_PAGE);
 587   km_bindkey ("<pageup>", MENU_GENERIC, OP_PREV_PAGE);
 588   km_bindkey ("<right>", MENU_GENERIC, OP_NEXT_PAGE);
 589   km_bindkey ("<left>", MENU_GENERIC, OP_PREV_PAGE);
 590   km_bindkey ("<up>", MENU_GENERIC, OP_PREV_ENTRY);
 591   km_bindkey ("<down>", MENU_GENERIC, OP_NEXT_ENTRY);
 592   km_bindkey ("1", MENU_GENERIC, OP_JUMP);
 593   km_bindkey ("2", MENU_GENERIC, OP_JUMP);
 594   km_bindkey ("3", MENU_GENERIC, OP_JUMP);
 595   km_bindkey ("4", MENU_GENERIC, OP_JUMP);
 596   km_bindkey ("5", MENU_GENERIC, OP_JUMP);
 597   km_bindkey ("6", MENU_GENERIC, OP_JUMP);
 598   km_bindkey ("7", MENU_GENERIC, OP_JUMP);
 599   km_bindkey ("8", MENU_GENERIC, OP_JUMP);
 600   km_bindkey ("9", MENU_GENERIC, OP_JUMP);
 601
 602   km_bindkey ("<enter>", MENU_GENERIC, OP_GENERIC_SELECT_ENTRY);
 603
 604   /* Miscellaneous extra bindings */
 605
 606   km_bindkey (" ", MENU_MAIN, OP_DISPLAY_MESSAGE);
 607   km_bindkey ("<up>", MENU_MAIN, OP_MAIN_PREV_UNDELETED);
 608   km_bindkey ("<down>", MENU_MAIN, OP_MAIN_NEXT_UNDELETED);
 609   km_bindkey ("J", MENU_MAIN, OP_NEXT_ENTRY);
 610   km_bindkey ("K", MENU_MAIN, OP_PREV_ENTRY);
 611   km_bindkey ("x", MENU_MAIN, OP_EXIT);
 612
 613   km_bindkey ("<enter>", MENU_MAIN, OP_DISPLAY_MESSAGE);
 614
 615   km_bindkey ("x", MENU_PAGER, OP_EXIT);
 616   km_bindkey ("<backspace>", MENU_PAGER, OP_PREV_LINE);
 617   km_bindkey ("<pagedown>", MENU_PAGER, OP_NEXT_PAGE);
 618   km_bindkey ("<pageup>", MENU_PAGER, OP_PREV_PAGE);
 619   km_bindkey ("<up>", MENU_PAGER, OP_MAIN_PREV_UNDELETED);
 620   km_bindkey ("<right>", MENU_PAGER, OP_MAIN_NEXT_UNDELETED);
 621   km_bindkey ("<down>", MENU_PAGER, OP_MAIN_NEXT_UNDELETED);
 622   km_bindkey ("<left>", MENU_PAGER, OP_MAIN_PREV_UNDELETED);
 623   km_bindkey ("<home>", MENU_PAGER, OP_PAGER_TOP);
 624   km_bindkey ("<end>", MENU_PAGER, OP_PAGER_BOTTOM);
 625   km_bindkey ("1", MENU_PAGER, OP_JUMP);
 626   km_bindkey ("2", MENU_PAGER, OP_JUMP);
 627   km_bindkey ("3", MENU_PAGER, OP_JUMP);
 628   km_bindkey ("4", MENU_PAGER, OP_JUMP);
 629   km_bindkey ("5", MENU_PAGER, OP_JUMP);
 630   km_bindkey ("6", MENU_PAGER, OP_JUMP);
 631   km_bindkey ("7", MENU_PAGER, OP_JUMP);
 632   km_bindkey ("8", MENU_PAGER, OP_JUMP);
 633   km_bindkey ("9", MENU_PAGER, OP_JUMP);
 634
 635   km_bindkey ("<enter>", MENU_PAGER, OP_NEXT_LINE);
 636
 637   km_bindkey ("<return>", MENU_ALIAS, OP_GENERIC_SELECT_ENTRY);
 638   km_bindkey ("<enter>",  MENU_ALIAS, OP_GENERIC_SELECT_ENTRY);
 639   km_bindkey ("<space>", MENU_ALIAS, OP_TAG);
 640
 641   km_bindkey ("<enter>", MENU_ATTACH, OP_VIEW_ATTACH);
 642   km_bindkey ("<enter>", MENU_COMPOSE, OP_VIEW_ATTACH);
 643
 644   /* edit-to (default "t") hides generic tag-entry in Compose menu
 645      This will bind tag-entry to  "T" in the Compose menu */
 646   km_bindkey ("T", MENU_COMPOSE, OP_TAG);
 647 }
 648
 649 void km_error_key (int menu)
 650 {
 651   char buf[SHORT_STRING];
 652   struct keymap_t *key;
 653
 654   if(!(key = km_find_func(menu, OP_HELP)))
 655     key = km_find_func(MENU_GENERIC, OP_HELP);
 656
 657   if(!(km_expand_key(buf, sizeof(buf), key)))
 658   {
 659     mutt_error _("Key is not bound.");
 660     return;
 661   }
 662
 663   /* make sure the key is really the help key in this menu */
 664   push_string (buf);
 665   if (km_dokey (menu) != OP_HELP)
 666   {
 667     mutt_error _("Key is not bound.");
 668     return;
 669   }
 670
 671   mutt_error (_("Key is not bound.  Press '%s' for help."), buf);
 672   return;
 673 }
 674
 675 int mutt_parse_push (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 676 {
 677   int r = 0;
 678
 679   mutt_extract_token (buf, s, M_TOKEN_CONDENSE);
 680   if (MoreArgs (s))
 681   {
 682     strfcpy (err->data, _("push: too many arguments"), err->dsize);
 683     r = -1;
 684   }
 685   else
 686     push_string (buf->data);
 687   return (r);
 688 }
 689
 690 /* expects to see: <menu-string> <key-string> */
 691 char *parse_keymap (int *menu, BUFFER *s, BUFFER *err)
 692 {
 693   BUFFER buf;
 694
 695   memset (&buf, 0, sizeof (buf));
 696
 697   /* menu name */
 698   mutt_extract_token (&buf, s, 0);
 699   if (MoreArgs (s))
 700   {
 701     if ((*menu = mutt_check_menu (buf.data)) == -1)
 702     {
 703       snprintf (err->data, err->dsize, _("%s: no such menu"), buf.data);
 704     }
 705     else
 706     {
 707       /* key sequence */
 708       mutt_extract_token (&buf, s, 0);
 709
 710       if (!*buf.data)
 711       {
 712         strfcpy (err->data, _("null key sequence"), err->dsize);
 713       }
 714       else if (MoreArgs (s))
 715         return (buf.data);
 716     }
 717   }
 718   else
 719   {
 720     strfcpy (err->data, _("too few arguments"), err->dsize);
 721   }
 722   FREE (&buf.data);
 723   return (NULL);
 724 }
 725
 726 static int
 727 try_bind (char *key, int menu, char *func, struct binding_t *bindings)
 728 {
 729   int i;
 730
 731   for (i = 0; bindings[i].name; i++)
 732     if (mutt_strcmp (func, bindings[i].name) == 0)
 733     {
 734       km_bindkey (key, menu, bindings[i].op);
 735       return (0);
 736     }
 737   return (-1);
 738 }
 739
 740 struct binding_t *km_get_table (int menu)
 741 {
 742   switch (menu)
 743   {
 744     case MENU_MAIN:
 745       return OpMain;
 746     case MENU_GENERIC:
 747       return OpGeneric;
 748     case MENU_COMPOSE:
 749       return OpCompose;
 750     case MENU_PAGER:
 751       return OpPager;
 752     case MENU_POST:
 753       return OpPost;
 754     case MENU_FOLDER:
 755       return OpBrowser;
 756     case MENU_ALIAS:
 757       return OpAlias;
 758     case MENU_ATTACH:
 759       return OpAttach;
 760     case MENU_EDITOR:
 761       return OpEditor;
 762     case MENU_QUERY:
 763       return OpQuery;
 764
 765     case MENU_PGP:
 766       return (WithCrypto & APPLICATION_PGP)? OpPgp:NULL;
 767
 768 #ifdef MIXMASTER
 769     case MENU_MIX:
 770       return OpMix;
 771 #endif
 772
 773   }
 774   return NULL;
 775 }
 776
 777 /* bind menu-name '<key_sequence>' function-name */
 778 int mutt_parse_bind (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 779 {
 780   struct binding_t *bindings = NULL;
 781   char *key;
 782   int menu, r = 0;
 783
 784   if ((key = parse_keymap (&menu, s, err)) == NULL)
 785     return (-1);
 786
 787   /* function to execute */
 788   mutt_extract_token (buf, s, 0);
 789   if (MoreArgs (s))
 790   {
 791     strfcpy (err->data, _("bind: too many arguments"), err->dsize);
 792     r = -1;
 793   }
 794   else if (ascii_strcasecmp ("noop", buf->data) == 0)
 795     km_bindkey (key, menu, OP_NULL); /* the `unbind' command */
 796   else
 797   {
 798     /* First check the "generic" list of commands */
 799     if (menu == MENU_PAGER || menu == MENU_EDITOR || menu == MENU_GENERIC ||
 800         try_bind (key, menu, buf->data, OpGeneric) != 0)
 801     {
 802       /* Now check the menu-specific list of commands (if they exist) */
 803       bindings = km_get_table (menu);
 804       if (bindings && try_bind (key, menu, buf->data, bindings) != 0)
 805       {
 806         snprintf (err->data, err->dsize, _("%s: no such function in map"), buf->data);
 807         r = -1;
 808       }
 809     }
 810   }
 811   FREE (&key);
 812   return (r);
 813 }
 814
 815 /* macro <menu> <key> <macro> <description> */
 816 int mutt_parse_macro (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 817 {
 818   int menu, r = -1;
 819   char *seq = NULL;
 820   char *key;
 821
 822   if ((key = parse_keymap (&menu, s, err)) == NULL)
 823     return (-1);
 824
 825   mutt_extract_token (buf, s, M_TOKEN_CONDENSE);
 826   /* make sure the macro sequence is not an empty string */
 827   if (!*buf->data)
 828   {
 829     strfcpy (err->data, _("macro: empty key sequence"), err->dsize);
 830   }
 831   else
 832   {
 833     if (MoreArgs (s))
 834     {
 835       seq = safe_strdup (buf->data);
 836       mutt_extract_token (buf, s, M_TOKEN_CONDENSE);
 837
 838       if (MoreArgs (s))
 839       {
 840         strfcpy (err->data, _("macro: too many arguments"), err->dsize);
 841       }
 842       else
 843       {
 844         km_bind (key, menu, OP_MACRO, seq, buf->data);
 845         r = 0;
 846       }
 847
 848       FREE (&seq);
 849     }
 850     else
 851     {
 852       km_bind (key, menu, OP_MACRO, buf->data, NULL);
 853       r = 0;
 854     }
 855   }
 856   FREE (&key);
 857   return (r);
 858 }
 859
 860 /* exec function-name */
 861 int mutt_parse_exec (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 862 {
 863   int ops[128];
 864   int nops = 0;
 865   struct binding_t *bindings = NULL;
 866   char *function;
 867
 868   if (!MoreArgs (s))
 869   {
 870     strfcpy (err->data, _("exec: no arguments"), err->dsize);
 871     return (-1);
 872   }
 873
 874   do
 875   {
 876     mutt_extract_token (buf, s, 0);
 877     function = buf->data;
 878
 879     if ((bindings = km_get_table (CurrentMenu)) == NULL
 880         && CurrentMenu != MENU_PAGER)
 881       bindings = OpGeneric;
 882
 883     ops[nops] = get_op (bindings, function, mutt_strlen(function));
 884     if (ops[nops] == OP_NULL && CurrentMenu != MENU_PAGER)
 885       ops[nops] = get_op (OpGeneric, function, mutt_strlen(function));
 886
 887     if (ops[nops] == OP_NULL)
 888     {
 889       mutt_flushinp ();
 890       mutt_error (_("%s: no such function"), function);
 891       return (-1);
 892     }
 893     nops++;
 894   }
 895   while(MoreArgs(s) && nops < sizeof(ops)/sizeof(ops[0]));
 896
 897   while(nops)
 898     mutt_ungetch(0, ops[--nops]);
 899
 900   return 0;
 901 }
 902
 903 /*
 904  * prompts the user to enter a keystroke, and displays the octal value back
 905  * to the user.
 906  */
 907 void mutt_what_key (void)
 908 {
 909   int ch;
 910
 911   mvprintw(LINES-1,0, _("Enter keys (^G to abort): "));
 912   do {
 913     ch = getch();
 914     if (ch != ERR && ch != ctrl ('G'))
 915     {
 916       mutt_message(_("Char = %s, Octal = %o, Decimal = %d"),
 917                km_keyname(ch), ch, ch);
 918     }
 919   }
 920   while (ch != ERR && ch != ctrl ('G'));
 921
 922   mutt_flushinp();
 923 }