lib/tty/key.h

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