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 unknown_width;
153 smallint sent_ESC_br6n;
156 /* Formerly these were big buffers on stack: */
157 #if ENABLE_FEATURE_TAB_COMPLETION
158 char exe_n_cwd_tab_completion__dirbuf[MAX_LINELEN];
159 char input_tab__matchBuf[MAX_LINELEN];
160 int16_t find_match__int_buf[MAX_LINELEN + 1]; /* need to have 9 bits at least */
161 int16_t find_match__pos_buf[MAX_LINELEN + 1];
165 /* See lineedit_ptr_hack.c */
166 extern struct lineedit_statics *const lineedit_ptr_to_statics;
168 #define S (*lineedit_ptr_to_statics)
169 #define state (S.state )
170 #define cmdedit_termw (S.cmdedit_termw )
171 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
172 #define cmdedit_x (S.cmdedit_x )
173 #define cmdedit_y (S.cmdedit_y )
174 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
175 #define cursor (S.cursor )
176 #define command_len (S.command_len )
177 #define command_ps (S.command_ps )
178 #define cmdedit_prompt (S.cmdedit_prompt )
179 #define num_ok_lines (S.num_ok_lines )
180 #define user_buf (S.user_buf )
181 #define home_pwd_buf (S.home_pwd_buf )
182 #define matches (S.matches )
183 #define num_matches (S.num_matches )
184 #define delptr (S.delptr )
185 #define newdelflag (S.newdelflag )
186 #define delbuf (S.delbuf )
188 #define INIT_S() do { \
189 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
191 cmdedit_termw = 80; \
192 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
193 IF_USERNAME_OR_HOMEDIR(home_pwd_buf = (char*)null_str;) \
195 static void deinit_S(void)
197 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
198 /* This one is allocated only if FANCY_PROMPT is on
199 * (otherwise it points to verbatim prompt (NOT malloced) */
200 free((char*)cmdedit_prompt);
202 #if ENABLE_USERNAME_OR_HOMEDIR
204 if (home_pwd_buf != null_str)
207 free(lineedit_ptr_to_statics);
209 #define DEINIT_S() deinit_S()
212 #if ENABLE_UNICODE_SUPPORT
213 static size_t load_string(const char *src, int maxsize)
215 ssize_t len = mbstowcs(command_ps, src, maxsize - 1);
221 static unsigned save_string(char *dst, unsigned maxsize)
223 # if !ENABLE_UNICODE_PRESERVE_BROKEN
224 ssize_t len = wcstombs(dst, command_ps, maxsize - 1);
234 while (dstpos < maxsize) {
237 while ((wc = command_ps[srcpos]) != 0
238 && !unicode_is_raw_byte(wc)
242 command_ps[srcpos] = 0;
243 n = wcstombs(dst + dstpos, command_ps + n, maxsize - dstpos);
244 if (n < 0) /* should not happen */
247 if (wc == 0) /* usually is */
249 /* We do have invalid byte here! */
250 command_ps[srcpos] = wc; /* restore it */
252 if (dstpos == maxsize)
254 dst[dstpos++] = (char) wc;
260 /* I thought just fputwc(c, stdout) would work. But no... */
261 static void BB_PUTCHAR(wchar_t c)
263 char buf[MB_CUR_MAX + 1];
264 mbstate_t mbst = { 0 };
267 len = wcrtomb(buf, c, &mbst);
273 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
274 static wchar_t adjust_width_and_validate_wc(unsigned *width_adj, wchar_t wc)
276 static wchar_t adjust_width_and_validate_wc(wchar_t wc)
277 # define adjust_width_and_validate_wc(width_adj, wc) \
278 ((*(width_adj))++, adjust_width_and_validate_wc(wc))
283 if (unicode_status == UNICODE_ON) {
284 if (wc > CONFIG_LAST_SUPPORTED_WCHAR) {
285 /* note: also true for unicode_is_raw_byte(wc) */
289 if ((ENABLE_UNICODE_COMBINING_WCHARS && w < 0)
290 || (!ENABLE_UNICODE_COMBINING_WCHARS && w <= 0)
291 || (!ENABLE_UNICODE_WIDE_WCHARS && w > 1)
295 wc = CONFIG_SUBST_WCHAR;
299 # if ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS
305 static size_t load_string(const char *src, int maxsize)
307 safe_strncpy(command_ps, src, maxsize);
308 return strlen(command_ps);
310 # if ENABLE_FEATURE_TAB_COMPLETION
311 static void save_string(char *dst, unsigned maxsize)
313 safe_strncpy(dst, command_ps, maxsize);
316 # define BB_PUTCHAR(c) bb_putchar(c)
317 /* Should never be called: */
318 int adjust_width_and_validate_wc(unsigned *width_adj, int wc);
322 /* Put 'command_ps[cursor]', cursor++.
323 * Advance cursor on screen. If we reached right margin, scroll text up
324 * and remove terminal margin effect by printing 'next_char' */
325 #define HACK_FOR_WRONG_WIDTH 1
326 static void put_cur_glyph_and_inc_cursor(void)
328 CHAR_T c = command_ps[cursor];
333 /* erase character after end of input string */
336 /* advance cursor only if we aren't at the end yet */
338 if (unicode_status == UNICODE_ON) {
339 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x;)
340 c = adjust_width_and_validate_wc(&cmdedit_x, c);
341 IF_UNICODE_WIDE_WCHARS(width = cmdedit_x - width;)
347 ofs_to_right = cmdedit_x - cmdedit_termw;
348 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right <= 0) {
349 /* c fits on this line */
353 if (ofs_to_right >= 0) {
354 /* we go to the next line */
355 #if HACK_FOR_WRONG_WIDTH
356 /* This works better if our idea of term width is wrong
357 * and it is actually wider (often happens on serial lines).
358 * Printing CR,LF *forces* cursor to next line.
359 * OTOH if terminal width is correct AND terminal does NOT
360 * have automargin (IOW: it is moving cursor to next line
361 * by itself (which is wrong for VT-10x terminals)),
362 * this will break things: there will be one extra empty line */
363 puts("\r"); /* + implicit '\n' */
365 /* VT-10x terminals don't wrap cursor to next line when last char
366 * on the line is printed - cursor stays "over" this char.
367 * Need to print _next_ char too (first one to appear on next line)
368 * to make cursor move down to next line.
370 /* Works ok only if cmdedit_termw is correct. */
371 c = command_ps[cursor];
378 if (!ENABLE_UNICODE_WIDE_WCHARS || ofs_to_right == 0) {
380 } else { /* ofs_to_right > 0 */
381 /* wide char c didn't fit on prev line */
388 /* Move to end of line (by printing all chars till the end) */
389 static void put_till_end_and_adv_cursor(void)
391 while (cursor < command_len)
392 put_cur_glyph_and_inc_cursor();
395 /* Go to the next line */
396 static void goto_new_line(void)
398 put_till_end_and_adv_cursor();
403 static void beep(void)
408 static void put_prompt(void)
412 fputs(cmdedit_prompt, stdout);
415 w = cmdedit_termw; /* read volatile var once */
416 cmdedit_y = cmdedit_prmt_len / w; /* new quasireal y */
417 cmdedit_x = cmdedit_prmt_len % w;
420 /* Move back one character */
421 /* (optimized for slow terminals) */
422 static void input_backward(unsigned num)
430 if ((ENABLE_UNICODE_COMBINING_WCHARS || ENABLE_UNICODE_WIDE_WCHARS)
431 && unicode_status == UNICODE_ON
433 /* correct NUM to be equal to _screen_ width */
437 adjust_width_and_validate_wc(&num, command_ps[cursor + n]);
442 if (cmdedit_x >= num) {
445 /* This is longer by 5 bytes on x86.
446 * Also gets miscompiled for ARM users
447 * (busybox.net/bugs/view.php?id=2274).
448 * printf(("\b\b\b\b" + 4) - num);
456 printf("\033[%uD", num);
460 /* Need to go one or more lines up */
461 if (ENABLE_UNICODE_WIDE_WCHARS) {
462 /* With wide chars, it is hard to "backtrack"
463 * and reliably figure out where to put cursor.
464 * Example (<> is a wide char; # is an ordinary char, _ cursor):
468 * and user presses left arrow. num = 1, cmdedit_x = 0,
469 * We need to go up one line, and then - how do we know that
470 * we need to go *10* positions to the right? Because
474 * in this situation we need to go *11* positions to the right.
476 * A simpler thing to do is to redraw everything from the start
477 * up to new cursor position (which is already known):
480 /* go to 1st column; go up to first line */
481 printf("\r" "\033[%uA", cmdedit_y);
484 put_prompt(); /* sets cursor to 0 */
485 while (cursor < sv_cursor)
486 put_cur_glyph_and_inc_cursor();
490 /* num = chars to go back from the beginning of current line: */
492 width = cmdedit_termw; /* read volatile var once */
493 /* num=1...w: one line up, w+1...2w: two, etc: */
494 lines_up = 1 + (num - 1) / width;
495 cmdedit_x = (width * cmdedit_y - num) % width;
496 cmdedit_y -= lines_up;
497 /* go to 1st column; go up */
498 printf("\r" "\033[%uA", lines_up);
499 /* go to correct column.
500 * xterm, konsole, Linux VT interpret 0 as 1 below! wow.
501 * need to *make sure* we skip it if cmdedit_x == 0 */
503 printf("\033[%uC", cmdedit_x);
507 /* draw prompt, editor line, and clear tail */
508 static void redraw(int y, int back_cursor)
510 if (y > 0) /* up y lines */
511 printf("\033[%uA", y);
514 put_till_end_and_adv_cursor();
515 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
516 input_backward(back_cursor);
519 /* Delete the char in front of the cursor, optionally saving it
520 * for later putback */
521 #if !ENABLE_FEATURE_EDITING_VI
522 static void input_delete(void)
523 #define input_delete(save) input_delete()
525 static void input_delete(int save)
530 if (j == (int)command_len)
533 #if ENABLE_FEATURE_EDITING_VI
539 if ((delptr - delbuf) < DELBUFSIZ)
540 *delptr++ = command_ps[j];
544 memmove(command_ps + j, command_ps + j + 1,
545 /* (command_len + 1 [because of NUL]) - (j + 1)
546 * simplified into (command_len - j) */
547 (command_len - j) * sizeof(command_ps[0]));
549 put_till_end_and_adv_cursor();
550 /* Last char is still visible, erase it (and more) */
551 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
552 input_backward(cursor - j); /* back to old pos cursor */
555 #if ENABLE_FEATURE_EDITING_VI
556 static void put(void)
559 int j = delptr - delbuf;
564 /* open hole and then fill it */
565 memmove(command_ps + cursor + j, command_ps + cursor,
566 (command_len - cursor + 1) * sizeof(command_ps[0]));
567 memcpy(command_ps + cursor, delbuf, j * sizeof(command_ps[0]));
569 put_till_end_and_adv_cursor();
570 input_backward(cursor - ocursor - j + 1); /* at end of new text */
574 /* Delete the char in back of the cursor */
575 static void input_backspace(void)
583 /* Move forward one character */
584 static void input_forward(void)
586 if (cursor < command_len)
587 put_cur_glyph_and_inc_cursor();
590 #if ENABLE_FEATURE_TAB_COMPLETION
592 static void free_tab_completion_data(void)
596 free(matches[--num_matches]);
602 static void add_match(char *matched)
604 matches = xrealloc_vector(matches, 4, num_matches);
605 matches[num_matches] = matched;
609 #if ENABLE_FEATURE_USERNAME_COMPLETION
610 static void username_tab_completion(char *ud, char *with_shash_flg)
612 struct passwd *entry;
615 ud++; /* ~user/... to user/... */
616 userlen = strlen(ud);
618 if (with_shash_flg) { /* "~/..." or "~user/..." */
619 char *sav_ud = ud - 1;
622 if (*ud == '/') { /* "~/..." */
627 temp = strchr(ud, '/');
628 *temp = '\0'; /* ~user\0 */
629 entry = getpwnam(ud);
630 *temp = '/'; /* restore ~user/... */
633 home = entry->pw_dir;
636 if ((userlen + strlen(home) + 1) < MAX_LINELEN) {
638 sprintf(sav_ud, "%s%s", home, ud);
643 /* Using _r function to avoid pulling in static buffers */
646 struct passwd *result;
649 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
650 /* Null usernames should result in all users as possible completions. */
651 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
652 add_match(xasprintf("~%s/", pwd.pw_name));
658 #endif /* FEATURE_COMMAND_USERNAME_COMPLETION */
666 static int path_parse(char ***p, int flags)
673 /* if not setenv PATH variable, to search cur dir "." */
674 if (flags != FIND_EXE_ONLY)
677 if (state->flags & WITH_PATH_LOOKUP)
678 pth = state->path_lookup;
680 pth = getenv("PATH");
681 /* PATH=<empty> or PATH=:<empty> */
682 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
686 npth = 1; /* path component count */
688 tmp = strchr(tmp, ':');
692 break; /* :<empty> */
696 res = xmalloc(npth * sizeof(char*));
697 res[0] = tmp = xstrdup(pth);
700 tmp = strchr(tmp, ':');
703 *tmp++ = '\0'; /* ':' -> '\0' */
705 break; /* :<empty> */
712 static void exe_n_cwd_tab_completion(char *command, int type)
718 char **paths = path1;
722 char *pfind = strrchr(command, '/');
723 /* char dirbuf[MAX_LINELEN]; */
724 #define dirbuf (S.exe_n_cwd_tab_completion__dirbuf)
727 path1[0] = (char*)".";
730 /* no dir, if flags==EXE_ONLY - get paths, else "." */
731 npaths = path_parse(&paths, type);
734 /* dirbuf = ".../.../.../" */
735 safe_strncpy(dirbuf, command, (pfind - command) + 2);
736 #if ENABLE_FEATURE_USERNAME_COMPLETION
737 if (dirbuf[0] == '~') /* ~/... or ~user/... */
738 username_tab_completion(dirbuf, dirbuf);
741 /* point to 'l' in "..../last_component" */
745 for (i = 0; i < npaths; i++) {
746 dir = opendir(paths[i]);
748 continue; /* don't print an error */
750 while ((next = readdir(dir)) != NULL) {
752 const char *str_found = next->d_name;
755 if (strncmp(str_found, pfind, strlen(pfind)))
757 /* not see .name without .match */
758 if (*str_found == '.' && *pfind == '\0') {
759 if (NOT_LONE_CHAR(paths[i], '/') || str_found[1])
761 str_found = ""; /* only "/" */
763 found = concat_path_file(paths[i], str_found);
764 /* hmm, remove in progress? */
765 /* NB: stat() first so that we see is it a directory;
766 * but if that fails, use lstat() so that
767 * we still match dangling links */
768 if (stat(found, &st) && lstat(found, &st))
770 /* find with dirs? */
771 if (paths[i] != dirbuf)
772 strcpy(found, next->d_name); /* only name */
774 len1 = strlen(found);
775 found = xrealloc(found, len1 + 2);
777 found[len1+1] = '\0';
779 if (S_ISDIR(st.st_mode)) {
780 /* name is a directory */
781 if (found[len1-1] != '/') {
785 /* not put found file if search only dirs for cd */
786 if (type == FIND_DIR_ONLY)
789 /* Add it to the list */
797 if (paths != path1) {
798 free(paths[0]); /* allocated memory is only in first member */
804 /* QUOT is used on elements of int_buf[], which are bytes,
805 * not Unicode chars. Therefore it works correctly even in Unicode mode.
807 #define QUOT (UCHAR_MAX+1)
809 #define int_buf (S.find_match__int_buf)
810 #define pos_buf (S.find_match__pos_buf)
811 /* is must be <= in */
812 static void collapse_pos(int is, int in)
814 memmove(int_buf+is, int_buf+in, (MAX_LINELEN+1-in)*sizeof(int_buf[0]));
815 memmove(pos_buf+is, pos_buf+in, (MAX_LINELEN+1-in)*sizeof(pos_buf[0]));
817 static NOINLINE int find_match(char *matchBuf, int *len_with_quotes)
822 /* Were local, but it uses too much stack */
823 /* int16_t int_buf[MAX_LINELEN + 1]; */
824 /* int16_t pos_buf[MAX_LINELEN + 1]; */
826 /* set to integer dimension characters and own positions */
828 int_buf[i] = (unsigned char)matchBuf[i];
829 if (int_buf[i] == 0) {
830 pos_buf[i] = -1; /* end-fo-line indicator */
836 /* mask \+symbol and convert '\t' to ' ' */
837 for (i = j = 0; matchBuf[i]; i++, j++) {
838 if (matchBuf[i] == '\\') {
839 collapse_pos(j, j + 1);
844 /* mask "symbols" or 'symbols' */
846 for (i = 0; int_buf[i]; i++) {
848 if (c == '\'' || c == '"') {
857 } else if (c2 != 0 && c != '$')
861 /* skip commands with arguments if line has commands delimiters */
862 /* ';' ';;' '&' '|' '&&' '||' but `>&' `<&' `>|' */
863 for (i = 0; int_buf[i]; i++) {
866 j = i ? int_buf[i - 1] : -1;
868 if (c == ';' || c == '&' || c == '|') {
869 command_mode = 1 + (c == c2);
871 if (j == '>' || j == '<')
873 } else if (c == '|' && j == '>')
877 collapse_pos(0, i + command_mode);
878 i = -1; /* hack incremet */
881 /* collapse `command...` */
882 for (i = 0; int_buf[i]; i++) {
883 if (int_buf[i] == '`') {
884 for (j = i + 1; int_buf[j]; j++)
885 if (int_buf[j] == '`') {
886 collapse_pos(i, j + 1);
891 /* not found closing ` - command mode, collapse all previous */
892 collapse_pos(0, i + 1);
895 i--; /* hack incremet */
899 /* collapse (command...(command...)...) or {command...{command...}...} */
900 c = 0; /* "recursive" level */
902 for (i = 0; int_buf[i]; i++) {
903 if (int_buf[i] == '(' || int_buf[i] == '{') {
904 if (int_buf[i] == '(')
908 collapse_pos(0, i + 1);
909 i = -1; /* hack incremet */
912 for (i = 0; pos_buf[i] >= 0 && (c > 0 || c2 > 0); i++) {
913 if ((int_buf[i] == ')' && c > 0) || (int_buf[i] == '}' && c2 > 0)) {
914 if (int_buf[i] == ')')
918 collapse_pos(0, i + 1);
919 i = -1; /* hack incremet */
923 /* skip first not quote space */
924 for (i = 0; int_buf[i]; i++)
925 if (int_buf[i] != ' ')
930 /* set find mode for completion */
931 command_mode = FIND_EXE_ONLY;
932 for (i = 0; int_buf[i]; i++) {
933 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
934 if (int_buf[i] == ' ' && command_mode == FIND_EXE_ONLY
935 && matchBuf[pos_buf[0]] == 'c'
936 && matchBuf[pos_buf[1]] == 'd'
938 command_mode = FIND_DIR_ONLY;
940 command_mode = FIND_FILE_ONLY;
945 for (i = 0; int_buf[i]; i++)
948 for (--i; i >= 0; i--) {
950 if (c == ' ' || c == '<' || c == '>' || c == '|' || c == '&') {
951 collapse_pos(0, i + 1);
955 /* skip first not quoted '\'' or '"' */
956 for (i = 0; int_buf[i] == '\'' || int_buf[i] == '"'; i++)
958 /* collapse quote or unquote // or /~ */
959 while ((int_buf[i] & ~QUOT) == '/'
960 && ((int_buf[i+1] & ~QUOT) == '/' || (int_buf[i+1] & ~QUOT) == '~')
965 /* set only match and destroy quotes */
967 for (c = 0; pos_buf[i] >= 0; i++) {
968 matchBuf[c++] = matchBuf[pos_buf[i]];
972 /* old length matchBuf with quotes symbols */
973 *len_with_quotes = j ? j - pos_buf[0] : 0;
981 * display by column (original idea from ls applet,
982 * very optimized by me :)
984 static void showfiles(void)
987 int column_width = 0;
988 int nfiles = num_matches;
992 /* find the longest file name - use that as the column width */
993 for (row = 0; row < nrows; row++) {
994 l = unicode_strwidth(matches[row]);
995 if (column_width < l)
998 column_width += 2; /* min space for columns */
999 ncols = cmdedit_termw / column_width;
1004 nrows++; /* round up fractionals */
1008 for (row = 0; row < nrows; row++) {
1012 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
1013 printf("%s%-*s", matches[n],
1014 (int)(column_width - unicode_strwidth(matches[n])), ""
1017 if (ENABLE_UNICODE_SUPPORT)
1018 puts(printable_string(NULL, matches[n]));
1024 static char *add_quote_for_spec_chars(char *found)
1027 char *s = xzalloc((strlen(found) + 1) * 2);
1030 if (strchr(" `\"#$%^&*()=+{}[]:;'|\\<>", *found))
1034 /* s[l] = '\0'; - already is */
1038 /* Do TAB completion */
1039 static void input_tab(smallint *lastWasTab)
1041 if (!(state->flags & TAB_COMPLETION))
1047 /* char matchBuf[MAX_LINELEN]; */
1048 #define matchBuf (S.input_tab__matchBuf)
1051 #if ENABLE_UNICODE_SUPPORT
1052 /* cursor pos in command converted to multibyte form */
1056 *lastWasTab = TRUE; /* flop trigger */
1058 /* Make a local copy of the string --
1059 * up to the position of the cursor */
1060 save_string(matchBuf, cursor + 1);
1061 #if ENABLE_UNICODE_SUPPORT
1062 cursor_mb = strlen(matchBuf);
1066 find_type = find_match(matchBuf, &recalc_pos);
1068 /* Free up any memory already allocated */
1069 free_tab_completion_data();
1071 #if ENABLE_FEATURE_USERNAME_COMPLETION
1072 /* If the word starts with `~' and there is no slash in the word,
1073 * then try completing this word as a username. */
1074 if (state->flags & USERNAME_COMPLETION)
1075 if (matchBuf[0] == '~' && strchr(matchBuf, '/') == NULL)
1076 username_tab_completion(matchBuf, NULL);
1078 /* Try to match any executable in our path and everything
1079 * in the current working directory */
1081 exe_n_cwd_tab_completion(matchBuf, find_type);
1082 /* Sort, then remove any duplicates found */
1086 qsort_string_vector(matches, num_matches);
1087 for (i = 0; i < num_matches - 1; ++i) {
1088 if (matches[i] && matches[i+1]) { /* paranoia */
1089 if (strcmp(matches[i], matches[i+1]) == 0) {
1091 matches[i] = NULL; /* paranoia */
1093 matches[n++] = matches[i];
1097 matches[n] = matches[i];
1098 num_matches = n + 1;
1100 /* Did we find exactly one match? */
1101 if (!matches || num_matches > 1) { /* no */
1104 return; /* not found */
1105 /* find minimal match */
1106 tmp1 = xstrdup(matches[0]);
1107 for (tmp = tmp1; *tmp; tmp++) {
1108 for (len_found = 1; len_found < num_matches; len_found++) {
1109 if (matches[len_found][tmp - tmp1] != *tmp) {
1115 if (*tmp1 == '\0') { /* have unique */
1119 tmp = add_quote_for_spec_chars(tmp1);
1121 } else { /* one match */
1122 tmp = add_quote_for_spec_chars(matches[0]);
1123 /* for next completion current found */
1124 *lastWasTab = FALSE;
1126 len_found = strlen(tmp);
1127 if (tmp[len_found-1] != '/') {
1128 tmp[len_found] = ' ';
1129 tmp[len_found+1] = '\0';
1133 len_found = strlen(tmp);
1134 #if !ENABLE_UNICODE_SUPPORT
1135 /* have space to place the match? */
1136 /* The result consists of three parts with these lengths: */
1137 /* (cursor - recalc_pos) + len_found + (command_len - cursor) */
1138 /* it simplifies into: */
1139 if ((int)(len_found + command_len - recalc_pos) < S.maxsize) {
1141 strcpy(matchBuf, command_ps + cursor);
1142 /* add match and tail */
1143 sprintf(&command_ps[cursor - recalc_pos], "%s%s", tmp, matchBuf);
1144 command_len = strlen(command_ps);
1146 recalc_pos = cursor - recalc_pos + len_found;
1147 /* write out the matched command */
1148 redraw(cmdedit_y, command_len - recalc_pos);
1152 char command[MAX_LINELEN];
1153 int len = save_string(command, sizeof(command));
1154 /* have space to place the match? */
1155 /* (cursor_mb - recalc_pos) + len_found + (len - cursor_mb) */
1156 if ((int)(len_found + len - recalc_pos) < MAX_LINELEN) {
1158 strcpy(matchBuf, command + cursor_mb);
1159 /* where do we want to have cursor after all? */
1160 strcpy(&command[cursor_mb - recalc_pos], tmp);
1161 len = load_string(command, S.maxsize);
1162 /* add match and tail */
1163 sprintf(&command[cursor_mb - recalc_pos], "%s%s", tmp, matchBuf);
1164 command_len = load_string(command, S.maxsize);
1165 /* write out the matched command */
1166 redraw(cmdedit_y, command_len - len);
1173 /* Ok -- the last char was a TAB. Since they
1174 * just hit TAB again, print a list of all the
1175 * available choices... */
1176 if (matches && num_matches > 0) {
1177 /* changed by goto_new_line() */
1178 int sav_cursor = cursor;
1180 /* Go to the next line */
1183 redraw(0, command_len - sav_cursor);
1188 #endif /* FEATURE_COMMAND_TAB_COMPLETION */
1191 line_input_t* FAST_FUNC new_line_input_t(int flags)
1193 line_input_t *n = xzalloc(sizeof(*n));
1201 static void save_command_ps_at_cur_history(void)
1203 if (command_ps[0] != BB_NUL) {
1204 int cur = state->cur_history;
1205 free(state->history[cur]);
1207 # if ENABLE_UNICODE_SUPPORT
1209 char tbuf[MAX_LINELEN];
1210 save_string(tbuf, sizeof(tbuf));
1211 state->history[cur] = xstrdup(tbuf);
1214 state->history[cur] = xstrdup(command_ps);
1219 /* state->flags is already checked to be nonzero */
1220 static int get_previous_history(void)
1222 if ((state->flags & DO_HISTORY) && state->cur_history) {
1223 save_command_ps_at_cur_history();
1224 state->cur_history--;
1231 static int get_next_history(void)
1233 if (state->flags & DO_HISTORY) {
1234 if (state->cur_history < state->cnt_history) {
1235 save_command_ps_at_cur_history(); /* save the current history line */
1236 return ++state->cur_history;
1243 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1244 /* We try to ensure that concurrent additions to the history
1245 * do not overwrite each other.
1246 * Otherwise shell users get unhappy.
1248 * History file is trimmed lazily, when it grows several times longer
1249 * than configured MAX_HISTORY lines.
1252 static void free_line_input_t(line_input_t *n)
1254 int i = n->cnt_history;
1256 free(n->history[--i]);
1260 /* state->flags is already checked to be nonzero */
1261 static void load_history(line_input_t *st_parm)
1263 char *temp_h[MAX_HISTORY];
1266 unsigned idx, i, line_len;
1268 /* NB: do not trash old history if file can't be opened */
1270 fp = fopen_for_read(st_parm->hist_file);
1272 /* clean up old history */
1273 for (idx = st_parm->cnt_history; idx > 0;) {
1275 free(st_parm->history[idx]);
1276 st_parm->history[idx] = NULL;
1279 /* fill temp_h[], retaining only last MAX_HISTORY lines */
1280 memset(temp_h, 0, sizeof(temp_h));
1281 st_parm->cnt_history_in_file = idx = 0;
1282 while ((line = xmalloc_fgetline(fp)) != NULL) {
1283 if (line[0] == '\0') {
1289 st_parm->cnt_history_in_file++;
1291 if (idx == MAX_HISTORY)
1296 /* find first non-NULL temp_h[], if any */
1297 if (st_parm->cnt_history_in_file) {
1298 while (temp_h[idx] == NULL) {
1300 if (idx == MAX_HISTORY)
1305 /* copy temp_h[] to st_parm->history[] */
1306 for (i = 0; i < MAX_HISTORY;) {
1311 if (idx == MAX_HISTORY)
1313 line_len = strlen(line);
1314 if (line_len >= MAX_LINELEN)
1315 line[MAX_LINELEN-1] = '\0';
1316 st_parm->history[i++] = line;
1318 st_parm->cnt_history = i;
1322 /* state->flags is already checked to be nonzero */
1323 static void save_history(char *str)
1328 fd = open(state->hist_file, O_WRONLY | O_CREAT | O_APPEND, 0666);
1331 xlseek(fd, 0, SEEK_END); /* paranoia */
1333 str[len] = '\n'; /* we (try to) do atomic write */
1334 len2 = full_write(fd, str, len + 1);
1337 if (len2 != len + 1)
1338 return; /* "wtf?" */
1340 /* did we write so much that history file needs trimming? */
1341 state->cnt_history_in_file++;
1342 if (state->cnt_history_in_file > MAX_HISTORY * 4) {
1345 line_input_t *st_temp;
1348 /* we may have concurrently written entries from others.
1350 st_temp = new_line_input_t(state->flags);
1351 st_temp->hist_file = state->hist_file;
1352 load_history(st_temp);
1354 /* write out temp file and replace hist_file atomically */
1355 new_name = xasprintf("%s.%u.new", state->hist_file, (int) getpid());
1356 fp = fopen_for_write(new_name);
1358 for (i = 0; i < st_temp->cnt_history; i++)
1359 fprintf(fp, "%s\n", st_temp->history[i]);
1361 if (rename(new_name, state->hist_file) == 0)
1362 state->cnt_history_in_file = st_temp->cnt_history;
1365 free_line_input_t(st_temp);
1369 # define load_history(a) ((void)0)
1370 # define save_history(a) ((void)0)
1371 # endif /* FEATURE_COMMAND_SAVEHISTORY */
1373 static void remember_in_history(char *str)
1377 if (!(state->flags & DO_HISTORY))
1381 i = state->cnt_history;
1382 /* Don't save dupes */
1383 if (i && strcmp(state->history[i-1], str) == 0)
1386 free(state->history[MAX_HISTORY]); /* redundant, paranoia */
1387 state->history[MAX_HISTORY] = NULL; /* redundant, paranoia */
1389 /* If history[] is full, remove the oldest command */
1390 /* we need to keep history[MAX_HISTORY] empty, hence >=, not > */
1391 if (i >= MAX_HISTORY) {
1392 free(state->history[0]);
1393 for (i = 0; i < MAX_HISTORY-1; i++)
1394 state->history[i] = state->history[i+1];
1395 /* i == MAX_HISTORY-1 */
1397 /* i <= MAX_HISTORY-1 */
1398 state->history[i++] = xstrdup(str);
1399 /* i <= MAX_HISTORY */
1400 state->cur_history = i;
1401 state->cnt_history = i;
1402 # if MAX_HISTORY > 0 && ENABLE_FEATURE_EDITING_SAVEHISTORY
1403 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1406 IF_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1409 #else /* MAX_HISTORY == 0 */
1410 # define remember_in_history(a) ((void)0)
1411 #endif /* MAX_HISTORY */
1414 #if ENABLE_FEATURE_EDITING_VI
1416 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1419 vi_Word_motion(int eat)
1421 CHAR_T *command = command_ps;
1423 while (cursor < command_len && !BB_isspace(command[cursor]))
1425 if (eat) while (cursor < command_len && BB_isspace(command[cursor]))
1430 vi_word_motion(int eat)
1432 CHAR_T *command = command_ps;
1434 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1435 while (cursor < command_len
1436 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1440 } else if (BB_ispunct(command[cursor])) {
1441 while (cursor < command_len && BB_ispunct(command[cursor+1]))
1445 if (cursor < command_len)
1449 while (cursor < command_len && BB_isspace(command[cursor]))
1457 CHAR_T *command = command_ps;
1460 while (cursor < command_len && BB_isspace(command[cursor]))
1462 while (cursor < command_len-1 && !BB_isspace(command[cursor+1]))
1469 CHAR_T *command = command_ps;
1471 if (cursor >= command_len-1)
1474 while (cursor < command_len-1 && BB_isspace(command[cursor]))
1476 if (cursor >= command_len-1)
1478 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1479 while (cursor < command_len-1
1480 && (BB_isalnum(command[cursor+1]) || command[cursor+1] == '_')
1484 } else if (BB_ispunct(command[cursor])) {
1485 while (cursor < command_len-1 && BB_ispunct(command[cursor+1]))
1491 vi_Back_motion(void)
1493 CHAR_T *command = command_ps;
1495 while (cursor > 0 && BB_isspace(command[cursor-1]))
1497 while (cursor > 0 && !BB_isspace(command[cursor-1]))
1502 vi_back_motion(void)
1504 CHAR_T *command = command_ps;
1509 while (cursor > 0 && BB_isspace(command[cursor]))
1513 if (BB_isalnum(command[cursor]) || command[cursor] == '_') {
1515 && (BB_isalnum(command[cursor-1]) || command[cursor-1] == '_')
1519 } else if (BB_ispunct(command[cursor])) {
1520 while (cursor > 0 && BB_ispunct(command[cursor-1]))
1526 /* Modelled after bash 4.0 behavior of Ctrl-<arrow> */
1527 static void ctrl_left(void)
1529 CHAR_T *command = command_ps;
1537 c = command[cursor];
1538 if (c != ' ' && !BB_ispunct(c)) {
1539 /* we reached a "word" delimited by spaces/punct.
1540 * go to its beginning */
1542 c = command[cursor - 1];
1543 if (c == ' ' || BB_ispunct(c))
1553 static void ctrl_right(void)
1555 CHAR_T *command = command_ps;
1560 c = command[cursor];
1563 if (c != ' ' && !BB_ispunct(c)) {
1564 /* we reached a "word" delimited by spaces/punct.
1565 * go to its end + 1 */
1568 c = command[cursor];
1569 if (c == BB_NUL || c == ' ' || BB_ispunct(c))
1580 * read_line_input and its helpers
1583 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1584 static void ask_terminal(void)
1586 /* Ask terminal where is the cursor now.
1587 * lineedit_read_key handles response and corrects
1588 * our idea of current cursor position.
1589 * Testcase: run "echo -n long_line_long_line_long_line",
1590 * then type in a long, wrapping command and try to
1591 * delete it using backspace key.
1592 * Note: we print it _after_ prompt, because
1593 * prompt may contain CR. Example: PS1='\[\r\n\]\w '
1595 /* Problem: if there is buffered input on stdin,
1596 * the response will be delivered later,
1597 * possibly to an unsuspecting application.
1598 * Testcase: "sleep 1; busybox ash" + press and hold [Enter].
1600 * ~/srcdevel/bbox/fix/busybox.t4 #
1601 * ~/srcdevel/bbox/fix/busybox.t4 #
1602 * ^[[59;34~/srcdevel/bbox/fix/busybox.t4 # <-- garbage
1603 * ~/srcdevel/bbox/fix/busybox.t4 #
1605 * Checking for input with poll only makes the race narrower,
1606 * I still can trigger it. Strace:
1608 * write(1, "~/srcdevel/bbox/fix/busybox.t4 # ", 33) = 33
1609 * poll([{fd=0, events=POLLIN}], 1, 0) = 0 (Timeout) <-- no input exists
1610 * write(1, "\33[6n", 4) = 4 <-- send the ESC sequence, quick!
1611 * poll([{fd=0, events=POLLIN}], 1, 4294967295) = 1 ([{fd=0, revents=POLLIN}])
1612 * read(0, "\n", 1) = 1 <-- oh crap, user's input got in first
1614 if (S.unknown_width) { /* only if window size is not known */
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! */
1627 #define ask_terminal() ((void)0)
1630 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1631 static void parse_and_put_prompt(const char *prmt_ptr)
1633 cmdedit_prompt = prmt_ptr;
1634 cmdedit_prmt_len = strlen(prmt_ptr);
1638 static void parse_and_put_prompt(const char *prmt_ptr)
1641 size_t cur_prmt_len = 0;
1642 char flg_not_length = '[';
1643 char *prmt_mem_ptr = xzalloc(1);
1644 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1649 cmdedit_prmt_len = 0;
1652 cwd_buf = (char *)bb_msg_unknown;
1655 cbuf[1] = '\0'; /* never changes */
1658 char *free_me = NULL;
1663 const char *cp = prmt_ptr;
1666 c = bb_process_escape_sequence(&prmt_ptr);
1667 if (prmt_ptr == cp) {
1673 # if ENABLE_USERNAME_OR_HOMEDIR
1675 pbuf = user_buf ? user_buf : (char*)"";
1679 pbuf = free_me = safe_gethostname();
1680 *strchrnul(pbuf, '.') = '\0';
1683 c = (geteuid() == 0 ? '#' : '$');
1685 # if ENABLE_USERNAME_OR_HOMEDIR
1687 /* /home/user[/something] -> ~[/something] */
1689 l = strlen(home_pwd_buf);
1691 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1692 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1693 && strlen(cwd_buf + l) < PATH_MAX
1695 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1701 cp = strrchr(pbuf, '/');
1702 if (cp != NULL && cp != pbuf)
1703 pbuf += (cp-pbuf) + 1;
1706 pbuf = free_me = xasprintf("%d", num_ok_lines);
1708 case 'e': case 'E': /* \e \E = \033 */
1711 case 'x': case 'X': {
1713 for (l = 0; l < 3;) {
1715 buf2[l++] = *prmt_ptr;
1717 h = strtoul(buf2, &pbuf, 16);
1718 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1724 c = (char)strtoul(buf2, NULL, 16);
1731 if (c == flg_not_length) {
1732 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1740 cur_prmt_len = strlen(pbuf);
1741 prmt_len += cur_prmt_len;
1742 if (flg_not_length != ']')
1743 cmdedit_prmt_len += cur_prmt_len;
1744 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1748 if (cwd_buf != (char *)bb_msg_unknown)
1750 cmdedit_prompt = prmt_mem_ptr;
1755 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1759 /* new y for current cursor */
1760 int new_y = (cursor + cmdedit_prmt_len) / w;
1762 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1767 static void win_changed(int nsig)
1769 int sv_errno = errno;
1771 IF_FEATURE_EDITING_ASK_TERMINAL(S.unknown_width =) get_terminal_width_height(0, &width, NULL);
1772 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1773 if (nsig == SIGWINCH)
1774 signal(SIGWINCH, win_changed); /* rearm ourself */
1778 static int lineedit_read_key(char *read_key_buffer)
1782 #if ENABLE_UNICODE_SUPPORT
1783 char unicode_buf[MB_CUR_MAX + 1];
1784 int unicode_idx = 0;
1788 /* Wait for input. TIMEOUT = -1 makes read_key wait even
1789 * on nonblocking stdin, TIMEOUT = 50 makes sure we won't
1790 * insist on full MB_CUR_MAX buffer to declare input like
1791 * "\xff\n",pause,"ls\n" invalid and thus won't lose "ls".
1793 * Note: read_key sets errno to 0 on success.
1795 ic = read_key(STDIN_FILENO, read_key_buffer, timeout);
1797 #if ENABLE_UNICODE_SUPPORT
1798 if (errno == EAGAIN && unicode_idx != 0)
1804 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
1805 if ((int32_t)ic == KEYCODE_CURSOR_POS
1808 S.sent_ESC_br6n = 0;
1809 if (cursor == 0) { /* otherwise it may be bogus */
1810 int col = ((ic >> 32) & 0x7fff) - 1;
1811 if (col > cmdedit_prmt_len) {
1812 cmdedit_x += (col - cmdedit_prmt_len);
1813 while (cmdedit_x >= cmdedit_termw) {
1814 cmdedit_x -= cmdedit_termw;
1823 #if ENABLE_UNICODE_SUPPORT
1824 if (unicode_status == UNICODE_ON) {
1827 if ((int32_t)ic < 0) /* KEYCODE_xxx */
1829 // TODO: imagine sequence like: 0xff,<left-arrow>: we are currently losing 0xff...
1831 unicode_buf[unicode_idx++] = ic;
1832 unicode_buf[unicode_idx] = '\0';
1833 if (mbstowcs(&wc, unicode_buf, 1) != 1) {
1834 /* Not (yet?) a valid unicode char */
1835 if (unicode_idx < MB_CUR_MAX) {
1840 /* Invalid sequence. Save all "bad bytes" except first */
1841 read_key_ungets(read_key_buffer, unicode_buf + 1, unicode_idx - 1);
1842 # if !ENABLE_UNICODE_PRESERVE_BROKEN
1843 ic = CONFIG_SUBST_WCHAR;
1845 ic = unicode_mark_raw_byte(unicode_buf[0]);
1848 /* Valid unicode char, return its code */
1859 #if ENABLE_UNICODE_BIDI_SUPPORT
1860 static int isrtl_str(void)
1864 while (idx < command_len && unicode_bidi_is_neutral_wchar(command_ps[idx]))
1866 return unicode_bidi_isrtl(command_ps[idx]);
1869 # define isrtl_str() 0
1872 /* leave out the "vi-mode"-only case labels if vi editing isn't
1874 #define vi_case(caselabel) IF_FEATURE_EDITING_VI(case caselabel)
1876 /* convert uppercase ascii to equivalent control char, for readability */
1878 #define CTRL(a) ((a) & ~0x40)
1880 /* maxsize must be >= 2.
1882 * -1 on read errors or EOF, or on bare Ctrl-D,
1883 * 0 on ctrl-C (the line entered is still returned in 'command'),
1884 * >0 length of input string, including terminating '\n'
1886 int FAST_FUNC read_line_input(const char *prompt, char *command, int maxsize, line_input_t *st)
1889 #if ENABLE_FEATURE_TAB_COMPLETION
1890 smallint lastWasTab = FALSE;
1892 smallint break_out = 0;
1893 #if ENABLE_FEATURE_EDITING_VI
1894 smallint vi_cmdmode = 0;
1896 struct termios initial_settings;
1897 struct termios new_settings;
1898 char read_key_buffer[KEYCODE_BUFFER_SIZE];
1902 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
1903 || !(initial_settings.c_lflag & ECHO)
1905 /* Happens when e.g. stty -echo was run before */
1906 parse_and_put_prompt(prompt);
1907 /* fflush_all(); - done by parse_and_put_prompt */
1908 if (fgets(command, maxsize, stdin) == NULL)
1909 len = -1; /* EOF or error */
1911 len = strlen(command);
1918 // FIXME: audit & improve this
1919 if (maxsize > MAX_LINELEN)
1920 maxsize = MAX_LINELEN;
1921 S.maxsize = maxsize;
1923 /* With null flags, no other fields are ever used */
1924 state = st ? st : (line_input_t*) &const_int_0;
1926 # if ENABLE_FEATURE_EDITING_SAVEHISTORY
1927 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1928 if (state->cnt_history == 0)
1929 load_history(state);
1931 if (state->flags & DO_HISTORY)
1932 state->cur_history = state->cnt_history;
1935 /* prepare before init handlers */
1936 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
1938 #if ENABLE_UNICODE_SUPPORT
1939 command_ps = xzalloc(maxsize * sizeof(command_ps[0]));
1941 command_ps = command;
1944 #define command command_must_not_be_used
1946 new_settings = initial_settings;
1947 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
1948 /* Turn off echoing and CTRL-C, so we can trap it */
1949 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
1950 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
1951 new_settings.c_cc[VMIN] = 1;
1952 new_settings.c_cc[VTIME] = 0;
1953 /* Turn off CTRL-C, so we can trap it */
1954 #ifndef _POSIX_VDISABLE
1955 # define _POSIX_VDISABLE '\0'
1957 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
1958 tcsetattr_stdin_TCSANOW(&new_settings);
1960 /* Now initialize things */
1961 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
1962 win_changed(0); /* do initial resizing */
1963 #if ENABLE_USERNAME_OR_HOMEDIR
1965 struct passwd *entry;
1967 entry = getpwuid(geteuid());
1969 user_buf = xstrdup(entry->pw_name);
1970 home_pwd_buf = xstrdup(entry->pw_dir);
1976 for (i = 0; i <= MAX_HISTORY; i++)
1977 bb_error_msg("history[%d]:'%s'", i, state->history[i]);
1978 bb_error_msg("cur_history:%d cnt_history:%d", state->cur_history, state->cnt_history);
1981 /* Print out the command prompt, optionally ask where cursor is */
1982 parse_and_put_prompt(prompt);
1985 read_key_buffer[0] = 0;
1988 * The emacs and vi modes share much of the code in the big
1989 * command loop. Commands entered when in vi's command mode
1990 * (aka "escape mode") get an extra bit added to distinguish
1991 * them - this keeps them from being self-inserted. This
1992 * clutters the big switch a bit, but keeps all the code
1996 VI_CMDMODE_BIT = 0x40000000,
1997 /* 0x80000000 bit flags KEYCODE_xxx */
2002 ic = ic_raw = lineedit_read_key(read_key_buffer);
2004 #if ENABLE_FEATURE_EDITING_VI
2007 /* btw, since KEYCODE_xxx are all < 0, this doesn't
2008 * change ic if it contains one of them: */
2009 ic |= VI_CMDMODE_BIT;
2016 vi_case('\n'|VI_CMDMODE_BIT:)
2017 vi_case('\r'|VI_CMDMODE_BIT:)
2023 vi_case('0'|VI_CMDMODE_BIT:)
2024 /* Control-a -- Beginning of line */
2025 input_backward(cursor);
2028 vi_case('h'|VI_CMDMODE_BIT:)
2029 vi_case('\b'|VI_CMDMODE_BIT:) /* ^H */
2030 vi_case('\x7f'|VI_CMDMODE_BIT:) /* DEL */
2031 input_backward(1); /* Move back one character */
2034 vi_case('$'|VI_CMDMODE_BIT:)
2035 /* Control-e -- End of line */
2036 put_till_end_and_adv_cursor();
2039 vi_case('l'|VI_CMDMODE_BIT:)
2040 vi_case(' '|VI_CMDMODE_BIT:)
2041 input_forward(); /* Move forward one character */
2044 case '\x7f': /* DEL */
2050 case KEYCODE_DELETE:
2056 #if ENABLE_FEATURE_TAB_COMPLETION
2058 input_tab(&lastWasTab);
2062 /* Control-k -- clear to end of line */
2063 command_ps[cursor] = BB_NUL;
2064 command_len = cursor;
2065 printf(SEQ_CLEAR_TILL_END_OF_SCREEN);
2068 vi_case(CTRL('L')|VI_CMDMODE_BIT:)
2069 /* Control-l -- clear screen */
2070 printf("\033[H"); /* cursor to top,left */
2071 redraw(0, command_len - cursor);
2075 vi_case(CTRL('N')|VI_CMDMODE_BIT:)
2076 vi_case('j'|VI_CMDMODE_BIT:)
2077 /* Control-n -- Get next command in history */
2078 if (get_next_history())
2082 vi_case(CTRL('P')|VI_CMDMODE_BIT:)
2083 vi_case('k'|VI_CMDMODE_BIT:)
2084 /* Control-p -- Get previous command from history */
2085 if (get_previous_history())
2090 vi_case(CTRL('U')|VI_CMDMODE_BIT:)
2091 /* Control-U -- Clear line before cursor */
2093 command_len -= cursor;
2094 memmove(command_ps, command_ps + cursor,
2095 (command_len + 1) * sizeof(command_ps[0]));
2096 redraw(cmdedit_y, command_len);
2100 vi_case(CTRL('W')|VI_CMDMODE_BIT:)
2101 /* Control-W -- Remove the last word */
2102 while (cursor > 0 && BB_isspace(command_ps[cursor-1]))
2104 while (cursor > 0 && !BB_isspace(command_ps[cursor-1]))
2108 #if ENABLE_FEATURE_EDITING_VI
2109 case 'i'|VI_CMDMODE_BIT:
2112 case 'I'|VI_CMDMODE_BIT:
2113 input_backward(cursor);
2116 case 'a'|VI_CMDMODE_BIT:
2120 case 'A'|VI_CMDMODE_BIT:
2121 put_till_end_and_adv_cursor();
2124 case 'x'|VI_CMDMODE_BIT:
2127 case 'X'|VI_CMDMODE_BIT:
2133 case 'W'|VI_CMDMODE_BIT:
2136 case 'w'|VI_CMDMODE_BIT:
2139 case 'E'|VI_CMDMODE_BIT:
2142 case 'e'|VI_CMDMODE_BIT:
2145 case 'B'|VI_CMDMODE_BIT:
2148 case 'b'|VI_CMDMODE_BIT:
2151 case 'C'|VI_CMDMODE_BIT:
2154 case 'D'|VI_CMDMODE_BIT:
2157 case 'c'|VI_CMDMODE_BIT:
2160 case 'd'|VI_CMDMODE_BIT: {
2163 ic = lineedit_read_key(read_key_buffer);
2164 if (errno) /* error */
2165 goto prepare_to_die;
2166 if (ic == ic_raw) { /* "cc", "dd" */
2167 input_backward(cursor);
2179 case 'w': /* "dw", "cw" */
2180 vi_word_motion(vi_cmdmode);
2182 case 'W': /* 'dW', 'cW' */
2183 vi_Word_motion(vi_cmdmode);
2185 case 'e': /* 'de', 'ce' */
2189 case 'E': /* 'dE', 'cE' */
2195 input_backward(cursor - sc);
2196 while (nc-- > cursor)
2199 case 'b': /* "db", "cb" */
2200 case 'B': /* implemented as B */
2205 while (sc-- > cursor)
2208 case ' ': /* "d ", "c " */
2211 case '$': /* "d$", "c$" */
2213 while (cursor < command_len)
2219 case 'p'|VI_CMDMODE_BIT:
2222 case 'P'|VI_CMDMODE_BIT:
2225 case 'r'|VI_CMDMODE_BIT:
2226 //FIXME: unicode case?
2227 ic = lineedit_read_key(read_key_buffer);
2228 if (errno) /* error */
2229 goto prepare_to_die;
2230 if (ic < ' ' || ic > 255) {
2233 command_ps[cursor] = ic;
2238 case '\x1b': /* ESC */
2239 if (state->flags & VI_MODE) {
2240 /* insert mode --> command mode */
2245 #endif /* FEATURE_COMMAND_EDITING_VI */
2249 if (get_previous_history())
2254 if (!get_next_history())
2257 /* Rewrite the line with the selected history item */
2258 /* change command */
2259 command_len = load_string(state->history[state->cur_history] ?
2260 state->history[state->cur_history] : "", maxsize);
2261 /* redraw and go to eol (bol, in vi) */
2262 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
2271 case KEYCODE_CTRL_LEFT:
2274 case KEYCODE_CTRL_RIGHT:
2278 input_backward(cursor);
2281 put_till_end_and_adv_cursor();
2285 if (initial_settings.c_cc[VINTR] != 0
2286 && ic_raw == initial_settings.c_cc[VINTR]
2288 /* Ctrl-C (usually) - stop gathering input */
2291 break_out = -1; /* "do not append '\n'" */
2294 if (initial_settings.c_cc[VEOF] != 0
2295 && ic_raw == initial_settings.c_cc[VEOF]
2297 /* Ctrl-D (usually) - delete one character,
2298 * or exit if len=0 and no chars to delete */
2299 if (command_len == 0) {
2301 #if ENABLE_FEATURE_EDITING_VI
2304 break_out = command_len = -1;
2310 // /* Control-V -- force insert of next char */
2311 // if (c == CTRL('V')) {
2312 // if (safe_read(STDIN_FILENO, &c, 1) < 1)
2313 // goto prepare_to_die;
2320 || (!ENABLE_UNICODE_SUPPORT && ic >= 256)
2321 || (ENABLE_UNICODE_SUPPORT && ic >= VI_CMDMODE_BIT)
2323 /* If VI_CMDMODE_BIT is set, ic is >= 256
2324 * and vi mode ignores unexpected chars.
2325 * Otherwise, we are here if ic is a
2326 * control char or an unhandled ESC sequence,
2327 * which is also ignored.
2331 if ((int)command_len >= (maxsize - 2)) {
2332 /* Not enough space for the char and EOL */
2337 if (cursor == (command_len - 1)) {
2338 /* We are at the end, append */
2339 command_ps[cursor] = ic;
2340 command_ps[cursor + 1] = BB_NUL;
2341 put_cur_glyph_and_inc_cursor();
2342 if (unicode_bidi_isrtl(ic))
2345 /* In the middle, insert */
2348 memmove(command_ps + sc + 1, command_ps + sc,
2349 (command_len - sc) * sizeof(command_ps[0]));
2350 command_ps[sc] = ic;
2351 /* is right-to-left char, or neutral one (e.g. comma) was just added to rtl text? */
2354 put_till_end_and_adv_cursor();
2355 /* to prev x pos + 1 */
2356 input_backward(cursor - sc);
2364 #if ENABLE_FEATURE_TAB_COMPLETION
2370 #if ENABLE_FEATURE_EDITING_ASK_TERMINAL
2371 if (S.sent_ESC_br6n) {
2372 /* "sleep 1; busybox ash" + hold [Enter] to trigger.
2373 * We sent "ESC [ 6 n", but got '\n' first, and
2374 * KEYCODE_CURSOR_POS response is now buffered from terminal.
2375 * It's bad already and not much can be done with it
2376 * (it _will_ be visible for the next process to read stdin),
2377 * but without this delay it even shows up on the screen
2378 * as garbage because we restore echo settings with tcsetattr
2379 * before it comes in. UGLY!
2385 /* End of bug-catching "command_must_not_be_used" trick */
2388 #if ENABLE_UNICODE_SUPPORT
2390 if (command_len > 0)
2391 command_len = save_string(command, maxsize - 1);
2395 if (command_len > 0)
2396 remember_in_history(command);
2398 if (break_out > 0) {
2399 command[command_len++] = '\n';
2400 command[command_len] = '\0';
2403 #if ENABLE_FEATURE_TAB_COMPLETION
2404 free_tab_completion_data();
2407 /* restore initial_settings */
2408 tcsetattr_stdin_TCSANOW(&initial_settings);
2409 /* restore SIGWINCH handler */
2410 signal(SIGWINCH, previous_SIGWINCH_handler);
2416 return len; /* can't return command_len, DEINIT_S() destroys it */
2419 #else /* !FEATURE_EDITING */
2421 #undef read_line_input
2422 int FAST_FUNC read_line_input(const char* prompt, char* command, int maxsize)
2424 fputs(prompt, stdout);
2426 fgets(command, maxsize, stdin);
2427 return strlen(command);
2430 #endif /* !FEATURE_EDITING */
2441 const char *applet_name = "debug stuff usage";
2443 int main(int argc, char **argv)
2445 char buff[MAX_LINELEN];
2447 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
2448 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
2449 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
2450 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
2457 l = read_line_input(prompt, buff);
2458 if (l <= 0 || buff[l-1] != '\n')
2461 printf("*** read_line_input() returned line =%s=\n", buff);
2463 printf("*** read_line_input() detect ^D\n");