]> git.lizzy.rs Git - linenoise.git/blob - linenoise.c
Bug fix. Fix fallback code for getting the terminal width.
[linenoise.git] / linenoise.c
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.
3  *
4  * You can find the latest source code at:
5  *
6  *   http://github.com/msteveb/linenoise
7  *   (forked from http://github.com/antirez/linenoise)
8  *
9  * Does a number of crazy assumptions that happen to be true in 99.9999% of
10  * the 2010 UNIX computers around.
11  *
12  * ------------------------------------------------------------------------
13  *
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>
17  *
18  * All rights reserved.
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions are
22  * met:
23  *
24  *  *  Redistributions of source code must retain the above copyright
25  *     notice, this list of conditions and the following disclaimer.
26  *
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.
30  *
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.
42  *
43  * ------------------------------------------------------------------------
44  *
45  * References:
46  * - http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
47  * - http://www.3waylabs.com/nw/WWW/products/wizcon/vt220.html
48  *
49  * Bloat:
50  * - Completion?
51  *
52  * Unix/termios
53  * ------------
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.
58  *
59  * EL (Erase Line)
60  *    Sequence: ESC [ n K
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
64  *
65  * CUF (CUrsor Forward)
66  *    Sequence: ESC [ n C
67  *    Effect: moves cursor forward of n chars
68  *
69  * CR (Carriage Return)
70  *    Sequence: \r
71  *    Effect: moves cursor to column 1
72  *
73  * The following are used to clear the screen: ESC [ H ESC [ 2 J
74  * This is actually composed of two sequences:
75  *
76  * cursorhome
77  *    Sequence: ESC [ H
78  *    Effect: moves the cursor to upper left corner
79  *
80  * ED2 (Clear entire screen)
81  *    Sequence: ESC [ 2 J
82  *    Effect: clear the whole screen
83  *
84  * == For highlighting control characters, we also use the following two ==
85  * SO (enter StandOut)
86  *    Sequence: ESC [ 7 m
87  *    Effect: Uses some standout mode such as reverse video
88  *
89  * SE (Standout End)
90  *    Sequence: ESC [ 0 m
91  *    Effect: Exit standout mode
92  *
93  * == Only used if TIOCGWINSZ fails ==
94  * DSR/CPR (Report cursor position)
95  *    Sequence: ESC [ 6 n
96  *    Effect: reports current cursor position as ESC [ NNN ; MMM R
97  *
98  * win32/console
99  * -------------
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.
103  */
104
105 #ifdef _WIN32 /* Windows platform, either MinGW or Visual Studio (MSVC) */
106 #include <windows.h>
107 #include <fcntl.h>
108 #define USE_WINCONSOLE
109 #ifdef __MINGW32__
110 #define HAVE_UNISTD_H
111 #else
112 /* Microsoft headers don't like old POSIX names */
113 #define strdup _strdup
114 #define snprintf _snprintf
115 #endif
116 #else
117 #include <termios.h>
118 #include <sys/ioctl.h>
119 #include <sys/poll.h>
120 #define USE_TERMIOS
121 #define HAVE_UNISTD_H
122 #endif
123
124 #ifdef HAVE_UNISTD_H
125 #include <unistd.h>
126 #endif
127 #include <stdlib.h>
128 #include <stdarg.h>
129 #include <stdio.h>
130 #include <errno.h>
131 #include <string.h>
132 #include <stdlib.h>
133 #include <sys/types.h>
134
135 #include "linenoise.h"
136 #include "utf8.h"
137
138 #define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100
139 #define LINENOISE_MAX_LINE 4096
140
141 #define ctrl(C) ((C) - '@')
142
143 /* Use -ve numbers here to co-exist with normal unicode chars */
144 enum {
145     SPECIAL_NONE,
146     SPECIAL_UP = -20,
147     SPECIAL_DOWN = -21,
148     SPECIAL_LEFT = -22,
149     SPECIAL_RIGHT = -23,
150     SPECIAL_DELETE = -24,
151     SPECIAL_HOME = -25,
152     SPECIAL_END = -26,
153     SPECIAL_INSERT = -27,
154     SPECIAL_PAGE_UP = -28,
155     SPECIAL_PAGE_DOWN = -29
156 };
157
158 static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
159 static int history_len = 0;
160 static char **history = NULL;
161
162 /* Structure to contain the status of the current (being edited) line */
163 struct current {
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 */
170     const char *prompt;
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 */
180 #endif
181 };
182
183 static int fd_read(struct current *current);
184 static int getWindowSize(struct current *current);
185
186 void linenoiseHistoryFree(void) {
187     if (history) {
188         int j;
189
190         for (j = 0; j < history_len; j++)
191             free(history[j]);
192         free(history);
193         history = NULL;
194         history_len = 0;
195     }
196 }
197
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 */
203
204 static const char *unsupported_term[] = {"dumb","cons25",NULL};
205
206 static int isUnsupportedTerm(void) {
207     char *term = getenv("TERM");
208
209     if (term) {
210         int j;
211         for (j = 0; unsupported_term[j]; j++) {
212             if (strcmp(term, unsupported_term[j]) == 0) {
213                 return 1;
214             }
215         }
216     }
217     return 0;
218 }
219
220 static int enableRawMode(struct current *current) {
221     struct termios raw;
222
223     current->fd = STDIN_FILENO;
224     current->cols = 0;
225
226     if (!isatty(current->fd) || isUnsupportedTerm() ||
227         tcgetattr(current->fd, &orig_termios) == -1) {
228 fatal:
229         errno = ENOTTY;
230         return -1;
231     }
232
233     if (!atexit_registered) {
234         atexit(linenoiseAtExit);
235         atexit_registered = 1;
236     }
237
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 */
252
253     /* put terminal in raw mode after flushing */
254     if (tcsetattr(current->fd,TCSADRAIN,&raw) < 0) {
255         goto fatal;
256     }
257     rawmode = 1;
258     return 0;
259 }
260
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)
264         rawmode = 0;
265 }
266
267 /* At exit we'll try to fix the terminal to the initial conditions. */
268 static void linenoiseAtExit(void) {
269     if (rawmode) {
270         tcsetattr(STDIN_FILENO, TCSADRAIN, &orig_termios);
271     }
272     linenoiseHistoryFree();
273 }
274
275 /* gcc/glibc insists that we care about the return code of write!
276  * Clarification: This means that a void-cast like "(void) (EXPR)"
277  * does not work.
278  */
279 #define IGNORE_RC(EXPR) if (EXPR) {}
280
281 /* This is fdprintf() on some systems, but use a different
282  * name to avoid conflicts
283  */
284 static void fd_printf(int fd, const char *format, ...)
285 {
286     va_list args;
287     char buf[64];
288     int n;
289
290     va_start(args, format);
291     n = vsnprintf(buf, sizeof(buf), format, args);
292     va_end(args);
293     IGNORE_RC(write(fd, buf, n));
294 }
295
296 static void clearScreen(struct current *current)
297 {
298     fd_printf(current->fd, "\x1b[H\x1b[2J");
299 }
300
301 static void cursorToLeft(struct current *current)
302 {
303     fd_printf(current->fd, "\r");
304 }
305
306 static int outputChars(struct current *current, const char *buf, int len)
307 {
308     return write(current->fd, buf, len);
309 }
310
311 static void outputControlChar(struct current *current, char ch)
312 {
313     fd_printf(current->fd, "\x1b[7m^%c\x1b[0m", ch);
314 }
315
316 static void eraseEol(struct current *current)
317 {
318     fd_printf(current->fd, "\x1b[0K");
319 }
320
321 static void setCursorPos(struct current *current, int x)
322 {
323     fd_printf(current->fd, "\r\x1b[%dC", x);
324 }
325
326 /**
327  * Reads a char from 'fd', waiting at most 'timeout' milliseconds.
328  *
329  * A timeout of -1 means to wait forever.
330  *
331  * Returns -1 if no char is received within the time or an error occurs.
332  */
333 static int fd_read_char(int fd, int timeout)
334 {
335     struct pollfd p;
336     unsigned char c;
337
338     p.fd = fd;
339     p.events = POLLIN;
340
341     if (poll(&p, 1, timeout) == 0) {
342         /* timeout */
343         return -1;
344     }
345     if (read(fd, &c, 1) != 1) {
346         return -1;
347     }
348     return c;
349 }
350
351 /**
352  * Reads a complete utf-8 character
353  * and returns the unicode value, or -1 on error.
354  */
355 static int fd_read(struct current *current)
356 {
357 #ifdef USE_UTF8
358     char buf[4];
359     int n;
360     int i;
361     int c;
362
363     if (read(current->fd, &buf[0], 1) != 1) {
364         return -1;
365     }
366     n = utf8_charlen(buf[0]);
367     if (n < 1 || n > 3) {
368         return -1;
369     }
370     for (i = 1; i < n; i++) {
371         if (read(current->fd, &buf[i], 1) != 1) {
372             return -1;
373         }
374     }
375     buf[n] = 0;
376     /* decode and return the character */
377     utf8_tounicode(buf, &c);
378     return c;
379 #else
380     return fd_read_char(current->fd, -1);
381 #endif
382 }
383
384 static int countColorControlChars(const char* prompt)
385 {
386     /* ANSI color control sequences have the form:
387      * "\x1b" "[" [0-9;]* "m"
388      * We parse them with a simple state machine.
389      */
390
391     enum {
392         search_esc,
393         expect_bracket,
394         expect_trail
395     } state = search_esc;
396     int len = 0, found = 0;
397     char ch;
398
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.
402      */
403     while ((ch = *prompt++) != 0) {
404         switch (state) {
405         case search_esc:
406             if (ch == '\x1b') {
407                 state = expect_bracket;
408             }
409             break;
410         case expect_bracket:
411             if (ch == '[') {
412                 state = expect_trail;
413                 /* 3 for "\e[ ... m" */
414                 len = 3;
415                 break;
416             }
417             state = search_esc;
418             break;
419         case expect_trail:
420             if ((ch == ';') || ((ch >= '0' && ch <= '9'))) {
421                 /* 0-9, or semicolon */
422                 len++;
423                 break;
424             }
425             if (ch == 'm') {
426                 found += len;
427             }
428             state = search_esc;
429             break;
430         }
431     }
432
433     return found;
434 }
435
436 /**
437  * Stores the current cursor column in '*cols'.
438  * Returns 1 if OK, or 0 if failed to determine cursor pos.
439  */
440 static int queryCursor(int fd, int* cols)
441 {
442     /* control sequence - report cursor location */
443     fd_printf(fd, "\x1b[6n");
444
445     /* Parse the response: ESC [ rows ; cols R */
446     if (fd_read_char(fd, 100) == 0x1b &&
447         fd_read_char(fd, 100) == '[') {
448
449         int n = 0;
450         while (1) {
451             int ch = fd_read_char(fd, 100);
452             if (ch == ';') {
453                 /* Ignore rows */
454                 n = 0;
455             }
456             else if (ch == 'R') {
457                 /* Got cols */
458                 if (n != 0 && n < 1000) {
459                     *cols = n;
460                 }
461                 break;
462             }
463             else if (ch >= 0 && ch <= '9') {
464                 n = n * 10 + ch - '0';
465             }
466             else {
467                 break;
468             }
469         }
470         return 1;
471     }
472
473     return 0;
474 }
475
476 /**
477  * Updates current->cols with the current window size (width)
478  */
479 static int getWindowSize(struct current *current)
480 {
481     struct winsize ws;
482
483     if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
484         current->cols = ws.ws_col;
485         return 0;
486     }
487
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.
493      *
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.
501      */
502
503     if (current->cols == 0) {
504         int here;
505
506         current->cols = 80;
507
508         /* (a) */
509         if (queryCursor (current->fd, &here)) {
510             /* (b) */
511             fd_printf(current->fd, "\x1b[999C");
512
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..
516              */
517             if (!queryCursor (current->fd, &current->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
521                  * be too bad.
522                  */
523                 fd_printf(current->fd, "\r");
524             } else {
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);
528                 }
529             }
530         } /* 1st query failed, doing nothing => default 80 */
531     }
532
533     return 0;
534 }
535
536 /**
537  * If escape (27) was received, reads subsequent
538  * chars to determine if this is a known special key.
539  *
540  * Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
541  *
542  * If no additional char is received within a short time,
543  * 27 is returned.
544  */
545 static int check_special(int fd)
546 {
547     int c = fd_read_char(fd, 50);
548     int c2;
549
550     if (c < 0) {
551         return 27;
552     }
553
554     c2 = fd_read_char(fd, 50);
555     if (c2 < 0) {
556         return c2;
557     }
558     if (c == '[' || c == 'O') {
559         /* Potential arrow key */
560         switch (c2) {
561             case 'A':
562                 return SPECIAL_UP;
563             case 'B':
564                 return SPECIAL_DOWN;
565             case 'C':
566                 return SPECIAL_RIGHT;
567             case 'D':
568                 return SPECIAL_LEFT;
569             case 'F':
570                 return SPECIAL_END;
571             case 'H':
572                 return SPECIAL_HOME;
573         }
574     }
575     if (c == '[' && c2 >= '1' && c2 <= '8') {
576         /* extended escape */
577         c = fd_read_char(fd, 50);
578         if (c == '~') {
579             switch (c2) {
580                 case '2':
581                     return SPECIAL_INSERT;
582                 case '3':
583                     return SPECIAL_DELETE;
584                 case '5':
585                     return SPECIAL_PAGE_UP;
586                 case '6':
587                     return SPECIAL_PAGE_DOWN;
588                 case '7':
589                     return SPECIAL_HOME;
590                 case '8':
591                     return SPECIAL_END;
592             }
593         }
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);
597         }
598     }
599
600     return SPECIAL_NONE;
601 }
602 #elif defined(USE_WINCONSOLE)
603
604 static DWORD orig_consolemode = 0;
605
606 static int enableRawMode(struct current *current) {
607     DWORD n;
608     INPUT_RECORD irec;
609
610     current->outh = GetStdHandle(STD_OUTPUT_HANDLE);
611     current->inh = GetStdHandle(STD_INPUT_HANDLE);
612
613     if (!PeekConsoleInput(current->inh, &irec, 1, &n)) {
614         return -1;
615     }
616     if (getWindowSize(current) != 0) {
617         return -1;
618     }
619     if (GetConsoleMode(current->inh, &orig_consolemode)) {
620         SetConsoleMode(current->inh, ENABLE_PROCESSED_INPUT);
621     }
622     return 0;
623 }
624
625 static void disableRawMode(struct current *current)
626 {
627     SetConsoleMode(current->inh, orig_consolemode);
628 }
629
630 static void clearScreen(struct current *current)
631 {
632     COORD topleft = { 0, 0 };
633     DWORD n;
634
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);
641 }
642
643 static void cursorToLeft(struct current *current)
644 {
645     COORD pos = { 0, (SHORT)current->y };
646     DWORD n;
647
648     FillConsoleOutputAttribute(current->outh,
649         FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN, current->cols, pos, &n);
650     current->x = 0;
651 }
652
653 static int outputChars(struct current *current, const char *buf, int len)
654 {
655     COORD pos = { (SHORT)current->x, (SHORT)current->y };
656     DWORD n;
657
658     WriteConsoleOutputCharacter(current->outh, buf, len, pos, &n);
659     current->x += len;
660     return 0;
661 }
662
663 static void outputControlChar(struct current *current, char ch)
664 {
665     COORD pos = { (SHORT)current->x, (SHORT)current->y };
666     DWORD n;
667
668     FillConsoleOutputAttribute(current->outh, BACKGROUND_INTENSITY, 2, pos, &n);
669     outputChars(current, "^", 1);
670     outputChars(current, &ch, 1);
671 }
672
673 static void eraseEol(struct current *current)
674 {
675     COORD pos = { (SHORT)current->x, (SHORT)current->y };
676     DWORD n;
677
678     FillConsoleOutputCharacter(current->outh, ' ', current->cols - current->x, pos, &n);
679 }
680
681 static void setCursorPos(struct current *current, int x)
682 {
683     COORD pos = { (SHORT)x, (SHORT)current->y };
684
685     SetConsoleCursorPosition(current->outh, pos);
686     current->x = x;
687 }
688
689 static int fd_read(struct current *current)
690 {
691     while (1) {
692         INPUT_RECORD irec;
693         DWORD n;
694         if (WaitForSingleObject(current->inh, INFINITE) != WAIT_OBJECT_0) {
695             break;
696         }
697         if (!ReadConsoleInput (current->inh, &irec, 1, &n)) {
698             break;
699         }
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) {
704                  case VK_LEFT:
705                     return SPECIAL_LEFT;
706                  case VK_RIGHT:
707                     return SPECIAL_RIGHT;
708                  case VK_UP:
709                     return SPECIAL_UP;
710                  case VK_DOWN:
711                     return SPECIAL_DOWN;
712                  case VK_INSERT:
713                     return SPECIAL_INSERT;
714                  case VK_DELETE:
715                     return SPECIAL_DELETE;
716                  case VK_HOME:
717                     return SPECIAL_HOME;
718                  case VK_END:
719                     return SPECIAL_END;
720                  case VK_PRIOR:
721                     return SPECIAL_PAGE_UP;
722                  case VK_NEXT:
723                     return SPECIAL_PAGE_DOWN;
724                 }
725             }
726             /* Note that control characters are already translated in AsciiChar */
727             else {
728 #ifdef USE_UTF8
729                 return k->uChar.UnicodeChar;
730 #else
731                 return k->uChar.AsciiChar;
732 #endif
733             }
734         }
735     }
736     return -1;
737 }
738
739 static int countColorControlChars(const char* prompt)
740 {
741     /* For windows we assume that there are no embedded ansi color
742      * control sequences.
743      */
744     return 0;
745 }
746
747 static int getWindowSize(struct current *current)
748 {
749     CONSOLE_SCREEN_BUFFER_INFO info;
750     if (!GetConsoleScreenBufferInfo(current->outh, &info)) {
751         return -1;
752     }
753     current->cols = info.dwSize.X;
754     current->rows = info.dwSize.Y;
755     if (current->cols <= 0 || current->rows <= 0) {
756         current->cols = 80;
757         return -1;
758     }
759     current->y = info.dwCursorPosition.Y;
760     current->x = info.dwCursorPosition.X;
761     return 0;
762 }
763 #endif
764
765 static int utf8_getchars(char *buf, int c)
766 {
767 #ifdef USE_UTF8
768     return utf8_fromunicode(buf, c);
769 #else
770     *buf = c;
771     return 1;
772 #endif
773 }
774
775 /**
776  * Returns the unicode character at the given offset,
777  * or -1 if none.
778  */
779 static int get_char(struct current *current, int pos)
780 {
781     if (pos >= 0 && pos < current->chars) {
782         int c;
783         int i = utf8_index(current->buf, pos);
784         (void)utf8_tounicode(current->buf + i, &c);
785         return c;
786     }
787     return -1;
788 }
789
790 static void refreshLine(const char *prompt, struct current *current)
791 {
792     int plen;
793     int pchars;
794     int backup = 0;
795     int i;
796     const char *buf = current->buf;
797     int chars = current->chars;
798     int pos = current->pos;
799     int b;
800     int ch;
801     int n;
802
803     /* Should intercept SIGWINCH. For now, just get the size every time */
804     getWindowSize(current);
805
806     plen = strlen(prompt);
807     pchars = utf8_strlen(prompt, plen);
808
809     /* Scan the prompt for embedded ansi color control sequences and
810      * discount them as characters/columns.
811      */
812     pchars -= countColorControlChars(prompt);
813
814     /* Account for a line which is too long to fit in the window.
815      * Note that control chars require an extra column
816      */
817
818     /* How many cols are required to the left of 'pos'?
819      * The prompt, plus one extra for each control char
820      */
821     n = pchars + utf8_strlen(buf, current->len);
822     b = 0;
823     for (i = 0; i < pos; i++) {
824         b += utf8_tounicode(buf + b, &ch);
825         if (ch < ' ') {
826             n++;
827         }
828     }
829
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.
833      */
834     if (current->pos < current->chars && get_char(current, current->pos) < ' ') {
835         n++;
836     }
837
838     while (n >= current->cols && pos > 0) {
839         b = utf8_tounicode(buf, &ch);
840         if (ch < ' ') {
841             n--;
842         }
843         n--;
844         buf += b;
845         pos--;
846         chars--;
847     }
848
849     /* Cursor to left edge, then the prompt */
850     cursorToLeft(current);
851     outputChars(current, prompt, plen);
852
853     /* Now the current buffer content */
854
855     /* Need special handling for control characters.
856      * If we hit 'cols', stop.
857      */
858     b = 0; /* unwritted bytes */
859     n = 0; /* How many control chars were written */
860     for (i = 0; i < chars; i++) {
861         int ch;
862         int w = utf8_tounicode(buf + b, &ch);
863         if (ch < ' ') {
864             n++;
865         }
866         if (pchars + i + n >= current->cols) {
867             break;
868         }
869         if (ch < ' ') {
870             /* A control character, so write the buffer so far */
871             outputChars(current, buf, b);
872             buf += b + w;
873             b = 0;
874             outputControlChar(current, ch + '@');
875             if (i < pos) {
876                 backup++;
877             }
878         }
879         else {
880             b += w;
881         }
882     }
883     outputChars(current, buf, b);
884
885     /* Erase to right, move cursor to original position */
886     eraseEol(current);
887     setCursorPos(current, pos + pchars + backup);
888 }
889
890 static void set_current(struct current *current, const char *str)
891 {
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);
896 }
897
898 static int has_room(struct current *current, int bytes)
899 {
900     return current->len + bytes < current->bufmax - 1;
901 }
902
903 /**
904  * Removes the char at 'pos'.
905  *
906  * Returns 1 if the line needs to be refreshed, 2 if not
907  * and 0 if nothing was removed
908  */
909 static int remove_char(struct current *current, int pos)
910 {
911     if (pos >= 0 && pos < current->chars) {
912         int p1, p2;
913         int ret = 1;
914         p1 = utf8_index(current->buf, pos);
915         p2 = p1 + utf8_index(current->buf + p1, 1);
916
917 #ifdef USE_TERMIOS
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) {
921                 ret = 2;
922                 fd_printf(current->fd, "\b \b");
923             }
924         }
925 #endif
926
927         /* Move the null char too */
928         memmove(current->buf + p1, current->buf + p2, current->len - p2 + 1);
929         current->len -= (p2 - p1);
930         current->chars--;
931
932         if (current->pos > pos) {
933             current->pos--;
934         }
935         return ret;
936     }
937     return 0;
938 }
939
940 /**
941  * Insert 'ch' at position 'pos'
942  *
943  * Returns 1 if the line needs to be refreshed, 2 if not
944  * and 0 if nothing was inserted (no room)
945  */
946 static int insert_char(struct current *current, int pos, int ch)
947 {
948     char buf[3];
949     int n = utf8_getchars(buf, ch);
950
951     if (has_room(current, n) && pos >= 0 && pos <= current->chars) {
952         int p1, p2;
953         int ret = 1;
954         p1 = utf8_index(current->buf, pos);
955         p2 = p1 + n;
956
957 #ifdef USE_TERMIOS
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));
962                 ret = 2;
963             }
964         }
965 #endif
966
967         memmove(current->buf + p2, current->buf + p1, current->len - p1);
968         memcpy(current->buf + p1, buf, n);
969         current->len += n;
970
971         current->chars++;
972         if (current->pos >= pos) {
973             current->pos++;
974         }
975         return ret;
976     }
977     return 0;
978 }
979
980 /**
981  * Captures up to 'n' characters starting at 'pos' for the cut buffer.
982  *
983  * This replaces any existing characters in the cut buffer.
984  */
985 static void capture_chars(struct current *current, int pos, int n)
986 {
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);
990
991         if (nbytes) {
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';
997         }
998     }
999 }
1000
1001 /**
1002  * Removes up to 'n' characters at cursor position 'pos'.
1003  *
1004  * Returns 0 if no chars were removed or non-zero otherwise.
1005  */
1006 static int remove_chars(struct current *current, int pos, int n)
1007 {
1008     int removed = 0;
1009
1010     /* First save any chars which will be removed */
1011     capture_chars(current, pos, n);
1012
1013     while (n-- && remove_char(current, pos)) {
1014         removed++;
1015     }
1016     return removed;
1017 }
1018 /**
1019  * Inserts the characters (string) 'chars' at the cursor position 'pos'.
1020  *
1021  * Returns 0 if no chars were inserted or non-zero otherwise.
1022  */
1023 static int insert_chars(struct current *current, int pos, const char *chars)
1024 {
1025     int inserted = 0;
1026
1027     while (*chars) {
1028         int ch;
1029         int n = utf8_tounicode(chars, &ch);
1030         if (insert_char(current, pos, ch) == 0) {
1031             break;
1032         }
1033         inserted++;
1034         pos++;
1035         chars += n;
1036     }
1037     return inserted;
1038 }
1039
1040 #ifndef NO_COMPLETION
1041 static linenoiseCompletionCallback *completionCallback = NULL;
1042
1043 static void beep() {
1044 #ifdef USE_TERMIOS
1045     fprintf(stderr, "\x7");
1046     fflush(stderr);
1047 #endif
1048 }
1049
1050 static void freeCompletions(linenoiseCompletions *lc) {
1051     size_t i;
1052     for (i = 0; i < lc->len; i++)
1053         free(lc->cvec[i]);
1054     free(lc->cvec);
1055 }
1056
1057 static int completeLine(struct current *current) {
1058     linenoiseCompletions lc = { 0, NULL };
1059     int c = 0;
1060
1061     completionCallback(current->buf,&lc);
1062     if (lc.len == 0) {
1063         beep();
1064     } else {
1065         size_t stop = 0, i = 0;
1066
1067         while(!stop) {
1068             /* Show completion or original buffer */
1069             if (i < lc.len) {
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);
1075             } else {
1076                 refreshLine(current->prompt, current);
1077             }
1078
1079             c = fd_read(current);
1080             if (c == -1) {
1081                 break;
1082             }
1083
1084             switch(c) {
1085                 case '\t': /* tab */
1086                     i = (i+1) % (lc.len+1);
1087                     if (i == lc.len) beep();
1088                     break;
1089                 case 27: /* escape */
1090                     /* Re-show original buffer */
1091                     if (i < lc.len) {
1092                         refreshLine(current->prompt, current);
1093                     }
1094                     stop = 1;
1095                     break;
1096                 default:
1097                     /* Update buffer and return */
1098                     if (i < lc.len) {
1099                         set_current(current,lc.cvec[i]);
1100                     }
1101                     stop = 1;
1102                     break;
1103             }
1104         }
1105     }
1106
1107     freeCompletions(&lc);
1108     return c; /* Return last read character */
1109 }
1110
1111 /* Register a callback function to be called for tab-completion. */
1112 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) {
1113     completionCallback = fn;
1114 }
1115
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);
1119 }
1120
1121 #endif
1122
1123 static int linenoiseEdit(struct current *current) {
1124     int history_index = 0;
1125
1126     /* The latest history entry is always our current buffer, that
1127      * initially is just an empty string. */
1128     linenoiseHistoryAdd("");
1129
1130     set_current(current, "");
1131     refreshLine(current->prompt, current);
1132
1133     while(1) {
1134         int dir = -1;
1135         int c = fd_read(current);
1136
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;
1147         }
1148 #endif
1149
1150 process_char:
1151         if (c == -1) return current->len;
1152 #ifdef USE_TERMIOS
1153         if (c == 27) {   /* escape sequence */
1154             c = check_special(current->fd);
1155         }
1156 #endif
1157         switch(c) {
1158         case '\r':    /* enter */
1159             history_len--;
1160             free(history[history_len]);
1161             return current->len;
1162         case ctrl('C'):     /* ctrl-c */
1163             errno = EAGAIN;
1164             return -1;
1165         case 127:   /* backspace */
1166         case ctrl('H'):
1167             if (remove_char(current, current->pos - 1) == 1) {
1168                 refreshLine(current->prompt, current);
1169             }
1170             break;
1171         case ctrl('D'):     /* ctrl-d */
1172             if (current->len == 0) {
1173                 /* Empty line, so EOF */
1174                 history_len--;
1175                 free(history[history_len]);
1176                 return -1;
1177             }
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);
1182             }
1183             break;
1184         case SPECIAL_INSERT:
1185             /* Ignore. Expansion Hook.
1186              * Future possibility: Toggle Insert/Overwrite Modes
1187              */
1188             break;
1189         case ctrl('W'):    /* ctrl-w, delete word at left. save deleted chars */
1190             /* eat any spaces on the left */
1191             {
1192                 int pos = current->pos;
1193                 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1194                     pos--;
1195                 }
1196
1197                 /* now eat any non-spaces on the left */
1198                 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1199                     pos--;
1200                 }
1201
1202                 if (remove_chars(current, pos, current->pos - pos)) {
1203                     refreshLine(current->prompt, current);
1204                 }
1205             }
1206             break;
1207         case ctrl('R'):    /* ctrl-r */
1208             {
1209                 /* Display the reverse-i-search prompt and process chars */
1210                 char rbuf[50];
1211                 char rprompt[80];
1212                 int rchars = 0;
1213                 int rlen = 0;
1214                 int searchpos = history_len - 1;
1215
1216                 rbuf[0] = 0;
1217                 while (1) {
1218                     int n = 0;
1219                     const char *p = NULL;
1220                     int skipsame = 0;
1221                     int searchdir = -1;
1222
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) {
1227                         if (rchars) {
1228                             int p = utf8_index(rbuf, --rchars);
1229                             rbuf[p] = 0;
1230                             rlen = strlen(rbuf);
1231                         }
1232                         continue;
1233                     }
1234 #ifdef USE_TERMIOS
1235                     if (c == 27) {
1236                         c = check_special(current->fd);
1237                     }
1238 #endif
1239                     if (c == ctrl('P') || c == SPECIAL_UP) {
1240                         /* Search for the previous (earlier) match */
1241                         if (searchpos > 0) {
1242                             searchpos--;
1243                         }
1244                         skipsame = 1;
1245                     }
1246                     else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1247                         /* Search for the next (later) match */
1248                         if (searchpos < history_len) {
1249                             searchpos++;
1250                         }
1251                         searchdir = 1;
1252                         skipsame = 1;
1253                     }
1254                     else if (c >= ' ') {
1255                         if (rlen >= (int)sizeof(rbuf) + 3) {
1256                             continue;
1257                         }
1258
1259                         n = utf8_getchars(rbuf + rlen, c);
1260                         rlen += n;
1261                         rchars++;
1262                         rbuf[rlen] = 0;
1263
1264                         /* Adding a new char resets the search location */
1265                         searchpos = history_len - 1;
1266                     }
1267                     else {
1268                         /* Exit from incremental search mode */
1269                         break;
1270                     }
1271
1272                     /* Now search through the history for a match */
1273                     for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1274                         p = strstr(history[searchpos], rbuf);
1275                         if (p) {
1276                             /* Found a match */
1277                             if (skipsame && strcmp(history[searchpos], current->buf) == 0) {
1278                                 /* But it is identical, so skip it */
1279                                 continue;
1280                             }
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]);
1284                             break;
1285                         }
1286                     }
1287                     if (!p && n) {
1288                         /* No match, so don't add it */
1289                         rchars--;
1290                         rlen -= n;
1291                         rbuf[rlen] = 0;
1292                     }
1293                 }
1294                 if (c == ctrl('G') || c == ctrl('C')) {
1295                     /* ctrl-g terminates the search with no effect */
1296                     set_current(current, "");
1297                     c = 0;
1298                 }
1299                 else if (c == ctrl('J')) {
1300                     /* ctrl-j terminates the search leaving the buffer in place */
1301                     c = 0;
1302                 }
1303                 /* Go process the char normally */
1304                 refreshLine(current->prompt, current);
1305                 goto process_char;
1306             }
1307             break;
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);
1316             }
1317             break;
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);
1325
1326                     /* Remove the ^V first */
1327                     remove_char(current, current->pos - 1);
1328                     if (c != -1) {
1329                         /* Insert the actual char */
1330                         insert_char(current, current->pos, c);
1331                     }
1332                     refreshLine(current->prompt, current);
1333                 }
1334             }
1335             break;
1336         case ctrl('B'):
1337         case SPECIAL_LEFT:
1338             if (current->pos > 0) {
1339                 current->pos--;
1340                 refreshLine(current->prompt, current);
1341             }
1342             break;
1343         case ctrl('F'):
1344         case SPECIAL_RIGHT:
1345             if (current->pos < current->chars) {
1346                 current->pos++;
1347                 refreshLine(current->prompt, current);
1348             }
1349             break;
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;
1356         case ctrl('P'):
1357         case SPECIAL_UP:
1358             dir = 1;
1359           goto history_navigation;
1360         case ctrl('N'):
1361         case SPECIAL_DOWN:
1362 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) {
1371                     history_index = 0;
1372                     break;
1373                 } else if (history_index >= history_len) {
1374                     history_index = history_len - 1;
1375                     break;
1376                 }
1377                 set_current(current, history[history_len - 1 - history_index]);
1378                 refreshLine(current->prompt, current);
1379             }
1380             break;
1381         case ctrl('A'): /* Ctrl+a, go to the start of the line */
1382         case SPECIAL_HOME:
1383             current->pos = 0;
1384             refreshLine(current->prompt, current);
1385             break;
1386         case ctrl('E'): /* ctrl+e, go to the end of the line */
1387         case SPECIAL_END:
1388             current->pos = current->chars;
1389             refreshLine(current->prompt, current);
1390             break;
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);
1394             }
1395             break;
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);
1399             }
1400             break;
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);
1404             }
1405             break;
1406         case ctrl('L'): /* Ctrl+L, clear screen */
1407             clearScreen(current);
1408             /* Force recalc of window size for serial terminals */
1409             current->cols = 0;
1410             refreshLine(current->prompt, current);
1411             break;
1412         default:
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);
1417                 }
1418             }
1419             break;
1420         }
1421     }
1422     return current->len;
1423 }
1424
1425 int linenoiseColumns(void)
1426 {
1427     struct current current;
1428     enableRawMode (&current);
1429     getWindowSize (&current);
1430     disableRawMode (&current);
1431     return current.cols;
1432 }
1433
1434 char *linenoise(const char *prompt)
1435 {
1436     int count;
1437     struct current current;
1438     char buf[LINENOISE_MAX_LINE];
1439
1440     if (enableRawMode(&current) == -1) {
1441         printf("%s", prompt);
1442         fflush(stdout);
1443         if (fgets(buf, sizeof(buf), stdin) == NULL) {
1444             return NULL;
1445         }
1446         count = strlen(buf);
1447         if (count && buf[count-1] == '\n') {
1448             count--;
1449             buf[count] = '\0';
1450         }
1451     }
1452     else
1453     {
1454         current.buf = buf;
1455         current.bufmax = sizeof(buf);
1456         current.len = 0;
1457         current.chars = 0;
1458         current.pos = 0;
1459         current.prompt = prompt;
1460         current.capture = NULL;
1461
1462         count = linenoiseEdit(&current);
1463
1464         disableRawMode(&current);
1465         printf("\n");
1466
1467         free(current.capture);
1468         if (count == -1) {
1469             return NULL;
1470         }
1471     }
1472     return strdup(buf);
1473 }
1474
1475 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1476 int linenoiseHistoryAdd(const char *line) {
1477     char *linecopy;
1478
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));
1484     }
1485
1486     /* do not insert duplicate lines into history */
1487     if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1488         return 0;
1489     }
1490
1491     linecopy = strdup(line);
1492     if (!linecopy) return 0;
1493     if (history_len == history_max_len) {
1494         free(history[0]);
1495         memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1496         history_len--;
1497     }
1498     history[history_len] = linecopy;
1499     history_len++;
1500     return 1;
1501 }
1502
1503 int linenoiseHistoryGetMaxLen(void) {
1504     return history_max_len;
1505 }
1506
1507 int linenoiseHistorySetMaxLen(int len) {
1508     char **newHistory;
1509
1510     if (len < 1) return 0;
1511     if (history) {
1512         int tocopy = history_len;
1513
1514         newHistory = (char **)malloc(sizeof(char*)*len);
1515         if (newHistory == NULL) return 0;
1516
1517         /* If we can't copy everything, free the elements we'll not use. */
1518         if (len < tocopy) {
1519             int j;
1520
1521             for (j = 0; j < tocopy-len; j++) free(history[j]);
1522             tocopy = len;
1523         }
1524         memset(newHistory,0,sizeof(char*)*len);
1525         memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
1526         free(history);
1527         history = newHistory;
1528     }
1529     history_max_len = len;
1530     if (history_len > history_max_len)
1531         history_len = history_max_len;
1532     return 1;
1533 }
1534
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");
1539     int j;
1540
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 */
1545         while (*str) {
1546             if (*str == '\\') {
1547                 fputs("\\\\", fp);
1548             }
1549             else if (*str == '\n') {
1550                 fputs("\\n", fp);
1551             }
1552             else if (*str == '\r') {
1553                 fputs("\\r", fp);
1554             }
1555             else {
1556                 fputc(*str, fp);
1557             }
1558             str++;
1559         }
1560         fputc('\n', fp);
1561     }
1562
1563     fclose(fp);
1564     return 0;
1565 }
1566
1567 /* Load the history from the specified file. If the file does not exist
1568  * zero is returned and no operation is performed.
1569  *
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];
1575
1576     if (fp == NULL) return -1;
1577
1578     while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) {
1579         char *src, *dest;
1580
1581         /* Decode backslash escaped values */
1582         for (src = dest = buf; *src; src++) {
1583             char ch = *src;
1584
1585             if (ch == '\\') {
1586                 src++;
1587                 if (*src == 'n') {
1588                     ch = '\n';
1589                 }
1590                 else if (*src == 'r') {
1591                     ch = '\r';
1592                 } else {
1593                     ch = *src;
1594                 }
1595             }
1596             *dest++ = ch;
1597         }
1598         /* Remove trailing newline */
1599         if (dest != buf && (dest[-1] == '\n' || dest[-1] == '\r')) {
1600             dest--;
1601         }
1602         *dest = 0;
1603
1604         linenoiseHistoryAdd(buf);
1605     }
1606     fclose(fp);
1607     return 0;
1608 }
1609
1610 /* Provide access to the history buffer.
1611  *
1612  * If 'len' is not NULL, the length is stored in *len.
1613  */
1614 char **linenoiseHistory(int *len) {
1615     if (len) {
1616         *len = history_len;
1617     }
1618     return history;
1619 }