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: clear from cursor to end of line
63 * CUF (CUrsor Forward)
65 * Effect: moves cursor forward n chars
67 * CR (Carriage Return)
69 * Effect: moves cursor to column 1
71 * The following are used to clear the screen: ESC [ H ESC [ 2 J
72 * This is actually composed of two sequences:
76 * Effect: moves the cursor to upper left corner
78 * ED2 (Clear entire screen)
80 * Effect: clear the whole screen
82 * == For highlighting control characters, we also use the following two ==
85 * Effect: Uses some standout mode such as reverse video
89 * Effect: Exit standout mode
91 * == Only used if TIOCGWINSZ fails ==
92 * DSR/CPR (Report cursor position)
94 * Effect: reports current cursor position as ESC [ NNN ; MMM R
96 * == Only used in multiline mode ==
99 * Effect: moves cursor up n chars.
102 * Sequence: ESC [ n B
103 * Effect: moves cursor down n chars.
107 * If __MINGW32__ is defined, the win32 console API is used.
108 * This could probably be made to work for the msvc compiler too.
109 * This support based in part on work by Jon Griffiths.
112 #ifdef _WIN32 /* Windows platform, either MinGW or Visual Studio (MSVC) */
115 #define USE_WINCONSOLE
117 #define HAVE_UNISTD_H
119 /* Microsoft headers don't like old POSIX names */
120 #define strdup _strdup
121 #define snprintf _snprintf
125 #include <sys/ioctl.h>
128 #define HAVE_UNISTD_H
142 #include <sys/types.h>
144 #include "linenoise.h"
146 #include "stringbuf.h"
150 #define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100
152 #define ctrl(C) ((C) - '@')
154 /* Use -ve numbers here to co-exist with normal unicode chars */
157 /* don't use -1 here since that indicates error */
162 SPECIAL_DELETE = -24,
165 SPECIAL_INSERT = -27,
166 SPECIAL_PAGE_UP = -28,
167 SPECIAL_PAGE_DOWN = -29,
169 /* Some handy names for other special keycodes */
174 static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
175 static int history_len = 0;
176 static char **history = NULL;
178 /* Structure to contain the status of the current (being edited) line */
180 stringbuf *buf; /* Current buffer. Always null terminated */
181 int pos; /* Cursor position, measured in chars */
182 int cols; /* Size of the window, in chars */
183 int nrows; /* How many rows are being used in multiline mode (>= 1) */
184 int rpos; /* The current row containing the cursor - multiline mode only */
185 int colsright; /* refreshLine() cached cols for insert_char() optimisation */
186 int colsleft; /* refreshLine() cached cols for remove_char() optimisation */
188 stringbuf *capture; /* capture buffer, or NULL for none. Always null terminated */
189 stringbuf *output; /* used only during refreshLine() - output accumulator */
190 #if defined(USE_TERMIOS)
191 int fd; /* Terminal fd */
192 #elif defined(USE_WINCONSOLE)
193 HANDLE outh; /* Console output handle */
194 HANDLE inh; /* Console input handle */
195 int rows; /* Screen rows */
196 int x; /* Current column during output */
197 int y; /* Current row */
199 #define UBUF_MAX_CHARS 132
200 WORD ubuf[UBUF_MAX_CHARS + 1]; /* Accumulates utf16 output - one extra for final surrogate pairs */
201 int ubuflen; /* length used in ubuf */
202 int ubufcols; /* how many columns are represented by the chars in ubuf? */
207 static int fd_read(struct current *current);
208 static int getWindowSize(struct current *current);
209 static void cursorDown(struct current *current, int n);
210 static void cursorUp(struct current *current, int n);
211 static void eraseEol(struct current *current);
212 static void refreshLine(struct current *current);
213 static void refreshLineAlt(struct current *current, const char *prompt, const char *buf, int cursor_pos);
214 static void setCursorPos(struct current *current, int x);
215 static void setOutputHighlight(struct current *current, const int *props, int nprops);
216 static void set_current(struct current *current, const char *str);
218 void linenoiseHistoryFree(void) {
222 for (j = 0; j < history_len; j++)
232 EP_START, /* looking for ESC */
233 EP_ESC, /* looking for [ */
234 EP_DIGITS, /* parsing digits */
235 EP_PROPS, /* parsing digits or semicolons */
237 EP_ERROR, /* error */
239 int props[5]; /* properties are stored here */
240 int maxprops; /* size of the props[] array */
241 int numprops; /* number of properties found */
242 int termchar; /* terminator char, or 0 for any alpha */
243 int current; /* current (partial) property value */
247 * Initialise the escape sequence parser at *parser.
249 * If termchar is 0 any alpha char terminates ok. Otherwise only the given
250 * char terminates successfully.
251 * Run the parser state machine with calls to parseEscapeSequence() for each char.
253 static void initParseEscapeSeq(struct esc_parser *parser, int termchar)
255 parser->state = EP_START;
256 parser->maxprops = sizeof(parser->props) / sizeof(*parser->props);
257 parser->numprops = 0;
259 parser->termchar = termchar;
263 * Pass character 'ch' into the state machine to parse:
264 * 'ESC' '[' <digits> (';' <digits>)* <termchar>
266 * The first character must be ESC.
267 * Returns the current state. The state machine is done when it returns either EP_END
270 * On EP_END, the "property/attribute" values can be read from parser->props[]
271 * of length parser->numprops.
273 static int parseEscapeSequence(struct esc_parser *parser, int ch)
275 switch (parser->state) {
277 parser->state = (ch == '\x1b') ? EP_ESC : EP_ERROR;
280 parser->state = (ch == '[') ? EP_DIGITS : EP_ERROR;
284 parser->state = EP_DIGITS;
286 if (parser->numprops + 1 < parser->maxprops) {
287 parser->props[parser->numprops++] = parser->current;
294 if (ch >= '0' && ch <= '9') {
295 parser->current = parser->current * 10 + (ch - '0');
296 parser->state = EP_PROPS;
299 /* must be terminator */
300 if (parser->termchar != ch) {
301 if (parser->termchar != 0 || !((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z'))) {
302 parser->state = EP_ERROR;
306 parser->state = EP_END;
309 parser->state = EP_ERROR;
314 return parser->state;
317 /*#define DEBUG_REFRESHLINE*/
319 #ifdef DEBUG_REFRESHLINE
320 #define DRL(ARGS...) fprintf(dfh, ARGS)
323 static void DRL_CHAR(int ch)
326 DRL("^%c", ch + '@');
335 static void DRL_STR(const char *str)
339 int n = utf8_tounicode(str, &ch);
350 #if defined(USE_WINCONSOLE)
351 #include "linenoise-win32.c"
354 #if defined(USE_TERMIOS)
355 static void linenoiseAtExit(void);
356 static struct termios orig_termios; /* in order to restore at exit */
357 static int rawmode = 0; /* for atexit() function to check if restore is needed*/
358 static int atexit_registered = 0; /* register atexit just 1 time */
360 static const char *unsupported_term[] = {"dumb","cons25","emacs",NULL};
362 static int isUnsupportedTerm(void) {
363 char *term = getenv("TERM");
367 for (j = 0; unsupported_term[j]; j++) {
368 if (strcmp(term, unsupported_term[j]) == 0) {
376 static int enableRawMode(struct current *current) {
379 current->fd = STDIN_FILENO;
382 if (!isatty(current->fd) || isUnsupportedTerm() ||
383 tcgetattr(current->fd, &orig_termios) == -1) {
389 if (!atexit_registered) {
390 atexit(linenoiseAtExit);
391 atexit_registered = 1;
394 raw = orig_termios; /* modify the original mode */
395 /* input modes: no break, no CR to NL, no parity check, no strip char,
396 * no start/stop output control. */
397 raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
398 /* output modes - actually, no need to disable post processing */
399 /*raw.c_oflag &= ~(OPOST);*/
400 /* control modes - set 8 bit chars */
401 raw.c_cflag |= (CS8);
402 /* local modes - choing off, canonical off, no extended functions,
403 * no signal chars (^Z,^C) */
404 raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
405 /* control chars - set return condition: min number of bytes and timer.
406 * We want read to return every single byte, without timeout. */
407 raw.c_cc[VMIN] = 1; raw.c_cc[VTIME] = 0; /* 1 byte, no timer */
409 /* put terminal in raw mode after flushing */
410 if (tcsetattr(current->fd,TCSADRAIN,&raw) < 0) {
417 static void disableRawMode(struct current *current) {
418 /* Don't even check the return value as it's too late. */
419 if (rawmode && tcsetattr(current->fd,TCSADRAIN,&orig_termios) != -1)
423 /* At exit we'll try to fix the terminal to the initial conditions. */
424 static void linenoiseAtExit(void) {
426 tcsetattr(STDIN_FILENO, TCSADRAIN, &orig_termios);
428 linenoiseHistoryFree();
431 /* gcc/glibc insists that we care about the return code of write!
432 * Clarification: This means that a void-cast like "(void) (EXPR)"
435 #define IGNORE_RC(EXPR) if (EXPR) {}
438 * Output bytes directly, or accumulate output (if current->output is set)
440 static void outputChars(struct current *current, const char *buf, int len)
445 if (current->output) {
446 sb_append_len(current->output, buf, len);
449 IGNORE_RC(write(current->fd, buf, len));
453 /* Like outputChars, but using printf-style formatting
455 static void outputFormatted(struct current *current, const char *format, ...)
461 va_start(args, format);
462 n = vsnprintf(buf, sizeof(buf), format, args);
463 /* This will never happen because we are sure to use outputFormatted() only for short sequences */
464 assert(n < (int)sizeof(buf));
466 outputChars(current, buf, n);
469 static void cursorToLeft(struct current *current)
471 outputChars(current, "\r", -1);
474 static void setOutputHighlight(struct current *current, const int *props, int nprops)
476 outputChars(current, "\x1b[", -1);
478 outputFormatted(current, "%d%c", *props, (nprops == 0) ? 'm' : ';');
483 static void eraseEol(struct current *current)
485 outputChars(current, "\x1b[0K", -1);
488 static void setCursorPos(struct current *current, int x)
491 cursorToLeft(current);
494 outputFormatted(current, "\r\x1b[%dC", x);
498 static void cursorUp(struct current *current, int n)
501 outputFormatted(current, "\x1b[%dA", n);
505 static void cursorDown(struct current *current, int n)
508 outputFormatted(current, "\x1b[%dB", n);
512 void linenoiseClearScreen(void)
514 IGNORE_RC(write(STDOUT_FILENO, "\x1b[H\x1b[2J", 7));
518 * Reads a char from 'fd', waiting at most 'timeout' milliseconds.
520 * A timeout of -1 means to wait forever.
522 * Returns -1 if no char is received within the time or an error occurs.
524 static int fd_read_char(int fd, int timeout)
532 if (poll(&p, 1, timeout) == 0) {
536 if (read(fd, &c, 1) != 1) {
543 * Reads a complete utf-8 character
544 * and returns the unicode value, or -1 on error.
546 static int fd_read(struct current *current)
549 char buf[MAX_UTF8_LEN];
554 if (read(current->fd, &buf[0], 1) != 1) {
557 n = utf8_charlen(buf[0]);
561 for (i = 1; i < n; i++) {
562 if (read(current->fd, &buf[i], 1) != 1) {
566 /* decode and return the character */
567 utf8_tounicode(buf, &c);
570 return fd_read_char(current->fd, -1);
576 * Stores the current cursor column in '*cols'.
577 * Returns 1 if OK, or 0 if failed to determine cursor pos.
579 static int queryCursor(struct current *current, int* cols)
581 struct esc_parser parser;
584 /* Should not be buffering this output, it needs to go immediately */
585 assert(current->output == NULL);
587 /* control sequence - report cursor location */
588 outputChars(current, "\x1b[6n", -1);
590 /* Parse the response: ESC [ rows ; cols R */
591 initParseEscapeSeq(&parser, 'R');
592 while ((ch = fd_read_char(current->fd, 100)) > 0) {
593 switch (parseEscapeSequence(&parser, ch)) {
597 if (parser.numprops == 2 && parser.props[1] < 1000) {
598 *cols = parser.props[1];
612 * Updates current->cols with the current window size (width)
614 static int getWindowSize(struct current *current)
618 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
619 current->cols = ws.ws_col;
623 /* Failed to query the window size. Perhaps we are on a serial terminal.
624 * Try to query the width by sending the cursor as far to the right
625 * and reading back the cursor position.
626 * Note that this is only done once per call to linenoise rather than
627 * every time the line is refreshed for efficiency reasons.
629 * In more detail, we:
630 * (a) request current cursor position,
631 * (b) move cursor far right,
632 * (c) request cursor position again,
633 * (d) at last move back to the old position.
634 * This gives us the width without messing with the externally
635 * visible cursor position.
638 if (current->cols == 0) {
641 /* If anything fails => default 80 */
645 if (queryCursor (current, &here)) {
647 setCursorPos(current, 999);
649 /* (c). Note: If (a) succeeded, then (c) should as well.
650 * For paranoia we still check and have a fallback action
651 * for (d) in case of failure..
653 if (queryCursor (current, ¤t->cols)) {
654 /* (d) Reset the cursor back to the original location. */
655 if (current->cols > here) {
656 setCursorPos(current, here);
666 * If CHAR_ESCAPE was received, reads subsequent
667 * chars to determine if this is a known special key.
669 * Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
671 * If no additional char is received within a short time,
672 * CHAR_ESCAPE is returned.
674 static int check_special(int fd)
676 int c = fd_read_char(fd, 50);
683 c2 = fd_read_char(fd, 50);
687 if (c == '[' || c == 'O') {
688 /* Potential arrow key */
695 return SPECIAL_RIGHT;
704 if (c == '[' && c2 >= '1' && c2 <= '8') {
705 /* extended escape */
706 c = fd_read_char(fd, 50);
710 return SPECIAL_INSERT;
712 return SPECIAL_DELETE;
714 return SPECIAL_PAGE_UP;
716 return SPECIAL_PAGE_DOWN;
723 while (c != -1 && c != '~') {
724 /* .e.g \e[12~ or '\e[11;2~ discard the complete sequence */
725 c = fd_read_char(fd, 50);
733 static void clearOutputHighlight(struct current *current)
736 setOutputHighlight(current, &nohighlight, 1);
739 static void outputControlChar(struct current *current, char ch)
742 setOutputHighlight(current, &reverse, 1);
743 outputChars(current, "^", 1);
744 outputChars(current, &ch, 1);
745 clearOutputHighlight(current);
748 #ifndef utf8_getchars
749 static int utf8_getchars(char *buf, int c)
752 return utf8_fromunicode(buf, c);
761 * Returns the unicode character at the given offset,
764 static int get_char(struct current *current, int pos)
766 if (pos >= 0 && pos < sb_chars(current->buf)) {
768 int i = utf8_index(sb_str(current->buf), pos);
769 (void)utf8_tounicode(sb_str(current->buf) + i, &c);
775 static int char_display_width(int ch)
778 /* control chars take two positions */
782 return utf8_width(ch);
786 #ifndef NO_COMPLETION
787 static linenoiseCompletionCallback *completionCallback = NULL;
788 static void *completionUserdata = NULL;
789 static int showhints = 1;
790 static linenoiseHintsCallback *hintsCallback = NULL;
791 static linenoiseFreeHintsCallback *freeHintsCallback = NULL;
792 static void *hintsUserdata = NULL;
796 fprintf(stderr, "\x7");
801 static void freeCompletions(linenoiseCompletions *lc) {
803 for (i = 0; i < lc->len; i++)
808 static int completeLine(struct current *current) {
809 linenoiseCompletions lc = { 0, NULL };
812 completionCallback(sb_str(current->buf),&lc,completionUserdata);
816 size_t stop = 0, i = 0;
819 /* Show completion or original buffer */
821 int chars = utf8_strlen(lc.cvec[i], -1);
822 refreshLineAlt(current, current->prompt, lc.cvec[i], chars);
824 refreshLine(current);
827 c = fd_read(current);
834 i = (i+1) % (lc.len+1);
835 if (i == lc.len) beep();
837 case CHAR_ESCAPE: /* escape */
838 /* Re-show original buffer */
840 refreshLine(current);
845 /* Update buffer and return */
847 set_current(current,lc.cvec[i]);
855 freeCompletions(&lc);
856 return c; /* Return last read character */
859 /* Register a callback function to be called for tab-completion.
860 Returns the prior callback so that the caller may (if needed)
861 restore it when done. */
862 linenoiseCompletionCallback * linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn, void *userdata) {
863 linenoiseCompletionCallback * old = completionCallback;
864 completionCallback = fn;
865 completionUserdata = userdata;
869 void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
870 lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
871 lc->cvec[lc->len++] = strdup(str);
874 void linenoiseSetHintsCallback(linenoiseHintsCallback *callback, void *userdata)
876 hintsCallback = callback;
877 hintsUserdata = userdata;
880 void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *callback)
882 freeHintsCallback = callback;
888 static const char *reduceSingleBuf(const char *buf, int availcols, int *cursor_pos)
890 /* We have availcols columns available.
891 * If necessary, strip chars off the front of buf until *cursor_pos
892 * fits within availcols
896 int new_cursor_pos = *cursor_pos;
897 const char *pt = buf;
899 DRL("reduceSingleBuf: availcols=%d, cursor_pos=%d\n", availcols, *cursor_pos);
903 int n = utf8_tounicode(pt, &ch);
906 needcols += char_display_width(ch);
908 /* If we need too many cols, strip
909 * chars off the front of buf to make it fit.
910 * We keep 3 extra cols to the right of the cursor.
911 * 2 for possible wide chars, 1 for the last column that
914 while (needcols >= availcols - 3) {
915 n = utf8_tounicode(buf, &ch);
917 needcols -= char_display_width(ch);
920 /* and adjust the apparent cursor position */
924 /* can't remove more than this */
929 if (pos++ == *cursor_pos) {
936 DRL("\nafter reduce, needcols=%d, new_cursor_pos=%d\n", needcols, new_cursor_pos);
938 /* Done, now new_cursor_pos contains the adjusted cursor position
939 * and buf points to he adjusted start
941 *cursor_pos = new_cursor_pos;
945 static int mlmode = 0;
947 void linenoiseSetMultiLine(int enableml)
952 /* Helper of refreshSingleLine() and refreshMultiLine() to show hints
953 * to the right of the prompt.
954 * Returns 1 if a hint was shown, or 0 if not
955 * If 'display' is 0, does no output. Just returns the appropriate return code.
957 static int refreshShowHints(struct current *current, const char *buf, int availcols, int display)
960 if (showhints && hintsCallback && availcols > 0) {
963 char *hint = hintsCallback(buf, &color, &bold, hintsUserdata);
968 if (bold == 1 && color == -1) color = 37;
969 if (bold || color > 0) {
970 int props[3] = { bold, color, 49 }; /* bold, color, fgnormal */
971 setOutputHighlight(current, props, 3);
973 DRL("<hint bold=%d,color=%d>", bold, color);
977 int n = utf8_tounicode(pt, &ch);
978 int width = char_display_width(ch);
980 if (width >= availcols) {
987 outputChars(current, pt, n);
990 if (bold || color > 0) {
991 clearOutputHighlight(current);
993 /* Call the function to free the hint returned. */
994 if (freeHintsCallback) freeHintsCallback(hint, hintsUserdata);
1002 static void refreshStart(struct current *current)
1004 /* We accumulate all output here */
1005 assert(current->output == NULL);
1006 current->output = sb_alloc();
1009 static void refreshEnd(struct current *current)
1011 /* Output everything at once */
1012 IGNORE_RC(write(current->fd, sb_str(current->output), sb_len(current->output)));
1013 sb_free(current->output);
1014 current->output = NULL;
1017 static void refreshStartChars(struct current *current)
1021 static void refreshNewline(struct current *current)
1024 outputChars(current, "\n", 1);
1027 static void refreshEndChars(struct current *current)
1032 static void refreshLineAlt(struct current *current, const char *prompt, const char *buf, int cursor_pos)
1044 struct esc_parser parser;
1046 #ifdef DEBUG_REFRESHLINE
1047 dfh = fopen("linenoise.debuglog", "a");
1050 /* Should intercept SIGWINCH. For now, just get the size every time */
1051 getWindowSize(current);
1053 refreshStart(current);
1055 DRL("wincols=%d, cursor_pos=%d, nrows=%d, rpos=%d\n", current->cols, cursor_pos, current->nrows, current->rpos);
1057 /* Here is the plan:
1058 * (a) move the the bottom row, going down the appropriate number of lines
1059 * (b) move to beginning of line and erase the current line
1060 * (c) go up one line and do the same, until we have erased up to the first row
1061 * (d) output the prompt, counting cols and rows, taking into account escape sequences
1062 * (e) output the buffer, counting cols and rows
1063 * (e') when we hit the current pos, save the cursor position
1064 * (f) move the cursor to the saved cursor position
1065 * (g) save the current cursor row and number of rows
1068 /* (a) - The cursor is currently at row rpos */
1069 cursorDown(current, current->nrows - current->rpos - 1);
1070 DRL("<cud=%d>", current->nrows - current->rpos - 1);
1072 /* (b), (c) - Erase lines upwards until we get to the first row */
1073 for (i = 0; i < current->nrows; i++) {
1076 cursorUp(current, 1);
1079 cursorToLeft(current);
1084 /* (d) First output the prompt. control sequences don't take up display space */
1086 displaycol = 0; /* current display column */
1087 displayrow = 0; /* current display row */
1090 refreshStartChars(current);
1095 int n = utf8_tounicode(pt, &ch);
1097 if (visible && ch == CHAR_ESCAPE) {
1098 /* The start of an escape sequence, so not visible */
1100 initParseEscapeSeq(&parser, 'm');
1101 DRL("<esc-seq-start>");
1104 if (ch == '\n' || ch == '\r') {
1105 /* treat both CR and NL the same and force wrap */
1106 refreshNewline(current);
1111 width = visible * utf8_width(ch);
1113 displaycol += width;
1114 if (displaycol >= current->cols) {
1115 /* need to wrap to the next line because of newline or if it doesn't fit
1116 * XXX this is a problem in single line mode
1118 refreshNewline(current);
1124 #ifdef USE_WINCONSOLE
1126 outputChars(current, pt, n);
1129 outputChars(current, pt, n);
1135 switch (parseEscapeSequence(&parser, ch)) {
1138 setOutputHighlight(current, parser.props, parser.numprops);
1139 DRL("<esc-seq-end,numprops=%d>", parser.numprops);
1142 DRL("<esc-seq-err>");
1149 /* Now we are at the first line with all lines erased */
1150 DRL("\nafter prompt: displaycol=%d, displayrow=%d\n", displaycol, displayrow);
1153 /* (e) output the buffer, counting cols and rows */
1155 /* In this mode we may need to trim chars from the start of the buffer until the
1156 * cursor fits in the window.
1158 pt = reduceSingleBuf(buf, current->cols - displaycol, &cursor_pos);
1169 int n = utf8_tounicode(pt, &ch);
1170 int width = char_display_width(ch);
1172 if (currentpos == cursor_pos) {
1173 /* (e') wherever we output this character is where we want the cursor */
1177 if (displaycol + width >= current->cols) {
1179 /* In single line mode stop once we print as much as we can on one line */
1183 /* need to wrap to the next line since it doesn't fit */
1184 refreshNewline(current);
1189 if (notecursor == 1) {
1190 /* (e') Save this position as the current cursor position */
1191 cursorcol = displaycol;
1192 cursorrow = displayrow;
1197 displaycol += width;
1200 outputControlChar(current, ch + '@');
1203 outputChars(current, pt, n);
1207 DRL("<w=%d>", width);
1214 /* If we didn't see the cursor, it is at the current location */
1217 cursorcol = displaycol;
1218 cursorrow = displayrow;
1221 DRL("\nafter buf: displaycol=%d, displayrow=%d, cursorcol=%d, cursorrow=%d\n", displaycol, displayrow, cursorcol, cursorrow);
1223 /* (f) show hints */
1224 hint = refreshShowHints(current, buf, current->cols - displaycol, 1);
1226 /* Remember how many many cols are available for insert optimisation */
1227 if (prompt == current->prompt && hint == 0) {
1228 current->colsright = current->cols - displaycol;
1229 current->colsleft = displaycol;
1232 /* Can't optimise */
1233 current->colsright = 0;
1234 current->colsleft = 0;
1236 DRL("\nafter hints: colsleft=%d, colsright=%d\n\n", current->colsleft, current->colsright);
1238 refreshEndChars(current);
1240 /* (g) move the cursor to the correct place */
1241 cursorUp(current, displayrow - cursorrow);
1242 setCursorPos(current, cursorcol);
1244 /* (h) Update the number of rows if larger, but never reduce this */
1245 if (displayrow >= current->nrows) {
1246 current->nrows = displayrow + 1;
1248 /* And remember the row that the cursor is on */
1249 current->rpos = cursorrow;
1251 refreshEnd(current);
1253 #ifdef DEBUG_REFRESHLINE
1258 static void refreshLine(struct current *current)
1260 refreshLineAlt(current, current->prompt, sb_str(current->buf), current->pos);
1263 static void set_current(struct current *current, const char *str)
1265 sb_clear(current->buf);
1266 sb_append(current->buf, str);
1267 current->pos = sb_chars(current->buf);
1271 * Removes the char at 'pos'.
1273 * Returns 1 if the line needs to be refreshed, 2 if not
1274 * and 0 if nothing was removed
1276 static int remove_char(struct current *current, int pos)
1278 if (pos >= 0 && pos < sb_chars(current->buf)) {
1279 int offset = utf8_index(sb_str(current->buf), pos);
1280 int nbytes = utf8_index(sb_str(current->buf) + offset, 1);
1283 /* Now we try to optimise in the simple but very common case that:
1284 * - we are remove the char at EOL
1285 * - the buffer is not empty
1286 * - there are columns available to the left
1287 * - the char being deleted is not a wide or utf-8 character
1288 * - no hints are being shown
1290 if (current->pos == pos + 1 && current->pos == sb_chars(current->buf) && pos > 0) {
1292 /* Could implement utf8_prev_len() but simplest just to not optimise this case */
1293 char last = sb_str(current->buf)[offset];
1297 if (current->colsleft > 0 && (last & 0x80) == 0) {
1298 /* Have cols on the left and not a UTF-8 char or continuation */
1299 /* Yes, can optimise */
1300 current->colsleft--;
1301 current->colsright++;
1306 sb_delete(current->buf, offset, nbytes);
1308 if (current->pos > pos) {
1312 if (refreshShowHints(current, sb_str(current->buf), current->colsright, 0)) {
1313 /* A hint needs to be shown, so can't optimise after all */
1317 /* optimised output */
1318 outputChars(current, "\b \b", 3);
1328 * Insert 'ch' at position 'pos'
1330 * Returns 1 if the line needs to be refreshed, 2 if not
1331 * and 0 if nothing was inserted (no room)
1333 static int insert_char(struct current *current, int pos, int ch)
1335 if (pos >= 0 && pos <= sb_chars(current->buf)) {
1336 char buf[MAX_UTF8_LEN + 1];
1337 int offset = utf8_index(sb_str(current->buf), pos);
1338 int n = utf8_getchars(buf, ch);
1341 /* null terminate since sb_insert() requires it */
1344 /* Now we try to optimise in the simple but very common case that:
1345 * - we are inserting at EOL
1346 * - there are enough columns available
1347 * - no hints are being shown
1349 if (pos == current->pos && pos == sb_chars(current->buf)) {
1350 int width = char_display_width(ch);
1351 if (current->colsright > width) {
1352 /* Yes, can optimise */
1353 current->colsright -= width;
1354 current->colsleft -= width;
1358 sb_insert(current->buf, offset, buf);
1359 if (current->pos >= pos) {
1363 if (refreshShowHints(current, sb_str(current->buf), current->colsright, 0)) {
1364 /* A hint needs to be shown, so can't optimise after all */
1368 /* optimised output */
1369 outputChars(current, buf, n);
1378 * Captures up to 'n' characters starting at 'pos' for the cut buffer.
1380 * This replaces any existing characters in the cut buffer.
1382 static void capture_chars(struct current *current, int pos, int nchars)
1384 if (pos >= 0 && (pos + nchars - 1) < sb_chars(current->buf)) {
1385 int offset = utf8_index(sb_str(current->buf), pos);
1386 int nbytes = utf8_index(sb_str(current->buf) + offset, nchars);
1389 if (current->capture) {
1390 sb_clear(current->capture);
1393 current->capture = sb_alloc();
1395 sb_append_len(current->capture, sb_str(current->buf) + offset, nbytes);
1401 * Removes up to 'n' characters at cursor position 'pos'.
1403 * Returns 0 if no chars were removed or non-zero otherwise.
1405 static int remove_chars(struct current *current, int pos, int n)
1409 /* First save any chars which will be removed */
1410 capture_chars(current, pos, n);
1412 while (n-- && remove_char(current, pos)) {
1418 * Inserts the characters (string) 'chars' at the cursor position 'pos'.
1420 * Returns 0 if no chars were inserted or non-zero otherwise.
1422 static int insert_chars(struct current *current, int pos, const char *chars)
1428 int n = utf8_tounicode(chars, &ch);
1429 if (insert_char(current, pos, ch) == 0) {
1440 * Returns the keycode to process, or 0 if none.
1442 static int reverseIncrementalSearch(struct current *current)
1444 /* Display the reverse-i-search prompt and process chars */
1449 int searchpos = history_len - 1;
1455 const char *p = NULL;
1459 snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
1460 refreshLineAlt(current, rprompt, sb_str(current->buf), current->pos);
1461 c = fd_read(current);
1462 if (c == ctrl('H') || c == CHAR_DELETE) {
1464 int p = utf8_index(rbuf, --rchars);
1466 rlen = strlen(rbuf);
1471 if (c == CHAR_ESCAPE) {
1472 c = check_special(current->fd);
1475 if (c == ctrl('P') || c == SPECIAL_UP) {
1476 /* Search for the previous (earlier) match */
1477 if (searchpos > 0) {
1482 else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1483 /* Search for the next (later) match */
1484 if (searchpos < history_len) {
1490 else if (c >= ' ') {
1491 /* >= here to allow for null terminator */
1492 if (rlen >= (int)sizeof(rbuf) - MAX_UTF8_LEN) {
1496 n = utf8_getchars(rbuf + rlen, c);
1501 /* Adding a new char resets the search location */
1502 searchpos = history_len - 1;
1505 /* Exit from incremental search mode */
1509 /* Now search through the history for a match */
1510 for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1511 p = strstr(history[searchpos], rbuf);
1514 if (skipsame && strcmp(history[searchpos], sb_str(current->buf)) == 0) {
1515 /* But it is identical, so skip it */
1518 /* Copy the matching line and set the cursor position */
1519 set_current(current,history[searchpos]);
1520 current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
1525 /* No match, so don't add it */
1531 if (c == ctrl('G') || c == ctrl('C')) {
1532 /* ctrl-g terminates the search with no effect */
1533 set_current(current, "");
1536 else if (c == ctrl('J')) {
1537 /* ctrl-j terminates the search leaving the buffer in place */
1541 /* Go process the char normally */
1542 refreshLine(current);
1546 static int linenoiseEdit(struct current *current) {
1547 int history_index = 0;
1549 /* The latest history entry is always our current buffer, that
1550 * initially is just an empty string. */
1551 linenoiseHistoryAdd("");
1553 set_current(current, "");
1554 refreshLine(current);
1558 int c = fd_read(current);
1560 #ifndef NO_COMPLETION
1561 /* Only autocomplete when the callback is set. It returns < 0 when
1562 * there was an error reading from fd. Otherwise it will return the
1563 * character that should be handled next. */
1564 if (c == '\t' && current->pos == sb_chars(current->buf) && completionCallback != NULL) {
1565 c = completeLine(current);
1568 if (c == ctrl('R')) {
1569 /* reverse incremental search will provide an alternative keycode or 0 for none */
1570 c = reverseIncrementalSearch(current);
1571 /* go on to process the returned char normally */
1575 if (c == CHAR_ESCAPE) { /* escape sequence */
1576 c = check_special(current->fd);
1580 /* Return on errors */
1581 return sb_len(current->buf);
1587 case '\r': /* enter/CR */
1590 free(history[history_len]);
1591 current->pos = sb_chars(current->buf);
1592 if (mlmode || hintsCallback) {
1594 refreshLine(current);
1597 return sb_len(current->buf);
1598 case ctrl('C'): /* ctrl-c */
1601 case ctrl('Z'): /* ctrl-z */
1603 /* send ourselves SIGSUSP */
1604 disableRawMode(current);
1607 enableRawMode(current);
1608 refreshLine(current);
1611 case CHAR_DELETE: /* backspace */
1613 if (remove_char(current, current->pos - 1) == 1) {
1614 refreshLine(current);
1617 case ctrl('D'): /* ctrl-d */
1618 if (sb_len(current->buf) == 0) {
1619 /* Empty line, so EOF */
1621 free(history[history_len]);
1624 /* Otherwise fall through to delete char to right of cursor */
1625 case SPECIAL_DELETE:
1626 if (remove_char(current, current->pos) == 1) {
1627 refreshLine(current);
1630 case SPECIAL_INSERT:
1631 /* Ignore. Expansion Hook.
1632 * Future possibility: Toggle Insert/Overwrite Modes
1635 case ctrl('W'): /* ctrl-w, delete word at left. save deleted chars */
1636 /* eat any spaces on the left */
1638 int pos = current->pos;
1639 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1643 /* now eat any non-spaces on the left */
1644 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1648 if (remove_chars(current, pos, current->pos - pos)) {
1649 refreshLine(current);
1653 case ctrl('T'): /* ctrl-t */
1654 if (current->pos > 0 && current->pos <= sb_chars(current->buf)) {
1655 /* If cursor is at end, transpose the previous two chars */
1656 int fixer = (current->pos == sb_chars(current->buf));
1657 c = get_char(current, current->pos - fixer);
1658 remove_char(current, current->pos - fixer);
1659 insert_char(current, current->pos - 1, c);
1660 refreshLine(current);
1663 case ctrl('V'): /* ctrl-v */
1664 /* Insert the ^V first */
1665 if (insert_char(current, current->pos, c)) {
1666 refreshLine(current);
1667 /* Now wait for the next char. Can insert anything except \0 */
1668 c = fd_read(current);
1670 /* Remove the ^V first */
1671 remove_char(current, current->pos - 1);
1673 /* Insert the actual char, can't be error or null */
1674 insert_char(current, current->pos, c);
1676 refreshLine(current);
1681 if (current->pos > 0) {
1683 refreshLine(current);
1688 if (current->pos < sb_chars(current->buf)) {
1690 refreshLine(current);
1693 case SPECIAL_PAGE_UP:
1694 dir = history_len - history_index - 1; /* move to start of history */
1695 goto history_navigation;
1696 case SPECIAL_PAGE_DOWN:
1697 dir = -history_index; /* move to 0 == end of history, i.e. current */
1698 goto history_navigation;
1702 goto history_navigation;
1706 if (history_len > 1) {
1707 /* Update the current history entry before to
1708 * overwrite it with tne next one. */
1709 free(history[history_len - 1 - history_index]);
1710 history[history_len - 1 - history_index] = strdup(sb_str(current->buf));
1711 /* Show the new entry */
1712 history_index += dir;
1713 if (history_index < 0) {
1716 } else if (history_index >= history_len) {
1717 history_index = history_len - 1;
1720 set_current(current, history[history_len - 1 - history_index]);
1721 refreshLine(current);
1724 case ctrl('A'): /* Ctrl+a, go to the start of the line */
1727 refreshLine(current);
1729 case ctrl('E'): /* ctrl+e, go to the end of the line */
1731 current->pos = sb_chars(current->buf);
1732 refreshLine(current);
1734 case ctrl('U'): /* Ctrl+u, delete to beginning of line, save deleted chars. */
1735 if (remove_chars(current, 0, current->pos)) {
1736 refreshLine(current);
1739 case ctrl('K'): /* Ctrl+k, delete from current to end of line, save deleted chars. */
1740 if (remove_chars(current, current->pos, sb_chars(current->buf) - current->pos)) {
1741 refreshLine(current);
1744 case ctrl('Y'): /* Ctrl+y, insert saved chars at current position */
1745 if (current->capture && insert_chars(current, current->pos, sb_str(current->capture))) {
1746 refreshLine(current);
1749 case ctrl('L'): /* Ctrl+L, clear screen */
1750 linenoiseClearScreen();
1751 /* Force recalc of window size for serial terminals */
1754 refreshLine(current);
1757 /* Only tab is allowed without ^V */
1758 if (c == '\t' || c >= ' ') {
1759 if (insert_char(current, current->pos, c) == 1) {
1760 refreshLine(current);
1766 return sb_len(current->buf);
1769 int linenoiseColumns(void)
1771 struct current current;
1772 current.output = NULL;
1773 enableRawMode (¤t);
1774 getWindowSize (¤t);
1775 disableRawMode (¤t);
1776 return current.cols;
1780 * Reads a line from the file handle (without the trailing NL or CRNL)
1781 * and returns it in a stringbuf.
1782 * Returns NULL if no characters are read before EOF or error.
1784 * Note that the character count will *not* be correct for lines containing
1785 * utf8 sequences. Do not rely on the character count.
1787 static stringbuf *sb_getline(FILE *fh)
1789 stringbuf *sb = sb_alloc();
1793 while ((c = getc(fh)) != EOF) {
1800 if (c == '\n' || c == '\r') {
1804 /* ignore the effect of character count for partial utf8 sequences */
1805 sb_append_len(sb, &ch, 1);
1814 char *linenoise(const char *prompt)
1817 struct current current;
1820 memset(¤t, 0, sizeof(current));
1822 if (enableRawMode(¤t) == -1) {
1823 printf("%s", prompt);
1825 sb = sb_getline(stdin);
1828 current.buf = sb_alloc();
1831 current.prompt = prompt;
1833 count = linenoiseEdit(¤t);
1835 disableRawMode(¤t);
1838 sb_free(current.capture);
1840 sb_free(current.buf);
1845 return sb ? sb_to_string(sb) : NULL;
1848 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1849 int linenoiseHistoryAddAllocated(char *line) {
1851 if (history_max_len == 0) {
1856 if (history == NULL) {
1857 history = (char **)calloc(sizeof(char*), history_max_len);
1860 /* do not insert duplicate lines into history */
1861 if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1865 if (history_len == history_max_len) {
1867 memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1870 history[history_len] = line;
1875 int linenoiseHistoryAdd(const char *line) {
1876 return linenoiseHistoryAddAllocated(strdup(line));
1879 int linenoiseHistoryGetMaxLen(void) {
1880 return history_max_len;
1883 int linenoiseHistorySetMaxLen(int len) {
1886 if (len < 1) return 0;
1888 int tocopy = history_len;
1890 newHistory = (char **)calloc(sizeof(char*), len);
1892 /* If we can't copy everything, free the elements we'll not use. */
1896 for (j = 0; j < tocopy-len; j++) free(history[j]);
1899 memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
1901 history = newHistory;
1903 history_max_len = len;
1904 if (history_len > history_max_len)
1905 history_len = history_max_len;
1909 /* Save the history in the specified file. On success 0 is returned
1910 * otherwise -1 is returned. */
1911 int linenoiseHistorySave(const char *filename) {
1912 FILE *fp = fopen(filename,"w");
1915 if (fp == NULL) return -1;
1916 for (j = 0; j < history_len; j++) {
1917 const char *str = history[j];
1918 /* Need to encode backslash, nl and cr */
1923 else if (*str == '\n') {
1926 else if (*str == '\r') {
1941 /* Load the history from the specified file.
1943 * If the file does not exist or can't be opened, no operation is performed
1944 * and -1 is returned.
1945 * Otherwise 0 is returned.
1947 int linenoiseHistoryLoad(const char *filename) {
1948 FILE *fp = fopen(filename,"r");
1951 if (fp == NULL) return -1;
1953 while ((sb = sb_getline(fp)) != NULL) {
1954 /* Take the stringbuf and decode backslash escaped values */
1955 char *buf = sb_to_string(sb);
1959 for (src = buf; *src; src++) {
1967 else if (*src == 'r') {
1977 linenoiseHistoryAddAllocated(buf);
1983 /* Provide access to the history buffer.
1985 * If 'len' is not NULL, the length is stored in *len.
1987 char **linenoiseHistory(int *len) {