keymap.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2000,2 Michael R. Elkins <me@mutt.org>
   4  *
   5  * This file is part of mutt-ng, see http://www.muttng.org/.
   6  * It's licensed under the GNU General Public License,
   7  * please see the file GPL in the top level source directory.
   8  */
   9
  10 #ifndef KEYMAP_H
  11 #define KEYMAP_H
  12
  13 #include "mapping.h"
  14
  15 /* maximal length of a key binding sequence used for buffer in km_bindkey */
  16 #define MAX_SEQ 8
  17
  18 /* type for key storage, the rest of mutt works fine with int type */
  19 typedef short keycode_t;
  20
  21 void km_bind (char *, int, int, char *, char *);
  22 void km_bindkey (char *, int, int);
  23 int km_dokey (int);
  24
  25 /* entry in the keymap tree */
  26 struct keymap_t {
  27   char *macro;                  /* macro expansion (op == OP_MACRO) */
  28   char *descr;                  /* description of a macro for the help menu */
  29   struct keymap_t *next;        /* next key in map */
  30   short op;                     /* operation to perform */
  31   short eq;                     /* number of leading keys equal to next entry */
  32   short len;                    /* length of key sequence (unit: sizeof (keycode_t)) */
  33   keycode_t *keys;              /* key sequence */
  34 };
  35
  36 char *km_keyname (int);
  37 int km_expand_key (char *, size_t, struct keymap_t *);
  38 struct keymap_t *km_find_func (int, int);
  39 void km_init (void);
  40 void km_error_key (int);
  41 void mutt_what_key (void);
  42
  43 enum {
  44   MENU_ALIAS,
  45   MENU_ATTACH,
  46   MENU_COMPOSE,
  47   MENU_EDITOR,
  48   MENU_FOLDER,
  49   MENU_GENERIC,
  50   MENU_MAIN,
  51   MENU_PAGER,
  52   MENU_POST,
  53   MENU_QUERY,
  54
  55
  56   MENU_PGP,
  57   MENU_SMIME,
  58
  59 #ifdef CRYPT_BACKEND_GPGME
  60   MENU_KEY_SELECT_PGP,
  61   MENU_KEY_SELECT_SMIME,
  62 #endif
  63
  64 #ifdef MIXMASTER
  65   MENU_MIX,
  66 #endif
  67
  68
  69
  70   MENU_MAX
  71 };
  72
  73 /* the keymap trees (one for each menu) */
  74 extern struct keymap_t *Keymaps[];
  75
  76 /* dokey() records the last real key pressed  */
  77 extern int LastKey;
  78
  79 extern struct mapping_t Menus[];
  80
  81 struct binding_t {
  82   char *name;                   /* name of the function */
  83   int op;                       /* function id number */
  84   char *seq;                    /* default key binding */
  85 };
  86
  87 struct binding_t *km_get_table (int menu);
  88
  89 extern struct binding_t OpGeneric[];
  90 extern struct binding_t OpPost[];
  91 extern struct binding_t OpMain[];
  92 extern struct binding_t OpAttach[];
  93 extern struct binding_t OpPager[];
  94 extern struct binding_t OpCompose[];
  95 extern struct binding_t OpBrowser[];
  96 extern struct binding_t OpEditor[];
  97 extern struct binding_t OpQuery[];
  98 extern struct binding_t OpAlias[];
  99
 100 extern struct binding_t OpPgp[];
 101
 102 extern struct binding_t OpSmime[];
 103
 104 #ifdef MIXMASTER
 105 extern struct binding_t OpMix[];
 106 #endif
 107
 108 #include "keymap_defs.h"
 109
 110 #endif /* KEYMAP_H */