edit/editkeys.c

   1 /* Editor key translation.
   2
   3    Copyright (C) 1996, 1997 the Free Software Foundation
   4
   5    Authors: 1996, 1997 Paul Sheer
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20    02111-1307, USA.
  21 */
  22
  23 #include <config.h>
  24 #include "edit.h"
  25 #include "edit-widget.h"        /* edit->macro_i */
  26 #include "editcmddef.h"         /* list of commands */
  27 #include "../src/key.h"         /* KEY_M_SHIFT */
  28 #include "../src/tty.h"         /* keys */
  29 #include "../src/charsets.h"    /* convert_from_input_c() */
  30 #include "../src/selcodepage.h" /* do_select_codepage() */
  31
  32 /*
  33  * Ordinary translations.  Note that the keys listed first take priority
  34  * when the key is assigned to more than one command.
  35  */
  36 static const long cooledit_key_map[] = {
  37     ALT ('b'), CK_Match_Bracket,
  38     ALT ('m'), CK_Mail,
  39     XCTRL ('f'), CK_Save_Block,
  40     XCTRL ('n'), CK_New,
  41     XCTRL ('p'), CK_Pipe_Block (1),     /* spell check */
  42     XCTRL ('x'), CK_Word_Right,
  43     XCTRL ('y'), CK_Delete_Line,
  44     XCTRL ('z'), CK_Word_Left,
  45     0, 0
  46 };
  47
  48 static long const emacs_key_map[] = {
  49     ALT ('$'), CK_Pipe_Block (1),       /* spell check */
  50     ALT ('b'), CK_Word_Left,
  51     ALT ('f'), CK_Word_Right,
  52     ALT ('v'), CK_Page_Up,
  53     ALT ('w'), CK_XStore,
  54     XCTRL ('@'), CK_Mark,
  55     XCTRL ('a'), CK_Home,
  56     XCTRL ('b'), CK_Left,
  57     XCTRL ('e'), CK_End,
  58     XCTRL ('f'), CK_Right,
  59     XCTRL ('n'), CK_Down,
  60     XCTRL ('p'), CK_Up,
  61     XCTRL ('s'), CK_Find,
  62     XCTRL ('v'), CK_Page_Down,
  63     XCTRL ('w'), CK_XCut,
  64     XCTRL ('y'), CK_XPaste,
  65     0, 0
  66 };
  67
  68 static long const common_key_map[] = {
  69     '\n', CK_Enter,
  70     '\t', CK_Tab,
  71
  72     ESC_CHAR, CK_Exit,
  73     KEY_BACKSPACE, CK_BackSpace,
  74     KEY_DC, CK_Delete,
  75     KEY_DOWN, CK_Down,
  76     KEY_END, CK_End,
  77     KEY_HOME, CK_Home,
  78     KEY_IC, CK_Toggle_Insert,
  79     KEY_LEFT, CK_Left,
  80     KEY_NPAGE, CK_Page_Down,
  81     KEY_PPAGE, CK_Page_Up,
  82     KEY_RIGHT, CK_Right,
  83     KEY_UP, CK_Up,
  84
  85     ALT ('\n'), CK_Return,
  86     ALT ('\t'), CK_Complete_Word,
  87     ALT ('l'), CK_Goto,
  88     ALT ('L'), CK_Goto,
  89     ALT ('p'), CK_Paragraph_Format,
  90     ALT ('t'), CK_Sort,
  91     ALT ('u'), CK_ExtCmd,
  92     ALT ('<'), CK_Beginning_Of_Text,
  93     ALT ('>'), CK_End_Of_Text,
  94     ALT (KEY_BACKSPACE), CK_Delete_Word_Left,
  95
  96     XCTRL ('k'), CK_Delete_To_Line_End,
  97     XCTRL ('l'), CK_Refresh,
  98     XCTRL ('o'), CK_Shell,
  99     XCTRL ('u'), CK_Undo,
 100
 101     KEY_F (1), CK_Help,
 102     KEY_F (2), CK_Save,
 103     KEY_F (3), CK_Mark,
 104     KEY_F (4), CK_Replace,
 105     KEY_F (5), CK_Copy,
 106     KEY_F (6), CK_Move,
 107     KEY_F (7), CK_Find,
 108     KEY_F (8), CK_Remove,
 109     KEY_F (10), CK_Exit,
 110     KEY_F (11), CK_User_Menu,   /* edit user menu */
 111     KEY_F (12), CK_Save_As,
 112     KEY_F (13), CK_Column_Mark,
 113     KEY_F (14), CK_Replace_Again,
 114     KEY_F (15), CK_Insert_File,
 115     KEY_F (17), CK_Find_Again,
 116     KEY_F (19), CK_Pipe_Block (0),      /* C formatter */
 117
 118     /* Shift */
 119     KEY_M_SHIFT | KEY_PPAGE, CK_Page_Up_Highlight,
 120     KEY_M_SHIFT | KEY_NPAGE, CK_Page_Down_Highlight,
 121     KEY_M_SHIFT | KEY_LEFT, CK_Left_Highlight,
 122     KEY_M_SHIFT | KEY_RIGHT, CK_Right_Highlight,
 123     KEY_M_SHIFT | KEY_UP, CK_Up_Highlight,
 124     KEY_M_SHIFT | KEY_DOWN, CK_Down_Highlight,
 125     KEY_M_SHIFT | KEY_HOME, CK_Home_Highlight,
 126     KEY_M_SHIFT | KEY_END, CK_End_Highlight,
 127     KEY_M_SHIFT | KEY_IC, CK_XPaste,
 128     KEY_M_SHIFT | KEY_DC, CK_XCut,
 129     KEY_M_SHIFT | '\n', CK_Return,      /* useful for pasting multiline text */
 130
 131     /* Ctrl */
 132     KEY_M_CTRL | (KEY_F (2)), CK_Save_As,
 133     KEY_M_CTRL | (KEY_F (4)), CK_Replace_Again,
 134     KEY_M_CTRL | (KEY_F (7)), CK_Find_Again,
 135     KEY_M_CTRL | KEY_BACKSPACE, CK_Undo,
 136     KEY_M_CTRL | KEY_PPAGE, CK_Beginning_Of_Text,
 137     KEY_M_CTRL | KEY_NPAGE, CK_End_Of_Text,
 138     KEY_M_CTRL | KEY_HOME, CK_Beginning_Of_Text,
 139     KEY_M_CTRL | KEY_END, CK_End_Of_Text,
 140     KEY_M_CTRL | KEY_UP, CK_Scroll_Up,
 141     KEY_M_CTRL | KEY_DOWN, CK_Scroll_Down,
 142     KEY_M_CTRL | KEY_LEFT, CK_Word_Left,
 143     KEY_M_CTRL | KEY_RIGHT, CK_Word_Right,
 144     KEY_M_CTRL | KEY_IC, CK_XStore,
 145     KEY_M_CTRL | KEY_DC, CK_Remove,
 146
 147     /* Ctrl + Shift */
 148     KEY_M_SHIFT | KEY_M_CTRL | KEY_PPAGE, CK_Beginning_Of_Text_Highlight,
 149     KEY_M_SHIFT | KEY_M_CTRL | KEY_NPAGE, CK_End_Of_Text_Highlight,
 150     KEY_M_SHIFT | KEY_M_CTRL | KEY_LEFT, CK_Word_Left_Highlight,
 151     KEY_M_SHIFT | KEY_M_CTRL | KEY_RIGHT, CK_Word_Right_Highlight,
 152     KEY_M_SHIFT | KEY_M_CTRL | KEY_UP, CK_Scroll_Up_Highlight,
 153     KEY_M_SHIFT | KEY_M_CTRL | KEY_DOWN, CK_Scroll_Down_Highlight,
 154
 155     0, 0
 156 };
 157
 158
 159 /*
 160  * Translate the keycode into either 'command' or 'char_for_insertion'.
 161  * 'command' is one of the editor commands from editcmddef.h.
 162  */
 163 int
 164 edit_translate_key (WEdit *edit, long x_key, int *cmd, int *ch)
 165 {
 166     int command = -1;
 167     int char_for_insertion = -1;
 168     int i = 0;
 169     static const long *key_map;
 170
 171     switch (edit_key_emulation) {
 172     case EDIT_KEY_EMULATION_NORMAL:
 173         key_map = cooledit_key_map;
 174         break;
 175     case EDIT_KEY_EMULATION_EMACS:
 176         key_map = emacs_key_map;
 177         if (x_key == XCTRL ('x')) {
 178             int ext_key;
 179             ext_key =
 180                 edit_raw_key_query (" Ctrl-X ", _(" Emacs key: "), 0);
 181             switch (ext_key) {
 182             case 's':
 183                 command = CK_Save;
 184                 goto fin;
 185             case 'x':
 186                 command = CK_Exit;
 187                 goto fin;
 188             case 'k':
 189                 command = CK_New;
 190                 goto fin;
 191             case 'e':
 192                 command =
 193                     CK_Macro (edit_raw_key_query
 194                               (_(" Execute Macro "),
 195                                _(" Press macro hotkey: "), 1));
 196                 if (command == CK_Macro (0))
 197                     command = -1;
 198                 goto fin;
 199             }
 200             goto fin;
 201         }
 202         break;
 203     }
 204
 205 #ifdef HAVE_CHARSET
 206     if (x_key == XCTRL ('t')) {
 207         do_select_codepage ();
 208
 209         edit->force = REDRAW_COMPLETELY;
 210         command = CK_Refresh;
 211         goto fin;
 212     }
 213 #endif
 214
 215     if (x_key == XCTRL ('q')) {
 216         char_for_insertion =
 217             edit_raw_key_query (_(" Insert Literal "),
 218                                 _(" Press any key: "), 0);
 219         goto fin;
 220     }
 221     if (x_key == XCTRL ('a')
 222         && edit_key_emulation != EDIT_KEY_EMULATION_EMACS) {
 223         command =
 224             CK_Macro (edit_raw_key_query
 225                       (_(" Execute Macro "), _(" Press macro hotkey: "),
 226                        1));
 227         if (command == CK_Macro (0))
 228             command = -1;
 229         goto fin;
 230     }
 231     /* edit is a pointer to the widget */
 232     if (edit)
 233         if (x_key == XCTRL ('r')) {
 234             command =
 235                 edit->macro_i <
 236                 0 ? CK_Begin_Record_Macro : CK_End_Record_Macro;
 237             goto fin;
 238         }
 239
 240
 241     /* an ordinary insertable character */
 242     if (x_key < 256) {
 243         int c = convert_from_input_c (x_key);
 244
 245         if (is_printable (c)) {
 246             char_for_insertion = c;
 247             goto fin;
 248         }
 249     }
 250
 251     /* Commands specific to the key emulation */
 252     i = 0;
 253     while (key_map[i] != x_key && (key_map[i] || key_map[i + 1]))
 254         i += 2;
 255     command = key_map[i + 1];
 256     if (command)
 257         goto fin;
 258
 259     /* Commands common for the key emulations */
 260     key_map = common_key_map;
 261     i = 0;
 262     while (key_map[i] != x_key && (key_map[i] || key_map[i + 1]))
 263         i += 2;
 264     command = key_map[i + 1];
 265     if (command)
 266         goto fin;
 267
 268     /* Function still not found for this key, so try macros */
 269     /* This allows the same macro to be
 270        enabled by either eg "ALT('f')" or "XCTRL('f')" or "XCTRL('a'), 'f'" */
 271
 272     if (x_key & ALT (0)) {      /* is an alt key ? */
 273         command = CK_Macro (x_key - ALT (0));
 274         goto fin;
 275     }
 276     if (x_key < ' ') {          /* is a ctrl key ? */
 277         command = CK_Macro (x_key);
 278         goto fin;
 279     }
 280   fin:
 281
 282     *cmd = command;
 283     *ch = char_for_insertion;
 284
 285     if ((command == -1 || command == 0) && char_for_insertion == -1) {
 286         /* unchanged, key has no function here */
 287         return 0;
 288     }
 289
 290     return 1;
 291 }