Fix readline prompt to correctly handle UTF-8 characters
[tig.git] / src / prompt.c
blob332029c288b800569898059f32ac049b905fb2a6
1 /* Copyright (c) 2006-2014 Jonas Fonseca <jonas.fonseca@gmail.com>
3 * This program is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU General Public License as
5 * published by the Free Software Foundation; either version 2 of
6 * the License, or (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include "tig/tig.h"
15 #include "tig/view.h"
16 #include "tig/draw.h"
17 #include "tig/display.h"
18 #include "tig/options.h"
19 #include "tig/prompt.h"
20 #include "tig/pager.h"
21 #include "tig/types.h"
23 #ifdef HAVE_READLINE
24 #include <readline/readline.h>
25 #include <readline/history.h>
26 #endif /* HAVE_READLINE */
28 static char *
29 prompt_input(const char *prompt, struct input *input)
31 enum input_status status = INPUT_OK;
32 unsigned char chars_length[SIZEOF_STR];
33 struct key key;
34 size_t promptlen = strlen(prompt);
35 int pos = 0, chars = 0;
37 input->buf[pos] = 0;
39 while (status == INPUT_OK || status == INPUT_SKIP) {
41 update_status("%s%.*s", prompt, pos, input->buf);
43 if (get_input(pos + promptlen, &key, FALSE) == OK) {
44 int len = strlen(key.data.bytes);
46 if (pos + len >= sizeof(input->buf)) {
47 report("Input string too long");
48 return NULL;
51 string_ncopy_do(input->buf + pos, sizeof(input->buf) - pos, key.data.bytes, len);
52 pos += len;
53 chars_length[chars++] = len;
54 status = input->handler(input, &key);
55 if (status != INPUT_OK) {
56 pos -= len;
57 chars--;
58 } else {
59 int changed_pos = strlen(input->buf);
61 if (changed_pos != pos) {
62 pos = changed_pos;
63 chars_length[chars - 1] = changed_pos - (pos - len);
66 } else {
67 status = input->handler(input, &key);
68 if (status == INPUT_DELETE) {
69 int len = chars_length[--chars];
71 pos -= len;
72 status = INPUT_OK;
73 } else {
74 int changed_pos = strlen(input->buf);
76 if (changed_pos != pos) {
77 pos = changed_pos;
78 chars_length[chars++] = changed_pos - pos;
82 input->buf[pos] = 0;
85 report_clear();
87 if (status == INPUT_CANCEL)
88 return NULL;
90 input->buf[pos++] = 0;
92 return input->buf;
95 static enum input_status
96 prompt_default_handler(struct input *input, struct key *key)
98 if (key->modifiers.multibytes)
99 return INPUT_SKIP;
101 switch (key->data.value) {
102 case KEY_RETURN:
103 case KEY_ENTER:
104 case '\n':
105 return *input->buf ? INPUT_STOP : INPUT_CANCEL;
107 case KEY_BACKSPACE:
108 return *input->buf ? INPUT_DELETE : INPUT_CANCEL;
110 case KEY_ESC:
111 return INPUT_CANCEL;
113 default:
114 return INPUT_SKIP;
118 static enum input_status
119 prompt_yesno_handler(struct input *input, struct key *key)
121 unsigned long c = key_to_unicode(key);
123 if (c == 'y' || c == 'Y')
124 return INPUT_STOP;
125 if (c == 'n' || c == 'N')
126 return INPUT_CANCEL;
127 return prompt_default_handler(input, key);
130 bool
131 prompt_yesno(const char *prompt)
133 char prompt2[SIZEOF_STR];
134 struct input input = { prompt_yesno_handler, NULL };
136 if (!string_format(prompt2, "%s [Yy/Nn]", prompt))
137 return FALSE;
139 return !!prompt_input(prompt2, &input);
142 struct incremental_input {
143 struct input input;
144 input_handler handler;
145 bool edit_mode;
148 static enum input_status
149 read_prompt_handler(struct input *input, struct key *key)
151 struct incremental_input *incremental = (struct incremental_input *) input;
153 if (incremental->edit_mode && !key->modifiers.multibytes)
154 return prompt_default_handler(input, key);
156 if (!unicode_width(key_to_unicode(key), 8))
157 return INPUT_SKIP;
159 if (!incremental->handler)
160 return INPUT_OK;
162 return incremental->handler(input, key);
165 char *
166 read_prompt_incremental(const char *prompt, bool edit_mode, input_handler handler, void *data)
168 static struct incremental_input incremental = { { read_prompt_handler } };
170 incremental.input.data = data;
171 incremental.handler = handler;
172 incremental.edit_mode = edit_mode;
174 return prompt_input(prompt, (struct input *) &incremental);
177 #ifdef HAVE_READLINE
178 static void
179 readline_display(void)
181 update_status("%s%s", rl_display_prompt, rl_line_buffer);
182 wrefresh(status_win);
185 static char *
186 readline_variable_generator(const char *text, int state)
188 static const char *vars[] = {
189 #define FORMAT_VAR(name, ifempty, initval) "%(" #name ")"
190 ARGV_ENV_INFO(FORMAT_VAR),
191 #undef FORMAT_VAR
192 NULL
195 static int index, len;
196 const char *name;
197 char *variable = NULL; /* No match */
199 /* If it is a new word to complete, initialize */
200 if (!state) {
201 index = 0;
202 len = strlen(text);
205 /* Return the next name which partially matches */
206 while ((name = vars[index])) {
207 index++;
209 /* Complete or format a variable */
210 if (strncmp(name, text, len) == 0) {
211 if (strlen(name) > len)
212 variable = strdup(name);
213 else
214 variable = argv_format_arg(&argv_env, text);
215 break;
219 return variable;
222 static char *
223 readline_action_generator(const char *text, int state)
225 static const char *actions[] = {
226 "!",
227 "source",
228 "color",
229 "bind",
230 "set",
231 "toggle",
232 "save-display",
233 #define REQ_GROUP(help)
234 #define REQ_(req, help) #req
235 REQ_INFO,
236 #undef REQ_GROUP
237 #undef REQ_
238 NULL
241 static int index, len;
242 const char *name;
243 char *match = NULL; /* No match */
245 /* If it is a new word to complete, initialize */
246 if (!state) {
247 index = 0;
248 len = strlen(text);
251 /* Return the next name which partially matches */
252 while ((name = actions[index])) {
253 name = enum_name(name);
254 index++;
256 if (strncmp(name, text, len) == 0) {
257 /* Ignore exact completion */
258 if (strlen(name) > len)
259 match = strdup(name);
260 break;
264 return match;
267 static char *
268 readline_set_generator(const char *text, int state)
270 static const char *words[] = {
271 #define DEFINE_OPTION_NAME(name, type, flags) #name " = ",
272 OPTION_INFO(DEFINE_OPTION_NAME)
273 #undef DEFINE_OPTION_NAME
274 NULL
277 static int index, len;
278 const char *name;
279 char *match = NULL; /* No match */
281 /* If it is a new word to complete, initialize */
282 if (!state) {
283 index = 0;
284 len = strlen(text);
287 /* Return the next name which partially matches */
288 while ((name = words[index])) {
289 name = enum_name(name);
290 index++;
292 if (strncmp(name, text, len) == 0) {
293 /* Ignore exact completion */
294 if (strlen(name) > len)
295 match = strdup(name);
296 break;
300 return match;
303 static char *
304 readline_toggle_generator(const char *text, int state)
306 static const char **words;
307 static int index, len;
308 const char *name;
309 char *match = NULL; /* No match */
311 if (!words) {
312 /* TODO: Only complete column options that are defined
313 * for the view. */
315 #define DEFINE_OPTION_WORD(name, type, flags) argv_append(&words, #name);
316 #define DEFINE_COLUMN_OPTIONS_WORD(name, type, flags) #name,
317 #define DEFINE_COLUMN_OPTIONS_WORDS(name, id, options) \
318 if (VIEW_COLUMN_##id != VIEW_COLUMN_SECTION) { \
319 const char *vars[] = { \
320 options(DEFINE_COLUMN_OPTIONS_WORD) \
321 }; \
322 char buf[SIZEOF_STR]; \
323 int i; \
324 for (i = 0; i < ARRAY_SIZE(vars); i++) { \
325 if (enum_name_prefixed(buf, sizeof(buf), #name, vars[i])) \
326 argv_append(&words, buf); \
330 OPTION_INFO(DEFINE_OPTION_WORD)
331 COLUMN_OPTIONS(DEFINE_COLUMN_OPTIONS_WORDS);
334 /* If it is a new word to complete, initialize */
335 if (!state) {
336 index = 0;
337 len = strlen(text);
340 /* Return the next name which partially matches */
341 while ((name = words[index])) {
342 name = enum_name(name);
343 index++;
345 if (strncmp(name, text, len) == 0) {
346 /* Ignore exact completion */
347 if (strlen(name) > len)
348 match = strdup(name);
349 break;
353 return match;
356 static int
357 readline_getc(FILE *stream)
359 return get_input_char();
362 static char **
363 readline_completion(const char *text, int start, int end)
365 /* Do not append a space after a completion */
366 rl_completion_suppress_append = 1;
369 * If the word is at the start of the line,
370 * then it is a tig action to complete.
372 if (start == 0)
373 return rl_completion_matches(text, readline_action_generator);
376 * If the line begins with "toggle", then we complete toggle options.
378 if (start >= 7 && strncmp(rl_line_buffer, "toggle ", 7) == 0)
379 return rl_completion_matches(text, readline_toggle_generator);
382 * If the line begins with "set", then we complete set options.
383 * (unless it is already completed)
385 if (start >= 4 && strncmp(rl_line_buffer, "set ", 4) == 0 &&
386 !strchr(rl_line_buffer, '='))
387 return rl_completion_matches(text, readline_set_generator);
390 * Otherwise it might be a variable name...
392 if (strncmp(text, "%(", 2) == 0)
393 return rl_completion_matches(text, readline_variable_generator);
396 * ... or finally fall back to filename completion.
398 return NULL;
401 static void
402 readline_display_matches(char **matches, int num_matches, int max_length)
404 unsigned int i;
406 wmove(status_win, 0, 0);
407 waddstr(status_win, "matches: ");
409 /* matches[0] is the incomplete word */
410 for (i = 1; i < num_matches + 1; ++i) {
411 waddstr(status_win, matches[i]);
412 waddch(status_win, ' ');
415 wgetch(status_win);
416 wrefresh(status_win);
419 static void
420 readline_init(void)
422 /* Allow conditional parsing of the ~/.inputrc file. */
423 rl_readline_name = "tig";
425 /* Word break caracters (we removed '(' to match variables) */
426 rl_basic_word_break_characters = " \t\n\"\\'`@$><=;|&{";
428 /* Custom display function */
429 rl_redisplay_function = readline_display;
430 rl_getc_function = readline_getc;
432 /* Completion support */
433 rl_attempted_completion_function = readline_completion;
435 rl_completion_display_matches_hook = readline_display_matches;
438 char *
439 read_prompt(const char *prompt)
441 static char *line = NULL;
443 if (line) {
444 free(line);
445 line = NULL;
448 line = readline(prompt);
449 if (line && !*line)
450 line = NULL;
451 if (line)
452 add_history(line);
454 return line;
457 void
458 prompt_init(void)
460 readline_init();
462 #else
463 char *
464 read_prompt(const char *prompt)
466 return read_prompt_incremental(prompt, TRUE, NULL, NULL);
469 void
470 prompt_init(void)
473 #endif /* HAVE_READLINE */
475 bool
476 prompt_menu(const char *prompt, const struct menu_item *items, int *selected)
478 enum input_status status = INPUT_OK;
479 struct key key;
480 int size = 0;
482 while (items[size].text)
483 size++;
485 assert(size > 0);
487 while (status == INPUT_OK) {
488 const struct menu_item *item = &items[*selected];
489 char hotkey[] = { '[', (char) item->hotkey, ']', ' ', 0 };
490 int i;
492 update_status("%s (%d of %d) %s%s", prompt, *selected + 1, size,
493 item->hotkey ? hotkey : "", item->text);
495 switch (get_input(COLS - 1, &key, FALSE)) {
496 case KEY_RETURN:
497 case KEY_ENTER:
498 case '\n':
499 status = INPUT_STOP;
500 break;
502 case KEY_LEFT:
503 case KEY_UP:
504 *selected = *selected - 1;
505 if (*selected < 0)
506 *selected = size - 1;
507 break;
509 case KEY_RIGHT:
510 case KEY_DOWN:
511 *selected = (*selected + 1) % size;
512 break;
514 case KEY_ESC:
515 status = INPUT_CANCEL;
516 break;
518 default:
519 for (i = 0; items[i].text; i++)
520 if (items[i].hotkey == key.data.bytes[0]) {
521 *selected = i;
522 status = INPUT_STOP;
523 break;
528 report_clear();
530 return status != INPUT_CANCEL;
533 struct prompt_toggle {
534 const char *name;
535 const char *type;
536 enum view_flag flags;
537 void *opt;
540 static bool
541 find_arg(const char *argv[], const char *arg)
543 int i;
545 for (i = 0; argv[i]; i++)
546 if (!strcmp(argv[i], arg))
547 return TRUE;
548 return FALSE;
551 static enum status_code
552 prompt_toggle_option(struct view *view, const char *argv[], const char *prefix,
553 struct prompt_toggle *toggle, enum view_flag *flags)
555 char name[SIZEOF_STR];
557 if (!enum_name_prefixed(name, sizeof(name), prefix, toggle->name))
558 return error("Failed to toggle option %s", toggle->name);
560 *flags = toggle->flags;
562 if (!strcmp(toggle->type, "bool")) {
563 bool *opt = toggle->opt;
565 *opt = !*opt;
566 if (opt == &opt_mouse)
567 enable_mouse(*opt);
568 return success("set %s = %s", name, *opt ? "yes" : "no");
570 } else if (!strncmp(toggle->type, "enum", 4)) {
571 const char *type = toggle->type + STRING_SIZE("enum ");
572 enum author *opt = toggle->opt;
573 const struct enum_map *map = find_enum_map(type);
575 *opt = (*opt + 1) % map->size;
576 return success("set %s = %s", name, enum_name(map->entries[*opt].name));
578 } else if (!strcmp(toggle->type, "int")) {
579 const char *arg = argv[2] ? argv[2] : "1";
580 int diff = atoi(arg);
581 int *opt = toggle->opt;
583 if (!diff)
584 diff = *arg == '-' ? -1 : 1;
586 if (opt == &opt_diff_context && *opt < 0)
587 *opt = -*opt;
588 if (opt == &opt_diff_context && diff < 0) {
589 if (!*opt)
590 return error("Diff context cannot be less than zero");
591 if (*opt < -diff)
592 diff = -*opt;
595 if (strstr(name, "commit-title-overflow")) {
596 *opt = *opt ? -*opt : 50;
597 if (*opt < 0)
598 return success("set %s = no", name);
599 diff = 0;
602 *opt += diff;
603 return success("set %s = %d", name, *opt);
605 } else if (!strcmp(toggle->type, "double")) {
606 const char *arg = argv[2] ? argv[2] : "1.0";
607 double *opt = toggle->opt;
608 int sign = 1;
609 double diff;
611 if (*arg == '-') {
612 sign = -1;
613 arg++;
616 if (parse_step(&diff, arg) != SUCCESS)
617 diff = strtod(arg, NULL);
619 *opt += sign * diff;
620 return success("set %s = %.2f", name, *opt);
622 } else if (!strcmp(toggle->type, "const char **")) {
623 const char ***opt = toggle->opt;
624 bool found = TRUE;
625 int i;
627 for (i = 2; argv[i]; i++) {
628 if (!find_arg(*opt, argv[i])) {
629 found = FALSE;
630 break;
634 if (found) {
635 int next, pos;
637 for (next = 0, pos = 0; (*opt)[pos]; pos++) {
638 const char *arg = (*opt)[pos];
640 if (find_arg(argv + 2, arg)) {
641 free((void *) arg);
642 continue;
644 (*opt)[next++] = arg;
647 (*opt)[next] = NULL;
649 } else if (!argv_copy(opt, argv + 2)) {
650 return ERROR_OUT_OF_MEMORY;
652 return SUCCESS;
654 } else {
655 return error("Unsupported `:toggle %s` (%s)", name, toggle->type);
659 static struct prompt_toggle *
660 find_prompt_toggle(struct prompt_toggle toggles[], size_t toggles_size,
661 const char *prefix, const char *name, size_t namelen)
663 char prefixed[SIZEOF_STR];
664 int i;
666 if (*prefix && namelen == strlen(prefix) &&
667 !string_enum_compare(prefix, name, namelen)) {
668 name = "display";
669 namelen = strlen(name);
672 for (i = 0; i < toggles_size; i++) {
673 struct prompt_toggle *toggle = &toggles[i];
675 if (namelen == strlen(toggle->name) &&
676 !string_enum_compare(toggle->name, name, namelen))
677 return toggle;
679 if (enum_name_prefixed(prefixed, sizeof(prefixed), prefix, toggle->name) &&
680 namelen == strlen(prefixed) &&
681 !string_enum_compare(prefixed, name, namelen))
682 return toggle;
685 return NULL;
688 static enum status_code
689 prompt_toggle(struct view *view, const char *argv[], enum view_flag *flags)
691 struct prompt_toggle option_toggles[] = {
692 #define DEFINE_OPTION_TOGGLES(name, type, flags) { #name, #type, flags, &opt_ ## name },
693 OPTION_INFO(DEFINE_OPTION_TOGGLES)
695 const char *option = argv[1];
696 size_t optionlen = option ? strlen(option) : 0;
697 struct prompt_toggle *toggle;
698 struct view_column *column;
700 if (!option)
701 return error("%s", "No option name given to :toggle");
703 if (enum_equals_static("sort-field", option, optionlen) ||
704 enum_equals_static("sort-order", option, optionlen)) {
705 if (!view_has_flags(view, VIEW_SORTABLE)) {
706 return error("Sorting is not yet supported for the %s view", view->name);
707 } else {
708 bool sort_field = enum_equals_static("sort-field", option, optionlen);
709 struct sort_state *sort = &view->sort;
711 sort_view(view, sort_field);
712 return success("set %s = %s", option,
713 sort_field ? view_column_name(get_sort_field(view))
714 : sort->reverse ? "descending" : "ascending");
718 toggle = find_prompt_toggle(option_toggles, ARRAY_SIZE(option_toggles),
719 "", option, optionlen);
720 if (toggle)
721 return prompt_toggle_option(view, argv, "", toggle, flags);
723 #define DEFINE_COLUMN_OPTIONS_TOGGLE(name, type, flags) \
724 { #name, #type, flags, &opt->name },
726 #define DEFINE_COLUMN_OPTIONS_CHECK(name, id, options) \
727 if (column->type == VIEW_COLUMN_##id) { \
728 struct name##_options *opt = &column->opt.name; \
729 struct prompt_toggle toggles[] = { \
730 options(DEFINE_COLUMN_OPTIONS_TOGGLE) \
731 }; \
732 toggle = find_prompt_toggle(toggles, ARRAY_SIZE(toggles), #name, option, optionlen); \
733 if (toggle) \
734 return prompt_toggle_option(view, argv, #name, toggle, flags); \
737 for (column = view->columns; column; column = column->next) {
738 COLUMN_OPTIONS(DEFINE_COLUMN_OPTIONS_CHECK);
741 return error("`:toggle %s` not supported", option);
744 enum request
745 run_prompt_command(struct view *view, const char *argv[])
747 enum request request;
748 const char *cmd = argv[0];
749 size_t cmdlen = cmd ? strlen(cmd) : 0;
751 if (!cmd)
752 return REQ_NONE;
754 if (string_isnumber(cmd)) {
755 int lineno = view->pos.lineno + 1;
757 if (parse_int(&lineno, cmd, 0, view->lines + 1) == SUCCESS) {
758 if (!lineno)
759 lineno = 1;
760 select_view_line(view, lineno - 1);
761 report_clear();
762 } else {
763 report("Unable to parse '%s' as a line number", cmd);
765 } else if (iscommit(cmd)) {
766 int lineno;
768 if (!(view->ops->column_bits & view_column_bit(ID))) {
769 report("Jumping to commits is not supported by the %s view", view->name);
770 return REQ_NONE;
773 for (lineno = 0; lineno < view->lines; lineno++) {
774 struct view_column_data column_data = {};
775 struct line *line = &view->line[lineno];
777 if (view->ops->get_column_data(view, line, &column_data) &&
778 column_data.id &&
779 !strncasecmp(column_data.id, cmd, cmdlen)) {
780 string_ncopy(view->env->search, cmd, cmdlen);
781 select_view_line(view, lineno);
782 report_clear();
783 return REQ_NONE;
787 report("Unable to find commit '%s'", view->env->search);
788 return REQ_NONE;
790 } else if (cmdlen > 1 && (cmd[0] == '/' || cmd[0] == '?')) {
791 char search[SIZEOF_STR];
793 if (!argv_to_string(argv, search, sizeof(search), " ")) {
794 report("Failed to copy search string");
795 return REQ_NONE;
798 if (!strcmp(search + 1, view->env->search))
799 return cmd[0] == '/' ? REQ_FIND_NEXT : REQ_FIND_PREV;
801 string_ncopy(view->env->search, search + 1, strlen(search + 1));
802 return cmd[0] == '/' ? REQ_SEARCH : REQ_SEARCH_BACK;
804 } else if (cmdlen > 1 && cmd[0] == '!') {
805 struct view *next = &pager_view;
806 bool copied;
808 /* Trim the leading '!'. */
809 argv[0] = cmd + 1;
810 copied = argv_format(view->env, &next->argv, argv, FALSE, TRUE);
811 argv[0] = cmd;
813 if (!copied) {
814 report("Argument formatting failed");
815 } else {
816 /* When running random commands, initially show the
817 * command in the title. However, it maybe later be
818 * overwritten if a commit line is selected. */
819 argv_to_string(next->argv, next->ref, sizeof(next->ref), " ");
821 next->dir = NULL;
822 open_pager_view(view, OPEN_PREPARED | OPEN_WITH_STDERR);
825 } else if (!strcmp(cmd, "save-display")) {
826 const char *path = argv[1] ? argv[1] : "tig-display.txt";
828 if (!save_display(path))
829 report("Failed to save screen to %s", path);
830 else
831 report("Saved screen to %s", path);
833 } else if (!strcmp(cmd, "toggle")) {
834 enum view_flag flags = VIEW_NO_FLAGS;
835 enum status_code code = prompt_toggle(view, argv, &flags);
836 const char *action = get_status_message(code);
837 int i;
839 if (code != SUCCESS) {
840 report("%s", action);
841 return REQ_NONE;
844 if (flags & VIEW_RESET_DISPLAY) {
845 resize_display();
846 redraw_display(TRUE);
849 foreach_displayed_view(view, i) {
850 if (view_has_flags(view, flags) && view_can_refresh(view))
851 reload_view(view);
852 else
853 redraw_view(view);
856 if (*action)
857 report("%s", action);
859 } else if (!strcmp(cmd, "script")) {
860 if (is_script_executing()) {
861 report("Scripts cannot be run from scripts");
862 } else if (!open_script(argv[1])) {
863 report("Failed to open %s", argv[1]);
866 } else {
867 struct key key = {};
869 /* Try :<key> */
870 key.modifiers.multibytes = 1;
871 string_ncopy(key.data.bytes, cmd, cmdlen);
872 request = get_keybinding(view->keymap, &key, 1);
873 if (request != REQ_NONE)
874 return request;
876 /* Try :<command> */
877 request = get_request(cmd);
878 if (request != REQ_UNKNOWN)
879 return request;
881 if (set_option(argv[0], argv_size(argv + 1), &argv[1]) == SUCCESS) {
882 request = view_can_refresh(view) ? REQ_REFRESH : REQ_SCREEN_REDRAW;
883 if (!strcmp(cmd, "color"))
884 init_colors();
885 resize_display();
886 redraw_display(TRUE);
888 return request;
890 return REQ_NONE;
893 enum request
894 open_prompt(struct view *view)
896 char *cmd = read_prompt(":");
897 const char *argv[SIZEOF_ARG] = { NULL };
898 int argc = 0;
900 if (cmd && !argv_from_string(argv, &argc, cmd)) {
901 report("Too many arguments");
902 return REQ_NONE;
905 return run_prompt_command(view, argv);
908 /* vim: set ts=8 sw=8 noexpandtab: */