edit/usermap.c

   1 /* cooledit.bindings file parser
   2
   3    Authors: 2005 Vitja Makarov
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307, USA.
  19 */
  20
  21 #include <config.h>
  22
  23 #include <ctype.h>
  24 #include <errno.h>
  25 #include <stdarg.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <unistd.h>
  32
  33 #include <mhl/types.h>
  34 #include <mhl/string.h>
  35
  36 #include "../src/global.h"
  37
  38 #include "edit.h"
  39 #include "edit-widget.h"
  40 #include "editcmddef.h"         /* list of commands */
  41 #include "usermap.h"
  42 #include "../src/key.h"         /* KEY_M_* */
  43 #include "../src/tty.h"         /* keys */
  44 #include "../src/wtools.h"
  45 #include "../src/widget.h"      /* buttonbar_redraw() */
  46
  47 typedef struct NameMap {
  48     const char *name;
  49     int val;
  50 } name_map_t;
  51
  52 typedef struct Config {
  53     time_t mtime;       /* mtime at the moment we read config file */
  54     GArray *keymap;
  55     GArray *ext_keymap;
  56     gchar *labels[10];
  57 } config_t;
  58
  59 typedef struct Command {
  60     const char *name;
  61     bool (*handler) (config_t *cfg, int argc, char *argv[]);
  62 } command_t;
  63
  64 static char error_msg[200] = "Nobody see this";
  65
  66 static const name_map_t key_names[] = {
  67     {"backspace", KEY_BACKSPACE},
  68     {"end", KEY_END},
  69     {"up", KEY_UP},
  70     {"down", KEY_DOWN},
  71     {"left", KEY_LEFT},
  72     {"right", KEY_RIGHT},
  73     {"home", KEY_HOME},
  74     {"a1", KEY_A1},
  75     {"c1", KEY_C1},
  76     {"npage", KEY_NPAGE},
  77     {"ppage", KEY_PPAGE},
  78     {"ic", KEY_IC},
  79     {"enter", KEY_ENTER},
  80     {"dc", KEY_DC},
  81     {"scancel", KEY_SCANCEL},
  82     {"btab", KEY_BTAB},
  83     {"f11", KEY_F(11)},
  84     {"f12", KEY_F(12)},
  85     {"f13", KEY_F(13)},
  86     {"f14", KEY_F(14)},
  87     {"f15", KEY_F(15)},
  88     {"f16", KEY_F(16)},
  89     {"f17", KEY_F(17)},
  90     {"f18", KEY_F(18)},
  91     {"f19", KEY_F(19)},
  92     {"f20", KEY_F(20)},
  93     {"tab", '\t'},
  94     {"return", '\n'},
  95     {NULL, 0}
  96 };
  97
  98 static const name_map_t command_names[] = {
  99     {"No-Command", CK_Ignore_Key},
 100     {"Ignore-Key", CK_Ignore_Key},
 101     {"BackSpace", CK_BackSpace},
 102     {"Delete", CK_Delete},
 103     {"Enter", CK_Enter},
 104     {"Page-Up", CK_Page_Up},
 105     {"Page-Down", CK_Page_Down},
 106     {"Left", CK_Left},
 107     {"Right", CK_Right},
 108     {"Word-Left", CK_Word_Left},
 109     {"Word-Right", CK_Word_Right},
 110     {"Up", CK_Up},
 111     {"Down", CK_Down},
 112     {"Home", CK_Home},
 113     {"End", CK_End},
 114     {"Tab", CK_Tab},
 115     {"Undo", CK_Undo},
 116     {"Beginning-Of-Text", CK_Beginning_Of_Text},
 117     {"End-Of-Text", CK_End_Of_Text},
 118     {"Scroll-Up", CK_Scroll_Up},
 119     {"Scroll-Down", CK_Scroll_Down},
 120     {"Return", CK_Return},
 121     {"Begin-Page", CK_Begin_Page},
 122     {"End-Page", CK_End_Page},
 123     {"Delete-Word-Left", CK_Delete_Word_Left},
 124     {"Delete-Word-Right", CK_Delete_Word_Right},
 125     {"Paragraph-Up", CK_Paragraph_Up},
 126     {"Paragraph-Down", CK_Paragraph_Down},
 127     {"Save", CK_Save},
 128     {"Load", CK_Load},
 129     {"New", CK_New},
 130     {"Save-as", CK_Save_As},
 131     {"Mark", CK_Mark},
 132     {"Copy", CK_Copy},
 133     {"Move", CK_Move},
 134     {"Remove", CK_Remove},
 135     {"Unmark", CK_Unmark},
 136     {"Save-Block", CK_Save_Block},
 137     {"Column-Mark", CK_Column_Mark},
 138     {"Find", CK_Find},
 139     {"Find-Again", CK_Find_Again},
 140     {"Replace", CK_Replace},
 141     {"Replace-Again", CK_Replace_Again},
 142     {"Complete-Word", CK_Complete_Word},
 143     {"Debug-Start", CK_Debug_Start},
 144     {"Debug-Stop", CK_Debug_Stop},
 145     {"Debug-Toggle-Break", CK_Debug_Toggle_Break},
 146     {"Debug-Clear", CK_Debug_Clear},
 147     {"Debug-Next", CK_Debug_Next},
 148     {"Debug-Step", CK_Debug_Step},
 149     {"Debug-Back-Trace", CK_Debug_Back_Trace},
 150     {"Debug-Continue", CK_Debug_Continue},
 151     {"Debug-Enter-Command", CK_Debug_Enter_Command},
 152     {"Debug-Until-Curser", CK_Debug_Until_Curser},
 153     {"Insert-File", CK_Insert_File},
 154     {"Exit", CK_Exit},
 155     {"Toggle-Insert", CK_Toggle_Insert},
 156     {"Help", CK_Help},
 157     {"Date", CK_Date},
 158     {"Refresh", CK_Refresh},
 159     {"Goto", CK_Goto},
 160     {"Delete-Line", CK_Delete_Line},
 161     {"Delete-To-Line-End", CK_Delete_To_Line_End},
 162     {"Delete-To-Line-Begin", CK_Delete_To_Line_Begin},
 163     {"Man-Page", CK_Man_Page},
 164     {"Sort", CK_Sort},
 165     {"Mail", CK_Mail},
 166     {"Cancel", CK_Cancel},
 167     {"Complete", CK_Complete},
 168     {"Paragraph-Format", CK_Paragraph_Format},
 169     {"Util", CK_Util},
 170     {"Type-Load-Python", CK_Type_Load_Python},
 171     {"Find-File", CK_Find_File},
 172     {"Ctags", CK_Ctags},
 173     {"Match-Bracket", CK_Match_Bracket},
 174     {"Terminal", CK_Terminal},
 175     {"Terminal-App", CK_Terminal_App},
 176     {"ExtCmd", CK_ExtCmd},
 177     {"User-Menu", CK_User_Menu},
 178     {"Save-Desktop", CK_Save_Desktop},
 179     {"New-Window", CK_New_Window},
 180     {"Cycle", CK_Cycle},
 181     {"Menu", CK_Menu},
 182     {"Save-And-Quit", CK_Save_And_Quit},
 183     {"Run-Another", CK_Run_Another},
 184     {"Check-Save-And-Quit", CK_Check_Save_And_Quit},
 185     {"Maximize", CK_Maximize},
 186     {"Begin-Record-Macro", CK_Begin_Record_Macro},
 187     {"End-Record-Macro", CK_End_Record_Macro},
 188     {"Delete-Macro", CK_Delete_Macro},
 189     {"Toggle-Bookmark", CK_Toggle_Bookmark},
 190     {"Flush-Bookmarks", CK_Flush_Bookmarks},
 191     {"Next-Bookmark", CK_Next_Bookmark},
 192     {"Prev-Bookmark", CK_Prev_Bookmark},
 193     {"Page-Up-Highlight", CK_Page_Up_Highlight},
 194     {"Page-Down-Highlight", CK_Page_Down_Highlight},
 195     {"Left-Highlight", CK_Left_Highlight},
 196     {"Right-Highlight", CK_Right_Highlight},
 197     {"Word-Left-Highlight", CK_Word_Left_Highlight},
 198     {"Word-Right-Highlight", CK_Word_Right_Highlight},
 199     {"Up-Highlight", CK_Up_Highlight},
 200     {"Down-Highlight", CK_Down_Highlight},
 201     {"Home-Highlight", CK_Home_Highlight},
 202     {"End-Highlight", CK_End_Highlight},
 203     {"Beginning-Of-Text-Highlight", CK_Beginning_Of_Text_Highlight},
 204     {"End-Of-Text_Highlight", CK_End_Of_Text_Highlight},
 205     {"Begin-Page-Highlight", CK_Begin_Page_Highlight},
 206     {"End-Page-Highlight", CK_End_Page_Highlight},
 207     {"Scroll-Up-Highlight", CK_Scroll_Up_Highlight},
 208     {"Scroll-Down-Highlight", CK_Scroll_Down_Highlight},
 209     {"Paragraph-Up-Highlight", CK_Paragraph_Up_Highlight},
 210     {"Paragraph-Down-Highlight", CK_Paragraph_Down_Highlight},
 211     {"XStore", CK_XStore},
 212     {"XCut", CK_XCut},
 213     {"XPaste", CK_XPaste},
 214     {"Selection-History", CK_Selection_History},
 215     {"Shell", CK_Shell},
 216     {"Select-Codepage", CK_Select_Codepage},
 217     {"Insert-Literal", CK_Insert_Literal},
 218     {"Execute-Macro", CK_Execute_Macro},
 219     {"Begin-or-End-Macro", CK_Begin_End_Macro},
 220     {"Ext-mode", CK_Ext_Mode},
 221 #if 0
 222     {"Focus-Next", CK_Focus_Next},
 223     {"Focus-Prev", CK_Focus_Prev},
 224     {"Height-Inc", CK_Height_Inc},
 225     {"Height-Dec", CK_Height_Dec},
 226     {"Make", CK_Make},
 227     {"Error-Next", CK_Error_Next},
 228     {"Error-Prev", CK_Error_Prev},
 229 #endif
 230     {NULL, 0}
 231 };
 232
 233 static void
 234 cfg_free_maps(config_t *cfg)
 235 {
 236     int i;
 237
 238     if (cfg->keymap)
 239         g_array_free(cfg->keymap, TRUE);
 240     cfg->keymap = NULL;
 241     if (cfg->ext_keymap)
 242         g_array_free(cfg->ext_keymap, TRUE);
 243     cfg->ext_keymap = NULL;
 244
 245     for (i = 0; i < 10; i++)
 246         g_free(cfg->labels[i]);
 247 }
 248
 249 /* Returns an array containing the words in str.  WARNING: As long as
 250  * the result is used, str[...] must be valid memory.  This function
 251  * modifies str[...] and uses it, so the caller should not use it until
 252  * g_ptr_array_free() is called for the returned result.
 253  */
 254 static GPtrArray *
 255 split_line(char *str)
 256 {
 257     bool inside_quote = false;
 258     int move = 0;
 259     GPtrArray *args;
 260
 261     args = g_ptr_array_new();
 262
 263     /* skip spaces */
 264     while (isspace((unsigned char) *str))
 265         str++;
 266
 267     g_ptr_array_add(args, str);
 268
 269     for (;; str++) {
 270         switch (*str) {
 271         case '#':               /* cut off comments */
 272             if (inside_quote)
 273                 break;
 274             /* FALLTHROUGH */
 275
 276         case '\n':              /* end of line */
 277         case '\r':
 278         case '\0':
 279             if (str == g_ptr_array_index(args, args->len - 1))
 280                 g_ptr_array_remove_index(args, args->len - 1);
 281             else
 282                 *(str - move) = '\0';
 283             return args;
 284
 285         case '"':               /* quote */
 286         case '\'':
 287             inside_quote = !inside_quote;
 288             move++;
 289             continue;
 290
 291         case ' ':               /* spaces */
 292         case '\t':
 293             if (inside_quote)
 294                 break;
 295
 296             *(str++ - move) = '\0';
 297             move = 0;
 298
 299             /* skip spaces */
 300             while (isspace((unsigned char) *str))
 301                 str++;
 302
 303             g_ptr_array_add(args, str--);
 304             break;
 305
 306         case '\\':
 307             switch (*(++str)) {
 308             case 'n':
 309                 *str = '\n';
 310                 break;
 311             case 'r':
 312                 *str = '\r';
 313                 break;
 314             case 't':
 315                 *str = '\t';
 316                 break;
 317             }
 318             move++;
 319             break;
 320         }
 321         if (move != 0)
 322             *(str - move) = *str;
 323     }
 324     /* never be here */
 325 }
 326
 327 static void
 328 keymap_add(GArray *keymap, int key, int cmd)
 329 {
 330     edit_key_map_type new_one, *map;
 331     guint i;
 332
 333     map = &(g_array_index(keymap, edit_key_map_type, 0));
 334     for (i = 0; i < keymap->len; i++) {
 335         if (map[i].key == key) {
 336             map[i].command = cmd;
 337             return;
 338         }
 339     }
 340
 341     new_one.key = key;
 342     new_one.command = cmd;
 343     g_array_append_val(keymap, new_one);
 344 }
 345
 346 /* bind <key> <command> */
 347 static bool
 348 cmd_bind(config_t *cfg, int argc, char *argv[])
 349 {
 350     char *keyname, *command;
 351     const name_map_t *key = key_names;
 352     const name_map_t *cmd = command_names;
 353     int mod = 0, k = -1, m = 0;
 354
 355     if (argc != 3) {
 356         snprintf(error_msg, sizeof(error_msg),
 357                  _("bind: Wrong argument number, bind <key> <command>"));
 358         return false;
 359     }
 360
 361     keyname = argv[1];
 362     command = argv[2];
 363
 364     while (*keyname) {
 365         switch (*keyname++) {
 366         case 'C':
 367             m = KEY_M_CTRL;
 368             continue;
 369         case 'M':
 370         case 'A':
 371             m = KEY_M_ALT;
 372             continue;
 373         case 'S':
 374             m = KEY_M_SHIFT;
 375             continue;
 376         case '-':
 377             if (!m) {           /* incorrect key */
 378                 snprintf(error_msg, sizeof(error_msg),
 379                          _("bind: Bad key value `%s'"), keyname);
 380                 return false;
 381             }
 382             mod |= m;
 383             m = 0;
 384             continue;
 385         }
 386         keyname--;
 387         break;
 388     }
 389
 390     /* no key */
 391     if (keyname[0] == '\0') {
 392         snprintf(error_msg, sizeof(error_msg), _("bind: Ehh...no key?"));
 393         return false;
 394     }
 395
 396     /* ordinary key */
 397     if (keyname[1] == '\0') {
 398         k = keyname[0];
 399     } else {
 400         while (key->name && strcasecmp(key->name, keyname) != 0)
 401             key++;
 402     }
 403
 404     if (k < 0 && !key->name) {
 405         snprintf(error_msg, sizeof(error_msg),
 406                  _("bind: Unknown key: `%s'"), keyname);
 407         return false;
 408     }
 409
 410     while (cmd->name && strcasecmp(cmd->name, command) != 0)
 411         cmd++;
 412
 413     if (!cmd->name) {
 414         snprintf(error_msg, sizeof(error_msg),
 415                  _("bind: Unknown command: `%s'"), command);
 416         return false;
 417     }
 418
 419     if (mod & KEY_M_CTRL) {
 420         if (k < 256)
 421             k = XCTRL(k);
 422         else
 423             k |= KEY_M_CTRL;
 424     }
 425
 426     if (mod & KEY_M_ALT)
 427         k |= KEY_M_ALT;
 428
 429     if (mod & KEY_M_SHIFT)
 430         k |= KEY_M_SHIFT;
 431
 432     if (!strcasecmp("bind-ext", argv[0]))
 433         keymap_add(cfg->ext_keymap, k, cmd->val);
 434     else
 435         keymap_add(cfg->keymap, k, cmd->val);
 436
 437     return true;
 438 }
 439
 440 #if 0
 441 #define CMD_F(x)                                \
 442     static void cmd_F ## x (WEdit * edit)       \
 443     {                                           \
 444         send_message ((Widget *) edit, WIDGET_KEY, KEY_F (x));  \
 445     }
 446
 447 CMD_F(1)
 448 CMD_F(2)
 449 CMD_F(3)
 450 CMD_F(4)
 451 CMD_F(5)
 452 CMD_F(6)
 453 CMD_F(7)
 454 CMD_F(8)
 455 CMD_F(9)
 456 CMD_F(10)
 457
 458 void (*cmd_Fx[]) (WEdit *) = {
 459     cmd_F1, cmd_F2, cmd_F3, cmd_F4, cmd_F5,
 460     cmd_F6, cmd_F7, cmd_F8, cmd_F9, cmd_F10
 461 } ;
 462
 463 /* move me! */
 464 static void edit_my_define (Dlg_head * h, int idx, const char *text,
 465                             void (*fn) (WEdit *), WEdit * edit)
 466 {
 467     /* function-cast ok */
 468     buttonbar_set_label_data (h, idx, text, (buttonbarfn) fn, edit);
 469 }
 470 #endif
 471
 472 /* label <number> <command> <label> */
 473 static bool
 474 cmd_label(config_t *cfg, int argc, char *argv[])
 475 {
 476     const name_map_t *cmd = command_names;
 477     const char *command, *label;
 478     int fn;
 479
 480     if (argc != 4) {
 481         snprintf(error_msg, sizeof(error_msg),
 482                  _("%s: Syntax: %s <n> <command> <label>"),
 483                 argv[0], argv[0]);
 484         return false;
 485     }
 486
 487     fn  = strtol(argv[1], NULL, 0);
 488     command = argv[2];
 489     label = argv[3];
 490
 491     while (cmd->name && strcasecmp(cmd->name, command) != 0)
 492         cmd++;
 493
 494     if (!cmd->name) {
 495         snprintf(error_msg, sizeof(error_msg),
 496                  _("%s: Unknown command: `%s'"), argv[0], command);
 497         return false;
 498     }
 499
 500     if (fn < 1 || fn > 10) {
 501         snprintf(error_msg, sizeof(error_msg),
 502                  _("%s: fn should be 1-10"), argv[0]);
 503         return false;
 504     }
 505
 506     keymap_add(cfg->keymap, KEY_F(fn), cmd->val);
 507     cfg->labels[fn - 1] = g_strdup(label);
 508
 509     return true;
 510 }
 511
 512
 513 static bool
 514 parse_file(config_t *cfg, const char *file, const command_t *cmd)
 515 {
 516     char buf[200];
 517     int line = 0;
 518
 519     FILE *fp = fopen(file, "r");
 520
 521     if (!fp) {
 522         snprintf(error_msg, sizeof(error_msg), _("%s: fopen(): %s"),
 523                  file, strerror(errno));
 524         return false;
 525     }
 526
 527     while (fgets(buf, sizeof(buf), fp)) {
 528         const command_t *c = cmd;
 529         GPtrArray *args;
 530         char **argv;
 531
 532         line++;
 533
 534         args = split_line(buf);
 535         argv = (char **) args->pdata;
 536
 537         if (args->len == 0) {
 538             g_ptr_array_free(args, TRUE);
 539             continue;
 540         }
 541
 542         while (c->name != NULL && strcasecmp(c->name, argv[0]) != 0)
 543             c++;
 544
 545         if (c->name == NULL) {
 546             snprintf(error_msg, sizeof(error_msg),
 547                      _("%s:%d: unknown command `%s'"), file, line,
 548                      argv[0]);
 549             g_ptr_array_free(args, TRUE);
 550             fclose(fp);
 551             return false;
 552         }
 553
 554         if (!(c->handler(cfg, args->len, argv))) {
 555             char *ss = g_strdup(error_msg);
 556             snprintf(error_msg, sizeof(error_msg),
 557                          _("%s:%d: %s"), file, line, ss);
 558             g_free(ss);
 559             g_ptr_array_free(args, TRUE);
 560             fclose(fp);
 561             return false;
 562         }
 563         g_ptr_array_free(args, TRUE);
 564     }
 565
 566     fclose(fp);
 567     return true;
 568 }
 569
 570 static bool
 571 load_user_keymap(config_t *cfg, const char *file)
 572 {
 573     const command_t cmd[] = {
 574         {"bind", cmd_bind},
 575         {"bind-ext", cmd_bind},
 576         {"label", cmd_label},
 577         {0, 0}
 578     };
 579
 580     cfg->keymap = g_array_new(TRUE, FALSE, sizeof(edit_key_map_type));
 581     cfg->ext_keymap = g_array_new(TRUE, FALSE, sizeof(edit_key_map_type));
 582
 583     if (!parse_file(cfg, file, cmd)) {
 584         return false;
 585     }
 586
 587     return true;
 588 }
 589
 590 bool
 591 edit_load_user_map(WEdit *edit)
 592 {
 593     static config_t cfg;
 594     config_t new_cfg;
 595     char *file;
 596     struct stat s;
 597
 598     if (edit_key_emulation != EDIT_KEY_EMULATION_USER)
 599         return true;
 600
 601     file = mhl_str_dir_plus_file(home_dir, MC_USERMAP);
 602
 603     if (stat(file, &s) < 0) {
 604         char *msg = g_strdup_printf(_("%s not found!"), file);
 605         edit_error_dialog(_("Error"), msg);
 606         g_free(msg);
 607         g_free(file);
 608         return false;
 609     }
 610
 611     if (s.st_mtime != cfg.mtime) {
 612         memset(&new_cfg, 0, sizeof(new_cfg));
 613         new_cfg.mtime = s.st_mtime;
 614
 615         if (!load_user_keymap(&new_cfg, file)) {
 616             edit_error_dialog(_("Error"), error_msg);
 617             cfg_free_maps(&new_cfg);
 618             g_free(file);
 619             return false;
 620         } else {
 621             cfg_free_maps(&cfg);
 622             cfg = new_cfg;
 623         }
 624     }
 625
 626     edit->user_map = (edit_key_map_type *) cfg.keymap->data;
 627     edit->ext_map = (edit_key_map_type *) cfg.ext_keymap->data;
 628     memcpy(edit->labels, cfg.labels, sizeof(edit->labels));
 629
 630     g_free(file);
 631
 632     return true;
 633 }