1 /* vi: set sw=4 ts=4: */
3 * Command line editing.
5 * Copyright (c) 1986-2003 may safely be consumed by a BSD or GPL license.
6 * Written by: Vladimir Oleynik <dzo@simtreas.ru>
9 * Adam Rogoyski <rogoyski@cs.utexas.edu>
10 * Dave Cinege <dcinege@psychosis.com>
11 * Jakub Jelinek (c) 1995
12 * Erik Andersen <andersen@codepoet.org> (Majorly adjusted for busybox)
14 * This code is 'as is' with no warranty.
18 * Usage and known bugs:
19 * Terminal key codes are not extensive, more needs to be added.
20 * This version was created on Debian GNU/Linux 2.x.
21 * Delete, Backspace, Home, End, and the arrow keys were tested
22 * to work in an Xterm and console. Ctrl-A also works as Home.
23 * Ctrl-E also works as End.
25 * The following readline-like commands are not implemented:
26 * ESC-b -- Move back one word
27 * ESC-f -- Move forward one word
28 * ESC-d -- Delete forward one word
29 * CTL-t -- Transpose two characters
31 * lineedit does not know that the terminal escape sequences do not
32 * take up space on the screen. The redisplay code assumes, unless
33 * told otherwise, that each character in the prompt is a printable
34 * character that takes up one character position on the screen.
35 * You need to tell lineedit that some sequences of characters
36 * in the prompt take up no screen space. Compatibly with readline,
37 * use the \[ escape to begin a sequence of non-printing characters,
38 * and the \] escape to signal the end of such a sequence. Example:
40 * PS1='\[\033[01;32m\]\u@\h\[\033[01;34m\] \w \$\[\033[00m\] '
44 #ifndef _POSIX_VDISABLE
45 # define _POSIX_VDISABLE '\0'
50 # define ENABLE_FEATURE_EDITING 0
51 # define ENABLE_FEATURE_TAB_COMPLETION 0
52 # define ENABLE_FEATURE_USERNAME_COMPLETION 0
56 /* Entire file (except TESTing part) sits inside this #if */
57 #if ENABLE_FEATURE_EDITING
60 #define ENABLE_USERNAME_OR_HOMEDIR \
61 (ENABLE_FEATURE_USERNAME_COMPLETION || ENABLE_FEATURE_EDITING_FANCY_PROMPT)
62 #define IF_USERNAME_OR_HOMEDIR(...)
63 #if ENABLE_USERNAME_OR_HOMEDIR
64 # undef IF_USERNAME_OR_HOMEDIR
65 # define IF_USERNAME_OR_HOMEDIR(...) __VA_ARGS__
70 #if ENABLE_UNICODE_SUPPORT
71 # define BB_NUL ((wchar_t)0)
72 # define CHAR_T wchar_t
73 static bool BB_isspace(CHAR_T c) { return ((unsigned)c < 256 && isspace(c)); }
74 # if ENABLE_FEATURE_EDITING_VI
75 static bool BB_isalnum(CHAR_T c) { return ((unsigned)c < 256 && isalnum(c)); }
77 static bool BB_ispunct(CHAR_T c) { return ((unsigned)c < 256 && ispunct(c)); }
82 # define isspace isspace_must_not_be_used
83 # define isalnum isalnum_must_not_be_used
84 # define ispunct ispunct_must_not_be_used
85 # define isprint isprint_must_not_be_used
89 # define BB_isspace(c) isspace(c)
90 # define BB_isalnum(c) isalnum(c)
91 # define BB_ispunct(c) ispunct(c)
93 #if ENABLE_UNICODE_PRESERVE_BROKEN
94 # define unicode_mark_raw_byte(wc) ((wc) | 0x20000000)
95 # define unicode_is_raw_byte(wc) ((wc) & 0x20000000)
97 # define unicode_is_raw_byte(wc) 0
103 #define SEQ_CLEAR_TILL_END_OF_SCREEN ESC"[J"
104 //#define SEQ_CLEAR_TILL_END_OF_LINE ESC"[K"
108 MAX_LINELEN = CONFIG_FEATURE_EDITING_MAX_LEN < 0x7ff0
109 ? CONFIG_FEATURE_EDITING_MAX_LEN
113 #if ENABLE_USERNAME_OR_HOMEDIR
114 static const char null_str[] ALIGN1 = "";
117 /* We try to minimize both static and stack usage. */
118 struct lineedit_statics {
121 volatile unsigned cmdedit_termw; /* = 80; */ /* actual terminal width */
122 sighandler_t previous_SIGWINCH_handler;
124 unsigned cmdedit_x; /* real x (col) terminal position */
125 unsigned cmdedit_y; /* pseudoreal y (row) terminal position */
126 unsigned cmdedit_prmt_len; /* length of prompt (without colors etc) */
129 int command_len; /* must be signed */
130 /* signed maxsize: we want x in "if (x > S.maxsize)"
131 * to _not_ be promoted to unsigned */
135 const char *cmdedit_prompt;
136 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
137 int num_ok_lines; /* = 1; */
140 #if ENABLE_USERNAME_OR_HOMEDIR
142 char *home_pwd_buf; /* = (char*)null_str; */
145 #if ENABLE_FEATURE_TAB_COMPLETION
147 unsigned num_matches;
150 #if ENABLE_FEATURE_EDITING_VI
151 # define DELBUFSIZ 128
153 smallint newdelflag; /* whether delbuf should be reused yet */
154 CHAR_T delbuf[DELBUFSIZ]; /* a place to store deleted characters */
156 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
157 smallint sent_ESC_br6n;
161 /* See lineedit_ptr_hack.c */
162 extern struct lineedit_statics *const lineedit_ptr_to_statics;
164 #define S (*lineedit_ptr_to_statics)
165 #define state (S.state )
166 #define cmdedit_termw (S.cmdedit_termw )
167 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
168 #define cmdedit_x (S.cmdedit_x )
169 #define cmdedit_y (S.cmdedit_y )
170 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
171 #define cursor (S.cursor )
172 #define command_len (S.command_len )
173 #define command_ps (S.command_ps )
174 #define cmdedit_prompt (S.cmdedit_prompt )
175 #define num_ok_lines (S.num_ok_lines )
176 #define user_buf (S.user_buf )
177 #define home_pwd_buf (S.home_pwd_buf )
178 #define matches (S.matches )
179 #define num_matches (S.num_matches )
180 #define delptr (S.delptr )
181 #define newdelflag (S.newdelflag )
182 #define delbuf (S.delbuf )
184 #define INIT_S() do { \
185 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
187 cmdedit_termw = 80; \
188 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
189 IF_USERNAME_OR_HOMEDIR(home_pwd_buf = (char*)null_str;) \
192 static void deinit_S(void)
194 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
195 /* This one is allocated only if FANCY_PROMPT is on
196 * (otherwise it points to verbatim prompt (NOT malloced)) */
197 free((char*)cmdedit_prompt);
199 #if ENABLE_USERNAME_OR_HOMEDIR
201 if (home_pwd_buf != null_str)
204 free(lineedit_ptr_to_statics);
206 #define DEINIT_S() deinit_S()
209 #if ENABLE_UNICODE_SUPPORT
210 static size_t load_string(const char *src)
212 if (unicode_status == UNICODE_ON) {
213 ssize_t len = mbstowcs(command_ps, src, S.maxsize - 1);
216 command_ps[len] = BB_NUL;
220 while (src[i] && i < S.maxsize - 1) {
221 command_ps[i] = src[i];
224 command_ps[i] = BB_NUL;
228 static unsigned save_string(char *dst, unsigned maxsize)
230 if (unicode_status == UNICODE_ON) {
231 # if !ENABLE_UNICODE_PRESERVE_BROKEN
232 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
242 while (dstpos < maxsize) {
246 /* Convert up to 1st invalid byte (or up to end) */
247 while ((wc = command_ps[srcpos]) != BB_NUL
248 && !unicode_is_raw_byte(wc)
252 command_ps[srcpos] = BB_NUL;
253 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
254 if (n < 0) /* should not happen */
257 if (wc == BB_NUL) /* usually is */
260 /* We do have invalid byte here! */
261 command_ps[srcpos] = wc; /* restore it */
263 if (dstpos == maxsize)
265 dst[dstpos++] = (char) wc;
272 while ((dst[i] = command_ps[i]) != 0)
277 /* I thought just fputwc(c, stdout) would work. But no... */
278 static void BB_PUTCHAR(wchar_t c)
280 if (unicode_status == UNICODE_ON) {
281 char buf[MB_CUR_MAX + 1];
282 mbstate_t mbst = { 0 };
283 ssize_t len = wcrtomb(buf, c, &mbst);
289 /* In this case, c is always one byte */
293 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
294 static wchar_t adjust_width_and_validate_wc(unsigned *width_adj, wchar_t wc)
296 static wchar_t adjust_width_and_validate_wc(wchar_t wc)
297 # define adjust_width_and_validate_wc(width_adj, wc) \
298 ((*(width_adj))++, adjust_width_and_validate_wc(wc))
303 if (unicode_status == UNICODE_ON) {
304 if (wc > CONFIG_LAST_SUPPORTED_WCHAR) {
305 /* note: also true for unicode_is_raw_byte(wc) */
309 if ((ENABLE_UNICODE_COMBINING_WCHARS && w < 0)
310 || (!ENABLE_UNICODE_COMBINING_WCHARS && w <= 0)
311 || (!ENABLE_UNICODE_WIDE_WCHARS && w > 1)
315 wc = CONFIG_SUBST_WCHAR;
319 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
325 static size_t load_string(const char *src)
327 safe_strncpy(command_ps, src, S.maxsize);
328 return strlen(command_ps);
330 # if ENABLE_FEATURE_TAB_COMPLETION
331 static void save_string(char *dst, unsigned maxsize)
333 safe_strncpy(dst, command_ps, maxsize);
336 # define BB_PUTCHAR(c) bb_putchar(c)
337 /* Should never be called: */
338 int adjust_width_and_validate_wc(unsigned *width_adj, int wc);
342 /* Put 'command_ps[cursor]', cursor++.
343 * Advance cursor on screen. If we reached right margin, scroll text up
344 * and remove terminal margin effect by printing 'next_char' */
345 #define HACK_FOR_WRONG_WIDTH 1
346 static void put_cur_glyph_and_inc_cursor(void)
348 CHAR_T c = command_ps[cursor];
353 /* erase character after end of input string */
356 /* advance cursor only if we aren't at the end yet */
358 if (unicode_status == UNICODE_ON) {
359 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x;)
360 c = adjust_width_and_validate_wc(&cmdedit_x, c);
361 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x - width;)
367 ofs_to_right = cmdedit_x - cmdedit_termw;
368 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right <= 0) {
369 /* c fits on this line */
373 if (ofs_to_right >= 0) {
374 /* we go to the next line */
375 #if HACK_FOR_WRONG_WIDTH
376 /* This works better if our idea of term width is wrong
377 * and it is actually wider (often happens on serial lines).
378 * Printing CR,LF *forces* cursor to next line.
379 * OTOH if terminal width is correct AND terminal does NOT
380 * have automargin (IOW: it is moving cursor to next line
381 * by itself (which is wrong for VT-10x terminals)),
382 * this will break things: there will be one extra empty line */
383 puts("\r"); /* + implicit '\n' */
385 /* VT-10x terminals don't wrap cursor to next line when last char
386 * on the line is printed - cursor stays "over" this char.
387 * Need to print _next_ char too (first one to appear on next line)
388 * to make cursor move down to next line.
390 /* Works ok only if cmdedit_termw is correct. */
391 c = command_ps[cursor];
398 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right == 0) {
400 } else { /* ofs_to_right > 0 */
401 /* wide char c didn't fit on prev line */
408 /* Move to end of line (by printing all chars till the end) */
409 static void put_till_end_and_adv_cursor(void)
411 while (cursor < command_len)
412 put_cur_glyph_and_inc_cursor();
415 /* Go to the next line */
416 static void goto_new_line(void)
418 put_till_end_and_adv_cursor();
423 static void beep(void)
428 static void put_prompt(void)
432 fputs(cmdedit_prompt, stdout);
435 w = cmdedit_termw; /* read volatile var once */
436 cmdedit_y = cmdedit_prmt_len / w; /* new quasireal y */
437 cmdedit_x = cmdedit_prmt_len % w;
440 /* Move back one character */
441 /* (optimized for slow terminals) */
442 static void input_backward(unsigned num)
450 if ((ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS)
451 && unicode_status == UNICODE_ON
453 /* correct NUM to be equal to _screen_ width */
457 adjust_width_and_validate_wc(&num, command_ps[cursor + n]);
462 if (cmdedit_x >= num) {
465 /* This is longer by 5 bytes on x86.
466 * Also gets miscompiled for ARM users
467 * (busybox.net/bugs/view.php?id=2274).
468 * printf(("\b\b\b\b" + 4) - num);
476 printf(ESC"[%uD", num);
480 /* Need to go one or more lines up */
481 if (ENABLE_UNICODE_WIDE_WCHARS) {
482 /* With wide chars, it is hard to "backtrack"
483 * and reliably figure out where to put cursor.
484 * Example (<> is a wide char; # is an ordinary char, _ cursor):
488 * and user presses left arrow. num = 1, cmdedit_x = 0,
489 * We need to go up one line, and then - how do we know that
490 * we need to go *10* positions to the right? Because
494 * in this situation we need to go *11* positions to the right.
496 * A simpler thing to do is to redraw everything from the start
497 * up to new cursor position (which is already known):
500 /* go to 1st column; go up to first line */
501 printf("\r" ESC"[%uA", cmdedit_y);
504 put_prompt(); /* sets cursor to 0 */
505 while (cursor < sv_cursor)
506 put_cur_glyph_and_inc_cursor();
510 /* num = chars to go back from the beginning of current line: */
512 width = cmdedit_termw; /* read volatile var once */
513 /* num=1...w: one line up, w+1...2w: two, etc: */
514 lines_up = 1 + (num - 1) / width;
515 cmdedit_x = (width * cmdedit_y - num) % width;
516 cmdedit_y -= lines_up;
517 /* go to 1st column; go up */
518 printf("\r" ESC"[%uA", lines_up);
519 /* go to correct column.
520 * xterm, konsole, Linux VT interpret 0 as 1 below! wow.
521 * need to *make sure* we skip it if cmdedit_x == 0 */
523 printf(ESC"[%uC", cmdedit_x);
527 /* draw prompt, editor line, and clear tail */
528 static void redraw(int y, int back_cursor)
530 if (y > 0) /* up y lines */
531 printf(ESC"[%uA", y);
534 put_till_end_and_adv_cursor();
535 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
536 input_backward(back_cursor);
539 /* Delete the char in front of the cursor, optionally saving it
540 * for later putback */
541 #if !ENABLE_FEATURE_EDITING_VI
542 static void input_delete(void)
543 #define input_delete(save) input_delete()
545 static void input_delete(int save)
550 if (j == (int)command_len)
553 #if ENABLE_FEATURE_EDITING_VI
559 if ((delptr - delbuf) < DELBUFSIZ)
560 *delptr++ = command_ps[j];
564 memmove(command_ps + j, command_ps + j + 1,
565 /* (command_len + 1 [because of NUL]) - (j + 1)
566 * simplified into (command_len - j) */
567 (command_len - j) * sizeof(command_ps[0]));
569 put_till_end_and_adv_cursor();
570 /* Last char is still visible, erase it (and more) */
571 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
572 input_backward(cursor - j); /* back to old pos cursor */
575 #if ENABLE_FEATURE_EDITING_VI
576 static void put(void)
579 int j = delptr - delbuf;
584 /* open hole and then fill it */
585 memmove(command_ps + cursor + j, command_ps + cursor,
586 (command_len - cursor + 1) * sizeof(command_ps[0]));
587 memcpy(command_ps + cursor, delbuf, j * sizeof(command_ps[0]));
589 put_till_end_and_adv_cursor();
590 input_backward(cursor - ocursor - j + 1); /* at end of new text */
594 /* Delete the char in back of the cursor */
595 static void input_backspace(void)
603 /* Move forward one character */
604 static void input_forward(void)
606 if (cursor < command_len)
607 put_cur_glyph_and_inc_cursor();
610 #if ENABLE_FEATURE_TAB_COMPLETION
613 //needs to be more clever: currently it thinks that "foo\ b<TAB>
614 //matches the file named "foo bar", which is untrue.
615 //Also, perhaps "foo b<TAB> needs to complete to "foo bar" <cursor>,
616 //not "foo bar <cursor>...
618 static void free_tab_completion_data(void)
622 free(matches[--num_matches]);
628 static void add_match(char *matched)
630 matches = xrealloc_vector(matches, 4, num_matches);
631 matches[num_matches] = matched;
635 # if ENABLE_FEATURE_USERNAME_COMPLETION
636 /* Replace "~user/..." with "/homedir/...".
637 * The parameter is malloced, free it or return it
638 * unchanged if no user is matched.
640 static char *username_path_completion(char *ud)
642 struct passwd *entry;
643 char *tilde_name = ud;
647 if (*ud == '/') { /* "~/..." */
651 ud = strchr(ud, '/');
652 *ud = '\0'; /* "~user" */
653 entry = getpwnam(tilde_name + 1);
654 *ud = '/'; /* restore "~user/..." */
656 home = entry->pw_dir;
659 ud = concat_path_file(home, ud);
666 /* ~use<tab> - find all users with this prefix.
667 * Return the length of the prefix used for matching.
669 static NOINLINE unsigned complete_username(const char *ud)
671 /* Using _r function to avoid pulling in static buffers */
674 struct passwd *result;
678 userlen = strlen(ud);
681 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
682 /* Null usernames should result in all users as possible completions. */
683 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
684 add_match(xasprintf("~%s/", pwd.pw_name));
691 # endif /* FEATURE_USERNAME_COMPLETION */
699 static int path_parse(char ***p)
706 if (state->flags & WITH_PATH_LOOKUP)
707 pth = state->path_lookup;
709 pth = getenv("PATH");
711 /* PATH="" or PATH=":"? */
712 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
716 npth = 1; /* path component count */
718 tmp = strchr(tmp, ':');
723 break; /* :<empty> */
727 *p = res = xmalloc(npth * sizeof(res[0]));
728 res[0] = tmp = xstrdup(pth);
731 tmp = strchr(tmp, ':');
734 *tmp++ = '\0'; /* ':' -> '\0' */
736 break; /* :<empty> */
742 /* Complete command, directory or file name.
743 * Return the length of the prefix used for matching.
745 static NOINLINE unsigned complete_cmd_dir_file(const char *command, int type)
748 char **paths = path1;
756 path1[0] = (char*)".";
758 pfind = strrchr(command, '/');
760 if (type == FIND_EXE_ONLY)
761 npaths = path_parse(&paths);
764 /* point to 'l' in "..../last_component" */
766 /* dirbuf = ".../.../.../" */
767 dirbuf = xstrndup(command, pfind - command);
768 # if ENABLE_FEATURE_USERNAME_COMPLETION
769 if (dirbuf[0] == '~') /* ~/... or ~user/... */
770 dirbuf = username_path_completion(dirbuf);
774 pf_len = strlen(pfind);
776 for (i = 0; i < npaths; i++) {
782 dir = opendir(paths[i]);
784 continue; /* don't print an error */
786 while ((next = readdir(dir)) != NULL) {
788 const char *name_found = next->d_name;
790 /* .../<tab>: bash 3.2.0 shows dotfiles, but not . and .. */
791 if (!pfind[0] && DOT_OR_DOTDOT(name_found))
794 if (strncmp(name_found, pfind, pf_len) != 0)
797 found = concat_path_file(paths[i], name_found);
798 /* NB: stat() first so that we see is it a directory;
799 * but if that fails, use lstat() so that
800 * we still match dangling links */
801 if (stat(found, &st) && lstat(found, &st))
802 goto cont; /* hmm, remove in progress? */
805 len = strlen(name_found);
806 found = xrealloc(found, len + 2); /* +2: for slash and NUL */
807 strcpy(found, name_found);
809 if (S_ISDIR(st.st_mode)) {
810 /* name is a directory, add slash */
812 found[len + 1] = '\0';
814 /* skip files if looking for dirs only (example: cd) */
815 if (type == FIND_DIR_ONLY)
818 /* add it to the list */
825 } /* for every path */
827 if (paths != path1) {
828 free(paths[0]); /* allocated memory is only in first member */
836 /* build_match_prefix:
837 * On entry, match_buf contains everything up to cursor at the moment <tab>
838 * was pressed. This function looks at it, figures out what part of it
839 * constitutes the command/file/directory prefix to use for completion,
840 * and rewrites match_buf to contain only that part.
844 /* QUOT is used on elements of int_buf[], which are bytes,
845 * not Unicode chars. Therefore it works correctly even in Unicode mode.
847 #define QUOT (UCHAR_MAX+1)
848 static void remove_chunk(int16_t *int_buf, int beg, int end)
850 /* beg must be <= end */
854 while ((int_buf[beg] = int_buf[end]) != 0)
859 for (i = 0; int_buf[i]; i++)
860 bb_putchar((unsigned char)int_buf[i]);
864 /* Caller ensures that match_buf points to a malloced buffer
865 * big enough to hold strlen(match_buf)*2 + 2
867 static NOINLINE int build_match_prefix(char *match_buf)
871 int16_t *int_buf = (int16_t*)match_buf;
873 if (dbg_bmp) printf("\n%s\n", match_buf);
875 /* Copy in reverse order, since they overlap */
876 i = strlen(match_buf);
878 int_buf[i] = (unsigned char)match_buf[i];
882 /* Mark every \c as "quoted c" */
883 for (i = 0; int_buf[i]; i++) {
884 if (int_buf[i] == '\\') {
885 remove_chunk(int_buf, i, i + 1);
889 /* Quote-mark "chars" and 'chars', drop delimiters */
894 int cur = int_buf[i];
897 if (cur == '\'' || cur == '"') {
898 if (!in_quote || (cur == in_quote)) {
900 remove_chunk(int_buf, i, i + 1);
905 int_buf[i] = cur | QUOT;
910 /* Remove everything up to command delimiters:
911 * ';' ';;' '&' '|' '&&' '||',
912 * but careful with '>&' '<&' '>|'
914 for (i = 0; int_buf[i]; i++) {
915 int cur = int_buf[i];
916 if (cur == ';' || cur == '&' || cur == '|') {
917 int prev = i ? int_buf[i - 1] : 0;
918 if (cur == '&' && (prev == '>' || prev == '<')) {
920 } else if (cur == '|' && prev == '>') {
923 remove_chunk(int_buf, 0, i + 1 + (cur == int_buf[i + 1]));
924 i = -1; /* back to square 1 */
927 /* Remove all `cmd` */
928 for (i = 0; int_buf[i]; i++) {
929 if (int_buf[i] == '`') {
930 for (j = i + 1; int_buf[j]; j++) {
931 if (int_buf[j] == '`') {
932 /* `cmd` should count as a word:
933 * `cmd` c<tab> should search for files c*,
934 * not commands c*. Therefore we don't drop
935 * `cmd` entirely, we replace it with single `.
937 remove_chunk(int_buf, i, j);
941 /* No closing ` - command mode, remove all up to ` */
942 remove_chunk(int_buf, 0, i + 1);
948 /* Remove "cmd (" and "cmd {"
949 * Example: "if { c<tab>"
950 * In this example, c should be matched as command pfx.
952 for (i = 0; int_buf[i]; i++) {
953 if (int_buf[i] == '(' || int_buf[i] == '{') {
954 remove_chunk(int_buf, 0, i + 1);
955 i = -1; /* back to square 1 */
959 /* Remove leading unquoted spaces */
960 for (i = 0; int_buf[i]; i++)
961 if (int_buf[i] != ' ')
963 remove_chunk(int_buf, 0, i);
965 /* Determine completion mode */
966 command_mode = FIND_EXE_ONLY;
967 for (i = 0; int_buf[i]; i++) {
968 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
969 if (int_buf[i] == ' '
970 && command_mode == FIND_EXE_ONLY
971 && (char)int_buf[0] == 'c'
972 && (char)int_buf[1] == 'd'
973 && i == 2 /* -> int_buf[2] == ' ' */
975 command_mode = FIND_DIR_ONLY;
977 command_mode = FIND_FILE_ONLY;
982 if (dbg_bmp) printf("command_mode(0:exe/1:dir/2:file):%d\n", command_mode);
984 /* Remove everything except last word */
985 for (i = 0; int_buf[i]; i++) /* quasi-strlen(int_buf) */
987 for (--i; i >= 0; i--) {
988 int cur = int_buf[i];
989 if (cur == ' ' || cur == '<' || cur == '>' || cur == '|' || cur == '&') {
990 remove_chunk(int_buf, 0, i + 1);
995 /* Convert back to string of _chars_ */
997 while ((match_buf[i] = int_buf[i]) != '\0')
1000 if (dbg_bmp) printf("final match_buf:'%s'\n", match_buf);
1002 return command_mode;
1006 * Display by column (original idea from ls applet,
1007 * very optimized by me [Vladimir] :)
1009 static void showfiles(void)
1012 int column_width = 0;
1013 int nfiles = num_matches;
1017 /* find the longest file name - use that as the column width */
1018 for (row = 0; row < nrows; row++) {
1019 l = unicode_strwidth(matches[row]);
1020 if (column_width < l)
1023 column_width += 2; /* min space for columns */
1024 ncols = cmdedit_termw / column_width;
1029 nrows++; /* round up fractionals */
1033 for (row = 0; row < nrows; row++) {
1037 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1038 printf("%s%-*s", matches[n],
1039 (int)(column_width - unicode_strwidth(matches[n])), ""
1042 if (ENABLE_UNICODE_SUPPORT)
1043 puts(printable_string(NULL, matches[n]));
1049 static const char *is_special_char(char c)
1051 return strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", c);
1054 static char *quote_special_chars(char *found)
1057 char *s = xzalloc((strlen(found) + 1) * 2);
1060 if (is_special_char(*found))
1064 /* s[l] = '\0'; - already is */
1068 /* Do TAB completion */
1069 static NOINLINE void input_tab(smallint *lastWasTab)
1074 /* Length of string used for matching */
1075 unsigned match_pfx_len = match_pfx_len;
1077 # if ENABLE_UNICODE_SUPPORT
1078 /* cursor pos in command converted to multibyte form */
1081 if (!(state->flags & TAB_COMPLETION))
1085 /* The last char was a TAB too.
1086 * Print a list of all the available choices.
1088 if (num_matches > 0) {
1089 /* cursor will be changed by goto_new_line() */
1090 int sav_cursor = cursor;
1093 redraw(0, command_len - sav_cursor);
1099 chosen_match = NULL;
1101 /* Make a local copy of the string up to the position of the cursor.
1102 * build_match_prefix will expand it into int16_t's, need to allocate
1103 * twice as much as the string_len+1.
1104 * (we then also (ab)use this extra space later - see (**))
1106 match_buf = xmalloc(MAX_LINELEN * sizeof(int16_t));
1107 # if !ENABLE_UNICODE_SUPPORT
1108 save_string(match_buf, cursor + 1); /* +1 for NUL */
1111 CHAR_T wc = command_ps[cursor];
1112 command_ps[cursor] = BB_NUL;
1113 save_string(match_buf, MAX_LINELEN);
1114 command_ps[cursor] = wc;
1115 cursor_mb = strlen(match_buf);
1118 find_type = build_match_prefix(match_buf);
1120 /* Free up any memory already allocated */
1121 free_tab_completion_data();
1123 # if ENABLE_FEATURE_USERNAME_COMPLETION
1124 /* If the word starts with ~ and there is no slash in the word,
1125 * then try completing this word as a username. */
1126 if (state->flags & USERNAME_COMPLETION)
1127 if (match_buf[0] == '~' && strchr(match_buf, '/') == NULL)
1128 match_pfx_len = complete_username(match_buf);
1130 /* If complete_username() did not match,
1131 * try to match a command in $PATH, or a directory, or a file */
1133 match_pfx_len = complete_cmd_dir_file(match_buf, find_type);
1135 /* Account for backslashes which will be inserted
1136 * by quote_special_chars() later */
1138 const char *e = match_buf + strlen(match_buf);
1139 const char *s = e - match_pfx_len;
1141 if (is_special_char(*s++))
1145 /* Remove duplicates */
1148 qsort_string_vector(matches, num_matches);
1149 for (i = 0; i < num_matches - 1; ++i) {
1150 //if (matches[i] && matches[i+1]) { /* paranoia */
1151 if (strcmp(matches[i], matches[i+1]) == 0) {
1153 //matches[i] = NULL; /* paranoia */
1155 matches[n++] = matches[i];
1159 matches[n++] = matches[i];
1163 /* Did we find exactly one match? */
1164 if (num_matches != 1) { /* no */
1168 goto ret; /* no matches at all */
1169 /* Find common prefix */
1170 chosen_match = xstrdup(matches[0]);
1171 for (cp = chosen_match; *cp; cp++) {
1173 for (n = 1; n < num_matches; n++) {
1174 if (matches[n][cp - chosen_match] != *cp) {
1180 if (cp == chosen_match) { /* have unique prefix? */
1184 cp = quote_special_chars(chosen_match);
1187 len_found = strlen(chosen_match);
1188 } else { /* exactly one match */
1189 /* Next <tab> is not a double-tab */
1192 chosen_match = quote_special_chars(matches[0]);
1193 len_found = strlen(chosen_match);
1194 if (chosen_match[len_found-1] != '/') {
1195 chosen_match[len_found] = ' ';
1196 chosen_match[++len_found] = '\0';
1200 # if !ENABLE_UNICODE_SUPPORT
1201 /* Have space to place the match? */
1202 /* The result consists of three parts with these lengths: */
1203 /* cursor + (len_found - match_pfx_len) + (command_len - cursor) */
1204 /* it simplifies into: */
1205 if ((int)(len_found - match_pfx_len + command_len) < S.maxsize) {
1208 strcpy(match_buf, &command_ps[cursor]);
1209 /* add match and tail */
1210 sprintf(&command_ps[cursor], "%s%s", chosen_match + match_pfx_len, match_buf);
1211 command_len = strlen(command_ps);
1213 pos = cursor + len_found - match_pfx_len;
1214 /* write out the matched command */
1215 redraw(cmdedit_y, command_len - pos);
1219 /* Use 2nd half of match_buf as scratch space - see (**) */
1220 char *command = match_buf + MAX_LINELEN;
1221 int len = save_string(command, MAX_LINELEN);
1222 /* Have space to place the match? */
1223 /* cursor_mb + (len_found - match_pfx_len) + (len - cursor_mb) */
1224 if ((int)(len_found - match_pfx_len + len) < MAX_LINELEN) {
1227 strcpy(match_buf, &command[cursor_mb]);
1228 /* where do we want to have cursor after all? */
1229 strcpy(&command[cursor_mb], chosen_match + match_pfx_len);
1230 len = load_string(command);
1231 /* add match and tail */
1232 sprintf(&command[cursor_mb], "%s%s", chosen_match + match_pfx_len, match_buf);
1233 command_len = load_string(command);
1234 /* write out the matched command */
1235 /* paranoia: load_string can return 0 on conv error,
1236 * prevent passing pos = (0 - 12) to redraw */
1237 pos = command_len - len;
1238 redraw(cmdedit_y, pos >= 0 ? pos : 0);
1247 #endif /* FEATURE_TAB_COMPLETION */
1250 line_input_t* FAST_FUNC new_line_input_t(int flags)
1252 line_input_t *n = xzalloc(sizeof(*n));
1254 n->max_history = MAX_HISTORY;
1261 unsigned size_from_HISTFILESIZE(const char *hp)
1263 int size = MAX_HISTORY;
1268 if (size > MAX_HISTORY)
1274 static void save_command_ps_at_cur_history(void)
1276 if (command_ps[0] != BB_NUL) {
1277 int cur = state->cur_history;
1278 free(state->history[cur]);
1280 # if ENABLE_UNICODE_SUPPORT
1282 char tbuf[MAX_LINELEN];
1283 save_string(tbuf, sizeof(tbuf));
1284 state->history[cur] = xstrdup(tbuf);
1287 state->history[cur] = xstrdup(command_ps);
1292 /* state->flags is already checked to be nonzero */
1293 static int get_previous_history(void)
1295 if ((state->flags & DO_HISTORY) && state->cur_history) {
1296 save_command_ps_at_cur_history();
1297 state->cur_history--;
1304 static int get_next_history(void)
1306 if (state->flags & DO_HISTORY) {
1307 if (state->cur_history < state->cnt_history) {
1308 save_command_ps_at_cur_history(); /* save the current history line */
1309 return ++state->cur_history;
1316 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1317 /* We try to ensure that concurrent additions to the history
1318 * do not overwrite each other.
1319 * Otherwise shell users get unhappy.
1321 * History file is trimmed lazily, when it grows several times longer
1322 * than configured MAX_HISTORY lines.
1325 static void free_line_input_t(line_input_t *n)
1327 int i = n->cnt_history;
1329 free(n->history[--i]);
1333 /* state->flags is already checked to be nonzero */
1334 static void load_history(line_input_t *st_parm)
1336 char *temp_h[MAX_HISTORY];
1339 unsigned idx, i, line_len;
1341 /* NB: do not trash old history if file can't be opened */
1343 fp = fopen_for_read(st_parm->hist_file);
1345 /* clean up old history */
1346 for (idx = st_parm->cnt_history; idx > 0;) {
1348 free(st_parm->history[idx]);
1349 st_parm->history[idx] = NULL;
1352 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1353 memset(temp_h, 0, sizeof(temp_h));
1355 if (!ENABLE_FEATURE_EDITING_SAVE_ON_EXIT)
1356 st_parm->cnt_history_in_file = 0;
1357 while ((line = xmalloc_fgetline(fp)) != NULL) {
1358 if (line[0] == '\0') {
1364 if (!ENABLE_FEATURE_EDITING_SAVE_ON_EXIT)
1365 st_parm->cnt_history_in_file++;
1367 if (idx == st_parm->max_history)
1372 /* find first non-NULL temp_h[], if any */
1373 if (st_parm->cnt_history_in_file) {
1374 while (temp_h[idx] == NULL) {
1376 if (idx == st_parm->max_history)
1381 /* copy temp_h[] to st_parm->history[] */
1382 for (i = 0; i < st_parm->max_history;) {
1387 if (idx == st_parm->max_history)
1389 line_len = strlen(line);
1390 if (line_len >= MAX_LINELEN)
1391 line[MAX_LINELEN-1] = '\0';
1392 st_parm->history[i++] = line;
1394 st_parm->cnt_history = i;
1395 if (ENABLE_FEATURE_EDITING_SAVE_ON_EXIT)
1396 st_parm->cnt_history_in_file = i;
1400 # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1401 void save_history(line_input_t *st)
1405 if (!(st->flags & SAVE_HISTORY))
1409 if (st->cnt_history <= st->cnt_history_in_file)
1412 fp = fopen(st->hist_file, "a");
1416 line_input_t *st_temp;
1418 for (i = st->cnt_history_in_file; i < st->cnt_history; i++)
1419 fprintf(fp, "%s\n", st->history[i]);
1422 /* we may have concurrently written entries from others.
1424 st_temp = new_line_input_t(st->flags);
1425 st_temp->hist_file = st->hist_file;
1426 st_temp->max_history = st->max_history;
1427 load_history(st_temp);
1429 /* write out temp file and replace hist_file atomically */
1430 new_name = xasprintf("%s.%u.new", st->hist_file, (int) getpid());
1431 fd = open(new_name, O_WRONLY | O_CREAT | O_TRUNC, 0600);
1433 fp = xfdopen_for_write(fd);
1434 for (i = 0; i < st_temp->cnt_history; i++)
1435 fprintf(fp, "%s\n", st_temp->history[i]);
1437 if (rename(new_name, st->hist_file) == 0)
1438 st->cnt_history_in_file = st_temp->cnt_history;
1441 free_line_input_t(st_temp);
1445 static void save_history(char *str)
1450 if (!(state->flags & SAVE_HISTORY))
1452 if (!state->hist_file)
1455 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0600);
1458 xlseek(fd, 0, SEEK_END); /* paranoia */
1460 str[len] = '\n'; /* we (try to) do atomic write */
1461 len2 = full_write(fd, str, len + 1);
1464 if (len2 != len + 1)
1465 return; /* "wtf?" */
1467 /* did we write so much that history file needs trimming? */
1468 state->cnt_history_in_file++;
1469 if (state->cnt_history_in_file > state->max_history * 4) {
1471 line_input_t *st_temp;
1473 /* we may have concurrently written entries from others.
1475 st_temp = new_line_input_t(state->flags);
1476 st_temp->hist_file = state->hist_file;
1477 st_temp->max_history = state->max_history;
1478 load_history(st_temp);
1480 /* write out temp file and replace hist_file atomically */
1481 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1482 fd = open(new_name, O_WRONLY | O_CREAT | O_TRUNC, 0600);
1487 fp = xfdopen_for_write(fd);
1488 for (i = 0; i < st_temp->cnt_history; i++)
1489 fprintf(fp, "%s\n", st_temp->history[i]);
1491 if (rename(new_name, state->hist_file) == 0)
1492 state->cnt_history_in_file = st_temp->cnt_history;
1495 free_line_input_t(st_temp);
1500 # define load_history(a) ((void)0)
1501 # define save_history(a) ((void)0)
1502 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1504 static void remember_in_history(char *str)
1508 if (!(state->flags & DO_HISTORY))
1512 i = state->cnt_history;
1513 /* Don't save dupes */
1514 if (i && strcmp(state->history[i-1], str) == 0)
1517 free(state->history[state->max_history]); /* redundant, paranoia */
1518 state->history[state->max_history] = NULL; /* redundant, paranoia */
1520 /* If history[] is full, remove the oldest command */
1521 /* we need to keep history[state->max_history] empty, hence >=, not > */
1522 if (i >= state->max_history) {
1523 free(state->history[0]);
1524 for (i = 0; i < state->max_history-1; i++)
1525 state->history[i] = state->history[i+1];
1526 /* i == state->max_history-1 */
1527 if (ENABLE_FEATURE_EDITING_SAVE_ON_EXIT && state->cnt_history_in_file)
1528 state->cnt_history_in_file--;
1530 /* i <= state->max_history-1 */
1531 state->history[i++] = xstrdup(str);
1532 /* i <= state->max_history */
1533 state->cur_history = i;
1534 state->cnt_history = i;
1535 # if ENABLE_FEATURE_EDITING_SAVEHISTORY && !ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1538 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1541 #else /* MAX_HISTORY == 0 */
1542 # define remember_in_history(a) ((void)0)
1543 #endif /* MAX_HISTORY */
1546 #if ENABLE_FEATURE_EDITING_VI
1548 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1551 vi_Word_motion(int eat)
1553 CHAR_T *command = command_ps;
1555 while (cursor < command_len && !BB_isspace(command[cursor]))
1557 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1562 vi_word_motion(int eat)
1564 CHAR_T *command = command_ps;
1566 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1567 while (cursor < command_len
1568 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1572 } else if (BB_ispunct(command[cursor])) {
1573 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1577 if (cursor < command_len)
1581 while (cursor < command_len && BB_isspace(command[cursor]))
1589 CHAR_T *command = command_ps;
1592 while (cursor < command_len && BB_isspace(command[cursor]))
1594 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1601 CHAR_T *command = command_ps;
1603 if (cursor >= command_len-1)
1606 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1608 if (cursor >= command_len-1)
1610 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1611 while (cursor < command_len-1
1612 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1616 } else if (BB_ispunct(command[cursor])) {
1617 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1623 vi_Back_motion(void)
1625 CHAR_T *command = command_ps;
1627 while (cursor > 0 && BB_isspace(command[cursor-1]))
1629 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1634 vi_back_motion(void)
1636 CHAR_T *command = command_ps;
1641 while (cursor > 0 && BB_isspace(command[cursor]))
1645 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1647 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1651 } else if (BB_ispunct(command[cursor])) {
1652 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1658 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1659 static void ctrl_left(void)
1661 CHAR_T *command = command_ps;
1669 c = command[cursor];
1670 if (c != ' ' && !BB_ispunct(c)) {
1671 /* we reached a "word" delimited by spaces/punct.
1672 * go to its beginning */
1674 c = command[cursor - 1];
1675 if (c == ' ' || BB_ispunct(c))
1685 static void ctrl_right(void)
1687 CHAR_T *command = command_ps;
1692 c = command[cursor];
1695 if (c != ' ' && !BB_ispunct(c)) {
1696 /* we reached a "word" delimited by spaces/punct.
1697 * go to its end + 1 */
1700 c = command[cursor];
1701 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1712 * read_line_input and its helpers
1715 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1716 static void ask_terminal(void)
1718 /* Ask terminal where is the cursor now.
1719 * lineedit_read_key handles response and corrects
1720 * our idea of current cursor position.
1721 * Testcase: run "echo -n long_line_long_line_long_line",
1722 * then type in a long, wrapping command and try to
1723 * delete it using backspace key.
1724 * Note: we print it _after_ prompt, because
1725 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1727 /* Problem: if there is buffered input on stdin,
1728 * the response will be delivered later,
1729 * possibly to an unsuspecting application.
1730 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1732 * ~/srcdevel/bbox/fix/busybox.t4 #
1733 * ~/srcdevel/bbox/fix/busybox.t4 #
1734 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1735 * ~/srcdevel/bbox/fix/busybox.t4 #
1737 * Checking for input with poll only makes the race narrower,
1738 * I still can trigger it. Strace:
1740 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1741 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1742 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1743 * poll([{fd=0, events=POLLIN}], 1, -1) = 1 ([{fd=0, revents=POLLIN}])
1744 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1748 pfd.fd = STDIN_FILENO;
1749 pfd.events = POLLIN;
1750 if (safe_poll(&pfd, 1, 0) == 0) {
1751 S.sent_ESC_br6n = 1;
1752 fputs(ESC"[6n", stdout);
1753 fflush_all(); /* make terminal see it ASAP! */
1757 #define ask_terminal() ((void)0)
1760 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1761 static void parse_and_put_prompt(const char *prmt_ptr)
1763 cmdedit_prompt = prmt_ptr;
1764 cmdedit_prmt_len = strlen(prmt_ptr);
1768 static void parse_and_put_prompt(const char *prmt_ptr)
1771 size_t cur_prmt_len = 0;
1772 char flg_not_length = '[';
1773 char *prmt_mem_ptr = xzalloc(1);
1774 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1779 cmdedit_prmt_len = 0;
1782 cwd_buf = (char *)bb_msg_unknown;
1785 cbuf[1] = '\0'; /* never changes */
1788 char *free_me = NULL;
1793 const char *cp = prmt_ptr;
1796 c = bb_process_escape_sequence(&prmt_ptr);
1797 if (prmt_ptr == cp) {
1803 # if ENABLE_USERNAME_OR_HOMEDIR
1805 pbuf = user_buf ? user_buf : (char*)"";
1809 pbuf = free_me = safe_gethostname();
1810 *strchrnul(pbuf, '.') = '\0';
1813 c = (geteuid() == 0 ? '#' : '$');
1815 # if ENABLE_USERNAME_OR_HOMEDIR
1817 /* /home/user[/something] -> ~[/something] */
1819 l = strlen(home_pwd_buf);
1821 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1822 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1823 && strlen(cwd_buf + l) < PATH_MAX
1825 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1831 cp = strrchr(pbuf, '/');
1832 if (cp != NULL && cp != pbuf)
1833 pbuf += (cp-pbuf) + 1;
1836 pbuf = free_me = xasprintf("%d", num_ok_lines);
1838 case 'e': case 'E': /* \e \E = \033 */
1841 case 'x': case 'X': {
1843 for (l = 0; l < 3;) {
1845 buf2[l++] = *prmt_ptr;
1847 h = strtoul(buf2, &pbuf, 16);
1848 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1854 c = (char)strtoul(buf2, NULL, 16);
1861 if (c == flg_not_length) {
1862 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1870 cur_prmt_len = strlen(pbuf);
1871 prmt_len += cur_prmt_len;
1872 if (flg_not_length != ']')
1873 cmdedit_prmt_len += cur_prmt_len;
1874 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1878 if (cwd_buf != (char *)bb_msg_unknown)
1880 cmdedit_prompt = prmt_mem_ptr;
1885 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1889 /* new y for current cursor */
1890 int new_y = (cursor + cmdedit_prmt_len) / w;
1892 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1897 static void win_changed(int nsig)
1899 int sv_errno = errno;
1902 get_terminal_width_height(0, &width, NULL);
1903 //FIXME: cmdedit_setwidth() -> redraw() -> printf() -> KABOOM! (we are in signal handler!)
1904 cmdedit_setwidth(width, /*redraw_flg:*/ nsig);
1909 static int lineedit_read_key(char *read_key_buffer, int timeout)
1912 #if ENABLE_UNICODE_SUPPORT
1913 char unicode_buf[MB_CUR_MAX + 1];
1914 int unicode_idx = 0;
1918 /* Wait for input. TIMEOUT = -1 makes read_key wait even
1919 * on nonblocking stdin, TIMEOUT = 50 makes sure we won't
1920 * insist on full MB_CUR_MAX buffer to declare input like
1921 * "\xff\n",pause,"ls\n" invalid and thus won't lose "ls".
1923 * Note: read_key sets errno to 0 on success.
1925 ic = read_key(STDIN_FILENO, read_key_buffer, timeout);
1927 #if ENABLE_UNICODE_SUPPORT
1928 if (errno == EAGAIN && unicode_idx != 0)
1934 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1935 if ((int32_t)ic == KEYCODE_CURSOR_POS
1938 S.sent_ESC_br6n = 0;
1939 if (cursor == 0) { /* otherwise it may be bogus */
1940 int col = ((ic >> 32) & 0x7fff) - 1;
1941 if (col > cmdedit_prmt_len) {
1942 cmdedit_x += (col - cmdedit_prmt_len);
1943 while (cmdedit_x >= cmdedit_termw) {
1944 cmdedit_x -= cmdedit_termw;
1953 #if ENABLE_UNICODE_SUPPORT
1954 if (unicode_status == UNICODE_ON) {
1957 if ((int32_t)ic < 0) /* KEYCODE_xxx */
1959 // TODO: imagine sequence like: 0xff,<left-arrow>: we are currently losing 0xff...
1961 unicode_buf[unicode_idx++] = ic;
1962 unicode_buf[unicode_idx] = '\0';
1963 if (mbstowcs(&wc, unicode_buf, 1) != 1) {
1964 /* Not (yet?) a valid unicode char */
1965 if (unicode_idx < MB_CUR_MAX) {
1970 /* Invalid sequence. Save all "bad bytes" except first */
1971 read_key_ungets(read_key_buffer, unicode_buf + 1, unicode_idx - 1);
1972 # if !ENABLE_UNICODE_PRESERVE_BROKEN
1973 ic = CONFIG_SUBST_WCHAR;
1975 ic = unicode_mark_raw_byte(unicode_buf[0]);
1978 /* Valid unicode char, return its code */
1989 #if ENABLE_UNICODE_BIDI_SUPPORT
1990 static int isrtl_str(void)
1994 while (idx < command_len && unicode_bidi_is_neutral_wchar(command_ps[idx]))
1996 return unicode_bidi_isrtl(command_ps[idx]);
1999 # define isrtl_str() 0
2002 /* leave out the "vi-mode"-only case labels if vi editing isn't
2004 #define vi_case(caselabel) IF_FEATURE_EDITING_VI(case caselabel)
2006 /* convert uppercase ascii to equivalent control char, for readability */
2008 #define CTRL(a) ((a) & ~0x40)
2011 VI_CMDMODE_BIT = 0x40000000,
2012 /* 0x80000000 bit flags KEYCODE_xxx */
2015 #if ENABLE_FEATURE_REVERSE_SEARCH
2016 /* Mimic readline Ctrl-R reverse history search.
2017 * When invoked, it shows the following prompt:
2018 * (reverse-i-search)'': user_input [cursor pos unchanged by Ctrl-R]
2019 * and typing results in search being performed:
2020 * (reverse-i-search)'tmp': cd /tmp [cursor under t in /tmp]
2021 * Search is performed by looking at progressively older lines in history.
2022 * Ctrl-R again searches for the next match in history.
2023 * Backspace deletes last matched char.
2024 * Control keys exit search and return to normal editing (at current history line).
2026 static int32_t reverse_i_search(void)
2028 char match_buf[128]; /* for user input */
2029 char read_key_buffer[KEYCODE_BUFFER_SIZE];
2030 const char *matched_history_line;
2031 const char *saved_prompt;
2034 matched_history_line = NULL;
2035 read_key_buffer[0] = 0;
2036 match_buf[0] = '\0';
2038 /* Save and replace the prompt */
2039 saved_prompt = cmdedit_prompt;
2044 unsigned match_buf_len = strlen(match_buf);
2047 //FIXME: correct timeout?
2048 ic = lineedit_read_key(read_key_buffer, -1);
2051 case CTRL('R'): /* searching for the next match */
2057 if (unicode_status == UNICODE_ON) {
2058 while (match_buf_len != 0) {
2059 uint8_t c = match_buf[--match_buf_len];
2060 if ((c & 0xc0) != 0x80) /* start of UTF-8 char? */
2064 if (match_buf_len != 0)
2067 match_buf[match_buf_len] = '\0';
2072 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2073 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2078 /* Append this char */
2079 #if ENABLE_UNICODE_SUPPORT
2080 if (unicode_status == UNICODE_ON) {
2081 mbstate_t mbstate = { 0 };
2082 char buf[MB_CUR_MAX + 1];
2083 int len = wcrtomb(buf, ic, &mbstate);
2086 if (match_buf_len + len < sizeof(match_buf))
2087 strcpy(match_buf + match_buf_len, buf);
2091 if (match_buf_len < sizeof(match_buf) - 1) {
2092 match_buf[match_buf_len] = ic;
2093 match_buf[match_buf_len + 1] = '\0';
2098 /* Search in history for match_buf */
2099 h = state->cur_history;
2100 if (ic == CTRL('R'))
2103 if (state->history[h]) {
2104 char *match = strstr(state->history[h], match_buf);
2106 state->cur_history = h;
2107 matched_history_line = state->history[h];
2108 command_len = load_string(matched_history_line);
2109 cursor = match - matched_history_line;
2110 //FIXME: cursor position for Unicode case
2112 free((char*)cmdedit_prompt);
2114 cmdedit_prompt = xasprintf("(reverse-i-search)'%s': ", match_buf);
2115 cmdedit_prmt_len = strlen(cmdedit_prompt);
2123 match_buf[match_buf_len] = '\0';
2128 redraw(cmdedit_y, command_len - cursor);
2132 if (matched_history_line)
2133 command_len = load_string(matched_history_line);
2135 free((char*)cmdedit_prompt);
2136 cmdedit_prompt = saved_prompt;
2137 cmdedit_prmt_len = strlen(cmdedit_prompt);
2138 redraw(cmdedit_y, command_len - cursor);
2144 /* maxsize must be >= 2.
2146 * -1 on read errors or EOF, or on bare Ctrl-D,
2147 * 0 on ctrl-C (the line entered is still returned in 'command'),
2148 * >0 length of input string, including terminating '\n'
2150 int FAST_FUNC read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout)
2153 #if ENABLE_FEATURE_TAB_COMPLETION
2154 smallint lastWasTab = 0;
2156 smallint break_out = 0;
2157 #if ENABLE_FEATURE_EDITING_VI
2158 smallint vi_cmdmode = 0;
2160 struct termios initial_settings;
2161 struct termios new_settings;
2162 char read_key_buffer[KEYCODE_BUFFER_SIZE];
2166 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
2167 || !(initial_settings.c_lflag & ECHO)
2169 /* Happens when e.g. stty -echo was run before */
2170 parse_and_put_prompt(prompt);
2171 /* fflush_all(); - done by parse_and_put_prompt */
2172 if (fgets(command, maxsize, stdin) == NULL)
2173 len = -1; /* EOF or error */
2175 len = strlen(command);
2182 // FIXME: audit & improve this
2183 if (maxsize > MAX_LINELEN)
2184 maxsize = MAX_LINELEN;
2185 S.maxsize = maxsize;
2187 /* With zero flags, no other fields are ever used */
2188 state = st ? st : (line_input_t*) &const_int_0;
2190 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
2191 if ((state->flags & SAVE_HISTORY) && state->hist_file)
2192 if (state->cnt_history == 0)
2193 load_history(state);
2195 if (state->flags & DO_HISTORY)
2196 state->cur_history = state->cnt_history;
2199 /* prepare before init handlers */
2200 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
2202 #if ENABLE_UNICODE_SUPPORT
2203 command_ps = xzalloc(maxsize * sizeof(command_ps[0]));
2205 command_ps = command;
2208 #define command command_must_not_be_used
2210 new_settings = initial_settings;
2211 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
2212 /* Turn off echoing and CTRL-C, so we can trap it */
2213 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
2214 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
2215 new_settings.c_cc[VMIN] = 1;
2216 new_settings.c_cc[VTIME] = 0;
2217 /* Turn off CTRL-C, so we can trap it */
2218 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
2219 tcsetattr_stdin_TCSANOW(&new_settings);
2221 #if ENABLE_USERNAME_OR_HOMEDIR
2223 struct passwd *entry;
2225 entry = getpwuid(geteuid());
2227 user_buf = xstrdup(entry->pw_name);
2228 home_pwd_buf = xstrdup(entry->pw_dir);
2234 for (i = 0; i <= state->max_history; i++)
2235 bb_error_msg("history[%d]:'%s'", i, state->history[i]);
2236 bb_error_msg("cur_history:%d cnt_history:%d", state->cur_history, state->cnt_history);
2239 /* Print out the command prompt, optionally ask where cursor is */
2240 parse_and_put_prompt(prompt);
2243 /* Install window resize handler (NB: after *all* init is complete) */
2244 //FIXME: save entire sigaction!
2245 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
2246 win_changed(0); /* get initial window size */
2248 read_key_buffer[0] = 0;
2251 * The emacs and vi modes share much of the code in the big
2252 * command loop. Commands entered when in vi's command mode
2253 * (aka "escape mode") get an extra bit added to distinguish
2254 * them - this keeps them from being self-inserted. This
2255 * clutters the big switch a bit, but keeps all the code
2261 ic = ic_raw = lineedit_read_key(read_key_buffer, timeout);
2263 #if ENABLE_FEATURE_REVERSE_SEARCH
2266 #if ENABLE_FEATURE_EDITING_VI
2269 /* btw, since KEYCODE_xxx are all < 0, this doesn't
2270 * change ic if it contains one of them: */
2271 ic |= VI_CMDMODE_BIT;
2278 vi_case('\n'|VI_CMDMODE_BIT:)
2279 vi_case('\r'|VI_CMDMODE_BIT:)
2285 vi_case('0'|VI_CMDMODE_BIT:)
2286 /* Control-a -- Beginning of line */
2287 input_backward(cursor);
2290 vi_case('h'|VI_CMDMODE_BIT:)
2291 vi_case('\b'|VI_CMDMODE_BIT:) /* ^H */
2292 vi_case('\x7f'|VI_CMDMODE_BIT:) /* DEL */
2293 input_backward(1); /* Move back one character */
2296 vi_case('$'|VI_CMDMODE_BIT:)
2297 /* Control-e -- End of line */
2298 put_till_end_and_adv_cursor();
2301 vi_case('l'|VI_CMDMODE_BIT:)
2302 vi_case(' '|VI_CMDMODE_BIT:)
2303 input_forward(); /* Move forward one character */
2306 case '\x7f': /* DEL */
2312 case KEYCODE_DELETE:
2318 #if ENABLE_FEATURE_TAB_COMPLETION
2320 input_tab(&lastWasTab);
2324 /* Control-k -- clear to end of line */
2325 command_ps[cursor] = BB_NUL;
2326 command_len = cursor;
2327 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
2330 vi_case(CTRL('L')|VI_CMDMODE_BIT:)
2331 /* Control-l -- clear screen */
2332 printf(ESC"[H"); /* cursor to top,left */
2333 redraw(0, command_len - cursor);
2337 vi_case(CTRL('N')|VI_CMDMODE_BIT:)
2338 vi_case('j'|VI_CMDMODE_BIT:)
2339 /* Control-n -- Get next command in history */
2340 if (get_next_history())
2344 vi_case(CTRL('P')|VI_CMDMODE_BIT:)
2345 vi_case('k'|VI_CMDMODE_BIT:)
2346 /* Control-p -- Get previous command from history */
2347 if (get_previous_history())
2352 vi_case(CTRL('U')|VI_CMDMODE_BIT:)
2353 /* Control-U -- Clear line before cursor */
2355 command_len -= cursor;
2356 memmove(command_ps, command_ps + cursor,
2357 (command_len + 1) * sizeof(command_ps[0]));
2358 redraw(cmdedit_y, command_len);
2362 vi_case(CTRL('W')|VI_CMDMODE_BIT:)
2363 /* Control-W -- Remove the last word */
2364 while (cursor > 0 && BB_isspace(command_ps[cursor-1]))
2366 while (cursor > 0 && !BB_isspace(command_ps[cursor-1]))
2369 #if ENABLE_FEATURE_REVERSE_SEARCH
2371 ic = ic_raw = reverse_i_search();
2375 #if ENABLE_FEATURE_EDITING_VI
2376 case 'i'|VI_CMDMODE_BIT:
2379 case 'I'|VI_CMDMODE_BIT:
2380 input_backward(cursor);
2383 case 'a'|VI_CMDMODE_BIT:
2387 case 'A'|VI_CMDMODE_BIT:
2388 put_till_end_and_adv_cursor();
2391 case 'x'|VI_CMDMODE_BIT:
2394 case 'X'|VI_CMDMODE_BIT:
2400 case 'W'|VI_CMDMODE_BIT:
2403 case 'w'|VI_CMDMODE_BIT:
2406 case 'E'|VI_CMDMODE_BIT:
2409 case 'e'|VI_CMDMODE_BIT:
2412 case 'B'|VI_CMDMODE_BIT:
2415 case 'b'|VI_CMDMODE_BIT:
2418 case 'C'|VI_CMDMODE_BIT:
2421 case 'D'|VI_CMDMODE_BIT:
2424 case 'c'|VI_CMDMODE_BIT:
2427 case 'd'|VI_CMDMODE_BIT: {
2430 ic = lineedit_read_key(read_key_buffer, timeout);
2431 if (errno) /* error */
2432 goto return_error_indicator;
2433 if (ic == ic_raw) { /* "cc", "dd" */
2434 input_backward(cursor);
2446 case 'w': /* "dw", "cw" */
2447 vi_word_motion(vi_cmdmode);
2449 case 'W': /* 'dW', 'cW' */
2450 vi_Word_motion(vi_cmdmode);
2452 case 'e': /* 'de', 'ce' */
2456 case 'E': /* 'dE', 'cE' */
2462 input_backward(cursor - sc);
2463 while (nc-- > cursor)
2466 case 'b': /* "db", "cb" */
2467 case 'B': /* implemented as B */
2472 while (sc-- > cursor)
2475 case ' ': /* "d ", "c " */
2478 case '$': /* "d$", "c$" */
2480 while (cursor < command_len)
2486 case 'p'|VI_CMDMODE_BIT:
2489 case 'P'|VI_CMDMODE_BIT:
2492 case 'r'|VI_CMDMODE_BIT:
2493 //FIXME: unicode case?
2494 ic = lineedit_read_key(read_key_buffer, timeout);
2495 if (errno) /* error */
2496 goto return_error_indicator;
2497 if (ic < ' ' || ic > 255) {
2500 command_ps[cursor] = ic;
2505 case '\x1b': /* ESC */
2506 if (state->flags & VI_MODE) {
2507 /* insert mode --> command mode */
2512 #endif /* FEATURE_COMMAND_EDITING_VI */
2516 if (get_previous_history())
2521 if (!get_next_history())
2524 /* Rewrite the line with the selected history item */
2525 /* change command */
2526 command_len = load_string(state->history[state->cur_history] ?
2527 state->history[state->cur_history] : "");
2528 /* redraw and go to eol (bol, in vi) */
2529 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
2538 case KEYCODE_CTRL_LEFT:
2541 case KEYCODE_CTRL_RIGHT:
2545 input_backward(cursor);
2548 put_till_end_and_adv_cursor();
2552 if (initial_settings.c_cc[VINTR] != 0
2553 && ic_raw == initial_settings.c_cc[VINTR]
2555 /* Ctrl-C (usually) - stop gathering input */
2558 break_out = -1; /* "do not append '\n'" */
2561 if (initial_settings.c_cc[VEOF] != 0
2562 && ic_raw == initial_settings.c_cc[VEOF]
2564 /* Ctrl-D (usually) - delete one character,
2565 * or exit if len=0 and no chars to delete */
2566 if (command_len == 0) {
2569 case -1: /* error (e.g. EIO when tty is destroyed) */
2570 IF_FEATURE_EDITING_VI(return_error_indicator:)
2571 break_out = command_len = -1;
2577 // /* Control-V -- force insert of next char */
2578 // if (c == CTRL('V')) {
2579 // if (safe_read(STDIN_FILENO, &c, 1) < 1)
2580 // goto return_error_indicator;
2587 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2588 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2590 /* If VI_CMDMODE_BIT is set, ic is >= 256
2591 * and vi mode ignores unexpected chars.
2592 * Otherwise, we are here if ic is a
2593 * control char or an unhandled ESC sequence,
2594 * which is also ignored.
2598 if ((int)command_len >= (maxsize - 2)) {
2599 /* Not enough space for the char and EOL */
2604 if (cursor == (command_len - 1)) {
2605 /* We are at the end, append */
2606 command_ps[cursor] = ic;
2607 command_ps[cursor + 1] = BB_NUL;
2608 put_cur_glyph_and_inc_cursor();
2609 if (unicode_bidi_isrtl(ic))
2612 /* In the middle, insert */
2615 memmove(command_ps + sc + 1, command_ps + sc,
2616 (command_len - sc) * sizeof(command_ps[0]));
2617 command_ps[sc] = ic;
2618 /* is right-to-left char, or neutral one (e.g. comma) was just added to rtl text? */
2621 put_till_end_and_adv_cursor();
2622 /* to prev x pos + 1 */
2623 input_backward(cursor - sc);
2631 #if ENABLE_FEATURE_TAB_COMPLETION
2637 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
2638 if (S.sent_ESC_br6n) {
2639 /* "sleep 1; busybox ash" + hold [Enter] to trigger.
2640 * We sent "ESC [ 6 n", but got '\n' first, and
2641 * KEYCODE_CURSOR_POS response is now buffered from terminal.
2642 * It's bad already and not much can be done with it
2643 * (it _will_ be visible for the next process to read stdin),
2644 * but without this delay it even shows up on the screen
2645 * as garbage because we restore echo settings with tcsetattr
2646 * before it comes in. UGLY!
2652 /* End of bug-catching "command_must_not_be_used" trick */
2655 #if ENABLE_UNICODE_SUPPORT
2657 if (command_len > 0)
2658 command_len = save_string(command, maxsize - 1);
2662 if (command_len > 0)
2663 remember_in_history(command);
2665 if (break_out > 0) {
2666 command[command_len++] = '\n';
2667 command[command_len] = '\0';
2670 #if ENABLE_FEATURE_TAB_COMPLETION
2671 free_tab_completion_data();
2674 /* restore initial_settings */
2675 tcsetattr_stdin_TCSANOW(&initial_settings);
2676 /* restore SIGWINCH handler */
2677 signal(SIGWINCH, previous_SIGWINCH_handler);
2683 return len; /* can't return command_len, DEINIT_S() destroys it */
2686 #else /* !FEATURE_EDITING */
2688 #undef read_line_input
2689 int FAST_FUNC read_line_input(const char* prompt, char* command, int maxsize)
2691 fputs(prompt, stdout);
2693 fgets(command, maxsize, stdin);
2694 return strlen(command);
2697 #endif /* !FEATURE_EDITING */
2708 const char *applet_name = "debug stuff usage";
2710 int main(int argc, char **argv)
2712 char buff[MAX_LINELEN];
2714 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
2715 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
2716 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
2717 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
2724 l = read_line_input(prompt, buff);
2725 if (l <= 0 || buff[l-1] != '\n')
2728 printf("*** read_line_input() returned line =%s=\n", buff);
2730 printf("*** read_line_input() detect ^D\n");