squiid/llvm
1
0
Fork 0
Code Issues Pull requests Activity

[lldb] Refactor command option enum values (NFC)

Browse source 
Refactor the command option enum values and the command argument table
to connect the two. This has two benefits:

 - We guarantee that two options that use the same argument type have
   the same accepted values.
 - We can print the enum values and their description in the help
   output. (D129707)

Differential revision: https://reviews.llvm.org/D129703
This commit is contained in:
Jonas Devlieghere 2022-07-13 20:11:37 -07:00
parent 888673b6e3
commit 7ced9fff95
No known key found for this signature in database
GPG key ID: 49CC0BD90FDEED4D
39 changed files with 734 additions and 753 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
lldb/include/lldb/Interpreter/CommandObject.h
View file

@ -77,17 +77,18 @@ public:
explicit operator bool() const { return (help_callback != nullptr); }
};
struct ArgumentTableEntry // Entries in the main argument information table
{
/// Entries in the main argument information table.
struct ArgumentTableEntry {
lldb::CommandArgumentType arg_type;
const char *arg_name;
CommandCompletions::CommonCompletionTypes completion_type;
OptionEnumValues enum_values;
ArgumentHelpCallback help_function;
const char *help_text;
};
struct CommandArgumentData // Used to build individual command argument lists
{
/// Used to build individual command argument lists.
struct CommandArgumentData {
lldb::CommandArgumentType arg_type;
ArgumentRepetitionType arg_repetition;
/// This arg might be associated only with some particular option set(s). By
@ -199,8 +200,6 @@ public:
virtual Options *GetOptions();
static const ArgumentTableEntry *GetArgumentTable();
static lldb::CommandArgumentType LookupArgumentName(llvm::StringRef arg_name);
static const ArgumentTableEntry *

334
lldb/include/lldb/Interpreter/CommandOptionArgumentTable.h Normal file
View file

@ -0,0 +1,334 @@
//===-- CommandOptionArgumentTable.h ----------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_INTERPRETER_COMMANDOPTIONARGUMENTTABLE_H
#define LLDB_INTERPRETER_COMMANDOPTIONARGUMENTTABLE_H
#include "lldb/Interpreter/CommandObject.h"
namespace lldb_private {
static constexpr OptionEnumValueElement g_corefile_save_style[] = {
{lldb::eSaveCoreFull, "full", "Create a core file with all memory saved"},
{lldb::eSaveCoreDirtyOnly, "modified-memory",
"Create a corefile with only modified memory saved"},
{lldb::eSaveCoreStackOnly, "stack",
"Create a corefile with only stack memory saved"},
};
static constexpr OptionEnumValueElement g_description_verbosity_type[] = {
{
eLanguageRuntimeDescriptionDisplayVerbosityCompact,
"compact",
"Only show the description string",
},
{
eLanguageRuntimeDescriptionDisplayVerbosityFull,
"full",
"Show the full output, including persistent variable's name and type",
},
};
static constexpr OptionEnumValueElement g_sort_option_enumeration[] = {
{
eSortOrderNone,
"none",
"No sorting, use the original symbol table order.",
},
{
eSortOrderByAddress,
"address",
"Sort output by symbol address.",
},
{
eSortOrderByName,
"name",
"Sort output by symbol name.",
},
};
// Note that the negation in the argument name causes a slightly confusing
// mapping of the enum values.
static constexpr OptionEnumValueElement g_dependents_enumeration[] = {
{
eLoadDependentsDefault,
"default",
"Only load dependents when the target is an executable.",
},
{
eLoadDependentsNo,
"true",
"Don't load dependents, even if the target is an executable.",
},
{
eLoadDependentsYes,
"false",
"Load dependents, even if the target is not an executable.",
},
};
// FIXME: "script-type" needs to have its contents determined dynamically, so
// somebody can add a new scripting language to lldb and have it pickable here
// without having to change this enumeration by hand and rebuild lldb proper.
static constexpr OptionEnumValueElement g_script_option_enumeration[] = {
{
lldb::eScriptLanguageNone,
"command",
"Commands are in the lldb command interpreter language",
},
{
lldb::eScriptLanguagePython,
"python",
"Commands are in the Python language.",
},
{
lldb::eScriptLanguageLua,
"lua",
"Commands are in the Lua language.",
},
{
lldb::eScriptLanguageNone,
"default",
"Commands are in the default scripting language.",
},
};
static constexpr OptionEnumValueElement g_log_handler_type[] = {
{
eLogHandlerDefault,
"default",
"Use the default (stream) log handler",
},
{
eLogHandlerStream,
"stream",
"Write log messages to the debugger output stream or to a file if one "
"is specified. A buffer size (in bytes) can be specified with -b. If "
"no buffer size is specified the output is unbuffered.",
},
{
eLogHandlerCircular,
"circular",
"Write log messages to a fixed size circular buffer. A buffer size "
"(number of messages) must be specified with -b.",
},
{
eLogHandlerSystem,
"os",
"Write log messages to the operating system log.",
},
};
static constexpr OptionEnumValueElement g_reproducer_provider_type[] = {
{
eReproducerProviderCommands,
"commands",
"Command Interpreter Commands",
},
{
eReproducerProviderFiles,
"files",
"Files",
},
{
eReproducerProviderSymbolFiles,
"symbol-files",
"Symbol Files",
},
{
eReproducerProviderGDB,
"gdb",
"GDB Remote Packets",
},
{
eReproducerProviderProcessInfo,
"processes",
"Process Info",
},
{
eReproducerProviderVersion,
"version",
"Version",
},
{
eReproducerProviderWorkingDirectory,
"cwd",
"Working Directory",
},
{
eReproducerProviderHomeDirectory,
"home",
"Home Directory",
},
{
eReproducerProviderNone,
"none",
"None",
},
};
static constexpr OptionEnumValueElement g_reproducer_signaltype[] = {
{
eReproducerCrashSigill,
"SIGILL",
"Illegal instruction",
},
{
eReproducerCrashSigsegv,
"SIGSEGV",
"Segmentation fault",
},
};
static constexpr OptionEnumValueElement g_script_synchro_type[] = {
{
eScriptedCommandSynchronicitySynchronous,
"synchronous",
"Run synchronous",
},
{
eScriptedCommandSynchronicityAsynchronous,
"asynchronous",
"Run asynchronous",
},
{
eScriptedCommandSynchronicityCurrentValue,
"current",
"Do not alter current setting",
},
};
static constexpr OptionEnumValueElement g_running_mode[] = {
{lldb::eOnlyThisThread, "this-thread", "Run only this thread"},
{lldb::eAllThreads, "all-threads", "Run all threads"},
{lldb::eOnlyDuringStepping, "while-stepping",
"Run only this thread while stepping"},
};
llvm::StringRef RegisterNameHelpTextCallback();
llvm::StringRef BreakpointIDHelpTextCallback();
llvm::StringRef BreakpointIDRangeHelpTextCallback();
llvm::StringRef BreakpointNameHelpTextCallback();
llvm::StringRef GDBFormatHelpTextCallback();
llvm::StringRef FormatHelpTextCallback();
llvm::StringRef LanguageTypeHelpTextCallback();
llvm::StringRef SummaryStringHelpTextCallback();
llvm::StringRef ExprPathHelpTextCallback();
llvm::StringRef arch_helper();
static constexpr CommandObject::ArgumentTableEntry g_argument_table[] = {
// clang-format off
{ lldb::eArgTypeAddress, "address", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A valid address in the target program's execution space." },
{ lldb::eArgTypeAddressOrExpression, "address-expression", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An expression that resolves to an address." },
{ lldb::eArgTypeAliasName, "alias-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of an abbreviation (alias) for a debugger command." },
{ lldb::eArgTypeAliasOptions, "options-for-aliased-command", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Command options to be used as part of an alias (abbreviation) definition. (See 'help commands alias' for more information.)" },
{ lldb::eArgTypeArchitecture, "arch", CommandCompletions::eArchitectureCompletion, {}, { arch_helper, true }, "The architecture name, e.g. i386 or x86_64." },
{ lldb::eArgTypeBoolean, "boolean", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A Boolean value: 'true' or 'false'" },
{ lldb::eArgTypeBreakpointID, "breakpt-id", CommandCompletions::eNoCompletion, {}, { BreakpointIDHelpTextCallback, false }, nullptr },
{ lldb::eArgTypeBreakpointIDRange, "breakpt-id-list", CommandCompletions::eNoCompletion, {}, { BreakpointIDRangeHelpTextCallback, false }, nullptr },
{ lldb::eArgTypeBreakpointName, "breakpoint-name", CommandCompletions::eBreakpointNameCompletion, {}, { BreakpointNameHelpTextCallback, false }, nullptr },
{ lldb::eArgTypeByteSize, "byte-size", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Number of bytes to use." },
{ lldb::eArgTypeClassName, "class-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Then name of a class from the debug information in the program." },
{ lldb::eArgTypeCommandName, "cmd-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A debugger command (may be multiple words), without any options or arguments." },
{ lldb::eArgTypeCount, "count", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An unsigned integer." },
{ lldb::eArgTypeDescriptionVerbosity, "description-verbosity", CommandCompletions::eNoCompletion, g_description_verbosity_type, { nullptr, false }, "How verbose the output of 'po' should be." },
{ lldb::eArgTypeDirectoryName, "directory", CommandCompletions::eDiskDirectoryCompletion, {}, { nullptr, false }, "A directory name." },
{ lldb::eArgTypeDisassemblyFlavor, "disassembly-flavor", CommandCompletions::eDisassemblyFlavorCompletion, {}, { nullptr, false }, "A disassembly flavor recognized by your disassembly plugin. Currently the only valid options are \"att\" and \"intel\" for Intel targets" },
{ lldb::eArgTypeEndAddress, "end-address", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeExpression, "expr", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeExpressionPath, "expr-path", CommandCompletions::eNoCompletion, {}, { ExprPathHelpTextCallback, true }, nullptr },
{ lldb::eArgTypeExprFormat, "expression-format", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "[ [bool|b] | [bin] | [char|c] | [oct|o] | [dec|i|d|u] | [hex|x] | [float|f] | [cstr|s] ]" },
{ lldb::eArgTypeFileLineColumn, "linespec", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A source specifier in the form file:line[:column]" },
{ lldb::eArgTypeFilename, "filename", CommandCompletions::eDiskFileCompletion, {}, { nullptr, false }, "The name of a file (can include path)." },
{ lldb::eArgTypeFormat, "format", CommandCompletions::eNoCompletion, {}, { FormatHelpTextCallback, true }, nullptr },
{ lldb::eArgTypeFrameIndex, "frame-index", CommandCompletions::eFrameIndexCompletion, {}, { nullptr, false }, "Index into a thread's list of frames." },
{ lldb::eArgTypeFullName, "fullname", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeFunctionName, "function-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a function." },
{ lldb::eArgTypeFunctionOrSymbol, "function-or-symbol", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a function or symbol." },
{ lldb::eArgTypeGDBFormat, "gdb-format", CommandCompletions::eNoCompletion, {}, { GDBFormatHelpTextCallback, true }, nullptr },
{ lldb::eArgTypeHelpText, "help-text", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Text to be used as help for some other entity in LLDB" },
{ lldb::eArgTypeIndex, "index", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An index into a list." },
{ lldb::eArgTypeLanguage, "source-language", CommandCompletions::eTypeLanguageCompletion, {}, { LanguageTypeHelpTextCallback, true }, nullptr },
{ lldb::eArgTypeLineNum, "linenum", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Line number in a source file." },
{ lldb::eArgTypeLogCategory, "log-category", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a category within a log channel, e.g. all (try \"log list\" to see a list of all channels and their categories." },
{ lldb::eArgTypeLogChannel, "log-channel", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a log channel, e.g. process.gdb-remote (try \"log list\" to see a list of all channels and their categories)." },
{ lldb::eArgTypeMethod, "method", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A C++ method name." },
{ lldb::eArgTypeName, "name", CommandCompletions::eTypeCategoryNameCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeNewPathPrefix, "new-path-prefix", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeNumLines, "num-lines", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The number of lines to use." },
{ lldb::eArgTypeNumberPerLine, "number-per-line", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The number of items per line to display." },
{ lldb::eArgTypeOffset, "offset", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeOldPathPrefix, "old-path-prefix", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeOneLiner, "one-line-command", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A command that is entered as a single line of text." },
{ lldb::eArgTypePath, "path", CommandCompletions::eDiskFileCompletion, {}, { nullptr, false }, "Path." },
{ lldb::eArgTypePermissionsNumber, "perms-numeric", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Permissions given as an octal number (e.g. 755)." },
{ lldb::eArgTypePermissionsString, "perms=string", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Permissions given as a string value (e.g. rw-r-xr--)." },
{ lldb::eArgTypePid, "pid", CommandCompletions::eProcessIDCompletion, {}, { nullptr, false }, "The process ID number." },
{ lldb::eArgTypePlugin, "plugin", CommandCompletions::eProcessPluginCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeProcessName, "process-name", CommandCompletions::eProcessNameCompletion, {}, { nullptr, false }, "The name of the process." },
{ lldb::eArgTypePythonClass, "python-class", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a Python class." },
{ lldb::eArgTypePythonFunction, "python-function", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a Python function." },
{ lldb::eArgTypePythonScript, "python-script", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Source code written in Python." },
{ lldb::eArgTypeQueueName, "queue-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of the thread queue." },
{ lldb::eArgTypeRegisterName, "register-name", CommandCompletions::eNoCompletion, {}, { RegisterNameHelpTextCallback, true }, nullptr },
{ lldb::eArgTypeRegularExpression, "regular-expression", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A POSIX-compliant extended regular expression." },
{ lldb::eArgTypeRunArgs, "run-args", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Arguments to be passed to the target program when it starts executing." },
{ lldb::eArgTypeRunMode, "run-mode", CommandCompletions::eNoCompletion, g_running_mode, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeScriptedCommandSynchronicity, "script-cmd-synchronicity", CommandCompletions::eNoCompletion, g_script_synchro_type, { nullptr, false }, "The synchronicity to use to run scripted commands with regard to LLDB event system." },
{ lldb::eArgTypeScriptLang, "script-language", CommandCompletions::eNoCompletion, g_script_option_enumeration, { nullptr, false }, "The scripting language to be used for script-based commands. Supported languages are python and lua." },
{ lldb::eArgTypeSearchWord, "search-word", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Any word of interest for search purposes." },
{ lldb::eArgTypeSelector, "selector", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An Objective-C selector name." },
{ lldb::eArgTypeSettingIndex, "setting-index", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An index into a settings variable that is an array (try 'settings list' to see all the possible settings variables and their types)." },
{ lldb::eArgTypeSettingKey, "setting-key", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A key into a settings variables that is a dictionary (try 'settings list' to see all the possible settings variables and their types)." },
{ lldb::eArgTypeSettingPrefix, "setting-prefix", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a settable internal debugger variable up to a dot ('.'), e.g. 'target.process.'" },
{ lldb::eArgTypeSettingVariableName, "setting-variable-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a settable internal debugger variable. Type 'settings list' to see a complete list of such variables." },
{ lldb::eArgTypeShlibName, "shlib-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The name of a shared library." },
{ lldb::eArgTypeSourceFile, "source-file", CommandCompletions::eSourceFileCompletion, {}, { nullptr, false }, "The name of a source file.." },
{ lldb::eArgTypeSortOrder, "sort-order", CommandCompletions::eNoCompletion, g_sort_option_enumeration, { nullptr, false }, "Specify a sort order when dumping lists." },
{ lldb::eArgTypeStartAddress, "start-address", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeSummaryString, "summary-string", CommandCompletions::eNoCompletion, {}, { SummaryStringHelpTextCallback, true }, nullptr },
{ lldb::eArgTypeSymbol, "symbol", CommandCompletions::eSymbolCompletion, {}, { nullptr, false }, "Any symbol name (function name, variable, argument, etc.)" },
{ lldb::eArgTypeThreadID, "thread-id", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Thread ID number." },
{ lldb::eArgTypeThreadIndex, "thread-index", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Index into the process' list of threads." },
{ lldb::eArgTypeThreadName, "thread-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The thread's name." },
{ lldb::eArgTypeTypeName, "type-name", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A type name." },
{ lldb::eArgTypeUnsignedInteger, "unsigned-integer", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An unsigned integer." },
{ lldb::eArgTypeUnixSignal, "unix-signal", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A valid Unix signal name or number (e.g. SIGKILL, KILL or 9)." },
{ lldb::eArgTypeVarName, "variable-name", CommandCompletions::eNoCompletion, {} ,{ nullptr, false }, "The name of a variable in your program." },
{ lldb::eArgTypeValue, "value", CommandCompletions::eNoCompletion, g_dependents_enumeration, { nullptr, false }, "A value could be anything, depending on where and how it is used." },
{ lldb::eArgTypeWidth, "width", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Help text goes here." },
{ lldb::eArgTypeNone, "none", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "No help available for this." },
{ lldb::eArgTypePlatform, "platform-name", CommandCompletions::ePlatformPluginCompletion, {}, { nullptr, false }, "The name of an installed platform plug-in . Type 'platform list' to see a complete list of installed platforms." },
{ lldb::eArgTypeWatchpointID, "watchpt-id", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Watchpoint IDs are positive integers." },
{ lldb::eArgTypeWatchpointIDRange, "watchpt-id-list", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "For example, '1-3' or '1 to 3'." },
{ lldb::eArgTypeWatchType, "watch-type", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Specify the type for a watchpoint." },
{ lldb::eArgRawInput, "raw-input", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Free-form text passed to a command without prior interpretation, allowing spaces without requiring quotes. To pass arguments and free form text put two dashes ' -- ' between the last argument and any raw input." },
{ lldb::eArgTypeCommand, "command", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "An LLDB Command line command element." },
{ lldb::eArgTypeColumnNum, "column", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "Column number in a source file." },
{ lldb::eArgTypeModuleUUID, "module-uuid", CommandCompletions::eModuleUUIDCompletion, {}, { nullptr, false }, "A module UUID value." },
{ lldb::eArgTypeSaveCoreStyle, "corefile-style", CommandCompletions::eNoCompletion, g_corefile_save_style, { nullptr, false }, "The type of corefile that lldb will try to create, dependant on this target's capabilities." },
{ lldb::eArgTypeLogHandler, "log-handler", CommandCompletions::eNoCompletion, g_log_handler_type ,{ nullptr, false }, "The log handle that will be used to write out log messages." },
{ lldb::eArgTypeSEDStylePair, "substitution-pair", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A sed-style pattern and target pair." },
{ lldb::eArgTypeRecognizerID, "frame-recognizer-id", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The ID for a stack frame recognizer." },
{ lldb::eArgTypeConnectURL, "process-connect-url", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "A URL-style specification for a remote connection." },
{ lldb::eArgTypeTargetID, "target-id", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The index ID for an lldb Target." },
{ lldb::eArgTypeStopHookID, "stop-hook-id", CommandCompletions::eNoCompletion, {}, { nullptr, false }, "The ID you receive when you create a stop-hook." },
{ lldb::eArgTypeReproducerProvider, "reproducer-provider", CommandCompletions::eNoCompletion, g_reproducer_provider_type, { nullptr, false }, "The reproducer provider." },
{ lldb::eArgTypeReproducerSignal, "reproducer-signal", CommandCompletions::eNoCompletion, g_reproducer_signaltype, { nullptr, false }, "The signal used to emulate a reproducer crash." },
// clang-format on
};
static_assert((sizeof(g_argument_table) /
sizeof(CommandObject::ArgumentTableEntry)) ==
lldb::eArgTypeLastArg,
"number of elements in g_argument_table doesn't match "
"CommandArgumentType enumeration");
} // namespace lldb_private
#endif // LLDB_INTERPRETER_COMMANDOPTIONARGUMENTTABLE_H

6
lldb/include/lldb/Target/Target.h
View file

@ -59,12 +59,6 @@ enum LoadCWDlldbinitFile {
eLoadCWDlldbinitWarn
};
enum LoadDependentFiles {
eLoadDependentsDefault,
eLoadDependentsYes,
eLoadDependentsNo,
};
enum ImportStdModule {
eImportStdModuleFalse,
eImportStdModuleFallback,

2
lldb/include/lldb/lldb-enumerations.h
View file

@ -608,6 +608,8 @@ enum CommandArgumentType {
eArgTypeConnectURL,
eArgTypeTargetID,
eArgTypeStopHookID,
eArgTypeReproducerProvider,
eArgTypeReproducerSignal,
eArgTypeLastArg // Always keep this entry as the last entry in this
// enumeration!!
};

23
lldb/include/lldb/lldb-private-enumerations.h
View file

@ -231,6 +231,29 @@ enum LogHandlerKind {
eLogHandlerDefault = eLogHandlerStream,
};
enum ReproducerProvider {
eReproducerProviderCommands,
eReproducerProviderFiles,
eReproducerProviderSymbolFiles,
eReproducerProviderGDB,
eReproducerProviderProcessInfo,
eReproducerProviderVersion,
eReproducerProviderWorkingDirectory,
eReproducerProviderHomeDirectory,
eReproducerProviderNone,
};
enum ReproducerCrashSignal {
eReproducerCrashSigill,
eReproducerCrashSigsegv,
};
enum LoadDependentFiles {
eLoadDependentsDefault,
eLoadDependentsYes,
eLoadDependentsNo,
};
inline std::string GetStatDescription(lldb_private::StatisticKind K) {
switch (K) {
case StatisticKind::ExpressionSuccessful:

1
lldb/source/Commands/CMakeLists.txt
View file

@ -38,6 +38,7 @@ add_lldb_library(lldbCommands
CommandObjectVersion.cpp
CommandObjectWatchpoint.cpp
CommandObjectWatchpointCommand.cpp
CommandOptionArgumentTable.cpp
CommandOptionsProcessLaunch.cpp
LINK_LIBS

1
lldb/source/Commands/CommandObjectBreakpoint.cpp
View file

@ -13,6 +13,7 @@
#include "lldb/Breakpoint/BreakpointLocation.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupPythonClassWithDict.h"

31
lldb/source/Commands/CommandObjectBreakpointCommand.cpp
View file

@ -14,6 +14,7 @@
#include "lldb/Core/IOHandler.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupPythonClassWithDict.h"
@ -22,36 +23,6 @@
using namespace lldb;
using namespace lldb_private;
// FIXME: "script-type" needs to have its contents determined dynamically, so
// somebody can add a new scripting language to lldb and have it pickable here
// without having to change this enumeration by hand and rebuild lldb proper.
static constexpr OptionEnumValueElement g_script_option_enumeration[] = {
{
eScriptLanguageNone,
"command",
"Commands are in the lldb command interpreter language",
},
{
eScriptLanguagePython,
"python",
"Commands are in the Python language.",
},
{
eScriptLanguageLua,
"lua",
"Commands are in the Lua language.",
},
{
eScriptLanguageDefault,
"default-script",
"Commands are in the default scripting language.",
},
};
static constexpr OptionEnumValues ScriptOptionEnum() {
return OptionEnumValues(g_script_option_enumeration);
}
#define LLDB_OPTIONS_breakpoint_command_add
#include "CommandOptions.inc"

24
lldb/source/Commands/CommandObjectCommands.cpp
View file

@ -13,6 +13,7 @@
#include "lldb/Core/IOHandler.h"
#include "lldb/Interpreter/CommandHistory.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionValueBoolean.h"
@ -1354,29 +1355,6 @@ protected:
CommandOptions m_options;
};
// CommandObjectCommandsScriptAdd
static constexpr OptionEnumValueElement g_script_synchro_type[] = {
{
eScriptedCommandSynchronicitySynchronous,
"synchronous",
"Run synchronous",
},
{
eScriptedCommandSynchronicityAsynchronous,
"asynchronous",
"Run asynchronous",
},
{
eScriptedCommandSynchronicityCurrentValue,
"current",
"Do not alter current setting",
},
};
static constexpr OptionEnumValues ScriptSynchroType() {
return OptionEnumValues(g_script_synchro_type);
}
#define LLDB_OPTIONS_script_add
#include "CommandOptions.inc"

1
lldb/source/Commands/CommandObjectDisassemble.cpp
View file

@ -12,6 +12,7 @@
#include "lldb/Core/Module.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/Options.h"

18
lldb/source/Commands/CommandObjectExpression.cpp
View file

@ -14,6 +14,7 @@
#include "lldb/Expression/UserExpression.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Target/Language.h"
@ -28,23 +29,6 @@ CommandObjectExpression::CommandOptions::CommandOptions() = default;
CommandObjectExpression::CommandOptions::~CommandOptions() = default;
static constexpr OptionEnumValueElement g_description_verbosity_type[] = {
{
eLanguageRuntimeDescriptionDisplayVerbosityCompact,
"compact",
"Only show the description string",
},
{
eLanguageRuntimeDescriptionDisplayVerbosityFull,
"full",
"Show the full output, including persistent variable's name and type",
},
};
static constexpr OptionEnumValues DescriptionVerbosityTypes() {
return OptionEnumValues(g_description_verbosity_type);
}
#define LLDB_OPTIONS_expression
#include "CommandOptions.inc"

1
lldb/source/Commands/CommandObjectFrame.cpp
View file

@ -13,6 +13,7 @@
#include "lldb/Host/Config.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupFormat.h"

1
lldb/source/Commands/CommandObjectHelp.cpp
View file

@ -8,6 +8,7 @@
#include "CommandObjectHelp.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
using namespace lldb;

31
lldb/source/Commands/CommandObjectLog.cpp
View file

@ -9,6 +9,7 @@
#include "CommandObjectLog.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionValueEnumeration.h"
@ -23,36 +24,6 @@
using namespace lldb;
using namespace lldb_private;
static constexpr OptionEnumValueElement g_log_handler_type[] = {
{
eLogHandlerDefault,
"default",
"Use the default (stream) log handler",
},
{
eLogHandlerStream,
"stream",
"Write log messages to the debugger output stream or to a file if one "
"is specified. A buffer size (in bytes) can be specified with -b. If "
"no buffer size is specified the output is unbuffered.",
},
{
eLogHandlerCircular,
"circular",
"Write log messages to a fixed size circular buffer. A buffer size "
"(number of messages) must be specified with -b.",
},
{
eLogHandlerSystem,
"os",
"Write log messages to the operating system log.",
},
};
static constexpr OptionEnumValues LogHandlerType() {
return OptionEnumValues(g_log_handler_type);
}
#define LLDB_OPTIONS_log_enable
#include "CommandOptions.inc"

1
lldb/source/Commands/CommandObjectMemory.cpp
View file

@ -13,6 +13,7 @@
#include "lldb/Core/ValueObjectMemory.h"
#include "lldb/Expression/ExpressionVariable.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupFormat.h"

1
lldb/source/Commands/CommandObjectMemoryTag.cpp
View file

@ -8,6 +8,7 @@
#include "CommandObjectMemoryTag.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupFormat.h"

1
lldb/source/Commands/CommandObjectPlatform.cpp
View file

@ -13,6 +13,7 @@
#include "lldb/Core/PluginManager.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandOptionValidators.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionGroupFile.h"

17
lldb/source/Commands/CommandObjectProcess.cpp
View file

@ -7,8 +7,8 @@
//===----------------------------------------------------------------------===//
#include "CommandObjectProcess.h"
#include "CommandObjectTrace.h"
#include "CommandObjectBreakpoint.h"
#include "CommandObjectTrace.h"
#include "CommandOptionsProcessLaunch.h"
#include "lldb/Breakpoint/Breakpoint.h"
#include "lldb/Breakpoint/BreakpointIDList.h"
@ -19,6 +19,7 @@
#include "lldb/Core/PluginManager.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupPythonClassWithDict.h"
@ -1332,20 +1333,6 @@ protected:
}
};
// CommandObjectProcessSaveCore
#pragma mark CommandObjectProcessSaveCore
static constexpr OptionEnumValueElement g_corefile_save_style[] = {
{eSaveCoreFull, "full", "Create a core file with all memory saved"},
{eSaveCoreDirtyOnly, "modified-memory",
"Create a corefile with only modified memory saved"},
{eSaveCoreStackOnly, "stack",
"Create a corefile with only stack memory saved"}};
static constexpr OptionEnumValues SaveCoreStyles() {
return OptionEnumValues(g_corefile_save_style);
}
#define LLDB_OPTIONS_process_save_core
#include "CommandOptions.inc"

1
lldb/source/Commands/CommandObjectRegister.cpp
View file

@ -10,6 +10,7 @@
#include "lldb/Core/Debugger.h"
#include "lldb/Core/DumpRegisterValue.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionGroupFormat.h"
#include "lldb/Interpreter/OptionValueArray.h"

87
lldb/source/Commands/CommandObjectReproducer.cpp
View file

@ -11,6 +11,7 @@
#include "lldb/Host/HostInfo.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Utility/GDBRemote.h"
@ -24,95 +25,9 @@ using namespace llvm;
using namespace lldb_private;
using namespace lldb_private::repro;
enum ReproducerProvider {
eReproducerProviderCommands,
eReproducerProviderFiles,
eReproducerProviderSymbolFiles,
eReproducerProviderGDB,
eReproducerProviderProcessInfo,
eReproducerProviderVersion,
eReproducerProviderWorkingDirectory,
eReproducerProviderHomeDirectory,
eReproducerProviderNone
};
static constexpr OptionEnumValueElement g_reproducer_provider_type[] = {
{
eReproducerProviderCommands,
"commands",
"Command Interpreter Commands",
},
{
eReproducerProviderFiles,
"files",
"Files",
},
{
eReproducerProviderSymbolFiles,
"symbol-files",
"Symbol Files",
},
{
eReproducerProviderGDB,
"gdb",
"GDB Remote Packets",
},
{
eReproducerProviderProcessInfo,
"processes",
"Process Info",
},
{
eReproducerProviderVersion,
"version",
"Version",
},
{
eReproducerProviderWorkingDirectory,
"cwd",
"Working Directory",
},
{
eReproducerProviderHomeDirectory,
"home",
"Home Directory",
},
{
eReproducerProviderNone,
"none",
"None",
},
};
static constexpr OptionEnumValues ReproducerProviderType() {
return OptionEnumValues(g_reproducer_provider_type);
}
#define LLDB_OPTIONS_reproducer_dump
#include "CommandOptions.inc"
enum ReproducerCrashSignal {
eReproducerCrashSigill,
eReproducerCrashSigsegv,
};
static constexpr OptionEnumValueElement g_reproducer_signaltype[] = {
{
eReproducerCrashSigill,
"SIGILL",
"Illegal instruction",
},
{
eReproducerCrashSigsegv,
"SIGSEGV",
"Segmentation fault",
},
};
static constexpr OptionEnumValues ReproducerSignalType() {
return OptionEnumValues(g_reproducer_signaltype);
}
#define LLDB_OPTIONS_reproducer_xcrash
#include "CommandOptions.inc"

23
lldb/source/Commands/CommandObjectScript.cpp
View file

@ -12,6 +12,7 @@
#include "lldb/Host/Config.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/ScriptInterpreter.h"
@ -20,28 +21,6 @@
using namespace lldb;
using namespace lldb_private;
static constexpr OptionEnumValueElement g_script_option_enumeration[] = {
{
eScriptLanguagePython,
"python",
"Python",
},
{
eScriptLanguageLua,
"lua",
"Lua",
},
{
eScriptLanguageNone,
"default",
"The default scripting language.",
},
};
static constexpr OptionEnumValues ScriptOptionEnum() {
return OptionEnumValues(g_script_option_enumeration);
}
#define LLDB_OPTIONS_script
#include "CommandOptions.inc"

1
lldb/source/Commands/CommandObjectSession.cpp
View file

@ -1,6 +1,7 @@
#include "CommandObjectSession.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionValue.h"

1
lldb/source/Commands/CommandObjectSettings.cpp
View file

@ -13,6 +13,7 @@
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandCompletions.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionValueProperties.h"

1
lldb/source/Commands/CommandObjectSource.cpp
View file

@ -14,6 +14,7 @@
#include "lldb/Core/ModuleSpec.h"
#include "lldb/Core/SourceManager.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionValueFileColonLine.h"

1
lldb/source/Commands/CommandObjectStats.cpp
View file

@ -9,6 +9,7 @@
#include "CommandObjectStats.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Target/Target.h"

41
lldb/source/Commands/CommandObjectTarget.cpp
View file

@ -17,6 +17,7 @@
#include "lldb/DataFormatters/ValueObjectPrinter.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupArchitecture.h"
@ -142,26 +143,6 @@ static uint32_t DumpTargetList(TargetList &target_list,
return num_targets;
}
// Note that the negation in the argument name causes a slightly confusing
// mapping of the enum values.
static constexpr OptionEnumValueElement g_dependents_enumeration[] = {
{
eLoadDependentsDefault,
"default",
"Only load dependents when the target is an executable.",
},
{
eLoadDependentsNo,
"true",
"Don't load dependents, even if the target is an executable.",
},
{
eLoadDependentsYes,
"false",
"Load dependents, even if the target is not an executable.",
},
};
#define LLDB_OPTIONS_target_dependents
#include "CommandOptions.inc"
@ -1923,26 +1904,6 @@ protected:
}
};
#pragma mark CommandObjectTargetModulesDumpSymtab
static constexpr OptionEnumValueElement g_sort_option_enumeration[] = {
{
eSortOrderNone,
"none",
"No sorting, use the original symbol table order.",
},
{
eSortOrderByAddress,
"address",
"Sort output by symbol address.",
},
{
eSortOrderByName,
"name",
"Sort output by symbol name.",
},
};
#define LLDB_OPTIONS_target_modules_dump_symtab
#include "CommandOptions.inc"

19
lldb/source/Commands/CommandObjectThread.cpp
View file

@ -17,6 +17,7 @@
#include "lldb/Core/ValueObject.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupPythonClassWithDict.h"
@ -239,16 +240,6 @@ protected:
enum StepScope { eStepScopeSource, eStepScopeInstruction };
static constexpr OptionEnumValueElement g_tri_running_mode[] = {
{eOnlyThisThread, "this-thread", "Run only this thread"},
{eAllThreads, "all-threads", "Run all threads"},
{eOnlyDuringStepping, "while-stepping",
"Run only this thread while stepping"}};
static constexpr OptionEnumValues TriRunningModes() {
return OptionEnumValues(g_tri_running_mode);
}
#define LLDB_OPTIONS_thread_step_scope
#include "CommandOptions.inc"
@ -813,14 +804,6 @@ public:
// CommandObjectThreadUntil
static constexpr OptionEnumValueElement g_duo_running_mode[] = {
{eOnlyThisThread, "this-thread", "Run only this thread"},
{eAllThreads, "all-threads", "Run all threads"}};
static constexpr OptionEnumValues DuoRunningModes() {
return OptionEnumValues(g_duo_running_mode);
}
#define LLDB_OPTIONS_thread_until
#include "CommandOptions.inc"

1
lldb/source/Commands/CommandObjectTrace.cpp
View file

@ -16,6 +16,7 @@
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandObject.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupFormat.h"

1
lldb/source/Commands/CommandObjectType.cpp
View file

@ -15,6 +15,7 @@
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandObject.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Interpreter/OptionGroupFormat.h"

1
lldb/source/Commands/CommandObjectWatchpoint.cpp
View file

@ -18,6 +18,7 @@
#include "lldb/Core/ValueObject.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Symbol/Variable.h"
#include "lldb/Symbol/VariableList.h"

31
lldb/source/Commands/CommandObjectWatchpointCommand.cpp
View file

@ -15,6 +15,7 @@
#include "lldb/Core/IOHandler.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Target/Target.h"
@ -22,36 +23,6 @@
using namespace lldb;
using namespace lldb_private;
// FIXME: "script-type" needs to have its contents determined dynamically, so
// somebody can add a new scripting language to lldb and have it pickable here
// without having to change this enumeration by hand and rebuild lldb proper.
static constexpr OptionEnumValueElement g_script_option_enumeration[] = {
{
eScriptLanguageNone,
"command",
"Commands are in the lldb command interpreter language",
},
{
eScriptLanguagePython,
"python",
"Commands are in the Python language.",
},
{
eScriptLanguageLua,
"lua",
"Commands are in the Lua language.",
},
{
eSortOrderByName,
"default-script",
"Commands are in the default scripting language.",
},
};
static constexpr OptionEnumValues ScriptOptionEnum() {
return OptionEnumValues(g_script_option_enumeration);
}
#define LLDB_OPTIONS_watchpoint_command_add
#include "CommandOptions.inc"

313
lldb/source/Commands/CommandOptionArgumentTable.cpp Normal file
View file

@ -0,0 +1,313 @@
//===-- CommandOptionArgumentTable.cpp ------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/DataFormatters/FormatManager.h"
#include "lldb/Target/Language.h"
#include "lldb/Utility/StreamString.h"
using namespace lldb;
using namespace lldb_private;
namespace lldb_private {
llvm::StringRef RegisterNameHelpTextCallback() {
return "Register names can be specified using the architecture specific "
"names. "
"They can also be specified using generic names. Not all generic "
"entities have "
"registers backing them on all architectures. When they don't the "
"generic name "
"will return an error.\n"
"The generic names defined in lldb are:\n"
"\n"
"pc - program counter register\n"
"ra - return address register\n"
"fp - frame pointer register\n"
"sp - stack pointer register\n"
"flags - the flags register\n"
"arg{1-6} - integer argument passing registers.\n";
}
llvm::StringRef BreakpointIDHelpTextCallback() {
return "Breakpoints are identified using major and minor numbers; the major "
"number corresponds to the single entity that was created with a "
"'breakpoint "
"set' command; the minor numbers correspond to all the locations that "
"were "
"actually found/set based on the major breakpoint. A full breakpoint "
"ID might "
"look like 3.14, meaning the 14th location set for the 3rd "
"breakpoint. You "
"can specify all the locations of a breakpoint by just indicating the "
"major "
"breakpoint number. A valid breakpoint ID consists either of just the "
"major "
"number, or the major number followed by a dot and the location "
"number (e.g. "
"3 or 3.2 could both be valid breakpoint IDs.)";
}
llvm::StringRef BreakpointIDRangeHelpTextCallback() {
return "A 'breakpoint ID list' is a manner of specifying multiple "
"breakpoints. "
"This can be done through several mechanisms. The easiest way is to "
"just "
"enter a space-separated list of breakpoint IDs. To specify all the "
"breakpoint locations under a major breakpoint, you can use the major "
"breakpoint number followed by '.*', eg. '5.*' means all the "
"locations under "
"breakpoint 5. You can also indicate a range of breakpoints by using "
"<start-bp-id> - <end-bp-id>. The start-bp-id and end-bp-id for a "
"range can "
"be any valid breakpoint IDs. It is not legal, however, to specify a "
"range "
"using specific locations that cross major breakpoint numbers. I.e. "
"3.2 - 3.7"
" is legal; 2 - 5 is legal; but 3.2 - 4.4 is not legal.";
}
llvm::StringRef BreakpointNameHelpTextCallback() {
return "A name that can be added to a breakpoint when it is created, or "
"later "
"on with the \"breakpoint name add\" command. "
"Breakpoint names can be used to specify breakpoints in all the "
"places breakpoint IDs "
"and breakpoint ID ranges can be used. As such they provide a "
"convenient way to group breakpoints, "
"and to operate on breakpoints you create without having to track the "
"breakpoint number. "
"Note, the attributes you set when using a breakpoint name in a "
"breakpoint command don't "
"adhere to the name, but instead are set individually on all the "
"breakpoints currently tagged with that "
"name. Future breakpoints "
"tagged with that name will not pick up the attributes previously "
"given using that name. "
"In order to distinguish breakpoint names from breakpoint IDs and "
"ranges, "
"names must start with a letter from a-z or A-Z and cannot contain "
"spaces, \".\" or \"-\". "
"Also, breakpoint names can only be applied to breakpoints, not to "
"breakpoint locations.";
}
llvm::StringRef GDBFormatHelpTextCallback() {
return "A GDB format consists of a repeat count, a format letter and a size "
"letter. "
"The repeat count is optional and defaults to 1. The format letter is "
"optional "
"and defaults to the previous format that was used. The size letter "
"is optional "
"and defaults to the previous size that was used.\n"
"\n"
"Format letters include:\n"
"o - octal\n"
"x - hexadecimal\n"
"d - decimal\n"
"u - unsigned decimal\n"
"t - binary\n"
"f - float\n"
"a - address\n"
"i - instruction\n"
"c - char\n"
"s - string\n"
"T - OSType\n"
"A - float as hex\n"
"\n"
"Size letters include:\n"
"b - 1 byte (byte)\n"
"h - 2 bytes (halfword)\n"
"w - 4 bytes (word)\n"
"g - 8 bytes (giant)\n"
"\n"
"Example formats:\n"
"32xb - show 32 1 byte hexadecimal integer values\n"
"16xh - show 16 2 byte hexadecimal integer values\n"
"64 - show 64 2 byte hexadecimal integer values (format and size "
"from the last format)\n"
"dw - show 1 4 byte decimal integer value\n";
}
llvm::StringRef FormatHelpTextCallback() {
static std::string help_text;
if (!help_text.empty())
return help_text;
StreamString sstr;
sstr << "One of the format names (or one-character names) that can be used "
"to show a variable's value:\n";
for (Format f = eFormatDefault; f < kNumFormats; f = Format(f + 1)) {
if (f != eFormatDefault)
sstr.PutChar('\n');
char format_char = FormatManager::GetFormatAsFormatChar(f);
if (format_char)
sstr.Printf("'%c' or ", format_char);
sstr.Printf("\"%s\"", FormatManager::GetFormatAsCString(f));
}
sstr.Flush();
help_text = std::string(sstr.GetString());
return help_text;
}
llvm::StringRef LanguageTypeHelpTextCallback() {
static std::string help_text;
if (!help_text.empty())
return help_text;
StreamString sstr;
sstr << "One of the following languages:\n";
Language::PrintAllLanguages(sstr, " ", "\n");
sstr.Flush();
help_text = std::string(sstr.GetString());
return help_text;
}
llvm::StringRef SummaryStringHelpTextCallback() {
return "A summary string is a way to extract information from variables in "
"order to present them using a summary.\n"
"Summary strings contain static text, variables, scopes and control "
"sequences:\n"
" - Static text can be any sequence of non-special characters, i.e. "
"anything but '{', '}', '$', or '\\'.\n"
" - Variables are sequences of characters beginning with ${, ending "
"with } and that contain symbols in the format described below.\n"
" - Scopes are any sequence of text between { and }. Anything "
"included in a scope will only appear in the output summary if there "
"were no errors.\n"
" - Control sequences are the usual C/C++ '\\a', '\\n', ..., plus "
"'\\$', '\\{' and '\\}'.\n"
"A summary string works by copying static text verbatim, turning "
"control sequences into their character counterpart, expanding "
"variables and trying to expand scopes.\n"
"A variable is expanded by giving it a value other than its textual "
"representation, and the way this is done depends on what comes after "
"the ${ marker.\n"
"The most common sequence if ${var followed by an expression path, "
"which is the text one would type to access a member of an aggregate "
"types, given a variable of that type"
" (e.g. if type T has a member named x, which has a member named y, "
"and if t is of type T, the expression path would be .x.y and the way "
"to fit that into a summary string would be"
" ${var.x.y}). You can also use ${*var followed by an expression path "
"and in that case the object referred by the path will be "
"dereferenced before being displayed."
" If the object is not a pointer, doing so will cause an error. For "
"additional details on expression paths, you can type 'help "
"expr-path'. \n"
"By default, summary strings attempt to display the summary for any "
"variable they reference, and if that fails the value. If neither can "
"be shown, nothing is displayed."
"In a summary string, you can also use an array index [n], or a "
"slice-like range [n-m]. This can have two different meanings "
"depending on what kind of object the expression"
" path refers to:\n"
" - if it is a scalar type (any basic type like int, float, ...) the "
"expression is a bitfield, i.e. the bits indicated by the indexing "
"operator are extracted out of the number"
" and displayed as an individual variable\n"
" - if it is an array or pointer the array items indicated by the "
"indexing operator are shown as the result of the variable. if the "
"expression is an array, real array items are"
" printed; if it is a pointer, the pointer-as-array syntax is used to "
"obtain the values (this means, the latter case can have no range "
"checking)\n"
"If you are trying to display an array for which the size is known, "
"you can also use [] instead of giving an exact range. This has the "
"effect of showing items 0 thru size - 1.\n"
"Additionally, a variable can contain an (optional) format code, as "
"in ${var.x.y%code}, where code can be any of the valid formats "
"described in 'help format', or one of the"
" special symbols only allowed as part of a variable:\n"
" %V: show the value of the object by default\n"
" %S: show the summary of the object by default\n"
" %@: show the runtime-provided object description (for "
"Objective-C, it calls NSPrintForDebugger; for C/C++ it does "
"nothing)\n"
" %L: show the location of the object (memory address or a "
"register name)\n"
" %#: show the number of children of the object\n"
" %T: show the type of the object\n"
"Another variable that you can use in summary strings is ${svar . "
"This sequence works exactly like ${var, including the fact that "
"${*svar is an allowed sequence, but uses"
" the object's synthetic children provider instead of the actual "
"objects. For instance, if you are using STL synthetic children "
"providers, the following summary string would"
" count the number of actual elements stored in an std::list:\n"
"type summary add -s \"${svar%#}\" -x \"std::list<\"";
}
llvm::StringRef ExprPathHelpTextCallback() {
return "An expression path is the sequence of symbols that is used in C/C++ "
"to access a member variable of an aggregate object (class).\n"
"For instance, given a class:\n"
" class foo {\n"
" int a;\n"
" int b; .\n"
" foo* next;\n"
" };\n"
"the expression to read item b in the item pointed to by next for foo "
"aFoo would be aFoo.next->b.\n"
"Given that aFoo could just be any object of type foo, the string "
"'.next->b' is the expression path, because it can be attached to any "
"foo instance to achieve the effect.\n"
"Expression paths in LLDB include dot (.) and arrow (->) operators, "
"and most commands using expression paths have ways to also accept "
"the star (*) operator.\n"
"The meaning of these operators is the same as the usual one given to "
"them by the C/C++ standards.\n"
"LLDB also has support for indexing ([ ]) in expression paths, and "
"extends the traditional meaning of the square brackets operator to "
"allow bitfield extraction:\n"
"for objects of native types (int, float, char, ...) saying '[n-m]' "
"as an expression path (where n and m are any positive integers, e.g. "
"[3-5]) causes LLDB to extract"
" bits n thru m from the value of the variable. If n == m, [n] is "
"also allowed as a shortcut syntax. For arrays and pointers, "
"expression paths can only contain one index"
" and the meaning of the operation is the same as the one defined by "
"C/C++ (item extraction). Some commands extend bitfield-like syntax "
"for arrays and pointers with the"
" meaning of array slicing (taking elements n thru m inside the array "
"or pointed-to memory).";
}
llvm::StringRef arch_helper() {
static StreamString g_archs_help;
if (g_archs_help.Empty()) {
StringList archs;
ArchSpec::ListSupportedArchNames(archs);
g_archs_help.Printf("These are the supported architecture names:\n");
archs.Join("\n", g_archs_help);
}
return g_archs_help.GetString();
}
template <int I> struct TableValidator : TableValidator<I + 1> {
static_assert(
g_argument_table[I].arg_type == I,
"g_argument_table order doesn't match CommandArgumentType enumeration");
};
template <> struct TableValidator<eArgTypeLastArg> {};
TableValidator<0> validator;
} // namespace lldb_private

2
lldb/source/Commands/CommandOptionsProcessLaunch.cpp
View file

@ -12,6 +12,8 @@
#include "lldb/Host/HostInfo.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandCompletions.h"
#include "lldb/Interpreter/CommandObject.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/OptionArgParser.h"
#include "lldb/Target/ExecutionContext.h"
#include "lldb/Target/Platform.h"

26
lldb/source/Commands/Options.td
View file

@ -3,7 +3,7 @@ include "OptionsBase.td"
let Command = "target modules dump symtab" in {
def tm_sort : Option<"sort", "s">, Group<1>,
Desc<"Supply a sort order when dumping the symbol table.">,
EnumArg<"SortOrder", "OptionEnumValues(g_sort_option_enumeration)">;
EnumArg<"SortOrder">;
def tm_smn : Option<"show-mangled-names", "m">, Group<1>,
Desc<"Do not demangle symbol names before showing them.">;
}
@ -282,7 +282,7 @@ let Command = "breakpoint command add" in {
Arg<"Boolean">, Desc<"Specify whether breakpoint command execution should "
"terminate on error.">;
def breakpoint_add_script_type : Option<"script-type", "s">,
EnumArg<"None", "ScriptOptionEnum()">,
EnumArg<"ScriptLang">,
Desc<"Specify the language for the commands - if none is specified, the "
"lldb command interpreter will be used.">;
def breakpoint_add_dummy_breakpoints : Option<"dummy-breakpoints", "D">,
@ -370,7 +370,7 @@ let Command = "expression" in {
"automatically applied to the expression.">;
def expression_options_description_verbosity :
Option<"description-verbosity", "v">, Group<1>,
OptionalEnumArg<"DescriptionVerbosity", "DescriptionVerbosityTypes()">,
OptionalEnumArg<"DescriptionVerbosity">,
Desc<"How verbose should the output of this expression be, if the object "
"description is asked for.">;
def expression_options_top_level : Option<"top-level", "p">, Groups<[1,2]>,
@ -437,7 +437,7 @@ let Command = "log enable" in {
def log_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
Desc<"Set the destination file to log to.">;
def log_handler : Option<"log-handler", "h">, Group<1>,
EnumArg<"LogHandler", "LogHandlerType()">, Desc<"Specify a log handler which determines where log messages are written.">;
EnumArg<"LogHandler">, Desc<"Specify a log handler which determines where log messages are written.">;
def log_buffer_size : Option<"buffer", "b">, Group<1>, Arg<"UnsignedInteger">,
Desc<"Set the log to be buffered, using the specified buffer size, if supported by the log handler.">;
def log_verbose : Option<"verbose", "v">, Group<1>,
@ -468,7 +468,7 @@ let Command = "log dump" in {
let Command = "reproducer dump" in {
def reproducer_provider : Option<"provider", "p">, Group<1>,
EnumArg<"None", "ReproducerProviderType()">,
EnumArg<"ReproducerProvider">,
Required, Desc<"The reproducer provider to dump.">;
def reproducer_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
Desc<"The reproducer path. If a reproducer is replayed and no path is "
@ -483,7 +483,7 @@ let Command = "reproducer verify" in {
let Command = "reproducer xcrash" in {
def reproducer_signal : Option<"signal", "s">, Group<1>,
EnumArg<"None", "ReproducerSignalType()">,
EnumArg<"ReproducerSignal">,
Required, Desc<"The signal to crash the debugger.">;
}
@ -781,7 +781,7 @@ let Command = "process status" in {
let Command = "process save_core" in {
def process_save_core_style : Option<"style", "s">, Group<1>,
EnumArg<"SaveCoreStyle", "SaveCoreStyles()">, Desc<"Request a specific style "
EnumArg<"SaveCoreStyle">, Desc<"Request a specific style "
"of corefile to be saved.">;
def process_save_core_plugin_name : Option<"plugin-name", "p">,
OptionalArg<"Plugin">, Desc<"Specify a plugin name to create the core file."
@ -812,7 +812,7 @@ let Command = "script add" in {
def script_add_overwrite : Option<"overwrite", "o">, Groups<[1,2]>,
Desc<"Overwrite an existing command at this node.">;
def script_add_synchronicity : Option<"synchronicity", "s">,
EnumArg<"ScriptedCommandSynchronicity", "ScriptSynchroType()">,
EnumArg<"ScriptedCommandSynchronicity">,
Desc<"Set the synchronicity of this command's executions with regard to "
"LLDB event system.">;
}
@ -828,7 +828,7 @@ let Command = "container add" in {
let Command = "script" in {
def script_language : Option<"language", "l">,
EnumArg<"ScriptLang", "ScriptOptionEnum()">, Desc<"Specify the scripting "
EnumArg<"ScriptLang">, Desc<"Specify the scripting "
" language. If none is specific the default scripting language is used.">;
}
@ -881,7 +881,7 @@ let Command = "source list" in {
let Command = "target dependents" in {
def dependents_no_dependents : Option<"no-dependents", "d">, Group<1>,
OptionalEnumArg<"Value", "OptionEnumValues(g_dependents_enumeration)">,
OptionalEnumArg<"Value">,
Desc<"Whether or not to load dependents when creating a target. If the "
"option is not specified, the value is implicitly 'default'. If the "
"option is specified but without a value, the value is implicitly "
@ -1054,7 +1054,7 @@ let Command = "thread step scope" in {
" block. This is particularly use in conjunction with --step-target to"
" step through a complex calling sequence.">;
def thread_step_scope_run_mode : Option<"run-mode", "m">, Group<1>,
EnumArg<"RunMode", "TriRunningModes()">, Desc<"Determine how to run other "
EnumArg<"RunMode">, Desc<"Determine how to run other "
"threads while stepping the current thread.">;
def thread_step_scope_step_over_regexp : Option<"step-over-regexp", "r">,
Group<1>, Arg<"RegularExpression">, Desc<"A regular expression that defines "
@ -1070,7 +1070,7 @@ let Command = "thread until" in {
def thread_until_thread : Option<"thread", "t">, Group<1>, Arg<"ThreadIndex">,
Desc<"Thread index for the thread for until operation">;
def thread_until_run_mode : Option<"run-mode", "m">, Group<1>,
EnumArg<"RunMode", "DuoRunningModes()">, Desc<"Determine how to run other "
EnumArg<"RunMode">, Desc<"Determine how to run other "
"threads while stepping this one">;
def thread_until_address : Option<"address", "a">, Group<1>,
Arg<"AddressOrExpression">, Desc<"Run until we reach the specified address, "
@ -1333,7 +1333,7 @@ let Command = "watchpoint command add" in {
Arg<"Boolean">, Desc<"Specify whether watchpoint command execution should "
"terminate on error.">;
def watchpoint_command_add_script_type : Option<"script-type", "s">,
EnumArg<"None", "ScriptOptionEnum()">, Desc<"Specify the language for the"
EnumArg<"ScriptLang">, Desc<"Specify the language for the"
" commands - if none is specified, the lldb command interpreter will be "
"used.">;
def watchpoint_command_add_python_function : Option<"python-function", "F">,

6
lldb/source/Commands/OptionsBase.td
View file

@ -151,15 +151,13 @@ class Arg<string type> {
}
// Gives the option an required argument.
class EnumArg<string type, string enum> {
class EnumArg<string type> {
string ArgType = type;
string ArgEnum = enum;
}
// Gives the option an required argument.
class OptionalEnumArg<string type, string enum> {
class OptionalEnumArg<string type> {
string ArgType = type;
string ArgEnum = enum;
bit OptionalArg = 1;
}

416
lldb/source/Interpreter/CommandObject.cpp
View file

@ -31,6 +31,7 @@
#include "lldb/Target/Language.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/CommandReturnObject.h"
using namespace lldb;
@ -365,19 +366,16 @@ CommandObject::GetArgumentEntryAtIndex(int idx) {
const CommandObject::ArgumentTableEntry *
CommandObject::FindArgumentDataByType(CommandArgumentType arg_type) {
const ArgumentTableEntry *table = CommandObject::GetArgumentTable();
for (int i = 0; i < eArgTypeLastArg; ++i)
if (table[i].arg_type == arg_type)
return &(table[i]);
if (g_argument_table[i].arg_type == arg_type)
return &(g_argument_table[i]);
return nullptr;
}
void CommandObject::GetArgumentHelp(Stream &str, CommandArgumentType arg_type,
CommandInterpreter &interpreter) {
const ArgumentTableEntry *table = CommandObject::GetArgumentTable();
const ArgumentTableEntry *entry = &(table[arg_type]);
const ArgumentTableEntry *entry = &(g_argument_table[arg_type]);
// The table is *supposed* to be kept in arg_type order, but someone *could*
// have messed it up...
@ -406,8 +404,7 @@ void CommandObject::GetArgumentHelp(Stream &str, CommandArgumentType arg_type,
}
const char *CommandObject::GetArgumentName(CommandArgumentType arg_type) {
const ArgumentTableEntry *entry =
&(CommandObject::GetArgumentTable()[arg_type]);
const ArgumentTableEntry *entry = &(g_argument_table[arg_type]);
// The table is *supposed* to be kept in arg_type order, but someone *could*
// have messed it up...
@ -544,287 +541,13 @@ CommandObject::LookupArgumentName(llvm::StringRef arg_name) {
arg_name = arg_name.ltrim('<').rtrim('>');
const ArgumentTableEntry *table = GetArgumentTable();
for (int i = 0; i < eArgTypeLastArg; ++i)
if (arg_name == table[i].arg_name)
return_type = GetArgumentTable()[i].arg_type;
if (arg_name == g_argument_table[i].arg_name)
return_type = g_argument_table[i].arg_type;
return return_type;
}
static llvm::StringRef RegisterNameHelpTextCallback() {
return "Register names can be specified using the architecture specific "
"names. "
"They can also be specified using generic names. Not all generic "
"entities have "
"registers backing them on all architectures. When they don't the "
"generic name "
"will return an error.\n"
"The generic names defined in lldb are:\n"
"\n"
"pc - program counter register\n"
"ra - return address register\n"
"fp - frame pointer register\n"
"sp - stack pointer register\n"
"flags - the flags register\n"
"arg{1-6} - integer argument passing registers.\n";
}
static llvm::StringRef BreakpointIDHelpTextCallback() {
return "Breakpoints are identified using major and minor numbers; the major "
"number corresponds to the single entity that was created with a "
"'breakpoint "
"set' command; the minor numbers correspond to all the locations that "
"were "
"actually found/set based on the major breakpoint. A full breakpoint "
"ID might "
"look like 3.14, meaning the 14th location set for the 3rd "
"breakpoint. You "
"can specify all the locations of a breakpoint by just indicating the "
"major "
"breakpoint number. A valid breakpoint ID consists either of just the "
"major "
"number, or the major number followed by a dot and the location "
"number (e.g. "
"3 or 3.2 could both be valid breakpoint IDs.)";
}
static llvm::StringRef BreakpointIDRangeHelpTextCallback() {
return "A 'breakpoint ID list' is a manner of specifying multiple "
"breakpoints. "
"This can be done through several mechanisms. The easiest way is to "
"just "
"enter a space-separated list of breakpoint IDs. To specify all the "
"breakpoint locations under a major breakpoint, you can use the major "
"breakpoint number followed by '.*', eg. '5.*' means all the "
"locations under "
"breakpoint 5. You can also indicate a range of breakpoints by using "
"<start-bp-id> - <end-bp-id>. The start-bp-id and end-bp-id for a "
"range can "
"be any valid breakpoint IDs. It is not legal, however, to specify a "
"range "
"using specific locations that cross major breakpoint numbers. I.e. "
"3.2 - 3.7"
" is legal; 2 - 5 is legal; but 3.2 - 4.4 is not legal.";
}
static llvm::StringRef BreakpointNameHelpTextCallback() {
return "A name that can be added to a breakpoint when it is created, or "
"later "
"on with the \"breakpoint name add\" command. "
"Breakpoint names can be used to specify breakpoints in all the "
"places breakpoint IDs "
"and breakpoint ID ranges can be used. As such they provide a "
"convenient way to group breakpoints, "
"and to operate on breakpoints you create without having to track the "
"breakpoint number. "
"Note, the attributes you set when using a breakpoint name in a "
"breakpoint command don't "
"adhere to the name, but instead are set individually on all the "
"breakpoints currently tagged with that "
"name. Future breakpoints "
"tagged with that name will not pick up the attributes previously "
"given using that name. "
"In order to distinguish breakpoint names from breakpoint IDs and "
"ranges, "
"names must start with a letter from a-z or A-Z and cannot contain "
"spaces, \".\" or \"-\". "
"Also, breakpoint names can only be applied to breakpoints, not to "
"breakpoint locations.";
}
static llvm::StringRef GDBFormatHelpTextCallback() {
return "A GDB format consists of a repeat count, a format letter and a size "
"letter. "
"The repeat count is optional and defaults to 1. The format letter is "
"optional "
"and defaults to the previous format that was used. The size letter "
"is optional "
"and defaults to the previous size that was used.\n"
"\n"
"Format letters include:\n"
"o - octal\n"
"x - hexadecimal\n"
"d - decimal\n"
"u - unsigned decimal\n"
"t - binary\n"
"f - float\n"
"a - address\n"
"i - instruction\n"
"c - char\n"
"s - string\n"
"T - OSType\n"
"A - float as hex\n"
"\n"
"Size letters include:\n"
"b - 1 byte (byte)\n"
"h - 2 bytes (halfword)\n"
"w - 4 bytes (word)\n"
"g - 8 bytes (giant)\n"
"\n"
"Example formats:\n"
"32xb - show 32 1 byte hexadecimal integer values\n"
"16xh - show 16 2 byte hexadecimal integer values\n"
"64 - show 64 2 byte hexadecimal integer values (format and size "
"from the last format)\n"
"dw - show 1 4 byte decimal integer value\n";
}
static llvm::StringRef FormatHelpTextCallback() {
static std::string help_text;
if (!help_text.empty())
return help_text;
StreamString sstr;
sstr << "One of the format names (or one-character names) that can be used "
"to show a variable's value:\n";
for (Format f = eFormatDefault; f < kNumFormats; f = Format(f + 1)) {
if (f != eFormatDefault)
sstr.PutChar('\n');
char format_char = FormatManager::GetFormatAsFormatChar(f);
if (format_char)
sstr.Printf("'%c' or ", format_char);
sstr.Printf("\"%s\"", FormatManager::GetFormatAsCString(f));
}
sstr.Flush();
help_text = std::string(sstr.GetString());
return help_text;
}
static llvm::StringRef LanguageTypeHelpTextCallback() {
static std::string help_text;
if (!help_text.empty())
return help_text;
StreamString sstr;
sstr << "One of the following languages:\n";
Language::PrintAllLanguages(sstr, " ", "\n");
sstr.Flush();
help_text = std::string(sstr.GetString());
return help_text;
}
static llvm::StringRef SummaryStringHelpTextCallback() {
return "A summary string is a way to extract information from variables in "
"order to present them using a summary.\n"
"Summary strings contain static text, variables, scopes and control "
"sequences:\n"
" - Static text can be any sequence of non-special characters, i.e. "
"anything but '{', '}', '$', or '\\'.\n"
" - Variables are sequences of characters beginning with ${, ending "
"with } and that contain symbols in the format described below.\n"
" - Scopes are any sequence of text between { and }. Anything "
"included in a scope will only appear in the output summary if there "
"were no errors.\n"
" - Control sequences are the usual C/C++ '\\a', '\\n', ..., plus "
"'\\$', '\\{' and '\\}'.\n"
"A summary string works by copying static text verbatim, turning "
"control sequences into their character counterpart, expanding "
"variables and trying to expand scopes.\n"
"A variable is expanded by giving it a value other than its textual "
"representation, and the way this is done depends on what comes after "
"the ${ marker.\n"
"The most common sequence if ${var followed by an expression path, "
"which is the text one would type to access a member of an aggregate "
"types, given a variable of that type"
" (e.g. if type T has a member named x, which has a member named y, "
"and if t is of type T, the expression path would be .x.y and the way "
"to fit that into a summary string would be"
" ${var.x.y}). You can also use ${*var followed by an expression path "
"and in that case the object referred by the path will be "
"dereferenced before being displayed."
" If the object is not a pointer, doing so will cause an error. For "
"additional details on expression paths, you can type 'help "
"expr-path'. \n"
"By default, summary strings attempt to display the summary for any "
"variable they reference, and if that fails the value. If neither can "
"be shown, nothing is displayed."
"In a summary string, you can also use an array index [n], or a "
"slice-like range [n-m]. This can have two different meanings "
"depending on what kind of object the expression"
" path refers to:\n"
" - if it is a scalar type (any basic type like int, float, ...) the "
"expression is a bitfield, i.e. the bits indicated by the indexing "
"operator are extracted out of the number"
" and displayed as an individual variable\n"
" - if it is an array or pointer the array items indicated by the "
"indexing operator are shown as the result of the variable. if the "
"expression is an array, real array items are"
" printed; if it is a pointer, the pointer-as-array syntax is used to "
"obtain the values (this means, the latter case can have no range "
"checking)\n"
"If you are trying to display an array for which the size is known, "
"you can also use [] instead of giving an exact range. This has the "
"effect of showing items 0 thru size - 1.\n"
"Additionally, a variable can contain an (optional) format code, as "
"in ${var.x.y%code}, where code can be any of the valid formats "
"described in 'help format', or one of the"
" special symbols only allowed as part of a variable:\n"
" %V: show the value of the object by default\n"
" %S: show the summary of the object by default\n"
" %@: show the runtime-provided object description (for "
"Objective-C, it calls NSPrintForDebugger; for C/C++ it does "
"nothing)\n"
" %L: show the location of the object (memory address or a "
"register name)\n"
" %#: show the number of children of the object\n"
" %T: show the type of the object\n"
"Another variable that you can use in summary strings is ${svar . "
"This sequence works exactly like ${var, including the fact that "
"${*svar is an allowed sequence, but uses"
" the object's synthetic children provider instead of the actual "
"objects. For instance, if you are using STL synthetic children "
"providers, the following summary string would"
" count the number of actual elements stored in an std::list:\n"
"type summary add -s \"${svar%#}\" -x \"std::list<\"";
}
static llvm::StringRef ExprPathHelpTextCallback() {
return "An expression path is the sequence of symbols that is used in C/C++ "
"to access a member variable of an aggregate object (class).\n"
"For instance, given a class:\n"
" class foo {\n"
" int a;\n"
" int b; .\n"
" foo* next;\n"
" };\n"
"the expression to read item b in the item pointed to by next for foo "
"aFoo would be aFoo.next->b.\n"
"Given that aFoo could just be any object of type foo, the string "
"'.next->b' is the expression path, because it can be attached to any "
"foo instance to achieve the effect.\n"
"Expression paths in LLDB include dot (.) and arrow (->) operators, "
"and most commands using expression paths have ways to also accept "
"the star (*) operator.\n"
"The meaning of these operators is the same as the usual one given to "
"them by the C/C++ standards.\n"
"LLDB also has support for indexing ([ ]) in expression paths, and "
"extends the traditional meaning of the square brackets operator to "
"allow bitfield extraction:\n"
"for objects of native types (int, float, char, ...) saying '[n-m]' "
"as an expression path (where n and m are any positive integers, e.g. "
"[3-5]) causes LLDB to extract"
" bits n thru m from the value of the variable. If n == m, [n] is "
"also allowed as a shortcut syntax. For arrays and pointers, "
"expression paths can only contain one index"
" and the meaning of the operation is the same as the one defined by "
"C/C++ (item extraction). Some commands extend bitfield-like syntax "
"for arrays and pointers with the"
" meaning of array slicing (taking elements n thru m inside the array "
"or pointed-to memory).";
}
void CommandObject::FormatLongHelpText(Stream &output_strm,
llvm::StringRef long_help) {
CommandInterpreter &interpreter = GetCommandInterpreter();
@ -924,14 +647,14 @@ const char *CommandObject::GetArgumentTypeAsCString(
const lldb::CommandArgumentType arg_type) {
assert(arg_type < eArgTypeLastArg &&
"Invalid argument type passed to GetArgumentTypeAsCString");
return GetArgumentTable()[arg_type].arg_name;
return g_argument_table[arg_type].arg_name;
}
const char *CommandObject::GetArgumentDescriptionAsCString(
const lldb::CommandArgumentType arg_type) {
assert(arg_type < eArgTypeLastArg &&
"Invalid argument type passed to GetArgumentDescriptionAsCString");
return GetArgumentTable()[arg_type].help_text;
return g_argument_table[arg_type].help_text;
}
Target &CommandObject::GetDummyTarget() {
@ -1028,124 +751,3 @@ bool CommandObjectRaw::Execute(const char *args_string,
}
return handled;
}
static llvm::StringRef arch_helper() {
static StreamString g_archs_help;
if (g_archs_help.Empty()) {
StringList archs;
ArchSpec::ListSupportedArchNames(archs);
g_archs_help.Printf("These are the supported architecture names:\n");
archs.Join("\n", g_archs_help);
}
return g_archs_help.GetString();
}
static constexpr CommandObject::ArgumentTableEntry g_arguments_data[] = {
// clang-format off
{ eArgTypeAddress, "address", CommandCompletions::eNoCompletion, { nullptr, false }, "A valid address in the target program's execution space." },
{ eArgTypeAddressOrExpression, "address-expression", CommandCompletions::eNoCompletion, { nullptr, false }, "An expression that resolves to an address." },
{ eArgTypeAliasName, "alias-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of an abbreviation (alias) for a debugger command." },
{ eArgTypeAliasOptions, "options-for-aliased-command", CommandCompletions::eNoCompletion, { nullptr, false }, "Command options to be used as part of an alias (abbreviation) definition. (See 'help commands alias' for more information.)" },
{ eArgTypeArchitecture, "arch", CommandCompletions::eArchitectureCompletion, { arch_helper, true }, "The architecture name, e.g. i386 or x86_64." },
{ eArgTypeBoolean, "boolean", CommandCompletions::eNoCompletion, { nullptr, false }, "A Boolean value: 'true' or 'false'" },
{ eArgTypeBreakpointID, "breakpt-id", CommandCompletions::eNoCompletion, { BreakpointIDHelpTextCallback, false }, nullptr },
{ eArgTypeBreakpointIDRange, "breakpt-id-list", CommandCompletions::eNoCompletion, { BreakpointIDRangeHelpTextCallback, false }, nullptr },
{ eArgTypeBreakpointName, "breakpoint-name", CommandCompletions::eBreakpointNameCompletion, { BreakpointNameHelpTextCallback, false }, nullptr },
{ eArgTypeByteSize, "byte-size", CommandCompletions::eNoCompletion, { nullptr, false }, "Number of bytes to use." },
{ eArgTypeClassName, "class-name", CommandCompletions::eNoCompletion, { nullptr, false }, "Then name of a class from the debug information in the program." },
{ eArgTypeCommandName, "cmd-name", CommandCompletions::eNoCompletion, { nullptr, false }, "A debugger command (may be multiple words), without any options or arguments." },
{ eArgTypeCount, "count", CommandCompletions::eNoCompletion, { nullptr, false }, "An unsigned integer." },
{ eArgTypeDirectoryName, "directory", CommandCompletions::eDiskDirectoryCompletion, { nullptr, false }, "A directory name." },
{ eArgTypeDisassemblyFlavor, "disassembly-flavor", CommandCompletions::eDisassemblyFlavorCompletion, { nullptr, false }, "A disassembly flavor recognized by your disassembly plugin. Currently the only valid options are \"att\" and \"intel\" for Intel targets" },
{ eArgTypeDescriptionVerbosity, "description-verbosity", CommandCompletions::eNoCompletion, { nullptr, false }, "How verbose the output of 'po' should be." },
{ eArgTypeEndAddress, "end-address", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeExpression, "expr", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeExpressionPath, "expr-path", CommandCompletions::eNoCompletion, { ExprPathHelpTextCallback, true }, nullptr },
{ eArgTypeExprFormat, "expression-format", CommandCompletions::eNoCompletion, { nullptr, false }, "[ [bool|b] | [bin] | [char|c] | [oct|o] | [dec|i|d|u] | [hex|x] | [float|f] | [cstr|s] ]" },
{ eArgTypeFilename, "filename", CommandCompletions::eDiskFileCompletion, { nullptr, false }, "The name of a file (can include path)." },
{ eArgTypeFormat, "format", CommandCompletions::eNoCompletion, { FormatHelpTextCallback, true }, nullptr },
{ eArgTypeFrameIndex, "frame-index", CommandCompletions::eFrameIndexCompletion, { nullptr, false }, "Index into a thread's list of frames." },
{ eArgTypeFullName, "fullname", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeFunctionName, "function-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a function." },
{ eArgTypeFunctionOrSymbol, "function-or-symbol", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a function or symbol." },
{ eArgTypeGDBFormat, "gdb-format", CommandCompletions::eNoCompletion, { GDBFormatHelpTextCallback, true }, nullptr },
{ eArgTypeHelpText, "help-text", CommandCompletions::eNoCompletion, { nullptr, false }, "Text to be used as help for some other entity in LLDB" },
{ eArgTypeIndex, "index", CommandCompletions::eNoCompletion, { nullptr, false }, "An index into a list." },
{ eArgTypeLanguage, "source-language", CommandCompletions::eTypeLanguageCompletion, { LanguageTypeHelpTextCallback, true }, nullptr },
{ eArgTypeLineNum, "linenum", CommandCompletions::eNoCompletion, { nullptr, false }, "Line number in a source file." },
{ eArgTypeFileLineColumn, "linespec", CommandCompletions::eNoCompletion, { nullptr, false }, "A source specifier in the form file:line[:column]" },
{ eArgTypeLogCategory, "log-category", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a category within a log channel, e.g. all (try \"log list\" to see a list of all channels and their categories." },
{ eArgTypeLogChannel, "log-channel", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a log channel, e.g. process.gdb-remote (try \"log list\" to see a list of all channels and their categories)." },
{ eArgTypeMethod, "method", CommandCompletions::eNoCompletion, { nullptr, false }, "A C++ method name." },
{ eArgTypeName, "name", CommandCompletions::eTypeCategoryNameCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeNewPathPrefix, "new-path-prefix", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeNumLines, "num-lines", CommandCompletions::eNoCompletion, { nullptr, false }, "The number of lines to use." },
{ eArgTypeNumberPerLine, "number-per-line", CommandCompletions::eNoCompletion, { nullptr, false }, "The number of items per line to display." },
{ eArgTypeOffset, "offset", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeOldPathPrefix, "old-path-prefix", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeOneLiner, "one-line-command", CommandCompletions::eNoCompletion, { nullptr, false }, "A command that is entered as a single line of text." },
{ eArgTypePath, "path", CommandCompletions::eDiskFileCompletion, { nullptr, false }, "Path." },
{ eArgTypePermissionsNumber, "perms-numeric", CommandCompletions::eNoCompletion, { nullptr, false }, "Permissions given as an octal number (e.g. 755)." },
{ eArgTypePermissionsString, "perms=string", CommandCompletions::eNoCompletion, { nullptr, false }, "Permissions given as a string value (e.g. rw-r-xr--)." },
{ eArgTypePid, "pid", CommandCompletions::eProcessIDCompletion, { nullptr, false }, "The process ID number." },
{ eArgTypePlugin, "plugin", CommandCompletions::eProcessPluginCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeProcessName, "process-name", CommandCompletions::eProcessNameCompletion, { nullptr, false }, "The name of the process." },
{ eArgTypePythonClass, "python-class", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a Python class." },
{ eArgTypePythonFunction, "python-function", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a Python function." },
{ eArgTypePythonScript, "python-script", CommandCompletions::eNoCompletion, { nullptr, false }, "Source code written in Python." },
{ eArgTypeQueueName, "queue-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of the thread queue." },
{ eArgTypeRegisterName, "register-name", CommandCompletions::eNoCompletion, { RegisterNameHelpTextCallback, true }, nullptr },
{ eArgTypeRegularExpression, "regular-expression", CommandCompletions::eNoCompletion, { nullptr, false }, "A POSIX-compliant extended regular expression." },
{ eArgTypeRunArgs, "run-args", CommandCompletions::eNoCompletion, { nullptr, false }, "Arguments to be passed to the target program when it starts executing." },
{ eArgTypeRunMode, "run-mode", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeScriptedCommandSynchronicity, "script-cmd-synchronicity", CommandCompletions::eNoCompletion, { nullptr, false }, "The synchronicity to use to run scripted commands with regard to LLDB event system." },
{ eArgTypeScriptLang, "script-language", CommandCompletions::eNoCompletion, { nullptr, false }, "The scripting language to be used for script-based commands. Supported languages are python and lua." },
{ eArgTypeSearchWord, "search-word", CommandCompletions::eNoCompletion, { nullptr, false }, "Any word of interest for search purposes." },
{ eArgTypeSelector, "selector", CommandCompletions::eNoCompletion, { nullptr, false }, "An Objective-C selector name." },
{ eArgTypeSettingIndex, "setting-index", CommandCompletions::eNoCompletion, { nullptr, false }, "An index into a settings variable that is an array (try 'settings list' to see all the possible settings variables and their types)." },
{ eArgTypeSettingKey, "setting-key", CommandCompletions::eNoCompletion, { nullptr, false }, "A key into a settings variables that is a dictionary (try 'settings list' to see all the possible settings variables and their types)." },
{ eArgTypeSettingPrefix, "setting-prefix", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a settable internal debugger variable up to a dot ('.'), e.g. 'target.process.'" },
{ eArgTypeSettingVariableName, "setting-variable-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a settable internal debugger variable. Type 'settings list' to see a complete list of such variables." },
{ eArgTypeShlibName, "shlib-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a shared library." },
{ eArgTypeSourceFile, "source-file", CommandCompletions::eSourceFileCompletion, { nullptr, false }, "The name of a source file.." },
{ eArgTypeSortOrder, "sort-order", CommandCompletions::eNoCompletion, { nullptr, false }, "Specify a sort order when dumping lists." },
{ eArgTypeStartAddress, "start-address", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeSummaryString, "summary-string", CommandCompletions::eNoCompletion, { SummaryStringHelpTextCallback, true }, nullptr },
{ eArgTypeSymbol, "symbol", CommandCompletions::eSymbolCompletion, { nullptr, false }, "Any symbol name (function name, variable, argument, etc.)" },
{ eArgTypeThreadID, "thread-id", CommandCompletions::eNoCompletion, { nullptr, false }, "Thread ID number." },
{ eArgTypeThreadIndex, "thread-index", CommandCompletions::eNoCompletion, { nullptr, false }, "Index into the process' list of threads." },
{ eArgTypeThreadName, "thread-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The thread's name." },
{ eArgTypeTypeName, "type-name", CommandCompletions::eNoCompletion, { nullptr, false }, "A type name." },
{ eArgTypeUnsignedInteger, "unsigned-integer", CommandCompletions::eNoCompletion, { nullptr, false }, "An unsigned integer." },
{ eArgTypeUnixSignal, "unix-signal", CommandCompletions::eNoCompletion, { nullptr, false }, "A valid Unix signal name or number (e.g. SIGKILL, KILL or 9)." },
{ eArgTypeVarName, "variable-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a variable in your program." },
{ eArgTypeValue, "value", CommandCompletions::eNoCompletion, { nullptr, false }, "A value could be anything, depending on where and how it is used." },
{ eArgTypeWidth, "width", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
{ eArgTypeNone, "none", CommandCompletions::eNoCompletion, { nullptr, false }, "No help available for this." },
{ eArgTypePlatform, "platform-name", CommandCompletions::ePlatformPluginCompletion, { nullptr, false }, "The name of an installed platform plug-in . Type 'platform list' to see a complete list of installed platforms." },
{ eArgTypeWatchpointID, "watchpt-id", CommandCompletions::eNoCompletion, { nullptr, false }, "Watchpoint IDs are positive integers." },
{ eArgTypeWatchpointIDRange, "watchpt-id-list", CommandCompletions::eNoCompletion, { nullptr, false }, "For example, '1-3' or '1 to 3'." },
{ eArgTypeWatchType, "watch-type", CommandCompletions::eNoCompletion, { nullptr, false }, "Specify the type for a watchpoint." },
{ eArgRawInput, "raw-input", CommandCompletions::eNoCompletion, { nullptr, false }, "Free-form text passed to a command without prior interpretation, allowing spaces without requiring quotes. To pass arguments and free form text put two dashes ' -- ' between the last argument and any raw input." },
{ eArgTypeCommand, "command", CommandCompletions::eNoCompletion, { nullptr, false }, "An LLDB Command line command element." },
{ eArgTypeColumnNum, "column", CommandCompletions::eNoCompletion, { nullptr, false }, "Column number in a source file." },
{ eArgTypeModuleUUID, "module-uuid", CommandCompletions::eModuleUUIDCompletion, { nullptr, false }, "A module UUID value." },
{ eArgTypeSaveCoreStyle, "corefile-style", CommandCompletions::eNoCompletion, { nullptr, false }, "The type of corefile that lldb will try to create, dependant on this target's capabilities." },
{ eArgTypeLogHandler, "log-handler", CommandCompletions::eNoCompletion, { nullptr, false }, "The log handle that will be used to write out log messages." },
{ eArgTypeSEDStylePair, "substitution-pair", CommandCompletions::eNoCompletion, { nullptr, false }, "A sed-style pattern and target pair." },
{ eArgTypeRecognizerID, "frame-recognizer-id", CommandCompletions::eNoCompletion, { nullptr, false }, "The ID for a stack frame recognizer." },
{ eArgTypeConnectURL, "process-connect-url", CommandCompletions::eNoCompletion, { nullptr, false }, "A URL-style specification for a remote connection." },
{ eArgTypeTargetID, "target-id", CommandCompletions::eNoCompletion, { nullptr, false }, "The index ID for an lldb Target." },
{ eArgTypeStopHookID, "stop-hook-id", CommandCompletions::eNoCompletion, { nullptr, false }, "The ID you receive when you create a stop-hook." }
// clang-format on
};
static_assert(
(sizeof(g_arguments_data) / sizeof(CommandObject::ArgumentTableEntry)) ==
eArgTypeLastArg,
"g_arguments_data out of sync with CommandArgumentType enumeration");
const CommandObject::ArgumentTableEntry *CommandObject::GetArgumentTable() {
return g_arguments_data;
}

1
lldb/source/Plugins/Trace/intel-pt/CommandObjectTraceStartIntelPT.cpp
View file

@ -11,6 +11,7 @@
#include "TraceIntelPT.h"
#include "TraceIntelPTConstants.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Target/Process.h"
#include "lldb/Target/Trace.h"

1
lldb/source/Plugins/TraceExporter/ctf/CommandObjectThreadTraceExportCTF.cpp
View file

@ -10,6 +10,7 @@
#include "../common/TraceHTR.h"
#include "lldb/Host/OptionParser.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Target/Process.h"
#include "lldb/Target/Trace.h"

8
lldb/utils/TableGen/LLDBOptionDefEmitter.cpp
View file

@ -31,7 +31,6 @@ struct CommandOption {
std::string ArgType;
bool OptionalArg = false;
std::string Validator;
std::string ArgEnum;
std::vector<StringRef> Completions;
std::string Description;
@ -65,9 +64,6 @@ struct CommandOption {
if (Option->getValue("Validator"))
Validator = std::string(Option->getValueAsString("Validator"));
if (Option->getValue("ArgEnum"))
ArgEnum = std::string(Option->getValueAsString("ArgEnum"));
if (Option->getValue("Completions"))
Completions = Option->getValueAsListOfStrings("Completions");
@ -114,8 +110,8 @@ static void emitOption(const CommandOption &O, raw_ostream &OS) {
OS << "nullptr";
OS << ", ";
if (!O.ArgEnum.empty())
OS << O.ArgEnum;
if (!O.ArgType.empty())
OS << "g_argument_table[eArgType" << O.ArgType << "].enum_values";
else
OS << "{}";
OS << ", ";