1include "../../include/lldb/Core/PropertiesBase.td"
2
3let Definition = "modulelist" in {
4  def EnableExternalLookup: Property<"enable-external-lookup", "Boolean">,
5    Global,
6    DefaultTrue,
7    Desc<"Control the use of external tools and repositories to locate symbol files. Directories listed in target.debug-file-search-paths and directory of the executable are always checked first for separate debug info files. Then depending on this setting: On macOS, Spotlight would be also used to locate a matching .dSYM bundle based on the UUID of the executable. On NetBSD, directory /usr/libdata/debug would be also searched. On platforms other than NetBSD directory /usr/lib/debug would be also searched.">;
8  def EnableBackgroundLookup: Property<"enable-background-lookup", "Boolean">,
9    Global,
10    DefaultFalse,
11    Desc<"On macOS, enable calling dsymForUUID (or an equivalent script/binary) in the background to locate symbol files that weren't found.">;
12  def ClangModulesCachePath: Property<"clang-modules-cache-path", "FileSpec">,
13    Global,
14    DefaultStringValue<"">,
15    Desc<"The path to the clang modules cache directory (-fmodules-cache-path).">;
16  def SymLinkPaths: Property<"debug-info-symlink-paths", "FileSpecList">,
17    Global,
18    DefaultStringValue<"">,
19    Desc<"Debug info path which should be resolved while parsing, relative to the host filesystem.">;
20  def EnableLLDBIndexCache: Property<"enable-lldb-index-cache", "Boolean">,
21    Global,
22    DefaultFalse,
23    Desc<"Enable caching for debug sessions in LLDB. LLDB can cache data for each module for improved performance in subsequent debug sessions.">;
24  def LLDBIndexCachePath: Property<"lldb-index-cache-path", "FileSpec">,
25    Global,
26    DefaultStringValue<"">,
27    Desc<"The path to the LLDB index cache directory.">;
28  def LLDBIndexCacheMaxByteSize: Property<"lldb-index-cache-max-byte-size", "UInt64">,
29    Global,
30    DefaultUnsignedValue<0>,
31    Desc<"The maximum size for the LLDB index cache directory in bytes. A value over the amount of available space on the disk will be reduced to the amount of available space. A value of 0 disables the absolute size-based pruning.">;
32  def LLDBIndexCacheMaxPercent: Property<"lldb-index-cache-max-percent", "UInt64">,
33    Global,
34    DefaultUnsignedValue<0>,
35    Desc<"The maximum size for the cache directory in terms of percentage of the available space on the disk. Set to 100 to indicate no limit, 50 to indicate that the cache size will not be left over half the available disk space. A value over 100 will be reduced to 100. A value of 0 disables the percentage size-based pruning.">;
36  def LLDBIndexCacheExpirationDays: Property<"lldb-index-cache-expiration-days", "UInt64">,
37    Global,
38    DefaultUnsignedValue<7>,
39    Desc<"The expiration time in days for a file. When a file hasn't been accessed for the specified amount of days, it is removed from the cache. A value of 0 disables the expiration-based pruning.">;
40  def LoadSymbolOnDemand: Property<"load-on-demand", "Boolean">,
41    Global,
42    DefaultFalse,
43    Desc<"Enable on demand symbol loading in LLDB. LLDB will load debug info on demand for each module based on various conditions (e.g. matched breakpoint, resolved stack frame addresses and matched global variables/function symbols in symbol table) to improve performance. Please refer to docs/use/ondemand.rst for details.">;
44}
45
46let Definition = "debugger" in {
47  def AutoConfirm: Property<"auto-confirm", "Boolean">,
48    Global,
49    DefaultFalse,
50    Desc<"If true all confirmation prompts will receive their default reply.">;
51  def DisassemblyFormat: Property<"disassembly-format", "FormatEntity">,
52    Global,
53    DefaultStringValue<"{${function.initial-function}{${module.file.basename}`}{${function.name-without-args}}:\\\\n}{${function.changed}\\\\n{${module.file.basename}`}{${function.name-without-args}}:\\\\n}{${ansi.fg.yellow}${current-pc-arrow}${ansi.normal} }${addr-file-or-load}{ <${function.concrete-only-addr-offset-no-padding}>}: ">,
54    Desc<"The default disassembly format string to use when disassembling instruction sequences.">;
55  def FrameFormat: Property<"frame-format", "FormatEntity">,
56    Global,
57    DefaultStringValue<"frame #${frame.index}: ${ansi.fg.yellow}${frame.pc}${ansi.normal}{ ${module.file.basename}{`${function.name-with-args}{${frame.no-debug}${function.pc-offset}}}}{ at ${ansi.fg.cyan}${line.file.basename}${ansi.normal}:${ansi.fg.yellow}${line.number}${ansi.normal}{:${ansi.fg.yellow}${line.column}${ansi.normal}}}{${function.is-optimized} [opt]}{${frame.is-artificial} [artificial]}\\\\n">,
58    Desc<"The default frame format string to use when displaying stack frame information for threads.">;
59  def NotiftVoid: Property<"notify-void", "Boolean">,
60    Global,
61    DefaultFalse,
62    Desc<"Notify the user explicitly if an expression returns void (default: false).">;
63  def Prompt: Property<"prompt", "String">,
64    Global,
65    DefaultEnumValue<"OptionValueString::eOptionEncodeCharacterEscapeSequences">,
66    DefaultStringValue<"(lldb) ">,
67    Desc<"The debugger command line prompt displayed for the user.">;
68  def ScriptLanguage: Property<"script-lang", "Enum">,
69    Global,
70    DefaultEnumValue<"eScriptLanguagePython">,
71    EnumValues<"OptionEnumValues(g_language_enumerators)">,
72    Desc<"The script language to be used for evaluating user-written scripts.">;
73  def REPLLanguage: Property<"repl-lang", "Language">,
74    Global,
75    DefaultEnumValue<"eLanguageTypeUnknown">,
76    Desc<"The language to use for the REPL.">;
77  def StopDisassemblyCount: Property<"stop-disassembly-count", "SInt64">,
78    Global,
79    DefaultUnsignedValue<4>,
80    Desc<"The number of disassembly lines to show when displaying a stopped context.">;
81  def StopDisassemblyDisplay: Property<"stop-disassembly-display", "Enum">,
82    Global,
83    DefaultEnumValue<"Debugger::eStopDisassemblyTypeNoDebugInfo">,
84    EnumValues<"OptionEnumValues(g_show_disassembly_enum_values)">,
85    Desc<"Control when to display disassembly when displaying a stopped context.">;
86  def StopDisassemblyMaxSize: Property<"stop-disassembly-max-size", "UInt64">,
87    Global,
88    DefaultUnsignedValue<32000>,
89    Desc<"The size limit to use when disassembling large functions (default: 32KB).">;
90  def StopLineCountAfter: Property<"stop-line-count-after", "SInt64">,
91    Global,
92    DefaultUnsignedValue<3>,
93    Desc<"The number of sources lines to display that come after the current source line when displaying a stopped context.">;
94  def StopLineCountBefore: Property<"stop-line-count-before", "SInt64">,
95    Global,
96    DefaultUnsignedValue<3>,
97    Desc<"The number of sources lines to display that come before the current source line when displaying a stopped context.">;
98  def HighlightSource: Property<"highlight-source", "Boolean">,
99    Global,
100    DefaultTrue,
101    Desc<"If true, LLDB will highlight the displayed source code.">;
102  def StopShowColumn: Property<"stop-show-column", "Enum">,
103    DefaultEnumValue<"eStopShowColumnAnsiOrCaret">,
104    EnumValues<"OptionEnumValues(s_stop_show_column_values)">,
105    Desc<"If true, LLDB will use the column information from the debug info to mark the current position when displaying a stopped context.">;
106  def StopShowColumnAnsiPrefix: Property<"stop-show-column-ansi-prefix", "String">,
107    Global,
108    DefaultStringValue<"${ansi.underline}">,
109    Desc<"When displaying the column marker in a color-enabled terminal, use the ANSI terminal code specified in this format at the immediately before the column to be marked.">;
110  def StopShowColumnAnsiSuffix: Property<"stop-show-column-ansi-suffix", "String">,
111    Global,
112    DefaultStringValue<"${ansi.normal}">,
113    Desc<"When displaying the column marker in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the column to be marked.">;
114  def StopShowLineMarkerAnsiPrefix: Property<"stop-show-line-ansi-prefix", "String">,
115    Global,
116    DefaultStringValue<"${ansi.fg.yellow}">,
117    Desc<"When displaying the line marker in a color-enabled terminal, use the ANSI terminal code specified in this format at the immediately before the line to be marked.">;
118  def StopShowLineMarkerAnsiSuffix: Property<"stop-show-line-ansi-suffix", "String">,
119    Global,
120    DefaultStringValue<"${ansi.normal}">,
121    Desc<"When displaying the line marker in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the line to be marked.">;
122  def TerminalWidth: Property<"term-width", "SInt64">,
123    Global,
124    DefaultUnsignedValue<80>,
125    Desc<"The maximum number of columns to use for displaying text.">;
126  def ThreadFormat: Property<"thread-format", "FormatEntity">,
127    Global,
128    DefaultStringValue<"thread #${thread.index}: tid = ${thread.id%tid}{, ${frame.pc}}{ ${module.file.basename}{`${function.name-with-args}{${frame.no-debug}${function.pc-offset}}}}{ at ${ansi.fg.cyan}${line.file.basename}${ansi.normal}:${ansi.fg.yellow}${line.number}${ansi.normal}{:${ansi.fg.yellow}${line.column}${ansi.normal}}}{, name = ${ansi.fg.green}'${thread.name}'${ansi.normal}}{, queue = ${ansi.fg.green}'${thread.queue}'${ansi.normal}}{, activity = ${ansi.fg.green}'${thread.info.activity.name}'${ansi.normal}}{, ${thread.info.trace_messages} messages}{, stop reason = ${ansi.fg.red}${thread.stop-reason}${ansi.normal}}{\\\\nReturn value: ${thread.return-value}}{\\\\nCompleted expression: ${thread.completed-expression}}\\\\n">,
129    Desc<"The default thread format string to use when displaying thread information.">;
130  def ThreadStopFormat: Property<"thread-stop-format", "FormatEntity">,
131    Global,
132    DefaultStringValue<"thread #${thread.index}{, name = '${thread.name}'}{, queue = ${ansi.fg.green}'${thread.queue}'${ansi.normal}}{, activity = ${ansi.fg.green}'${thread.info.activity.name}'${ansi.normal}}{, ${thread.info.trace_messages} messages}{, stop reason = ${ansi.fg.red}${thread.stop-reason}${ansi.normal}}{\\\\nReturn value: ${thread.return-value}}{\\\\nCompleted expression: ${thread.completed-expression}}\\\\n">,
133    Desc<"The default thread format  string to use when displaying thread information as part of the stop display.">;
134  def UseExternalEditor: Property<"use-external-editor", "Boolean">,
135    Global,
136    DefaultFalse,
137    Desc<"Whether to use an external editor or not.">;
138  def UseColor: Property<"use-color", "Boolean">,
139    Global,
140    DefaultTrue,
141    Desc<"Whether to use Ansi color codes or not.">;
142  def ShowProgress: Property<"show-progress", "Boolean">,
143    Global,
144    DefaultTrue,
145    Desc<"Whether to show progress or not if the debugger's output is an interactive color-enabled terminal.">;
146  def ShowProgressAnsiPrefix: Property<"show-progress-ansi-prefix", "String">,
147    Global,
148    DefaultStringValue<"${ansi.faint}">,
149    Desc<"When displaying progress in a color-enabled terminal, use the ANSI terminal code specified in this format immediately before the progress message.">;
150  def ShowProgressAnsiSuffix: Property<"show-progress-ansi-suffix", "String">,
151    Global,
152    DefaultStringValue<"${ansi.normal}">,
153    Desc<"When displaying progress in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the progress message.">;
154  def UseSourceCache: Property<"use-source-cache", "Boolean">,
155    Global,
156    DefaultTrue,
157    Desc<"Whether to cache source files in memory or not.">;
158  def AutoOneLineSummaries: Property<"auto-one-line-summaries", "Boolean">,
159    Global,
160    DefaultTrue,
161    Desc<"If true, LLDB will automatically display small structs in one-liner format (default: true).">;
162  def AutoIndent: Property<"auto-indent", "Boolean">,
163    Global,
164    DefaultTrue,
165    Desc<"If true, LLDB will auto indent/outdent code. Currently only supported in the REPL (default: true).">;
166  def PrintDecls: Property<"print-decls", "Boolean">,
167    Global,
168    DefaultTrue,
169    Desc<"If true, LLDB will print the values of variables declared in an expression. Currently only supported in the REPL (default: true).">;
170  def TabSize: Property<"tab-size", "UInt64">,
171    Global,
172    DefaultUnsignedValue<4>,
173    Desc<"The tab size to use when indenting code in multi-line input mode (default: 4).">;
174  def EscapeNonPrintables: Property<"escape-non-printables", "Boolean">,
175    Global,
176    DefaultTrue,
177    Desc<"If true, LLDB will automatically escape non-printable and escape characters when formatting strings.">;
178  def FrameFormatUnique: Property<"frame-format-unique", "FormatEntity">,
179    Global,
180    DefaultStringValue<"frame #${frame.index}: ${ansi.fg.yellow}${frame.pc}${ansi.normal}{ ${module.file.basename}{`${function.name-without-args}{${frame.no-debug}${function.pc-offset}}}}{ at ${ansi.fg.cyan}${line.file.basename}${ansi.normal}:${ansi.fg.yellow}${line.number}${ansi.normal}{:${ansi.fg.yellow}${line.column}${ansi.normal}}}{${function.is-optimized} [opt]}{${frame.is-artificial} [artificial]}\\\\n">,
181    Desc<"The default frame format string to use when displaying stack frame information for threads from thread backtrace unique.">;
182  def ShowAutosuggestion: Property<"show-autosuggestion", "Boolean">,
183    Global,
184    DefaultFalse,
185    Desc<"If true, LLDB will show suggestions to complete the command the user typed. Suggestions may be accepted using Ctrl-F.">;
186  def ShowAutosuggestionAnsiPrefix: Property<"show-autosuggestion-ansi-prefix", "String">,
187    Global,
188    DefaultStringValue<"${ansi.faint}">,
189    Desc<"When displaying suggestion in a color-enabled terminal, use the ANSI terminal code specified in this format immediately before the suggestion.">;
190  def ShowAutosuggestionAnsiSuffix: Property<"show-autosuggestion-ansi-suffix", "String">,
191    Global,
192    DefaultStringValue<"${ansi.normal}">,
193    Desc<"When displaying suggestion in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the suggestion.">;
194  def DWIMPrintVerbosity: Property<"dwim-print-verbosity", "Enum">,
195    Global,
196    DefaultEnumValue<"eDWIMPrintVerbosityExpression">,
197    EnumValues<"OptionEnumValues(g_dwim_print_verbosities)">,
198    Desc<"The verbosity level used by dwim-print.">;
199}
200