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\] '
46 # define ENABLE_FEATURE_EDITING 0
47 # define ENABLE_FEATURE_TAB_COMPLETION 0
48 # define ENABLE_FEATURE_USERNAME_COMPLETION 0
52 /* Entire file (except TESTing part) sits inside this #if */
53 #if ENABLE_FEATURE_EDITING
56 #define ENABLE_USERNAME_OR_HOMEDIR \
57 (ENABLE_FEATURE_USERNAME_COMPLETION || ENABLE_FEATURE_EDITING_FANCY_PROMPT)
58 #define IF_USERNAME_OR_HOMEDIR(...)
59 #if ENABLE_USERNAME_OR_HOMEDIR
60 # undef IF_USERNAME_OR_HOMEDIR
61 # define IF_USERNAME_OR_HOMEDIR(...) __VA_ARGS__
66 #if ENABLE_UNICODE_SUPPORT
67 # define BB_NUL ((wchar_t)0)
68 # define CHAR_T wchar_t
69 static bool BB_isspace(CHAR_T c) { return ((unsigned)c < 256 && isspace(c)); }
70 # if ENABLE_FEATURE_EDITING_VI
71 static bool BB_isalnum(CHAR_T c) { return ((unsigned)c < 256 && isalnum(c)); }
73 static bool BB_ispunct(CHAR_T c) { return ((unsigned)c < 256 && ispunct(c)); }
78 # define isspace isspace_must_not_be_used
79 # define isalnum isalnum_must_not_be_used
80 # define ispunct ispunct_must_not_be_used
81 # define isprint isprint_must_not_be_used
85 # define BB_isspace(c) isspace(c)
86 # define BB_isalnum(c) isalnum(c)
87 # define BB_ispunct(c) ispunct(c)
89 #if ENABLE_UNICODE_PRESERVE_BROKEN
90 # define unicode_mark_raw_byte(wc) ((wc) | 0x20000000)
91 # define unicode_is_raw_byte(wc) ((wc) & 0x20000000)
93 # define unicode_is_raw_byte(wc) 0
99 #define SEQ_CLEAR_TILL_END_OF_SCREEN ESC"[J"
100 //#define SEQ_CLEAR_TILL_END_OF_LINE ESC"[K"
104 MAX_LINELEN = CONFIG_FEATURE_EDITING_MAX_LEN < 0x7ff0
105 ? CONFIG_FEATURE_EDITING_MAX_LEN
109 #if ENABLE_USERNAME_OR_HOMEDIR
110 static const char null_str[] ALIGN1 = "";
113 /* We try to minimize both static and stack usage. */
114 struct lineedit_statics {
117 volatile unsigned cmdedit_termw; /* = 80; */ /* actual terminal width */
118 sighandler_t previous_SIGWINCH_handler;
120 unsigned cmdedit_x; /* real x (col) terminal position */
121 unsigned cmdedit_y; /* pseudoreal y (row) terminal position */
122 unsigned cmdedit_prmt_len; /* length of prompt (without colors etc) */
125 int command_len; /* must be signed */
126 /* signed maxsize: we want x in "if (x > S.maxsize)"
127 * to _not_ be promoted to unsigned */
131 const char *cmdedit_prompt;
132 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
133 int num_ok_lines; /* = 1; */
136 #if ENABLE_USERNAME_OR_HOMEDIR
138 char *home_pwd_buf; /* = (char*)null_str; */
141 #if ENABLE_FEATURE_TAB_COMPLETION
143 unsigned num_matches;
146 #if ENABLE_FEATURE_EDITING_VI
147 # define DELBUFSIZ 128
149 smallint newdelflag; /* whether delbuf should be reused yet */
150 CHAR_T delbuf[DELBUFSIZ]; /* a place to store deleted characters */
152 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
153 smallint sent_ESC_br6n;
157 /* See lineedit_ptr_hack.c */
158 extern struct lineedit_statics *const lineedit_ptr_to_statics;
160 #define S (*lineedit_ptr_to_statics)
161 #define state (S.state )
162 #define cmdedit_termw (S.cmdedit_termw )
163 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
164 #define cmdedit_x (S.cmdedit_x )
165 #define cmdedit_y (S.cmdedit_y )
166 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
167 #define cursor (S.cursor )
168 #define command_len (S.command_len )
169 #define command_ps (S.command_ps )
170 #define cmdedit_prompt (S.cmdedit_prompt )
171 #define num_ok_lines (S.num_ok_lines )
172 #define user_buf (S.user_buf )
173 #define home_pwd_buf (S.home_pwd_buf )
174 #define matches (S.matches )
175 #define num_matches (S.num_matches )
176 #define delptr (S.delptr )
177 #define newdelflag (S.newdelflag )
178 #define delbuf (S.delbuf )
180 #define INIT_S() do { \
181 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
183 cmdedit_termw = 80; \
184 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
185 IF_USERNAME_OR_HOMEDIR(home_pwd_buf = (char*)null_str;) \
187 static void deinit_S(void)
189 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
190 /* This one is allocated only if FANCY_PROMPT is on
191 * (otherwise it points to verbatim prompt (NOT malloced)) */
192 free((char*)cmdedit_prompt);
194 #if ENABLE_USERNAME_OR_HOMEDIR
196 if (home_pwd_buf != null_str)
199 free(lineedit_ptr_to_statics);
201 #define DEINIT_S() deinit_S()
204 #if ENABLE_UNICODE_SUPPORT
205 static size_t load_string(const char *src, int maxsize)
207 ssize_t len = mbstowcs(command_ps, src, maxsize - 1);
210 command_ps[len] = BB_NUL;
213 static unsigned save_string(char *dst, unsigned maxsize)
215 # if !ENABLE_UNICODE_PRESERVE_BROKEN
216 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
226 while (dstpos < maxsize) {
230 /* Convert up to 1st invalid byte (or up to end) */
231 while ((wc = command_ps[srcpos]) != BB_NUL
232 && !unicode_is_raw_byte(wc)
236 command_ps[srcpos] = BB_NUL;
237 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
238 if (n < 0) /* should not happen */
241 if (wc == BB_NUL) /* usually is */
244 /* We do have invalid byte here! */
245 command_ps[srcpos] = wc; /* restore it */
247 if (dstpos == maxsize)
249 dst[dstpos++] = (char) wc;
255 /* I thought just fputwc(c, stdout) would work. But no... */
256 static void BB_PUTCHAR(wchar_t c)
258 char buf[MB_CUR_MAX + 1];
259 mbstate_t mbst = { 0 };
262 len = wcrtomb(buf, c, &mbst);
268 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
269 static wchar_t adjust_width_and_validate_wc(unsigned *width_adj, wchar_t wc)
271 static wchar_t adjust_width_and_validate_wc(wchar_t wc)
272 # define adjust_width_and_validate_wc(width_adj, wc) \
273 ((*(width_adj))++, adjust_width_and_validate_wc(wc))
278 if (unicode_status == UNICODE_ON) {
279 if (wc > CONFIG_LAST_SUPPORTED_WCHAR) {
280 /* note: also true for unicode_is_raw_byte(wc) */
284 if ((ENABLE_UNICODE_COMBINING_WCHARS && w < 0)
285 || (!ENABLE_UNICODE_COMBINING_WCHARS && w <= 0)
286 || (!ENABLE_UNICODE_WIDE_WCHARS && w > 1)
290 wc = CONFIG_SUBST_WCHAR;
294 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
300 static size_t load_string(const char *src, int maxsize)
302 safe_strncpy(command_ps, src, maxsize);
303 return strlen(command_ps);
305 # if ENABLE_FEATURE_TAB_COMPLETION
306 static void save_string(char *dst, unsigned maxsize)
308 safe_strncpy(dst, command_ps, maxsize);
311 # define BB_PUTCHAR(c) bb_putchar(c)
312 /* Should never be called: */
313 int adjust_width_and_validate_wc(unsigned *width_adj, int wc);
317 /* Put 'command_ps[cursor]', cursor++.
318 * Advance cursor on screen. If we reached right margin, scroll text up
319 * and remove terminal margin effect by printing 'next_char' */
320 #define HACK_FOR_WRONG_WIDTH 1
321 static void put_cur_glyph_and_inc_cursor(void)
323 CHAR_T c = command_ps[cursor];
328 /* erase character after end of input string */
331 /* advance cursor only if we aren't at the end yet */
333 if (unicode_status == UNICODE_ON) {
334 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x;)
335 c = adjust_width_and_validate_wc(&cmdedit_x, c);
336 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x - width;)
342 ofs_to_right = cmdedit_x - cmdedit_termw;
343 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right <= 0) {
344 /* c fits on this line */
348 if (ofs_to_right >= 0) {
349 /* we go to the next line */
350 #if HACK_FOR_WRONG_WIDTH
351 /* This works better if our idea of term width is wrong
352 * and it is actually wider (often happens on serial lines).
353 * Printing CR,LF *forces* cursor to next line.
354 * OTOH if terminal width is correct AND terminal does NOT
355 * have automargin (IOW: it is moving cursor to next line
356 * by itself (which is wrong for VT-10x terminals)),
357 * this will break things: there will be one extra empty line */
358 puts("\r"); /* + implicit '\n' */
360 /* VT-10x terminals don't wrap cursor to next line when last char
361 * on the line is printed - cursor stays "over" this char.
362 * Need to print _next_ char too (first one to appear on next line)
363 * to make cursor move down to next line.
365 /* Works ok only if cmdedit_termw is correct. */
366 c = command_ps[cursor];
373 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right == 0) {
375 } else { /* ofs_to_right > 0 */
376 /* wide char c didn't fit on prev line */
383 /* Move to end of line (by printing all chars till the end) */
384 static void put_till_end_and_adv_cursor(void)
386 while (cursor < command_len)
387 put_cur_glyph_and_inc_cursor();
390 /* Go to the next line */
391 static void goto_new_line(void)
393 put_till_end_and_adv_cursor();
398 static void beep(void)
403 static void put_prompt(void)
407 fputs(cmdedit_prompt, stdout);
410 w = cmdedit_termw; /* read volatile var once */
411 cmdedit_y = cmdedit_prmt_len / w; /* new quasireal y */
412 cmdedit_x = cmdedit_prmt_len % w;
415 /* Move back one character */
416 /* (optimized for slow terminals) */
417 static void input_backward(unsigned num)
425 if ((ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS)
426 && unicode_status == UNICODE_ON
428 /* correct NUM to be equal to _screen_ width */
432 adjust_width_and_validate_wc(&num, command_ps[cursor + n]);
437 if (cmdedit_x >= num) {
440 /* This is longer by 5 bytes on x86.
441 * Also gets miscompiled for ARM users
442 * (busybox.net/bugs/view.php?id=2274).
443 * printf(("\b\b\b\b" + 4) - num);
451 printf(ESC"[%uD", num);
455 /* Need to go one or more lines up */
456 if (ENABLE_UNICODE_WIDE_WCHARS) {
457 /* With wide chars, it is hard to "backtrack"
458 * and reliably figure out where to put cursor.
459 * Example (<> is a wide char; # is an ordinary char, _ cursor):
463 * and user presses left arrow. num = 1, cmdedit_x = 0,
464 * We need to go up one line, and then - how do we know that
465 * we need to go *10* positions to the right? Because
469 * in this situation we need to go *11* positions to the right.
471 * A simpler thing to do is to redraw everything from the start
472 * up to new cursor position (which is already known):
475 /* go to 1st column; go up to first line */
476 printf("\r" ESC"[%uA", cmdedit_y);
479 put_prompt(); /* sets cursor to 0 */
480 while (cursor < sv_cursor)
481 put_cur_glyph_and_inc_cursor();
485 /* num = chars to go back from the beginning of current line: */
487 width = cmdedit_termw; /* read volatile var once */
488 /* num=1...w: one line up, w+1...2w: two, etc: */
489 lines_up = 1 + (num - 1) / width;
490 cmdedit_x = (width * cmdedit_y - num) % width;
491 cmdedit_y -= lines_up;
492 /* go to 1st column; go up */
493 printf("\r" ESC"[%uA", lines_up);
494 /* go to correct column.
495 * xterm, konsole, Linux VT interpret 0 as 1 below! wow.
496 * need to *make sure* we skip it if cmdedit_x == 0 */
498 printf(ESC"[%uC", cmdedit_x);
502 /* draw prompt, editor line, and clear tail */
503 static void redraw(int y, int back_cursor)
505 if (y > 0) /* up y lines */
506 printf(ESC"[%uA", y);
509 put_till_end_and_adv_cursor();
510 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
511 input_backward(back_cursor);
514 /* Delete the char in front of the cursor, optionally saving it
515 * for later putback */
516 #if !ENABLE_FEATURE_EDITING_VI
517 static void input_delete(void)
518 #define input_delete(save) input_delete()
520 static void input_delete(int save)
525 if (j == (int)command_len)
528 #if ENABLE_FEATURE_EDITING_VI
534 if ((delptr - delbuf) < DELBUFSIZ)
535 *delptr++ = command_ps[j];
539 memmove(command_ps + j, command_ps + j + 1,
540 /* (command_len + 1 [because of NUL]) - (j + 1)
541 * simplified into (command_len - j) */
542 (command_len - j) * sizeof(command_ps[0]));
544 put_till_end_and_adv_cursor();
545 /* Last char is still visible, erase it (and more) */
546 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
547 input_backward(cursor - j); /* back to old pos cursor */
550 #if ENABLE_FEATURE_EDITING_VI
551 static void put(void)
554 int j = delptr - delbuf;
559 /* open hole and then fill it */
560 memmove(command_ps + cursor + j, command_ps + cursor,
561 (command_len - cursor + 1) * sizeof(command_ps[0]));
562 memcpy(command_ps + cursor, delbuf, j * sizeof(command_ps[0]));
564 put_till_end_and_adv_cursor();
565 input_backward(cursor - ocursor - j + 1); /* at end of new text */
569 /* Delete the char in back of the cursor */
570 static void input_backspace(void)
578 /* Move forward one character */
579 static void input_forward(void)
581 if (cursor < command_len)
582 put_cur_glyph_and_inc_cursor();
585 #if ENABLE_FEATURE_TAB_COMPLETION
588 //needs to be more clever: currently it thinks that "foo\ b<TAB>
589 //matches the file named "foo bar", which is untrue.
590 //Also, perhaps "foo b<TAB> needs to complete to "foo bar" <cursor>,
591 //not "foo bar <cursor>...
593 static void free_tab_completion_data(void)
597 free(matches[--num_matches]);
603 static void add_match(char *matched)
605 matches = xrealloc_vector(matches, 4, num_matches);
606 matches[num_matches] = matched;
610 # if ENABLE_FEATURE_USERNAME_COMPLETION
611 /* Replace "~user/..." with "/homedir/...".
612 * The parameter is malloced, free it or return it
613 * unchanged if no user is matched.
615 static char *username_path_completion(char *ud)
617 struct passwd *entry;
618 char *tilde_name = ud;
622 if (*ud == '/') { /* "~/..." */
626 ud = strchr(ud, '/');
627 *ud = '\0'; /* "~user" */
628 entry = getpwnam(tilde_name + 1);
629 *ud = '/'; /* restore "~user/..." */
631 home = entry->pw_dir;
634 ud = concat_path_file(home, ud);
641 /* ~use<tab> - find all users with this prefix.
642 * Return the length of the prefix used for matching.
644 static NOINLINE unsigned complete_username(const char *ud)
646 /* Using _r function to avoid pulling in static buffers */
649 struct passwd *result;
653 userlen = strlen(ud);
656 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
657 /* Null usernames should result in all users as possible completions. */
658 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
659 add_match(xasprintf("~%s/", pwd.pw_name));
666 # endif /* FEATURE_USERNAME_COMPLETION */
674 static int path_parse(char ***p)
681 if (state->flags & WITH_PATH_LOOKUP)
682 pth = state->path_lookup;
684 pth = getenv("PATH");
686 /* PATH="" or PATH=":"? */
687 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
691 npth = 1; /* path component count */
693 tmp = strchr(tmp, ':');
698 break; /* :<empty> */
702 *p = res = xmalloc(npth * sizeof(res[0]));
703 res[0] = tmp = xstrdup(pth);
706 tmp = strchr(tmp, ':');
709 *tmp++ = '\0'; /* ':' -> '\0' */
711 break; /* :<empty> */
717 /* Complete command, directory or file name.
718 * Return the length of the prefix used for matching.
720 static NOINLINE unsigned complete_cmd_dir_file(const char *command, int type)
723 char **paths = path1;
731 path1[0] = (char*)".";
733 pfind = strrchr(command, '/');
735 if (type == FIND_EXE_ONLY)
736 npaths = path_parse(&paths);
739 /* point to 'l' in "..../last_component" */
741 /* dirbuf = ".../.../.../" */
742 dirbuf = xstrndup(command, pfind - command);
743 # if ENABLE_FEATURE_USERNAME_COMPLETION
744 if (dirbuf[0] == '~') /* ~/... or ~user/... */
745 dirbuf = username_path_completion(dirbuf);
749 pf_len = strlen(pfind);
751 for (i = 0; i < npaths; i++) {
757 dir = opendir(paths[i]);
759 continue; /* don't print an error */
761 while ((next = readdir(dir)) != NULL) {
763 const char *name_found = next->d_name;
765 /* .../<tab>: bash 3.2.0 shows dotfiles, but not . and .. */
766 if (!pfind[0] && DOT_OR_DOTDOT(name_found))
769 if (strncmp(name_found, pfind, pf_len) != 0)
772 found = concat_path_file(paths[i], name_found);
773 /* NB: stat() first so that we see is it a directory;
774 * but if that fails, use lstat() so that
775 * we still match dangling links */
776 if (stat(found, &st) && lstat(found, &st))
777 goto cont; /* hmm, remove in progress? */
780 len = strlen(name_found);
781 found = xrealloc(found, len + 2); /* +2: for slash and NUL */
782 strcpy(found, name_found);
784 if (S_ISDIR(st.st_mode)) {
785 /* name is a directory, add slash */
787 found[len + 1] = '\0';
789 /* skip files if looking for dirs only (example: cd) */
790 if (type == FIND_DIR_ONLY)
793 /* add it to the list */
800 } /* for every path */
802 if (paths != path1) {
803 free(paths[0]); /* allocated memory is only in first member */
811 /* build_match_prefix:
812 * On entry, match_buf contains everything up to cursor at the moment <tab>
813 * was pressed. This function looks at it, figures out what part of it
814 * constitutes the command/file/directory prefix to use for completion,
815 * and rewrites match_buf to contain only that part.
819 /* QUOT is used on elements of int_buf[], which are bytes,
820 * not Unicode chars. Therefore it works correctly even in Unicode mode.
822 #define QUOT (UCHAR_MAX+1)
823 static void remove_chunk(int16_t *int_buf, int beg, int end)
825 /* beg must be <= end */
829 while ((int_buf[beg] = int_buf[end]) != 0)
834 for (i = 0; int_buf[i]; i++)
835 bb_putchar((unsigned char)int_buf[i]);
839 /* Caller ensures that match_buf points to a malloced buffer
840 * big enough to hold strlen(match_buf)*2 + 2
842 static NOINLINE int build_match_prefix(char *match_buf)
846 int16_t *int_buf = (int16_t*)match_buf;
848 if (dbg_bmp) printf("\n%s\n", match_buf);
850 /* Copy in reverse order, since they overlap */
851 i = strlen(match_buf);
853 int_buf[i] = (unsigned char)match_buf[i];
857 /* Mark every \c as "quoted c" */
858 for (i = 0; int_buf[i]; i++) {
859 if (int_buf[i] == '\\') {
860 remove_chunk(int_buf, i, i + 1);
864 /* Quote-mark "chars" and 'chars', drop delimiters */
869 int cur = int_buf[i];
872 if (cur == '\'' || cur == '"') {
873 if (!in_quote || (cur == in_quote)) {
875 remove_chunk(int_buf, i, i + 1);
880 int_buf[i] = cur | QUOT;
885 /* Remove everything up to command delimiters:
886 * ';' ';;' '&' '|' '&&' '||',
887 * but careful with '>&' '<&' '>|'
889 for (i = 0; int_buf[i]; i++) {
890 int cur = int_buf[i];
891 if (cur == ';' || cur == '&' || cur == '|') {
892 int prev = i ? int_buf[i - 1] : 0;
893 if (cur == '&' && (prev == '>' || prev == '<')) {
895 } else if (cur == '|' && prev == '>') {
898 remove_chunk(int_buf, 0, i + 1 + (cur == int_buf[i + 1]));
899 i = -1; /* back to square 1 */
902 /* Remove all `cmd` */
903 for (i = 0; int_buf[i]; i++) {
904 if (int_buf[i] == '`') {
905 for (j = i + 1; int_buf[j]; j++) {
906 if (int_buf[j] == '`') {
907 /* `cmd` should count as a word:
908 * `cmd` c<tab> should search for files c*,
909 * not commands c*. Therefore we don't drop
910 * `cmd` entirely, we replace it with single `.
912 remove_chunk(int_buf, i, j);
916 /* No closing ` - command mode, remove all up to ` */
917 remove_chunk(int_buf, 0, i + 1);
923 /* Remove "cmd (" and "cmd {"
924 * Example: "if { c<tab>"
925 * In this example, c should be matched as command pfx.
927 for (i = 0; int_buf[i]; i++) {
928 if (int_buf[i] == '(' || int_buf[i] == '{') {
929 remove_chunk(int_buf, 0, i + 1);
930 i = -1; /* back to square 1 */
934 /* Remove leading unquoted spaces */
935 for (i = 0; int_buf[i]; i++)
936 if (int_buf[i] != ' ')
938 remove_chunk(int_buf, 0, i);
940 /* Determine completion mode */
941 command_mode = FIND_EXE_ONLY;
942 for (i = 0; int_buf[i]; i++) {
943 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
944 if (int_buf[i] == ' '
945 && command_mode == FIND_EXE_ONLY
946 && (char)int_buf[0] == 'c'
947 && (char)int_buf[1] == 'd'
948 && i == 2 /* -> int_buf[2] == ' ' */
950 command_mode = FIND_DIR_ONLY;
952 command_mode = FIND_FILE_ONLY;
957 if (dbg_bmp) printf("command_mode(0:exe/1:dir/2:file):%d\n", command_mode);
959 /* Remove everything except last word */
960 for (i = 0; int_buf[i]; i++) /* quasi-strlen(int_buf) */
962 for (--i; i >= 0; i--) {
963 int cur = int_buf[i];
964 if (cur == ' ' || cur == '<' || cur == '>' || cur == '|' || cur == '&') {
965 remove_chunk(int_buf, 0, i + 1);
970 /* Convert back to string of _chars_ */
972 while ((match_buf[i] = int_buf[i]) != '\0')
975 if (dbg_bmp) printf("final match_buf:'%s'\n", match_buf);
981 * Display by column (original idea from ls applet,
982 * very optimized by me [Vladimir] :)
984 static void showfiles(void)
987 int column_width = 0;
988 int nfiles = num_matches;
992 /* find the longest file name - use that as the column width */
993 for (row = 0; row < nrows; row++) {
994 l = unicode_strwidth(matches[row]);
995 if (column_width < l)
998 column_width += 2; /* min space for columns */
999 ncols = cmdedit_termw / column_width;
1004 nrows++; /* round up fractionals */
1008 for (row = 0; row < nrows; row++) {
1012 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1013 printf("%s%-*s", matches[n],
1014 (int)(column_width - unicode_strwidth(matches[n])), ""
1017 if (ENABLE_UNICODE_SUPPORT)
1018 puts(printable_string(NULL, matches[n]));
1024 static const char *is_special_char(char c)
1026 return strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", c);
1029 static char *quote_special_chars(char *found)
1032 char *s = xzalloc((strlen(found) + 1) * 2);
1035 if (is_special_char(*found))
1039 /* s[l] = '\0'; - already is */
1043 /* Do TAB completion */
1044 static NOINLINE void input_tab(smallint *lastWasTab)
1049 /* Length of string used for matching */
1050 unsigned match_pfx_len = match_pfx_len;
1052 # if ENABLE_UNICODE_SUPPORT
1053 /* cursor pos in command converted to multibyte form */
1056 if (!(state->flags & TAB_COMPLETION))
1060 /* The last char was a TAB too.
1061 * Print a list of all the available choices.
1063 if (num_matches > 0) {
1064 /* cursor will be changed by goto_new_line() */
1065 int sav_cursor = cursor;
1068 redraw(0, command_len - sav_cursor);
1074 chosen_match = NULL;
1076 /* Make a local copy of the string up to the position of the cursor.
1077 * build_match_prefix will expand it into int16_t's, need to allocate
1078 * twice as much as the string_len+1.
1079 * (we then also (ab)use this extra space later - see (**))
1081 match_buf = xmalloc(MAX_LINELEN * sizeof(int16_t));
1082 # if !ENABLE_UNICODE_SUPPORT
1083 save_string(match_buf, cursor + 1); /* +1 for NUL */
1086 CHAR_T wc = command_ps[cursor];
1087 command_ps[cursor] = BB_NUL;
1088 save_string(match_buf, MAX_LINELEN);
1089 command_ps[cursor] = wc;
1090 cursor_mb = strlen(match_buf);
1093 find_type = build_match_prefix(match_buf);
1095 /* Free up any memory already allocated */
1096 free_tab_completion_data();
1098 # if ENABLE_FEATURE_USERNAME_COMPLETION
1099 /* If the word starts with ~ and there is no slash in the word,
1100 * then try completing this word as a username. */
1101 if (state->flags & USERNAME_COMPLETION)
1102 if (match_buf[0] == '~' && strchr(match_buf, '/') == NULL)
1103 match_pfx_len = complete_username(match_buf);
1105 /* If complete_username() did not match,
1106 * try to match a command in $PATH, or a directory, or a file */
1108 match_pfx_len = complete_cmd_dir_file(match_buf, find_type);
1110 /* Account for backslashes which will be inserted
1111 * by quote_special_chars() later */
1113 const char *e = match_buf + strlen(match_buf);
1114 const char *s = e - match_pfx_len;
1116 if (is_special_char(*s++))
1120 /* Remove duplicates */
1123 qsort_string_vector(matches, num_matches);
1124 for (i = 0; i < num_matches - 1; ++i) {
1125 //if (matches[i] && matches[i+1]) { /* paranoia */
1126 if (strcmp(matches[i], matches[i+1]) == 0) {
1128 //matches[i] = NULL; /* paranoia */
1130 matches[n++] = matches[i];
1134 matches[n++] = matches[i];
1138 /* Did we find exactly one match? */
1139 if (num_matches != 1) { /* no */
1143 goto ret; /* no matches at all */
1144 /* Find common prefix */
1145 chosen_match = xstrdup(matches[0]);
1146 for (cp = chosen_match; *cp; cp++) {
1148 for (n = 1; n < num_matches; n++) {
1149 if (matches[n][cp - chosen_match] != *cp) {
1155 if (cp == chosen_match) { /* have unique prefix? */
1159 cp = quote_special_chars(chosen_match);
1162 len_found = strlen(chosen_match);
1163 } else { /* exactly one match */
1164 /* Next <tab> is not a double-tab */
1167 chosen_match = quote_special_chars(matches[0]);
1168 len_found = strlen(chosen_match);
1169 if (chosen_match[len_found-1] != '/') {
1170 chosen_match[len_found] = ' ';
1171 chosen_match[++len_found] = '\0';
1175 # if !ENABLE_UNICODE_SUPPORT
1176 /* Have space to place the match? */
1177 /* The result consists of three parts with these lengths: */
1178 /* cursor + (len_found - match_pfx_len) + (command_len - cursor) */
1179 /* it simplifies into: */
1180 if ((int)(len_found - match_pfx_len + command_len) < S.maxsize) {
1183 strcpy(match_buf, &command_ps[cursor]);
1184 /* add match and tail */
1185 sprintf(&command_ps[cursor], "%s%s", chosen_match + match_pfx_len, match_buf);
1186 command_len = strlen(command_ps);
1188 pos = cursor + len_found - match_pfx_len;
1189 /* write out the matched command */
1190 redraw(cmdedit_y, command_len - pos);
1194 /* Use 2nd half of match_buf as scratch space - see (**) */
1195 char *command = match_buf + MAX_LINELEN;
1196 int len = save_string(command, MAX_LINELEN);
1197 /* Have space to place the match? */
1198 /* cursor_mb + (len_found - match_pfx_len) + (len - cursor_mb) */
1199 if ((int)(len_found - match_pfx_len + len) < MAX_LINELEN) {
1202 strcpy(match_buf, &command[cursor_mb]);
1203 /* where do we want to have cursor after all? */
1204 strcpy(&command[cursor_mb], chosen_match + match_pfx_len);
1205 len = load_string(command, S.maxsize);
1206 /* add match and tail */
1207 sprintf(&command[cursor_mb], "%s%s", chosen_match + match_pfx_len, match_buf);
1208 command_len = load_string(command, S.maxsize);
1209 /* write out the matched command */
1210 /* paranoia: load_string can return 0 on conv error,
1211 * prevent passing pos = (0 - 12) to redraw */
1212 pos = command_len - len;
1213 redraw(cmdedit_y, pos >= 0 ? pos : 0);
1222 #endif /* FEATURE_TAB_COMPLETION */
1225 line_input_t* FAST_FUNC new_line_input_t(int flags)
1227 line_input_t *n = xzalloc(sizeof(*n));
1235 static void save_command_ps_at_cur_history(void)
1237 if (command_ps[0] != BB_NUL) {
1238 int cur = state->cur_history;
1239 free(state->history[cur]);
1241 # if ENABLE_UNICODE_SUPPORT
1243 char tbuf[MAX_LINELEN];
1244 save_string(tbuf, sizeof(tbuf));
1245 state->history[cur] = xstrdup(tbuf);
1248 state->history[cur] = xstrdup(command_ps);
1253 /* state->flags is already checked to be nonzero */
1254 static int get_previous_history(void)
1256 if ((state->flags & DO_HISTORY) && state->cur_history) {
1257 save_command_ps_at_cur_history();
1258 state->cur_history--;
1265 static int get_next_history(void)
1267 if (state->flags & DO_HISTORY) {
1268 if (state->cur_history < state->cnt_history) {
1269 save_command_ps_at_cur_history(); /* save the current history line */
1270 return ++state->cur_history;
1277 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1278 /* We try to ensure that concurrent additions to the history
1279 * do not overwrite each other.
1280 * Otherwise shell users get unhappy.
1282 * History file is trimmed lazily, when it grows several times longer
1283 * than configured MAX_HISTORY lines.
1286 static void free_line_input_t(line_input_t *n)
1288 int i = n->cnt_history;
1290 free(n->history[--i]);
1294 /* state->flags is already checked to be nonzero */
1295 static void load_history(line_input_t *st_parm)
1297 char *temp_h[MAX_HISTORY];
1300 unsigned idx, i, line_len;
1302 /* NB: do not trash old history if file can't be opened */
1304 fp = fopen_for_read(st_parm->hist_file);
1306 /* clean up old history */
1307 for (idx = st_parm->cnt_history; idx > 0;) {
1309 free(st_parm->history[idx]);
1310 st_parm->history[idx] = NULL;
1313 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1314 memset(temp_h, 0, sizeof(temp_h));
1315 st_parm->cnt_history_in_file = idx = 0;
1316 while ((line = xmalloc_fgetline(fp)) != NULL) {
1317 if (line[0] == '\0') {
1323 st_parm->cnt_history_in_file++;
1325 if (idx == MAX_HISTORY)
1330 /* find first non-NULL temp_h[], if any */
1331 if (st_parm->cnt_history_in_file) {
1332 while (temp_h[idx] == NULL) {
1334 if (idx == MAX_HISTORY)
1339 /* copy temp_h[] to st_parm->history[] */
1340 for (i = 0; i < MAX_HISTORY;) {
1345 if (idx == MAX_HISTORY)
1347 line_len = strlen(line);
1348 if (line_len >= MAX_LINELEN)
1349 line[MAX_LINELEN-1] = '\0';
1350 st_parm->history[i++] = line;
1352 st_parm->cnt_history = i;
1356 /* state->flags is already checked to be nonzero */
1357 static void save_history(char *str)
1362 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0600);
1365 xlseek(fd, 0, SEEK_END); /* paranoia */
1367 str[len] = '\n'; /* we (try to) do atomic write */
1368 len2 = full_write(fd, str, len + 1);
1371 if (len2 != len + 1)
1372 return; /* "wtf?" */
1374 /* did we write so much that history file needs trimming? */
1375 state->cnt_history_in_file++;
1376 if (state->cnt_history_in_file > MAX_HISTORY * 4) {
1378 line_input_t *st_temp;
1380 /* we may have concurrently written entries from others.
1382 st_temp = new_line_input_t(state->flags);
1383 st_temp->hist_file = state->hist_file;
1384 load_history(st_temp);
1386 /* write out temp file and replace hist_file atomically */
1387 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1388 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_TRUNC, 0600);
1393 fp = xfdopen_for_write(fd);
1394 for (i = 0; i < st_temp->cnt_history; i++)
1395 fprintf(fp, "%s\n", st_temp->history[i]);
1397 if (rename(new_name, state->hist_file) == 0)
1398 state->cnt_history_in_file = st_temp->cnt_history;
1401 free_line_input_t(st_temp);
1405 # define load_history(a) ((void)0)
1406 # define save_history(a) ((void)0)
1407 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1409 static void remember_in_history(char *str)
1413 if (!(state->flags & DO_HISTORY))
1417 i = state->cnt_history;
1418 /* Don't save dupes */
1419 if (i && strcmp(state->history[i-1], str) == 0)
1422 free(state->history[MAX_HISTORY]); /* redundant, paranoia */
1423 state->history[MAX_HISTORY] = NULL; /* redundant, paranoia */
1425 /* If history[] is full, remove the oldest command */
1426 /* we need to keep history[MAX_HISTORY] empty, hence >=, not > */
1427 if (i >= MAX_HISTORY) {
1428 free(state->history[0]);
1429 for (i = 0; i < MAX_HISTORY-1; i++)
1430 state->history[i] = state->history[i+1];
1431 /* i == MAX_HISTORY-1 */
1433 /* i <= MAX_HISTORY-1 */
1434 state->history[i++] = xstrdup(str);
1435 /* i <= MAX_HISTORY */
1436 state->cur_history = i;
1437 state->cnt_history = i;
1438 # if MAX_HISTORY > 0 && ENABLE_FEATURE_EDITING_SAVEHISTORY
1439 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1442 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1445 #else /* MAX_HISTORY == 0 */
1446 # define remember_in_history(a) ((void)0)
1447 #endif /* MAX_HISTORY */
1450 #if ENABLE_FEATURE_EDITING_VI
1452 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1455 vi_Word_motion(int eat)
1457 CHAR_T *command = command_ps;
1459 while (cursor < command_len && !BB_isspace(command[cursor]))
1461 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1466 vi_word_motion(int eat)
1468 CHAR_T *command = command_ps;
1470 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1471 while (cursor < command_len
1472 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1476 } else if (BB_ispunct(command[cursor])) {
1477 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1481 if (cursor < command_len)
1485 while (cursor < command_len && BB_isspace(command[cursor]))
1493 CHAR_T *command = command_ps;
1496 while (cursor < command_len && BB_isspace(command[cursor]))
1498 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1505 CHAR_T *command = command_ps;
1507 if (cursor >= command_len-1)
1510 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1512 if (cursor >= command_len-1)
1514 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1515 while (cursor < command_len-1
1516 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1520 } else if (BB_ispunct(command[cursor])) {
1521 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1527 vi_Back_motion(void)
1529 CHAR_T *command = command_ps;
1531 while (cursor > 0 && BB_isspace(command[cursor-1]))
1533 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1538 vi_back_motion(void)
1540 CHAR_T *command = command_ps;
1545 while (cursor > 0 && BB_isspace(command[cursor]))
1549 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1551 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1555 } else if (BB_ispunct(command[cursor])) {
1556 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1562 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1563 static void ctrl_left(void)
1565 CHAR_T *command = command_ps;
1573 c = command[cursor];
1574 if (c != ' ' && !BB_ispunct(c)) {
1575 /* we reached a "word" delimited by spaces/punct.
1576 * go to its beginning */
1578 c = command[cursor - 1];
1579 if (c == ' ' || BB_ispunct(c))
1589 static void ctrl_right(void)
1591 CHAR_T *command = command_ps;
1596 c = command[cursor];
1599 if (c != ' ' && !BB_ispunct(c)) {
1600 /* we reached a "word" delimited by spaces/punct.
1601 * go to its end + 1 */
1604 c = command[cursor];
1605 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1616 * read_line_input and its helpers
1619 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1620 static void ask_terminal(void)
1622 /* Ask terminal where is the cursor now.
1623 * lineedit_read_key handles response and corrects
1624 * our idea of current cursor position.
1625 * Testcase: run "echo -n long_line_long_line_long_line",
1626 * then type in a long, wrapping command and try to
1627 * delete it using backspace key.
1628 * Note: we print it _after_ prompt, because
1629 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1631 /* Problem: if there is buffered input on stdin,
1632 * the response will be delivered later,
1633 * possibly to an unsuspecting application.
1634 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1636 * ~/srcdevel/bbox/fix/busybox.t4 #
1637 * ~/srcdevel/bbox/fix/busybox.t4 #
1638 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1639 * ~/srcdevel/bbox/fix/busybox.t4 #
1641 * Checking for input with poll only makes the race narrower,
1642 * I still can trigger it. Strace:
1644 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1645 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1646 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1647 * poll([{fd=0, events=POLLIN}], 1, 4294967295) = 1 ([{fd=0, revents=POLLIN}])
1648 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1652 pfd.fd = STDIN_FILENO;
1653 pfd.events = POLLIN;
1654 if (safe_poll(&pfd, 1, 0) == 0) {
1655 S.sent_ESC_br6n = 1;
1656 fputs(ESC"[6n", stdout);
1657 fflush_all(); /* make terminal see it ASAP! */
1661 #define ask_terminal() ((void)0)
1664 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1665 static void parse_and_put_prompt(const char *prmt_ptr)
1667 cmdedit_prompt = prmt_ptr;
1668 cmdedit_prmt_len = strlen(prmt_ptr);
1672 static void parse_and_put_prompt(const char *prmt_ptr)
1675 size_t cur_prmt_len = 0;
1676 char flg_not_length = '[';
1677 char *prmt_mem_ptr = xzalloc(1);
1678 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1683 cmdedit_prmt_len = 0;
1686 cwd_buf = (char *)bb_msg_unknown;
1689 cbuf[1] = '\0'; /* never changes */
1692 char *free_me = NULL;
1697 const char *cp = prmt_ptr;
1700 c = bb_process_escape_sequence(&prmt_ptr);
1701 if (prmt_ptr == cp) {
1707 # if ENABLE_USERNAME_OR_HOMEDIR
1709 pbuf = user_buf ? user_buf : (char*)"";
1713 pbuf = free_me = safe_gethostname();
1714 *strchrnul(pbuf, '.') = '\0';
1717 c = (geteuid() == 0 ? '#' : '$');
1719 # if ENABLE_USERNAME_OR_HOMEDIR
1721 /* /home/user[/something] -> ~[/something] */
1723 l = strlen(home_pwd_buf);
1725 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1726 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1727 && strlen(cwd_buf + l) < PATH_MAX
1729 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1735 cp = strrchr(pbuf, '/');
1736 if (cp != NULL && cp != pbuf)
1737 pbuf += (cp-pbuf) + 1;
1740 pbuf = free_me = xasprintf("%d", num_ok_lines);
1742 case 'e': case 'E': /* \e \E = \033 */
1745 case 'x': case 'X': {
1747 for (l = 0; l < 3;) {
1749 buf2[l++] = *prmt_ptr;
1751 h = strtoul(buf2, &pbuf, 16);
1752 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1758 c = (char)strtoul(buf2, NULL, 16);
1765 if (c == flg_not_length) {
1766 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1774 cur_prmt_len = strlen(pbuf);
1775 prmt_len += cur_prmt_len;
1776 if (flg_not_length != ']')
1777 cmdedit_prmt_len += cur_prmt_len;
1778 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1782 if (cwd_buf != (char *)bb_msg_unknown)
1784 cmdedit_prompt = prmt_mem_ptr;
1789 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1793 /* new y for current cursor */
1794 int new_y = (cursor + cmdedit_prmt_len) / w;
1796 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1801 static void win_changed(int nsig)
1803 int sv_errno = errno;
1805 get_terminal_width_height(0, &width, NULL);
1806 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1807 if (nsig == SIGWINCH)
1808 signal(SIGWINCH, win_changed); /* rearm ourself */
1812 static int lineedit_read_key(char *read_key_buffer)
1816 #if ENABLE_UNICODE_SUPPORT
1817 char unicode_buf[MB_CUR_MAX + 1];
1818 int unicode_idx = 0;
1822 /* Wait for input. TIMEOUT = -1 makes read_key wait even
1823 * on nonblocking stdin, TIMEOUT = 50 makes sure we won't
1824 * insist on full MB_CUR_MAX buffer to declare input like
1825 * "\xff\n",pause,"ls\n" invalid and thus won't lose "ls".
1827 * Note: read_key sets errno to 0 on success.
1829 ic = read_key(STDIN_FILENO, read_key_buffer, timeout);
1831 #if ENABLE_UNICODE_SUPPORT
1832 if (errno == EAGAIN && unicode_idx != 0)
1838 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1839 if ((int32_t)ic == KEYCODE_CURSOR_POS
1842 S.sent_ESC_br6n = 0;
1843 if (cursor == 0) { /* otherwise it may be bogus */
1844 int col = ((ic >> 32) & 0x7fff) - 1;
1845 if (col > cmdedit_prmt_len) {
1846 cmdedit_x += (col - cmdedit_prmt_len);
1847 while (cmdedit_x >= cmdedit_termw) {
1848 cmdedit_x -= cmdedit_termw;
1857 #if ENABLE_UNICODE_SUPPORT
1858 if (unicode_status == UNICODE_ON) {
1861 if ((int32_t)ic < 0) /* KEYCODE_xxx */
1863 // TODO: imagine sequence like: 0xff,<left-arrow>: we are currently losing 0xff...
1865 unicode_buf[unicode_idx++] = ic;
1866 unicode_buf[unicode_idx] = '\0';
1867 if (mbstowcs(&wc, unicode_buf, 1) != 1) {
1868 /* Not (yet?) a valid unicode char */
1869 if (unicode_idx < MB_CUR_MAX) {
1874 /* Invalid sequence. Save all "bad bytes" except first */
1875 read_key_ungets(read_key_buffer, unicode_buf + 1, unicode_idx - 1);
1876 # if !ENABLE_UNICODE_PRESERVE_BROKEN
1877 ic = CONFIG_SUBST_WCHAR;
1879 ic = unicode_mark_raw_byte(unicode_buf[0]);
1882 /* Valid unicode char, return its code */
1893 #if ENABLE_UNICODE_BIDI_SUPPORT
1894 static int isrtl_str(void)
1898 while (idx < command_len && unicode_bidi_is_neutral_wchar(command_ps[idx]))
1900 return unicode_bidi_isrtl(command_ps[idx]);
1903 # define isrtl_str() 0
1906 /* leave out the "vi-mode"-only case labels if vi editing isn't
1908 #define vi_case(caselabel) IF_FEATURE_EDITING_VI(case caselabel)
1910 /* convert uppercase ascii to equivalent control char, for readability */
1912 #define CTRL(a) ((a) & ~0x40)
1914 /* maxsize must be >= 2.
1916 * -1 on read errors or EOF, or on bare Ctrl-D,
1917 * 0 on ctrl-C (the line entered is still returned in 'command'),
1918 * >0 length of input string, including terminating '\n'
1920 int FAST_FUNC read_line_input(const char *prompt, char *command, int maxsize, line_input_t *st)
1923 #if ENABLE_FEATURE_TAB_COMPLETION
1924 smallint lastWasTab = 0;
1926 smallint break_out = 0;
1927 #if ENABLE_FEATURE_EDITING_VI
1928 smallint vi_cmdmode = 0;
1930 struct termios initial_settings;
1931 struct termios new_settings;
1932 char read_key_buffer[KEYCODE_BUFFER_SIZE];
1936 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
1937 || !(initial_settings.c_lflag & ECHO)
1939 /* Happens when e.g. stty -echo was run before */
1940 parse_and_put_prompt(prompt);
1941 /* fflush_all(); - done by parse_and_put_prompt */
1942 if (fgets(command, maxsize, stdin) == NULL)
1943 len = -1; /* EOF or error */
1945 len = strlen(command);
1952 // FIXME: audit & improve this
1953 if (maxsize > MAX_LINELEN)
1954 maxsize = MAX_LINELEN;
1955 S.maxsize = maxsize;
1957 /* With null flags, no other fields are ever used */
1958 state = st ? st : (line_input_t*) &const_int_0;
1960 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1961 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1962 if (state->cnt_history == 0)
1963 load_history(state);
1965 if (state->flags & DO_HISTORY)
1966 state->cur_history = state->cnt_history;
1969 /* prepare before init handlers */
1970 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
1972 #if ENABLE_UNICODE_SUPPORT
1973 command_ps = xzalloc(maxsize * sizeof(command_ps[0]));
1975 command_ps = command;
1978 #define command command_must_not_be_used
1980 new_settings = initial_settings;
1981 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
1982 /* Turn off echoing and CTRL-C, so we can trap it */
1983 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
1984 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
1985 new_settings.c_cc[VMIN] = 1;
1986 new_settings.c_cc[VTIME] = 0;
1987 /* Turn off CTRL-C, so we can trap it */
1988 #ifndef _POSIX_VDISABLE
1989 # define _POSIX_VDISABLE '\0'
1991 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
1992 tcsetattr_stdin_TCSANOW(&new_settings);
1994 /* Now initialize things */
1995 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
1996 win_changed(0); /* do initial resizing */
1997 #if ENABLE_USERNAME_OR_HOMEDIR
1999 struct passwd *entry;
2001 entry = getpwuid(geteuid());
2003 user_buf = xstrdup(entry->pw_name);
2004 home_pwd_buf = xstrdup(entry->pw_dir);
2010 for (i = 0; i <= MAX_HISTORY; i++)
2011 bb_error_msg("history[%d]:'%s'", i, state->history[i]);
2012 bb_error_msg("cur_history:%d cnt_history:%d", state->cur_history, state->cnt_history);
2015 /* Print out the command prompt, optionally ask where cursor is */
2016 parse_and_put_prompt(prompt);
2019 read_key_buffer[0] = 0;
2022 * The emacs and vi modes share much of the code in the big
2023 * command loop. Commands entered when in vi's command mode
2024 * (aka "escape mode") get an extra bit added to distinguish
2025 * them - this keeps them from being self-inserted. This
2026 * clutters the big switch a bit, but keeps all the code
2030 VI_CMDMODE_BIT = 0x40000000,
2031 /* 0x80000000 bit flags KEYCODE_xxx */
2036 ic = ic_raw = lineedit_read_key(read_key_buffer);
2038 #if ENABLE_FEATURE_EDITING_VI
2041 /* btw, since KEYCODE_xxx are all < 0, this doesn't
2042 * change ic if it contains one of them: */
2043 ic |= VI_CMDMODE_BIT;
2050 vi_case('\n'|VI_CMDMODE_BIT:)
2051 vi_case('\r'|VI_CMDMODE_BIT:)
2057 vi_case('0'|VI_CMDMODE_BIT:)
2058 /* Control-a -- Beginning of line */
2059 input_backward(cursor);
2062 vi_case('h'|VI_CMDMODE_BIT:)
2063 vi_case('\b'|VI_CMDMODE_BIT:) /* ^H */
2064 vi_case('\x7f'|VI_CMDMODE_BIT:) /* DEL */
2065 input_backward(1); /* Move back one character */
2068 vi_case('$'|VI_CMDMODE_BIT:)
2069 /* Control-e -- End of line */
2070 put_till_end_and_adv_cursor();
2073 vi_case('l'|VI_CMDMODE_BIT:)
2074 vi_case(' '|VI_CMDMODE_BIT:)
2075 input_forward(); /* Move forward one character */
2078 case '\x7f': /* DEL */
2084 case KEYCODE_DELETE:
2090 #if ENABLE_FEATURE_TAB_COMPLETION
2092 input_tab(&lastWasTab);
2096 /* Control-k -- clear to end of line */
2097 command_ps[cursor] = BB_NUL;
2098 command_len = cursor;
2099 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
2102 vi_case(CTRL('L')|VI_CMDMODE_BIT:)
2103 /* Control-l -- clear screen */
2104 printf(ESC"[H"); /* cursor to top,left */
2105 redraw(0, command_len - cursor);
2109 vi_case(CTRL('N')|VI_CMDMODE_BIT:)
2110 vi_case('j'|VI_CMDMODE_BIT:)
2111 /* Control-n -- Get next command in history */
2112 if (get_next_history())
2116 vi_case(CTRL('P')|VI_CMDMODE_BIT:)
2117 vi_case('k'|VI_CMDMODE_BIT:)
2118 /* Control-p -- Get previous command from history */
2119 if (get_previous_history())
2124 vi_case(CTRL('U')|VI_CMDMODE_BIT:)
2125 /* Control-U -- Clear line before cursor */
2127 command_len -= cursor;
2128 memmove(command_ps, command_ps + cursor,
2129 (command_len + 1) * sizeof(command_ps[0]));
2130 redraw(cmdedit_y, command_len);
2134 vi_case(CTRL('W')|VI_CMDMODE_BIT:)
2135 /* Control-W -- Remove the last word */
2136 while (cursor > 0 && BB_isspace(command_ps[cursor-1]))
2138 while (cursor > 0 && !BB_isspace(command_ps[cursor-1]))
2142 #if ENABLE_FEATURE_EDITING_VI
2143 case 'i'|VI_CMDMODE_BIT:
2146 case 'I'|VI_CMDMODE_BIT:
2147 input_backward(cursor);
2150 case 'a'|VI_CMDMODE_BIT:
2154 case 'A'|VI_CMDMODE_BIT:
2155 put_till_end_and_adv_cursor();
2158 case 'x'|VI_CMDMODE_BIT:
2161 case 'X'|VI_CMDMODE_BIT:
2167 case 'W'|VI_CMDMODE_BIT:
2170 case 'w'|VI_CMDMODE_BIT:
2173 case 'E'|VI_CMDMODE_BIT:
2176 case 'e'|VI_CMDMODE_BIT:
2179 case 'B'|VI_CMDMODE_BIT:
2182 case 'b'|VI_CMDMODE_BIT:
2185 case 'C'|VI_CMDMODE_BIT:
2188 case 'D'|VI_CMDMODE_BIT:
2191 case 'c'|VI_CMDMODE_BIT:
2194 case 'd'|VI_CMDMODE_BIT: {
2197 ic = lineedit_read_key(read_key_buffer);
2198 if (errno) /* error */
2199 goto return_error_indicator;
2200 if (ic == ic_raw) { /* "cc", "dd" */
2201 input_backward(cursor);
2213 case 'w': /* "dw", "cw" */
2214 vi_word_motion(vi_cmdmode);
2216 case 'W': /* 'dW', 'cW' */
2217 vi_Word_motion(vi_cmdmode);
2219 case 'e': /* 'de', 'ce' */
2223 case 'E': /* 'dE', 'cE' */
2229 input_backward(cursor - sc);
2230 while (nc-- > cursor)
2233 case 'b': /* "db", "cb" */
2234 case 'B': /* implemented as B */
2239 while (sc-- > cursor)
2242 case ' ': /* "d ", "c " */
2245 case '$': /* "d$", "c$" */
2247 while (cursor < command_len)
2253 case 'p'|VI_CMDMODE_BIT:
2256 case 'P'|VI_CMDMODE_BIT:
2259 case 'r'|VI_CMDMODE_BIT:
2260 //FIXME: unicode case?
2261 ic = lineedit_read_key(read_key_buffer);
2262 if (errno) /* error */
2263 goto return_error_indicator;
2264 if (ic < ' ' || ic > 255) {
2267 command_ps[cursor] = ic;
2272 case '\x1b': /* ESC */
2273 if (state->flags & VI_MODE) {
2274 /* insert mode --> command mode */
2279 #endif /* FEATURE_COMMAND_EDITING_VI */
2283 if (get_previous_history())
2288 if (!get_next_history())
2291 /* Rewrite the line with the selected history item */
2292 /* change command */
2293 command_len = load_string(state->history[state->cur_history] ?
2294 state->history[state->cur_history] : "", maxsize);
2295 /* redraw and go to eol (bol, in vi) */
2296 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
2305 case KEYCODE_CTRL_LEFT:
2308 case KEYCODE_CTRL_RIGHT:
2312 input_backward(cursor);
2315 put_till_end_and_adv_cursor();
2319 if (initial_settings.c_cc[VINTR] != 0
2320 && ic_raw == initial_settings.c_cc[VINTR]
2322 /* Ctrl-C (usually) - stop gathering input */
2325 break_out = -1; /* "do not append '\n'" */
2328 if (initial_settings.c_cc[VEOF] != 0
2329 && ic_raw == initial_settings.c_cc[VEOF]
2331 /* Ctrl-D (usually) - delete one character,
2332 * or exit if len=0 and no chars to delete */
2333 if (command_len == 0) {
2336 case -1: /* error (e.g. EIO when tty is destroyed) */
2337 IF_FEATURE_EDITING_VI(return_error_indicator:)
2338 break_out = command_len = -1;
2344 // /* Control-V -- force insert of next char */
2345 // if (c == CTRL('V')) {
2346 // if (safe_read(STDIN_FILENO, &c, 1) < 1)
2347 // goto return_error_indicator;
2354 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2355 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2357 /* If VI_CMDMODE_BIT is set, ic is >= 256
2358 * and vi mode ignores unexpected chars.
2359 * Otherwise, we are here if ic is a
2360 * control char or an unhandled ESC sequence,
2361 * which is also ignored.
2365 if ((int)command_len >= (maxsize - 2)) {
2366 /* Not enough space for the char and EOL */
2371 if (cursor == (command_len - 1)) {
2372 /* We are at the end, append */
2373 command_ps[cursor] = ic;
2374 command_ps[cursor + 1] = BB_NUL;
2375 put_cur_glyph_and_inc_cursor();
2376 if (unicode_bidi_isrtl(ic))
2379 /* In the middle, insert */
2382 memmove(command_ps + sc + 1, command_ps + sc,
2383 (command_len - sc) * sizeof(command_ps[0]));
2384 command_ps[sc] = ic;
2385 /* is right-to-left char, or neutral one (e.g. comma) was just added to rtl text? */
2388 put_till_end_and_adv_cursor();
2389 /* to prev x pos + 1 */
2390 input_backward(cursor - sc);
2398 #if ENABLE_FEATURE_TAB_COMPLETION
2404 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
2405 if (S.sent_ESC_br6n) {
2406 /* "sleep 1; busybox ash" + hold [Enter] to trigger.
2407 * We sent "ESC [ 6 n", but got '\n' first, and
2408 * KEYCODE_CURSOR_POS response is now buffered from terminal.
2409 * It's bad already and not much can be done with it
2410 * (it _will_ be visible for the next process to read stdin),
2411 * but without this delay it even shows up on the screen
2412 * as garbage because we restore echo settings with tcsetattr
2413 * before it comes in. UGLY!
2419 /* End of bug-catching "command_must_not_be_used" trick */
2422 #if ENABLE_UNICODE_SUPPORT
2424 if (command_len > 0)
2425 command_len = save_string(command, maxsize - 1);
2429 if (command_len > 0)
2430 remember_in_history(command);
2432 if (break_out > 0) {
2433 command[command_len++] = '\n';
2434 command[command_len] = '\0';
2437 #if ENABLE_FEATURE_TAB_COMPLETION
2438 free_tab_completion_data();
2441 /* restore initial_settings */
2442 tcsetattr_stdin_TCSANOW(&initial_settings);
2443 /* restore SIGWINCH handler */
2444 signal(SIGWINCH, previous_SIGWINCH_handler);
2450 return len; /* can't return command_len, DEINIT_S() destroys it */
2453 #else /* !FEATURE_EDITING */
2455 #undef read_line_input
2456 int FAST_FUNC read_line_input(const char* prompt, char* command, int maxsize)
2458 fputs(prompt, stdout);
2460 fgets(command, maxsize, stdin);
2461 return strlen(command);
2464 #endif /* !FEATURE_EDITING */
2475 const char *applet_name = "debug stuff usage";
2477 int main(int argc, char **argv)
2479 char buff[MAX_LINELEN];
2481 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
2482 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
2483 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
2484 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
2491 l = read_line_input(prompt, buff);
2492 if (l <= 0 || buff[l-1] != '\n')
2495 printf("*** read_line_input() returned line =%s=\n", buff);
2497 printf("*** read_line_input() detect ^D\n");