ScriptedFrame#

class lldb.plugins.scripted_process.ScriptedFrame(thread: ScriptedThread | SBThread, args: SBStructuredData)#

The base class for a scripted frame.

Most of the base class methods are @abstractmethod that need to be overwritten by the inheriting class.

Methods Summary

`get_display_function_name`()	Get the scripted frame display function name.
`get_function_name`()	Get the scripted frame function name.
`get_id`()	Get the scripted frame identifier.
`get_pc`()	Get the scripted frame address.
`get_register_context`()	Get the scripted thread register context
`get_register_info`()	Get the register info dictionary describing the scripted frame's registers.
`get_symbol_context`()	Get the scripted frame symbol context.
`get_variables`(filters)	Get the scripted thread state type.
`is_artificial`()	Check if the scripted frame is artificial.
`is_hidden`()	Check if the scripted frame is hidden.
`is_inlined`()	Check if the scripted frame is inlined.

Methods Documentation

get_display_function_name() → str#

Get the scripted frame display function name.

Returns:: The display function name of the scripted frame.
Return type:: str

get_function_name() → str#

Get the scripted frame function name.

Returns:: The function name of the scripted frame.
Return type:: str

abstract get_id() → int#

Get the scripted frame identifier.

Returns:: The identifier of the scripted frame in the scripted thread.
Return type:: int

get_pc() → int | None#

Get the scripted frame address.

Returns:: The optional address of the scripted frame in the scripted thread.
Return type:: int

abstract get_register_context() → str#

Get the scripted thread register context

Returns:: A byte representing all register’s value.
Return type:: str

get_register_info() → dict[str, Any]#

Get the register info dictionary describing the scripted frame’s registers. Delegates to the originating scripted thread when there is one; otherwise lazily populates a per-architecture general-purpose register layout keyed off self.arch.

Returns:: The register info dictionary with sets and registers keys. sets is a list of register set names and registers is a list of register descriptions.
Return type:: Dict
Raises:: ValueError – If self.arch is not one of the architectures the base class ships a register layout for.

get_symbol_context() → SBSymbolContext | None#

Get the scripted frame symbol context.

Returns:: The symbol context of the scripted frame in the scripted thread.
Return type:: lldb.SBSymbolContext

get_variables(filters: SBVariablesOptions) → SBValueList | None#

Get the scripted thread state type.

Parameters:

filter (lldb.SBVariablesOptions) – The filter used to resolve the variables

Returns:

The SBValueList containing the SBValue for each resolved variable.: Returns None by default.

Return type:

lldb.SBValueList

is_artificial() → bool#

Check if the scripted frame is artificial.

Returns:: True if scripted frame is artificial. False otherwise.
Return type:: bool

is_hidden() → bool#

Check if the scripted frame is hidden.

Returns:: True if scripted frame is hidden. False otherwise.
Return type:: bool

is_inlined() → bool#

Check if the scripted frame is inlined.

Returns:: True if scripted frame is inlined. False otherwise.
Return type:: bool