get.h

Go to the documentation of this file.

 
#ifndef MUTT_KEY_GET_H
#define MUTT_KEY_GET_H
 
#include <stdint.h>
#include "mutt/lib.h"
#include "menu/lib.h"
#include "keymap.h"
 
struct MenuDefinition;

enum GetChFlag
{
  GETCH_NONE         =       0,  
  GETCH_IGNORE_MACRO = 1U << 0,  
  GETCH_NO_COUNTER   = 1U << 1,  
  GETCH_NO_FEEDBACK  = 1U << 2,  
};
typedef uint8_t GetChFlags;

#define KEY_COUNT_MAX_DIGITS 6
#define KEY_SEQ_MAX_LEN 8

enum KeyGatherFlag
{
  KEY_GATHER_NO_MATCH =       0,  
  KEY_GATHER_MATCH    = 1U << 0,  
  KEY_GATHER_LONGER   = 1U << 1,  
};
typedef uint8_t KeyGatherFlags;

enum MenuFuncFlag
{
  MFF_NONE       =       0,  
  MFF_DEPRECATED = 1U << 1,  
};
typedef uint8_t MenuFuncFlags;

struct KeyEvent
{
  int ch;    
  int op;    
  int count; 
};
ARRAY_HEAD(KeyEventArray, struct KeyEvent);

struct KeymapMatch
{
  enum MenuType  mtype;       
  KeyGatherFlags flags;       
  struct Keymap *keymap;      
};
ARRAY_HEAD(KeymapMatchArray, struct KeymapMatch);
 
void             array_add                   (struct KeyEventArray *a, int ch, int op);
struct KeyEvent *array_pop                   (struct KeyEventArray *a);
void             array_to_endcond            (struct KeyEventArray *a);
KeyGatherFlags   gather_functions            (const struct MenuDefinition *md, const keycode_t *keys, int key_len, struct KeymapMatchArray *kma);
void             generic_tokenize_push_string(char *s);
struct KeyEvent  km_dokey                    (const struct MenuDefinition *md, GetChFlags flags);
void             km_error_key                (const struct MenuDefinition *md);
void             mutt_flushinp               (void);
void             mutt_flush_macro_to_endcond (void);
struct KeyEvent  mutt_getch                  (GetChFlags flags);
int              mutt_monitor_getch          (void);
void             mutt_push_macro_event       (int ch, int op);
void             mutt_push_macro_repeated    (char *macro, int count);
void             mutt_unget_ch               (int ch);
void             mutt_unget_op               (int op);
 
#endif /* MUTT_KEY_GET_H */