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 #include "../src/main.h"        /* display_codepage */
  48 #include "../src/strutil.h"     /* str_isutf8 () */
  49
  50 /*
  51  * Ordinary translations.  Note that the keys listed first take priority
  52  * when the key is assigned to more than one command.
  53  */
  54 static const edit_key_map_type cooledit_key_map[] = {
  55     { ALT ('b'), CK_Match_Bracket },
  56     { ALT ('m'), CK_Mail },
  57     { XCTRL ('f'), CK_Save_Block },
  58     { XCTRL ('n'), CK_New },
  59     { XCTRL ('p'), CK_Pipe_Block (1) }, /* spell check */
  60     { XCTRL ('x'), CK_Word_Right },
  61     { XCTRL ('y'), CK_Delete_Line },
  62     { XCTRL ('z'), CK_Word_Left },
  63     { 0, 0 }
  64 };
  65
  66 static const edit_key_map_type emacs_key_map[] = {
  67     { ALT ('$'), CK_Pipe_Block (1) },   /* spell check */
  68     { ALT ('b'), CK_Word_Left },
  69     { ALT ('f'), CK_Word_Right },
  70     { ALT ('v'), CK_Page_Up },
  71     { ALT ('w'), CK_XStore },
  72     { XCTRL ('@'), CK_Mark },
  73     { XCTRL ('a'), CK_Home },
  74     { XCTRL ('b'), CK_Left },
  75     { XCTRL ('e'), CK_End },
  76     { XCTRL ('f'), CK_Right },
  77     { XCTRL ('g'), CK_Ignore_Key },
  78     { XCTRL ('n'), CK_Down },
  79     { XCTRL ('p'), CK_Up },
  80     { XCTRL ('s'), CK_Find },
  81     { XCTRL ('v'), CK_Page_Down },
  82     { XCTRL ('w'), CK_XCut },
  83     { XCTRL ('y'), CK_XPaste },
  84     { 0, 0 }
  85 };
  86
  87 static const edit_key_map_type common_key_map[] = {
  88     { '\n', CK_Enter },
  89     { '\t', CK_Tab },
  90
  91     { ESC_CHAR, CK_Exit },
  92     { KEY_BACKSPACE, CK_BackSpace },
  93     { KEY_DC, CK_Delete },
  94     { KEY_DOWN, CK_Down },
  95     { KEY_END, CK_End },
  96     { KEY_HOME, CK_Home },
  97     { KEY_IC, CK_Toggle_Insert },
  98     { KEY_LEFT, CK_Left },
  99     { KEY_NPAGE, CK_Page_Down },
 100     { KEY_PPAGE, CK_Page_Up },
 101     { KEY_RIGHT, CK_Right },
 102     { KEY_UP, CK_Up },
 103
 104     { ALT ('\n'), CK_Find_Definition },
 105     { ALT ('\t'), CK_Complete_Word },
 106     { ALT ('l'), CK_Goto },
 107     { ALT ('L'), CK_Goto },
 108     { ALT ('p'), CK_Paragraph_Format },
 109     { ALT ('t'), CK_Sort },
 110     { ALT ('u'), CK_ExtCmd },
 111     { ALT ('<'), CK_Beginning_Of_Text },
 112     { ALT ('>'), CK_End_Of_Text },
 113     { ALT ('-'), CK_Load_Prev_File },
 114     { ALT ('='), CK_Load_Next_File },
 115     { ALT (KEY_BACKSPACE), CK_Delete_Word_Left },
 116
 117     { XCTRL ('k'), CK_Delete_To_Line_End },
 118     { XCTRL ('l'), CK_Refresh },
 119     { XCTRL ('o'), CK_Shell },
 120     { XCTRL ('s'), CK_Toggle_Syntax },
 121     { XCTRL ('u'), CK_Undo },
 122     { XCTRL ('t'), CK_Select_Codepage },
 123     { XCTRL ('q'), CK_Insert_Literal },
 124     { XCTRL ('a'), CK_Execute_Macro },
 125     { XCTRL ('r'), CK_Begin_End_Macro },
 126
 127     { KEY_F (1), CK_Help },
 128     { KEY_F (2), CK_Save },
 129     { KEY_F (3), CK_Mark },
 130     { KEY_F (4), CK_Replace },
 131     { KEY_F (5), CK_Copy },
 132     { KEY_F (6), CK_Move },
 133     { KEY_F (7), CK_Find },
 134     { KEY_F (8), CK_Remove },
 135     { KEY_F (10), CK_Exit },
 136     { KEY_F (11), CK_User_Menu },       /* edit user menu */
 137     { KEY_F (12), CK_Save_As },
 138     { KEY_F (13), CK_Column_Mark },
 139     { KEY_F (14), CK_Replace_Again },
 140     { KEY_F (15), CK_Insert_File },
 141     { KEY_F (17), CK_Find_Again },
 142     { KEY_F (19), CK_Pipe_Block (0) },  /* C formatter */
 143
 144     /* Shift */
 145     { KEY_M_SHIFT | KEY_PPAGE, CK_Page_Up_Highlight },
 146     { KEY_M_SHIFT | KEY_NPAGE, CK_Page_Down_Highlight },
 147     { KEY_M_SHIFT | KEY_LEFT, CK_Left_Highlight },
 148     { KEY_M_SHIFT | KEY_RIGHT, CK_Right_Highlight },
 149     { KEY_M_SHIFT | KEY_UP, CK_Up_Highlight },
 150     { KEY_M_SHIFT | KEY_DOWN, CK_Down_Highlight },
 151     { KEY_M_SHIFT | KEY_HOME, CK_Home_Highlight },
 152     { KEY_M_SHIFT | KEY_END, CK_End_Highlight },
 153     { KEY_M_SHIFT | KEY_IC, CK_XPaste },
 154     { KEY_M_SHIFT | KEY_DC, CK_XCut },
 155     { KEY_M_SHIFT | '\n', CK_Return },  /* useful for pasting multiline text */
 156
 157     /* Ctrl */
 158     { KEY_M_CTRL | (KEY_F (2)), CK_Save_As },
 159     { KEY_M_CTRL | (KEY_F (4)), CK_Replace_Again },
 160     { KEY_M_CTRL | (KEY_F (7)), CK_Find_Again },
 161     { KEY_M_CTRL | KEY_BACKSPACE, CK_Undo },
 162     { KEY_M_CTRL | KEY_PPAGE, CK_Beginning_Of_Text },
 163     { KEY_M_CTRL | KEY_NPAGE, CK_End_Of_Text },
 164     { KEY_M_CTRL | KEY_HOME, CK_Beginning_Of_Text },
 165     { KEY_M_CTRL | KEY_END, CK_End_Of_Text },
 166     { KEY_M_CTRL | KEY_UP, CK_Scroll_Up },
 167     { KEY_M_CTRL | KEY_DOWN, CK_Scroll_Down },
 168     { KEY_M_CTRL | KEY_LEFT, CK_Word_Left },
 169     { KEY_M_CTRL | KEY_RIGHT, CK_Word_Right },
 170     { KEY_M_CTRL | KEY_IC, CK_XStore },
 171     { KEY_M_CTRL | KEY_DC, CK_Remove },
 172
 173     /* Ctrl + Shift */
 174     { KEY_M_SHIFT | KEY_M_CTRL | KEY_PPAGE, CK_Beginning_Of_Text_Highlight },
 175     { KEY_M_SHIFT | KEY_M_CTRL | KEY_NPAGE, CK_End_Of_Text_Highlight },
 176     { KEY_M_SHIFT | KEY_M_CTRL | KEY_LEFT, CK_Word_Left_Highlight },
 177     { KEY_M_SHIFT | KEY_M_CTRL | KEY_RIGHT, CK_Word_Right_Highlight },
 178     { KEY_M_SHIFT | KEY_M_CTRL | KEY_UP, CK_Scroll_Up_Highlight },
 179     { KEY_M_SHIFT | KEY_M_CTRL | KEY_DOWN, CK_Scroll_Down_Highlight },
 180
 181     { 0, 0 }
 182 };
 183
 184
 185 /*
 186  * Translate the keycode into either 'command' or 'char_for_insertion'.
 187  * 'command' is one of the editor commands from editcmddef.h.
 188  */
 189 int
 190 edit_translate_key (WEdit *edit, long x_key, int *cmd, int *ch)
 191 {
 192     int command = CK_Insert_Char;
 193     int char_for_insertion = -1;
 194     int i = 0;
 195     int extmod = 0;
 196     int c;
 197
 198     const edit_key_map_type *key_map = NULL;
 199     switch (edit_key_emulation) {
 200     case EDIT_KEY_EMULATION_NORMAL:
 201         key_map = cooledit_key_map;
 202         break;
 203     case EDIT_KEY_EMULATION_EMACS:
 204         key_map = emacs_key_map;
 205         if (x_key == XCTRL ('x')) {
 206             int ext_key;
 207             ext_key =
 208                 edit_raw_key_query (" Ctrl-X ", _(" Emacs key: "), 0);
 209             switch (ext_key) {
 210             case 's':
 211                 command = CK_Save;
 212                 goto fin;
 213             case 'x':
 214                 command = CK_Exit;
 215                 goto fin;
 216             case 'k':
 217                 command = CK_New;
 218                 goto fin;
 219             case 'e':
 220                 command =
 221                     CK_Macro (edit_raw_key_query
 222                               (_(" Execute Macro "),
 223                                _(" Press macro hotkey: "), 1));
 224                 if (command == CK_Macro (0))
 225                     command = CK_Insert_Char;
 226                 goto fin;
 227             }
 228             goto fin;
 229         }
 230         break;
 231
 232     case EDIT_KEY_EMULATION_USER:
 233         if (edit->user_map != NULL) {
 234             if (edit->extmod && edit->ext_map != NULL) {
 235                 key_map = edit->ext_map;
 236                 extmod = 1;
 237             } else {
 238                 key_map = edit->user_map;
 239             }
 240             edit->extmod = 0;
 241         } else {
 242             key_map = edit->user_map = cooledit_key_map;
 243         }
 244         break;
 245     }
 246     assert (key_map != NULL);
 247
 248     /* an ordinary insertable character */
 249     if (x_key < 256 && !extmod) {
 250         if ( edit->charpoint >= 4 ) {
 251             edit->charpoint = 0;
 252             edit->charbuf[edit->charpoint] = '\0';
 253         }
 254         if ( edit->charpoint < 4 ) {
 255             edit->charbuf[edit->charpoint++] = x_key;
 256             edit->charbuf[edit->charpoint] = '\0';
 257         }
 258
 259         /* input from 8-bit locale */
 260         if ( !utf8_display ) {
 261             /* source in 8-bit codeset */
 262             if (!edit->utf8) {
 263                 c = convert_from_input_c (x_key);
 264                 if (is_printable (c)) {
 265                     char_for_insertion = c;
 266                     goto fin;
 267                 }
 268             } else {
 269                 //FIXME: need more think about
 270                 //must be return multibyte char but this func return 8bit char
 271             }
 272         /* UTF-8 locale */
 273         } else {
 274             /* source in UTF-8 codeset */
 275             if ( edit->utf8 ) {
 276                 int res = str_is_valid_char (edit->charbuf, edit->charpoint);
 277                 if (res < 0) {
 278                     if (res != -2) {
 279                         edit->charpoint = 0; /* broken multibyte char, skip */
 280                         goto fin;
 281                     }
 282                     char_for_insertion = x_key;
 283                     goto fin;
 284                 } else {
 285                     edit->charbuf[edit->charpoint]='\0';
 286                     edit->charpoint = 0;
 287                     if ( g_unichar_isprint (g_utf8_get_char(edit->charbuf))) {
 288                         char_for_insertion = x_key;
 289                         goto fin;
 290                     }
 291                 }
 292
 293             /* 8-bit source */
 294             } else {
 295                 edit->charbuf[edit->charpoint + 1] = '\0';
 296                 int res = str_is_valid_char (edit->charbuf, edit->charpoint);
 297                 if (res < 0) {
 298                     if (res != -2) {
 299                         edit->charpoint = 0; /* broken multibyte char, skip */
 300                         goto fin;
 301                     }
 302                     /* not finised multibyte input (in meddle multibyte utf-8 char) */
 303                     goto fin;
 304                 } else {
 305                     if ( g_unichar_isprint (g_utf8_get_char(edit->charbuf)) ) {
 306                         c = convert_from_utf_to_current ( edit->charbuf );
 307                         edit->charbuf[0] = '\0';
 308                         edit->charpoint = 0;
 309                         if (is_printable (c)) {
 310                             char_for_insertion = c;
 311                             goto fin;
 312                         }
 313                     }
 314                     /* unprinteble utf input, skip it */
 315                     edit->charbuf[0] = '\0';
 316                     edit->charpoint = 0;
 317                 }
 318             }
 319         }
 320     }
 321
 322     /* Commands specific to the key emulation */
 323     for (i = 0; key_map[i].key != 0 && key_map[i].key != x_key; i++)
 324         continue;
 325     if (key_map[i].key != 0) {
 326         command = key_map[i].command;
 327         goto fin;
 328     }
 329
 330     /* Commands common for the key emulations */
 331     key_map = common_key_map;
 332     for (i = 0; key_map[i].key != 0 && key_map[i].key != x_key; i++)
 333         continue;
 334     if (key_map[i].key != 0) {
 335         command = key_map[i].command;
 336         goto fin;
 337     }
 338
 339     /* Function still not found for this key, so try macros */
 340     /* This allows the same macro to be
 341        enabled by either eg "ALT('f')" or "XCTRL('f')" or "XCTRL('a'), 'f'" */
 342
 343     if (x_key & ALT (0)) {      /* is an alt key ? */
 344         command = CK_Macro (x_key - ALT (0));
 345         goto fin;
 346     }
 347     if (x_key < ' ') {          /* is a ctrl key ? */
 348         command = CK_Macro (x_key);
 349         goto fin;
 350     }
 351   fin:
 352
 353     *cmd = command;
 354     *ch = char_for_insertion;
 355
 356     if (command == CK_Insert_Char && char_for_insertion == -1) {
 357         /* unchanged, key has no function here */
 358         return 0;
 359     }
 360
 361     return 1;
 362 }