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