Skip to content

Commit 7de424d

Browse files
ashgtiashgti
committed
[lldb-dap] Adding defaults to VSCode settings for user level defaults.
This adds support for loading user level defaults in VSCode. The defaults are stored as basic settings that are loaded when the debug configuration is resolved. Not all settings are currently supported, I limited it to settings that would likely apply across multiple launch.json configurations.
1 parent 561a21f commit 7de424d

File tree

2 files changed

+187
-4
lines changed

2 files changed

+187
-4
lines changed

‎lldb/tools/lldb-dap/package.json‎

Lines changed: 106 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@
7272
"title": "lldb-dap",
7373
"properties": {
7474
"lldb-dap.executable-path": {
75-
"scope": "resource",
7675
"type": "string",
7776
"scope": "machine-overridable",
7877
"description": "The path to the lldb-dap binary, e.g. /usr/local/bin/lldb-dap"
@@ -105,6 +104,112 @@
105104
"type": "boolean",
106105
"markdownDescription": "Run lldb-dap in server mode.\n\nWhen enabled, lldb-dap will start a background server that will be reused between debug sessions. This allows caching of debug symbols between sessions and improves launch performance.",
107106
"default": false
107+
},
108+
"lldb-dap.defaults.commandEscapePrefix": {
109+
"type": "string",
110+
"description": "The escape prefix to use for executing regular LLDB commands in the Debug Console, instead of printing variables. Defaults to a back-tick (`). If it's an empty string, then all expression in the Debug Console are treated as regular LLDB commands.",
111+
"default": "`"
112+
},
113+
"lldb-dap.defaults.customFrameFormat": {
114+
"type": "string",
115+
"description": "If non-empty, stack frames will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for frames. If the format string contains errors, an error message will be displayed on the Debug Console and the default frame names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.",
116+
"default": ""
117+
},
118+
"lldb-dap.defaults.customThreadFormat": {
119+
"type": "string",
120+
"description": "If non-empty, threads will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for threads. If the format string contains errors, an error message will be displayed on the Debug Console and the default thread names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.",
121+
"default": ""
122+
},
123+
"lldb-dap.defaults.detachOnError": {
124+
"type": "boolean",
125+
"description": "Detach from the program.",
126+
"default": false
127+
},
128+
"lldb-dap.defaults.disableASLR": {
129+
"type": "boolean",
130+
"description": "Enable or disable Address space layout randomization if the debugger supports it.",
131+
"default": true
132+
},
133+
"lldb-dap.defaults.disableSTDIO": {
134+
"type": "boolean",
135+
"description": "Don't retrieve STDIN, STDOUT and STDERR as the program is running.",
136+
"default": false
137+
},
138+
"lldb-dap.defaults.displayExtendedBacktrace": {
139+
"type": "boolean",
140+
"description": "Enable language specific extended backtraces.",
141+
"default": false
142+
},
143+
"lldb-dap.defaults.enableAutoVariableSummaries": {
144+
"type": "boolean",
145+
"description": "Enable auto generated summaries for variables when no summaries exist for a given type. This feature can cause performance delays in large projects when viewing variables.",
146+
"default": false
147+
},
148+
"lldb-dap.defaults.enableSyntheticChildDebugging": {
149+
"type": "boolean",
150+
"description": "If a variable is displayed using a synthetic children, also display the actual contents of the variable at the end under a [raw] entry. This is useful when creating sythetic child plug-ins as it lets you see the actual contents of the variable.",
151+
"default": false
152+
},
153+
"lldb-dap.defaults.timeout": {
154+
"type": "number",
155+
"description": "The time in seconds to wait for a program to stop at entry point when launching with \"launchCommands\". Defaults to 30 seconds.",
156+
"default": 30
157+
},
158+
"lldb-dap.defaults.targetTriple": {
159+
"type": "string",
160+
"description": "Triplet of the target architecture to override value derived from the program file."
161+
},
162+
"lldb-dap.defaults.platformName": {
163+
"type": "string",
164+
"description": "Name of the execution platform to override value derived from the program file."
165+
},
166+
"lldb-dap.defaults.initCommands": {
167+
"type": "array",
168+
"items": {
169+
"type": "string"
170+
},
171+
"description": "Initialization commands executed upon debugger startup.",
172+
"default": []
173+
},
174+
"lldb-dap.defaults.preRunCommands": {
175+
"type": "array",
176+
"items": {
177+
"type": "string"
178+
},
179+
"description": "Commands executed just before the program is launched.",
180+
"default": []
181+
},
182+
"lldb-dap.defaults.postRunCommands": {
183+
"type": "array",
184+
"items": {
185+
"type": "string"
186+
},
187+
"description": "Commands executed just as soon as the program is successfully launched when it's in a stopped state prior to any automatic continuation.",
188+
"default": []
189+
},
190+
"lldb-dap.defaults.stopCommands": {
191+
"type": "array",
192+
"items": {
193+
"type": "string"
194+
},
195+
"description": "Commands executed each time the program stops.",
196+
"default": []
197+
},
198+
"lldb-dap.defaults.exitCommands": {
199+
"type": "array",
200+
"items": {
201+
"type": "string"
202+
},
203+
"description": "Commands executed when the program exits.",
204+
"default": []
205+
},
206+
"lldb-dap.defaults.terminateCommands": {
207+
"type": "array",
208+
"items": {
209+
"type": "string"
210+
},
211+
"description": "Commands executed when the debugging session ends.",
212+
"default": []
108213
}
109214
}
110215
},

‎lldb/tools/lldb-dap/src-ts/debug-configuration-provider.ts‎

Lines changed: 81 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,88 @@ async function isServerModeSupported(exe: string): Promise<boolean> {
2020
return /--connection/.test(stdout);
2121
}
2222

23+
interface BoolConfig {
24+
type: 'boolean';
25+
default: boolean;
26+
}
27+
interface StringConfig {
28+
type: 'string';
29+
default: string;
30+
}
31+
interface NumberConfig {
32+
type: 'number';
33+
default: number;
34+
}
35+
interface StringArrayConfig {
36+
type: 'stringArray';
37+
default: string[];
38+
}
39+
type DefaultConfig = BoolConfig | NumberConfig | StringConfig | StringArrayConfig;
40+
41+
const configurations: Record<string, DefaultConfig> = {
42+
// Keys for debugger configurations.
43+
"commandEscapePrefix": { type: "string", default: "`" },
44+
"customFrameFormat": { type: "string", default: "" },
45+
"customThreadFormat": { type: "string", default: "" },
46+
"detachOnError": { type: "boolean", default: false },
47+
"disableASLR": { type: "boolean", default: true },
48+
"disableSTDIO": { type: "boolean", default: false },
49+
"displayExtendedBacktrace": { type: "boolean", default: false },
50+
"enableAutoVariableSummaries": { type: "boolean", default: false },
51+
"enableSyntheticChildDebugging": { type: "boolean", default: false },
52+
"timeout": { type: "number", default: 30 },
53+
54+
// Keys for platform / target configuration.
55+
"platformName": { type: "string", default: "" },
56+
"targetTriple": { type: "string", default: "" },
57+
58+
// Keys for debugger command hooks.
59+
"initCommands": { type: "stringArray", default: [] },
60+
"preRunCommands": { type: "stringArray", default: [] },
61+
"postRunCommands": { type: "stringArray", default: [] },
62+
"stopCommands": { type: "stringArray", default: [] },
63+
"exitCommands": { type: "stringArray", default: [] },
64+
"terminateCommands": { type: "stringArray", default: [] },
65+
};
66+
2367
export class LLDBDapConfigurationProvider
24-
implements vscode.DebugConfigurationProvider
25-
{
26-
constructor(private readonly server: LLDBDapServer) {}
68+
implements vscode.DebugConfigurationProvider {
69+
constructor(private readonly server: LLDBDapServer) { }
70+
71+
async resolveDebugConfiguration(
72+
folder: vscode.WorkspaceFolder | undefined,
73+
debugConfiguration: vscode.DebugConfiguration,
74+
token?: vscode.CancellationToken): Promise<vscode.DebugConfiguration> {
75+
let config = vscode.workspace.getConfiguration('lldb-dap.defaults');
76+
for (const [key, cfg] of Object.entries(configurations)) {
77+
if (Reflect.has(debugConfiguration, key)) continue;
78+
const value = config.get(key);
79+
if (value === cfg.default) continue;
80+
switch (cfg.type) {
81+
case 'string':
82+
if (typeof value !== 'string')
83+
throw new Error(`Expected ${key} to be a string, got ${value}`);
84+
break;
85+
case 'number':
86+
if (typeof value !== 'number')
87+
throw new Error(`Expected ${key} to be a number, got ${value}`);
88+
break;
89+
case 'boolean':
90+
if (typeof value !== 'boolean')
91+
throw new Error(`Expected ${key} to be a boolean, got ${value}`);
92+
break;
93+
case 'stringArray':
94+
if (typeof value !== 'object' && Array.isArray(value))
95+
throw new Error(`Expected ${key} to be a array of strings, got ${value}`);
96+
if ((value as string[]).length === 0) continue;
97+
break;
98+
}
99+
100+
debugConfiguration[key] = value;
101+
}
102+
103+
return debugConfiguration;
104+
}
27105

28106
async resolveDebugConfigurationWithSubstitutedVariables(
29107
folder: vscode.WorkspaceFolder | undefined,

0 commit comments

Comments
 (0)