Chris Lattner | 30fdc8d | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 1 | //===-- CommandObjectSettings.cpp -------------------------------*- C++ -*-===// |
| 2 | // |
Chandler Carruth | 2946cd7 | 2019-01-19 08:50:56 +0000 | [diff] [blame] | 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
Chris Lattner | 30fdc8d | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | |
| 9 | #include "CommandObjectSettings.h" |
| 10 | |
Eugene Zelenko | 3f18ea0 | 2016-02-24 02:05:55 +0000 | [diff] [blame] | 11 | #include "llvm/ADT/StringRef.h" |
| 12 | |
Zachary Turner | 3eb2b44 | 2017-03-22 23:33:16 +0000 | [diff] [blame] | 13 | #include "lldb/Host/OptionParser.h" |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 14 | #include "lldb/Interpreter/CommandCompletions.h" |
Chris Lattner | 30fdc8d | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 15 | #include "lldb/Interpreter/CommandInterpreter.h" |
| 16 | #include "lldb/Interpreter/CommandReturnObject.h" |
Zachary Turner | 633a29c | 2015-03-04 01:58:01 +0000 | [diff] [blame] | 17 | #include "lldb/Interpreter/OptionValueProperties.h" |
Chris Lattner | 30fdc8d | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 18 | |
| 19 | using namespace lldb; |
| 20 | using namespace lldb_private; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 21 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 22 | // CommandObjectSettingsSet |
Raphael Isemann | 6f4fb4e | 2019-07-12 15:30:55 +0000 | [diff] [blame] | 23 | #define LLDB_OPTIONS_settings_set |
Raphael Isemann | c5a2d74 | 2019-07-16 09:27:02 +0000 | [diff] [blame] | 24 | #include "CommandOptions.inc" |
Zachary Turner | 1f0f5b5 | 2016-09-22 20:22:55 +0000 | [diff] [blame] | 25 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 26 | class CommandObjectSettingsSet : public CommandObjectRaw { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 27 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 28 | CommandObjectSettingsSet(CommandInterpreter &interpreter) |
| 29 | : CommandObjectRaw(interpreter, "settings set", |
Zachary Turner | a449698 | 2016-10-05 21:14:38 +0000 | [diff] [blame] | 30 | "Set the value of the specified debugger setting."), |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 31 | m_options() { |
| 32 | CommandArgumentEntry arg1; |
| 33 | CommandArgumentEntry arg2; |
| 34 | CommandArgumentData var_name_arg; |
| 35 | CommandArgumentData value_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 36 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 37 | // Define the first (and only) variant of this arg. |
| 38 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 39 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 40 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 41 | // There is only one variant this argument could be; put it into the |
| 42 | // argument entry. |
| 43 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 44 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 45 | // Define the first (and only) variant of this arg. |
| 46 | value_arg.arg_type = eArgTypeValue; |
| 47 | value_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 48 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 49 | // There is only one variant this argument could be; put it into the |
| 50 | // argument entry. |
| 51 | arg2.push_back(value_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 52 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 53 | // Push the data for the first argument into the m_arguments vector. |
| 54 | m_arguments.push_back(arg1); |
| 55 | m_arguments.push_back(arg2); |
| 56 | |
| 57 | SetHelpLong( |
| 58 | "\nWhen setting a dictionary or array variable, you can set multiple entries \ |
| 59 | at once by giving the values to the set command. For example:" |
| 60 | R"( |
Kate Stone | ea671fb | 2015-07-14 05:48:36 +0000 | [diff] [blame] | 61 | |
| 62 | (lldb) settings set target.run-args value1 value2 value3 |
| 63 | (lldb) settings set target.env-vars MYPATH=~/.:/usr/bin SOME_ENV_VAR=12345 |
| 64 | |
| 65 | (lldb) settings show target.run-args |
| 66 | [0]: 'value1' |
| 67 | [1]: 'value2' |
| 68 | [3]: 'value3' |
| 69 | (lldb) settings show target.env-vars |
| 70 | 'MYPATH=~/.:/usr/bin' |
| 71 | 'SOME_ENV_VAR=12345' |
| 72 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 73 | )" |
| 74 | "Warning: The 'set' command re-sets the entire array or dictionary. If you \ |
Kate Stone | ea671fb | 2015-07-14 05:48:36 +0000 | [diff] [blame] | 75 | just want to add, remove or update individual values (or add something to \ |
| 76 | the end), use one of the other settings sub-commands: append, replace, \ |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 77 | insert-before or insert-after."); |
| 78 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 79 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 80 | ~CommandObjectSettingsSet() override = default; |
| 81 | |
| 82 | // Overrides base class's behavior where WantsCompletion = |
| 83 | // !WantsRawCommandString. |
| 84 | bool WantsCompletion() override { return true; } |
| 85 | |
| 86 | Options *GetOptions() override { return &m_options; } |
| 87 | |
| 88 | class CommandOptions : public Options { |
| 89 | public: |
| 90 | CommandOptions() : Options(), m_global(false) {} |
| 91 | |
| 92 | ~CommandOptions() override = default; |
| 93 | |
Zachary Turner | 97206d5 | 2017-05-12 04:51:55 +0000 | [diff] [blame] | 94 | Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, |
| 95 | ExecutionContext *execution_context) override { |
| 96 | Status error; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 97 | const int short_option = m_getopt_table[option_idx].val; |
| 98 | |
| 99 | switch (short_option) { |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 100 | case 'f': |
| 101 | m_force = true; |
| 102 | break; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 103 | case 'g': |
| 104 | m_global = true; |
| 105 | break; |
| 106 | default: |
Raphael Isemann | 3616201 | 2019-08-22 08:08:05 +0000 | [diff] [blame] | 107 | llvm_unreachable("Unimplemented option"); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | return error; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 111 | } |
| 112 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 113 | void OptionParsingStarting(ExecutionContext *execution_context) override { |
| 114 | m_global = false; |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 115 | m_force = false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 116 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 117 | |
Zachary Turner | 1f0f5b5 | 2016-09-22 20:22:55 +0000 | [diff] [blame] | 118 | llvm::ArrayRef<OptionDefinition> GetDefinitions() override { |
Zachary Turner | 7060243 | 2016-09-22 21:06:13 +0000 | [diff] [blame] | 119 | return llvm::makeArrayRef(g_settings_set_options); |
Zachary Turner | 1f0f5b5 | 2016-09-22 20:22:55 +0000 | [diff] [blame] | 120 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 121 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 122 | // Instance variables to hold the values for command options. |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 123 | bool m_global; |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 124 | bool m_force; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 125 | }; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 126 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 127 | void |
| 128 | HandleArgumentCompletion(CompletionRequest &request, |
| 129 | OptionElementVector &opt_element_vector) override { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 130 | |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 131 | const size_t argc = request.GetParsedLine().GetArgumentCount(); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 132 | const char *arg = nullptr; |
| 133 | int setting_var_idx; |
Pavel Labath | 5f56fca | 2018-03-09 10:39:40 +0000 | [diff] [blame] | 134 | for (setting_var_idx = 0; setting_var_idx < static_cast<int>(argc); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 135 | ++setting_var_idx) { |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 136 | arg = request.GetParsedLine().GetArgumentAtIndex(setting_var_idx); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 137 | if (arg && arg[0] != '-') |
| 138 | break; // We found our setting variable name index |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 139 | } |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 140 | if (request.GetCursorIndex() == setting_var_idx) { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 141 | // Attempting to complete setting variable name |
| 142 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 143 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 144 | request, nullptr); |
Raphael Isemann | 1153dc9 | 2019-08-22 09:02:54 +0000 | [diff] [blame^] | 145 | return; |
| 146 | } |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 147 | arg = |
| 148 | request.GetParsedLine().GetArgumentAtIndex(request.GetCursorIndex()); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 149 | |
Raphael Isemann | 1153dc9 | 2019-08-22 09:02:54 +0000 | [diff] [blame^] | 150 | if (!arg) |
| 151 | return; |
| 152 | |
| 153 | // Complete option name |
| 154 | if (arg[0] != '-') |
| 155 | return; |
| 156 | |
| 157 | // Complete setting value |
| 158 | const char *setting_var_name = |
| 159 | request.GetParsedLine().GetArgumentAtIndex(setting_var_idx); |
| 160 | Status error; |
| 161 | lldb::OptionValueSP value_sp(GetDebugger().GetPropertyValue( |
| 162 | &m_exe_ctx, setting_var_name, false, error)); |
| 163 | if (!value_sp) |
| 164 | return; |
| 165 | value_sp->AutoComplete(m_interpreter, request); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 166 | } |
| 167 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 168 | protected: |
Raphael Isemann | 4d51a90 | 2018-07-12 22:28:52 +0000 | [diff] [blame] | 169 | bool DoExecute(llvm::StringRef command, |
| 170 | CommandReturnObject &result) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 171 | Args cmd_args(command); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 172 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 173 | // Process possible options. |
| 174 | if (!ParseOptions(cmd_args, result)) |
| 175 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 176 | |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 177 | const size_t min_argc = m_options.m_force ? 1 : 2; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 178 | const size_t argc = cmd_args.GetArgumentCount(); |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 179 | |
| 180 | if ((argc < min_argc) && (!m_options.m_global)) { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 181 | result.AppendError("'settings set' takes more arguments"); |
| 182 | result.SetStatus(eReturnStatusFailed); |
| 183 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 184 | } |
Eugene Zelenko | 3f18ea0 | 2016-02-24 02:05:55 +0000 | [diff] [blame] | 185 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 186 | const char *var_name = cmd_args.GetArgumentAtIndex(0); |
| 187 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 188 | result.AppendError( |
| 189 | "'settings set' command requires a valid variable name"); |
| 190 | result.SetStatus(eReturnStatusFailed); |
| 191 | return false; |
| 192 | } |
| 193 | |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 194 | // A missing value corresponds to clearing the setting when "force" is |
| 195 | // specified. |
| 196 | if (argc == 1 && m_options.m_force) { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 197 | Status error(GetDebugger().SetPropertyValue( |
Jonas Devlieghere | 9c6c201 | 2018-10-24 22:04:20 +0000 | [diff] [blame] | 198 | &m_exe_ctx, eVarSetOperationClear, var_name, llvm::StringRef())); |
| 199 | if (error.Fail()) { |
| 200 | result.AppendError(error.AsCString()); |
| 201 | result.SetStatus(eReturnStatusFailed); |
| 202 | return false; |
| 203 | } |
| 204 | return result.Succeeded(); |
| 205 | } |
| 206 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 207 | // Split the raw command into var_name and value pair. |
| 208 | llvm::StringRef raw_str(command); |
| 209 | std::string var_value_string = raw_str.split(var_name).second.str(); |
| 210 | const char *var_value_cstr = |
| 211 | Args::StripSpaces(var_value_string, true, false, false); |
| 212 | |
Zachary Turner | 97206d5 | 2017-05-12 04:51:55 +0000 | [diff] [blame] | 213 | Status error; |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 214 | if (m_options.m_global) { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 215 | error = GetDebugger().SetPropertyValue(nullptr, eVarSetOperationAssign, |
| 216 | var_name, var_value_cstr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 217 | } |
| 218 | |
| 219 | if (error.Success()) { |
| 220 | // FIXME this is the same issue as the one in commands script import |
| 221 | // we could be setting target.load-script-from-symbol-file which would |
Adrian Prantl | 0509724 | 2018-04-30 16:49:04 +0000 | [diff] [blame] | 222 | // cause Python scripts to be loaded, which could run LLDB commands (e.g. |
| 223 | // settings set target.process.python-os-plugin-path) and cause a crash |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 224 | // if we did not clear the command's exe_ctx first |
| 225 | ExecutionContext exe_ctx(m_exe_ctx); |
| 226 | m_exe_ctx.Clear(); |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 227 | error = GetDebugger().SetPropertyValue(&exe_ctx, eVarSetOperationAssign, |
| 228 | var_name, var_value_cstr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | if (error.Fail()) { |
| 232 | result.AppendError(error.AsCString()); |
| 233 | result.SetStatus(eReturnStatusFailed); |
| 234 | return false; |
| 235 | } else { |
| 236 | result.SetStatus(eReturnStatusSuccessFinishResult); |
| 237 | } |
| 238 | |
| 239 | return result.Succeeded(); |
| 240 | } |
| 241 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 242 | private: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 243 | CommandOptions m_options; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 244 | }; |
| 245 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 246 | // CommandObjectSettingsShow -- Show current values |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 247 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 248 | class CommandObjectSettingsShow : public CommandObjectParsed { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 249 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 250 | CommandObjectSettingsShow(CommandInterpreter &interpreter) |
| 251 | : CommandObjectParsed(interpreter, "settings show", |
| 252 | "Show matching debugger settings and their current " |
| 253 | "values. Defaults to showing all settings.", |
| 254 | nullptr) { |
| 255 | CommandArgumentEntry arg1; |
| 256 | CommandArgumentData var_name_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 257 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 258 | // Define the first (and only) variant of this arg. |
| 259 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 260 | var_name_arg.arg_repetition = eArgRepeatOptional; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 261 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 262 | // There is only one variant this argument could be; put it into the |
| 263 | // argument entry. |
| 264 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 265 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 266 | // Push the data for the first argument into the m_arguments vector. |
| 267 | m_arguments.push_back(arg1); |
| 268 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 269 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 270 | ~CommandObjectSettingsShow() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 271 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 272 | void |
| 273 | HandleArgumentCompletion(CompletionRequest &request, |
| 274 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 275 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 276 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 277 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 278 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 279 | |
| 280 | protected: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 281 | bool DoExecute(Args &args, CommandReturnObject &result) override { |
| 282 | result.SetStatus(eReturnStatusSuccessFinishResult); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 283 | |
Zachary Turner | 97d2c40 | 2016-10-05 23:40:23 +0000 | [diff] [blame] | 284 | if (!args.empty()) { |
Zachary Turner | d6a2475 | 2016-11-22 17:10:15 +0000 | [diff] [blame] | 285 | for (const auto &arg : args) { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 286 | Status error(GetDebugger().DumpPropertyValue( |
Zachary Turner | d6a2475 | 2016-11-22 17:10:15 +0000 | [diff] [blame] | 287 | &m_exe_ctx, result.GetOutputStream(), arg.ref, |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 288 | OptionValue::eDumpGroupValue)); |
| 289 | if (error.Success()) { |
| 290 | result.GetOutputStream().EOL(); |
| 291 | } else { |
| 292 | result.AppendError(error.AsCString()); |
| 293 | result.SetStatus(eReturnStatusFailed); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 294 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 295 | } |
| 296 | } else { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 297 | GetDebugger().DumpAllPropertyValues(&m_exe_ctx, result.GetOutputStream(), |
| 298 | OptionValue::eDumpGroupValue); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 299 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 300 | |
| 301 | return result.Succeeded(); |
| 302 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 303 | }; |
| 304 | |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 305 | // CommandObjectSettingsWrite -- Write settings to file |
Raphael Isemann | 6f4fb4e | 2019-07-12 15:30:55 +0000 | [diff] [blame] | 306 | #define LLDB_OPTIONS_settings_write |
Raphael Isemann | c5a2d74 | 2019-07-16 09:27:02 +0000 | [diff] [blame] | 307 | #include "CommandOptions.inc" |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 308 | |
| 309 | class CommandObjectSettingsWrite : public CommandObjectParsed { |
| 310 | public: |
| 311 | CommandObjectSettingsWrite(CommandInterpreter &interpreter) |
| 312 | : CommandObjectParsed( |
| 313 | interpreter, "settings export", |
| 314 | "Write matching debugger settings and their " |
| 315 | "current values to a file that can be read in with " |
| 316 | "\"settings read\". Defaults to writing all settings.", |
| 317 | nullptr), |
| 318 | m_options() { |
| 319 | CommandArgumentEntry arg1; |
| 320 | CommandArgumentData var_name_arg; |
| 321 | |
| 322 | // Define the first (and only) variant of this arg. |
| 323 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 324 | var_name_arg.arg_repetition = eArgRepeatOptional; |
| 325 | |
| 326 | // There is only one variant this argument could be; put it into the |
| 327 | // argument entry. |
| 328 | arg1.push_back(var_name_arg); |
| 329 | |
| 330 | // Push the data for the first argument into the m_arguments vector. |
| 331 | m_arguments.push_back(arg1); |
| 332 | } |
| 333 | |
| 334 | ~CommandObjectSettingsWrite() override = default; |
| 335 | |
| 336 | Options *GetOptions() override { return &m_options; } |
| 337 | |
| 338 | class CommandOptions : public Options { |
| 339 | public: |
| 340 | CommandOptions() : Options() {} |
| 341 | |
| 342 | ~CommandOptions() override = default; |
| 343 | |
| 344 | Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, |
| 345 | ExecutionContext *execution_context) override { |
| 346 | Status error; |
| 347 | const int short_option = m_getopt_table[option_idx].val; |
| 348 | |
| 349 | switch (short_option) { |
| 350 | case 'f': |
| 351 | m_filename.assign(option_arg); |
| 352 | break; |
| 353 | case 'a': |
| 354 | m_append = true; |
| 355 | break; |
| 356 | default: |
Raphael Isemann | 3616201 | 2019-08-22 08:08:05 +0000 | [diff] [blame] | 357 | llvm_unreachable("Unimplemented option"); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 358 | } |
| 359 | |
| 360 | return error; |
| 361 | } |
| 362 | |
| 363 | void OptionParsingStarting(ExecutionContext *execution_context) override { |
| 364 | m_filename.clear(); |
| 365 | m_append = false; |
| 366 | } |
| 367 | |
| 368 | llvm::ArrayRef<OptionDefinition> GetDefinitions() override { |
| 369 | return llvm::makeArrayRef(g_settings_write_options); |
| 370 | } |
| 371 | |
| 372 | // Instance variables to hold the values for command options. |
| 373 | std::string m_filename; |
| 374 | bool m_append = false; |
| 375 | }; |
| 376 | |
| 377 | protected: |
| 378 | bool DoExecute(Args &args, CommandReturnObject &result) override { |
Jonas Devlieghere | 8f3be7a | 2018-11-01 21:05:36 +0000 | [diff] [blame] | 379 | FileSpec file_spec(m_options.m_filename); |
| 380 | FileSystem::Instance().Resolve(file_spec); |
| 381 | std::string path(file_spec.GetPath()); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 382 | uint32_t options = File::OpenOptions::eOpenOptionWrite | |
| 383 | File::OpenOptions::eOpenOptionCanCreate; |
| 384 | if (m_options.m_append) |
| 385 | options |= File::OpenOptions::eOpenOptionAppend; |
| 386 | else |
| 387 | options |= File::OpenOptions::eOpenOptionTruncate; |
| 388 | |
| 389 | StreamFile out_file(path.c_str(), options, |
| 390 | lldb::eFilePermissionsFileDefault); |
| 391 | |
| 392 | if (!out_file.GetFile().IsValid()) { |
| 393 | result.AppendErrorWithFormat("%s: unable to write to file", path.c_str()); |
| 394 | result.SetStatus(eReturnStatusFailed); |
| 395 | return false; |
| 396 | } |
| 397 | |
| 398 | // Exporting should not be context sensitive. |
| 399 | ExecutionContext clean_ctx; |
| 400 | |
| 401 | if (args.empty()) { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 402 | GetDebugger().DumpAllPropertyValues(&clean_ctx, out_file, |
| 403 | OptionValue::eDumpGroupExport); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 404 | return result.Succeeded(); |
| 405 | } |
| 406 | |
| 407 | for (const auto &arg : args) { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 408 | Status error(GetDebugger().DumpPropertyValue( |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 409 | &clean_ctx, out_file, arg.ref, OptionValue::eDumpGroupExport)); |
| 410 | if (!error.Success()) { |
| 411 | result.AppendError(error.AsCString()); |
| 412 | result.SetStatus(eReturnStatusFailed); |
| 413 | } |
| 414 | } |
| 415 | |
| 416 | return result.Succeeded(); |
| 417 | } |
| 418 | |
| 419 | private: |
| 420 | CommandOptions m_options; |
| 421 | }; |
| 422 | |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 423 | // CommandObjectSettingsRead -- Read settings from file |
Raphael Isemann | 6f4fb4e | 2019-07-12 15:30:55 +0000 | [diff] [blame] | 424 | #define LLDB_OPTIONS_settings_read |
Raphael Isemann | c5a2d74 | 2019-07-16 09:27:02 +0000 | [diff] [blame] | 425 | #include "CommandOptions.inc" |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 426 | |
| 427 | class CommandObjectSettingsRead : public CommandObjectParsed { |
| 428 | public: |
| 429 | CommandObjectSettingsRead(CommandInterpreter &interpreter) |
| 430 | : CommandObjectParsed( |
| 431 | interpreter, "settings read", |
| 432 | "Read settings previously saved to a file with \"settings write\".", |
| 433 | nullptr), |
| 434 | m_options() {} |
| 435 | |
| 436 | ~CommandObjectSettingsRead() override = default; |
| 437 | |
| 438 | Options *GetOptions() override { return &m_options; } |
| 439 | |
| 440 | class CommandOptions : public Options { |
| 441 | public: |
| 442 | CommandOptions() : Options() {} |
| 443 | |
| 444 | ~CommandOptions() override = default; |
| 445 | |
| 446 | Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, |
| 447 | ExecutionContext *execution_context) override { |
| 448 | Status error; |
| 449 | const int short_option = m_getopt_table[option_idx].val; |
| 450 | |
| 451 | switch (short_option) { |
| 452 | case 'f': |
| 453 | m_filename.assign(option_arg); |
| 454 | break; |
| 455 | default: |
Raphael Isemann | 3616201 | 2019-08-22 08:08:05 +0000 | [diff] [blame] | 456 | llvm_unreachable("Unimplemented option"); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 457 | } |
| 458 | |
| 459 | return error; |
| 460 | } |
| 461 | |
| 462 | void OptionParsingStarting(ExecutionContext *execution_context) override { |
| 463 | m_filename.clear(); |
| 464 | } |
| 465 | |
| 466 | llvm::ArrayRef<OptionDefinition> GetDefinitions() override { |
| 467 | return llvm::makeArrayRef(g_settings_read_options); |
| 468 | } |
| 469 | |
| 470 | // Instance variables to hold the values for command options. |
| 471 | std::string m_filename; |
| 472 | }; |
| 473 | |
| 474 | protected: |
| 475 | bool DoExecute(Args &command, CommandReturnObject &result) override { |
Jonas Devlieghere | 8f3be7a | 2018-11-01 21:05:36 +0000 | [diff] [blame] | 476 | FileSpec file(m_options.m_filename); |
| 477 | FileSystem::Instance().Resolve(file); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 478 | ExecutionContext clean_ctx; |
| 479 | CommandInterpreterRunOptions options; |
| 480 | options.SetAddToHistory(false); |
| 481 | options.SetEchoCommands(false); |
| 482 | options.SetPrintResults(true); |
Jonas Devlieghere | c0b48ab | 2019-05-08 01:23:47 +0000 | [diff] [blame] | 483 | options.SetPrintErrors(true); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 484 | options.SetStopOnError(false); |
| 485 | m_interpreter.HandleCommandsFromFile(file, &clean_ctx, options, result); |
| 486 | return result.Succeeded(); |
| 487 | } |
| 488 | |
| 489 | private: |
| 490 | CommandOptions m_options; |
| 491 | }; |
| 492 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 493 | // CommandObjectSettingsList -- List settable variables |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 494 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 495 | class CommandObjectSettingsList : public CommandObjectParsed { |
Kate Stone | 7428a18 | 2016-07-14 22:03:10 +0000 | [diff] [blame] | 496 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 497 | CommandObjectSettingsList(CommandInterpreter &interpreter) |
| 498 | : CommandObjectParsed(interpreter, "settings list", |
| 499 | "List and describe matching debugger settings. " |
| 500 | "Defaults to all listing all settings.", |
| 501 | nullptr) { |
| 502 | CommandArgumentEntry arg; |
| 503 | CommandArgumentData var_name_arg; |
| 504 | CommandArgumentData prefix_name_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 505 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 506 | // Define the first variant of this arg. |
| 507 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 508 | var_name_arg.arg_repetition = eArgRepeatOptional; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 509 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 510 | // Define the second variant of this arg. |
| 511 | prefix_name_arg.arg_type = eArgTypeSettingPrefix; |
| 512 | prefix_name_arg.arg_repetition = eArgRepeatOptional; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 513 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 514 | arg.push_back(var_name_arg); |
| 515 | arg.push_back(prefix_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 516 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 517 | // Push the data for the first argument into the m_arguments vector. |
| 518 | m_arguments.push_back(arg); |
| 519 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 520 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 521 | ~CommandObjectSettingsList() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 522 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 523 | void |
| 524 | HandleArgumentCompletion(CompletionRequest &request, |
| 525 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 526 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 527 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 528 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 529 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 530 | |
| 531 | protected: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 532 | bool DoExecute(Args &args, CommandReturnObject &result) override { |
| 533 | result.SetStatus(eReturnStatusSuccessFinishResult); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 534 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 535 | const bool will_modify = false; |
| 536 | const size_t argc = args.GetArgumentCount(); |
| 537 | if (argc > 0) { |
| 538 | const bool dump_qualified_name = true; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 539 | |
Zachary Turner | 97d2c40 | 2016-10-05 23:40:23 +0000 | [diff] [blame] | 540 | // TODO: Convert to StringRef based enumeration. Requires converting |
| 541 | // GetPropertyAtPath first. |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 542 | for (size_t i = 0; i < argc; ++i) { |
| 543 | const char *property_path = args.GetArgumentAtIndex(i); |
Greg Clayton | 67cc063 | 2012-08-22 17:17:09 +0000 | [diff] [blame] | 544 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 545 | const Property *property = |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 546 | GetDebugger().GetValueProperties()->GetPropertyAtPath( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 547 | &m_exe_ctx, will_modify, property_path); |
| 548 | |
| 549 | if (property) { |
| 550 | property->DumpDescription(m_interpreter, result.GetOutputStream(), 0, |
| 551 | dump_qualified_name); |
| 552 | } else { |
| 553 | result.AppendErrorWithFormat("invalid property path '%s'", |
| 554 | property_path); |
| 555 | result.SetStatus(eReturnStatusFailed); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 556 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 557 | } |
| 558 | } else { |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 559 | GetDebugger().DumpAllDescriptions(m_interpreter, |
| 560 | result.GetOutputStream()); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 561 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 562 | |
| 563 | return result.Succeeded(); |
| 564 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 565 | }; |
| 566 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 567 | // CommandObjectSettingsRemove |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 568 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 569 | class CommandObjectSettingsRemove : public CommandObjectRaw { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 570 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 571 | CommandObjectSettingsRemove(CommandInterpreter &interpreter) |
| 572 | : CommandObjectRaw(interpreter, "settings remove", |
| 573 | "Remove a value from a setting, specified by array " |
Zachary Turner | a449698 | 2016-10-05 21:14:38 +0000 | [diff] [blame] | 574 | "index or dictionary key.") { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 575 | CommandArgumentEntry arg1; |
| 576 | CommandArgumentEntry arg2; |
| 577 | CommandArgumentData var_name_arg; |
| 578 | CommandArgumentData index_arg; |
| 579 | CommandArgumentData key_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 580 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 581 | // Define the first (and only) variant of this arg. |
| 582 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 583 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 584 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 585 | // There is only one variant this argument could be; put it into the |
| 586 | // argument entry. |
| 587 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 588 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 589 | // Define the first variant of this arg. |
| 590 | index_arg.arg_type = eArgTypeSettingIndex; |
| 591 | index_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 592 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 593 | // Define the second variant of this arg. |
| 594 | key_arg.arg_type = eArgTypeSettingKey; |
| 595 | key_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 596 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 597 | // Push both variants into this arg |
| 598 | arg2.push_back(index_arg); |
| 599 | arg2.push_back(key_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 600 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 601 | // Push the data for the first argument into the m_arguments vector. |
| 602 | m_arguments.push_back(arg1); |
| 603 | m_arguments.push_back(arg2); |
| 604 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 605 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 606 | ~CommandObjectSettingsRemove() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 607 | |
Raphael Isemann | 006d22d | 2019-08-21 12:57:06 +0000 | [diff] [blame] | 608 | bool WantsCompletion() override { return true; } |
| 609 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 610 | void |
| 611 | HandleArgumentCompletion(CompletionRequest &request, |
| 612 | OptionElementVector &opt_element_vector) override { |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 613 | if (request.GetCursorIndex() < 2) |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 614 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 615 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 616 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 617 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 618 | |
| 619 | protected: |
Raphael Isemann | 4d51a90 | 2018-07-12 22:28:52 +0000 | [diff] [blame] | 620 | bool DoExecute(llvm::StringRef command, |
| 621 | CommandReturnObject &result) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 622 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
| 623 | |
| 624 | Args cmd_args(command); |
| 625 | |
| 626 | // Process possible options. |
| 627 | if (!ParseOptions(cmd_args, result)) |
| 628 | return false; |
| 629 | |
| 630 | const size_t argc = cmd_args.GetArgumentCount(); |
| 631 | if (argc == 0) { |
Raphael Isemann | 34a04e7 | 2019-08-21 13:24:21 +0000 | [diff] [blame] | 632 | result.AppendError("'settings remove' takes an array or dictionary item, " |
| 633 | "or an array followed by one or more indexes, or a " |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 634 | "dictionary followed by one or more key names to " |
| 635 | "remove"); |
| 636 | result.SetStatus(eReturnStatusFailed); |
| 637 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 638 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 639 | |
| 640 | const char *var_name = cmd_args.GetArgumentAtIndex(0); |
| 641 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 642 | result.AppendError( |
Raphael Isemann | 34a04e7 | 2019-08-21 13:24:21 +0000 | [diff] [blame] | 643 | "'settings remove' command requires a valid variable name"); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 644 | result.SetStatus(eReturnStatusFailed); |
| 645 | return false; |
| 646 | } |
| 647 | |
| 648 | // Split the raw command into var_name and value pair. |
| 649 | llvm::StringRef raw_str(command); |
| 650 | std::string var_value_string = raw_str.split(var_name).second.str(); |
| 651 | const char *var_value_cstr = |
| 652 | Args::StripSpaces(var_value_string, true, true, false); |
| 653 | |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 654 | Status error(GetDebugger().SetPropertyValue( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 655 | &m_exe_ctx, eVarSetOperationRemove, var_name, var_value_cstr)); |
| 656 | if (error.Fail()) { |
| 657 | result.AppendError(error.AsCString()); |
| 658 | result.SetStatus(eReturnStatusFailed); |
| 659 | return false; |
| 660 | } |
| 661 | |
| 662 | return result.Succeeded(); |
| 663 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 664 | }; |
| 665 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 666 | // CommandObjectSettingsReplace |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 667 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 668 | class CommandObjectSettingsReplace : public CommandObjectRaw { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 669 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 670 | CommandObjectSettingsReplace(CommandInterpreter &interpreter) |
| 671 | : CommandObjectRaw(interpreter, "settings replace", |
| 672 | "Replace the debugger setting value specified by " |
Zachary Turner | a449698 | 2016-10-05 21:14:38 +0000 | [diff] [blame] | 673 | "array index or dictionary key.") { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 674 | CommandArgumentEntry arg1; |
| 675 | CommandArgumentEntry arg2; |
| 676 | CommandArgumentEntry arg3; |
| 677 | CommandArgumentData var_name_arg; |
| 678 | CommandArgumentData index_arg; |
| 679 | CommandArgumentData key_arg; |
| 680 | CommandArgumentData value_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 681 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 682 | // Define the first (and only) variant of this arg. |
| 683 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 684 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 685 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 686 | // There is only one variant this argument could be; put it into the |
| 687 | // argument entry. |
| 688 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 689 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 690 | // Define the first (variant of this arg. |
| 691 | index_arg.arg_type = eArgTypeSettingIndex; |
| 692 | index_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 693 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 694 | // Define the second (variant of this arg. |
| 695 | key_arg.arg_type = eArgTypeSettingKey; |
| 696 | key_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 697 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 698 | // Put both variants into this arg |
| 699 | arg2.push_back(index_arg); |
| 700 | arg2.push_back(key_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 701 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 702 | // Define the first (and only) variant of this arg. |
| 703 | value_arg.arg_type = eArgTypeValue; |
| 704 | value_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 705 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 706 | // There is only one variant this argument could be; put it into the |
| 707 | // argument entry. |
| 708 | arg3.push_back(value_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 709 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 710 | // Push the data for the first argument into the m_arguments vector. |
| 711 | m_arguments.push_back(arg1); |
| 712 | m_arguments.push_back(arg2); |
| 713 | m_arguments.push_back(arg3); |
| 714 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 715 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 716 | ~CommandObjectSettingsReplace() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 717 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 718 | // Overrides base class's behavior where WantsCompletion = |
| 719 | // !WantsRawCommandString. |
| 720 | bool WantsCompletion() override { return true; } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 721 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 722 | void |
| 723 | HandleArgumentCompletion(CompletionRequest &request, |
| 724 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 725 | // Attempting to complete variable name |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 726 | if (request.GetCursorIndex() < 2) |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 727 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 728 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 729 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 730 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 731 | |
| 732 | protected: |
Raphael Isemann | 4d51a90 | 2018-07-12 22:28:52 +0000 | [diff] [blame] | 733 | bool DoExecute(llvm::StringRef command, |
| 734 | CommandReturnObject &result) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 735 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 736 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 737 | Args cmd_args(command); |
| 738 | const char *var_name = cmd_args.GetArgumentAtIndex(0); |
| 739 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 740 | result.AppendError("'settings replace' command requires a valid variable " |
| 741 | "name; No value supplied"); |
| 742 | result.SetStatus(eReturnStatusFailed); |
| 743 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 744 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 745 | |
| 746 | // Split the raw command into var_name, index_value, and value triple. |
| 747 | llvm::StringRef raw_str(command); |
| 748 | std::string var_value_string = raw_str.split(var_name).second.str(); |
| 749 | const char *var_value_cstr = |
| 750 | Args::StripSpaces(var_value_string, true, true, false); |
| 751 | |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 752 | Status error(GetDebugger().SetPropertyValue( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 753 | &m_exe_ctx, eVarSetOperationReplace, var_name, var_value_cstr)); |
| 754 | if (error.Fail()) { |
| 755 | result.AppendError(error.AsCString()); |
| 756 | result.SetStatus(eReturnStatusFailed); |
| 757 | return false; |
| 758 | } else { |
| 759 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
| 760 | } |
| 761 | |
| 762 | return result.Succeeded(); |
| 763 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 764 | }; |
| 765 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 766 | // CommandObjectSettingsInsertBefore |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 767 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 768 | class CommandObjectSettingsInsertBefore : public CommandObjectRaw { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 769 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 770 | CommandObjectSettingsInsertBefore(CommandInterpreter &interpreter) |
| 771 | : CommandObjectRaw(interpreter, "settings insert-before", |
| 772 | "Insert one or more values into an debugger array " |
| 773 | "setting immediately before the specified element " |
Zachary Turner | a449698 | 2016-10-05 21:14:38 +0000 | [diff] [blame] | 774 | "index.") { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 775 | CommandArgumentEntry arg1; |
| 776 | CommandArgumentEntry arg2; |
| 777 | CommandArgumentEntry arg3; |
| 778 | CommandArgumentData var_name_arg; |
| 779 | CommandArgumentData index_arg; |
| 780 | CommandArgumentData value_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 781 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 782 | // Define the first (and only) variant of this arg. |
| 783 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 784 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 785 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 786 | // There is only one variant this argument could be; put it into the |
| 787 | // argument entry. |
| 788 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 789 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 790 | // Define the first (variant of this arg. |
| 791 | index_arg.arg_type = eArgTypeSettingIndex; |
| 792 | index_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 793 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 794 | // There is only one variant this argument could be; put it into the |
| 795 | // argument entry. |
| 796 | arg2.push_back(index_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 797 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 798 | // Define the first (and only) variant of this arg. |
| 799 | value_arg.arg_type = eArgTypeValue; |
| 800 | value_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 801 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 802 | // There is only one variant this argument could be; put it into the |
| 803 | // argument entry. |
| 804 | arg3.push_back(value_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 805 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 806 | // Push the data for the first argument into the m_arguments vector. |
| 807 | m_arguments.push_back(arg1); |
| 808 | m_arguments.push_back(arg2); |
| 809 | m_arguments.push_back(arg3); |
| 810 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 811 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 812 | ~CommandObjectSettingsInsertBefore() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 813 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 814 | // Overrides base class's behavior where WantsCompletion = |
| 815 | // !WantsRawCommandString. |
| 816 | bool WantsCompletion() override { return true; } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 817 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 818 | void |
| 819 | HandleArgumentCompletion(CompletionRequest &request, |
| 820 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 821 | // Attempting to complete variable name |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 822 | if (request.GetCursorIndex() < 2) |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 823 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 824 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 825 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 826 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 827 | |
| 828 | protected: |
Raphael Isemann | 4d51a90 | 2018-07-12 22:28:52 +0000 | [diff] [blame] | 829 | bool DoExecute(llvm::StringRef command, |
| 830 | CommandReturnObject &result) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 831 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 832 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 833 | Args cmd_args(command); |
| 834 | const size_t argc = cmd_args.GetArgumentCount(); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 835 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 836 | if (argc < 3) { |
| 837 | result.AppendError("'settings insert-before' takes more arguments"); |
| 838 | result.SetStatus(eReturnStatusFailed); |
| 839 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 840 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 841 | |
| 842 | const char *var_name = cmd_args.GetArgumentAtIndex(0); |
| 843 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 844 | result.AppendError("'settings insert-before' command requires a valid " |
| 845 | "variable name; No value supplied"); |
| 846 | result.SetStatus(eReturnStatusFailed); |
| 847 | return false; |
| 848 | } |
| 849 | |
| 850 | // Split the raw command into var_name, index_value, and value triple. |
| 851 | llvm::StringRef raw_str(command); |
| 852 | std::string var_value_string = raw_str.split(var_name).second.str(); |
| 853 | const char *var_value_cstr = |
| 854 | Args::StripSpaces(var_value_string, true, true, false); |
| 855 | |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 856 | Status error(GetDebugger().SetPropertyValue( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 857 | &m_exe_ctx, eVarSetOperationInsertBefore, var_name, var_value_cstr)); |
| 858 | if (error.Fail()) { |
| 859 | result.AppendError(error.AsCString()); |
| 860 | result.SetStatus(eReturnStatusFailed); |
| 861 | return false; |
| 862 | } |
| 863 | |
| 864 | return result.Succeeded(); |
| 865 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 866 | }; |
| 867 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 868 | // CommandObjectSettingInsertAfter |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 869 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 870 | class CommandObjectSettingsInsertAfter : public CommandObjectRaw { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 871 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 872 | CommandObjectSettingsInsertAfter(CommandInterpreter &interpreter) |
| 873 | : CommandObjectRaw(interpreter, "settings insert-after", |
| 874 | "Insert one or more values into a debugger array " |
Zachary Turner | a449698 | 2016-10-05 21:14:38 +0000 | [diff] [blame] | 875 | "settings after the specified element index.") { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 876 | CommandArgumentEntry arg1; |
| 877 | CommandArgumentEntry arg2; |
| 878 | CommandArgumentEntry arg3; |
| 879 | CommandArgumentData var_name_arg; |
| 880 | CommandArgumentData index_arg; |
| 881 | CommandArgumentData value_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 882 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 883 | // Define the first (and only) variant of this arg. |
| 884 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 885 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 886 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 887 | // There is only one variant this argument could be; put it into the |
| 888 | // argument entry. |
| 889 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 890 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 891 | // Define the first (variant of this arg. |
| 892 | index_arg.arg_type = eArgTypeSettingIndex; |
| 893 | index_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 894 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 895 | // There is only one variant this argument could be; put it into the |
| 896 | // argument entry. |
| 897 | arg2.push_back(index_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 898 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 899 | // Define the first (and only) variant of this arg. |
| 900 | value_arg.arg_type = eArgTypeValue; |
| 901 | value_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 902 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 903 | // There is only one variant this argument could be; put it into the |
| 904 | // argument entry. |
| 905 | arg3.push_back(value_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 906 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 907 | // Push the data for the first argument into the m_arguments vector. |
| 908 | m_arguments.push_back(arg1); |
| 909 | m_arguments.push_back(arg2); |
| 910 | m_arguments.push_back(arg3); |
| 911 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 912 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 913 | ~CommandObjectSettingsInsertAfter() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 914 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 915 | // Overrides base class's behavior where WantsCompletion = |
| 916 | // !WantsRawCommandString. |
| 917 | bool WantsCompletion() override { return true; } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 918 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 919 | void |
| 920 | HandleArgumentCompletion(CompletionRequest &request, |
| 921 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 922 | // Attempting to complete variable name |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 923 | if (request.GetCursorIndex() < 2) |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 924 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 925 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 926 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 927 | } |
| 928 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 929 | protected: |
Raphael Isemann | 4d51a90 | 2018-07-12 22:28:52 +0000 | [diff] [blame] | 930 | bool DoExecute(llvm::StringRef command, |
| 931 | CommandReturnObject &result) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 932 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 933 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 934 | Args cmd_args(command); |
| 935 | const size_t argc = cmd_args.GetArgumentCount(); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 936 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 937 | if (argc < 3) { |
| 938 | result.AppendError("'settings insert-after' takes more arguments"); |
| 939 | result.SetStatus(eReturnStatusFailed); |
| 940 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 941 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 942 | |
| 943 | const char *var_name = cmd_args.GetArgumentAtIndex(0); |
| 944 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 945 | result.AppendError("'settings insert-after' command requires a valid " |
| 946 | "variable name; No value supplied"); |
| 947 | result.SetStatus(eReturnStatusFailed); |
| 948 | return false; |
| 949 | } |
| 950 | |
| 951 | // Split the raw command into var_name, index_value, and value triple. |
| 952 | llvm::StringRef raw_str(command); |
| 953 | std::string var_value_string = raw_str.split(var_name).second.str(); |
| 954 | const char *var_value_cstr = |
| 955 | Args::StripSpaces(var_value_string, true, true, false); |
| 956 | |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 957 | Status error(GetDebugger().SetPropertyValue( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 958 | &m_exe_ctx, eVarSetOperationInsertAfter, var_name, var_value_cstr)); |
| 959 | if (error.Fail()) { |
| 960 | result.AppendError(error.AsCString()); |
| 961 | result.SetStatus(eReturnStatusFailed); |
| 962 | return false; |
| 963 | } |
| 964 | |
| 965 | return result.Succeeded(); |
| 966 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 967 | }; |
| 968 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 969 | // CommandObjectSettingsAppend |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 970 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 971 | class CommandObjectSettingsAppend : public CommandObjectRaw { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 972 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 973 | CommandObjectSettingsAppend(CommandInterpreter &interpreter) |
| 974 | : CommandObjectRaw(interpreter, "settings append", |
| 975 | "Append one or more values to a debugger array, " |
Zachary Turner | a449698 | 2016-10-05 21:14:38 +0000 | [diff] [blame] | 976 | "dictionary, or string setting.") { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 977 | CommandArgumentEntry arg1; |
| 978 | CommandArgumentEntry arg2; |
| 979 | CommandArgumentData var_name_arg; |
| 980 | CommandArgumentData value_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 981 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 982 | // Define the first (and only) variant of this arg. |
| 983 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 984 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 985 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 986 | // There is only one variant this argument could be; put it into the |
| 987 | // argument entry. |
| 988 | arg1.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 989 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 990 | // Define the first (and only) variant of this arg. |
| 991 | value_arg.arg_type = eArgTypeValue; |
| 992 | value_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 993 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 994 | // There is only one variant this argument could be; put it into the |
| 995 | // argument entry. |
| 996 | arg2.push_back(value_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 997 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 998 | // Push the data for the first argument into the m_arguments vector. |
| 999 | m_arguments.push_back(arg1); |
| 1000 | m_arguments.push_back(arg2); |
| 1001 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1002 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1003 | ~CommandObjectSettingsAppend() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1004 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1005 | // Overrides base class's behavior where WantsCompletion = |
| 1006 | // !WantsRawCommandString. |
| 1007 | bool WantsCompletion() override { return true; } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1008 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 1009 | void |
| 1010 | HandleArgumentCompletion(CompletionRequest &request, |
| 1011 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1012 | // Attempting to complete variable name |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 1013 | if (request.GetCursorIndex() < 2) |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1014 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 1015 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 1016 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1017 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1018 | |
| 1019 | protected: |
Raphael Isemann | 4d51a90 | 2018-07-12 22:28:52 +0000 | [diff] [blame] | 1020 | bool DoExecute(llvm::StringRef command, |
| 1021 | CommandReturnObject &result) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1022 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
| 1023 | Args cmd_args(command); |
| 1024 | const size_t argc = cmd_args.GetArgumentCount(); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1025 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1026 | if (argc < 2) { |
| 1027 | result.AppendError("'settings append' takes more arguments"); |
| 1028 | result.SetStatus(eReturnStatusFailed); |
| 1029 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1030 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1031 | |
| 1032 | const char *var_name = cmd_args.GetArgumentAtIndex(0); |
| 1033 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 1034 | result.AppendError("'settings append' command requires a valid variable " |
| 1035 | "name; No value supplied"); |
| 1036 | result.SetStatus(eReturnStatusFailed); |
| 1037 | return false; |
| 1038 | } |
| 1039 | |
Adrian Prantl | 0509724 | 2018-04-30 16:49:04 +0000 | [diff] [blame] | 1040 | // Do not perform cmd_args.Shift() since StringRef is manipulating the raw |
| 1041 | // character string later on. |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1042 | |
| 1043 | // Split the raw command into var_name and value pair. |
| 1044 | llvm::StringRef raw_str(command); |
| 1045 | std::string var_value_string = raw_str.split(var_name).second.str(); |
| 1046 | const char *var_value_cstr = |
| 1047 | Args::StripSpaces(var_value_string, true, true, false); |
| 1048 | |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 1049 | Status error(GetDebugger().SetPropertyValue( |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1050 | &m_exe_ctx, eVarSetOperationAppend, var_name, var_value_cstr)); |
| 1051 | if (error.Fail()) { |
| 1052 | result.AppendError(error.AsCString()); |
| 1053 | result.SetStatus(eReturnStatusFailed); |
| 1054 | return false; |
| 1055 | } |
| 1056 | |
| 1057 | return result.Succeeded(); |
| 1058 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1059 | }; |
| 1060 | |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1061 | // CommandObjectSettingsClear |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1062 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1063 | class CommandObjectSettingsClear : public CommandObjectParsed { |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1064 | public: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1065 | CommandObjectSettingsClear(CommandInterpreter &interpreter) |
| 1066 | : CommandObjectParsed( |
| 1067 | interpreter, "settings clear", |
| 1068 | "Clear a debugger setting array, dictionary, or string.", nullptr) { |
| 1069 | CommandArgumentEntry arg; |
| 1070 | CommandArgumentData var_name_arg; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1071 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1072 | // Define the first (and only) variant of this arg. |
| 1073 | var_name_arg.arg_type = eArgTypeSettingVariableName; |
| 1074 | var_name_arg.arg_repetition = eArgRepeatPlain; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1075 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1076 | // There is only one variant this argument could be; put it into the |
| 1077 | // argument entry. |
| 1078 | arg.push_back(var_name_arg); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1079 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1080 | // Push the data for the first argument into the m_arguments vector. |
| 1081 | m_arguments.push_back(arg); |
| 1082 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1083 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1084 | ~CommandObjectSettingsClear() override = default; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1085 | |
Raphael Isemann | ae34ed2 | 2019-08-22 07:41:23 +0000 | [diff] [blame] | 1086 | void |
| 1087 | HandleArgumentCompletion(CompletionRequest &request, |
| 1088 | OptionElementVector &opt_element_vector) override { |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1089 | // Attempting to complete variable name |
Raphael Isemann | 2443bbd | 2018-07-02 21:29:56 +0000 | [diff] [blame] | 1090 | if (request.GetCursorIndex() < 2) |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1091 | CommandCompletions::InvokeCommonCompletionCallbacks( |
| 1092 | GetCommandInterpreter(), CommandCompletions::eSettingsNameCompletion, |
Raphael Isemann | a2e76c0 | 2018-07-13 18:28:14 +0000 | [diff] [blame] | 1093 | request, nullptr); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1094 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1095 | |
| 1096 | protected: |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1097 | bool DoExecute(Args &command, CommandReturnObject &result) override { |
| 1098 | result.SetStatus(eReturnStatusSuccessFinishNoResult); |
| 1099 | const size_t argc = command.GetArgumentCount(); |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1100 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1101 | if (argc != 1) { |
| 1102 | result.AppendError("'settings clear' takes exactly one argument"); |
| 1103 | result.SetStatus(eReturnStatusFailed); |
| 1104 | return false; |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1105 | } |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1106 | |
| 1107 | const char *var_name = command.GetArgumentAtIndex(0); |
| 1108 | if ((var_name == nullptr) || (var_name[0] == '\0')) { |
| 1109 | result.AppendError("'settings clear' command requires a valid variable " |
| 1110 | "name; No value supplied"); |
| 1111 | result.SetStatus(eReturnStatusFailed); |
| 1112 | return false; |
| 1113 | } |
| 1114 | |
Jonas Devlieghere | 5717986 | 2019-04-27 06:19:42 +0000 | [diff] [blame] | 1115 | Status error(GetDebugger().SetPropertyValue( |
Zachary Turner | 31d97a5 | 2016-11-17 18:08:12 +0000 | [diff] [blame] | 1116 | &m_exe_ctx, eVarSetOperationClear, var_name, llvm::StringRef())); |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1117 | if (error.Fail()) { |
| 1118 | result.AppendError(error.AsCString()); |
| 1119 | result.SetStatus(eReturnStatusFailed); |
| 1120 | return false; |
| 1121 | } |
| 1122 | |
| 1123 | return result.Succeeded(); |
| 1124 | } |
Jim Ingham | 5a98841 | 2012-06-08 21:56:10 +0000 | [diff] [blame] | 1125 | }; |
Chris Lattner | 30fdc8d | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 1126 | |
Caroline Tice | 3df9a8d | 2010-09-04 00:03:46 +0000 | [diff] [blame] | 1127 | // CommandObjectMultiwordSettings |
Chris Lattner | 30fdc8d | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 1128 | |
Kate Stone | b9c1b51 | 2016-09-06 20:57:50 +0000 | [diff] [blame] | 1129 | CommandObjectMultiwordSettings::CommandObjectMultiwordSettings( |
| 1130 | CommandInterpreter &interpreter) |
| 1131 | : CommandObjectMultiword(interpreter, "settings", |
| 1132 | "Commands for managing LLDB settings.", |
| 1133 | "settings <subcommand> [<command-options>]") { |
| 1134 | LoadSubCommand("set", |
| 1135 | CommandObjectSP(new CommandObjectSettingsSet(interpreter))); |
| 1136 | LoadSubCommand("show", |
| 1137 | CommandObjectSP(new CommandObjectSettingsShow(interpreter))); |
| 1138 | LoadSubCommand("list", |
| 1139 | CommandObjectSP(new CommandObjectSettingsList(interpreter))); |
| 1140 | LoadSubCommand("remove", |
| 1141 | CommandObjectSP(new CommandObjectSettingsRemove(interpreter))); |
| 1142 | LoadSubCommand("replace", CommandObjectSP( |
| 1143 | new CommandObjectSettingsReplace(interpreter))); |
| 1144 | LoadSubCommand( |
| 1145 | "insert-before", |
| 1146 | CommandObjectSP(new CommandObjectSettingsInsertBefore(interpreter))); |
| 1147 | LoadSubCommand( |
| 1148 | "insert-after", |
| 1149 | CommandObjectSP(new CommandObjectSettingsInsertAfter(interpreter))); |
| 1150 | LoadSubCommand("append", |
| 1151 | CommandObjectSP(new CommandObjectSettingsAppend(interpreter))); |
| 1152 | LoadSubCommand("clear", |
| 1153 | CommandObjectSP(new CommandObjectSettingsClear(interpreter))); |
Jonas Devlieghere | b76e25a | 2018-10-26 00:00:17 +0000 | [diff] [blame] | 1154 | LoadSubCommand("write", |
| 1155 | CommandObjectSP(new CommandObjectSettingsWrite(interpreter))); |
| 1156 | LoadSubCommand("read", |
| 1157 | CommandObjectSP(new CommandObjectSettingsRead(interpreter))); |
Caroline Tice | 3df9a8d | 2010-09-04 00:03:46 +0000 | [diff] [blame] | 1158 | } |
| 1159 | |
Eugene Zelenko | 3f18ea0 | 2016-02-24 02:05:55 +0000 | [diff] [blame] | 1160 | CommandObjectMultiwordSettings::~CommandObjectMultiwordSettings() = default; |