Skip to content

Commit 9c8de63

Browse files
jerchjerch
committed
multiple changes in APC handling:
- change interface to IFunctionIdentifier (API change) - extend parser states APC_ENTRY, APC_INTERMEDIATE, APC_PASSTHROUGH - remove APC_STRING - change ApcParser.start to retrieve ident - change actions APC_START and APC_PUT
1 parent 9c54203 commit 9c8de63

16 files changed

Lines changed: 188 additions & 205 deletions

‎addons/addon-image/src/ImageAddon.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ export class ImageAddon implements ITerminalAddon, IImageApi {
166166
this._disposeLater(
167167
kittyStorage,
168168
kittyHandler,
169-
terminal._core._inputHandler._parser.registerApcHandler(0x47, kittyHandler)
169+
terminal._core._inputHandler._parser.registerApcHandler({ final: 'G' }, kittyHandler)
170170
);
171171
}
172172
}

‎package-lock.json‎

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/browser/TestUtils.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export class MockTerminal implements ITerminal {
107107
public registerOscHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
108108
throw new Error('Method not implemented.');
109109
}
110-
public registerApcHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
110+
public registerApcHandler(id: IFunctionIdentifier, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
111111
throw new Error('Method not implemented.');
112112
}
113113
public registerLinkProvider(linkProvider: ILinkProvider): IDisposable {

‎src/common/CoreTerminal.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,8 @@ export abstract class CoreTerminal extends Disposable implements ICoreTerminal {
243243
}
244244

245245
/** Add handler for APC escape sequence. See xterm.d.ts for details. */
246-
public registerApcHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
247-
return this._inputHandler.registerApcHandler(ident, callback);
246+
public registerApcHandler(id: IFunctionIdentifier, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
247+
return this._inputHandler.registerApcHandler(id, callback);
248248
}
249249

250250
protected _setup(): void {

‎src/common/InputHandler.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -729,8 +729,8 @@ export class InputHandler extends Disposable implements IInputHandler {
729729
/**
730730
* Forward registerApcHandler from parser.
731731
*/
732-
public registerApcHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
733-
return this._parser.registerApcHandler(ident, new ApcHandler(callback));
732+
public registerApcHandler(id: IFunctionIdentifier, callback: (data: string) => boolean | Promise<boolean>): IDisposable {
733+
return this._parser.registerApcHandler(id, new ApcHandler(callback));
734734
}
735735

736736
/**

‎src/common/Types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface ICoreTerminal {
2222
registerDcsHandler(id: IFunctionIdentifier, callback: (data: string, param: IParams) => boolean | Promise<boolean>): IDisposable;
2323
registerEscHandler(id: IFunctionIdentifier, callback: () => boolean | Promise<boolean>): IDisposable;
2424
registerOscHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable;
25-
registerApcHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable;
25+
registerApcHandler(id: IFunctionIdentifier, callback: (data: string) => boolean | Promise<boolean>): IDisposable;
2626
}
2727

2828
export interface IDisposable {
@@ -476,7 +476,7 @@ export interface IInputHandler {
476476
registerDcsHandler(id: IFunctionIdentifier, callback: (data: string, param: IParams) => boolean | Promise<boolean>): IDisposable;
477477
registerEscHandler(id: IFunctionIdentifier, callback: () => boolean | Promise<boolean>): IDisposable;
478478
registerOscHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable;
479-
registerApcHandler(ident: number, callback: (data: string) => boolean | Promise<boolean>): IDisposable;
479+
registerApcHandler(id: IFunctionIdentifier, callback: (data: string) => boolean | Promise<boolean>): IDisposable;
480480

481481
/** C0 BEL */ bell(): boolean;
482482
/** C0 LF */ lineFeed(): boolean;

‎src/common/parser/ApcParser.test.ts‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ describe('ApcParser', () => {
6060

6161
describe('identifier parsing', () => {
6262
it('single character identifier', () => {
63-
parser.start();
64-
const data = toUtf32('Gf=100,a=T;payload');
63+
parser.start('G'.charCodeAt(0));
64+
const data = toUtf32('f=100,a=T;payload');
6565
parser.put(data, 0, data.length);
6666
parser.end(true);
6767
assert.deepEqual(reports, [
@@ -71,20 +71,20 @@ describe('ApcParser', () => {
7171
]);
7272
});
7373

74-
it('identifier with no payload', () => {
75-
parser.start();
76-
const data = toUtf32('G');
77-
parser.put(data, 0, data.length);
78-
parser.end(true);
79-
assert.deepEqual(reports, [
80-
[0x47, 'START', undefined],
81-
[0x47, 'END', true]
82-
]);
83-
});
74+
//it('identifier with no payload', () => {
75+
// parser.start('G'.charCodeAt(0));
76+
// const data = toUtf32('');
77+
// parser.put(data, 0, data.length);
78+
// parser.end(true);
79+
// assert.deepEqual(reports, [
80+
// [0x47, 'START', undefined],
81+
// [0x47, 'END', true]
82+
// ]);
83+
//});
8484

8585
it('identifier with chunked payload', () => {
86-
parser.start();
87-
let data = toUtf32('Gf=100');
86+
parser.start('G'.charCodeAt(0));
87+
let data = toUtf32('f=100');
8888
parser.put(data, 0, data.length);
8989
data = toUtf32(',a=T');
9090
parser.put(data, 0, data.length);
@@ -100,11 +100,11 @@ describe('ApcParser', () => {
100100
]);
101101
});
102102

103-
it('empty APC sequence', () => {
104-
parser.start();
105-
parser.end(true);
106-
assert.deepEqual(reports, []);
107-
});
103+
//it('empty APC sequence', () => {
104+
// parser.start('G'.charCodeAt(0));
105+
// parser.end(true);
106+
// assert.deepEqual(reports, []);
107+
//});
108108
});
109109

110110
describe('handler registration', () => {
@@ -117,8 +117,8 @@ describe('ApcParser', () => {
117117
it('registerHandler for specific identifier', () => {
118118
const G_CODE = 0x47; // 'G'
119119
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'kitty'));
120-
parser.start();
121-
const data = toUtf32('Gf=100,a=T;imagedata');
120+
parser.start('G'.charCodeAt(0));
121+
const data = toUtf32('f=100,a=T;imagedata');
122122
parser.put(data, 0, data.length);
123123
parser.end(true);
124124
assert.deepEqual(handlerReports, [
@@ -133,8 +133,8 @@ describe('ApcParser', () => {
133133
const G_CODE = 0x47; // 'G'
134134
const X_CODE = 0x58; // 'X'
135135
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'kitty'));
136-
parser.start();
137-
const data = toUtf32('Xsome data');
136+
parser.start('X'.charCodeAt(0));
137+
const data = toUtf32('some data');
138138
parser.put(data, 0, data.length);
139139
parser.end(true);
140140
assert.deepEqual(handlerReports, []);
@@ -149,8 +149,8 @@ describe('ApcParser', () => {
149149
const G_CODE = 0x47;
150150
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'kitty'));
151151
parser.clearHandler(G_CODE);
152-
parser.start();
153-
const data = toUtf32('Gf=100');
152+
parser.start('G'.charCodeAt(0));
153+
const data = toUtf32('f=100');
154154
parser.put(data, 0, data.length);
155155
parser.end(true);
156156
assert.deepEqual(handlerReports, []);
@@ -165,8 +165,8 @@ describe('ApcParser', () => {
165165
const G_CODE = 0x47;
166166
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'handler1'));
167167
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'handler2'));
168-
parser.start();
169-
const data = toUtf32('Gdata');
168+
parser.start('G'.charCodeAt(0));
169+
const data = toUtf32('data');
170170
parser.put(data, 0, data.length);
171171
parser.end(true);
172172
assert.deepEqual(handlerReports, [
@@ -183,8 +183,8 @@ describe('ApcParser', () => {
183183
const G_CODE = 0x47;
184184
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'handler1'));
185185
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'handler2', true));
186-
parser.start();
187-
const data = toUtf32('Gdata');
186+
parser.start('G'.charCodeAt(0));
187+
const data = toUtf32('data');
188188
parser.put(data, 0, data.length);
189189
parser.end(true);
190190
assert.deepEqual(handlerReports, [
@@ -202,8 +202,8 @@ describe('ApcParser', () => {
202202
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'handler1'));
203203
const disposable = parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'handler2'));
204204
disposable.dispose();
205-
parser.start();
206-
const data = toUtf32('Gdata');
205+
parser.start('G'.charCodeAt(0));
206+
const data = toUtf32('data');
207207
parser.put(data, 0, data.length);
208208
parser.end(true);
209209
assert.deepEqual(handlerReports, [
@@ -237,8 +237,8 @@ describe('ApcParser', () => {
237237
results.push([G_CODE, data]);
238238
return true;
239239
}));
240-
parser.start();
241-
let data = toUtf32('Gf=100');
240+
parser.start('G'.charCodeAt(0));
241+
let data = toUtf32('f=100');
242242
parser.put(data, 0, data.length);
243243
data = toUtf32(',a=T;payload');
244244
parser.put(data, 0, data.length);
@@ -253,8 +253,8 @@ describe('ApcParser', () => {
253253
results.push([G_CODE, data]);
254254
return true;
255255
}));
256-
parser.start();
257-
const data = toUtf32('Gf=100,a=T;payload');
256+
parser.start('G'.charCodeAt(0));
257+
const data = toUtf32('f=100,a=T;payload');
258258
parser.put(data, 0, data.length);
259259
parser.end(false);
260260
assert.deepEqual(results, []);
@@ -268,8 +268,8 @@ describe('ApcParser', () => {
268268
results.push([G_CODE, data]);
269269
return true;
270270
}));
271-
parser.start();
272-
let data = toUtf32('G');
271+
parser.start('G'.charCodeAt(0));
272+
let data = toUtf32('');
273273
parser.put(data, 0, data.length);
274274
data = toUtf32('A'.repeat(CHUNK_SIZE));
275275
for (let i = 0; i < TEST_PAYLOAD_LIMIT; i += CHUNK_SIZE) {
@@ -287,8 +287,8 @@ describe('ApcParser', () => {
287287
results.push([G_CODE, data]);
288288
return true;
289289
}));
290-
parser.start();
291-
let data = toUtf32('G');
290+
parser.start('G'.charCodeAt(0));
291+
let data = toUtf32('');
292292
parser.put(data, 0, data.length);
293293
data = toUtf32('A'.repeat(CHUNK_SIZE));
294294
for (let i = 0; i < TEST_PAYLOAD_LIMIT; i += CHUNK_SIZE) {
@@ -311,8 +311,8 @@ describe('ApcParser', () => {
311311
it('reset during payload cleans up handlers', () => {
312312
const G_CODE = 0x47;
313313
parser.registerHandler(G_CODE, new TestHandler(G_CODE, handlerReports, 'kitty'));
314-
parser.start();
315-
const data = toUtf32('Gf=100');
314+
parser.start('G'.charCodeAt(0));
315+
const data = toUtf32('f=100');
316316
parser.put(data, 0, data.length);
317317
parser.reset();
318318
assert.deepEqual(handlerReports, [
@@ -353,8 +353,8 @@ describe('ApcParser - async tests', () => {
353353
results.push([G_CODE, data]);
354354
return true;
355355
}));
356-
parser.start();
357-
const data = toUtf32('Gf=100,a=T');
356+
parser.start('G'.charCodeAt(0));
357+
const data = toUtf32('f=100,a=T');
358358
parser.put(data, 0, data.length);
359359
await endP(parser, true);
360360
assert.deepEqual(results, [[G_CODE, 'f=100,a=T']]);

0 commit comments

Comments
 (0)