]> git.lizzy.rs Git - linenoise.git/blob - linenoise.c
Avoid ESC [ n C with n=0
[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     if (x == 0) {
324         cursorToLeft(current);
325     }
326     else {
327         fd_printf(current->fd, "\r\x1b[%dC", x);
328     }
329 }
330
331 /**
332  * Reads a char from 'fd', waiting at most 'timeout' milliseconds.
333  *
334  * A timeout of -1 means to wait forever.
335  *
336  * Returns -1 if no char is received within the time or an error occurs.
337  */
338 static int fd_read_char(int fd, int timeout)
339 {
340     struct pollfd p;
341     unsigned char c;
342
343     p.fd = fd;
344     p.events = POLLIN;
345
346     if (poll(&p, 1, timeout) == 0) {
347         /* timeout */
348         return -1;
349     }
350     if (read(fd, &c, 1) != 1) {
351         return -1;
352     }
353     return c;
354 }
355
356 /**
357  * Reads a complete utf-8 character
358  * and returns the unicode value, or -1 on error.
359  */
360 static int fd_read(struct current *current)
361 {
362 #ifdef USE_UTF8
363     char buf[4];
364     int n;
365     int i;
366     int c;
367
368     if (read(current->fd, &buf[0], 1) != 1) {
369         return -1;
370     }
371     n = utf8_charlen(buf[0]);
372     if (n < 1 || n > 3) {
373         return -1;
374     }
375     for (i = 1; i < n; i++) {
376         if (read(current->fd, &buf[i], 1) != 1) {
377             return -1;
378         }
379     }
380     buf[n] = 0;
381     /* decode and return the character */
382     utf8_tounicode(buf, &c);
383     return c;
384 #else
385     return fd_read_char(current->fd, -1);
386 #endif
387 }
388
389 static int countColorControlChars(const char* prompt)
390 {
391     /* ANSI color control sequences have the form:
392      * "\x1b" "[" [0-9;]* "m"
393      * We parse them with a simple state machine.
394      */
395
396     enum {
397         search_esc,
398         expect_bracket,
399         expect_trail
400     } state = search_esc;
401     int len = 0, found = 0;
402     char ch;
403
404     /* XXX: Strictly we should be checking utf8 chars rather than
405      *      bytes in case of the extremely unlikely scenario where
406      *      an ANSI sequence is part of a utf8 sequence.
407      */
408     while ((ch = *prompt++) != 0) {
409         switch (state) {
410         case search_esc:
411             if (ch == '\x1b') {
412                 state = expect_bracket;
413             }
414             break;
415         case expect_bracket:
416             if (ch == '[') {
417                 state = expect_trail;
418                 /* 3 for "\e[ ... m" */
419                 len = 3;
420                 break;
421             }
422             state = search_esc;
423             break;
424         case expect_trail:
425             if ((ch == ';') || ((ch >= '0' && ch <= '9'))) {
426                 /* 0-9, or semicolon */
427                 len++;
428                 break;
429             }
430             if (ch == 'm') {
431                 found += len;
432             }
433             state = search_esc;
434             break;
435         }
436     }
437
438     return found;
439 }
440
441 /**
442  * Stores the current cursor column in '*cols'.
443  * Returns 1 if OK, or 0 if failed to determine cursor pos.
444  */
445 static int queryCursor(int fd, int* cols)
446 {
447     /* control sequence - report cursor location */
448     fd_printf(fd, "\x1b[6n");
449
450     /* Parse the response: ESC [ rows ; cols R */
451     if (fd_read_char(fd, 100) == 0x1b &&
452         fd_read_char(fd, 100) == '[') {
453
454         int n = 0;
455         while (1) {
456             int ch = fd_read_char(fd, 100);
457             if (ch == ';') {
458                 /* Ignore rows */
459                 n = 0;
460             }
461             else if (ch == 'R') {
462                 /* Got cols */
463                 if (n != 0 && n < 1000) {
464                     *cols = n;
465                 }
466                 break;
467             }
468             else if (ch >= 0 && ch <= '9') {
469                 n = n * 10 + ch - '0';
470             }
471             else {
472                 break;
473             }
474         }
475         return 1;
476     }
477
478     return 0;
479 }
480
481 /**
482  * Updates current->cols with the current window size (width)
483  */
484 static int getWindowSize(struct current *current)
485 {
486     struct winsize ws;
487
488     if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
489         current->cols = ws.ws_col;
490         return 0;
491     }
492
493     /* Failed to query the window size. Perhaps we are on a serial terminal.
494      * Try to query the width by sending the cursor as far to the right
495      * and reading back the cursor position.
496      * Note that this is only done once per call to linenoise rather than
497      * every time the line is refreshed for efficiency reasons.
498      *
499      * In more detail, we:
500      * (a) request current cursor position,
501      * (b) move cursor far right,
502      * (c) request cursor position again,
503      * (d) at last move back to the old position.
504      * This gives us the width without messing with the externally
505      * visible cursor position.
506      */
507
508     if (current->cols == 0) {
509         int here;
510
511         current->cols = 80;
512
513         /* (a) */
514         if (queryCursor (current->fd, &here)) {
515             /* (b) */
516             fd_printf(current->fd, "\x1b[999C");
517
518             /* (c). Note: If (a) succeeded, then (c) should as well.
519              * For paranoia we still check and have a fallback action
520              * for (d) in case of failure..
521              */
522             if (!queryCursor (current->fd, &current->cols)) {
523                 /* (d') Unable to get accurate position data, reset
524                  * the cursor to the far left. While this may not
525                  * restore the exact original position it should not
526                  * be too bad.
527                  */
528                 fd_printf(current->fd, "\r");
529             } else {
530                 /* (d) Reset the cursor back to the original location. */
531                 if (current->cols > here) {
532                     fd_printf(current->fd, "\x1b[%dD", current->cols - here);
533                 }
534             }
535         } /* 1st query failed, doing nothing => default 80 */
536     }
537
538     return 0;
539 }
540
541 /**
542  * If escape (27) was received, reads subsequent
543  * chars to determine if this is a known special key.
544  *
545  * Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
546  *
547  * If no additional char is received within a short time,
548  * 27 is returned.
549  */
550 static int check_special(int fd)
551 {
552     int c = fd_read_char(fd, 50);
553     int c2;
554
555     if (c < 0) {
556         return 27;
557     }
558
559     c2 = fd_read_char(fd, 50);
560     if (c2 < 0) {
561         return c2;
562     }
563     if (c == '[' || c == 'O') {
564         /* Potential arrow key */
565         switch (c2) {
566             case 'A':
567                 return SPECIAL_UP;
568             case 'B':
569                 return SPECIAL_DOWN;
570             case 'C':
571                 return SPECIAL_RIGHT;
572             case 'D':
573                 return SPECIAL_LEFT;
574             case 'F':
575                 return SPECIAL_END;
576             case 'H':
577                 return SPECIAL_HOME;
578         }
579     }
580     if (c == '[' && c2 >= '1' && c2 <= '8') {
581         /* extended escape */
582         c = fd_read_char(fd, 50);
583         if (c == '~') {
584             switch (c2) {
585                 case '2':
586                     return SPECIAL_INSERT;
587                 case '3':
588                     return SPECIAL_DELETE;
589                 case '5':
590                     return SPECIAL_PAGE_UP;
591                 case '6':
592                     return SPECIAL_PAGE_DOWN;
593                 case '7':
594                     return SPECIAL_HOME;
595                 case '8':
596                     return SPECIAL_END;
597             }
598         }
599         while (c != -1 && c != '~') {
600             /* .e.g \e[12~ or '\e[11;2~   discard the complete sequence */
601             c = fd_read_char(fd, 50);
602         }
603     }
604
605     return SPECIAL_NONE;
606 }
607 #elif defined(USE_WINCONSOLE)
608
609 static DWORD orig_consolemode = 0;
610
611 static int enableRawMode(struct current *current) {
612     DWORD n;
613     INPUT_RECORD irec;
614
615     current->outh = GetStdHandle(STD_OUTPUT_HANDLE);
616     current->inh = GetStdHandle(STD_INPUT_HANDLE);
617
618     if (!PeekConsoleInput(current->inh, &irec, 1, &n)) {
619         return -1;
620     }
621     if (getWindowSize(current) != 0) {
622         return -1;
623     }
624     if (GetConsoleMode(current->inh, &orig_consolemode)) {
625         SetConsoleMode(current->inh, ENABLE_PROCESSED_INPUT);
626     }
627     return 0;
628 }
629
630 static void disableRawMode(struct current *current)
631 {
632     SetConsoleMode(current->inh, orig_consolemode);
633 }
634
635 static void clearScreen(struct current *current)
636 {
637     COORD topleft = { 0, 0 };
638     DWORD n;
639
640     FillConsoleOutputCharacter(current->outh, ' ',
641         current->cols * current->rows, topleft, &n);
642     FillConsoleOutputAttribute(current->outh,
643         FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN,
644         current->cols * current->rows, topleft, &n);
645     SetConsoleCursorPosition(current->outh, topleft);
646 }
647
648 static void cursorToLeft(struct current *current)
649 {
650     COORD pos;
651     DWORD n;
652
653     pos.X = 0;
654     pos.Y = (SHORT)current->y;
655
656     FillConsoleOutputAttribute(current->outh,
657         FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN, current->cols, pos, &n);
658     current->x = 0;
659 }
660
661 static int outputChars(struct current *current, const char *buf, int len)
662 {
663     COORD pos;
664     DWORD n;
665
666     pos.X = (SHORT)current->x;
667     pos.Y = (SHORT)current->y;
668
669     WriteConsoleOutputCharacter(current->outh, buf, len, pos, &n);
670     current->x += len;
671     return 0;
672 }
673
674 static void outputControlChar(struct current *current, char ch)
675 {
676     COORD pos;
677     DWORD n;
678
679     pos.X = (SHORT) current->x;
680     pos.Y = (SHORT) current->y;
681
682     FillConsoleOutputAttribute(current->outh, BACKGROUND_INTENSITY, 2, pos, &n);
683     outputChars(current, "^", 1);
684     outputChars(current, &ch, 1);
685 }
686
687 static void eraseEol(struct current *current)
688 {
689     COORD pos;
690     DWORD n;
691
692     pos.X = (SHORT) current->x;
693     pos.Y = (SHORT) current->y;
694
695     FillConsoleOutputCharacter(current->outh, ' ', current->cols - current->x, pos, &n);
696 }
697
698 static void setCursorPos(struct current *current, int x)
699 {
700     COORD pos;
701
702     pos.X = (SHORT)x;
703     pos.Y = (SHORT) current->y;
704
705     SetConsoleCursorPosition(current->outh, pos);
706     current->x = x;
707 }
708
709 static int fd_read(struct current *current)
710 {
711     while (1) {
712         INPUT_RECORD irec;
713         DWORD n;
714         if (WaitForSingleObject(current->inh, INFINITE) != WAIT_OBJECT_0) {
715             break;
716         }
717         if (!ReadConsoleInput (current->inh, &irec, 1, &n)) {
718             break;
719         }
720         if (irec.EventType == KEY_EVENT && irec.Event.KeyEvent.bKeyDown) {
721             KEY_EVENT_RECORD *k = &irec.Event.KeyEvent;
722             if (k->dwControlKeyState & ENHANCED_KEY) {
723                 switch (k->wVirtualKeyCode) {
724                  case VK_LEFT:
725                     return SPECIAL_LEFT;
726                  case VK_RIGHT:
727                     return SPECIAL_RIGHT;
728                  case VK_UP:
729                     return SPECIAL_UP;
730                  case VK_DOWN:
731                     return SPECIAL_DOWN;
732                  case VK_INSERT:
733                     return SPECIAL_INSERT;
734                  case VK_DELETE:
735                     return SPECIAL_DELETE;
736                  case VK_HOME:
737                     return SPECIAL_HOME;
738                  case VK_END:
739                     return SPECIAL_END;
740                  case VK_PRIOR:
741                     return SPECIAL_PAGE_UP;
742                  case VK_NEXT:
743                     return SPECIAL_PAGE_DOWN;
744                 }
745             }
746             /* Note that control characters are already translated in AsciiChar */
747             else if (k->wVirtualKeyCode == VK_CONTROL)
748                 continue;
749             else {
750 #ifdef USE_UTF8
751                 return k->uChar.UnicodeChar;
752 #else
753                 return k->uChar.AsciiChar;
754 #endif
755             }
756         }
757     }
758     return -1;
759 }
760
761 static int countColorControlChars(const char* prompt)
762 {
763     /* For windows we assume that there are no embedded ansi color
764      * control sequences.
765      */
766     return 0;
767 }
768
769 static int getWindowSize(struct current *current)
770 {
771     CONSOLE_SCREEN_BUFFER_INFO info;
772     if (!GetConsoleScreenBufferInfo(current->outh, &info)) {
773         return -1;
774     }
775     current->cols = info.dwSize.X;
776     current->rows = info.dwSize.Y;
777     if (current->cols <= 0 || current->rows <= 0) {
778         current->cols = 80;
779         return -1;
780     }
781     current->y = info.dwCursorPosition.Y;
782     current->x = info.dwCursorPosition.X;
783     return 0;
784 }
785 #endif
786
787 static int utf8_getchars(char *buf, int c)
788 {
789 #ifdef USE_UTF8
790     return utf8_fromunicode(buf, c);
791 #else
792     *buf = c;
793     return 1;
794 #endif
795 }
796
797 /**
798  * Returns the unicode character at the given offset,
799  * or -1 if none.
800  */
801 static int get_char(struct current *current, int pos)
802 {
803     if (pos >= 0 && pos < current->chars) {
804         int c;
805         int i = utf8_index(current->buf, pos);
806         (void)utf8_tounicode(current->buf + i, &c);
807         return c;
808     }
809     return -1;
810 }
811
812 static void refreshLine(const char *prompt, struct current *current)
813 {
814     int plen;
815     int pchars;
816     int backup = 0;
817     int i;
818     const char *buf = current->buf;
819     int chars = current->chars;
820     int pos = current->pos;
821     int b;
822     int ch;
823     int n;
824
825     /* Should intercept SIGWINCH. For now, just get the size every time */
826     getWindowSize(current);
827
828     plen = strlen(prompt);
829     pchars = utf8_strlen(prompt, plen);
830
831     /* Scan the prompt for embedded ansi color control sequences and
832      * discount them as characters/columns.
833      */
834     pchars -= countColorControlChars(prompt);
835
836     /* Account for a line which is too long to fit in the window.
837      * Note that control chars require an extra column
838      */
839
840     /* How many cols are required to the left of 'pos'?
841      * The prompt, plus one extra for each control char
842      */
843     n = pchars + utf8_strlen(buf, current->len);
844     b = 0;
845     for (i = 0; i < pos; i++) {
846         b += utf8_tounicode(buf + b, &ch);
847         if (ch < ' ') {
848             n++;
849         }
850     }
851
852     /* If too many are needed, strip chars off the front of 'buf'
853      * until it fits. Note that if the current char is a control character,
854      * we need one extra col.
855      */
856     if (current->pos < current->chars && get_char(current, current->pos) < ' ') {
857         n++;
858     }
859
860     while (n >= current->cols && pos > 0) {
861         b = utf8_tounicode(buf, &ch);
862         if (ch < ' ') {
863             n--;
864         }
865         n--;
866         buf += b;
867         pos--;
868         chars--;
869     }
870
871     /* Cursor to left edge, then the prompt */
872     cursorToLeft(current);
873     outputChars(current, prompt, plen);
874
875     /* Now the current buffer content */
876
877     /* Need special handling for control characters.
878      * If we hit 'cols', stop.
879      */
880     b = 0; /* unwritted bytes */
881     n = 0; /* How many control chars were written */
882     for (i = 0; i < chars; i++) {
883         int ch;
884         int w = utf8_tounicode(buf + b, &ch);
885         if (ch < ' ') {
886             n++;
887         }
888         if (pchars + i + n >= current->cols) {
889             break;
890         }
891         if (ch < ' ') {
892             /* A control character, so write the buffer so far */
893             outputChars(current, buf, b);
894             buf += b + w;
895             b = 0;
896             outputControlChar(current, ch + '@');
897             if (i < pos) {
898                 backup++;
899             }
900         }
901         else {
902             b += w;
903         }
904     }
905     outputChars(current, buf, b);
906
907     /* Erase to right, move cursor to original position */
908     eraseEol(current);
909     setCursorPos(current, pos + pchars + backup);
910 }
911
912 static void set_current(struct current *current, const char *str)
913 {
914     strncpy(current->buf, str, current->bufmax);
915     current->buf[current->bufmax - 1] = 0;
916     current->len = strlen(current->buf);
917     current->pos = current->chars = utf8_strlen(current->buf, current->len);
918 }
919
920 static int has_room(struct current *current, int bytes)
921 {
922     return current->len + bytes < current->bufmax - 1;
923 }
924
925 /**
926  * Removes the char at 'pos'.
927  *
928  * Returns 1 if the line needs to be refreshed, 2 if not
929  * and 0 if nothing was removed
930  */
931 static int remove_char(struct current *current, int pos)
932 {
933     if (pos >= 0 && pos < current->chars) {
934         int p1, p2;
935         int ret = 1;
936         p1 = utf8_index(current->buf, pos);
937         p2 = p1 + utf8_index(current->buf + p1, 1);
938
939 #ifdef USE_TERMIOS
940         /* optimise remove char in the case of removing the last char */
941         if (current->pos == pos + 1 && current->pos == current->chars) {
942             if (current->buf[pos] >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
943                 ret = 2;
944                 fd_printf(current->fd, "\b \b");
945             }
946         }
947 #endif
948
949         /* Move the null char too */
950         memmove(current->buf + p1, current->buf + p2, current->len - p2 + 1);
951         current->len -= (p2 - p1);
952         current->chars--;
953
954         if (current->pos > pos) {
955             current->pos--;
956         }
957         return ret;
958     }
959     return 0;
960 }
961
962 /**
963  * Insert 'ch' at position 'pos'
964  *
965  * Returns 1 if the line needs to be refreshed, 2 if not
966  * and 0 if nothing was inserted (no room)
967  */
968 static int insert_char(struct current *current, int pos, int ch)
969 {
970     char buf[3];
971     int n = utf8_getchars(buf, ch);
972
973     if (has_room(current, n) && pos >= 0 && pos <= current->chars) {
974         int p1, p2;
975         int ret = 1;
976         p1 = utf8_index(current->buf, pos);
977         p2 = p1 + n;
978
979 #ifdef USE_TERMIOS
980         /* optimise the case where adding a single char to the end and no scrolling is needed */
981         if (current->pos == pos && current->chars == pos) {
982             if (ch >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
983                 IGNORE_RC(write(current->fd, buf, n));
984                 ret = 2;
985             }
986         }
987 #endif
988
989         memmove(current->buf + p2, current->buf + p1, current->len - p1);
990         memcpy(current->buf + p1, buf, n);
991         current->len += n;
992
993         current->chars++;
994         if (current->pos >= pos) {
995             current->pos++;
996         }
997         return ret;
998     }
999     return 0;
1000 }
1001
1002 /**
1003  * Captures up to 'n' characters starting at 'pos' for the cut buffer.
1004  *
1005  * This replaces any existing characters in the cut buffer.
1006  */
1007 static void capture_chars(struct current *current, int pos, int n)
1008 {
1009     if (pos >= 0 && (pos + n - 1) < current->chars) {
1010         int p1 = utf8_index(current->buf, pos);
1011         int nbytes = utf8_index(current->buf + p1, n);
1012
1013         if (nbytes) {
1014             free(current->capture);
1015             /* Include space for the null terminator */
1016             current->capture = (char *)malloc(nbytes + 1);
1017             memcpy(current->capture, current->buf + p1, nbytes);
1018             current->capture[nbytes] = '\0';
1019         }
1020     }
1021 }
1022
1023 /**
1024  * Removes up to 'n' characters at cursor position 'pos'.
1025  *
1026  * Returns 0 if no chars were removed or non-zero otherwise.
1027  */
1028 static int remove_chars(struct current *current, int pos, int n)
1029 {
1030     int removed = 0;
1031
1032     /* First save any chars which will be removed */
1033     capture_chars(current, pos, n);
1034
1035     while (n-- && remove_char(current, pos)) {
1036         removed++;
1037     }
1038     return removed;
1039 }
1040 /**
1041  * Inserts the characters (string) 'chars' at the cursor position 'pos'.
1042  *
1043  * Returns 0 if no chars were inserted or non-zero otherwise.
1044  */
1045 static int insert_chars(struct current *current, int pos, const char *chars)
1046 {
1047     int inserted = 0;
1048
1049     while (*chars) {
1050         int ch;
1051         int n = utf8_tounicode(chars, &ch);
1052         if (insert_char(current, pos, ch) == 0) {
1053             break;
1054         }
1055         inserted++;
1056         pos++;
1057         chars += n;
1058     }
1059     return inserted;
1060 }
1061
1062 #ifndef NO_COMPLETION
1063 static linenoiseCompletionCallback *completionCallback = NULL;
1064
1065 static void beep() {
1066 #ifdef USE_TERMIOS
1067     fprintf(stderr, "\x7");
1068     fflush(stderr);
1069 #endif
1070 }
1071
1072 static void freeCompletions(linenoiseCompletions *lc) {
1073     size_t i;
1074     for (i = 0; i < lc->len; i++)
1075         free(lc->cvec[i]);
1076     free(lc->cvec);
1077 }
1078
1079 static int completeLine(struct current *current) {
1080     linenoiseCompletions lc = { 0, NULL };
1081     int c = 0;
1082
1083     completionCallback(current->buf,&lc);
1084     if (lc.len == 0) {
1085         beep();
1086     } else {
1087         size_t stop = 0, i = 0;
1088
1089         while(!stop) {
1090             /* Show completion or original buffer */
1091             if (i < lc.len) {
1092                 struct current tmp = *current;
1093                 tmp.buf = lc.cvec[i];
1094                 tmp.pos = tmp.len = strlen(tmp.buf);
1095                 tmp.chars = utf8_strlen(tmp.buf, tmp.len);
1096                 refreshLine(current->prompt, &tmp);
1097             } else {
1098                 refreshLine(current->prompt, current);
1099             }
1100
1101             c = fd_read(current);
1102             if (c == -1) {
1103                 break;
1104             }
1105
1106             switch(c) {
1107                 case '\t': /* tab */
1108                     i = (i+1) % (lc.len+1);
1109                     if (i == lc.len) beep();
1110                     break;
1111                 case 27: /* escape */
1112                     /* Re-show original buffer */
1113                     if (i < lc.len) {
1114                         refreshLine(current->prompt, current);
1115                     }
1116                     stop = 1;
1117                     break;
1118                 default:
1119                     /* Update buffer and return */
1120                     if (i < lc.len) {
1121                         set_current(current,lc.cvec[i]);
1122                     }
1123                     stop = 1;
1124                     break;
1125             }
1126         }
1127     }
1128
1129     freeCompletions(&lc);
1130     return c; /* Return last read character */
1131 }
1132
1133 /* Register a callback function to be called for tab-completion.
1134    Returns the prior callback so that the caller may (if needed)
1135    restore it when done. */
1136 linenoiseCompletionCallback * linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) {
1137     linenoiseCompletionCallback * old = completionCallback;
1138     completionCallback = fn;
1139     return old;
1140 }
1141
1142 void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
1143     lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
1144     lc->cvec[lc->len++] = strdup(str);
1145 }
1146
1147 #endif
1148
1149 static int linenoiseEdit(struct current *current) {
1150     int history_index = 0;
1151
1152     /* The latest history entry is always our current buffer, that
1153      * initially is just an empty string. */
1154     linenoiseHistoryAdd("");
1155
1156     set_current(current, "");
1157     refreshLine(current->prompt, current);
1158
1159     while(1) {
1160         int dir = -1;
1161         int c = fd_read(current);
1162
1163 #ifndef NO_COMPLETION
1164         /* Only autocomplete when the callback is set. It returns < 0 when
1165          * there was an error reading from fd. Otherwise it will return the
1166          * character that should be handled next. */
1167         if (c == '\t' && current->pos == current->chars && completionCallback != NULL) {
1168             c = completeLine(current);
1169             /* Return on errors */
1170             if (c < 0) return current->len;
1171             /* Read next character when 0 */
1172             if (c == 0) continue;
1173         }
1174 #endif
1175
1176 process_char:
1177         if (c == -1) return current->len;
1178 #ifdef USE_TERMIOS
1179         if (c == 27) {   /* escape sequence */
1180             c = check_special(current->fd);
1181         }
1182 #endif
1183         switch(c) {
1184         case '\r':    /* enter */
1185             history_len--;
1186             free(history[history_len]);
1187             return current->len;
1188         case ctrl('C'):     /* ctrl-c */
1189             errno = EAGAIN;
1190             return -1;
1191         case 127:   /* backspace */
1192         case ctrl('H'):
1193             if (remove_char(current, current->pos - 1) == 1) {
1194                 refreshLine(current->prompt, current);
1195             }
1196             break;
1197         case ctrl('D'):     /* ctrl-d */
1198             if (current->len == 0) {
1199                 /* Empty line, so EOF */
1200                 history_len--;
1201                 free(history[history_len]);
1202                 return -1;
1203             }
1204             /* Otherwise fall through to delete char to right of cursor */
1205         case SPECIAL_DELETE:
1206             if (remove_char(current, current->pos) == 1) {
1207                 refreshLine(current->prompt, current);
1208             }
1209             break;
1210         case SPECIAL_INSERT:
1211             /* Ignore. Expansion Hook.
1212              * Future possibility: Toggle Insert/Overwrite Modes
1213              */
1214             break;
1215         case ctrl('W'):    /* ctrl-w, delete word at left. save deleted chars */
1216             /* eat any spaces on the left */
1217             {
1218                 int pos = current->pos;
1219                 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1220                     pos--;
1221                 }
1222
1223                 /* now eat any non-spaces on the left */
1224                 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1225                     pos--;
1226                 }
1227
1228                 if (remove_chars(current, pos, current->pos - pos)) {
1229                     refreshLine(current->prompt, current);
1230                 }
1231             }
1232             break;
1233         case ctrl('R'):    /* ctrl-r */
1234             {
1235                 /* Display the reverse-i-search prompt and process chars */
1236                 char rbuf[50];
1237                 char rprompt[80];
1238                 int rchars = 0;
1239                 int rlen = 0;
1240                 int searchpos = history_len - 1;
1241
1242                 rbuf[0] = 0;
1243                 while (1) {
1244                     int n = 0;
1245                     const char *p = NULL;
1246                     int skipsame = 0;
1247                     int searchdir = -1;
1248
1249                     snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
1250                     refreshLine(rprompt, current);
1251                     c = fd_read(current);
1252                     if (c == ctrl('H') || c == 127) {
1253                         if (rchars) {
1254                             int p = utf8_index(rbuf, --rchars);
1255                             rbuf[p] = 0;
1256                             rlen = strlen(rbuf);
1257                         }
1258                         continue;
1259                     }
1260 #ifdef USE_TERMIOS
1261                     if (c == 27) {
1262                         c = check_special(current->fd);
1263                     }
1264 #endif
1265                     if (c == ctrl('P') || c == SPECIAL_UP) {
1266                         /* Search for the previous (earlier) match */
1267                         if (searchpos > 0) {
1268                             searchpos--;
1269                         }
1270                         skipsame = 1;
1271                     }
1272                     else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1273                         /* Search for the next (later) match */
1274                         if (searchpos < history_len) {
1275                             searchpos++;
1276                         }
1277                         searchdir = 1;
1278                         skipsame = 1;
1279                     }
1280                     else if (c >= ' ') {
1281                         if (rlen >= (int)sizeof(rbuf) + 3) {
1282                             continue;
1283                         }
1284
1285                         n = utf8_getchars(rbuf + rlen, c);
1286                         rlen += n;
1287                         rchars++;
1288                         rbuf[rlen] = 0;
1289
1290                         /* Adding a new char resets the search location */
1291                         searchpos = history_len - 1;
1292                     }
1293                     else {
1294                         /* Exit from incremental search mode */
1295                         break;
1296                     }
1297
1298                     /* Now search through the history for a match */
1299                     for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1300                         p = strstr(history[searchpos], rbuf);
1301                         if (p) {
1302                             /* Found a match */
1303                             if (skipsame && strcmp(history[searchpos], current->buf) == 0) {
1304                                 /* But it is identical, so skip it */
1305                                 continue;
1306                             }
1307                             /* Copy the matching line and set the cursor position */
1308                             set_current(current,history[searchpos]);
1309                             current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
1310                             break;
1311                         }
1312                     }
1313                     if (!p && n) {
1314                         /* No match, so don't add it */
1315                         rchars--;
1316                         rlen -= n;
1317                         rbuf[rlen] = 0;
1318                     }
1319                 }
1320                 if (c == ctrl('G') || c == ctrl('C')) {
1321                     /* ctrl-g terminates the search with no effect */
1322                     set_current(current, "");
1323                     c = 0;
1324                 }
1325                 else if (c == ctrl('J')) {
1326                     /* ctrl-j terminates the search leaving the buffer in place */
1327                     c = 0;
1328                 }
1329                 /* Go process the char normally */
1330                 refreshLine(current->prompt, current);
1331                 goto process_char;
1332             }
1333             break;
1334         case ctrl('T'):    /* ctrl-t */
1335             if (current->pos > 0 && current->pos <= current->chars) {
1336                 /* If cursor is at end, transpose the previous two chars */
1337                 int fixer = (current->pos == current->chars);
1338                 c = get_char(current, current->pos - fixer);
1339                 remove_char(current, current->pos - fixer);
1340                 insert_char(current, current->pos - 1, c);
1341                 refreshLine(current->prompt, current);
1342             }
1343             break;
1344         case ctrl('V'):    /* ctrl-v */
1345             if (has_room(current, 3)) {
1346                 /* Insert the ^V first */
1347                 if (insert_char(current, current->pos, c)) {
1348                     refreshLine(current->prompt, current);
1349                     /* Now wait for the next char. Can insert anything except \0 */
1350                     c = fd_read(current);
1351
1352                     /* Remove the ^V first */
1353                     remove_char(current, current->pos - 1);
1354                     if (c != -1) {
1355                         /* Insert the actual char */
1356                         insert_char(current, current->pos, c);
1357                     }
1358                     refreshLine(current->prompt, current);
1359                 }
1360             }
1361             break;
1362         case ctrl('B'):
1363         case SPECIAL_LEFT:
1364             if (current->pos > 0) {
1365                 current->pos--;
1366                 refreshLine(current->prompt, current);
1367             }
1368             break;
1369         case ctrl('F'):
1370         case SPECIAL_RIGHT:
1371             if (current->pos < current->chars) {
1372                 current->pos++;
1373                 refreshLine(current->prompt, current);
1374             }
1375             break;
1376         case SPECIAL_PAGE_UP:
1377           dir = history_len - history_index - 1; /* move to start of history */
1378           goto history_navigation;
1379         case SPECIAL_PAGE_DOWN:
1380           dir = -history_index; /* move to 0 == end of history, i.e. current */
1381           goto history_navigation;
1382         case ctrl('P'):
1383         case SPECIAL_UP:
1384             dir = 1;
1385           goto history_navigation;
1386         case ctrl('N'):
1387         case SPECIAL_DOWN:
1388 history_navigation:
1389             if (history_len > 1) {
1390                 /* Update the current history entry before to
1391                  * overwrite it with tne next one. */
1392                 free(history[history_len - 1 - history_index]);
1393                 history[history_len - 1 - history_index] = strdup(current->buf);
1394                 /* Show the new entry */
1395                 history_index += dir;
1396                 if (history_index < 0) {
1397                     history_index = 0;
1398                     break;
1399                 } else if (history_index >= history_len) {
1400                     history_index = history_len - 1;
1401                     break;
1402                 }
1403                 set_current(current, history[history_len - 1 - history_index]);
1404                 refreshLine(current->prompt, current);
1405             }
1406             break;
1407         case ctrl('A'): /* Ctrl+a, go to the start of the line */
1408         case SPECIAL_HOME:
1409             current->pos = 0;
1410             refreshLine(current->prompt, current);
1411             break;
1412         case ctrl('E'): /* ctrl+e, go to the end of the line */
1413         case SPECIAL_END:
1414             current->pos = current->chars;
1415             refreshLine(current->prompt, current);
1416             break;
1417         case ctrl('U'): /* Ctrl+u, delete to beginning of line, save deleted chars. */
1418             if (remove_chars(current, 0, current->pos)) {
1419                 refreshLine(current->prompt, current);
1420             }
1421             break;
1422         case ctrl('K'): /* Ctrl+k, delete from current to end of line, save deleted chars. */
1423             if (remove_chars(current, current->pos, current->chars - current->pos)) {
1424                 refreshLine(current->prompt, current);
1425             }
1426             break;
1427         case ctrl('Y'): /* Ctrl+y, insert saved chars at current position */
1428             if (current->capture && insert_chars(current, current->pos, current->capture)) {
1429                 refreshLine(current->prompt, current);
1430             }
1431             break;
1432         case ctrl('L'): /* Ctrl+L, clear screen */
1433             clearScreen(current);
1434             /* Force recalc of window size for serial terminals */
1435             current->cols = 0;
1436             refreshLine(current->prompt, current);
1437             break;
1438         default:
1439             /* Only tab is allowed without ^V */
1440             if (c == '\t' || c >= ' ') {
1441                 if (insert_char(current, current->pos, c) == 1) {
1442                     refreshLine(current->prompt, current);
1443                 }
1444             }
1445             break;
1446         }
1447     }
1448     return current->len;
1449 }
1450
1451 int linenoiseColumns(void)
1452 {
1453     struct current current;
1454     enableRawMode (&current);
1455     getWindowSize (&current);
1456     disableRawMode (&current);
1457     return current.cols;
1458 }
1459
1460 char *linenoise(const char *prompt)
1461 {
1462     int count;
1463     struct current current;
1464     char buf[LINENOISE_MAX_LINE];
1465
1466     if (enableRawMode(&current) == -1) {
1467         printf("%s", prompt);
1468         fflush(stdout);
1469         if (fgets(buf, sizeof(buf), stdin) == NULL) {
1470             return NULL;
1471         }
1472         count = strlen(buf);
1473         if (count && buf[count-1] == '\n') {
1474             count--;
1475             buf[count] = '\0';
1476         }
1477     }
1478     else
1479     {
1480         current.buf = buf;
1481         current.bufmax = sizeof(buf);
1482         current.len = 0;
1483         current.chars = 0;
1484         current.pos = 0;
1485         current.prompt = prompt;
1486         current.capture = NULL;
1487
1488         count = linenoiseEdit(&current);
1489
1490         disableRawMode(&current);
1491         printf("\n");
1492
1493         free(current.capture);
1494         if (count == -1) {
1495             return NULL;
1496         }
1497     }
1498     return strdup(buf);
1499 }
1500
1501 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1502 int linenoiseHistoryAdd(const char *line) {
1503     char *linecopy;
1504
1505     if (history_max_len == 0) return 0;
1506     if (history == NULL) {
1507         history = (char **)malloc(sizeof(char*)*history_max_len);
1508         if (history == NULL) return 0;
1509         memset(history,0,(sizeof(char*)*history_max_len));
1510     }
1511
1512     /* do not insert duplicate lines into history */
1513     if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1514         return 0;
1515     }
1516
1517     linecopy = strdup(line);
1518     if (!linecopy) return 0;
1519     if (history_len == history_max_len) {
1520         free(history[0]);
1521         memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1522         history_len--;
1523     }
1524     history[history_len] = linecopy;
1525     history_len++;
1526     return 1;
1527 }
1528
1529 int linenoiseHistoryGetMaxLen(void) {
1530     return history_max_len;
1531 }
1532
1533 int linenoiseHistorySetMaxLen(int len) {
1534     char **newHistory;
1535
1536     if (len < 1) return 0;
1537     if (history) {
1538         int tocopy = history_len;
1539
1540         newHistory = (char **)malloc(sizeof(char*)*len);
1541         if (newHistory == NULL) return 0;
1542
1543         /* If we can't copy everything, free the elements we'll not use. */
1544         if (len < tocopy) {
1545             int j;
1546
1547             for (j = 0; j < tocopy-len; j++) free(history[j]);
1548             tocopy = len;
1549         }
1550         memset(newHistory,0,sizeof(char*)*len);
1551         memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
1552         free(history);
1553         history = newHistory;
1554     }
1555     history_max_len = len;
1556     if (history_len > history_max_len)
1557         history_len = history_max_len;
1558     return 1;
1559 }
1560
1561 /* Save the history in the specified file. On success 0 is returned
1562  * otherwise -1 is returned. */
1563 int linenoiseHistorySave(const char *filename) {
1564     FILE *fp = fopen(filename,"w");
1565     int j;
1566
1567     if (fp == NULL) return -1;
1568     for (j = 0; j < history_len; j++) {
1569         const char *str = history[j];
1570         /* Need to encode backslash, nl and cr */
1571         while (*str) {
1572             if (*str == '\\') {
1573                 fputs("\\\\", fp);
1574             }
1575             else if (*str == '\n') {
1576                 fputs("\\n", fp);
1577             }
1578             else if (*str == '\r') {
1579                 fputs("\\r", fp);
1580             }
1581             else {
1582                 fputc(*str, fp);
1583             }
1584             str++;
1585         }
1586         fputc('\n', fp);
1587     }
1588
1589     fclose(fp);
1590     return 0;
1591 }
1592
1593 /* Load the history from the specified file. If the file does not exist
1594  * zero is returned and no operation is performed.
1595  *
1596  * If the file exists and the operation succeeded 0 is returned, otherwise
1597  * on error -1 is returned. */
1598 int linenoiseHistoryLoad(const char *filename) {
1599     FILE *fp = fopen(filename,"r");
1600     char buf[LINENOISE_MAX_LINE];
1601
1602     if (fp == NULL) return -1;
1603
1604     while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) {
1605         char *src, *dest;
1606
1607         /* Decode backslash escaped values */
1608         for (src = dest = buf; *src; src++) {
1609             char ch = *src;
1610
1611             if (ch == '\\') {
1612                 src++;
1613                 if (*src == 'n') {
1614                     ch = '\n';
1615                 }
1616                 else if (*src == 'r') {
1617                     ch = '\r';
1618                 } else {
1619                     ch = *src;
1620                 }
1621             }
1622             *dest++ = ch;
1623         }
1624         /* Remove trailing newline */
1625         if (dest != buf && (dest[-1] == '\n' || dest[-1] == '\r')) {
1626             dest--;
1627         }
1628         *dest = 0;
1629
1630         linenoiseHistoryAdd(buf);
1631     }
1632     fclose(fp);
1633     return 0;
1634 }
1635
1636 /* Provide access to the history buffer.
1637  *
1638  * If 'len' is not NULL, the length is stored in *len.
1639  */
1640 char **linenoiseHistory(int *len) {
1641     if (len) {
1642         *len = history_len;
1643     }
1644     return history;
1645 }