contrib/llvm/tools/lldb/source/Interpreter/CommandObject.cpp

   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 <map>
  13 #include <sstream>
  14 #include <string>
  15
  16 #include <ctype.h>
  17 #include <stdlib.h>
  18
  19 #include "lldb/Core/Address.h"
  20 #include "lldb/Interpreter/Options.h"
  21 #include "lldb/Utility/ArchSpec.h"
  22
  23 // These are for the Sourcename completers.
  24 // FIXME: Make a separate file for the completers.
  25 #include "lldb/Core/FileSpecList.h"
  26 #include "lldb/DataFormatters/FormatManager.h"
  27 #include "lldb/Target/Process.h"
  28 #include "lldb/Target/Target.h"
  29 #include "lldb/Utility/FileSpec.h"
  30
  31 #include "lldb/Target/Language.h"
  32
  33 #include "lldb/Interpreter/CommandInterpreter.h"
  34 #include "lldb/Interpreter/CommandReturnObject.h"
  35
  36 using namespace lldb;
  37 using namespace lldb_private;
  38
  39 //-------------------------------------------------------------------------
  40 // CommandObject
  41 //-------------------------------------------------------------------------
  42
  43 CommandObject::CommandObject(CommandInterpreter &interpreter, llvm::StringRef name,
  44   llvm::StringRef help, llvm::StringRef syntax, uint32_t flags)
  45     : m_interpreter(interpreter), m_cmd_name(name),
  46       m_cmd_help_short(), m_cmd_help_long(), m_cmd_syntax(), m_flags(flags),
  47       m_arguments(), m_deprecated_command_override_callback(nullptr),
  48       m_command_override_callback(nullptr), m_command_override_baton(nullptr) {
  49   m_cmd_help_short = help;
  50   m_cmd_syntax = syntax;
  51 }
  52
  53 CommandObject::~CommandObject() {}
  54
  55 llvm::StringRef CommandObject::GetHelp() { return m_cmd_help_short; }
  56
  57 llvm::StringRef CommandObject::GetHelpLong() { return m_cmd_help_long; }
  58
  59 llvm::StringRef CommandObject::GetSyntax() {
  60   if (!m_cmd_syntax.empty())
  61     return m_cmd_syntax;
  62
  63   StreamString syntax_str;
  64   syntax_str.PutCString(GetCommandName());
  65
  66   if (!IsDashDashCommand() && GetOptions() != nullptr)
  67     syntax_str.PutCString(" <cmd-options>");
  68
  69   if (!m_arguments.empty()) {
  70     syntax_str.PutCString(" ");
  71
  72     if (!IsDashDashCommand() && WantsRawCommandString() && GetOptions() &&
  73         GetOptions()->NumCommandOptions())
  74       syntax_str.PutCString("-- ");
  75     GetFormattedCommandArguments(syntax_str);
  76   }
  77   m_cmd_syntax = syntax_str.GetString();
  78
  79   return m_cmd_syntax;
  80 }
  81
  82 llvm::StringRef CommandObject::GetCommandName() const { return m_cmd_name; }
  83
  84 void CommandObject::SetCommandName(llvm::StringRef name) { m_cmd_name = name; }
  85
  86 void CommandObject::SetHelp(llvm::StringRef str) { m_cmd_help_short = str; }
  87
  88 void CommandObject::SetHelpLong(llvm::StringRef str) { m_cmd_help_long = str; }
  89
  90 void CommandObject::SetSyntax(llvm::StringRef str) { m_cmd_syntax = str; }
  91
  92 Options *CommandObject::GetOptions() {
  93   // By default commands don't have options unless this virtual function is
  94   // overridden by base classes.
  95   return nullptr;
  96 }
  97
  98 bool CommandObject::ParseOptions(Args &args, CommandReturnObject &result) {
  99   // See if the subclass has options?
 100   Options *options = GetOptions();
 101   if (options != nullptr) {
 102     Status error;
 103
 104     auto exe_ctx = GetCommandInterpreter().GetExecutionContext();
 105     options->NotifyOptionParsingStarting(&exe_ctx);
 106
 107     const bool require_validation = true;
 108     llvm::Expected<Args> args_or = options->Parse(
 109         args, &exe_ctx, GetCommandInterpreter().GetPlatform(true),
 110         require_validation);
 111
 112     if (args_or) {
 113       args = std::move(*args_or);
 114       error = options->NotifyOptionParsingFinished(&exe_ctx);
 115     } else
 116       error = args_or.takeError();
 117
 118     if (error.Success()) {
 119       if (options->VerifyOptions(result))
 120         return true;
 121     } else {
 122       const char *error_cstr = error.AsCString();
 123       if (error_cstr) {
 124         // We got an error string, lets use that
 125         result.AppendError(error_cstr);
 126       } else {
 127         // No error string, output the usage information into result
 128         options->GenerateOptionUsage(
 129             result.GetErrorStream(), this,
 130             GetCommandInterpreter().GetDebugger().GetTerminalWidth());
 131       }
 132     }
 133     result.SetStatus(eReturnStatusFailed);
 134     return false;
 135   }
 136   return true;
 137 }
 138
 139 bool CommandObject::CheckRequirements(CommandReturnObject &result) {
 140 #ifdef LLDB_CONFIGURATION_DEBUG
 141   // Nothing should be stored in m_exe_ctx between running commands as
 142   // m_exe_ctx has shared pointers to the target, process, thread and frame and
 143   // we don't want any CommandObject instances to keep any of these objects
 144   // around longer than for a single command. Every command should call
 145   // CommandObject::Cleanup() after it has completed
 146   assert(m_exe_ctx.GetTargetPtr() == NULL);
 147   assert(m_exe_ctx.GetProcessPtr() == NULL);
 148   assert(m_exe_ctx.GetThreadPtr() == NULL);
 149   assert(m_exe_ctx.GetFramePtr() == NULL);
 150 #endif
 151
 152   // Lock down the interpreter's execution context prior to running the command
 153   // so we guarantee the selected target, process, thread and frame can't go
 154   // away during the execution
 155   m_exe_ctx = m_interpreter.GetExecutionContext();
 156
 157   const uint32_t flags = GetFlags().Get();
 158   if (flags & (eCommandRequiresTarget | eCommandRequiresProcess |
 159                eCommandRequiresThread | eCommandRequiresFrame |
 160                eCommandTryTargetAPILock)) {
 161
 162     if ((flags & eCommandRequiresTarget) && !m_exe_ctx.HasTargetScope()) {
 163       result.AppendError(GetInvalidTargetDescription());
 164       return false;
 165     }
 166
 167     if ((flags & eCommandRequiresProcess) && !m_exe_ctx.HasProcessScope()) {
 168       if (!m_exe_ctx.HasTargetScope())
 169         result.AppendError(GetInvalidTargetDescription());
 170       else
 171         result.AppendError(GetInvalidProcessDescription());
 172       return false;
 173     }
 174
 175     if ((flags & eCommandRequiresThread) && !m_exe_ctx.HasThreadScope()) {
 176       if (!m_exe_ctx.HasTargetScope())
 177         result.AppendError(GetInvalidTargetDescription());
 178       else if (!m_exe_ctx.HasProcessScope())
 179         result.AppendError(GetInvalidProcessDescription());
 180       else
 181         result.AppendError(GetInvalidThreadDescription());
 182       return false;
 183     }
 184
 185     if ((flags & eCommandRequiresFrame) && !m_exe_ctx.HasFrameScope()) {
 186       if (!m_exe_ctx.HasTargetScope())
 187         result.AppendError(GetInvalidTargetDescription());
 188       else if (!m_exe_ctx.HasProcessScope())
 189         result.AppendError(GetInvalidProcessDescription());
 190       else if (!m_exe_ctx.HasThreadScope())
 191         result.AppendError(GetInvalidThreadDescription());
 192       else
 193         result.AppendError(GetInvalidFrameDescription());
 194       return false;
 195     }
 196
 197     if ((flags & eCommandRequiresRegContext) &&
 198         (m_exe_ctx.GetRegisterContext() == nullptr)) {
 199       result.AppendError(GetInvalidRegContextDescription());
 200       return false;
 201     }
 202
 203     if (flags & eCommandTryTargetAPILock) {
 204       Target *target = m_exe_ctx.GetTargetPtr();
 205       if (target)
 206         m_api_locker =
 207             std::unique_lock<std::recursive_mutex>(target->GetAPIMutex());
 208     }
 209   }
 210
 211   if (GetFlags().AnySet(eCommandProcessMustBeLaunched |
 212                         eCommandProcessMustBePaused)) {
 213     Process *process = m_interpreter.GetExecutionContext().GetProcessPtr();
 214     if (process == nullptr) {
 215       // A process that is not running is considered paused.
 216       if (GetFlags().Test(eCommandProcessMustBeLaunched)) {
 217         result.AppendError("Process must exist.");
 218         result.SetStatus(eReturnStatusFailed);
 219         return false;
 220       }
 221     } else {
 222       StateType state = process->GetState();
 223       switch (state) {
 224       case eStateInvalid:
 225       case eStateSuspended:
 226       case eStateCrashed:
 227       case eStateStopped:
 228         break;
 229
 230       case eStateConnected:
 231       case eStateAttaching:
 232       case eStateLaunching:
 233       case eStateDetached:
 234       case eStateExited:
 235       case eStateUnloaded:
 236         if (GetFlags().Test(eCommandProcessMustBeLaunched)) {
 237           result.AppendError("Process must be launched.");
 238           result.SetStatus(eReturnStatusFailed);
 239           return false;
 240         }
 241         break;
 242
 243       case eStateRunning:
 244       case eStateStepping:
 245         if (GetFlags().Test(eCommandProcessMustBePaused)) {
 246           result.AppendError("Process is running.  Use 'process interrupt' to "
 247                              "pause execution.");
 248           result.SetStatus(eReturnStatusFailed);
 249           return false;
 250         }
 251       }
 252     }
 253   }
 254   return true;
 255 }
 256
 257 void CommandObject::Cleanup() {
 258   m_exe_ctx.Clear();
 259   if (m_api_locker.owns_lock())
 260     m_api_locker.unlock();
 261 }
 262
 263 int CommandObject::HandleCompletion(CompletionRequest &request) {
 264   // Default implementation of WantsCompletion() is !WantsRawCommandString().
 265   // Subclasses who want raw command string but desire, for example, argument
 266   // completion should override WantsCompletion() to return true, instead.
 267   if (WantsRawCommandString() && !WantsCompletion()) {
 268     // FIXME: Abstract telling the completion to insert the completion
 269     // character.
 270     return -1;
 271   } else {
 272     // Can we do anything generic with the options?
 273     Options *cur_options = GetOptions();
 274     CommandReturnObject result;
 275     OptionElementVector opt_element_vector;
 276
 277     if (cur_options != nullptr) {
 278       opt_element_vector = cur_options->ParseForCompletion(
 279           request.GetParsedLine(), request.GetCursorIndex());
 280
 281       bool handled_by_options = cur_options->HandleOptionCompletion(
 282           request, opt_element_vector, GetCommandInterpreter());
 283       if (handled_by_options)
 284         return request.GetNumberOfMatches();
 285     }
 286
 287     // If we got here, the last word is not an option or an option argument.
 288     return HandleArgumentCompletion(request, opt_element_vector);
 289   }
 290 }
 291
 292 bool CommandObject::HelpTextContainsWord(llvm::StringRef search_word,
 293                                          bool search_short_help,
 294                                          bool search_long_help,
 295                                          bool search_syntax,
 296                                          bool search_options) {
 297   std::string options_usage_help;
 298
 299   bool found_word = false;
 300
 301   llvm::StringRef short_help = GetHelp();
 302   llvm::StringRef long_help = GetHelpLong();
 303   llvm::StringRef syntax_help = GetSyntax();
 304
 305   if (search_short_help && short_help.contains_lower(search_word))
 306     found_word = true;
 307   else if (search_long_help && long_help.contains_lower(search_word))
 308     found_word = true;
 309   else if (search_syntax && syntax_help.contains_lower(search_word))
 310     found_word = true;
 311
 312   if (!found_word && search_options && GetOptions() != nullptr) {
 313     StreamString usage_help;
 314     GetOptions()->GenerateOptionUsage(
 315         usage_help, this,
 316         GetCommandInterpreter().GetDebugger().GetTerminalWidth());
 317     if (!usage_help.Empty()) {
 318       llvm::StringRef usage_text = usage_help.GetString();
 319       if (usage_text.contains_lower(search_word))
 320         found_word = true;
 321     }
 322   }
 323
 324   return found_word;
 325 }
 326
 327 bool CommandObject::ParseOptionsAndNotify(Args &args,
 328                                           CommandReturnObject &result,
 329                                           OptionGroupOptions &group_options,
 330                                           ExecutionContext &exe_ctx) {
 331   if (!ParseOptions(args, result))
 332     return false;
 333
 334   Status error(group_options.NotifyOptionParsingFinished(&exe_ctx));
 335   if (error.Fail()) {
 336     result.AppendError(error.AsCString());
 337     result.SetStatus(eReturnStatusFailed);
 338     return false;
 339   }
 340   return true;
 341 }
 342
 343 int CommandObject::GetNumArgumentEntries() { return m_arguments.size(); }
 344
 345 CommandObject::CommandArgumentEntry *
 346 CommandObject::GetArgumentEntryAtIndex(int idx) {
 347   if (static_cast<size_t>(idx) < m_arguments.size())
 348     return &(m_arguments[idx]);
 349
 350   return nullptr;
 351 }
 352
 353 const CommandObject::ArgumentTableEntry *
 354 CommandObject::FindArgumentDataByType(CommandArgumentType arg_type) {
 355   const ArgumentTableEntry *table = CommandObject::GetArgumentTable();
 356
 357   for (int i = 0; i < eArgTypeLastArg; ++i)
 358     if (table[i].arg_type == arg_type)
 359       return &(table[i]);
 360
 361   return nullptr;
 362 }
 363
 364 void CommandObject::GetArgumentHelp(Stream &str, CommandArgumentType arg_type,
 365                                     CommandInterpreter &interpreter) {
 366   const ArgumentTableEntry *table = CommandObject::GetArgumentTable();
 367   const ArgumentTableEntry *entry = &(table[arg_type]);
 368
 369   // The table is *supposed* to be kept in arg_type order, but someone *could*
 370   // have messed it up...
 371
 372   if (entry->arg_type != arg_type)
 373     entry = CommandObject::FindArgumentDataByType(arg_type);
 374
 375   if (!entry)
 376     return;
 377
 378   StreamString name_str;
 379   name_str.Printf("<%s>", entry->arg_name);
 380
 381   if (entry->help_function) {
 382     llvm::StringRef help_text = entry->help_function();
 383     if (!entry->help_function.self_formatting) {
 384       interpreter.OutputFormattedHelpText(str, name_str.GetString(), "--",
 385                                           help_text, name_str.GetSize());
 386     } else {
 387       interpreter.OutputHelpText(str, name_str.GetString(), "--", help_text,
 388                                  name_str.GetSize());
 389     }
 390   } else
 391     interpreter.OutputFormattedHelpText(str, name_str.GetString(), "--",
 392                                         entry->help_text, name_str.GetSize());
 393 }
 394
 395 const char *CommandObject::GetArgumentName(CommandArgumentType arg_type) {
 396   const ArgumentTableEntry *entry =
 397       &(CommandObject::GetArgumentTable()[arg_type]);
 398
 399   // The table is *supposed* to be kept in arg_type order, but someone *could*
 400   // have messed it up...
 401
 402   if (entry->arg_type != arg_type)
 403     entry = CommandObject::FindArgumentDataByType(arg_type);
 404
 405   if (entry)
 406     return entry->arg_name;
 407
 408   return nullptr;
 409 }
 410
 411 bool CommandObject::IsPairType(ArgumentRepetitionType arg_repeat_type) {
 412   return (arg_repeat_type == eArgRepeatPairPlain) ||
 413          (arg_repeat_type == eArgRepeatPairOptional) ||
 414          (arg_repeat_type == eArgRepeatPairPlus) ||
 415          (arg_repeat_type == eArgRepeatPairStar) ||
 416          (arg_repeat_type == eArgRepeatPairRange) ||
 417          (arg_repeat_type == eArgRepeatPairRangeOptional);
 418 }
 419
 420 static CommandObject::CommandArgumentEntry
 421 OptSetFiltered(uint32_t opt_set_mask,
 422                CommandObject::CommandArgumentEntry &cmd_arg_entry) {
 423   CommandObject::CommandArgumentEntry ret_val;
 424   for (unsigned i = 0; i < cmd_arg_entry.size(); ++i)
 425     if (opt_set_mask & cmd_arg_entry[i].arg_opt_set_association)
 426       ret_val.push_back(cmd_arg_entry[i]);
 427   return ret_val;
 428 }
 429
 430 // Default parameter value of opt_set_mask is LLDB_OPT_SET_ALL, which means
 431 // take all the argument data into account.  On rare cases where some argument
 432 // sticks with certain option sets, this function returns the option set
 433 // filtered args.
 434 void CommandObject::GetFormattedCommandArguments(Stream &str,
 435                                                  uint32_t opt_set_mask) {
 436   int num_args = m_arguments.size();
 437   for (int i = 0; i < num_args; ++i) {
 438     if (i > 0)
 439       str.Printf(" ");
 440     CommandArgumentEntry arg_entry =
 441         opt_set_mask == LLDB_OPT_SET_ALL
 442             ? m_arguments[i]
 443             : OptSetFiltered(opt_set_mask, m_arguments[i]);
 444     int num_alternatives = arg_entry.size();
 445
 446     if ((num_alternatives == 2) && IsPairType(arg_entry[0].arg_repetition)) {
 447       const char *first_name = GetArgumentName(arg_entry[0].arg_type);
 448       const char *second_name = GetArgumentName(arg_entry[1].arg_type);
 449       switch (arg_entry[0].arg_repetition) {
 450       case eArgRepeatPairPlain:
 451         str.Printf("<%s> <%s>", first_name, second_name);
 452         break;
 453       case eArgRepeatPairOptional:
 454         str.Printf("[<%s> <%s>]", first_name, second_name);
 455         break;
 456       case eArgRepeatPairPlus:
 457         str.Printf("<%s> <%s> [<%s> <%s> [...]]", first_name, second_name,
 458                    first_name, second_name);
 459         break;
 460       case eArgRepeatPairStar:
 461         str.Printf("[<%s> <%s> [<%s> <%s> [...]]]", first_name, second_name,
 462                    first_name, second_name);
 463         break;
 464       case eArgRepeatPairRange:
 465         str.Printf("<%s_1> <%s_1> ... <%s_n> <%s_n>", first_name, second_name,
 466                    first_name, second_name);
 467         break;
 468       case eArgRepeatPairRangeOptional:
 469         str.Printf("[<%s_1> <%s_1> ... <%s_n> <%s_n>]", first_name, second_name,
 470                    first_name, second_name);
 471         break;
 472       // Explicitly test for all the rest of the cases, so if new types get
 473       // added we will notice the missing case statement(s).
 474       case eArgRepeatPlain:
 475       case eArgRepeatOptional:
 476       case eArgRepeatPlus:
 477       case eArgRepeatStar:
 478       case eArgRepeatRange:
 479         // These should not be reached, as they should fail the IsPairType test
 480         // above.
 481         break;
 482       }
 483     } else {
 484       StreamString names;
 485       for (int j = 0; j < num_alternatives; ++j) {
 486         if (j > 0)
 487           names.Printf(" | ");
 488         names.Printf("%s", GetArgumentName(arg_entry[j].arg_type));
 489       }
 490
 491       std::string name_str = names.GetString();
 492       switch (arg_entry[0].arg_repetition) {
 493       case eArgRepeatPlain:
 494         str.Printf("<%s>", name_str.c_str());
 495         break;
 496       case eArgRepeatPlus:
 497         str.Printf("<%s> [<%s> [...]]", name_str.c_str(), name_str.c_str());
 498         break;
 499       case eArgRepeatStar:
 500         str.Printf("[<%s> [<%s> [...]]]", name_str.c_str(), name_str.c_str());
 501         break;
 502       case eArgRepeatOptional:
 503         str.Printf("[<%s>]", name_str.c_str());
 504         break;
 505       case eArgRepeatRange:
 506         str.Printf("<%s_1> .. <%s_n>", name_str.c_str(), name_str.c_str());
 507         break;
 508       // Explicitly test for all the rest of the cases, so if new types get
 509       // added we will notice the missing case statement(s).
 510       case eArgRepeatPairPlain:
 511       case eArgRepeatPairOptional:
 512       case eArgRepeatPairPlus:
 513       case eArgRepeatPairStar:
 514       case eArgRepeatPairRange:
 515       case eArgRepeatPairRangeOptional:
 516         // These should not be hit, as they should pass the IsPairType test
 517         // above, and control should have gone into the other branch of the if
 518         // statement.
 519         break;
 520       }
 521     }
 522   }
 523 }
 524
 525 CommandArgumentType
 526 CommandObject::LookupArgumentName(llvm::StringRef arg_name) {
 527   CommandArgumentType return_type = eArgTypeLastArg;
 528
 529   arg_name = arg_name.ltrim('<').rtrim('>');
 530
 531   const ArgumentTableEntry *table = GetArgumentTable();
 532   for (int i = 0; i < eArgTypeLastArg; ++i)
 533     if (arg_name == table[i].arg_name)
 534       return_type = g_arguments_data[i].arg_type;
 535
 536   return return_type;
 537 }
 538
 539 static llvm::StringRef RegisterNameHelpTextCallback() {
 540   return "Register names can be specified using the architecture specific "
 541          "names.  "
 542          "They can also be specified using generic names.  Not all generic "
 543          "entities have "
 544          "registers backing them on all architectures.  When they don't the "
 545          "generic name "
 546          "will return an error.\n"
 547          "The generic names defined in lldb are:\n"
 548          "\n"
 549          "pc       - program counter register\n"
 550          "ra       - return address register\n"
 551          "fp       - frame pointer register\n"
 552          "sp       - stack pointer register\n"
 553          "flags    - the flags register\n"
 554          "arg{1-6} - integer argument passing registers.\n";
 555 }
 556
 557 static llvm::StringRef BreakpointIDHelpTextCallback() {
 558   return "Breakpoints are identified using major and minor numbers; the major "
 559          "number corresponds to the single entity that was created with a "
 560          "'breakpoint "
 561          "set' command; the minor numbers correspond to all the locations that "
 562          "were "
 563          "actually found/set based on the major breakpoint.  A full breakpoint "
 564          "ID might "
 565          "look like 3.14, meaning the 14th location set for the 3rd "
 566          "breakpoint.  You "
 567          "can specify all the locations of a breakpoint by just indicating the "
 568          "major "
 569          "breakpoint number. A valid breakpoint ID consists either of just the "
 570          "major "
 571          "number, or the major number followed by a dot and the location "
 572          "number (e.g. "
 573          "3 or 3.2 could both be valid breakpoint IDs.)";
 574 }
 575
 576 static llvm::StringRef BreakpointIDRangeHelpTextCallback() {
 577   return "A 'breakpoint ID list' is a manner of specifying multiple "
 578          "breakpoints. "
 579          "This can be done through several mechanisms.  The easiest way is to "
 580          "just "
 581          "enter a space-separated list of breakpoint IDs.  To specify all the "
 582          "breakpoint locations under a major breakpoint, you can use the major "
 583          "breakpoint number followed by '.*', eg. '5.*' means all the "
 584          "locations under "
 585          "breakpoint 5.  You can also indicate a range of breakpoints by using "
 586          "<start-bp-id> - <end-bp-id>.  The start-bp-id and end-bp-id for a "
 587          "range can "
 588          "be any valid breakpoint IDs.  It is not legal, however, to specify a "
 589          "range "
 590          "using specific locations that cross major breakpoint numbers.  I.e. "
 591          "3.2 - 3.7"
 592          " is legal; 2 - 5 is legal; but 3.2 - 4.4 is not legal.";
 593 }
 594
 595 static llvm::StringRef BreakpointNameHelpTextCallback() {
 596   return "A name that can be added to a breakpoint when it is created, or "
 597          "later "
 598          "on with the \"breakpoint name add\" command.  "
 599          "Breakpoint names can be used to specify breakpoints in all the "
 600          "places breakpoint IDs "
 601          "and breakpoint ID ranges can be used.  As such they provide a "
 602          "convenient way to group breakpoints, "
 603          "and to operate on breakpoints you create without having to track the "
 604          "breakpoint number.  "
 605          "Note, the attributes you set when using a breakpoint name in a "
 606          "breakpoint command don't "
 607          "adhere to the name, but instead are set individually on all the "
 608          "breakpoints currently tagged with that "
 609          "name.  Future breakpoints "
 610          "tagged with that name will not pick up the attributes previously "
 611          "given using that name.  "
 612          "In order to distinguish breakpoint names from breakpoint IDs and "
 613          "ranges, "
 614          "names must start with a letter from a-z or A-Z and cannot contain "
 615          "spaces, \".\" or \"-\".  "
 616          "Also, breakpoint names can only be applied to breakpoints, not to "
 617          "breakpoint locations.";
 618 }
 619
 620 static llvm::StringRef GDBFormatHelpTextCallback() {
 621   return "A GDB format consists of a repeat count, a format letter and a size "
 622          "letter. "
 623          "The repeat count is optional and defaults to 1. The format letter is "
 624          "optional "
 625          "and defaults to the previous format that was used. The size letter "
 626          "is optional "
 627          "and defaults to the previous size that was used.\n"
 628          "\n"
 629          "Format letters include:\n"
 630          "o - octal\n"
 631          "x - hexadecimal\n"
 632          "d - decimal\n"
 633          "u - unsigned decimal\n"
 634          "t - binary\n"
 635          "f - float\n"
 636          "a - address\n"
 637          "i - instruction\n"
 638          "c - char\n"
 639          "s - string\n"
 640          "T - OSType\n"
 641          "A - float as hex\n"
 642          "\n"
 643          "Size letters include:\n"
 644          "b - 1 byte  (byte)\n"
 645          "h - 2 bytes (halfword)\n"
 646          "w - 4 bytes (word)\n"
 647          "g - 8 bytes (giant)\n"
 648          "\n"
 649          "Example formats:\n"
 650          "32xb - show 32 1 byte hexadecimal integer values\n"
 651          "16xh - show 16 2 byte hexadecimal integer values\n"
 652          "64   - show 64 2 byte hexadecimal integer values (format and size "
 653          "from the last format)\n"
 654          "dw   - show 1 4 byte decimal integer value\n";
 655 }
 656
 657 static llvm::StringRef FormatHelpTextCallback() {
 658   static std::string help_text;
 659
 660   if (!help_text.empty())
 661     return help_text;
 662
 663   StreamString sstr;
 664   sstr << "One of the format names (or one-character names) that can be used "
 665           "to show a variable's value:\n";
 666   for (Format f = eFormatDefault; f < kNumFormats; f = Format(f + 1)) {
 667     if (f != eFormatDefault)
 668       sstr.PutChar('\n');
 669
 670     char format_char = FormatManager::GetFormatAsFormatChar(f);
 671     if (format_char)
 672       sstr.Printf("'%c' or ", format_char);
 673
 674     sstr.Printf("\"%s\"", FormatManager::GetFormatAsCString(f));
 675   }
 676
 677   sstr.Flush();
 678
 679   help_text = sstr.GetString();
 680
 681   return help_text;
 682 }
 683
 684 static llvm::StringRef LanguageTypeHelpTextCallback() {
 685   static std::string help_text;
 686
 687   if (!help_text.empty())
 688     return help_text;
 689
 690   StreamString sstr;
 691   sstr << "One of the following languages:\n";
 692
 693   Language::PrintAllLanguages(sstr, "  ", "\n");
 694
 695   sstr.Flush();
 696
 697   help_text = sstr.GetString();
 698
 699   return help_text;
 700 }
 701
 702 static llvm::StringRef SummaryStringHelpTextCallback() {
 703   return "A summary string is a way to extract information from variables in "
 704          "order to present them using a summary.\n"
 705          "Summary strings contain static text, variables, scopes and control "
 706          "sequences:\n"
 707          "  - Static text can be any sequence of non-special characters, i.e. "
 708          "anything but '{', '}', '$', or '\\'.\n"
 709          "  - Variables are sequences of characters beginning with ${, ending "
 710          "with } and that contain symbols in the format described below.\n"
 711          "  - Scopes are any sequence of text between { and }. Anything "
 712          "included in a scope will only appear in the output summary if there "
 713          "were no errors.\n"
 714          "  - Control sequences are the usual C/C++ '\\a', '\\n', ..., plus "
 715          "'\\$', '\\{' and '\\}'.\n"
 716          "A summary string works by copying static text verbatim, turning "
 717          "control sequences into their character counterpart, expanding "
 718          "variables and trying to expand scopes.\n"
 719          "A variable is expanded by giving it a value other than its textual "
 720          "representation, and the way this is done depends on what comes after "
 721          "the ${ marker.\n"
 722          "The most common sequence if ${var followed by an expression path, "
 723          "which is the text one would type to access a member of an aggregate "
 724          "types, given a variable of that type"
 725          " (e.g. if type T has a member named x, which has a member named y, "
 726          "and if t is of type T, the expression path would be .x.y and the way "
 727          "to fit that into a summary string would be"
 728          " ${var.x.y}). You can also use ${*var followed by an expression path "
 729          "and in that case the object referred by the path will be "
 730          "dereferenced before being displayed."
 731          " If the object is not a pointer, doing so will cause an error. For "
 732          "additional details on expression paths, you can type 'help "
 733          "expr-path'. \n"
 734          "By default, summary strings attempt to display the summary for any "
 735          "variable they reference, and if that fails the value. If neither can "
 736          "be shown, nothing is displayed."
 737          "In a summary string, you can also use an array index [n], or a "
 738          "slice-like range [n-m]. This can have two different meanings "
 739          "depending on what kind of object the expression"
 740          " path refers to:\n"
 741          "  - if it is a scalar type (any basic type like int, float, ...) the "
 742          "expression is a bitfield, i.e. the bits indicated by the indexing "
 743          "operator are extracted out of the number"
 744          " and displayed as an individual variable\n"
 745          "  - if it is an array or pointer the array items indicated by the "
 746          "indexing operator are shown as the result of the variable. if the "
 747          "expression is an array, real array items are"
 748          " printed; if it is a pointer, the pointer-as-array syntax is used to "
 749          "obtain the values (this means, the latter case can have no range "
 750          "checking)\n"
 751          "If you are trying to display an array for which the size is known, "
 752          "you can also use [] instead of giving an exact range. This has the "
 753          "effect of showing items 0 thru size - 1.\n"
 754          "Additionally, a variable can contain an (optional) format code, as "
 755          "in ${var.x.y%code}, where code can be any of the valid formats "
 756          "described in 'help format', or one of the"
 757          " special symbols only allowed as part of a variable:\n"
 758          "    %V: show the value of the object by default\n"
 759          "    %S: show the summary of the object by default\n"
 760          "    %@: show the runtime-provided object description (for "
 761          "Objective-C, it calls NSPrintForDebugger; for C/C++ it does "
 762          "nothing)\n"
 763          "    %L: show the location of the object (memory address or a "
 764          "register name)\n"
 765          "    %#: show the number of children of the object\n"
 766          "    %T: show the type of the object\n"
 767          "Another variable that you can use in summary strings is ${svar . "
 768          "This sequence works exactly like ${var, including the fact that "
 769          "${*svar is an allowed sequence, but uses"
 770          " the object's synthetic children provider instead of the actual "
 771          "objects. For instance, if you are using STL synthetic children "
 772          "providers, the following summary string would"
 773          " count the number of actual elements stored in an std::list:\n"
 774          "type summary add -s \"${svar%#}\" -x \"std::list<\"";
 775 }
 776
 777 static llvm::StringRef ExprPathHelpTextCallback() {
 778   return "An expression path is the sequence of symbols that is used in C/C++ "
 779          "to access a member variable of an aggregate object (class).\n"
 780          "For instance, given a class:\n"
 781          "  class foo {\n"
 782          "      int a;\n"
 783          "      int b; .\n"
 784          "      foo* next;\n"
 785          "  };\n"
 786          "the expression to read item b in the item pointed to by next for foo "
 787          "aFoo would be aFoo.next->b.\n"
 788          "Given that aFoo could just be any object of type foo, the string "
 789          "'.next->b' is the expression path, because it can be attached to any "
 790          "foo instance to achieve the effect.\n"
 791          "Expression paths in LLDB include dot (.) and arrow (->) operators, "
 792          "and most commands using expression paths have ways to also accept "
 793          "the star (*) operator.\n"
 794          "The meaning of these operators is the same as the usual one given to "
 795          "them by the C/C++ standards.\n"
 796          "LLDB also has support for indexing ([ ]) in expression paths, and "
 797          "extends the traditional meaning of the square brackets operator to "
 798          "allow bitfield extraction:\n"
 799          "for objects of native types (int, float, char, ...) saying '[n-m]' "
 800          "as an expression path (where n and m are any positive integers, e.g. "
 801          "[3-5]) causes LLDB to extract"
 802          " bits n thru m from the value of the variable. If n == m, [n] is "
 803          "also allowed as a shortcut syntax. For arrays and pointers, "
 804          "expression paths can only contain one index"
 805          " and the meaning of the operation is the same as the one defined by "
 806          "C/C++ (item extraction). Some commands extend bitfield-like syntax "
 807          "for arrays and pointers with the"
 808          " meaning of array slicing (taking elements n thru m inside the array "
 809          "or pointed-to memory).";
 810 }
 811
 812 void CommandObject::FormatLongHelpText(Stream &output_strm,
 813                                        llvm::StringRef long_help) {
 814   CommandInterpreter &interpreter = GetCommandInterpreter();
 815   std::stringstream lineStream(long_help);
 816   std::string line;
 817   while (std::getline(lineStream, line)) {
 818     if (line.empty()) {
 819       output_strm << "\n";
 820       continue;
 821     }
 822     size_t result = line.find_first_not_of(" \t");
 823     if (result == std::string::npos) {
 824       result = 0;
 825     }
 826     std::string whitespace_prefix = line.substr(0, result);
 827     std::string remainder = line.substr(result);
 828     interpreter.OutputFormattedHelpText(output_strm, whitespace_prefix.c_str(),
 829                                         remainder.c_str());
 830   }
 831 }
 832
 833 void CommandObject::GenerateHelpText(CommandReturnObject &result) {
 834   GenerateHelpText(result.GetOutputStream());
 835
 836   result.SetStatus(eReturnStatusSuccessFinishNoResult);
 837 }
 838
 839 void CommandObject::GenerateHelpText(Stream &output_strm) {
 840   CommandInterpreter &interpreter = GetCommandInterpreter();
 841   if (WantsRawCommandString()) {
 842     std::string help_text(GetHelp());
 843     help_text.append("  Expects 'raw' input (see 'help raw-input'.)");
 844     interpreter.OutputFormattedHelpText(output_strm, "", "", help_text.c_str(),
 845                                         1);
 846   } else
 847     interpreter.OutputFormattedHelpText(output_strm, "", "", GetHelp(), 1);
 848   output_strm << "\nSyntax: " << GetSyntax() << "\n";
 849   Options *options = GetOptions();
 850   if (options != nullptr) {
 851     options->GenerateOptionUsage(
 852         output_strm, this,
 853         GetCommandInterpreter().GetDebugger().GetTerminalWidth());
 854   }
 855   llvm::StringRef long_help = GetHelpLong();
 856   if (!long_help.empty()) {
 857     FormatLongHelpText(output_strm, long_help);
 858   }
 859   if (!IsDashDashCommand() && options && options->NumCommandOptions() > 0) {
 860     if (WantsRawCommandString() && !WantsCompletion()) {
 861       // Emit the message about using ' -- ' between the end of the command
 862       // options and the raw input conditionally, i.e., only if the command
 863       // object does not want completion.
 864       interpreter.OutputFormattedHelpText(
 865           output_strm, "", "",
 866           "\nImportant Note: Because this command takes 'raw' input, if you "
 867           "use any command options"
 868           " you must use ' -- ' between the end of the command options and the "
 869           "beginning of the raw input.",
 870           1);
 871     } else if (GetNumArgumentEntries() > 0) {
 872       // Also emit a warning about using "--" in case you are using a command
 873       // that takes options and arguments.
 874       interpreter.OutputFormattedHelpText(
 875           output_strm, "", "",
 876           "\nThis command takes options and free-form arguments.  If your "
 877           "arguments resemble"
 878           " option specifiers (i.e., they start with a - or --), you must use "
 879           "' -- ' between"
 880           " the end of the command options and the beginning of the arguments.",
 881           1);
 882     }
 883   }
 884 }
 885
 886 void CommandObject::AddIDsArgumentData(CommandArgumentEntry &arg,
 887                                        CommandArgumentType ID,
 888                                        CommandArgumentType IDRange) {
 889   CommandArgumentData id_arg;
 890   CommandArgumentData id_range_arg;
 891
 892   // Create the first variant for the first (and only) argument for this
 893   // command.
 894   id_arg.arg_type = ID;
 895   id_arg.arg_repetition = eArgRepeatOptional;
 896
 897   // Create the second variant for the first (and only) argument for this
 898   // command.
 899   id_range_arg.arg_type = IDRange;
 900   id_range_arg.arg_repetition = eArgRepeatOptional;
 901
 902   // The first (and only) argument for this command could be either an id or an
 903   // id_range. Push both variants into the entry for the first argument for
 904   // this command.
 905   arg.push_back(id_arg);
 906   arg.push_back(id_range_arg);
 907 }
 908
 909 const char *CommandObject::GetArgumentTypeAsCString(
 910     const lldb::CommandArgumentType arg_type) {
 911   assert(arg_type < eArgTypeLastArg &&
 912          "Invalid argument type passed to GetArgumentTypeAsCString");
 913   return g_arguments_data[arg_type].arg_name;
 914 }
 915
 916 const char *CommandObject::GetArgumentDescriptionAsCString(
 917     const lldb::CommandArgumentType arg_type) {
 918   assert(arg_type < eArgTypeLastArg &&
 919          "Invalid argument type passed to GetArgumentDescriptionAsCString");
 920   return g_arguments_data[arg_type].help_text;
 921 }
 922
 923 Target *CommandObject::GetDummyTarget() {
 924   return m_interpreter.GetDebugger().GetDummyTarget();
 925 }
 926
 927 Target *CommandObject::GetSelectedOrDummyTarget(bool prefer_dummy) {
 928   return m_interpreter.GetDebugger().GetSelectedOrDummyTarget(prefer_dummy);
 929 }
 930
 931 Thread *CommandObject::GetDefaultThread() {
 932   Thread *thread_to_use = m_exe_ctx.GetThreadPtr();
 933   if (thread_to_use)
 934     return thread_to_use;
 935
 936   Process *process = m_exe_ctx.GetProcessPtr();
 937   if (!process) {
 938     Target *target = m_exe_ctx.GetTargetPtr();
 939     if (!target) {
 940       target = m_interpreter.GetDebugger().GetSelectedTarget().get();
 941     }
 942     if (target)
 943       process = target->GetProcessSP().get();
 944   }
 945
 946   if (process)
 947     return process->GetThreadList().GetSelectedThread().get();
 948   else
 949     return nullptr;
 950 }
 951
 952 bool CommandObjectParsed::Execute(const char *args_string,
 953                                   CommandReturnObject &result) {
 954   bool handled = false;
 955   Args cmd_args(args_string);
 956   if (HasOverrideCallback()) {
 957     Args full_args(GetCommandName());
 958     full_args.AppendArguments(cmd_args);
 959     handled =
 960         InvokeOverrideCallback(full_args.GetConstArgumentVector(), result);
 961   }
 962   if (!handled) {
 963     for (auto entry : llvm::enumerate(cmd_args.entries())) {
 964       if (!entry.value().ref.empty() && entry.value().ref.front() == '`') {
 965         cmd_args.ReplaceArgumentAtIndex(
 966             entry.index(),
 967             m_interpreter.ProcessEmbeddedScriptCommands(entry.value().c_str()));
 968       }
 969     }
 970
 971     if (CheckRequirements(result)) {
 972       if (ParseOptions(cmd_args, result)) {
 973         // Call the command-specific version of 'Execute', passing it the
 974         // already processed arguments.
 975         handled = DoExecute(cmd_args, result);
 976       }
 977     }
 978
 979     Cleanup();
 980   }
 981   return handled;
 982 }
 983
 984 bool CommandObjectRaw::Execute(const char *args_string,
 985                                CommandReturnObject &result) {
 986   bool handled = false;
 987   if (HasOverrideCallback()) {
 988     std::string full_command(GetCommandName());
 989     full_command += ' ';
 990     full_command += args_string;
 991     const char *argv[2] = {nullptr, nullptr};
 992     argv[0] = full_command.c_str();
 993     handled = InvokeOverrideCallback(argv, result);
 994   }
 995   if (!handled) {
 996     if (CheckRequirements(result))
 997       handled = DoExecute(args_string, result);
 998
 999     Cleanup();
1000   }
1001   return handled;
1002 }
1003
1004 static llvm::StringRef arch_helper() {
1005   static StreamString g_archs_help;
1006   if (g_archs_help.Empty()) {
1007     StringList archs;
1008
1009     ArchSpec::ListSupportedArchNames(archs);
1010     g_archs_help.Printf("These are the supported architecture names:\n");
1011     archs.Join("\n", g_archs_help);
1012   }
1013   return g_archs_help.GetString();
1014 }
1015
1016 CommandObject::ArgumentTableEntry CommandObject::g_arguments_data[] = {
1017     // clang-format off
1018     { eArgTypeAddress, "address", CommandCompletions::eNoCompletion, { nullptr, false }, "A valid address in the target program's execution space." },
1019     { eArgTypeAddressOrExpression, "address-expression", CommandCompletions::eNoCompletion, { nullptr, false }, "An expression that resolves to an address." },
1020     { eArgTypeAliasName, "alias-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of an abbreviation (alias) for a debugger command." },
1021     { eArgTypeAliasOptions, "options-for-aliased-command", CommandCompletions::eNoCompletion, { nullptr, false }, "Command options to be used as part of an alias (abbreviation) definition.  (See 'help commands alias' for more information.)" },
1022     { eArgTypeArchitecture, "arch", CommandCompletions::eArchitectureCompletion, { arch_helper, true }, "The architecture name, e.g. i386 or x86_64." },
1023     { eArgTypeBoolean, "boolean", CommandCompletions::eNoCompletion, { nullptr, false }, "A Boolean value: 'true' or 'false'" },
1024     { eArgTypeBreakpointID, "breakpt-id", CommandCompletions::eNoCompletion, { BreakpointIDHelpTextCallback, false }, nullptr },
1025     { eArgTypeBreakpointIDRange, "breakpt-id-list", CommandCompletions::eNoCompletion, { BreakpointIDRangeHelpTextCallback, false }, nullptr },
1026     { eArgTypeBreakpointName, "breakpoint-name", CommandCompletions::eNoCompletion, { BreakpointNameHelpTextCallback, false }, nullptr },
1027     { eArgTypeByteSize, "byte-size", CommandCompletions::eNoCompletion, { nullptr, false }, "Number of bytes to use." },
1028     { eArgTypeClassName, "class-name", CommandCompletions::eNoCompletion, { nullptr, false }, "Then name of a class from the debug information in the program." },
1029     { eArgTypeCommandName, "cmd-name", CommandCompletions::eNoCompletion, { nullptr, false }, "A debugger command (may be multiple words), without any options or arguments." },
1030     { eArgTypeCount, "count", CommandCompletions::eNoCompletion, { nullptr, false }, "An unsigned integer." },
1031     { eArgTypeDirectoryName, "directory", CommandCompletions::eDiskDirectoryCompletion, { nullptr, false }, "A directory name." },
1032     { eArgTypeDisassemblyFlavor, "disassembly-flavor", CommandCompletions::eNoCompletion, { nullptr, false }, "A disassembly flavor recognized by your disassembly plugin.  Currently the only valid options are \"att\" and \"intel\" for Intel targets" },
1033     { eArgTypeDescriptionVerbosity, "description-verbosity", CommandCompletions::eNoCompletion, { nullptr, false }, "How verbose the output of 'po' should be." },
1034     { eArgTypeEndAddress, "end-address", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1035     { eArgTypeExpression, "expr", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1036     { eArgTypeExpressionPath, "expr-path", CommandCompletions::eNoCompletion, { ExprPathHelpTextCallback, true }, nullptr },
1037     { eArgTypeExprFormat, "expression-format", CommandCompletions::eNoCompletion, { nullptr, false }, "[ [bool|b] | [bin] | [char|c] | [oct|o] | [dec|i|d|u] | [hex|x] | [float|f] | [cstr|s] ]" },
1038     { eArgTypeFilename, "filename", CommandCompletions::eDiskFileCompletion, { nullptr, false }, "The name of a file (can include path)." },
1039     { eArgTypeFormat, "format", CommandCompletions::eNoCompletion, { FormatHelpTextCallback, true }, nullptr },
1040     { eArgTypeFrameIndex, "frame-index", CommandCompletions::eNoCompletion, { nullptr, false }, "Index into a thread's list of frames." },
1041     { eArgTypeFullName, "fullname", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1042     { eArgTypeFunctionName, "function-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a function." },
1043     { eArgTypeFunctionOrSymbol, "function-or-symbol", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a function or symbol." },
1044     { eArgTypeGDBFormat, "gdb-format", CommandCompletions::eNoCompletion, { GDBFormatHelpTextCallback, true }, nullptr },
1045     { eArgTypeHelpText, "help-text", CommandCompletions::eNoCompletion, { nullptr, false }, "Text to be used as help for some other entity in LLDB" },
1046     { eArgTypeIndex, "index", CommandCompletions::eNoCompletion, { nullptr, false }, "An index into a list." },
1047     { eArgTypeLanguage, "source-language", CommandCompletions::eNoCompletion, { LanguageTypeHelpTextCallback, true }, nullptr },
1048     { eArgTypeLineNum, "linenum", CommandCompletions::eNoCompletion, { nullptr, false }, "Line number in a source file." },
1049     { eArgTypeLogCategory, "log-category", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a category within a log channel, e.g. all (try \"log list\" to see a list of all channels and their categories." },
1050     { eArgTypeLogChannel, "log-channel", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a log channel, e.g. process.gdb-remote (try \"log list\" to see a list of all channels and their categories)." },
1051     { eArgTypeMethod, "method", CommandCompletions::eNoCompletion, { nullptr, false }, "A C++ method name." },
1052     { eArgTypeName, "name", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1053     { eArgTypeNewPathPrefix, "new-path-prefix", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1054     { eArgTypeNumLines, "num-lines", CommandCompletions::eNoCompletion, { nullptr, false }, "The number of lines to use." },
1055     { eArgTypeNumberPerLine, "number-per-line", CommandCompletions::eNoCompletion, { nullptr, false }, "The number of items per line to display." },
1056     { eArgTypeOffset, "offset", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1057     { eArgTypeOldPathPrefix, "old-path-prefix", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1058     { eArgTypeOneLiner, "one-line-command", CommandCompletions::eNoCompletion, { nullptr, false }, "A command that is entered as a single line of text." },
1059     { eArgTypePath, "path", CommandCompletions::eDiskFileCompletion, { nullptr, false }, "Path." },
1060     { eArgTypePermissionsNumber, "perms-numeric", CommandCompletions::eNoCompletion, { nullptr, false }, "Permissions given as an octal number (e.g. 755)." },
1061     { eArgTypePermissionsString, "perms=string", CommandCompletions::eNoCompletion, { nullptr, false }, "Permissions given as a string value (e.g. rw-r-xr--)." },
1062     { eArgTypePid, "pid", CommandCompletions::eNoCompletion, { nullptr, false }, "The process ID number." },
1063     { eArgTypePlugin, "plugin", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1064     { eArgTypeProcessName, "process-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of the process." },
1065     { eArgTypePythonClass, "python-class", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a Python class." },
1066     { eArgTypePythonFunction, "python-function", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a Python function." },
1067     { eArgTypePythonScript, "python-script", CommandCompletions::eNoCompletion, { nullptr, false }, "Source code written in Python." },
1068     { eArgTypeQueueName, "queue-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of the thread queue." },
1069     { eArgTypeRegisterName, "register-name", CommandCompletions::eNoCompletion, { RegisterNameHelpTextCallback, true }, nullptr },
1070     { eArgTypeRegularExpression, "regular-expression", CommandCompletions::eNoCompletion, { nullptr, false }, "A regular expression." },
1071     { eArgTypeRunArgs, "run-args", CommandCompletions::eNoCompletion, { nullptr, false }, "Arguments to be passed to the target program when it starts executing." },
1072     { eArgTypeRunMode, "run-mode", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1073     { eArgTypeScriptedCommandSynchronicity, "script-cmd-synchronicity", CommandCompletions::eNoCompletion, { nullptr, false }, "The synchronicity to use to run scripted commands with regard to LLDB event system." },
1074     { eArgTypeScriptLang, "script-language", CommandCompletions::eNoCompletion, { nullptr, false }, "The scripting language to be used for script-based commands.  Currently only Python is valid." },
1075     { eArgTypeSearchWord, "search-word", CommandCompletions::eNoCompletion, { nullptr, false }, "Any word of interest for search purposes." },
1076     { eArgTypeSelector, "selector", CommandCompletions::eNoCompletion, { nullptr, false }, "An Objective-C selector name." },
1077     { eArgTypeSettingIndex, "setting-index", CommandCompletions::eNoCompletion, { nullptr, false }, "An index into a settings variable that is an array (try 'settings list' to see all the possible settings variables and their types)." },
1078     { eArgTypeSettingKey, "setting-key", CommandCompletions::eNoCompletion, { nullptr, false }, "A key into a settings variables that is a dictionary (try 'settings list' to see all the possible settings variables and their types)." },
1079     { eArgTypeSettingPrefix, "setting-prefix", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a settable internal debugger variable up to a dot ('.'), e.g. 'target.process.'" },
1080     { eArgTypeSettingVariableName, "setting-variable-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a settable internal debugger variable.  Type 'settings list' to see a complete list of such variables." },
1081     { eArgTypeShlibName, "shlib-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a shared library." },
1082     { eArgTypeSourceFile, "source-file", CommandCompletions::eSourceFileCompletion, { nullptr, false }, "The name of a source file.." },
1083     { eArgTypeSortOrder, "sort-order", CommandCompletions::eNoCompletion, { nullptr, false }, "Specify a sort order when dumping lists." },
1084     { eArgTypeStartAddress, "start-address", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1085     { eArgTypeSummaryString, "summary-string", CommandCompletions::eNoCompletion, { SummaryStringHelpTextCallback, true }, nullptr },
1086     { eArgTypeSymbol, "symbol", CommandCompletions::eSymbolCompletion, { nullptr, false }, "Any symbol name (function name, variable, argument, etc.)" },
1087     { eArgTypeThreadID, "thread-id", CommandCompletions::eNoCompletion, { nullptr, false }, "Thread ID number." },
1088     { eArgTypeThreadIndex, "thread-index", CommandCompletions::eNoCompletion, { nullptr, false }, "Index into the process' list of threads." },
1089     { eArgTypeThreadName, "thread-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The thread's name." },
1090     { eArgTypeTypeName, "type-name", CommandCompletions::eNoCompletion, { nullptr, false }, "A type name." },
1091     { eArgTypeUnsignedInteger, "unsigned-integer", CommandCompletions::eNoCompletion, { nullptr, false }, "An unsigned integer." },
1092     { eArgTypeUnixSignal, "unix-signal", CommandCompletions::eNoCompletion, { nullptr, false }, "A valid Unix signal name or number (e.g. SIGKILL, KILL or 9)." },
1093     { eArgTypeVarName, "variable-name", CommandCompletions::eNoCompletion, { nullptr, false }, "The name of a variable in your program." },
1094     { eArgTypeValue, "value", CommandCompletions::eNoCompletion, { nullptr, false }, "A value could be anything, depending on where and how it is used." },
1095     { eArgTypeWidth, "width", CommandCompletions::eNoCompletion, { nullptr, false }, "Help text goes here." },
1096     { eArgTypeNone, "none", CommandCompletions::eNoCompletion, { nullptr, false }, "No help available for this." },
1097     { eArgTypePlatform, "platform-name", CommandCompletions::ePlatformPluginCompletion, { nullptr, false }, "The name of an installed platform plug-in . Type 'platform list' to see a complete list of installed platforms." },
1098     { eArgTypeWatchpointID, "watchpt-id", CommandCompletions::eNoCompletion, { nullptr, false }, "Watchpoint IDs are positive integers." },
1099     { eArgTypeWatchpointIDRange, "watchpt-id-list", CommandCompletions::eNoCompletion, { nullptr, false }, "For example, '1-3' or '1 to 3'." },
1100     { eArgTypeWatchType, "watch-type", CommandCompletions::eNoCompletion, { nullptr, false }, "Specify the type for a watchpoint." },
1101     { eArgRawInput, "raw-input", CommandCompletions::eNoCompletion, { nullptr, false }, "Free-form text passed to a command without prior interpretation, allowing spaces without requiring quotes.  To pass arguments and free form text put two dashes ' -- ' between the last argument and any raw input." },
1102     { eArgTypeCommand, "command", CommandCompletions::eNoCompletion, { nullptr, false }, "An LLDB Command line command." }
1103     // clang-format on
1104 };
1105
1106 const CommandObject::ArgumentTableEntry *CommandObject::GetArgumentTable() {
1107   // If this assertion fires, then the table above is out of date with the
1108   // CommandArgumentType enumeration
1109   assert((sizeof(CommandObject::g_arguments_data) /
1110           sizeof(CommandObject::ArgumentTableEntry)) == eArgTypeLastArg);
1111   return CommandObject::g_arguments_data;
1112 }