keymap.h

Go to the documentation of this file.

 
#ifndef MUTT_KEYMAP_H
#define MUTT_KEYMAP_H
 
#include "config.h"
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "menu/lib.h"
 
#define MUTT_UNBIND  1<<0
#define MUTT_UNMACRO 1<<1
/* maximal length of a key binding sequence used for buffer in km_bindkey */
#define MAX_SEQ 8
 
typedef short keycode_t;
 
void init_extended_keys(void);
 
struct Keymap
{
  char *macro;                  
  char *desc;                   
  short op;                     
  short eq;                     
  short len;                    
  keycode_t *keys;              
  STAILQ_ENTRY(Keymap) entries; 
};
 
STAILQ_HEAD(KeymapList, Keymap);
 
struct KeyEvent
{
  int ch; 
  int op; 
};
 
int km_expand_key(char *s, size_t len, struct Keymap *map);
struct Keymap *km_find_func(enum MenuType menu, int func);
void km_init(void);
void km_error_key(enum MenuType menu);
void mutt_what_key(void);
void mutt_init_abort_key(void);
int main_config_observer(struct NotifyCallback *nc);
 
enum CommandResult km_bind(char *s, enum MenuType menu, int op, char *macro, char *desc);
int km_dokey(enum MenuType menu);
struct KeyEvent km_dokey_event(enum MenuType menu);
 
extern struct KeymapList Keymaps[]; 
 
extern keycode_t AbortKey; 
 
extern const struct Mapping Menus[];
 
struct MenuFuncOp
{
  const char *name; 
  int op;           
};
 
struct MenuOpSeq
{
  int op;           
  const char *seq;  
};
 
struct EventBinding
{
  enum MenuType menu; 
  const char *key;    
  int op;             
};
 
enum NotifyBinding
{
  NT_BINDING_ADD = 1,    
  NT_BINDING_DELETE,     
  NT_BINDING_DELETE_ALL, 
 
  NT_MACRO_ADD,          
  NT_MACRO_DELETE,       
  NT_MACRO_DELETE_ALL,   
};
 
const struct MenuFuncOp *km_get_table(enum MenuType mtype);
const char *mutt_get_func(const struct MenuFuncOp *bindings, int op);
 
void mutt_keys_free(void);
 
enum CommandResult mutt_parse_bind   (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
enum CommandResult mutt_parse_exec   (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
enum CommandResult mutt_parse_macro  (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
enum CommandResult mutt_parse_push   (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
enum CommandResult mutt_parse_unbind (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
enum CommandResult mutt_parse_unmacro(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
 
#endif /* MUTT_KEYMAP_H */