1 /* vi: set sw=4 ts=4: */
3 * Termios command line History and 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 /* We use int16_t for positions, need to limit line len */
103 MAX_LINELEN = CONFIG_FEATURE_EDITING_MAX_LEN < 0x7ff0
104 ? CONFIG_FEATURE_EDITING_MAX_LEN
108 #if ENABLE_USERNAME_OR_HOMEDIR
109 static const char null_str[] ALIGN1 = "";
112 /* We try to minimize both static and stack usage. */
113 struct lineedit_statics {
116 volatile unsigned cmdedit_termw; /* = 80; */ /* actual terminal width */
117 sighandler_t previous_SIGWINCH_handler;
119 unsigned cmdedit_x; /* real x (col) terminal position */
120 unsigned cmdedit_y; /* pseudoreal y (row) terminal position */
121 unsigned cmdedit_prmt_len; /* length of prompt (without colors etc) */
124 int command_len; /* must be signed */
125 /* signed maxsize: we want x in "if (x > S.maxsize)"
126 * to _not_ be promoted to unsigned */
130 const char *cmdedit_prompt;
131 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
132 int num_ok_lines; /* = 1; */
135 #if ENABLE_USERNAME_OR_HOMEDIR
137 char *home_pwd_buf; /* = (char*)null_str; */
140 #if ENABLE_FEATURE_TAB_COMPLETION
142 unsigned num_matches;
145 #if ENABLE_FEATURE_EDITING_VI
146 # define DELBUFSIZ 128
148 smallint newdelflag; /* whether delbuf should be reused yet */
149 CHAR_T delbuf[DELBUFSIZ]; /* a place to store deleted characters */
151 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
152 smallint sent_ESC_br6n;
155 /* Formerly these were big buffers on stack: */
156 #if ENABLE_FEATURE_TAB_COMPLETION
157 char input_tab__matchBuf[MAX_LINELEN];
158 int16_t find_match__int_buf[MAX_LINELEN + 1]; /* need to have 9 bits at least */
159 int16_t find_match__pos_buf[MAX_LINELEN + 1];
163 /* See lineedit_ptr_hack.c */
164 extern struct lineedit_statics *const lineedit_ptr_to_statics;
166 #define S (*lineedit_ptr_to_statics)
167 #define state (S.state )
168 #define cmdedit_termw (S.cmdedit_termw )
169 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
170 #define cmdedit_x (S.cmdedit_x )
171 #define cmdedit_y (S.cmdedit_y )
172 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
173 #define cursor (S.cursor )
174 #define command_len (S.command_len )
175 #define command_ps (S.command_ps )
176 #define cmdedit_prompt (S.cmdedit_prompt )
177 #define num_ok_lines (S.num_ok_lines )
178 #define user_buf (S.user_buf )
179 #define home_pwd_buf (S.home_pwd_buf )
180 #define matches (S.matches )
181 #define num_matches (S.num_matches )
182 #define delptr (S.delptr )
183 #define newdelflag (S.newdelflag )
184 #define delbuf (S.delbuf )
186 #define INIT_S() do { \
187 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
189 cmdedit_termw = 80; \
190 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
191 IF_USERNAME_OR_HOMEDIR(home_pwd_buf = (char*)null_str;) \
193 static void deinit_S(void)
195 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
196 /* This one is allocated only if FANCY_PROMPT is on
197 * (otherwise it points to verbatim prompt (NOT malloced) */
198 free((char*)cmdedit_prompt);
200 #if ENABLE_USERNAME_OR_HOMEDIR
202 if (home_pwd_buf != null_str)
205 free(lineedit_ptr_to_statics);
207 #define DEINIT_S() deinit_S()
210 #if ENABLE_UNICODE_SUPPORT
211 static size_t load_string(const char *src, int maxsize)
213 ssize_t len = mbstowcs(command_ps, src, maxsize - 1);
219 static unsigned save_string(char *dst, unsigned maxsize)
221 # if !ENABLE_UNICODE_PRESERVE_BROKEN
222 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
232 while (dstpos < maxsize) {
236 /* Convert up to 1st invalid byte (or up to end) */
237 while ((wc = command_ps[srcpos]) != 0
238 && !unicode_is_raw_byte(wc)
242 command_ps[srcpos] = 0;
243 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
244 if (n < 0) /* should not happen */
247 if (wc == 0) /* usually is */
250 /* We do have invalid byte here! */
251 command_ps[srcpos] = wc; /* restore it */
253 if (dstpos == maxsize)
255 dst[dstpos++] = (char) wc;
261 /* I thought just fputwc(c, stdout) would work. But no... */
262 static void BB_PUTCHAR(wchar_t c)
264 char buf[MB_CUR_MAX + 1];
265 mbstate_t mbst = { 0 };
268 len = wcrtomb(buf, c, &mbst);
274 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
275 static wchar_t adjust_width_and_validate_wc(unsigned *width_adj, wchar_t wc)
277 static wchar_t adjust_width_and_validate_wc(wchar_t wc)
278 # define adjust_width_and_validate_wc(width_adj, wc) \
279 ((*(width_adj))++, adjust_width_and_validate_wc(wc))
284 if (unicode_status == UNICODE_ON) {
285 if (wc > CONFIG_LAST_SUPPORTED_WCHAR) {
286 /* note: also true for unicode_is_raw_byte(wc) */
290 if ((ENABLE_UNICODE_COMBINING_WCHARS && w < 0)
291 || (!ENABLE_UNICODE_COMBINING_WCHARS && w <= 0)
292 || (!ENABLE_UNICODE_WIDE_WCHARS && w > 1)
296 wc = CONFIG_SUBST_WCHAR;
300 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
306 static size_t load_string(const char *src, int maxsize)
308 safe_strncpy(command_ps, src, maxsize);
309 return strlen(command_ps);
311 # if ENABLE_FEATURE_TAB_COMPLETION
312 static void save_string(char *dst, unsigned maxsize)
314 safe_strncpy(dst, command_ps, maxsize);
317 # define BB_PUTCHAR(c) bb_putchar(c)
318 /* Should never be called: */
319 int adjust_width_and_validate_wc(unsigned *width_adj, int wc);
323 /* Put 'command_ps[cursor]', cursor++.
324 * Advance cursor on screen. If we reached right margin, scroll text up
325 * and remove terminal margin effect by printing 'next_char' */
326 #define HACK_FOR_WRONG_WIDTH 1
327 static void put_cur_glyph_and_inc_cursor(void)
329 CHAR_T c = command_ps[cursor];
334 /* erase character after end of input string */
337 /* advance cursor only if we aren't at the end yet */
339 if (unicode_status == UNICODE_ON) {
340 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x;)
341 c = adjust_width_and_validate_wc(&cmdedit_x, c);
342 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x - width;)
348 ofs_to_right = cmdedit_x - cmdedit_termw;
349 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right <= 0) {
350 /* c fits on this line */
354 if (ofs_to_right >= 0) {
355 /* we go to the next line */
356 #if HACK_FOR_WRONG_WIDTH
357 /* This works better if our idea of term width is wrong
358 * and it is actually wider (often happens on serial lines).
359 * Printing CR,LF *forces* cursor to next line.
360 * OTOH if terminal width is correct AND terminal does NOT
361 * have automargin (IOW: it is moving cursor to next line
362 * by itself (which is wrong for VT-10x terminals)),
363 * this will break things: there will be one extra empty line */
364 puts("\r"); /* + implicit '\n' */
366 /* VT-10x terminals don't wrap cursor to next line when last char
367 * on the line is printed - cursor stays "over" this char.
368 * Need to print _next_ char too (first one to appear on next line)
369 * to make cursor move down to next line.
371 /* Works ok only if cmdedit_termw is correct. */
372 c = command_ps[cursor];
379 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right == 0) {
381 } else { /* ofs_to_right > 0 */
382 /* wide char c didn't fit on prev line */
389 /* Move to end of line (by printing all chars till the end) */
390 static void put_till_end_and_adv_cursor(void)
392 while (cursor < command_len)
393 put_cur_glyph_and_inc_cursor();
396 /* Go to the next line */
397 static void goto_new_line(void)
399 put_till_end_and_adv_cursor();
404 static void beep(void)
409 static void put_prompt(void)
413 fputs(cmdedit_prompt, stdout);
416 w = cmdedit_termw; /* read volatile var once */
417 cmdedit_y = cmdedit_prmt_len / w; /* new quasireal y */
418 cmdedit_x = cmdedit_prmt_len % w;
421 /* Move back one character */
422 /* (optimized for slow terminals) */
423 static void input_backward(unsigned num)
431 if ((ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS)
432 && unicode_status == UNICODE_ON
434 /* correct NUM to be equal to _screen_ width */
438 adjust_width_and_validate_wc(&num, command_ps[cursor + n]);
443 if (cmdedit_x >= num) {
446 /* This is longer by 5 bytes on x86.
447 * Also gets miscompiled for ARM users
448 * (busybox.net/bugs/view.php?id=2274).
449 * printf(("\b\b\b\b" + 4) - num);
457 printf("\033[%uD", num);
461 /* Need to go one or more lines up */
462 if (ENABLE_UNICODE_WIDE_WCHARS) {
463 /* With wide chars, it is hard to "backtrack"
464 * and reliably figure out where to put cursor.
465 * Example (<> is a wide char; # is an ordinary char, _ cursor):
469 * and user presses left arrow. num = 1, cmdedit_x = 0,
470 * We need to go up one line, and then - how do we know that
471 * we need to go *10* positions to the right? Because
475 * in this situation we need to go *11* positions to the right.
477 * A simpler thing to do is to redraw everything from the start
478 * up to new cursor position (which is already known):
481 /* go to 1st column; go up to first line */
482 printf("\r" "\033[%uA", cmdedit_y);
485 put_prompt(); /* sets cursor to 0 */
486 while (cursor < sv_cursor)
487 put_cur_glyph_and_inc_cursor();
491 /* num = chars to go back from the beginning of current line: */
493 width = cmdedit_termw; /* read volatile var once */
494 /* num=1...w: one line up, w+1...2w: two, etc: */
495 lines_up = 1 + (num - 1) / width;
496 cmdedit_x = (width * cmdedit_y - num) % width;
497 cmdedit_y -= lines_up;
498 /* go to 1st column; go up */
499 printf("\r" "\033[%uA", lines_up);
500 /* go to correct column.
501 * xterm, konsole, Linux VT interpret 0 as 1 below! wow.
502 * need to *make sure* we skip it if cmdedit_x == 0 */
504 printf("\033[%uC", cmdedit_x);
508 /* draw prompt, editor line, and clear tail */
509 static void redraw(int y, int back_cursor)
511 if (y > 0) /* up y lines */
512 printf("\033[%uA", y);
515 put_till_end_and_adv_cursor();
516 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
517 input_backward(back_cursor);
520 /* Delete the char in front of the cursor, optionally saving it
521 * for later putback */
522 #if !ENABLE_FEATURE_EDITING_VI
523 static void input_delete(void)
524 #define input_delete(save) input_delete()
526 static void input_delete(int save)
531 if (j == (int)command_len)
534 #if ENABLE_FEATURE_EDITING_VI
540 if ((delptr - delbuf) < DELBUFSIZ)
541 *delptr++ = command_ps[j];
545 memmove(command_ps + j, command_ps + j + 1,
546 /* (command_len + 1 [because of NUL]) - (j + 1)
547 * simplified into (command_len - j) */
548 (command_len - j) * sizeof(command_ps[0]));
550 put_till_end_and_adv_cursor();
551 /* Last char is still visible, erase it (and more) */
552 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
553 input_backward(cursor - j); /* back to old pos cursor */
556 #if ENABLE_FEATURE_EDITING_VI
557 static void put(void)
560 int j = delptr - delbuf;
565 /* open hole and then fill it */
566 memmove(command_ps + cursor + j, command_ps + cursor,
567 (command_len - cursor + 1) * sizeof(command_ps[0]));
568 memcpy(command_ps + cursor, delbuf, j * sizeof(command_ps[0]));
570 put_till_end_and_adv_cursor();
571 input_backward(cursor - ocursor - j + 1); /* at end of new text */
575 /* Delete the char in back of the cursor */
576 static void input_backspace(void)
584 /* Move forward one character */
585 static void input_forward(void)
587 if (cursor < command_len)
588 put_cur_glyph_and_inc_cursor();
591 #if ENABLE_FEATURE_TAB_COMPLETION
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 static NOINLINE void username_completion(const char *ud)
644 /* Using _r function to avoid pulling in static buffers */
647 struct passwd *result;
651 userlen = strlen(ud);
654 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
655 /* Null usernames should result in all users as possible completions. */
656 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
657 add_match(xasprintf("~%s/", pwd.pw_name));
662 #endif /* FEATURE_COMMAND_USERNAME_COMPLETION */
670 static int path_parse(char ***p)
677 if (state->flags & WITH_PATH_LOOKUP)
678 pth = state->path_lookup;
680 pth = getenv("PATH");
682 /* PATH="" or PATH=":"? */
683 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
687 npth = 1; /* path component count */
689 tmp = strchr(tmp, ':');
694 break; /* :<empty> */
698 *p = res = xmalloc(npth * sizeof(res[0]));
699 res[0] = tmp = xstrdup(pth);
702 tmp = strchr(tmp, ':');
705 *tmp++ = '\0'; /* ':' -> '\0' */
707 break; /* :<empty> */
713 static void exe_n_cwd_tab_completion(char *command, int type)
716 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);
742 for (i = 0; i < npaths; i++) {
748 dir = opendir(paths[i]);
750 continue; /* don't print an error */
752 while ((next = readdir(dir)) != NULL) {
753 const char *name_found = next->d_name;
755 /* .../<tab>: bash 3.2.0 shows dotfiles, but not . and .. */
756 if (!pfind[0] && DOT_OR_DOTDOT(name_found))
759 if (strncmp(name_found, pfind, strlen(pfind)) != 0)
762 found = concat_path_file(paths[i], name_found);
763 /* NB: stat() first so that we see is it a directory;
764 * but if that fails, use lstat() so that
765 * we still match dangling links */
766 if (stat(found, &st) && lstat(found, &st))
767 goto cont; /* hmm, remove in progress? */
769 /* save only name if we scan PATH */
770 if (paths[i] != dirbuf)
771 strcpy(found, name_found);
773 if (S_ISDIR(st.st_mode)) {
774 unsigned len1 = strlen(found);
775 /* name is a directory */
776 if (found[len1-1] != '/') {
777 found = xrealloc(found, len1 + 2);
779 found[len1 + 1] = '\0';
782 /* skip files if looking for dirs only (example: cd) */
783 if (type == FIND_DIR_ONLY)
786 /* add it to the list */
793 } /* for every path */
795 if (paths != path1) {
796 free(paths[0]); /* allocated memory is only in first member */
802 /* QUOT is used on elements of int_buf[], which are bytes,
803 * not Unicode chars. Therefore it works correctly even in Unicode mode.
805 #define QUOT (UCHAR_MAX+1)
807 #define int_buf (S.find_match__int_buf)
808 #define pos_buf (S.find_match__pos_buf)
809 /* is must be <= in */
810 static void collapse_pos(int is, int in)
812 memmove(int_buf+is, int_buf+in, (MAX_LINELEN+1-in) * sizeof(int_buf[0]));
813 memmove(pos_buf+is, pos_buf+in, (MAX_LINELEN+1-in) * sizeof(pos_buf[0]));
815 /* On entry, matchBuf contains everything up to cursor at the moment <tab>
816 * was pressed. This function looks at it, figures out what part of it
817 * constitutes the command/file/directory prefix to use for completion,
818 * and rewrites matchBuf to contain only that part.
820 static NOINLINE int build_match_prefix(char *matchBuf, int *len_with_quotes)
825 /* Were local, but it used too much stack */
826 /* int16_t int_buf[MAX_LINELEN + 1]; */
827 /* int16_t pos_buf[MAX_LINELEN + 1]; */
829 /* set to integer dimension characters and own positions */
831 int_buf[i] = (unsigned char)matchBuf[i];
832 if (int_buf[i] == 0) {
833 pos_buf[i] = -1; /* end-fo-line indicator */
839 /* mask \+symbol and convert '\t' to ' ' */
840 for (i = j = 0; matchBuf[i]; i++, j++) {
841 if (matchBuf[i] == '\\') {
842 collapse_pos(j, j + 1);
847 /* mask "symbols" or 'symbols' */
849 for (i = 0; int_buf[i]; i++) {
851 if (c == '\'' || c == '"') {
860 } else if (c2 != 0 && c != '$')
864 /* skip commands with arguments if line has commands delimiters */
865 /* ';' ';;' '&' '|' '&&' '||' but '>&' '<&' '>|' */
866 for (i = 0; int_buf[i]; i++) {
870 j = i ? int_buf[i - 1] : -1;
872 if (c == ';' || c == '&' || c == '|') {
875 if (j == '>' || j == '<')
877 } else if (c == '|' && j == '>')
881 collapse_pos(0, i + n);
882 i = -1; /* hack incremet */
885 /* collapse `command...` */
886 for (i = 0; int_buf[i]; i++) {
887 if (int_buf[i] == '`') {
888 for (j = i + 1; int_buf[j]; j++)
889 if (int_buf[j] == '`') {
890 collapse_pos(i, j + 1);
895 /* not found closing ` - command mode, collapse all previous */
896 collapse_pos(0, i + 1);
899 i--; /* hack incremet */
903 /* collapse (command...(command...)...) or {command...{command...}...} */
904 c = 0; /* "recursive" level */
906 for (i = 0; int_buf[i]; i++) {
907 if (int_buf[i] == '(' || int_buf[i] == '{') {
908 if (int_buf[i] == '(')
912 collapse_pos(0, i + 1);
913 i = -1; /* hack incremet */
916 for (i = 0; pos_buf[i] >= 0 && (c > 0 || c2 > 0); i++) {
917 if ((int_buf[i] == ')' && c > 0) || (int_buf[i] == '}' && c2 > 0)) {
918 if (int_buf[i] == ')')
922 collapse_pos(0, i + 1);
923 i = -1; /* hack incremet */
927 /* skip first not quote space */
928 for (i = 0; int_buf[i]; i++)
929 if (int_buf[i] != ' ')
934 /* set find mode for completion */
935 command_mode = FIND_EXE_ONLY;
936 for (i = 0; int_buf[i]; i++) {
937 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
938 if (int_buf[i] == ' ' && command_mode == FIND_EXE_ONLY
939 && matchBuf[pos_buf[0]] == 'c'
940 && matchBuf[pos_buf[1]] == 'd'
942 command_mode = FIND_DIR_ONLY;
944 command_mode = FIND_FILE_ONLY;
949 for (i = 0; int_buf[i]; i++) /* quasi-strlen(int_buf) */
952 for (--i; i >= 0; i--) {
954 if (c == ' ' || c == '<' || c == '>' || c == '|' || c == '&') {
955 collapse_pos(0, i + 1);
959 /* skip first not quoted '\'' or '"' */
960 for (i = 0; int_buf[i] == '\'' || int_buf[i] == '"'; i++)
962 /* collapse quote or unquote // or /~ */
963 while ((int_buf[i] & ~QUOT) == '/'
964 && ((int_buf[i+1] & ~QUOT) == '/' || (int_buf[i+1] & ~QUOT) == '~')
969 /* set only match and destroy quotes */
971 for (c = 0; pos_buf[i] >= 0; i++) {
972 matchBuf[c++] = matchBuf[pos_buf[i]];
976 /* old length matchBuf with quotes symbols */
977 *len_with_quotes = j ? j - pos_buf[0] : 0;
985 * display by column (original idea from ls applet,
986 * very optimized by me :)
988 static void showfiles(void)
991 int column_width = 0;
992 int nfiles = num_matches;
996 /* find the longest file name - use that as the column width */
997 for (row = 0; row < nrows; row++) {
998 l = unicode_strwidth(matches[row]);
999 if (column_width < l)
1002 column_width += 2; /* min space for columns */
1003 ncols = cmdedit_termw / column_width;
1008 nrows++; /* round up fractionals */
1012 for (row = 0; row < nrows; row++) {
1016 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1017 printf("%s%-*s", matches[n],
1018 (int)(column_width - unicode_strwidth(matches[n])), ""
1021 if (ENABLE_UNICODE_SUPPORT)
1022 puts(printable_string(NULL, matches[n]));
1028 static char *add_quote_for_spec_chars(char *found)
1031 char *s = xzalloc((strlen(found) + 1) * 2);
1034 if (strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", *found))
1038 /* s[l] = '\0'; - already is */
1042 /* Do TAB completion */
1043 static void input_tab(smallint *lastWasTab)
1045 if (!(state->flags & TAB_COMPLETION))
1051 /* char matchBuf[MAX_LINELEN]; */
1052 #define matchBuf (S.input_tab__matchBuf)
1055 #if ENABLE_UNICODE_SUPPORT
1056 /* cursor pos in command converted to multibyte form */
1060 *lastWasTab = TRUE; /* flop trigger */
1062 /* Make a local copy of the string --
1063 * up to the position of the cursor */
1064 #if !ENABLE_UNICODE_SUPPORT
1065 save_string(matchBuf, cursor + 1);
1068 CHAR_T wc = command_ps[cursor];
1069 command_ps[cursor] = 0;
1070 save_string(matchBuf, MAX_LINELEN);
1071 command_ps[cursor] = wc;
1072 cursor_mb = strlen(matchBuf);
1077 find_type = build_match_prefix(matchBuf, &recalc_pos);
1079 /* Free up any memory already allocated */
1080 free_tab_completion_data();
1082 #if ENABLE_FEATURE_USERNAME_COMPLETION
1083 /* If the word starts with `~' and there is no slash in the word,
1084 * then try completing this word as a username. */
1085 if (state->flags & USERNAME_COMPLETION)
1086 if (matchBuf[0] == '~' && strchr(matchBuf, '/') == NULL)
1087 username_completion(matchBuf);
1089 /* Try to match any executable in our path and everything
1090 * in the current working directory */
1092 exe_n_cwd_tab_completion(matchBuf, find_type);
1093 /* Sort, then remove any duplicates found */
1097 qsort_string_vector(matches, num_matches);
1098 for (i = 0; i < num_matches - 1; ++i) {
1099 if (matches[i] && matches[i+1]) { /* paranoia */
1100 if (strcmp(matches[i], matches[i+1]) == 0) {
1102 matches[i] = NULL; /* paranoia */
1104 matches[n++] = matches[i];
1108 matches[n++] = matches[i];
1111 /* Did we find exactly one match? */
1112 if (num_matches != 1) { /* no */
1115 return; /* no matches at all */
1116 /* find minimal match */
1117 tmp1 = xstrdup(matches[0]);
1118 for (tmp = tmp1; *tmp; tmp++) {
1119 for (len_found = 1; len_found < num_matches; len_found++) {
1120 if (matches[len_found][tmp - tmp1] != *tmp) {
1126 if (*tmp1 == '\0') { /* have unique pfx? */
1127 free(tmp1); /* no */
1130 tmp = add_quote_for_spec_chars(tmp1);
1132 len_found = strlen(tmp);
1133 } else { /* exactly one match */
1134 tmp = add_quote_for_spec_chars(matches[0]);
1135 /* for next completion current found */
1136 *lastWasTab = FALSE;
1138 len_found = strlen(tmp);
1139 if (tmp[len_found-1] != '/') {
1140 tmp[len_found] = ' ';
1141 tmp[++len_found] = '\0';
1145 #if !ENABLE_UNICODE_SUPPORT
1146 /* have space to place the match? */
1147 /* The result consists of three parts with these lengths: */
1148 /* (cursor - recalc_pos) + len_found + (command_len - cursor) */
1149 /* it simplifies into: */
1150 if ((int)(len_found + command_len - recalc_pos) < S.maxsize) {
1152 strcpy(matchBuf, command_ps + cursor);
1153 /* add match and tail */
1154 sprintf(&command_ps[cursor - recalc_pos], "%s%s", tmp, matchBuf);
1155 command_len = strlen(command_ps);
1157 recalc_pos = cursor - recalc_pos + len_found;
1158 /* write out the matched command */
1159 redraw(cmdedit_y, command_len - recalc_pos);
1163 char command[MAX_LINELEN];
1164 int len = save_string(command, sizeof(command));
1165 /* have space to place the match? */
1166 /* (cursor_mb - recalc_pos) + len_found + (len - cursor_mb) */
1167 if ((int)(len_found + len - recalc_pos) < MAX_LINELEN) {
1169 strcpy(matchBuf, command + cursor_mb);
1170 /* where do we want to have cursor after all? */
1171 strcpy(&command[cursor_mb - recalc_pos], tmp);
1172 len = load_string(command, S.maxsize);
1173 /* add match and tail */
1174 sprintf(&command[cursor_mb - recalc_pos], "%s%s", tmp, matchBuf);
1175 command_len = load_string(command, S.maxsize);
1176 /* write out the matched command */
1177 /* paranoia: load_string can return 0 on conv error,
1178 * prevent passing len = (0 - 12) to redraw */
1179 len = command_len - len;
1180 redraw(cmdedit_y, len >= 0 ? len : 0);
1187 /* Ok -- the last char was a TAB. Since they
1188 * just hit TAB again, print a list of all the
1189 * available choices... */
1190 if (matches && num_matches > 0) {
1191 /* changed by goto_new_line() */
1192 int sav_cursor = cursor;
1194 /* Go to the next line */
1197 redraw(0, command_len - sav_cursor);
1202 #endif /* FEATURE_COMMAND_TAB_COMPLETION */
1205 line_input_t* FAST_FUNC new_line_input_t(int flags)
1207 line_input_t *n = xzalloc(sizeof(*n));
1215 static void save_command_ps_at_cur_history(void)
1217 if (command_ps[0] != BB_NUL) {
1218 int cur = state->cur_history;
1219 free(state->history[cur]);
1221 # if ENABLE_UNICODE_SUPPORT
1223 char tbuf[MAX_LINELEN];
1224 save_string(tbuf, sizeof(tbuf));
1225 state->history[cur] = xstrdup(tbuf);
1228 state->history[cur] = xstrdup(command_ps);
1233 /* state->flags is already checked to be nonzero */
1234 static int get_previous_history(void)
1236 if ((state->flags & DO_HISTORY) && state->cur_history) {
1237 save_command_ps_at_cur_history();
1238 state->cur_history--;
1245 static int get_next_history(void)
1247 if (state->flags & DO_HISTORY) {
1248 if (state->cur_history < state->cnt_history) {
1249 save_command_ps_at_cur_history(); /* save the current history line */
1250 return ++state->cur_history;
1257 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1258 /* We try to ensure that concurrent additions to the history
1259 * do not overwrite each other.
1260 * Otherwise shell users get unhappy.
1262 * History file is trimmed lazily, when it grows several times longer
1263 * than configured MAX_HISTORY lines.
1266 static void free_line_input_t(line_input_t *n)
1268 int i = n->cnt_history;
1270 free(n->history[--i]);
1274 /* state->flags is already checked to be nonzero */
1275 static void load_history(line_input_t *st_parm)
1277 char *temp_h[MAX_HISTORY];
1280 unsigned idx, i, line_len;
1282 /* NB: do not trash old history if file can't be opened */
1284 fp = fopen_for_read(st_parm->hist_file);
1286 /* clean up old history */
1287 for (idx = st_parm->cnt_history; idx > 0;) {
1289 free(st_parm->history[idx]);
1290 st_parm->history[idx] = NULL;
1293 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1294 memset(temp_h, 0, sizeof(temp_h));
1295 st_parm->cnt_history_in_file = idx = 0;
1296 while ((line = xmalloc_fgetline(fp)) != NULL) {
1297 if (line[0] == '\0') {
1303 st_parm->cnt_history_in_file++;
1305 if (idx == MAX_HISTORY)
1310 /* find first non-NULL temp_h[], if any */
1311 if (st_parm->cnt_history_in_file) {
1312 while (temp_h[idx] == NULL) {
1314 if (idx == MAX_HISTORY)
1319 /* copy temp_h[] to st_parm->history[] */
1320 for (i = 0; i < MAX_HISTORY;) {
1325 if (idx == MAX_HISTORY)
1327 line_len = strlen(line);
1328 if (line_len >= MAX_LINELEN)
1329 line[MAX_LINELEN-1] = '\0';
1330 st_parm->history[i++] = line;
1332 st_parm->cnt_history = i;
1336 /* state->flags is already checked to be nonzero */
1337 static void save_history(char *str)
1342 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0666);
1345 xlseek(fd, 0, SEEK_END); /* paranoia */
1347 str[len] = '\n'; /* we (try to) do atomic write */
1348 len2 = full_write(fd, str, len + 1);
1351 if (len2 != len + 1)
1352 return; /* "wtf?" */
1354 /* did we write so much that history file needs trimming? */
1355 state->cnt_history_in_file++;
1356 if (state->cnt_history_in_file > MAX_HISTORY * 4) {
1359 line_input_t *st_temp;
1362 /* we may have concurrently written entries from others.
1364 st_temp = new_line_input_t(state->flags);
1365 st_temp->hist_file = state->hist_file;
1366 load_history(st_temp);
1368 /* write out temp file and replace hist_file atomically */
1369 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1370 fp = fopen_for_write(new_name);
1372 for (i = 0; i < st_temp->cnt_history; i++)
1373 fprintf(fp, "%s\n", st_temp->history[i]);
1375 if (rename(new_name, state->hist_file) == 0)
1376 state->cnt_history_in_file = st_temp->cnt_history;
1379 free_line_input_t(st_temp);
1383 # define load_history(a) ((void)0)
1384 # define save_history(a) ((void)0)
1385 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1387 static void remember_in_history(char *str)
1391 if (!(state->flags & DO_HISTORY))
1395 i = state->cnt_history;
1396 /* Don't save dupes */
1397 if (i && strcmp(state->history[i-1], str) == 0)
1400 free(state->history[MAX_HISTORY]); /* redundant, paranoia */
1401 state->history[MAX_HISTORY] = NULL; /* redundant, paranoia */
1403 /* If history[] is full, remove the oldest command */
1404 /* we need to keep history[MAX_HISTORY] empty, hence >=, not > */
1405 if (i >= MAX_HISTORY) {
1406 free(state->history[0]);
1407 for (i = 0; i < MAX_HISTORY-1; i++)
1408 state->history[i] = state->history[i+1];
1409 /* i == MAX_HISTORY-1 */
1411 /* i <= MAX_HISTORY-1 */
1412 state->history[i++] = xstrdup(str);
1413 /* i <= MAX_HISTORY */
1414 state->cur_history = i;
1415 state->cnt_history = i;
1416 # if MAX_HISTORY > 0 && ENABLE_FEATURE_EDITING_SAVEHISTORY
1417 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1420 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1423 #else /* MAX_HISTORY == 0 */
1424 # define remember_in_history(a) ((void)0)
1425 #endif /* MAX_HISTORY */
1428 #if ENABLE_FEATURE_EDITING_VI
1430 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1433 vi_Word_motion(int eat)
1435 CHAR_T *command = command_ps;
1437 while (cursor < command_len && !BB_isspace(command[cursor]))
1439 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1444 vi_word_motion(int eat)
1446 CHAR_T *command = command_ps;
1448 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1449 while (cursor < command_len
1450 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1454 } else if (BB_ispunct(command[cursor])) {
1455 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1459 if (cursor < command_len)
1463 while (cursor < command_len && BB_isspace(command[cursor]))
1471 CHAR_T *command = command_ps;
1474 while (cursor < command_len && BB_isspace(command[cursor]))
1476 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1483 CHAR_T *command = command_ps;
1485 if (cursor >= command_len-1)
1488 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1490 if (cursor >= command_len-1)
1492 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1493 while (cursor < command_len-1
1494 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1498 } else if (BB_ispunct(command[cursor])) {
1499 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1505 vi_Back_motion(void)
1507 CHAR_T *command = command_ps;
1509 while (cursor > 0 && BB_isspace(command[cursor-1]))
1511 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1516 vi_back_motion(void)
1518 CHAR_T *command = command_ps;
1523 while (cursor > 0 && BB_isspace(command[cursor]))
1527 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1529 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1533 } else if (BB_ispunct(command[cursor])) {
1534 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1540 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1541 static void ctrl_left(void)
1543 CHAR_T *command = command_ps;
1551 c = command[cursor];
1552 if (c != ' ' && !BB_ispunct(c)) {
1553 /* we reached a "word" delimited by spaces/punct.
1554 * go to its beginning */
1556 c = command[cursor - 1];
1557 if (c == ' ' || BB_ispunct(c))
1567 static void ctrl_right(void)
1569 CHAR_T *command = command_ps;
1574 c = command[cursor];
1577 if (c != ' ' && !BB_ispunct(c)) {
1578 /* we reached a "word" delimited by spaces/punct.
1579 * go to its end + 1 */
1582 c = command[cursor];
1583 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1594 * read_line_input and its helpers
1597 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1598 static void ask_terminal(void)
1600 /* Ask terminal where is the cursor now.
1601 * lineedit_read_key handles response and corrects
1602 * our idea of current cursor position.
1603 * Testcase: run "echo -n long_line_long_line_long_line",
1604 * then type in a long, wrapping command and try to
1605 * delete it using backspace key.
1606 * Note: we print it _after_ prompt, because
1607 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1609 /* Problem: if there is buffered input on stdin,
1610 * the response will be delivered later,
1611 * possibly to an unsuspecting application.
1612 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1614 * ~/srcdevel/bbox/fix/busybox.t4 #
1615 * ~/srcdevel/bbox/fix/busybox.t4 #
1616 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1617 * ~/srcdevel/bbox/fix/busybox.t4 #
1619 * Checking for input with poll only makes the race narrower,
1620 * I still can trigger it. Strace:
1622 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1623 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1624 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1625 * poll([{fd=0, events=POLLIN}], 1, 4294967295) = 1 ([{fd=0, revents=POLLIN}])
1626 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1630 pfd.fd = STDIN_FILENO;
1631 pfd.events = POLLIN;
1632 if (safe_poll(&pfd, 1, 0) == 0) {
1633 S.sent_ESC_br6n = 1;
1634 fputs("\033" "[6n", stdout);
1635 fflush_all(); /* make terminal see it ASAP! */
1639 #define ask_terminal() ((void)0)
1642 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1643 static void parse_and_put_prompt(const char *prmt_ptr)
1645 cmdedit_prompt = prmt_ptr;
1646 cmdedit_prmt_len = strlen(prmt_ptr);
1650 static void parse_and_put_prompt(const char *prmt_ptr)
1653 size_t cur_prmt_len = 0;
1654 char flg_not_length = '[';
1655 char *prmt_mem_ptr = xzalloc(1);
1656 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1661 cmdedit_prmt_len = 0;
1664 cwd_buf = (char *)bb_msg_unknown;
1667 cbuf[1] = '\0'; /* never changes */
1670 char *free_me = NULL;
1675 const char *cp = prmt_ptr;
1678 c = bb_process_escape_sequence(&prmt_ptr);
1679 if (prmt_ptr == cp) {
1685 # if ENABLE_USERNAME_OR_HOMEDIR
1687 pbuf = user_buf ? user_buf : (char*)"";
1691 pbuf = free_me = safe_gethostname();
1692 *strchrnul(pbuf, '.') = '\0';
1695 c = (geteuid() == 0 ? '#' : '$');
1697 # if ENABLE_USERNAME_OR_HOMEDIR
1699 /* /home/user[/something] -> ~[/something] */
1701 l = strlen(home_pwd_buf);
1703 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1704 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1705 && strlen(cwd_buf + l) < PATH_MAX
1707 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1713 cp = strrchr(pbuf, '/');
1714 if (cp != NULL && cp != pbuf)
1715 pbuf += (cp-pbuf) + 1;
1718 pbuf = free_me = xasprintf("%d", num_ok_lines);
1720 case 'e': case 'E': /* \e \E = \033 */
1723 case 'x': case 'X': {
1725 for (l = 0; l < 3;) {
1727 buf2[l++] = *prmt_ptr;
1729 h = strtoul(buf2, &pbuf, 16);
1730 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1736 c = (char)strtoul(buf2, NULL, 16);
1743 if (c == flg_not_length) {
1744 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1752 cur_prmt_len = strlen(pbuf);
1753 prmt_len += cur_prmt_len;
1754 if (flg_not_length != ']')
1755 cmdedit_prmt_len += cur_prmt_len;
1756 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1760 if (cwd_buf != (char *)bb_msg_unknown)
1762 cmdedit_prompt = prmt_mem_ptr;
1767 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1771 /* new y for current cursor */
1772 int new_y = (cursor + cmdedit_prmt_len) / w;
1774 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1779 static void win_changed(int nsig)
1781 int sv_errno = errno;
1783 get_terminal_width_height(0, &width, NULL);
1784 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1785 if (nsig == SIGWINCH)
1786 signal(SIGWINCH, win_changed); /* rearm ourself */
1790 static int lineedit_read_key(char *read_key_buffer)
1794 #if ENABLE_UNICODE_SUPPORT
1795 char unicode_buf[MB_CUR_MAX + 1];
1796 int unicode_idx = 0;
1800 /* Wait for input. TIMEOUT = -1 makes read_key wait even
1801 * on nonblocking stdin, TIMEOUT = 50 makes sure we won't
1802 * insist on full MB_CUR_MAX buffer to declare input like
1803 * "\xff\n",pause,"ls\n" invalid and thus won't lose "ls".
1805 * Note: read_key sets errno to 0 on success.
1807 ic = read_key(STDIN_FILENO, read_key_buffer, timeout);
1809 #if ENABLE_UNICODE_SUPPORT
1810 if (errno == EAGAIN && unicode_idx != 0)
1816 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1817 if ((int32_t)ic == KEYCODE_CURSOR_POS
1820 S.sent_ESC_br6n = 0;
1821 if (cursor == 0) { /* otherwise it may be bogus */
1822 int col = ((ic >> 32) & 0x7fff) - 1;
1823 if (col > cmdedit_prmt_len) {
1824 cmdedit_x += (col - cmdedit_prmt_len);
1825 while (cmdedit_x >= cmdedit_termw) {
1826 cmdedit_x -= cmdedit_termw;
1835 #if ENABLE_UNICODE_SUPPORT
1836 if (unicode_status == UNICODE_ON) {
1839 if ((int32_t)ic < 0) /* KEYCODE_xxx */
1841 // TODO: imagine sequence like: 0xff,<left-arrow>: we are currently losing 0xff...
1843 unicode_buf[unicode_idx++] = ic;
1844 unicode_buf[unicode_idx] = '\0';
1845 if (mbstowcs(&wc, unicode_buf, 1) != 1) {
1846 /* Not (yet?) a valid unicode char */
1847 if (unicode_idx < MB_CUR_MAX) {
1852 /* Invalid sequence. Save all "bad bytes" except first */
1853 read_key_ungets(read_key_buffer, unicode_buf + 1, unicode_idx - 1);
1854 # if !ENABLE_UNICODE_PRESERVE_BROKEN
1855 ic = CONFIG_SUBST_WCHAR;
1857 ic = unicode_mark_raw_byte(unicode_buf[0]);
1860 /* Valid unicode char, return its code */
1871 #if ENABLE_UNICODE_BIDI_SUPPORT
1872 static int isrtl_str(void)
1876 while (idx < command_len && unicode_bidi_is_neutral_wchar(command_ps[idx]))
1878 return unicode_bidi_isrtl(command_ps[idx]);
1881 # define isrtl_str() 0
1884 /* leave out the "vi-mode"-only case labels if vi editing isn't
1886 #define vi_case(caselabel) IF_FEATURE_EDITING_VI(case caselabel)
1888 /* convert uppercase ascii to equivalent control char, for readability */
1890 #define CTRL(a) ((a) & ~0x40)
1892 /* maxsize must be >= 2.
1894 * -1 on read errors or EOF, or on bare Ctrl-D,
1895 * 0 on ctrl-C (the line entered is still returned in 'command'),
1896 * >0 length of input string, including terminating '\n'
1898 int FAST_FUNC read_line_input(const char *prompt, char *command, int maxsize, line_input_t *st)
1901 #if ENABLE_FEATURE_TAB_COMPLETION
1902 smallint lastWasTab = FALSE;
1904 smallint break_out = 0;
1905 #if ENABLE_FEATURE_EDITING_VI
1906 smallint vi_cmdmode = 0;
1908 struct termios initial_settings;
1909 struct termios new_settings;
1910 char read_key_buffer[KEYCODE_BUFFER_SIZE];
1914 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
1915 || !(initial_settings.c_lflag & ECHO)
1917 /* Happens when e.g. stty -echo was run before */
1918 parse_and_put_prompt(prompt);
1919 /* fflush_all(); - done by parse_and_put_prompt */
1920 if (fgets(command, maxsize, stdin) == NULL)
1921 len = -1; /* EOF or error */
1923 len = strlen(command);
1930 // FIXME: audit & improve this
1931 if (maxsize > MAX_LINELEN)
1932 maxsize = MAX_LINELEN;
1933 S.maxsize = maxsize;
1935 /* With null flags, no other fields are ever used */
1936 state = st ? st : (line_input_t*) &const_int_0;
1938 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1939 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1940 if (state->cnt_history == 0)
1941 load_history(state);
1943 if (state->flags & DO_HISTORY)
1944 state->cur_history = state->cnt_history;
1947 /* prepare before init handlers */
1948 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
1950 #if ENABLE_UNICODE_SUPPORT
1951 command_ps = xzalloc(maxsize * sizeof(command_ps[0]));
1953 command_ps = command;
1956 #define command command_must_not_be_used
1958 new_settings = initial_settings;
1959 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
1960 /* Turn off echoing and CTRL-C, so we can trap it */
1961 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
1962 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
1963 new_settings.c_cc[VMIN] = 1;
1964 new_settings.c_cc[VTIME] = 0;
1965 /* Turn off CTRL-C, so we can trap it */
1966 #ifndef _POSIX_VDISABLE
1967 # define _POSIX_VDISABLE '\0'
1969 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
1970 tcsetattr_stdin_TCSANOW(&new_settings);
1972 /* Now initialize things */
1973 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
1974 win_changed(0); /* do initial resizing */
1975 #if ENABLE_USERNAME_OR_HOMEDIR
1977 struct passwd *entry;
1979 entry = getpwuid(geteuid());
1981 user_buf = xstrdup(entry->pw_name);
1982 home_pwd_buf = xstrdup(entry->pw_dir);
1988 for (i = 0; i <= MAX_HISTORY; i++)
1989 bb_error_msg("history[%d]:'%s'", i, state->history[i]);
1990 bb_error_msg("cur_history:%d cnt_history:%d", state->cur_history, state->cnt_history);
1993 /* Print out the command prompt, optionally ask where cursor is */
1994 parse_and_put_prompt(prompt);
1997 read_key_buffer[0] = 0;
2000 * The emacs and vi modes share much of the code in the big
2001 * command loop. Commands entered when in vi's command mode
2002 * (aka "escape mode") get an extra bit added to distinguish
2003 * them - this keeps them from being self-inserted. This
2004 * clutters the big switch a bit, but keeps all the code
2008 VI_CMDMODE_BIT = 0x40000000,
2009 /* 0x80000000 bit flags KEYCODE_xxx */
2014 ic = ic_raw = lineedit_read_key(read_key_buffer);
2016 #if ENABLE_FEATURE_EDITING_VI
2019 /* btw, since KEYCODE_xxx are all < 0, this doesn't
2020 * change ic if it contains one of them: */
2021 ic |= VI_CMDMODE_BIT;
2028 vi_case('\n'|VI_CMDMODE_BIT:)
2029 vi_case('\r'|VI_CMDMODE_BIT:)
2035 vi_case('0'|VI_CMDMODE_BIT:)
2036 /* Control-a -- Beginning of line */
2037 input_backward(cursor);
2040 vi_case('h'|VI_CMDMODE_BIT:)
2041 vi_case('\b'|VI_CMDMODE_BIT:) /* ^H */
2042 vi_case('\x7f'|VI_CMDMODE_BIT:) /* DEL */
2043 input_backward(1); /* Move back one character */
2046 vi_case('$'|VI_CMDMODE_BIT:)
2047 /* Control-e -- End of line */
2048 put_till_end_and_adv_cursor();
2051 vi_case('l'|VI_CMDMODE_BIT:)
2052 vi_case(' '|VI_CMDMODE_BIT:)
2053 input_forward(); /* Move forward one character */
2056 case '\x7f': /* DEL */
2062 case KEYCODE_DELETE:
2068 #if ENABLE_FEATURE_TAB_COMPLETION
2070 input_tab(&lastWasTab);
2074 /* Control-k -- clear to end of line */
2075 command_ps[cursor] = BB_NUL;
2076 command_len = cursor;
2077 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
2080 vi_case(CTRL('L')|VI_CMDMODE_BIT:)
2081 /* Control-l -- clear screen */
2082 printf("\033[H"); /* cursor to top,left */
2083 redraw(0, command_len - cursor);
2087 vi_case(CTRL('N')|VI_CMDMODE_BIT:)
2088 vi_case('j'|VI_CMDMODE_BIT:)
2089 /* Control-n -- Get next command in history */
2090 if (get_next_history())
2094 vi_case(CTRL('P')|VI_CMDMODE_BIT:)
2095 vi_case('k'|VI_CMDMODE_BIT:)
2096 /* Control-p -- Get previous command from history */
2097 if (get_previous_history())
2102 vi_case(CTRL('U')|VI_CMDMODE_BIT:)
2103 /* Control-U -- Clear line before cursor */
2105 command_len -= cursor;
2106 memmove(command_ps, command_ps + cursor,
2107 (command_len + 1) * sizeof(command_ps[0]));
2108 redraw(cmdedit_y, command_len);
2112 vi_case(CTRL('W')|VI_CMDMODE_BIT:)
2113 /* Control-W -- Remove the last word */
2114 while (cursor > 0 && BB_isspace(command_ps[cursor-1]))
2116 while (cursor > 0 && !BB_isspace(command_ps[cursor-1]))
2120 #if ENABLE_FEATURE_EDITING_VI
2121 case 'i'|VI_CMDMODE_BIT:
2124 case 'I'|VI_CMDMODE_BIT:
2125 input_backward(cursor);
2128 case 'a'|VI_CMDMODE_BIT:
2132 case 'A'|VI_CMDMODE_BIT:
2133 put_till_end_and_adv_cursor();
2136 case 'x'|VI_CMDMODE_BIT:
2139 case 'X'|VI_CMDMODE_BIT:
2145 case 'W'|VI_CMDMODE_BIT:
2148 case 'w'|VI_CMDMODE_BIT:
2151 case 'E'|VI_CMDMODE_BIT:
2154 case 'e'|VI_CMDMODE_BIT:
2157 case 'B'|VI_CMDMODE_BIT:
2160 case 'b'|VI_CMDMODE_BIT:
2163 case 'C'|VI_CMDMODE_BIT:
2166 case 'D'|VI_CMDMODE_BIT:
2169 case 'c'|VI_CMDMODE_BIT:
2172 case 'd'|VI_CMDMODE_BIT: {
2175 ic = lineedit_read_key(read_key_buffer);
2176 if (errno) /* error */
2177 goto prepare_to_die;
2178 if (ic == ic_raw) { /* "cc", "dd" */
2179 input_backward(cursor);
2191 case 'w': /* "dw", "cw" */
2192 vi_word_motion(vi_cmdmode);
2194 case 'W': /* 'dW', 'cW' */
2195 vi_Word_motion(vi_cmdmode);
2197 case 'e': /* 'de', 'ce' */
2201 case 'E': /* 'dE', 'cE' */
2207 input_backward(cursor - sc);
2208 while (nc-- > cursor)
2211 case 'b': /* "db", "cb" */
2212 case 'B': /* implemented as B */
2217 while (sc-- > cursor)
2220 case ' ': /* "d ", "c " */
2223 case '$': /* "d$", "c$" */
2225 while (cursor < command_len)
2231 case 'p'|VI_CMDMODE_BIT:
2234 case 'P'|VI_CMDMODE_BIT:
2237 case 'r'|VI_CMDMODE_BIT:
2238 //FIXME: unicode case?
2239 ic = lineedit_read_key(read_key_buffer);
2240 if (errno) /* error */
2241 goto prepare_to_die;
2242 if (ic < ' ' || ic > 255) {
2245 command_ps[cursor] = ic;
2250 case '\x1b': /* ESC */
2251 if (state->flags & VI_MODE) {
2252 /* insert mode --> command mode */
2257 #endif /* FEATURE_COMMAND_EDITING_VI */
2261 if (get_previous_history())
2266 if (!get_next_history())
2269 /* Rewrite the line with the selected history item */
2270 /* change command */
2271 command_len = load_string(state->history[state->cur_history] ?
2272 state->history[state->cur_history] : "", maxsize);
2273 /* redraw and go to eol (bol, in vi) */
2274 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
2283 case KEYCODE_CTRL_LEFT:
2286 case KEYCODE_CTRL_RIGHT:
2290 input_backward(cursor);
2293 put_till_end_and_adv_cursor();
2297 if (initial_settings.c_cc[VINTR] != 0
2298 && ic_raw == initial_settings.c_cc[VINTR]
2300 /* Ctrl-C (usually) - stop gathering input */
2303 break_out = -1; /* "do not append '\n'" */
2306 if (initial_settings.c_cc[VEOF] != 0
2307 && ic_raw == initial_settings.c_cc[VEOF]
2309 /* Ctrl-D (usually) - delete one character,
2310 * or exit if len=0 and no chars to delete */
2311 if (command_len == 0) {
2313 #if ENABLE_FEATURE_EDITING_VI
2316 break_out = command_len = -1;
2322 // /* Control-V -- force insert of next char */
2323 // if (c == CTRL('V')) {
2324 // if (safe_read(STDIN_FILENO, &c, 1) < 1)
2325 // goto prepare_to_die;
2332 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2333 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2335 /* If VI_CMDMODE_BIT is set, ic is >= 256
2336 * and vi mode ignores unexpected chars.
2337 * Otherwise, we are here if ic is a
2338 * control char or an unhandled ESC sequence,
2339 * which is also ignored.
2343 if ((int)command_len >= (maxsize - 2)) {
2344 /* Not enough space for the char and EOL */
2349 if (cursor == (command_len - 1)) {
2350 /* We are at the end, append */
2351 command_ps[cursor] = ic;
2352 command_ps[cursor + 1] = BB_NUL;
2353 put_cur_glyph_and_inc_cursor();
2354 if (unicode_bidi_isrtl(ic))
2357 /* In the middle, insert */
2360 memmove(command_ps + sc + 1, command_ps + sc,
2361 (command_len - sc) * sizeof(command_ps[0]));
2362 command_ps[sc] = ic;
2363 /* is right-to-left char, or neutral one (e.g. comma) was just added to rtl text? */
2366 put_till_end_and_adv_cursor();
2367 /* to prev x pos + 1 */
2368 input_backward(cursor - sc);
2376 #if ENABLE_FEATURE_TAB_COMPLETION
2382 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
2383 if (S.sent_ESC_br6n) {
2384 /* "sleep 1; busybox ash" + hold [Enter] to trigger.
2385 * We sent "ESC [ 6 n", but got '\n' first, and
2386 * KEYCODE_CURSOR_POS response is now buffered from terminal.
2387 * It's bad already and not much can be done with it
2388 * (it _will_ be visible for the next process to read stdin),
2389 * but without this delay it even shows up on the screen
2390 * as garbage because we restore echo settings with tcsetattr
2391 * before it comes in. UGLY!
2397 /* End of bug-catching "command_must_not_be_used" trick */
2400 #if ENABLE_UNICODE_SUPPORT
2402 if (command_len > 0)
2403 command_len = save_string(command, maxsize - 1);
2407 if (command_len > 0)
2408 remember_in_history(command);
2410 if (break_out > 0) {
2411 command[command_len++] = '\n';
2412 command[command_len] = '\0';
2415 #if ENABLE_FEATURE_TAB_COMPLETION
2416 free_tab_completion_data();
2419 /* restore initial_settings */
2420 tcsetattr_stdin_TCSANOW(&initial_settings);
2421 /* restore SIGWINCH handler */
2422 signal(SIGWINCH, previous_SIGWINCH_handler);
2428 return len; /* can't return command_len, DEINIT_S() destroys it */
2431 #else /* !FEATURE_EDITING */
2433 #undef read_line_input
2434 int FAST_FUNC read_line_input(const char* prompt, char* command, int maxsize)
2436 fputs(prompt, stdout);
2438 fgets(command, maxsize, stdin);
2439 return strlen(command);
2442 #endif /* !FEATURE_EDITING */
2453 const char *applet_name = "debug stuff usage";
2455 int main(int argc, char **argv)
2457 char buff[MAX_LINELEN];
2459 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
2460 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
2461 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
2462 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
2469 l = read_line_input(prompt, buff);
2470 if (l <= 0 || buff[l-1] != '\n')
2473 printf("*** read_line_input() returned line =%s=\n", buff);
2475 printf("*** read_line_input() detect ^D\n");