11#include "llvm/ADT/StringRef.h"
24#define LLDB_OPTIONS_settings_set
25#include "CommandOptions.inc"
31 "Set the value of the specified debugger setting.") {
43 arg1.push_back(var_name_arg);
51 arg2.push_back(value_arg);
58 "\nWhen setting a dictionary or array variable, you can set multiple entries \
59at once by giving the values to the set command. For example:"
62(lldb) settings set target.run-args value1 value2 value3
63(lldb) settings set target.env-vars MYPATH=~/.:/usr/bin SOME_ENV_VAR=12345
65(lldb) settings show target.run-args
69(lldb) settings show target.env-vars
74 "Warning: The 'set' command re-sets the entire array or dictionary. If you \
75just want to add, remove or update individual values (or add something to \
76the end), use one of the other settings sub-commands: append, replace, \
77insert-before or insert-after.");
88 class CommandOptions :
public Options {
99 switch (short_option) {
110 llvm_unreachable(
"Unimplemented option");
123 return llvm::ArrayRef(g_settings_set_options);
137 const char *arg =
nullptr;
138 size_t setting_var_idx;
139 for (setting_var_idx = 0; setting_var_idx < argc; ++setting_var_idx) {
141 if (arg && arg[0] !=
'-')
161 const char *setting_var_name =
174 Args cmd_args(command);
181 const size_t argc = cmd_args.GetArgumentCount();
184 result.
AppendError(
"'settings set' takes more arguments");
188 const char *var_name = cmd_args.GetArgumentAtIndex(0);
189 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
191 "'settings set' command requires a valid variable name");
207 llvm::StringRef var_value(command);
208 var_value = var_value.split(var_name).second.ltrim();
213 var_name, var_value);
215 if (
error.Success()) {
224 var_name, var_value);
245 "Show matching debugger settings and their current "
246 "values. Defaults to showing all settings.",
257 arg1.push_back(var_name_arg);
278 for (
const auto &arg : args) {
282 if (
error.Success()) {
296#define LLDB_OPTIONS_settings_write
297#include "CommandOptions.inc"
303 interpreter,
"settings export",
304 "Write matching debugger settings and their "
305 "current values to a file that can be read in with "
306 "\"settings read\". Defaults to writing all settings.",
317 arg1.push_back(var_name_arg);
338 switch (short_option) {
346 llvm_unreachable(
"Unimplemented option");
358 return llvm::ArrayRef(g_settings_write_options);
370 std::string path(file_spec.
GetPath());
378 lldb::eFilePermissionsFileDefault);
394 for (
const auto &arg : args) {
397 if (!
error.Success()) {
408#define LLDB_OPTIONS_settings_read
409#include "CommandOptions.inc"
415 interpreter,
"settings read",
416 "Read settings previously saved to a file with \"settings write\".",
434 switch (short_option) {
439 llvm_unreachable(
"Unimplemented option");
450 return llvm::ArrayRef(g_settings_read_options);
480 "List and describe matching debugger settings. "
481 "Defaults to all listing all settings.",
495 arg.push_back(var_name_arg);
496 arg.push_back(prefix_name_arg);
518 const bool dump_qualified_name =
true;
521 const char *property_path = arg.c_str();
529 dump_qualified_name);
548 "Remove a value from a setting, specified by array "
549 "index or dictionary key.") {
562 arg1.push_back(var_name_arg);
573 arg2.push_back(index_arg);
574 arg2.push_back(key_arg);
599 Args cmd_args(command);
607 result.
AppendError(
"'settings remove' takes an array or dictionary item, "
608 "or an array followed by one or more indexes, or a "
609 "dictionary followed by one or more key names to "
615 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
617 "'settings remove' command requires a valid variable name");
622 llvm::StringRef var_value(command);
623 var_value = var_value.split(var_name).second.trim();
639 "Replace the debugger setting value specified by "
640 "array index or dictionary key.") {
655 arg1.push_back(var_name_arg);
666 arg2.push_back(index_arg);
667 arg2.push_back(key_arg);
675 arg3.push_back(value_arg);
704 Args cmd_args(command);
706 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
707 result.
AppendError(
"'settings replace' command requires a valid variable "
708 "name; No value supplied");
713 llvm::StringRef var_value(command);
714 var_value = var_value.split(var_name).second.trim();
732 "Insert one or more values into an debugger array "
733 "setting immediately before the specified element "
748 arg1.push_back(var_name_arg);
756 arg2.push_back(index_arg);
764 arg3.push_back(value_arg);
793 Args cmd_args(command);
797 result.
AppendError(
"'settings insert-before' takes more arguments");
802 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
803 result.
AppendError(
"'settings insert-before' command requires a valid "
804 "variable name; No value supplied");
809 llvm::StringRef var_value(command);
810 var_value = var_value.split(var_name).second.trim();
826 "Insert one or more values into a debugger array "
827 "settings after the specified element index.") {
841 arg1.push_back(var_name_arg);
849 arg2.push_back(index_arg);
857 arg3.push_back(value_arg);
886 Args cmd_args(command);
890 result.
AppendError(
"'settings insert-after' takes more arguments");
895 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
896 result.
AppendError(
"'settings insert-after' command requires a valid "
897 "variable name; No value supplied");
902 llvm::StringRef var_value(command);
903 var_value = var_value.split(var_name).second.trim();
919 "Append one or more values to a debugger array, "
920 "dictionary, or string setting.") {
932 arg1.push_back(var_name_arg);
940 arg2.push_back(value_arg);
967 Args cmd_args(command);
971 result.
AppendError(
"'settings append' takes more arguments");
976 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
977 result.
AppendError(
"'settings append' command requires a valid variable "
978 "name; No value supplied");
986 llvm::StringRef var_value(command);
987 var_value = var_value.split(var_name).second.trim();
998#define LLDB_OPTIONS_settings_clear
999#include "CommandOptions.inc"
1005 interpreter,
"settings clear",
1006 "Clear a debugger setting array, dictionary, or string. "
1007 "If '-a' option is specified, it clears all settings.", nullptr) {
1017 arg.push_back(var_name_arg);
1046 switch (short_option) {
1051 llvm_unreachable(
"Unimplemented option");
1061 return llvm::ArrayRef(g_settings_clear_options);
1074 result.
AppendError(
"'settings clear --all' doesn't take any arguments");
1082 result.
AppendError(
"'settings clear' takes exactly one argument");
1087 if ((var_name ==
nullptr) || (var_name[0] ==
'\0')) {
1088 result.
AppendError(
"'settings clear' command requires a valid variable "
1089 "name; No value supplied");
1109 "Commands for managing LLDB settings.",
1110 "settings <subcommand> [<command-options>]") {
static llvm::raw_ostream & error(Stream &strm)
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
CommandObjectSettingsAppend(CommandInterpreter &interpreter)
~CommandObjectSettingsAppend() override=default
void DoExecute(llvm::StringRef command, CommandReturnObject &result) override
bool WantsCompletion() override
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
Set the value of an option.
void OptionParsingStarting(ExecutionContext *execution_context) override
llvm::ArrayRef< OptionDefinition > GetDefinitions() override
~CommandOptions() override=default
Options * GetOptions() override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
~CommandObjectSettingsClear() override=default
void DoExecute(Args &command, CommandReturnObject &result) override
CommandObjectSettingsClear(CommandInterpreter &interpreter)
~CommandObjectSettingsInsertAfter() override=default
void DoExecute(llvm::StringRef command, CommandReturnObject &result) override
CommandObjectSettingsInsertAfter(CommandInterpreter &interpreter)
bool WantsCompletion() override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
~CommandObjectSettingsInsertBefore() override=default
CommandObjectSettingsInsertBefore(CommandInterpreter &interpreter)
bool WantsCompletion() override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
void DoExecute(llvm::StringRef command, CommandReturnObject &result) override
CommandObjectSettingsList(CommandInterpreter &interpreter)
void DoExecute(Args &args, CommandReturnObject &result) override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
~CommandObjectSettingsList() override=default
~CommandOptions() override=default
void OptionParsingStarting(ExecutionContext *execution_context) override
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
Set the value of an option.
llvm::ArrayRef< OptionDefinition > GetDefinitions() override
~CommandObjectSettingsRead() override=default
CommandObjectSettingsRead(CommandInterpreter &interpreter)
Options * GetOptions() override
void DoExecute(Args &command, CommandReturnObject &result) override
void DoExecute(llvm::StringRef command, CommandReturnObject &result) override
bool WantsCompletion() override
CommandObjectSettingsRemove(CommandInterpreter &interpreter)
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
~CommandObjectSettingsRemove() override=default
bool WantsCompletion() override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
void DoExecute(llvm::StringRef command, CommandReturnObject &result) override
CommandObjectSettingsReplace(CommandInterpreter &interpreter)
~CommandObjectSettingsReplace() override=default
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
Set the value of an option.
void OptionParsingStarting(ExecutionContext *execution_context) override
~CommandOptions() override=default
llvm::ArrayRef< OptionDefinition > GetDefinitions() override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
Options * GetOptions() override
CommandObjectSettingsSet(CommandInterpreter &interpreter)
~CommandObjectSettingsSet() override=default
bool WantsCompletion() override
void DoExecute(llvm::StringRef command, CommandReturnObject &result) override
void DoExecute(Args &args, CommandReturnObject &result) override
CommandObjectSettingsShow(CommandInterpreter &interpreter)
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
~CommandObjectSettingsShow() override=default
llvm::ArrayRef< OptionDefinition > GetDefinitions() override
~CommandOptions() override=default
void OptionParsingStarting(ExecutionContext *execution_context) override
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
Set the value of an option.
void DoExecute(Args &args, CommandReturnObject &result) override
~CommandObjectSettingsWrite() override=default
CommandObjectSettingsWrite(CommandInterpreter &interpreter)
Options * GetOptions() override
A command line argument class.
size_t GetArgumentCount() const
Gets the number of arguments left in this command object.
const char * GetArgumentAtIndex(size_t idx) const
Gets the NULL terminated C string argument pointer for the argument at index idx.
static bool InvokeCommonCompletionCallbacks(CommandInterpreter &interpreter, uint32_t completion_mask, lldb_private::CompletionRequest &request, SearchFilter *searcher)
void SetPrintErrors(bool print_errors)
void SetEchoCommands(bool echo_commands)
void SetAddToHistory(bool add_to_history)
void SetStopOnError(bool stop_on_error)
void SetPrintResults(bool print_results)
void HandleCommandsFromFile(FileSpec &file, const ExecutionContext &context, const CommandInterpreterRunOptions &options, CommandReturnObject &result)
Execute a list of commands from a file.
~CommandObjectMultiwordSettings() override
CommandObjectMultiwordSettings(CommandInterpreter &interpreter)
bool LoadSubCommand(llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj) override
std::vector< CommandArgumentData > CommandArgumentEntry
virtual void SetHelpLong(llvm::StringRef str)
ExecutionContext m_exe_ctx
std::vector< CommandArgumentEntry > m_arguments
CommandInterpreter & GetCommandInterpreter()
CommandInterpreter & m_interpreter
bool ParseOptions(Args &args, CommandReturnObject &result)
void void AppendError(llvm::StringRef in_string)
void SetStatus(lldb::ReturnStatus status)
void AppendErrorWithFormat(const char *format,...) __attribute__((format(printf
Stream & GetOutputStream()
"lldb/Utility/ArgCompletionRequest.h"
const Args & GetParsedLine() const
size_t GetCursorIndex() const
Status SetPropertyValue(const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef property_path, llvm::StringRef value) override
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
void Clear()
Clear the object's state.
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
void Resolve(llvm::SmallVectorImpl< char > &path)
Resolve path to make it canonical.
static FileSystem & Instance()
bool IsValid() const override
IsValid.
A command line option parsing protocol class.
std::vector< Option > m_getopt_table
virtual void DumpAllDescriptions(CommandInterpreter &interpreter, Stream &strm) const
virtual void DumpAllPropertyValues(const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask, bool is_json=false)
virtual lldb::OptionValuePropertiesSP GetValueProperties() const
size_t EOL()
Output and End of Line character to the stream.
A class that represents a running process on the host machine.
std::vector< OptionArgElement > OptionElementVector
@ eVarSetOperationReplace
@ eVarSetOperationInsertBefore
@ eVarSetOperationInsertAfter
@ eSettingsNameCompletion
std::shared_ptr< lldb_private::CommandObject > CommandObjectSP
@ eReturnStatusSuccessFinishResult
@ eReturnStatusSuccessFinishNoResult
@ eArgTypeSettingVariableName
std::shared_ptr< lldb_private::OptionValue > OptionValueSP
Used to build individual command argument lists.
ArgumentRepetitionType arg_repetition
lldb::CommandArgumentType arg_type