lib.h

Go to the documentation of this file.

 
#ifndef MUTT_KEY_LIB_H
#define MUTT_KEY_LIB_H
 
#include "config.h"
#include <stdbool.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)  
 
typedef uint8_t GetChFlags;            
#define GETCH_NO_FLAGS             0   
#define GETCH_IGNORE_MACRO   (1 << 0)  

typedef short keycode_t;

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; 
};
ARRAY_HEAD(KeyEventArray, struct KeyEvent);

struct BindingInfo
{
  const char *a[3]; 
};
ARRAY_HEAD(BindingInfoArray, struct BindingInfo);
 
extern struct KeyEventArray MacroEvents;
 
extern struct KeymapList Keymaps[]; 
extern struct Mapping KeyNames[];
 
extern keycode_t AbortKey; 
 
extern const struct Mapping Menus[];
 
typedef uint8_t MenuFuncFlags;          
#define MFF_NO_FLAGS               0    
#define MFF_DEPRECATED       (1 << 1)   

struct MenuFuncOp
{
  const char   *name;    
  int           op;      
  MenuFuncFlags flags;   
};

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,   
};
 
// key/extended
#ifdef HAVE_USE_EXTENDED_NAMES
void init_extended_keys(void);
#else
static inline void init_extended_keys(void) {}
#endif
 
// key/commands.c
enum CommandResult km_bind     (const char *s, enum MenuType mtype, int op, char *macro, char *desc, struct Buffer *err);
enum CommandResult parse_bind  (const struct Command *cmd, struct Buffer *line, struct Buffer *err);
enum CommandResult parse_exec  (const struct Command *cmd, struct Buffer *line, struct Buffer *err);
enum CommandResult parse_macro (const struct Command *cmd, struct Buffer *line, struct Buffer *err);
enum CommandResult parse_push  (const struct Command *cmd, struct Buffer *line, struct Buffer *err);
enum CommandResult parse_unbind(const struct Command *cmd, struct Buffer *line, struct Buffer *err);
 
// key/init.c
void km_init             (void);
int  main_config_observer(struct NotifyCallback *nc);
void mutt_init_abort_key (void);
void mutt_keys_cleanup   (void);
 
// key/get.c
int             km_dokey                   (enum MenuType menu, GetChFlags flags);
struct KeyEvent km_dokey_event             (enum MenuType menu, GetChFlags flags);
void            km_error_key               (enum MenuType menu);
void            mutt_flush_macro_to_endcond(void);
 
// key/lib.c
bool                     km_expand_key       (struct Keymap *map, struct Buffer *buf);
struct Keymap *          km_find_func        (enum MenuType menu, int func);
const struct MenuFuncOp *km_get_table        (enum MenuType mtype);
void                     km_keyname          (int c, struct Buffer *buf);
 
// Private to libkey
struct Keymap *    alloc_keys                  (size_t len, keycode_t *keys);
enum CommandResult parse_bind_macro            (const struct Command *cmd, struct Buffer *line, struct Buffer *err);
void               generic_tokenize_push_string(char *s);
int                get_op                      (const struct MenuFuncOp *funcs, const char *start, size_t len);
struct Keymap *    km_compare_keys             (struct Keymap *k1, struct Keymap *k2, size_t *pos);
const char *       mutt_get_func               (const struct MenuFuncOp *bindings, int op);
void               mutt_keymap_free            (struct Keymap **ptr);
int                parse_fkey                  (char *s);
size_t             parsekeys                   (const char *str, keycode_t *d, size_t max);
void               km_expand_key_string        (char *str, struct Buffer *buf);
 
struct KeyEvent mutt_getch(GetChFlags flags);
void mutt_flushinp(void);
void mutt_push_macro_event(int ch, int op);
void mutt_unget_ch(int ch);
void mutt_unget_op(int op);
void mutt_unget_string(const char *s);
 
int  measure_column(struct BindingInfoArray *bia, int col);
void gather_menu(enum MenuType menu, struct BindingInfoArray *bia_bind, struct BindingInfoArray *bia_macro);
int  gather_unbound(const struct MenuFuncOp *funcs, const struct KeymapList *km_menu, const struct KeymapList *km_aux, struct BindingInfoArray *bia_unbound);
int binding_sort(const void *a, const void *b, void *sdata);
 
#endif /* MUTT_KEY_LIB_H */