lib/tty/key.h

   1 /** \file key.h
   2  *  \brief Header: keyboard support routines
   3  */
   4
   5 #ifndef MC__KEY_H
   6 #define MC__KEY_H
   7
   8 #include "lib/global.h"         /* <glib.h> */
   9 #include "tty.h"                /* KEY_F macro */
  10
  11 /*** typedefs(not structures) and defined constants **********************************************/
  12
  13 /* Possible return values from tty_get_event: */
  14 #define EV_MOUSE   -2
  15 #define EV_NONE    -1
  16
  17 /*
  18  * Internal representation of the key modifiers.  It is used in the
  19  * sequence tables and the keycodes in the mc sources.
  20  */
  21 #define KEY_M_SHIFT 0x1000
  22 #define KEY_M_ALT   0x2000
  23 #define KEY_M_CTRL  0x4000
  24 #define KEY_M_MASK  0x7000
  25
  26 #define XCTRL(x) (KEY_M_CTRL | ((x) & 0x1F))
  27 #define ALT(x) (KEY_M_ALT | (unsigned int)(x))
  28
  29 /* To define sequences and return codes */
  30 #define MCKEY_NOACTION  0
  31 #define MCKEY_ESCAPE    1
  32
  33 /* Return code for the mouse sequence */
  34 #define MCKEY_MOUSE     -2
  35
  36 /* Return code for the extended mouse sequence */
  37 #define MCKEY_EXTENDED_MOUSE     -3
  38
  39 /*** enums ***************************************************************************************/
  40
  41 /*** structures declarations (and typedefs of structures)*****************************************/
  42
  43 typedef struct
  44 {
  45     int code;
  46     const char *name;
  47     const char *longname;
  48     const char *shortcut;
  49 } key_code_name_t;
  50
  51 struct Gpm_Event;
  52
  53 /*** global variables defined in .c file *********************************************************/
  54
  55 extern const key_code_name_t key_name_conv_tab[];
  56
  57 extern int old_esc_mode_timeout;
  58
  59 extern int double_click_speed;
  60 extern int old_esc_mode;
  61 extern int use_8th_bit_as_meta;
  62 extern int mou_auto_repeat;
  63
  64 /*** declarations of public functions ************************************************************/
  65
  66 gboolean define_sequence (int code, const char *seq, int action);
  67
  68 void init_key (void);
  69 void init_key_input_fd (void);
  70 void done_key (void);
  71
  72 long lookup_key (const char *name, char **label);
  73 char *lookup_key_by_code (const int keycode);
  74 /* mouse support */
  75 int tty_get_event (struct Gpm_Event *event, gboolean redo_event, gboolean block);
  76 gboolean is_idle (void);
  77 int tty_getch (void);
  78
  79 /* While waiting for input, the program can select on more than one file */
  80 typedef int (*select_fn) (int fd, void *info);
  81
  82 /* Channel manipulation */
  83 void add_select_channel (int fd, select_fn callback, void *info);
  84 void delete_select_channel (int fd);
  85 void remove_select_channel (int fd);
  86
  87 /* Activate/deactivate the channel checking */
  88 void channels_up (void);
  89 void channels_down (void);
  90
  91 /* internally used in key.c, defined in keyxtra.c */
  92 void load_xtra_key_defines (void);
  93
  94 /* Learn a single key */
  95 char *learn_key (void);
  96
  97 /* Returns a key code (interpreted) */
  98 int get_key_code (int nodelay);
  99
 100 /* Set keypad mode (xterm and linux console only) */
 101 void numeric_keypad_mode (void);
 102 void application_keypad_mode (void);
 103
 104 /*** inline functions ****************************************************************************/
 105
 106 static inline gboolean
 107 is_abort_char (int c)
 108 {
 109     return ((c == (int) ESC_CHAR) || (c == (int) KEY_F (10)));
 110 }
 111
 112 #endif /* MC_KEY_H */