vis-cmds.c

   1 /* this file is included from sam.c */
   2
   3 #include <termkey.h>
   4 #include "vis-lua.h"
   5
   6 // FIXME: avoid this redirection?
   7 typedef struct {
   8         CommandDef def;
   9         VisCommandFunction *func;
  10         void *data;
  11 } CmdUser;
  12
  13 static void cmdfree(CmdUser *cmd) {
  14         if (!cmd)
  15                 return;
  16         free((char*)cmd->def.name);
  17         free(VIS_HELP_USE((char*)cmd->def.help));
  18         free(cmd);
  19 }
  20
  21 bool vis_cmd_register(Vis *vis, const char *name, const char *help, void *data, VisCommandFunction *func) {
  22         if (!name)
  23                 return false;
  24         if (!vis->usercmds && !(vis->usercmds = map_new()))
  25                 return false;
  26         CmdUser *cmd = calloc(1, sizeof *cmd);
  27         if (!cmd)
  28                 return false;
  29         if (!(cmd->def.name = strdup(name)))
  30                 goto err;
  31 #if CONFIG_HELP
  32         if (help && !(cmd->def.help = strdup(help)))
  33                 goto err;
  34 #endif
  35         cmd->def.flags = CMD_ARGV|CMD_FORCE|CMD_ONCE|CMD_ADDRESS_ALL;
  36         cmd->def.func = cmd_user;
  37         cmd->func = func;
  38         cmd->data = data;
  39         if (!map_put(vis->cmds, name, &cmd->def))
  40                 goto err;
  41         if (!map_put(vis->usercmds, name, cmd)) {
  42                 map_delete(vis->cmds, name);
  43                 goto err;
  44         }
  45         return true;
  46 err:
  47         cmdfree(cmd);
  48         return false;
  49 }
  50
  51 bool vis_cmd_unregister(Vis *vis, const char *name) {
  52         if (!name)
  53                 return true;
  54         CmdUser *cmd = map_get(vis->usercmds, name);
  55         if (!cmd)
  56                 return false;
  57         if (!map_delete(vis->cmds, name))
  58                 return false;
  59         if (!map_delete(vis->usercmds, name))
  60                 return false;
  61         cmdfree(cmd);
  62         return true;
  63 }
  64
  65 static void option_free(OptionDef *opt) {
  66         if (!opt)
  67                 return;
  68         for (size_t i = 0; i < LENGTH(options); i++) {
  69                 if (opt == &options[i])
  70                         return;
  71         }
  72
  73         for (const char **name = opt->names; *name; name++)
  74                 free((char*)*name);
  75         free(VIS_HELP_USE((char*)opt->help));
  76         free(opt);
  77 }
  78
  79 bool vis_option_register(Vis *vis, const char *names[], enum VisOption flags,
  80                          VisOptionFunction *func, void *context, const char *help) {
  81
  82         if (!names || !names[0])
  83                 return false;
  84
  85         for (const char **name = names; *name; name++) {
  86                 if (map_get(vis->options, *name))
  87                         return false;
  88         }
  89         OptionDef *opt = calloc(1, sizeof *opt);
  90         if (!opt)
  91                 return false;
  92         for (size_t i = 0; i < LENGTH(opt->names)-1 && names[i]; i++) {
  93                 if (!(opt->names[i] = strdup(names[i])))
  94                         goto err;
  95         }
  96         opt->flags = flags;
  97         opt->func = func;
  98         opt->context = context;
  99 #if CONFIG_HELP
 100         if (help && !(opt->help = strdup(help)))
 101                 goto err;
 102 #endif
 103         for (const char **name = names; *name; name++)
 104                 map_put(vis->options, *name, opt);
 105         return true;
 106 err:
 107         option_free(opt);
 108         return false;
 109 }
 110
 111 bool vis_option_unregister(Vis *vis, const char *name) {
 112         OptionDef *opt = map_get(vis->options, name);
 113         if (!opt)
 114                 return false;
 115         for (const char **alias = opt->names; *alias; alias++) {
 116                 if (!map_delete(vis->options, *alias))
 117                         return false;
 118         }
 119         option_free(opt);
 120         return true;
 121 }
 122
 123 static bool cmd_user(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 124         CmdUser *user = map_get(vis->usercmds, argv[0]);
 125         return user && user->func(vis, win, user->data, cmd->flags == '!', argv, sel, range);
 126 }
 127
 128 static void windows_arrange(Vis *vis, enum UiLayout layout) {
 129         vis->ui->arrange(vis->ui, layout);
 130 }
 131
 132 static void tabwidth_set(Vis *vis, int tabwidth) {
 133         if (tabwidth < 1 || tabwidth > 8)
 134                 return;
 135         for (Win *win = vis->windows; win; win = win->next)
 136                 view_tabwidth_set(win->view, tabwidth);
 137         vis->tabwidth = tabwidth;
 138 }
 139
 140 /* parse human-readable boolean value in s. If successful, store the result in
 141  * outval and return true. Else return false and leave outval alone. */
 142 static bool parse_bool(const char *s, bool *outval) {
 143         for (const char **t = (const char*[]){"1", "true", "yes", "on", NULL}; *t; t++) {
 144                 if (!strcasecmp(s, *t)) {
 145                         *outval = true;
 146                         return true;
 147                 }
 148         }
 149         for (const char **f = (const char*[]){"0", "false", "no", "off", NULL}; *f; f++) {
 150                 if (!strcasecmp(s, *f)) {
 151                         *outval = false;
 152                         return true;
 153                 }
 154         }
 155         return false;
 156 }
 157
 158 static bool cmd_set(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 159
 160         if (!argv[1] || !argv[1][0] || argv[3]) {
 161                 vis_info_show(vis, "Expecting: set option [value]");
 162                 return false;
 163         }
 164
 165         char name[256];
 166         strncpy(name, argv[1], sizeof(name)-1);
 167         char *lastchar = &name[strlen(name)-1];
 168         bool toggle = (*lastchar == '!');
 169         if (toggle)
 170                 *lastchar = '\0';
 171
 172         OptionDef *opt = map_closest(vis->options, name);
 173         if (!opt) {
 174                 vis_info_show(vis, "Unknown option: `%s'", name);
 175                 return false;
 176         }
 177
 178         if (!win && (opt->flags & VIS_OPTION_NEED_WINDOW)) {
 179                 vis_info_show(vis, "Need active window for `:set %s'", name);
 180                 return false;
 181         }
 182
 183         if (toggle) {
 184                 if (!(opt->flags & VIS_OPTION_TYPE_BOOL)) {
 185                         vis_info_show(vis, "Only boolean options can be toggled");
 186                         return false;
 187                 }
 188                 if (argv[2]) {
 189                         vis_info_show(vis, "Can not specify option value when toggling");
 190                         return false;
 191                 }
 192         }
 193
 194         Arg arg;
 195         if (opt->flags & VIS_OPTION_TYPE_STRING) {
 196                 if (!(opt->flags & VIS_OPTION_VALUE_OPTIONAL) && !argv[2]) {
 197                         vis_info_show(vis, "Expecting string option value");
 198                         return false;
 199                 }
 200                 arg.s = argv[2];
 201         } else if (opt->flags & VIS_OPTION_TYPE_BOOL) {
 202                 if (!argv[2]) {
 203                         arg.b = !toggle;
 204                 } else if (!parse_bool(argv[2], &arg.b)) {
 205                         vis_info_show(vis, "Expecting boolean option value not: `%s'", argv[2]);
 206                         return false;
 207                 }
 208         } else if (opt->flags & VIS_OPTION_TYPE_NUMBER) {
 209                 if (!argv[2]) {
 210                         vis_info_show(vis, "Expecting number");
 211                         return false;
 212                 }
 213                 char *ep;
 214                 errno = 0;
 215                 long lval = strtol(argv[2], &ep, 10);
 216                 if (argv[2][0] == '\0' || *ep != '\0') {
 217                         vis_info_show(vis, "Invalid number");
 218                         return false;
 219                 }
 220
 221                 if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) ||
 222                     (lval > INT_MAX || lval < INT_MIN)) {
 223                         vis_info_show(vis, "Number overflow");
 224                         return false;
 225                 }
 226
 227                 if (lval < 0) {
 228                         vis_info_show(vis, "Expecting positive number");
 229                         return false;
 230                 }
 231                 arg.i = lval;
 232         } else {
 233                 return false;
 234         }
 235
 236         size_t opt_index = 0;
 237         for (; opt_index < LENGTH(options); opt_index++) {
 238                 if (opt == &options[opt_index])
 239                         break;
 240         }
 241
 242         switch (opt_index) {
 243         case OPTION_SHELL:
 244         {
 245                 char *shell = strdup(arg.s);
 246                 if (!shell) {
 247                         vis_info_show(vis, "Failed to change shell");
 248                         return false;
 249                 }
 250                 free(vis->shell);
 251                 vis->shell = shell;
 252                 break;
 253         }
 254         case OPTION_ESCDELAY:
 255         {
 256                 TermKey *termkey = vis->ui->termkey_get(vis->ui);
 257                 termkey_set_waittime(termkey, arg.i);
 258                 break;
 259         }
 260         case OPTION_EXPANDTAB:
 261                 vis->expandtab = toggle ? !vis->expandtab : arg.b;
 262                 break;
 263         case OPTION_AUTOINDENT:
 264                 vis->autoindent = toggle ? !vis->autoindent : arg.b;
 265                 break;
 266         case OPTION_TABWIDTH:
 267                 tabwidth_set(vis, arg.i);
 268                 break;
 269         case OPTION_SHOW_SPACES:
 270         case OPTION_SHOW_TABS:
 271         case OPTION_SHOW_NEWLINES:
 272         case OPTION_SHOW_EOF:
 273         {
 274                 const int values[] = {
 275                         [OPTION_SHOW_SPACES] = UI_OPTION_SYMBOL_SPACE,
 276                         [OPTION_SHOW_TABS] = UI_OPTION_SYMBOL_TAB|UI_OPTION_SYMBOL_TAB_FILL,
 277                         [OPTION_SHOW_NEWLINES] = UI_OPTION_SYMBOL_EOL,
 278                         [OPTION_SHOW_EOF] = UI_OPTION_SYMBOL_EOF,
 279                 };
 280                 int flags = view_options_get(win->view);
 281                 if (arg.b || (toggle && !(flags & values[opt_index])))
 282                         flags |= values[opt_index];
 283                 else
 284                         flags &= ~values[opt_index];
 285                 view_options_set(win->view, flags);
 286                 break;
 287         }
 288         case OPTION_NUMBER: {
 289                 enum UiOption opt = view_options_get(win->view);
 290                 if (arg.b || (toggle && !(opt & UI_OPTION_LINE_NUMBERS_ABSOLUTE))) {
 291                         opt &= ~UI_OPTION_LINE_NUMBERS_RELATIVE;
 292                         opt |=  UI_OPTION_LINE_NUMBERS_ABSOLUTE;
 293                 } else {
 294                         opt &= ~UI_OPTION_LINE_NUMBERS_ABSOLUTE;
 295                 }
 296                 view_options_set(win->view, opt);
 297                 break;
 298         }
 299         case OPTION_NUMBER_RELATIVE: {
 300                 enum UiOption opt = view_options_get(win->view);
 301                 if (arg.b || (toggle && !(opt & UI_OPTION_LINE_NUMBERS_RELATIVE))) {
 302                         opt &= ~UI_OPTION_LINE_NUMBERS_ABSOLUTE;
 303                         opt |=  UI_OPTION_LINE_NUMBERS_RELATIVE;
 304                 } else {
 305                         opt &= ~UI_OPTION_LINE_NUMBERS_RELATIVE;
 306                 }
 307                 view_options_set(win->view, opt);
 308                 break;
 309         }
 310         case OPTION_CURSOR_LINE: {
 311                 enum UiOption opt = view_options_get(win->view);
 312                 if (arg.b || (toggle && !(opt & UI_OPTION_CURSOR_LINE)))
 313                         opt |= UI_OPTION_CURSOR_LINE;
 314                 else
 315                         opt &= ~UI_OPTION_CURSOR_LINE;
 316                 view_options_set(win->view, opt);
 317                 break;
 318         }
 319         case OPTION_COLOR_COLUMN:
 320                 view_colorcolumn_set(win->view, arg.i);
 321                 break;
 322         case OPTION_SAVE_METHOD:
 323                 if (strcmp("auto", arg.s) == 0) {
 324                         win->file->save_method = TEXT_SAVE_AUTO;
 325                 } else if (strcmp("atomic", arg.s) == 0) {
 326                         win->file->save_method = TEXT_SAVE_ATOMIC;
 327                 } else if (strcmp("inplace", arg.s) == 0) {
 328                         win->file->save_method = TEXT_SAVE_INPLACE;
 329                 } else {
 330                         vis_info_show(vis, "Invalid save method `%s', expected "
 331                                       "'auto', 'atomic' or 'inplace'", arg.s);
 332                         return false;
 333                 }
 334                 break;
 335         case OPTION_CHANGE_256COLORS:
 336                 vis->change_colors = toggle ? !vis->change_colors : arg.b;
 337                 break;
 338         default:
 339                 if (!opt->func)
 340                         return false;
 341                 return opt->func(vis, win, opt->context, toggle, opt->flags, name, &arg);
 342         }
 343
 344         return true;
 345 }
 346
 347 static bool is_file_pattern(const char *pattern) {
 348         if (!pattern)
 349                 return false;
 350         struct stat meta;
 351         if (stat(pattern, &meta) == 0 && S_ISDIR(meta.st_mode))
 352                 return true;
 353         for (char special[] = "*?[{$~", *s = special; *s; s++) {
 354                 if (strchr(pattern, *s))
 355                         return true;
 356         }
 357         return false;
 358 }
 359
 360 static const char *file_open_dialog(Vis *vis, const char *pattern) {
 361         static char name[PATH_MAX];
 362         name[0] = '\0';
 363
 364         if (!is_file_pattern(pattern))
 365                 return pattern;
 366
 367         Buffer bufcmd, bufout, buferr;
 368         buffer_init(&bufcmd);
 369         buffer_init(&bufout);
 370         buffer_init(&buferr);
 371
 372         if (!buffer_put0(&bufcmd, VIS_OPEN " ") || !buffer_append0(&bufcmd, pattern ? pattern : ""))
 373                 return NULL;
 374
 375         Filerange empty = text_range_new(0,0);
 376         int status = vis_pipe(vis, vis->win->file, &empty,
 377                 (const char*[]){ buffer_content0(&bufcmd), NULL },
 378                 &bufout, read_buffer, &buferr, read_buffer);
 379
 380         if (status == 0)
 381                 strncpy(name, buffer_content0(&bufout), sizeof(name)-1);
 382         else
 383                 vis_info_show(vis, "Command failed %s", buffer_content0(&buferr));
 384
 385         buffer_release(&bufcmd);
 386         buffer_release(&bufout);
 387         buffer_release(&buferr);
 388
 389         for (char *end = name+strlen(name)-1; end >= name && isspace((unsigned char)*end); end--)
 390                 *end = '\0';
 391
 392         return name[0] ? name : NULL;
 393 }
 394
 395 static bool openfiles(Vis *vis, const char **files) {
 396         for (; *files; files++) {
 397                 const char *file = file_open_dialog(vis, *files);
 398                 if (!file)
 399                         return false;
 400                 errno = 0;
 401                 if (!vis_window_new(vis, file)) {
 402                         vis_info_show(vis, "Could not open `%s' %s", file,
 403                                          errno ? strerror(errno) : "");
 404                         return false;
 405                 }
 406         }
 407         return true;
 408 }
 409
 410 static bool cmd_open(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 411         if (!argv[1])
 412                 return vis_window_new(vis, NULL);
 413         return openfiles(vis, &argv[1]);
 414 }
 415
 416 static void info_unsaved_changes(Vis *vis) {
 417         vis_info_show(vis, "No write since last change (add ! to override)");
 418 }
 419
 420 static bool cmd_edit(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 421         if (argv[2]) {
 422                 vis_info_show(vis, "Only 1 filename allowed");
 423                 return false;
 424         }
 425         Win *oldwin = win;
 426         if (!oldwin)
 427                 return false;
 428         if (cmd->flags != '!' && !vis_window_closable(oldwin)) {
 429                 info_unsaved_changes(vis);
 430                 return false;
 431         }
 432         if (!argv[1]) {
 433                 if (oldwin->file->refcount > 1) {
 434                         vis_info_show(vis, "Can not reload file being opened multiple times");
 435                         return false;
 436                 }
 437                 return vis_window_reload(oldwin);
 438         }
 439         if (!openfiles(vis, &argv[1]))
 440                 return false;
 441         if (vis->win != oldwin) {
 442                 Win *newwin = vis->win;
 443                 vis_window_swap(oldwin, newwin);
 444                 vis_window_close(oldwin);
 445                 vis_window_focus(newwin);
 446         }
 447         return vis->win != oldwin;
 448 }
 449
 450 static bool cmd_read(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 451         bool ret = false;
 452         const size_t first_file = 3;
 453         const char *args[MAX_ARGV] = { argv[0], "cat", "--" };
 454         const char **name = argv[1] ? &argv[1] : (const char*[]){ ".", NULL };
 455         for (size_t i = first_file; *name && i < LENGTH(args)-1; name++, i++) {
 456                 const char *file = file_open_dialog(vis, *name);
 457                 if (!file || !(args[i] = strdup(file)))
 458                         goto err;
 459         }
 460         args[LENGTH(args)-1] = NULL;
 461         ret = cmd_pipein(vis, win, cmd, args, sel, range);
 462 err:
 463         for (size_t i = first_file; i < LENGTH(args); i++)
 464                 free((char*)args[i]);
 465         return ret;
 466 }
 467
 468 static bool has_windows(Vis *vis) {
 469         for (Win *win = vis->windows; win; win = win->next) {
 470                 if (!win->file->internal)
 471                         return true;
 472         }
 473         return false;
 474 }
 475
 476 static bool cmd_quit(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 477         if (cmd->flags != '!' && !vis_window_closable(win)) {
 478                 info_unsaved_changes(vis);
 479                 return false;
 480         }
 481         vis_window_close(win);
 482         if (!has_windows(vis))
 483                 vis_exit(vis, EXIT_SUCCESS);
 484         return true;
 485 }
 486
 487 static bool cmd_qall(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 488         for (Win *next, *win = vis->windows; win; win = next) {
 489                 next = win->next;
 490                 if (!win->file->internal && (!text_modified(win->file->text) || cmd->flags == '!'))
 491                         vis_window_close(win);
 492         }
 493         if (!has_windows(vis)) {
 494                 vis_exit(vis, EXIT_SUCCESS);
 495                 return true;
 496         } else {
 497                 info_unsaved_changes(vis);
 498                 return false;
 499         }
 500 }
 501
 502 static bool cmd_split(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 503         if (!win)
 504                 return false;
 505         enum UiOption options = view_options_get(win->view);
 506         windows_arrange(vis, UI_LAYOUT_HORIZONTAL);
 507         if (!argv[1])
 508                 return vis_window_split(win);
 509         bool ret = openfiles(vis, &argv[1]);
 510         if (ret)
 511                 view_options_set(vis->win->view, options);
 512         return ret;
 513 }
 514
 515 static bool cmd_vsplit(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 516         if (!win)
 517                 return false;
 518         enum UiOption options = view_options_get(win->view);
 519         windows_arrange(vis, UI_LAYOUT_VERTICAL);
 520         if (!argv[1])
 521                 return vis_window_split(win);
 522         bool ret = openfiles(vis, &argv[1]);
 523         if (ret)
 524                 view_options_set(vis->win->view, options);
 525         return ret;
 526 }
 527
 528 static bool cmd_new(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 529         windows_arrange(vis, UI_LAYOUT_HORIZONTAL);
 530         return vis_window_new(vis, NULL);
 531 }
 532
 533 static bool cmd_vnew(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 534         windows_arrange(vis, UI_LAYOUT_VERTICAL);
 535         return vis_window_new(vis, NULL);
 536 }
 537
 538 static bool cmd_wq(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 539         if (!win)
 540                 return false;
 541         File *file = win->file;
 542         bool unmodified = file->fd == -1 && !file->name && !text_modified(file->text);
 543         if (unmodified || cmd_write(vis, win, cmd, argv, sel, range))
 544                 return cmd_quit(vis, win, cmd, argv, sel, range);
 545         return false;
 546 }
 547
 548 static bool cmd_earlier_later(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 549         if (!win)
 550                 return false;
 551         Text *txt = win->file->text;
 552         char *unit = "";
 553         long count = 1;
 554         size_t pos = EPOS;
 555         if (argv[1]) {
 556                 errno = 0;
 557                 count = strtol(argv[1], &unit, 10);
 558                 if (errno || unit == argv[1] || count < 0) {
 559                         vis_info_show(vis, "Invalid number");
 560                         return false;
 561                 }
 562
 563                 if (*unit) {
 564                         while (*unit && isspace((unsigned char)*unit))
 565                                 unit++;
 566                         switch (*unit) {
 567                         case 'd': count *= 24; /* fall through */
 568                         case 'h': count *= 60; /* fall through */
 569                         case 'm': count *= 60; /* fall through */
 570                         case 's': break;
 571                         default:
 572                                 vis_info_show(vis, "Unknown time specifier (use: s,m,h or d)");
 573                                 return false;
 574                         }
 575
 576                         if (argv[0][0] == 'e')
 577                                 count = -count; /* earlier, move back in time */
 578
 579                         pos = text_restore(txt, text_state(txt) + count);
 580                 }
 581         }
 582
 583         if (!*unit) {
 584                 VisCountIterator it = vis_count_iterator_init(vis, count);
 585                 while (vis_count_iterator_next(&it)) {
 586                         if (argv[0][0] == 'e')
 587                                 pos = text_earlier(txt);
 588                         else
 589                                 pos = text_later(txt);
 590                 }
 591         }
 592
 593         time_t state = text_state(txt);
 594         char buf[32];
 595         strftime(buf, sizeof buf, "State from %H:%M", localtime(&state));
 596         vis_info_show(vis, "%s", buf);
 597
 598         return pos != EPOS;
 599 }
 600
 601 static bool print_keylayout(const char *key, void *value, void *data) {
 602         return text_appendf(data, "  %-18s\t%s\n", key[0] == ' ' ? "␣" : key, (char*)value);
 603 }
 604
 605 static bool print_keybinding(const char *key, void *value, void *data) {
 606         KeyBinding *binding = value;
 607         const char *desc = binding->alias;
 608         if (!desc && binding->action)
 609                 desc = VIS_HELP_USE(binding->action->help);
 610         return text_appendf(data, "  %-18s\t%s\n", key[0] == ' ' ? "␣" : key, desc ? desc : "");
 611 }
 612
 613 static void print_mode(Mode *mode, Text *txt) {
 614         if (!map_empty(mode->bindings))
 615                 text_appendf(txt, "\n %s\n\n", mode->name);
 616         map_iterate(mode->bindings, print_keybinding, txt);
 617 }
 618
 619 static bool print_action(const char *key, void *value, void *data) {
 620         const char *help = VIS_HELP_USE(((KeyAction*)value)->help);
 621         return text_appendf(data, "  %-30s\t%s\n", key, help ? help : "");
 622 }
 623
 624 static bool print_cmd(const char *key, void *value, void *data) {
 625         CommandDef *cmd = value;
 626         const char *help = VIS_HELP_USE(cmd->help);
 627         char usage[256];
 628         snprintf(usage, sizeof usage, "%s%s%s%s%s%s%s",
 629                  cmd->name,
 630                  (cmd->flags & CMD_FORCE) ? "[!]" : "",
 631                  (cmd->flags & CMD_TEXT) ? "/text/" : "",
 632                  (cmd->flags & CMD_REGEX) ? "/regexp/" : "",
 633                  (cmd->flags & CMD_CMD) ? " command" : "",
 634                  (cmd->flags & CMD_SHELL) ? (!strcmp(cmd->name, "s") ? "/regexp/text/" : " shell-command") : "",
 635                  (cmd->flags & CMD_ARGV) ? " [args...]" : "");
 636         return text_appendf(data, "  %-30s %s\n", usage, help ? help : "");
 637 }
 638
 639 static bool print_option(const char *key, void *value, void *txt) {
 640         char desc[256];
 641         const OptionDef *opt = value;
 642         const char *help = VIS_HELP_USE(opt->help);
 643         if (strcmp(key, opt->names[0]))
 644                 return true;
 645         snprintf(desc, sizeof desc, "%s%s%s%s%s",
 646                  opt->names[0],
 647                  opt->names[1] ? "|" : "",
 648                  opt->names[1] ? opt->names[1] : "",
 649                  opt->flags & VIS_OPTION_TYPE_BOOL ? " on|off" : "",
 650                  opt->flags & VIS_OPTION_TYPE_NUMBER ? " nn" : "");
 651         return text_appendf(txt, "  %-30s %s\n", desc, help ? help : "");
 652 }
 653
 654 static void print_symbolic_keys(Vis *vis, Text *txt) {
 655         static const int keys[] = {
 656                 TERMKEY_SYM_BACKSPACE,
 657                 TERMKEY_SYM_TAB,
 658                 TERMKEY_SYM_ENTER,
 659                 TERMKEY_SYM_ESCAPE,
 660                 //TERMKEY_SYM_SPACE,
 661                 TERMKEY_SYM_DEL,
 662                 TERMKEY_SYM_UP,
 663                 TERMKEY_SYM_DOWN,
 664                 TERMKEY_SYM_LEFT,
 665                 TERMKEY_SYM_RIGHT,
 666                 TERMKEY_SYM_BEGIN,
 667                 TERMKEY_SYM_FIND,
 668                 TERMKEY_SYM_INSERT,
 669                 TERMKEY_SYM_DELETE,
 670                 TERMKEY_SYM_SELECT,
 671                 TERMKEY_SYM_PAGEUP,
 672                 TERMKEY_SYM_PAGEDOWN,
 673                 TERMKEY_SYM_HOME,
 674                 TERMKEY_SYM_END,
 675                 TERMKEY_SYM_CANCEL,
 676                 TERMKEY_SYM_CLEAR,
 677                 TERMKEY_SYM_CLOSE,
 678                 TERMKEY_SYM_COMMAND,
 679                 TERMKEY_SYM_COPY,
 680                 TERMKEY_SYM_EXIT,
 681                 TERMKEY_SYM_HELP,
 682                 TERMKEY_SYM_MARK,
 683                 TERMKEY_SYM_MESSAGE,
 684                 TERMKEY_SYM_MOVE,
 685                 TERMKEY_SYM_OPEN,
 686                 TERMKEY_SYM_OPTIONS,
 687                 TERMKEY_SYM_PRINT,
 688                 TERMKEY_SYM_REDO,
 689                 TERMKEY_SYM_REFERENCE,
 690                 TERMKEY_SYM_REFRESH,
 691                 TERMKEY_SYM_REPLACE,
 692                 TERMKEY_SYM_RESTART,
 693                 TERMKEY_SYM_RESUME,
 694                 TERMKEY_SYM_SAVE,
 695                 TERMKEY_SYM_SUSPEND,
 696                 TERMKEY_SYM_UNDO,
 697                 TERMKEY_SYM_KP0,
 698                 TERMKEY_SYM_KP1,
 699                 TERMKEY_SYM_KP2,
 700                 TERMKEY_SYM_KP3,
 701                 TERMKEY_SYM_KP4,
 702                 TERMKEY_SYM_KP5,
 703                 TERMKEY_SYM_KP6,
 704                 TERMKEY_SYM_KP7,
 705                 TERMKEY_SYM_KP8,
 706                 TERMKEY_SYM_KP9,
 707                 TERMKEY_SYM_KPENTER,
 708                 TERMKEY_SYM_KPPLUS,
 709                 TERMKEY_SYM_KPMINUS,
 710                 TERMKEY_SYM_KPMULT,
 711                 TERMKEY_SYM_KPDIV,
 712                 TERMKEY_SYM_KPCOMMA,
 713                 TERMKEY_SYM_KPPERIOD,
 714                 TERMKEY_SYM_KPEQUALS,
 715         };
 716
 717         TermKey *termkey = vis->ui->termkey_get(vis->ui);
 718         text_appendf(txt, "  ␣ (a literal \" \" space symbol must be used to refer to <Space>)\n");
 719         for (size_t i = 0; i < LENGTH(keys); i++) {
 720                 text_appendf(txt, "  <%s>\n", termkey_get_keyname(termkey, keys[i]));
 721         }
 722 }
 723
 724 static bool cmd_help(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 725         if (!vis_window_new(vis, NULL))
 726                 return false;
 727
 728         Text *txt = vis->win->file->text;
 729
 730         text_appendf(txt, "vis %s (PID: %ld)\n\n", VERSION, (long)getpid());
 731
 732         text_appendf(txt, " Modes\n\n");
 733         for (int i = 0; i < LENGTH(vis_modes); i++) {
 734                 Mode *mode = &vis_modes[i];
 735                 if (mode->help)
 736                         text_appendf(txt, "  %-18s\t%s\n", mode->name, mode->help);
 737         }
 738
 739         if (!map_empty(vis->keymap)) {
 740                 text_appendf(txt, "\n Layout specific mappings (affects all modes except INSERT/REPLACE)\n\n");
 741                 map_iterate(vis->keymap, print_keylayout, txt);
 742         }
 743
 744         print_mode(&vis_modes[VIS_MODE_NORMAL], txt);
 745         print_mode(&vis_modes[VIS_MODE_OPERATOR_PENDING], txt);
 746         print_mode(&vis_modes[VIS_MODE_VISUAL], txt);
 747         print_mode(&vis_modes[VIS_MODE_INSERT], txt);
 748
 749         text_appendf(txt, "\n :-Commands\n\n");
 750         map_iterate(vis->cmds, print_cmd, txt);
 751
 752         text_appendf(txt, "\n Marks\n\n");
 753         text_appendf(txt, "  a-z General purpose marks\n");
 754         for (size_t i = 0; i < LENGTH(vis_marks); i++) {
 755                 const char *help = VIS_HELP_USE(vis_marks[i].help);
 756                 text_appendf(txt, "  %c   %s\n", vis_marks[i].name, help ? help : "");
 757         }
 758
 759         text_appendf(txt, "\n Registers\n\n");
 760         text_appendf(txt, "  a-z General purpose registers\n");
 761         text_appendf(txt, "  A-Z Append to corresponding general purpose register\n");
 762         for (size_t i = 0; i < LENGTH(vis_registers); i++) {
 763                 const char *help = VIS_HELP_USE(vis_registers[i].help);
 764                 text_appendf(txt, "  %c   %s\n", vis_registers[i].name, help ? help : "");
 765         }
 766
 767         text_appendf(txt, "\n :set command options\n\n");
 768         map_iterate(vis->options, print_option, txt);
 769
 770         text_appendf(txt, "\n Key binding actions\n\n");
 771         map_iterate(vis->actions, print_action, txt);
 772
 773         text_appendf(txt, "\n Symbolic keys usable for key bindings "
 774                 "(prefix with C-, S-, and M- for Ctrl, Shift and Alt respectively)\n\n");
 775         print_symbolic_keys(vis, txt);
 776
 777         char *paths[] = { NULL, NULL };
 778         char *paths_description[] = {
 779                 "Lua paths used to load runtime files (? will be replaced by filename):",
 780                 "Lua paths used to load C libraries (? will be replaced by filename):",
 781         };
 782
 783         if (vis_lua_paths_get(vis, &paths[0], &paths[1])) {
 784                 for (size_t i = 0; i < LENGTH(paths); i++) {
 785                         text_appendf(txt, "\n %s\n\n", paths_description[i]);
 786                         for (char *elem = paths[i], *next; elem; elem = next) {
 787                                 if ((next = strstr(elem, ";")))
 788                                         *next++ = '\0';
 789                                 if (*elem)
 790                                         text_appendf(txt, "  %s\n", elem);
 791                         }
 792                         free(paths[i]);
 793                 }
 794         }
 795
 796         text_appendf(txt, "\n Compile time configuration\n\n");
 797
 798         const struct {
 799                 const char *name;
 800                 bool enabled;
 801         } configs[] = {
 802                 { "Curses support: ", CONFIG_CURSES },
 803                 { "Lua support: ", CONFIG_LUA },
 804                 { "Lua LPeg statically built-in: ", CONFIG_LPEG },
 805                 { "TRE based regex support: ", CONFIG_TRE },
 806                 { "POSIX ACL support: ", CONFIG_ACL },
 807                 { "SELinux support: ", CONFIG_SELINUX },
 808         };
 809
 810         for (size_t i = 0; i < LENGTH(configs); i++)
 811                 text_appendf(txt, "  %-32s\t%s\n", configs[i].name, configs[i].enabled ? "yes" : "no");
 812
 813         text_save(txt, NULL);
 814         view_cursor_to(vis->win->view, 0);
 815
 816         if (argv[1])
 817                 vis_motion(vis, VIS_MOVE_SEARCH_FORWARD, argv[1]);
 818         return true;
 819 }
 820
 821 static bool cmd_langmap(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 822         const char *nonlatin = argv[1];
 823         const char *latin = argv[2];
 824         bool mapped = true;
 825
 826         if (!latin || !nonlatin) {
 827                 vis_info_show(vis, "usage: langmap <non-latin keys> <latin keys>");
 828                 return false;
 829         }
 830
 831         while (*latin && *nonlatin) {
 832                 size_t i = 0, j = 0;
 833                 char latin_key[8], nonlatin_key[8];
 834                 do {
 835                         if (i < sizeof(latin_key)-1)
 836                                 latin_key[i++] = *latin;
 837                         latin++;
 838                 } while (!ISUTF8(*latin));
 839                 do {
 840                         if (j < sizeof(nonlatin_key)-1)
 841                                 nonlatin_key[j++] = *nonlatin;
 842                         nonlatin++;
 843                 } while (!ISUTF8(*nonlatin));
 844                 latin_key[i] = '\0';
 845                 nonlatin_key[j] = '\0';
 846                 mapped &= vis_keymap_add(vis, nonlatin_key, strdup(latin_key));
 847         }
 848
 849         return mapped;
 850 }
 851
 852 static bool cmd_map(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 853         bool mapped = false;
 854         bool local = strstr(argv[0], "-") != NULL;
 855         enum VisMode mode = vis_mode_from(vis, argv[1]);
 856
 857         if (local && !win) {
 858                 vis_info_show(vis, "Invalid window for :%s", argv[0]);
 859                 return false;
 860         }
 861
 862         if (mode == VIS_MODE_INVALID || !argv[2] || !argv[3]) {
 863                 vis_info_show(vis, "usage: %s mode lhs rhs", argv[0]);
 864                 return false;
 865         }
 866
 867         const char *lhs = argv[2];
 868         KeyBinding *binding = vis_binding_new(vis);
 869         if (!binding || !(binding->alias = strdup(argv[3])))
 870                 goto err;
 871
 872         if (local)
 873                 mapped = vis_window_mode_map(win, mode, cmd->flags == '!', lhs, binding);
 874         else
 875                 mapped = vis_mode_map(vis, mode, cmd->flags == '!', lhs, binding);
 876
 877 err:
 878         if (!mapped) {
 879                 vis_info_show(vis, "Failed to map `%s' in %s mode%s", lhs, argv[1],
 880                               cmd->flags != '!' ? ", mapping already exists, "
 881                               "override with `!'" : "");
 882                 vis_binding_free(vis, binding);
 883         }
 884         return mapped;
 885 }
 886
 887 static bool cmd_unmap(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 888         bool unmapped = false;
 889         bool local = strstr(argv[0], "-") != NULL;
 890         enum VisMode mode = vis_mode_from(vis, argv[1]);
 891         const char *lhs = argv[2];
 892
 893         if (local && !win) {
 894                 vis_info_show(vis, "Invalid window for :%s", argv[0]);
 895                 return false;
 896         }
 897
 898         if (mode == VIS_MODE_INVALID || !lhs) {
 899                 vis_info_show(vis, "usage: %s mode lhs", argv[0]);
 900                 return false;
 901         }
 902
 903         if (local)
 904                 unmapped = vis_window_mode_unmap(win, mode, lhs);
 905         else
 906                 unmapped = vis_mode_unmap(vis, mode, lhs);
 907         if (!unmapped)
 908                 vis_info_show(vis, "Failed to unmap `%s' in %s mode", lhs, argv[1]);
 909         return unmapped;
 910 }