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.
59 * CHA (Cursor Horizontal Absolute)
61 * Effect: moves cursor to column n (1 based)
65 * Effect: if n is 0 or missing, clear from cursor to end of line
66 * Effect: if n is 1, clear from beginning of line to cursor
67 * Effect: if n is 2, clear entire line
69 * CUF (CUrsor Forward)
71 * Effect: moves cursor forward of n chars
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,
155 static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
156 static int history_len = 0;
157 static char **history = NULL;
159 /* Structure to contain the status of the current (being edited) line */
161 char *buf; /* Current buffer. Always null terminated */
162 int bufmax; /* Size of the buffer, including space for the null termination */
163 int len; /* Number of bytes in 'buf' */
164 int chars; /* Number of chars in 'buf' (utf-8 chars) */
165 int pos; /* Cursor position, measured in chars */
166 int cols; /* Size of the window, in chars */
168 #if defined(USE_TERMIOS)
169 int fd; /* Terminal fd */
170 #elif defined(USE_WINCONSOLE)
171 HANDLE outh; /* Console output handle */
172 HANDLE inh; /* Console input handle */
173 int rows; /* Screen rows */
174 int x; /* Current column during output */
175 int y; /* Current row */
179 static int fd_read(struct current *current);
180 static int getWindowSize(struct current *current);
182 void linenoiseHistoryFree(void) {
186 for (j = 0; j < history_len; j++)
193 #if defined(USE_TERMIOS)
194 static void linenoiseAtExit(void);
195 static struct termios orig_termios; /* in order to restore at exit */
196 static int rawmode = 0; /* for atexit() function to check if restore is needed*/
197 static int atexit_registered = 0; /* register atexit just 1 time */
199 static const char *unsupported_term[] = {"dumb","cons25",NULL};
201 static int isUnsupportedTerm(void) {
202 char *term = getenv("TERM");
206 for (j = 0; unsupported_term[j]; j++) {
207 if (strcasecmp(term, unsupported_term[j]) == 0) {
215 static int enableRawMode(struct current *current) {
218 current->fd = STDIN_FILENO;
220 if (!isatty(current->fd) || isUnsupportedTerm() ||
221 tcgetattr(current->fd, &orig_termios) == -1) {
227 if (!atexit_registered) {
228 atexit(linenoiseAtExit);
229 atexit_registered = 1;
232 raw = orig_termios; /* modify the original mode */
233 /* input modes: no break, no CR to NL, no parity check, no strip char,
234 * no start/stop output control. */
235 raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
236 /* output modes - disable post processing */
237 raw.c_oflag &= ~(OPOST);
238 /* control modes - set 8 bit chars */
239 raw.c_cflag |= (CS8);
240 /* local modes - choing off, canonical off, no extended functions,
241 * no signal chars (^Z,^C) */
242 raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
243 /* control chars - set return condition: min number of bytes and timer.
244 * We want read to return every single byte, without timeout. */
245 raw.c_cc[VMIN] = 1; raw.c_cc[VTIME] = 0; /* 1 byte, no timer */
247 /* put terminal in raw mode after flushing */
248 if (tcsetattr(current->fd,TCSADRAIN,&raw) < 0) {
257 static void disableRawMode(struct current *current) {
258 /* Don't even check the return value as it's too late. */
259 if (rawmode && tcsetattr(current->fd,TCSADRAIN,&orig_termios) != -1)
263 /* At exit we'll try to fix the terminal to the initial conditions. */
264 static void linenoiseAtExit(void) {
266 tcsetattr(STDIN_FILENO, TCSADRAIN, &orig_termios);
268 linenoiseHistoryFree();
271 /* gcc/glibc insists that we care about the return code of write! */
272 #define IGNORE_RC(EXPR) if (EXPR) {}
274 /* This is fdprintf() on some systems, but use a different
275 * name to avoid conflicts
277 static void fd_printf(int fd, const char *format, ...)
283 va_start(args, format);
284 n = vsnprintf(buf, sizeof(buf), format, args);
286 IGNORE_RC(write(fd, buf, n));
289 static void clearScreen(struct current *current)
291 fd_printf(current->fd, "\x1b[H\x1b[2J");
294 static void cursorToLeft(struct current *current)
296 fd_printf(current->fd, "\x1b[1G");
299 static int outputChars(struct current *current, const char *buf, int len)
301 return write(current->fd, buf, len);
304 static void outputControlChar(struct current *current, char ch)
306 fd_printf(current->fd, "\033[7m^%c\033[0m", ch);
309 static void eraseEol(struct current *current)
311 fd_printf(current->fd, "\x1b[0K");
314 static void setCursorPos(struct current *current, int x)
316 fd_printf(current->fd, "\x1b[1G\x1b[%dC", x);
320 * Reads a char from 'fd', waiting at most 'timeout' milliseconds.
322 * A timeout of -1 means to wait forever.
324 * Returns -1 if no char is received within the time or an error occurs.
326 static int fd_read_char(int fd, int timeout)
334 if (poll(&p, 1, timeout) == 0) {
338 if (read(fd, &c, 1) != 1) {
345 * Reads a complete utf-8 character
346 * and returns the unicode value, or -1 on error.
348 static int fd_read(struct current *current)
356 if (read(current->fd, &buf[0], 1) != 1) {
359 n = utf8_charlen(buf[0]);
360 if (n < 1 || n > 3) {
363 for (i = 1; i < n; i++) {
364 if (read(current->fd, &buf[i], 1) != 1) {
369 /* decode and return the character */
370 utf8_tounicode(buf, &c);
373 return fd_read_char(current->fd, -1);
377 static int getWindowSize(struct current *current)
381 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
382 current->cols = ws.ws_col;
386 /* Failed to query the window size. Perhaps we are on a serial terminal.
387 * Try to query the width by sending the cursor as far to the right
388 * and reading back the cursor position.
389 * Note that this is only done once per call to linenoise rather than
390 * every time the line is refreshed for efficiency reasons.
392 if (current->cols == 0) {
395 /* Move cursor far right and report cursor position */
396 fd_printf(current->fd, "\x1b[999G" "\x1b[6n");
398 /* Parse the response: ESC [ rows ; cols R */
399 if (fd_read_char(current->fd, 100) == 0x1b && fd_read_char(current->fd, 100) == '[') {
402 int ch = fd_read_char(current->fd, 100);
407 else if (ch == 'R') {
409 if (n != 0 && n < 1000) {
414 else if (ch >= 0 && ch <= '9') {
415 n = n * 10 + ch - '0';
427 * If escape (27) was received, reads subsequent
428 * chars to determine if this is a known special key.
430 * Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
432 * If no additional char is received within a short time,
435 static int check_special(int fd)
437 int c = fd_read_char(fd, 50);
444 c2 = fd_read_char(fd, 50);
448 if (c == '[' || c == 'O') {
449 /* Potential arrow key */
456 return SPECIAL_RIGHT;
465 if (c == '[' && c2 >= '1' && c2 <= '8') {
466 /* extended escape */
467 c = fd_read_char(fd, 50);
471 return SPECIAL_DELETE;
478 while (c != -1 && c != '~') {
479 /* .e.g \e[12~ or '\e[11;2~ discard the complete sequence */
480 c = fd_read_char(fd, 50);
486 #elif defined(USE_WINCONSOLE)
488 static DWORD orig_consolemode = 0;
490 static int enableRawMode(struct current *current) {
494 current->outh = GetStdHandle(STD_OUTPUT_HANDLE);
495 current->inh = GetStdHandle(STD_INPUT_HANDLE);
497 if (!PeekConsoleInput(current->inh, &irec, 1, &n)) {
500 if (getWindowSize(current) != 0) {
503 if (GetConsoleMode(current->inh, &orig_consolemode)) {
504 SetConsoleMode(current->inh, ENABLE_PROCESSED_INPUT);
509 static void disableRawMode(struct current *current)
511 SetConsoleMode(current->inh, orig_consolemode);
514 static void clearScreen(struct current *current)
516 COORD topleft = { 0, 0 };
519 FillConsoleOutputCharacter(current->outh, ' ',
520 current->cols * current->rows, topleft, &n);
521 FillConsoleOutputAttribute(current->outh,
522 FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN,
523 current->cols * current->rows, topleft, &n);
524 SetConsoleCursorPosition(current->outh, topleft);
527 static void cursorToLeft(struct current *current)
529 COORD pos = { 0, current->y };
532 FillConsoleOutputAttribute(current->outh,
533 FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN, current->cols, pos, &n);
537 static int outputChars(struct current *current, const char *buf, int len)
539 COORD pos = { current->x, current->y };
540 WriteConsoleOutputCharacter(current->outh, buf, len, pos, 0);
545 static void outputControlChar(struct current *current, char ch)
547 COORD pos = { current->x, current->y };
550 FillConsoleOutputAttribute(current->outh, BACKGROUND_INTENSITY, 2, pos, &n);
551 outputChars(current, "^", 1);
552 outputChars(current, &ch, 1);
555 static void eraseEol(struct current *current)
557 COORD pos = { current->x, current->y };
560 FillConsoleOutputCharacter(current->outh, ' ', current->cols - current->x, pos, &n);
563 static void setCursorPos(struct current *current, int x)
565 COORD pos = { x, current->y };
567 SetConsoleCursorPosition(current->outh, pos);
571 static int fd_read(struct current *current)
576 if (WaitForSingleObject(current->inh, INFINITE) != WAIT_OBJECT_0) {
579 if (!ReadConsoleInput (current->inh, &irec, 1, &n)) {
582 if (irec.EventType == KEY_EVENT && irec.Event.KeyEvent.bKeyDown) {
583 KEY_EVENT_RECORD *k = &irec.Event.KeyEvent;
584 if (k->dwControlKeyState & ENHANCED_KEY) {
585 switch (k->wVirtualKeyCode) {
589 return SPECIAL_RIGHT;
595 return SPECIAL_DELETE;
602 /* Note that control characters are already translated in AsciiChar */
605 return k->uChar.UnicodeChar;
607 return k->uChar.AsciiChar;
615 static int getWindowSize(struct current *current)
617 CONSOLE_SCREEN_BUFFER_INFO info;
618 if (!GetConsoleScreenBufferInfo(current->outh, &info)) {
621 current->cols = info.dwSize.X;
622 current->rows = info.dwSize.Y;
623 if (current->cols <= 0 || current->rows <= 0) {
627 current->y = info.dwCursorPosition.Y;
628 current->x = info.dwCursorPosition.X;
633 static int utf8_getchars(char *buf, int c)
636 return utf8_fromunicode(buf, c);
644 * Returns the unicode character at the given offset,
647 static int get_char(struct current *current, int pos)
649 if (pos >= 0 && pos < current->chars) {
651 int i = utf8_index(current->buf, pos);
652 (void)utf8_tounicode(current->buf + i, &c);
658 static void refreshLine(const char *prompt, struct current *current)
664 const char *buf = current->buf;
665 int chars = current->chars;
666 int pos = current->pos;
671 /* Should intercept SIGWINCH. For now, just get the size every time */
672 getWindowSize(current);
674 plen = strlen(prompt);
675 pchars = utf8_strlen(prompt, plen);
677 /* Account for a line which is too long to fit in the window.
678 * Note that control chars require an extra column
681 /* How many cols are required to the left of 'pos'?
682 * The prompt, plus one extra for each control char
684 n = pchars + utf8_strlen(buf, current->len);
686 for (i = 0; i < pos; i++) {
687 b += utf8_tounicode(buf + b, &ch);
693 /* If too many are need, strip chars off the front of 'buf'
694 * until it fits. Note that if the current char is a control character,
695 * we need one extra col.
697 if (current->pos < current->chars && get_char(current, current->pos) < ' ') {
701 while (n >= current->cols) {
702 b = utf8_tounicode(buf, &ch);
712 /* Cursor to left edge, then the prompt */
713 cursorToLeft(current);
714 outputChars(current, prompt, plen);
716 /* Now the current buffer content */
718 /* Need special handling for control characters.
719 * If we hit 'cols', stop.
721 b = 0; /* unwritted bytes */
722 n = 0; /* How many control chars were written */
723 for (i = 0; i < chars; i++) {
725 int w = utf8_tounicode(buf + b, &ch);
729 if (pchars + i + n >= current->cols) {
733 /* A control character, so write the buffer so far */
734 outputChars(current, buf, b);
737 outputControlChar(current, ch + '@');
746 outputChars(current, buf, b);
748 /* Erase to right, move cursor to original position */
750 setCursorPos(current, pos + pchars + backup);
753 static void set_current(struct current *current, const char *str)
755 strncpy(current->buf, str, current->bufmax);
756 current->buf[current->bufmax - 1] = 0;
757 current->len = strlen(current->buf);
758 current->pos = current->chars = utf8_strlen(current->buf, current->len);
761 static int has_room(struct current *current, int bytes)
763 return current->len + bytes < current->bufmax - 1;
767 * Removes the char at 'pos'.
769 * Returns 1 if the line needs to be refreshed, 2 if not
770 * and 0 if nothing was removed
772 static int remove_char(struct current *current, int pos)
774 if (pos >= 0 && pos < current->chars) {
777 p1 = utf8_index(current->buf, pos);
778 p2 = p1 + utf8_index(current->buf + p1, 1);
781 /* optimise remove char in the case of removing the last char */
782 if (current->pos == pos + 1 && current->pos == current->chars) {
783 if (current->buf[pos] >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
785 fd_printf(current->fd, "\b \b");
790 /* Move the null char too */
791 memmove(current->buf + p1, current->buf + p2, current->len - p2 + 1);
792 current->len -= (p2 - p1);
795 if (current->pos > pos) {
804 * Insert 'ch' at position 'pos'
806 * Returns 1 if the line needs to be refreshed, 2 if not
807 * and 0 if nothing was inserted (no room)
809 static int insert_char(struct current *current, int pos, int ch)
812 int n = utf8_getchars(buf, ch);
814 if (has_room(current, n) && pos >= 0 && pos <= current->chars) {
817 p1 = utf8_index(current->buf, pos);
821 /* optimise the case where adding a single char to the end and no scrolling is needed */
822 if (current->pos == pos && current->chars == pos) {
823 if (ch >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
824 IGNORE_RC(write(current->fd, buf, n));
830 memmove(current->buf + p2, current->buf + p1, current->len - p1);
831 memcpy(current->buf + p1, buf, n);
835 if (current->pos >= pos) {
844 * Returns 0 if no chars were removed or non-zero otherwise.
846 static int remove_chars(struct current *current, int pos, int n)
849 while (n-- && remove_char(current, pos)) {
855 #ifndef NO_COMPLETION
856 static linenoiseCompletionCallback *completionCallback = NULL;
860 fprintf(stderr, "\x7");
865 static void freeCompletions(linenoiseCompletions *lc) {
867 for (i = 0; i < lc->len; i++)
872 static int completeLine(struct current *current) {
873 linenoiseCompletions lc = { 0, NULL };
876 completionCallback(current->buf,&lc);
880 size_t stop = 0, i = 0;
883 /* Show completion or original buffer */
885 struct current tmp = *current;
886 tmp.buf = lc.cvec[i];
887 tmp.pos = tmp.len = strlen(tmp.buf);
888 tmp.chars = utf8_strlen(tmp.buf, tmp.len);
889 refreshLine(current->prompt, &tmp);
891 refreshLine(current->prompt, current);
894 c = fd_read(current);
901 i = (i+1) % (lc.len+1);
902 if (i == lc.len) beep();
904 case 27: /* escape */
905 /* Re-show original buffer */
907 refreshLine(current->prompt, current);
912 /* Update buffer and return */
914 set_current(current,lc.cvec[i]);
922 freeCompletions(&lc);
923 return c; /* Return last read character */
926 /* Register a callback function to be called for tab-completion. */
927 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) {
928 completionCallback = fn;
931 void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
932 lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
933 lc->cvec[lc->len++] = strdup(str);
938 static int linenoisePrompt(struct current *current) {
939 int history_index = 0;
941 /* The latest history entry is always our current buffer, that
942 * initially is just an empty string. */
943 linenoiseHistoryAdd("");
945 set_current(current, "");
946 refreshLine(current->prompt, current);
950 int c = fd_read(current);
952 #ifndef NO_COMPLETION
953 /* Only autocomplete when the callback is set. It returns < 0 when
954 * there was an error reading from fd. Otherwise it will return the
955 * character that should be handled next. */
956 if (c == 9 && completionCallback != NULL) {
957 c = completeLine(current);
958 /* Return on errors */
959 if (c < 0) return current->len;
960 /* Read next character when 0 */
961 if (c == 0) continue;
966 if (c == -1) return current->len;
968 if (c == 27) { /* escape sequence */
969 c = check_special(current->fd);
973 case '\r': /* enter */
975 free(history[history_len]);
977 case ctrl('C'): /* ctrl-c */
980 case 127: /* backspace */
982 if (remove_char(current, current->pos - 1) == 1) {
983 refreshLine(current->prompt, current);
986 case ctrl('D'): /* ctrl-d */
987 if (current->len == 0) {
988 /* Empty line, so EOF */
990 free(history[history_len]);
993 /* Otherwise fall through to delete char to right of cursor */
995 if (remove_char(current, current->pos) == 1) {
996 refreshLine(current->prompt, current);
999 case ctrl('W'): /* ctrl-w */
1000 /* eat any spaces on the left */
1002 int pos = current->pos;
1003 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1007 /* now eat any non-spaces on the left */
1008 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1012 if (remove_chars(current, pos, current->pos - pos)) {
1013 refreshLine(current->prompt, current);
1017 case ctrl('R'): /* ctrl-r */
1019 /* Display the reverse-i-search prompt and process chars */
1024 int searchpos = history_len - 1;
1029 const char *p = NULL;
1033 snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
1034 refreshLine(rprompt, current);
1035 c = fd_read(current);
1036 if (c == ctrl('H') || c == 127) {
1038 int p = utf8_index(rbuf, --rchars);
1040 rlen = strlen(rbuf);
1046 c = check_special(current->fd);
1049 if (c == ctrl('P') || c == SPECIAL_UP) {
1050 /* Search for the previous (earlier) match */
1051 if (searchpos > 0) {
1056 else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1057 /* Search for the next (later) match */
1058 if (searchpos < history_len) {
1064 else if (c >= ' ') {
1065 if (rlen >= (int)sizeof(rbuf) + 3) {
1069 n = utf8_getchars(rbuf + rlen, c);
1074 /* Adding a new char resets the search location */
1075 searchpos = history_len - 1;
1078 /* Exit from incremental search mode */
1082 /* Now search through the history for a match */
1083 for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1084 p = strstr(history[searchpos], rbuf);
1087 if (skipsame && strcmp(history[searchpos], current->buf) == 0) {
1088 /* But it is identical, so skip it */
1091 /* Copy the matching line and set the cursor position */
1092 set_current(current,history[searchpos]);
1093 current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
1098 /* No match, so don't add it */
1104 if (c == ctrl('G') || c == ctrl('C')) {
1105 /* ctrl-g terminates the search with no effect */
1106 set_current(current, "");
1109 else if (c == ctrl('J')) {
1110 /* ctrl-j terminates the search leaving the buffer in place */
1113 /* Go process the char normally */
1114 refreshLine(current->prompt, current);
1118 case ctrl('T'): /* ctrl-t */
1119 if (current->pos > 0 && current->pos < current->chars) {
1120 c = get_char(current, current->pos);
1121 remove_char(current, current->pos);
1122 insert_char(current, current->pos - 1, c);
1123 refreshLine(current->prompt, current);
1126 case ctrl('V'): /* ctrl-v */
1127 if (has_room(current, 3)) {
1128 /* Insert the ^V first */
1129 if (insert_char(current, current->pos, c)) {
1130 refreshLine(current->prompt, current);
1131 /* Now wait for the next char. Can insert anything except \0 */
1132 c = fd_read(current);
1134 /* Remove the ^V first */
1135 remove_char(current, current->pos - 1);
1137 /* Insert the actual char */
1138 insert_char(current, current->pos, c);
1140 refreshLine(current->prompt, current);
1146 if (current->pos > 0) {
1148 refreshLine(current->prompt, current);
1153 if (current->pos < current->chars) {
1155 refreshLine(current->prompt, current);
1163 if (history_len > 1) {
1164 /* Update the current history entry before to
1165 * overwrite it with tne next one. */
1166 free(history[history_len-1-history_index]);
1167 history[history_len-1-history_index] = strdup(current->buf);
1168 /* Show the new entry */
1169 history_index += dir;
1170 if (history_index < 0) {
1173 } else if (history_index >= history_len) {
1174 history_index = history_len-1;
1177 set_current(current, history[history_len-1-history_index]);
1178 refreshLine(current->prompt, current);
1181 case ctrl('A'): /* Ctrl+a, go to the start of the line */
1184 refreshLine(current->prompt, current);
1186 case ctrl('E'): /* ctrl+e, go to the end of the line */
1188 current->pos = current->chars;
1189 refreshLine(current->prompt, current);
1191 case ctrl('U'): /* Ctrl+u, delete to beginning of line. */
1192 if (remove_chars(current, 0, current->pos)) {
1193 refreshLine(current->prompt, current);
1196 case ctrl('K'): /* Ctrl+k, delete from current to end of line. */
1197 if (remove_chars(current, current->pos, current->chars - current->pos)) {
1198 refreshLine(current->prompt, current);
1201 case ctrl('L'): /* Ctrl+L, clear screen */
1202 clearScreen(current);
1203 /* Force recalc of window size for serial terminals */
1205 refreshLine(current->prompt, current);
1208 /* Only tab is allowed without ^V */
1209 if (c == '\t' || c >= ' ') {
1210 if (insert_char(current, current->pos, c) == 1) {
1211 refreshLine(current->prompt, current);
1217 return current->len;
1220 char *linenoise(const char *prompt)
1223 struct current current;
1224 char buf[LINENOISE_MAX_LINE];
1226 if (enableRawMode(¤t) == -1) {
1227 printf("%s", prompt);
1229 if (fgets(buf, sizeof(buf), stdin) == NULL) {
1232 count = strlen(buf);
1233 if (count && buf[count-1] == '\n') {
1241 current.bufmax = sizeof(buf);
1245 current.prompt = prompt;
1247 count = linenoisePrompt(¤t);
1248 disableRawMode(¤t);
1257 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1258 int linenoiseHistoryAdd(const char *line) {
1261 if (history_max_len == 0) return 0;
1262 if (history == NULL) {
1263 history = (char **)malloc(sizeof(char*)*history_max_len);
1264 if (history == NULL) return 0;
1265 memset(history,0,(sizeof(char*)*history_max_len));
1268 /* do not insert duplicate lines into history */
1269 if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1273 linecopy = strdup(line);
1274 if (!linecopy) return 0;
1275 if (history_len == history_max_len) {
1277 memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1280 history[history_len] = linecopy;
1285 int linenoiseHistorySetMaxLen(int len) {
1288 if (len < 1) return 0;
1290 int tocopy = history_len;
1292 newHistory = (char **)malloc(sizeof(char*)*len);
1293 if (newHistory == NULL) return 0;
1294 if (len < tocopy) tocopy = len;
1295 memcpy(newHistory,history+(history_max_len-tocopy), sizeof(char*)*tocopy);
1297 history = newHistory;
1299 history_max_len = len;
1300 if (history_len > history_max_len)
1301 history_len = history_max_len;
1305 /* Save the history in the specified file. On success 0 is returned
1306 * otherwise -1 is returned. */
1307 int linenoiseHistorySave(const char *filename) {
1308 FILE *fp = fopen(filename,"w");
1311 if (fp == NULL) return -1;
1312 for (j = 0; j < history_len; j++) {
1313 const char *str = history[j];
1314 /* Need to encode backslash, nl and cr */
1319 else if (*str == '\n') {
1322 else if (*str == '\r') {
1337 /* Load the history from the specified file. If the file does not exist
1338 * zero is returned and no operation is performed.
1340 * If the file exists and the operation succeeded 0 is returned, otherwise
1341 * on error -1 is returned. */
1342 int linenoiseHistoryLoad(const char *filename) {
1343 FILE *fp = fopen(filename,"r");
1344 char buf[LINENOISE_MAX_LINE];
1346 if (fp == NULL) return -1;
1348 while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) {
1351 /* Decode backslash escaped values */
1352 for (src = dest = buf; *src; src++) {
1360 else if (*src == 'r') {
1368 /* Remove trailing newline */
1369 if (dest != buf && (dest[-1] == '\n' || dest[-1] == '\r')) {
1374 linenoiseHistoryAdd(buf);
1380 /* Provide access to the history buffer.
1382 * If 'len' is not NULL, the length is stored in *len.
1384 char **linenoiseHistory(int *len) {