keymap.h

   1 /*
   2  * Copyright (C) 1996-2000,2 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18
  19 #ifndef KEYMAP_H
  20 #define KEYMAP_H
  21
  22 #include "mapping.h"
  23
  24 /* maximal length of a key binding sequence used for buffer in km_bindkey */
  25 #define MAX_SEQ 8
  26
  27 /* type for key storage, the rest of mutt works fine with int type */
  28 typedef short keycode_t;
  29
  30 void km_bind (char *, int, int, char *, char *);
  31 void km_bindkey (char *, int, int);
  32 int km_dokey (int);
  33
  34 void init_extended_keys(void);
  35
  36 /* entry in the keymap tree */
  37 struct keymap_t
  38 {
  39   char *macro;           /* macro expansion (op == OP_MACRO) */
  40   char *descr;           /* description of a macro for the help menu */
  41   struct keymap_t *next; /* next key in map */
  42   short op;              /* operation to perform */
  43   short eq;              /* number of leading keys equal to next entry */
  44   short len;             /* length of key sequence (unit: sizeof (keycode_t)) */
  45   keycode_t *keys;       /* key sequence */
  46 };
  47
  48 char *km_keyname (int);
  49 int km_expand_key (char *, size_t, struct keymap_t *);
  50 struct keymap_t *km_find_func (int, int);
  51 void km_init (void);
  52 void km_error_key (int);
  53 void mutt_what_key (void);
  54
  55 enum
  56 {
  57   MENU_ALIAS,
  58   MENU_ATTACH,
  59   MENU_COMPOSE,
  60   MENU_EDITOR,
  61   MENU_FOLDER,
  62   MENU_GENERIC,
  63   MENU_MAIN,
  64   MENU_PAGER,
  65   MENU_POST,
  66   MENU_QUERY,
  67
  68
  69   MENU_PGP,
  70   MENU_SMIME,
  71
  72 #ifdef CRYPT_BACKEND_GPGME
  73   MENU_KEY_SELECT_PGP,
  74   MENU_KEY_SELECT_SMIME,
  75 #endif
  76
  77 #ifdef MIXMASTER
  78   MENU_MIX,
  79 #endif
  80
  81
  82
  83   MENU_MAX
  84 };
  85
  86 /* the keymap trees (one for each menu) */
  87 extern struct keymap_t *Keymaps[];
  88
  89 /* dokey() records the last real key pressed  */
  90 extern int LastKey;
  91
  92 extern struct mapping_t Menus[];
  93
  94 struct binding_t
  95 {
  96   char *name;   /* name of the function */
  97   int op;       /* function id number */
  98   char *seq;    /* default key binding */
  99 };
 100
 101 struct binding_t *km_get_table (int menu);
 102
 103 extern struct binding_t OpGeneric[];
 104 extern struct binding_t OpPost[];
 105 extern struct binding_t OpMain[];
 106 extern struct binding_t OpAttach[];
 107 extern struct binding_t OpPager[];
 108 extern struct binding_t OpCompose[];
 109 extern struct binding_t OpBrowser[];
 110 extern struct binding_t OpEditor[];
 111 extern struct binding_t OpQuery[];
 112 extern struct binding_t OpAlias[];
 113
 114 extern struct binding_t OpPgp[];
 115
 116 extern struct binding_t OpSmime[];
 117
 118 #ifdef MIXMASTER
 119 extern struct binding_t OpMix[];
 120 #endif
 121
 122 #include "keymap_defs.h"
 123
 124 #endif /* KEYMAP_H */