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. If all other methods fail there may be symbol-locator plugins that, if configured properly, will also attempt to acquire symbols. The debuginfod plugin defaults to the DEGUFINFOD_URLS environment variable which is configurable through the 'plugin.symbol-locator.debuginfod.server_urls' setting.">; 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 PromptAnsiPrefix: Property<"prompt-ansi-prefix", "String">, 69 Global, 70 DefaultStringValue<"${ansi.faint}">, 71 Desc<"When in a color-enabled terminal, use the ANSI terminal code specified in this format immediately before the prompt.">; 72 def PromptAnsiSuffix: Property<"prompt-ansi-suffix", "String">, 73 Global, 74 DefaultStringValue<"${ansi.normal}">, 75 Desc<"When in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the prompt.">; 76 def ScriptLanguage: Property<"script-lang", "Enum">, 77 Global, 78 DefaultEnumValue<"eScriptLanguageLua">, 79 EnumValues<"OptionEnumValues(g_language_enumerators)">, 80 Desc<"The script language to be used for evaluating user-written scripts.">; 81 def REPLLanguage: Property<"repl-lang", "Language">, 82 Global, 83 DefaultEnumValue<"eLanguageTypeUnknown">, 84 Desc<"The language to use for the REPL.">; 85 def StopDisassemblyCount: Property<"stop-disassembly-count", "UInt64">, 86 Global, 87 DefaultUnsignedValue<4>, 88 Desc<"The number of disassembly lines to show when displaying a stopped context.">; 89 def StopDisassemblyDisplay: Property<"stop-disassembly-display", "Enum">, 90 Global, 91 DefaultEnumValue<"Debugger::eStopDisassemblyTypeNoDebugInfo">, 92 EnumValues<"OptionEnumValues(g_show_disassembly_enum_values)">, 93 Desc<"Control when to display disassembly when displaying a stopped context.">; 94 def StopDisassemblyMaxSize: Property<"stop-disassembly-max-size", "UInt64">, 95 Global, 96 DefaultUnsignedValue<32000>, 97 Desc<"The size limit to use when disassembling large functions (default: 32KB).">; 98 def StopLineCountAfter: Property<"stop-line-count-after", "UInt64">, 99 Global, 100 DefaultUnsignedValue<3>, 101 Desc<"The number of sources lines to display that come after the current source line when displaying a stopped context.">; 102 def StopLineCountBefore: Property<"stop-line-count-before", "UInt64">, 103 Global, 104 DefaultUnsignedValue<3>, 105 Desc<"The number of sources lines to display that come before the current source line when displaying a stopped context.">; 106 def HighlightSource: Property<"highlight-source", "Boolean">, 107 Global, 108 DefaultTrue, 109 Desc<"If true, LLDB will highlight the displayed source code.">; 110 def StopShowColumn: Property<"stop-show-column", "Enum">, 111 DefaultEnumValue<"eStopShowColumnAnsiOrCaret">, 112 EnumValues<"OptionEnumValues(s_stop_show_column_values)">, 113 Desc<"If true, LLDB will use the column information from the debug info to mark the current position when displaying a stopped context.">; 114 def StopShowColumnAnsiPrefix: Property<"stop-show-column-ansi-prefix", "String">, 115 Global, 116 DefaultStringValue<"${ansi.underline}">, 117 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.">; 118 def StopShowColumnAnsiSuffix: Property<"stop-show-column-ansi-suffix", "String">, 119 Global, 120 DefaultStringValue<"${ansi.normal}">, 121 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.">; 122 def StopShowLineMarkerAnsiPrefix: Property<"stop-show-line-ansi-prefix", "String">, 123 Global, 124 DefaultStringValue<"${ansi.fg.yellow}">, 125 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.">; 126 def StopShowLineMarkerAnsiSuffix: Property<"stop-show-line-ansi-suffix", "String">, 127 Global, 128 DefaultStringValue<"${ansi.normal}">, 129 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.">; 130 def TerminalWidth: Property<"term-width", "SInt64">, 131 Global, 132 DefaultUnsignedValue<80>, 133 Desc<"The maximum number of columns to use for displaying text.">; 134 def ThreadFormat: Property<"thread-format", "FormatEntity">, 135 Global, 136 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">, 137 Desc<"The default thread format string to use when displaying thread information.">; 138 def ThreadStopFormat: Property<"thread-stop-format", "FormatEntity">, 139 Global, 140 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">, 141 Desc<"The default thread format string to use when displaying thread information as part of the stop display.">; 142 def UseExternalEditor: Property<"use-external-editor", "Boolean">, 143 Global, 144 DefaultFalse, 145 Desc<"Whether to use an external editor or not.">; 146 def ExternalEditor: Property<"external-editor", "String">, 147 Global, 148 DefaultStringValue<"">, 149 Desc<"External editor to use when use-external-editor is enabled.">; 150 def UseColor: Property<"use-color", "Boolean">, 151 Global, 152 DefaultTrue, 153 Desc<"Whether to use Ansi color codes or not.">; 154 def ShowProgress: Property<"show-progress", "Boolean">, 155 Global, 156 DefaultTrue, 157 Desc<"Whether to show progress or not if the debugger's output is an interactive color-enabled terminal.">; 158 def ShowProgressAnsiPrefix: Property<"show-progress-ansi-prefix", "String">, 159 Global, 160 DefaultStringValue<"${ansi.faint}">, 161 Desc<"When displaying progress in a color-enabled terminal, use the ANSI terminal code specified in this format immediately before the progress message.">; 162 def ShowProgressAnsiSuffix: Property<"show-progress-ansi-suffix", "String">, 163 Global, 164 DefaultStringValue<"${ansi.normal}">, 165 Desc<"When displaying progress in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the progress message.">; 166 def UseSourceCache: Property<"use-source-cache", "Boolean">, 167 Global, 168 DefaultTrue, 169 Desc<"Whether to cache source files in memory or not.">; 170 def AutoOneLineSummaries: Property<"auto-one-line-summaries", "Boolean">, 171 Global, 172 DefaultTrue, 173 Desc<"If true, LLDB will automatically display small structs in one-liner format (default: true).">; 174 def AutoIndent: Property<"auto-indent", "Boolean">, 175 Global, 176 DefaultTrue, 177 Desc<"If true, LLDB will auto indent/outdent code. Currently only supported in the REPL (default: true).">; 178 def PrintDecls: Property<"print-decls", "Boolean">, 179 Global, 180 DefaultTrue, 181 Desc<"If true, LLDB will print the values of variables declared in an expression. Currently only supported in the REPL (default: true).">; 182 def TabSize: Property<"tab-size", "UInt64">, 183 Global, 184 DefaultUnsignedValue<2>, 185 Desc<"The tab size to use when indenting code in multi-line input mode (default: 2).">; 186 def EscapeNonPrintables: Property<"escape-non-printables", "Boolean">, 187 Global, 188 DefaultTrue, 189 Desc<"If true, LLDB will automatically escape non-printable and escape characters when formatting strings.">; 190 def FrameFormatUnique: Property<"frame-format-unique", "FormatEntity">, 191 Global, 192 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">, 193 Desc<"The default frame format string to use when displaying stack frame information for threads from thread backtrace unique.">; 194 def ShowAutosuggestion: Property<"show-autosuggestion", "Boolean">, 195 Global, 196 DefaultFalse, 197 Desc<"If true, LLDB will show suggestions to complete the command the user typed. Suggestions may be accepted using Ctrl-F.">; 198 def ShowAutosuggestionAnsiPrefix: Property<"show-autosuggestion-ansi-prefix", "String">, 199 Global, 200 DefaultStringValue<"${ansi.faint}">, 201 Desc<"When displaying suggestion in a color-enabled terminal, use the ANSI terminal code specified in this format immediately before the suggestion.">; 202 def ShowAutosuggestionAnsiSuffix: Property<"show-autosuggestion-ansi-suffix", "String">, 203 Global, 204 DefaultStringValue<"${ansi.normal}">, 205 Desc<"When displaying suggestion in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the suggestion.">; 206 def ShowRegexMatchAnsiPrefix: Property<"show-regex-match-ansi-prefix", "String">, 207 Global, 208 DefaultStringValue<"${ansi.fg.red}">, 209 Desc<"When displaying a regex match in a color-enabled terminal, use the ANSI terminal code specified in this format immediately before the match.">; 210 def ShowRegexMatchAnsiSuffix: Property<"show-regex-match-ansi-suffix", "String">, 211 Global, 212 DefaultStringValue<"${ansi.normal}">, 213 Desc<"When displaying a regex match in a color-enabled terminal, use the ANSI terminal code specified in this format immediately after the match.">; 214 def ShowDontUsePoHint: Property<"show-dont-use-po-hint", "Boolean">, 215 Global, 216 DefaultTrue, 217 Desc<"If true, and object description was requested for a type that does not implement it, LLDB will print a hint telling the user to consider using p instead.">; 218 def DWIMPrintVerbosity: Property<"dwim-print-verbosity", "Enum">, 219 Global, 220 DefaultEnumValue<"eDWIMPrintVerbosityNone">, 221 EnumValues<"OptionEnumValues(g_dwim_print_verbosities)">, 222 Desc<"The verbosity level used by dwim-print.">; 223} 224