LLDB mainline
|
Public Member Functions | |
CommandObjectPythonFunction (CommandInterpreter &interpreter, std::string name, std::string funct, std::string help, ScriptedCommandSynchronicity synch, CompletionType completion_type) | |
~CommandObjectPythonFunction () override=default | |
bool | IsRemovable () const override |
const std::string & | GetFunctionName () |
ScriptedCommandSynchronicity | GetSynchronicity () |
llvm::StringRef | GetHelpLong () override |
void | HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override |
The default version handles argument definitions that have only one argument type, and use one of the argument types that have an entry in the CommonCompletions. | |
bool | WantsCompletion () override |
Public Member Functions inherited from lldb_private::CommandObjectRaw | |
CommandObjectRaw (CommandInterpreter &interpreter, llvm::StringRef name, llvm::StringRef help="", llvm::StringRef syntax="", uint32_t flags=0) | |
~CommandObjectRaw () override=default | |
void | Execute (const char *args_string, CommandReturnObject &result) override |
Public Member Functions inherited from lldb_private::CommandObject | |
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 | GetSyntax () |
llvm::StringRef | GetCommandName () const |
virtual void | SetHelp (llvm::StringRef str) |
virtual void | SetHelpLong (llvm::StringRef str) |
void | SetSyntax (llvm::StringRef str) |
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 Options * | GetOptions () |
void | AddSimpleArgumentList (lldb::CommandArgumentType arg_type, ArgumentRepetitionType repetition_type=eArgRepeatPlain) |
void | AddIDsArgumentData (IDType type) |
int | GetNumArgumentEntries () |
CommandArgumentEntry * | GetArgumentEntryAtIndex (int idx) |
void | GetFormattedCommandArguments (Stream &str, uint32_t opt_set_mask=LLDB_OPT_SET_ALL) |
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. | |
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_private::CommandOverrideCallbackWithResult callback, void *baton) |
bool | InvokeOverrideCallback (const char **argv, CommandReturnObject &result) |
void | SetOriginalCommandString (std::string s) |
Set the command input as it appeared in the terminal. |
Protected Member Functions | |
void | DoExecute (llvm::StringRef raw_command_line, CommandReturnObject &result) override |
Protected Member Functions inherited from lldb_private::CommandObjectRaw | |
bool | WantsRawCommandString () override |
Protected Member Functions inherited from lldb_private::CommandObject | |
bool | ParseOptionsAndNotify (Args &args, CommandReturnObject &result, OptionGroupOptions &group_options, ExecutionContext &exe_ctx) |
virtual const char * | GetInvalidTargetDescription () |
virtual const char * | GetInvalidProcessDescription () |
virtual const char * | GetInvalidThreadDescription () |
virtual const char * | GetInvalidFrameDescription () |
virtual const char * | GetInvalidRegContextDescription () |
Target & | GetDummyTarget () |
Target & | GetTarget () |
Thread * | GetDefaultThread () |
bool | CheckRequirements (CommandReturnObject &result) |
Check the command to make sure anything required by this command is available. | |
void | Cleanup () |
Private Attributes | |
std::string | m_function_name |
ScriptedCommandSynchronicity | m_synchro |
bool | m_fetched_help_long = false |
CompletionType | m_completion_type = eNoCompletion |
Definition at line 1038 of file CommandObjectCommands.cpp.
|
inline |
Definition at line 1040 of file CommandObjectCommands.cpp.
References lldb_private::CommandObjectRaw::CommandObjectRaw(), lldb_private::StreamString::GetString(), m_completion_type, m_function_name, m_synchro, lldb_private::Stream::Printf(), and lldb_private::CommandObject::SetHelp().
|
overridedefault |
|
inlineoverrideprotectedvirtual |
Implements lldb_private::CommandObjectRaw.
Definition at line 1089 of file CommandObjectCommands.cpp.
References lldb_private::CommandReturnObject::AppendError(), lldb::eReturnStatusInvalid, lldb::eReturnStatusSuccessFinishNoResult, lldb::eReturnStatusSuccessFinishResult, error(), lldb_private::CommandObject::GetDebugger(), lldb_private::CommandReturnObject::GetOutputString(), lldb_private::Debugger::GetScriptInterpreter(), lldb_private::CommandReturnObject::GetStatus(), lldb_private::CommandObject::m_exe_ctx, m_function_name, lldb_private::CommandObject::m_interpreter, m_synchro, lldb_private::ScriptInterpreter::RunScriptBasedCommand(), and lldb_private::CommandReturnObject::SetStatus().
|
inline |
Definition at line 1059 of file CommandObjectCommands.cpp.
References m_function_name.
|
inlineoverridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 1063 of file CommandObjectCommands.cpp.
References lldb_private::CommandObject::GetDebugger(), lldb_private::ScriptInterpreter::GetDocumentationForItem(), lldb_private::CommandObject::GetHelpLong(), lldb_private::Debugger::GetScriptInterpreter(), m_fetched_help_long, m_function_name, and lldb_private::CommandObject::SetHelpLong().
|
inline |
Definition at line 1061 of file CommandObjectCommands.cpp.
References m_synchro.
|
inlineoverridevirtual |
The default version handles argument definitions that have only one argument type, and use one of the argument types that have an entry in the CommonCompletions.
Override this if you have a more complex argument setup. FIXME: we should be able to extend this to more complex argument definitions provided we have completers for all the argument types.
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 1080 of file CommandObjectCommands.cpp.
References lldb_private::CommandObject::GetCommandInterpreter(), lldb_private::CommandCompletions::InvokeCommonCompletionCallbacks(), and m_completion_type.
|
inlineoverridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 1057 of file CommandObjectCommands.cpp.
|
inlineoverridevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 1086 of file CommandObjectCommands.cpp.
|
private |
Definition at line 1118 of file CommandObjectCommands.cpp.
Referenced by CommandObjectPythonFunction(), and HandleArgumentCompletion().
|
private |
Definition at line 1117 of file CommandObjectCommands.cpp.
Referenced by GetHelpLong().
|
private |
Definition at line 1115 of file CommandObjectCommands.cpp.
Referenced by CommandObjectPythonFunction(), DoExecute(), GetFunctionName(), and GetHelpLong().
|
private |
Definition at line 1116 of file CommandObjectCommands.cpp.
Referenced by CommandObjectPythonFunction(), DoExecute(), and GetSynchronicity().