LLDB mainline
|
#include <CommandObjectMultiword.h>
Public Member Functions | |
CommandObjectProxy (CommandInterpreter &interpreter, const char *name, const char *help=nullptr, const char *syntax=nullptr, uint32_t flags=0) | |
~CommandObjectProxy () override | |
virtual CommandObject * | GetProxyCommandObject ()=0 |
llvm::StringRef | GetSyntax () override |
llvm::StringRef | GetHelp () override |
llvm::StringRef | GetHelpLong () override |
bool | IsRemovable () const override |
bool | IsMultiwordObject () override |
CommandObjectMultiword * | GetAsMultiwordCommand () override |
void | GenerateHelpText (Stream &result) override |
lldb::CommandObjectSP | GetSubcommandSP (llvm::StringRef sub_cmd, StringList *matches=nullptr) override |
CommandObject * | GetSubcommandObject (llvm::StringRef sub_cmd, StringList *matches=nullptr) override |
bool | LoadSubCommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj) override |
bool | WantsRawCommandString () override |
bool | WantsCompletion () override |
Options * | GetOptions () override |
void | HandleCompletion (CompletionRequest &request) override |
This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option. | |
void | HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override |
The input array contains a parsed version of the line. | |
std::optional< std::string > | GetRepeatCommand (Args ¤t_command_args, uint32_t index) override |
Get the command that appropriate for a "repeat" of the current command. | |
virtual llvm::StringRef | GetUnsupportedError () |
bool | Execute (const char *args_string, CommandReturnObject &result) override |
![]() | |
CommandObject (CommandInterpreter &interpreter, llvm::StringRef name, llvm::StringRef help="", llvm::StringRef syntax="", uint32_t flags=0) | |
virtual | ~CommandObject ()=default |
CommandInterpreter & | GetCommandInterpreter () |
Debugger & | GetDebugger () |
virtual llvm::StringRef | GetHelp () |
virtual llvm::StringRef | GetHelpLong () |
virtual llvm::StringRef | GetSyntax () |
llvm::StringRef | GetCommandName () const |
virtual void | SetHelp (llvm::StringRef str) |
virtual void | SetHelpLong (llvm::StringRef str) |
void | SetSyntax (llvm::StringRef str) |
virtual bool | IsRemovable () const |
virtual bool | IsMultiwordObject () |
bool | IsUserCommand () |
void | SetIsUserCommand (bool is_user) |
virtual CommandObjectMultiword * | GetAsMultiwordCommand () |
virtual bool | IsAlias () |
virtual bool | IsDashDashCommand () |
virtual lldb::CommandObjectSP | GetSubcommandSP (llvm::StringRef sub_cmd, StringList *matches=nullptr) |
virtual lldb::CommandObjectSP | GetSubcommandSPExact (llvm::StringRef sub_cmd) |
virtual CommandObject * | GetSubcommandObject (llvm::StringRef sub_cmd, StringList *matches=nullptr) |
void | FormatLongHelpText (Stream &output_strm, llvm::StringRef long_help) |
void | GenerateHelpText (CommandReturnObject &result) |
virtual void | GenerateHelpText (Stream &result) |
virtual bool | LoadSubCommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj) |
virtual llvm::Error | LoadUserSubcommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj, bool can_replace) |
virtual bool | WantsRawCommandString ()=0 |
virtual bool | WantsCompletion () |
virtual Options * | GetOptions () |
int | GetNumArgumentEntries () |
CommandArgumentEntry * | GetArgumentEntryAtIndex (int idx) |
void | GetFormattedCommandArguments (Stream &str, uint32_t opt_set_mask=LLDB_OPT_SET_ALL) |
bool | IsPairType (ArgumentRepetitionType arg_repeat_type) |
bool | ParseOptions (Args &args, CommandReturnObject &result) |
void | SetCommandName (llvm::StringRef name) |
virtual void | HandleCompletion (CompletionRequest &request) |
This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option. | |
virtual void | HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) |
The input array contains a parsed version of the line. | |
bool | HelpTextContainsWord (llvm::StringRef search_word, bool search_short_help=true, bool search_long_help=true, bool search_syntax=true, bool search_options=true) |
Flags & | GetFlags () |
The flags accessor. | |
const Flags & | GetFlags () const |
The flags const accessor. | |
virtual std::optional< std::string > | GetRepeatCommand (Args ¤t_command_args, uint32_t index) |
Get the command that appropriate for a "repeat" of the current command. | |
bool | HasOverrideCallback () const |
void | SetOverrideCallback (lldb::CommandOverrideCallback callback, void *baton) |
void | SetOverrideCallback (lldb::CommandOverrideCallbackWithResult callback, void *baton) |
bool | InvokeOverrideCallback (const char **argv, CommandReturnObject &result) |
virtual bool | Execute (const char *args_string, CommandReturnObject &result)=0 |
Friends | |
class | CommandInterpreter |
class | CommandObjectSyntax |
Definition at line 77 of file CommandObjectMultiword.h.
CommandObjectProxy::CommandObjectProxy | ( | CommandInterpreter & | interpreter, |
const char * | name, | ||
const char * | help = nullptr , |
||
const char * | syntax = nullptr , |
||
uint32_t | flags = 0 |
||
) |
Definition at line 302 of file CommandObjectMultiword.cpp.
|
overridedefault |
|
overridevirtual |
Implements lldb_private::CommandObject.
Definition at line 432 of file CommandObjectMultiword.cpp.
References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandObject::Execute(), GetProxyCommandObject(), and GetUnsupportedError().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 359 of file CommandObjectMultiword.cpp.
References lldb_private::CommandObject::GenerateHelpText(), and GetProxyCommandObject().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 352 of file CommandObjectMultiword.cpp.
References lldb_private::CommandObject::GetAsMultiwordCommand(), and GetProxyCommandObject().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 316 of file CommandObjectMultiword.cpp.
References lldb_private::CommandObject::GetHelp(), and GetProxyCommandObject().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 330 of file CommandObjectMultiword.cpp.
References lldb_private::CommandObject::GetHelpLong(), and GetProxyCommandObject().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 309 of file CommandObjectMultiword.cpp.
References lldb_private::CommandObject::GetOptions(), and GetProxyCommandObject().
|
pure virtual |
Implemented in CommandObjectProcessPlugin, and lldb_private::CommandObjectTraceProxy.
Referenced by Execute(), GenerateHelpText(), GetAsMultiwordCommand(), GetHelp(), GetHelpLong(), GetOptions(), GetRepeatCommand(), GetSubcommandObject(), GetSubcommandSP(), GetSyntax(), HandleArgumentCompletion(), HandleCompletion(), IsMultiwordObject(), IsRemovable(), LoadSubCommand(), WantsCompletion(), and WantsRawCommandString().
|
overridevirtual |
Get the command that appropriate for a "repeat" of the current command.
[in] | current_command_args | The command arguments. |
Reimplemented from lldb_private::CommandObject.
Definition at line 420 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::GetRepeatCommand().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 376 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::GetSubcommandObject().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 368 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::GetSubcommandSP().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 323 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::GetSyntax().
|
virtual |
Reimplemented in lldb_private::CommandObjectTraceProxy.
Definition at line 428 of file CommandObjectMultiword.cpp.
Referenced by Execute().
|
overridevirtual |
The input array contains a parsed version of the line.
We've constructed the map of options and their arguments as well if that is helpful for the completion.
[in,out] | request | The completion request that needs to be answered. |
Reimplemented from lldb_private::CommandObject.
Definition at line 412 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::HandleArgumentCompletion().
|
overridevirtual |
This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option.
Don't override this method, override HandleArgumentCompletion instead unless you have special reasons.
[in,out] | request | The completion request that needs to be answered. |
Reimplemented from lldb_private::CommandObject.
Definition at line 406 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::HandleCompletion().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 345 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::IsMultiwordObject().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 337 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::IsRemovable().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 384 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::LoadSubCommand().
|
overridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 399 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::WantsCompletion().
|
overridevirtual |
Implements lldb_private::CommandObject.
Definition at line 392 of file CommandObjectMultiword.cpp.
References GetProxyCommandObject(), and lldb_private::CommandObject::WantsRawCommandString().
|
friend |
Definition at line 136 of file CommandObjectMultiword.h.
|
friend |
Definition at line 137 of file CommandObjectMultiword.h.