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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { distinct, lastIndex } from 'vs/base/common/arrays';
import { RunOnceScheduler } from 'vs/base/common/async';
import { decodeBase64, encodeBase64, VSBuffer } from 'vs/base/common/buffer';
import { CancellationTokenSource } from 'vs/base/common/cancellation';
import { Emitter, Event } from 'vs/base/common/event';
import { Disposable } from 'vs/base/common/lifecycle';
import { mixin } from 'vs/base/common/objects';
import * as resources from 'vs/base/common/resources';
import { isString, isUndefinedOrNull } from 'vs/base/common/types';
import { URI, URI as uri } from 'vs/base/common/uri';
import { generateUuid } from 'vs/base/common/uuid';
import { IRange, Range } from 'vs/editor/common/core/range';
import * as nls from 'vs/nls';
import { IUriIdentityService } from 'vs/platform/uriIdentity/common/uriIdentity';
import { IEditorPane } from 'vs/workbench/common/editor';
import { DEBUG_MEMORY_SCHEME, IBaseBreakpoint, IBreakpoint, IBreakpointData, IBreakpointsChangeEvent, IBreakpointUpdateData, IDataBreakpoint, IDebugModel, IDebugSession, IEnablement, IExceptionBreakpoint, IExceptionInfo, IExpression, IExpressionContainer, IFunctionBreakpoint, IInstructionBreakpoint, IMemoryInvalidationEvent, IMemoryRegion, IRawModelUpdate, IRawStoppedDetails, IScope, IStackFrame, IThread, ITreeElement, MemoryRange, MemoryRangeType, State } from 'vs/workbench/contrib/debug/common/debug';
import { getUriFromSource, Source, UNKNOWN_SOURCE_LABEL } from 'vs/workbench/contrib/debug/common/debugSource';
import { DebugStorage } from 'vs/workbench/contrib/debug/common/debugStorage';
import { DisassemblyViewInput } from 'vs/workbench/contrib/debug/common/disassemblyViewInput';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
interface IDebugProtocolVariableWithContext extends DebugProtocol.Variable {
__vscodeVariableMenuContext?: string;
}
export class ExpressionContainer implements IExpressionContainer {
public static readonly allValues = new Map<string, string>();
// Use chunks to support variable paging #9537
private static readonly BASE_CHUNK_SIZE = 100;
public type: string | undefined;
public valueChanged = false;
private _value: string = '';
protected children?: Promise<IExpression[]>;
constructor(
protected session: IDebugSession | undefined,
protected readonly threadId: number | undefined,
private _reference: number | undefined,
private readonly id: string,
public namedVariables: number | undefined = 0,
public indexedVariables: number | undefined = 0,
public memoryReference: string | undefined = undefined,
private startOfVariables: number | undefined = 0,
public presentationHint: DebugProtocol.VariablePresentationHint | undefined = undefined
) { }
get reference(): number | undefined {
return this._reference;
}
set reference(value: number | undefined) {
this._reference = value;
this.children = undefined; // invalidate children cache
}
async evaluateLazy(): Promise<void> {
if (typeof this.reference === 'undefined') {
return;
}
const response = await this.session!.variables(this.reference, this.threadId, undefined, undefined, undefined);
if (!response || !response.body || !response.body.variables || response.body.variables.length !== 1) {
return;
}
const dummyVar = response.body.variables[0];
this.reference = dummyVar.variablesReference;
this._value = dummyVar.value;
this.namedVariables = dummyVar.namedVariables;
this.indexedVariables = dummyVar.indexedVariables;
this.memoryReference = dummyVar.memoryReference;
this.presentationHint = dummyVar.presentationHint;
// Also call overridden method to adopt subclass props
this.adoptLazyResponse(dummyVar);
}
protected adoptLazyResponse(response: DebugProtocol.Variable): void {
}
getChildren(): Promise<IExpression[]> {
if (!this.children) {
this.children = this.doGetChildren();
}
return this.children;
}
private async doGetChildren(): Promise<IExpression[]> {
if (!this.hasChildren) {
return [];
}
if (!this.getChildrenInChunks) {
return this.fetchVariables(undefined, undefined, undefined);
}
// Check if object has named variables, fetch them independent from indexed variables #9670
const children = this.namedVariables ? await this.fetchVariables(undefined, undefined, 'named') : [];
// Use a dynamic chunk size based on the number of elements #9774
let chunkSize = ExpressionContainer.BASE_CHUNK_SIZE;
while (!!this.indexedVariables && this.indexedVariables > chunkSize * ExpressionContainer.BASE_CHUNK_SIZE) {
chunkSize *= ExpressionContainer.BASE_CHUNK_SIZE;
}
if (!!this.indexedVariables && this.indexedVariables > chunkSize) {
// There are a lot of children, create fake intermediate values that represent chunks #9537
const numberOfChunks = Math.ceil(this.indexedVariables / chunkSize);
for (let i = 0; i < numberOfChunks; i++) {
const start = (this.startOfVariables || 0) + i * chunkSize;
const count = Math.min(chunkSize, this.indexedVariables - i * chunkSize);
children.push(new Variable(this.session, this.threadId, this, this.reference, `[${start}..${start + count - 1}]`, '', '', undefined, count, undefined, { kind: 'virtual' }, undefined, undefined, true, start));
}
return children;
}
const variables = await this.fetchVariables(this.startOfVariables, this.indexedVariables, 'indexed');
return children.concat(variables);
}
getId(): string {
return this.id;
}
getSession(): IDebugSession | undefined {
return this.session;
}
get value(): string {
return this._value;
}
get hasChildren(): boolean {
// only variables with reference > 0 have children.
return !!this.reference && this.reference > 0 && !this.presentationHint?.lazy;
}
private async fetchVariables(start: number | undefined, count: number | undefined, filter: 'indexed' | 'named' | undefined): Promise<Variable[]> {
try {
const response = await this.session!.variables(this.reference || 0, this.threadId, filter, start, count);
if (!response || !response.body || !response.body.variables) {
return [];
}
const nameCount = new Map<string, number>();
const vars = response.body.variables.filter(v => !!v).map((v: IDebugProtocolVariableWithContext) => {
if (isString(v.value) && isString(v.name) && typeof v.variablesReference === 'number') {
const count = nameCount.get(v.name) || 0;
const idDuplicationIndex = count > 0 ? count.toString() : '';
nameCount.set(v.name, count + 1);
return new Variable(this.session, this.threadId, this, v.variablesReference, v.name, v.evaluateName, v.value, v.namedVariables, v.indexedVariables, v.memoryReference, v.presentationHint, v.type, v.__vscodeVariableMenuContext, true, 0, idDuplicationIndex);
}
return new Variable(this.session, this.threadId, this, 0, '', undefined, nls.localize('invalidVariableAttributes', "Invalid variable attributes"), 0, 0, undefined, { kind: 'virtual' }, undefined, undefined, false);
});
if (this.session!.autoExpandLazyVariables) {
await Promise.all(vars.map(v => v.presentationHint?.lazy && v.evaluateLazy()));
}
return vars;
} catch (e) {
return [new Variable(this.session, this.threadId, this, 0, '', undefined, e.message, 0, 0, undefined, { kind: 'virtual' }, undefined, undefined, false)];
}
}
// The adapter explicitly sents the children count of an expression only if there are lots of children which should be chunked.
private get getChildrenInChunks(): boolean {
return !!this.indexedVariables;
}
set value(value: string) {
this._value = value;
this.valueChanged = !!ExpressionContainer.allValues.get(this.getId()) &&
ExpressionContainer.allValues.get(this.getId()) !== Expression.DEFAULT_VALUE && ExpressionContainer.allValues.get(this.getId()) !== value;
ExpressionContainer.allValues.set(this.getId(), value);
}
toString(): string {
return this.value;
}
async evaluateExpression(
expression: string,
session: IDebugSession | undefined,
stackFrame: IStackFrame | undefined,
context: string,
keepLazyVars = false): Promise<boolean> {
if (!session || (!stackFrame && context !== 'repl')) {
this.value = context === 'repl' ? nls.localize('startDebugFirst', "Please start a debug session to evaluate expressions") : Expression.DEFAULT_VALUE;
this.reference = 0;
return false;
}
this.session = session;
try {
const response = await session.evaluate(expression, stackFrame ? stackFrame.frameId : undefined, context);
if (response && response.body) {
this.value = response.body.result || '';
this.reference = response.body.variablesReference;
this.namedVariables = response.body.namedVariables;
this.indexedVariables = response.body.indexedVariables;
this.memoryReference = response.body.memoryReference;
this.type = response.body.type || this.type;
this.presentationHint = response.body.presentationHint;
if (!keepLazyVars && response.body.presentationHint?.lazy) {
await this.evaluateLazy();
}
return true;
}
return false;
} catch (e) {
this.value = e.message || '';
this.reference = 0;
return false;
}
}
}
function handleSetResponse(expression: ExpressionContainer, response: DebugProtocol.SetVariableResponse | DebugProtocol.SetExpressionResponse | undefined): void {
if (response && response.body) {
expression.value = response.body.value || '';
expression.type = response.body.type || expression.type;
expression.reference = response.body.variablesReference;
expression.namedVariables = response.body.namedVariables;
expression.indexedVariables = response.body.indexedVariables;
// todo @weinand: the set responses contain most properties, but not memory references. Should they?
}
}
export class Expression extends ExpressionContainer implements IExpression {
static readonly DEFAULT_VALUE = nls.localize('notAvailable', "not available");
public available: boolean;
constructor(public name: string, id = generateUuid()) {
super(undefined, undefined, 0, id);
this.available = false;
// name is not set if the expression is just being added
// in that case do not set default value to prevent flashing #14499
if (name) {
this.value = Expression.DEFAULT_VALUE;
}
}
async evaluate(session: IDebugSession | undefined, stackFrame: IStackFrame | undefined, context: string, keepLazyVars?: boolean): Promise<void> {
this.available = await this.evaluateExpression(this.name, session, stackFrame, context, keepLazyVars);
}
override toString(): string {
return `${this.name}\n${this.value}`;
}
async setExpression(value: string, stackFrame: IStackFrame): Promise<void> {
if (!this.session) {
return;
}
const response = await this.session.setExpression(stackFrame.frameId, this.name, value);
handleSetResponse(this, response);
}
}
export class Variable extends ExpressionContainer implements IExpression {
// Used to show the error message coming from the adapter when setting the value #7807
public errorMessage: string | undefined;
constructor(
session: IDebugSession | undefined,
threadId: number | undefined,
public readonly parent: IExpressionContainer,
reference: number | undefined,
public readonly name: string,
public evaluateName: string | undefined,
value: string | undefined,
namedVariables: number | undefined,
indexedVariables: number | undefined,
memoryReference: string | undefined,
presentationHint: DebugProtocol.VariablePresentationHint | undefined,
type: string | undefined = undefined,
public readonly variableMenuContext: string | undefined = undefined,
public readonly available = true,
startOfVariables = 0,
idDuplicationIndex = '',
) {
super(session, threadId, reference, `variable:${parent.getId()}:${name}:${idDuplicationIndex}`, namedVariables, indexedVariables, memoryReference, startOfVariables, presentationHint);
this.value = value || '';
this.type = type;
}
async setVariable(value: string, stackFrame: IStackFrame): Promise<any> {
if (!this.session) {
return;
}
try {
// Send out a setExpression for debug extensions that do not support set variables https://github.com/microsoft/vscode/issues/124679#issuecomment-869844437
if (this.session.capabilities.supportsSetExpression && !this.session.capabilities.supportsSetVariable && this.evaluateName) {
return this.setExpression(value, stackFrame);
}
const response = await this.session.setVariable((<ExpressionContainer>this.parent).reference, this.name, value);
handleSetResponse(this, response);
} catch (err) {
this.errorMessage = err.message;
}
}
async setExpression(value: string, stackFrame: IStackFrame): Promise<void> {
if (!this.session || !this.evaluateName) {
return;
}
const response = await this.session.setExpression(stackFrame.frameId, this.evaluateName, value);
handleSetResponse(this, response);
}
override toString(): string {
return this.name ? `${this.name}: ${this.value}` : this.value;
}
protected override adoptLazyResponse(response: DebugProtocol.Variable): void {
this.evaluateName = response.evaluateName;
}
toDebugProtocolObject(): DebugProtocol.Variable {
return {
name: this.name,
variablesReference: this.reference || 0,
memoryReference: this.memoryReference,
value: this.value,
evaluateName: this.evaluateName
};
}
}
export class Scope extends ExpressionContainer implements IScope {
constructor(
stackFrame: IStackFrame,
index: number,
public readonly name: string,
reference: number,
public expensive: boolean,
namedVariables?: number,
indexedVariables?: number,
public readonly range?: IRange
) {
super(stackFrame.thread.session, stackFrame.thread.threadId, reference, `scope:${name}:${index}`, namedVariables, indexedVariables);
}
override toString(): string {
return this.name;
}
toDebugProtocolObject(): DebugProtocol.Scope {
return {
name: this.name,
variablesReference: this.reference || 0,
expensive: this.expensive
};
}
}
export class ErrorScope extends Scope {
constructor(
stackFrame: IStackFrame,
index: number,
message: string,
) {
super(stackFrame, index, message, 0, false);
}
override toString(): string {
return this.name;
}
}
export class StackFrame implements IStackFrame {
private scopes: Promise<Scope[]> | undefined;
constructor(
public readonly thread: Thread,
public readonly frameId: number,
public readonly source: Source,
public readonly name: string,
public readonly presentationHint: string | undefined,
public readonly range: IRange,
private readonly index: number,
public readonly canRestart: boolean,
public readonly instructionPointerReference?: string
) { }
getId(): string {
return `stackframe:${this.thread.getId()}:${this.index}:${this.source.name}`;
}
getScopes(): Promise<IScope[]> {
if (!this.scopes) {
this.scopes = this.thread.session.scopes(this.frameId, this.thread.threadId).then(response => {
if (!response || !response.body || !response.body.scopes) {
return [];
}
const scopeNameIndexes = new Map<string, number>();
return response.body.scopes.map(rs => {
const previousIndex = scopeNameIndexes.get(rs.name);
const index = typeof previousIndex === 'number' ? previousIndex + 1 : 0;
scopeNameIndexes.set(rs.name, index);
return new Scope(this, index, rs.name, rs.variablesReference, rs.expensive, rs.namedVariables, rs.indexedVariables,
rs.line && rs.column && rs.endLine && rs.endColumn ? new Range(rs.line, rs.column, rs.endLine, rs.endColumn) : undefined);
});
}, err => [new ErrorScope(this, 0, err.message)]);
}
return this.scopes;
}
async getMostSpecificScopes(range: IRange): Promise<IScope[]> {
const scopes = await this.getScopes();
const nonExpensiveScopes = scopes.filter(s => !s.expensive);
const haveRangeInfo = nonExpensiveScopes.some(s => !!s.range);
if (!haveRangeInfo) {
return nonExpensiveScopes;
}
const scopesContainingRange = nonExpensiveScopes.filter(scope => scope.range && Range.containsRange(scope.range, range))
.sort((first, second) => (first.range!.endLineNumber - first.range!.startLineNumber) - (second.range!.endLineNumber - second.range!.startLineNumber));
return scopesContainingRange.length ? scopesContainingRange : nonExpensiveScopes;
}
restart(): Promise<void> {
return this.thread.session.restartFrame(this.frameId, this.thread.threadId);
}
forgetScopes(): void {
this.scopes = undefined;
}
toString(): string {
const lineNumberToString = typeof this.range.startLineNumber === 'number' ? `:${this.range.startLineNumber}` : '';
const sourceToString = `${this.source.inMemory ? this.source.name : this.source.uri.fsPath}${lineNumberToString}`;
return sourceToString === UNKNOWN_SOURCE_LABEL ? this.name : `${this.name} (${sourceToString})`;
}
async openInEditor(editorService: IEditorService, preserveFocus?: boolean, sideBySide?: boolean, pinned?: boolean): Promise<IEditorPane | undefined> {
const threadStopReason = this.thread.stoppedDetails?.reason;
if (this.instructionPointerReference &&
(threadStopReason === 'instruction breakpoint' ||
(threadStopReason === 'step' && this.thread.lastSteppingGranularity === 'instruction'))) {
return editorService.openEditor(DisassemblyViewInput.instance, { pinned: true });
}
if (this.source.available) {
return this.source.openInEditor(editorService, this.range, preserveFocus, sideBySide, pinned);
}
return undefined;
}
equals(other: IStackFrame): boolean {
return (this.name === other.name) && (other.thread === this.thread) && (this.frameId === other.frameId) && (other.source === this.source) && (Range.equalsRange(this.range, other.range));
}
}
export class Thread implements IThread {
private callStack: IStackFrame[];
private staleCallStack: IStackFrame[];
private callStackCancellationTokens: CancellationTokenSource[] = [];
public stoppedDetails: IRawStoppedDetails | undefined;
public stopped: boolean;
public reachedEndOfCallStack = false;
public lastSteppingGranularity: DebugProtocol.SteppingGranularity | undefined;
constructor(public readonly session: IDebugSession, public name: string, public readonly threadId: number) {
this.callStack = [];
this.staleCallStack = [];
this.stopped = false;
}
getId(): string {
return `thread:${this.session.getId()}:${this.threadId}`;
}
clearCallStack(): void {
if (this.callStack.length) {
this.staleCallStack = this.callStack;
}
this.callStack = [];
this.callStackCancellationTokens.forEach(c => c.dispose(true));
this.callStackCancellationTokens = [];
}
getCallStack(): IStackFrame[] {
return this.callStack;
}
getStaleCallStack(): ReadonlyArray<IStackFrame> {
return this.staleCallStack;
}
getTopStackFrame(): IStackFrame | undefined {
const callStack = this.getCallStack();
// Allow stack frame without source and with instructionReferencePointer as top stack frame when using disassembly view.
const firstAvailableStackFrame = callStack.find(sf => !!(sf &&
((this.stoppedDetails?.reason === 'instruction breakpoint' || (this.stoppedDetails?.reason === 'step' && this.lastSteppingGranularity === 'instruction')) && sf.instructionPointerReference) ||
(sf.source && sf.source.available && sf.source.presentationHint !== 'deemphasize')));
return firstAvailableStackFrame || (callStack.length > 0 ? callStack[0] : undefined);
}
get stateLabel(): string {
if (this.stoppedDetails) {
return this.stoppedDetails.description ||
(this.stoppedDetails.reason ? nls.localize({ key: 'pausedOn', comment: ['indicates reason for program being paused'] }, "Paused on {0}", this.stoppedDetails.reason) : nls.localize('paused', "Paused"));
}
return nls.localize({ key: 'running', comment: ['indicates state'] }, "Running");
}
/**
* Queries the debug adapter for the callstack and returns a promise
* which completes once the call stack has been retrieved.
* If the thread is not stopped, it returns a promise to an empty array.
* Only fetches the first stack frame for performance reasons. Calling this method consecutive times
* gets the remainder of the call stack.
*/
async fetchCallStack(levels = 20): Promise<void> {
if (this.stopped) {
const start = this.callStack.length;
const callStack = await this.getCallStackImpl(start, levels);
this.reachedEndOfCallStack = callStack.length < levels;
if (start < this.callStack.length) {
// Set the stack frames for exact position we requested. To make sure no concurrent requests create duplicate stack frames #30660
this.callStack.splice(start, this.callStack.length - start);
}
this.callStack = this.callStack.concat(callStack || []);
if (typeof this.stoppedDetails?.totalFrames === 'number' && this.stoppedDetails.totalFrames === this.callStack.length) {
this.reachedEndOfCallStack = true;
}
}
}
private async getCallStackImpl(startFrame: number, levels: number): Promise<IStackFrame[]> {
try {
const tokenSource = new CancellationTokenSource();
this.callStackCancellationTokens.push(tokenSource);
const response = await this.session.stackTrace(this.threadId, startFrame, levels, tokenSource.token);
if (!response || !response.body || tokenSource.token.isCancellationRequested) {
return [];
}
if (this.stoppedDetails) {
this.stoppedDetails.totalFrames = response.body.totalFrames;
}
return response.body.stackFrames.map((rsf, index) => {
const source = this.session.getSource(rsf.source);
return new StackFrame(this, rsf.id, source, rsf.name, rsf.presentationHint, new Range(
rsf.line,
rsf.column,
rsf.endLine || rsf.line,
rsf.endColumn || rsf.column
), startFrame + index, typeof rsf.canRestart === 'boolean' ? rsf.canRestart : true, rsf.instructionPointerReference);
});
} catch (err) {
if (this.stoppedDetails) {
this.stoppedDetails.framesErrorMessage = err.message;
}
return [];
}
}
/**
* Returns exception info promise if the exception was thrown, otherwise undefined
*/
get exceptionInfo(): Promise<IExceptionInfo | undefined> {
if (this.stoppedDetails && this.stoppedDetails.reason === 'exception') {
if (this.session.capabilities.supportsExceptionInfoRequest) {
return this.session.exceptionInfo(this.threadId);
}
return Promise.resolve({
description: this.stoppedDetails.text,
breakMode: null
});
}
return Promise.resolve(undefined);
}
next(granularity?: DebugProtocol.SteppingGranularity): Promise<any> {
return this.session.next(this.threadId, granularity);
}
stepIn(granularity?: DebugProtocol.SteppingGranularity): Promise<any> {
return this.session.stepIn(this.threadId, undefined, granularity);
}
stepOut(granularity?: DebugProtocol.SteppingGranularity): Promise<any> {
return this.session.stepOut(this.threadId, granularity);
}
stepBack(granularity?: DebugProtocol.SteppingGranularity): Promise<any> {
return this.session.stepBack(this.threadId, granularity);
}
continue(): Promise<any> {
return this.session.continue(this.threadId);
}
pause(): Promise<any> {
return this.session.pause(this.threadId);
}
terminate(): Promise<any> {
return this.session.terminateThreads([this.threadId]);
}
reverseContinue(): Promise<any> {
return this.session.reverseContinue(this.threadId);
}
}
/**
* Gets a URI to a memory in the given session ID.
*/
export const getUriForDebugMemory = (
sessionId: string,
memoryReference: string,
range?: { fromOffset: number; toOffset: number },
displayName = 'memory'
) => {
return URI.from({
scheme: DEBUG_MEMORY_SCHEME,
authority: sessionId,
path: '/' + encodeURIComponent(memoryReference) + `/${encodeURIComponent(displayName)}.bin`,
query: range ? `?range=${range.fromOffset}:${range.toOffset}` : undefined,
});
};
export class MemoryRegion extends Disposable implements IMemoryRegion {
private readonly invalidateEmitter = this._register(new Emitter<IMemoryInvalidationEvent>());
/** @inheritdoc */
public readonly onDidInvalidate = this.invalidateEmitter.event;
/** @inheritdoc */
public readonly writable = !!this.session.capabilities.supportsWriteMemoryRequest;
constructor(private readonly memoryReference: string, private readonly session: IDebugSession) {
super();
this._register(session.onDidInvalidateMemory(e => {
if (e.body.memoryReference === memoryReference) {
this.invalidate(e.body.offset, e.body.count - e.body.offset);
}
}));
}
public async read(fromOffset: number, toOffset: number): Promise<MemoryRange[]> {
const length = toOffset - fromOffset;
const offset = fromOffset;
const result = await this.session.readMemory(this.memoryReference, offset, length);
if (result === undefined || !result.body?.data) {
return [{ type: MemoryRangeType.Unreadable, offset, length }];
}
let data: VSBuffer;
try {
data = decodeBase64(result.body.data);
} catch {
return [{ type: MemoryRangeType.Error, offset, length, error: 'Invalid base64 data from debug adapter' }];
}
const unreadable = result.body.unreadableBytes || 0;
const dataLength = length - unreadable;
if (data.byteLength < dataLength) {
const pad = VSBuffer.alloc(dataLength - data.byteLength);
pad.buffer.fill(0);
data = VSBuffer.concat([data, pad], dataLength);
} else if (data.byteLength > dataLength) {
data = data.slice(0, dataLength);
}
if (!unreadable) {
return [{ type: MemoryRangeType.Valid, offset, length, data }];
}
return [
{ type: MemoryRangeType.Valid, offset, length: dataLength, data },
{ type: MemoryRangeType.Unreadable, offset: offset + dataLength, length: unreadable },
];
}
public async write(offset: number, data: VSBuffer): Promise<number> {
const result = await this.session.writeMemory(this.memoryReference, offset, encodeBase64(data), true);
const written = result?.body?.bytesWritten ?? data.byteLength;
this.invalidate(offset, offset + written);
return written;
}
public override dispose() {
super.dispose();
}
private invalidate(fromOffset: number, toOffset: number) {
this.invalidateEmitter.fire({ fromOffset, toOffset });
}
}
export class Enablement implements IEnablement {
constructor(
public enabled: boolean,
private readonly id: string
) { }
getId(): string {
return this.id;
}
}
interface IBreakpointSessionData extends DebugProtocol.Breakpoint {
supportsConditionalBreakpoints: boolean;
supportsHitConditionalBreakpoints: boolean;
supportsLogPoints: boolean;
supportsFunctionBreakpoints: boolean;
supportsDataBreakpoints: boolean;
supportsInstructionBreakpoints: boolean;
sessionId: string;
}
function toBreakpointSessionData(data: DebugProtocol.Breakpoint, capabilities: DebugProtocol.Capabilities): IBreakpointSessionData {
return mixin({
supportsConditionalBreakpoints: !!capabilities.supportsConditionalBreakpoints,
supportsHitConditionalBreakpoints: !!capabilities.supportsHitConditionalBreakpoints,
supportsLogPoints: !!capabilities.supportsLogPoints,
supportsFunctionBreakpoints: !!capabilities.supportsFunctionBreakpoints,
supportsDataBreakpoints: !!capabilities.supportsDataBreakpoints,
supportsInstructionBreakpoints: !!capabilities.supportsInstructionBreakpoints
}, data);
}
export abstract class BaseBreakpoint extends Enablement implements IBaseBreakpoint {
private sessionData = new Map<string, IBreakpointSessionData>();
protected data: IBreakpointSessionData | undefined;
constructor(
enabled: boolean,
public hitCondition: string | undefined,
public condition: string | undefined,
public logMessage: string | undefined,
id: string
) {
super(enabled, id);
if (enabled === undefined) {
this.enabled = true;
}
}
setSessionData(sessionId: string, data: IBreakpointSessionData | undefined): void {
if (!data) {
this.sessionData.delete(sessionId);
} else {
data.sessionId = sessionId;
this.sessionData.set(sessionId, data);
}
const allData = Array.from(this.sessionData.values());
const verifiedData = distinct(allData.filter(d => d.verified), d => `${d.line}:${d.column}`);
if (verifiedData.length) {
// In case multiple session verified the breakpoint and they provide different data show the intial data that the user set (corner case)
this.data = verifiedData.length === 1 ? verifiedData[0] : undefined;
} else {
// No session verified the breakpoint
this.data = allData.length ? allData[0] : undefined;
}
}
get message(): string | undefined {
if (!this.data) {
return undefined;
}
return this.data.message;
}
get verified(): boolean {
return this.data ? this.data.verified : true;
}
get sessionsThatVerified() {
const sessionIds: string[] = [];
for (const [sessionId, data] of this.sessionData) {
if (data.verified) {
sessionIds.push(sessionId);
}
}
return sessionIds;
}
abstract get supported(): boolean;
getIdFromAdapter(sessionId: string): number | undefined {
const data = this.sessionData.get(sessionId);
return data ? data.id : undefined;
}
getDebugProtocolBreakpoint(sessionId: string): DebugProtocol.Breakpoint | undefined {
const data = this.sessionData.get(sessionId);
if (data) {
const bp: DebugProtocol.Breakpoint = {
id: data.id,
verified: data.verified,
message: data.message,
source: data.source,
line: data.line,
column: data.column,
endLine: data.endLine,
endColumn: data.endColumn,
instructionReference: data.instructionReference,
offset: data.offset
};
return bp;
}
return undefined;
}
toJSON(): any {
const result = Object.create(null);
result.enabled = this.enabled;
result.condition = this.condition;
result.hitCondition = this.hitCondition;
result.logMessage = this.logMessage;
return result;
}
}
export class Breakpoint extends BaseBreakpoint implements IBreakpoint {
constructor(
private readonly _uri: uri,
private _lineNumber: number,
private _column: number | undefined,
enabled: boolean,
condition: string | undefined,
hitCondition: string | undefined,
logMessage: string | undefined,
private _adapterData: any,
private readonly textFileService: ITextFileService,
private readonly uriIdentityService: IUriIdentityService,
id = generateUuid()
) {
super(enabled, hitCondition, condition, logMessage, id);
}
get lineNumber(): number {
return this.verified && this.data && typeof this.data.line === 'number' ? this.data.line : this._lineNumber;
}
override get verified(): boolean {
if (this.data) {
return this.data.verified && !this.textFileService.isDirty(this._uri);
}
return true;
}
get uri(): uri {
return this.verified && this.data && this.data.source ? getUriFromSource(this.data.source, this.data.source.path, this.data.sessionId, this.uriIdentityService) : this._uri;
}
get column(): number | undefined {
return this.verified && this.data && typeof this.data.column === 'number' ? this.data.column : this._column;
}
override get message(): string | undefined {
if (this.textFileService.isDirty(this.uri)) {
return nls.localize('breakpointDirtydHover', "Unverified breakpoint. File is modified, please restart debug session.");
}
return super.message;
}
get adapterData(): any {
return this.data && this.data.source && this.data.source.adapterData ? this.data.source.adapterData : this._adapterData;
}
get endLineNumber(): number | undefined {
return this.verified && this.data ? this.data.endLine : undefined;
}
get endColumn(): number | undefined {
return this.verified && this.data ? this.data.endColumn : undefined;
}
get sessionAgnosticData(): { lineNumber: number; column: number | undefined } {
return {
lineNumber: this._lineNumber,
column: this._column
};
}
get supported(): boolean {
if (!this.data) {
return true;
}
if (this.logMessage && !this.data.supportsLogPoints) {
return false;
}
if (this.condition && !this.data.supportsConditionalBreakpoints) {
return false;
}
if (this.hitCondition && !this.data.supportsHitConditionalBreakpoints) {
return false;
}
return true;
}
override setSessionData(sessionId: string, data: IBreakpointSessionData | undefined): void {
super.setSessionData(sessionId, data);
if (!this._adapterData) {
this._adapterData = this.adapterData;
}
}
override toJSON(): any {
const result = super.toJSON();
result.uri = this._uri;
result.lineNumber = this._lineNumber;
result.column = this._column;
result.adapterData = this.adapterData;
return result;
}
override toString(): string {
return `${resources.basenameOrAuthority(this.uri)} ${this.lineNumber}`;
}
update(data: IBreakpointUpdateData): void {
if (!isUndefinedOrNull(data.lineNumber)) {
this._lineNumber = data.lineNumber;
}
if (!isUndefinedOrNull(data.column)) {
this._column = data.column;
}
if (!isUndefinedOrNull(data.condition)) {
this.condition = data.condition;
}
if (!isUndefinedOrNull(data.hitCondition)) {
this.hitCondition = data.hitCondition;
}
if (!isUndefinedOrNull(data.logMessage)) {
this.logMessage = data.logMessage;
}
}
}
export class FunctionBreakpoint extends BaseBreakpoint implements IFunctionBreakpoint {
constructor(
public name: string,
enabled: boolean,
hitCondition: string | undefined,
condition: string | undefined,
logMessage: string | undefined,
id = generateUuid()
) {
super(enabled, hitCondition, condition, logMessage, id);
}
override toJSON(): any {
const result = super.toJSON();
result.name = this.name;
return result;
}
get supported(): boolean {
if (!this.data) {
return true;
}
return this.data.supportsFunctionBreakpoints;
}
override toString(): string {
return this.name;
}
}
export class DataBreakpoint extends BaseBreakpoint implements IDataBreakpoint {
constructor(
public readonly description: string,
public readonly dataId: string,
public readonly canPersist: boolean,
enabled: boolean,
hitCondition: string | undefined,
condition: string | undefined,
logMessage: string | undefined,
public readonly accessTypes: DebugProtocol.DataBreakpointAccessType[] | undefined,
public readonly accessType: DebugProtocol.DataBreakpointAccessType,
id = generateUuid()
) {
super(enabled, hitCondition, condition, logMessage, id);
}
override toJSON(): any {
const result = super.toJSON();
result.description = this.description;
result.dataId = this.dataId;
result.accessTypes = this.accessTypes;
result.accessType = this.accessType;
return result;
}
get supported(): boolean {
if (!this.data) {
return true;
}
return this.data.supportsDataBreakpoints;
}
override toString(): string {
return this.description;
}
}
export class ExceptionBreakpoint extends BaseBreakpoint implements IExceptionBreakpoint {
constructor(
public readonly filter: string,
public readonly label: string,
enabled: boolean,
public readonly supportsCondition: boolean,
condition: string | undefined,
public readonly description: string | undefined,
public readonly conditionDescription: string | undefined
) {
super(enabled, undefined, condition, undefined, generateUuid());
}
override toJSON(): any {
const result = Object.create(null);
result.filter = this.filter;
result.label = this.label;
result.enabled = this.enabled;
result.supportsCondition = this.supportsCondition;
result.condition = this.condition;
return result;
}
get supported(): boolean {
return true;
}
override toString(): string {
return this.label;
}
}
export class InstructionBreakpoint extends BaseBreakpoint implements IInstructionBreakpoint {
constructor(
public readonly instructionReference: string,
public readonly offset: number,
public readonly canPersist: boolean,
enabled: boolean,
hitCondition: string | undefined,
condition: string | undefined,
logMessage: string | undefined,
id = generateUuid()
) {
super(enabled, hitCondition, condition, logMessage, id);
}
override toJSON(): any {
const result = super.toJSON();
result.instructionReference = this.instructionReference;
result.offset = this.offset;
return result;
}
get supported(): boolean {
if (!this.data) {
return true;
}
return this.data.supportsInstructionBreakpoints;
}
override toString(): string {
return this.instructionReference;
}
}
export class ThreadAndSessionIds implements ITreeElement {
constructor(public sessionId: string, public threadId: number) { }
getId(): string {
return `${this.sessionId}:${this.threadId}`;
}
}
export class Memory {
}
export class DebugModel implements IDebugModel {
private sessions: IDebugSession[];
private schedulers = new Map<string, RunOnceScheduler>();
private breakpointsActivated = true;
private readonly _onDidChangeBreakpoints = new Emitter<IBreakpointsChangeEvent | undefined>();
private readonly _onDidChangeCallStack = new Emitter<void>();
private readonly _onDidChangeWatchExpressions = new Emitter<IExpression | undefined>();
private breakpoints: Breakpoint[];
private functionBreakpoints: FunctionBreakpoint[];
private exceptionBreakpoints: ExceptionBreakpoint[];
private dataBreakpoints: DataBreakpoint[];
private watchExpressions: Expression[];
private instructionBreakpoints: InstructionBreakpoint[];
constructor(
debugStorage: DebugStorage,
@ITextFileService private readonly textFileService: ITextFileService,
@IUriIdentityService private readonly uriIdentityService: IUriIdentityService
) {
this.breakpoints = debugStorage.loadBreakpoints();
this.functionBreakpoints = debugStorage.loadFunctionBreakpoints();
this.exceptionBreakpoints = debugStorage.loadExceptionBreakpoints();
this.dataBreakpoints = debugStorage.loadDataBreakpoints();
this.watchExpressions = debugStorage.loadWatchExpressions();
this.instructionBreakpoints = [];
this.sessions = [];
}
getId(): string {
return 'root';
}
getSession(sessionId: string | undefined, includeInactive = false): IDebugSession | undefined {
if (sessionId) {
return this.getSessions(includeInactive).find(s => s.getId() === sessionId);
}
return undefined;
}
getSessions(includeInactive = false): IDebugSession[] {
// By default do not return inactive sessions.
// However we are still holding onto inactive sessions due to repl and debug service session revival (eh scenario)
return this.sessions.filter(s => includeInactive || s.state !== State.Inactive);
}
addSession(session: IDebugSession): void {
this.sessions = this.sessions.filter(s => {
if (s.getId() === session.getId()) {
// Make sure to de-dupe if a session is re-initialized. In case of EH debugging we are adding a session again after an attach.
return false;
}
if (s.state === State.Inactive && s.configuration.name === session.configuration.name) {
// Make sure to remove all inactive sessions that are using the same configuration as the new session
return false;
}
return true;
});
let i = 1;
while (this.sessions.some(s => s.getLabel() === session.getLabel())) {
session.setName(`${session.configuration.name} ${++i}`);
}
let index = -1;
if (session.parentSession) {
// Make sure that child sessions are placed after the parent session
index = lastIndex(this.sessions, s => s.parentSession === session.parentSession || s === session.parentSession);
}
if (index >= 0) {
this.sessions.splice(index + 1, 0, session);
} else {
this.sessions.push(session);
}
this._onDidChangeCallStack.fire(undefined);
}
get onDidChangeBreakpoints(): Event<IBreakpointsChangeEvent | undefined> {
return this._onDidChangeBreakpoints.event;
}
get onDidChangeCallStack(): Event<void> {
return this._onDidChangeCallStack.event;
}
get onDidChangeWatchExpressions(): Event<IExpression | undefined> {
return this._onDidChangeWatchExpressions.event;
}
rawUpdate(data: IRawModelUpdate): void {
const session = this.sessions.find(p => p.getId() === data.sessionId);
if (session) {
session.rawUpdate(data);
this._onDidChangeCallStack.fire(undefined);
}
}
clearThreads(id: string, removeThreads: boolean, reference: number | undefined = undefined): void {
const session = this.sessions.find(p => p.getId() === id);
this.schedulers.forEach(scheduler => scheduler.dispose());
this.schedulers.clear();
if (session) {
session.clearThreads(removeThreads, reference);
this._onDidChangeCallStack.fire(undefined);
}
}
fetchCallStack(thread: Thread): { topCallStack: Promise<void>; wholeCallStack: Promise<void> } {
if (thread.session.capabilities.supportsDelayedStackTraceLoading) {
// For improved performance load the first stack frame and then load the rest async.
let topCallStack = Promise.resolve();
const wholeCallStack = new Promise<void>((c, e) => {
topCallStack = thread.fetchCallStack(1).then(() => {
if (!this.schedulers.has(thread.getId())) {
this.schedulers.set(thread.getId(), new RunOnceScheduler(() => {
thread.fetchCallStack(19).then(() => {
const stale = thread.getStaleCallStack();
const current = thread.getCallStack();
let bottomOfCallStackChanged = stale.length !== current.length;
for (let i = 1; i < stale.length && !bottomOfCallStackChanged; i++) {
bottomOfCallStackChanged = !stale[i].equals(current[i]);
}
if (bottomOfCallStackChanged) {
this._onDidChangeCallStack.fire();
}
c();
});
}, 420));
}
this.schedulers.get(thread.getId())!.schedule();
this._onDidChangeCallStack.fire();
});
});
return { topCallStack, wholeCallStack };
}
const wholeCallStack = thread.fetchCallStack();
return { wholeCallStack, topCallStack: wholeCallStack };
}
getBreakpoints(filter?: { uri?: uri; lineNumber?: number; column?: number; enabledOnly?: boolean }): IBreakpoint[] {
if (filter) {
const uriStr = filter.uri ? filter.uri.toString() : undefined;
return this.breakpoints.filter(bp => {
if (uriStr && bp.uri.toString() !== uriStr) {
return false;
}
if (filter.lineNumber && bp.lineNumber !== filter.lineNumber) {
return false;
}
if (filter.column && bp.column !== filter.column) {
return false;
}
if (filter.enabledOnly && (!this.breakpointsActivated || !bp.enabled)) {
return false;
}
return true;
});
}
return this.breakpoints;
}
getFunctionBreakpoints(): IFunctionBreakpoint[] {
return this.functionBreakpoints;
}
getDataBreakpoints(): IDataBreakpoint[] {
return this.dataBreakpoints;
}
getExceptionBreakpoints(): IExceptionBreakpoint[] {
return this.exceptionBreakpoints;
}
getInstructionBreakpoints(): IInstructionBreakpoint[] {
return this.instructionBreakpoints;
}
setExceptionBreakpoints(data: DebugProtocol.ExceptionBreakpointsFilter[]): void {
if (data) {
if (this.exceptionBreakpoints.length === data.length && this.exceptionBreakpoints.every((exbp, i) =>
exbp.filter === data[i].filter && exbp.label === data[i].label && exbp.supportsCondition === data[i].supportsCondition && exbp.conditionDescription === data[i].conditionDescription && exbp.description === data[i].description)) {
// No change
return;
}
this.exceptionBreakpoints = data.map(d => {
const ebp = this.exceptionBreakpoints.filter(ebp => ebp.filter === d.filter).pop();
return new ExceptionBreakpoint(d.filter, d.label, ebp ? ebp.enabled : !!d.default, !!d.supportsCondition, ebp?.condition, d.description, d.conditionDescription);
});
this._onDidChangeBreakpoints.fire(undefined);
}
}
setExceptionBreakpointCondition(exceptionBreakpoint: IExceptionBreakpoint, condition: string | undefined): void {
(exceptionBreakpoint as ExceptionBreakpoint).condition = condition;
this._onDidChangeBreakpoints.fire(undefined);
}
areBreakpointsActivated(): boolean {
return this.breakpointsActivated;
}
setBreakpointsActivated(activated: boolean): void {
this.breakpointsActivated = activated;
this._onDidChangeBreakpoints.fire(undefined);
}
addBreakpoints(uri: uri, rawData: IBreakpointData[], fireEvent = true): IBreakpoint[] {
const newBreakpoints = rawData.map(rawBp => new Breakpoint(uri, rawBp.lineNumber, rawBp.column, rawBp.enabled === false ? false : true, rawBp.condition, rawBp.hitCondition, rawBp.logMessage, undefined, this.textFileService, this.uriIdentityService, rawBp.id));
this.breakpoints = this.breakpoints.concat(newBreakpoints);
this.breakpointsActivated = true;
this.sortAndDeDup();
if (fireEvent) {
this._onDidChangeBreakpoints.fire({ added: newBreakpoints, sessionOnly: false });
}
return newBreakpoints;
}
removeBreakpoints(toRemove: IBreakpoint[]): void {
this.breakpoints = this.breakpoints.filter(bp => !toRemove.some(toRemove => toRemove.getId() === bp.getId()));
this._onDidChangeBreakpoints.fire({ removed: toRemove, sessionOnly: false });
}
updateBreakpoints(data: Map<string, IBreakpointUpdateData>): void {
const updated: IBreakpoint[] = [];
this.breakpoints.forEach(bp => {
const bpData = data.get(bp.getId());
if (bpData) {
bp.update(bpData);
updated.push(bp);
}
});
this.sortAndDeDup();
this._onDidChangeBreakpoints.fire({ changed: updated, sessionOnly: false });
}
setBreakpointSessionData(sessionId: string, capabilites: DebugProtocol.Capabilities, data: Map<string, DebugProtocol.Breakpoint> | undefined): void {
this.breakpoints.forEach(bp => {
if (!data) {
bp.setSessionData(sessionId, undefined);
} else {
const bpData = data.get(bp.getId());
if (bpData) {
bp.setSessionData(sessionId, toBreakpointSessionData(bpData, capabilites));
}
}
});
this.functionBreakpoints.forEach(fbp => {
if (!data) {
fbp.setSessionData(sessionId, undefined);
} else {
const fbpData = data.get(fbp.getId());
if (fbpData) {
fbp.setSessionData(sessionId, toBreakpointSessionData(fbpData, capabilites));
}
}
});
this.dataBreakpoints.forEach(dbp => {
if (!data) {
dbp.setSessionData(sessionId, undefined);
} else {
const dbpData = data.get(dbp.getId());
if (dbpData) {
dbp.setSessionData(sessionId, toBreakpointSessionData(dbpData, capabilites));
}
}
});
this.exceptionBreakpoints.forEach(ebp => {
if (!data) {
ebp.setSessionData(sessionId, undefined);
} else {
const ebpData = data.get(ebp.getId());
if (ebpData) {
ebp.setSessionData(sessionId, toBreakpointSessionData(ebpData, capabilites));
}
}
});
this.instructionBreakpoints.forEach(ibp => {
if (!data) {
ibp.setSessionData(sessionId, undefined);
} else {
const ibpData = data.get(ibp.getId());
if (ibpData) {
ibp.setSessionData(sessionId, toBreakpointSessionData(ibpData, capabilites));
}
}
});
this._onDidChangeBreakpoints.fire({
sessionOnly: true
});
}
getDebugProtocolBreakpoint(breakpointId: string, sessionId: string): DebugProtocol.Breakpoint | undefined {
const bp = this.breakpoints.find(bp => bp.getId() === breakpointId);
if (bp) {
return bp.getDebugProtocolBreakpoint(sessionId);
}
return undefined;
}
private sortAndDeDup(): void {
this.breakpoints = this.breakpoints.sort((first, second) => {
if (first.uri.toString() !== second.uri.toString()) {
return resources.basenameOrAuthority(first.uri).localeCompare(resources.basenameOrAuthority(second.uri));
}
if (first.lineNumber === second.lineNumber) {
if (first.column && second.column) {
return first.column - second.column;
}
return 1;
}
return first.lineNumber - second.lineNumber;
});
this.breakpoints = distinct(this.breakpoints, bp => `${bp.uri.toString()}:${bp.lineNumber}:${bp.column}`);
}
setEnablement(element: IEnablement, enable: boolean): void {
if (element instanceof Breakpoint || element instanceof FunctionBreakpoint || element instanceof ExceptionBreakpoint || element instanceof DataBreakpoint || element instanceof InstructionBreakpoint) {
const changed: Array<IBreakpoint | IFunctionBreakpoint | IDataBreakpoint | IInstructionBreakpoint> = [];
if (element.enabled !== enable && (element instanceof Breakpoint || element instanceof FunctionBreakpoint || element instanceof DataBreakpoint || element instanceof InstructionBreakpoint)) {
changed.push(element);
}
element.enabled = enable;
if (enable) {
this.breakpointsActivated = true;
}
this._onDidChangeBreakpoints.fire({ changed: changed, sessionOnly: false });
}
}
enableOrDisableAllBreakpoints(enable: boolean): void {
const changed: Array<IBreakpoint | IFunctionBreakpoint | IDataBreakpoint | IInstructionBreakpoint> = [];
this.breakpoints.forEach(bp => {
if (bp.enabled !== enable) {
changed.push(bp);
}
bp.enabled = enable;
});
this.functionBreakpoints.forEach(fbp => {
if (fbp.enabled !== enable) {
changed.push(fbp);
}
fbp.enabled = enable;
});
this.dataBreakpoints.forEach(dbp => {
if (dbp.enabled !== enable) {
changed.push(dbp);
}
dbp.enabled = enable;
});
this.instructionBreakpoints.forEach(ibp => {
if (ibp.enabled !== enable) {
changed.push(ibp);
}
ibp.enabled = enable;
});
if (enable) {
this.breakpointsActivated = true;
}
this._onDidChangeBreakpoints.fire({ changed: changed, sessionOnly: false });
}
addFunctionBreakpoint(functionName: string, id?: string): IFunctionBreakpoint {
const newFunctionBreakpoint = new FunctionBreakpoint(functionName, true, undefined, undefined, undefined, id);
this.functionBreakpoints.push(newFunctionBreakpoint);
this._onDidChangeBreakpoints.fire({ added: [newFunctionBreakpoint], sessionOnly: false });
return newFunctionBreakpoint;
}
updateFunctionBreakpoint(id: string, update: { name?: string; hitCondition?: string; condition?: string }): void {
const functionBreakpoint = this.functionBreakpoints.find(fbp => fbp.getId() === id);
if (functionBreakpoint) {
if (typeof update.name === 'string') {
functionBreakpoint.name = update.name;
}
if (typeof update.condition === 'string') {
functionBreakpoint.condition = update.condition;
}
if (typeof update.hitCondition === 'string') {
functionBreakpoint.hitCondition = update.hitCondition;
}
this._onDidChangeBreakpoints.fire({ changed: [functionBreakpoint], sessionOnly: false });
}
}
removeFunctionBreakpoints(id?: string): void {
let removed: FunctionBreakpoint[];
if (id) {
removed = this.functionBreakpoints.filter(fbp => fbp.getId() === id);
this.functionBreakpoints = this.functionBreakpoints.filter(fbp => fbp.getId() !== id);
} else {
removed = this.functionBreakpoints;
this.functionBreakpoints = [];
}
this._onDidChangeBreakpoints.fire({ removed, sessionOnly: false });
}
addDataBreakpoint(label: string, dataId: string, canPersist: boolean, accessTypes: DebugProtocol.DataBreakpointAccessType[] | undefined, accessType: DebugProtocol.DataBreakpointAccessType): void {
const newDataBreakpoint = new DataBreakpoint(label, dataId, canPersist, true, undefined, undefined, undefined, accessTypes, accessType);
this.dataBreakpoints.push(newDataBreakpoint);
this._onDidChangeBreakpoints.fire({ added: [newDataBreakpoint], sessionOnly: false });
}
removeDataBreakpoints(id?: string): void {
let removed: DataBreakpoint[];
if (id) {
removed = this.dataBreakpoints.filter(fbp => fbp.getId() === id);
this.dataBreakpoints = this.dataBreakpoints.filter(fbp => fbp.getId() !== id);
} else {
removed = this.dataBreakpoints;
this.dataBreakpoints = [];
}
this._onDidChangeBreakpoints.fire({ removed, sessionOnly: false });
}
addInstructionBreakpoint(address: string, offset: number, condition?: string, hitCondition?: string): void {
const newInstructionBreakpoint = new InstructionBreakpoint(address, offset, false, true, hitCondition, condition, undefined);
this.instructionBreakpoints.push(newInstructionBreakpoint);
this._onDidChangeBreakpoints.fire({ added: [newInstructionBreakpoint], sessionOnly: true });
}
removeInstructionBreakpoints(address?: string): void {
let removed: InstructionBreakpoint[];
if (address) {
removed = this.instructionBreakpoints.filter(fbp => fbp.instructionReference === address);
this.instructionBreakpoints = this.instructionBreakpoints.filter(fbp => fbp.instructionReference !== address);
} else {
removed = this.instructionBreakpoints;
this.instructionBreakpoints = [];
}
this._onDidChangeBreakpoints.fire({ removed, sessionOnly: false });
}
getWatchExpressions(): Expression[] {
return this.watchExpressions;
}
addWatchExpression(name?: string): IExpression {
const we = new Expression(name || '');
this.watchExpressions.push(we);
this._onDidChangeWatchExpressions.fire(we);
return we;
}
renameWatchExpression(id: string, newName: string): void {
const filtered = this.watchExpressions.filter(we => we.getId() === id);
if (filtered.length === 1) {
filtered[0].name = newName;
this._onDidChangeWatchExpressions.fire(filtered[0]);
}
}
removeWatchExpressions(id: string | null = null): void {
this.watchExpressions = id ? this.watchExpressions.filter(we => we.getId() !== id) : [];
this._onDidChangeWatchExpressions.fire(undefined);
}
moveWatchExpression(id: string, position: number): void {
const we = this.watchExpressions.find(we => we.getId() === id);
if (we) {
this.watchExpressions = this.watchExpressions.filter(we => we.getId() !== id);
this.watchExpressions = this.watchExpressions.slice(0, position).concat(we, this.watchExpressions.slice(position));
this._onDidChangeWatchExpressions.fire(undefined);
}
}
sourceIsNotAvailable(uri: uri): void {
this.sessions.forEach(s => {
const source = s.getSourceForUri(uri);
if (source) {
source.available = false;
}
});
this._onDidChangeCallStack.fire(undefined);
}
}
|