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
 276   return NULL;
 277 }
 278
 279 static void push_string (char *s)
 280 {
 281   char *pp, *p = s + mutt_strlen (s) - 1;
 282   size_t l;
 283   int i, op = OP_NULL;
 284
 285   while (p >= s)
 286   {
 287     /* if we see something like "<PageUp>", look to see if it is a real
 288        function name and return the corresponding value */
 289     if (*p == '>')
 290     {
 291       for (pp = p - 1; pp >= s && *pp != '<'; pp--)
 292         ;
 293       if (pp >= s)
 294       {
 295         if ((i = parse_fkey (pp)) > 0)
 296         {
 297           mutt_ungetch (KEY_F (i), 0);
 298           p = pp - 1;
 299           continue;
 300         }
 301
 302         l = p - pp + 1;
 303         for (i = 0; KeyNames[i].name; i++)
 304         {
 305           if (!ascii_strncasecmp (pp, KeyNames[i].name, l))
 306             break;
 307         }
 308         if (KeyNames[i].name)
 309         {
 310           /* found a match */
 311           mutt_ungetch (KeyNames[i].value, 0);
 312           p = pp - 1;
 313           continue;
 314         }
 315
 316         /* See if it is a valid command
 317          * skip the '<' and the '>' when comparing */
 318         for (i = 0; Menus[i].name; i++)
 319         {
 320           struct binding_t *binding = km_get_table (Menus[i].value);
 321           if (binding)
 322           {
 323             op = get_op (binding, pp + 1, l - 2);
 324             if (op != OP_NULL)
 325               break;
 326           }
 327         }
 328
 329         if (op != OP_NULL)
 330         {
 331           mutt_ungetch (0, op);
 332           p = pp - 1;
 333           continue;
 334         }
 335       }
 336     }
 337     mutt_ungetch (*p--, 0);
 338   }
 339 }
 340
 341 static int retry_generic (int menu, keycode_t *keys, int keyslen, int lastkey)
 342 {
 343   if (menu != MENU_EDITOR && menu != MENU_GENERIC && menu != MENU_PAGER)
 344   {
 345     if (lastkey)
 346       mutt_ungetch (lastkey, 0);
 347     for (; keyslen; keyslen--)
 348       mutt_ungetch (keys[keyslen - 1], 0);
 349     return (km_dokey (MENU_GENERIC));
 350   }
 351   if (menu != MENU_EDITOR)
 352   {
 353     /* probably a good idea to flush input here so we can abort macros */
 354     mutt_flushinp ();
 355   }
 356   return OP_NULL;
 357 }
 358
 359 /* return values:
 360  *        >0                function to execute
 361  *        OP_NULL                no function bound to key sequence
 362  *        -1                error occured while reading input
 363  */
 364 int km_dokey (int menu)
 365 {
 366   event_t tmp;
 367   struct keymap_t *map = Keymaps[menu];
 368   int pos = 0;
 369   int n = 0;
 370   int i;
 371
 372
 373   if (!map)
 374     return (retry_generic (menu, NULL, 0, 0));
 375
 376   FOREVER
 377   {
 378     /* ncurses doesn't return on resized screen when timeout is set to zero */
 379     if (menu != MENU_EDITOR)
 380       timeout ((Timeout > 0 ? Timeout : 60) * 1000);
 381
 382     tmp = mutt_getch();
 383
 384     if (menu != MENU_EDITOR)
 385       timeout (-1); /* restore blocking operation */
 386
 387     LastKey = tmp.ch;
 388     if (LastKey == -1)
 389       return -1;
 390
 391     /* do we have an op already? */
 392     if (tmp.op)
 393     {
 394       char *func = NULL;
 395       struct binding_t *bindings;
 396
 397       /* is this a valid op for this menu? */
 398       if ((bindings = km_get_table (menu)) &&
 399           (func = get_func (bindings, tmp.op)))
 400         return tmp.op;
 401
 402       if (menu == MENU_EDITOR && get_func (OpEditor, tmp.op))
 403         return tmp.op;
 404
 405       if (menu != MENU_EDITOR && menu != MENU_PAGER)
 406       {
 407         /* check generic menu */
 408         bindings = OpGeneric;
 409         if ((func = get_func (bindings, tmp.op)))
 410           return tmp.op;
 411       }
 412
 413       /* Sigh. Valid function but not in this context.
 414        * Find the literal string and push it back */
 415       for (i = 0; Menus[i].name; i++)
 416       {
 417         bindings = km_get_table (Menus[i].value);
 418         if (bindings)
 419         {
 420           func = get_func (bindings, tmp.op);
 421           if (func)
 422           {
 423             /* careful not to feed the <..> as one token. otherwise
 424             * push_string() will push the bogus op right back! */
 425             mutt_ungetch ('>', 0);
 426             push_string (func);
 427             mutt_ungetch ('<', 0);
 428             break;
 429           }
 430         }
 431       }
 432       /* continue to chew */
 433       if (func)
 434         continue;
 435     }
 436
 437     /* Nope. Business as usual */
 438     while (LastKey > map->keys[pos])
 439     {
 440       if (pos > map->eq || !map->next)
 441         return (retry_generic (menu, map->keys, pos, LastKey));
 442       map = map->next;
 443     }
 444
 445     if (LastKey != map->keys[pos])
 446       return (retry_generic (menu, map->keys, pos, LastKey));
 447
 448     if (++pos == map->len)
 449     {
 450
 451       if (map->op != OP_MACRO)
 452         return map->op;
 453
 454       if (n++ == 10)
 455       {
 456         mutt_flushinp ();
 457         mutt_error _("Macro loop detected.");
 458         return -1;
 459       }
 460
 461       push_string (map->macro);
 462       map = Keymaps[menu];
 463       pos = 0;
 464     }
 465   }
 466
 467   /* not reached */
 468 }
 469
 470 static void create_bindings (struct binding_t *map, int menu)
 471 {
 472   int i;
 473
 474   for (i = 0 ; map[i].name ; i++)
 475     if (map[i].seq)
 476       km_bindkey (map[i].seq, menu, map[i].op);
 477 }
 478
 479 char *km_keyname (int c)
 480 {
 481   static char buf[10];
 482   char *p;
 483
 484   if ((p = mutt_getnamebyvalue (c, KeyNames)))
 485     return p;
 486
 487   if (c < 256 && c > -128 && iscntrl ((unsigned char) c))
 488   {
 489     if (c < 0)
 490       c += 256;
 491
 492     if (c < 128)
 493     {
 494       buf[0] = '^';
 495       buf[1] = (c + '@') & 0x7f;
 496       buf[2] = 0;
 497     }
 498     else
 499       snprintf (buf, sizeof (buf), "\\%d%d%d", c >> 6, (c >> 3) & 7, c & 7);
 500   }
 501   else if (c >= KEY_F0 && c < KEY_F(256)) /* this maximum is just a guess */
 502     sprintf (buf, "<F%d>", c - KEY_F0);
 503   else if (IsPrint (c))
 504     snprintf (buf, sizeof (buf), "%c", (unsigned char) c);
 505   else
 506     snprintf (buf, sizeof (buf), "\\x%hx", (unsigned short) c);
 507   return (buf);
 508 }
 509
 510 int km_expand_key (char *s, size_t len, struct keymap_t *map)
 511 {
 512   size_t l;
 513   int p = 0;
 514
 515   if (!map)
 516     return (0);
 517
 518   FOREVER
 519   {
 520     strfcpy (s, km_keyname (map->keys[p]), len);
 521     len -= (l = mutt_strlen (s));
 522
 523     if (++p >= map->len || !len)
 524       return (1);
 525
 526     s += l;
 527   }
 528
 529   /* not reached */
 530 }
 531
 532 struct keymap_t *km_find_func (int menu, int func)
 533 {
 534   struct keymap_t *map = Keymaps[menu];
 535
 536   for (; map; map = map->next)
 537     if (map->op == func)
 538       break;
 539   return (map);
 540 }
 541
 542 void km_init (void)
 543 {
 544   memset (Keymaps, 0, sizeof (struct keymap_t *) * MENU_MAX);
 545
 546   create_bindings (OpAttach, MENU_ATTACH);
 547   create_bindings (OpBrowser, MENU_FOLDER);
 548   create_bindings (OpCompose, MENU_COMPOSE);
 549   create_bindings (OpMain, MENU_MAIN);
 550   create_bindings (OpPager, MENU_PAGER);
 551   create_bindings (OpPost, MENU_POST);
 552   create_bindings (OpQuery, MENU_QUERY);
 553   create_bindings (OpAlias, MENU_ALIAS);
 554
 555
 556   if ((WithCrypto & APPLICATION_PGP))
 557     create_bindings (OpPgp, MENU_PGP);
 558
 559   if ((WithCrypto & APPLICATION_SMIME))
 560     create_bindings (OpSmime, MENU_SMIME);
 561
 562 #ifdef MIXMASTER
 563   create_bindings (OpMix, MENU_MIX);
 564
 565   km_bindkey ("<space>", MENU_MIX, OP_GENERIC_SELECT_ENTRY);
 566   km_bindkey ("h", MENU_MIX, OP_MIX_CHAIN_PREV);
 567   km_bindkey ("l", MENU_MIX, OP_MIX_CHAIN_NEXT);
 568 #endif
 569
 570   /* bindings for the line editor */
 571   create_bindings (OpEditor, MENU_EDITOR);
 572
 573   km_bindkey ("<up>", MENU_EDITOR, OP_EDITOR_HISTORY_UP);
 574   km_bindkey ("<down>", MENU_EDITOR, OP_EDITOR_HISTORY_DOWN);
 575   km_bindkey ("<left>", MENU_EDITOR, OP_EDITOR_BACKWARD_CHAR);
 576   km_bindkey ("<right>", MENU_EDITOR, OP_EDITOR_FORWARD_CHAR);
 577   km_bindkey ("<home>", MENU_EDITOR, OP_EDITOR_BOL);
 578   km_bindkey ("<end>", MENU_EDITOR, OP_EDITOR_EOL);
 579   km_bindkey ("<backspace>", MENU_EDITOR, OP_EDITOR_BACKSPACE);
 580   km_bindkey ("<delete>", MENU_EDITOR, OP_EDITOR_BACKSPACE);
 581   km_bindkey ("\177", MENU_EDITOR, OP_EDITOR_BACKSPACE);
 582
 583   /* generic menu keymap */
 584   create_bindings (OpGeneric, MENU_GENERIC);
 585
 586   km_bindkey ("<home>", MENU_GENERIC, OP_FIRST_ENTRY);
 587   km_bindkey ("<end>", MENU_GENERIC, OP_LAST_ENTRY);
 588   km_bindkey ("<pagedown>", MENU_GENERIC, OP_NEXT_PAGE);
 589   km_bindkey ("<pageup>", MENU_GENERIC, OP_PREV_PAGE);
 590   km_bindkey ("<right>", MENU_GENERIC, OP_NEXT_PAGE);
 591   km_bindkey ("<left>", MENU_GENERIC, OP_PREV_PAGE);
 592   km_bindkey ("<up>", MENU_GENERIC, OP_PREV_ENTRY);
 593   km_bindkey ("<down>", MENU_GENERIC, OP_NEXT_ENTRY);
 594   km_bindkey ("1", MENU_GENERIC, OP_JUMP);
 595   km_bindkey ("2", MENU_GENERIC, OP_JUMP);
 596   km_bindkey ("3", MENU_GENERIC, OP_JUMP);
 597   km_bindkey ("4", MENU_GENERIC, OP_JUMP);
 598   km_bindkey ("5", MENU_GENERIC, OP_JUMP);
 599   km_bindkey ("6", MENU_GENERIC, OP_JUMP);
 600   km_bindkey ("7", MENU_GENERIC, OP_JUMP);
 601   km_bindkey ("8", MENU_GENERIC, OP_JUMP);
 602   km_bindkey ("9", MENU_GENERIC, OP_JUMP);
 603
 604   km_bindkey ("<enter>", MENU_GENERIC, OP_GENERIC_SELECT_ENTRY);
 605
 606   /* Miscellaneous extra bindings */
 607
 608   km_bindkey (" ", MENU_MAIN, OP_DISPLAY_MESSAGE);
 609   km_bindkey ("<up>", MENU_MAIN, OP_MAIN_PREV_UNDELETED);
 610   km_bindkey ("<down>", MENU_MAIN, OP_MAIN_NEXT_UNDELETED);
 611   km_bindkey ("J", MENU_MAIN, OP_NEXT_ENTRY);
 612   km_bindkey ("K", MENU_MAIN, OP_PREV_ENTRY);
 613   km_bindkey ("x", MENU_MAIN, OP_EXIT);
 614
 615   km_bindkey ("<enter>", MENU_MAIN, OP_DISPLAY_MESSAGE);
 616
 617   km_bindkey ("x", MENU_PAGER, OP_EXIT);
 618   km_bindkey ("<backspace>", MENU_PAGER, OP_PREV_LINE);
 619   km_bindkey ("<pagedown>", MENU_PAGER, OP_NEXT_PAGE);
 620   km_bindkey ("<pageup>", MENU_PAGER, OP_PREV_PAGE);
 621   km_bindkey ("<up>", MENU_PAGER, OP_MAIN_PREV_UNDELETED);
 622   km_bindkey ("<right>", MENU_PAGER, OP_MAIN_NEXT_UNDELETED);
 623   km_bindkey ("<down>", MENU_PAGER, OP_MAIN_NEXT_UNDELETED);
 624   km_bindkey ("<left>", MENU_PAGER, OP_MAIN_PREV_UNDELETED);
 625   km_bindkey ("<home>", MENU_PAGER, OP_PAGER_TOP);
 626   km_bindkey ("<end>", MENU_PAGER, OP_PAGER_BOTTOM);
 627   km_bindkey ("1", MENU_PAGER, OP_JUMP);
 628   km_bindkey ("2", MENU_PAGER, OP_JUMP);
 629   km_bindkey ("3", MENU_PAGER, OP_JUMP);
 630   km_bindkey ("4", MENU_PAGER, OP_JUMP);
 631   km_bindkey ("5", MENU_PAGER, OP_JUMP);
 632   km_bindkey ("6", MENU_PAGER, OP_JUMP);
 633   km_bindkey ("7", MENU_PAGER, OP_JUMP);
 634   km_bindkey ("8", MENU_PAGER, OP_JUMP);
 635   km_bindkey ("9", MENU_PAGER, OP_JUMP);
 636
 637   km_bindkey ("<enter>", MENU_PAGER, OP_NEXT_LINE);
 638
 639   km_bindkey ("<return>", MENU_ALIAS, OP_GENERIC_SELECT_ENTRY);
 640   km_bindkey ("<enter>",  MENU_ALIAS, OP_GENERIC_SELECT_ENTRY);
 641   km_bindkey ("<space>", MENU_ALIAS, OP_TAG);
 642
 643   km_bindkey ("<enter>", MENU_ATTACH, OP_VIEW_ATTACH);
 644   km_bindkey ("<enter>", MENU_COMPOSE, OP_VIEW_ATTACH);
 645
 646   /* edit-to (default "t") hides generic tag-entry in Compose menu
 647      This will bind tag-entry to  "T" in the Compose menu */
 648   km_bindkey ("T", MENU_COMPOSE, OP_TAG);
 649 }
 650
 651 void km_error_key (int menu)
 652 {
 653   char buf[SHORT_STRING];
 654   struct keymap_t *key;
 655
 656   if(!(key = km_find_func(menu, OP_HELP)))
 657     key = km_find_func(MENU_GENERIC, OP_HELP);
 658
 659   if(!(km_expand_key(buf, sizeof(buf), key)))
 660   {
 661     mutt_error _("Key is not bound.");
 662     return;
 663   }
 664
 665   /* make sure the key is really the help key in this menu */
 666   push_string (buf);
 667   if (km_dokey (menu) != OP_HELP)
 668   {
 669     mutt_error _("Key is not bound.");
 670     return;
 671   }
 672
 673   mutt_error (_("Key is not bound.  Press '%s' for help."), buf);
 674   return;
 675 }
 676
 677 int mutt_parse_push (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 678 {
 679   int r = 0;
 680
 681   mutt_extract_token (buf, s, M_TOKEN_CONDENSE);
 682   if (MoreArgs (s))
 683   {
 684     strfcpy (err->data, _("push: too many arguments"), err->dsize);
 685     r = -1;
 686   }
 687   else
 688     push_string (buf->data);
 689   return (r);
 690 }
 691
 692 /* expects to see: <menu-string> <key-string> */
 693 char *parse_keymap (int *menu, BUFFER *s, BUFFER *err)
 694 {
 695   BUFFER buf;
 696
 697   memset (&buf, 0, sizeof (buf));
 698
 699   /* menu name */
 700   mutt_extract_token (&buf, s, 0);
 701   if (MoreArgs (s))
 702   {
 703     if ((*menu = mutt_check_menu (buf.data)) == -1)
 704     {
 705       snprintf (err->data, err->dsize, _("%s: no such menu"), buf.data);
 706     }
 707     else
 708     {
 709       /* key sequence */
 710       mutt_extract_token (&buf, s, 0);
 711
 712       if (!*buf.data)
 713       {
 714         strfcpy (err->data, _("null key sequence"), err->dsize);
 715       }
 716       else if (MoreArgs (s))
 717         return (buf.data);
 718     }
 719   }
 720   else
 721   {
 722     strfcpy (err->data, _("too few arguments"), err->dsize);
 723   }
 724   FREE (&buf.data);
 725   return (NULL);
 726 }
 727
 728 static int
 729 try_bind (char *key, int menu, char *func, struct binding_t *bindings)
 730 {
 731   int i;
 732
 733   for (i = 0; bindings[i].name; i++)
 734     if (mutt_strcmp (func, bindings[i].name) == 0)
 735     {
 736       km_bindkey (key, menu, bindings[i].op);
 737       return (0);
 738     }
 739   return (-1);
 740 }
 741
 742 struct binding_t *km_get_table (int menu)
 743 {
 744   switch (menu)
 745   {
 746     case MENU_MAIN:
 747       return OpMain;
 748     case MENU_GENERIC:
 749       return OpGeneric;
 750     case MENU_COMPOSE:
 751       return OpCompose;
 752     case MENU_PAGER:
 753       return OpPager;
 754     case MENU_POST:
 755       return OpPost;
 756     case MENU_FOLDER:
 757       return OpBrowser;
 758     case MENU_ALIAS:
 759       return OpAlias;
 760     case MENU_ATTACH:
 761       return OpAttach;
 762     case MENU_EDITOR:
 763       return OpEditor;
 764     case MENU_QUERY:
 765       return OpQuery;
 766
 767     case MENU_PGP:
 768       return (WithCrypto & APPLICATION_PGP)? OpPgp:NULL;
 769
 770 #ifdef MIXMASTER
 771     case MENU_MIX:
 772       return OpMix;
 773 #endif
 774
 775   }
 776   return NULL;
 777 }
 778
 779 /* bind menu-name '<key_sequence>' function-name */
 780 int mutt_parse_bind (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 781 {
 782   struct binding_t *bindings = NULL;
 783   char *key;
 784   int menu, r = 0;
 785
 786   if ((key = parse_keymap (&menu, s, err)) == NULL)
 787     return (-1);
 788
 789   /* function to execute */
 790   mutt_extract_token (buf, s, 0);
 791   if (MoreArgs (s))
 792   {
 793     strfcpy (err->data, _("bind: too many arguments"), err->dsize);
 794     r = -1;
 795   }
 796   else if (ascii_strcasecmp ("noop", buf->data) == 0)
 797     km_bindkey (key, menu, OP_NULL); /* the `unbind' command */
 798   else
 799   {
 800     /* First check the "generic" list of commands */
 801     if (menu == MENU_PAGER || menu == MENU_EDITOR || menu == MENU_GENERIC ||
 802         try_bind (key, menu, buf->data, OpGeneric) != 0)
 803     {
 804       /* Now check the menu-specific list of commands (if they exist) */
 805       bindings = km_get_table (menu);
 806       if (bindings && try_bind (key, menu, buf->data, bindings) != 0)
 807       {
 808         snprintf (err->data, err->dsize, _("%s: no such function in map"), buf->data);
 809         r = -1;
 810       }
 811     }
 812   }
 813   FREE (&key);
 814   return (r);
 815 }
 816
 817 /* macro <menu> <key> <macro> <description> */
 818 int mutt_parse_macro (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 819 {
 820   int menu, r = -1;
 821   char *seq = NULL;
 822   char *key;
 823
 824   if ((key = parse_keymap (&menu, s, err)) == NULL)
 825     return (-1);
 826
 827   mutt_extract_token (buf, s, M_TOKEN_CONDENSE);
 828   /* make sure the macro sequence is not an empty string */
 829   if (!*buf->data)
 830   {
 831     strfcpy (err->data, _("macro: empty key sequence"), err->dsize);
 832   }
 833   else
 834   {
 835     if (MoreArgs (s))
 836     {
 837       seq = safe_strdup (buf->data);
 838       mutt_extract_token (buf, s, M_TOKEN_CONDENSE);
 839
 840       if (MoreArgs (s))
 841       {
 842         strfcpy (err->data, _("macro: too many arguments"), err->dsize);
 843       }
 844       else
 845       {
 846         km_bind (key, menu, OP_MACRO, seq, buf->data);
 847         r = 0;
 848       }
 849
 850       FREE (&seq);
 851     }
 852     else
 853     {
 854       km_bind (key, menu, OP_MACRO, buf->data, NULL);
 855       r = 0;
 856     }
 857   }
 858   FREE (&key);
 859   return (r);
 860 }
 861
 862 /* exec function-name */
 863 int mutt_parse_exec (BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err)
 864 {
 865   int ops[128];
 866   int nops = 0;
 867   struct binding_t *bindings = NULL;
 868   char *function;
 869
 870   if (!MoreArgs (s))
 871   {
 872     strfcpy (err->data, _("exec: no arguments"), err->dsize);
 873     return (-1);
 874   }
 875
 876   do
 877   {
 878     mutt_extract_token (buf, s, 0);
 879     function = buf->data;
 880
 881     if ((bindings = km_get_table (CurrentMenu)) == NULL
 882         && CurrentMenu != MENU_PAGER)
 883       bindings = OpGeneric;
 884
 885     ops[nops] = get_op (bindings, function, mutt_strlen(function));
 886     if (ops[nops] == OP_NULL && CurrentMenu != MENU_PAGER)
 887       ops[nops] = get_op (OpGeneric, function, mutt_strlen(function));
 888
 889     if (ops[nops] == OP_NULL)
 890     {
 891       mutt_flushinp ();
 892       mutt_error (_("%s: no such function"), function);
 893       return (-1);
 894     }
 895     nops++;
 896   }
 897   while(MoreArgs(s) && nops < sizeof(ops)/sizeof(ops[0]));
 898
 899   while(nops)
 900     mutt_ungetch(0, ops[--nops]);
 901
 902   return 0;
 903 }
 904
 905 /*
 906  * prompts the user to enter a keystroke, and displays the octal value back
 907  * to the user.
 908  */
 909 void mutt_what_key (void)
 910 {
 911   int ch;
 912
 913   mvprintw(LINES-1,0, _("Enter keys (^G to abort): "));
 914   do {
 915     ch = getch();
 916     if (ch != ERR && ch != ctrl ('G'))
 917     {
 918       mutt_message(_("Char = %s, Octal = %o, Decimal = %d"),
 919                km_keyname(ch), ch, ch);
 920     }
 921   }
 922   while (ch != ERR && ch != ctrl ('G'));
 923
 924   mutt_flushinp();
 925 }