1 /* $NetBSD: readline.c,v 1.159 2019/10/09 14:31:07 christos Exp $ */
4 * Copyright (c) 1997 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
33 #if !defined(lint) && !defined(SCCSID)
34 __RCSID("$NetBSD: readline.c,v 1.159 2019/10/09 14:31:07 christos Exp $");
35 #endif /* not lint && not SCCSID */
37 #include <sys/types.h>
53 #include "readline/readline.h"
56 #include "filecomplete.h"
58 void rl_prep_terminal(int);
59 void rl_deprep_terminal(void);
61 /* for rl_complete() */
64 /* see comment at the #ifdef for sense of this */
65 /* #define GDB_411_HACK */
67 /* readline compatibility stuff - look at readline sources/documentation */
68 /* to see what these variables mean */
69 const char *rl_library_version = "EditLine wrapper";
70 int rl_readline_version = RL_READLINE_VERSION;
71 static char empty[] = { '\0' };
72 static char expand_chars[] = { ' ', '\t', '\n', '=', '(', '\0' };
73 static char break_chars[] = { ' ', '\t', '\n', '"', '\\', '\'', '`', '@', '$',
74 '>', '<', '=', ';', '|', '&', '{', '(', '\0' };
75 const char *rl_readline_name = empty;
76 FILE *rl_instream = NULL;
77 FILE *rl_outstream = NULL;
80 char *rl_line_buffer = NULL;
81 rl_vcpfunc_t *rl_linefunc = NULL;
83 rl_hook_func_t *rl_event_hook = NULL;
84 KEYMAP_ENTRY_ARRAY emacs_standard_keymap,
88 * The following is not implemented; we always catch signals in the
89 * libedit fashion: set handlers on entry to el_gets() and clear them
90 * on the way out. This simplistic approach works for most cases; if
91 * it does not work for your application, please let us know.
93 int rl_catch_signals = 1;
94 int rl_catch_sigwinch = 1;
96 int history_base = 1; /* probably never subject to change */
97 int history_length = 0;
98 int history_offset = 0;
99 int max_input_history = 0;
100 char history_expansion_char = '!';
101 char history_subst_char = '^';
102 char *history_no_expand_chars = expand_chars;
103 Function *history_inhibit_expansion_function = NULL;
104 char *history_arg_extract(int start, int end, const char *str);
106 int rl_inhibit_completion = 0;
107 int rl_attempted_completion_over = 0;
108 const char *rl_basic_word_break_characters = break_chars;
109 char *rl_completer_word_break_characters = NULL;
110 const char *rl_completer_quote_characters = NULL;
111 rl_compentry_func_t *rl_completion_entry_function = NULL;
112 char *(*rl_completion_word_break_hook)(void) = NULL;
113 rl_completion_func_t *rl_attempted_completion_function = NULL;
114 Function *rl_pre_input_hook = NULL;
115 Function *rl_startup1_hook = NULL;
116 int (*rl_getc_function)(FILE *) = NULL;
117 char *rl_terminal_name = NULL;
118 int rl_already_prompted = 0;
119 int rl_filename_completion_desired = 0;
120 int rl_ignore_completion_duplicates = 0;
121 int readline_echoing_p = 1;
122 int _rl_print_completions_horizontally = 0;
123 VFunction *rl_redisplay_function = NULL;
124 Function *rl_startup_hook = NULL;
125 int rl_did_startup_hook = 0;
126 VFunction *rl_completion_display_matches_hook = NULL;
127 VFunction *rl_prep_term_function = (VFunction *)rl_prep_terminal;
128 VFunction *rl_deprep_term_function = (VFunction *)rl_deprep_terminal;
129 KEYMAP_ENTRY_ARRAY emacs_meta_keymap;
132 * The current prompt string.
134 char *rl_prompt = NULL;
136 * This is set to character indicating type of completion being done by
137 * rl_complete_internal(); this is available for application completion
140 int rl_completion_type = 0;
143 * If more than this number of items results from query for possible
144 * completions, we ask user if they are sure to really display the list.
146 int rl_completion_query_items = 100;
149 * List of characters which are word break characters, but should be left
150 * in the parsed text when it is passed to the completion function.
151 * Shell uses this to help determine what kind of completing to do.
153 const char *rl_special_prefixes = NULL;
156 * This is the character appended to the completed words if at the end of
157 * the line. Default is ' ' (a space).
159 int rl_completion_append_character = ' ';
161 /* stuff below is used internally by libedit for readline emulation */
163 static History *h = NULL;
164 static EditLine *e = NULL;
165 static rl_command_func_t *map[256];
166 static jmp_buf topbuf;
168 /* internal functions */
169 static unsigned char _el_rl_complete(EditLine *, int);
170 static unsigned char _el_rl_tstp(EditLine *, int);
171 static char *_get_prompt(EditLine *);
172 static int _getc_function(EditLine *, wchar_t *);
173 static int _history_expand_command(const char *, size_t, size_t,
175 static char *_rl_compat_sub(const char *, const char *,
177 static int _rl_event_read_char(EditLine *, wchar_t *);
178 static void _rl_update_pos(void);
180 static HIST_ENTRY rl_he;
184 _get_prompt(EditLine *el __attribute__((__unused__)))
186 rl_already_prompted = 1;
192 * read one key from user defined input function
196 _getc_function(EditLine *el __attribute__((__unused__)), wchar_t *c)
200 i = (*rl_getc_function)(rl_instream);
208 _resize_fun(EditLine *el, void *a)
214 /* a cheesy way to get rid of const cast. */
215 *ap = memchr(li->buffer, *li->buffer, (size_t)1);
219 _default_history_file(void)
228 if ((p = getpwuid(getuid())) == NULL)
231 len = strlen(p->pw_dir) + sizeof("/.history");
232 if ((path = malloc(len)) == NULL)
235 (void)snprintf(path, len, "%s/.history", p->pw_dir);
240 * READLINE compatibility stuff
247 rl_set_prompt(const char *prompt)
253 if (rl_prompt != NULL && strcmp(rl_prompt, prompt) == 0)
257 rl_prompt = strdup(prompt);
258 if (rl_prompt == NULL)
261 while ((p = strchr(rl_prompt, RL_PROMPT_END_IGNORE)) != NULL) {
262 /* Remove adjacent end/start markers to avoid double-escapes. */
263 if (p[1] == RL_PROMPT_START_IGNORE) {
264 memmove(p, p + 2, 1 + strlen(p + 2));
266 *p = RL_PROMPT_START_IGNORE;
274 * initialize rl compat stuff
291 rl_outstream = stdout;
294 * See if we don't really want to run the editor
296 if (tcgetattr(fileno(rl_instream), &t) != -1 && (t.c_lflag & ECHO) == 0)
299 e = el_init_internal(rl_readline_name, rl_instream, rl_outstream,
300 stderr, fileno(rl_instream), fileno(rl_outstream), fileno(stderr),
304 el_set(e, EL_EDITMODE, 0);
310 history(h, &ev, H_SETSIZE, INT_MAX); /* unlimited */
312 max_input_history = INT_MAX;
313 el_set(e, EL_HIST, history, h);
315 /* Setup resize function */
316 el_set(e, EL_RESIZE, _resize_fun, &rl_line_buffer);
318 /* setup getc function if valid */
319 if (rl_getc_function)
320 el_set(e, EL_GETCFN, _getc_function);
322 /* for proper prompt printing in readline() */
323 if (rl_set_prompt("") == -1) {
328 el_set(e, EL_PROMPT_ESC, _get_prompt, RL_PROMPT_START_IGNORE);
329 el_set(e, EL_SIGNAL, rl_catch_signals);
331 /* set default mode to "emacs"-style and read setting afterwards */
332 /* so this can be overridden */
333 el_set(e, EL_EDITOR, "emacs");
334 if (rl_terminal_name != NULL)
335 el_set(e, EL_TERMINAL, rl_terminal_name);
337 el_get(e, EL_TERMINAL, &rl_terminal_name);
340 * Word completion - this has to go AFTER rebinding keys
343 el_set(e, EL_ADDFN, "rl_complete",
344 "ReadLine compatible completion function",
346 el_set(e, EL_BIND, "^I", "rl_complete", NULL);
349 * Send TSTP when ^Z is pressed.
351 el_set(e, EL_ADDFN, "rl_tstp",
352 "ReadLine compatible suspend function",
354 el_set(e, EL_BIND, "^Z", "rl_tstp", NULL);
357 * Set some readline compatible key-bindings.
359 el_set(e, EL_BIND, "^R", "em-inc-search-prev", NULL);
362 * Allow the use of Home/End keys.
364 el_set(e, EL_BIND, "\\e[1~", "ed-move-to-beg", NULL);
365 el_set(e, EL_BIND, "\\e[4~", "ed-move-to-end", NULL);
366 el_set(e, EL_BIND, "\\e[7~", "ed-move-to-beg", NULL);
367 el_set(e, EL_BIND, "\\e[8~", "ed-move-to-end", NULL);
368 el_set(e, EL_BIND, "\\e[H", "ed-move-to-beg", NULL);
369 el_set(e, EL_BIND, "\\e[F", "ed-move-to-end", NULL);
372 * Allow the use of the Delete/Insert keys.
374 el_set(e, EL_BIND, "\\e[3~", "ed-delete-next-char", NULL);
375 el_set(e, EL_BIND, "\\e[2~", "ed-quoted-insert", NULL);
378 * Ctrl-left-arrow and Ctrl-right-arrow for word moving.
380 el_set(e, EL_BIND, "\\e[1;5C", "em-next-word", NULL);
381 el_set(e, EL_BIND, "\\e[1;5D", "ed-prev-word", NULL);
382 el_set(e, EL_BIND, "\\e[5C", "em-next-word", NULL);
383 el_set(e, EL_BIND, "\\e[5D", "ed-prev-word", NULL);
384 el_set(e, EL_BIND, "\\e\\e[C", "em-next-word", NULL);
385 el_set(e, EL_BIND, "\\e\\e[D", "ed-prev-word", NULL);
387 /* read settings from configuration file */
391 * Unfortunately, some applications really do use rl_point
392 * and rl_line_buffer directly.
394 _resize_fun(e, &rl_line_buffer);
397 tty_end(e, TCSADRAIN);
404 * read one line from input stream and return it, chomping
405 * trailing newline (if there is any)
408 readline(const char *p)
411 const char * volatile prompt = p;
415 static int used_event_hook;
417 if (e == NULL || h == NULL)
419 if (rl_did_startup_hook == 0 && rl_startup_hook) {
420 rl_did_startup_hook = 1;
421 (*rl_startup_hook)(NULL, 0);
428 (void)setjmp(topbuf);
431 /* update prompt accordingly to what has been passed */
432 if (rl_set_prompt(prompt) == -1)
435 if (rl_pre_input_hook)
436 (*rl_pre_input_hook)(NULL, 0);
438 if (rl_event_hook && !(e->el_flags & NO_TTY)) {
439 el_set(e, EL_GETCFN, _rl_event_read_char);
443 if (!rl_event_hook && used_event_hook) {
444 el_set(e, EL_GETCFN, EL_BUILTIN_GETCFN);
448 rl_already_prompted = 0;
450 /* get one line from input stream */
451 ret = el_gets(e, &count);
453 if (ret && count > 0) {
460 if (buf[lastidx] == '\n')
465 history(h, &ev, H_GETSIZE);
466 history_length = ev.num;
469 tty_end(e, TCSADRAIN);
478 * is normally called before application starts to use
479 * history expansion functions
484 if (h == NULL || e == NULL)
486 history_offset = history_length;
491 * substitute ``what'' with ``with'', returning resulting string; if
492 * globally == 1, substitutes all occurrences of what, otherwise only the
496 _rl_compat_sub(const char *str, const char *what, const char *with,
501 size_t len, with_len, what_len;
504 with_len = strlen(with);
505 what_len = strlen(what);
507 /* calculate length we need for result */
510 if (*s == *what && !strncmp(s, what, what_len)) {
511 len += with_len - what_len;
518 r = result = el_calloc(len + 1, sizeof(*r));
523 if (*s == *what && !strncmp(s, what, what_len)) {
524 memcpy(r, with, with_len);
538 static char *last_search_pat; /* last !?pat[?] search pattern */
539 static char *last_search_match; /* last !?pat[?] that matched */
542 get_history_event(const char *cmd, int *cindex, int qchar)
544 int idx, sign, sub, num, begin, ret;
551 if (cmd[idx++] != history_expansion_char)
554 /* find out which event to take */
555 if (cmd[idx] == history_expansion_char || cmd[idx] == '\0') {
556 if (history(h, &ev, H_FIRST) != 0)
558 *cindex = cmd[idx]? (idx + 1):idx;
562 if (cmd[idx] == '-') {
567 if ('0' <= cmd[idx] && cmd[idx] <= '9') {
571 while (cmd[idx] && '0' <= cmd[idx] && cmd[idx] <= '9') {
572 num = num * 10 + cmd[idx] - '0';
576 num = history_length - num + history_base;
578 if (!(he = history_get(num)))
585 if (cmd[idx] == '?') {
591 if (cmd[idx] == '\n')
593 if (sub && cmd[idx] == '?')
595 if (!sub && (cmd[idx] == ':' || cmd[idx] == ' '
596 || cmd[idx] == '\t' || cmd[idx] == qchar))
600 len = (size_t)idx - (size_t)begin;
601 if (sub && cmd[idx] == '?')
603 if (sub && len == 0 && last_search_pat && *last_search_pat)
604 pat = last_search_pat;
608 if ((pat = el_calloc(len + 1, sizeof(*pat))) == NULL)
610 (void)strlcpy(pat, cmd + begin, len + 1);
613 if (history(h, &ev, H_CURR) != 0) {
614 if (pat != last_search_pat)
621 if (pat != last_search_pat) {
623 el_free(last_search_pat);
624 last_search_pat = pat;
626 ret = history_search(pat, -1);
628 ret = history_search_prefix(pat, -1);
631 /* restore to end of list on failed search */
632 history(h, &ev, H_FIRST);
633 (void)fprintf(rl_outstream, "%s: Event not found\n", pat);
634 if (pat != last_search_pat)
640 if (last_search_match && last_search_match != pat)
641 el_free(last_search_match);
642 last_search_match = pat;
645 if (pat != last_search_pat)
648 if (history(h, &ev, H_CURR) != 0)
653 /* roll back to original position */
654 (void)history(h, &ev, H_SET, num);
660 * the real function doing history expansion - takes as argument command
661 * to do and data upon which the command should be executed
662 * does expansion the way I've understood readline documentation
664 * returns 0 if data was not modified, 1 if it was and 2 if the string
665 * should be only printed and not executed; in case of error,
666 * returns -1 and *result points to NULL
667 * it's the caller's responsibility to free() the string returned in *result
670 _history_expand_command(const char *command, size_t offs, size_t cmdlen,
673 char *tmp, *search = NULL, *aptr;
674 const char *ptr, *cmd;
675 static char *from = NULL, *to = NULL;
676 int start, end, idx, has_mods = 0;
677 int p_on = 0, g_on = 0;
683 /* First get event specifier */
686 if (strchr(":^*$", command[offs + 1])) {
689 * "!:" is shorthand for "!!:".
690 * "!^", "!*" and "!$" are shorthand for
691 * "!!:^", "!!:*" and "!!:$" respectively.
693 str[0] = str[1] = '!';
695 ptr = get_history_event(str, &idx, 0);
696 idx = (command[offs + 1] == ':')? 1:0;
699 if (command[offs + 1] == '#') {
700 /* use command so far */
701 if ((aptr = el_calloc(offs + 1, sizeof(*aptr)))
704 (void)strlcpy(aptr, command, offs + 1);
709 qchar = (offs > 0 && command[offs - 1] == '"')? '"':0;
710 ptr = get_history_event(command + offs, &idx, qchar);
712 has_mods = command[offs + (size_t)idx] == ':';
715 if (ptr == NULL && aptr == NULL)
719 *result = strdup(aptr ? aptr : ptr);
727 cmd = command + offs + idx + 1;
729 /* Now parse any word designators */
731 if (*cmd == '%') /* last word matched by ?pat? */
732 tmp = strdup(last_search_match? last_search_match:"");
733 else if (strchr("^*$-0123456789", *cmd)) {
736 start = end = 1, cmd++;
737 else if (*cmd == '$')
739 else if (*cmd == '*')
741 else if (*cmd == '-' || isdigit((unsigned char) *cmd)) {
743 while (*cmd && '0' <= *cmd && *cmd <= '9')
744 start = start * 10 + *cmd++ - '0';
747 if (isdigit((unsigned char) cmd[1])) {
750 while (*cmd && '0' <= *cmd && *cmd <= '9')
751 end = end * 10 + *cmd++ - '0';
752 } else if (cmd[1] == '$') {
759 } else if (*cmd == '*')
764 tmp = history_arg_extract(start, end, aptr? aptr:ptr);
766 (void)fprintf(rl_outstream, "%s: Bad word specifier",
767 command + offs + idx);
773 tmp = strdup(aptr? aptr:ptr);
778 if (*cmd == '\0' || ((size_t)(cmd - (command + offs)) >= cmdlen)) {
783 for (; *cmd; cmd++) {
786 else if (*cmd == 'h') { /* remove trailing path */
787 if ((aptr = strrchr(tmp, '/')) != NULL)
789 } else if (*cmd == 't') { /* remove leading path */
790 if ((aptr = strrchr(tmp, '/')) != NULL) {
791 aptr = strdup(aptr + 1);
795 } else if (*cmd == 'r') { /* remove trailing suffix */
796 if ((aptr = strrchr(tmp, '.')) != NULL)
798 } else if (*cmd == 'e') { /* remove all but suffix */
799 if ((aptr = strrchr(tmp, '.')) != NULL) {
804 } else if (*cmd == 'p') /* print only */
806 else if (*cmd == 'g')
808 else if (*cmd == 's' || *cmd == '&') {
809 char *what, *with, delim;
810 size_t len, from_len;
813 if (*cmd == '&' && (from == NULL || to == NULL))
815 else if (*cmd == 's') {
816 delim = *(++cmd), cmd++;
818 what = el_realloc(from, size * sizeof(*what));
825 for (; *cmd && *cmd != delim; cmd++) {
826 if (*cmd == '\\' && cmd[1] == delim)
830 nwhat = el_realloc(what,
847 from = strdup(search);
858 cmd++; /* shift after delim */
863 with = el_realloc(to, size * sizeof(*with));
870 from_len = strlen(from);
871 for (; *cmd && *cmd != delim; cmd++) {
872 if (len + from_len + 1 >= size) {
874 size += from_len + 1;
875 nwith = el_realloc(with,
876 size * sizeof(*nwith));
886 (void)strcpy(&with[len], from);
891 && (*(cmd + 1) == delim
892 || *(cmd + 1) == '&'))
900 aptr = _rl_compat_sub(tmp, from, to, g_on);
914 * csh-style history expansion
917 history_expand(char *str, char **output)
923 if (h == NULL || e == NULL)
926 if (history_expansion_char == 0) {
927 *output = strdup(str);
932 if (str[0] == history_subst_char) {
933 /* ^foo^foo2^ is equivalent to !!:s^foo^foo2^ */
934 *output = el_calloc(strlen(str) + 4 + 1, sizeof(**output));
937 (*output)[0] = (*output)[1] = history_expansion_char;
940 (void)strcpy((*output) + 4, str);
943 *output = strdup(str);
948 #define ADD_STRING(what, len, fr) \
950 if (idx + len + 1 > size) { \
951 char *nresult = el_realloc(result, \
952 (size += len + 1) * sizeof(*nresult)); \
953 if (nresult == NULL) { \
955 if (/*CONSTCOND*/fr) \
961 (void)strlcpy(&result[idx], what, len + 1); \
968 for (i = 0; str[i];) {
969 int qchar, loop_again;
970 size_t len, start, j;
976 for (; str[j]; j++) {
977 if (str[j] == '\\' &&
978 str[j + 1] == history_expansion_char) {
979 len = strlen(&str[j + 1]) + 1;
980 memmove(&str[j], &str[j + 1], len);
984 if (isspace((unsigned char) str[j])
988 if (str[j] == history_expansion_char
989 && !strchr(history_no_expand_chars, str[j + 1])
990 && (!history_inhibit_expansion_function ||
991 (*history_inhibit_expansion_function)(str,
996 if (str[j] && loop_again) {
998 qchar = (j > 0 && str[j - 1] == '"' )? '"':0;
1000 if (str[j] == history_expansion_char)
1006 ADD_STRING(&str[start], len, 0);
1008 if (str[i] == '\0' || str[i] != history_expansion_char) {
1010 ADD_STRING(&str[i], len, 0);
1017 ret = _history_expand_command (str, i, (j - i), &tmp);
1018 if (ret > 0 && tmp) {
1020 ADD_STRING(tmp, len, 1);
1029 /* ret is 2 for "print only" option */
1031 add_history(result);
1033 /* gdb 4.11 has been shipped with readline, where */
1034 /* history_expand() returned -1 when the line */
1035 /* should not be executed; in readline 2.1+ */
1036 /* it should return 2 in such a case */
1047 * Return a string consisting of arguments of "str" from "start" to "end".
1050 history_arg_extract(int start, int end, const char *str)
1053 char **arr, *result = NULL;
1055 arr = history_tokenize(str);
1058 if (arr && *arr == NULL)
1061 for (max = 0; arr[max]; max++)
1070 end = (int)max + end + 1;
1074 if (start < 0 || end < 0 || (size_t)start > max ||
1075 (size_t)end > max || start > end)
1078 for (i = (size_t)start, len = 0; i <= (size_t)end; i++)
1079 len += strlen(arr[i]) + 1;
1081 result = el_calloc(len, sizeof(*result));
1085 for (i = (size_t)start, len = 0; i <= (size_t)end; i++) {
1086 (void)strcpy(result + len, arr[i]);
1087 len += strlen(arr[i]);
1088 if (i < (size_t)end)
1089 result[len++] = ' ';
1094 for (i = 0; arr[i]; i++)
1102 * Parse the string into individual tokens,
1103 * similar to how shell would do it.
1106 history_tokenize(const char *str)
1108 int size = 1, idx = 0, i, start;
1110 char **result = NULL, *temp, delim = '\0';
1112 for (i = 0; str[i];) {
1113 while (isspace((unsigned char) str[i]))
1117 if (str[i] == '\\') {
1118 if (str[i+1] != '\0')
1120 } else if (str[i] == delim)
1123 (isspace((unsigned char) str[i]) ||
1124 strchr("()<>;&|$", str[i])))
1126 else if (!delim && strchr("'`\"", str[i]))
1132 if (idx + 2 >= size) {
1135 nresult = el_realloc(result, (size_t)size * sizeof(*nresult));
1136 if (nresult == NULL) {
1142 len = (size_t)i - (size_t)start;
1143 temp = el_calloc(len + 1, sizeof(*temp));
1145 for (i = 0; i < idx; i++)
1150 (void)strlcpy(temp, &str[start], len + 1);
1151 result[idx++] = temp;
1161 * limit size of history record to ``max'' events
1164 stifle_history(int max)
1169 if (h == NULL || e == NULL)
1172 if (history(h, &ev, H_SETSIZE, max) == 0) {
1173 max_input_history = max;
1174 if (history_length > max)
1175 history_base = history_length - max;
1176 while (history_length > max) {
1177 he = remove_history(0);
1179 el_free((void *)(unsigned long)he->line);
1187 * "unlimit" size of history - set the limit to maximum allowed int value
1190 unstifle_history(void)
1195 history(h, &ev, H_SETSIZE, INT_MAX);
1196 omax = max_input_history;
1197 max_input_history = INT_MAX;
1198 return omax; /* some value _must_ be returned */
1203 history_is_stifled(void)
1206 /* cannot return true answer */
1207 return max_input_history != INT_MAX;
1210 static const char _history_tmp_template[] = "/tmp/.historyXXXXXX";
1213 history_truncate_file (const char *filename, int nlines)
1217 char template[sizeof(_history_tmp_template)];
1225 if (filename == NULL && (filename = _default_history_file()) == NULL)
1227 if ((fp = fopen(filename, "r+")) == NULL)
1229 strcpy(template, _history_tmp_template);
1230 if ((fd = mkstemp(template)) == -1) {
1235 if ((tp = fdopen(fd, "r+")) == NULL) {
1242 if (fread(buf, sizeof(buf), (size_t)1, fp) != 1) {
1247 if (fseeko(fp, (off_t)sizeof(buf) * count, SEEK_SET) ==
1252 left = (ssize_t)fread(buf, (size_t)1, sizeof(buf), fp);
1260 } else if (fwrite(buf, (size_t)left, (size_t)1, tp)
1268 if (fwrite(buf, sizeof(buf), (size_t)1, tp) != 1) {
1276 cp = buf + left - 1;
1280 while (--cp >= buf) {
1282 if (--nlines == 0) {
1283 if (++cp >= buf + sizeof(buf)) {
1291 if (nlines <= 0 || count == 0)
1294 if (fseeko(tp, (off_t)sizeof(buf) * count, SEEK_SET) < 0) {
1298 if (fread(buf, sizeof(buf), (size_t)1, tp) != 1) {
1306 cp = buf + sizeof(buf);
1309 if (ret || nlines > 0)
1312 if (fseeko(fp, (off_t)0, SEEK_SET) == (off_t)-1) {
1317 if (fseeko(tp, (off_t)sizeof(buf) * count + (cp - buf), SEEK_SET) ==
1324 if ((left = (ssize_t)fread(buf, (size_t)1, sizeof(buf), tp)) == 0) {
1329 if (fwrite(buf, (size_t)left, (size_t)1, fp) != 1) {
1335 if((off = ftello(fp)) > 0)
1336 (void)ftruncate(fileno(fp), off);
1349 * read history from a file given
1352 read_history(const char *filename)
1356 if (h == NULL || e == NULL)
1358 if (filename == NULL && (filename = _default_history_file()) == NULL)
1361 if (history(h, &ev, H_LOAD, filename) == -1)
1362 return errno ? errno : EINVAL;
1363 if (history(h, &ev, H_GETSIZE) == 0)
1364 history_length = ev.num;
1365 if (history_length < 0)
1372 * write history to a file given
1375 write_history(const char *filename)
1379 if (h == NULL || e == NULL)
1381 if (filename == NULL && (filename = _default_history_file()) == NULL)
1383 return history(h, &ev, H_SAVE, filename) == -1 ?
1384 (errno ? errno : EINVAL) : 0;
1388 append_history(int n, const char *filename)
1393 if (h == NULL || e == NULL)
1395 if (filename == NULL && (filename = _default_history_file()) == NULL)
1398 if ((fp = fopen(filename, "a")) == NULL)
1401 if (history(h, &ev, H_NSAVE_FP, (size_t)n, fp) == -1) {
1402 int serrno = errno ? errno : EINVAL;
1411 * returns history ``num''th event
1413 * returned pointer points to static variable
1416 history_get(int num)
1418 static HIST_ENTRY she;
1422 if (h == NULL || e == NULL)
1425 if (num < history_base)
1428 /* save current position */
1429 if (history(h, &ev, H_CURR) != 0)
1434 * use H_DELDATA to set to nth history (without delete) by passing
1435 * (void **)-1 -- as in history_set_pos
1437 if (history(h, &ev, H_DELDATA, num - history_base, (void **)-1) != 0)
1440 /* get current entry */
1441 if (history(h, &ev, H_CURR) != 0)
1443 if (history(h, &ev, H_NEXT_EVDATA, ev.num, &she.data) != 0)
1447 /* restore pointer to where it was */
1448 (void)history(h, &ev, H_SET, curr_num);
1453 /* restore pointer to where it was */
1454 (void)history(h, &ev, H_SET, curr_num);
1460 * add the line to history table
1463 add_history(const char *line)
1467 if (h == NULL || e == NULL)
1470 if (history(h, &ev, H_ENTER, line) == -1)
1473 (void)history(h, &ev, H_GETSIZE);
1474 if (ev.num == history_length)
1478 history_length = ev.num;
1485 * remove the specified entry from the history list and return it.
1488 remove_history(int num)
1493 if (h == NULL || e == NULL)
1496 if ((he = el_malloc(sizeof(*he))) == NULL)
1499 if (history(h, &ev, H_DELDATA, num, &he->data) != 0) {
1505 if (history(h, &ev, H_GETSIZE) == 0)
1506 history_length = ev.num;
1513 * replace the line and data of the num-th entry
1516 replace_history_entry(int num, const char *line, histdata_t data)
1522 if (h == NULL || e == NULL)
1525 /* save current position */
1526 if (history(h, &ev, H_CURR) != 0)
1530 /* start from the oldest */
1531 if (history(h, &ev, H_LAST) != 0)
1532 return NULL; /* error */
1534 if ((he = el_malloc(sizeof(*he))) == NULL)
1537 /* look forwards for event matching specified offset */
1538 if (history(h, &ev, H_NEXT_EVDATA, num, &he->data))
1541 he->line = strdup(ev.str);
1542 if (he->line == NULL)
1545 if (history(h, &ev, H_REPLACE, line, data))
1548 /* restore pointer to where it was */
1549 if (history(h, &ev, H_SET, curr_num))
1559 * clear the history list - delete all entries
1566 if (h == NULL || e == NULL)
1569 (void)history(h, &ev, H_CLEAR);
1570 history_offset = history_length = 0;
1575 * returns offset of the current history event
1580 return history_offset;
1583 static HIST_ENTRY **_history_listp;
1584 static HIST_ENTRY *_history_list;
1590 HIST_ENTRY **nlp, *nl;
1593 if (history(h, &ev, H_LAST) != 0)
1596 if ((nlp = el_realloc(_history_listp,
1597 ((size_t)history_length + 1) * sizeof(*nlp))) == NULL)
1599 _history_listp = nlp;
1601 if ((nl = el_realloc(_history_list,
1602 (size_t)history_length * sizeof(*nl))) == NULL)
1608 _history_listp[i] = &_history_list[i];
1609 _history_list[i].line = ev.str;
1610 _history_list[i].data = NULL;
1611 if (i++ == history_length)
1613 } while (history(h, &ev, H_PREV) == 0);
1614 _history_listp[i] = NULL;
1615 return _history_listp;
1619 * returns current history event or NULL if there is no such event
1622 current_history(void)
1626 if (history(h, &ev, H_PREV_EVENT, history_offset + 1) != 0)
1629 rl_he.line = ev.str;
1636 * returns total number of bytes history events' data are using
1639 history_total_bytes(void)
1645 if (history(h, &ev, H_CURR) != 0)
1649 (void)history(h, &ev, H_FIRST);
1652 size += strlen(ev.str) * sizeof(*ev.str);
1653 while (history(h, &ev, H_NEXT) == 0);
1655 /* get to the same position as before */
1656 history(h, &ev, H_PREV_EVENT, curr_num);
1663 * sets the position in the history list to ``pos''
1666 history_set_pos(int pos)
1668 if (pos >= history_length || pos < 0)
1671 history_offset = pos;
1677 * returns previous event in history and shifts pointer accordingly
1678 * Note that readline and editline define directions in opposite ways.
1681 previous_history(void)
1685 if (history_offset == 0)
1688 if (history(h, &ev, H_LAST) != 0)
1692 return current_history();
1697 * returns next event in history and shifts pointer accordingly
1704 if (history_offset >= history_length)
1707 if (history(h, &ev, H_LAST) != 0)
1711 return current_history();
1716 * searches for first history event containing the str
1719 history_search(const char *str, int direction)
1725 if (history(h, &ev, H_CURR) != 0)
1730 if ((strp = strstr(ev.str, str)) != NULL)
1731 return (int)(strp - ev.str);
1732 if (history(h, &ev, direction < 0 ? H_NEXT:H_PREV) != 0)
1735 (void)history(h, &ev, H_SET, curr_num);
1741 * searches for first history event beginning with str
1744 history_search_prefix(const char *str, int direction)
1748 return (history(h, &ev, direction < 0 ?
1749 H_PREV_STR : H_NEXT_STR, str));
1754 * search for event in history containing str, starting at offset
1755 * abs(pos); continue backward, if pos<0, forward otherwise
1759 history_search_pos(const char *str,
1760 int direction __attribute__((__unused__)), int pos)
1765 off = (pos > 0) ? pos : -pos;
1766 pos = (pos > 0) ? 1 : -1;
1768 if (history(h, &ev, H_CURR) != 0)
1772 if (!history_set_pos(off) || history(h, &ev, H_CURR) != 0)
1776 if (strstr(ev.str, str))
1778 if (history(h, &ev, (pos < 0) ? H_PREV : H_NEXT) != 0)
1782 /* set "current" pointer back to previous state */
1783 (void)history(h, &ev,
1784 pos < 0 ? H_NEXT_EVENT : H_PREV_EVENT, curr_num);
1790 /********************************/
1791 /* completion functions */
1794 tilde_expand(char *name)
1796 return fn_tilde_expand(name);
1800 filename_completion_function(const char *name, int state)
1802 return fn_filename_completion_function(name, state);
1806 * a completion generator for usernames; returns _first_ username
1807 * which starts with supplied text
1808 * text contains a partial username preceded by random character
1809 * (usually '~'); state resets search from start (??? should we do that anyway)
1810 * it's the caller's responsibility to free the returned value
1813 username_completion_function(const char *text, int state)
1815 #if defined(HAVE_GETPW_R_POSIX) || defined(HAVE_GETPW_R_DRAFT)
1816 struct passwd pwres;
1819 struct passwd *pass = NULL;
1821 if (text[0] == '\0')
1831 #if defined(HAVE_GETPW_R_POSIX) || defined(HAVE_GETPW_R_DRAFT)
1832 getpwent_r(&pwres, pwbuf, sizeof(pwbuf), &pass) == 0 && pass != NULL
1834 (pass = getpwent()) != NULL
1836 && text[0] == pass->pw_name[0]
1837 && strcmp(text, pass->pw_name) == 0)
1844 return strdup(pass->pw_name);
1849 * el-compatible wrapper to send TSTP on ^Z
1852 static unsigned char
1853 _el_rl_tstp(EditLine *el __attribute__((__unused__)), int ch __attribute__((__unused__)))
1855 (void)kill(0, SIGTSTP);
1861 _rl_completion_append_character_function(const char *dummy
1862 __attribute__((__unused__)))
1865 buf[0] = (char)rl_completion_append_character;
1872 * Display list of strings in columnar format on readline's output stream.
1873 * 'matches' is list of strings, 'len' is number of strings in 'matches',
1874 * 'max' is maximum length of string in 'matches'.
1877 rl_display_match_list(char **matches, int len, int max)
1880 fn_display_match_list(e, matches, (size_t)len, (size_t)max,
1881 _rl_completion_append_character_function);
1885 * complete word at current point
1889 rl_complete(int ignore __attribute__((__unused__)), int invoking_key)
1891 static ct_buffer_t wbreak_conv, sprefix_conv;
1892 const char *breakchars;
1894 if (h == NULL || e == NULL)
1897 if (rl_inhibit_completion) {
1899 arr[0] = (char)invoking_key;
1901 el_insertstr(e, arr);
1905 if (rl_completion_word_break_hook != NULL)
1906 breakchars = (*rl_completion_word_break_hook)();
1908 breakchars = rl_basic_word_break_characters;
1912 /* Just look at how many global variables modify this operation! */
1913 return fn_complete(e,
1914 (rl_compentry_func_t *)rl_completion_entry_function,
1915 rl_attempted_completion_function,
1916 ct_decode_string(rl_basic_word_break_characters, &wbreak_conv),
1917 ct_decode_string(breakchars, &sprefix_conv),
1918 _rl_completion_append_character_function,
1919 (size_t)rl_completion_query_items,
1920 &rl_completion_type, &rl_attempted_completion_over,
1921 &rl_point, &rl_end);
1928 static unsigned char
1929 _el_rl_complete(EditLine *el __attribute__((__unused__)), int ch)
1931 return (unsigned char)rl_complete(0, ch);
1935 * misc other functions
1939 * bind key c to readline-type function func
1942 rl_bind_key(int c, rl_command_func_t *func)
1946 if (h == NULL || e == NULL)
1949 if (func == rl_insert) {
1950 /* XXX notice there is no range checking of ``c'' */
1951 e->el_map.key[c] = ED_INSERT;
1959 * read one key from input - handles chars pushed back
1960 * to input stream also
1965 char fooarr[2 * sizeof(int)];
1967 if (e == NULL || h == NULL)
1970 return el_getc(e, fooarr);
1975 * reset the terminal
1979 rl_reset_terminal(const char *p __attribute__((__unused__)))
1982 if (h == NULL || e == NULL)
1990 * insert character ``c'' back into input stream, ``count'' times
1993 rl_insert(int count, int c)
1997 if (h == NULL || e == NULL)
2000 /* XXX - int -> char conversion can lose on multichars */
2004 for (; count > 0; count--)
2011 rl_insert_text(const char *text)
2013 if (!text || *text == 0)
2016 if (h == NULL || e == NULL)
2019 if (el_insertstr(e, text) < 0)
2021 return (int)strlen(text);
2026 rl_newline(int count __attribute__((__unused__)),
2027 int c __attribute__((__unused__)))
2030 * Readline-4.0 appears to ignore the args.
2032 return rl_insert(1, '\n');
2036 static unsigned char
2037 rl_bind_wrapper(EditLine *el __attribute__((__unused__)), unsigned char c)
2046 /* If rl_done was set by the above call, deal with it here */
2054 rl_add_defun(const char *name, rl_command_func_t *fun, int c)
2057 if ((size_t)c >= sizeof(map) / sizeof(map[0]) || c < 0)
2059 map[(unsigned char)c] = fun;
2060 el_set(e, EL_ADDFN, name, name, rl_bind_wrapper);
2061 vis(dest, c, VIS_WHITE|VIS_NOSLASH, 0);
2062 el_set(e, EL_BIND, dest, name, NULL);
2067 rl_callback_read_char(void)
2069 int count = 0, done = 0;
2070 const char *buf = el_gets(e, &count);
2073 if (buf == NULL || count-- <= 0)
2075 if (count == 0 && buf[0] == e->el_tty.t_c[TS_IO][C_EOF])
2077 if (buf[count] == '\n' || buf[count] == '\r')
2080 if (done && rl_linefunc != NULL) {
2081 el_set(e, EL_UNBUFFERED, 0);
2083 if ((wbuf = strdup(buf)) != NULL)
2087 (*(void (*)(const char *))rl_linefunc)(wbuf);
2088 el_set(e, EL_UNBUFFERED, 1);
2093 rl_callback_handler_install(const char *prompt, rl_vcpfunc_t *linefunc)
2098 (void)rl_set_prompt(prompt);
2099 rl_linefunc = linefunc;
2100 el_set(e, EL_UNBUFFERED, 1);
2104 rl_callback_handler_remove(void)
2115 a[0] = (char)e->el_tty.t_c[TS_IO][C_REPRINT];
2121 rl_get_previous_history(int count, int key)
2133 rl_prep_terminal(int meta_flag __attribute__((__unused__)))
2135 el_set(e, EL_PREP_TERM, 1);
2139 rl_deprep_terminal(void)
2141 el_set(e, EL_PREP_TERM, 0);
2145 rl_read_init_file(const char *s)
2147 return el_source(e, s);
2151 rl_parse_and_bind(const char *line)
2157 tok = tok_init(NULL);
2158 tok_str(tok, line, &argc, &argv);
2159 argc = el_parse(e, argc, argv);
2161 return argc ? 1 : 0;
2165 rl_variable_bind(const char *var, const char *value)
2168 * The proper return value is undocument, but this is what the
2169 * readline source seems to do.
2171 return el_set(e, EL_BIND, "", var, value, NULL) == -1 ? 1 : 0;
2175 rl_stuff_char(int c)
2181 el_insertstr(e, buf);
2186 _rl_event_read_char(EditLine *el, wchar_t *wc)
2190 ssize_t num_read = 0;
2194 while (rl_event_hook) {
2198 #if defined(FIONREAD)
2199 if (ioctl(el->el_infd, FIONREAD, &n) < 0)
2202 num_read = read(el->el_infd, &ch, (size_t)1);
2205 #elif defined(F_SETFL) && defined(O_NDELAY)
2206 if ((n = fcntl(el->el_infd, F_GETFL, 0)) < 0)
2208 if (fcntl(el->el_infd, F_SETFL, n|O_NDELAY) < 0)
2210 num_read = read(el->el_infd, &ch, 1);
2211 if (fcntl(el->el_infd, F_SETFL, n))
2214 /* not non-blocking, but what you gonna do? */
2215 num_read = read(el->el_infd, &ch, 1);
2219 if (num_read < 0 && errno == EAGAIN)
2226 el_set(el, EL_GETCFN, EL_BUILTIN_GETCFN);
2228 return (int)num_read;
2232 _rl_update_pos(void)
2234 const LineInfo *li = el_line(e);
2236 rl_point = (int)(li->cursor - li->buffer);
2237 rl_end = (int)(li->lastchar - li->buffer);
2238 rl_line_buffer[rl_end] = '\0';
2242 rl_get_screen_size(int *rows, int *cols)
2245 el_get(e, EL_GETTC, "li", rows);
2247 el_get(e, EL_GETTC, "co", cols);
2251 rl_set_screen_size(int rows, int cols)
2254 (void)snprintf(buf, sizeof(buf), "%d", rows);
2255 el_set(e, EL_SETTC, "li", buf, NULL);
2256 (void)snprintf(buf, sizeof(buf), "%d", cols);
2257 el_set(e, EL_SETTC, "co", buf, NULL);
2261 rl_completion_matches(const char *str, rl_compentry_func_t *fun)
2263 size_t len, max, i, j, min;
2264 char **list, *match, *a, *b;
2268 if ((list = el_calloc(max, sizeof(*list))) == NULL)
2271 while ((match = (*fun)(str, (int)(len - 1))) != NULL) {
2272 list[len++] = match;
2276 if ((nl = el_realloc(list, max * sizeof(*nl))) == NULL)
2285 if ((list[0] = strdup(list[1])) == NULL)
2289 qsort(&list[1], len - 1, sizeof(*list),
2290 (int (*)(const void *, const void *)) strcmp);
2292 for (i = 1, a = list[i]; i < len - 1; i++, a = b) {
2294 for (j = 0; a[j] && a[j] == b[j]; j++)
2299 if (min == 0 && *str) {
2300 if ((list[0] = strdup(str)) == NULL)
2303 if ((list[0] = el_calloc(min + 1, sizeof(*list[0]))) == NULL)
2305 (void)memcpy(list[0], list[1], min);
2306 list[0][min] = '\0';
2316 rl_filename_completion_function (const char *text, int state)
2318 return fn_filename_completion_function(text, state);
2322 rl_forced_update_display(void)
2324 el_set(e, EL_REFRESH);
2328 _rl_abort_internal(void)
2336 _rl_qsort_string_compare(char **s1, char **s2)
2338 return strcoll(*s1, *s2);
2342 history_get_history_state(void)
2346 if ((hs = el_malloc(sizeof(*hs))) == NULL)
2348 hs->length = history_length;
2354 rl_kill_text(int from __attribute__((__unused__)),
2355 int to __attribute__((__unused__)))
2361 rl_make_bare_keymap(void)
2374 rl_set_keymap(Keymap k __attribute__((__unused__)))
2380 rl_generic_bind(int type __attribute__((__unused__)),
2381 const char * keyseq __attribute__((__unused__)),
2382 const char * data __attribute__((__unused__)),
2383 Keymap k __attribute__((__unused__)))
2390 rl_bind_key_in_map(int key __attribute__((__unused__)),
2391 rl_command_func_t *fun __attribute__((__unused__)),
2392 Keymap k __attribute__((__unused__)))
2397 /* unsupported, but needed by python */
2399 rl_cleanup_after_signal(void)
2404 rl_on_new_line(void)
2410 rl_free_line_state(void)
2416 rl_set_keyboard_input_timeout(int u __attribute__((__unused__)))
2422 rl_resize_terminal(void)
2428 rl_reset_after_signal(void)
2430 if (rl_prep_term_function)
2431 (*rl_prep_term_function)();
2435 rl_echo_signal_char(int sig)
2437 int c = tty_get_signal_character(e, sig);