edit/editkeys.c

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