]> git.lizzy.rs Git - linenoise.git/blob - linenoise.c
091d197a06eea216d65702ae2725172daad1bc0c
[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 - actually, no need to 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 void linenoiseClearScreen(void)
297 {
298     fd_printf(STDOUT_FILENO, "\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 void linenoiseClearScreen(void)
636 {
637     /* XXX: This is ugly. Should just have the caller pass a handle */
638     struct current current;
639
640     current.outh = GetStdHandle(STD_OUTPUT_HANDLE);
641
642     if (getWindowSize(&current) == 0) {
643         COORD topleft = { 0, 0 };
644         DWORD n;
645
646         FillConsoleOutputCharacter(current.outh, ' ',
647             current.cols * current.rows, topleft, &n);
648         FillConsoleOutputAttribute(current.outh,
649             FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN,
650             current.cols * current.rows, topleft, &n);
651         SetConsoleCursorPosition(current.outh, topleft);
652     }
653 }
654
655 static void cursorToLeft(struct current *current)
656 {
657     COORD pos;
658     DWORD n;
659
660     pos.X = 0;
661     pos.Y = (SHORT)current->y;
662
663     FillConsoleOutputAttribute(current->outh,
664         FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN, current->cols, pos, &n);
665     current->x = 0;
666 }
667
668 static int outputChars(struct current *current, const char *buf, int len)
669 {
670     COORD pos;
671     DWORD n;
672
673     pos.Y = (SHORT)current->y;
674
675 #ifdef USE_UTF8
676     while ( len > 0 ) {
677         int c, s;
678         wchar_t wc;
679
680         s = utf8_tounicode(buf, &c);
681
682         len -= s;
683         buf += s;
684
685         wc = (wchar_t)c;
686
687         pos.X = (SHORT)current->x;
688
689         /* fixed display utf8 character */
690         WriteConsoleOutputCharacterW(current->outh, &wc, 1, pos, &n);
691
692         current->x += utf8_width(c);
693     }
694 #else
695     pos.X = (SHORT)current->x;
696
697     WriteConsoleOutputCharacterA(current->outh, buf, len, pos, &n);
698     current->x += len;
699 #endif
700
701     return 0;
702 }
703
704 static void outputControlChar(struct current *current, char ch)
705 {
706     COORD pos;
707     DWORD n;
708
709     pos.X = (SHORT) current->x;
710     pos.Y = (SHORT) current->y;
711
712     FillConsoleOutputAttribute(current->outh, BACKGROUND_INTENSITY, 2, pos, &n);
713     outputChars(current, "^", 1);
714     outputChars(current, &ch, 1);
715 }
716
717 static void eraseEol(struct current *current)
718 {
719     COORD pos;
720     DWORD n;
721
722     pos.X = (SHORT) current->x;
723     pos.Y = (SHORT) current->y;
724
725     FillConsoleOutputCharacter(current->outh, ' ', current->cols - current->x, pos, &n);
726 }
727
728 static void setCursorPos(struct current *current, int x)
729 {
730     COORD pos;
731
732     pos.X = (SHORT)x;
733     pos.Y = (SHORT) current->y;
734
735     SetConsoleCursorPosition(current->outh, pos);
736     current->x = x;
737 }
738
739 static int fd_read(struct current *current)
740 {
741     while (1) {
742         INPUT_RECORD irec;
743         DWORD n;
744         if (WaitForSingleObject(current->inh, INFINITE) != WAIT_OBJECT_0) {
745             break;
746         }
747         if (!ReadConsoleInput (current->inh, &irec, 1, &n)) {
748             break;
749         }
750         if (irec.EventType == KEY_EVENT && irec.Event.KeyEvent.bKeyDown) {
751             KEY_EVENT_RECORD *k = &irec.Event.KeyEvent;
752             if (k->dwControlKeyState & ENHANCED_KEY) {
753                 switch (k->wVirtualKeyCode) {
754                  case VK_LEFT:
755                     return SPECIAL_LEFT;
756                  case VK_RIGHT:
757                     return SPECIAL_RIGHT;
758                  case VK_UP:
759                     return SPECIAL_UP;
760                  case VK_DOWN:
761                     return SPECIAL_DOWN;
762                  case VK_INSERT:
763                     return SPECIAL_INSERT;
764                  case VK_DELETE:
765                     return SPECIAL_DELETE;
766                  case VK_HOME:
767                     return SPECIAL_HOME;
768                  case VK_END:
769                     return SPECIAL_END;
770                  case VK_PRIOR:
771                     return SPECIAL_PAGE_UP;
772                  case VK_NEXT:
773                     return SPECIAL_PAGE_DOWN;
774                 }
775             }
776             /* Note that control characters are already translated in AsciiChar */
777             else if (k->wVirtualKeyCode == VK_CONTROL)
778                 continue;
779             else {
780 #ifdef USE_UTF8
781                 return k->uChar.UnicodeChar;
782 #else
783                 return k->uChar.AsciiChar;
784 #endif
785             }
786         }
787     }
788     return -1;
789 }
790
791 static int countColorControlChars(const char* prompt)
792 {
793     /* For windows we assume that there are no embedded ansi color
794      * control sequences.
795      */
796     return 0;
797 }
798
799 static int getWindowSize(struct current *current)
800 {
801     CONSOLE_SCREEN_BUFFER_INFO info;
802     if (!GetConsoleScreenBufferInfo(current->outh, &info)) {
803         return -1;
804     }
805     current->cols = info.dwSize.X;
806     current->rows = info.dwSize.Y;
807     if (current->cols <= 0 || current->rows <= 0) {
808         current->cols = 80;
809         return -1;
810     }
811     current->y = info.dwCursorPosition.Y;
812     current->x = info.dwCursorPosition.X;
813     return 0;
814 }
815 #endif
816
817 static int utf8_getchars(char *buf, int c)
818 {
819 #ifdef USE_UTF8
820     return utf8_fromunicode(buf, c);
821 #else
822     *buf = c;
823     return 1;
824 #endif
825 }
826
827 /**
828  * Returns the unicode character at the given offset,
829  * or -1 if none.
830  */
831 static int get_char(struct current *current, int pos)
832 {
833     if (pos >= 0 && pos < current->chars) {
834         int c;
835         int i = utf8_index(current->buf, pos);
836         (void)utf8_tounicode(current->buf + i, &c);
837         return c;
838     }
839     return -1;
840 }
841
842 static void refreshLine(const char *prompt, struct current *current)
843 {
844     int plen;
845     int pchars;
846     int backup = 0;
847     int i;
848     const char *buf = current->buf;
849     int chars = current->chars;
850     int pos = current->pos;
851     int b;
852     int ch;
853     int n;
854     int width;
855     int bufwidth;
856
857     /* Should intercept SIGWINCH. For now, just get the size every time */
858     getWindowSize(current);
859
860     plen = strlen(prompt);
861     pchars = utf8_strwidth(prompt, utf8_strlen(prompt, plen));
862
863     /* Scan the prompt for embedded ansi color control sequences and
864      * discount them as characters/columns.
865      */
866     pchars -= countColorControlChars(prompt);
867
868     /* Account for a line which is too long to fit in the window.
869      * Note that control chars require an extra column
870      */
871
872     /* How many cols are required to the left of 'pos'?
873      * The prompt, plus one extra for each control char
874      */
875     n = pchars + utf8_strwidth(buf, utf8_strlen(buf, current->len));
876     b = 0;
877     for (i = 0; i < pos; i++) {
878         b += utf8_tounicode(buf + b, &ch);
879         if (ch < ' ') {
880             n++;
881         }
882     }
883
884     /* Pluse one if the current char is a control character */
885     if (current->pos < current->chars && get_char(current, current->pos) < ' ') {
886         n++;
887     }
888
889     /* If too many are needed, strip chars off the front of 'buf'
890      * until it fits. Note that if the current char is a control character,
891      * we need one extra col.
892      */
893     while (n >= current->cols && pos > 0) {
894         b = utf8_tounicode(buf, &ch);
895         if (ch < ' ') {
896             n--;
897         }
898         n -= utf8_width(ch);
899         buf += b;
900         pos--;
901         chars--;
902     }
903
904     /* Cursor to left edge, then the prompt */
905     cursorToLeft(current);
906     outputChars(current, prompt, plen);
907
908     /* Now the current buffer content */
909
910     /* Need special handling for control characters.
911      * If we hit 'cols', stop.
912      */
913     b = 0; /* unwritted bytes */
914     n = 0; /* How many control chars were written */
915     width = 0; /* current display width */
916     bufwidth = utf8_strwidth(buf, pos);
917
918     for (i = 0; i < chars; i++) {
919         int ch;
920         int w = utf8_tounicode(buf + b, &ch);
921         if (ch < ' ') {
922             n++;
923         }
924
925         width += utf8_width(ch);
926
927         if (pchars + width + n >= current->cols) {
928             break;
929         }
930         if (ch < ' ') {
931             /* A control character, so write the buffer so far */
932             outputChars(current, buf, b);
933             buf += b + w;
934             b = 0;
935             outputControlChar(current, ch + '@');
936             if (i < pos) {
937                 backup++;
938             }
939         }
940         else {
941             b += w;
942         }
943     }
944     outputChars(current, buf, b);
945
946     /* Erase to right, move cursor to original position */
947     eraseEol(current);
948     setCursorPos(current, bufwidth + pchars + backup);
949 }
950
951 static void set_current(struct current *current, const char *str)
952 {
953     strncpy(current->buf, str, current->bufmax);
954     current->buf[current->bufmax - 1] = 0;
955     current->len = strlen(current->buf);
956     current->pos = current->chars = utf8_strlen(current->buf, current->len);
957 }
958
959 static int has_room(struct current *current, int bytes)
960 {
961     return current->len + bytes < current->bufmax - 1;
962 }
963
964 /**
965  * Removes the char at 'pos'.
966  *
967  * Returns 1 if the line needs to be refreshed, 2 if not
968  * and 0 if nothing was removed
969  */
970 static int remove_char(struct current *current, int pos)
971 {
972     if (pos >= 0 && pos < current->chars) {
973         int p1, p2;
974         int ret = 1;
975         p1 = utf8_index(current->buf, pos);
976         p2 = p1 + utf8_index(current->buf + p1, 1);
977
978 #ifdef USE_TERMIOS
979         /* optimise remove char in the case of removing the last char */
980         if (current->pos == pos + 1 && current->pos == current->chars) {
981             if (current->buf[pos] >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
982                 ret = 2;
983                 fd_printf(current->fd, "\b \b");
984             }
985         }
986 #endif
987
988         /* Move the null char too */
989         memmove(current->buf + p1, current->buf + p2, current->len - p2 + 1);
990         current->len -= (p2 - p1);
991         current->chars--;
992
993         if (current->pos > pos) {
994             current->pos--;
995         }
996         return ret;
997     }
998     return 0;
999 }
1000
1001 /**
1002  * Insert 'ch' at position 'pos'
1003  *
1004  * Returns 1 if the line needs to be refreshed, 2 if not
1005  * and 0 if nothing was inserted (no room)
1006  */
1007 static int insert_char(struct current *current, int pos, int ch)
1008 {
1009     char buf[3];
1010     int n = utf8_getchars(buf, ch);
1011
1012     if (has_room(current, n) && pos >= 0 && pos <= current->chars) {
1013         int p1, p2;
1014         int ret = 1;
1015         p1 = utf8_index(current->buf, pos);
1016         p2 = p1 + n;
1017
1018 #ifdef USE_TERMIOS
1019         /* optimise the case where adding a single char to the end and no scrolling is needed */
1020         if (current->pos == pos && current->chars == pos) {
1021             if (ch >= ' ' && utf8_strlen(current->prompt, -1) + utf8_strlen(current->buf, current->len) < current->cols - 1) {
1022                 IGNORE_RC(write(current->fd, buf, n));
1023                 ret = 2;
1024             }
1025         }
1026 #endif
1027
1028         memmove(current->buf + p2, current->buf + p1, current->len - p1);
1029         memcpy(current->buf + p1, buf, n);
1030         current->len += n;
1031
1032         current->chars++;
1033         if (current->pos >= pos) {
1034             current->pos++;
1035         }
1036         return ret;
1037     }
1038     return 0;
1039 }
1040
1041 /**
1042  * Captures up to 'n' characters starting at 'pos' for the cut buffer.
1043  *
1044  * This replaces any existing characters in the cut buffer.
1045  */
1046 static void capture_chars(struct current *current, int pos, int n)
1047 {
1048     if (pos >= 0 && (pos + n - 1) < current->chars) {
1049         int p1 = utf8_index(current->buf, pos);
1050         int nbytes = utf8_index(current->buf + p1, n);
1051
1052         if (nbytes) {
1053             free(current->capture);
1054             /* Include space for the null terminator */
1055             current->capture = (char *)malloc(nbytes + 1);
1056             memcpy(current->capture, current->buf + p1, nbytes);
1057             current->capture[nbytes] = '\0';
1058         }
1059     }
1060 }
1061
1062 /**
1063  * Removes up to 'n' characters at cursor position 'pos'.
1064  *
1065  * Returns 0 if no chars were removed or non-zero otherwise.
1066  */
1067 static int remove_chars(struct current *current, int pos, int n)
1068 {
1069     int removed = 0;
1070
1071     /* First save any chars which will be removed */
1072     capture_chars(current, pos, n);
1073
1074     while (n-- && remove_char(current, pos)) {
1075         removed++;
1076     }
1077     return removed;
1078 }
1079 /**
1080  * Inserts the characters (string) 'chars' at the cursor position 'pos'.
1081  *
1082  * Returns 0 if no chars were inserted or non-zero otherwise.
1083  */
1084 static int insert_chars(struct current *current, int pos, const char *chars)
1085 {
1086     int inserted = 0;
1087
1088     while (*chars) {
1089         int ch;
1090         int n = utf8_tounicode(chars, &ch);
1091         if (insert_char(current, pos, ch) == 0) {
1092             break;
1093         }
1094         inserted++;
1095         pos++;
1096         chars += n;
1097     }
1098     return inserted;
1099 }
1100
1101 #ifndef NO_COMPLETION
1102 static linenoiseCompletionCallback *completionCallback = NULL;
1103 static void *completionUserdata = NULL;
1104
1105 static void beep() {
1106 #ifdef USE_TERMIOS
1107     fprintf(stderr, "\x7");
1108     fflush(stderr);
1109 #endif
1110 }
1111
1112 static void freeCompletions(linenoiseCompletions *lc) {
1113     size_t i;
1114     for (i = 0; i < lc->len; i++)
1115         free(lc->cvec[i]);
1116     free(lc->cvec);
1117 }
1118
1119 static int completeLine(struct current *current) {
1120     linenoiseCompletions lc = { 0, NULL };
1121     int c = 0;
1122
1123     completionCallback(current->buf,&lc,completionUserdata);
1124     if (lc.len == 0) {
1125         beep();
1126     } else {
1127         size_t stop = 0, i = 0;
1128
1129         while(!stop) {
1130             /* Show completion or original buffer */
1131             if (i < lc.len) {
1132                 struct current tmp = *current;
1133                 tmp.buf = lc.cvec[i];
1134                 tmp.pos = tmp.len = strlen(tmp.buf);
1135                 tmp.chars = utf8_strlen(tmp.buf, tmp.len);
1136                 refreshLine(current->prompt, &tmp);
1137             } else {
1138                 refreshLine(current->prompt, current);
1139             }
1140
1141             c = fd_read(current);
1142             if (c == -1) {
1143                 break;
1144             }
1145
1146             switch(c) {
1147                 case '\t': /* tab */
1148                     i = (i+1) % (lc.len+1);
1149                     if (i == lc.len) beep();
1150                     break;
1151                 case 27: /* escape */
1152                     /* Re-show original buffer */
1153                     if (i < lc.len) {
1154                         refreshLine(current->prompt, current);
1155                     }
1156                     stop = 1;
1157                     break;
1158                 default:
1159                     /* Update buffer and return */
1160                     if (i < lc.len) {
1161                         set_current(current,lc.cvec[i]);
1162                     }
1163                     stop = 1;
1164                     break;
1165             }
1166         }
1167     }
1168
1169     freeCompletions(&lc);
1170     return c; /* Return last read character */
1171 }
1172
1173 /* Register a callback function to be called for tab-completion.
1174    Returns the prior callback so that the caller may (if needed)
1175    restore it when done. */
1176 linenoiseCompletionCallback * linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn, void *userdata) {
1177     linenoiseCompletionCallback * old = completionCallback;
1178     completionCallback = fn;
1179     completionUserdata = userdata;
1180     return old;
1181 }
1182
1183 void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
1184     lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
1185     lc->cvec[lc->len++] = strdup(str);
1186 }
1187
1188 #endif
1189
1190 static int linenoiseEdit(struct current *current) {
1191     int history_index = 0;
1192
1193     /* The latest history entry is always our current buffer, that
1194      * initially is just an empty string. */
1195     linenoiseHistoryAdd("");
1196
1197     set_current(current, "");
1198     refreshLine(current->prompt, current);
1199
1200     while(1) {
1201         int dir = -1;
1202         int c = fd_read(current);
1203
1204 #ifndef NO_COMPLETION
1205         /* Only autocomplete when the callback is set. It returns < 0 when
1206          * there was an error reading from fd. Otherwise it will return the
1207          * character that should be handled next. */
1208         if (c == '\t' && current->pos == current->chars && completionCallback != NULL) {
1209             c = completeLine(current);
1210             /* Return on errors */
1211             if (c < 0) return current->len;
1212             /* Read next character when 0 */
1213             if (c == 0) continue;
1214         }
1215 #endif
1216
1217 process_char:
1218         if (c == -1) return current->len;
1219 #ifdef USE_TERMIOS
1220         if (c == 27) {   /* escape sequence */
1221             c = check_special(current->fd);
1222         }
1223 #endif
1224         switch(c) {
1225         case '\r':    /* enter */
1226             history_len--;
1227             free(history[history_len]);
1228             return current->len;
1229         case ctrl('C'):     /* ctrl-c */
1230             errno = EAGAIN;
1231             return -1;
1232         case 127:   /* backspace */
1233         case ctrl('H'):
1234             if (remove_char(current, current->pos - 1) == 1) {
1235                 refreshLine(current->prompt, current);
1236             }
1237             break;
1238         case ctrl('D'):     /* ctrl-d */
1239             if (current->len == 0) {
1240                 /* Empty line, so EOF */
1241                 history_len--;
1242                 free(history[history_len]);
1243                 return -1;
1244             }
1245             /* Otherwise fall through to delete char to right of cursor */
1246         case SPECIAL_DELETE:
1247             if (remove_char(current, current->pos) == 1) {
1248                 refreshLine(current->prompt, current);
1249             }
1250             break;
1251         case SPECIAL_INSERT:
1252             /* Ignore. Expansion Hook.
1253              * Future possibility: Toggle Insert/Overwrite Modes
1254              */
1255             break;
1256         case ctrl('W'):    /* ctrl-w, delete word at left. save deleted chars */
1257             /* eat any spaces on the left */
1258             {
1259                 int pos = current->pos;
1260                 while (pos > 0 && get_char(current, pos - 1) == ' ') {
1261                     pos--;
1262                 }
1263
1264                 /* now eat any non-spaces on the left */
1265                 while (pos > 0 && get_char(current, pos - 1) != ' ') {
1266                     pos--;
1267                 }
1268
1269                 if (remove_chars(current, pos, current->pos - pos)) {
1270                     refreshLine(current->prompt, current);
1271                 }
1272             }
1273             break;
1274         case ctrl('R'):    /* ctrl-r */
1275             {
1276                 /* Display the reverse-i-search prompt and process chars */
1277                 char rbuf[50];
1278                 char rprompt[80];
1279                 int rchars = 0;
1280                 int rlen = 0;
1281                 int searchpos = history_len - 1;
1282
1283                 rbuf[0] = 0;
1284                 while (1) {
1285                     int n = 0;
1286                     const char *p = NULL;
1287                     int skipsame = 0;
1288                     int searchdir = -1;
1289
1290                     snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
1291                     refreshLine(rprompt, current);
1292                     c = fd_read(current);
1293                     if (c == ctrl('H') || c == 127) {
1294                         if (rchars) {
1295                             int p = utf8_index(rbuf, --rchars);
1296                             rbuf[p] = 0;
1297                             rlen = strlen(rbuf);
1298                         }
1299                         continue;
1300                     }
1301 #ifdef USE_TERMIOS
1302                     if (c == 27) {
1303                         c = check_special(current->fd);
1304                     }
1305 #endif
1306                     if (c == ctrl('P') || c == SPECIAL_UP) {
1307                         /* Search for the previous (earlier) match */
1308                         if (searchpos > 0) {
1309                             searchpos--;
1310                         }
1311                         skipsame = 1;
1312                     }
1313                     else if (c == ctrl('N') || c == SPECIAL_DOWN) {
1314                         /* Search for the next (later) match */
1315                         if (searchpos < history_len) {
1316                             searchpos++;
1317                         }
1318                         searchdir = 1;
1319                         skipsame = 1;
1320                     }
1321                     else if (c >= ' ') {
1322                         if (rlen >= (int)sizeof(rbuf) + 3) {
1323                             continue;
1324                         }
1325
1326                         n = utf8_getchars(rbuf + rlen, c);
1327                         rlen += n;
1328                         rchars++;
1329                         rbuf[rlen] = 0;
1330
1331                         /* Adding a new char resets the search location */
1332                         searchpos = history_len - 1;
1333                     }
1334                     else {
1335                         /* Exit from incremental search mode */
1336                         break;
1337                     }
1338
1339                     /* Now search through the history for a match */
1340                     for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
1341                         p = strstr(history[searchpos], rbuf);
1342                         if (p) {
1343                             /* Found a match */
1344                             if (skipsame && strcmp(history[searchpos], current->buf) == 0) {
1345                                 /* But it is identical, so skip it */
1346                                 continue;
1347                             }
1348                             /* Copy the matching line and set the cursor position */
1349                             set_current(current,history[searchpos]);
1350                             current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
1351                             break;
1352                         }
1353                     }
1354                     if (!p && n) {
1355                         /* No match, so don't add it */
1356                         rchars--;
1357                         rlen -= n;
1358                         rbuf[rlen] = 0;
1359                     }
1360                 }
1361                 if (c == ctrl('G') || c == ctrl('C')) {
1362                     /* ctrl-g terminates the search with no effect */
1363                     set_current(current, "");
1364                     c = 0;
1365                 }
1366                 else if (c == ctrl('J')) {
1367                     /* ctrl-j terminates the search leaving the buffer in place */
1368                     c = 0;
1369                 }
1370                 /* Go process the char normally */
1371                 refreshLine(current->prompt, current);
1372                 goto process_char;
1373             }
1374             break;
1375         case ctrl('T'):    /* ctrl-t */
1376             if (current->pos > 0 && current->pos <= current->chars) {
1377                 /* If cursor is at end, transpose the previous two chars */
1378                 int fixer = (current->pos == current->chars);
1379                 c = get_char(current, current->pos - fixer);
1380                 remove_char(current, current->pos - fixer);
1381                 insert_char(current, current->pos - 1, c);
1382                 refreshLine(current->prompt, current);
1383             }
1384             break;
1385         case ctrl('V'):    /* ctrl-v */
1386             if (has_room(current, 3)) {
1387                 /* Insert the ^V first */
1388                 if (insert_char(current, current->pos, c)) {
1389                     refreshLine(current->prompt, current);
1390                     /* Now wait for the next char. Can insert anything except \0 */
1391                     c = fd_read(current);
1392
1393                     /* Remove the ^V first */
1394                     remove_char(current, current->pos - 1);
1395                     if (c != -1) {
1396                         /* Insert the actual char */
1397                         insert_char(current, current->pos, c);
1398                     }
1399                     refreshLine(current->prompt, current);
1400                 }
1401             }
1402             break;
1403         case ctrl('B'):
1404         case SPECIAL_LEFT:
1405             if (current->pos > 0) {
1406                 current->pos--;
1407                 refreshLine(current->prompt, current);
1408             }
1409             break;
1410         case ctrl('F'):
1411         case SPECIAL_RIGHT:
1412             if (current->pos < current->chars) {
1413                 current->pos++;
1414                 refreshLine(current->prompt, current);
1415             }
1416             break;
1417         case SPECIAL_PAGE_UP:
1418           dir = history_len - history_index - 1; /* move to start of history */
1419           goto history_navigation;
1420         case SPECIAL_PAGE_DOWN:
1421           dir = -history_index; /* move to 0 == end of history, i.e. current */
1422           goto history_navigation;
1423         case ctrl('P'):
1424         case SPECIAL_UP:
1425             dir = 1;
1426           goto history_navigation;
1427         case ctrl('N'):
1428         case SPECIAL_DOWN:
1429 history_navigation:
1430             if (history_len > 1) {
1431                 /* Update the current history entry before to
1432                  * overwrite it with tne next one. */
1433                 free(history[history_len - 1 - history_index]);
1434                 history[history_len - 1 - history_index] = strdup(current->buf);
1435                 /* Show the new entry */
1436                 history_index += dir;
1437                 if (history_index < 0) {
1438                     history_index = 0;
1439                     break;
1440                 } else if (history_index >= history_len) {
1441                     history_index = history_len - 1;
1442                     break;
1443                 }
1444                 set_current(current, history[history_len - 1 - history_index]);
1445                 refreshLine(current->prompt, current);
1446             }
1447             break;
1448         case ctrl('A'): /* Ctrl+a, go to the start of the line */
1449         case SPECIAL_HOME:
1450             current->pos = 0;
1451             refreshLine(current->prompt, current);
1452             break;
1453         case ctrl('E'): /* ctrl+e, go to the end of the line */
1454         case SPECIAL_END:
1455             current->pos = current->chars;
1456             refreshLine(current->prompt, current);
1457             break;
1458         case ctrl('U'): /* Ctrl+u, delete to beginning of line, save deleted chars. */
1459             if (remove_chars(current, 0, current->pos)) {
1460                 refreshLine(current->prompt, current);
1461             }
1462             break;
1463         case ctrl('K'): /* Ctrl+k, delete from current to end of line, save deleted chars. */
1464             if (remove_chars(current, current->pos, current->chars - current->pos)) {
1465                 refreshLine(current->prompt, current);
1466             }
1467             break;
1468         case ctrl('Y'): /* Ctrl+y, insert saved chars at current position */
1469             if (current->capture && insert_chars(current, current->pos, current->capture)) {
1470                 refreshLine(current->prompt, current);
1471             }
1472             break;
1473         case ctrl('L'): /* Ctrl+L, clear screen */
1474             linenoiseClearScreen();
1475             /* Force recalc of window size for serial terminals */
1476             current->cols = 0;
1477             refreshLine(current->prompt, current);
1478             break;
1479         default:
1480             /* Only tab is allowed without ^V */
1481             if (c == '\t' || c >= ' ') {
1482                 if (insert_char(current, current->pos, c) == 1) {
1483                     refreshLine(current->prompt, current);
1484                 }
1485             }
1486             break;
1487         }
1488     }
1489     return current->len;
1490 }
1491
1492 int linenoiseColumns(void)
1493 {
1494     struct current current;
1495     enableRawMode (&current);
1496     getWindowSize (&current);
1497     disableRawMode (&current);
1498     return current.cols;
1499 }
1500
1501 char *linenoise(const char *prompt)
1502 {
1503     int count;
1504     struct current current;
1505     char buf[LINENOISE_MAX_LINE];
1506
1507     if (enableRawMode(&current) == -1) {
1508         printf("%s", prompt);
1509         fflush(stdout);
1510         if (fgets(buf, sizeof(buf), stdin) == NULL) {
1511             return NULL;
1512         }
1513         count = strlen(buf);
1514         if (count && buf[count-1] == '\n') {
1515             count--;
1516             buf[count] = '\0';
1517         }
1518     }
1519     else
1520     {
1521         current.buf = buf;
1522         current.bufmax = sizeof(buf);
1523         current.len = 0;
1524         current.chars = 0;
1525         current.pos = 0;
1526         current.prompt = prompt;
1527         current.capture = NULL;
1528
1529         count = linenoiseEdit(&current);
1530
1531         disableRawMode(&current);
1532         printf("\n");
1533
1534         free(current.capture);
1535         if (count == -1) {
1536             return NULL;
1537         }
1538     }
1539     return strdup(buf);
1540 }
1541
1542 /* Using a circular buffer is smarter, but a bit more complex to handle. */
1543 int linenoiseHistoryAdd(const char *line) {
1544     char *linecopy;
1545
1546     if (history_max_len == 0) return 0;
1547     if (history == NULL) {
1548         history = (char **)malloc(sizeof(char*)*history_max_len);
1549         if (history == NULL) return 0;
1550         memset(history,0,(sizeof(char*)*history_max_len));
1551     }
1552
1553     /* do not insert duplicate lines into history */
1554     if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
1555         return 0;
1556     }
1557
1558     linecopy = strdup(line);
1559     if (!linecopy) return 0;
1560     if (history_len == history_max_len) {
1561         free(history[0]);
1562         memmove(history,history+1,sizeof(char*)*(history_max_len-1));
1563         history_len--;
1564     }
1565     history[history_len] = linecopy;
1566     history_len++;
1567     return 1;
1568 }
1569
1570 int linenoiseHistoryGetMaxLen(void) {
1571     return history_max_len;
1572 }
1573
1574 int linenoiseHistorySetMaxLen(int len) {
1575     char **newHistory;
1576
1577     if (len < 1) return 0;
1578     if (history) {
1579         int tocopy = history_len;
1580
1581         newHistory = (char **)malloc(sizeof(char*)*len);
1582         if (newHistory == NULL) return 0;
1583
1584         /* If we can't copy everything, free the elements we'll not use. */
1585         if (len < tocopy) {
1586             int j;
1587
1588             for (j = 0; j < tocopy-len; j++) free(history[j]);
1589             tocopy = len;
1590         }
1591         memset(newHistory,0,sizeof(char*)*len);
1592         memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
1593         free(history);
1594         history = newHistory;
1595     }
1596     history_max_len = len;
1597     if (history_len > history_max_len)
1598         history_len = history_max_len;
1599     return 1;
1600 }
1601
1602 /* Save the history in the specified file. On success 0 is returned
1603  * otherwise -1 is returned. */
1604 int linenoiseHistorySave(const char *filename) {
1605     FILE *fp = fopen(filename,"w");
1606     int j;
1607
1608     if (fp == NULL) return -1;
1609     for (j = 0; j < history_len; j++) {
1610         const char *str = history[j];
1611         /* Need to encode backslash, nl and cr */
1612         while (*str) {
1613             if (*str == '\\') {
1614                 fputs("\\\\", fp);
1615             }
1616             else if (*str == '\n') {
1617                 fputs("\\n", fp);
1618             }
1619             else if (*str == '\r') {
1620                 fputs("\\r", fp);
1621             }
1622             else {
1623                 fputc(*str, fp);
1624             }
1625             str++;
1626         }
1627         fputc('\n', fp);
1628     }
1629
1630     fclose(fp);
1631     return 0;
1632 }
1633
1634 /* Load the history from the specified file. If the file does not exist
1635  * zero is returned and no operation is performed.
1636  *
1637  * If the file exists and the operation succeeded 0 is returned, otherwise
1638  * on error -1 is returned. */
1639 int linenoiseHistoryLoad(const char *filename) {
1640     FILE *fp = fopen(filename,"r");
1641     char buf[LINENOISE_MAX_LINE];
1642
1643     if (fp == NULL) return -1;
1644
1645     while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) {
1646         char *src, *dest;
1647
1648         /* Decode backslash escaped values */
1649         for (src = dest = buf; *src; src++) {
1650             char ch = *src;
1651
1652             if (ch == '\\') {
1653                 src++;
1654                 if (*src == 'n') {
1655                     ch = '\n';
1656                 }
1657                 else if (*src == 'r') {
1658                     ch = '\r';
1659                 } else {
1660                     ch = *src;
1661                 }
1662             }
1663             *dest++ = ch;
1664         }
1665         /* Remove trailing newline */
1666         if (dest != buf && (dest[-1] == '\n' || dest[-1] == '\r')) {
1667             dest--;
1668         }
1669         *dest = 0;
1670
1671         linenoiseHistoryAdd(buf);
1672     }
1673     fclose(fp);
1674     return 0;
1675 }
1676
1677 /* Provide access to the history buffer.
1678  *
1679  * If 'len' is not NULL, the length is stored in *len.
1680  */
1681 char **linenoiseHistory(int *len) {
1682     if (len) {
1683         *len = history_len;
1684     }
1685     return history;
1686 }