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         {
 273                 const int values[] = {
 274                         [OPTION_SHOW_SPACES] = UI_OPTION_SYMBOL_SPACE,
 275                         [OPTION_SHOW_TABS] = UI_OPTION_SYMBOL_TAB|UI_OPTION_SYMBOL_TAB_FILL,
 276                         [OPTION_SHOW_NEWLINES] = UI_OPTION_SYMBOL_EOL,
 277                 };
 278                 int flags = view_options_get(win->view);
 279                 if (arg.b || (toggle && !(flags & values[opt_index])))
 280                         flags |= values[opt_index];
 281                 else
 282                         flags &= ~values[opt_index];
 283                 view_options_set(win->view, flags);
 284                 break;
 285         }
 286         case OPTION_NUMBER: {
 287                 enum UiOption opt = view_options_get(win->view);
 288                 if (arg.b || (toggle && !(opt & UI_OPTION_LINE_NUMBERS_ABSOLUTE))) {
 289                         opt &= ~UI_OPTION_LINE_NUMBERS_RELATIVE;
 290                         opt |=  UI_OPTION_LINE_NUMBERS_ABSOLUTE;
 291                 } else {
 292                         opt &= ~UI_OPTION_LINE_NUMBERS_ABSOLUTE;
 293                 }
 294                 view_options_set(win->view, opt);
 295                 break;
 296         }
 297         case OPTION_NUMBER_RELATIVE: {
 298                 enum UiOption opt = view_options_get(win->view);
 299                 if (arg.b || (toggle && !(opt & UI_OPTION_LINE_NUMBERS_RELATIVE))) {
 300                         opt &= ~UI_OPTION_LINE_NUMBERS_ABSOLUTE;
 301                         opt |=  UI_OPTION_LINE_NUMBERS_RELATIVE;
 302                 } else {
 303                         opt &= ~UI_OPTION_LINE_NUMBERS_RELATIVE;
 304                 }
 305                 view_options_set(win->view, opt);
 306                 break;
 307         }
 308         case OPTION_CURSOR_LINE: {
 309                 enum UiOption opt = view_options_get(win->view);
 310                 if (arg.b || (toggle && !(opt & UI_OPTION_CURSOR_LINE)))
 311                         opt |= UI_OPTION_CURSOR_LINE;
 312                 else
 313                         opt &= ~UI_OPTION_CURSOR_LINE;
 314                 view_options_set(win->view, opt);
 315                 break;
 316         }
 317         case OPTION_COLOR_COLUMN:
 318                 view_colorcolumn_set(win->view, arg.i);
 319                 break;
 320         case OPTION_SAVE_METHOD:
 321                 if (strcmp("auto", arg.s) == 0) {
 322                         win->file->save_method = TEXT_SAVE_AUTO;
 323                 } else if (strcmp("atomic", arg.s) == 0) {
 324                         win->file->save_method = TEXT_SAVE_ATOMIC;
 325                 } else if (strcmp("inplace", arg.s) == 0) {
 326                         win->file->save_method = TEXT_SAVE_INPLACE;
 327                 } else {
 328                         vis_info_show(vis, "Invalid save method `%s', expected "
 329                                       "'auto', 'atomic' or 'inplace'", arg.s);
 330                         return false;
 331                 }
 332                 break;
 333         case OPTION_CHANGE_256COLORS:
 334                 vis->change_colors = toggle ? !vis->change_colors : arg.b;
 335                 break;
 336         default:
 337                 if (!opt->func)
 338                         return false;
 339                 return opt->func(vis, win, opt->context, toggle, opt->flags, name, &arg);
 340         }
 341
 342         return true;
 343 }
 344
 345 static bool is_file_pattern(const char *pattern) {
 346         if (!pattern)
 347                 return false;
 348         struct stat meta;
 349         if (stat(pattern, &meta) == 0 && S_ISDIR(meta.st_mode))
 350                 return true;
 351         for (char special[] = "*?[{$~", *s = special; *s; s++) {
 352                 if (strchr(pattern, *s))
 353                         return true;
 354         }
 355         return false;
 356 }
 357
 358 static const char *file_open_dialog(Vis *vis, const char *pattern) {
 359         static char name[PATH_MAX];
 360         name[0] = '\0';
 361
 362         if (!is_file_pattern(pattern))
 363                 return pattern;
 364
 365         Buffer bufcmd, bufout, buferr;
 366         buffer_init(&bufcmd);
 367         buffer_init(&bufout);
 368         buffer_init(&buferr);
 369
 370         if (!buffer_put0(&bufcmd, VIS_OPEN " ") || !buffer_append0(&bufcmd, pattern ? pattern : ""))
 371                 return NULL;
 372
 373         Filerange empty = text_range_new(0,0);
 374         int status = vis_pipe(vis, vis->win->file, &empty,
 375                 (const char*[]){ buffer_content0(&bufcmd), NULL },
 376                 &bufout, read_buffer, &buferr, read_buffer);
 377
 378         if (status == 0)
 379                 strncpy(name, buffer_content0(&bufout), sizeof(name)-1);
 380         else
 381                 vis_info_show(vis, "Command failed %s", buffer_content0(&buferr));
 382
 383         buffer_release(&bufcmd);
 384         buffer_release(&bufout);
 385         buffer_release(&buferr);
 386
 387         for (char *end = name+strlen(name)-1; end >= name && isspace((unsigned char)*end); end--)
 388                 *end = '\0';
 389
 390         return name[0] ? name : NULL;
 391 }
 392
 393 static bool openfiles(Vis *vis, const char **files) {
 394         for (; *files; files++) {
 395                 const char *file = file_open_dialog(vis, *files);
 396                 if (!file)
 397                         return false;
 398                 errno = 0;
 399                 if (!vis_window_new(vis, file)) {
 400                         vis_info_show(vis, "Could not open `%s' %s", file,
 401                                          errno ? strerror(errno) : "");
 402                         return false;
 403                 }
 404         }
 405         return true;
 406 }
 407
 408 static bool cmd_open(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 409         if (!argv[1])
 410                 return vis_window_new(vis, NULL);
 411         return openfiles(vis, &argv[1]);
 412 }
 413
 414 static void info_unsaved_changes(Vis *vis) {
 415         vis_info_show(vis, "No write since last change (add ! to override)");
 416 }
 417
 418 static bool cmd_edit(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 419         if (argv[2]) {
 420                 vis_info_show(vis, "Only 1 filename allowed");
 421                 return false;
 422         }
 423         Win *oldwin = win;
 424         if (!oldwin)
 425                 return false;
 426         if (cmd->flags != '!' && !vis_window_closable(oldwin)) {
 427                 info_unsaved_changes(vis);
 428                 return false;
 429         }
 430         if (!argv[1]) {
 431                 if (oldwin->file->refcount > 1) {
 432                         vis_info_show(vis, "Can not reload file being opened multiple times");
 433                         return false;
 434                 }
 435                 return vis_window_reload(oldwin);
 436         }
 437         if (!openfiles(vis, &argv[1]))
 438                 return false;
 439         if (vis->win != oldwin) {
 440                 Win *newwin = vis->win;
 441                 vis_window_swap(oldwin, newwin);
 442                 vis_window_close(oldwin);
 443                 vis_window_focus(newwin);
 444         }
 445         return vis->win != oldwin;
 446 }
 447
 448 static bool cmd_read(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 449         bool ret = false;
 450         const size_t first_file = 3;
 451         const char *args[MAX_ARGV] = { argv[0], "cat", "--" };
 452         const char **name = argv[1] ? &argv[1] : (const char*[]){ ".", NULL };
 453         for (size_t i = first_file; *name && i < LENGTH(args)-1; name++, i++) {
 454                 const char *file = file_open_dialog(vis, *name);
 455                 if (!file || !(args[i] = strdup(file)))
 456                         goto err;
 457         }
 458         args[LENGTH(args)-1] = NULL;
 459         ret = cmd_pipein(vis, win, cmd, args, sel, range);
 460 err:
 461         for (size_t i = first_file; i < LENGTH(args); i++)
 462                 free((char*)args[i]);
 463         return ret;
 464 }
 465
 466 static bool has_windows(Vis *vis) {
 467         for (Win *win = vis->windows; win; win = win->next) {
 468                 if (!win->file->internal)
 469                         return true;
 470         }
 471         return false;
 472 }
 473
 474 static bool cmd_quit(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 475         if (cmd->flags != '!' && !vis_window_closable(win)) {
 476                 info_unsaved_changes(vis);
 477                 return false;
 478         }
 479         vis_window_close(win);
 480         if (!has_windows(vis))
 481                 vis_exit(vis, EXIT_SUCCESS);
 482         return true;
 483 }
 484
 485 static bool cmd_qall(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 486         for (Win *next, *win = vis->windows; win; win = next) {
 487                 next = win->next;
 488                 if (!win->file->internal && (!text_modified(win->file->text) || cmd->flags == '!'))
 489                         vis_window_close(win);
 490         }
 491         if (!has_windows(vis)) {
 492                 vis_exit(vis, EXIT_SUCCESS);
 493                 return true;
 494         } else {
 495                 info_unsaved_changes(vis);
 496                 return false;
 497         }
 498 }
 499
 500 static bool cmd_split(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 501         if (!win)
 502                 return false;
 503         enum UiOption options = view_options_get(win->view);
 504         windows_arrange(vis, UI_LAYOUT_HORIZONTAL);
 505         if (!argv[1])
 506                 return vis_window_split(win);
 507         bool ret = openfiles(vis, &argv[1]);
 508         if (ret)
 509                 view_options_set(vis->win->view, options);
 510         return ret;
 511 }
 512
 513 static bool cmd_vsplit(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 514         if (!win)
 515                 return false;
 516         enum UiOption options = view_options_get(win->view);
 517         windows_arrange(vis, UI_LAYOUT_VERTICAL);
 518         if (!argv[1])
 519                 return vis_window_split(win);
 520         bool ret = openfiles(vis, &argv[1]);
 521         if (ret)
 522                 view_options_set(vis->win->view, options);
 523         return ret;
 524 }
 525
 526 static bool cmd_new(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 527         windows_arrange(vis, UI_LAYOUT_HORIZONTAL);
 528         return vis_window_new(vis, NULL);
 529 }
 530
 531 static bool cmd_vnew(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 532         windows_arrange(vis, UI_LAYOUT_VERTICAL);
 533         return vis_window_new(vis, NULL);
 534 }
 535
 536 static bool cmd_wq(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 537         if (!win)
 538                 return false;
 539         File *file = win->file;
 540         bool unmodified = file->fd == -1 && !file->name && !text_modified(file->text);
 541         if (unmodified || cmd_write(vis, win, cmd, argv, sel, range))
 542                 return cmd_quit(vis, win, cmd, argv, sel, range);
 543         return false;
 544 }
 545
 546 static bool cmd_earlier_later(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 547         if (!win)
 548                 return false;
 549         Text *txt = win->file->text;
 550         char *unit = "";
 551         long count = 1;
 552         size_t pos = EPOS;
 553         if (argv[1]) {
 554                 errno = 0;
 555                 count = strtol(argv[1], &unit, 10);
 556                 if (errno || unit == argv[1] || count < 0) {
 557                         vis_info_show(vis, "Invalid number");
 558                         return false;
 559                 }
 560
 561                 if (*unit) {
 562                         while (*unit && isspace((unsigned char)*unit))
 563                                 unit++;
 564                         switch (*unit) {
 565                         case 'd': count *= 24; /* fall through */
 566                         case 'h': count *= 60; /* fall through */
 567                         case 'm': count *= 60; /* fall through */
 568                         case 's': break;
 569                         default:
 570                                 vis_info_show(vis, "Unknown time specifier (use: s,m,h or d)");
 571                                 return false;
 572                         }
 573
 574                         if (argv[0][0] == 'e')
 575                                 count = -count; /* earlier, move back in time */
 576
 577                         pos = text_restore(txt, text_state(txt) + count);
 578                 }
 579         }
 580
 581         if (!*unit) {
 582                 VisCountIterator it = vis_count_iterator_init(vis, count);
 583                 while (vis_count_iterator_next(&it)) {
 584                         if (argv[0][0] == 'e')
 585                                 pos = text_earlier(txt);
 586                         else
 587                                 pos = text_later(txt);
 588                 }
 589         }
 590
 591         time_t state = text_state(txt);
 592         char buf[32];
 593         strftime(buf, sizeof buf, "State from %H:%M", localtime(&state));
 594         vis_info_show(vis, "%s", buf);
 595
 596         return pos != EPOS;
 597 }
 598
 599 static bool print_keylayout(const char *key, void *value, void *data) {
 600         return text_appendf(data, "  %-18s\t%s\n", key[0] == ' ' ? "␣" : key, (char*)value);
 601 }
 602
 603 static bool print_keybinding(const char *key, void *value, void *data) {
 604         KeyBinding *binding = value;
 605         const char *desc = binding->alias;
 606         if (!desc && binding->action)
 607                 desc = VIS_HELP_USE(binding->action->help);
 608         return text_appendf(data, "  %-18s\t%s\n", key[0] == ' ' ? "␣" : key, desc ? desc : "");
 609 }
 610
 611 static void print_mode(Mode *mode, Text *txt) {
 612         if (!map_empty(mode->bindings))
 613                 text_appendf(txt, "\n %s\n\n", mode->name);
 614         map_iterate(mode->bindings, print_keybinding, txt);
 615 }
 616
 617 static bool print_action(const char *key, void *value, void *data) {
 618         const char *help = VIS_HELP_USE(((KeyAction*)value)->help);
 619         return text_appendf(data, "  %-30s\t%s\n", key, help ? help : "");
 620 }
 621
 622 static bool print_cmd(const char *key, void *value, void *data) {
 623         CommandDef *cmd = value;
 624         const char *help = VIS_HELP_USE(cmd->help);
 625         char usage[256];
 626         snprintf(usage, sizeof usage, "%s%s%s%s%s%s%s",
 627                  cmd->name,
 628                  (cmd->flags & CMD_FORCE) ? "[!]" : "",
 629                  (cmd->flags & CMD_TEXT) ? "/text/" : "",
 630                  (cmd->flags & CMD_REGEX) ? "/regexp/" : "",
 631                  (cmd->flags & CMD_CMD) ? " command" : "",
 632                  (cmd->flags & CMD_SHELL) ? (!strcmp(cmd->name, "s") ? "/regexp/text/" : " shell-command") : "",
 633                  (cmd->flags & CMD_ARGV) ? " [args...]" : "");
 634         return text_appendf(data, "  %-30s %s\n", usage, help ? help : "");
 635 }
 636
 637 static bool print_option(const char *key, void *value, void *txt) {
 638         char desc[256];
 639         const OptionDef *opt = value;
 640         const char *help = VIS_HELP_USE(opt->help);
 641         if (strcmp(key, opt->names[0]))
 642                 return true;
 643         snprintf(desc, sizeof desc, "%s%s%s%s%s",
 644                  opt->names[0],
 645                  opt->names[1] ? "|" : "",
 646                  opt->names[1] ? opt->names[1] : "",
 647                  opt->flags & VIS_OPTION_TYPE_BOOL ? " on|off" : "",
 648                  opt->flags & VIS_OPTION_TYPE_NUMBER ? " nn" : "");
 649         return text_appendf(txt, "  %-30s %s\n", desc, help ? help : "");
 650 }
 651
 652 static void print_symbolic_keys(Vis *vis, Text *txt) {
 653         static const int keys[] = {
 654                 TERMKEY_SYM_BACKSPACE,
 655                 TERMKEY_SYM_TAB,
 656                 TERMKEY_SYM_ENTER,
 657                 TERMKEY_SYM_ESCAPE,
 658                 //TERMKEY_SYM_SPACE,
 659                 TERMKEY_SYM_DEL,
 660                 TERMKEY_SYM_UP,
 661                 TERMKEY_SYM_DOWN,
 662                 TERMKEY_SYM_LEFT,
 663                 TERMKEY_SYM_RIGHT,
 664                 TERMKEY_SYM_BEGIN,
 665                 TERMKEY_SYM_FIND,
 666                 TERMKEY_SYM_INSERT,
 667                 TERMKEY_SYM_DELETE,
 668                 TERMKEY_SYM_SELECT,
 669                 TERMKEY_SYM_PAGEUP,
 670                 TERMKEY_SYM_PAGEDOWN,
 671                 TERMKEY_SYM_HOME,
 672                 TERMKEY_SYM_END,
 673                 TERMKEY_SYM_CANCEL,
 674                 TERMKEY_SYM_CLEAR,
 675                 TERMKEY_SYM_CLOSE,
 676                 TERMKEY_SYM_COMMAND,
 677                 TERMKEY_SYM_COPY,
 678                 TERMKEY_SYM_EXIT,
 679                 TERMKEY_SYM_HELP,
 680                 TERMKEY_SYM_MARK,
 681                 TERMKEY_SYM_MESSAGE,
 682                 TERMKEY_SYM_MOVE,
 683                 TERMKEY_SYM_OPEN,
 684                 TERMKEY_SYM_OPTIONS,
 685                 TERMKEY_SYM_PRINT,
 686                 TERMKEY_SYM_REDO,
 687                 TERMKEY_SYM_REFERENCE,
 688                 TERMKEY_SYM_REFRESH,
 689                 TERMKEY_SYM_REPLACE,
 690                 TERMKEY_SYM_RESTART,
 691                 TERMKEY_SYM_RESUME,
 692                 TERMKEY_SYM_SAVE,
 693                 TERMKEY_SYM_SUSPEND,
 694                 TERMKEY_SYM_UNDO,
 695                 TERMKEY_SYM_KP0,
 696                 TERMKEY_SYM_KP1,
 697                 TERMKEY_SYM_KP2,
 698                 TERMKEY_SYM_KP3,
 699                 TERMKEY_SYM_KP4,
 700                 TERMKEY_SYM_KP5,
 701                 TERMKEY_SYM_KP6,
 702                 TERMKEY_SYM_KP7,
 703                 TERMKEY_SYM_KP8,
 704                 TERMKEY_SYM_KP9,
 705                 TERMKEY_SYM_KPENTER,
 706                 TERMKEY_SYM_KPPLUS,
 707                 TERMKEY_SYM_KPMINUS,
 708                 TERMKEY_SYM_KPMULT,
 709                 TERMKEY_SYM_KPDIV,
 710                 TERMKEY_SYM_KPCOMMA,
 711                 TERMKEY_SYM_KPPERIOD,
 712                 TERMKEY_SYM_KPEQUALS,
 713         };
 714
 715         TermKey *termkey = vis->ui->termkey_get(vis->ui);
 716         text_appendf(txt, "  ␣ (a literal \" \" space symbol must be used to refer to <Space>)\n");
 717         for (size_t i = 0; i < LENGTH(keys); i++) {
 718                 text_appendf(txt, "  <%s>\n", termkey_get_keyname(termkey, keys[i]));
 719         }
 720 }
 721
 722 static bool cmd_help(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 723         if (!vis_window_new(vis, NULL))
 724                 return false;
 725
 726         Text *txt = vis->win->file->text;
 727
 728         text_appendf(txt, "vis %s (PID: %ld)\n\n", VERSION, (long)getpid());
 729
 730         text_appendf(txt, " Modes\n\n");
 731         for (int i = 0; i < LENGTH(vis_modes); i++) {
 732                 Mode *mode = &vis_modes[i];
 733                 if (mode->help)
 734                         text_appendf(txt, "  %-18s\t%s\n", mode->name, mode->help);
 735         }
 736
 737         if (!map_empty(vis->keymap)) {
 738                 text_appendf(txt, "\n Layout specific mappings (affects all modes except INSERT/REPLACE)\n\n");
 739                 map_iterate(vis->keymap, print_keylayout, txt);
 740         }
 741
 742         print_mode(&vis_modes[VIS_MODE_NORMAL], txt);
 743         print_mode(&vis_modes[VIS_MODE_OPERATOR_PENDING], txt);
 744         print_mode(&vis_modes[VIS_MODE_VISUAL], txt);
 745         print_mode(&vis_modes[VIS_MODE_INSERT], txt);
 746
 747         text_appendf(txt, "\n :-Commands\n\n");
 748         map_iterate(vis->cmds, print_cmd, txt);
 749
 750         text_appendf(txt, "\n Marks\n\n");
 751         text_appendf(txt, "  a-z General purpose marks\n");
 752         for (size_t i = 0; i < LENGTH(vis_marks); i++) {
 753                 const char *help = VIS_HELP_USE(vis_marks[i].help);
 754                 text_appendf(txt, "  %c   %s\n", vis_marks[i].name, help ? help : "");
 755         }
 756
 757         text_appendf(txt, "\n Registers\n\n");
 758         text_appendf(txt, "  a-z General purpose registers\n");
 759         text_appendf(txt, "  A-Z Append to corresponding general purpose register\n");
 760         for (size_t i = 0; i < LENGTH(vis_registers); i++) {
 761                 const char *help = VIS_HELP_USE(vis_registers[i].help);
 762                 text_appendf(txt, "  %c   %s\n", vis_registers[i].name, help ? help : "");
 763         }
 764
 765         text_appendf(txt, "\n :set command options\n\n");
 766         map_iterate(vis->options, print_option, txt);
 767
 768         text_appendf(txt, "\n Key binding actions\n\n");
 769         map_iterate(vis->actions, print_action, txt);
 770
 771         text_appendf(txt, "\n Symbolic keys usable for key bindings "
 772                 "(prefix with C-, S-, and M- for Ctrl, Shift and Alt respectively)\n\n");
 773         print_symbolic_keys(vis, txt);
 774
 775         char *paths[] = { NULL, NULL };
 776         char *paths_description[] = {
 777                 "Lua paths used to load runtime files (? will be replaced by filename):",
 778                 "Lua paths used to load C libraries (? will be replaced by filename):",
 779         };
 780
 781         if (vis_lua_paths_get(vis, &paths[0], &paths[1])) {
 782                 for (size_t i = 0; i < LENGTH(paths); i++) {
 783                         text_appendf(txt, "\n %s\n\n", paths_description[i]);
 784                         for (char *elem = paths[i], *next; elem; elem = next) {
 785                                 if ((next = strstr(elem, ";")))
 786                                         *next++ = '\0';
 787                                 if (*elem)
 788                                         text_appendf(txt, "  %s\n", elem);
 789                         }
 790                         free(paths[i]);
 791                 }
 792         }
 793
 794         text_appendf(txt, "\n Compile time configuration\n\n");
 795
 796         const struct {
 797                 const char *name;
 798                 bool enabled;
 799         } configs[] = {
 800                 { "Curses support: ", CONFIG_CURSES },
 801                 { "Lua support: ", CONFIG_LUA },
 802                 { "Lua LPeg statically built-in: ", CONFIG_LPEG },
 803                 { "TRE based regex support: ", CONFIG_TRE },
 804                 { "POSIX ACL support: ", CONFIG_ACL },
 805                 { "SELinux support: ", CONFIG_SELINUX },
 806         };
 807
 808         for (size_t i = 0; i < LENGTH(configs); i++)
 809                 text_appendf(txt, "  %-32s\t%s\n", configs[i].name, configs[i].enabled ? "yes" : "no");
 810
 811         text_save(txt, NULL);
 812         view_cursor_to(vis->win->view, 0);
 813
 814         if (argv[1])
 815                 vis_motion(vis, VIS_MOVE_SEARCH_FORWARD, argv[1]);
 816         return true;
 817 }
 818
 819 static bool cmd_langmap(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 820         const char *nonlatin = argv[1];
 821         const char *latin = argv[2];
 822         bool mapped = true;
 823
 824         if (!latin || !nonlatin) {
 825                 vis_info_show(vis, "usage: langmap <non-latin keys> <latin keys>");
 826                 return false;
 827         }
 828
 829         while (*latin && *nonlatin) {
 830                 size_t i = 0, j = 0;
 831                 char latin_key[8], nonlatin_key[8];
 832                 do {
 833                         if (i < sizeof(latin_key)-1)
 834                                 latin_key[i++] = *latin;
 835                         latin++;
 836                 } while (!ISUTF8(*latin));
 837                 do {
 838                         if (j < sizeof(nonlatin_key)-1)
 839                                 nonlatin_key[j++] = *nonlatin;
 840                         nonlatin++;
 841                 } while (!ISUTF8(*nonlatin));
 842                 latin_key[i] = '\0';
 843                 nonlatin_key[j] = '\0';
 844                 mapped &= vis_keymap_add(vis, nonlatin_key, strdup(latin_key));
 845         }
 846
 847         return mapped;
 848 }
 849
 850 static bool cmd_map(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 851         bool mapped = false;
 852         bool local = strstr(argv[0], "-") != NULL;
 853         enum VisMode mode = vis_mode_from(vis, argv[1]);
 854
 855         if (local && !win) {
 856                 vis_info_show(vis, "Invalid window for :%s", argv[0]);
 857                 return false;
 858         }
 859
 860         if (mode == VIS_MODE_INVALID || !argv[2] || !argv[3]) {
 861                 vis_info_show(vis, "usage: %s mode lhs rhs", argv[0]);
 862                 return false;
 863         }
 864
 865         const char *lhs = argv[2];
 866         KeyBinding *binding = vis_binding_new(vis);
 867         if (!binding || !(binding->alias = strdup(argv[3])))
 868                 goto err;
 869
 870         if (local)
 871                 mapped = vis_window_mode_map(win, mode, cmd->flags == '!', lhs, binding);
 872         else
 873                 mapped = vis_mode_map(vis, mode, cmd->flags == '!', lhs, binding);
 874
 875 err:
 876         if (!mapped) {
 877                 vis_info_show(vis, "Failed to map `%s' in %s mode%s", lhs, argv[1],
 878                               cmd->flags != '!' ? ", mapping already exists, "
 879                               "override with `!'" : "");
 880                 vis_binding_free(vis, binding);
 881         }
 882         return mapped;
 883 }
 884
 885 static bool cmd_unmap(Vis *vis, Win *win, Command *cmd, const char *argv[], Selection *sel, Filerange *range) {
 886         bool unmapped = false;
 887         bool local = strstr(argv[0], "-") != NULL;
 888         enum VisMode mode = vis_mode_from(vis, argv[1]);
 889         const char *lhs = argv[2];
 890
 891         if (local && !win) {
 892                 vis_info_show(vis, "Invalid window for :%s", argv[0]);
 893                 return false;
 894         }
 895
 896         if (mode == VIS_MODE_INVALID || !lhs) {
 897                 vis_info_show(vis, "usage: %s mode lhs", argv[0]);
 898                 return false;
 899         }
 900
 901         if (local)
 902                 unmapped = vis_window_mode_unmap(win, mode, lhs);
 903         else
 904                 unmapped = vis_mode_unmap(vis, mode, lhs);
 905         if (!unmapped)
 906                 vis_info_show(vis, "Failed to unmap `%s' in %s mode", lhs, argv[1]);
 907         return unmapped;
 908 }