edit/edit_key_translator.c

   1 /*
   2     these #defines are probably the ones most people will be interested in.
   3     You can use these two #defines to hard code the key mappings --- just
   4     uncomment the one you want. But only if you have trouble with learn
   5     keys (which is unlikely).
   6 */
   7
   8     /* KEY_BACKSPACE is the key learned in the learn keys menu : */
   9 #define OUR_BACKSPACE_KEY KEY_BACKSPACE
  10     /* ...otherwise ctrl-h : */
  11 /* #define OUR_BACKSPACE_KEY XCTRL ('h') */
  12     /* ...otherwise 127 or DEL in ascii : */
  13 /* #define OUR_BACKSPACE_KEY 0177 */
  14
  15     /* KEY_DC is the key learned in the learn keys menu */
  16 #define OUR_DELETE_KEY KEY_DC
  17     /* ...otherwise ctrl-d : */
  18 /* #define OUR_DELETE_KEY XCTRL ('d') */
  19     /* ...otherwise 127 or DEL in ascii : */
  20 /* #define OUR_DELETE_KEY 0177 */
  21
  22
  23 /*
  24    This is #include'd into the function edit_translate_key in edit.c.
  25    This sequence of code takes 'x_state' and 'x_key' and translates them
  26    into either 'command' or 'char_for_insertion'. 'x_key' holds one of
  27    KEY_NPAGE, KEY_HOME etc., and 'x_state' holds a bitwise inclusive OR of
  28    CONTROL_PRESSED, ALT_PRESSED or SHIFT_PRESSED, although none may
  29    be supported.
  30    'command' is one of the editor commands editcmddef.h.
  31
  32    Almost any C code can go into this file. The code below is an example
  33    that may by appended or modified by the user.
  34  */
  35
  36 /* look in this file for the list of commands : */
  37 #include "editcmddef.h"
  38
  39 #define KEY_NUMLOCK ???
  40
  41 /* ordinary translations. (Some of this may be redundant.) Note that keys listed
  42    first take priority when a key is assigned to more than one command */
  43     static const long *key_map;
  44     static const long cooledit_key_map[] =
  45     {OUR_BACKSPACE_KEY, CK_BackSpace, OUR_DELETE_KEY, CK_Delete,
  46      XCTRL ('d'), CK_Delete, '\n', CK_Enter,
  47      KEY_PPAGE, CK_Page_Up, KEY_NPAGE, CK_Page_Down, KEY_LEFT, CK_Left,
  48      KEY_RIGHT, CK_Right, KEY_UP, CK_Up, KEY_DOWN, CK_Down,
  49      ALT ('\t'), CK_Complete_Word, ALT ('\n'), CK_Return,
  50      KEY_HOME, CK_Home, KEY_END, CK_End, '\t', CK_Tab,
  51      XCTRL ('u'), CK_Undo, KEY_IC, CK_Toggle_Insert,
  52      XCTRL ('o'), CK_Shell, KEY_F (3), CK_Mark,
  53      KEY_F (13), CK_Column_Mark, KEY_F (5), CK_Copy,
  54      KEY_F (6), CK_Move, KEY_F (8), CK_Remove, KEY_F (12), CK_Save_As,
  55      KEY_F (2), CK_Save, XCTRL ('n'), CK_New,
  56      XCTRL ('l'), CK_Refresh, ESC_CHAR, CK_Exit, KEY_F (10), CK_Exit,
  57      KEY_F (11), /* edit user menu */ CK_User_Menu,
  58      KEY_F (19), /*C formatter */ CK_Pipe_Block (0),
  59      XCTRL ('p'), /*spell check */ CK_Pipe_Block (1),
  60      KEY_F (15), CK_Insert_File,
  61      XCTRL ('f'), CK_Save_Block, KEY_F (1), CK_Help,
  62      ALT ('t'), CK_Sort, ALT ('m'), CK_Mail,
  63      XCTRL ('z'), CK_Word_Left, XCTRL ('x'), CK_Word_Right,
  64      KEY_F (4), CK_Replace, KEY_F (7), CK_Find, KEY_F (14), CK_Replace_Again,
  65      XCTRL ('h'), CK_BackSpace, ALT ('l'), CK_Goto, ALT ('L'), CK_Goto,
  66      XCTRL ('y'), CK_Delete_Line,
  67      XCTRL ('k'), CK_Delete_To_Line_End,
  68      KEY_F (17), CK_Find_Again, ALT ('p'), CK_Paragraph_Format,
  69      ALT ('b'), CK_Match_Bracket,
  70      0177, CK_BackSpace,
  71      0, 0};
  72
  73     static long const emacs_key_map[] =
  74     {OUR_BACKSPACE_KEY, CK_BackSpace, OUR_DELETE_KEY, CK_Delete, '\n', CK_Enter,
  75      KEY_PPAGE, CK_Page_Up, KEY_NPAGE, CK_Page_Down, KEY_LEFT, CK_Left,
  76      KEY_RIGHT, CK_Right, KEY_UP, CK_Up, KEY_DOWN, CK_Down,
  77      ALT ('\t'), CK_Complete_Word, ALT ('\n'), CK_Return,
  78      KEY_HOME, CK_Home, KEY_END, CK_End, '\t', CK_Tab,
  79      XCTRL ('u'), CK_Undo, KEY_IC, CK_Toggle_Insert,
  80      XCTRL ('o'), CK_Shell, KEY_F (3), CK_Mark, KEY_F (13), CK_Column_Mark,
  81      KEY_F (5), CK_Copy,
  82      KEY_F (6), CK_Move, KEY_F (8), CK_Remove, KEY_F (12), CK_Save_As,
  83      KEY_F (2), CK_Save, ALT ('p'), CK_Paragraph_Format,
  84
  85      ALT ('t'), CK_Sort,
  86
  87      XCTRL ('a'), CK_Home, XCTRL ('e'), CK_End,
  88      XCTRL ('b'), CK_Left, XCTRL ('f'), CK_Right,
  89      XCTRL ('n'), CK_Down, XCTRL ('p'), CK_Up,
  90      XCTRL ('d'), CK_Delete,
  91      XCTRL ('v'), CK_Page_Down, ALT ('v'), CK_Page_Up,
  92      XCTRL ('@'), CK_Mark,
  93      XCTRL ('k'), CK_Delete_To_Line_End,
  94      XCTRL ('s'), CK_Find,
  95
  96      ALT ('b'), CK_Word_Left, ALT ('f'), CK_Word_Right,
  97      XCTRL ('w'), CK_XCut,
  98      XCTRL ('y'), CK_XPaste,
  99      ALT ('w'), CK_XStore,
 100
 101      XCTRL ('l'), CK_Refresh, ESC_CHAR, CK_Exit, KEY_F (10), CK_Exit,
 102      KEY_F (11), /* edit user menu */ CK_User_Menu,
 103      KEY_F (19), /*C formatter */ CK_Pipe_Block (0),
 104      ALT ('$'), /*spell check */ CK_Pipe_Block (1),
 105      KEY_F (15), CK_Insert_File,
 106      KEY_F (1), CK_Help,
 107
 108      KEY_F (4), CK_Replace, KEY_F (7), CK_Find, KEY_F (14), CK_Replace_Again,
 109      XCTRL ('h'), CK_BackSpace, ALT ('l'), CK_Goto, ALT ('L'), CK_Goto,
 110      KEY_F (17), CK_Find_Again,
 111      ALT ('<'), CK_Beginning_Of_Text,
 112      ALT ('>'), CK_End_Of_Text,
 113      0177, CK_BackSpace,
 114
 115      0, 0};
 116
 117     static long const key_pad_map[10] =
 118     {XCTRL ('o'), KEY_END, KEY_DOWN, KEY_NPAGE, KEY_LEFT,
 119      KEY_DOWN, KEY_RIGHT, KEY_HOME, KEY_UP, KEY_PPAGE};
 120
 121
 122 #define DEFAULT_NUM_LOCK        0
 123
 124     static int num_lock = DEFAULT_NUM_LOCK;
 125     int i = 0;
 126
 127     switch (edit_key_emulation) {
 128     case EDIT_KEY_EMULATION_NORMAL:
 129         key_map = cooledit_key_map;
 130         break;
 131     case EDIT_KEY_EMULATION_EMACS:
 132         key_map = emacs_key_map;
 133         if (x_key == XCTRL ('x')) {
 134             int ext_key;
 135             ext_key = edit_raw_key_query (" Ctrl-X ", _(" Emacs key: "), 0);
 136             switch (ext_key) {
 137             case 's':
 138                 command = CK_Save;
 139                 goto fin;
 140             case 'x':
 141                 command = CK_Exit;
 142                 goto fin;
 143             case 'k':
 144                 command = CK_New;
 145                 goto fin;
 146             case 'e':
 147                 command = CK_Macro (edit_raw_key_query (_(" Execute Macro "), _(" Press macro hotkey: "), 1));
 148                 if (command == CK_Macro (0))
 149                     command = -1;
 150                 goto fin;
 151             }
 152             goto fin;
 153         }
 154         break;
 155     }
 156
 157 #ifdef HAVE_CHARSET
 158     if (x_key == XCTRL('t')) {
 159         do_select_codepage();
 160
 161         edit->force = REDRAW_COMPLETELY;
 162         command = CK_Refresh;
 163         goto fin;
 164     }
 165 #endif
 166
 167     if (x_key == XCTRL ('q')) {
 168         char_for_insertion = edit_raw_key_query (_(" Insert Literal "), _(" Press any key: "), 0);
 169         goto fin;
 170     }
 171     if (x_key == XCTRL ('a') && edit_key_emulation != EDIT_KEY_EMULATION_EMACS) {
 172         command = CK_Macro (edit_raw_key_query (_(" Execute Macro "), _(" Press macro hotkey: "), 1));
 173         if (command == CK_Macro (0))
 174             command = -1;
 175         goto fin;
 176     }
 177 /* edit is a pointer to the widget */
 178     if (edit)
 179         if (x_key == XCTRL ('r')) {
 180             command = edit->macro_i < 0 ? CK_Begin_Record_Macro : CK_End_Record_Macro;
 181             goto fin;
 182         }
 183 /*    if (x_key == KEY_NUMLOCK) {
 184    num_lock = 1 - num_lock;
 185    return 1;
 186    }
 187  */
 188
 189 /* first translate the key-pad */
 190     if (num_lock) {
 191         if (x_key >= '0' && x_key <= '9') {
 192             x_key = key_pad_map[x_key - '0'];
 193         }
 194         if (x_key == '.') {
 195             x_key = KEY_DC;
 196         }
 197     }
 198     if ((x_state & SHIFT_PRESSED) && (x_state & CONTROL_PRESSED)) {
 199         switch (x_key) {
 200         case KEY_PPAGE:
 201             command = CK_Beginning_Of_Text_Highlight;
 202             goto fin;
 203         case KEY_NPAGE:
 204             command = CK_End_Of_Text_Highlight;
 205             goto fin;
 206         case KEY_LEFT:
 207             command = CK_Word_Left_Highlight;
 208             goto fin;
 209         case KEY_RIGHT:
 210             command = CK_Word_Right_Highlight;
 211             goto fin;
 212         case KEY_UP:
 213             command = CK_Scroll_Up_Highlight;
 214             goto fin;
 215         case KEY_DOWN:
 216             command = CK_Scroll_Down_Highlight;
 217             goto fin;
 218         }
 219     }
 220     if ((x_state & SHIFT_PRESSED) && !(x_state & CONTROL_PRESSED)) {
 221         switch (x_key) {
 222         case KEY_PPAGE:
 223             command = CK_Page_Up_Highlight;
 224             goto fin;
 225         case KEY_NPAGE:
 226             command = CK_Page_Down_Highlight;
 227             goto fin;
 228         case KEY_LEFT:
 229             command = CK_Left_Highlight;
 230             goto fin;
 231         case KEY_RIGHT:
 232             command = CK_Right_Highlight;
 233             goto fin;
 234         case KEY_UP:
 235             command = CK_Up_Highlight;
 236             goto fin;
 237         case KEY_DOWN:
 238             command = CK_Down_Highlight;
 239             goto fin;
 240         case KEY_HOME:
 241             command = CK_Home_Highlight;
 242             goto fin;
 243         case KEY_END:
 244             command = CK_End_Highlight;
 245             goto fin;
 246         case KEY_IC:
 247             command = CK_XPaste;
 248             goto fin;
 249         case KEY_DC:
 250             command = CK_XCut;
 251             goto fin;
 252         }
 253     }
 254 /* things that need a control key */
 255     if (x_state & CONTROL_PRESSED) {
 256         switch (x_key) {
 257         case KEY_F (2):
 258             command = CK_Save_As;
 259             goto fin;
 260         case KEY_F (4):
 261             command = CK_Replace_Again;
 262             goto fin;
 263         case KEY_F (7):
 264             command = CK_Find_Again;
 265             goto fin;
 266         case KEY_BACKSPACE:
 267             command = CK_Undo;
 268             goto fin;
 269         case KEY_PPAGE:
 270             command = CK_Beginning_Of_Text;
 271             goto fin;
 272         case KEY_NPAGE:
 273             command = CK_End_Of_Text;
 274             goto fin;
 275         case KEY_UP:
 276             command = CK_Scroll_Up;
 277             goto fin;
 278         case KEY_DOWN:
 279             command = CK_Scroll_Down;
 280             goto fin;
 281         case KEY_LEFT:
 282             command = CK_Word_Left;
 283             goto fin;
 284         case KEY_RIGHT:
 285             command = CK_Word_Right;
 286             goto fin;
 287         case KEY_IC:
 288             command = CK_XStore;
 289             goto fin;
 290         case KEY_DC:
 291             command = CK_Remove;
 292             goto fin;
 293         }
 294     }
 295
 296 /* an ordinary insertable character */
 297     if (x_key < 256) {
 298         int c = convert_from_input_c (x_key);
 299
 300         if (is_printable (c)) {
 301             char_for_insertion = c;
 302             goto fin;
 303         }
 304     }
 305
 306 /* other commands */
 307     i = 0;
 308     while (key_map[i] != x_key && (key_map[i] || key_map[i + 1]))
 309         i += 2;
 310     command = key_map[i + 1];
 311     if (command)
 312         goto fin;
 313
 314 /* Function still not found for this key, so try macro's */
 315 /* This allows the same macro to be
 316    enabled by either eg "ALT('f')" or "XCTRL('f')" or "XCTRL('a'), 'f'" */
 317
 318 /* key.h: #define ALT(x) (0x200 | (x)) */
 319     if (x_key & ALT (0)) {      /* is an alt key ? */
 320         command = CK_Macro (x_key - ALT (0));
 321         goto fin;
 322     }
 323 /* key.h: #define XCTRL(x) ((x) & 31) */
 324     if (x_key < ' ') {          /* is a ctrl key ? */
 325         command = CK_Macro (x_key);
 326         goto fin;
 327     }
 328   fin:
 329
 330