This repository was archived by the owner on Dec 1, 2021. It is now read-only.
forked from robberphex/vscode-php-debug
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathxdebugConnection.ts
More file actions
801 lines (732 loc) · 31.8 KB
/
Copy pathxdebugConnection.ts
File metadata and controls
801 lines (732 loc) · 31.8 KB
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
import * as net from 'net';
import * as iconv from 'iconv-lite';
import {DbgpConnection} from './dbgp';
/** The encoding all XDebug messages are encoded with */
const ENCODING = 'iso-8859-1';
/** The first packet we receive from XDebug. Returned by waitForInitPacket() */
export class InitPacket {
/** The file that was requested as a file:// URI */
fileUri: string;
/** GDGP version (1.0) */
protocolVersion: string;
/** language being debugged (PHP) */
language: string;
/** an IDE key, by default the PC name */
ideKey: string;
/** a reference to the connection this packet was received from */
connection: Connection;
/** the version of XDebug */
engineVersion: string;
/**
* @param {XMLDocument} document - An XML document to read from
* @param {Connection} connection
*/
constructor(document: XMLDocument, connection: Connection) {
const documentElement = document.documentElement;
this.fileUri = documentElement.getAttribute('fileuri')!;
this.language = documentElement.getAttribute('language')!;
this.protocolVersion = documentElement.getAttribute('protocol_version')!;
this.ideKey = documentElement.getAttribute('idekey')!;
this.engineVersion = documentElement.getElementsByTagName('engine')[0].getAttribute('version')!;
this.connection = connection;
}
}
/** Error class for errors returned from XDebug */
export class XDebugError extends Error {
code: number;
constructor(message: string, code: number) {
super(message);
this.code = code;
this.message = message;
this.name = 'XDebugError';
}
}
/** The base class for all XDebug responses to commands executed on a connection */
export class Response {
/** A unique transaction ID that matches the one in the request */
transactionId: number;
/** The command that this is an answer for */
command: string;
/** The connection this response was received from */
connection: Connection;
/**
* contructs a new Response object from an XML document.
* If there is an error child node, an exception is thrown with the appropiate code and message.
* @param {XMLDocument} document - An XML document to read from
* @param {Connection} connection
*/
constructor(document: XMLDocument, connection: Connection) {
const documentElement = document.documentElement;
if (documentElement.hasChildNodes() && documentElement.firstChild.nodeName === 'error') {
const errorNode = <Element>documentElement.firstChild;
const code = parseInt(errorNode.getAttribute('code')!);
const message = errorNode.textContent!;
throw new XDebugError(message, code);
}
this.transactionId = parseInt(documentElement.getAttribute('transaction_id')!);
this.command = documentElement.getAttribute('command')!;
this.connection = connection;
}
}
/** A response to the status command */
export class StatusResponse extends Response {
/** The current status. Can be 'break', ... */
status: string;
/** The reason for being in this status, can be 'ok', ... */
reason: string;
/** Contains the file URI if the status is 'break' */
fileUri: string;
/** Contains the line number if the status is 'break' */
line: number;
/** Contains info about the exception if the reason for breaking was an exception */
exception: {
name: string;
message: string;
code?: number;
};
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
const documentElement = document.documentElement;
this.status = documentElement.getAttribute('status')!;
this.reason = documentElement.getAttribute('reason')!;
if (documentElement.hasChildNodes()) {
const messageNode = <Element>documentElement.firstChild;
if (messageNode.hasAttribute('exception')) {
this.exception = {
name: messageNode.getAttribute('exception')!,
message: messageNode.textContent!
};
if (messageNode.hasAttribute('code')) {
this.exception.code = parseInt(messageNode.getAttribute('code')!);
}
}
if (messageNode.hasAttribute('filename')) {
this.fileUri = messageNode.getAttribute('filename')!;
}
if (messageNode.hasAttribute('lineno')) {
this.line = parseInt(messageNode.getAttribute('lineno')!);
}
}
}
}
export type BreakpointType = 'line' | 'call' | 'return' | 'exception' | 'conditional' | 'watch';
export type BreakpointState = 'enabled' | 'disabled';
/** Abstract base class for all breakpoints */
export abstract class Breakpoint {
/** Unique ID which is used for modifying the breakpoint (only when received through breakpoint_list) */
id: number;
/** The type of the breakpoint: line, call, return, exception, conditional or watch */
type: BreakpointType;
/** State of the breakpoint: enabled, disabled */
state: BreakpointState;
/** The connection this breakpoint is set on */
connection: Connection;
/** dynamically detects the type of breakpoint and returns the appropiate object */
public static fromXml(breakpointNode: Element, connection: Connection): Breakpoint {
switch (breakpointNode.getAttribute('type')) {
case 'exception': return new ExceptionBreakpoint(breakpointNode, connection);
case 'line': return new LineBreakpoint(breakpointNode, connection);
case 'conditional': return new ConditionalBreakpoint(breakpointNode, connection);
case 'call': return new CallBreakpoint(breakpointNode, connection);
default: throw new Error(`Invalid type ${breakpointNode.getAttribute('type')}`);
}
}
/** Constructs a breakpoint object from an XML node from a XDebug response */
constructor(breakpointNode: Element, connection: Connection);
/** To create a new breakpoint in derived classes */
constructor(type: BreakpointType);
constructor() {
if (typeof arguments[0] === 'object') {
// from XML
const breakpointNode: Element = arguments[0];
this.connection = arguments[1];
this.type = <BreakpointType>breakpointNode.getAttribute('type');
this.id = parseInt(breakpointNode.getAttribute('id')!);
this.state = <BreakpointState>breakpointNode.getAttribute('state');
} else {
this.type = arguments[0];
}
}
/** Removes the breakpoint by sending a breakpoint_remove command */
public remove() {
return this.connection.sendBreakpointRemoveCommand(this);
}
}
/** class for line breakpoints. Returned from a breakpoint_list or passed to sendBreakpointSetCommand */
export class LineBreakpoint extends Breakpoint {
/** File URI of the file in which to break */
fileUri: string;
/** Line to break on */
line: number;
/** constructs a line breakpoint from an XML node */
constructor(breakpointNode: Element, connection: Connection);
/** contructs a line breakpoint for passing to sendSetBreakpointCommand */
constructor(fileUri: string, line: number);
constructor() {
if (typeof arguments[0] === 'object') {
const breakpointNode: Element = arguments[0];
const connection: Connection = arguments[1];
super(breakpointNode, connection);
this.line = parseInt(breakpointNode.getAttribute('lineno')!);
this.fileUri = breakpointNode.getAttribute('filename')!;
} else {
// construct from arguments
super('line');
this.fileUri = arguments[0];
this.line = arguments[1];
}
}
}
/** class for call breakpoints. Returned from a breakpoint_list or passed to sendBreakpointSetCommand */
export class CallBreakpoint extends Breakpoint {
/** the function to break on */
fn: string;
/** optional expression that must evaluate to true */
expression: string;
/** constructs a call breakpoint from an XML node */
constructor(breakpointNode: Element, connection: Connection);
/** contructs a call breakpoint for passing to sendSetBreakpointCommand */
constructor(fn: string, expression?: string);
constructor() {
if (typeof arguments[0] === 'object') {
const breakpointNode: Element = arguments[0];
const connection: Connection = arguments[1];
super(breakpointNode, connection);
this.fn = breakpointNode.getAttribute('function')!;
this.expression = breakpointNode.getAttribute('expression')!; // Base64 encoded?
} else {
// construct from arguments
super('call');
this.fn = arguments[0];
this.expression = arguments[1];
}
}
}
/** class for exception breakpoints. Returned from a breakpoint_list or passed to sendBreakpointSetCommand */
export class ExceptionBreakpoint extends Breakpoint {
/** The Exception name to break on. Can also contain wildcards. */
exception: string;
/** Constructs a breakpoint object from an XML node from a XDebug response */
constructor(breakpointNode: Element, connection: Connection);
/** Constructs a breakpoint for passing it to sendSetBreakpointCommand */
constructor(exception: string);
constructor() {
if (typeof arguments[0] === 'object') {
// from XML
const breakpointNode: Element = arguments[0];
const connection: Connection = arguments[1];
super(breakpointNode, connection);
this.exception = breakpointNode.getAttribute('exception')!;
} else {
// from arguments
super('exception');
this.exception = arguments[0];
}
}
}
/** class for conditional breakpoints. Returned from a breakpoint_list or passed to sendBreakpointSetCommand */
export class ConditionalBreakpoint extends Breakpoint {
/** File URI */
fileUri: string;
/** Line (optional) */
line: number;
/** The PHP expression under which to break on */
expression: string;
/** Constructs a breakpoint object from an XML node from a XDebug response */
constructor(breakpointNode: Element, connection: Connection);
/** Contructs a breakpoint object for passing to sendSetBreakpointCommand */
constructor(expression: string, fileUri: string, line?: number);
constructor() {
if (typeof arguments[0] === 'object') {
// from XML
const breakpointNode: Element = arguments[0];
const connection: Connection = arguments[1];
super(breakpointNode, connection);
this.expression = breakpointNode.getAttribute('expression')!; // Base64 encoded?
} else {
// from arguments
super('conditional');
this.expression = arguments[0];
this.fileUri = arguments[1];
this.line = arguments[2];
}
}
}
/** Response to a breakpoint_set command */
export class BreakpointSetResponse extends Response {
breakpointId: number;
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
this.breakpointId = parseInt(document.documentElement.getAttribute('id')!);
}
}
/** The response to a breakpoint_list command */
export class BreakpointListResponse extends Response {
/** The currently set breakpoints for this connection */
breakpoints: Breakpoint[];
/**
* @param {XMLDocument} document
* @param {Connection} connection
*/
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
this.breakpoints = Array.from(document.documentElement.childNodes).map((breakpointNode: Element) => Breakpoint.fromXml(breakpointNode, connection));
}
}
/** One stackframe inside a stacktrace retrieved through stack_get */
export class StackFrame {
/** The UI-friendly name of this stack frame, like a function name or "{main}" */
name: string;
/** The type of stack frame. Valid values are "file" and "eval" */
type: string;
/** The file URI where the stackframe was entered */
fileUri: string;
/** The line number inside file where the stackframe was entered */
line: number;
/** The level (index) inside the stack trace at which the stack frame receides */
level: number;
/** The connection this stackframe belongs to */
connection: Connection;
/**
* @param {Element} stackFrameNode
* @param {Connection} connection
*/
constructor(stackFrameNode: Element, connection: Connection) {
this.name = stackFrameNode.getAttribute('where')!;
this.fileUri = stackFrameNode.getAttribute('filename')!;
this.type = stackFrameNode.getAttribute('type')!;
this.line = parseInt(stackFrameNode.getAttribute('lineno')!);
this.level = parseInt(stackFrameNode.getAttribute('level')!);
this.connection = connection;
}
/** Returns the available contexts (scopes, such as "Local" and "Superglobals") by doing a context_names command */
public async getContexts(): Promise<Context[]> {
return (await this.connection.sendContextNamesCommand(this)).contexts;
}
}
/** The response to a stack_get command */
export class StackGetResponse extends Response {
/** The current stack trace */
stack: StackFrame[];
/**
* @param {XMLDocument} document
* @param {Connection} connection
*/
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
this.stack = Array.from(document.documentElement.childNodes).map((stackFrameNode: Element) => new StackFrame(stackFrameNode, connection));
}
}
export class SourceResponse extends Response {
source: string;
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
this.source = (new Buffer(document.documentElement.textContent!, 'base64')).toString();
}
}
/** A context inside a stack frame, like "Local" or "Superglobals" */
export class Context {
/** Unique id that is used for further commands */
id: number;
/** UI-friendly name like "Local" or "Superglobals" */
name: string;
/** The stackframe this context belongs to */
stackFrame: StackFrame;
/**
* @param {Element} contextNode
* @param {StackFrame} stackFrame
*/
constructor(contextNode: Element, stackFrame: StackFrame) {
this.id = parseInt(contextNode.getAttribute('id')!);
this.name = contextNode.getAttribute('name')!;
this.stackFrame = stackFrame;
}
/**
* Returns the properties (variables) inside this context by doing a context_get command
* @returns Promise.<Property[]>
*/
public async getProperties(): Promise<Property[]> {
return (await this.stackFrame.connection.sendContextGetCommand(this)).properties;
}
}
/** Response to a context_names command */
export class ContextNamesResponse extends Response {
/** the available contexts inside the given stack frame */
contexts: Context[];
/**
* @param {XMLDocument} document
* @param {StackFrame} stackFrame
*/
constructor(document: XMLDocument, stackFrame: StackFrame) {
super(document, stackFrame.connection);
this.contexts = Array.from(document.documentElement.childNodes).map((contextNode: Element) => new Context(contextNode, stackFrame));
}
}
/** The parent for properties inside a scope and properties retrieved through eval requests */
export abstract class BaseProperty {
/** the short name of the property */
name: string;
/** the data type of the variable. Can be string, int, float, bool, array, object, uninitialized, null or resource */
type: string;
/** the class if the type is object */
class: string;
/** a boolean indicating wether children of this property can be received or not. This is true for arrays and objects. */
hasChildren: boolean;
/** the number of children this property has, if any. Useful for showing array length. */
numberOfChildren: number;
/** the value of the property for primitive types */
value: string;
/** children that were already included in the response */
children: BaseProperty[];
constructor(propertyNode: Element) {
if (propertyNode.hasAttribute('name')) {
this.name = propertyNode.getAttribute('name')!;
}
this.type = propertyNode.getAttribute('type')!;
if (propertyNode.hasAttribute('classname')) {
this.class = propertyNode.getAttribute('classname')!;
}
this.hasChildren = !!parseInt(propertyNode.getAttribute('children')!);
if (this.hasChildren) {
this.numberOfChildren = parseInt(propertyNode.getAttribute('numchildren')!);
} else {
const encoding = propertyNode.getAttribute('encoding');
if (encoding) {
this.value = iconv.encode(propertyNode.textContent!, encoding) + '';
} else {
this.value = propertyNode.textContent!;
}
}
}
}
/** a property (variable) inside a context or a child of another property */
export class Property extends BaseProperty {
/** the fully-qualified name of the property inside the context */
fullName: string;
/** the context this property belongs to */
context: Context;
children: Property[];
/**
* @param {Element} propertyNode
* @param {Context} context
*/
constructor(propertyNode: Element, context: Context) {
super(propertyNode);
this.fullName = propertyNode.getAttribute('fullname')!;
this.context = context;
if (this.hasChildren) {
this.children = Array.from(propertyNode.childNodes).map((propertyNode: Element) => new Property(propertyNode, context));
}
}
/**
* Returns the child properties of this property by doing another property_get
* @returns Promise.<Property[]>
*/
public async getChildren(page?: number): Promise<Property[]> {
if (!this.hasChildren) {
throw new Error('This property has no children');
}
return (await this.context.stackFrame.connection.sendPropertyGetCommand(this, page)).children;
}
}
/** The response to a context_get command */
export class ContextGetResponse extends Response {
/** the available properties inside the context */
properties: Property[];
/**
* @param {XMLDocument} document
* @param {Context} context
*/
constructor(document: XMLDocument, context: Context) {
super(document, context.stackFrame.connection);
this.properties = Array.from(document.documentElement.childNodes).map((propertyNode: Element) => new Property(propertyNode, context));
}
}
/** The response to a property_get command */
export class PropertyGetResponse extends Response {
/** the children of the given property */
children: Property[];
/**
* @param {XMLDocument} document
* @param {Property} property
*/
constructor(document: XMLDocument, property: Property) {
super(document, property.context.stackFrame.connection);
this.children = Array.from(document.documentElement.firstChild.childNodes).map((propertyNode: Element) => new Property(propertyNode, property.context));
}
}
/** class for properties returned from eval commands. These don't have a full name or an ID, but have all children already inlined. */
export class EvalResultProperty extends BaseProperty {
children: EvalResultProperty[];
constructor(propertyNode: Element) {
super(propertyNode);
if (this.hasChildren) {
this.children = Array.from(propertyNode.childNodes).map((propertyNode: Element) => new EvalResultProperty(propertyNode));
}
}
}
/** The response to an eval command */
export class EvalResponse extends Response {
/** the result of the expression, if there was any */
result: EvalResultProperty;
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
if (document.documentElement.hasChildNodes()) {
this.result = new EvalResultProperty(<Element>document.documentElement.firstChild);
}
}
}
/** The response to an feature_set command */
export class FeatureSetResponse extends Response {
/** the feature that was set */
feature: string;
constructor(document: XMLDocument, connection: Connection) {
super(document, connection);
this.feature = document.documentElement.getAttribute('feature')!;
}
}
/** A command inside the queue */
interface Command {
/** The name of the command, like breakpoint_list */
name: string;
/** All arguments as one string */
args?: string;
/** Data that gets appended after an " -- " in base64 */
data?: string;
/** callback that gets called with an XML document when a response arrives that could be parsed */
resolveFn: (response: XMLDocument) => any;
/** callback that gets called if an error happened while parsing the response */
rejectFn: (error?: Error) => any;
}
/**
* This class represents a connection to XDebug and is instantiated with a socket.
*/
export class Connection extends DbgpConnection {
/** a counter for unique connection IDs */
private static _connectionCounter = 1;
/** unique connection ID */
public id: number;
/** the time this connection was established */
public timeEstablished: Date;
/** a counter for unique transaction IDs. */
private _transactionCounter = 1;
/** the promise that gets resolved once we receive the init packet */
private _initPromise: Promise<InitPacket>;
/** resolves the init promise */
private _initPromiseResolveFn: (initPackt: InitPacket) => any;
/** rejects the init promise */
private _initPromiseRejectFn: (err?: Error) => any;
/**
* a map from transaction IDs to pending commands that have been sent to XDebug and are awaiting a response.
* This should in theory only contain max one element at any time.
*/
private _pendingCommands = new Map<number, Command>();
/**
* XDebug does NOT support async communication.
* This means before sending a new command, we have to wait until we get a response for the previous.
* This array is a stack of commands that get passed to _sendCommand once XDebug can accept commands again.
*/
private _commandQueue: Command[] = [];
/** Constructs a new connection that uses the given socket to communicate with XDebug. */
constructor(socket: net.Socket) {
super(socket);
this.id = Connection._connectionCounter++;
this.timeEstablished = new Date();
this._initPromise = new Promise<InitPacket>((resolve, reject) => {
this._initPromiseResolveFn = resolve;
this._initPromiseRejectFn = reject;
});
this.on('message', (response: XMLDocument) => {
if (response.documentElement.nodeName === 'init') {
this._initPromiseResolveFn(new InitPacket(response, this));
} else {
const transactionId = parseInt(response.documentElement.getAttribute('transaction_id')!);
if (this._pendingCommands.has(transactionId)) {
const command = this._pendingCommands.get(transactionId);
this._pendingCommands.delete(transactionId);
command.resolveFn(response);
}
if (this._commandQueue.length > 0) {
const command = this._commandQueue.shift()!;
this._executeCommand(command).catch(command.rejectFn);
}
}
});
}
/** Returns a promise that gets resolved once the init packet arrives */
public waitForInitPacket(): Promise<InitPacket> {
return this._initPromise;
}
/**
* Pushes a new command to the queue that will be executed after all the previous commands have finished and we received a response.
* If the queue is empty AND there are no pending transactions (meaning we already received a response and XDebug is waiting for
* commands) the command will be executed emidiatly.
*/
private _enqueueCommand(name: string, args?: string, data?: string): Promise<XMLDocument> {
return new Promise((resolveFn, rejectFn) => {
const command = {name, args, data, resolveFn, rejectFn};
if (this._commandQueue.length === 0 && this._pendingCommands.size === 0) {
this._executeCommand(command);
} else {
this._commandQueue.push(command);
}
});
}
/**
* Sends a command to XDebug with a new transaction ID and calls the callback on the command. This can
* only be called when XDebug can actually accept commands, which is after we received a response for the
* previous command.
*/
private async _executeCommand(command: Command): Promise<void> {
const transactionId = this._transactionCounter++;
let commandString = command.name + ' -i ' + transactionId;
if (command.args) {
commandString += ' ' + command.args;
}
if (command.data) {
commandString += ' -- ' + (new Buffer(command.data)).toString('base64');
}
commandString += '\0';
const data = iconv.encode(commandString, ENCODING);
await this.write(data);
this._pendingCommands.set(transactionId, command);
}
public close() {
this._commandQueue = [];
this._initPromiseRejectFn(new Error('connection closed'));
return super.close();
}
// ------------------------ status --------------------------------------------
/** Sends a status command */
public async sendStatusCommand(): Promise<StatusResponse> {
return new StatusResponse(await this._enqueueCommand('status'), this);
}
// ------------------------ feature negotiation --------------------------------
/**
* Sends a feature_get command
* feature can be one of
* - language_supports_threads
* - language_name
* - language_version
* - encoding
* - protocol_version
* - supports_async
* - data_encoding
* - breakpoint_languages
* - breakpoint_types
* - multiple_sessions
* - max_children
* - max_data
* - max_depth
* - extended_properties
* optional features:
* - supports_postmortem
* - show_hidden
* - notify_ok
* or any command.
*/
public async sendFeatureGetCommand(feature: string): Promise<XMLDocument> {
return await this._enqueueCommand('feature_get', `-n feature`);
}
/**
* Sends a feature_set command
* feature can be one of
* - multiple_sessions
* - max_children
* - max_data
* - max_depth
* - extended_properties
* optional features:
* - show_hidden
* - notify_ok
*/
public async sendFeatureSetCommand(feature: string, value: string): Promise<FeatureSetResponse> {
return new FeatureSetResponse(await this._enqueueCommand('feature_set', `-n ${feature} -v ${value}`), this);
}
// ---------------------------- breakpoints ------------------------------------
/**
* Sends a breakpoint_set command that sets a breakpoint.
* @param {Breakpoint} breakpoint - an instance of LineBreakpoint, ConditionalBreakpoint or ExceptionBreakpoint
* @returns Promise.<BreakpointSetResponse>
*/
public async sendBreakpointSetCommand(breakpoint: Breakpoint): Promise<BreakpointSetResponse> {
let args = `-t ${breakpoint.type}`;
let data: string | undefined;
if (breakpoint instanceof LineBreakpoint) {
args += ` -f ${breakpoint.fileUri} -n ${breakpoint.line}`;
} else if (breakpoint instanceof ExceptionBreakpoint) {
args += ` -x ${breakpoint.exception}`;
} else if (breakpoint instanceof ConditionalBreakpoint) {
args += ` -f ${breakpoint.fileUri}`;
if (typeof breakpoint.line === 'number') {
args += ` -n ${breakpoint.line}`;
}
data = breakpoint.expression;
} else if (breakpoint instanceof CallBreakpoint) {
args += ` -m ${breakpoint.fn}`;
data = breakpoint.expression;
}
return new BreakpointSetResponse(await this._enqueueCommand('breakpoint_set', args, data), this);
}
/** sends a breakpoint_list command */
public async sendBreakpointListCommand(): Promise<BreakpointListResponse> {
return new BreakpointListResponse(await this._enqueueCommand('breakpoint_list'), this);
}
/** sends a breakpoint_remove command */
public async sendBreakpointRemoveCommand(breakpoint: Breakpoint): Promise<Response> {
return new Response(await this._enqueueCommand('breakpoint_remove', `-d ${breakpoint.id}`), this);
}
// ----------------------------- continuation ---------------------------------
/** sends a run command */
public async sendRunCommand(): Promise<StatusResponse> {
return new StatusResponse(await this._enqueueCommand('run'), this);
}
/** sends a step_into command */
public async sendStepIntoCommand(): Promise<StatusResponse> {
return new StatusResponse(await this._enqueueCommand('step_into'), this);
}
/** sends a step_over command */
public async sendStepOverCommand(): Promise<StatusResponse> {
return new StatusResponse(await this._enqueueCommand('step_over'), this);
}
/** sends a step_out command */
public async sendStepOutCommand(): Promise<StatusResponse> {
return new StatusResponse(await this._enqueueCommand('step_out'), this);
}
/** sends a stop command */
public async sendStopCommand(): Promise<StatusResponse> {
return new StatusResponse(await this._enqueueCommand('stop'), this);
}
// ------------------------------ stack ----------------------------------------
/** Sends a stack_get command */
public async sendStackGetCommand(): Promise<StackGetResponse> {
return new StackGetResponse(await this._enqueueCommand('stack_get'), this);
}
public async sendSourceCommand(uri: string): Promise<SourceResponse> {
return new SourceResponse(await this._enqueueCommand('source', `-f ${uri}`), this);
}
// ------------------------------ context --------------------------------------
/** Sends a context_names command. */
public async sendContextNamesCommand(stackFrame: StackFrame): Promise<ContextNamesResponse> {
return new ContextNamesResponse(await this._enqueueCommand('context_names', `-d ${stackFrame.level}`), stackFrame);
}
/** Sends a context_get comand */
public async sendContextGetCommand(context: Context): Promise<ContextGetResponse> {
return new ContextGetResponse(await this._enqueueCommand('context_get', `-d ${context.stackFrame.level} -c ${context.id}`), context);
}
/** Sends a property_get command */
public async sendPropertyGetCommand(property: Property, page: number = 0): Promise<PropertyGetResponse> {
const escapedFullName = '"' + property.fullName.replace(/("|\\)/g, '\\$1') + '"';
return new PropertyGetResponse(await this._enqueueCommand('property_get', [
'-d', property.context.stackFrame.level,
'-c', property.context.id,
'-n', escapedFullName,
'-p', page
].join(' ')), property);
}
// ------------------------------- eval -----------------------------------------
/** sends an eval command */
public async sendEvalCommand(expression: string): Promise<EvalResponse> {
return new EvalResponse(await this._enqueueCommand('eval', undefined, expression), this);
}
}