]> git.llucax.com Git - software/mutt-debian.git/blob - keymap.h
restoring .gitignore
[software/mutt-debian.git] / 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 /* entry in the keymap tree */
35 struct keymap_t
36 {
37   char *macro;           /* macro expansion (op == OP_MACRO) */
38   char *descr;           /* description of a macro for the help menu */
39   struct keymap_t *next; /* next key in map */
40   short op;              /* operation to perform */
41   short eq;              /* number of leading keys equal to next entry */
42   short len;             /* length of key sequence (unit: sizeof (keycode_t)) */
43   keycode_t *keys;       /* key sequence */
44 };
45
46 char *km_keyname (int);
47 int km_expand_key (char *, size_t, struct keymap_t *);
48 struct keymap_t *km_find_func (int, int);
49 void km_init (void);
50 void km_error_key (int);
51 void mutt_what_key (void);
52
53 enum
54 {
55   MENU_ALIAS,
56   MENU_ATTACH,
57   MENU_COMPOSE,
58   MENU_EDITOR,
59   MENU_FOLDER,
60   MENU_GENERIC,
61   MENU_MAIN,
62   MENU_PAGER,
63   MENU_POST,
64   MENU_QUERY,
65
66   
67   MENU_PGP,
68   MENU_SMIME,
69
70 #ifdef CRYPT_BACKEND_GPGME
71   MENU_KEY_SELECT_PGP,
72   MENU_KEY_SELECT_SMIME,
73 #endif
74   
75 #ifdef MIXMASTER
76   MENU_MIX,
77 #endif
78
79
80
81   MENU_MAX
82 };
83
84 /* the keymap trees (one for each menu) */
85 extern struct keymap_t *Keymaps[];
86
87 /* dokey() records the last real key pressed  */
88 extern int LastKey;
89
90 extern struct mapping_t Menus[];
91
92 struct binding_t
93 {
94   char *name;   /* name of the function */
95   int op;       /* function id number */
96   char *seq;    /* default key binding */
97 };
98
99 struct binding_t *km_get_table (int menu);
100
101 extern struct binding_t OpGeneric[];
102 extern struct binding_t OpPost[];
103 extern struct binding_t OpMain[];
104 extern struct binding_t OpAttach[];
105 extern struct binding_t OpPager[];
106 extern struct binding_t OpCompose[];
107 extern struct binding_t OpBrowser[];
108 extern struct binding_t OpEditor[];
109 extern struct binding_t OpQuery[];
110 extern struct binding_t OpAlias[];
111
112 extern struct binding_t OpPgp[];
113
114 extern struct binding_t OpSmime[];
115
116 #ifdef MIXMASTER
117 extern struct binding_t OpMix[];
118 #endif
119
120 #include "keymap_defs.h"
121
122 #endif /* KEYMAP_H */