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_FEATURE_GETUSERNAME_AND_HOMEDIR \
57 (ENABLE_FEATURE_USERNAME_COMPLETION || ENABLE_FEATURE_EDITING_FANCY_PROMPT)
58 #define IF_FEATURE_GETUSERNAME_AND_HOMEDIR(...)
59 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
60 #undef IF_FEATURE_GETUSERNAME_AND_HOMEDIR
61 #define IF_FEATURE_GETUSERNAME_AND_HOMEDIR(...) __VA_ARGS__
65 #define SEQ_CLEAR_TILL_END_OF_SCREEN "\033[J"
66 //#define SEQ_CLEAR_TILL_END_OF_LINE "\033[K"
70 #if ENABLE_UNICODE_SUPPORT
71 # define BB_NUL ((wchar_t)0)
72 # define CHAR_T wchar_t
73 static bool BB_isspace(CHAR_T c) { return ((unsigned)c < 256 && isspace(c)); }
74 # if ENABLE_FEATURE_EDITING_VI
75 static bool BB_isalnum(CHAR_T c) { return ((unsigned)c < 256 && isalnum(c)); }
77 static bool BB_ispunct(CHAR_T c) { return ((unsigned)c < 256 && ispunct(c)); }
82 # define isspace isspace_must_not_be_used
83 # define isalnum isalnum_must_not_be_used
84 # define ispunct ispunct_must_not_be_used
85 # define isprint isprint_must_not_be_used
89 # define BB_isspace(c) isspace(c)
90 # define BB_isalnum(c) isalnum(c)
91 # define BB_ispunct(c) ispunct(c)
95 # if ENABLE_UNICODE_PRESERVE_BROKEN
96 # define unicode_mark_raw_byte(wc) ((wc) | 0x20000000)
97 # define unicode_is_raw_byte(wc) ((wc) & 0x20000000)
99 # define unicode_is_raw_byte(wc) 0
104 /* We use int16_t for positions, need to limit line len */
105 MAX_LINELEN = CONFIG_FEATURE_EDITING_MAX_LEN < 0x7ff0
106 ? CONFIG_FEATURE_EDITING_MAX_LEN
110 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
111 static const char null_str[] ALIGN1 = "";
114 /* We try to minimize both static and stack usage. */
115 struct lineedit_statics {
118 volatile unsigned cmdedit_termw; /* = 80; */ /* actual terminal width */
119 sighandler_t previous_SIGWINCH_handler;
121 unsigned cmdedit_x; /* real x (col) terminal position */
122 unsigned cmdedit_y; /* pseudoreal y (row) terminal position */
123 unsigned cmdedit_prmt_len; /* length of prompt (without colors etc) */
126 int command_len; /* must be signed */
127 /* signed maxsize: we want x in "if (x > S.maxsize)"
128 * to _not_ be promoted to unsigned */
132 const char *cmdedit_prompt;
133 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
134 int num_ok_lines; /* = 1; */
137 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
139 char *home_pwd_buf; /* = (char*)null_str; */
142 #if ENABLE_FEATURE_TAB_COMPLETION
144 unsigned num_matches;
147 #if ENABLE_FEATURE_EDITING_VI
148 #define DELBUFSIZ 128
150 smallint newdelflag; /* whether delbuf should be reused yet */
151 CHAR_T delbuf[DELBUFSIZ]; /* a place to store deleted characters */
153 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
154 smallint sent_ESC_br6n;
157 /* Formerly these were big buffers on stack: */
158 #if ENABLE_FEATURE_TAB_COMPLETION
159 char exe_n_cwd_tab_completion__dirbuf[MAX_LINELEN];
160 char input_tab__matchBuf[MAX_LINELEN];
161 int16_t find_match__int_buf[MAX_LINELEN + 1]; /* need to have 9 bits at least */
162 int16_t find_match__pos_buf[MAX_LINELEN + 1];
166 /* See lineedit_ptr_hack.c */
167 extern struct lineedit_statics *const lineedit_ptr_to_statics;
169 #define S (*lineedit_ptr_to_statics)
170 #define state (S.state )
171 #define cmdedit_termw (S.cmdedit_termw )
172 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
173 #define cmdedit_x (S.cmdedit_x )
174 #define cmdedit_y (S.cmdedit_y )
175 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
176 #define cursor (S.cursor )
177 #define command_len (S.command_len )
178 #define command_ps (S.command_ps )
179 #define cmdedit_prompt (S.cmdedit_prompt )
180 #define num_ok_lines (S.num_ok_lines )
181 #define user_buf (S.user_buf )
182 #define home_pwd_buf (S.home_pwd_buf )
183 #define matches (S.matches )
184 #define num_matches (S.num_matches )
185 #define delptr (S.delptr )
186 #define newdelflag (S.newdelflag )
187 #define delbuf (S.delbuf )
189 #define INIT_S() do { \
190 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
192 cmdedit_termw = 80; \
193 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
194 IF_FEATURE_GETUSERNAME_AND_HOMEDIR(home_pwd_buf = (char*)null_str;) \
196 static void deinit_S(void)
198 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
199 /* This one is allocated only if FANCY_PROMPT is on
200 * (otherwise it points to verbatim prompt (NOT malloced) */
201 free((char*)cmdedit_prompt);
203 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
205 if (home_pwd_buf != null_str)
208 free(lineedit_ptr_to_statics);
210 #define DEINIT_S() deinit_S()
213 #if ENABLE_UNICODE_SUPPORT
214 static size_t load_string(const char *src, int maxsize)
216 ssize_t len = mbstowcs(command_ps, src, maxsize - 1);
222 static unsigned save_string(char *dst, unsigned maxsize)
224 # if !ENABLE_UNICODE_PRESERVE_BROKEN
225 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
235 while (dstpos < maxsize) {
238 while ((wc = command_ps[srcpos]) != 0
239 && !unicode_is_raw_byte(wc)
243 command_ps[srcpos] = 0;
244 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
245 if (n < 0) /* should not happen */
248 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 static void username_tab_completion(char *ud, char *with_shash_flg)
613 struct passwd *entry;
616 ud++; /* ~user/... to user/... */
617 userlen = strlen(ud);
619 if (with_shash_flg) { /* "~/..." or "~user/..." */
620 char *sav_ud = ud - 1;
623 if (*ud == '/') { /* "~/..." */
628 temp = strchr(ud, '/');
629 *temp = '\0'; /* ~user\0 */
630 entry = getpwnam(ud);
631 *temp = '/'; /* restore ~user/... */
634 home = entry->pw_dir;
637 if ((userlen + strlen(home) + 1) < MAX_LINELEN) {
639 sprintf(sav_ud, "%s%s", home, ud);
644 /* Using _r function to avoid pulling in static buffers */
647 struct passwd *result;
650 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
651 /* Null usernames should result in all users as possible completions. */
652 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
653 add_match(xasprintf("~%s/", pwd.pw_name));
659 #endif /* FEATURE_COMMAND_USERNAME_COMPLETION */
667 static int path_parse(char ***p, int flags)
674 /* if not setenv PATH variable, to search cur dir "." */
675 if (flags != FIND_EXE_ONLY)
678 if (state->flags & WITH_PATH_LOOKUP)
679 pth = state->path_lookup;
681 pth = getenv("PATH");
682 /* PATH=<empty> or PATH=:<empty> */
683 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
687 npth = 1; /* path component count */
689 tmp = strchr(tmp, ':');
693 break; /* :<empty> */
697 res = xmalloc(npth * sizeof(char*));
698 res[0] = tmp = xstrdup(pth);
701 tmp = strchr(tmp, ':');
704 *tmp++ = '\0'; /* ':' -> '\0' */
706 break; /* :<empty> */
713 static void exe_n_cwd_tab_completion(char *command, int type)
719 char **paths = path1;
723 char *pfind = strrchr(command, '/');
724 /* char dirbuf[MAX_LINELEN]; */
725 #define dirbuf (S.exe_n_cwd_tab_completion__dirbuf)
728 path1[0] = (char*)".";
731 /* no dir, if flags==EXE_ONLY - get paths, else "." */
732 npaths = path_parse(&paths, type);
735 /* dirbuf = ".../.../.../" */
736 safe_strncpy(dirbuf, command, (pfind - command) + 2);
737 #if ENABLE_FEATURE_USERNAME_COMPLETION
738 if (dirbuf[0] == '~') /* ~/... or ~user/... */
739 username_tab_completion(dirbuf, dirbuf);
742 /* point to 'l' in "..../last_component" */
746 for (i = 0; i < npaths; i++) {
747 dir = opendir(paths[i]);
749 continue; /* don't print an error */
751 while ((next = readdir(dir)) != NULL) {
753 const char *str_found = next->d_name;
756 if (strncmp(str_found, pfind, strlen(pfind)))
758 /* not see .name without .match */
759 if (*str_found == '.' && *pfind == '\0') {
760 if (NOT_LONE_CHAR(paths[i], '/') || str_found[1])
762 str_found = ""; /* only "/" */
764 found = concat_path_file(paths[i], str_found);
765 /* hmm, remove in progress? */
766 /* NB: stat() first so that we see is it a directory;
767 * but if that fails, use lstat() so that
768 * we still match dangling links */
769 if (stat(found, &st) && lstat(found, &st))
771 /* find with dirs? */
772 if (paths[i] != dirbuf)
773 strcpy(found, next->d_name); /* only name */
775 len1 = strlen(found);
776 found = xrealloc(found, len1 + 2);
778 found[len1+1] = '\0';
780 if (S_ISDIR(st.st_mode)) {
781 /* name is a directory */
782 if (found[len1-1] != '/') {
786 /* not put found file if search only dirs for cd */
787 if (type == FIND_DIR_ONLY)
790 /* Add it to the list */
798 if (paths != path1) {
799 free(paths[0]); /* allocated memory is only in first member */
805 /* QUOT is used on elements of int_buf[], which are bytes,
806 * not Unicode chars. Therefore it works correctly even in Unicode mode.
808 #define QUOT (UCHAR_MAX+1)
810 #define int_buf (S.find_match__int_buf)
811 #define pos_buf (S.find_match__pos_buf)
812 /* is must be <= in */
813 static void collapse_pos(int is, int in)
815 memmove(int_buf+is, int_buf+in, (MAX_LINELEN+1-in)*sizeof(int_buf[0]));
816 memmove(pos_buf+is, pos_buf+in, (MAX_LINELEN+1-in)*sizeof(pos_buf[0]));
818 static NOINLINE int find_match(char *matchBuf, int *len_with_quotes)
823 /* Were local, but it uses too much stack */
824 /* int16_t int_buf[MAX_LINELEN + 1]; */
825 /* int16_t pos_buf[MAX_LINELEN + 1]; */
827 /* set to integer dimension characters and own positions */
829 int_buf[i] = (unsigned char)matchBuf[i];
830 if (int_buf[i] == 0) {
831 pos_buf[i] = -1; /* end-fo-line indicator */
837 /* mask \+symbol and convert '\t' to ' ' */
838 for (i = j = 0; matchBuf[i]; i++, j++) {
839 if (matchBuf[i] == '\\') {
840 collapse_pos(j, j + 1);
845 /* mask "symbols" or 'symbols' */
847 for (i = 0; int_buf[i]; i++) {
849 if (c == '\'' || c == '"') {
858 } else if (c2 != 0 && c != '$')
862 /* skip commands with arguments if line has commands delimiters */
863 /* ';' ';;' '&' '|' '&&' '||' but `>&' `<&' `>|' */
864 for (i = 0; int_buf[i]; i++) {
867 j = i ? int_buf[i - 1] : -1;
869 if (c == ';' || c == '&' || c == '|') {
870 command_mode = 1 + (c == c2);
872 if (j == '>' || j == '<')
874 } else if (c == '|' && j == '>')
878 collapse_pos(0, i + command_mode);
879 i = -1; /* hack incremet */
882 /* collapse `command...` */
883 for (i = 0; int_buf[i]; i++) {
884 if (int_buf[i] == '`') {
885 for (j = i + 1; int_buf[j]; j++)
886 if (int_buf[j] == '`') {
887 collapse_pos(i, j + 1);
892 /* not found closing ` - command mode, collapse all previous */
893 collapse_pos(0, i + 1);
896 i--; /* hack incremet */
900 /* collapse (command...(command...)...) or {command...{command...}...} */
901 c = 0; /* "recursive" level */
903 for (i = 0; int_buf[i]; i++) {
904 if (int_buf[i] == '(' || int_buf[i] == '{') {
905 if (int_buf[i] == '(')
909 collapse_pos(0, i + 1);
910 i = -1; /* hack incremet */
913 for (i = 0; pos_buf[i] >= 0 && (c > 0 || c2 > 0); i++) {
914 if ((int_buf[i] == ')' && c > 0) || (int_buf[i] == '}' && c2 > 0)) {
915 if (int_buf[i] == ')')
919 collapse_pos(0, i + 1);
920 i = -1; /* hack incremet */
924 /* skip first not quote space */
925 for (i = 0; int_buf[i]; i++)
926 if (int_buf[i] != ' ')
931 /* set find mode for completion */
932 command_mode = FIND_EXE_ONLY;
933 for (i = 0; int_buf[i]; i++) {
934 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
935 if (int_buf[i] == ' ' && command_mode == FIND_EXE_ONLY
936 && matchBuf[pos_buf[0]] == 'c'
937 && matchBuf[pos_buf[1]] == 'd'
939 command_mode = FIND_DIR_ONLY;
941 command_mode = FIND_FILE_ONLY;
946 for (i = 0; int_buf[i]; i++)
949 for (--i; i >= 0; i--) {
951 if (c == ' ' || c == '<' || c == '>' || c == '|' || c == '&') {
952 collapse_pos(0, i + 1);
956 /* skip first not quoted '\'' or '"' */
957 for (i = 0; int_buf[i] == '\'' || int_buf[i] == '"'; i++)
959 /* collapse quote or unquote // or /~ */
960 while ((int_buf[i] & ~QUOT) == '/'
961 && ((int_buf[i+1] & ~QUOT) == '/' || (int_buf[i+1] & ~QUOT) == '~')
966 /* set only match and destroy quotes */
968 for (c = 0; pos_buf[i] >= 0; i++) {
969 matchBuf[c++] = matchBuf[pos_buf[i]];
973 /* old length matchBuf with quotes symbols */
974 *len_with_quotes = j ? j - pos_buf[0] : 0;
982 * display by column (original idea from ls applet,
983 * very optimized by me :)
985 static void showfiles(void)
988 int column_width = 0;
989 int nfiles = num_matches;
993 /* find the longest file name - use that as the column width */
994 for (row = 0; row < nrows; row++) {
995 l = unicode_strwidth(matches[row]);
996 if (column_width < l)
999 column_width += 2; /* min space for columns */
1000 ncols = cmdedit_termw / column_width;
1005 nrows++; /* round up fractionals */
1009 for (row = 0; row < nrows; row++) {
1013 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1014 printf("%s%-*s", matches[n],
1015 (int)(column_width - unicode_strwidth(matches[n])), ""
1018 if (ENABLE_UNICODE_SUPPORT)
1019 puts(printable_string(NULL, matches[n]));
1025 static char *add_quote_for_spec_chars(char *found)
1028 char *s = xzalloc((strlen(found) + 1) * 2);
1031 if (strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", *found))
1035 /* s[l] = '\0'; - already is */
1039 /* Do TAB completion */
1040 static void input_tab(smallint *lastWasTab)
1042 if (!(state->flags & TAB_COMPLETION))
1048 /* char matchBuf[MAX_LINELEN]; */
1049 #define matchBuf (S.input_tab__matchBuf)
1052 #if ENABLE_UNICODE_SUPPORT
1053 /* cursor pos in command converted to multibyte form */
1057 *lastWasTab = TRUE; /* flop trigger */
1059 /* Make a local copy of the string --
1060 * up to the position of the cursor */
1061 save_string(matchBuf, cursor + 1);
1062 #if ENABLE_UNICODE_SUPPORT
1063 cursor_mb = strlen(matchBuf);
1067 find_type = find_match(matchBuf, &recalc_pos);
1069 /* Free up any memory already allocated */
1070 free_tab_completion_data();
1072 #if ENABLE_FEATURE_USERNAME_COMPLETION
1073 /* If the word starts with `~' and there is no slash in the word,
1074 * then try completing this word as a username. */
1075 if (state->flags & USERNAME_COMPLETION)
1076 if (matchBuf[0] == '~' && strchr(matchBuf, '/') == NULL)
1077 username_tab_completion(matchBuf, NULL);
1079 /* Try to match any executable in our path and everything
1080 * in the current working directory */
1082 exe_n_cwd_tab_completion(matchBuf, find_type);
1083 /* Sort, then remove any duplicates found */
1087 qsort_string_vector(matches, num_matches);
1088 for (i = 0; i < num_matches - 1; ++i) {
1089 if (matches[i] && matches[i+1]) { /* paranoia */
1090 if (strcmp(matches[i], matches[i+1]) == 0) {
1092 matches[i] = NULL; /* paranoia */
1094 matches[n++] = matches[i];
1098 matches[n] = matches[i];
1099 num_matches = n + 1;
1101 /* Did we find exactly one match? */
1102 if (!matches || num_matches > 1) { /* no */
1105 return; /* not found */
1106 /* find minimal match */
1107 tmp1 = xstrdup(matches[0]);
1108 for (tmp = tmp1; *tmp; tmp++) {
1109 for (len_found = 1; len_found < num_matches; len_found++) {
1110 if (matches[len_found][tmp - tmp1] != *tmp) {
1116 if (*tmp1 == '\0') { /* have unique */
1120 tmp = add_quote_for_spec_chars(tmp1);
1122 } else { /* one match */
1123 tmp = add_quote_for_spec_chars(matches[0]);
1124 /* for next completion current found */
1125 *lastWasTab = FALSE;
1127 len_found = strlen(tmp);
1128 if (tmp[len_found-1] != '/') {
1129 tmp[len_found] = ' ';
1130 tmp[len_found+1] = '\0';
1134 len_found = strlen(tmp);
1135 #if !ENABLE_UNICODE_SUPPORT
1136 /* have space to place the match? */
1137 /* The result consists of three parts with these lengths: */
1138 /* (cursor - recalc_pos) + len_found + (command_len - cursor) */
1139 /* it simplifies into: */
1140 if ((int)(len_found + command_len - recalc_pos) < S.maxsize) {
1142 strcpy(matchBuf, command_ps + cursor);
1143 /* add match and tail */
1144 sprintf(&command_ps[cursor - recalc_pos], "%s%s", tmp, matchBuf);
1145 command_len = strlen(command_ps);
1147 recalc_pos = cursor - recalc_pos + len_found;
1148 /* write out the matched command */
1149 redraw(cmdedit_y, command_len - recalc_pos);
1153 char command[MAX_LINELEN];
1154 int len = save_string(command, sizeof(command));
1155 /* have space to place the match? */
1156 /* (cursor_mb - recalc_pos) + len_found + (len - cursor_mb) */
1157 if ((int)(len_found + len - recalc_pos) < MAX_LINELEN) {
1159 strcpy(matchBuf, command + cursor_mb);
1160 /* where do we want to have cursor after all? */
1161 strcpy(&command[cursor_mb - recalc_pos], tmp);
1162 len = load_string(command, S.maxsize);
1163 /* add match and tail */
1164 sprintf(&command[cursor_mb - recalc_pos], "%s%s", tmp, matchBuf);
1165 command_len = load_string(command, S.maxsize);
1166 /* write out the matched command */
1167 redraw(cmdedit_y, command_len - len);
1174 /* Ok -- the last char was a TAB. Since they
1175 * just hit TAB again, print a list of all the
1176 * available choices... */
1177 if (matches && num_matches > 0) {
1178 /* changed by goto_new_line() */
1179 int sav_cursor = cursor;
1181 /* Go to the next line */
1184 redraw(0, command_len - sav_cursor);
1189 #endif /* FEATURE_COMMAND_TAB_COMPLETION */
1192 line_input_t* FAST_FUNC new_line_input_t(int flags)
1194 line_input_t *n = xzalloc(sizeof(*n));
1202 static void save_command_ps_at_cur_history(void)
1204 if (command_ps[0] != BB_NUL) {
1205 int cur = state->cur_history;
1206 free(state->history[cur]);
1208 # if ENABLE_UNICODE_SUPPORT
1210 char tbuf[MAX_LINELEN];
1211 save_string(tbuf, sizeof(tbuf));
1212 state->history[cur] = xstrdup(tbuf);
1215 state->history[cur] = xstrdup(command_ps);
1220 /* state->flags is already checked to be nonzero */
1221 static int get_previous_history(void)
1223 if ((state->flags & DO_HISTORY) && state->cur_history) {
1224 save_command_ps_at_cur_history();
1225 state->cur_history--;
1232 static int get_next_history(void)
1234 if (state->flags & DO_HISTORY) {
1235 if (state->cur_history < state->cnt_history) {
1236 save_command_ps_at_cur_history(); /* save the current history line */
1237 return ++state->cur_history;
1244 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1245 /* We try to ensure that concurrent additions to the history
1246 * do not overwrite each other.
1247 * Otherwise shell users get unhappy.
1249 * History file is trimmed lazily, when it grows several times longer
1250 * than configured MAX_HISTORY lines.
1253 static void free_line_input_t(line_input_t *n)
1255 int i = n->cnt_history;
1257 free(n->history[--i]);
1261 /* state->flags is already checked to be nonzero */
1262 static void load_history(line_input_t *st_parm)
1264 char *temp_h[MAX_HISTORY];
1267 unsigned idx, i, line_len;
1269 /* NB: do not trash old history if file can't be opened */
1271 fp = fopen_for_read(st_parm->hist_file);
1273 /* clean up old history */
1274 for (idx = st_parm->cnt_history; idx > 0;) {
1276 free(st_parm->history[idx]);
1277 st_parm->history[idx] = NULL;
1280 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1281 memset(temp_h, 0, sizeof(temp_h));
1282 st_parm->cnt_history_in_file = idx = 0;
1283 while ((line = xmalloc_fgetline(fp)) != NULL) {
1284 if (line[0] == '\0') {
1290 st_parm->cnt_history_in_file++;
1292 if (idx == MAX_HISTORY)
1297 /* find first non-NULL temp_h[], if any */
1298 if (st_parm->cnt_history_in_file) {
1299 while (temp_h[idx] == NULL) {
1301 if (idx == MAX_HISTORY)
1306 /* copy temp_h[] to st_parm->history[] */
1307 for (i = 0; i < MAX_HISTORY;) {
1312 if (idx == MAX_HISTORY)
1314 line_len = strlen(line);
1315 if (line_len >= MAX_LINELEN)
1316 line[MAX_LINELEN-1] = '\0';
1317 st_parm->history[i++] = line;
1319 st_parm->cnt_history = i;
1323 /* state->flags is already checked to be nonzero */
1324 static void save_history(char *str)
1329 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0666);
1332 xlseek(fd, 0, SEEK_END); /* paranoia */
1334 str[len] = '\n'; /* we (try to) do atomic write */
1335 len2 = full_write(fd, str, len + 1);
1338 if (len2 != len + 1)
1339 return; /* "wtf?" */
1341 /* did we write so much that history file needs trimming? */
1342 state->cnt_history_in_file++;
1343 if (state->cnt_history_in_file > MAX_HISTORY * 4) {
1346 line_input_t *st_temp;
1349 /* we may have concurrently written entries from others.
1351 st_temp = new_line_input_t(state->flags);
1352 st_temp->hist_file = state->hist_file;
1353 load_history(st_temp);
1355 /* write out temp file and replace hist_file atomically */
1356 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1357 fp = fopen_for_write(new_name);
1359 for (i = 0; i < st_temp->cnt_history; i++)
1360 fprintf(fp, "%s\n", st_temp->history[i]);
1362 if (rename(new_name, state->hist_file) == 0)
1363 state->cnt_history_in_file = st_temp->cnt_history;
1366 free_line_input_t(st_temp);
1370 # define load_history(a) ((void)0)
1371 # define save_history(a) ((void)0)
1372 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1374 static void remember_in_history(char *str)
1378 if (!(state->flags & DO_HISTORY))
1382 i = state->cnt_history;
1383 /* Don't save dupes */
1384 if (i && strcmp(state->history[i-1], str) == 0)
1387 free(state->history[MAX_HISTORY]); /* redundant, paranoia */
1388 state->history[MAX_HISTORY] = NULL; /* redundant, paranoia */
1390 /* If history[] is full, remove the oldest command */
1391 /* we need to keep history[MAX_HISTORY] empty, hence >=, not > */
1392 if (i >= MAX_HISTORY) {
1393 free(state->history[0]);
1394 for (i = 0; i < MAX_HISTORY-1; i++)
1395 state->history[i] = state->history[i+1];
1396 /* i == MAX_HISTORY-1 */
1398 /* i <= MAX_HISTORY-1 */
1399 state->history[i++] = xstrdup(str);
1400 /* i <= MAX_HISTORY */
1401 state->cur_history = i;
1402 state->cnt_history = i;
1403 # if MAX_HISTORY > 0 && ENABLE_FEATURE_EDITING_SAVEHISTORY
1404 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1407 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1410 #else /* MAX_HISTORY == 0 */
1411 # define remember_in_history(a) ((void)0)
1412 #endif /* MAX_HISTORY */
1415 #if ENABLE_FEATURE_EDITING_VI
1417 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1420 vi_Word_motion(int eat)
1422 CHAR_T *command = command_ps;
1424 while (cursor < command_len && !BB_isspace(command[cursor]))
1426 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1431 vi_word_motion(int eat)
1433 CHAR_T *command = command_ps;
1435 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1436 while (cursor < command_len
1437 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1441 } else if (BB_ispunct(command[cursor])) {
1442 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1446 if (cursor < command_len)
1450 while (cursor < command_len && BB_isspace(command[cursor]))
1458 CHAR_T *command = command_ps;
1461 while (cursor < command_len && BB_isspace(command[cursor]))
1463 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1470 CHAR_T *command = command_ps;
1472 if (cursor >= command_len-1)
1475 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1477 if (cursor >= command_len-1)
1479 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1480 while (cursor < command_len-1
1481 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1485 } else if (BB_ispunct(command[cursor])) {
1486 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1492 vi_Back_motion(void)
1494 CHAR_T *command = command_ps;
1496 while (cursor > 0 && BB_isspace(command[cursor-1]))
1498 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1503 vi_back_motion(void)
1505 CHAR_T *command = command_ps;
1510 while (cursor > 0 && BB_isspace(command[cursor]))
1514 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1516 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1520 } else if (BB_ispunct(command[cursor])) {
1521 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1527 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1528 static void ctrl_left(void)
1530 CHAR_T *command = command_ps;
1538 c = command[cursor];
1539 if (c != ' ' && !BB_ispunct(c)) {
1540 /* we reached a "word" delimited by spaces/punct.
1541 * go to its beginning */
1543 c = command[cursor - 1];
1544 if (c == ' ' || BB_ispunct(c))
1554 static void ctrl_right(void)
1556 CHAR_T *command = command_ps;
1561 c = command[cursor];
1564 if (c != ' ' && !BB_ispunct(c)) {
1565 /* we reached a "word" delimited by spaces/punct.
1566 * go to its end + 1 */
1569 c = command[cursor];
1570 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1581 * read_line_input and its helpers
1584 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1585 static void ask_terminal(void)
1587 /* Ask terminal where is the cursor now.
1588 * lineedit_read_key handles response and corrects
1589 * our idea of current cursor position.
1590 * Testcase: run "echo -n long_line_long_line_long_line",
1591 * then type in a long, wrapping command and try to
1592 * delete it using backspace key.
1593 * Note: we print it _after_ prompt, because
1594 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1596 /* Problem: if there is buffered input on stdin,
1597 * the response will be delivered later,
1598 * possibly to an unsuspecting application.
1599 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1601 * ~/srcdevel/bbox/fix/busybox.t4 #
1602 * ~/srcdevel/bbox/fix/busybox.t4 #
1603 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1604 * ~/srcdevel/bbox/fix/busybox.t4 #
1606 * Checking for input with poll only makes the race narrower,
1607 * I still can trigger it. Strace:
1609 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1610 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1611 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1612 * poll([{fd=0, events=POLLIN}], 1, 4294967295) = 1 ([{fd=0, revents=POLLIN}])
1613 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1617 pfd.fd = STDIN_FILENO;
1618 pfd.events = POLLIN;
1619 if (safe_poll(&pfd, 1, 0) == 0) {
1620 S.sent_ESC_br6n = 1;
1621 fputs("\033" "[6n", stdout);
1622 fflush_all(); /* make terminal see it ASAP! */
1626 #define ask_terminal() ((void)0)
1629 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1630 static void parse_and_put_prompt(const char *prmt_ptr)
1632 cmdedit_prompt = prmt_ptr;
1633 cmdedit_prmt_len = strlen(prmt_ptr);
1637 static void parse_and_put_prompt(const char *prmt_ptr)
1640 size_t cur_prmt_len = 0;
1641 char flg_not_length = '[';
1642 char *prmt_mem_ptr = xzalloc(1);
1643 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1648 cmdedit_prmt_len = 0;
1651 cwd_buf = (char *)bb_msg_unknown;
1654 cbuf[1] = '\0'; /* never changes */
1657 char *free_me = NULL;
1662 const char *cp = prmt_ptr;
1665 c = bb_process_escape_sequence(&prmt_ptr);
1666 if (prmt_ptr == cp) {
1672 # if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
1674 pbuf = user_buf ? user_buf : (char*)"";
1678 pbuf = free_me = safe_gethostname();
1679 *strchrnul(pbuf, '.') = '\0';
1682 c = (geteuid() == 0 ? '#' : '$');
1684 # if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
1686 /* /home/user[/something] -> ~[/something] */
1688 l = strlen(home_pwd_buf);
1690 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1691 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1692 && strlen(cwd_buf + l) < PATH_MAX
1694 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1700 cp = strrchr(pbuf, '/');
1701 if (cp != NULL && cp != pbuf)
1702 pbuf += (cp-pbuf) + 1;
1705 pbuf = free_me = xasprintf("%d", num_ok_lines);
1707 case 'e': case 'E': /* \e \E = \033 */
1710 case 'x': case 'X': {
1712 for (l = 0; l < 3;) {
1714 buf2[l++] = *prmt_ptr;
1716 h = strtoul(buf2, &pbuf, 16);
1717 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1723 c = (char)strtoul(buf2, NULL, 16);
1730 if (c == flg_not_length) {
1731 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1739 cur_prmt_len = strlen(pbuf);
1740 prmt_len += cur_prmt_len;
1741 if (flg_not_length != ']')
1742 cmdedit_prmt_len += cur_prmt_len;
1743 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1747 if (cwd_buf != (char *)bb_msg_unknown)
1749 cmdedit_prompt = prmt_mem_ptr;
1754 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1758 /* new y for current cursor */
1759 int new_y = (cursor + cmdedit_prmt_len) / w;
1761 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1766 static void win_changed(int nsig)
1769 get_terminal_width_height(0, &width, NULL);
1770 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1771 if (nsig == SIGWINCH)
1772 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_FEATURE_GETUSERNAME_AND_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 /* Stop bug catching using "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 */
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");