Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 1 | //===-- CommandObject.cpp ---------------------------------------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | |
| 10 | #include "lldb/Interpreter/CommandObject.h" |
| 11 | |
| 12 | #include <string> |
| 13 | #include <map> |
| 14 | |
| 15 | #include <getopt.h> |
| 16 | #include <stdlib.h> |
| 17 | #include <ctype.h> |
| 18 | |
| 19 | #include "lldb/Core/Address.h" |
Jim Ingham | 84cdc15 | 2010-06-15 19:49:27 +0000 | [diff] [blame] | 20 | #include "lldb/Interpreter/Options.h" |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 21 | |
| 22 | // These are for the Sourcename completers. |
| 23 | // FIXME: Make a separate file for the completers. |
| 24 | #include "lldb/Core/FileSpec.h" |
| 25 | #include "lldb/Core/FileSpecList.h" |
| 26 | #include "lldb/Target/Process.h" |
| 27 | #include "lldb/Target/Target.h" |
| 28 | |
| 29 | #include "lldb/Interpreter/CommandInterpreter.h" |
| 30 | #include "lldb/Interpreter/CommandReturnObject.h" |
| 31 | #include "lldb/Interpreter/ScriptInterpreter.h" |
| 32 | #include "lldb/Interpreter/ScriptInterpreterPython.h" |
| 33 | |
| 34 | using namespace lldb; |
| 35 | using namespace lldb_private; |
| 36 | |
| 37 | //------------------------------------------------------------------------- |
| 38 | // CommandObject |
| 39 | //------------------------------------------------------------------------- |
| 40 | |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 41 | CommandObject::CommandObject |
| 42 | ( |
| 43 | CommandInterpreter &interpreter, |
| 44 | const char *name, |
| 45 | const char *help, |
| 46 | const char *syntax, |
| 47 | uint32_t flags |
| 48 | ) : |
| 49 | m_interpreter (interpreter), |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 50 | m_cmd_name (name), |
| 51 | m_cmd_help_short (), |
| 52 | m_cmd_help_long (), |
| 53 | m_cmd_syntax (), |
Jim Ingham | d40f8a6 | 2010-07-06 22:46:59 +0000 | [diff] [blame] | 54 | m_is_alias (false), |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 55 | m_flags (flags), |
| 56 | m_arguments() |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 57 | { |
| 58 | if (help && help[0]) |
| 59 | m_cmd_help_short = help; |
| 60 | if (syntax && syntax[0]) |
| 61 | m_cmd_syntax = syntax; |
| 62 | } |
| 63 | |
| 64 | CommandObject::~CommandObject () |
| 65 | { |
| 66 | } |
| 67 | |
| 68 | const char * |
| 69 | CommandObject::GetHelp () |
| 70 | { |
| 71 | return m_cmd_help_short.c_str(); |
| 72 | } |
| 73 | |
| 74 | const char * |
| 75 | CommandObject::GetHelpLong () |
| 76 | { |
| 77 | return m_cmd_help_long.c_str(); |
| 78 | } |
| 79 | |
| 80 | const char * |
| 81 | CommandObject::GetSyntax () |
| 82 | { |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 83 | if (m_cmd_syntax.length() == 0) |
| 84 | { |
| 85 | StreamString syntax_str; |
| 86 | syntax_str.Printf ("%s", GetCommandName()); |
| 87 | if (GetOptions() != NULL) |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 88 | syntax_str.Printf (" <cmd-options>"); |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 89 | if (m_arguments.size() > 0) |
| 90 | { |
| 91 | syntax_str.Printf (" "); |
| 92 | GetFormattedCommandArguments (syntax_str); |
| 93 | } |
| 94 | m_cmd_syntax = syntax_str.GetData (); |
| 95 | } |
| 96 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 97 | return m_cmd_syntax.c_str(); |
| 98 | } |
| 99 | |
| 100 | const char * |
| 101 | CommandObject::Translate () |
| 102 | { |
| 103 | //return m_cmd_func_name.c_str(); |
| 104 | return "This function is currently not implemented."; |
| 105 | } |
| 106 | |
| 107 | const char * |
| 108 | CommandObject::GetCommandName () |
| 109 | { |
| 110 | return m_cmd_name.c_str(); |
| 111 | } |
| 112 | |
| 113 | void |
| 114 | CommandObject::SetCommandName (const char *name) |
| 115 | { |
| 116 | m_cmd_name = name; |
| 117 | } |
| 118 | |
| 119 | void |
| 120 | CommandObject::SetHelp (const char *cstr) |
| 121 | { |
| 122 | m_cmd_help_short = cstr; |
| 123 | } |
| 124 | |
| 125 | void |
| 126 | CommandObject::SetHelpLong (const char *cstr) |
| 127 | { |
| 128 | m_cmd_help_long = cstr; |
| 129 | } |
| 130 | |
| 131 | void |
| 132 | CommandObject::SetSyntax (const char *cstr) |
| 133 | { |
| 134 | m_cmd_syntax = cstr; |
| 135 | } |
| 136 | |
| 137 | Options * |
| 138 | CommandObject::GetOptions () |
| 139 | { |
| 140 | // By default commands don't have options unless this virtual function |
| 141 | // is overridden by base classes. |
| 142 | return NULL; |
| 143 | } |
| 144 | |
| 145 | Flags& |
| 146 | CommandObject::GetFlags() |
| 147 | { |
| 148 | return m_flags; |
| 149 | } |
| 150 | |
| 151 | const Flags& |
| 152 | CommandObject::GetFlags() const |
| 153 | { |
| 154 | return m_flags; |
| 155 | } |
| 156 | |
| 157 | bool |
| 158 | CommandObject::ExecuteCommandString |
| 159 | ( |
| 160 | const char *command_line, |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 161 | CommandReturnObject &result |
| 162 | ) |
| 163 | { |
| 164 | Args command_args(command_line); |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 165 | return ExecuteWithOptions (command_args, result); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | bool |
| 169 | CommandObject::ParseOptions |
| 170 | ( |
| 171 | Args& args, |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 172 | CommandReturnObject &result |
| 173 | ) |
| 174 | { |
| 175 | // See if the subclass has options? |
| 176 | Options *options = GetOptions(); |
| 177 | if (options != NULL) |
| 178 | { |
| 179 | Error error; |
| 180 | options->ResetOptionValues(); |
| 181 | |
| 182 | // ParseOptions calls getopt_long, which always skips the zero'th item in the array and starts at position 1, |
| 183 | // so we need to push a dummy value into position zero. |
| 184 | args.Unshift("dummy_string"); |
| 185 | error = args.ParseOptions (*options); |
| 186 | |
| 187 | // The "dummy_string" will have already been removed by ParseOptions, |
| 188 | // so no need to remove it. |
| 189 | |
| 190 | if (error.Fail() || !options->VerifyOptions (result)) |
| 191 | { |
| 192 | const char *error_cstr = error.AsCString(); |
| 193 | if (error_cstr) |
| 194 | { |
| 195 | // We got an error string, lets use that |
| 196 | result.GetErrorStream().PutCString(error_cstr); |
| 197 | } |
| 198 | else |
| 199 | { |
| 200 | // No error string, output the usage information into result |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 201 | options->GenerateOptionUsage (m_interpreter, result.GetErrorStream(), this); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 202 | } |
| 203 | // Set the return status to failed (this was an error). |
| 204 | result.SetStatus (eReturnStatusFailed); |
| 205 | return false; |
| 206 | } |
| 207 | } |
| 208 | return true; |
| 209 | } |
| 210 | bool |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 211 | CommandObject::ExecuteWithOptions (Args& args, CommandReturnObject &result) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 212 | { |
| 213 | for (size_t i = 0; i < args.GetArgumentCount(); ++i) |
| 214 | { |
| 215 | const char *tmp_str = args.GetArgumentAtIndex (i); |
| 216 | if (tmp_str[0] == '`') // back-quote |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 217 | args.ReplaceArgumentAtIndex (i, m_interpreter.ProcessEmbeddedScriptCommands (tmp_str)); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 218 | } |
| 219 | |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 220 | Process *process = m_interpreter.GetDebugger().GetExecutionContext().process; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 221 | if (process == NULL) |
| 222 | { |
| 223 | if (GetFlags().IsSet(CommandObject::eFlagProcessMustBeLaunched | CommandObject::eFlagProcessMustBePaused)) |
| 224 | { |
| 225 | result.AppendError ("Process must exist."); |
| 226 | result.SetStatus (eReturnStatusFailed); |
| 227 | return false; |
| 228 | } |
| 229 | } |
| 230 | else |
| 231 | { |
| 232 | StateType state = process->GetState(); |
| 233 | |
| 234 | switch (state) |
| 235 | { |
| 236 | |
| 237 | case eStateAttaching: |
| 238 | case eStateLaunching: |
| 239 | case eStateSuspended: |
| 240 | case eStateCrashed: |
| 241 | case eStateStopped: |
| 242 | break; |
| 243 | |
| 244 | case eStateDetached: |
| 245 | case eStateExited: |
| 246 | case eStateUnloaded: |
| 247 | if (GetFlags().IsSet(CommandObject::eFlagProcessMustBeLaunched)) |
| 248 | { |
| 249 | result.AppendError ("Process must be launched."); |
| 250 | result.SetStatus (eReturnStatusFailed); |
| 251 | return false; |
| 252 | } |
| 253 | break; |
| 254 | |
| 255 | case eStateRunning: |
| 256 | case eStateStepping: |
| 257 | if (GetFlags().IsSet(CommandObject::eFlagProcessMustBePaused)) |
| 258 | { |
| 259 | result.AppendError ("Process is running. Use 'process interrupt' to pause execution."); |
| 260 | result.SetStatus (eReturnStatusFailed); |
| 261 | return false; |
| 262 | } |
| 263 | } |
| 264 | } |
| 265 | |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 266 | if (!ParseOptions (args, result)) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 267 | return false; |
| 268 | |
| 269 | // Call the command-specific version of 'Execute', passing it the already processed arguments. |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 270 | return Execute (args, result); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 271 | } |
| 272 | |
| 273 | class CommandDictCommandPartialMatch |
| 274 | { |
| 275 | public: |
| 276 | CommandDictCommandPartialMatch (const char *match_str) |
| 277 | { |
| 278 | m_match_str = match_str; |
| 279 | } |
| 280 | bool operator() (const std::pair<std::string, lldb::CommandObjectSP> map_element) const |
| 281 | { |
| 282 | // A NULL or empty string matches everything. |
| 283 | if (m_match_str == NULL || *m_match_str == '\0') |
| 284 | return 1; |
| 285 | |
| 286 | size_t found = map_element.first.find (m_match_str, 0); |
| 287 | if (found == std::string::npos) |
| 288 | return 0; |
| 289 | else |
| 290 | return found == 0; |
| 291 | } |
| 292 | |
| 293 | private: |
| 294 | const char *m_match_str; |
| 295 | }; |
| 296 | |
| 297 | int |
| 298 | CommandObject::AddNamesMatchingPartialString (CommandObject::CommandMap &in_map, const char *cmd_str, |
| 299 | StringList &matches) |
| 300 | { |
| 301 | int number_added = 0; |
| 302 | CommandDictCommandPartialMatch matcher(cmd_str); |
| 303 | |
| 304 | CommandObject::CommandMap::iterator matching_cmds = std::find_if (in_map.begin(), in_map.end(), matcher); |
| 305 | |
| 306 | while (matching_cmds != in_map.end()) |
| 307 | { |
| 308 | ++number_added; |
| 309 | matches.AppendString((*matching_cmds).first.c_str()); |
| 310 | matching_cmds = std::find_if (++matching_cmds, in_map.end(), matcher);; |
| 311 | } |
| 312 | return number_added; |
| 313 | } |
| 314 | |
| 315 | int |
| 316 | CommandObject::HandleCompletion |
| 317 | ( |
| 318 | Args &input, |
| 319 | int &cursor_index, |
| 320 | int &cursor_char_position, |
| 321 | int match_start_point, |
| 322 | int max_return_elements, |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame] | 323 | bool &word_complete, |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 324 | StringList &matches |
| 325 | ) |
| 326 | { |
| 327 | if (WantsRawCommandString()) |
| 328 | { |
| 329 | // FIXME: Abstract telling the completion to insert the completion character. |
| 330 | matches.Clear(); |
| 331 | return -1; |
| 332 | } |
| 333 | else |
| 334 | { |
| 335 | // Can we do anything generic with the options? |
| 336 | Options *cur_options = GetOptions(); |
| 337 | CommandReturnObject result; |
| 338 | OptionElementVector opt_element_vector; |
| 339 | |
| 340 | if (cur_options != NULL) |
| 341 | { |
| 342 | // Re-insert the dummy command name string which will have been |
| 343 | // stripped off: |
| 344 | input.Unshift ("dummy-string"); |
| 345 | cursor_index++; |
| 346 | |
| 347 | |
| 348 | // I stick an element on the end of the input, because if the last element is |
| 349 | // option that requires an argument, getopt_long will freak out. |
| 350 | |
| 351 | input.AppendArgument ("<FAKE-VALUE>"); |
| 352 | |
Jim Ingham | adb8429 | 2010-06-24 20:31:04 +0000 | [diff] [blame] | 353 | input.ParseArgsForCompletion (*cur_options, opt_element_vector, cursor_index); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 354 | |
| 355 | input.DeleteArgumentAtIndex(input.GetArgumentCount() - 1); |
| 356 | |
| 357 | bool handled_by_options; |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 358 | handled_by_options = cur_options->HandleOptionCompletion (m_interpreter, |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 359 | input, |
| 360 | opt_element_vector, |
| 361 | cursor_index, |
| 362 | cursor_char_position, |
| 363 | match_start_point, |
| 364 | max_return_elements, |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame] | 365 | word_complete, |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 366 | matches); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 367 | if (handled_by_options) |
| 368 | return matches.GetSize(); |
| 369 | } |
| 370 | |
| 371 | // If we got here, the last word is not an option or an option argument. |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 372 | return HandleArgumentCompletion (input, |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 373 | cursor_index, |
| 374 | cursor_char_position, |
| 375 | opt_element_vector, |
| 376 | match_start_point, |
| 377 | max_return_elements, |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame] | 378 | word_complete, |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 379 | matches); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 380 | } |
| 381 | } |
| 382 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 383 | // Case insensitive version of ::strstr() |
| 384 | // Returns true if s2 is contained within s1. |
| 385 | |
| 386 | static bool |
| 387 | contains_string (const char *s1, const char *s2) |
| 388 | { |
| 389 | char *locase_s1 = (char *) malloc (strlen (s1) + 1); |
| 390 | char *locase_s2 = (char *) malloc (strlen (s2) + 1); |
| 391 | int i; |
| 392 | for (i = 0; s1 && s1[i] != '\0'; i++) |
| 393 | locase_s1[i] = ::tolower (s1[i]); |
| 394 | locase_s1[i] = '\0'; |
| 395 | for (i = 0; s2 && s2[i] != '\0'; i++) |
| 396 | locase_s2[i] = ::tolower (s2[i]); |
| 397 | locase_s2[i] = '\0'; |
| 398 | |
| 399 | const char *result = ::strstr (locase_s1, locase_s2); |
| 400 | free (locase_s1); |
| 401 | free (locase_s2); |
| 402 | // 'result' points into freed memory - but we're not |
| 403 | // deref'ing it so hopefully current/future compilers |
| 404 | // won't complain.. |
| 405 | |
| 406 | if (result == NULL) |
| 407 | return false; |
| 408 | else |
| 409 | return true; |
| 410 | } |
| 411 | |
| 412 | bool |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 413 | CommandObject::HelpTextContainsWord (const char *search_word) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 414 | { |
| 415 | const char *short_help; |
| 416 | const char *long_help; |
| 417 | const char *syntax_help; |
| 418 | std::string options_usage_help; |
| 419 | |
| 420 | |
| 421 | bool found_word = false; |
| 422 | |
| 423 | short_help = GetHelp(); |
| 424 | long_help = GetHelpLong(); |
| 425 | syntax_help = GetSyntax(); |
| 426 | |
| 427 | if (contains_string (short_help, search_word)) |
| 428 | found_word = true; |
| 429 | else if (contains_string (long_help, search_word)) |
| 430 | found_word = true; |
| 431 | else if (contains_string (syntax_help, search_word)) |
| 432 | found_word = true; |
| 433 | |
| 434 | if (!found_word |
| 435 | && GetOptions() != NULL) |
| 436 | { |
| 437 | StreamString usage_help; |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 438 | GetOptions()->GenerateOptionUsage (m_interpreter, usage_help, this); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 439 | if (usage_help.GetSize() > 0) |
| 440 | { |
| 441 | const char *usage_text = usage_help.GetData(); |
| 442 | if (contains_string (usage_text, search_word)) |
| 443 | found_word = true; |
| 444 | } |
| 445 | } |
| 446 | |
| 447 | return found_word; |
| 448 | } |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 449 | |
| 450 | int |
| 451 | CommandObject::GetNumArgumentEntries () |
| 452 | { |
| 453 | return m_arguments.size(); |
| 454 | } |
| 455 | |
| 456 | CommandObject::CommandArgumentEntry * |
| 457 | CommandObject::GetArgumentEntryAtIndex (int idx) |
| 458 | { |
| 459 | if (idx < m_arguments.size()) |
| 460 | return &(m_arguments[idx]); |
| 461 | |
| 462 | return NULL; |
| 463 | } |
| 464 | |
| 465 | CommandObject::ArgumentTableEntry * |
| 466 | CommandObject::FindArgumentDataByType (CommandArgumentType arg_type) |
| 467 | { |
| 468 | const ArgumentTableEntry *table = CommandObject::GetArgumentTable(); |
| 469 | |
| 470 | for (int i = 0; i < eArgTypeLastArg; ++i) |
| 471 | if (table[i].arg_type == arg_type) |
| 472 | return (ArgumentTableEntry *) &(table[i]); |
| 473 | |
| 474 | return NULL; |
| 475 | } |
| 476 | |
| 477 | void |
| 478 | CommandObject::GetArgumentHelp (Stream &str, CommandArgumentType arg_type, CommandInterpreter &interpreter) |
| 479 | { |
| 480 | const ArgumentTableEntry* table = CommandObject::GetArgumentTable(); |
| 481 | ArgumentTableEntry *entry = (ArgumentTableEntry *) &(table[arg_type]); |
| 482 | |
| 483 | // The table is *supposed* to be kept in arg_type order, but someone *could* have messed it up... |
| 484 | |
| 485 | if (entry->arg_type != arg_type) |
| 486 | entry = CommandObject::FindArgumentDataByType (arg_type); |
| 487 | |
| 488 | if (!entry) |
| 489 | return; |
| 490 | |
| 491 | StreamString name_str; |
| 492 | name_str.Printf ("<%s>", entry->arg_name); |
| 493 | |
| 494 | if (entry->help_function != NULL) |
| 495 | interpreter.OutputFormattedHelpText (str, name_str.GetData(), "--", (*(entry->help_function)) (), |
| 496 | name_str.GetSize()); |
| 497 | else |
| 498 | interpreter.OutputFormattedHelpText (str, name_str.GetData(), "--", entry->help_text, name_str.GetSize()); |
| 499 | } |
| 500 | |
| 501 | const char * |
| 502 | CommandObject::GetArgumentName (CommandArgumentType arg_type) |
| 503 | { |
Caroline Tice | 4d6675c | 2010-10-01 19:59:14 +0000 | [diff] [blame] | 504 | ArgumentTableEntry *entry = (ArgumentTableEntry *) &(CommandObject::GetArgumentTable()[arg_type]); |
| 505 | |
| 506 | // The table is *supposed* to be kept in arg_type order, but someone *could* have messed it up... |
| 507 | |
| 508 | if (entry->arg_type != arg_type) |
| 509 | entry = CommandObject::FindArgumentDataByType (arg_type); |
| 510 | |
| 511 | return entry->arg_name; |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 512 | } |
| 513 | |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 514 | bool |
| 515 | CommandObject::IsPairType (lldb::ArgumentRepetitionType arg_repeat_type) |
| 516 | { |
| 517 | if ((arg_repeat_type == eArgRepeatPairPlain) |
| 518 | || (arg_repeat_type == eArgRepeatPairOptional) |
| 519 | || (arg_repeat_type == eArgRepeatPairPlus) |
| 520 | || (arg_repeat_type == eArgRepeatPairStar) |
| 521 | || (arg_repeat_type == eArgRepeatPairRange) |
| 522 | || (arg_repeat_type == eArgRepeatPairRangeOptional)) |
| 523 | return true; |
| 524 | |
| 525 | return false; |
| 526 | } |
| 527 | |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 528 | void |
| 529 | CommandObject::GetFormattedCommandArguments (Stream &str) |
| 530 | { |
| 531 | int num_args = m_arguments.size(); |
| 532 | for (int i = 0; i < num_args; ++i) |
| 533 | { |
| 534 | if (i > 0) |
| 535 | str.Printf (" "); |
| 536 | CommandArgumentEntry arg_entry = m_arguments[i]; |
| 537 | int num_alternatives = arg_entry.size(); |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 538 | |
| 539 | if ((num_alternatives == 2) |
| 540 | && IsPairType (arg_entry[0].arg_repetition)) |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 541 | { |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 542 | const char *first_name = GetArgumentName (arg_entry[0].arg_type); |
| 543 | const char *second_name = GetArgumentName (arg_entry[1].arg_type); |
| 544 | switch (arg_entry[0].arg_repetition) |
| 545 | { |
| 546 | case eArgRepeatPairPlain: |
| 547 | str.Printf ("<%s> <%s>", first_name, second_name); |
| 548 | break; |
| 549 | case eArgRepeatPairOptional: |
| 550 | str.Printf ("[<%s> <%s>]", first_name, second_name); |
| 551 | break; |
| 552 | case eArgRepeatPairPlus: |
| 553 | str.Printf ("<%s> <%s> [<%s> <%s> [...]]", first_name, second_name, first_name, second_name); |
| 554 | break; |
| 555 | case eArgRepeatPairStar: |
| 556 | str.Printf ("[<%s> <%s> [<%s> <%s> [...]]]", first_name, second_name, first_name, second_name); |
| 557 | break; |
| 558 | case eArgRepeatPairRange: |
| 559 | str.Printf ("<%s_1> <%s_1> ... <%s_n> <%s_n>", first_name, second_name, first_name, second_name); |
| 560 | break; |
| 561 | case eArgRepeatPairRangeOptional: |
| 562 | str.Printf ("[<%s_1> <%s_1> ... <%s_n> <%s_n>]", first_name, second_name, first_name, second_name); |
| 563 | break; |
| 564 | } |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 565 | } |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 566 | else |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 567 | { |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 568 | StreamString names; |
| 569 | for (int j = 0; j < num_alternatives; ++j) |
| 570 | { |
| 571 | if (j > 0) |
| 572 | names.Printf (" | "); |
| 573 | names.Printf ("%s", GetArgumentName (arg_entry[j].arg_type)); |
| 574 | } |
| 575 | switch (arg_entry[0].arg_repetition) |
| 576 | { |
| 577 | case eArgRepeatPlain: |
| 578 | str.Printf ("<%s>", names.GetData()); |
| 579 | break; |
| 580 | case eArgRepeatPlus: |
| 581 | str.Printf ("<%s> [<%s> [...]]", names.GetData(), names.GetData()); |
| 582 | break; |
| 583 | case eArgRepeatStar: |
| 584 | str.Printf ("[<%s> [<%s> [...]]]", names.GetData(), names.GetData()); |
| 585 | break; |
| 586 | case eArgRepeatOptional: |
| 587 | str.Printf ("[<%s>]", names.GetData()); |
| 588 | break; |
| 589 | case eArgRepeatRange: |
| 590 | str.Printf ("<%s_1> .. <%s_n>", names.GetData()); |
| 591 | } |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 592 | } |
| 593 | } |
| 594 | } |
| 595 | |
| 596 | const CommandArgumentType |
| 597 | CommandObject::LookupArgumentName (const char *arg_name) |
| 598 | { |
| 599 | CommandArgumentType return_type = eArgTypeLastArg; |
| 600 | |
| 601 | std::string arg_name_str (arg_name); |
| 602 | size_t len = arg_name_str.length(); |
| 603 | if (arg_name[0] == '<' |
| 604 | && arg_name[len-1] == '>') |
| 605 | arg_name_str = arg_name_str.substr (1, len-2); |
| 606 | |
| 607 | for (int i = 0; i < eArgTypeLastArg; ++i) |
| 608 | if (arg_name_str.compare (g_arguments_data[i].arg_name) == 0) |
| 609 | return_type = g_arguments_data[i].arg_type; |
| 610 | |
| 611 | return return_type; |
| 612 | } |
| 613 | |
| 614 | static const char * |
| 615 | BreakpointIDHelpTextCallback () |
| 616 | { |
| 617 | return "Breakpoint ID's consist major and minor numbers; the major number corresponds to the single entity that was created with a 'breakpoint set' command; the minor numbers correspond to all the locations that were actually found/set based on the major breakpoint. A full breakpoint ID might look like 3.14, meaning the 14th location set for the 3rd breakpoint. You can specify all the locations of a breakpoint by just indicating the major breakpoint number. A valid breakpoint id consists either of just the major id number, or the major number, a dot, and the location number (e.g. 3 or 3.2 could both be valid breakpoint ids)."; |
| 618 | } |
| 619 | |
| 620 | static const char * |
| 621 | BreakpointIDRangeHelpTextCallback () |
| 622 | { |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 623 | return "A 'breakpoint id list' is a manner of specifying multiple breakpoints. This can be done through several mechanisms. The easiest way is to just enter a space-separated list of breakpoint ids. To specify all the breakpoint locations under a major breakpoint, you can use the major breakpoint number followed by '.*', eg. '5.*' means all the locations under breakpoint 5. You can also indicate a range of breakpoints by using <start-bp-id> - <end-bp-id>. The start-bp-id and end-bp-id for a range can be any valid breakpoint ids. It is not legal, however, to specify a range using specific locations that cross major breakpoint numbers. I.e. 3.2 - 3.7 is legal; 2 - 5 is legal; but 3.2 - 4.4 is not legal."; |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 624 | } |
| 625 | |
| 626 | CommandObject::ArgumentTableEntry |
| 627 | CommandObject::g_arguments_data[] = |
| 628 | { |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 629 | { eArgTypeAddress, "address", CommandCompletions::eNoCompletion, NULL, "A valid address in the target program's execution space." }, |
| 630 | { eArgTypeAliasName, "alias-name", CommandCompletions::eNoCompletion, NULL, "The name of an abbreviation (alias) for a debugger command." }, |
| 631 | { eArgTypeAliasOptions, "options-for-aliased-command", CommandCompletions::eNoCompletion, NULL, "Command options to be used as part of an alias (abbreviation) definition. (See 'help commands alias' for more information.)" }, |
| 632 | { eArgTypeArchitecture, "arch", CommandCompletions::eNoCompletion, NULL, "The architecture name, e.g. i386 or x86_64." }, |
Caroline Tice | 4d6675c | 2010-10-01 19:59:14 +0000 | [diff] [blame] | 633 | { eArgTypeBoolean, "boolean", CommandCompletions::eNoCompletion, NULL, "A Boolean value: 'true' or 'false'" }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 634 | { eArgTypeBreakpointID, "breakpt-id", CommandCompletions::eNoCompletion, BreakpointIDHelpTextCallback, NULL }, |
| 635 | { eArgTypeBreakpointIDRange, "breakpt-id-list", CommandCompletions::eNoCompletion, BreakpointIDRangeHelpTextCallback, NULL }, |
| 636 | { eArgTypeByteSize, "byte-size", CommandCompletions::eNoCompletion, NULL, "Number of bytes to use." }, |
| 637 | { eArgTypeCommandName, "cmd-name", CommandCompletions::eNoCompletion, NULL, "A debugger command (may be multiple words), without any options or arguments." }, |
Caroline Tice | 4d6675c | 2010-10-01 19:59:14 +0000 | [diff] [blame] | 638 | { eArgTypeCount, "count", CommandCompletions::eNoCompletion, NULL, "An unsigned integer." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 639 | { eArgTypeEndAddress, "end-address", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
| 640 | { eArgTypeExpression, "expr", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 4d6675c | 2010-10-01 19:59:14 +0000 | [diff] [blame] | 641 | { eArgTypeExprFormat, "expression-format", CommandCompletions::eNoCompletion, NULL, "[ [bool|b] | [bin] | [char|c] | [oct|o] | [dec|i|d|u] | [hex|x] | [float|f] | [cstr|s] ]" }, |
| 642 | { eArgTypeFilename, "filename", CommandCompletions::eNoCompletion, NULL, "The name of a file (can include path)." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 643 | { eArgTypeFormat, "format", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 644 | { eArgTypeFrameIndex, "frame-index", CommandCompletions::eNoCompletion, NULL, "Index into a thread's list of frames." }, |
| 645 | { eArgTypeFullName, "fullname", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
| 646 | { eArgTypeFunctionName, "function-name", CommandCompletions::eNoCompletion, NULL, "The name of a function." }, |
| 647 | { eArgTypeIndex, "index", CommandCompletions::eNoCompletion, NULL, "An index into a list." }, |
| 648 | { eArgTypeLineNum, "linenum", CommandCompletions::eNoCompletion, NULL, "Line number in a source file." }, |
| 649 | { eArgTypeLogChannel, "log-channel", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
| 650 | { eArgTypeMethod, "method", CommandCompletions::eNoCompletion, NULL, "A C++ method name." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 651 | { eArgTypeName, "name", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 652 | { eArgTypeNewPathPrefix, "new-path-prefix", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
| 653 | { eArgTypeNumLines, "num-lines", CommandCompletions::eNoCompletion, NULL, "The number of lines to use." }, |
| 654 | { eArgTypeNumberPerLine, "number-per-line", CommandCompletions::eNoCompletion, NULL, "The number of items per line to display." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 655 | { eArgTypeOffset, "offset", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 656 | { eArgTypeOldPathPrefix, "old-path-prefix", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 4d6675c | 2010-10-01 19:59:14 +0000 | [diff] [blame] | 657 | { eArgTypeOneLiner, "one-line-breakpoint-command", CommandCompletions::eNoCompletion, NULL, "A breakpoint command that is entered as a single line of text." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 658 | { eArgTypePath, "path", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 659 | { eArgTypePid, "pid", CommandCompletions::eNoCompletion, NULL, "The process ID number." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 660 | { eArgTypePlugin, "plugin", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 661 | { eArgTypeProcessName, "process-name", CommandCompletions::eNoCompletion, NULL, "The name of the process." }, |
| 662 | { eArgTypeQueueName, "queue-name", CommandCompletions::eNoCompletion, NULL, "The name of the thread queue." }, |
| 663 | { eArgTypeRegisterName, "register-name", CommandCompletions::eNoCompletion, NULL, "A register name." }, |
| 664 | { eArgTypeRegularExpression, "regular-expression", CommandCompletions::eNoCompletion, NULL, "A regular expression." }, |
| 665 | { eArgTypeRunArgs, "run-args", CommandCompletions::eNoCompletion, NULL, "Arguments to be passed to the target program when it starts executing." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 666 | { eArgTypeRunMode, "run-mode", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 667 | { eArgTypeScriptLang, "script-language", CommandCompletions::eNoCompletion, NULL, "The scripting language to be used for script-based commands. Currently only Python is valid." }, |
| 668 | { eArgTypeSearchWord, "search-word", CommandCompletions::eNoCompletion, NULL, "The word for which you wish to search for information about." }, |
| 669 | { eArgTypeSelector, "selector", CommandCompletions::eNoCompletion, NULL, "An Objective-C selector name." }, |
| 670 | { eArgTypeSettingIndex, "setting-index", CommandCompletions::eNoCompletion, NULL, "An index into a settings variable that is an array (try 'settings list' to see all the possible settings variables and their types)." }, |
| 671 | { eArgTypeSettingKey, "setting-key", CommandCompletions::eNoCompletion, NULL, "A key into a settings variables that is a dictionary (try 'settings list' to see all the possible settings variables and their types)." }, |
| 672 | { eArgTypeSettingPrefix, "setting-prefix", CommandCompletions::eNoCompletion, NULL, "The name of a settable internal debugger variable up to a dot ('.'), e.g. 'target.process.'" }, |
| 673 | { eArgTypeSettingVariableName, "setting-variable-name", CommandCompletions::eNoCompletion, NULL, "The name of a settable internal debugger variable. Type 'settings list' to see a complete list of such variables." }, |
| 674 | { eArgTypeShlibName, "shlib-name", CommandCompletions::eNoCompletion, NULL, "The name of a shared library." }, |
| 675 | { eArgTypeSourceFile, "source-file", CommandCompletions::eNoCompletion, NULL, "The name of a source file.." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 676 | { eArgTypeStartAddress, "start-address", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 677 | { eArgTypeSymbol, "symbol", CommandCompletions::eNoCompletion, NULL, "Any symbol name (function name, variable, argument, etc.)" }, |
| 678 | { eArgTypeThreadID, "thread-id", CommandCompletions::eNoCompletion, NULL, "Thread ID number." }, |
| 679 | { eArgTypeThreadIndex, "thread-index", CommandCompletions::eNoCompletion, NULL, "Index into the process' list of threads." }, |
| 680 | { eArgTypeThreadName, "thread-name", CommandCompletions::eNoCompletion, NULL, "The thread's name." }, |
| 681 | { eArgTypeUnixSignalNumber, "unix-signal-number", CommandCompletions::eNoCompletion, NULL, "A valid Unix signal number." }, |
| 682 | { eArgTypeVarName, "variable-name", CommandCompletions::eNoCompletion, NULL, "The name of a variable in your program." }, |
| 683 | { eArgTypeValue, "value", CommandCompletions::eNoCompletion, NULL, "A value could be anything, depending on where and how it is used." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 684 | { eArgTypeWidth, "width", CommandCompletions::eNoCompletion, NULL, "Help text goes here." }, |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame^] | 685 | { eArgTypeNone, "none", CommandCompletions::eNoCompletion, NULL, "No help available for this." }, |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 686 | }; |
| 687 | |
| 688 | const CommandObject::ArgumentTableEntry* |
| 689 | CommandObject::GetArgumentTable () |
| 690 | { |
| 691 | return CommandObject::g_arguments_data; |
| 692 | } |
| 693 | |
| 694 | |