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
97 #define SEQ_CLEAR_TILL_END_OF_SCREEN "\033[J"
98 //#define SEQ_CLEAR_TILL_END_OF_LINE "\033[K"
102 MAX_LINELEN = CONFIG_FEATURE_EDITING_MAX_LEN < 0x7ff0
103 ? CONFIG_FEATURE_EDITING_MAX_LEN
107 #if ENABLE_USERNAME_OR_HOMEDIR
108 static const char null_str[] ALIGN1 = "";
111 /* We try to minimize both static and stack usage. */
112 struct lineedit_statics {
115 volatile unsigned cmdedit_termw; /* = 80; */ /* actual terminal width */
116 sighandler_t previous_SIGWINCH_handler;
118 unsigned cmdedit_x; /* real x (col) terminal position */
119 unsigned cmdedit_y; /* pseudoreal y (row) terminal position */
120 unsigned cmdedit_prmt_len; /* length of prompt (without colors etc) */
123 int command_len; /* must be signed */
124 /* signed maxsize: we want x in "if (x > S.maxsize)"
125 * to _not_ be promoted to unsigned */
129 const char *cmdedit_prompt;
130 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
131 int num_ok_lines; /* = 1; */
134 #if ENABLE_USERNAME_OR_HOMEDIR
136 char *home_pwd_buf; /* = (char*)null_str; */
139 #if ENABLE_FEATURE_TAB_COMPLETION
141 unsigned num_matches;
144 #if ENABLE_FEATURE_EDITING_VI
145 # define DELBUFSIZ 128
147 smallint newdelflag; /* whether delbuf should be reused yet */
148 CHAR_T delbuf[DELBUFSIZ]; /* a place to store deleted characters */
150 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
151 smallint sent_ESC_br6n;
155 /* See lineedit_ptr_hack.c */
156 extern struct lineedit_statics *const lineedit_ptr_to_statics;
158 #define S (*lineedit_ptr_to_statics)
159 #define state (S.state )
160 #define cmdedit_termw (S.cmdedit_termw )
161 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
162 #define cmdedit_x (S.cmdedit_x )
163 #define cmdedit_y (S.cmdedit_y )
164 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
165 #define cursor (S.cursor )
166 #define command_len (S.command_len )
167 #define command_ps (S.command_ps )
168 #define cmdedit_prompt (S.cmdedit_prompt )
169 #define num_ok_lines (S.num_ok_lines )
170 #define user_buf (S.user_buf )
171 #define home_pwd_buf (S.home_pwd_buf )
172 #define matches (S.matches )
173 #define num_matches (S.num_matches )
174 #define delptr (S.delptr )
175 #define newdelflag (S.newdelflag )
176 #define delbuf (S.delbuf )
178 #define INIT_S() do { \
179 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
181 cmdedit_termw = 80; \
182 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
183 IF_USERNAME_OR_HOMEDIR(home_pwd_buf = (char*)null_str;) \
185 static void deinit_S(void)
187 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
188 /* This one is allocated only if FANCY_PROMPT is on
189 * (otherwise it points to verbatim prompt (NOT malloced)) */
190 free((char*)cmdedit_prompt);
192 #if ENABLE_USERNAME_OR_HOMEDIR
194 if (home_pwd_buf != null_str)
197 free(lineedit_ptr_to_statics);
199 #define DEINIT_S() deinit_S()
202 #if ENABLE_UNICODE_SUPPORT
203 static size_t load_string(const char *src, int maxsize)
205 ssize_t len = mbstowcs(command_ps, src, maxsize - 1);
208 command_ps[len] = BB_NUL;
211 static unsigned save_string(char *dst, unsigned maxsize)
213 # if !ENABLE_UNICODE_PRESERVE_BROKEN
214 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
224 while (dstpos < maxsize) {
228 /* Convert up to 1st invalid byte (or up to end) */
229 while ((wc = command_ps[srcpos]) != BB_NUL
230 && !unicode_is_raw_byte(wc)
234 command_ps[srcpos] = BB_NUL;
235 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
236 if (n < 0) /* should not happen */
239 if (wc == BB_NUL) /* usually is */
242 /* We do have invalid byte here! */
243 command_ps[srcpos] = wc; /* restore it */
245 if (dstpos == maxsize)
247 dst[dstpos++] = (char) wc;
253 /* I thought just fputwc(c, stdout) would work. But no... */
254 static void BB_PUTCHAR(wchar_t c)
256 char buf[MB_CUR_MAX + 1];
257 mbstate_t mbst = { 0 };
260 len = wcrtomb(buf, c, &mbst);
266 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
267 static wchar_t adjust_width_and_validate_wc(unsigned *width_adj, wchar_t wc)
269 static wchar_t adjust_width_and_validate_wc(wchar_t wc)
270 # define adjust_width_and_validate_wc(width_adj, wc) \
271 ((*(width_adj))++, adjust_width_and_validate_wc(wc))
276 if (unicode_status == UNICODE_ON) {
277 if (wc > CONFIG_LAST_SUPPORTED_WCHAR) {
278 /* note: also true for unicode_is_raw_byte(wc) */
282 if ((ENABLE_UNICODE_COMBINING_WCHARS && w < 0)
283 || (!ENABLE_UNICODE_COMBINING_WCHARS && w <= 0)
284 || (!ENABLE_UNICODE_WIDE_WCHARS && w > 1)
288 wc = CONFIG_SUBST_WCHAR;
292 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
298 static size_t load_string(const char *src, int maxsize)
300 safe_strncpy(command_ps, src, maxsize);
301 return strlen(command_ps);
303 # if ENABLE_FEATURE_TAB_COMPLETION
304 static void save_string(char *dst, unsigned maxsize)
306 safe_strncpy(dst, command_ps, maxsize);
309 # define BB_PUTCHAR(c) bb_putchar(c)
310 /* Should never be called: */
311 int adjust_width_and_validate_wc(unsigned *width_adj, int wc);
315 /* Put 'command_ps[cursor]', cursor++.
316 * Advance cursor on screen. If we reached right margin, scroll text up
317 * and remove terminal margin effect by printing 'next_char' */
318 #define HACK_FOR_WRONG_WIDTH 1
319 static void put_cur_glyph_and_inc_cursor(void)
321 CHAR_T c = command_ps[cursor];
326 /* erase character after end of input string */
329 /* advance cursor only if we aren't at the end yet */
331 if (unicode_status == UNICODE_ON) {
332 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x;)
333 c = adjust_width_and_validate_wc(&cmdedit_x, c);
334 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x - width;)
340 ofs_to_right = cmdedit_x - cmdedit_termw;
341 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right <= 0) {
342 /* c fits on this line */
346 if (ofs_to_right >= 0) {
347 /* we go to the next line */
348 #if HACK_FOR_WRONG_WIDTH
349 /* This works better if our idea of term width is wrong
350 * and it is actually wider (often happens on serial lines).
351 * Printing CR,LF *forces* cursor to next line.
352 * OTOH if terminal width is correct AND terminal does NOT
353 * have automargin (IOW: it is moving cursor to next line
354 * by itself (which is wrong for VT-10x terminals)),
355 * this will break things: there will be one extra empty line */
356 puts("\r"); /* + implicit '\n' */
358 /* VT-10x terminals don't wrap cursor to next line when last char
359 * on the line is printed - cursor stays "over" this char.
360 * Need to print _next_ char too (first one to appear on next line)
361 * to make cursor move down to next line.
363 /* Works ok only if cmdedit_termw is correct. */
364 c = command_ps[cursor];
371 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right == 0) {
373 } else { /* ofs_to_right > 0 */
374 /* wide char c didn't fit on prev line */
381 /* Move to end of line (by printing all chars till the end) */
382 static void put_till_end_and_adv_cursor(void)
384 while (cursor < command_len)
385 put_cur_glyph_and_inc_cursor();
388 /* Go to the next line */
389 static void goto_new_line(void)
391 put_till_end_and_adv_cursor();
396 static void beep(void)
401 static void put_prompt(void)
405 fputs(cmdedit_prompt, stdout);
408 w = cmdedit_termw; /* read volatile var once */
409 cmdedit_y = cmdedit_prmt_len / w; /* new quasireal y */
410 cmdedit_x = cmdedit_prmt_len % w;
413 /* Move back one character */
414 /* (optimized for slow terminals) */
415 static void input_backward(unsigned num)
423 if ((ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS)
424 && unicode_status == UNICODE_ON
426 /* correct NUM to be equal to _screen_ width */
430 adjust_width_and_validate_wc(&num, command_ps[cursor + n]);
435 if (cmdedit_x >= num) {
438 /* This is longer by 5 bytes on x86.
439 * Also gets miscompiled for ARM users
440 * (busybox.net/bugs/view.php?id=2274).
441 * printf(("\b\b\b\b" + 4) - num);
449 printf("\033[%uD", num);
453 /* Need to go one or more lines up */
454 if (ENABLE_UNICODE_WIDE_WCHARS) {
455 /* With wide chars, it is hard to "backtrack"
456 * and reliably figure out where to put cursor.
457 * Example (<> is a wide char; # is an ordinary char, _ cursor):
461 * and user presses left arrow. num = 1, cmdedit_x = 0,
462 * We need to go up one line, and then - how do we know that
463 * we need to go *10* positions to the right? Because
467 * in this situation we need to go *11* positions to the right.
469 * A simpler thing to do is to redraw everything from the start
470 * up to new cursor position (which is already known):
473 /* go to 1st column; go up to first line */
474 printf("\r" "\033[%uA", cmdedit_y);
477 put_prompt(); /* sets cursor to 0 */
478 while (cursor < sv_cursor)
479 put_cur_glyph_and_inc_cursor();
483 /* num = chars to go back from the beginning of current line: */
485 width = cmdedit_termw; /* read volatile var once */
486 /* num=1...w: one line up, w+1...2w: two, etc: */
487 lines_up = 1 + (num - 1) / width;
488 cmdedit_x = (width * cmdedit_y - num) % width;
489 cmdedit_y -= lines_up;
490 /* go to 1st column; go up */
491 printf("\r" "\033[%uA", lines_up);
492 /* go to correct column.
493 * xterm, konsole, Linux VT interpret 0 as 1 below! wow.
494 * need to *make sure* we skip it if cmdedit_x == 0 */
496 printf("\033[%uC", cmdedit_x);
500 /* draw prompt, editor line, and clear tail */
501 static void redraw(int y, int back_cursor)
503 if (y > 0) /* up y lines */
504 printf("\033[%uA", y);
507 put_till_end_and_adv_cursor();
508 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
509 input_backward(back_cursor);
512 /* Delete the char in front of the cursor, optionally saving it
513 * for later putback */
514 #if !ENABLE_FEATURE_EDITING_VI
515 static void input_delete(void)
516 #define input_delete(save) input_delete()
518 static void input_delete(int save)
523 if (j == (int)command_len)
526 #if ENABLE_FEATURE_EDITING_VI
532 if ((delptr - delbuf) < DELBUFSIZ)
533 *delptr++ = command_ps[j];
537 memmove(command_ps + j, command_ps + j + 1,
538 /* (command_len + 1 [because of NUL]) - (j + 1)
539 * simplified into (command_len - j) */
540 (command_len - j) * sizeof(command_ps[0]));
542 put_till_end_and_adv_cursor();
543 /* Last char is still visible, erase it (and more) */
544 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
545 input_backward(cursor - j); /* back to old pos cursor */
548 #if ENABLE_FEATURE_EDITING_VI
549 static void put(void)
552 int j = delptr - delbuf;
557 /* open hole and then fill it */
558 memmove(command_ps + cursor + j, command_ps + cursor,
559 (command_len - cursor + 1) * sizeof(command_ps[0]));
560 memcpy(command_ps + cursor, delbuf, j * sizeof(command_ps[0]));
562 put_till_end_and_adv_cursor();
563 input_backward(cursor - ocursor - j + 1); /* at end of new text */
567 /* Delete the char in back of the cursor */
568 static void input_backspace(void)
576 /* Move forward one character */
577 static void input_forward(void)
579 if (cursor < command_len)
580 put_cur_glyph_and_inc_cursor();
583 #if ENABLE_FEATURE_TAB_COMPLETION
585 static void free_tab_completion_data(void)
589 free(matches[--num_matches]);
595 static void add_match(char *matched)
597 matches = xrealloc_vector(matches, 4, num_matches);
598 matches[num_matches] = matched;
602 #if ENABLE_FEATURE_USERNAME_COMPLETION
603 /* Replace "~user/..." with "/homedir/...".
604 * The parameter is malloced, free it or return it
605 * unchanged if no user is matched.
607 static char *username_path_completion(char *ud)
609 struct passwd *entry;
610 char *tilde_name = ud;
614 if (*ud == '/') { /* "~/..." */
618 ud = strchr(ud, '/');
619 *ud = '\0'; /* "~user" */
620 entry = getpwnam(tilde_name + 1);
621 *ud = '/'; /* restore "~user/..." */
623 home = entry->pw_dir;
626 ud = concat_path_file(home, ud);
633 /* ~use<tab> - find all users with this prefix.
634 * Return the length of the prefix used for matching.
636 static NOINLINE unsigned complete_username(const char *ud)
638 /* Using _r function to avoid pulling in static buffers */
641 struct passwd *result;
645 userlen = strlen(ud);
648 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
649 /* Null usernames should result in all users as possible completions. */
650 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
651 add_match(xasprintf("~%s/", pwd.pw_name));
658 #endif /* FEATURE_USERNAME_COMPLETION */
666 static int path_parse(char ***p)
673 if (state->flags & WITH_PATH_LOOKUP)
674 pth = state->path_lookup;
676 pth = getenv("PATH");
678 /* PATH="" or PATH=":"? */
679 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
683 npth = 1; /* path component count */
685 tmp = strchr(tmp, ':');
690 break; /* :<empty> */
694 *p = res = xmalloc(npth * sizeof(res[0]));
695 res[0] = tmp = xstrdup(pth);
698 tmp = strchr(tmp, ':');
701 *tmp++ = '\0'; /* ':' -> '\0' */
703 break; /* :<empty> */
709 /* Complete command, directory or file name.
710 * Return the length of the prefix used for matching.
712 static NOINLINE unsigned complete_cmd_dir_file(const char *command, int type)
715 char **paths = path1;
723 path1[0] = (char*)".";
725 pfind = strrchr(command, '/');
727 if (type == FIND_EXE_ONLY)
728 npaths = path_parse(&paths);
731 /* point to 'l' in "..../last_component" */
733 /* dirbuf = ".../.../.../" */
734 dirbuf = xstrndup(command, pfind - command);
735 #if ENABLE_FEATURE_USERNAME_COMPLETION
736 if (dirbuf[0] == '~') /* ~/... or ~user/... */
737 dirbuf = username_path_completion(dirbuf);
741 pf_len = strlen(pfind);
743 for (i = 0; i < npaths; i++) {
749 dir = opendir(paths[i]);
751 continue; /* don't print an error */
753 while ((next = readdir(dir)) != NULL) {
755 const char *name_found = next->d_name;
757 /* .../<tab>: bash 3.2.0 shows dotfiles, but not . and .. */
758 if (!pfind[0] && DOT_OR_DOTDOT(name_found))
761 if (strncmp(name_found, pfind, pf_len) != 0)
764 found = concat_path_file(paths[i], name_found);
765 /* NB: stat() first so that we see is it a directory;
766 * but if that fails, use lstat() so that
767 * we still match dangling links */
768 if (stat(found, &st) && lstat(found, &st))
769 goto cont; /* hmm, remove in progress? */
772 len = strlen(name_found);
773 found = xrealloc(found, len + 2); /* +2: for slash and NUL */
774 strcpy(found, name_found);
776 if (S_ISDIR(st.st_mode)) {
777 /* name is a directory, add slash */
779 found[len + 1] = '\0';
781 /* skip files if looking for dirs only (example: cd) */
782 if (type == FIND_DIR_ONLY)
785 /* add it to the list */
792 } /* for every path */
794 if (paths != path1) {
795 free(paths[0]); /* allocated memory is only in first member */
803 /* build_match_prefix:
804 * On entry, match_buf contains everything up to cursor at the moment <tab>
805 * was pressed. This function looks at it, figures out what part of it
806 * constitutes the command/file/directory prefix to use for completion,
807 * and rewrites match_buf to contain only that part.
811 /* QUOT is used on elements of int_buf[], which are bytes,
812 * not Unicode chars. Therefore it works correctly even in Unicode mode.
814 #define QUOT (UCHAR_MAX+1)
815 static void remove_chunk(int16_t *int_buf, int beg, int end)
817 /* beg must be <= end */
821 while ((int_buf[beg] = int_buf[end]) != 0)
826 for (i = 0; int_buf[i]; i++)
827 bb_putchar((unsigned char)int_buf[i]);
831 /* Caller ensures that match_buf points to a malloced buffer
832 * big enough to hold strlen(match_buf)*2 + 2
834 static NOINLINE int build_match_prefix(char *match_buf)
838 int16_t *int_buf = (int16_t*)match_buf;
840 if (dbg_bmp) printf("\n%s\n", match_buf);
842 /* Copy in reverse order, since they overlap */
843 i = strlen(match_buf);
845 int_buf[i] = (unsigned char)match_buf[i];
849 /* Mark every \c as "quoted c" */
850 for (i = 0; int_buf[i]; i++) {
851 if (int_buf[i] == '\\') {
852 remove_chunk(int_buf, i, i + 1);
856 /* Quote-mark "chars" and 'chars', drop delimiters */
861 int cur = int_buf[i];
864 if (cur == '\'' || cur == '"') {
865 if (!in_quote || (cur == in_quote)) {
867 remove_chunk(int_buf, i, i + 1);
872 int_buf[i] = cur | QUOT;
877 /* Remove everything up to command delimiters:
878 * ';' ';;' '&' '|' '&&' '||',
879 * but careful with '>&' '<&' '>|'
881 for (i = 0; int_buf[i]; i++) {
882 int cur = int_buf[i];
883 if (cur == ';' || cur == '&' || cur == '|') {
884 int prev = i ? int_buf[i - 1] : 0;
885 if (cur == '&' && (prev == '>' || prev == '<')) {
887 } else if (cur == '|' && prev == '>') {
890 remove_chunk(int_buf, 0, i + 1 + (cur == int_buf[i + 1]));
891 i = -1; /* back to square 1 */
894 /* Remove all `cmd` */
895 for (i = 0; int_buf[i]; i++) {
896 if (int_buf[i] == '`') {
897 for (j = i + 1; int_buf[j]; j++) {
898 if (int_buf[j] == '`') {
899 /* `cmd` should count as a word:
900 * `cmd` c<tab> should search for files c*,
901 * not commands c*. Therefore we don't drop
902 * `cmd` entirely, we replace it with single `.
904 remove_chunk(int_buf, i, j);
908 /* No closing ` - command mode, remove all up to ` */
909 remove_chunk(int_buf, 0, i + 1);
915 /* Remove "cmd (" and "cmd {"
916 * Example: "if { c<tab>"
917 * In this example, c should be matched as command pfx.
919 for (i = 0; int_buf[i]; i++) {
920 if (int_buf[i] == '(' || int_buf[i] == '{') {
921 remove_chunk(int_buf, 0, i + 1);
922 i = -1; /* back to square 1 */
926 /* Remove leading unquoted spaces */
927 for (i = 0; int_buf[i]; i++)
928 if (int_buf[i] != ' ')
930 remove_chunk(int_buf, 0, i);
932 /* Determine completion mode */
933 command_mode = FIND_EXE_ONLY;
934 for (i = 0; int_buf[i]; i++) {
935 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
936 if (int_buf[i] == ' '
937 && command_mode == FIND_EXE_ONLY
938 && (char)int_buf[0] == 'c'
939 && (char)int_buf[1] == 'd'
940 && i == 2 /* -> int_buf[2] == ' ' */
942 command_mode = FIND_DIR_ONLY;
944 command_mode = FIND_FILE_ONLY;
949 if (dbg_bmp) printf("command_mode(0:exe/1:dir/2:file):%d\n", command_mode);
951 /* Remove everything except last word */
952 for (i = 0; int_buf[i]; i++) /* quasi-strlen(int_buf) */
954 for (--i; i >= 0; i--) {
955 int cur = int_buf[i];
956 if (cur == ' ' || cur == '<' || cur == '>' || cur == '|' || cur == '&') {
957 remove_chunk(int_buf, 0, i + 1);
962 /* Convert back to string of _chars_ */
964 while ((match_buf[i] = int_buf[i]) != '\0')
967 if (dbg_bmp) printf("final match_buf:'%s'\n", match_buf);
973 * Display by column (original idea from ls applet,
974 * very optimized by me [Vladimir] :)
976 static void showfiles(void)
979 int column_width = 0;
980 int nfiles = num_matches;
984 /* find the longest file name - use that as the column width */
985 for (row = 0; row < nrows; row++) {
986 l = unicode_strwidth(matches[row]);
987 if (column_width < l)
990 column_width += 2; /* min space for columns */
991 ncols = cmdedit_termw / column_width;
996 nrows++; /* round up fractionals */
1000 for (row = 0; row < nrows; row++) {
1004 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1005 printf("%s%-*s", matches[n],
1006 (int)(column_width - unicode_strwidth(matches[n])), ""
1009 if (ENABLE_UNICODE_SUPPORT)
1010 puts(printable_string(NULL, matches[n]));
1016 static char *add_quote_for_spec_chars(char *found)
1019 char *s = xzalloc((strlen(found) + 1) * 2);
1022 if (strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", *found))
1026 /* s[l] = '\0'; - already is */
1030 /* Do TAB completion */
1031 static NOINLINE void input_tab(smallint *lastWasTab)
1036 /* Length of string used for matching */
1037 unsigned match_pfx_len = match_pfx_len;
1039 #if ENABLE_UNICODE_SUPPORT
1040 /* cursor pos in command converted to multibyte form */
1043 if (!(state->flags & TAB_COMPLETION))
1047 /* The last char was a TAB too.
1048 * Print a list of all the available choices.
1050 if (num_matches > 0) {
1051 /* cursor will be changed by goto_new_line() */
1052 int sav_cursor = cursor;
1055 redraw(0, command_len - sav_cursor);
1061 chosen_match = NULL;
1063 /* Make a local copy of the string up to the position of the cursor.
1064 * build_match_prefix will expand it into int16_t's, need to allocate
1065 * twice as much as the string_len+1.
1066 * (we then also (ab)use this extra space later - see (**))
1068 match_buf = xmalloc(MAX_LINELEN * sizeof(int16_t));
1069 #if !ENABLE_UNICODE_SUPPORT
1070 save_string(match_buf, cursor + 1); /* +1 for NUL */
1073 CHAR_T wc = command_ps[cursor];
1074 command_ps[cursor] = BB_NUL;
1075 save_string(match_buf, MAX_LINELEN);
1076 command_ps[cursor] = wc;
1077 cursor_mb = strlen(match_buf);
1080 find_type = build_match_prefix(match_buf);
1082 /* Free up any memory already allocated */
1083 free_tab_completion_data();
1085 #if ENABLE_FEATURE_USERNAME_COMPLETION
1086 /* If the word starts with `~' and there is no slash in the word,
1087 * then try completing this word as a username. */
1088 if (state->flags & USERNAME_COMPLETION)
1089 if (match_buf[0] == '~' && strchr(match_buf, '/') == NULL)
1090 match_pfx_len = complete_username(match_buf);
1092 /* Try to match a command in $PATH, or a directory, or a file */
1094 match_pfx_len = complete_cmd_dir_file(match_buf, find_type);
1095 /* Remove duplicates */
1099 qsort_string_vector(matches, num_matches);
1100 for (i = 0; i < num_matches - 1; ++i) {
1101 //if (matches[i] && matches[i+1]) { /* paranoia */
1102 if (strcmp(matches[i], matches[i+1]) == 0) {
1104 //matches[i] = NULL; /* paranoia */
1106 matches[n++] = matches[i];
1110 matches[n++] = matches[i];
1113 /* Did we find exactly one match? */
1114 if (num_matches != 1) { /* no */
1118 goto ret; /* no matches at all */
1119 /* Find common prefix */
1120 chosen_match = xstrdup(matches[0]);
1121 for (cp = chosen_match; *cp; cp++) {
1123 for (n = 1; n < num_matches; n++) {
1124 if (matches[n][cp - chosen_match] != *cp) {
1130 if (cp == chosen_match) { /* have unique prefix? */
1134 cp = add_quote_for_spec_chars(chosen_match);
1137 len_found = strlen(chosen_match);
1138 } else { /* exactly one match */
1139 /* Next <tab> is not a double-tab */
1142 chosen_match = add_quote_for_spec_chars(matches[0]);
1143 len_found = strlen(chosen_match);
1144 if (chosen_match[len_found-1] != '/') {
1145 chosen_match[len_found] = ' ';
1146 chosen_match[++len_found] = '\0';
1150 #if !ENABLE_UNICODE_SUPPORT
1151 /* Have space to place the match? */
1152 /* The result consists of three parts with these lengths: */
1153 /* cursor + (len_found - match_pfx_len) + (command_len - cursor) */
1154 /* it simplifies into: */
1155 if ((int)(len_found - match_pfx_len + command_len) < S.maxsize) {
1158 strcpy(match_buf, &command_ps[cursor]);
1159 /* add match and tail */
1160 sprintf(&command_ps[cursor], "%s%s", chosen_match + match_pfx_len, match_buf);
1161 command_len = strlen(command_ps);
1163 pos = cursor + len_found - match_pfx_len;
1164 /* write out the matched command */
1165 redraw(cmdedit_y, command_len - pos);
1169 /* Use 2nd half of match_buf as scratch space - see (**) */
1170 char *command = match_buf + MAX_LINELEN;
1171 int len = save_string(command, MAX_LINELEN);
1172 /* Have space to place the match? */
1173 /* cursor_mb + (len_found - match_pfx_len) + (len - cursor_mb) */
1174 if ((int)(len_found - match_pfx_len + len) < MAX_LINELEN) {
1177 strcpy(match_buf, &command[cursor_mb]);
1178 /* where do we want to have cursor after all? */
1179 strcpy(&command[cursor_mb], chosen_match + match_pfx_len);
1180 len = load_string(command, S.maxsize);
1181 /* add match and tail */
1182 sprintf(&command[cursor_mb], "%s%s", chosen_match + match_pfx_len, match_buf);
1183 command_len = load_string(command, S.maxsize);
1184 /* write out the matched command */
1185 /* paranoia: load_string can return 0 on conv error,
1186 * prevent passing pos = (0 - 12) to redraw */
1187 pos = command_len - len;
1188 redraw(cmdedit_y, pos >= 0 ? pos : 0);
1197 #endif /* FEATURE_TAB_COMPLETION */
1200 line_input_t* FAST_FUNC new_line_input_t(int flags)
1202 line_input_t *n = xzalloc(sizeof(*n));
1210 static void save_command_ps_at_cur_history(void)
1212 if (command_ps[0] != BB_NUL) {
1213 int cur = state->cur_history;
1214 free(state->history[cur]);
1216 # if ENABLE_UNICODE_SUPPORT
1218 char tbuf[MAX_LINELEN];
1219 save_string(tbuf, sizeof(tbuf));
1220 state->history[cur] = xstrdup(tbuf);
1223 state->history[cur] = xstrdup(command_ps);
1228 /* state->flags is already checked to be nonzero */
1229 static int get_previous_history(void)
1231 if ((state->flags & DO_HISTORY) && state->cur_history) {
1232 save_command_ps_at_cur_history();
1233 state->cur_history--;
1240 static int get_next_history(void)
1242 if (state->flags & DO_HISTORY) {
1243 if (state->cur_history < state->cnt_history) {
1244 save_command_ps_at_cur_history(); /* save the current history line */
1245 return ++state->cur_history;
1252 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1253 /* We try to ensure that concurrent additions to the history
1254 * do not overwrite each other.
1255 * Otherwise shell users get unhappy.
1257 * History file is trimmed lazily, when it grows several times longer
1258 * than configured MAX_HISTORY lines.
1261 static void free_line_input_t(line_input_t *n)
1263 int i = n->cnt_history;
1265 free(n->history[--i]);
1269 /* state->flags is already checked to be nonzero */
1270 static void load_history(line_input_t *st_parm)
1272 char *temp_h[MAX_HISTORY];
1275 unsigned idx, i, line_len;
1277 /* NB: do not trash old history if file can't be opened */
1279 fp = fopen_for_read(st_parm->hist_file);
1281 /* clean up old history */
1282 for (idx = st_parm->cnt_history; idx > 0;) {
1284 free(st_parm->history[idx]);
1285 st_parm->history[idx] = NULL;
1288 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1289 memset(temp_h, 0, sizeof(temp_h));
1290 st_parm->cnt_history_in_file = idx = 0;
1291 while ((line = xmalloc_fgetline(fp)) != NULL) {
1292 if (line[0] == '\0') {
1298 st_parm->cnt_history_in_file++;
1300 if (idx == MAX_HISTORY)
1305 /* find first non-NULL temp_h[], if any */
1306 if (st_parm->cnt_history_in_file) {
1307 while (temp_h[idx] == NULL) {
1309 if (idx == MAX_HISTORY)
1314 /* copy temp_h[] to st_parm->history[] */
1315 for (i = 0; i < MAX_HISTORY;) {
1320 if (idx == MAX_HISTORY)
1322 line_len = strlen(line);
1323 if (line_len >= MAX_LINELEN)
1324 line[MAX_LINELEN-1] = '\0';
1325 st_parm->history[i++] = line;
1327 st_parm->cnt_history = i;
1331 /* state->flags is already checked to be nonzero */
1332 static void save_history(char *str)
1337 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0666);
1340 xlseek(fd, 0, SEEK_END); /* paranoia */
1342 str[len] = '\n'; /* we (try to) do atomic write */
1343 len2 = full_write(fd, str, len + 1);
1346 if (len2 != len + 1)
1347 return; /* "wtf?" */
1349 /* did we write so much that history file needs trimming? */
1350 state->cnt_history_in_file++;
1351 if (state->cnt_history_in_file > MAX_HISTORY * 4) {
1354 line_input_t *st_temp;
1357 /* we may have concurrently written entries from others.
1359 st_temp = new_line_input_t(state->flags);
1360 st_temp->hist_file = state->hist_file;
1361 load_history(st_temp);
1363 /* write out temp file and replace hist_file atomically */
1364 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1365 fp = fopen_for_write(new_name);
1367 for (i = 0; i < st_temp->cnt_history; i++)
1368 fprintf(fp, "%s\n", st_temp->history[i]);
1370 if (rename(new_name, state->hist_file) == 0)
1371 state->cnt_history_in_file = st_temp->cnt_history;
1374 free_line_input_t(st_temp);
1378 # define load_history(a) ((void)0)
1379 # define save_history(a) ((void)0)
1380 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1382 static void remember_in_history(char *str)
1386 if (!(state->flags & DO_HISTORY))
1390 i = state->cnt_history;
1391 /* Don't save dupes */
1392 if (i && strcmp(state->history[i-1], str) == 0)
1395 free(state->history[MAX_HISTORY]); /* redundant, paranoia */
1396 state->history[MAX_HISTORY] = NULL; /* redundant, paranoia */
1398 /* If history[] is full, remove the oldest command */
1399 /* we need to keep history[MAX_HISTORY] empty, hence >=, not > */
1400 if (i >= MAX_HISTORY) {
1401 free(state->history[0]);
1402 for (i = 0; i < MAX_HISTORY-1; i++)
1403 state->history[i] = state->history[i+1];
1404 /* i == MAX_HISTORY-1 */
1406 /* i <= MAX_HISTORY-1 */
1407 state->history[i++] = xstrdup(str);
1408 /* i <= MAX_HISTORY */
1409 state->cur_history = i;
1410 state->cnt_history = i;
1411 # if MAX_HISTORY > 0 && ENABLE_FEATURE_EDITING_SAVEHISTORY
1412 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1415 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1418 #else /* MAX_HISTORY == 0 */
1419 # define remember_in_history(a) ((void)0)
1420 #endif /* MAX_HISTORY */
1423 #if ENABLE_FEATURE_EDITING_VI
1425 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1428 vi_Word_motion(int eat)
1430 CHAR_T *command = command_ps;
1432 while (cursor < command_len && !BB_isspace(command[cursor]))
1434 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1439 vi_word_motion(int eat)
1441 CHAR_T *command = command_ps;
1443 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1444 while (cursor < command_len
1445 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1449 } else if (BB_ispunct(command[cursor])) {
1450 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1454 if (cursor < command_len)
1458 while (cursor < command_len && BB_isspace(command[cursor]))
1466 CHAR_T *command = command_ps;
1469 while (cursor < command_len && BB_isspace(command[cursor]))
1471 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1478 CHAR_T *command = command_ps;
1480 if (cursor >= command_len-1)
1483 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1485 if (cursor >= command_len-1)
1487 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1488 while (cursor < command_len-1
1489 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1493 } else if (BB_ispunct(command[cursor])) {
1494 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1500 vi_Back_motion(void)
1502 CHAR_T *command = command_ps;
1504 while (cursor > 0 && BB_isspace(command[cursor-1]))
1506 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1511 vi_back_motion(void)
1513 CHAR_T *command = command_ps;
1518 while (cursor > 0 && BB_isspace(command[cursor]))
1522 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1524 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1528 } else if (BB_ispunct(command[cursor])) {
1529 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1535 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1536 static void ctrl_left(void)
1538 CHAR_T *command = command_ps;
1546 c = command[cursor];
1547 if (c != ' ' && !BB_ispunct(c)) {
1548 /* we reached a "word" delimited by spaces/punct.
1549 * go to its beginning */
1551 c = command[cursor - 1];
1552 if (c == ' ' || BB_ispunct(c))
1562 static void ctrl_right(void)
1564 CHAR_T *command = command_ps;
1569 c = command[cursor];
1572 if (c != ' ' && !BB_ispunct(c)) {
1573 /* we reached a "word" delimited by spaces/punct.
1574 * go to its end + 1 */
1577 c = command[cursor];
1578 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1589 * read_line_input and its helpers
1592 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1593 static void ask_terminal(void)
1595 /* Ask terminal where is the cursor now.
1596 * lineedit_read_key handles response and corrects
1597 * our idea of current cursor position.
1598 * Testcase: run "echo -n long_line_long_line_long_line",
1599 * then type in a long, wrapping command and try to
1600 * delete it using backspace key.
1601 * Note: we print it _after_ prompt, because
1602 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1604 /* Problem: if there is buffered input on stdin,
1605 * the response will be delivered later,
1606 * possibly to an unsuspecting application.
1607 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1609 * ~/srcdevel/bbox/fix/busybox.t4 #
1610 * ~/srcdevel/bbox/fix/busybox.t4 #
1611 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1612 * ~/srcdevel/bbox/fix/busybox.t4 #
1614 * Checking for input with poll only makes the race narrower,
1615 * I still can trigger it. Strace:
1617 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1618 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1619 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1620 * poll([{fd=0, events=POLLIN}], 1, 4294967295) = 1 ([{fd=0, revents=POLLIN}])
1621 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1625 pfd.fd = STDIN_FILENO;
1626 pfd.events = POLLIN;
1627 if (safe_poll(&pfd, 1, 0) == 0) {
1628 S.sent_ESC_br6n = 1;
1629 fputs("\033" "[6n", stdout);
1630 fflush_all(); /* make terminal see it ASAP! */
1634 #define ask_terminal() ((void)0)
1637 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1638 static void parse_and_put_prompt(const char *prmt_ptr)
1640 cmdedit_prompt = prmt_ptr;
1641 cmdedit_prmt_len = strlen(prmt_ptr);
1645 static void parse_and_put_prompt(const char *prmt_ptr)
1648 size_t cur_prmt_len = 0;
1649 char flg_not_length = '[';
1650 char *prmt_mem_ptr = xzalloc(1);
1651 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1656 cmdedit_prmt_len = 0;
1659 cwd_buf = (char *)bb_msg_unknown;
1662 cbuf[1] = '\0'; /* never changes */
1665 char *free_me = NULL;
1670 const char *cp = prmt_ptr;
1673 c = bb_process_escape_sequence(&prmt_ptr);
1674 if (prmt_ptr == cp) {
1680 # if ENABLE_USERNAME_OR_HOMEDIR
1682 pbuf = user_buf ? user_buf : (char*)"";
1686 pbuf = free_me = safe_gethostname();
1687 *strchrnul(pbuf, '.') = '\0';
1690 c = (geteuid() == 0 ? '#' : '$');
1692 # if ENABLE_USERNAME_OR_HOMEDIR
1694 /* /home/user[/something] -> ~[/something] */
1696 l = strlen(home_pwd_buf);
1698 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1699 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1700 && strlen(cwd_buf + l) < PATH_MAX
1702 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1708 cp = strrchr(pbuf, '/');
1709 if (cp != NULL && cp != pbuf)
1710 pbuf += (cp-pbuf) + 1;
1713 pbuf = free_me = xasprintf("%d", num_ok_lines);
1715 case 'e': case 'E': /* \e \E = \033 */
1718 case 'x': case 'X': {
1720 for (l = 0; l < 3;) {
1722 buf2[l++] = *prmt_ptr;
1724 h = strtoul(buf2, &pbuf, 16);
1725 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1731 c = (char)strtoul(buf2, NULL, 16);
1738 if (c == flg_not_length) {
1739 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1747 cur_prmt_len = strlen(pbuf);
1748 prmt_len += cur_prmt_len;
1749 if (flg_not_length != ']')
1750 cmdedit_prmt_len += cur_prmt_len;
1751 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1755 if (cwd_buf != (char *)bb_msg_unknown)
1757 cmdedit_prompt = prmt_mem_ptr;
1762 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1766 /* new y for current cursor */
1767 int new_y = (cursor + cmdedit_prmt_len) / w;
1769 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1774 static void win_changed(int nsig)
1776 int sv_errno = errno;
1778 get_terminal_width_height(0, &width, NULL);
1779 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1780 if (nsig == SIGWINCH)
1781 signal(SIGWINCH, win_changed); /* rearm ourself */
1785 static int lineedit_read_key(char *read_key_buffer)
1789 #if ENABLE_UNICODE_SUPPORT
1790 char unicode_buf[MB_CUR_MAX + 1];
1791 int unicode_idx = 0;
1795 /* Wait for input. TIMEOUT = -1 makes read_key wait even
1796 * on nonblocking stdin, TIMEOUT = 50 makes sure we won't
1797 * insist on full MB_CUR_MAX buffer to declare input like
1798 * "\xff\n",pause,"ls\n" invalid and thus won't lose "ls".
1800 * Note: read_key sets errno to 0 on success.
1802 ic = read_key(STDIN_FILENO, read_key_buffer, timeout);
1804 #if ENABLE_UNICODE_SUPPORT
1805 if (errno == EAGAIN && unicode_idx != 0)
1811 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1812 if ((int32_t)ic == KEYCODE_CURSOR_POS
1815 S.sent_ESC_br6n = 0;
1816 if (cursor == 0) { /* otherwise it may be bogus */
1817 int col = ((ic >> 32) & 0x7fff) - 1;
1818 if (col > cmdedit_prmt_len) {
1819 cmdedit_x += (col - cmdedit_prmt_len);
1820 while (cmdedit_x >= cmdedit_termw) {
1821 cmdedit_x -= cmdedit_termw;
1830 #if ENABLE_UNICODE_SUPPORT
1831 if (unicode_status == UNICODE_ON) {
1834 if ((int32_t)ic < 0) /* KEYCODE_xxx */
1836 // TODO: imagine sequence like: 0xff,<left-arrow>: we are currently losing 0xff...
1838 unicode_buf[unicode_idx++] = ic;
1839 unicode_buf[unicode_idx] = '\0';
1840 if (mbstowcs(&wc, unicode_buf, 1) != 1) {
1841 /* Not (yet?) a valid unicode char */
1842 if (unicode_idx < MB_CUR_MAX) {
1847 /* Invalid sequence. Save all "bad bytes" except first */
1848 read_key_ungets(read_key_buffer, unicode_buf + 1, unicode_idx - 1);
1849 # if !ENABLE_UNICODE_PRESERVE_BROKEN
1850 ic = CONFIG_SUBST_WCHAR;
1852 ic = unicode_mark_raw_byte(unicode_buf[0]);
1855 /* Valid unicode char, return its code */
1866 #if ENABLE_UNICODE_BIDI_SUPPORT
1867 static int isrtl_str(void)
1871 while (idx < command_len && unicode_bidi_is_neutral_wchar(command_ps[idx]))
1873 return unicode_bidi_isrtl(command_ps[idx]);
1876 # define isrtl_str() 0
1879 /* leave out the "vi-mode"-only case labels if vi editing isn't
1881 #define vi_case(caselabel) IF_FEATURE_EDITING_VI(case caselabel)
1883 /* convert uppercase ascii to equivalent control char, for readability */
1885 #define CTRL(a) ((a) & ~0x40)
1887 /* maxsize must be >= 2.
1889 * -1 on read errors or EOF, or on bare Ctrl-D,
1890 * 0 on ctrl-C (the line entered is still returned in 'command'),
1891 * >0 length of input string, including terminating '\n'
1893 int FAST_FUNC read_line_input(const char *prompt, char *command, int maxsize, line_input_t *st)
1896 #if ENABLE_FEATURE_TAB_COMPLETION
1897 smallint lastWasTab = 0;
1899 smallint break_out = 0;
1900 #if ENABLE_FEATURE_EDITING_VI
1901 smallint vi_cmdmode = 0;
1903 struct termios initial_settings;
1904 struct termios new_settings;
1905 char read_key_buffer[KEYCODE_BUFFER_SIZE];
1909 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
1910 || !(initial_settings.c_lflag & ECHO)
1912 /* Happens when e.g. stty -echo was run before */
1913 parse_and_put_prompt(prompt);
1914 /* fflush_all(); - done by parse_and_put_prompt */
1915 if (fgets(command, maxsize, stdin) == NULL)
1916 len = -1; /* EOF or error */
1918 len = strlen(command);
1925 // FIXME: audit & improve this
1926 if (maxsize > MAX_LINELEN)
1927 maxsize = MAX_LINELEN;
1928 S.maxsize = maxsize;
1930 /* With null flags, no other fields are ever used */
1931 state = st ? st : (line_input_t*) &const_int_0;
1933 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1934 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1935 if (state->cnt_history == 0)
1936 load_history(state);
1938 if (state->flags & DO_HISTORY)
1939 state->cur_history = state->cnt_history;
1942 /* prepare before init handlers */
1943 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
1945 #if ENABLE_UNICODE_SUPPORT
1946 command_ps = xzalloc(maxsize * sizeof(command_ps[0]));
1948 command_ps = command;
1951 #define command command_must_not_be_used
1953 new_settings = initial_settings;
1954 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
1955 /* Turn off echoing and CTRL-C, so we can trap it */
1956 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
1957 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
1958 new_settings.c_cc[VMIN] = 1;
1959 new_settings.c_cc[VTIME] = 0;
1960 /* Turn off CTRL-C, so we can trap it */
1961 #ifndef _POSIX_VDISABLE
1962 # define _POSIX_VDISABLE '\0'
1964 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
1965 tcsetattr_stdin_TCSANOW(&new_settings);
1967 /* Now initialize things */
1968 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
1969 win_changed(0); /* do initial resizing */
1970 #if ENABLE_USERNAME_OR_HOMEDIR
1972 struct passwd *entry;
1974 entry = getpwuid(geteuid());
1976 user_buf = xstrdup(entry->pw_name);
1977 home_pwd_buf = xstrdup(entry->pw_dir);
1983 for (i = 0; i <= MAX_HISTORY; i++)
1984 bb_error_msg("history[%d]:'%s'", i, state->history[i]);
1985 bb_error_msg("cur_history:%d cnt_history:%d", state->cur_history, state->cnt_history);
1988 /* Print out the command prompt, optionally ask where cursor is */
1989 parse_and_put_prompt(prompt);
1992 read_key_buffer[0] = 0;
1995 * The emacs and vi modes share much of the code in the big
1996 * command loop. Commands entered when in vi's command mode
1997 * (aka "escape mode") get an extra bit added to distinguish
1998 * them - this keeps them from being self-inserted. This
1999 * clutters the big switch a bit, but keeps all the code
2003 VI_CMDMODE_BIT = 0x40000000,
2004 /* 0x80000000 bit flags KEYCODE_xxx */
2009 ic = ic_raw = lineedit_read_key(read_key_buffer);
2011 #if ENABLE_FEATURE_EDITING_VI
2014 /* btw, since KEYCODE_xxx are all < 0, this doesn't
2015 * change ic if it contains one of them: */
2016 ic |= VI_CMDMODE_BIT;
2023 vi_case('\n'|VI_CMDMODE_BIT:)
2024 vi_case('\r'|VI_CMDMODE_BIT:)
2030 vi_case('0'|VI_CMDMODE_BIT:)
2031 /* Control-a -- Beginning of line */
2032 input_backward(cursor);
2035 vi_case('h'|VI_CMDMODE_BIT:)
2036 vi_case('\b'|VI_CMDMODE_BIT:) /* ^H */
2037 vi_case('\x7f'|VI_CMDMODE_BIT:) /* DEL */
2038 input_backward(1); /* Move back one character */
2041 vi_case('$'|VI_CMDMODE_BIT:)
2042 /* Control-e -- End of line */
2043 put_till_end_and_adv_cursor();
2046 vi_case('l'|VI_CMDMODE_BIT:)
2047 vi_case(' '|VI_CMDMODE_BIT:)
2048 input_forward(); /* Move forward one character */
2051 case '\x7f': /* DEL */
2057 case KEYCODE_DELETE:
2063 #if ENABLE_FEATURE_TAB_COMPLETION
2065 input_tab(&lastWasTab);
2069 /* Control-k -- clear to end of line */
2070 command_ps[cursor] = BB_NUL;
2071 command_len = cursor;
2072 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
2075 vi_case(CTRL('L')|VI_CMDMODE_BIT:)
2076 /* Control-l -- clear screen */
2077 printf("\033[H"); /* cursor to top,left */
2078 redraw(0, command_len - cursor);
2082 vi_case(CTRL('N')|VI_CMDMODE_BIT:)
2083 vi_case('j'|VI_CMDMODE_BIT:)
2084 /* Control-n -- Get next command in history */
2085 if (get_next_history())
2089 vi_case(CTRL('P')|VI_CMDMODE_BIT:)
2090 vi_case('k'|VI_CMDMODE_BIT:)
2091 /* Control-p -- Get previous command from history */
2092 if (get_previous_history())
2097 vi_case(CTRL('U')|VI_CMDMODE_BIT:)
2098 /* Control-U -- Clear line before cursor */
2100 command_len -= cursor;
2101 memmove(command_ps, command_ps + cursor,
2102 (command_len + 1) * sizeof(command_ps[0]));
2103 redraw(cmdedit_y, command_len);
2107 vi_case(CTRL('W')|VI_CMDMODE_BIT:)
2108 /* Control-W -- Remove the last word */
2109 while (cursor > 0 && BB_isspace(command_ps[cursor-1]))
2111 while (cursor > 0 && !BB_isspace(command_ps[cursor-1]))
2115 #if ENABLE_FEATURE_EDITING_VI
2116 case 'i'|VI_CMDMODE_BIT:
2119 case 'I'|VI_CMDMODE_BIT:
2120 input_backward(cursor);
2123 case 'a'|VI_CMDMODE_BIT:
2127 case 'A'|VI_CMDMODE_BIT:
2128 put_till_end_and_adv_cursor();
2131 case 'x'|VI_CMDMODE_BIT:
2134 case 'X'|VI_CMDMODE_BIT:
2140 case 'W'|VI_CMDMODE_BIT:
2143 case 'w'|VI_CMDMODE_BIT:
2146 case 'E'|VI_CMDMODE_BIT:
2149 case 'e'|VI_CMDMODE_BIT:
2152 case 'B'|VI_CMDMODE_BIT:
2155 case 'b'|VI_CMDMODE_BIT:
2158 case 'C'|VI_CMDMODE_BIT:
2161 case 'D'|VI_CMDMODE_BIT:
2164 case 'c'|VI_CMDMODE_BIT:
2167 case 'd'|VI_CMDMODE_BIT: {
2170 ic = lineedit_read_key(read_key_buffer);
2171 if (errno) /* error */
2172 goto return_error_indicator;
2173 if (ic == ic_raw) { /* "cc", "dd" */
2174 input_backward(cursor);
2186 case 'w': /* "dw", "cw" */
2187 vi_word_motion(vi_cmdmode);
2189 case 'W': /* 'dW', 'cW' */
2190 vi_Word_motion(vi_cmdmode);
2192 case 'e': /* 'de', 'ce' */
2196 case 'E': /* 'dE', 'cE' */
2202 input_backward(cursor - sc);
2203 while (nc-- > cursor)
2206 case 'b': /* "db", "cb" */
2207 case 'B': /* implemented as B */
2212 while (sc-- > cursor)
2215 case ' ': /* "d ", "c " */
2218 case '$': /* "d$", "c$" */
2220 while (cursor < command_len)
2226 case 'p'|VI_CMDMODE_BIT:
2229 case 'P'|VI_CMDMODE_BIT:
2232 case 'r'|VI_CMDMODE_BIT:
2233 //FIXME: unicode case?
2234 ic = lineedit_read_key(read_key_buffer);
2235 if (errno) /* error */
2236 goto return_error_indicator;
2237 if (ic < ' ' || ic > 255) {
2240 command_ps[cursor] = ic;
2245 case '\x1b': /* ESC */
2246 if (state->flags & VI_MODE) {
2247 /* insert mode --> command mode */
2252 #endif /* FEATURE_COMMAND_EDITING_VI */
2256 if (get_previous_history())
2261 if (!get_next_history())
2264 /* Rewrite the line with the selected history item */
2265 /* change command */
2266 command_len = load_string(state->history[state->cur_history] ?
2267 state->history[state->cur_history] : "", maxsize);
2268 /* redraw and go to eol (bol, in vi) */
2269 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
2278 case KEYCODE_CTRL_LEFT:
2281 case KEYCODE_CTRL_RIGHT:
2285 input_backward(cursor);
2288 put_till_end_and_adv_cursor();
2292 if (initial_settings.c_cc[VINTR] != 0
2293 && ic_raw == initial_settings.c_cc[VINTR]
2295 /* Ctrl-C (usually) - stop gathering input */
2298 break_out = -1; /* "do not append '\n'" */
2301 if (initial_settings.c_cc[VEOF] != 0
2302 && ic_raw == initial_settings.c_cc[VEOF]
2304 /* Ctrl-D (usually) - delete one character,
2305 * or exit if len=0 and no chars to delete */
2306 if (command_len == 0) {
2309 case -1: /* error (e.g. EIO when tty is destroyed) */
2310 IF_FEATURE_EDITING_VI(return_error_indicator:)
2311 break_out = command_len = -1;
2317 // /* Control-V -- force insert of next char */
2318 // if (c == CTRL('V')) {
2319 // if (safe_read(STDIN_FILENO, &c, 1) < 1)
2320 // goto return_error_indicator;
2327 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2328 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2330 /* If VI_CMDMODE_BIT is set, ic is >= 256
2331 * and vi mode ignores unexpected chars.
2332 * Otherwise, we are here if ic is a
2333 * control char or an unhandled ESC sequence,
2334 * which is also ignored.
2338 if ((int)command_len >= (maxsize - 2)) {
2339 /* Not enough space for the char and EOL */
2344 if (cursor == (command_len - 1)) {
2345 /* We are at the end, append */
2346 command_ps[cursor] = ic;
2347 command_ps[cursor + 1] = BB_NUL;
2348 put_cur_glyph_and_inc_cursor();
2349 if (unicode_bidi_isrtl(ic))
2352 /* In the middle, insert */
2355 memmove(command_ps + sc + 1, command_ps + sc,
2356 (command_len - sc) * sizeof(command_ps[0]));
2357 command_ps[sc] = ic;
2358 /* is right-to-left char, or neutral one (e.g. comma) was just added to rtl text? */
2361 put_till_end_and_adv_cursor();
2362 /* to prev x pos + 1 */
2363 input_backward(cursor - sc);
2371 #if ENABLE_FEATURE_TAB_COMPLETION
2377 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
2378 if (S.sent_ESC_br6n) {
2379 /* "sleep 1; busybox ash" + hold [Enter] to trigger.
2380 * We sent "ESC [ 6 n", but got '\n' first, and
2381 * KEYCODE_CURSOR_POS response is now buffered from terminal.
2382 * It's bad already and not much can be done with it
2383 * (it _will_ be visible for the next process to read stdin),
2384 * but without this delay it even shows up on the screen
2385 * as garbage because we restore echo settings with tcsetattr
2386 * before it comes in. UGLY!
2392 /* End of bug-catching "command_must_not_be_used" trick */
2395 #if ENABLE_UNICODE_SUPPORT
2397 if (command_len > 0)
2398 command_len = save_string(command, maxsize - 1);
2402 if (command_len > 0)
2403 remember_in_history(command);
2405 if (break_out > 0) {
2406 command[command_len++] = '\n';
2407 command[command_len] = '\0';
2410 #if ENABLE_FEATURE_TAB_COMPLETION
2411 free_tab_completion_data();
2414 /* restore initial_settings */
2415 tcsetattr_stdin_TCSANOW(&initial_settings);
2416 /* restore SIGWINCH handler */
2417 signal(SIGWINCH, previous_SIGWINCH_handler);
2423 return len; /* can't return command_len, DEINIT_S() destroys it */
2426 #else /* !FEATURE_EDITING */
2428 #undef read_line_input
2429 int FAST_FUNC read_line_input(const char* prompt, char* command, int maxsize)
2431 fputs(prompt, stdout);
2433 fgets(command, maxsize, stdin);
2434 return strlen(command);
2437 #endif /* !FEATURE_EDITING */
2448 const char *applet_name = "debug stuff usage";
2450 int main(int argc, char **argv)
2452 char buff[MAX_LINELEN];
2454 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
2455 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
2456 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
2457 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
2464 l = read_line_input(prompt, buff);
2465 if (l <= 0 || buff[l-1] != '\n')
2468 printf("*** read_line_input() returned line =%s=\n", buff);
2470 printf("*** read_line_input() detect ^D\n");