-
Notifications
You must be signed in to change notification settings - Fork 24
/
tsm-vte.c
3162 lines (2965 loc) · 84.4 KB
/
tsm-vte.c
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
/*
* libtsm - VT Emulator
*
* Copyright (c) 2018 Aetf <aetf@unlimitedcodeworks.xyz>
* Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*
* Virtual Terminal Emulator
* This is the VT implementation. It is written from scratch. It uses the
* screen state-machine as output and is tightly bound to it. It supports
* functionality from vt100 up to vt500 series. It doesn't implement an
* explicitly selected terminal but tries to support the most important commands
* to be compatible with existing implementations. However, full vt102
* compatibility is the least that is provided.
*
* The main parser in this file controls the parser-state and dispatches the
* actions to the related handlers. The parser is based on the state-diagram
* from Paul Williams: http://vt100.net/emu/
* It is written from scratch, though.
* This parser is fully compatible up to the vt500 series. It requires UTF-8 and
* does not support any other input encoding. The G0 and G1 sets are therefore
* defined as subsets of UTF-8. You may still map G0-G3 into GL, though.
*
* However, the CSI/DCS/etc handlers are not designed after a specific VT
* series. We try to support all vt102 commands but implement several other
* often used sequences, too. Feel free to add further.
*/
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "libtsm.h"
#include "libtsm-int.h"
#include "shl-llog.h"
#include <xkbcommon/xkbcommon-keysyms.h>
#define LLOG_SUBSYSTEM "tsm-vte"
/* Input parser states */
enum parser_state {
STATE_NONE, /* placeholder */
STATE_GROUND, /* initial state and ground */
STATE_ESC, /* ESC sequence was started */
STATE_ESC_INT, /* intermediate escape characters */
STATE_CSI_ENTRY, /* starting CSI sequence */
STATE_CSI_PARAM, /* CSI parameters */
STATE_CSI_INT, /* intermediate CSI characters */
STATE_CSI_IGNORE, /* CSI error; ignore this CSI sequence */
STATE_DCS_ENTRY, /* starting DCS sequence */
STATE_DCS_PARAM, /* DCS parameters */
STATE_DCS_INT, /* intermediate DCS characters */
STATE_DCS_PASS, /* DCS data passthrough */
STATE_DCS_IGNORE, /* DCS error; ignore this DCS sequence */
STATE_OSC_STRING, /* parsing OCS sequence */
STATE_ST_IGNORE, /* unimplemented seq; ignore until ST */
STATE_NUM
};
/* Input parser actions */
enum parser_action {
ACTION_NONE, /* placeholder */
ACTION_IGNORE, /* ignore the character entirely */
ACTION_PRINT, /* print the character on the console */
ACTION_EXECUTE, /* execute single control character (C0/C1) */
ACTION_CLEAR, /* clear current parameter state */
ACTION_COLLECT, /* collect intermediate character */
ACTION_PARAM, /* collect parameter character */
ACTION_ESC_DISPATCH, /* dispatch escape sequence */
ACTION_CSI_DISPATCH, /* dispatch csi sequence */
ACTION_DCS_START, /* start of DCS data */
ACTION_DCS_COLLECT, /* collect DCS data */
ACTION_DCS_END, /* end of DCS data */
ACTION_OSC_START, /* start of OSC data */
ACTION_OSC_COLLECT, /* collect OSC data */
ACTION_OSC_END, /* end of OSC data */
ACTION_NUM
};
/* CSI flags */
#define CSI_BANG 0x0001 /* CSI: ! */
#define CSI_CASH 0x0002 /* CSI: $ */
#define CSI_WHAT 0x0004 /* CSI: ? */
#define CSI_GT 0x0008 /* CSI: > */
#define CSI_SPACE 0x0010 /* CSI: */
#define CSI_SQUOTE 0x0020 /* CSI: ' */
#define CSI_DQUOTE 0x0040 /* CSI: " */
#define CSI_MULT 0x0080 /* CSI: * */
#define CSI_PLUS 0x0100 /* CSI: + */
#define CSI_POPEN 0x0200 /* CSI: ( */
#define CSI_PCLOSE 0x0400 /* CSI: ) */
/* max CSI arguments */
#define CSI_ARG_MAX 16
/* max length of an OSC code */
#define OSC_MAX_LEN 128
/* terminal flags */
#define FLAG_CURSOR_KEY_MODE 0x00000001 /* DEC cursor key mode */
#define FLAG_KEYPAD_APPLICATION_MODE 0x00000002 /* DEC keypad application mode; TODO: toggle on numlock? */
#define FLAG_LINE_FEED_NEW_LINE_MODE 0x00000004 /* DEC line-feed/new-line mode */
#define FLAG_8BIT_MODE 0x00000008 /* Disable UTF-8 mode and enable 8bit compatible mode */
#define FLAG_7BIT_MODE 0x00000010 /* Disable 8bit mode and use 7bit compatible mode */
#define FLAG_USE_C1 0x00000020 /* Explicitly use 8bit C1 codes; TODO: implement */
#define FLAG_KEYBOARD_ACTION_MODE 0x00000040 /* Disable keyboard; TODO: implement? */
#define FLAG_INSERT_REPLACE_MODE 0x00000080 /* Enable insert mode */
#define FLAG_SEND_RECEIVE_MODE 0x00000100 /* Disable local echo */
#define FLAG_TEXT_CURSOR_MODE 0x00000200 /* Show cursor */
#define FLAG_INVERSE_SCREEN_MODE 0x00000400 /* Inverse colors */
#define FLAG_ORIGIN_MODE 0x00000800 /* Relative origin for cursor */
#define FLAG_AUTO_WRAP_MODE 0x00001000 /* Auto line wrap mode */
#define FLAG_AUTO_REPEAT_MODE 0x00002000 /* Auto repeat key press; TODO: implement */
#define FLAG_NATIONAL_CHARSET_MODE 0x00004000 /* Send keys from nation charsets; TODO: implement */
#define FLAG_BACKGROUND_COLOR_ERASE_MODE 0x00008000 /* Set background color on erase (bce) */
#define FLAG_PREPEND_ESCAPE 0x00010000 /* Prepend escape character to next output */
#define FLAG_TITE_INHIBIT_MODE 0x00020000 /* Prevent switching to alternate screen buffer */
struct vte_saved_state {
unsigned int cursor_x;
unsigned int cursor_y;
struct tsm_screen_attr cattr;
tsm_vte_charset **gl;
tsm_vte_charset **gr;
bool wrap_mode;
bool origin_mode;
};
struct tsm_vte {
unsigned long ref;
tsm_log_t llog;
void *llog_data;
struct tsm_screen *con;
tsm_vte_write_cb write_cb;
void *data;
char *palette_name;
bool backspace_sends_delete;
struct tsm_utf8_mach *mach;
unsigned long parse_cnt;
unsigned int state;
unsigned int csi_argc;
int csi_argv[CSI_ARG_MAX];
unsigned int csi_flags;
tsm_vte_osc_cb osc_cb;
void *osc_data;
unsigned int osc_len;
char osc_arg[OSC_MAX_LEN];
tsm_vte_mouse_cb mouse_cb;
void *mouse_data;
unsigned int mouse_mode;
unsigned int mouse_event;
unsigned int mouse_last_col;
unsigned int mouse_last_row;
uint8_t (*custom_palette_storage)[3];
uint8_t (*palette)[3];
struct tsm_screen_attr def_attr;
struct tsm_screen_attr cattr;
unsigned int flags;
tsm_vte_charset **gl;
tsm_vte_charset **gr;
tsm_vte_charset **glt;
tsm_vte_charset **grt;
tsm_vte_charset *g0;
tsm_vte_charset *g1;
tsm_vte_charset *g2;
tsm_vte_charset *g3;
struct vte_saved_state saved_state;
unsigned int alt_cursor_x;
unsigned int alt_cursor_y;
};
static uint8_t color_palette[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 0, 0, 0 }, /* black */
[TSM_COLOR_RED] = { 205, 0, 0 }, /* red */
[TSM_COLOR_GREEN] = { 0, 205, 0 }, /* green */
[TSM_COLOR_YELLOW] = { 205, 205, 0 }, /* yellow */
[TSM_COLOR_BLUE] = { 0, 0, 238 }, /* blue */
[TSM_COLOR_MAGENTA] = { 205, 0, 205 }, /* magenta */
[TSM_COLOR_CYAN] = { 0, 205, 205 }, /* cyan */
[TSM_COLOR_LIGHT_GREY] = { 229, 229, 229 }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 127, 127, 127 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 255, 0, 0 }, /* light red */
[TSM_COLOR_LIGHT_GREEN] = { 0, 255, 0 }, /* light green */
[TSM_COLOR_LIGHT_YELLOW] = { 255, 255, 0 }, /* light yellow */
[TSM_COLOR_LIGHT_BLUE] = { 92, 92, 255 }, /* light blue */
[TSM_COLOR_LIGHT_MAGENTA] = { 255, 0, 255 }, /* light magenta */
[TSM_COLOR_LIGHT_CYAN] = { 0, 255, 255 }, /* light cyan */
[TSM_COLOR_WHITE] = { 255, 255, 255 }, /* white */
[TSM_COLOR_FOREGROUND] = { 229, 229, 229 }, /* light grey */
[TSM_COLOR_BACKGROUND] = { 0, 0, 0 }, /* black */
};
static uint8_t color_palette_solarized[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 7, 54, 66 }, /* black */
[TSM_COLOR_RED] = { 220, 50, 47 }, /* red */
[TSM_COLOR_GREEN] = { 133, 153, 0 }, /* green */
[TSM_COLOR_YELLOW] = { 181, 137, 0 }, /* yellow */
[TSM_COLOR_BLUE] = { 38, 139, 210 }, /* blue */
[TSM_COLOR_MAGENTA] = { 211, 54, 130 }, /* magenta */
[TSM_COLOR_CYAN] = { 42, 161, 152 }, /* cyan */
[TSM_COLOR_LIGHT_GREY] = { 238, 232, 213 }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 0, 43, 54 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 203, 75, 22 }, /* light red */
[TSM_COLOR_LIGHT_GREEN] = { 88, 110, 117 }, /* light green */
[TSM_COLOR_LIGHT_YELLOW] = { 101, 123, 131 }, /* light yellow */
[TSM_COLOR_LIGHT_BLUE] = { 131, 148, 150 }, /* light blue */
[TSM_COLOR_LIGHT_MAGENTA] = { 108, 113, 196 }, /* light magenta */
[TSM_COLOR_LIGHT_CYAN] = { 147, 161, 161 }, /* light cyan */
[TSM_COLOR_WHITE] = { 253, 246, 227 }, /* white */
[TSM_COLOR_FOREGROUND] = { 238, 232, 213 }, /* light grey */
[TSM_COLOR_BACKGROUND] = { 7, 54, 66 }, /* black */
};
static uint8_t color_palette_solarized_black[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 0, 0, 0 }, /* black */
[TSM_COLOR_RED] = { 220, 50, 47 }, /* red */
[TSM_COLOR_GREEN] = { 133, 153, 0 }, /* green */
[TSM_COLOR_YELLOW] = { 181, 137, 0 }, /* yellow */
[TSM_COLOR_BLUE] = { 38, 139, 210 }, /* blue */
[TSM_COLOR_MAGENTA] = { 211, 54, 130 }, /* magenta */
[TSM_COLOR_CYAN] = { 42, 161, 152 }, /* cyan */
[TSM_COLOR_LIGHT_GREY] = { 238, 232, 213 }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 0, 43, 54 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 203, 75, 22 }, /* light red */
[TSM_COLOR_LIGHT_GREEN] = { 88, 110, 117 }, /* light green */
[TSM_COLOR_LIGHT_YELLOW] = { 101, 123, 131 }, /* light yellow */
[TSM_COLOR_LIGHT_BLUE] = { 131, 148, 150 }, /* light blue */
[TSM_COLOR_LIGHT_MAGENTA] = { 108, 113, 196 }, /* light magenta */
[TSM_COLOR_LIGHT_CYAN] = { 147, 161, 161 }, /* light cyan */
[TSM_COLOR_WHITE] = { 253, 246, 227 }, /* white */
[TSM_COLOR_FOREGROUND] = { 238, 232, 213 }, /* light grey */
[TSM_COLOR_BACKGROUND] = { 0, 0, 0 }, /* black */
};
static uint8_t color_palette_solarized_white[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 7, 54, 66 }, /* black */
[TSM_COLOR_RED] = { 220, 50, 47 }, /* red */
[TSM_COLOR_GREEN] = { 133, 153, 0 }, /* green */
[TSM_COLOR_YELLOW] = { 181, 137, 0 }, /* yellow */
[TSM_COLOR_BLUE] = { 38, 139, 210 }, /* blue */
[TSM_COLOR_MAGENTA] = { 211, 54, 130 }, /* magenta */
[TSM_COLOR_CYAN] = { 42, 161, 152 }, /* cyan */
[TSM_COLOR_LIGHT_GREY] = { 238, 232, 213 }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 0, 43, 54 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 203, 75, 22 }, /* light red */
[TSM_COLOR_LIGHT_GREEN] = { 88, 110, 117 }, /* light green */
[TSM_COLOR_LIGHT_YELLOW] = { 101, 123, 131 }, /* light yellow */
[TSM_COLOR_LIGHT_BLUE] = { 131, 148, 150 }, /* light blue */
[TSM_COLOR_LIGHT_MAGENTA] = { 108, 113, 196 }, /* light magenta */
[TSM_COLOR_LIGHT_CYAN] = { 147, 161, 161 }, /* light cyan */
[TSM_COLOR_WHITE] = { 253, 246, 227 }, /* white */
[TSM_COLOR_FOREGROUND] = { 7, 54, 66 }, /* black */
[TSM_COLOR_BACKGROUND] = { 238, 232, 213 }, /* light grey */
};
static uint8_t color_palette_soft_black[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 0x3f, 0x3f, 0x3f }, /* black */
[TSM_COLOR_RED] = { 0x70, 0x50, 0x50 }, /* red */
[TSM_COLOR_GREEN] = { 0x60, 0xb4, 0x8a }, /* green */
[TSM_COLOR_YELLOW] = { 0xdf, 0xaf, 0x8f }, /* yellow */
[TSM_COLOR_BLUE] = { 0x9a, 0xb8, 0xd7 }, /* blue */
[TSM_COLOR_MAGENTA] = { 0xdc, 0x8c, 0xc3 }, /* magenta */
[TSM_COLOR_CYAN] = { 0x8c, 0xd0, 0xd3 }, /* cyan */
[TSM_COLOR_LIGHT_GREY] = { 0xff, 0xff, 0xff }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 0x70, 0x90, 0x80 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 0xdc, 0xa3, 0xa3 }, /* light red */
[TSM_COLOR_LIGHT_GREEN] = { 0x72, 0xd5, 0xa3 }, /* light green */
[TSM_COLOR_LIGHT_YELLOW] = { 0xf0, 0xdf, 0xaf }, /* light yellow */
[TSM_COLOR_LIGHT_BLUE] = { 0x94, 0xbf, 0xf3 }, /* light blue */
[TSM_COLOR_LIGHT_MAGENTA] = { 0xec, 0x93, 0xd3 }, /* light magenta */
[TSM_COLOR_LIGHT_CYAN] = { 0x93, 0xe0, 0xe3 }, /* light cyan */
[TSM_COLOR_WHITE] = { 0xdc, 0xdc, 0xcc }, /* white */
[TSM_COLOR_FOREGROUND] = { 0xdc, 0xdc, 0xcc }, /* white */
[TSM_COLOR_BACKGROUND] = { 0x2c, 0x2c, 0x2c }, /* light grey */
};
static uint8_t color_palette_base16_dark[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 0x00, 0x00, 0x00 }, /* black */
[TSM_COLOR_RED] = { 0xab, 0x46, 0x42 }, /* red, base08 */
[TSM_COLOR_GREEN] = { 0xa1, 0xb5, 0x6c }, /* green, base0B */
[TSM_COLOR_YELLOW] = { 0xf7, 0xca, 0x88 }, /* yellow, base0A */
[TSM_COLOR_BLUE] = { 0x7c, 0xaf, 0xc2 }, /* blue, base0D */
[TSM_COLOR_MAGENTA] = { 0xba, 0x8b, 0xaf }, /* magenta, base0E */
[TSM_COLOR_CYAN] = { 0x86, 0xc1, 0xb9 }, /* cyan, base0C */
[TSM_COLOR_LIGHT_GREY] = { 0xaa, 0xaa, 0xaa }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 0x55, 0x55, 0x55 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 0xab, 0x46, 0x42 }, /* red, base08 */
[TSM_COLOR_LIGHT_GREEN] = { 0xa1, 0xb5, 0x6c }, /* green, base0B */
[TSM_COLOR_LIGHT_YELLOW] = { 0xf7, 0xca, 0x88 }, /* yellow, base0A */
[TSM_COLOR_LIGHT_BLUE] = { 0x7c, 0xaf, 0xc2 }, /* blue, base0D */
[TSM_COLOR_LIGHT_MAGENTA] = { 0xba, 0x8b, 0xaf }, /* magenta, base0E */
[TSM_COLOR_LIGHT_CYAN] = { 0x86, 0xc1, 0xb9 }, /* cyan, base0C */
[TSM_COLOR_WHITE] = { 0xff, 0xff, 0xff }, /* white */
[TSM_COLOR_FOREGROUND] = { 0xd8, 0xd8, 0xd8 }, /* light grey */
[TSM_COLOR_BACKGROUND] = { 0x18, 0x18, 0x18 }, /* dark grey */
};
static uint8_t color_palette_base16_light[TSM_COLOR_NUM][3] = {
[TSM_COLOR_BLACK] = { 0x00, 0x00, 0x00 }, /* black */
[TSM_COLOR_RED] = { 0xab, 0x46, 0x42 }, /* red, base08 */
[TSM_COLOR_GREEN] = { 0xa1, 0xb5, 0x6c }, /* green, base0B */
[TSM_COLOR_YELLOW] = { 0xf7, 0xca, 0x88 }, /* yellow, base0A */
[TSM_COLOR_BLUE] = { 0x7c, 0xaf, 0xc2 }, /* blue, base0D */
[TSM_COLOR_MAGENTA] = { 0xba, 0x8b, 0xaf }, /* magenta, base0E */
[TSM_COLOR_CYAN] = { 0x86, 0xc1, 0xb9 }, /* cyan, base0C */
[TSM_COLOR_LIGHT_GREY] = { 0xaa, 0xaa, 0xaa }, /* light grey */
[TSM_COLOR_DARK_GREY] = { 0x55, 0x55, 0x55 }, /* dark grey */
[TSM_COLOR_LIGHT_RED] = { 0xab, 0x46, 0x42 }, /* red, base08 */
[TSM_COLOR_LIGHT_GREEN] = { 0xa1, 0xb5, 0x6c }, /* green, base0B */
[TSM_COLOR_LIGHT_YELLOW] = { 0xf7, 0xca, 0x88 }, /* yellow, base0A */
[TSM_COLOR_LIGHT_BLUE] = { 0x7c, 0xaf, 0xc2 }, /* blue, base0D */
[TSM_COLOR_LIGHT_MAGENTA] = { 0xba, 0x8b, 0xaf }, /* magenta, base0E */
[TSM_COLOR_LIGHT_CYAN] = { 0x86, 0xc1, 0xb9 }, /* cyan, base0C */
[TSM_COLOR_WHITE] = { 0xff, 0xff, 0xff }, /* white */
[TSM_COLOR_FOREGROUND] = { 0x18, 0x18, 0x18 }, /* dark grey */
[TSM_COLOR_BACKGROUND] = { 0xd8, 0xd8, 0xd8 }, /* light grey */
};
static uint8_t (*get_palette(struct tsm_vte *vte))[3]
{
if (!vte->palette_name)
return color_palette;
if (!strcmp(vte->palette_name, "custom") && vte->custom_palette_storage)
return vte->custom_palette_storage;
if (!strcmp(vte->palette_name, "solarized"))
return color_palette_solarized;
if (!strcmp(vte->palette_name, "solarized-black"))
return color_palette_solarized_black;
if (!strcmp(vte->palette_name, "solarized-white"))
return color_palette_solarized_white;
if (!strcmp(vte->palette_name, "soft-black"))
return color_palette_soft_black;
if (!strcmp(vte->palette_name, "base16-dark"))
return color_palette_base16_dark;
if (!strcmp(vte->palette_name, "base16-light"))
return color_palette_base16_light;
return color_palette;
}
/* Several effects may occur when non-RGB colors are used. For instance, if bold
* is enabled, then a dark color code is always converted to a light color to
* simulate bold (even though bold may actually be supported!). To support this,
* we need to differentiate between a set color-code and a set rgb-color.
* This function actually converts a set color-code into an RGB color. This must
* be called before passing the attribute to the console layer so the console
* layer can always work with RGB values and does not have to care for color
* codes. */
static void to_rgb(struct tsm_vte *vte, struct tsm_screen_attr *attr)
{
int8_t code;
code = attr->fccode;
if (code >= 0) {
/* bold causes light colors */
if (attr->bold && code < 8)
code += 8;
if (code >= TSM_COLOR_NUM)
code = TSM_COLOR_FOREGROUND;
attr->fr = vte->palette[code][0];
attr->fg = vte->palette[code][1];
attr->fb = vte->palette[code][2];
}
code = attr->bccode;
if (code >= 0) {
if (code >= TSM_COLOR_NUM)
code = TSM_COLOR_BACKGROUND;
attr->br = vte->palette[code][0];
attr->bg = vte->palette[code][1];
attr->bb = vte->palette[code][2];
}
}
static void copy_fcolor(struct tsm_screen_attr *dest,
const struct tsm_screen_attr *src)
{
dest->fccode = src->fccode;
dest->fr = src->fr;
dest->fg = src->fg;
dest->fb = src->fb;
}
static void copy_bcolor(struct tsm_screen_attr *dest,
const struct tsm_screen_attr *src)
{
dest->bccode = src->bccode;
dest->br = src->br;
dest->bg = src->bg;
dest->bb = src->bb;
}
SHL_EXPORT
int tsm_vte_new(struct tsm_vte **out, struct tsm_screen *con,
tsm_vte_write_cb write_cb, void *data,
tsm_log_t log, void *log_data)
{
struct tsm_vte *vte;
int ret;
if (!out || !con || !write_cb)
return -EINVAL;
vte = malloc(sizeof(*vte));
if (!vte)
return -ENOMEM;
memset(vte, 0, sizeof(*vte));
vte->ref = 1;
vte->llog = log;
vte->llog_data = log_data;
vte->con = con;
vte->write_cb = write_cb;
vte->data = data;
vte->backspace_sends_delete = false;
vte->osc_cb = NULL;
vte->osc_data = NULL;
vte->mouse_cb = NULL;
vte->mouse_data = NULL;
vte->custom_palette_storage = NULL;
vte->palette = get_palette(vte);
vte->def_attr.fccode = TSM_COLOR_FOREGROUND;
vte->def_attr.bccode = TSM_COLOR_BACKGROUND;
to_rgb(vte, &vte->def_attr);
ret = tsm_utf8_mach_new(&vte->mach);
if (ret)
goto err_free;
tsm_vte_reset(vte);
tsm_screen_erase_screen(vte->con, false);
llog_debug(vte, "new vte object");
tsm_screen_ref(vte->con);
*out = vte;
return 0;
err_free:
free(vte);
return ret;
}
SHL_EXPORT
void tsm_vte_ref(struct tsm_vte *vte)
{
if (!vte)
return;
vte->ref++;
}
SHL_EXPORT
void tsm_vte_unref(struct tsm_vte *vte)
{
if (!vte || !vte->ref)
return;
if (--vte->ref)
return;
llog_debug(vte, "destroying vte object");
free(vte->palette_name);
tsm_screen_unref(vte->con);
tsm_utf8_mach_free(vte->mach);
free(vte->custom_palette_storage);
free(vte);
}
SHL_EXPORT
void tsm_vte_set_osc_cb(struct tsm_vte *vte, tsm_vte_osc_cb osc_cb, void *osc_data)
{
if (!vte)
return;
vte->osc_cb = osc_cb;
vte->osc_data = osc_data;
}
SHL_EXPORT
void tsm_vte_set_mouse_cb(struct tsm_vte *vte, tsm_vte_mouse_cb mouse_cb, void *mouse_data)
{
if (!vte)
return;
vte->mouse_cb = mouse_cb;
vte->mouse_data = mouse_data;
}
static int vte_update_palette(struct tsm_vte *vte)
{
vte->palette = get_palette(vte);
vte->def_attr.fccode = TSM_COLOR_FOREGROUND;
vte->def_attr.bccode = TSM_COLOR_BACKGROUND;
to_rgb(vte, &vte->def_attr);
memcpy(&vte->cattr, &vte->def_attr, sizeof(vte->cattr));
tsm_screen_set_def_attr(vte->con, &vte->def_attr);
tsm_screen_erase_screen(vte->con, false);
return 0;
}
SHL_EXPORT
int tsm_vte_set_palette(struct tsm_vte *vte, const char *palette_name)
{
char *tmp = NULL;
if (!vte)
return -EINVAL;
if (palette_name) {
tmp = strdup(palette_name);
if (!tmp)
return -ENOMEM;
}
free(vte->palette_name);
vte->palette_name = tmp;
return vte_update_palette(vte);
}
SHL_EXPORT
int tsm_vte_set_custom_palette(struct tsm_vte *vte, uint8_t (*palette)[3])
{
const size_t palette_byte_size = sizeof(color_palette);
uint8_t (*tmp)[3] = NULL;
if (!vte)
return -EINVAL;
if (palette) {
tmp = malloc(palette_byte_size);
if (!tmp)
return -ENOMEM;
memcpy(tmp, palette, palette_byte_size);
}
free(vte->custom_palette_storage);
vte->custom_palette_storage = tmp;
return vte_update_palette(vte);
}
SHL_EXPORT
void tsm_vte_get_def_attr(struct tsm_vte *vte, struct tsm_screen_attr *out)
{
if (!vte || !out)
return;
memcpy(out, &vte->def_attr, sizeof(*out));
}
SHL_EXPORT
unsigned int tsm_vte_get_flags(struct tsm_vte *vte)
{
if (!vte) {
return 0;
}
return vte->flags;
}
SHL_EXPORT
unsigned int tsm_vte_get_mouse_mode(struct tsm_vte *vte)
{
if (!vte) {
return 0;
}
return vte->mouse_mode;
}
SHL_EXPORT
unsigned int tsm_vte_get_mouse_event(struct tsm_vte *vte)
{
if (!vte) {
return 0;
}
return vte->mouse_event;
}
/*
* Write raw byte-stream to pty.
* When writing data to the client we must make sure that we send the correct
* encoding. For backwards-compatibility reasons we should always send 7bit
* characters exclusively. However, when TSM_VTE_FLAG_7BIT_MODE is not set, then we can
* also send raw 8bit characters. For instance, in TSM_VTE_FLAG_8BIT_MODE we can use the
* GR characters as keyboard input and send them directly or even use the C1
* escape characters. In unicode mode (default) we can send multi-byte utf-8
* characters which are also 8bit. When sending these characters, set the \raw
* flag to true so this function does not perform debug checks on data we send.
* If debugging is disabled, these checks are also disabled and won't affect
* performance.
* For better debugging, we also use the __LINE__ and __FILE__ macros. Use the
* vte_write() and vte_write_raw() macros below for more convenient use.
*
* As a rule of thumb do never send 8bit characters in escape sequences and also
* avoid all 8bit escape codes including the C1 codes. This will guarantee that
* all kind of clients are always compatible to us.
*
* If SEND_RECEIVE_MODE is off (that is, local echo is on) we have to send all
* data directly to ourself again. However, we must avoid recursion when
* tsm_vte_input() itself calls vte_write*(), therefore, we increase the
* PARSER counter when entering tsm_vte_input() and reset it when leaving it
* so we never echo data that origins from tsm_vte_input().
* But note that SEND_RECEIVE_MODE is inherently broken for escape sequences
* that request answers. That is, if we send a request to the client that awaits
* a response and parse that request via local echo ourself, then we will also
* send a response to the client even though he didn't request one. This
* recursion fix does not avoid this but only prevents us from endless loops
* here. Anyway, only few applications rely on local echo so we can safely
* ignore this.
*/
static void vte_write_debug(struct tsm_vte *vte, const char *u8, size_t len,
bool raw, const char *file, int line)
{
#ifdef BUILD_ENABLE_DEBUG
/* in debug mode we check that escape sequences are always <0x7f so they
* are correctly parsed by non-unicode and non-8bit-mode clients. */
size_t i;
if (!raw) {
for (i = 0; i < len; ++i) {
if (u8[i] & 0x80)
llog_warning(vte, "sending 8bit character inline to client in %s:%d",
file, line);
}
}
#endif
/* in local echo mode, directly parse the data again */
if (!vte->parse_cnt && !(vte->flags & TSM_VTE_FLAG_SEND_RECEIVE_MODE)) {
if (vte->flags & TSM_VTE_FLAG_PREPEND_ESCAPE)
tsm_vte_input(vte, "\e", 1);
tsm_vte_input(vte, u8, len);
}
if (vte->flags & TSM_VTE_FLAG_PREPEND_ESCAPE)
vte->write_cb(vte, "\e", 1, vte->data);
vte->write_cb(vte, u8, len, vte->data);
vte->flags &= ~TSM_VTE_FLAG_PREPEND_ESCAPE;
}
#define vte_write(_vte, _u8, _len) \
vte_write_debug((_vte), (_u8), (_len), false, __FILE__, __LINE__)
#define vte_write_raw(_vte, _u8, _len) \
vte_write_debug((_vte), (_u8), (_len), true, __FILE__, __LINE__)
/* write to console */
static void write_console(struct tsm_vte *vte, tsm_symbol_t sym)
{
to_rgb(vte, &vte->cattr);
tsm_screen_write(vte->con, sym, &vte->cattr);
}
static void reset_state(struct tsm_vte *vte)
{
vte->saved_state.cursor_x = 0;
vte->saved_state.cursor_y = 0;
vte->saved_state.origin_mode = false;
vte->saved_state.wrap_mode = true;
vte->saved_state.gl = &vte->g0;
vte->saved_state.gr = &vte->g1;
copy_fcolor(&vte->saved_state.cattr, &vte->def_attr);
copy_bcolor(&vte->saved_state.cattr, &vte->def_attr);
vte->saved_state.cattr.bold = 0;
vte->saved_state.cattr.italic = 0;
vte->saved_state.cattr.underline = 0;
vte->saved_state.cattr.inverse = 0;
vte->saved_state.cattr.protect = 0;
vte->saved_state.cattr.blink = 0;
}
static void save_state(struct tsm_vte *vte)
{
vte->saved_state.cursor_x = tsm_screen_get_cursor_x(vte->con);
vte->saved_state.cursor_y = tsm_screen_get_cursor_y(vte->con);
vte->saved_state.cattr = vte->cattr;
vte->saved_state.gl = vte->gl;
vte->saved_state.gr = vte->gr;
vte->saved_state.wrap_mode = vte->flags & TSM_VTE_FLAG_AUTO_WRAP_MODE;
vte->saved_state.origin_mode = vte->flags & TSM_VTE_FLAG_ORIGIN_MODE;
}
static void restore_state(struct tsm_vte *vte)
{
tsm_screen_move_to(vte->con, vte->saved_state.cursor_x,
vte->saved_state.cursor_y);
vte->cattr = vte->saved_state.cattr;
to_rgb(vte, &vte->cattr);
if (vte->flags & TSM_VTE_FLAG_BACKGROUND_COLOR_ERASE_MODE)
tsm_screen_set_def_attr(vte->con, &vte->cattr);
vte->gl = vte->saved_state.gl;
vte->gr = vte->saved_state.gr;
if (vte->saved_state.wrap_mode) {
vte->flags |= TSM_VTE_FLAG_AUTO_WRAP_MODE;
tsm_screen_set_flags(vte->con, TSM_SCREEN_AUTO_WRAP);
} else {
vte->flags &= ~TSM_VTE_FLAG_AUTO_WRAP_MODE;
tsm_screen_reset_flags(vte->con, TSM_SCREEN_AUTO_WRAP);
}
if (vte->saved_state.origin_mode) {
vte->flags |= TSM_VTE_FLAG_ORIGIN_MODE;
tsm_screen_set_flags(vte->con, TSM_SCREEN_REL_ORIGIN);
} else {
vte->flags &= ~TSM_VTE_FLAG_ORIGIN_MODE;
tsm_screen_reset_flags(vte->con, TSM_SCREEN_REL_ORIGIN);
}
}
/*
* Reset VTE state
* This performs a soft reset of the VTE. That is, everything is reset to the
* same state as when the VTE was created. This does not affect the console,
* though.
*/
SHL_EXPORT
void tsm_vte_reset(struct tsm_vte *vte)
{
if (!vte)
return;
vte->flags = 0;
vte->flags |= TSM_VTE_FLAG_TEXT_CURSOR_MODE;
vte->flags |= TSM_VTE_FLAG_AUTO_REPEAT_MODE;
vte->flags |= TSM_VTE_FLAG_SEND_RECEIVE_MODE;
vte->flags |= TSM_VTE_FLAG_AUTO_WRAP_MODE;
vte->flags |= TSM_VTE_FLAG_BACKGROUND_COLOR_ERASE_MODE;
tsm_screen_reset(vte->con);
tsm_screen_set_flags(vte->con, TSM_SCREEN_AUTO_WRAP);
tsm_utf8_mach_reset(vte->mach);
vte->state = STATE_GROUND;
vte->gl = &vte->g0;
vte->gr = &vte->g1;
vte->glt = NULL;
vte->grt = NULL;
vte->g0 = &tsm_vte_unicode_lower;
vte->g1 = &tsm_vte_unicode_upper;
vte->g2 = &tsm_vte_unicode_lower;
vte->g3 = &tsm_vte_unicode_upper;
vte->mouse_mode = 0;
vte->mouse_event = 0;
vte->mouse_last_col = 0;
vte->mouse_last_row = 0;
memcpy(&vte->cattr, &vte->def_attr, sizeof(vte->cattr));
to_rgb(vte, &vte->cattr);
tsm_screen_set_def_attr(vte->con, &vte->def_attr);
reset_state(vte);
}
SHL_EXPORT
void tsm_vte_hard_reset(struct tsm_vte *vte)
{
if (!vte)
return;
tsm_vte_reset(vte);
tsm_screen_erase_screen(vte->con, false);
tsm_screen_clear_sb(vte->con);
tsm_screen_move_to(vte->con, 0, 0);
}
static void send_primary_da(struct tsm_vte *vte)
{
const static char str[] = "\e[?60;1;6;9;15c";
vte_write(vte, str, sizeof(str) - 1);
}
/* execute control character (C0 or C1) */
static void do_execute(struct tsm_vte *vte, uint32_t ctrl)
{
switch (ctrl) {
case 0x00: /* NUL */
/* Ignore on input */
break;
case 0x05: /* ENQ */
/* Transmit answerback message */
/* TODO: is there a better answer than ACK? */
vte_write(vte, "\x06", 1);
break;
case 0x07: /* BEL */
/* Sound bell tone */
/* TODO: I always considered this annying, however, we
* should at least provide some way to enable it if the
* user *really* wants it.
*/
break;
case 0x08: /* BS */
/* Move cursor one position left */
tsm_screen_move_left(vte->con, 1);
break;
case 0x09: /* HT */
/* Move to next tab stop or end of line */
tsm_screen_tab_right(vte->con, 1);
break;
case 0x0a: /* LF */
case 0x0b: /* VT */
case 0x0c: /* FF */
/* Line feed or newline (CR/NL mode) */
if (vte->flags & TSM_VTE_FLAG_LINE_FEED_NEW_LINE_MODE)
tsm_screen_newline(vte->con);
else
tsm_screen_move_down(vte->con, 1, true);
break;
case 0x0d: /* CR */
/* Move cursor to left margin */
tsm_screen_move_line_home(vte->con);
break;
case 0x0e: /* SO */
/* Map G1 character set into GL */
vte->gl = &vte->g1;
break;
case 0x0f: /* SI */
/* Map G0 character set into GL */
vte->gl = &vte->g0;
break;
case 0x11: /* XON */
/* Resume transmission */
/* TODO */
break;
case 0x13: /* XOFF */
/* Stop transmission */
/* TODO */
break;
case 0x18: /* CAN */
/* Cancel escape sequence */
/* nothing to do here */
break;
case 0x1a: /* SUB */
/* Discard current escape sequence and show err-sym */
write_console(vte, 0xbf);
break;
case 0x1b: /* ESC */
/* Invokes an escape sequence */
/* nothing to do here */
break;
case 0x1f: /* DEL */
/* Ignored */
break;
case 0x84: /* IND */
/* Move down one row, perform scroll-up if needed */
tsm_screen_move_down(vte->con, 1, true);
break;
case 0x85: /* NEL */
/* CR/NL with scroll-up if needed */
tsm_screen_newline(vte->con);
break;
case 0x88: /* HTS */
/* Set tab stop at current position */
tsm_screen_set_tabstop(vte->con);
break;
case 0x8d: /* RI */
/* Move up one row, perform scroll-down if needed */
tsm_screen_move_up(vte->con, 1, true);
break;
case 0x8e: /* SS2 */
/* Temporarily map G2 into GL for next char only */
vte->glt = &vte->g2;
break;
case 0x8f: /* SS3 */
/* Temporarily map G3 into GL for next char only */
vte->glt = &vte->g3;
break;
case 0x9a: /* DECID */
/* Send device attributes response like ANSI DA */
send_primary_da(vte);
break;
case 0x9c: /* ST */
/* End control string */
/* nothing to do here */
break;
default:
llog_debug(vte, "unhandled control char %u", ctrl);
}
}
static void do_clear(struct tsm_vte *vte)
{
int i;
vte->csi_argc = 0;
for (i = 0; i < CSI_ARG_MAX; ++i)
vte->csi_argv[i] = -1;
vte->csi_flags = 0;
vte->osc_len = 0;
memset(vte->osc_arg, 0, sizeof(vte->osc_arg));
}
static void do_collect(struct tsm_vte *vte, uint32_t data)
{
switch (data) {
case '!':
vte->csi_flags |= CSI_BANG;
break;
case '$':
vte->csi_flags |= CSI_CASH;
break;
case '?':
vte->csi_flags |= CSI_WHAT;
break;
case '>':
vte->csi_flags |= CSI_GT;
break;
case ' ':
vte->csi_flags |= CSI_SPACE;
break;
case '\'':
vte->csi_flags |= CSI_SQUOTE;
break;
case '"':
vte->csi_flags |= CSI_DQUOTE;
break;
case '*':
vte->csi_flags |= CSI_MULT;
break;
case '+':
vte->csi_flags |= CSI_PLUS;
break;
case '(':
vte->csi_flags |= CSI_POPEN;
break;
case ')':
vte->csi_flags |= CSI_PCLOSE;
break;
}
}
static void do_param(struct tsm_vte *vte, uint32_t data)
{
int new;
if (data == ';') {
if (vte->csi_argc < CSI_ARG_MAX)
vte->csi_argc++;
return;
}
if (vte->csi_argc >= CSI_ARG_MAX)
return;
/* avoid integer overflows; max allowed value is 16384 anyway */
if (vte->csi_argv[vte->csi_argc] > 0xffff)
return;
if (data >= '0' && data <= '9') {
new = vte->csi_argv[vte->csi_argc];
if (new <= 0)
new = data - '0';
else
new = new * 10 + data - '0';