1 /* linenoise.c -- guerrilla line editing library against the idea that a
2 * line editing lib needs to be 20,000 lines of C code.
4 * You can find the latest source code at:
6 * http://github.com/msteveb/linenoise
7 * (forked from http://github.com/antirez/linenoise)
9 * Does a number of crazy assumptions that happen to be true in 99.9999% of
10 * the 2010 UNIX computers around.
12 * ------------------------------------------------------------------------
14 * Copyright (c) 2010, Salvatore Sanfilippo <antirez at gmail dot com>
15 * Copyright (c) 2010, Pieter Noordhuis <pcnoordhuis at gmail dot com>
16 * Copyright (c) 2011, Steve Bennett <steveb at workware dot net dot au>
18 * All rights reserved.
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions are
24 * * Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
27 * * Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 * ------------------------------------------------------------------------
46 * - http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
47 * - http://www.3waylabs.com/nw/WWW/products/wizcon/vt220.html
54 * List of escape sequences used by this program, we do everything just
55 * a few sequences. In order to be so cheap we may have some
56 * flickering effect with some slow terminal, but the lesser sequences
57 * the more compatible.
61 * Effect: if n is 0 or missing, clear from cursor to end of line
62 * Effect: if n is 1, clear from beginning of line to cursor
63 * Effect: if n is 2, clear entire line
65 * CUF (CUrsor Forward)
67 * Effect: moves cursor forward of n chars
69 * CR (Carriage Return)
71 * Effect: moves cursor to column 1
73 * The following are used to clear the screen: ESC [ H ESC [ 2 J
74 * This is actually composed of two sequences:
78 * Effect: moves the cursor to upper left corner
80 * ED2 (Clear entire screen)
82 * Effect: clear the whole screen
84 * == For highlighting control characters, we also use the following two ==
87 * Effect: Uses some standout mode such as reverse video
91 * Effect: Exit standout mode
93 * == Only used if TIOCGWINSZ fails ==
94 * DSR/CPR (Report cursor position)
96 * Effect: reports current cursor position as ESC [ NNN ; MMM R
100 * If __MINGW32__ is defined, the win32 console API is used.
101 * This could probably be made to work for the msvc compiler too.
102 * This support based in part on work by Jon Griffiths.
105 #ifdef _WIN32 /* Windows platform, either MinGW or Visual Studio (MSVC) */
108 #define USE_WINCONSOLE
110 #define HAVE_UNISTD_H
112 /* Microsoft headers don't like old POSIX names */
113 #define strdup _strdup
114 #define snprintf _snprintf
118 #include <sys/ioctl.h>
119 #include <sys/poll.h>
121 #define HAVE_UNISTD_H
133 #include <sys/types.h>
135 #include "linenoise.h"
138 #define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100
139 #define LINENOISE_MAX_LINE 4096
141 #define ctrl(C) ((C) - '@')
143 /* Use -ve numbers here to co-exist with normal unicode chars */
150 SPECIAL_DELETE = -24,
153 SPECIAL_INSERT = -27,
154 SPECIAL_PAGE_UP = -28,
155 SPECIAL_PAGE_DOWN = -29
158 static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
159 static int history_len = 0;
160 static char **history = NULL;
162 /* Structure to contain the status of the current (being edited) line */
164 char *buf; /* Current buffer. Always null terminated */
165 int bufmax; /* Size of the buffer, including space for the null termination */
166 int len; /* Number of bytes in 'buf' */
167 int chars; /* Number of chars in 'buf' (utf-8 chars) */
168 int pos; /* Cursor position, measured in chars */
169 int cols; /* Size of the window, in chars */
171 char *capture; /* Allocated capture buffer, or NULL for none. Always null terminated */
172 #if defined(USE_TERMIOS)
173 int fd; /* Terminal fd */
174 #elif defined(USE_WINCONSOLE)
175 HANDLE outh; /* Console output handle */
176 HANDLE inh; /* Console input handle */
177 int rows; /* Screen rows */
178 int x; /* Current column during output */
179 int y; /* Current row */
183 static int fd_read(struct current *current);
184 static int getWindowSize(struct current *current);
186 void linenoiseHistoryFree(void) {
190 for (j = 0; j < history_len; j++)
198 #if defined(USE_TERMIOS)
199 static void linenoiseAtExit(void);
200 static struct termios orig_termios; /* in order to restore at exit */
201 static int rawmode = 0; /* for atexit() function to check if restore is needed*/
202 static int atexit_registered = 0; /* register atexit just 1 time */
204 static const char *unsupported_term[] = {"dumb","cons25",NULL};
206 static int isUnsupportedTerm(void) {
207 char *term = getenv("TERM");
211 for (j = 0; unsupported_term[j]; j++) {
212 if (strcasecmp(term, unsupported_term[j]) == 0) {
220 static int enableRawMode(struct current *current) {
223 current->fd = STDIN_FILENO;
225 if (!isatty(current->fd) || isUnsupportedTerm() ||
226 tcgetattr(current->fd, &orig_termios) == -1) {
232 if (!atexit_registered) {
233 atexit(linenoiseAtExit);
234 atexit_registered = 1;
237 raw = orig_termios; /* modify the original mode */
238 /* input modes: no break, no CR to NL, no parity check, no strip char,
239 * no start/stop output control. */
240 raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
241 /* output modes - disable post processing */
242 raw.c_oflag &= ~(OPOST);
243 /* control modes - set 8 bit chars */
244 raw.c_cflag |= (CS8);
245 /* local modes - choing off, canonical off, no extended functions,
246 * no signal chars (^Z,^C) */
247 raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
248 /* control chars - set return condition: min number of bytes and timer.
249 * We want read to return every single byte, without timeout. */
250 raw.c_cc[VMIN] = 1; raw.c_cc[VTIME] = 0; /* 1 byte, no timer */
252 /* put terminal in raw mode after flushing */
253 if (tcsetattr(current->fd,TCSADRAIN,&raw) < 0) {
262 static void disableRawMode(struct current *current) {
263 /* Don't even check the return value as it's too late. */
264 if (rawmode && tcsetattr(current->fd,TCSADRAIN,&orig_termios) != -1)
268 /* At exit we'll try to fix the terminal to the initial conditions. */
269 static void linenoiseAtExit(void) {
271 tcsetattr(STDIN_FILENO, TCSADRAIN, &orig_termios);
273 linenoiseHistoryFree();
276 /* gcc/glibc insists that we care about the return code of write!
277 * Clarification: This means that a void-cast like "(void) (EXPR)"
280 #define IGNORE_RC(EXPR) if (EXPR) {}
282 /* This is fdprintf() on some systems, but use a different
283 * name to avoid conflicts
285 static void fd_printf(int fd, const char *format, ...)
291 va_start(args, format);
292 n = vsnprintf(buf, sizeof(buf), format, args);
294 IGNORE_RC(write(fd, buf, n));
297 static void clearScreen(struct current *current)
299 fd_printf(current->fd, "\x1b[H\x1b[2J");
302 static void cursorToLeft(struct current *current)
304 fd_printf(current->fd, "\r");
307 static int outputChars(struct current *current, const char *buf, int len)
309 return write(current->fd, buf, len);
312 static void outputControlChar(struct current *current, char ch)
314 fd_printf(current->fd, "\x1b[7m^%c\x1b[0m", ch);
317 static void eraseEol(struct current *current)
319 fd_printf(current->fd, "\x1b[0K");
322 static void setCursorPos(struct current *current, int x)
324 fd_printf(current->fd, "\r\x1b[%dC", x);
328 * Reads a char from 'fd', waiting at most 'timeout' milliseconds.
330 * A timeout of -1 means to wait forever.
332 * Returns -1 if no char is received within the time or an error occurs.
334 static int fd_read_char(int fd, int timeout)
342 if (poll(&p, 1, timeout) == 0) {
346 if (read(fd, &c, 1) != 1) {
353 * Reads a complete utf-8 character
354 * and returns the unicode value, or -1 on error.
356 static int fd_read(struct current *current)
364 if (read(current->fd, &buf[0], 1) != 1) {
367 n = utf8_charlen(buf[0]);
368 if (n < 1 || n > 3) {
371 for (i = 1; i < n; i++) {
372 if (read(current->fd, &buf[i], 1) != 1) {
377 /* decode and return the character */
378 utf8_tounicode(buf, &c);
381 return fd_read_char(current->fd, -1);
385 static int countColorControlChars(const char* prompt, int plen)
387 /* ANSI color control sequences have the form:
388 * "\x1b" "[" [0-9;]+ "m"
389 * We parse them with a simple state machine.
397 } state = search_esc;
401 /* XXX: Strictly we should be checking utf8 chars rather than
402 * bytes in case of the extremely unlikely scenario where
403 * an ANSI sequence is part of a utf8 sequence.
405 for (; plen ; plen--, prompt++) {
412 state = expect_bracket;
418 state = expect_inner;
425 if (ch >= '0' && ch <= '9') {
427 state = expect_trail;
437 } else if ((ch != ';') && ((ch < '0') || (ch > '9'))) {
440 /* 0-9, or semicolon */
449 static int getWindowSize(struct current *current)
453 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
454 current->cols = ws.ws_col;
458 /* Failed to query the window size. Perhaps we are on a serial terminal.
459 * Try to query the width by sending the cursor as far to the right
460 * and reading back the cursor position.
461 * Note that this is only done once per call to linenoise rather than
462 * every time the line is refreshed for efficiency reasons.
464 if (current->cols == 0) {
467 /* Move cursor far right and report cursor position, then back to the left */
468 fd_printf(current->fd, "\x1b[999C" "\x1b[6n");
470 /* Parse the response: ESC [ rows ; cols R */
471 if (fd_read_char(current->fd, 100) == 0x1b && fd_read_char(current->fd, 100) == '[') {
474 int ch = fd_read_char(current->fd, 100);
479 else if (ch == 'R') {
481 if (n != 0 && n < 1000) {
486 else if (ch >= 0 && ch <= '9') {
487 n = n * 10 + ch - '0';
499 * If escape (27) was received, reads subsequent
500 * chars to determine if this is a known special key.
502 * Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
504 * If no additional char is received within a short time,
507 static int check_special(int fd)
509 int c = fd_read_char(fd, 50);
516 c2 = fd_read_char(fd, 50);
520 if (c == '[' || c == 'O') {
521 /* Potential arrow key */
528 return SPECIAL_RIGHT;
537 if (c == '[' && c2 >= '1' && c2 <= '8') {
538 /* extended escape */
539 c = fd_read_char(fd, 50);
543 return SPECIAL_INSERT;
545 return SPECIAL_DELETE;
547 return SPECIAL_PAGE_UP;
549 return SPECIAL_PAGE_DOWN;
556 while (c != -1 && c != '~') {
557 /* .e.g \e[12~ or '\e[11;2~ discard the complete sequence */
558 c = fd_read_char(fd, 50);
564 #elif defined(USE_WINCONSOLE)
566 static DWORD orig_consolemode = 0;
568 static int enableRawMode(struct current *current) {
572 current->outh = GetStdHandle(STD_OUTPUT_HANDLE);
573 current->inh = GetStdHandle(STD_INPUT_HANDLE);
575 if (!PeekConsoleInput(current->inh, &irec, 1, &n)) {
578 if (getWindowSize(current) != 0) {
581 if (GetConsoleMode(current->inh, &orig_consolemode)) {
582 SetConsoleMode(current->inh, ENABLE_PROCESSED_INPUT);
587 static void disableRawMode(struct current *current)
589 SetConsoleMode(current->inh, orig_consolemode);
592 static void clearScreen(struct current *current)
594 COORD topleft = { 0, 0 };
597 FillConsoleOutputCharacter(current->outh, ' ',
598 current->cols * current->rows, topleft, &n);
599 FillConsoleOutputAttribute(current->outh,
600 FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN,
601 current->cols * current->rows, topleft, &n);
602 SetConsoleCursorPosition(current->outh, topleft);
605 static void cursorToLeft(struct current *current)
607 COORD pos = { 0, (SHORT)current->y };
610 FillConsoleOutputAttribute(current->outh,
611 FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN, current->cols, pos, &n);
615 static int outputChars(struct current *current, const char *buf, int len)
617 COORD pos = { (SHORT)current->x, (SHORT)current->y };
620 WriteConsoleOutputCharacter(current->outh, buf, len, pos, &n);
625 static void outputControlChar(struct current *current, char ch)
627 COORD pos = { (SHORT)current->x, (SHORT)current->y };
630 FillConsoleOutputAttribute(current->outh, BACKGROUND_INTENSITY, 2, pos, &n);
631 outputChars(current, "^", 1);
632 outputChars(current, &ch, 1);
635 static void eraseEol(struct current *current)
637 COORD pos = { (SHORT)current->x, (SHORT)current->y };
640 FillConsoleOutputCharacter(current->outh, ' ', current->cols - current->x, pos, &n);
643 static void setCursorPos(struct current *current, int x)
645 COORD pos = { (SHORT)x, (SHORT)current->y };
647 SetConsoleCursorPosition(current->outh, pos);
651 static int fd_read(struct current *current)
656 if (WaitForSingleObject(current->inh, INFINITE) != WAIT_OBJECT_0) {
659 if (!ReadConsoleInput (current->inh, &irec, 1, &n)) {
662 if (irec.EventType == KEY_EVENT && irec.Event.KeyEvent.bKeyDown) {
663 KEY_EVENT_RECORD *k = &irec.Event.KeyEvent;
664 if (k->dwControlKeyState & ENHANCED_KEY) {
665 switch (k->wVirtualKeyCode) {
669 return SPECIAL_RIGHT;
675 return SPECIAL_INSERT;
677 return SPECIAL_DELETE;
683 return SPECIAL_PAGE_UP;
685 return SPECIAL_PAGE_DOWN;
688 /* Note that control characters are already translated in AsciiChar */
691 return k->uChar.UnicodeChar;
693 return k->uChar.AsciiChar;
701 static int countColorControlChars(char* prompt, int plen)
703 /* For windows we assume that there are no embedded ansi color
709 static int getWindowSize(struct current *current)
711 CONSOLE_SCREEN_BUFFER_INFO info;
712 if (!GetConsoleScreenBufferInfo(current->outh, &info)) {
715 current->cols = info.dwSize.X;
716 current->rows = info.dwSize.Y;
717 if (current->cols <= 0 || current->rows <= 0) {
721 current->y = info.dwCursorPosition.Y;
722 current->x = info.dwCursorPosition.X;
727 static int utf8_getchars(char *buf, int c)
730 return utf8_fromunicode(buf, c);
738 * Returns the unicode character at the given offset,
741 static int get_char(struct current *current, int pos)
743 if (pos >= 0 && pos < current->chars) {
745 int i = utf8_index(current->buf, pos);
746 (void)utf8_tounicode(current->buf + i, &c);
752 static void refreshLine(const char *prompt, struct current *current)
758 const char *buf = current->buf;
759 int chars = current->chars;
760 int pos = current->pos;
765 /* Should intercept SIGWINCH. For now, just get the size every time */
766 getWindowSize(current);
768 plen = strlen(prompt);
769 pchars = utf8_strlen(prompt, plen);
771 /* Scan the prompt for embedded ansi color control sequences and
772 * discount them as characters/columns.
774 pchars -= countColorControlChars(prompt, plen);
776 /* Account for a line which is too long to fit in the window.
777 * Note that control chars require an extra column
780 /* How many cols are required to the left of 'pos'?
781 * The prompt, plus one extra for each control char
783 n = pchars + utf8_strlen(buf, current->len);
785 for (i = 0; i < pos; i++) {
786 b += utf8_tounicode(buf + b, &ch);
792 /* If too many are needed, strip chars off the front of 'buf'
793 * until it fits. Note that if the current char is a control character,
794 * we need one extra col.
796 if (current->pos < current->chars && get_char(current, current->pos) < ' ') {
800 while (n >= current->cols && pos > 0) {
801 b = utf8_tounicode(buf, &ch);
811 /* Cursor to left edge, then the prompt */
812 cursorToLeft(current);
813 outputChars(current, prompt, plen);
815 /* Now the current buffer content */
817 /* Need special handling for control characters.
818 * If we hit 'cols', stop.
820 b = 0; /* unwritted bytes */
821 n = 0; /* How many control chars were written */
822 for (i = 0; i < chars; i++) {
824 int w = utf8_tounicode(buf + b, &ch);
828 if (pchars + i + n >= current->cols) {
832 /* A control character, so write the buffer so far */
833 outputChars(current, buf, b);
836 outputControlChar(current, ch + '@');
845 outputChars(current, buf, b);
847 /* Erase to right, move cursor to original position */
849 setCursorPos(current, pos + pchars + backup);
852 static void set_current(struct current *current, const char *str)
854 strncpy(current->buf, str, current->bufmax);
855 current->buf[current->bufmax - 1] = 0;
856 current->len = strlen(current->buf);
857 current->pos = current->chars = utf8_strlen(current->buf, current->len);
860 static int has_room(struct current *current, int bytes)
862 return current->len + bytes < current->bufmax - 1;
866 * Removes the char at 'pos'.
868 * Returns 1 if the line needs to be refreshed, 2 if not
869 * and 0 if nothing was removed
871 static int remove_char(struct current *current, int pos)
873 if (pos >= 0 && pos < current->chars) {
876 p1 = utf8_index(current->buf, pos);
877 p2 = p1 + utf8_index(current->buf + p1, 1);
880 /* optimise remove char in the case of removing the last char */
881 if (current->pos == pos + 1 && current->pos == current->chars) {
882 if (current->buf[pos] >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
884 fd_printf(current->fd, "\b \b");
889 /* Move the null char too */
890 memmove(current->buf + p1, current->buf + p2, current->len - p2 + 1);
891 current->len -= (p2 - p1);
894 if (current->pos > pos) {
903 * Insert 'ch' at position 'pos'
905 * Returns 1 if the line needs to be refreshed, 2 if not
906 * and 0 if nothing was inserted (no room)
908 static int insert_char(struct current *current, int pos, int ch)
911 int n = utf8_getchars(buf, ch);
913 if (has_room(current, n) && pos >= 0 && pos <= current->chars) {
916 p1 = utf8_index(current->buf, pos);
920 /* optimise the case where adding a single char to the end and no scrolling is needed */
921 if (current->pos == pos && current->chars == pos) {
922 if (ch >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
923 IGNORE_RC(write(current->fd, buf, n));
929 memmove(current->buf + p2, current->buf + p1, current->len - p1);
930 memcpy(current->buf + p1, buf, n);
934 if (current->pos >= pos) {
943 * Captures up to 'n' characters starting at 'pos' for the cut buffer.
945 * This replaces any existing characters in the cut buffer.
947 static void capture_chars(struct current *current, int pos, int n)
949 if (pos >= 0 && (pos + n - 1) < current->chars) {
950 int p1 = utf8_index(current->buf, pos);
951 int nbytes = utf8_index(current->buf + p1, n);
954 free(current->capture);
955 /* Include space for the null terminator */
956 current->capture = (char *)malloc(nbytes + 1);
957 memcpy(current->capture, current->buf + p1, nbytes);
958 current->capture[nbytes] = '\0';
964 * Removes up to 'n' characters at cursor position 'pos'.
966 * Returns 0 if no chars were removed or non-zero otherwise.
968 static int remove_chars(struct current *current, int pos, int n)
972 /* First save any chars which will be removed */
973 capture_chars(current, pos, n);
975 while (n-- && remove_char(current, pos)) {
981 * Inserts the characters (string) 'chars' at the cursor position 'pos'.
983 * Returns 0 if no chars were inserted or non-zero otherwise.
985 static int insert_chars(struct current *current, int pos, const char *chars)
991 int n = utf8_tounicode(chars, &ch);
992 if (insert_char(current, pos, ch) == 0) {
1002 #ifndef NO_COMPLETION
1003 static linenoiseCompletionCallback *completionCallback = NULL;
1005 static void beep() {
1007 fprintf(stderr, "\x7");
1012 static void freeCompletions(linenoiseCompletions *lc) {
1014 for (i = 0; i < lc->len; i++)
1019 static int completeLine(struct current *current) {
1020 linenoiseCompletions lc = { 0, NULL };
1023 completionCallback(current->buf,&lc);
1027 size_t stop = 0, i = 0;
1030 /* Show completion or original buffer */
1032 struct current tmp = *current;
1033 tmp.buf = lc.cvec[i];
1034 tmp.pos = tmp.len = strlen(tmp.buf);
1035 tmp.chars = utf8_strlen(tmp.buf, tmp.len);
1036 refreshLine(current->prompt, &tmp);
1038 refreshLine(current->prompt, current);
1041 c = fd_read(current);
1047 case '\t': /* tab */
1048 i = (i+1) % (lc.len+1);
1049 if (i == lc.len) beep();
1051 case 27: /* escape */
1052 /* Re-show original buffer */
1054 refreshLine(current->prompt, current);
1059 /* Update buffer and return */
1061 set_current(current,lc.cvec[i]);
1069 freeCompletions(&lc);
1070 return c; /* Return last read character */
1073 /* Register a callback function to be called for tab-completion. */
1074 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) {
1075 completionCallback = fn;
1078 void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
1079 lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
1080 lc->cvec[lc->len++] = strdup(str);
1085 static int linenoiseEdit(struct current *current) {
1086 int history_index = 0;
1088 /* The latest history entry is always our current buffer, that
1089 * initially is just an empty string. */
1090 linenoiseHistoryAdd("");
1092 set_current(current, "");
1093 refreshLine(current->prompt, current);
1097 int c = fd_read(current);
1099 #ifndef NO_COMPLETION
1100 /* Only autocomplete when the callback is set. It returns < 0 when
1101 * there was an error reading from fd. Otherwise it will return the
1102 * character that should be handled next. */
1103 if (c == '\t' && current->pos == current->chars && completionCallback != NULL) {
1104 c = completeLine(current);
1105 /* Return on errors */
1106 if (c < 0) return current->len;
1107 /* Read next character when 0 */
1108 if (c == 0) continue;
1113 if (c == -1) return current->len;
1115 if (c == 27) { /* escape sequence */
1116 c = check_special(current->fd);
1120 case '\r': /* enter */
1122 free(history[history_len]);
1123 return current->len;
1124 case ctrl('C'): /* ctrl-c */
1127 case 127: /* backspace */
1129 if (remove_char(current, current->pos - 1) == 1) {
1130 refreshLine(current->prompt, current);
1133 case ctrl('D'): /* ctrl-d */
1134 if (current->len == 0) {
1135 /* Empty line, so EOF */
1137 free(history[history_len]);
1140 /* Otherwise fall through to delete char to right of cursor */
1141 case SPECIAL_DELETE:
1142 if (remove_char(current, current->pos) == 1) {
1143 refreshLine(current->prompt, current);
1146 case SPECIAL_INSERT:
1147 /* Ignore. Expansion Hook.
1148 * Future possibility: Toggle Insert/Overwrite Modes
1151 case ctrl('W'): /* ctrl-w, delete word at left. save deleted chars */
1152 /* eat any spaces on the left */
1154 int pos = current->pos;
1155 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1159 /* now eat any non-spaces on the left */
1160 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1164 if (remove_chars(current, pos, current->pos - pos)) {
1165 refreshLine(current->prompt, current);
1169 case ctrl('R'): /* ctrl-r */
1171 /* Display the reverse-i-search prompt and process chars */
1176 int searchpos = history_len - 1;
1181 const char *p = NULL;
1185 snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
1186 refreshLine(rprompt, current);
1187 c = fd_read(current);
1188 if (c == ctrl('H') || c == 127) {
1190 int p = utf8_index(rbuf, --rchars);
1192 rlen = strlen(rbuf);
1198 c = check_special(current->fd);
1201 if (c == ctrl('P') || c == SPECIAL_UP) {
1202 /* Search for the previous (earlier) match */
1203 if (searchpos > 0) {
1208 else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1209 /* Search for the next (later) match */
1210 if (searchpos < history_len) {
1216 else if (c >= ' ') {
1217 if (rlen >= (int)sizeof(rbuf) + 3) {
1221 n = utf8_getchars(rbuf + rlen, c);
1226 /* Adding a new char resets the search location */
1227 searchpos = history_len - 1;
1230 /* Exit from incremental search mode */
1234 /* Now search through the history for a match */
1235 for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1236 p = strstr(history[searchpos], rbuf);
1239 if (skipsame && strcmp(history[searchpos], current->buf) == 0) {
1240 /* But it is identical, so skip it */
1243 /* Copy the matching line and set the cursor position */
1244 set_current(current,history[searchpos]);
1245 current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
1250 /* No match, so don't add it */
1256 if (c == ctrl('G') || c == ctrl('C')) {
1257 /* ctrl-g terminates the search with no effect */
1258 set_current(current, "");
1261 else if (c == ctrl('J')) {
1262 /* ctrl-j terminates the search leaving the buffer in place */
1265 /* Go process the char normally */
1266 refreshLine(current->prompt, current);
1270 case ctrl('T'): /* ctrl-t */
1271 if (current->pos > 0 && current->pos <= current->chars) {
1272 /* If cursor is at end, transpose the previous two chars */
1273 int fixer = (current->pos == current->chars);
1274 c = get_char(current, current->pos - fixer);
1275 remove_char(current, current->pos - fixer);
1276 insert_char(current, current->pos - 1, c);
1277 refreshLine(current->prompt, current);
1280 case ctrl('V'): /* ctrl-v */
1281 if (has_room(current, 3)) {
1282 /* Insert the ^V first */
1283 if (insert_char(current, current->pos, c)) {
1284 refreshLine(current->prompt, current);
1285 /* Now wait for the next char. Can insert anything except \0 */
1286 c = fd_read(current);
1288 /* Remove the ^V first */
1289 remove_char(current, current->pos - 1);
1291 /* Insert the actual char */
1292 insert_char(current, current->pos, c);
1294 refreshLine(current->prompt, current);
1300 if (current->pos > 0) {
1302 refreshLine(current->prompt, current);
1307 if (current->pos < current->chars) {
1309 refreshLine(current->prompt, current);
1312 case SPECIAL_PAGE_UP:
1313 dir = history_len - history_index - 1; /* move to start of history */
1314 goto history_navigation;
1315 case SPECIAL_PAGE_DOWN:
1316 dir = -history_index; /* move to 0 == end of history, i.e. current */
1317 goto history_navigation;
1321 goto history_navigation;
1325 if (history_len > 1) {
1326 /* Update the current history entry before to
1327 * overwrite it with tne next one. */
1328 free(history[history_len - 1 - history_index]);
1329 history[history_len - 1 - history_index] = strdup(current->buf);
1330 /* Show the new entry */
1331 history_index += dir;
1332 if (history_index < 0) {
1335 } else if (history_index >= history_len) {
1336 history_index = history_len - 1;
1339 set_current(current, history[history_len - 1 - history_index]);
1340 refreshLine(current->prompt, current);
1343 case ctrl('A'): /* Ctrl+a, go to the start of the line */
1346 refreshLine(current->prompt, current);
1348 case ctrl('E'): /* ctrl+e, go to the end of the line */
1350 current->pos = current->chars;
1351 refreshLine(current->prompt, current);
1353 case ctrl('U'): /* Ctrl+u, delete to beginning of line, save deleted chars. */
1354 if (remove_chars(current, 0, current->pos)) {
1355 refreshLine(current->prompt, current);
1358 case ctrl('K'): /* Ctrl+k, delete from current to end of line, save deleted chars. */
1359 if (remove_chars(current, current->pos, current->chars - current->pos)) {
1360 refreshLine(current->prompt, current);
1363 case ctrl('Y'): /* Ctrl+y, insert saved chars at current position */
1364 if (current->capture && insert_chars(current, current->pos, current->capture)) {
1365 refreshLine(current->prompt, current);
1368 case ctrl('L'): /* Ctrl+L, clear screen */
1369 clearScreen(current);
1370 /* Force recalc of window size for serial terminals */
1372 refreshLine(current->prompt, current);
1375 /* Only tab is allowed without ^V */
1376 if (c == '\t' || c >= ' ') {
1377 if (insert_char(current, current->pos, c) == 1) {
1378 refreshLine(current->prompt, current);
1384 return current->len;
1387 int linenoiseColumns(void)
1389 struct current current;
1390 enableRawMode (¤t);
1391 getWindowSize (¤t);
1392 disableRawMode (¤t);
1393 return current.cols;
1396 char *linenoise(const char *prompt)
1399 struct current current;
1400 char buf[LINENOISE_MAX_LINE];
1402 if (enableRawMode(¤t) == -1) {
1403 printf("%s", prompt);
1405 if (fgets(buf, sizeof(buf), stdin) == NULL) {
1408 count = strlen(buf);
1409 if (count && buf[count-1] == '\n') {
1417 current.bufmax = sizeof(buf);
1421 current.prompt = prompt;
1422 current.capture = NULL;
1424 count = linenoiseEdit(¤t);
1426 disableRawMode(¤t);
1429 free(current.capture);
1437 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1438 int linenoiseHistoryAdd(const char *line) {
1441 if (history_max_len == 0) return 0;
1442 if (history == NULL) {
1443 history = (char **)malloc(sizeof(char*)*history_max_len);
1444 if (history == NULL) return 0;
1445 memset(history,0,(sizeof(char*)*history_max_len));
1448 /* do not insert duplicate lines into history */
1449 if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1453 linecopy = strdup(line);
1454 if (!linecopy) return 0;
1455 if (history_len == history_max_len) {
1457 memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1460 history[history_len] = linecopy;
1465 int linenoiseHistoryGetMaxLen(void) {
1466 return history_max_len;
1469 int linenoiseHistorySetMaxLen(int len) {
1472 if (len < 1) return 0;
1474 int tocopy = history_len;
1476 newHistory = (char **)malloc(sizeof(char*)*len);
1477 if (newHistory == NULL) return 0;
1479 /* If we can't copy everything, free the elements we'll not use. */
1483 for (j = 0; j < tocopy-len; j++) free(history[j]);
1486 memset(newHistory,0,sizeof(char*)*len);
1487 memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
1489 history = newHistory;
1491 history_max_len = len;
1492 if (history_len > history_max_len)
1493 history_len = history_max_len;
1497 /* Save the history in the specified file. On success 0 is returned
1498 * otherwise -1 is returned. */
1499 int linenoiseHistorySave(const char *filename) {
1500 FILE *fp = fopen(filename,"w");
1503 if (fp == NULL) return -1;
1504 for (j = 0; j < history_len; j++) {
1505 const char *str = history[j];
1506 /* Need to encode backslash, nl and cr */
1511 else if (*str == '\n') {
1514 else if (*str == '\r') {
1529 /* Load the history from the specified file. If the file does not exist
1530 * zero is returned and no operation is performed.
1532 * If the file exists and the operation succeeded 0 is returned, otherwise
1533 * on error -1 is returned. */
1534 int linenoiseHistoryLoad(const char *filename) {
1535 FILE *fp = fopen(filename,"r");
1536 char buf[LINENOISE_MAX_LINE];
1538 if (fp == NULL) return -1;
1540 while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) {
1543 /* Decode backslash escaped values */
1544 for (src = dest = buf; *src; src++) {
1552 else if (*src == 'r') {
1560 /* Remove trailing newline */
1561 if (dest != buf && (dest[-1] == '\n' || dest[-1] == '\r')) {
1566 linenoiseHistoryAdd(buf);
1572 /* Provide access to the history buffer.
1574 * If 'len' is not NULL, the length is stored in *len.
1576 char **linenoiseHistory(int *len) {