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.
19 Terminal key codes are not extensive, and more will probably
20 need to be added. 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 Small bugs (simple effect):
26 - not true viewing if terminal size (x*y symbols) less
27 size (prompt + editor's line + 2 symbols)
28 - not true viewing if length prompt less terminal width
34 /* FIXME: obsolete CONFIG item? */
35 #define ENABLE_FEATURE_NONPRINTABLE_INVERSE_PUT 0
40 #define ENABLE_FEATURE_EDITING 0
41 #define ENABLE_FEATURE_TAB_COMPLETION 0
42 #define ENABLE_FEATURE_USERNAME_COMPLETION 0
43 #define ENABLE_FEATURE_NONPRINTABLE_INVERSE_PUT 0
48 /* Entire file (except TESTing part) sits inside this #if */
49 #if ENABLE_FEATURE_EDITING
51 #if ENABLE_LOCALE_SUPPORT
52 #define Isprint(c) isprint(c)
54 #define Isprint(c) ((c) >= ' ' && (c) != ((unsigned char)'\233'))
57 #define ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR \
58 (ENABLE_FEATURE_USERNAME_COMPLETION || ENABLE_FEATURE_EDITING_FANCY_PROMPT)
59 #define USE_FEATURE_GETUSERNAME_AND_HOMEDIR(...)
60 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
61 #undef USE_FEATURE_GETUSERNAME_AND_HOMEDIR
62 #define USE_FEATURE_GETUSERNAME_AND_HOMEDIR(...) __VA_ARGS__
66 /* We use int16_t for positions, need to limit line len */
67 MAX_LINELEN = CONFIG_FEATURE_EDITING_MAX_LEN < 0x7ff0
68 ? CONFIG_FEATURE_EDITING_MAX_LEN
72 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
73 static const char null_str[] ALIGN1 = "";
76 /* We try to minimize both static and stack usage. */
77 struct lineedit_statics {
80 volatile unsigned cmdedit_termw; /* = 80; */ /* actual terminal width */
81 sighandler_t previous_SIGWINCH_handler;
84 int cmdedit_x; /* real x terminal position */
85 int cmdedit_y; /* pseudoreal y terminal position */
86 int cmdedit_prmt_len; /* length of prompt (without colors etc) */
92 const char *cmdedit_prompt;
93 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
94 int num_ok_lines; /* = 1; */
97 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
99 char *home_pwd_buf; /* = (char*)null_str; */
102 #if ENABLE_FEATURE_TAB_COMPLETION
104 unsigned num_matches;
107 #if ENABLE_FEATURE_EDITING_VI
108 #define DELBUFSIZ 128
110 smallint newdelflag; /* whether delbuf should be reused yet */
111 char delbuf[DELBUFSIZ]; /* a place to store deleted characters */
114 /* Formerly these were big buffers on stack: */
115 #if ENABLE_FEATURE_TAB_COMPLETION
116 char exe_n_cwd_tab_completion__dirbuf[MAX_LINELEN];
117 char input_tab__matchBuf[MAX_LINELEN];
118 int16_t find_match__int_buf[MAX_LINELEN + 1]; /* need to have 9 bits at least */
119 int16_t find_match__pos_buf[MAX_LINELEN + 1];
123 /* See lineedit_ptr_hack.c */
124 extern struct lineedit_statics *const lineedit_ptr_to_statics;
126 #define S (*lineedit_ptr_to_statics)
127 #define state (S.state )
128 #define cmdedit_termw (S.cmdedit_termw )
129 #define previous_SIGWINCH_handler (S.previous_SIGWINCH_handler)
130 #define cmdedit_x (S.cmdedit_x )
131 #define cmdedit_y (S.cmdedit_y )
132 #define cmdedit_prmt_len (S.cmdedit_prmt_len)
133 #define cursor (S.cursor )
134 #define command_len (S.command_len )
135 #define command_ps (S.command_ps )
136 #define cmdedit_prompt (S.cmdedit_prompt )
137 #define num_ok_lines (S.num_ok_lines )
138 #define user_buf (S.user_buf )
139 #define home_pwd_buf (S.home_pwd_buf )
140 #define matches (S.matches )
141 #define num_matches (S.num_matches )
142 #define delptr (S.delptr )
143 #define newdelflag (S.newdelflag )
144 #define delbuf (S.delbuf )
146 #define INIT_S() do { \
147 (*(struct lineedit_statics**)&lineedit_ptr_to_statics) = xzalloc(sizeof(S)); \
149 cmdedit_termw = 80; \
150 USE_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines = 1;) \
151 USE_FEATURE_GETUSERNAME_AND_HOMEDIR(home_pwd_buf = (char*)null_str;) \
153 static void deinit_S(void)
155 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
156 /* This one is allocated only if FANCY_PROMPT is on
157 * (otherwise it points to verbatim prompt (NOT malloced) */
158 free((char*)cmdedit_prompt);
160 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
162 if (home_pwd_buf != null_str)
165 free(lineedit_ptr_to_statics);
167 #define DEINIT_S() deinit_S()
169 /* Put 'command_ps[cursor]', cursor++.
170 * Advance cursor on screen. If we reached right margin, scroll text up
171 * and remove terminal margin effect by printing 'next_char' */
172 static void cmdedit_set_out_char(int next_char)
174 int c = (unsigned char)command_ps[cursor];
177 /* erase character after end of input string */
180 #if ENABLE_FEATURE_NONPRINTABLE_INVERSE_PUT
181 /* Display non-printable characters in reverse */
189 printf("\033[7m%c\033[0m", c);
195 if (++cmdedit_x >= cmdedit_termw) {
196 /* terminal is scrolled down */
199 /* destroy "(auto)margin" */
200 bb_putchar(next_char);
203 // Huh? What if command_ps[cursor] == '\0' (we are at the end already?)
207 /* Move to end of line (by printing all chars till the end) */
208 static void input_end(void)
210 while (cursor < command_len)
211 cmdedit_set_out_char(' ');
214 /* Go to the next line */
215 static void goto_new_line(void)
223 static void out1str(const char *s)
229 static void beep(void)
234 /* Move back one character */
235 /* (optimized for slow terminals) */
236 static void input_backward(unsigned num)
246 if (cmdedit_x >= num) {
249 /* This is longer by 5 bytes on x86.
250 * Also gets mysteriously
251 * miscompiled for some ARM users.
252 * printf(("\b\b\b\b" + 4) - num);
260 printf("\033[%uD", num);
264 /* Need to go one or more lines up */
266 count_y = 1 + (num / cmdedit_termw);
267 cmdedit_y -= count_y;
268 cmdedit_x = cmdedit_termw * count_y - num;
269 /* go to 1st column; go up; go to correct column */
270 printf("\r" "\033[%dA" "\033[%dC", count_y, cmdedit_x);
273 static void put_prompt(void)
275 out1str(cmdedit_prompt);
276 cmdedit_x = cmdedit_prmt_len;
278 // Huh? what if cmdedit_prmt_len >= width?
279 cmdedit_y = 0; /* new quasireal y */
282 /* draw prompt, editor line, and clear tail */
283 static void redraw(int y, int back_cursor)
285 if (y > 0) /* up to start y */
286 printf("\033[%dA", y);
289 input_end(); /* rewrite */
290 printf("\033[J"); /* erase after cursor */
291 input_backward(back_cursor);
294 /* Delete the char in front of the cursor, optionally saving it
295 * for later putback */
296 #if !ENABLE_FEATURE_EDITING_VI
297 static void input_delete(void)
298 #define input_delete(save) input_delete()
300 static void input_delete(int save)
305 if (j == command_len)
308 #if ENABLE_FEATURE_EDITING_VI
314 if ((delptr - delbuf) < DELBUFSIZ)
315 *delptr++ = command_ps[j];
319 strcpy(command_ps + j, command_ps + j + 1);
321 input_end(); /* rewrite new line */
322 cmdedit_set_out_char(' '); /* erase char */
323 input_backward(cursor - j); /* back to old pos cursor */
326 #if ENABLE_FEATURE_EDITING_VI
327 static void put(void)
330 int j = delptr - delbuf;
335 /* open hole and then fill it */
336 memmove(command_ps + cursor + j, command_ps + cursor, command_len - cursor + 1);
337 strncpy(command_ps + cursor, delbuf, j);
339 input_end(); /* rewrite new line */
340 input_backward(cursor - ocursor - j + 1); /* at end of new text */
344 /* Delete the char in back of the cursor */
345 static void input_backspace(void)
353 /* Move forward one character */
354 static void input_forward(void)
356 if (cursor < command_len)
357 cmdedit_set_out_char(command_ps[cursor + 1]);
360 #if ENABLE_FEATURE_TAB_COMPLETION
362 static void free_tab_completion_data(void)
366 free(matches[--num_matches]);
372 static void add_match(char *matched)
374 int nm = num_matches;
377 matches = xrealloc(matches, nm1 * sizeof(char *));
378 matches[nm] = matched;
382 #if ENABLE_FEATURE_USERNAME_COMPLETION
383 static void username_tab_completion(char *ud, char *with_shash_flg)
385 struct passwd *entry;
388 ud++; /* ~user/... to user/... */
389 userlen = strlen(ud);
391 if (with_shash_flg) { /* "~/..." or "~user/..." */
392 char *sav_ud = ud - 1;
395 if (*ud == '/') { /* "~/..." */
400 temp = strchr(ud, '/');
401 *temp = '\0'; /* ~user\0 */
402 entry = getpwnam(ud);
403 *temp = '/'; /* restore ~user/... */
406 home = entry->pw_dir;
409 if ((userlen + strlen(home) + 1) < MAX_LINELEN) {
411 sprintf(sav_ud, "%s%s", home, ud);
416 /* Using _r function to avoid pulling in static buffers */
419 struct passwd *result;
422 while (!getpwent_r(&pwd, line_buff, sizeof(line_buff), &result)) {
423 /* Null usernames should result in all users as possible completions. */
424 if (/*!userlen || */ strncmp(ud, pwd.pw_name, userlen) == 0) {
425 add_match(xasprintf("~%s/", pwd.pw_name));
431 #endif /* FEATURE_COMMAND_USERNAME_COMPLETION */
439 static int path_parse(char ***p, int flags)
446 /* if not setenv PATH variable, to search cur dir "." */
447 if (flags != FIND_EXE_ONLY)
450 if (state->flags & WITH_PATH_LOOKUP)
451 pth = state->path_lookup;
453 pth = getenv("PATH");
454 /* PATH=<empty> or PATH=:<empty> */
455 if (!pth || !pth[0] || LONE_CHAR(pth, ':'))
459 npth = 1; /* path component count */
461 tmp = strchr(tmp, ':');
465 break; /* :<empty> */
469 res = xmalloc(npth * sizeof(char*));
470 res[0] = tmp = xstrdup(pth);
473 tmp = strchr(tmp, ':');
476 *tmp++ = '\0'; /* ':' -> '\0' */
478 break; /* :<empty> */
485 static void exe_n_cwd_tab_completion(char *command, int type)
491 char **paths = path1;
495 char *pfind = strrchr(command, '/');
496 /* char dirbuf[MAX_LINELEN]; */
497 #define dirbuf (S.exe_n_cwd_tab_completion__dirbuf)
500 path1[0] = (char*)".";
503 /* no dir, if flags==EXE_ONLY - get paths, else "." */
504 npaths = path_parse(&paths, type);
507 /* dirbuf = ".../.../.../" */
508 safe_strncpy(dirbuf, command, (pfind - command) + 2);
509 #if ENABLE_FEATURE_USERNAME_COMPLETION
510 if (dirbuf[0] == '~') /* ~/... or ~user/... */
511 username_tab_completion(dirbuf, dirbuf);
514 /* point to 'l' in "..../last_component" */
518 for (i = 0; i < npaths; i++) {
519 dir = opendir(paths[i]);
520 if (!dir) /* Don't print an error */
523 while ((next = readdir(dir)) != NULL) {
525 const char *str_found = next->d_name;
528 if (strncmp(str_found, pfind, strlen(pfind)))
530 /* not see .name without .match */
531 if (*str_found == '.' && *pfind == 0) {
532 if (NOT_LONE_CHAR(paths[i], '/') || str_found[1])
534 str_found = ""; /* only "/" */
536 found = concat_path_file(paths[i], str_found);
537 /* hmm, remover in progress? */
538 if (lstat(found, &st) < 0)
540 /* find with dirs? */
541 if (paths[i] != dirbuf)
542 strcpy(found, next->d_name); /* only name */
544 len1 = strlen(found);
545 found = xrealloc(found, len1 + 2);
547 found[len1+1] = '\0';
549 if (S_ISDIR(st.st_mode)) {
550 /* name is directory */
551 if (found[len1-1] != '/') {
555 /* not put found file if search only dirs for cd */
556 if (type == FIND_DIR_ONLY)
559 /* Add it to the list */
567 if (paths != path1) {
568 free(paths[0]); /* allocated memory only in first member */
574 #define QUOT (UCHAR_MAX+1)
576 #define collapse_pos(is, in) do { \
577 memmove(int_buf+(is), int_buf+(in), (MAX_LINELEN+1-(is)-(in)) * sizeof(pos_buf[0])); \
578 memmove(pos_buf+(is), pos_buf+(in), (MAX_LINELEN+1-(is)-(in)) * sizeof(pos_buf[0])); \
581 static int find_match(char *matchBuf, int *len_with_quotes)
586 /* int16_t int_buf[MAX_LINELEN + 1]; */
587 /* int16_t pos_buf[MAX_LINELEN + 1]; */
588 #define int_buf (S.find_match__int_buf)
589 #define pos_buf (S.find_match__pos_buf)
591 /* set to integer dimension characters and own positions */
593 int_buf[i] = (unsigned char)matchBuf[i];
594 if (int_buf[i] == 0) {
595 pos_buf[i] = -1; /* indicator end line */
601 /* mask \+symbol and convert '\t' to ' ' */
602 for (i = j = 0; matchBuf[i]; i++, j++)
603 if (matchBuf[i] == '\\') {
604 collapse_pos(j, j + 1);
607 #if ENABLE_FEATURE_NONPRINTABLE_INVERSE_PUT
608 if (matchBuf[i] == '\t') /* algorithm equivalent */
609 int_buf[j] = ' ' | QUOT;
612 #if ENABLE_FEATURE_NONPRINTABLE_INVERSE_PUT
613 else if (matchBuf[i] == '\t')
617 /* mask "symbols" or 'symbols' */
619 for (i = 0; int_buf[i]; i++) {
621 if (c == '\'' || c == '"') {
630 } else if (c2 != 0 && c != '$')
634 /* skip commands with arguments if line has commands delimiters */
635 /* ';' ';;' '&' '|' '&&' '||' but `>&' `<&' `>|' */
636 for (i = 0; int_buf[i]; i++) {
639 j = i ? int_buf[i - 1] : -1;
641 if (c == ';' || c == '&' || c == '|') {
642 command_mode = 1 + (c == c2);
644 if (j == '>' || j == '<')
646 } else if (c == '|' && j == '>')
650 collapse_pos(0, i + command_mode);
651 i = -1; /* hack incremet */
654 /* collapse `command...` */
655 for (i = 0; int_buf[i]; i++)
656 if (int_buf[i] == '`') {
657 for (j = i + 1; int_buf[j]; j++)
658 if (int_buf[j] == '`') {
659 collapse_pos(i, j + 1);
664 /* not found close ` - command mode, collapse all previous */
665 collapse_pos(0, i + 1);
668 i--; /* hack incremet */
671 /* collapse (command...(command...)...) or {command...{command...}...} */
672 c = 0; /* "recursive" level */
674 for (i = 0; int_buf[i]; i++)
675 if (int_buf[i] == '(' || int_buf[i] == '{') {
676 if (int_buf[i] == '(')
680 collapse_pos(0, i + 1);
681 i = -1; /* hack incremet */
683 for (i = 0; pos_buf[i] >= 0 && (c > 0 || c2 > 0); i++)
684 if ((int_buf[i] == ')' && c > 0) || (int_buf[i] == '}' && c2 > 0)) {
685 if (int_buf[i] == ')')
689 collapse_pos(0, i + 1);
690 i = -1; /* hack incremet */
693 /* skip first not quote space */
694 for (i = 0; int_buf[i]; i++)
695 if (int_buf[i] != ' ')
700 /* set find mode for completion */
701 command_mode = FIND_EXE_ONLY;
702 for (i = 0; int_buf[i]; i++)
703 if (int_buf[i] == ' ' || int_buf[i] == '<' || int_buf[i] == '>') {
704 if (int_buf[i] == ' ' && command_mode == FIND_EXE_ONLY
705 && matchBuf[pos_buf[0]] == 'c'
706 && matchBuf[pos_buf[1]] == 'd'
708 command_mode = FIND_DIR_ONLY;
710 command_mode = FIND_FILE_ONLY;
714 for (i = 0; int_buf[i]; i++)
717 for (--i; i >= 0; i--) {
719 if (c == ' ' || c == '<' || c == '>' || c == '|' || c == '&') {
720 collapse_pos(0, i + 1);
724 /* skip first not quoted '\'' or '"' */
725 for (i = 0; int_buf[i] == '\'' || int_buf[i] == '"'; i++)
727 /* collapse quote or unquote // or /~ */
728 while ((int_buf[i] & ~QUOT) == '/'
729 && ((int_buf[i+1] & ~QUOT) == '/' || (int_buf[i+1] & ~QUOT) == '~')
734 /* set only match and destroy quotes */
736 for (c = 0; pos_buf[i] >= 0; i++) {
737 matchBuf[c++] = matchBuf[pos_buf[i]];
741 /* old length matchBuf with quotes symbols */
742 *len_with_quotes = j ? j - pos_buf[0] : 0;
750 * display by column (original idea from ls applet,
751 * very optimized by me :)
753 static void showfiles(void)
756 int column_width = 0;
757 int nfiles = num_matches;
761 /* find the longest file name- use that as the column width */
762 for (row = 0; row < nrows; row++) {
763 l = strlen(matches[row]);
764 if (column_width < l)
767 column_width += 2; /* min space for columns */
768 ncols = cmdedit_termw / column_width;
773 nrows++; /* round up fractionals */
777 for (row = 0; row < nrows; row++) {
781 for (nc = 1; nc < ncols && n+nrows < nfiles; n += nrows, nc++) {
782 printf("%s%-*s", matches[n],
783 (int)(column_width - strlen(matches[n])), "");
789 static char *add_quote_for_spec_chars(char *found)
792 char *s = xmalloc((strlen(found) + 1) * 2);
795 if (strchr(" `\"#$%^&*()=+{}[]:;\'|\\<>", *found))
803 /* Do TAB completion */
804 static void input_tab(smallint *lastWasTab)
806 if (!(state->flags & TAB_COMPLETION))
812 /* char matchBuf[MAX_LINELEN]; */
813 #define matchBuf (S.input_tab__matchBuf)
817 *lastWasTab = TRUE; /* flop trigger */
819 /* Make a local copy of the string -- up
820 * to the position of the cursor */
821 tmp = strncpy(matchBuf, command_ps, cursor);
824 find_type = find_match(matchBuf, &recalc_pos);
826 /* Free up any memory already allocated */
827 free_tab_completion_data();
829 #if ENABLE_FEATURE_USERNAME_COMPLETION
830 /* If the word starts with `~' and there is no slash in the word,
831 * then try completing this word as a username. */
832 if (state->flags & USERNAME_COMPLETION)
833 if (matchBuf[0] == '~' && strchr(matchBuf, '/') == 0)
834 username_tab_completion(matchBuf, NULL);
836 /* Try to match any executable in our path and everything
837 * in the current working directory */
839 exe_n_cwd_tab_completion(matchBuf, find_type);
840 /* Sort, then remove any duplicates found */
843 qsort_string_vector(matches, num_matches);
844 for (i = 0; i < num_matches - 1; ++i) {
845 if (matches[i] && matches[i+1]) { /* paranoia */
846 if (strcmp(matches[i], matches[i+1]) == 0) {
848 matches[i] = NULL; /* paranoia */
850 matches[n++] = matches[i];
854 matches[n] = matches[i];
857 /* Did we find exactly one match? */
858 if (!matches || num_matches > 1) {
861 return; /* not found */
862 /* find minimal match */
863 tmp1 = xstrdup(matches[0]);
864 for (tmp = tmp1; *tmp; tmp++)
865 for (len_found = 1; len_found < num_matches; len_found++)
866 if (matches[len_found][(tmp - tmp1)] != *tmp) {
870 if (*tmp1 == '\0') { /* have unique */
874 tmp = add_quote_for_spec_chars(tmp1);
876 } else { /* one match */
877 tmp = add_quote_for_spec_chars(matches[0]);
878 /* for next completion current found */
881 len_found = strlen(tmp);
882 if (tmp[len_found-1] != '/') {
883 tmp[len_found] = ' ';
884 tmp[len_found+1] = '\0';
887 len_found = strlen(tmp);
888 /* have space to placed match? */
889 if ((len_found - strlen(matchBuf) + command_len) < MAX_LINELEN) {
890 /* before word for match */
891 command_ps[cursor - recalc_pos] = '\0';
893 strcpy(matchBuf, command_ps + cursor);
895 strcat(command_ps, tmp);
897 strcat(command_ps, matchBuf);
898 /* back to begin word for match */
899 input_backward(recalc_pos);
901 recalc_pos = cursor + len_found;
903 command_len = strlen(command_ps);
904 /* write out the matched command */
905 redraw(cmdedit_y, command_len - recalc_pos);
910 /* Ok -- the last char was a TAB. Since they
911 * just hit TAB again, print a list of all the
912 * available choices... */
913 if (matches && num_matches > 0) {
914 int sav_cursor = cursor; /* change goto_new_line() */
916 /* Go to the next line */
919 redraw(0, command_len - sav_cursor);
924 #endif /* FEATURE_COMMAND_TAB_COMPLETION */
929 /* state->flags is already checked to be nonzero */
930 static void get_previous_history(void)
932 if (command_ps[0] != '\0' || state->history[state->cur_history] == NULL) {
933 free(state->history[state->cur_history]);
934 state->history[state->cur_history] = xstrdup(command_ps);
936 state->cur_history--;
939 static int get_next_history(void)
941 if (state->flags & DO_HISTORY) {
942 int ch = state->cur_history;
943 if (ch < state->cnt_history) {
944 get_previous_history(); /* save the current history line */
945 state->cur_history = ch + 1;
946 return state->cur_history;
953 #if ENABLE_FEATURE_EDITING_SAVEHISTORY
954 /* state->flags is already checked to be nonzero */
955 static void load_history(const char *fromfile)
960 /* NB: do not trash old history if file can't be opened */
962 fp = fopen(fromfile, "r");
964 /* clean up old history */
965 for (hi = state->cnt_history; hi > 0;) {
967 free(state->history[hi]);
970 for (hi = 0; hi < MAX_HISTORY;) {
971 char *hl = xmalloc_fgetline(fp);
977 if (l >= MAX_LINELEN)
978 hl[MAX_LINELEN-1] = '\0';
979 if (l == 0 || hl[0] == ' ') {
983 state->history[hi++] = hl;
986 state->cur_history = state->cnt_history = hi;
990 /* state->flags is already checked to be nonzero */
991 static void save_history(const char *tofile)
995 fp = fopen(tofile, "w");
999 for (i = 0; i < state->cnt_history; i++) {
1000 fprintf(fp, "%s\n", state->history[i]);
1006 #define load_history(a) ((void)0)
1007 #define save_history(a) ((void)0)
1008 #endif /* FEATURE_COMMAND_SAVEHISTORY */
1010 static void remember_in_history(const char *str)
1014 if (!(state->flags & DO_HISTORY))
1017 i = state->cnt_history;
1018 free(state->history[MAX_HISTORY]);
1019 state->history[MAX_HISTORY] = NULL;
1020 /* After max history, remove the oldest command */
1021 if (i >= MAX_HISTORY) {
1022 free(state->history[0]);
1023 for (i = 0; i < MAX_HISTORY-1; i++)
1024 state->history[i] = state->history[i+1];
1026 // Maybe "if (!i || strcmp(history[i-1], command) != 0) ..."
1027 // (i.e. do not save dups?)
1028 state->history[i++] = xstrdup(str);
1029 state->cur_history = i;
1030 state->cnt_history = i;
1031 #if ENABLE_FEATURE_EDITING_SAVEHISTORY
1032 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1033 save_history(state->hist_file);
1035 USE_FEATURE_EDITING_FANCY_PROMPT(num_ok_lines++;)
1038 #else /* MAX_HISTORY == 0 */
1039 #define remember_in_history(a) ((void)0)
1040 #endif /* MAX_HISTORY */
1044 * This function is used to grab a character buffer
1045 * from the input file descriptor and allows you to
1046 * a string with full command editing (sort of like
1049 * The following standard commands are not implemented:
1050 * ESC-b -- Move back one word
1051 * ESC-f -- Move forward one word
1052 * ESC-d -- Delete back one word
1053 * ESC-h -- Delete forward one word
1054 * CTL-t -- Transpose two characters
1056 * Minimalist vi-style command line editing available if configured.
1057 * vi mode implemented 2005 by Paul Fox <pgf@foxharp.boston.ma.us>
1060 #if ENABLE_FEATURE_EDITING_VI
1062 vi_Word_motion(char *command, int eat)
1064 while (cursor < command_len && !isspace(command[cursor]))
1066 if (eat) while (cursor < command_len && isspace(command[cursor]))
1071 vi_word_motion(char *command, int eat)
1073 if (isalnum(command[cursor]) || command[cursor] == '_') {
1074 while (cursor < command_len
1075 && (isalnum(command[cursor+1]) || command[cursor+1] == '_'))
1077 } else if (ispunct(command[cursor])) {
1078 while (cursor < command_len && ispunct(command[cursor+1]))
1082 if (cursor < command_len)
1085 if (eat && cursor < command_len && isspace(command[cursor]))
1086 while (cursor < command_len && isspace(command[cursor]))
1091 vi_End_motion(char *command)
1094 while (cursor < command_len && isspace(command[cursor]))
1096 while (cursor < command_len-1 && !isspace(command[cursor+1]))
1101 vi_end_motion(char *command)
1103 if (cursor >= command_len-1)
1106 while (cursor < command_len-1 && isspace(command[cursor]))
1108 if (cursor >= command_len-1)
1110 if (isalnum(command[cursor]) || command[cursor] == '_') {
1111 while (cursor < command_len-1
1112 && (isalnum(command[cursor+1]) || command[cursor+1] == '_')
1116 } else if (ispunct(command[cursor])) {
1117 while (cursor < command_len-1 && ispunct(command[cursor+1]))
1123 vi_Back_motion(char *command)
1125 while (cursor > 0 && isspace(command[cursor-1]))
1127 while (cursor > 0 && !isspace(command[cursor-1]))
1132 vi_back_motion(char *command)
1137 while (cursor > 0 && isspace(command[cursor]))
1141 if (isalnum(command[cursor]) || command[cursor] == '_') {
1143 && (isalnum(command[cursor-1]) || command[cursor-1] == '_')
1147 } else if (ispunct(command[cursor])) {
1148 while (cursor > 0 && ispunct(command[cursor-1]))
1156 * read_line_input and its helpers
1159 #if !ENABLE_FEATURE_EDITING_FANCY_PROMPT
1160 static void parse_and_put_prompt(const char *prmt_ptr)
1162 cmdedit_prompt = prmt_ptr;
1163 cmdedit_prmt_len = strlen(prmt_ptr);
1167 static void parse_and_put_prompt(const char *prmt_ptr)
1170 size_t cur_prmt_len = 0;
1171 char flg_not_length = '[';
1172 char *prmt_mem_ptr = xzalloc(1);
1173 char *cwd_buf = xrealloc_getcwd_or_warn(NULL);
1178 cmdedit_prmt_len = 0;
1181 cwd_buf = (char *)bb_msg_unknown;
1184 cbuf[1] = '\0'; /* never changes */
1187 char *free_me = NULL;
1192 const char *cp = prmt_ptr;
1195 c = bb_process_escape_sequence(&prmt_ptr);
1196 if (prmt_ptr == cp) {
1202 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
1204 pbuf = user_buf ? user_buf : (char*)"";
1208 pbuf = free_me = safe_gethostname();
1209 *strchrnul(pbuf, '.') = '\0';
1212 c = (geteuid() == 0 ? '#' : '$');
1214 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
1216 /* /home/user[/something] -> ~[/something] */
1218 l = strlen(home_pwd_buf);
1220 && strncmp(home_pwd_buf, cwd_buf, l) == 0
1221 && (cwd_buf[l]=='/' || cwd_buf[l]=='\0')
1222 && strlen(cwd_buf + l) < PATH_MAX
1224 pbuf = free_me = xasprintf("~%s", cwd_buf + l);
1230 cp = strrchr(pbuf, '/');
1231 if (cp != NULL && cp != pbuf)
1232 pbuf += (cp-pbuf) + 1;
1235 pbuf = free_me = xasprintf("%d", num_ok_lines);
1237 case 'e': case 'E': /* \e \E = \033 */
1240 case 'x': case 'X': {
1242 for (l = 0; l < 3;) {
1244 buf2[l++] = *prmt_ptr;
1246 h = strtoul(buf2, &pbuf, 16);
1247 if (h > UCHAR_MAX || (pbuf - buf2) < l) {
1253 c = (char)strtoul(buf2, NULL, 16);
1260 if (c == flg_not_length) {
1261 flg_not_length = (flg_not_length == '[' ? ']' : '[');
1269 cur_prmt_len = strlen(pbuf);
1270 prmt_len += cur_prmt_len;
1271 if (flg_not_length != ']')
1272 cmdedit_prmt_len += cur_prmt_len;
1273 prmt_mem_ptr = strcat(xrealloc(prmt_mem_ptr, prmt_len+1), pbuf);
1277 if (cwd_buf != (char *)bb_msg_unknown)
1279 cmdedit_prompt = prmt_mem_ptr;
1284 static void cmdedit_setwidth(unsigned w, int redraw_flg)
1288 /* new y for current cursor */
1289 int new_y = (cursor + cmdedit_prmt_len) / w;
1291 redraw((new_y >= cmdedit_y ? new_y : cmdedit_y), command_len - cursor);
1296 static void win_changed(int nsig)
1299 get_terminal_width_height(0, &width, NULL);
1300 cmdedit_setwidth(width, nsig /* - just a yes/no flag */);
1301 if (nsig == SIGWINCH)
1302 signal(SIGWINCH, win_changed); /* rearm ourself */
1306 * The emacs and vi modes share much of the code in the big
1307 * command loop. Commands entered when in vi's command mode (aka
1308 * "escape mode") get an extra bit added to distinguish them --
1309 * this keeps them from being self-inserted. This clutters the
1310 * big switch a bit, but keeps all the code in one place.
1315 /* leave out the "vi-mode"-only case labels if vi editing isn't
1317 #define vi_case(caselabel) USE_FEATURE_EDITING(case caselabel)
1319 /* convert uppercase ascii to equivalent control char, for readability */
1321 #define CTRL(a) ((a) & ~0x40)
1324 * -1 on read errors or EOF, or on bare Ctrl-D,
1325 * 0 on ctrl-C (the line entered is still returned in 'command'),
1326 * >0 length of input string, including terminating '\n'
1328 int read_line_input(const char *prompt, char *command, int maxsize, line_input_t *st)
1330 #if ENABLE_FEATURE_TAB_COMPLETION
1331 smallint lastWasTab = FALSE;
1335 smallint break_out = 0;
1336 #if ENABLE_FEATURE_EDITING_VI
1337 smallint vi_cmdmode = 0;
1340 struct termios initial_settings;
1341 struct termios new_settings;
1345 if (tcgetattr(STDIN_FILENO, &initial_settings) < 0
1346 || !(initial_settings.c_lflag & ECHO)
1348 /* Happens when e.g. stty -echo was run before */
1350 parse_and_put_prompt(prompt);
1352 if (fgets(command, maxsize, stdin) == NULL)
1353 len = -1; /* EOF or error */
1355 len = strlen(command);
1360 // FIXME: audit & improve this
1361 if (maxsize > MAX_LINELEN)
1362 maxsize = MAX_LINELEN;
1364 /* With null flags, no other fields are ever used */
1365 state = st ? st : (line_input_t*) &const_int_0;
1366 #if ENABLE_FEATURE_EDITING_SAVEHISTORY
1367 if ((state->flags & SAVE_HISTORY) && state->hist_file)
1368 load_history(state->hist_file);
1371 /* prepare before init handlers */
1372 cmdedit_y = 0; /* quasireal y, not true if line > xt*yt */
1374 command_ps = command;
1377 new_settings = initial_settings;
1378 new_settings.c_lflag &= ~ICANON; /* unbuffered input */
1379 /* Turn off echoing and CTRL-C, so we can trap it */
1380 new_settings.c_lflag &= ~(ECHO | ECHONL | ISIG);
1381 /* Hmm, in linux c_cc[] is not parsed if ICANON is off */
1382 new_settings.c_cc[VMIN] = 1;
1383 new_settings.c_cc[VTIME] = 0;
1384 /* Turn off CTRL-C, so we can trap it */
1385 #ifndef _POSIX_VDISABLE
1386 #define _POSIX_VDISABLE '\0'
1388 new_settings.c_cc[VINTR] = _POSIX_VDISABLE;
1389 tcsetattr(STDIN_FILENO, TCSANOW, &new_settings);
1391 /* Now initialize things */
1392 previous_SIGWINCH_handler = signal(SIGWINCH, win_changed);
1393 win_changed(0); /* do initial resizing */
1394 #if ENABLE_FEATURE_GETUSERNAME_AND_HOMEDIR
1396 struct passwd *entry;
1398 entry = getpwuid(geteuid());
1400 user_buf = xstrdup(entry->pw_name);
1401 home_pwd_buf = xstrdup(entry->pw_dir);
1405 /* Print out the command prompt */
1406 parse_and_put_prompt(prompt);
1411 if (nonblock_safe_read(STDIN_FILENO, &c, 1) < 1) {
1412 /* if we can't read input then exit */
1413 goto prepare_to_die;
1418 #if ENABLE_FEATURE_EDITING_VI
1434 /* Control-a -- Beginning of line */
1435 input_backward(cursor);
1440 vi_case('\x7f'|vbit:) /* DEL */
1441 /* Control-b -- Move back one character */
1445 vi_case(CTRL('C')|vbit:)
1446 /* Control-c -- stop gathering input */
1449 break_out = -1; /* "do not append '\n'" */
1452 /* Control-d -- Delete one character, or exit
1453 * if the len=0 and no chars to delete */
1454 if (command_len == 0) {
1457 /* to control stopped jobs */
1458 break_out = command_len = -1;
1466 /* Control-e -- End of line */
1472 /* Control-f -- Move forward one character */
1477 case '\x7f': /* DEL */
1478 /* Control-h and DEL */
1482 #if ENABLE_FEATURE_TAB_COMPLETION
1484 input_tab(&lastWasTab);
1489 /* Control-k -- clear to end of line */
1490 command[cursor] = 0;
1491 command_len = cursor;
1495 vi_case(CTRL('L')|vbit:)
1496 /* Control-l -- clear screen */
1498 redraw(0, command_len - cursor);
1503 vi_case(CTRL('N')|vbit:)
1505 /* Control-n -- Get next command in history */
1506 if (get_next_history())
1510 vi_case(CTRL('P')|vbit:)
1512 /* Control-p -- Get previous command from history */
1513 if ((state->flags & DO_HISTORY) && state->cur_history > 0) {
1514 get_previous_history();
1522 vi_case(CTRL('U')|vbit:)
1523 /* Control-U -- Clear line before cursor */
1525 strcpy(command, command + cursor);
1526 command_len -= cursor;
1527 redraw(cmdedit_y, command_len);
1531 vi_case(CTRL('W')|vbit:)
1532 /* Control-W -- Remove the last word */
1533 while (cursor > 0 && isspace(command[cursor-1]))
1535 while (cursor > 0 && !isspace(command[cursor-1]))
1539 #if ENABLE_FEATURE_EDITING_VI
1544 input_backward(cursor);
1565 vi_Word_motion(command, 1);
1568 vi_word_motion(command, 1);
1571 vi_End_motion(command);
1574 vi_end_motion(command);
1577 vi_Back_motion(command);
1580 vi_back_motion(command);
1595 if (safe_read(STDIN_FILENO, &c, 1) < 1)
1596 goto prepare_to_die;
1597 if (c == (prevc & 0xff)) {
1599 input_backward(cursor);
1609 case 'w': /* "dw", "cw" */
1610 vi_word_motion(command, vi_cmdmode);
1612 case 'W': /* 'dW', 'cW' */
1613 vi_Word_motion(command, vi_cmdmode);
1615 case 'e': /* 'de', 'ce' */
1616 vi_end_motion(command);
1619 case 'E': /* 'dE', 'cE' */
1620 vi_End_motion(command);
1625 input_backward(cursor - sc);
1626 while (nc-- > cursor)
1629 case 'b': /* "db", "cb" */
1630 case 'B': /* implemented as B */
1632 vi_back_motion(command);
1634 vi_Back_motion(command);
1635 while (sc-- > cursor)
1638 case ' ': /* "d ", "c " */
1641 case '$': /* "d$", "c$" */
1643 while (cursor < command_len)
1656 if (safe_read(STDIN_FILENO, &c, 1) < 1)
1657 goto prepare_to_die;
1661 *(command + cursor) = c;
1666 #endif /* FEATURE_COMMAND_EDITING_VI */
1668 case '\x1b': /* ESC */
1670 #if ENABLE_FEATURE_EDITING_VI
1671 if (state->flags & VI_MODE) {
1672 /* ESC: insert mode --> command mode */
1678 /* escape sequence follows */
1679 if (safe_read(STDIN_FILENO, &c, 1) < 1)
1680 goto prepare_to_die;
1681 /* different vt100 emulations */
1682 if (c == '[' || c == 'O') {
1685 if (safe_read(STDIN_FILENO, &c, 1) < 1)
1686 goto prepare_to_die;
1688 if (c >= '1' && c <= '9') {
1689 unsigned char dummy;
1691 if (safe_read(STDIN_FILENO, &dummy, 1) < 1)
1692 goto prepare_to_die;
1698 #if ENABLE_FEATURE_TAB_COMPLETION
1699 case '\t': /* Alt-Tab */
1700 input_tab(&lastWasTab);
1705 /* Up Arrow -- Get previous command from history */
1706 if ((state->flags & DO_HISTORY) && state->cur_history > 0) {
1707 get_previous_history();
1713 /* Down Arrow -- Get next command in history */
1714 if (!get_next_history())
1717 /* Rewrite the line with the selected history item */
1718 /* change command */
1719 command_len = strlen(strcpy(command, state->history[state->cur_history]));
1720 /* redraw and go to eol (bol, in vi */
1721 redraw(cmdedit_y, (state->flags & VI_MODE) ? 9999 : 0);
1725 /* Right Arrow -- Move forward one character */
1729 /* Left Arrow -- Move back one character */
1736 case '1': // vt100? linux vt? or what?
1737 case '7': // vt100? linux vt? or what?
1738 case 'H': /* xterm's <Home> */
1739 input_backward(cursor);
1741 case '4': // vt100? linux vt? or what?
1742 case '8': // vt100? linux vt? or what?
1743 case 'F': /* xterm's <End> */
1752 default: /* If it's regular input, do the normal thing */
1754 /* Control-V -- force insert of next char */
1755 if (c == CTRL('V')) {
1756 if (safe_read(STDIN_FILENO, &c, 1) < 1)
1757 goto prepare_to_die;
1764 #if ENABLE_FEATURE_EDITING_VI
1765 if (vi_cmdmode) /* Don't self-insert */
1768 if (command_len >= (maxsize - 2)) /* Need to leave space for enter */
1772 if (cursor == (command_len - 1)) { /* Append if at the end of the line */
1773 command[cursor] = c;
1774 command[cursor+1] = '\0';
1775 cmdedit_set_out_char(' ');
1776 } else { /* Insert otherwise */
1779 memmove(command + sc + 1, command + sc, command_len - sc);
1782 /* rewrite from cursor */
1784 /* to prev x pos + 1 */
1785 input_backward(cursor - sc);
1789 if (break_out) /* Enter is the command terminator, no more input. */
1792 #if ENABLE_FEATURE_TAB_COMPLETION
1798 if (command_len > 0)
1799 remember_in_history(command);
1801 if (break_out > 0) {
1802 command[command_len++] = '\n';
1803 command[command_len] = '\0';
1806 #if ENABLE_FEATURE_TAB_COMPLETION
1807 free_tab_completion_data();
1810 /* restore initial_settings */
1811 tcsetattr(STDIN_FILENO, TCSANOW, &initial_settings);
1812 /* restore SIGWINCH handler */
1813 signal(SIGWINCH, previous_SIGWINCH_handler);
1821 line_input_t *new_line_input_t(int flags)
1823 line_input_t *n = xzalloc(sizeof(*n));
1830 #undef read_line_input
1831 int read_line_input(const char* prompt, char* command, int maxsize)
1833 fputs(prompt, stdout);
1835 fgets(command, maxsize, stdin);
1836 return strlen(command);
1839 #endif /* FEATURE_COMMAND_EDITING */
1850 const char *applet_name = "debug stuff usage";
1852 int main(int argc, char **argv)
1854 char buff[MAX_LINELEN];
1856 #if ENABLE_FEATURE_EDITING_FANCY_PROMPT
1857 "\\[\\033[32;1m\\]\\u@\\[\\x1b[33;1m\\]\\h:"
1858 "\\[\\033[34;1m\\]\\w\\[\\033[35;1m\\] "
1859 "\\!\\[\\e[36;1m\\]\\$ \\[\\E[0m\\]";
1864 #if ENABLE_FEATURE_NONPRINTABLE_INVERSE_PUT
1865 setlocale(LC_ALL, "");
1869 l = read_line_input(prompt, buff);
1870 if (l <= 0 || buff[l-1] != '\n')
1873 printf("*** read_line_input() returned line =%s=\n", buff);
1875 printf("*** read_line_input() detect ^D\n");