lldb_private::ScriptedFrameProviderInterface Class Reference

#include <ScriptedFrameProviderInterface.h>

Inheritance diagram for lldb_private::ScriptedFrameProviderInterface:

Public Member Functions
virtual bool	AppliesToThread (llvm::StringRef class_name, lldb::ThreadSP thread_sp)
virtual llvm::Expected< StructuredData::GenericSP >	CreatePluginObject (llvm::StringRef class_name, lldb::StackFrameListSP input_frames, StructuredData::DictionarySP args_sp)=0
virtual std::string	GetDescription (llvm::StringRef class_name)
	Get a description string for the frame provider.
virtual std::optional< uint32_t >	GetPriority (llvm::StringRef class_name)
	Get the priority of this frame provider.
virtual StructuredData::ObjectSP	GetFrameAtIndex (uint32_t index)
Public Member Functions inherited from lldb_private::ScriptedInterface
	ScriptedInterface ()=default
virtual	~ScriptedInterface ()=default
StructuredData::GenericSP	GetScriptObjectInstance ()
virtual llvm::SmallVector< AbstractMethodRequirement >	GetAbstractMethodRequirements () const =0
virtual llvm::Expected< FileSpec >	GetScriptedModulePath ()
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

Detailed Description

Definition at line 17 of file ScriptedFrameProviderInterface.h.

Member Function Documentation

AppliesToThread()

virtual bool lldb_private::ScriptedFrameProviderInterface::AppliesToThread ( llvm::StringRef class_name, lldb::ThreadSP thread_sp )

inlinevirtual

Definition at line 19 of file ScriptedFrameProviderInterface.h.

CreatePluginObject()

virtual llvm::Expected< StructuredData::GenericSP > lldb_private::ScriptedFrameProviderInterface::CreatePluginObject ( llvm::StringRef class_name, lldb::StackFrameListSP input_frames, StructuredData::DictionarySP args_sp )

pure virtual

GetDescription()

virtual std::string lldb_private::ScriptedFrameProviderInterface::GetDescription ( llvm::StringRef class_name )

inlinevirtual

Get a description string for the frame provider.

This is called by the descriptor to fetch a description from the scripted implementation. Implementations should call a static method on the scripting class to retrieve the description.

Parameters

class_name

The name of the scripting class implementing the provider.

Returns

A string describing what this frame provider does, or an empty string if no description is available.

Definition at line 40 of file ScriptedFrameProviderInterface.h.

GetFrameAtIndex()

virtual StructuredData::ObjectSP lldb_private::ScriptedFrameProviderInterface::GetFrameAtIndex ( uint32_t index )

inlinevirtual

Definition at line 58 of file ScriptedFrameProviderInterface.h.

GetPriority()

virtual std::optional< uint32_t > lldb_private::ScriptedFrameProviderInterface::GetPriority ( llvm::StringRef class_name )

inlinevirtual

Get the priority of this frame provider.

This is called by the descriptor to fetch the priority from the scripted implementation. Implementations should call a static method on the scripting class to retrieve the priority. Lower numbers indicate higher priority (like Unix nice values).

Parameters

class_name

The name of the scripting class implementing the provider.

Returns

Priority value where 0 is highest priority, or std::nullopt for default priority (UINT32_MAX - lowest priority).

Definition at line 54 of file ScriptedFrameProviderInterface.h.

---

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

• ScriptedFrameProviderInterface.h