debug-adapter-protocol 0.1.0

A Rust implementation of the Debug Adapter Protocol
Documentation
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
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
use crate::utils::eq_default;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;
use typed_builder::TypedBuilder;

/// Information about a Breakpoint created in setBreakpoints, setFunctionBreakpoints, setInstructionBreakpoints, or setDataBreakpoints.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Breakpoint {
    /// An optional identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints.
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub id: Option<i32>,

    /// If true breakpoint could be set (but not necessarily at the desired location).
    #[serde(rename = "verified")]
    pub verified: bool,

    /// An optional message about the state of the breakpoint.
    ///
    /// This is shown to the user and can be used to explain why a breakpoint could not be verified.
    #[serde(rename = "message", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub message: Option<String>,

    /// The source where the breakpoint is located.
    #[serde(rename = "source", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub source: Option<Source>,

    /// The start line of the actual range covered by the breakpoint.
    #[serde(rename = "line", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub line: Option<i32>,

    /// An optional start column of the actual range covered by the breakpoint.
    #[serde(rename = "column", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub column: Option<i32>,

    /// An optional end line of the actual range covered by the breakpoint.
    #[serde(rename = "endLine", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_line: Option<i32>,

    /// An optional end column of the actual range covered by the breakpoint.
    ///
    /// If no end line is given, then the end column is assumed to be in the start line.
    #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_column: Option<i32>,

    /// An optional memory reference to where the breakpoint is set.
    #[serde(
        rename = "instructionReference",
        skip_serializing_if = "Option::is_none"
    )]
    #[builder(default)]
    pub instruction_reference: Option<String>,

    /// An optional offset from the instruction reference.
    ///
    /// This can be negative.
    #[serde(rename = "offset", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub offset: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Properties of a breakpoint location returned from the 'breakpointLocations' request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct BreakpointLocation {
    /// Start line of breakpoint location.
    #[serde(rename = "line")]
    pub line: i32,

    /// Optional start column of breakpoint location.
    #[serde(rename = "column", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub column: Option<i32>,

    /// Optional end line of breakpoint location if the location covers a range.
    #[serde(rename = "endLine", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_line: Option<i32>,

    /// Optional end column of breakpoint location if the location covers a range.
    #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_column: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Information about the capabilities of a debug adapter.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Capabilities {
    /// The debug adapter supports the 'configurationDone' request.
    #[serde(
        rename = "supportsConfigurationDoneRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_configuration_done_request: bool,

    /// The debug adapter supports function breakpoints.
    #[serde(
        rename = "supportsFunctionBreakpoints",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_function_breakpoints: bool,

    /// The debug adapter supports conditional breakpoints.
    #[serde(
        rename = "supportsConditionalBreakpoints",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_conditional_breakpoints: bool,

    /// The debug adapter supports breakpoints that break execution after a specified number of hits.
    #[serde(
        rename = "supportsHitConditionalBreakpoints",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_hit_conditional_breakpoints: bool,

    /// The debug adapter supports a (side effect free) evaluate request for data hovers.
    #[serde(
        rename = "supportsEvaluateForHovers",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_evaluate_for_hovers: bool,

    /// Available exception filter options for the 'setExceptionBreakpoints' request.
    #[serde(
        rename = "exceptionBreakpointFilters",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    #[builder(default)]
    pub exception_breakpoint_filters: Vec<ExceptionBreakpointsFilter>,

    /// The debug adapter supports stepping back via the 'stepBack' and 'reverseContinue' requests.
    #[serde(
        rename = "supportsStepBack",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_step_back: bool,

    /// The debug adapter supports setting a variable to a value.
    #[serde(
        rename = "supportsSetVariable",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_set_variable: bool,

    /// The debug adapter supports restarting a frame.
    #[serde(
        rename = "supportsRestartFrame",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_restart_frame: bool,

    /// The debug adapter supports the 'gotoTargets' request.
    #[serde(
        rename = "supportsGotoTargetsRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_goto_targets_request: bool,

    /// The debug adapter supports the 'stepInTargets' request.
    #[serde(
        rename = "supportsStepInTargetsRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_step_in_targets_request: bool,

    /// The debug adapter supports the 'completions' request.
    #[serde(
        rename = "supportsCompletionsRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_completions_request: bool,

    /// The set of characters that should trigger completion in a REPL. If not specified, the UI should assume the '.' character.
    #[serde(
        rename = "completionTriggerCharacters",
        skip_serializing_if = "Option::is_none"
    )]
    #[builder(default)]
    pub completion_trigger_characters: Option<Vec<String>>,

    /// The debug adapter supports the 'modules' request.
    #[serde(
        rename = "supportsModulesRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_modules_request: bool,

    /// The set of additional module information exposed by the debug adapter.
    #[serde(
        rename = "additionalModuleColumns",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    #[builder(default)]
    pub additional_module_columns: Vec<ColumnDescriptor>,

    /// Checksum algorithms supported by the debug adapter.
    #[serde(
        rename = "supportedChecksumAlgorithms",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    #[builder(default)]
    pub supported_checksum_algorithms: Vec<ChecksumAlgorithm>,

    /// The debug adapter supports the 'restart' request. In this case a client should not implement 'restart' by terminating and relaunching the adapter but by calling the RestartRequest.
    #[serde(
        rename = "supportsRestartRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_restart_request: bool,

    /// The debug adapter supports 'exceptionOptions' on the setExceptionBreakpoints request.
    #[serde(
        rename = "supportsExceptionOptions",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_exception_options: bool,

    /// The debug adapter supports a 'format' attribute on the stackTraceRequest, variablesRequest, and evaluateRequest.
    #[serde(
        rename = "supportsValueFormattingOptions",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_value_formatting_options: bool,

    /// The debug adapter supports the 'exceptionInfo' request.
    #[serde(
        rename = "supportsExceptionInfoRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_exception_info_request: bool,

    /// The debug adapter supports the 'terminateDebuggee' attribute on the 'disconnect' request.
    #[serde(
        rename = "supportTerminateDebuggee",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub support_terminate_debuggee: bool,

    /// The debug adapter supports the 'suspendDebuggee' attribute on the 'disconnect' request.
    #[serde(
        rename = "supportSuspendDebuggee",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub support_suspend_debuggee: bool,

    /// The debug adapter supports the delayed loading of parts of the stack, which requires that both the 'startFrame' and 'levels' arguments and an optional 'totalFrames' result of the 'StackTrace' request are supported.
    #[serde(
        rename = "supportsDelayedStackTraceLoading",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_delayed_stack_trace_loading: bool,

    /// The debug adapter supports the 'loadedSources' request.
    #[serde(
        rename = "supportsLoadedSourcesRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_loaded_sources_request: bool,

    /// The debug adapter supports logpoints by interpreting the 'logMessage' attribute of the SourceBreakpoint.
    #[serde(
        rename = "supportsLogPoints",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_log_points: bool,

    /// The debug adapter supports the 'terminateThreads' request.
    #[serde(
        rename = "supportsTerminateThreadsRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_terminate_threads_request: bool,

    /// The debug adapter supports the 'setExpression' request.
    #[serde(
        rename = "supportsSetExpression",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_set_expression: bool,

    /// The debug adapter supports the 'terminate' request.
    #[serde(
        rename = "supportsTerminateRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_terminate_request: bool,

    /// The debug adapter supports data breakpoints.
    #[serde(
        rename = "supportsDataBreakpoints",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_data_breakpoints: bool,

    /// The debug adapter supports the 'readMemory' request.
    #[serde(
        rename = "supportsReadMemoryRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_read_memory_request: bool,

    /// The debug adapter supports the 'disassemble' request.
    #[serde(
        rename = "supportsDisassembleRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_disassemble_request: bool,

    /// The debug adapter supports the 'cancel' request.
    #[serde(
        rename = "supportsCancelRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_cancel_request: bool,

    /// The debug adapter supports the 'breakpointLocations' request.
    #[serde(
        rename = "supportsBreakpointLocationsRequest",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_breakpoint_locations_request: bool,

    /// The debug adapter supports the 'clipboard' context value in the 'evaluate' request.
    #[serde(
        rename = "supportsClipboardContext",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_clipboard_context: bool,

    /// The debug adapter supports stepping granularities (argument 'granularity') for the stepping requests.
    #[serde(
        rename = "supportsSteppingGranularity",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_stepping_granularity: bool,

    /// The debug adapter supports adding breakpoints based on instruction references.
    #[serde(
        rename = "supportsInstructionBreakpoints",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_instruction_breakpoints: bool,

    /// The debug adapter supports 'filterOptions' as an argument on the 'setExceptionBreakpoints' request.
    #[serde(
        rename = "supportsExceptionFilterOptions",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_exception_filter_options: bool,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// The checksum of an item calculated by the specified algorithm.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Checksum {
    /// The algorithm used to calculate this checksum.
    #[serde(rename = "algorithm")]
    pub algorithm: ChecksumAlgorithm,

    /// Value of the checksum.
    #[serde(rename = "checksum")]
    pub checksum: String,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Names of checksum algorithms that may be supported by a debug adapter.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum ChecksumAlgorithm {
    #[serde(rename = "MD5")]
    MD5,

    #[serde(rename = "SHA1")]
    SHA1,

    #[serde(rename = "SHA256")]
    SHA256,

    #[serde(rename = "timestamp")]
    Timestamp,
}

/// A ColumnDescriptor specifies what module attribute to show in a column of the ModulesView, how to format it,
///
/// and what the column's label should be.
///
/// It is only used if the underlying UI actually supports this level of customization.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ColumnDescriptor {
    /// Name of the attribute rendered in this column.
    #[serde(rename = "attributeName")]
    pub attribute_name: String,

    /// Header UI label of column.
    #[serde(rename = "label")]
    pub label: String,

    /// Format to use for the rendered values in this column. TBD how the format strings looks like.
    #[serde(rename = "format", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub format: Option<String>,

    /// Datatype of values in this column.  Defaults to 'string' if not specified.
    #[serde(rename = "type", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub type_: ColumnDescriptorType,

    /// Width of this column in characters (hint only).
    #[serde(rename = "width", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub width: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum ColumnDescriptorType {
    #[serde(rename = "string")]
    String,

    #[serde(rename = "number")]
    Number,

    #[serde(rename = "boolean")]
    Boolean,

    #[serde(rename = "unixTimestampUTC")]
    UnixTimestampUTC,
}

impl Default for ColumnDescriptorType {
    fn default() -> Self {
        ColumnDescriptorType::String
    }
}

/// CompletionItems are the suggestions returned from the CompletionsRequest.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct CompletionItem {
    /// The label of this completion item. By default this is also the text that is inserted when selecting this completion.
    #[serde(rename = "label")]
    pub label: String,

    /// If text is not falsy then it is inserted instead of the label.
    #[serde(rename = "text", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub text: Option<String>,

    /// A string that should be used when comparing this item with other items. When `falsy` the label is used.
    #[serde(rename = "sortText", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub sort_text: Option<String>,

    /// The item's type. Typically the client uses this information to render the item in the UI with an icon.
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub type_: Option<CompletionItemType>,

    /// This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.
    ///
    /// If missing the text is added at the location specified by the CompletionsRequest's 'column' attribute.
    #[serde(rename = "start", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub start: Option<i32>,

    /// This value determines how many characters are overwritten by the completion text.
    ///
    /// If missing the value 0 is assumed which results in the completion text being inserted.
    #[serde(rename = "length", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub length: i32,

    /// Determines the start of the new selection after the text has been inserted (or replaced).
    ///
    /// The start position must in the range 0 and length of the completion text.
    ///
    /// If omitted the selection starts at the end of the completion text.
    #[serde(rename = "selectionStart", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub selection_start: Option<i32>,

    /// Determines the length of the new selection after the text has been inserted (or replaced).
    ///
    /// The selection can not extend beyond the bounds of the completion text.
    ///
    /// If omitted the length is assumed to be 0.
    #[serde(
        rename = "selectionLength",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub selection_length: i32,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Some predefined types for the CompletionItem. Please note that not all clients have specific icons for all of them.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum CompletionItemType {
    #[serde(rename = "method")]
    Method,

    #[serde(rename = "function")]
    Function,

    #[serde(rename = "constructor")]
    Constructor,

    #[serde(rename = "field")]
    Field,

    #[serde(rename = "variable")]
    Variable,

    #[serde(rename = "class")]
    Class,

    #[serde(rename = "interface")]
    Interface,

    #[serde(rename = "module")]
    Module,

    #[serde(rename = "property")]
    Property,

    #[serde(rename = "unit")]
    Unit,

    #[serde(rename = "value")]
    Value,

    #[serde(rename = "enum")]
    Enum,

    #[serde(rename = "keyword")]
    Keyword,

    #[serde(rename = "snippet")]
    Snippet,

    #[serde(rename = "text")]
    Text,

    #[serde(rename = "color")]
    Color,

    #[serde(rename = "file")]
    File,

    #[serde(rename = "reference")]
    Reference,

    #[serde(rename = "customcolor")]
    Customcolor,
}

/// Properties of a data breakpoint passed to the setDataBreakpoints request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct DataBreakpoint {
    /// An id representing the data. This id is returned from the dataBreakpointInfo request.
    #[serde(rename = "dataId")]
    pub data_id: String,

    /// The access type of the data.
    #[serde(rename = "accessType", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub access_type: Option<DataBreakpointAccessType>,

    /// An optional expression for conditional breakpoints.
    #[serde(rename = "condition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub condition: Option<String>,

    /// An optional expression that controls how many hits of the breakpoint are ignored.
    ///
    /// The backend is expected to interpret the expression as needed.
    #[serde(rename = "hitCondition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub hit_condition: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// This enumeration defines all possible access types for data breakpoints.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum DataBreakpointAccessType {
    #[serde(rename = "read")]
    Read,

    #[serde(rename = "write")]
    Write,

    #[serde(rename = "readWrite")]
    ReadWrite,
}

/// Represents a single disassembled instruction.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct DisassembledInstruction {
    /// The address of the instruction. Treated as a hex value if prefixed with '0x', or as a decimal value otherwise.
    #[serde(rename = "address")]
    pub address: String,

    /// Optional raw bytes representing the instruction and its operands, in an implementation-defined format.
    #[serde(rename = "instructionBytes", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub instruction_bytes: Option<String>,

    /// Text representing the instruction and its operands, in an implementation-defined format.
    #[serde(rename = "instruction")]
    pub instruction: String,

    /// Name of the symbol that corresponds with the location of this instruction, if any.
    #[serde(rename = "symbol", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub symbol: Option<String>,

    /// Source location that corresponds to this instruction, if any.
    ///
    /// Should always be set (if available) on the first instruction returned,
    ///
    /// but can be omitted afterwards if this instruction maps to the same source file as the previous instruction.
    #[serde(rename = "location", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub location: Option<Source>,

    /// The line within the source location that corresponds to this instruction, if any.
    #[serde(rename = "line", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub line: Option<i32>,

    /// The column within the line that corresponds to this instruction, if any.
    #[serde(rename = "column", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub column: Option<i32>,

    /// The end line of the range that corresponds to this instruction, if any.
    #[serde(rename = "endLine", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_line: Option<i32>,

    /// The end column of the range that corresponds to this instruction, if any.
    #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_column: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// This enumeration defines all possible conditions when a thrown exception should result in a break.
///
/// never: never breaks,
///
/// always: always breaks,
///
/// unhandled: breaks when exception unhandled,
///
/// userUnhandled: breaks if the exception is not handled by user code.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum ExceptionBreakMode {
    #[serde(rename = "never")]
    Never,

    #[serde(rename = "always")]
    Always,

    #[serde(rename = "unhandled")]
    Unhandled,

    #[serde(rename = "userUnhandled")]
    UserUnhandled,
}

/// An ExceptionBreakpointsFilter is shown in the UI as an filter option for configuring how exceptions are dealt with.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ExceptionBreakpointsFilter {
    /// The internal ID of the filter option. This value is passed to the 'setExceptionBreakpoints' request.
    #[serde(rename = "filter")]
    pub filter: String,

    /// The name of the filter option. This will be shown in the UI.
    #[serde(rename = "label")]
    pub label: String,

    /// An optional help text providing additional information about the exception filter. This string is typically shown as a hover and must be translated.
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub description: Option<String>,

    /// Initial value of the filter option. If not specified a value 'false' is assumed.
    #[serde(rename = "default", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub default: bool,

    /// Controls whether a condition can be specified for this filter option. If false or missing, a condition can not be set.
    #[serde(
        rename = "supportsCondition",
        default,
        skip_serializing_if = "eq_default"
    )]
    #[builder(default)]
    pub supports_condition: bool,

    /// An optional help text providing information about the condition. This string is shown as the placeholder text for a text box and must be translated.
    #[serde(
        rename = "conditionDescription",
        skip_serializing_if = "Option::is_none"
    )]
    #[builder(default)]
    pub condition_description: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Detailed information about an exception that has occurred.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ExceptionDetails {
    /// Message contained in the exception.
    #[serde(rename = "message", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub message: Option<String>,

    /// Short type name of the exception object.
    #[serde(rename = "typeName", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub type_name: Option<String>,

    /// Fully-qualified type name of the exception object.
    #[serde(rename = "fullTypeName", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub full_type_name: Option<String>,

    /// Optional expression that can be evaluated in the current scope to obtain the exception object.
    #[serde(rename = "evaluateName", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub evaluate_name: Option<String>,

    /// Stack trace at the time the exception was thrown.
    #[serde(rename = "stackTrace", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub stack_trace: Option<String>,

    /// Details of the exception contained by this exception, if any.
    #[serde(
        rename = "innerException",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    #[builder(default)]
    pub inner_exception: Vec<ExceptionDetails>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// An ExceptionFilterOptions is used to specify an exception filter together with a condition for the setExceptionsFilter request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ExceptionFilterOptions {
    /// ID of an exception filter returned by the 'exceptionBreakpointFilters' capability.
    #[serde(rename = "filterId")]
    pub filter_id: String,

    /// An optional expression for conditional exceptions.
    ///
    /// The exception will break into the debugger if the result of the condition is true.
    #[serde(rename = "condition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub condition: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// An ExceptionOptions assigns configuration options to a set of exceptions.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ExceptionOptions {
    /// A path that selects a single or multiple exceptions in a tree. If 'path' is missing, the whole tree is selected.
    ///
    /// By convention the first segment of the path is a category that is used to group exceptions in the UI.
    #[serde(rename = "path", default, skip_serializing_if = "Vec::is_empty")]
    #[builder(default)]
    pub path: Vec<ExceptionPathSegment>,

    /// Condition when a thrown exception should result in a break.
    #[serde(rename = "breakMode")]
    pub break_mode: ExceptionBreakMode,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// An ExceptionPathSegment represents a segment in a path that is used to match leafs or nodes in a tree of exceptions.
///
/// If a segment consists of more than one name, it matches the names provided if 'negate' is false or missing or
///
/// it matches anything except the names provided if 'negate' is true.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ExceptionPathSegment {
    /// If false or missing this segment matches the names provided, otherwise it matches anything except the names provided.
    #[serde(rename = "negate", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub negate: bool,

    /// Depending on the value of 'negate' the names that should match or not match.
    #[serde(rename = "names")]
    pub names: Vec<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Properties of a breakpoint passed to the setFunctionBreakpoints request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct FunctionBreakpoint {
    /// The name of the function.
    #[serde(rename = "name")]
    pub name: String,

    /// An optional expression for conditional breakpoints.
    ///
    /// It is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true.
    #[serde(rename = "condition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub condition: Option<String>,

    /// An optional expression that controls how many hits of the breakpoint are ignored.
    ///
    /// The backend is expected to interpret the expression as needed.
    ///
    /// The attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true.
    #[serde(rename = "hitCondition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub hit_condition: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// A GotoTarget describes a code location that can be used as a target in the 'goto' request.
///
/// The possible goto targets can be determined via the 'gotoTargets' request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct GotoTarget {
    /// Unique identifier for a goto target. This is used in the goto request.
    #[serde(rename = "id")]
    pub id: i32,

    /// The name of the goto target (shown in the UI).
    #[serde(rename = "label")]
    pub label: String,

    /// The line of the goto target.
    #[serde(rename = "line")]
    pub line: i32,

    /// An optional column of the goto target.
    #[serde(rename = "column", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub column: Option<i32>,

    /// An optional end line of the range covered by the goto target.
    #[serde(rename = "endLine", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_line: Option<i32>,

    /// An optional end column of the range covered by the goto target.
    #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_column: Option<i32>,

    /// Optional memory reference for the instruction pointer value represented by this target.
    #[serde(
        rename = "instructionPointerReference",
        skip_serializing_if = "Option::is_none"
    )]
    #[builder(default)]
    pub instruction_pointer_reference: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Properties of a breakpoint passed to the setInstructionBreakpoints request
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct InstructionBreakpoint {
    /// The instruction reference of the breakpoint.
    ///
    /// This should be a memory or instruction pointer reference from an EvaluateResponse, Variable, StackFrame, GotoTarget, or Breakpoint.
    #[serde(rename = "instructionReference")]
    pub instruction_reference: String,

    /// An optional offset from the instruction reference.
    ///
    /// This can be negative.
    #[serde(rename = "offset", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub offset: Option<i32>,

    /// An optional expression for conditional breakpoints.
    ///
    /// It is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true.
    #[serde(rename = "condition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub condition: Option<String>,

    /// An optional expression that controls how many hits of the breakpoint are ignored.
    ///
    /// The backend is expected to interpret the expression as needed.
    ///
    /// The attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true.
    #[serde(rename = "hitCondition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub hit_condition: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Logical areas that can be invalidated by the 'invalidated' event.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum InvalidatedAreas {
    /// All previously fetched data has become invalid and needs to be refetched.
    #[serde(rename = "all")]
    All,

    /// Previously fetched stack related data has become invalid and needs to be refetched.
    #[serde(rename = "stacks")]
    Stacks,

    /// Previously fetched thread related data has become invalid and needs to be refetched.
    #[serde(rename = "threads")]
    Threads,

    /// Previously fetched variable data has become invalid and needs to be refetched.
    #[serde(rename = "variables")]
    Variables,
}

/// A structured message object. Used to return errors from requests.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Message {
    /// Unique identifier for the message.
    #[serde(rename = "id")]
    pub id: i32,

    /// A format string for the message. Embedded variables have the form '{name}'.
    ///
    /// If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.
    #[serde(rename = "format")]
    pub format: String,

    /// An object used as a dictionary for looking up the variables in the format string.
    #[serde(
        rename = "variables",
        default,
        skip_serializing_if = "HashMap::is_empty"
    )]
    #[builder(default)]
    pub variables: HashMap<String, String>,

    /// If true send to telemetry.
    #[serde(rename = "sendTelemetry", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub send_telemetry: bool,

    /// If true show user.
    #[serde(rename = "showUser", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub show_user: bool,

    /// An optional url where additional information about this message can be found.
    #[serde(rename = "url", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub url: Option<String>,

    /// An optional label that is presented to the user as the UI for opening the url.
    #[serde(rename = "urlLabel", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub url_label: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// A Module object represents a row in the modules view.
///
/// Two attributes are mandatory: an id identifies a module in the modules view and is used in a ModuleEvent for identifying a module for adding, updating or deleting.
///
/// The name is used to minimally render the module in the UI.
///
///
///
/// Additional attributes can be added to the module. They will show up in the module View if they have a corresponding ColumnDescriptor.
///
///
///
/// To avoid an unnecessary proliferation of additional attributes with similar semantics but different names
///
/// we recommend to re-use attributes from the 'recommended' list below first, and only introduce new attributes if nothing appropriate could be found.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Module {
    /// Unique identifier for the module.
    #[serde(rename = "id")]
    pub id: ModuleId,

    /// A name of the module.
    #[serde(rename = "name")]
    pub name: String,

    /// optional but recommended attributes.
    ///
    /// always try to use these first before introducing additional attributes.
    ///
    ///
    ///
    /// Logical full path to the module. The exact definition is implementation defined, but usually this would be a full path to the on-disk file for the module.
    #[serde(rename = "path", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub path: Option<String>,

    /// True if the module is optimized.
    #[serde(rename = "isOptimized", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub is_optimized: Option<bool>,

    /// True if the module is considered 'user code' by a debugger that supports 'Just My Code'.
    #[serde(rename = "isUserCode", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub is_user_code: Option<bool>,

    /// Version of Module.
    #[serde(rename = "version", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub version: Option<String>,

    /// User understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.
    #[serde(rename = "symbolStatus", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub symbol_status: Option<String>,

    /// Logical full path to the symbol file. The exact definition is implementation defined.
    #[serde(rename = "symbolFilePath", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub symbol_file_path: Option<String>,

    /// Module created or modified.
    #[serde(rename = "dateTimeStamp", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub date_time_stamp: Option<String>,

    /// Address range covered by this module.
    #[serde(rename = "addressRange", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub address_range: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(untagged)]
pub enum ModuleId {
    Integer(i32),
    String(String),
}

/// The ModulesViewDescriptor is the container for all declarative configuration options of a ModuleView.
///
/// For now it only specifies the columns to be shown in the modules view.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ModulesViewDescriptor {
    #[serde(rename = "columns")]
    pub columns: Vec<ColumnDescriptor>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// A Scope is a named container for variables. Optionally a scope can map to a source or a range within a source.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Scope {
    /// Name of the scope such as 'Arguments', 'Locals', or 'Registers'. This string is shown in the UI as is and can be translated.
    #[serde(rename = "name")]
    pub name: String,

    /// An optional hint for how to present this scope in the UI. If this attribute is missing, the scope is shown with a generic UI.
    #[serde(rename = "presentationHint", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub presentation_hint: Option<ScopePresentationHint>,

    /// The variables of this scope can be retrieved by passing the value of variablesReference to the VariablesRequest.
    #[serde(rename = "variablesReference")]
    pub variables_reference: i32,

    /// The number of named variables in this scope.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    #[serde(rename = "namedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub named_variables: Option<i32>,

    /// The number of indexed variables in this scope.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    #[serde(rename = "indexedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub indexed_variables: Option<i32>,

    /// If true, the number of variables in this scope is large or expensive to retrieve.
    #[serde(rename = "expensive")]
    pub expensive: bool,

    /// Optional source for this scope.
    #[serde(rename = "source", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub source: Option<Source>,

    /// Optional start line of the range covered by this scope.
    #[serde(rename = "line", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub line: Option<i32>,

    /// Optional start column of the range covered by this scope.
    #[serde(rename = "column", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub column: Option<i32>,

    /// Optional end line of the range covered by this scope.
    #[serde(rename = "endLine", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_line: Option<i32>,

    /// Optional end column of the range covered by this scope.
    #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_column: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum ScopePresentationHint {
    /// Scope contains method arguments.
    #[serde(rename = "arguments")]
    Arguments,

    /// Scope contains local variables.
    #[serde(rename = "locals")]
    Locals,

    /// Scope contains registers. Only a single 'registers' scope should be returned from a 'scopes' request.
    #[serde(rename = "registers")]
    Registers,
}

/// A Source is a descriptor for source code.
///
/// It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Source {
    /// The short name of the source. Every source returned from the debug adapter has a name.
    ///
    /// When sending a source to the debug adapter this name is optional.
    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub name: Option<String>,

    /// The path of the source to be shown in the UI.
    ///
    /// It is only used to locate and load the content of the source if no sourceReference is specified (or its value is 0).
    #[serde(rename = "path", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub path: Option<String>,

    /// If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a path is specified).
    ///
    /// A sourceReference is only valid for a session, so it must not be used to persist a source.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "sourceReference", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub source_reference: Option<i32>,

    /// An optional hint for how to present the source in the UI.
    ///
    /// A value of 'deemphasize' can be used to indicate that the source is not available or that it is skipped on stepping.
    #[serde(rename = "presentationHint", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub presentation_hint: Option<SourcePresentationHint>,

    /// The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc.
    #[serde(rename = "origin", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub origin: Option<String>,

    /// An optional list of sources that are related to this source. These may be the source that generated this source.
    #[serde(rename = "sources", default, skip_serializing_if = "Vec::is_empty")]
    #[builder(default)]
    pub sources: Vec<Source>,

    /// Optional data that a debug adapter might want to loop through the client.
    ///
    /// The client should leave the data intact and persist it across sessions. The client should not interpret the data.
    #[serde(rename = "adapterData", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub adapter_data: Option<Value>,

    /// The checksums associated with this file.
    #[serde(rename = "checksums", default, skip_serializing_if = "Vec::is_empty")]
    #[builder(default)]
    pub checksums: Vec<Checksum>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// An optional hint for how to present the source in the UI.
///
/// A value of 'deemphasize' can be used to indicate that the source is not available or that it is skipped on stepping.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum SourcePresentationHint {
    #[serde(rename = "normal")]
    Normal,

    #[serde(rename = "emphasize")]
    Emphasize,

    #[serde(rename = "deemphasize")]
    Deemphasize,
}

/// Properties of a breakpoint or logpoint passed to the setBreakpoints request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SourceBreakpoint {
    /// The source line of the breakpoint or logpoint.
    #[serde(rename = "line")]
    pub line: i32,

    /// An optional source column of the breakpoint.
    #[serde(rename = "column", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub column: Option<i32>,

    /// An optional expression for conditional breakpoints.
    ///
    /// It is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true.
    #[serde(rename = "condition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub condition: Option<String>,

    /// An optional expression that controls how many hits of the breakpoint are ignored.
    ///
    /// The backend is expected to interpret the expression as needed.
    ///
    /// The attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true.
    #[serde(rename = "hitCondition", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub hit_condition: Option<String>,

    /// If this attribute exists and is non-empty, the backend must not 'break' (stop)
    ///
    /// but log the message instead. Expressions within {} are interpolated.
    ///
    /// The attribute is only honored by a debug adapter if the capability 'supportsLogPoints' is true.
    #[serde(rename = "logMessage", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub log_message: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// A Stackframe contains the source location.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct StackFrame {
    /// An identifier for the stack frame. It must be unique across all threads.
    ///
    /// This id can be used to retrieve the scopes of the frame with the 'scopesRequest' or to restart the execution of a stackframe.
    #[serde(rename = "id")]
    pub id: i32,

    /// The name of the stack frame, typically a method name.
    #[serde(rename = "name")]
    pub name: String,

    /// The optional source of the frame.
    #[serde(rename = "source", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub source: Option<Source>,

    /// The line within the file of the frame. If source is null or doesn't exist, line is 0 and must be ignored.
    #[serde(rename = "line")]
    pub line: i32,

    /// The column within the line. If source is null or doesn't exist, column is 0 and must be ignored.
    #[serde(rename = "column")]
    pub column: i32,

    /// An optional end line of the range covered by the stack frame.
    #[serde(rename = "endLine", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_line: Option<i32>,

    /// An optional end column of the range covered by the stack frame.
    #[serde(rename = "endColumn", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub end_column: Option<i32>,

    /// Indicates whether this frame can be restarted with the 'restart' request. Clients should only use this if the debug adapter supports the 'restart' request (capability 'supportsRestartRequest' is true).
    #[serde(rename = "canRestart", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub can_restart: Option<bool>,

    /// Optional memory reference for the current instruction pointer in this frame.
    #[serde(
        rename = "instructionPointerReference",
        skip_serializing_if = "Option::is_none"
    )]
    #[builder(default)]
    pub instruction_pointer_reference: Option<String>,

    /// The module associated with this frame, if any.
    #[serde(rename = "moduleId", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub module_id: Option<ModuleId>,

    /// An optional hint for how to present this frame in the UI.
    ///
    /// A value of 'label' can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of 'subtle' can be used to change the appearance of a frame in a 'subtle' way.
    #[serde(rename = "presentationHint", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub presentation_hint: Option<StackFramePresentationHint>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum StackFramePresentationHint {
    #[serde(rename = "normal")]
    Normal,

    #[serde(rename = "label")]
    Label,

    #[serde(rename = "subtle")]
    Subtle,
}

/// Provides formatting information for a stack frame.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct StackFrameFormat {
    /// Displays parameters for the stack frame.
    #[serde(rename = "parameters", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub parameters: Option<bool>,

    /// Displays the types of parameters for the stack frame.
    #[serde(rename = "parameterTypes", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub parameter_types: Option<bool>,

    /// Displays the names of parameters for the stack frame.
    #[serde(rename = "parameterNames", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub parameter_names: Option<bool>,

    /// Displays the values of parameters for the stack frame.
    #[serde(rename = "parameterValues", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub parameter_values: Option<bool>,

    /// Displays the line number of the stack frame.
    #[serde(rename = "line", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub line: Option<bool>,

    /// Displays the module of the stack frame.
    #[serde(rename = "module", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub module: Option<bool>,

    /// Includes all stack frames, including those the debug adapter might otherwise hide.
    #[serde(rename = "includeAll", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub include_all: Option<bool>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// A StepInTarget can be used in the 'stepIn' request and determines into which single target the stepIn request should step.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct StepInTarget {
    /// Unique identifier for a stepIn target.
    #[serde(rename = "id")]
    pub id: i32,

    /// The name of the stepIn target (shown in the UI).
    #[serde(rename = "label")]
    pub label: String,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// The granularity of one 'step' in the stepping requests 'next', 'stepIn', 'stepOut', and 'stepBack'.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum SteppingGranularity {
    /// The step should allow the program to run until the current statement has finished executing.
    ///
    /// The meaning of a statement is determined by the adapter and it may be considered equivalent to a line.
    ///
    /// For example 'for(int i = 0; i < 10; i++) could be considered to have 3 statements 'int i = 0', 'i < 10', and 'i++'.
    #[serde(rename = "statement")]
    Statement,

    /// The step should allow the program to run until the current source line has executed.
    #[serde(rename = "line")]
    Line,

    /// The step should allow one instruction to execute (e.g. one x86 instruction).
    #[serde(rename = "instruction")]
    Instruction,
}

impl Default for SteppingGranularity {
    fn default() -> Self {
        SteppingGranularity::Statement
    }
}

/// A Thread
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Thread {
    /// Unique identifier for the thread.
    #[serde(rename = "id")]
    pub id: i32,

    /// A name of the thread.
    #[serde(rename = "name")]
    pub name: String,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Provides formatting information for a value.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ValueFormat {
    /// Display the value in hex.
    #[serde(rename = "hex", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub hex: Option<bool>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// A Variable is a name/value pair.
///
/// Optionally a variable can have a 'type' that is shown if space permits or when hovering over the variable's name.
///
/// An optional 'kind' is used to render additional properties of the variable, e.g. different icons can be used to indicate that a variable is public or private.
///
/// If the value is structured (has children), a handle is provided to retrieve the children with the VariablesRequest.
///
/// If the number of named or indexed children is large, the numbers should be returned via the optional 'namedVariables' and 'indexedVariables' attributes.
///
/// The client can use this optional information to present the children in a paged UI and fetch them in chunks.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct Variable {
    /// The variable's name.
    #[serde(rename = "name")]
    pub name: String,

    /// The variable's value. This can be a multi-line text, e.g. for a function the body of a function.
    #[serde(rename = "value")]
    pub value: String,

    /// The type of the variable's value. Typically shown in the UI when hovering over the value.
    ///
    /// This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub type_: Option<String>,

    /// Properties of a variable that can be used to determine how to render the variable in the UI.
    #[serde(rename = "presentationHint", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub presentation_hint: Option<VariablePresentationHint>,

    /// Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's value.
    #[serde(rename = "evaluateName", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub evaluate_name: Option<String>,

    /// If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
    #[serde(rename = "variablesReference")]
    pub variables_reference: i32,

    /// The number of named child variables.
    ///
    /// The client can use this optional information to present the children in a paged UI and fetch them in chunks.
    #[serde(rename = "namedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub named_variables: Option<i32>,

    /// The number of indexed child variables.
    ///
    /// The client can use this optional information to present the children in a paged UI and fetch them in chunks.
    #[serde(rename = "indexedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub indexed_variables: Option<i32>,

    /// Optional memory reference for the variable if the variable represents executable code, such as a function pointer.
    ///
    /// This attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.
    #[serde(rename = "memoryReference", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub memory_reference: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

/// Optional properties of a variable that can be used to determine how to render the variable in the UI.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct VariablePresentationHint {
    /// The kind of variable. Before introducing additional values, try to use the listed values.
    #[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub kind: Option<VariableKind>,

    /// Set of attributes represented as an array of strings. Before introducing additional values, try to use the listed values.
    #[serde(rename = "attributes", default, skip_serializing_if = "Vec::is_empty")]
    #[builder(default)]
    pub attributes: Vec<VariableAttribute>,

    /// Visibility of variable. Before introducing additional values, try to use the listed values.
    #[serde(rename = "visibility", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub visibility: Option<VariableVisibility>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum VariableKind {
    /// Indicates that the object is a property.
    #[serde(rename = "property")]
    Property,

    /// Indicates that the object is a method.
    #[serde(rename = "method")]
    Method,

    /// Indicates that the object is a class.
    #[serde(rename = "class")]
    Class,

    /// Indicates that the object is data.
    #[serde(rename = "data")]
    Data,

    /// Indicates that the object is an event.
    #[serde(rename = "event")]
    Event,

    /// Indicates that the object is a base class.
    #[serde(rename = "baseClass")]
    BaseClass,

    /// Indicates that the object is an inner class.
    #[serde(rename = "innerClass")]
    InnerClass,

    /// Indicates that the object is an interface.
    #[serde(rename = "interface")]
    Interface,

    /// Indicates that the object is the most derived class.
    #[serde(rename = "mostDerivedClass")]
    MostDerivedClass,

    /// Indicates that the object is virtual, that means it is a synthetic object introducedby the
    ///
    /// adapter for rendering purposes, e.g. an index range for large arrays.
    #[serde(rename = "virtual")]
    Virtual,

    /// Deprecated: Indicates that a data breakpoint is registered for the object. The 'hasDataBreakpoint' attribute should generally be used instead.
    #[serde(rename = "dataBreakpoint")]
    DataBreakpoint,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum VariableAttribute {
    /// Indicates that the object is static.
    #[serde(rename = "static")]
    Static,

    /// Indicates that the object is a constant.
    #[serde(rename = "constant")]
    Constant,

    /// Indicates that the object is read only.
    #[serde(rename = "readOnly")]
    ReadOnly,

    /// Indicates that the object is a raw string.
    #[serde(rename = "rawString")]
    RawString,

    /// Indicates that the object can have an Object ID created for it.
    #[serde(rename = "hasObjectId")]
    HasObjectId,

    /// Indicates that the object has an Object ID associated with it.
    #[serde(rename = "canHaveObjectId")]
    CanHaveObjectId,

    /// Indicates that the evaluation had side effects.
    #[serde(rename = "hasSideEffects")]
    HasSideEffects,

    /// Indicates that the object has its value tracked by a data breakpoint.
    #[serde(rename = "hasDataBreakpoint")]
    HasDataBreakpoint,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum VariableVisibility {
    #[serde(rename = "public")]
    Public,

    #[serde(rename = "private")]
    Private,

    #[serde(rename = "protected")]
    Protected,

    #[serde(rename = "internal")]
    Internal,

    #[serde(rename = "final")]
    Final,
}