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 (strcmp(term, unsupported_term[j]) == 0) {
220 static int enableRawMode(struct current *current) {
223 current->fd = STDIN_FILENO;
226 if (!isatty(current->fd) || isUnsupportedTerm() ||
227 tcgetattr(current->fd, &orig_termios) == -1) {
233 if (!atexit_registered) {
234 atexit(linenoiseAtExit);
235 atexit_registered = 1;
238 raw = orig_termios; /* modify the original mode */
239 /* input modes: no break, no CR to NL, no parity check, no strip char,
240 * no start/stop output control. */
241 raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
242 /* output modes - disable post processing */
243 raw.c_oflag &= ~(OPOST);
244 /* control modes - set 8 bit chars */
245 raw.c_cflag |= (CS8);
246 /* local modes - choing off, canonical off, no extended functions,
247 * no signal chars (^Z,^C) */
248 raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
249 /* control chars - set return condition: min number of bytes and timer.
250 * We want read to return every single byte, without timeout. */
251 raw.c_cc[VMIN] = 1; raw.c_cc[VTIME] = 0; /* 1 byte, no timer */
253 /* put terminal in raw mode after flushing */
254 if (tcsetattr(current->fd,TCSADRAIN,&raw) < 0) {
261 static void disableRawMode(struct current *current) {
262 /* Don't even check the return value as it's too late. */
263 if (rawmode && tcsetattr(current->fd,TCSADRAIN,&orig_termios) != -1)
267 /* At exit we'll try to fix the terminal to the initial conditions. */
268 static void linenoiseAtExit(void) {
270 tcsetattr(STDIN_FILENO, TCSADRAIN, &orig_termios);
272 linenoiseHistoryFree();
275 /* gcc/glibc insists that we care about the return code of write!
276 * Clarification: This means that a void-cast like "(void) (EXPR)"
279 #define IGNORE_RC(EXPR) if (EXPR) {}
281 /* This is fdprintf() on some systems, but use a different
282 * name to avoid conflicts
284 static void fd_printf(int fd, const char *format, ...)
290 va_start(args, format);
291 n = vsnprintf(buf, sizeof(buf), format, args);
293 IGNORE_RC(write(fd, buf, n));
296 static void clearScreen(struct current *current)
298 fd_printf(current->fd, "\x1b[H\x1b[2J");
301 static void cursorToLeft(struct current *current)
303 fd_printf(current->fd, "\r");
306 static int outputChars(struct current *current, const char *buf, int len)
308 return write(current->fd, buf, len);
311 static void outputControlChar(struct current *current, char ch)
313 fd_printf(current->fd, "\x1b[7m^%c\x1b[0m", ch);
316 static void eraseEol(struct current *current)
318 fd_printf(current->fd, "\x1b[0K");
321 static void setCursorPos(struct current *current, int x)
323 fd_printf(current->fd, "\r\x1b[%dC", x);
327 * Reads a char from 'fd', waiting at most 'timeout' milliseconds.
329 * A timeout of -1 means to wait forever.
331 * Returns -1 if no char is received within the time or an error occurs.
333 static int fd_read_char(int fd, int timeout)
341 if (poll(&p, 1, timeout) == 0) {
345 if (read(fd, &c, 1) != 1) {
352 * Reads a complete utf-8 character
353 * and returns the unicode value, or -1 on error.
355 static int fd_read(struct current *current)
363 if (read(current->fd, &buf[0], 1) != 1) {
366 n = utf8_charlen(buf[0]);
367 if (n < 1 || n > 3) {
370 for (i = 1; i < n; i++) {
371 if (read(current->fd, &buf[i], 1) != 1) {
376 /* decode and return the character */
377 utf8_tounicode(buf, &c);
380 return fd_read_char(current->fd, -1);
384 static int countColorControlChars(const char* prompt)
386 /* ANSI color control sequences have the form:
387 * "\x1b" "[" [0-9;]* "m"
388 * We parse them with a simple state machine.
395 } state = search_esc;
396 int len = 0, found = 0;
399 /* XXX: Strictly we should be checking utf8 chars rather than
400 * bytes in case of the extremely unlikely scenario where
401 * an ANSI sequence is part of a utf8 sequence.
403 while ((ch = *prompt++) != 0) {
407 state = expect_bracket;
412 state = expect_trail;
413 /* 3 for "\e[ ... m" */
420 if ((ch == ';') || ((ch >= '0' && ch <= '9'))) {
421 /* 0-9, or semicolon */
437 * Stores the current cursor column in '*cols'.
438 * Returns 1 if OK, or 0 if failed to determine cursor pos.
440 static int queryCursor(int fd, int* cols)
442 /* control sequence - report cursor location */
443 fd_printf(fd, "\x1b[6n");
445 /* Parse the response: ESC [ rows ; cols R */
446 if (fd_read_char(fd, 100) == 0x1b &&
447 fd_read_char(fd, 100) == '[') {
451 int ch = fd_read_char(fd, 100);
456 else if (ch == 'R') {
458 if (n != 0 && n < 1000) {
463 else if (ch >= 0 && ch <= '9') {
464 n = n * 10 + ch - '0';
477 * Updates current->cols with the current window size (width)
479 static int getWindowSize(struct current *current)
483 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
484 current->cols = ws.ws_col;
488 /* Failed to query the window size. Perhaps we are on a serial terminal.
489 * Try to query the width by sending the cursor as far to the right
490 * and reading back the cursor position.
491 * Note that this is only done once per call to linenoise rather than
492 * every time the line is refreshed for efficiency reasons.
494 * In more detail, we:
495 * (a) request current cursor position,
496 * (b) move cursor far right,
497 * (c) request cursor position again,
498 * (d) at last move back to the old position.
499 * This gives us the width without messing with the externally
500 * visible cursor position.
503 if (current->cols == 0) {
509 if (queryCursor (current->fd, &here)) {
511 fd_printf(current->fd, "\x1b[999C");
513 /* (c). Note: If (a) succeeded, then (c) should as well.
514 * For paranoia we still check and have a fallback action
515 * for (d) in case of failure..
517 if (!queryCursor (current->fd, ¤t->cols)) {
518 /* (d') Unable to get accurate position data, reset
519 * the cursor to the far left. While this may not
520 * restore the exact original position it should not
523 fd_printf(current->fd, "\r");
525 /* (d) Reset the cursor back to the original location. */
526 if (current->cols > here) {
527 fd_printf(current->fd, "\x1b[%dD", current->cols - here);
530 } /* 1st query failed, doing nothing => default 80 */
537 * If escape (27) was received, reads subsequent
538 * chars to determine if this is a known special key.
540 * Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
542 * If no additional char is received within a short time,
545 static int check_special(int fd)
547 int c = fd_read_char(fd, 50);
554 c2 = fd_read_char(fd, 50);
558 if (c == '[' || c == 'O') {
559 /* Potential arrow key */
566 return SPECIAL_RIGHT;
575 if (c == '[' && c2 >= '1' && c2 <= '8') {
576 /* extended escape */
577 c = fd_read_char(fd, 50);
581 return SPECIAL_INSERT;
583 return SPECIAL_DELETE;
585 return SPECIAL_PAGE_UP;
587 return SPECIAL_PAGE_DOWN;
594 while (c != -1 && c != '~') {
595 /* .e.g \e[12~ or '\e[11;2~ discard the complete sequence */
596 c = fd_read_char(fd, 50);
602 #elif defined(USE_WINCONSOLE)
604 static DWORD orig_consolemode = 0;
606 static int enableRawMode(struct current *current) {
610 current->outh = GetStdHandle(STD_OUTPUT_HANDLE);
611 current->inh = GetStdHandle(STD_INPUT_HANDLE);
613 if (!PeekConsoleInput(current->inh, &irec, 1, &n)) {
616 if (getWindowSize(current) != 0) {
619 if (GetConsoleMode(current->inh, &orig_consolemode)) {
620 SetConsoleMode(current->inh, ENABLE_PROCESSED_INPUT);
625 static void disableRawMode(struct current *current)
627 SetConsoleMode(current->inh, orig_consolemode);
630 static void clearScreen(struct current *current)
632 COORD topleft = { 0, 0 };
635 FillConsoleOutputCharacter(current->outh, ' ',
636 current->cols * current->rows, topleft, &n);
637 FillConsoleOutputAttribute(current->outh,
638 FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN,
639 current->cols * current->rows, topleft, &n);
640 SetConsoleCursorPosition(current->outh, topleft);
643 static void cursorToLeft(struct current *current)
645 COORD pos = { 0, (SHORT)current->y };
648 FillConsoleOutputAttribute(current->outh,
649 FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN, current->cols, pos, &n);
653 static int outputChars(struct current *current, const char *buf, int len)
655 COORD pos = { (SHORT)current->x, (SHORT)current->y };
658 WriteConsoleOutputCharacter(current->outh, buf, len, pos, &n);
663 static void outputControlChar(struct current *current, char ch)
665 COORD pos = { (SHORT)current->x, (SHORT)current->y };
668 FillConsoleOutputAttribute(current->outh, BACKGROUND_INTENSITY, 2, pos, &n);
669 outputChars(current, "^", 1);
670 outputChars(current, &ch, 1);
673 static void eraseEol(struct current *current)
675 COORD pos = { (SHORT)current->x, (SHORT)current->y };
678 FillConsoleOutputCharacter(current->outh, ' ', current->cols - current->x, pos, &n);
681 static void setCursorPos(struct current *current, int x)
683 COORD pos = { (SHORT)x, (SHORT)current->y };
685 SetConsoleCursorPosition(current->outh, pos);
689 static int fd_read(struct current *current)
694 if (WaitForSingleObject(current->inh, INFINITE) != WAIT_OBJECT_0) {
697 if (!ReadConsoleInput (current->inh, &irec, 1, &n)) {
700 if (irec.EventType == KEY_EVENT && irec.Event.KeyEvent.bKeyDown) {
701 KEY_EVENT_RECORD *k = &irec.Event.KeyEvent;
702 if (k->dwControlKeyState & ENHANCED_KEY) {
703 switch (k->wVirtualKeyCode) {
707 return SPECIAL_RIGHT;
713 return SPECIAL_INSERT;
715 return SPECIAL_DELETE;
721 return SPECIAL_PAGE_UP;
723 return SPECIAL_PAGE_DOWN;
726 /* Note that control characters are already translated in AsciiChar */
729 return k->uChar.UnicodeChar;
731 return k->uChar.AsciiChar;
739 static int countColorControlChars(const char* prompt)
741 /* For windows we assume that there are no embedded ansi color
747 static int getWindowSize(struct current *current)
749 CONSOLE_SCREEN_BUFFER_INFO info;
750 if (!GetConsoleScreenBufferInfo(current->outh, &info)) {
753 current->cols = info.dwSize.X;
754 current->rows = info.dwSize.Y;
755 if (current->cols <= 0 || current->rows <= 0) {
759 current->y = info.dwCursorPosition.Y;
760 current->x = info.dwCursorPosition.X;
765 static int utf8_getchars(char *buf, int c)
768 return utf8_fromunicode(buf, c);
776 * Returns the unicode character at the given offset,
779 static int get_char(struct current *current, int pos)
781 if (pos >= 0 && pos < current->chars) {
783 int i = utf8_index(current->buf, pos);
784 (void)utf8_tounicode(current->buf + i, &c);
790 static void refreshLine(const char *prompt, struct current *current)
796 const char *buf = current->buf;
797 int chars = current->chars;
798 int pos = current->pos;
803 /* Should intercept SIGWINCH. For now, just get the size every time */
804 getWindowSize(current);
806 plen = strlen(prompt);
807 pchars = utf8_strlen(prompt, plen);
809 /* Scan the prompt for embedded ansi color control sequences and
810 * discount them as characters/columns.
812 pchars -= countColorControlChars(prompt);
814 /* Account for a line which is too long to fit in the window.
815 * Note that control chars require an extra column
818 /* How many cols are required to the left of 'pos'?
819 * The prompt, plus one extra for each control char
821 n = pchars + utf8_strlen(buf, current->len);
823 for (i = 0; i < pos; i++) {
824 b += utf8_tounicode(buf + b, &ch);
830 /* If too many are needed, strip chars off the front of 'buf'
831 * until it fits. Note that if the current char is a control character,
832 * we need one extra col.
834 if (current->pos < current->chars && get_char(current, current->pos) < ' ') {
838 while (n >= current->cols && pos > 0) {
839 b = utf8_tounicode(buf, &ch);
849 /* Cursor to left edge, then the prompt */
850 cursorToLeft(current);
851 outputChars(current, prompt, plen);
853 /* Now the current buffer content */
855 /* Need special handling for control characters.
856 * If we hit 'cols', stop.
858 b = 0; /* unwritted bytes */
859 n = 0; /* How many control chars were written */
860 for (i = 0; i < chars; i++) {
862 int w = utf8_tounicode(buf + b, &ch);
866 if (pchars + i + n >= current->cols) {
870 /* A control character, so write the buffer so far */
871 outputChars(current, buf, b);
874 outputControlChar(current, ch + '@');
883 outputChars(current, buf, b);
885 /* Erase to right, move cursor to original position */
887 setCursorPos(current, pos + pchars + backup);
890 static void set_current(struct current *current, const char *str)
892 strncpy(current->buf, str, current->bufmax);
893 current->buf[current->bufmax - 1] = 0;
894 current->len = strlen(current->buf);
895 current->pos = current->chars = utf8_strlen(current->buf, current->len);
898 static int has_room(struct current *current, int bytes)
900 return current->len + bytes < current->bufmax - 1;
904 * Removes the char at 'pos'.
906 * Returns 1 if the line needs to be refreshed, 2 if not
907 * and 0 if nothing was removed
909 static int remove_char(struct current *current, int pos)
911 if (pos >= 0 && pos < current->chars) {
914 p1 = utf8_index(current->buf, pos);
915 p2 = p1 + utf8_index(current->buf + p1, 1);
918 /* optimise remove char in the case of removing the last char */
919 if (current->pos == pos + 1 && current->pos == current->chars) {
920 if (current->buf[pos] >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
922 fd_printf(current->fd, "\b \b");
927 /* Move the null char too */
928 memmove(current->buf + p1, current->buf + p2, current->len - p2 + 1);
929 current->len -= (p2 - p1);
932 if (current->pos > pos) {
941 * Insert 'ch' at position 'pos'
943 * Returns 1 if the line needs to be refreshed, 2 if not
944 * and 0 if nothing was inserted (no room)
946 static int insert_char(struct current *current, int pos, int ch)
949 int n = utf8_getchars(buf, ch);
951 if (has_room(current, n) && pos >= 0 && pos <= current->chars) {
954 p1 = utf8_index(current->buf, pos);
958 /* optimise the case where adding a single char to the end and no scrolling is needed */
959 if (current->pos == pos && current->chars == pos) {
960 if (ch >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
961 IGNORE_RC(write(current->fd, buf, n));
967 memmove(current->buf + p2, current->buf + p1, current->len - p1);
968 memcpy(current->buf + p1, buf, n);
972 if (current->pos >= pos) {
981 * Captures up to 'n' characters starting at 'pos' for the cut buffer.
983 * This replaces any existing characters in the cut buffer.
985 static void capture_chars(struct current *current, int pos, int n)
987 if (pos >= 0 && (pos + n - 1) < current->chars) {
988 int p1 = utf8_index(current->buf, pos);
989 int nbytes = utf8_index(current->buf + p1, n);
992 free(current->capture);
993 /* Include space for the null terminator */
994 current->capture = (char *)malloc(nbytes + 1);
995 memcpy(current->capture, current->buf + p1, nbytes);
996 current->capture[nbytes] = '\0';
1002 * Removes up to 'n' characters at cursor position 'pos'.
1004 * Returns 0 if no chars were removed or non-zero otherwise.
1006 static int remove_chars(struct current *current, int pos, int n)
1010 /* First save any chars which will be removed */
1011 capture_chars(current, pos, n);
1013 while (n-- && remove_char(current, pos)) {
1019 * Inserts the characters (string) 'chars' at the cursor position 'pos'.
1021 * Returns 0 if no chars were inserted or non-zero otherwise.
1023 static int insert_chars(struct current *current, int pos, const char *chars)
1029 int n = utf8_tounicode(chars, &ch);
1030 if (insert_char(current, pos, ch) == 0) {
1040 #ifndef NO_COMPLETION
1041 static linenoiseCompletionCallback *completionCallback = NULL;
1043 static void beep() {
1045 fprintf(stderr, "\x7");
1050 static void freeCompletions(linenoiseCompletions *lc) {
1052 for (i = 0; i < lc->len; i++)
1057 static int completeLine(struct current *current) {
1058 linenoiseCompletions lc = { 0, NULL };
1061 completionCallback(current->buf,&lc);
1065 size_t stop = 0, i = 0;
1068 /* Show completion or original buffer */
1070 struct current tmp = *current;
1071 tmp.buf = lc.cvec[i];
1072 tmp.pos = tmp.len = strlen(tmp.buf);
1073 tmp.chars = utf8_strlen(tmp.buf, tmp.len);
1074 refreshLine(current->prompt, &tmp);
1076 refreshLine(current->prompt, current);
1079 c = fd_read(current);
1085 case '\t': /* tab */
1086 i = (i+1) % (lc.len+1);
1087 if (i == lc.len) beep();
1089 case 27: /* escape */
1090 /* Re-show original buffer */
1092 refreshLine(current->prompt, current);
1097 /* Update buffer and return */
1099 set_current(current,lc.cvec[i]);
1107 freeCompletions(&lc);
1108 return c; /* Return last read character */
1111 /* Register a callback function to be called for tab-completion. */
1112 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) {
1113 completionCallback = fn;
1116 void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
1117 lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
1118 lc->cvec[lc->len++] = strdup(str);
1123 static int linenoiseEdit(struct current *current) {
1124 int history_index = 0;
1126 /* The latest history entry is always our current buffer, that
1127 * initially is just an empty string. */
1128 linenoiseHistoryAdd("");
1130 set_current(current, "");
1131 refreshLine(current->prompt, current);
1135 int c = fd_read(current);
1137 #ifndef NO_COMPLETION
1138 /* Only autocomplete when the callback is set. It returns < 0 when
1139 * there was an error reading from fd. Otherwise it will return the
1140 * character that should be handled next. */
1141 if (c == '\t' && current->pos == current->chars && completionCallback != NULL) {
1142 c = completeLine(current);
1143 /* Return on errors */
1144 if (c < 0) return current->len;
1145 /* Read next character when 0 */
1146 if (c == 0) continue;
1151 if (c == -1) return current->len;
1153 if (c == 27) { /* escape sequence */
1154 c = check_special(current->fd);
1158 case '\r': /* enter */
1160 free(history[history_len]);
1161 return current->len;
1162 case ctrl('C'): /* ctrl-c */
1165 case 127: /* backspace */
1167 if (remove_char(current, current->pos - 1) == 1) {
1168 refreshLine(current->prompt, current);
1171 case ctrl('D'): /* ctrl-d */
1172 if (current->len == 0) {
1173 /* Empty line, so EOF */
1175 free(history[history_len]);
1178 /* Otherwise fall through to delete char to right of cursor */
1179 case SPECIAL_DELETE:
1180 if (remove_char(current, current->pos) == 1) {
1181 refreshLine(current->prompt, current);
1184 case SPECIAL_INSERT:
1185 /* Ignore. Expansion Hook.
1186 * Future possibility: Toggle Insert/Overwrite Modes
1189 case ctrl('W'): /* ctrl-w, delete word at left. save deleted chars */
1190 /* eat any spaces on the left */
1192 int pos = current->pos;
1193 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1197 /* now eat any non-spaces on the left */
1198 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1202 if (remove_chars(current, pos, current->pos - pos)) {
1203 refreshLine(current->prompt, current);
1207 case ctrl('R'): /* ctrl-r */
1209 /* Display the reverse-i-search prompt and process chars */
1214 int searchpos = history_len - 1;
1219 const char *p = NULL;
1223 snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
1224 refreshLine(rprompt, current);
1225 c = fd_read(current);
1226 if (c == ctrl('H') || c == 127) {
1228 int p = utf8_index(rbuf, --rchars);
1230 rlen = strlen(rbuf);
1236 c = check_special(current->fd);
1239 if (c == ctrl('P') || c == SPECIAL_UP) {
1240 /* Search for the previous (earlier) match */
1241 if (searchpos > 0) {
1246 else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1247 /* Search for the next (later) match */
1248 if (searchpos < history_len) {
1254 else if (c >= ' ') {
1255 if (rlen >= (int)sizeof(rbuf) + 3) {
1259 n = utf8_getchars(rbuf + rlen, c);
1264 /* Adding a new char resets the search location */
1265 searchpos = history_len - 1;
1268 /* Exit from incremental search mode */
1272 /* Now search through the history for a match */
1273 for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1274 p = strstr(history[searchpos], rbuf);
1277 if (skipsame && strcmp(history[searchpos], current->buf) == 0) {
1278 /* But it is identical, so skip it */
1281 /* Copy the matching line and set the cursor position */
1282 set_current(current,history[searchpos]);
1283 current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
1288 /* No match, so don't add it */
1294 if (c == ctrl('G') || c == ctrl('C')) {
1295 /* ctrl-g terminates the search with no effect */
1296 set_current(current, "");
1299 else if (c == ctrl('J')) {
1300 /* ctrl-j terminates the search leaving the buffer in place */
1303 /* Go process the char normally */
1304 refreshLine(current->prompt, current);
1308 case ctrl('T'): /* ctrl-t */
1309 if (current->pos > 0 && current->pos <= current->chars) {
1310 /* If cursor is at end, transpose the previous two chars */
1311 int fixer = (current->pos == current->chars);
1312 c = get_char(current, current->pos - fixer);
1313 remove_char(current, current->pos - fixer);
1314 insert_char(current, current->pos - 1, c);
1315 refreshLine(current->prompt, current);
1318 case ctrl('V'): /* ctrl-v */
1319 if (has_room(current, 3)) {
1320 /* Insert the ^V first */
1321 if (insert_char(current, current->pos, c)) {
1322 refreshLine(current->prompt, current);
1323 /* Now wait for the next char. Can insert anything except \0 */
1324 c = fd_read(current);
1326 /* Remove the ^V first */
1327 remove_char(current, current->pos - 1);
1329 /* Insert the actual char */
1330 insert_char(current, current->pos, c);
1332 refreshLine(current->prompt, current);
1338 if (current->pos > 0) {
1340 refreshLine(current->prompt, current);
1345 if (current->pos < current->chars) {
1347 refreshLine(current->prompt, current);
1350 case SPECIAL_PAGE_UP:
1351 dir = history_len - history_index - 1; /* move to start of history */
1352 goto history_navigation;
1353 case SPECIAL_PAGE_DOWN:
1354 dir = -history_index; /* move to 0 == end of history, i.e. current */
1355 goto history_navigation;
1359 goto history_navigation;
1363 if (history_len > 1) {
1364 /* Update the current history entry before to
1365 * overwrite it with tne next one. */
1366 free(history[history_len - 1 - history_index]);
1367 history[history_len - 1 - history_index] = strdup(current->buf);
1368 /* Show the new entry */
1369 history_index += dir;
1370 if (history_index < 0) {
1373 } else if (history_index >= history_len) {
1374 history_index = history_len - 1;
1377 set_current(current, history[history_len - 1 - history_index]);
1378 refreshLine(current->prompt, current);
1381 case ctrl('A'): /* Ctrl+a, go to the start of the line */
1384 refreshLine(current->prompt, current);
1386 case ctrl('E'): /* ctrl+e, go to the end of the line */
1388 current->pos = current->chars;
1389 refreshLine(current->prompt, current);
1391 case ctrl('U'): /* Ctrl+u, delete to beginning of line, save deleted chars. */
1392 if (remove_chars(current, 0, current->pos)) {
1393 refreshLine(current->prompt, current);
1396 case ctrl('K'): /* Ctrl+k, delete from current to end of line, save deleted chars. */
1397 if (remove_chars(current, current->pos, current->chars - current->pos)) {
1398 refreshLine(current->prompt, current);
1401 case ctrl('Y'): /* Ctrl+y, insert saved chars at current position */
1402 if (current->capture && insert_chars(current, current->pos, current->capture)) {
1403 refreshLine(current->prompt, current);
1406 case ctrl('L'): /* Ctrl+L, clear screen */
1407 clearScreen(current);
1408 /* Force recalc of window size for serial terminals */
1410 refreshLine(current->prompt, current);
1413 /* Only tab is allowed without ^V */
1414 if (c == '\t' || c >= ' ') {
1415 if (insert_char(current, current->pos, c) == 1) {
1416 refreshLine(current->prompt, current);
1422 return current->len;
1425 int linenoiseColumns(void)
1427 struct current current;
1428 enableRawMode (¤t);
1429 getWindowSize (¤t);
1430 disableRawMode (¤t);
1431 return current.cols;
1434 char *linenoise(const char *prompt)
1437 struct current current;
1438 char buf[LINENOISE_MAX_LINE];
1440 if (enableRawMode(¤t) == -1) {
1441 printf("%s", prompt);
1443 if (fgets(buf, sizeof(buf), stdin) == NULL) {
1446 count = strlen(buf);
1447 if (count && buf[count-1] == '\n') {
1455 current.bufmax = sizeof(buf);
1459 current.prompt = prompt;
1460 current.capture = NULL;
1462 count = linenoiseEdit(¤t);
1464 disableRawMode(¤t);
1467 free(current.capture);
1475 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1476 int linenoiseHistoryAdd(const char *line) {
1479 if (history_max_len == 0) return 0;
1480 if (history == NULL) {
1481 history = (char **)malloc(sizeof(char*)*history_max_len);
1482 if (history == NULL) return 0;
1483 memset(history,0,(sizeof(char*)*history_max_len));
1486 /* do not insert duplicate lines into history */
1487 if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1491 linecopy = strdup(line);
1492 if (!linecopy) return 0;
1493 if (history_len == history_max_len) {
1495 memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1498 history[history_len] = linecopy;
1503 int linenoiseHistoryGetMaxLen(void) {
1504 return history_max_len;
1507 int linenoiseHistorySetMaxLen(int len) {
1510 if (len < 1) return 0;
1512 int tocopy = history_len;
1514 newHistory = (char **)malloc(sizeof(char*)*len);
1515 if (newHistory == NULL) return 0;
1517 /* If we can't copy everything, free the elements we'll not use. */
1521 for (j = 0; j < tocopy-len; j++) free(history[j]);
1524 memset(newHistory,0,sizeof(char*)*len);
1525 memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
1527 history = newHistory;
1529 history_max_len = len;
1530 if (history_len > history_max_len)
1531 history_len = history_max_len;
1535 /* Save the history in the specified file. On success 0 is returned
1536 * otherwise -1 is returned. */
1537 int linenoiseHistorySave(const char *filename) {
1538 FILE *fp = fopen(filename,"w");
1541 if (fp == NULL) return -1;
1542 for (j = 0; j < history_len; j++) {
1543 const char *str = history[j];
1544 /* Need to encode backslash, nl and cr */
1549 else if (*str == '\n') {
1552 else if (*str == '\r') {
1567 /* Load the history from the specified file. If the file does not exist
1568 * zero is returned and no operation is performed.
1570 * If the file exists and the operation succeeded 0 is returned, otherwise
1571 * on error -1 is returned. */
1572 int linenoiseHistoryLoad(const char *filename) {
1573 FILE *fp = fopen(filename,"r");
1574 char buf[LINENOISE_MAX_LINE];
1576 if (fp == NULL) return -1;
1578 while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) {
1581 /* Decode backslash escaped values */
1582 for (src = dest = buf; *src; src++) {
1590 else if (*src == 'r') {
1598 /* Remove trailing newline */
1599 if (dest != buf && (dest[-1] == '\n' || dest[-1] == '\r')) {
1604 linenoiseHistoryAdd(buf);
1610 /* Provide access to the history buffer.
1612 * If 'len' is not NULL, the length is stored in *len.
1614 char **linenoiseHistory(int *len) {