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 exe_n_cwd_tab_completion__dirbuf[MAX_LINELEN];
158 char input_tab__matchBuf[MAX_LINELEN];
159 int16_t find_match__int_buf[MAX_LINELEN + 1]; /* need to have 9 bits at least */
160 int16_t find_match__pos_buf[MAX_LINELEN + 1];
164 /* See lineedit_ptr_hack.c */
165 extern struct lineedit_statics *const lineedit_ptr_to_statics;
167 #define S (*lineedit_ptr_to_statics)
168 #define state (S.state )
169 #define cmdedit_termw (S.cmdedit_termw )
170 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
171 #define cmdedit_x (S.cmdedit_x )
172 #define cmdedit_y (S.cmdedit_y )
173 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
174 #define cursor (S.cursor )
175 #define command_len (S.command_len )
176 #define command_ps (S.command_ps )
177 #define cmdedit_prompt (S.cmdedit_prompt )
178 #define num_ok_lines (S.num_ok_lines )
179 #define user_buf (S.user_buf )
180 #define home_pwd_buf (S.home_pwd_buf )
181 #define matches (S.matches )
182 #define num_matches (S.num_matches )
183 #define delptr (S.delptr )
184 #define newdelflag (S.newdelflag )
185 #define delbuf (S.delbuf )
187 #define INIT_S() do { \
188 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
190 cmdedit_termw = 80; \
191 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
192 IF_USERNAME_OR_HOMEDIR(home_pwd_buf = (char*)null_str;) \
194 static void deinit_S(void)
196 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
197 /* This one is allocated only if FANCY_PROMPT is on
198 * (otherwise it points to verbatim prompt (NOT malloced) */
199 free((char*)cmdedit_prompt);
201 #if ENABLE_USERNAME_OR_HOMEDIR
203 if (home_pwd_buf != null_str)
206 free(lineedit_ptr_to_statics);
208 #define DEINIT_S() deinit_S()
211 #if ENABLE_UNICODE_SUPPORT
212 static size_t load_string(const char *src, int maxsize)
214 ssize_t len = mbstowcs(command_ps, src, maxsize - 1);
220 static unsigned save_string(char *dst, unsigned maxsize)
222 # if !ENABLE_UNICODE_PRESERVE_BROKEN
223 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
233 while (dstpos < maxsize) {
236 while ((wc = command_ps[srcpos]) != 0
237 && !unicode_is_raw_byte(wc)
241 command_ps[srcpos] = 0;
242 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
243 if (n < 0) /* should not happen */
246 if (wc == 0) /* usually is */
248 /* We do have invalid byte here! */
249 command_ps[srcpos] = wc; /* restore it */
251 if (dstpos == maxsize)
253 dst[dstpos++] = (char) wc;
259 /* I thought just fputwc(c, stdout) would work. But no... */
260 static void BB_PUTCHAR(wchar_t c)
262 char buf[MB_CUR_MAX + 1];
263 mbstate_t mbst = { 0 };
266 len = wcrtomb(buf, c, &mbst);
272 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
273 static wchar_t adjust_width_and_validate_wc(unsigned *width_adj, wchar_t wc)
275 static wchar_t adjust_width_and_validate_wc(wchar_t wc)
276 # define adjust_width_and_validate_wc(width_adj, wc) \
277 ((*(width_adj))++, adjust_width_and_validate_wc(wc))
282 if (unicode_status == UNICODE_ON) {
283 if (wc > CONFIG_LAST_SUPPORTED_WCHAR) {
284 /* note: also true for unicode_is_raw_byte(wc) */
288 if ((ENABLE_UNICODE_COMBINING_WCHARS && w < 0)
289 || (!ENABLE_UNICODE_COMBINING_WCHARS && w <= 0)
290 || (!ENABLE_UNICODE_WIDE_WCHARS && w > 1)
294 wc = CONFIG_SUBST_WCHAR;
298 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
304 static size_t load_string(const char *src, int maxsize)
306 safe_strncpy(command_ps, src, maxsize);
307 return strlen(command_ps);
309 # if ENABLE_FEATURE_TAB_COMPLETION
310 static void save_string(char *dst, unsigned maxsize)
312 safe_strncpy(dst, command_ps, maxsize);
315 # define BB_PUTCHAR(c) bb_putchar(c)
316 /* Should never be called: */
317 int adjust_width_and_validate_wc(unsigned *width_adj, int wc);
321 /* Put 'command_ps[cursor]', cursor++.
322 * Advance cursor on screen. If we reached right margin, scroll text up
323 * and remove terminal margin effect by printing 'next_char' */
324 #define HACK_FOR_WRONG_WIDTH 1
325 static void put_cur_glyph_and_inc_cursor(void)
327 CHAR_T c = command_ps[cursor];
332 /* erase character after end of input string */
335 /* advance cursor only if we aren't at the end yet */
337 if (unicode_status == UNICODE_ON) {
338 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x;)
339 c = adjust_width_and_validate_wc(&cmdedit_x, c);
340 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x - width;)
346 ofs_to_right = cmdedit_x - cmdedit_termw;
347 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right <= 0) {
348 /* c fits on this line */
352 if (ofs_to_right >= 0) {
353 /* we go to the next line */
354 #if HACK_FOR_WRONG_WIDTH
355 /* This works better if our idea of term width is wrong
356 * and it is actually wider (often happens on serial lines).
357 * Printing CR,LF *forces* cursor to next line.
358 * OTOH if terminal width is correct AND terminal does NOT
359 * have automargin (IOW: it is moving cursor to next line
360 * by itself (which is wrong for VT-10x terminals)),
361 * this will break things: there will be one extra empty line */
362 puts("\r"); /* + implicit '\n' */
364 /* VT-10x terminals don't wrap cursor to next line when last char
365 * on the line is printed - cursor stays "over" this char.
366 * Need to print _next_ char too (first one to appear on next line)
367 * to make cursor move down to next line.
369 /* Works ok only if cmdedit_termw is correct. */
370 c = command_ps[cursor];
377 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right == 0) {
379 } else { /* ofs_to_right > 0 */
380 /* wide char c didn't fit on prev line */
387 /* Move to end of line (by printing all chars till the end) */
388 static void put_till_end_and_adv_cursor(void)
390 while (cursor < command_len)
391 put_cur_glyph_and_inc_cursor();
394 /* Go to the next line */
395 static void goto_new_line(void)
397 put_till_end_and_adv_cursor();
402 static void beep(void)
407 static void put_prompt(void)
411 fputs(cmdedit_prompt, stdout);
414 w = cmdedit_termw; /* read volatile var once */
415 cmdedit_y = cmdedit_prmt_len / w; /* new quasireal y */
416 cmdedit_x = cmdedit_prmt_len % w;
419 /* Move back one character */
420 /* (optimized for slow terminals) */
421 static void input_backward(unsigned num)
429 if ((ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS)
430 && unicode_status == UNICODE_ON
432 /* correct NUM to be equal to _screen_ width */
436 adjust_width_and_validate_wc(&num, command_ps[cursor + n]);
441 if (cmdedit_x >= num) {
444 /* This is longer by 5 bytes on x86.
445 * Also gets miscompiled for ARM users
446 * (busybox.net/bugs/view.php?id=2274).
447 * printf(("\b\b\b\b" + 4) - num);
455 printf("\033[%uD", num);
459 /* Need to go one or more lines up */
460 if (ENABLE_UNICODE_WIDE_WCHARS) {
461 /* With wide chars, it is hard to "backtrack"
462 * and reliably figure out where to put cursor.
463 * Example (<> is a wide char; # is an ordinary char, _ cursor):
467 * and user presses left arrow. num = 1, cmdedit_x = 0,
468 * We need to go up one line, and then - how do we know that
469 * we need to go *10* positions to the right? Because
473 * in this situation we need to go *11* positions to the right.
475 * A simpler thing to do is to redraw everything from the start
476 * up to new cursor position (which is already known):
479 /* go to 1st column; go up to first line */
480 printf("\r" "\033[%uA", cmdedit_y);
483 put_prompt(); /* sets cursor to 0 */
484 while (cursor < sv_cursor)
485 put_cur_glyph_and_inc_cursor();
489 /* num = chars to go back from the beginning of current line: */
491 width = cmdedit_termw; /* read volatile var once */
492 /* num=1...w: one line up, w+1...2w: two, etc: */
493 lines_up = 1 + (num - 1) / width;
494 cmdedit_x = (width * cmdedit_y - num) % width;
495 cmdedit_y -= lines_up;
496 /* go to 1st column; go up */
497 printf("\r" "\033[%uA", lines_up);
498 /* go to correct column.
499 * xterm, konsole, Linux VT interpret 0 as 1 below! wow.
500 * need to *make sure* we skip it if cmdedit_x == 0 */
502 printf("\033[%uC", cmdedit_x);
506 /* draw prompt, editor line, and clear tail */
507 static void redraw(int y, int back_cursor)
509 if (y > 0) /* up y lines */
510 printf("\033[%uA", y);
513 put_till_end_and_adv_cursor();
514 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
515 input_backward(back_cursor);
518 /* Delete the char in front of the cursor, optionally saving it
519 * for later putback */
520 #if !ENABLE_FEATURE_EDITING_VI
521 static void input_delete(void)
522 #define input_delete(save) input_delete()
524 static void input_delete(int save)
529 if (j == (int)command_len)
532 #if ENABLE_FEATURE_EDITING_VI
538 if ((delptr - delbuf) < DELBUFSIZ)
539 *delptr++ = command_ps[j];
543 memmove(command_ps + j, command_ps + j + 1,
544 /* (command_len + 1 [because of NUL]) - (j + 1)
545 * simplified into (command_len - j) */
546 (command_len - j) * sizeof(command_ps[0]));
548 put_till_end_and_adv_cursor();
549 /* Last char is still visible, erase it (and more) */
550 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
551 input_backward(cursor - j); /* back to old pos cursor */
554 #if ENABLE_FEATURE_EDITING_VI
555 static void put(void)
558 int j = delptr - delbuf;
563 /* open hole and then fill it */
564 memmove(command_ps + cursor + j, command_ps + cursor,
565 (command_len - cursor + 1) * sizeof(command_ps[0]));
566 memcpy(command_ps + cursor, delbuf, j * sizeof(command_ps[0]));
568 put_till_end_and_adv_cursor();
569 input_backward(cursor - ocursor - j + 1); /* at end of new text */
573 /* Delete the char in back of the cursor */
574 static void input_backspace(void)
582 /* Move forward one character */
583 static void input_forward(void)
585 if (cursor < command_len)
586 put_cur_glyph_and_inc_cursor();
589 #if ENABLE_FEATURE_TAB_COMPLETION
591 static void free_tab_completion_data(void)
595 free(matches[--num_matches]);
601 static void add_match(char *matched)
603 matches = xrealloc_vector(matches, 4, num_matches);
604 matches[num_matches] = matched;
608 #if ENABLE_FEATURE_USERNAME_COMPLETION
609 static void username_tab_completion(char *ud, char *with_shash_flg)
611 struct passwd *entry;
614 ud++; /* ~user/... to user/... */
615 userlen = strlen(ud);
617 if (with_shash_flg) { /* "~/..." or "~user/..." */
618 char *sav_ud = ud - 1;
621 if (*ud == '/') { /* "~/..." */
626 temp = strchr(ud, '/');
627 *temp = '\0'; /* ~user\0 */
628 entry = getpwnam(ud);
629 *temp = '/'; /* restore ~user/... */
632 home = entry->pw_dir;
635 if ((userlen + strlen(home) + 1) < MAX_LINELEN) {
637 sprintf(sav_ud, "%s%s", home, ud);
642 /* Using _r function to avoid pulling in static buffers */
645 struct passwd *result;
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));
657 #endif /* FEATURE_COMMAND_USERNAME_COMPLETION */
665 static int path_parse(char ***p, int flags)
672 /* if not setenv PATH variable, to search cur dir "." */
673 if (flags != FIND_EXE_ONLY)
676 if (state->flags & WITH_PATH_LOOKUP)
677 pth = state->path_lookup;
679 pth = getenv("PATH");
680 /* PATH=<empty> or PATH=:<empty> */
681 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
685 npth = 1; /* path component count */
687 tmp = strchr(tmp, ':');
691 break; /* :<empty> */
695 res = xmalloc(npth * sizeof(char*));
696 res[0] = tmp = xstrdup(pth);
699 tmp = strchr(tmp, ':');
702 *tmp++ = '\0'; /* ':' -> '\0' */
704 break; /* :<empty> */
711 static void exe_n_cwd_tab_completion(char *command, int type)
717 char **paths = path1;
721 char *pfind = strrchr(command, '/');
722 /* char dirbuf[MAX_LINELEN]; */
723 #define dirbuf (S.exe_n_cwd_tab_completion__dirbuf)
726 path1[0] = (char*)".";
729 /* no dir, if flags==EXE_ONLY - get paths, else "." */
730 npaths = path_parse(&paths, type);
733 /* dirbuf = ".../.../.../" */
734 safe_strncpy(dirbuf, command, (pfind - command) + 2);
735 #if ENABLE_FEATURE_USERNAME_COMPLETION
736 if (dirbuf[0] == '~') /* ~/... or ~user/... */
737 username_tab_completion(dirbuf, dirbuf);
740 /* point to 'l' in "..../last_component" */
744 for (i = 0; i < npaths; i++) {
745 dir = opendir(paths[i]);
747 continue; /* don't print an error */
749 while ((next = readdir(dir)) != NULL) {
751 const char *str_found = next->d_name;
754 if (strncmp(str_found, pfind, strlen(pfind)))
756 /* not see .name without .match */
757 if (*str_found == '.' && *pfind == '\0') {
758 if (NOT_LONE_CHAR(paths[i], '/') || str_found[1])
760 str_found = ""; /* only "/" */
762 found = concat_path_file(paths[i], str_found);
763 /* hmm, remove in progress? */
764 /* NB: stat() first so that we see is it a directory;
765 * but if that fails, use lstat() so that
766 * we still match dangling links */
767 if (stat(found, &st) && lstat(found, &st))
769 /* find with dirs? */
770 if (paths[i] != dirbuf)
771 strcpy(found, next->d_name); /* only name */
773 len1 = strlen(found);
774 found = xrealloc(found, len1 + 2);
776 found[len1+1] = '\0';
778 if (S_ISDIR(st.st_mode)) {
779 /* name is a directory */
780 if (found[len1-1] != '/') {
784 /* not put found file if search only dirs for cd */
785 if (type == FIND_DIR_ONLY)
788 /* Add it to the list */
796 if (paths != path1) {
797 free(paths[0]); /* allocated memory is only in first member */
803 /* QUOT is used on elements of int_buf[], which are bytes,
804 * not Unicode chars. Therefore it works correctly even in Unicode mode.
806 #define QUOT (UCHAR_MAX+1)
808 #define int_buf (S.find_match__int_buf)
809 #define pos_buf (S.find_match__pos_buf)
810 /* is must be <= in */
811 static void collapse_pos(int is, int in)
813 memmove(int_buf+is, int_buf+in, (MAX_LINELEN+1-in)*sizeof(int_buf[0]));
814 memmove(pos_buf+is, pos_buf+in, (MAX_LINELEN+1-in)*sizeof(pos_buf[0]));
816 static NOINLINE int find_match(char *matchBuf, int *len_with_quotes)
821 /* Were local, but it uses too much stack */
822 /* int16_t int_buf[MAX_LINELEN + 1]; */
823 /* int16_t pos_buf[MAX_LINELEN + 1]; */
825 /* set to integer dimension characters and own positions */
827 int_buf[i] = (unsigned char)matchBuf[i];
828 if (int_buf[i] == 0) {
829 pos_buf[i] = -1; /* end-fo-line indicator */
835 /* mask \+symbol and convert '\t' to ' ' */
836 for (i = j = 0; matchBuf[i]; i++, j++) {
837 if (matchBuf[i] == '\\') {
838 collapse_pos(j, j + 1);
843 /* mask "symbols" or 'symbols' */
845 for (i = 0; int_buf[i]; i++) {
847 if (c == '\'' || c == '"') {
856 } else if (c2 != 0 && c != '$')
860 /* skip commands with arguments if line has commands delimiters */
861 /* ';' ';;' '&' '|' '&&' '||' but `>&' `<&' `>|' */
862 for (i = 0; int_buf[i]; i++) {
865 j = i ? int_buf[i - 1] : -1;
867 if (c == ';' || c == '&' || c == '|') {
868 command_mode = 1 + (c == c2);
870 if (j == '>' || j == '<')
872 } else if (c == '|' && j == '>')
876 collapse_pos(0, i + command_mode);
877 i = -1; /* hack incremet */
880 /* collapse `command...` */
881 for (i = 0; int_buf[i]; i++) {
882 if (int_buf[i] == '`') {
883 for (j = i + 1; int_buf[j]; j++)
884 if (int_buf[j] == '`') {
885 collapse_pos(i, j + 1);
890 /* not found closing ` - command mode, collapse all previous */
891 collapse_pos(0, i + 1);
894 i--; /* hack incremet */
898 /* collapse (command...(command...)...) or {command...{command...}...} */
899 c = 0; /* "recursive" level */
901 for (i = 0; int_buf[i]; i++) {
902 if (int_buf[i] == '(' || int_buf[i] == '{') {
903 if (int_buf[i] == '(')
907 collapse_pos(0, i + 1);
908 i = -1; /* hack incremet */
911 for (i = 0; pos_buf[i] >= 0 && (c > 0 || c2 > 0); i++) {
912 if ((int_buf[i] == ')' && c > 0) || (int_buf[i] == '}' && c2 > 0)) {
913 if (int_buf[i] == ')')
917 collapse_pos(0, i + 1);
918 i = -1; /* hack incremet */
922 /* skip first not quote space */
923 for (i = 0; int_buf[i]; i++)
924 if (int_buf[i] != ' ')
929 /* set find mode for completion */
930 command_mode = FIND_EXE_ONLY;
931 for (i = 0; int_buf[i]; i++) {
932 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
933 if (int_buf[i] == ' ' && command_mode == FIND_EXE_ONLY
934 && matchBuf[pos_buf[0]] == 'c'
935 && matchBuf[pos_buf[1]] == 'd'
937 command_mode = FIND_DIR_ONLY;
939 command_mode = FIND_FILE_ONLY;
944 for (i = 0; int_buf[i]; i++)
947 for (--i; i >= 0; i--) {
949 if (c == ' ' || c == '<' || c == '>' || c == '|' || c == '&') {
950 collapse_pos(0, i + 1);
954 /* skip first not quoted '\'' or '"' */
955 for (i = 0; int_buf[i] == '\'' || int_buf[i] == '"'; i++)
957 /* collapse quote or unquote // or /~ */
958 while ((int_buf[i] & ~QUOT) == '/'
959 && ((int_buf[i+1] & ~QUOT) == '/' || (int_buf[i+1] & ~QUOT) == '~')
964 /* set only match and destroy quotes */
966 for (c = 0; pos_buf[i] >= 0; i++) {
967 matchBuf[c++] = matchBuf[pos_buf[i]];
971 /* old length matchBuf with quotes symbols */
972 *len_with_quotes = j ? j - pos_buf[0] : 0;
980 * display by column (original idea from ls applet,
981 * very optimized by me :)
983 static void showfiles(void)
986 int column_width = 0;
987 int nfiles = num_matches;
991 /* find the longest file name - use that as the column width */
992 for (row = 0; row < nrows; row++) {
993 l = unicode_strwidth(matches[row]);
994 if (column_width < l)
997 column_width += 2; /* min space for columns */
998 ncols = cmdedit_termw / column_width;
1003 nrows++; /* round up fractionals */
1007 for (row = 0; row < nrows; row++) {
1011 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1012 printf("%s%-*s", matches[n],
1013 (int)(column_width - unicode_strwidth(matches[n])), ""
1016 if (ENABLE_UNICODE_SUPPORT)
1017 puts(printable_string(NULL, matches[n]));
1023 static char *add_quote_for_spec_chars(char *found)
1026 char *s = xzalloc((strlen(found) + 1) * 2);
1029 if (strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", *found))
1033 /* s[l] = '\0'; - already is */
1037 /* Do TAB completion */
1038 static void input_tab(smallint *lastWasTab)
1040 if (!(state->flags & TAB_COMPLETION))
1046 /* char matchBuf[MAX_LINELEN]; */
1047 #define matchBuf (S.input_tab__matchBuf)
1050 #if ENABLE_UNICODE_SUPPORT
1051 /* cursor pos in command converted to multibyte form */
1055 *lastWasTab = TRUE; /* flop trigger */
1057 /* Make a local copy of the string --
1058 * up to the position of the cursor */
1059 save_string(matchBuf, cursor + 1);
1060 #if ENABLE_UNICODE_SUPPORT
1061 cursor_mb = strlen(matchBuf);
1065 find_type = find_match(matchBuf, &recalc_pos);
1067 /* Free up any memory already allocated */
1068 free_tab_completion_data();
1070 #if ENABLE_FEATURE_USERNAME_COMPLETION
1071 /* If the word starts with `~' and there is no slash in the word,
1072 * then try completing this word as a username. */
1073 if (state->flags & USERNAME_COMPLETION)
1074 if (matchBuf[0] == '~' && strchr(matchBuf, '/') == NULL)
1075 username_tab_completion(matchBuf, NULL);
1077 /* Try to match any executable in our path and everything
1078 * in the current working directory */
1080 exe_n_cwd_tab_completion(matchBuf, find_type);
1081 /* Sort, then remove any duplicates found */
1085 qsort_string_vector(matches, num_matches);
1086 for (i = 0; i < num_matches - 1; ++i) {
1087 if (matches[i] && matches[i+1]) { /* paranoia */
1088 if (strcmp(matches[i], matches[i+1]) == 0) {
1090 matches[i] = NULL; /* paranoia */
1092 matches[n++] = matches[i];
1096 matches[n] = matches[i];
1097 num_matches = n + 1;
1099 /* Did we find exactly one match? */
1100 if (!matches || num_matches > 1) { /* no */
1103 return; /* not found */
1104 /* find minimal match */
1105 tmp1 = xstrdup(matches[0]);
1106 for (tmp = tmp1; *tmp; tmp++) {
1107 for (len_found = 1; len_found < num_matches; len_found++) {
1108 if (matches[len_found][tmp - tmp1] != *tmp) {
1114 if (*tmp1 == '\0') { /* have unique */
1118 tmp = add_quote_for_spec_chars(tmp1);
1120 } else { /* one match */
1121 tmp = add_quote_for_spec_chars(matches[0]);
1122 /* for next completion current found */
1123 *lastWasTab = FALSE;
1125 len_found = strlen(tmp);
1126 if (tmp[len_found-1] != '/') {
1127 tmp[len_found] = ' ';
1128 tmp[len_found+1] = '\0';
1132 len_found = strlen(tmp);
1133 #if !ENABLE_UNICODE_SUPPORT
1134 /* have space to place the match? */
1135 /* The result consists of three parts with these lengths: */
1136 /* (cursor - recalc_pos) + len_found + (command_len - cursor) */
1137 /* it simplifies into: */
1138 if ((int)(len_found + command_len - recalc_pos) < S.maxsize) {
1140 strcpy(matchBuf, command_ps + cursor);
1141 /* add match and tail */
1142 sprintf(&command_ps[cursor - recalc_pos], "%s%s", tmp, matchBuf);
1143 command_len = strlen(command_ps);
1145 recalc_pos = cursor - recalc_pos + len_found;
1146 /* write out the matched command */
1147 redraw(cmdedit_y, command_len - recalc_pos);
1151 char command[MAX_LINELEN];
1152 int len = save_string(command, sizeof(command));
1153 /* have space to place the match? */
1154 /* (cursor_mb - recalc_pos) + len_found + (len - cursor_mb) */
1155 if ((int)(len_found + len - recalc_pos) < MAX_LINELEN) {
1157 strcpy(matchBuf, command + cursor_mb);
1158 /* where do we want to have cursor after all? */
1159 strcpy(&command[cursor_mb - recalc_pos], tmp);
1160 len = load_string(command, S.maxsize);
1161 /* add match and tail */
1162 sprintf(&command[cursor_mb - recalc_pos], "%s%s", tmp, matchBuf);
1163 command_len = load_string(command, S.maxsize);
1164 /* write out the matched command */
1165 redraw(cmdedit_y, command_len - len);
1172 /* Ok -- the last char was a TAB. Since they
1173 * just hit TAB again, print a list of all the
1174 * available choices... */
1175 if (matches && num_matches > 0) {
1176 /* changed by goto_new_line() */
1177 int sav_cursor = cursor;
1179 /* Go to the next line */
1182 redraw(0, command_len - sav_cursor);
1187 #endif /* FEATURE_COMMAND_TAB_COMPLETION */
1190 line_input_t* FAST_FUNC new_line_input_t(int flags)
1192 line_input_t *n = xzalloc(sizeof(*n));
1200 static void save_command_ps_at_cur_history(void)
1202 if (command_ps[0] != BB_NUL) {
1203 int cur = state->cur_history;
1204 free(state->history[cur]);
1206 # if ENABLE_UNICODE_SUPPORT
1208 char tbuf[MAX_LINELEN];
1209 save_string(tbuf, sizeof(tbuf));
1210 state->history[cur] = xstrdup(tbuf);
1213 state->history[cur] = xstrdup(command_ps);
1218 /* state->flags is already checked to be nonzero */
1219 static int get_previous_history(void)
1221 if ((state->flags & DO_HISTORY) && state->cur_history) {
1222 save_command_ps_at_cur_history();
1223 state->cur_history--;
1230 static int get_next_history(void)
1232 if (state->flags & DO_HISTORY) {
1233 if (state->cur_history < state->cnt_history) {
1234 save_command_ps_at_cur_history(); /* save the current history line */
1235 return ++state->cur_history;
1242 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1243 /* We try to ensure that concurrent additions to the history
1244 * do not overwrite each other.
1245 * Otherwise shell users get unhappy.
1247 * History file is trimmed lazily, when it grows several times longer
1248 * than configured MAX_HISTORY lines.
1251 static void free_line_input_t(line_input_t *n)
1253 int i = n->cnt_history;
1255 free(n->history[--i]);
1259 /* state->flags is already checked to be nonzero */
1260 static void load_history(line_input_t *st_parm)
1262 char *temp_h[MAX_HISTORY];
1265 unsigned idx, i, line_len;
1267 /* NB: do not trash old history if file can't be opened */
1269 fp = fopen_for_read(st_parm->hist_file);
1271 /* clean up old history */
1272 for (idx = st_parm->cnt_history; idx > 0;) {
1274 free(st_parm->history[idx]);
1275 st_parm->history[idx] = NULL;
1278 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1279 memset(temp_h, 0, sizeof(temp_h));
1280 st_parm->cnt_history_in_file = idx = 0;
1281 while ((line = xmalloc_fgetline(fp)) != NULL) {
1282 if (line[0] == '\0') {
1288 st_parm->cnt_history_in_file++;
1290 if (idx == MAX_HISTORY)
1295 /* find first non-NULL temp_h[], if any */
1296 if (st_parm->cnt_history_in_file) {
1297 while (temp_h[idx] == NULL) {
1299 if (idx == MAX_HISTORY)
1304 /* copy temp_h[] to st_parm->history[] */
1305 for (i = 0; i < MAX_HISTORY;) {
1310 if (idx == MAX_HISTORY)
1312 line_len = strlen(line);
1313 if (line_len >= MAX_LINELEN)
1314 line[MAX_LINELEN-1] = '\0';
1315 st_parm->history[i++] = line;
1317 st_parm->cnt_history = i;
1321 /* state->flags is already checked to be nonzero */
1322 static void save_history(char *str)
1327 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0666);
1330 xlseek(fd, 0, SEEK_END); /* paranoia */
1332 str[len] = '\n'; /* we (try to) do atomic write */
1333 len2 = full_write(fd, str, len + 1);
1336 if (len2 != len + 1)
1337 return; /* "wtf?" */
1339 /* did we write so much that history file needs trimming? */
1340 state->cnt_history_in_file++;
1341 if (state->cnt_history_in_file > MAX_HISTORY * 4) {
1344 line_input_t *st_temp;
1347 /* we may have concurrently written entries from others.
1349 st_temp = new_line_input_t(state->flags);
1350 st_temp->hist_file = state->hist_file;
1351 load_history(st_temp);
1353 /* write out temp file and replace hist_file atomically */
1354 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1355 fp = fopen_for_write(new_name);
1357 for (i = 0; i < st_temp->cnt_history; i++)
1358 fprintf(fp, "%s\n", st_temp->history[i]);
1360 if (rename(new_name, state->hist_file) == 0)
1361 state->cnt_history_in_file = st_temp->cnt_history;
1364 free_line_input_t(st_temp);
1368 # define load_history(a) ((void)0)
1369 # define save_history(a) ((void)0)
1370 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1372 static void remember_in_history(char *str)
1376 if (!(state->flags & DO_HISTORY))
1380 i = state->cnt_history;
1381 /* Don't save dupes */
1382 if (i && strcmp(state->history[i-1], str) == 0)
1385 free(state->history[MAX_HISTORY]); /* redundant, paranoia */
1386 state->history[MAX_HISTORY] = NULL; /* redundant, paranoia */
1388 /* If history[] is full, remove the oldest command */
1389 /* we need to keep history[MAX_HISTORY] empty, hence >=, not > */
1390 if (i >= MAX_HISTORY) {
1391 free(state->history[0]);
1392 for (i = 0; i < MAX_HISTORY-1; i++)
1393 state->history[i] = state->history[i+1];
1394 /* i == MAX_HISTORY-1 */
1396 /* i <= MAX_HISTORY-1 */
1397 state->history[i++] = xstrdup(str);
1398 /* i <= MAX_HISTORY */
1399 state->cur_history = i;
1400 state->cnt_history = i;
1401 # if MAX_HISTORY > 0 && ENABLE_FEATURE_EDITING_SAVEHISTORY
1402 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1405 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1408 #else /* MAX_HISTORY == 0 */
1409 # define remember_in_history(a) ((void)0)
1410 #endif /* MAX_HISTORY */
1413 #if ENABLE_FEATURE_EDITING_VI
1415 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1418 vi_Word_motion(int eat)
1420 CHAR_T *command = command_ps;
1422 while (cursor < command_len && !BB_isspace(command[cursor]))
1424 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1429 vi_word_motion(int eat)
1431 CHAR_T *command = command_ps;
1433 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1434 while (cursor < command_len
1435 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1439 } else if (BB_ispunct(command[cursor])) {
1440 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1444 if (cursor < command_len)
1448 while (cursor < command_len && BB_isspace(command[cursor]))
1456 CHAR_T *command = command_ps;
1459 while (cursor < command_len && BB_isspace(command[cursor]))
1461 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1468 CHAR_T *command = command_ps;
1470 if (cursor >= command_len-1)
1473 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1475 if (cursor >= command_len-1)
1477 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1478 while (cursor < command_len-1
1479 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1483 } else if (BB_ispunct(command[cursor])) {
1484 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1490 vi_Back_motion(void)
1492 CHAR_T *command = command_ps;
1494 while (cursor > 0 && BB_isspace(command[cursor-1]))
1496 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1501 vi_back_motion(void)
1503 CHAR_T *command = command_ps;
1508 while (cursor > 0 && BB_isspace(command[cursor]))
1512 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1514 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1518 } else if (BB_ispunct(command[cursor])) {
1519 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1525 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1526 static void ctrl_left(void)
1528 CHAR_T *command = command_ps;
1536 c = command[cursor];
1537 if (c != ' ' && !BB_ispunct(c)) {
1538 /* we reached a "word" delimited by spaces/punct.
1539 * go to its beginning */
1541 c = command[cursor - 1];
1542 if (c == ' ' || BB_ispunct(c))
1552 static void ctrl_right(void)
1554 CHAR_T *command = command_ps;
1559 c = command[cursor];
1562 if (c != ' ' && !BB_ispunct(c)) {
1563 /* we reached a "word" delimited by spaces/punct.
1564 * go to its end + 1 */
1567 c = command[cursor];
1568 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1579 * read_line_input and its helpers
1582 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1583 static void ask_terminal(void)
1585 /* Ask terminal where is the cursor now.
1586 * lineedit_read_key handles response and corrects
1587 * our idea of current cursor position.
1588 * Testcase: run "echo -n long_line_long_line_long_line",
1589 * then type in a long, wrapping command and try to
1590 * delete it using backspace key.
1591 * Note: we print it _after_ prompt, because
1592 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1594 /* Problem: if there is buffered input on stdin,
1595 * the response will be delivered later,
1596 * possibly to an unsuspecting application.
1597 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1599 * ~/srcdevel/bbox/fix/busybox.t4 #
1600 * ~/srcdevel/bbox/fix/busybox.t4 #
1601 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1602 * ~/srcdevel/bbox/fix/busybox.t4 #
1604 * Checking for input with poll only makes the race narrower,
1605 * I still can trigger it. Strace:
1607 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1608 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1609 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1610 * poll([{fd=0, events=POLLIN}], 1, 4294967295) = 1 ([{fd=0, revents=POLLIN}])
1611 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1615 pfd.fd = STDIN_FILENO;
1616 pfd.events = POLLIN;
1617 if (safe_poll(&pfd, 1, 0) == 0) {
1618 S.sent_ESC_br6n = 1;
1619 fputs("\033" "[6n", stdout);
1620 fflush_all(); /* make terminal see it ASAP! */
1624 #define ask_terminal() ((void)0)
1627 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1628 static void parse_and_put_prompt(const char *prmt_ptr)
1630 cmdedit_prompt = prmt_ptr;
1631 cmdedit_prmt_len = strlen(prmt_ptr);
1635 static void parse_and_put_prompt(const char *prmt_ptr)
1638 size_t cur_prmt_len = 0;
1639 char flg_not_length = '[';
1640 char *prmt_mem_ptr = xzalloc(1);
1641 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1646 cmdedit_prmt_len = 0;
1649 cwd_buf = (char *)bb_msg_unknown;
1652 cbuf[1] = '\0'; /* never changes */
1655 char *free_me = NULL;
1660 const char *cp = prmt_ptr;
1663 c = bb_process_escape_sequence(&prmt_ptr);
1664 if (prmt_ptr == cp) {
1670 # if ENABLE_USERNAME_OR_HOMEDIR
1672 pbuf = user_buf ? user_buf : (char*)"";
1676 pbuf = free_me = safe_gethostname();
1677 *strchrnul(pbuf, '.') = '\0';
1680 c = (geteuid() == 0 ? '#' : '$');
1682 # if ENABLE_USERNAME_OR_HOMEDIR
1684 /* /home/user[/something] -> ~[/something] */
1686 l = strlen(home_pwd_buf);
1688 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1689 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1690 && strlen(cwd_buf + l) < PATH_MAX
1692 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1698 cp = strrchr(pbuf, '/');
1699 if (cp != NULL && cp != pbuf)
1700 pbuf += (cp-pbuf) + 1;
1703 pbuf = free_me = xasprintf("%d", num_ok_lines);
1705 case 'e': case 'E': /* \e \E = \033 */
1708 case 'x': case 'X': {
1710 for (l = 0; l < 3;) {
1712 buf2[l++] = *prmt_ptr;
1714 h = strtoul(buf2, &pbuf, 16);
1715 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1721 c = (char)strtoul(buf2, NULL, 16);
1728 if (c == flg_not_length) {
1729 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1737 cur_prmt_len = strlen(pbuf);
1738 prmt_len += cur_prmt_len;
1739 if (flg_not_length != ']')
1740 cmdedit_prmt_len += cur_prmt_len;
1741 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1745 if (cwd_buf != (char *)bb_msg_unknown)
1747 cmdedit_prompt = prmt_mem_ptr;
1752 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1756 /* new y for current cursor */
1757 int new_y = (cursor + cmdedit_prmt_len) / w;
1759 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1764 static void win_changed(int nsig)
1766 int sv_errno = errno;
1768 get_terminal_width_height(0, &width, NULL);
1769 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1770 if (nsig == SIGWINCH)
1771 signal(SIGWINCH, win_changed); /* rearm ourself */
1775 static int lineedit_read_key(char *read_key_buffer)
1779 #if ENABLE_UNICODE_SUPPORT
1780 char unicode_buf[MB_CUR_MAX + 1];
1781 int unicode_idx = 0;
1785 /* Wait for input. TIMEOUT = -1 makes read_key wait even
1786 * on nonblocking stdin, TIMEOUT = 50 makes sure we won't
1787 * insist on full MB_CUR_MAX buffer to declare input like
1788 * "\xff\n",pause,"ls\n" invalid and thus won't lose "ls".
1790 * Note: read_key sets errno to 0 on success.
1792 ic = read_key(STDIN_FILENO, read_key_buffer, timeout);
1794 #if ENABLE_UNICODE_SUPPORT
1795 if (errno == EAGAIN && unicode_idx != 0)
1801 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1802 if ((int32_t)ic == KEYCODE_CURSOR_POS
1805 S.sent_ESC_br6n = 0;
1806 if (cursor == 0) { /* otherwise it may be bogus */
1807 int col = ((ic >> 32) & 0x7fff) - 1;
1808 if (col > cmdedit_prmt_len) {
1809 cmdedit_x += (col - cmdedit_prmt_len);
1810 while (cmdedit_x >= cmdedit_termw) {
1811 cmdedit_x -= cmdedit_termw;
1820 #if ENABLE_UNICODE_SUPPORT
1821 if (unicode_status == UNICODE_ON) {
1824 if ((int32_t)ic < 0) /* KEYCODE_xxx */
1826 // TODO: imagine sequence like: 0xff,<left-arrow>: we are currently losing 0xff...
1828 unicode_buf[unicode_idx++] = ic;
1829 unicode_buf[unicode_idx] = '\0';
1830 if (mbstowcs(&wc, unicode_buf, 1) != 1) {
1831 /* Not (yet?) a valid unicode char */
1832 if (unicode_idx < MB_CUR_MAX) {
1837 /* Invalid sequence. Save all "bad bytes" except first */
1838 read_key_ungets(read_key_buffer, unicode_buf + 1, unicode_idx - 1);
1839 # if !ENABLE_UNICODE_PRESERVE_BROKEN
1840 ic = CONFIG_SUBST_WCHAR;
1842 ic = unicode_mark_raw_byte(unicode_buf[0]);
1845 /* Valid unicode char, return its code */
1856 #if ENABLE_UNICODE_BIDI_SUPPORT
1857 static int isrtl_str(void)
1861 while (idx < command_len && unicode_bidi_is_neutral_wchar(command_ps[idx]))
1863 return unicode_bidi_isrtl(command_ps[idx]);
1866 # define isrtl_str() 0
1869 /* leave out the "vi-mode"-only case labels if vi editing isn't
1871 #define vi_case(caselabel) IF_FEATURE_EDITING_VI(case caselabel)
1873 /* convert uppercase ascii to equivalent control char, for readability */
1875 #define CTRL(a) ((a) & ~0x40)
1877 /* maxsize must be >= 2.
1879 * -1 on read errors or EOF, or on bare Ctrl-D,
1880 * 0 on ctrl-C (the line entered is still returned in 'command'),
1881 * >0 length of input string, including terminating '\n'
1883 int FAST_FUNC read_line_input(const char *prompt, char *command, int maxsize, line_input_t *st)
1886 #if ENABLE_FEATURE_TAB_COMPLETION
1887 smallint lastWasTab = FALSE;
1889 smallint break_out = 0;
1890 #if ENABLE_FEATURE_EDITING_VI
1891 smallint vi_cmdmode = 0;
1893 struct termios initial_settings;
1894 struct termios new_settings;
1895 char read_key_buffer[KEYCODE_BUFFER_SIZE];
1899 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
1900 || !(initial_settings.c_lflag & ECHO)
1902 /* Happens when e.g. stty -echo was run before */
1903 parse_and_put_prompt(prompt);
1904 /* fflush_all(); - done by parse_and_put_prompt */
1905 if (fgets(command, maxsize, stdin) == NULL)
1906 len = -1; /* EOF or error */
1908 len = strlen(command);
1915 // FIXME: audit & improve this
1916 if (maxsize > MAX_LINELEN)
1917 maxsize = MAX_LINELEN;
1918 S.maxsize = maxsize;
1920 /* With null flags, no other fields are ever used */
1921 state = st ? st : (line_input_t*) &const_int_0;
1923 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1924 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1925 if (state->cnt_history == 0)
1926 load_history(state);
1928 if (state->flags & DO_HISTORY)
1929 state->cur_history = state->cnt_history;
1932 /* prepare before init handlers */
1933 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
1935 #if ENABLE_UNICODE_SUPPORT
1936 command_ps = xzalloc(maxsize * sizeof(command_ps[0]));
1938 command_ps = command;
1941 #define command command_must_not_be_used
1943 new_settings = initial_settings;
1944 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
1945 /* Turn off echoing and CTRL-C, so we can trap it */
1946 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
1947 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
1948 new_settings.c_cc[VMIN] = 1;
1949 new_settings.c_cc[VTIME] = 0;
1950 /* Turn off CTRL-C, so we can trap it */
1951 #ifndef _POSIX_VDISABLE
1952 # define _POSIX_VDISABLE '\0'
1954 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
1955 tcsetattr_stdin_TCSANOW(&new_settings);
1957 /* Now initialize things */
1958 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
1959 win_changed(0); /* do initial resizing */
1960 #if ENABLE_USERNAME_OR_HOMEDIR
1962 struct passwd *entry;
1964 entry = getpwuid(geteuid());
1966 user_buf = xstrdup(entry->pw_name);
1967 home_pwd_buf = xstrdup(entry->pw_dir);
1973 for (i = 0; i <= MAX_HISTORY; i++)
1974 bb_error_msg("history[%d]:'%s'", i, state->history[i]);
1975 bb_error_msg("cur_history:%d cnt_history:%d", state->cur_history, state->cnt_history);
1978 /* Print out the command prompt, optionally ask where cursor is */
1979 parse_and_put_prompt(prompt);
1982 read_key_buffer[0] = 0;
1985 * The emacs and vi modes share much of the code in the big
1986 * command loop. Commands entered when in vi's command mode
1987 * (aka "escape mode") get an extra bit added to distinguish
1988 * them - this keeps them from being self-inserted. This
1989 * clutters the big switch a bit, but keeps all the code
1993 VI_CMDMODE_BIT = 0x40000000,
1994 /* 0x80000000 bit flags KEYCODE_xxx */
1999 ic = ic_raw = lineedit_read_key(read_key_buffer);
2001 #if ENABLE_FEATURE_EDITING_VI
2004 /* btw, since KEYCODE_xxx are all < 0, this doesn't
2005 * change ic if it contains one of them: */
2006 ic |= VI_CMDMODE_BIT;
2013 vi_case('\n'|VI_CMDMODE_BIT:)
2014 vi_case('\r'|VI_CMDMODE_BIT:)
2020 vi_case('0'|VI_CMDMODE_BIT:)
2021 /* Control-a -- Beginning of line */
2022 input_backward(cursor);
2025 vi_case('h'|VI_CMDMODE_BIT:)
2026 vi_case('\b'|VI_CMDMODE_BIT:) /* ^H */
2027 vi_case('\x7f'|VI_CMDMODE_BIT:) /* DEL */
2028 input_backward(1); /* Move back one character */
2031 vi_case('$'|VI_CMDMODE_BIT:)
2032 /* Control-e -- End of line */
2033 put_till_end_and_adv_cursor();
2036 vi_case('l'|VI_CMDMODE_BIT:)
2037 vi_case(' '|VI_CMDMODE_BIT:)
2038 input_forward(); /* Move forward one character */
2041 case '\x7f': /* DEL */
2047 case KEYCODE_DELETE:
2053 #if ENABLE_FEATURE_TAB_COMPLETION
2055 input_tab(&lastWasTab);
2059 /* Control-k -- clear to end of line */
2060 command_ps[cursor] = BB_NUL;
2061 command_len = cursor;
2062 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
2065 vi_case(CTRL('L')|VI_CMDMODE_BIT:)
2066 /* Control-l -- clear screen */
2067 printf("\033[H"); /* cursor to top,left */
2068 redraw(0, command_len - cursor);
2072 vi_case(CTRL('N')|VI_CMDMODE_BIT:)
2073 vi_case('j'|VI_CMDMODE_BIT:)
2074 /* Control-n -- Get next command in history */
2075 if (get_next_history())
2079 vi_case(CTRL('P')|VI_CMDMODE_BIT:)
2080 vi_case('k'|VI_CMDMODE_BIT:)
2081 /* Control-p -- Get previous command from history */
2082 if (get_previous_history())
2087 vi_case(CTRL('U')|VI_CMDMODE_BIT:)
2088 /* Control-U -- Clear line before cursor */
2090 command_len -= cursor;
2091 memmove(command_ps, command_ps + cursor,
2092 (command_len + 1) * sizeof(command_ps[0]));
2093 redraw(cmdedit_y, command_len);
2097 vi_case(CTRL('W')|VI_CMDMODE_BIT:)
2098 /* Control-W -- Remove the last word */
2099 while (cursor > 0 && BB_isspace(command_ps[cursor-1]))
2101 while (cursor > 0 && !BB_isspace(command_ps[cursor-1]))
2105 #if ENABLE_FEATURE_EDITING_VI
2106 case 'i'|VI_CMDMODE_BIT:
2109 case 'I'|VI_CMDMODE_BIT:
2110 input_backward(cursor);
2113 case 'a'|VI_CMDMODE_BIT:
2117 case 'A'|VI_CMDMODE_BIT:
2118 put_till_end_and_adv_cursor();
2121 case 'x'|VI_CMDMODE_BIT:
2124 case 'X'|VI_CMDMODE_BIT:
2130 case 'W'|VI_CMDMODE_BIT:
2133 case 'w'|VI_CMDMODE_BIT:
2136 case 'E'|VI_CMDMODE_BIT:
2139 case 'e'|VI_CMDMODE_BIT:
2142 case 'B'|VI_CMDMODE_BIT:
2145 case 'b'|VI_CMDMODE_BIT:
2148 case 'C'|VI_CMDMODE_BIT:
2151 case 'D'|VI_CMDMODE_BIT:
2154 case 'c'|VI_CMDMODE_BIT:
2157 case 'd'|VI_CMDMODE_BIT: {
2160 ic = lineedit_read_key(read_key_buffer);
2161 if (errno) /* error */
2162 goto prepare_to_die;
2163 if (ic == ic_raw) { /* "cc", "dd" */
2164 input_backward(cursor);
2176 case 'w': /* "dw", "cw" */
2177 vi_word_motion(vi_cmdmode);
2179 case 'W': /* 'dW', 'cW' */
2180 vi_Word_motion(vi_cmdmode);
2182 case 'e': /* 'de', 'ce' */
2186 case 'E': /* 'dE', 'cE' */
2192 input_backward(cursor - sc);
2193 while (nc-- > cursor)
2196 case 'b': /* "db", "cb" */
2197 case 'B': /* implemented as B */
2202 while (sc-- > cursor)
2205 case ' ': /* "d ", "c " */
2208 case '$': /* "d$", "c$" */
2210 while (cursor < command_len)
2216 case 'p'|VI_CMDMODE_BIT:
2219 case 'P'|VI_CMDMODE_BIT:
2222 case 'r'|VI_CMDMODE_BIT:
2223 //FIXME: unicode case?
2224 ic = lineedit_read_key(read_key_buffer);
2225 if (errno) /* error */
2226 goto prepare_to_die;
2227 if (ic < ' ' || ic > 255) {
2230 command_ps[cursor] = ic;
2235 case '\x1b': /* ESC */
2236 if (state->flags & VI_MODE) {
2237 /* insert mode --> command mode */
2242 #endif /* FEATURE_COMMAND_EDITING_VI */
2246 if (get_previous_history())
2251 if (!get_next_history())
2254 /* Rewrite the line with the selected history item */
2255 /* change command */
2256 command_len = load_string(state->history[state->cur_history] ?
2257 state->history[state->cur_history] : "", maxsize);
2258 /* redraw and go to eol (bol, in vi) */
2259 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
2268 case KEYCODE_CTRL_LEFT:
2271 case KEYCODE_CTRL_RIGHT:
2275 input_backward(cursor);
2278 put_till_end_and_adv_cursor();
2282 if (initial_settings.c_cc[VINTR] != 0
2283 && ic_raw == initial_settings.c_cc[VINTR]
2285 /* Ctrl-C (usually) - stop gathering input */
2288 break_out = -1; /* "do not append '\n'" */
2291 if (initial_settings.c_cc[VEOF] != 0
2292 && ic_raw == initial_settings.c_cc[VEOF]
2294 /* Ctrl-D (usually) - delete one character,
2295 * or exit if len=0 and no chars to delete */
2296 if (command_len == 0) {
2298 #if ENABLE_FEATURE_EDITING_VI
2301 break_out = command_len = -1;
2307 // /* Control-V -- force insert of next char */
2308 // if (c == CTRL('V')) {
2309 // if (safe_read(STDIN_FILENO, &c, 1) < 1)
2310 // goto prepare_to_die;
2317 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2318 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2320 /* If VI_CMDMODE_BIT is set, ic is >= 256
2321 * and vi mode ignores unexpected chars.
2322 * Otherwise, we are here if ic is a
2323 * control char or an unhandled ESC sequence,
2324 * which is also ignored.
2328 if ((int)command_len >= (maxsize - 2)) {
2329 /* Not enough space for the char and EOL */
2334 if (cursor == (command_len - 1)) {
2335 /* We are at the end, append */
2336 command_ps[cursor] = ic;
2337 command_ps[cursor + 1] = BB_NUL;
2338 put_cur_glyph_and_inc_cursor();
2339 if (unicode_bidi_isrtl(ic))
2342 /* In the middle, insert */
2345 memmove(command_ps + sc + 1, command_ps + sc,
2346 (command_len - sc) * sizeof(command_ps[0]));
2347 command_ps[sc] = ic;
2348 /* is right-to-left char, or neutral one (e.g. comma) was just added to rtl text? */
2351 put_till_end_and_adv_cursor();
2352 /* to prev x pos + 1 */
2353 input_backward(cursor - sc);
2361 #if ENABLE_FEATURE_TAB_COMPLETION
2367 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
2368 if (S.sent_ESC_br6n) {
2369 /* "sleep 1; busybox ash" + hold [Enter] to trigger.
2370 * We sent "ESC [ 6 n", but got '\n' first, and
2371 * KEYCODE_CURSOR_POS response is now buffered from terminal.
2372 * It's bad already and not much can be done with it
2373 * (it _will_ be visible for the next process to read stdin),
2374 * but without this delay it even shows up on the screen
2375 * as garbage because we restore echo settings with tcsetattr
2376 * before it comes in. UGLY!
2382 /* End of bug-catching "command_must_not_be_used" trick */
2385 #if ENABLE_UNICODE_SUPPORT
2387 if (command_len > 0)
2388 command_len = save_string(command, maxsize - 1);
2392 if (command_len > 0)
2393 remember_in_history(command);
2395 if (break_out > 0) {
2396 command[command_len++] = '\n';
2397 command[command_len] = '\0';
2400 #if ENABLE_FEATURE_TAB_COMPLETION
2401 free_tab_completion_data();
2404 /* restore initial_settings */
2405 tcsetattr_stdin_TCSANOW(&initial_settings);
2406 /* restore SIGWINCH handler */
2407 signal(SIGWINCH, previous_SIGWINCH_handler);
2413 return len; /* can't return command_len, DEINIT_S() destroys it */
2416 #else /* !FEATURE_EDITING */
2418 #undef read_line_input
2419 int FAST_FUNC read_line_input(const char* prompt, char* command, int maxsize)
2421 fputs(prompt, stdout);
2423 fgets(command, maxsize, stdin);
2424 return strlen(command);
2427 #endif /* !FEATURE_EDITING */
2438 const char *applet_name = "debug stuff usage";
2440 int main(int argc, char **argv)
2442 char buff[MAX_LINELEN];
2444 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
2445 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
2446 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
2447 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
2454 l = read_line_input(prompt, buff);
2455 if (l <= 0 || buff[l-1] != '\n')
2458 printf("*** read_line_input() returned line =%s=\n", buff);
2460 printf("*** read_line_input() detect ^D\n");