LLDB mainline
lldb_private::ScriptedHookPythonInterface Class Reference

#include <ScriptedHookPythonInterface.h>

Inheritance diagram for lldb_private::ScriptedHookPythonInterface:
[legend]

Public Member Functions

 ScriptedHookPythonInterface (ScriptInterpreterPythonImpl &interpreter)
llvm::Expected< StructuredData::GenericSPCreatePluginObject (llvm::StringRef class_name, lldb::TargetSP target_sp, const StructuredDataImpl &args_sp) override
llvm::SmallVector< AbstractMethodRequirementGetAbstractMethodRequirements () const override
 A hook class must implement at least one callback.
SupportedHookMethods GetSupportedMethods () override
 Check which of the three hook methods the Python class implements.
void HandleModuleLoaded (lldb::StreamSP &output_sp) override
 Called when modules are loaded into the target.
void HandleModuleUnloaded (lldb::StreamSP &output_sp) override
 Called when modules are unloaded from the target. Optional.
llvm::Expected< boolHandleStop (ExecutionContext &exe_ctx, lldb::StreamSP &output_sp) override
 Called when the process stops.
llvm::StringRef GetPluginName () override
Public Member Functions inherited from lldb_private::ScriptedInterface
 ScriptedInterface ()=default
virtual ~ScriptedInterface ()=default
StructuredData::GenericSP GetScriptObjectInstance ()
llvm::SmallVector< llvm::StringLiteral > const GetAbstractMethods () const
Public Member Functions inherited from lldb_private::ScriptedPythonInterface
 ScriptedPythonInterface (ScriptInterpreterPythonImpl &interpreter)
 ~ScriptedPythonInterface () override=default
llvm::Expected< FileSpecGetScriptedModulePath () override
llvm::Expected< std::map< llvm::StringLiteral, AbstractMethodCheckerPayload > > CheckAbstractMethodImplementation (const python::PythonDictionary &class_dict) const
template<typename... Args>
llvm::Expected< StructuredData::GenericSPCreatePluginObject (llvm::StringRef class_name, StructuredData::Generic *script_obj, Args... args)
template<typename T = StructuredData::ObjectSP, typename... Args>
CallStaticMethod (llvm::StringRef class_name, llvm::StringRef method_name, Status &error, Args &&...args)
 Call a static method on a Python class without creating an instance.
Public Member Functions inherited from lldb_private::PluginInterface
 PluginInterface ()=default
virtual ~PluginInterface ()=default
 PluginInterface (const PluginInterface &)=delete
PluginInterfaceoperator= (const PluginInterface &)=delete

Static Public Member Functions

static void Initialize ()
static void Terminate ()
static llvm::StringRef GetPluginNameStatic ()
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)

Additional Inherited Members

Public Types inherited from lldb_private::ScriptedPythonInterface
enum class  AbstractMethodCheckerCases {
  eNotImplemented , eNotAllocated , eNotCallable , eUnknownArgumentCount ,
  eInvalidArgumentCount , eValid
}
Protected Member Functions inherited from lldb_private::ScriptedPythonInterface
template<typename T = StructuredData::ObjectSP>
ExtractValueFromPythonObject (python::PythonObject &p, Status &error)
template<typename T = StructuredData::ObjectSP, typename... Args>
Dispatch (llvm::StringRef method_name, Status &error, Args &&...args)
template<typename... Args>
Status GetStatusFromMethod (llvm::StringRef method_name, Args &&...args)
template<typename T>
Transform (T object)
python::PythonObject Transform (bool arg)
python::PythonObject Transform (const Status &arg)
python::PythonObject Transform (Status &&arg)
python::PythonObject Transform (const StructuredDataImpl &arg)
python::PythonObject Transform (lldb::ExecutionContextRefSP arg)
python::PythonObject Transform (lldb::TargetSP arg)
python::PythonObject Transform (lldb::BreakpointSP arg)
python::PythonObject Transform (lldb::BreakpointLocationSP arg)
python::PythonObject Transform (lldb::ProcessSP arg)
python::PythonObject Transform (lldb::ThreadSP arg)
python::PythonObject Transform (lldb::StackFrameListSP arg)
python::PythonObject Transform (lldb::ThreadPlanSP arg)
python::PythonObject Transform (lldb::ProcessAttachInfoSP arg)
python::PythonObject Transform (lldb::ProcessLaunchInfoSP arg)
python::PythonObject Transform (Event *arg)
python::PythonObject Transform (const SymbolContext &arg)
python::PythonObject Transform (lldb::StreamSP arg)
python::PythonObject Transform (lldb::StackFrameSP arg)
python::PythonObject Transform (lldb::DataExtractorSP arg)
python::PythonObject Transform (lldb::DescriptionLevel arg)
python::PythonObject Transform (lldb::ValueObjectSP arg)
template<typename T, typename U>
void ReverseTransform (T &original_arg, U transformed_arg, Status &error)
template<typename T>
void ReverseTransform (T &original_arg, python::PythonObject transformed_arg, Status &error)
void ReverseTransform (bool &original_arg, python::PythonObject transformed_arg, Status &error)
template<std::size_t... I, typename... Args>
auto TransformTuple (const std::tuple< Args... > &args, std::index_sequence< I... >)
template<typename... Args>
auto TransformArgs (const std::tuple< Args... > &args)
template<typename T, typename U>
void TransformBack (T &original_arg, U transformed_arg, Status &error)
template<std::size_t... I, typename... Ts, typename... Us>
bool ReassignPtrsOrRefsArgs (std::tuple< Ts... > &original_args, std::tuple< Us... > &transformed_args, std::index_sequence< I... >)
template<typename... Ts, typename... Us>
bool ReassignPtrsOrRefsArgs (std::tuple< Ts... > &original_args, std::tuple< Us... > &transformed_args)
template<typename T, typename... Args>
void FormatArgs (std::string &fmt, T arg, Args... args) const
template<typename T>
void FormatArgs (std::string &fmt, T arg) const
void FormatArgs (std::string &fmt) const
template<>
Status ExtractValueFromPythonObject (python::PythonObject &p, Status &error)
template<>
EventExtractValueFromPythonObject (python::PythonObject &p, Status &error)
template<>
SymbolContext ExtractValueFromPythonObject (python::PythonObject &p, Status &error)
template<>
Status ExtractValueFromPythonObject (python::PythonObject &p, Status &error)
template<>
EventExtractValueFromPythonObject (python::PythonObject &p, Status &error)
template<>
SymbolContext ExtractValueFromPythonObject (python::PythonObject &p, Status &error)
Protected Attributes inherited from lldb_private::ScriptedInterface
StructuredData::GenericSP m_object_instance_sp
Protected Attributes inherited from lldb_private::ScriptedPythonInterface
ScriptInterpreterPythonImplm_interpreter

Detailed Description

Definition at line 17 of file ScriptedHookPythonInterface.h.

Constructor & Destructor Documentation

◆ ScriptedHookPythonInterface()

ScriptedHookPythonInterface::ScriptedHookPythonInterface ( ScriptInterpreterPythonImpl & interpreter)

Member Function Documentation

◆ CreatePluginObject()

llvm::Expected< StructuredData::GenericSP > ScriptedHookPythonInterface::CreatePluginObject ( llvm::StringRef class_name,
lldb::TargetSP target_sp,
const StructuredDataImpl & args_sp )
overridevirtual

◆ GetAbstractMethodRequirements()

llvm::SmallVector< AbstractMethodRequirement > lldb_private::ScriptedHookPythonInterface::GetAbstractMethodRequirements ( ) const
inlineoverridevirtual

A hook class must implement at least one callback.

All three are individually optional; hooks that implement none will be rejected at creation time.

Implements lldb_private::ScriptedInterface.

Definition at line 31 of file ScriptedHookPythonInterface.h.

◆ GetPluginName()

llvm::StringRef lldb_private::ScriptedHookPythonInterface::GetPluginName ( )
inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 50 of file ScriptedHookPythonInterface.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

llvm::StringRef lldb_private::ScriptedHookPythonInterface::GetPluginNameStatic ( )
inlinestatic

Definition at line 46 of file ScriptedHookPythonInterface.h.

Referenced by GetPluginName(), and Initialize().

◆ GetSupportedMethods()

◆ HandleModuleLoaded()

void ScriptedHookPythonInterface::HandleModuleLoaded ( lldb::StreamSP & output_sp)
overridevirtual

Called when modules are loaded into the target.

Reimplemented from lldb_private::ScriptedHookInterface.

Definition at line 61 of file ScriptedHookPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and error().

◆ HandleModuleUnloaded()

void ScriptedHookPythonInterface::HandleModuleUnloaded ( lldb::StreamSP & output_sp)
overridevirtual

Called when modules are unloaded from the target. Optional.

Reimplemented from lldb_private::ScriptedHookInterface.

Definition at line 67 of file ScriptedHookPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and error().

◆ HandleStop()

llvm::Expected< bool > ScriptedHookPythonInterface::HandleStop ( ExecutionContext & exe_ctx,
lldb::StreamSP & output_sp )
overridevirtual

Called when the process stops.

Returns "should_stop" if false, the process will continue. Defaults to true (stop on unimplemented).

Reimplemented from lldb_private::ScriptedHookInterface.

Definition at line 74 of file ScriptedHookPythonInterface.cpp.

References lldb_private::ScriptedInterface::CheckStructuredDataObject(), lldb_private::ScriptedPythonInterface::Dispatch(), and error().

◆ Initialize()

◆ Terminate()


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