LLDB mainline
lldb_private::ScriptedStackFrameRecognizerPythonInterface Class Reference

#include <ScriptedStackFrameRecognizerPythonInterface.h>

Inheritance diagram for lldb_private::ScriptedStackFrameRecognizerPythonInterface:
[legend]

Public Member Functions

 ScriptedStackFrameRecognizerPythonInterface (ScriptInterpreterPythonImpl &interpreter)
llvm::Expected< StructuredData::GenericSPCreatePluginObject (const ScriptedMetadata &scripted_metadata) override
llvm::SmallVector< AbstractMethodRequirementGetAbstractMethodRequirements () const override
lldb::ValueObjectListSP GetRecognizedArguments (lldb::StackFrameSP frame_sp) override
bool ShouldHide (lldb::StackFrameSP frame_sp) override
lldb::StackFrameSP SelectMostRelevantFrame (lldb::StackFrameSP frame_sp) override
lldb::ValueObjectSP GetException (lldb::StackFrameSP frame_sp) override
std::string GetStopDescription (lldb::StackFrameSP frame_sp) override
lldb::ThreadPlanSP GetStepThroughPlan (lldb::ThreadSP thread_sp) override
llvm::StringRef GetPluginName () override
Public Member Functions inherited from lldb_private::ScriptedInterface
 ScriptedInterface ()=default
virtual ~ScriptedInterface ()=default
StructuredData::GenericSP GetScriptObjectInstance ()
const std::optional< ScriptedMetadata > & GetScriptedMetadata () const
virtual bool UserCanRunDirectly () const
 Whether the user can invoke this extension directly, the way a scripted command can.
virtual llvm::SmallVector< llvm::StringLiteral > GetOptionalMethods () const
 Methods a script may legitimately leave out, for which LLDB has a documented answer.
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::PythonObject &obj_class) const
template<typename... Args>
llvm::Expected< StructuredData::GenericSPCreatePluginObject (const ScriptedMetadata &scripted_metadata, StructuredData::Generic *script_obj, Args... args)
template<typename T = StructuredData::ObjectSP, typename... Args>
llvm::Expected< T > CallStaticMethod (llvm::StringRef class_name, llvm::StringRef method_name, 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 user_msg, Status &error, LLDBLog log_category=LLDBLog::Process)
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, typename... Args>
llvm::Expected< std::optional< T > > DispatchToOptional (llvm::StringRef method_name, Args &&...args)
 Call an optional method_name, reporting "the script doesn't implement it" as std::nullopt rather than as a failure.
template<typename T = StructuredData::ObjectSP>
llvm::Expected< T > ExtractValueFromPythonObject (python::PythonObject &p)
template<typename T = StructuredData::ObjectSP, typename... Args>
llvm::Expected< T > Dispatch (llvm::StringRef method_name, Args &&...args)
 Call method_name on the scripted object.
template<typename... Args>
Status GetStatusFromMethod (llvm::StringRef method_name, Args &&...args)
 Call method_name and fold both failure channels into one Status: a failure to call the method at all, and the SBError the method returned.
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)
template<typename T, typename = std::enable_if_t< std::is_base_of_v<StructuredData::Object, T>>>
python::PythonObject Transform (std::shared_ptr< T > 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::StepType arg)
python::PythonObject Transform (lldb::ValueObjectSP arg)
python::PythonObject Transform (lldb::DebuggerSP arg)
python::PythonObject Transform (const std::vector< std::string > &arg)
python::ScopedPythonObject< lldb::SBCommandReturnObjectTransform (CommandReturnObject *arg)
python::PythonObject Transform (const TypeSummaryOptions &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)
template<typename T>
void ReverseTransform (const 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<typename T, typename SB>
void TransformBack (T &original_arg, python::ScopedPythonObject< SB > &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<>
llvm::Expected< StatusExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< Event * > ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< CommandReturnObject * > ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< SymbolContextExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< StatusExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< Event * > ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< SymbolContextExtractValueFromPythonObject (python::PythonObject &p)
Static Protected Member Functions inherited from lldb_private::ScriptedPythonInterface
static std::string ExtractPythonError (llvm::Error error)
 Extract detailed error message including Python backtrace if available.
template<typename... Ts>
static llvm::Error LogAndError (llvm::StringRef caller_name, const char *format, Ts &&...ts)
 Log message against caller_name and return it as an error.
template<typename T>
static T LogAndDefault (llvm::Expected< T > value_or_err, llvm::StringRef caller)
 Log the failure in value_or_err and fall back to a default-constructed T.
template<std::size_t N, typename Tuple, typename Fn, std::size_t... I>
static void ApplyPrefixImpl (Tuple &&t, Fn &&fn, std::index_sequence< I... >)
template<std::size_t N, typename Tuple, typename Fn>
static void ApplyPrefix (Tuple &&t, Fn &&fn)
template<typename Tuple, std::size_t... Is, typename Fn>
static void CallWithArity (size_t call_arity, Tuple &&t, std::index_sequence< Is... >, Fn &&fn)
Protected Attributes inherited from lldb_private::ScriptedInterface
StructuredData::GenericSP m_object_instance_sp
std::optional< ScriptedMetadatam_scripted_metadata
Protected Attributes inherited from lldb_private::ScriptedPythonInterface
ScriptInterpreterPythonImplm_interpreter

Detailed Description

Constructor & Destructor Documentation

◆ ScriptedStackFrameRecognizerPythonInterface()

ScriptedStackFrameRecognizerPythonInterface::ScriptedStackFrameRecognizerPythonInterface ( ScriptInterpreterPythonImpl & interpreter)

Member Function Documentation

◆ CreatePluginObject()

llvm::Expected< StructuredData::GenericSP > ScriptedStackFrameRecognizerPythonInterface::CreatePluginObject ( const ScriptedMetadata & scripted_metadata)
overridevirtual

◆ GetAbstractMethodRequirements()

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

◆ GetException()

◆ GetPluginName()

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

◆ GetPluginNameStatic()

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

Definition at line 51 of file ScriptedStackFrameRecognizerPythonInterface.h.

Referenced by GetPluginName(), and Initialize().

◆ GetRecognizedArguments()

lldb::ValueObjectListSP ScriptedStackFrameRecognizerPythonInterface::GetRecognizedArguments ( lldb::StackFrameSP frame_sp)
overridevirtual

◆ GetStepThroughPlan()

lldb::ThreadPlanSP ScriptedStackFrameRecognizerPythonInterface::GetStepThroughPlan ( lldb::ThreadSP thread_sp)
overridevirtual

◆ GetStopDescription()

std::string ScriptedStackFrameRecognizerPythonInterface::GetStopDescription ( lldb::StackFrameSP frame_sp)
overridevirtual

◆ Initialize()

◆ SelectMostRelevantFrame()

lldb::StackFrameSP ScriptedStackFrameRecognizerPythonInterface::SelectMostRelevantFrame ( lldb::StackFrameSP frame_sp)
overridevirtual

◆ ShouldHide()

bool ScriptedStackFrameRecognizerPythonInterface::ShouldHide ( lldb::StackFrameSP frame_sp)
overridevirtual

◆ Terminate()


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