1 import { C0 } from './EscapeSequences';
2 import { IInputHandler } from './Interfaces';
3 import { CHARSETS } from './Charsets';
5 const normalStateHandler: {[key: string]: (parser: Parser, handler: IInputHandler) => void} = {};
6 normalStateHandler[C0.BEL] = (parser, handler) => handler.bell();
7 normalStateHandler[C0.LF] = (parser, handler) => handler.lineFeed();
8 normalStateHandler[C0.VT] = normalStateHandler[C0.LF];
9 normalStateHandler[C0.FF] = normalStateHandler[C0.LF];
10 normalStateHandler[C0.CR] = (parser, handler) => handler.carriageReturn();
11 normalStateHandler[C0.BS] = (parser, handler) => handler.backspace();
12 normalStateHandler[C0.HT] = (parser, handler) => handler.tab();
13 normalStateHandler[C0.SO] = (parser, handler) => handler.shiftOut();
14 normalStateHandler[C0.SI] = (parser, handler) => handler.shiftIn();
15 normalStateHandler[C0.ESC] = (parser, handler) => parser.setState(ParserState.ESCAPED);
17 // TODO: Remove terminal when parser owns params and currentParam
18 const escapedStateHandler: {[key: string]: (parser: Parser, terminal: any) => void} = {};
19 escapedStateHandler['['] = (parser, terminal) => {
20 // ESC [ Control Sequence Introducer (CSI is 0x9b)
22 terminal.currentParam = 0;
23 parser.setState(ParserState.CSI_PARAM);
25 escapedStateHandler[']'] = (parser, terminal) => {
26 // ESC ] Operating System Command (OSC is 0x9d)
28 terminal.currentParam = 0;
29 parser.setState(ParserState.OSC);
31 escapedStateHandler['P'] = (parser, terminal) => {
32 // ESC P Device Control String (DCS is 0x90)
34 terminal.currentParam = 0;
35 parser.setState(ParserState.DCS);
37 escapedStateHandler['_'] = (parser, terminal) => {
38 // ESC _ Application Program Command ( APC is 0x9f).
39 parser.setState(ParserState.IGNORE);
41 escapedStateHandler['^'] = (parser, terminal) => {
42 // ESC ^ Privacy Message ( PM is 0x9e).
43 parser.setState(ParserState.IGNORE);
45 escapedStateHandler['c'] = (parser, terminal) => {
46 // ESC c Full Reset (RIS).
49 escapedStateHandler['E'] = (parser, terminal) => {
50 // ESC E Next Line ( NEL is 0x85).
53 parser.setState(ParserState.NORMAL);
55 escapedStateHandler['D'] = (parser, terminal) => {
56 // ESC D Index ( IND is 0x84).
58 parser.setState(ParserState.NORMAL);
60 escapedStateHandler['M'] = (parser, terminal) => {
61 // ESC M Reverse Index ( RI is 0x8d).
62 terminal.reverseIndex();
63 parser.setState(ParserState.NORMAL);
65 escapedStateHandler['%'] = (parser, terminal) => {
66 // ESC % Select default/utf-8 character set.
67 // @ = default, G = utf-8
68 terminal.setgLevel(0);
69 terminal.setgCharset(0, CHARSETS.US);
70 parser.setState(ParserState.NORMAL);
71 parser.skipNextChar();
74 const csiParamStateHandler: {[key: string]: (parser: Parser) => void} = {};
75 csiParamStateHandler['?'] = (parser) => parser.setPrefix('?');
76 csiParamStateHandler['>'] = (parser) => parser.setPrefix('>');
77 csiParamStateHandler['!'] = (parser) => parser.setPrefix('!');
78 csiParamStateHandler['0'] = (parser) => parser.setParam(parser.getParam() * 10);
79 csiParamStateHandler['1'] = (parser) => parser.setParam(parser.getParam() * 10 + 1);
80 csiParamStateHandler['2'] = (parser) => parser.setParam(parser.getParam() * 10 + 2);
81 csiParamStateHandler['3'] = (parser) => parser.setParam(parser.getParam() * 10 + 3);
82 csiParamStateHandler['4'] = (parser) => parser.setParam(parser.getParam() * 10 + 4);
83 csiParamStateHandler['5'] = (parser) => parser.setParam(parser.getParam() * 10 + 5);
84 csiParamStateHandler['6'] = (parser) => parser.setParam(parser.getParam() * 10 + 6);
85 csiParamStateHandler['7'] = (parser) => parser.setParam(parser.getParam() * 10 + 7);
86 csiParamStateHandler['8'] = (parser) => parser.setParam(parser.getParam() * 10 + 8);
87 csiParamStateHandler['9'] = (parser) => parser.setParam(parser.getParam() * 10 + 9);
88 csiParamStateHandler['$'] = (parser) => parser.setPostfix('$');
89 csiParamStateHandler['"'] = (parser) => parser.setPostfix('"');
90 csiParamStateHandler[' '] = (parser) => parser.setPostfix(' ');
91 csiParamStateHandler['\''] = (parser) => parser.setPostfix('\'');
92 csiParamStateHandler[';'] = (parser) => parser.finalizeParam();
94 const csiStateHandler: {[key: string]: (handler: IInputHandler, params: number[], prefix: string) => void} = {};
95 csiStateHandler['@'] = (handler, params, prefix) => handler.insertChars(params);
96 csiStateHandler['A'] = (handler, params, prefix) => handler.cursorUp(params);
97 csiStateHandler['B'] = (handler, params, prefix) => handler.cursorDown(params);
98 csiStateHandler['C'] = (handler, params, prefix) => handler.cursorForward(params);
99 csiStateHandler['D'] = (handler, params, prefix) => handler.cursorBackward(params);
100 csiStateHandler['E'] = (handler, params, prefix) => handler.cursorNextLine(params);
101 csiStateHandler['F'] = (handler, params, prefix) => handler.cursorPrecedingLine(params);
102 csiStateHandler['G'] = (handler, params, prefix) => handler.cursorCharAbsolute(params);
103 csiStateHandler['H'] = (handler, params, prefix) => handler.cursorPosition(params);
104 csiStateHandler['I'] = (handler, params, prefix) => handler.cursorForwardTab(params);
105 csiStateHandler['J'] = (handler, params, prefix) => handler.eraseInDisplay(params);
106 csiStateHandler['K'] = (handler, params, prefix) => handler.eraseInLine(params);
107 csiStateHandler['L'] = (handler, params, prefix) => handler.insertLines(params);
108 csiStateHandler['M'] = (handler, params, prefix) => handler.deleteLines(params);
109 csiStateHandler['P'] = (handler, params, prefix) => handler.deleteChars(params);
110 csiStateHandler['S'] = (handler, params, prefix) => handler.scrollUp(params);
111 csiStateHandler['T'] = (handler, params, prefix) => {
112 if (params.length < 2 && !prefix) {
113 handler.scrollDown(params);
116 csiStateHandler['X'] = (handler, params, prefix) => handler.eraseChars(params);
117 csiStateHandler['Z'] = (handler, params, prefix) => handler.cursorBackwardTab(params);
118 csiStateHandler['`'] = (handler, params, prefix) => handler.charPosAbsolute(params);
119 csiStateHandler['a'] = (handler, params, prefix) => handler.HPositionRelative(params);
120 csiStateHandler['b'] = (handler, params, prefix) => handler.repeatPrecedingCharacter(params);
121 csiStateHandler['c'] = (handler, params, prefix) => handler.sendDeviceAttributes(params);
122 csiStateHandler['d'] = (handler, params, prefix) => handler.linePosAbsolute(params);
123 csiStateHandler['e'] = (handler, params, prefix) => handler.VPositionRelative(params);
124 csiStateHandler['f'] = (handler, params, prefix) => handler.HVPosition(params);
125 csiStateHandler['g'] = (handler, params, prefix) => handler.tabClear(params);
126 csiStateHandler['h'] = (handler, params, prefix) => handler.setMode(params);
127 csiStateHandler['l'] = (handler, params, prefix) => handler.resetMode(params);
128 csiStateHandler['m'] = (handler, params, prefix) => handler.charAttributes(params);
129 csiStateHandler['n'] = (handler, params, prefix) => handler.deviceStatus(params);
130 csiStateHandler['p'] = (handler, params, prefix) => {
132 case '!': handler.softReset(params); break;
135 csiStateHandler['r'] = (handler, params) => handler.setScrollRegion(params);
136 csiStateHandler['s'] = (handler, params) => handler.saveCursor(params);
137 csiStateHandler['u'] = (handler, params) => handler.restoreCursor(params);
139 // TODO: Many codes/charsets appear to not be supported
140 // See: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
143 'A': CHARSETS.UK, // United Kingdom
144 'B': CHARSETS.US, // United States (USASCII)
146 'C': CHARSETS.Finnish,
147 '5': CHARSETS.Finnish,
148 'f': CHARSETS.French,
149 'Q': CHARSETS.FrenchCanadian,
150 'K': CHARSETS.German,
151 'Y': CHARSETS.Italian,
152 'E': CHARSETS.NorwegianDanish,
153 '6': CHARSETS.NorwegianDanish,
154 'Z': CHARSETS.Spanish,
155 'H': CHARSETS.Swedish,
156 '7': CHARSETS.Swedish,
158 '/': CHARSETS.ISOLatin // ISOLatin is actually /A
172 export class Parser {
173 private _state: ParserState;
174 private _position: number;
176 // TODO: Remove terminal when handler can do everything
178 private _inputHandler: IInputHandler,
179 private _terminal: any
181 this._state = ParserState.NORMAL;
184 public parse(data: string) {
185 let l = data.length, j, cs, ch, code, low;
188 // apply leftover surrogate high from last write
189 if (this._terminal.surrogate_high) {
190 data = this._terminal.surrogate_high + data;
191 this._terminal.surrogate_high = '';
194 for (; this._position < l; this._position++) {
195 ch = data[this._position];
197 // FIXME: higher chars than 0xa0 are not allowed in escape sequences
198 // --> maybe move to default
199 code = data.charCodeAt(this._position);
200 if (0xD800 <= code && code <= 0xDBFF) {
201 // we got a surrogate high
202 // get surrogate low (next 2 bytes)
203 low = data.charCodeAt(this._position + 1);
205 // end of data stream, save surrogate high
206 this._terminal.surrogate_high = ch;
209 code = ((code - 0xD800) * 0x400) + (low - 0xDC00) + 0x10000;
210 ch += data.charAt(this._position + 1);
212 // surrogate low - already handled above
213 if (0xDC00 <= code && code <= 0xDFFF)
216 switch (this._state) {
217 case ParserState.NORMAL:
218 if (ch in normalStateHandler) {
219 normalStateHandler[ch](this, this._inputHandler);
221 this._inputHandler.addChar(ch, code);
224 case ParserState.ESCAPED:
225 if (ch in escapedStateHandler) {
226 escapedStateHandler[ch](this, this._terminal);
227 // Skip switch as it was just handled
232 // ESC (,),*,+,-,. Designate G0-G2 Character Set.
233 case '(': // <-- this seems to get all the attention
241 this._terminal.gcharset = 0;
244 this._terminal.gcharset = 1;
247 this._terminal.gcharset = 2;
250 this._terminal.gcharset = 3;
253 this._terminal.gcharset = 1;
256 this._terminal.gcharset = 2;
259 this._state = ParserState.CHARSET;
262 // Designate G3 Character Set (VT300).
263 // A = ISO Latin-1 Supplemental.
266 this._terminal.gcharset = 3;
267 this._state = ParserState.CHARSET;
272 // Single Shift Select of G2 Character Set
273 // ( SS2 is 0x8e). This affects next character only.
277 // Single Shift Select of G3 Character Set
278 // ( SS3 is 0x8f). This affects next character only.
282 // Invoke the G2 Character Set as GL (LS2).
284 this._terminal.setgLevel(2);
287 // Invoke the G3 Character Set as GL (LS3).
289 this._terminal.setgLevel(3);
292 // Invoke the G3 Character Set as GR (LS3R).
294 this._terminal.setgLevel(3);
297 // Invoke the G2 Character Set as GR (LS2R).
299 this._terminal.setgLevel(2);
302 // Invoke the G1 Character Set as GR (LS1R).
304 this._terminal.setgLevel(1);
307 // ESC 7 Save Cursor (DECSC).
309 this._inputHandler.saveCursor();
310 this._state = ParserState.NORMAL;
313 // ESC 8 Restore Cursor (DECRC).
315 this._inputHandler.restoreCursor();
316 this._state = ParserState.NORMAL;
319 // ESC # 3 DEC line height/width
321 this._state = ParserState.NORMAL;
325 // ESC H Tab Set (HTS is 0x88).
327 this._terminal.tabSet();
328 this._state = ParserState.NORMAL;
331 // ESC = Application Keypad (DECKPAM).
333 this._terminal.log('Serial port requested application keypad.');
334 this._terminal.applicationKeypad = true;
335 this._terminal.viewport.syncScrollArea();
336 this._state = ParserState.NORMAL;
339 // ESC > Normal Keypad (DECKPNM).
341 this._terminal.log('Switching back to normal keypad.');
342 this._terminal.applicationKeypad = false;
343 this._terminal.viewport.syncScrollArea();
344 this._state = ParserState.NORMAL;
348 this._state = ParserState.NORMAL;
349 this._terminal.error('Unknown ESC control: %s.', ch);
354 case ParserState.CHARSET:
355 if (ch in charsetMap) {
357 if (ch === '/') { // ISOLatin is actually /A
361 cs = CHARSETS.US; // Default
363 this._terminal.setgCharset(this._terminal.gcharset, cs);
364 this._terminal.gcharset = null;
365 this._state = ParserState.NORMAL;
368 case ParserState.OSC:
371 // Set Text Parameters.
372 if (ch === C0.ESC || ch === C0.BEL) {
373 if (ch === C0.ESC) this._position++;
375 this._terminal.params.push(this._terminal.currentParam);
377 switch (this._terminal.params[0]) {
381 if (this._terminal.params[1]) {
382 this._terminal.title = this._terminal.params[1];
383 this._terminal.handleTitle(this._terminal.title);
391 // change dynamic colors
403 // change dynamic ui colors
415 // manipulate selection data
432 this._terminal.params = [];
433 this._terminal.currentParam = 0;
434 this._state = ParserState.NORMAL;
436 if (!this._terminal.params.length) {
437 if (ch >= '0' && ch <= '9') {
438 this._terminal.currentParam =
439 this._terminal.currentParam * 10 + ch.charCodeAt(0) - 48;
440 } else if (ch === ';') {
441 this._terminal.params.push(this._terminal.currentParam);
442 this._terminal.currentParam = '';
445 this._terminal.currentParam += ch;
450 case ParserState.CSI_PARAM:
451 if (ch in csiParamStateHandler) {
452 csiParamStateHandler[ch](this);
455 this.finalizeParam();
456 // Fall through the CSI as this character should be the CSI code.
457 this._state = ParserState.CSI;
459 case ParserState.CSI:
460 if (ch in csiStateHandler) {
461 csiStateHandler[ch](this._inputHandler, this._terminal.params, this._terminal.prefix);
463 this._terminal.error('Unknown CSI code: %s.', ch);
466 this._state = ParserState.NORMAL;
467 this._terminal.prefix = '';
468 this._terminal.postfix = '';
471 case ParserState.DCS:
472 if (ch === C0.ESC || ch === C0.BEL) {
473 if (ch === C0.ESC) this._position++;
475 switch (this._terminal.prefix) {
476 // User-Defined Keys (DECUDK).
480 // Request Status String (DECRQSS).
481 // test: echo -e '\eP$q"p\e\\'
483 let pt = this._terminal.currentParam
500 + (this._terminal.scrollTop + 1)
502 + (this._terminal.scrollBottom + 1)
512 this._terminal.error('Unknown DCS Pt: %s.', pt);
517 this._terminal.send(C0.ESC + 'P' + +valid + '$r' + pt + C0.ESC + '\\');
520 // Set Termcap/Terminfo Data (xterm, experimental).
524 // Request Termcap/Terminfo String (xterm, experimental)
525 // Regular xterm does not even respond to this sequence.
526 // This can cause a small glitch in vim.
527 // test: echo -ne '\eP+q6b64\e\\'
529 // TODO: Don't declare pt twice
530 /*let*/ pt = this._terminal.currentParam
533 this._terminal.send(C0.ESC + 'P' + +valid + '+r' + pt + C0.ESC + '\\');
537 this._terminal.error('Unknown DCS prefix: %s.', this._terminal.prefix);
541 this._terminal.currentParam = 0;
542 this._terminal.prefix = '';
543 this._state = ParserState.NORMAL;
544 } else if (!this._terminal.currentParam) {
545 if (!this._terminal.prefix && ch !== '$' && ch !== '+') {
546 this._terminal.currentParam = ch;
547 } else if (this._terminal.prefix.length === 2) {
548 this._terminal.currentParam = ch;
550 this._terminal.prefix += ch;
553 this._terminal.currentParam += ch;
557 case ParserState.IGNORE:
559 if (ch === C0.ESC || ch === C0.BEL) {
560 if (ch === C0.ESC) this._position++;
561 this._state = ParserState.NORMAL;
568 public setState(state: ParserState): void {
572 public setPrefix(prefix: string): void {
573 this._terminal.prefix = prefix;
576 public setParam(param: number) {
577 this._terminal.currentParam = param;
580 public getParam(): number {
581 return this._terminal.currentParam;
584 public finalizeParam(): void {
585 this._terminal.params.push(this._terminal.currentParam);
586 this._terminal.currentParam = 0;
589 public setPostfix(postfix: string): void {
590 this._terminal.postfix = postfix;
593 public skipNextChar(): void {
597 // public repeatChar(): void {