LLDB mainline
lldb_private::ScriptedCommandInterface Class Referenceabstract

#include <ScriptedCommandInterface.h>

Inheritance diagram for lldb_private::ScriptedCommandInterface:
[legend]

Public Member Functions

virtual llvm::Expected< StructuredData::GenericSPCreatePluginObject (llvm::StringRef class_name, lldb::DebuggerSP debugger_sp)=0
virtual bool RunRawCommand (llvm::StringRef args, ScriptedCommandSynchronicity synchronicity, CommandReturnObject &cmd_retobj, Status &error, const ExecutionContext &exe_ctx)
virtual bool RunParsedCommand (Args &args, ScriptedCommandSynchronicity synchronicity, CommandReturnObject &cmd_retobj, Status &error, const ExecutionContext &exe_ctx)
virtual std::optional< std::string > GetRepeatCommand (Args &args)
virtual StructuredData::DictionarySP HandleArgumentCompletion (std::vector< std::string > &args, size_t args_pos, size_t char_in_arg)
virtual StructuredData::DictionarySP HandleOptionArgumentCompletion (llvm::StringRef &long_option, size_t char_in_arg)
virtual bool GetShortHelp (std::string &dest)
virtual bool GetLongHelp (std::string &dest)
virtual uint32_t GetFlags ()
virtual StructuredData::ObjectSP GetOptionsDefinition ()
virtual StructuredData::ObjectSP GetArgumentsDefinition ()
virtual void OptionParsingStarted ()
virtual bool SetOptionValue (ExecutionContext *exe_ctx, llvm::StringRef long_option, llvm::StringRef value)
Public Member Functions inherited from lldb_private::ScriptedInterface
 ScriptedInterface ()=default
virtual ~ScriptedInterface ()=default
StructuredData::GenericSP GetScriptObjectInstance ()
const std::optional< ScriptedMetadata > & GetScriptedMetadata () const
virtual llvm::SmallVector< AbstractMethodRequirementGetAbstractMethodRequirements () const =0
virtual llvm::Expected< FileSpecGetScriptedModulePath ()
llvm::SmallVector< llvm::StringLiteral > const GetAbstractMethods () const

Additional Inherited Members

Static Public Member Functions inherited from lldb_private::ScriptedInterface
template<typename Ret>
static Ret ErrorWithMessage (llvm::StringRef caller_name, llvm::StringRef error_msg, Status &error, LLDBLog log_category=LLDBLog::Process)
template<typename T = StructuredData::ObjectSP>
static bool CheckStructuredDataObject (llvm::StringRef caller, T obj, Status &error)
static bool CreateInstance (lldb::ScriptLanguage language, ScriptedInterfaceUsages usages)
Protected Attributes inherited from lldb_private::ScriptedInterface
StructuredData::GenericSP m_object_instance_sp
std::optional< ScriptedMetadatam_scripted_metadata

Detailed Description

Definition at line 16 of file ScriptedCommandInterface.h.

Member Function Documentation

◆ CreatePluginObject()

virtual llvm::Expected< StructuredData::GenericSP > lldb_private::ScriptedCommandInterface::CreatePluginObject ( llvm::StringRef class_name,
lldb::DebuggerSP debugger_sp )
pure virtual

◆ GetArgumentsDefinition()

virtual StructuredData::ObjectSP lldb_private::ScriptedCommandInterface::GetArgumentsDefinition ( )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 66 of file ScriptedCommandInterface.h.

◆ GetFlags()

virtual uint32_t lldb_private::ScriptedCommandInterface::GetFlags ( )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 62 of file ScriptedCommandInterface.h.

◆ GetLongHelp()

virtual bool lldb_private::ScriptedCommandInterface::GetLongHelp ( std::string & dest)
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 57 of file ScriptedCommandInterface.h.

◆ GetOptionsDefinition()

virtual StructuredData::ObjectSP lldb_private::ScriptedCommandInterface::GetOptionsDefinition ( )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 64 of file ScriptedCommandInterface.h.

◆ GetRepeatCommand()

virtual std::optional< std::string > lldb_private::ScriptedCommandInterface::GetRepeatCommand ( Args & args)
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 36 of file ScriptedCommandInterface.h.

◆ GetShortHelp()

virtual bool lldb_private::ScriptedCommandInterface::GetShortHelp ( std::string & dest)
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 52 of file ScriptedCommandInterface.h.

◆ HandleArgumentCompletion()

virtual StructuredData::DictionarySP lldb_private::ScriptedCommandInterface::HandleArgumentCompletion ( std::vector< std::string > & args,
size_t args_pos,
size_t char_in_arg )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 41 of file ScriptedCommandInterface.h.

◆ HandleOptionArgumentCompletion()

virtual StructuredData::DictionarySP lldb_private::ScriptedCommandInterface::HandleOptionArgumentCompletion ( llvm::StringRef & long_option,
size_t char_in_arg )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 47 of file ScriptedCommandInterface.h.

◆ OptionParsingStarted()

virtual void lldb_private::ScriptedCommandInterface::OptionParsingStarted ( )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 68 of file ScriptedCommandInterface.h.

◆ RunParsedCommand()

virtual bool lldb_private::ScriptedCommandInterface::RunParsedCommand ( Args & args,
ScriptedCommandSynchronicity synchronicity,
CommandReturnObject & cmd_retobj,
Status & error,
const ExecutionContext & exe_ctx )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 29 of file ScriptedCommandInterface.h.

References error().

◆ RunRawCommand()

virtual bool lldb_private::ScriptedCommandInterface::RunRawCommand ( llvm::StringRef args,
ScriptedCommandSynchronicity synchronicity,
CommandReturnObject & cmd_retobj,
Status & error,
const ExecutionContext & exe_ctx )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 22 of file ScriptedCommandInterface.h.

References error().

◆ SetOptionValue()

virtual bool lldb_private::ScriptedCommandInterface::SetOptionValue ( ExecutionContext * exe_ctx,
llvm::StringRef long_option,
llvm::StringRef value )
inlinevirtual

Reimplemented in lldb_private::ScriptedCommandPythonInterface.

Definition at line 70 of file ScriptedCommandInterface.h.


The documentation for this class was generated from the following file: