-
Notifications
You must be signed in to change notification settings - Fork 5.6k
/
linenoise.cpp
2850 lines (2644 loc) · 110 KB
/
linenoise.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* linenoise.c -- guerrilla line editing library against the idea that a
*
* Copyright (c) 2010, Salvatore Sanfilippo <antirez at gmail dot com>
* Copyright (c) 2010, Pieter Noordhuis <pcnoordhuis at gmail dot com>
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Redis nor the names of its contributors may be used
* to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* line editing lib needs to be 20,000 lines of C code.
*
* You can find the latest source code at:
*
* http://github.com/antirez/linenoise
*
* Does a number of crazy assumptions that happen to be true in 99.9999% of
* the 2010 UNIX computers around.
*
* References:
* - http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
* - http://www.3waylabs.com/nw/WWW/products/wizcon/vt220.html
*
* Todo list:
* - Switch to gets() if $TERM is something we can't support.
* - Filter bogus Ctrl+<char> combinations.
* - Win32 support
*
* Bloat:
* - Completion?
* - History search like Ctrl+r in readline?
*
* List of escape sequences used by this program, we do everything just
* with three sequences. In order to be so cheap we may have some
* flickering effect with some slow terminal, but the lesser sequences
* the more compatible.
*
* CHA (Cursor Horizontal Absolute)
* Sequence: ESC [ n G
* Effect: moves cursor to column n (1 based)
*
* EL (Erase Line)
* Sequence: ESC [ n K
* Effect: if n is 0 or missing, clear from cursor to end of line
* Effect: if n is 1, clear from beginning of line to cursor
* Effect: if n is 2, clear entire line
*
* CUF (Cursor Forward)
* Sequence: ESC [ n C
* Effect: moves cursor forward of n chars
*
* The following are used to clear the screen: ESC [ H ESC [ 2 J
* This is actually composed of two sequences:
*
* cursorhome
* Sequence: ESC [ H
* Effect: moves the cursor to upper left corner
*
* ED2 (Clear entire screen)
* Sequence: ESC [ 2 J
* Effect: clear the whole screen
*
*/
#include "mongo/platform/basic.h"
#ifdef _WIN32
#include <conio.h>
#include <io.h>
#define strcasecmp _stricmp
#define strdup _strdup
#define isatty _isatty
#define write _write
#define STDIN_FILENO 0
#else /* _WIN32 */
#include <cctype>
#include <signal.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
#include <sys/types.h>
#include <termios.h>
#include <unistd.h>
#include <wctype.h>
#endif /* _WIN32 */
#include "linenoise.h"
#include "linenoise_utf8.h"
#include "mk_wcwidth.h"
#include <errno.h>
#include <fcntl.h>
#include <sstream>
#include <stdio.h>
#include <string>
#include <vector>
#include "mongo/util/errno_util.h"
using std::string;
using std::vector;
using std::unique_ptr;
using linenoise_utf8::UChar8;
using linenoise_utf8::UChar32;
using linenoise_utf8::copyString8to32;
using linenoise_utf8::copyString32;
using linenoise_utf8::copyString32to8;
using linenoise_utf8::strlen32;
using linenoise_utf8::strncmp32;
using linenoise_utf8::write32;
using linenoise_utf8::Utf8String;
using linenoise_utf8::Utf32String;
struct linenoiseCompletions {
vector<Utf32String> completionStrings;
};
#define LINENOISE_DEFAULT_HISTORY_MAX_LEN 1000
#define LINENOISE_MAX_LINE 4096
// make control-characters more readable
#define ctrlChar(upperCaseASCII) (upperCaseASCII - 0x40)
/**
* Recompute widths of all characters in a UChar32 buffer
* @param text input buffer of Unicode characters
* @param widths output buffer of character widths
* @param charCount number of characters in buffer
*/
static void recomputeCharacterWidths(const UChar32* text, char* widths, int charCount) {
for (int i = 0; i < charCount; ++i) {
widths[i] = mk_wcwidth(text[i]);
}
}
/**
* Calculate a new screen position given a starting position, screen width and character count
* @param x initial x position (zero-based)
* @param y initial y position (zero-based)
* @param screenColumns screen column count
* @param charCount character positions to advance
* @param xOut returned x position (zero-based)
* @param yOut returned y position (zero-based)
*/
static void calculateScreenPosition(
int x, int y, int screenColumns, int charCount, int& xOut, int& yOut) {
xOut = x;
yOut = y;
int charsRemaining = charCount;
while (charsRemaining > 0) {
int charsThisRow =
(x + charsRemaining < screenColumns) ? charsRemaining : screenColumns - x;
xOut = x + charsThisRow;
yOut = y;
charsRemaining -= charsThisRow;
x = 0;
++y;
}
if (xOut == screenColumns) { // we have to special-case line wrap
xOut = 0;
++yOut;
}
}
/**
* Calculate a column width using mk_wcswidth()
* @param buf32 text to calculate
* @param len length of text to calculate
*/
static int calculateColumnPosition(UChar32* buf32, int len) {
int width = mk_wcswidth(reinterpret_cast<const int*>(buf32), len);
if (width == -1)
return len;
else
return width;
}
static bool isControlChar(UChar32 testChar) {
return (testChar < ' ') || // C0 controls
(testChar >= 0x7F && testChar <= 0x9F); // DEL and C1 controls
}
struct PromptBase { // a convenience struct for grouping prompt info
Utf32String promptText; // our copy of the prompt text, edited
char* promptCharWidths; // character widths from mk_wcwidth()
int promptChars; // chars in promptText
int promptExtraLines; // extra lines (beyond 1) occupied by prompt
int promptIndentation; // column offset to end of prompt
int promptLastLinePosition; // index into promptText where last line begins
int promptPreviousInputLen; // promptChars of previous input line, for clearing
int promptCursorRowOffset; // where the cursor is relative to the start of the prompt
int promptScreenColumns; // width of screen in columns
int promptPreviousLen; // help erasing
int promptErrorCode; // error code (invalid UTF-8) or zero
PromptBase() : promptPreviousInputLen(0) {}
};
struct PromptInfo : public PromptBase {
PromptInfo(const UChar8* textPtr, int columns) {
promptExtraLines = 0;
promptLastLinePosition = 0;
promptPreviousLen = 0;
promptScreenColumns = columns;
Utf32String tempUnicode(textPtr);
// strip control characters from the prompt -- we do allow newline
UChar32* pIn = tempUnicode.get();
UChar32* pOut = pIn;
while (*pIn) {
UChar32 c = *pIn;
if ('\n' == c || !isControlChar(c)) {
*pOut = c;
++pOut;
}
++pIn;
}
*pOut = 0;
promptChars = pOut - tempUnicode.get();
promptText = tempUnicode;
int x = 0;
for (int i = 0; i < promptChars; ++i) {
UChar32 c = promptText[i];
if ('\n' == c) {
x = 0;
++promptExtraLines;
promptLastLinePosition = i + 1;
} else {
++x;
if (x >= promptScreenColumns) {
x = 0;
++promptExtraLines;
promptLastLinePosition = i + 1;
}
}
}
promptIndentation = promptChars - promptLastLinePosition;
promptCursorRowOffset = promptExtraLines;
}
};
// Used with DynamicPrompt (history search)
//
static const Utf32String forwardSearchBasePrompt(reinterpret_cast<const UChar8*>("(i-search)`"));
static const Utf32String reverseSearchBasePrompt(
reinterpret_cast<const UChar8*>("(reverse-i-search)`"));
static const Utf32String endSearchBasePrompt(reinterpret_cast<const UChar8*>("': "));
static Utf32String previousSearchText; // remembered across invocations of linenoise()
// changing prompt for "(reverse-i-search)`text':" etc.
//
struct DynamicPrompt : public PromptBase {
Utf32String searchText; // text we are searching for
char* searchCharWidths; // character widths from mk_wcwidth()
int searchTextLen; // chars in searchText
int direction; // current search direction, 1=forward, -1=reverse
DynamicPrompt(PromptBase& pi, int initialDirection)
: searchTextLen(0), direction(initialDirection) {
promptScreenColumns = pi.promptScreenColumns;
promptCursorRowOffset = 0;
Utf32String emptyString(1);
searchText = emptyString;
const Utf32String* basePrompt =
(direction > 0) ? &forwardSearchBasePrompt : &reverseSearchBasePrompt;
size_t promptStartLength = basePrompt->length();
promptChars = promptStartLength + endSearchBasePrompt.length();
promptLastLinePosition =
promptChars; // TODO fix this, we are asssuming that the history prompt won't wrap (!)
promptPreviousLen = promptChars;
Utf32String tempUnicode(promptChars + 1);
memcpy(tempUnicode.get(), basePrompt->get(), sizeof(UChar32) * promptStartLength);
memcpy(&tempUnicode[promptStartLength],
endSearchBasePrompt.get(),
sizeof(UChar32) * (endSearchBasePrompt.length() + 1));
tempUnicode.initFromBuffer();
promptText = tempUnicode;
calculateScreenPosition(
0, 0, pi.promptScreenColumns, promptChars, promptIndentation, promptExtraLines);
}
void updateSearchPrompt(void) {
const Utf32String* basePrompt =
(direction > 0) ? &forwardSearchBasePrompt : &reverseSearchBasePrompt;
size_t promptStartLength = basePrompt->length();
promptChars = promptStartLength + searchTextLen + endSearchBasePrompt.length();
Utf32String tempUnicode(promptChars + 1);
memcpy(tempUnicode.get(), basePrompt->get(), sizeof(UChar32) * promptStartLength);
memcpy(&tempUnicode[promptStartLength], searchText.get(), sizeof(UChar32) * searchTextLen);
size_t endIndex = promptStartLength + searchTextLen;
memcpy(&tempUnicode[endIndex],
endSearchBasePrompt.get(),
sizeof(UChar32) * (endSearchBasePrompt.length() + 1));
tempUnicode.initFromBuffer();
promptText = tempUnicode;
}
void updateSearchText(const UChar32* textPtr) {
Utf32String tempUnicode(textPtr);
searchTextLen = tempUnicode.chars();
searchText = tempUnicode;
updateSearchPrompt();
}
};
class KillRing {
static const int capacity = 10;
int size;
int index;
char indexToSlot[10];
vector<Utf32String> theRing;
public:
enum action { actionOther, actionKill, actionYank };
action lastAction;
size_t lastYankSize;
KillRing() : size(0), index(0), lastAction(actionOther) {
theRing.reserve(capacity);
}
void kill(const UChar32* text, int textLen, bool forward) {
if (textLen == 0) {
return;
}
Utf32String killedText(text, textLen);
if (lastAction == actionKill && size > 0) {
int slot = indexToSlot[0];
int currentLen = theRing[slot].length();
int resultLen = currentLen + textLen;
Utf32String temp(resultLen + 1);
if (forward) {
memcpy(temp.get(), theRing[slot].get(), currentLen * sizeof(UChar32));
memcpy(&temp[currentLen], killedText.get(), textLen * sizeof(UChar32));
} else {
memcpy(temp.get(), killedText.get(), textLen * sizeof(UChar32));
memcpy(&temp[textLen], theRing[slot].get(), currentLen * sizeof(UChar32));
}
temp[resultLen] = 0;
temp.initFromBuffer();
theRing[slot] = temp;
} else {
if (size < capacity) {
if (size > 0) {
memmove(&indexToSlot[1], &indexToSlot[0], size);
}
indexToSlot[0] = size;
size++;
theRing.push_back(killedText);
} else {
int slot = indexToSlot[capacity - 1];
theRing[slot] = killedText;
memmove(&indexToSlot[1], &indexToSlot[0], capacity - 1);
indexToSlot[0] = slot;
}
index = 0;
}
}
Utf32String* yank() {
return (size > 0) ? &theRing[indexToSlot[index]] : 0;
}
Utf32String* yankPop() {
if (size == 0) {
return 0;
}
++index;
if (index == size) {
index = 0;
}
return &theRing[indexToSlot[index]];
}
};
class InputBuffer {
UChar32* buf32; // input buffer
char* charWidths; // character widths from mk_wcwidth()
int buflen; // buffer size in characters
int len; // length of text in input buffer
int pos; // character position in buffer ( 0 <= pos <= len )
void clearScreen(PromptBase& pi);
int incrementalHistorySearch(PromptBase& pi, int startChar);
int completeLine(PromptBase& pi);
void refreshLine(PromptBase& pi);
public:
InputBuffer(UChar32* buffer, char* widthArray, int bufferLen)
: buf32(buffer), charWidths(widthArray), buflen(bufferLen - 1), len(0), pos(0) {
buf32[0] = 0;
}
void preloadBuffer(const UChar8* preloadText) {
size_t ucharCount;
int errorCode;
copyString8to32(buf32, preloadText, buflen + 1, ucharCount, errorCode);
recomputeCharacterWidths(buf32, charWidths, ucharCount);
len = ucharCount;
pos = ucharCount;
}
int getInputLine(PromptBase& pi);
int length(void) const {
return len;
}
};
// Special codes for keyboard input:
//
// Between Windows and the various Linux "terminal" programs, there is some
// pretty diverse behavior in the "scan codes" and escape sequences we are
// presented with. So ... we'll translate them all into our own pidgin
// pseudocode, trying to stay out of the way of UTF-8 and international
// characters. Here's the general plan.
//
// "User input keystrokes" (key chords, whatever) will be encoded as a single value.
// The low 21 bits are reserved for Unicode characters. Popular function-type keys
// get their own codes in the range 0x10200000 to (if needed) 0x1FE00000, currently
// just arrow keys, Home, End and Delete. Keypresses with Ctrl get ORed with
// 0x20000000, with Alt get ORed with 0x40000000. So, Ctrl+Alt+Home is encoded
// as 0x20000000 + 0x40000000 + 0x10A00000 == 0x70A00000. To keep things complicated,
// the Alt key is equivalent to prefixing the keystroke with ESC, so ESC followed by
// D is treated the same as Alt + D ... we'll just use Emacs terminology and call
// this "Meta". So, we will encode both ESC followed by D and Alt held down while D
// is pressed the same, as Meta-D, encoded as 0x40000064.
//
// Here are the definitions of our component constants:
//
// Maximum unsigned 32-bit value = 0xFFFFFFFF; // For reference, max 32-bit value
// Highest allocated Unicode char = 0x001FFFFF; // For reference, max Unicode value
static const int META = 0x40000000; // Meta key combination
static const int CTRL = 0x20000000; // Ctrl key combination
static const int SPECIAL_KEY = 0x10000000; // Common bit for all special keys
static const int UP_ARROW_KEY = 0x10200000; // Special keys
static const int DOWN_ARROW_KEY = 0x10400000;
static const int RIGHT_ARROW_KEY = 0x10600000;
static const int LEFT_ARROW_KEY = 0x10800000;
static const int HOME_KEY = 0x10A00000;
static const int END_KEY = 0x10C00000;
static const int DELETE_KEY = 0x10E00000;
static const int PAGE_UP_KEY = 0x11000000;
static const int PAGE_DOWN_KEY = 0x11200000;
static const char* unsupported_term[] = {"dumb", "cons25", "emacs", NULL};
static linenoiseCompletionCallback* completionCallback = NULL;
#ifdef _WIN32
static HANDLE console_in, console_out;
static DWORD oldMode;
static WORD oldDisplayAttribute;
#else
static struct termios orig_termios; /* in order to restore at exit */
#endif
static KillRing killRing;
static int rawmode = 0; /* for atexit() function to check if restore is needed*/
static int atexit_registered = 0; /* register atexit just 1 time */
static int historyMaxLen = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
static int historyLen = 0;
static int historyIndex = 0;
static UChar8** history = NULL;
// used to emulate Windows command prompt on down-arrow after a recall
// we use -2 as our "not set" value because we add 1 to the previous index on down-arrow,
// and zero is a valid index (so -1 is a valid "previous index")
static int historyPreviousIndex = -2;
static bool historyRecallMostRecent = false;
static void linenoiseAtExit(void);
static bool isUnsupportedTerm(void) {
char* term = getenv("TERM");
if (term == NULL)
return false;
for (int j = 0; unsupported_term[j]; ++j)
if (!strcasecmp(term, unsupported_term[j])) {
return true;
}
return false;
}
static void beep() {
fprintf(stderr, "\x7"); // ctrl-G == bell/beep
fflush(stderr);
}
void linenoiseHistoryFree(void) {
if (history) {
for (int j = 0; j < historyLen; ++j)
free(history[j]);
historyLen = 0;
free(history);
history = 0;
}
}
static int enableRawMode(void) {
#ifdef _WIN32
if (!console_in) {
console_in = GetStdHandle(STD_INPUT_HANDLE);
console_out = GetStdHandle(STD_OUTPUT_HANDLE);
GetConsoleMode(console_in, &oldMode);
SetConsoleMode(console_in,
oldMode & ~(ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT | ENABLE_PROCESSED_INPUT));
}
return 0;
#else
struct termios raw;
if (!isatty(0))
goto fatal;
if (!atexit_registered) {
atexit(linenoiseAtExit);
atexit_registered = 1;
}
if (tcgetattr(0, &orig_termios) == -1)
goto fatal;
raw = orig_termios; /* modify the original mode */
/* input modes: no break, no CR to NL, no parity check, no strip char,
* no start/stop output control. */
raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
/* output modes - disable post processing */
// this is wrong, we don't want raw output, it turns newlines into straight linefeeds
// raw.c_oflag &= ~(OPOST);
/* control modes - set 8 bit chars */
raw.c_cflag |= (CS8);
/* local modes - echoing off, canonical off, no extended functions,
* no signal chars (^Z,^C) */
raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
/* control chars - set return condition: min number of bytes and timer.
* We want read to return every single byte, without timeout. */
raw.c_cc[VMIN] = 1;
raw.c_cc[VTIME] = 0; /* 1 byte, no timer */
/* put terminal in raw mode after flushing */
if (tcsetattr(0, TCSADRAIN, &raw) < 0)
goto fatal;
rawmode = 1;
return 0;
fatal:
errno = ENOTTY;
return -1;
#endif
}
static void disableRawMode(void) {
#ifdef _WIN32
SetConsoleMode(console_in, oldMode);
console_in = 0;
console_out = 0;
#else
if (rawmode && tcsetattr(0, TCSADRAIN, &orig_termios) != -1)
rawmode = 0;
#endif
}
// At exit we'll try to fix the terminal to the initial conditions
static void linenoiseAtExit(void) {
disableRawMode();
}
static int getScreenColumns(void) {
int cols;
#ifdef _WIN32
CONSOLE_SCREEN_BUFFER_INFO inf;
GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &inf);
cols = inf.dwSize.X;
#else
struct winsize ws;
cols = (ioctl(1, TIOCGWINSZ, &ws) == -1) ? 80 : ws.ws_col;
#endif
// cols is 0 in certain circumstances like inside debugger, which creates further issues
return (cols > 0) ? cols : 80;
}
static int getScreenRows(void) {
int rows;
#ifdef _WIN32
CONSOLE_SCREEN_BUFFER_INFO inf;
GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &inf);
rows = 1 + inf.srWindow.Bottom - inf.srWindow.Top;
#else
struct winsize ws;
rows = (ioctl(1, TIOCGWINSZ, &ws) == -1) ? 24 : ws.ws_row;
#endif
return (rows > 0) ? rows : 24;
}
static void setDisplayAttribute(bool enhancedDisplay) {
#ifdef _WIN32
if (enhancedDisplay) {
CONSOLE_SCREEN_BUFFER_INFO inf;
GetConsoleScreenBufferInfo(console_out, &inf);
oldDisplayAttribute = inf.wAttributes;
BYTE oldLowByte = oldDisplayAttribute & 0xFF;
BYTE newLowByte;
switch (oldLowByte) {
case 0x07:
// newLowByte = FOREGROUND_BLUE | FOREGROUND_INTENSITY; // too dim
// newLowByte = FOREGROUND_BLUE; // even dimmer
newLowByte =
FOREGROUND_BLUE | FOREGROUND_GREEN; // most similar to xterm appearance
break;
case 0x70:
newLowByte = BACKGROUND_BLUE | BACKGROUND_INTENSITY;
break;
default:
newLowByte = oldLowByte ^ 0xFF; // default to inverse video
break;
}
inf.wAttributes = (inf.wAttributes & 0xFF00) | newLowByte;
SetConsoleTextAttribute(console_out, inf.wAttributes);
} else {
SetConsoleTextAttribute(console_out, oldDisplayAttribute);
}
#else
if (enhancedDisplay) {
if (write(1, "\x1b[1;34m", 7) == -1)
return; /* bright blue (visible with both B&W bg) */
} else {
if (write(1, "\x1b[0m", 4) == -1)
return; /* reset */
}
#endif
}
/**
* Display the dynamic incremental search prompt and the current user input line.
* @param pi PromptBase struct holding information about the prompt and our screen position
* @param buf32 input buffer to be displayed
* @param len count of characters in the buffer
* @param pos current cursor position within the buffer (0 <= pos <= len)
*/
static void dynamicRefresh(PromptBase& pi, UChar32* buf32, int len, int pos) {
// calculate the position of the end of the prompt
int xEndOfPrompt, yEndOfPrompt;
calculateScreenPosition(
0, 0, pi.promptScreenColumns, pi.promptChars, xEndOfPrompt, yEndOfPrompt);
pi.promptIndentation = xEndOfPrompt;
// calculate the position of the end of the input line
int xEndOfInput, yEndOfInput;
calculateScreenPosition(xEndOfPrompt,
yEndOfPrompt,
pi.promptScreenColumns,
calculateColumnPosition(buf32, len),
xEndOfInput,
yEndOfInput);
// calculate the desired position of the cursor
int xCursorPos, yCursorPos;
calculateScreenPosition(xEndOfPrompt,
yEndOfPrompt,
pi.promptScreenColumns,
calculateColumnPosition(buf32, pos),
xCursorPos,
yCursorPos);
#ifdef _WIN32
// position at the start of the prompt, clear to end of previous input
CONSOLE_SCREEN_BUFFER_INFO inf;
GetConsoleScreenBufferInfo(console_out, &inf);
inf.dwCursorPosition.X = 0;
inf.dwCursorPosition.Y -= pi.promptCursorRowOffset /*- pi.promptExtraLines*/;
SetConsoleCursorPosition(console_out, inf.dwCursorPosition);
DWORD count;
FillConsoleOutputCharacterA(console_out,
' ',
pi.promptPreviousLen + pi.promptPreviousInputLen,
inf.dwCursorPosition,
&count);
pi.promptPreviousLen = pi.promptIndentation;
pi.promptPreviousInputLen = len;
// display the prompt
if (write32(1, pi.promptText.get(), pi.promptChars) == -1)
return;
// display the input line
if (write32(1, buf32, len) == -1)
return;
// position the cursor
GetConsoleScreenBufferInfo(console_out, &inf);
inf.dwCursorPosition.X = xCursorPos; // 0-based on Win32
inf.dwCursorPosition.Y -= yEndOfInput - yCursorPos;
SetConsoleCursorPosition(console_out, inf.dwCursorPosition);
#else // _WIN32
char seq[64];
int cursorRowMovement = pi.promptCursorRowOffset - pi.promptExtraLines;
if (cursorRowMovement > 0) { // move the cursor up as required
snprintf(seq, sizeof seq, "\x1b[%dA", cursorRowMovement);
if (write(1, seq, strlen(seq)) == -1)
return;
}
// position at the start of the prompt, clear to end of screen
snprintf(seq, sizeof seq, "\x1b[1G\x1b[J"); // 1-based on VT100
if (write(1, seq, strlen(seq)) == -1)
return;
// display the prompt
if (write32(1, pi.promptText.get(), pi.promptChars) == -1)
return;
// display the input line
if (write32(1, buf32, len) == -1)
return;
// we have to generate our own newline on line wrap
if (xEndOfInput == 0 && yEndOfInput > 0)
if (write(1, "\n", 1) == -1)
return;
// position the cursor
cursorRowMovement = yEndOfInput - yCursorPos;
if (cursorRowMovement > 0) { // move the cursor up as required
snprintf(seq, sizeof seq, "\x1b[%dA", cursorRowMovement);
if (write(1, seq, strlen(seq)) == -1)
return;
}
// position the cursor within the line
snprintf(seq, sizeof seq, "\x1b[%dG", xCursorPos + 1); // 1-based on VT100
if (write(1, seq, strlen(seq)) == -1)
return;
#endif
pi.promptCursorRowOffset = pi.promptExtraLines + yCursorPos; // remember row for next pass
}
/**
* Refresh the user's input line: the prompt is already onscreen and is not redrawn here
* @param pi PromptBase struct holding information about the prompt and our screen position
*/
void InputBuffer::refreshLine(PromptBase& pi) {
// check for a matching brace/bracket/paren, remember its position if found
int highlight = -1;
if (pos < len) {
/* this scans for a brace matching buf32[pos] to highlight */
int scanDirection = 0;
if (strchr("}])", buf32[pos]))
scanDirection = -1; /* backwards */
else if (strchr("{[(", buf32[pos]))
scanDirection = 1; /* forwards */
if (scanDirection) {
int unmatched = scanDirection;
for (int i = pos + scanDirection; i >= 0 && i < len; i += scanDirection) {
/* TODO: the right thing when inside a string */
if (strchr("}])", buf32[i]))
--unmatched;
else if (strchr("{[(", buf32[i]))
++unmatched;
if (unmatched == 0) {
highlight = i;
break;
}
}
}
}
// calculate the position of the end of the input line
int xEndOfInput, yEndOfInput;
calculateScreenPosition(pi.promptIndentation,
0,
pi.promptScreenColumns,
calculateColumnPosition(buf32, len),
xEndOfInput,
yEndOfInput);
// calculate the desired position of the cursor
int xCursorPos, yCursorPos;
calculateScreenPosition(pi.promptIndentation,
0,
pi.promptScreenColumns,
calculateColumnPosition(buf32, pos),
xCursorPos,
yCursorPos);
#ifdef _WIN32
// position at the end of the prompt, clear to end of previous input
CONSOLE_SCREEN_BUFFER_INFO inf;
GetConsoleScreenBufferInfo(console_out, &inf);
inf.dwCursorPosition.X = pi.promptIndentation; // 0-based on Win32
inf.dwCursorPosition.Y -= pi.promptCursorRowOffset - pi.promptExtraLines;
SetConsoleCursorPosition(console_out, inf.dwCursorPosition);
DWORD count;
if (len < pi.promptPreviousInputLen)
FillConsoleOutputCharacterA(
console_out, ' ', pi.promptPreviousInputLen, inf.dwCursorPosition, &count);
pi.promptPreviousInputLen = len;
// display the input line
if (highlight == -1) {
if (write32(1, buf32, len) == -1)
return;
} else {
if (write32(1, buf32, highlight) == -1)
return;
setDisplayAttribute(true); /* bright blue (visible with both B&W bg) */
if (write32(1, &buf32[highlight], 1) == -1)
return;
setDisplayAttribute(false);
if (write32(1, buf32 + highlight + 1, len - highlight - 1) == -1)
return;
}
// position the cursor
GetConsoleScreenBufferInfo(console_out, &inf);
inf.dwCursorPosition.X = xCursorPos; // 0-based on Win32
inf.dwCursorPosition.Y -= yEndOfInput - yCursorPos;
SetConsoleCursorPosition(console_out, inf.dwCursorPosition);
#else // _WIN32
char seq[64];
int cursorRowMovement = pi.promptCursorRowOffset - pi.promptExtraLines;
if (cursorRowMovement > 0) { // move the cursor up as required
snprintf(seq, sizeof seq, "\x1b[%dA", cursorRowMovement);
if (write(1, seq, strlen(seq)) == -1)
return;
}
// position at the end of the prompt, clear to end of screen
snprintf(seq, sizeof seq, "\x1b[%dG\x1b[J", pi.promptIndentation + 1); // 1-based on VT100
if (write(1, seq, strlen(seq)) == -1)
return;
if (highlight == -1) { // write unhighlighted text
if (write32(1, buf32, len) == -1)
return;
} else { // highlight the matching brace/bracket/parenthesis
if (write32(1, buf32, highlight) == -1)
return;
setDisplayAttribute(true);
if (write32(1, &buf32[highlight], 1) == -1)
return;
setDisplayAttribute(false);
if (write32(1, buf32 + highlight + 1, len - highlight - 1) == -1)
return;
}
// we have to generate our own newline on line wrap
if (xEndOfInput == 0 && yEndOfInput > 0)
if (write(1, "\n", 1) == -1)
return;
// position the cursor
cursorRowMovement = yEndOfInput - yCursorPos;
if (cursorRowMovement > 0) { // move the cursor up as required
snprintf(seq, sizeof seq, "\x1b[%dA", cursorRowMovement);
if (write(1, seq, strlen(seq)) == -1)
return;
}
// position the cursor within the line
snprintf(seq, sizeof seq, "\x1b[%dG", xCursorPos + 1); // 1-based on VT100
if (write(1, seq, strlen(seq)) == -1)
return;
#endif
pi.promptCursorRowOffset = pi.promptExtraLines + yCursorPos; // remember row for next pass
}
#ifndef _WIN32
/**
* Read a UTF-8 sequence from the non-Windows keyboard and return the Unicode (UChar32) character it
* encodes
*
* @return UChar32 Unicode character
*/
static UChar32 readUnicodeCharacter(void) {
static UChar8 utf8String[5];
static size_t utf8Count = 0;
while (true) {
UChar8 c;
if (read(0, &c, 1) <= 0)
return 0;
if (c <= 0x7F) { // short circuit ASCII
utf8Count = 0;
return c;
} else if (utf8Count < sizeof(utf8String) - 1) {
utf8String[utf8Count++] = c;
utf8String[utf8Count] = 0;
UChar32 unicodeChar[2];
size_t ucharCount;
int errorCode;
copyString8to32(unicodeChar, utf8String, 2, ucharCount, errorCode);
if (ucharCount && errorCode == 0) {
utf8Count = 0;
return unicodeChar[0];
}
} else {
utf8Count = 0; // this shouldn't happen: got four bytes but no UTF-8 character
}
}
}
namespace EscapeSequenceProcessing { // move these out of global namespace
// This chunk of code does parsing of the escape sequences sent by various Linux terminals.
//
// It handles arrow keys, Home, End and Delete keys by interpreting the sequences sent by
// gnome terminal, xterm, rxvt, konsole, aterm and yakuake including the Alt and Ctrl key
// combinations that are understood by linenoise.
//
// The parsing uses tables, a bunch of intermediate dispatch routines and a doDispatch
// loop that reads the tables and sends control to "deeper" routines to continue the
// parsing. The starting call to doDispatch( c, initialDispatch ) will eventually return
// either a character (with optional CTRL and META bits set), or -1 if parsing fails, or
// zero if an attempt to read from the keyboard fails.
//
// This is rather sloppy escape sequence processing, since we're not paying attention to what the
// actual TERM is set to and are processing all key sequences for all terminals, but it works with
// the most common keystrokes on the most common terminals. It's intricate, but the nested 'if'
// statements required to do it directly would be worse. This way has the advantage of allowing
// changes and extensions without having to touch a lot of code.
// This is a typedef for the routine called by doDispatch(). It takes the current character
// as input, does any required processing including reading more characters and calling other
// dispatch routines, then eventually returns the final (possibly extended or special) character.
//
typedef UChar32 (*CharacterDispatchRoutine)(UChar32);
// This structure is used by doDispatch() to hold a list of characters to test for and
// a list of routines to call if the character matches. The dispatch routine list is one
// longer than the character list; the final entry is used if no character matches.
//
struct CharacterDispatch {
unsigned int len; // length of the chars list
const char* chars; // chars to test
CharacterDispatchRoutine* dispatch; // array of routines to call
};
// This dispatch routine is given a dispatch table and then farms work out to routines
// listed in the table based on the character it is called with. The dispatch routines can
// read more input characters to decide what should eventually be returned. Eventually,
// a called routine returns either a character or -1 to indicate parsing failure.
//
static UChar32 doDispatch(UChar32 c, CharacterDispatch& dispatchTable) {
for (unsigned int i = 0; i < dispatchTable.len; ++i) {
if (static_cast<unsigned char>(dispatchTable.chars[i]) == c) {
return dispatchTable.dispatch[i](c);
}
}
return dispatchTable.dispatch[dispatchTable.len](c);
}
static UChar32 thisKeyMetaCtrl = 0; // holds pre-set Meta and/or Ctrl modifiers
// Final dispatch routines -- return something
//
static UChar32 normalKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | c;
}
static UChar32 upArrowKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | UP_ARROW_KEY;
}
static UChar32 downArrowKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | DOWN_ARROW_KEY;
}
static UChar32 rightArrowKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | RIGHT_ARROW_KEY;
}
static UChar32 leftArrowKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | LEFT_ARROW_KEY;
}
static UChar32 homeKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | HOME_KEY;
}
static UChar32 endKeyRoutine(UChar32 c) {
return thisKeyMetaCtrl | END_KEY;
}