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