[Lldb-commits] [lldb] Start to clean up the process of defining command arguments. (PR #83097)
via lldb-commits
lldb-commits at lists.llvm.org
Mon Feb 26 18:26:01 PST 2024
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: None (jimingham)
<details>
<summary>Changes</summary>
Partly, there's just a lot of unnecessary boiler plate. It's also possible to define combinations of arguments that make no sense (e.g. eArgRepeatPlus followed by eArgRepeatPlain...) but these are never checked since we just push_back directly into the argument definitions.
This commit is step 1 of this cleanup - do the obvious stuff. In it, all the simple homogenous argument lists and the breakpoint/watchpoint ID/Range types, are set with common functions. This is an NFC change, it just centralizes boiler plate. There's no checking yet because you can't get a single argument wrong.
The end goal is that all argument definition goes through functions and m_arguments is hidden so that you can't define inconsistent argument sets.
---
Patch is 91.31 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/83097.diff
28 Files Affected:
- (modified) lldb/include/lldb/Interpreter/CommandObject.h (+16-5)
- (modified) lldb/source/Commands/CommandObjectApropos.cpp (+1-13)
- (modified) lldb/source/Commands/CommandObjectBreakpoint.cpp (+9-63)
- (modified) lldb/source/Commands/CommandObjectBreakpointCommand.cpp (+3-39)
- (modified) lldb/source/Commands/CommandObjectCommands.cpp (+9-110)
- (modified) lldb/source/Commands/CommandObjectDWIMPrint.cpp (+1-2)
- (modified) lldb/source/Commands/CommandObjectExpression.cpp (+1-13)
- (modified) lldb/source/Commands/CommandObjectFrame.cpp (+5-54)
- (modified) lldb/source/Commands/CommandObjectHelp.cpp (+1-12)
- (modified) lldb/source/Commands/CommandObjectLog.cpp (+4-52)
- (modified) lldb/source/Commands/CommandObjectPlatform.cpp (+13-67)
- (modified) lldb/source/Commands/CommandObjectPlugin.cpp (+1-13)
- (modified) lldb/source/Commands/CommandObjectProcess.cpp (+7-43)
- (modified) lldb/source/Commands/CommandObjectQuit.cpp (+1-2)
- (modified) lldb/source/Commands/CommandObjectRegister.cpp (+2-20)
- (modified) lldb/source/Commands/CommandObjectSession.cpp (+1-3)
- (modified) lldb/source/Commands/CommandObjectSettings.cpp (+3-39)
- (modified) lldb/source/Commands/CommandObjectTarget.cpp (+14-93)
- (modified) lldb/source/Commands/CommandObjectThread.cpp (+8-82)
- (modified) lldb/source/Commands/CommandObjectThreadUtil.cpp (+2-4)
- (modified) lldb/source/Commands/CommandObjectTrace.cpp (+3-6)
- (modified) lldb/source/Commands/CommandObjectType.cpp (+12-101)
- (modified) lldb/source/Commands/CommandObjectWatchpoint.cpp (+8-60)
- (modified) lldb/source/Commands/CommandObjectWatchpointCommand.cpp (+3-39)
- (modified) lldb/source/Interpreter/CommandObject.cpp (+31-8)
- (modified) lldb/source/Plugins/LanguageRuntime/CPlusPlus/ItaniumABI/ItaniumABILanguageRuntime.cpp (+1-13)
- (modified) lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV2.cpp (+2-26)
- (modified) lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp (+2-4)
``````````diff
diff --git a/lldb/include/lldb/Interpreter/CommandObject.h b/lldb/include/lldb/Interpreter/CommandObject.h
index a326c6dc38a37a..49cf4a21e25d73 100644
--- a/lldb/include/lldb/Interpreter/CommandObject.h
+++ b/lldb/include/lldb/Interpreter/CommandObject.h
@@ -206,6 +206,22 @@ class CommandObject : public std::enable_shared_from_this<CommandObject> {
static const ArgumentTableEntry *
FindArgumentDataByType(lldb::CommandArgumentType arg_type);
+
+ // Sets the argument list for this command to one homogenous argument type,
+ // with the repeat specified.
+ void AddSimpleArgumentList(lldb::CommandArgumentType arg_type,
+ ArgumentRepetitionType repetition_type = eArgRepeatPlain);
+
+ // Helper function to set BP IDs or ID ranges as the command argument data
+ // for this command.
+ // This used to just populate an entry you could add to, but that was never
+ // used. If we ever need that we can take optional extra args here.
+ // Use this to define a simple argument list:
+ enum IDType {
+ eBreakpointArgs = 0,
+ eWatchpointArgs = 1
+ };
+ void AddIDsArgumentData(IDType type);
int GetNumArgumentEntries();
@@ -392,11 +408,6 @@ class CommandObject : public std::enable_shared_from_this<CommandObject> {
void *m_command_override_baton;
bool m_is_user_command = false;
- // Helper function to populate IDs or ID ranges as the command argument data
- // to the specified command argument entry.
- static void AddIDsArgumentData(CommandArgumentEntry &arg,
- lldb::CommandArgumentType ID,
- lldb::CommandArgumentType IDRange);
};
class CommandObjectParsed : public CommandObject {
diff --git a/lldb/source/Commands/CommandObjectApropos.cpp b/lldb/source/Commands/CommandObjectApropos.cpp
index 88c214d4fc56ab..d663f2bd923fe2 100644
--- a/lldb/source/Commands/CommandObjectApropos.cpp
+++ b/lldb/source/Commands/CommandObjectApropos.cpp
@@ -21,19 +21,7 @@ CommandObjectApropos::CommandObjectApropos(CommandInterpreter &interpreter)
: CommandObjectParsed(
interpreter, "apropos",
"List debugger commands related to a word or subject.", nullptr) {
- CommandArgumentEntry arg;
- CommandArgumentData search_word_arg;
-
- // Define the first (and only) variant of this arg.
- search_word_arg.arg_type = eArgTypeSearchWord;
- search_word_arg.arg_repetition = eArgRepeatPlain;
-
- // There is only one variant this argument could be; put it into the argument
- // entry.
- arg.push_back(search_word_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeSearchWord);
}
CommandObjectApropos::~CommandObjectApropos() = default;
diff --git a/lldb/source/Commands/CommandObjectBreakpoint.cpp b/lldb/source/Commands/CommandObjectBreakpoint.cpp
index fc2217608a0bb9..6043d089aa211d 100644
--- a/lldb/source/Commands/CommandObjectBreakpoint.cpp
+++ b/lldb/source/Commands/CommandObjectBreakpoint.cpp
@@ -810,12 +810,7 @@ class CommandObjectBreakpointModify : public CommandObjectParsed {
"With the exception of -e, -d and -i, passing an "
"empty argument clears the modification.",
nullptr) {
- CommandArgumentEntry arg;
- CommandObject::AddIDsArgumentData(arg, eArgTypeBreakpointID,
- eArgTypeBreakpointIDRange);
- // Add the entry for the first argument for this command to the object's
- // arguments vector.
- m_arguments.push_back(arg);
+ CommandObject::AddIDsArgumentData(eBreakpointArgs);
m_options.Append(&m_bp_opts,
LLDB_OPT_SET_1 | LLDB_OPT_SET_2 | LLDB_OPT_SET_3,
@@ -887,12 +882,7 @@ class CommandObjectBreakpointEnable : public CommandObjectParsed {
"Enable the specified disabled breakpoint(s). If "
"no breakpoints are specified, enable all of them.",
nullptr) {
- CommandArgumentEntry arg;
- CommandObject::AddIDsArgumentData(arg, eArgTypeBreakpointID,
- eArgTypeBreakpointIDRange);
- // Add the entry for the first argument for this command to the object's
- // arguments vector.
- m_arguments.push_back(arg);
+ CommandObject::AddIDsArgumentData(eBreakpointArgs);
}
~CommandObjectBreakpointEnable() override = default;
@@ -999,12 +989,7 @@ execution will NOT stop at location 1.1. To achieve that, type:
"The first command disables all locations for breakpoint 1, \
the second re-enables the first location.");
- CommandArgumentEntry arg;
- CommandObject::AddIDsArgumentData(arg, eArgTypeBreakpointID,
- eArgTypeBreakpointIDRange);
- // Add the entry for the first argument for this command to the object's
- // arguments vector.
- m_arguments.push_back(arg);
+ CommandObject::AddIDsArgumentData(eBreakpointArgs);
}
~CommandObjectBreakpointDisable() override = default;
@@ -1095,15 +1080,7 @@ class CommandObjectBreakpointList : public CommandObjectParsed {
CommandArgumentData bp_id_arg;
// Define the first (and only) variant of this arg.
- bp_id_arg.arg_type = eArgTypeBreakpointID;
- bp_id_arg.arg_repetition = eArgRepeatOptional;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(bp_id_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeBreakpointID, eArgRepeatOptional);
}
~CommandObjectBreakpointList() override = default;
@@ -1369,12 +1346,7 @@ class CommandObjectBreakpointDelete : public CommandObjectParsed {
"Delete the specified breakpoint(s). If no "
"breakpoints are specified, delete them all.",
nullptr) {
- CommandArgumentEntry arg;
- CommandObject::AddIDsArgumentData(arg, eArgTypeBreakpointID,
- eArgTypeBreakpointIDRange);
- // Add the entry for the first argument for this command to the object's
- // arguments vector.
- m_arguments.push_back(arg);
+ CommandObject::AddIDsArgumentData(eBreakpointArgs);
}
~CommandObjectBreakpointDelete() override = default;
@@ -1676,14 +1648,7 @@ class CommandObjectBreakpointNameConfigure : public CommandObjectParsed {
"on the name.",
"breakpoint name configure <command-options> "
"<breakpoint-name-list>") {
- // Create the first variant for the first (and only) argument for this
- // command.
- CommandArgumentEntry arg1;
- CommandArgumentData id_arg;
- id_arg.arg_type = eArgTypeBreakpointName;
- id_arg.arg_repetition = eArgRepeatOptional;
- arg1.push_back(id_arg);
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeBreakpointName, eArgRepeatOptional);
m_option_group.Append(&m_bp_opts, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
m_option_group.Append(&m_access_options, LLDB_OPT_SET_ALL,
@@ -1769,14 +1734,7 @@ class CommandObjectBreakpointNameAdd : public CommandObjectParsed {
: CommandObjectParsed(
interpreter, "add", "Add a name to the breakpoints provided.",
"breakpoint name add <command-options> <breakpoint-id-list>") {
- // Create the first variant for the first (and only) argument for this
- // command.
- CommandArgumentEntry arg1;
- CommandArgumentData id_arg;
- id_arg.arg_type = eArgTypeBreakpointID;
- id_arg.arg_repetition = eArgRepeatOptional;
- arg1.push_back(id_arg);
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeBreakpointID, eArgRepeatOptional);
m_option_group.Append(&m_name_options, LLDB_OPT_SET_1, LLDB_OPT_SET_ALL);
m_option_group.Finalize();
@@ -1850,14 +1808,7 @@ class CommandObjectBreakpointNameDelete : public CommandObjectParsed {
interpreter, "delete",
"Delete a name from the breakpoints provided.",
"breakpoint name delete <command-options> <breakpoint-id-list>") {
- // Create the first variant for the first (and only) argument for this
- // command.
- CommandArgumentEntry arg1;
- CommandArgumentData id_arg;
- id_arg.arg_type = eArgTypeBreakpointID;
- id_arg.arg_repetition = eArgRepeatOptional;
- arg1.push_back(id_arg);
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeBreakpointID, eArgRepeatOptional);
m_option_group.Append(&m_name_options, LLDB_OPT_SET_1, LLDB_OPT_SET_ALL);
m_option_group.Finalize();
@@ -2305,12 +2256,7 @@ class CommandObjectBreakpointWrite : public CommandObjectParsed {
"be read in with \"breakpoint read\". "
"If given no arguments, writes all breakpoints.",
nullptr) {
- CommandArgumentEntry arg;
- CommandObject::AddIDsArgumentData(arg, eArgTypeBreakpointID,
- eArgTypeBreakpointIDRange);
- // Add the entry for the first argument for this command to the object's
- // arguments vector.
- m_arguments.push_back(arg);
+ CommandObject::AddIDsArgumentData(eBreakpointArgs);
}
~CommandObjectBreakpointWrite() override = default;
diff --git a/lldb/source/Commands/CommandObjectBreakpointCommand.cpp b/lldb/source/Commands/CommandObjectBreakpointCommand.cpp
index fefafcd94546a5..6ebe6e8a35570e 100644
--- a/lldb/source/Commands/CommandObjectBreakpointCommand.cpp
+++ b/lldb/source/Commands/CommandObjectBreakpointCommand.cpp
@@ -185,19 +185,7 @@ are no syntax errors may indicate that a function was declared but never called.
LLDB_OPT_SET_2);
m_all_options.Finalize();
- CommandArgumentEntry arg;
- CommandArgumentData bp_id_arg;
-
- // Define the first (and only) variant of this arg.
- bp_id_arg.arg_type = eArgTypeBreakpointID;
- bp_id_arg.arg_repetition = eArgRepeatOptional;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(bp_id_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeBreakpointID, eArgRepeatOptional);
}
~CommandObjectBreakpointCommandAdd() override = default;
@@ -449,19 +437,7 @@ class CommandObjectBreakpointCommandDelete : public CommandObjectParsed {
: CommandObjectParsed(interpreter, "delete",
"Delete the set of commands from a breakpoint.",
nullptr) {
- CommandArgumentEntry arg;
- CommandArgumentData bp_id_arg;
-
- // Define the first (and only) variant of this arg.
- bp_id_arg.arg_type = eArgTypeBreakpointID;
- bp_id_arg.arg_repetition = eArgRepeatPlain;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(bp_id_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeBreakpointID);
}
~CommandObjectBreakpointCommandDelete() override = default;
@@ -565,19 +541,7 @@ class CommandObjectBreakpointCommandList : public CommandObjectParsed {
"List the script or set of commands to be "
"executed when the breakpoint is hit.",
nullptr, eCommandRequiresTarget) {
- CommandArgumentEntry arg;
- CommandArgumentData bp_id_arg;
-
- // Define the first (and only) variant of this arg.
- bp_id_arg.arg_type = eArgTypeBreakpointID;
- bp_id_arg.arg_repetition = eArgRepeatPlain;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(bp_id_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeBreakpointID);
}
~CommandObjectBreakpointCommandList() override = default;
diff --git a/lldb/source/Commands/CommandObjectCommands.cpp b/lldb/source/Commands/CommandObjectCommands.cpp
index 7c459bdaf38022..f4903e373b086b 100644
--- a/lldb/source/Commands/CommandObjectCommands.cpp
+++ b/lldb/source/Commands/CommandObjectCommands.cpp
@@ -41,19 +41,7 @@ class CommandObjectCommandsSource : public CommandObjectParsed {
interpreter, "command source",
"Read and execute LLDB commands from the file <filename>.",
nullptr) {
- CommandArgumentEntry arg;
- CommandArgumentData file_arg;
-
- // Define the first (and only) variant of this arg.
- file_arg.arg_type = eArgTypeFilename;
- file_arg.arg_repetition = eArgRepeatPlain;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(file_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeFilename);
}
~CommandObjectCommandsSource() override = default;
@@ -614,19 +602,7 @@ class CommandObjectCommandsUnalias : public CommandObjectParsed {
interpreter, "command unalias",
"Delete one or more custom commands defined by 'command alias'.",
nullptr) {
- CommandArgumentEntry arg;
- CommandArgumentData alias_arg;
-
- // Define the first (and only) variant of this arg.
- alias_arg.arg_type = eArgTypeAliasName;
- alias_arg.arg_repetition = eArgRepeatPlain;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(alias_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeAliasName);
}
~CommandObjectCommandsUnalias() override = default;
@@ -701,19 +677,7 @@ class CommandObjectCommandsDelete : public CommandObjectParsed {
interpreter, "command delete",
"Delete one or more custom commands defined by 'command regex'.",
nullptr) {
- CommandArgumentEntry arg;
- CommandArgumentData alias_arg;
-
- // Define the first (and only) variant of this arg.
- alias_arg.arg_type = eArgTypeCommandName;
- alias_arg.arg_repetition = eArgRepeatPlain;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg.push_back(alias_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg);
+ AddSimpleArgumentList(eArgTypeCommandName);
}
~CommandObjectCommandsDelete() override = default;
@@ -815,8 +779,7 @@ a number follows 'f':"
R"(
(lldb) command regex f s/^$/finish/ 's/([0-9]+)/frame select %1/')");
- CommandArgumentData thread_arg{eArgTypeSEDStylePair, eArgRepeatOptional};
- m_arguments.push_back({thread_arg});
+ AddSimpleArgumentList(eArgTypeSEDStylePair, eArgRepeatOptional);
}
~CommandObjectCommandsAddRegex() override = default;
@@ -1944,19 +1907,7 @@ class CommandObjectCommandsScriptImport : public CommandObjectParsed {
CommandObjectCommandsScriptImport(CommandInterpreter &interpreter)
: CommandObjectParsed(interpreter, "command script import",
"Import a scripting module in LLDB.", nullptr) {
- CommandArgumentEntry arg1;
- CommandArgumentData cmd_arg;
-
- // Define the first (and only) variant of this arg.
- cmd_arg.arg_type = eArgTypeFilename;
- cmd_arg.arg_repetition = eArgRepeatPlus;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg1.push_back(cmd_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeFilename, eArgRepeatPlus);
}
~CommandObjectCommandsScriptImport() override = default;
@@ -2066,20 +2017,7 @@ class CommandObjectCommandsScriptAdd : public CommandObjectParsed,
"command, and the last element will be the new "
"command name."),
IOHandlerDelegateMultiline("DONE") {
- CommandArgumentEntry arg1;
- CommandArgumentData cmd_arg;
-
- // This is one or more command names, which form the path to the command
- // you want to add.
- cmd_arg.arg_type = eArgTypeCommand;
- cmd_arg.arg_repetition = eArgRepeatPlus;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg1.push_back(cmd_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeCommand, eArgRepeatPlus);
}
~CommandObjectCommandsScriptAdd() override = default;
@@ -2400,20 +2338,7 @@ class CommandObjectCommandsScriptDelete : public CommandObjectParsed {
interpreter, "command script delete",
"Delete a scripted command by specifying the path to the command.",
nullptr) {
- CommandArgumentEntry arg1;
- CommandArgumentData cmd_arg;
-
- // This is a list of command names forming the path to the command
- // to be deleted.
- cmd_arg.arg_type = eArgTypeCommand;
- cmd_arg.arg_repetition = eArgRepeatPlus;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg1.push_back(cmd_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeCommand, eArgRepeatPlus);
}
~CommandObjectCommandsScriptDelete() override = default;
@@ -2549,20 +2474,7 @@ class CommandObjectCommandsContainerAdd : public CommandObjectParsed {
"Add a container command to lldb. Adding to built-"
"in container commands is not allowed.",
"command container add [[path1]...] container-name") {
- CommandArgumentEntry arg1;
- CommandArgumentData cmd_arg;
-
- // This is one or more command names, which form the path to the command
- // you want to add.
- cmd_arg.arg_type = eArgTypeCommand;
- cmd_arg.arg_repetition = eArgRepeatPlus;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg1.push_back(cmd_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeCommand, eArgRepeatPlus);
}
~CommandObjectCommandsContainerAdd() override = default;
@@ -2690,20 +2602,7 @@ class CommandObjectCommandsContainerDelete : public CommandObjectParsed {
"Delete a container command previously added to "
"lldb.",
"command container delete [[path1] ...] container-cmd") {
- CommandArgumentEntry arg1;
- CommandArgumentData cmd_arg;
-
- // This is one or more command names, which form the path to the command
- // you want to add.
- cmd_arg.arg_type = eArgTypeCommand;
- cmd_arg.arg_repetition = eArgRepeatPlus;
-
- // There is only one variant this argument could be; put it into the
- // argument entry.
- arg1.push_back(cmd_arg);
-
- // Push the data for the first argument into the m_arguments vector.
- m_arguments.push_back(arg1);
+ AddSimpleArgumentList(eArgTypeCommand, eArgRepeatPlus);
}
~CommandObjectCommandsContainerDelete() override = default;
diff --git a/lldb/source/Commands/CommandObjectDWIMPrint.cpp b/lldb/source/Commands/CommandObjectDWIMPrint.cpp
index fb2cc106ffd2dd..b183cb423111fb 100644
--- a/lldb/source/Commands/CommandObjectDWIMPrint.cpp
+++ b/lldb/source/Commands/CommandObjectDWIMPrint.cpp
@@ -37,8 +37,7 @@ CommandObjectDWIMPrint::CommandObjectDWIMPrint(CommandInterpreter &interpreter)
"dwim-print [<variable-name> | <expression>]",
eCommandProcessMustBePaused | eCommandTryTargetAPILock) {
- CommandArgumentData var_name_arg(eArgTypeVarName, eArgRepeatPlain);
- m_arguments.push_back({var_name_arg});
+ AddSimpleArgumentList(eArgTypeVarName);
m_option_group.Append(&m_format_options,
...
[truncated]
``````````
</details>
https://github.com/llvm/llvm-project/pull/83097
More information about the lldb-commits
mailing list