lldb_private::ScriptInterpreter Class Reference

#include <ScriptInterpreter.h>

Inheritance diagram for lldb_private::ScriptInterpreter:

Classes
struct	ExtensionTemplateRequest
	Describes one extension to emit into the generated template file. More...
class	SanitizedScriptingModuleName
	Holds an lldb_private::Module name and a "sanitized" version of it for the purposes of loading a script of that name by the relevant ScriptInterpreter. More...

Public Types

enum

ScriptReturnType {   eScriptReturnTypeCharPtr , eScriptReturnTypeBool , eScriptReturnTypeShortInt , eScriptReturnTypeShortIntUnsigned ,   eScriptReturnTypeInt , eScriptReturnTypeIntUnsigned , eScriptReturnTypeLongInt , eScriptReturnTypeLongIntUnsigned ,   eScriptReturnTypeLongLong , eScriptReturnTypeLongLongUnsigned , eScriptReturnTypeFloat , eScriptReturnTypeDouble ,   eScriptReturnTypeChar , eScriptReturnTypeCharStrOrNone , eScriptReturnTypeOpaqueObject }

Public Member Functions
	ScriptInterpreter (Debugger &debugger, lldb::ScriptLanguage script_lang)
virtual StructuredData::DictionarySP	GetInterpreterInfo ()
virtual llvm::Expected< FileSpec >	GenerateExtensionTemplate (const std::string &name, std::vector< ExtensionTemplateRequest > &extensions, bool generate_non_abstract_methods, std::string output_file)
	~ScriptInterpreter () override=default
virtual bool	Interrupt ()
virtual bool	ExecuteOneLine (llvm::StringRef command, CommandReturnObject *result, const ExecuteScriptOptions &options=ExecuteScriptOptions())=0
virtual void	ExecuteInterpreterLoop ()=0
virtual bool	ExecuteOneLineWithReturn (llvm::StringRef in_string, ScriptReturnType return_type, void *ret_value, const ExecuteScriptOptions &options=ExecuteScriptOptions())
virtual Status	ExecuteMultipleLines (const char *in_string, const ExecuteScriptOptions &options=ExecuteScriptOptions())
virtual Status	ExportFunctionDefinitionToInterpreter (StringList &function_def)
virtual Status	GenerateBreakpointCommandCallbackData (StringList &input, std::string &output, bool has_extra_args, bool is_callback)
virtual bool	GenerateWatchpointCommandCallbackData (StringList &input, std::string &output, bool is_callback)
virtual bool	GenerateTypeScriptFunction (const char *oneliner, std::string &output, const void *name_token=nullptr)
virtual bool	GenerateTypeScriptFunction (StringList &input, std::string &output, const void *name_token=nullptr)
virtual bool	GenerateScriptAliasFunction (StringList &input, std::string &output)
virtual bool	GenerateTypeSynthClass (StringList &input, std::string &output, const void *name_token=nullptr)
virtual bool	GenerateTypeSynthClass (const char *oneliner, std::string &output, const void *name_token=nullptr)
virtual StructuredData::ObjectSP	LoadPluginModule (const FileSpec &file_spec, lldb_private::Status &error)
virtual StructuredData::DictionarySP	GetDynamicSettings (StructuredData::ObjectSP plugin_module_sp, Target *target, const char *setting_name, lldb_private::Status &error)
virtual Status	GenerateFunction (const char *signature, const StringList &input, bool is_callback)
virtual void	CollectDataForBreakpointCommandCallback (std::vector< std::reference_wrapper< BreakpointOptions > > &options, CommandReturnObject &result)
virtual void	CollectDataForWatchpointCommandCallback (WatchpointOptions *wp_options, CommandReturnObject &result)
Status	SetBreakpointCommandCallback (std::vector< std::reference_wrapper< BreakpointOptions > > &bp_options_vec, const char *callback_text)
	Set the specified text as the callback for the breakpoint.
virtual Status	SetBreakpointCommandCallback (BreakpointOptions &bp_options, const char *callback_text, bool is_callback)
virtual Status	SetBreakpointCommandCallback (BreakpointOptions &bp_options, std::unique_ptr< BreakpointOptions::CommandData > &data_up)
	This one is for deserialization:
Status	SetBreakpointCommandCallbackFunction (std::vector< std::reference_wrapper< BreakpointOptions > > &bp_options_vec, const char *function_name, StructuredData::ObjectSP extra_args_sp)
virtual Status	SetBreakpointCommandCallbackFunction (BreakpointOptions &bp_options, const char *function_name, StructuredData::ObjectSP extra_args_sp)
	Set a script function as the callback for the breakpoint.
virtual void	SetWatchpointCommandCallback (WatchpointOptions *wp_options, const char *user_input, bool is_callback)
	Set a one-liner as the callback for the watchpoint.
virtual bool	GetScriptedSummary (const char *function_name, lldb::ValueObjectSP valobj, StructuredData::ObjectSP &callee_wrapper_sp, const TypeSummaryOptions &options, std::string &retval)
virtual bool	FormatterCallbackFunction (const char *function_name, lldb::TypeImplSP type_impl_sp)
virtual void	Clear ()
virtual bool	RunScriptBasedCommand (const char *impl_function, llvm::StringRef args, ScriptedCommandSynchronicity synchronicity, lldb_private::CommandReturnObject &cmd_retobj, Status &error, const lldb_private::ExecutionContext &exe_ctx)
virtual bool	RunScriptFormatKeyword (const char *impl_function, Process *process, std::string &output, Status &error)
virtual bool	RunScriptFormatKeyword (const char *impl_function, Thread *thread, std::string &output, Status &error)
virtual bool	RunScriptFormatKeyword (const char *impl_function, Target *target, std::string &output, Status &error)
virtual bool	RunScriptFormatKeyword (const char *impl_function, StackFrame *frame, std::string &output, Status &error)
virtual bool	RunScriptFormatKeyword (const char *impl_function, ValueObject *value, std::string &output, Status &error)
virtual bool	GetDocumentationForItem (const char *item, std::string &dest)
virtual bool	CheckObjectExists (const char *name)
virtual bool	LoadScriptingModule (const char *filename, const LoadScriptOptions &options, lldb_private::Status &error, StructuredData::ObjectSP *module_sp=nullptr, FileSpec extra_search_dir={}, lldb::TargetSP loaded_into_target_sp={})
virtual bool	IsReservedWord (const char *word)
virtual std::unique_ptr< ScriptInterpreterLocker >	AcquireInterpreterLock ()
const char *	GetScriptInterpreterPtyName ()
virtual llvm::Expected< unsigned >	GetMaxPositionalArgumentsForCallable (const llvm::StringRef &callable_name)
virtual llvm::Expected< std::string >	ExtensionToImportPath (lldb::ScriptedExtension extension)
lldb::ScriptLanguage	GetLanguage ()
virtual lldb::ScriptedProcessInterfaceUP	CreateScriptedProcessInterface ()
virtual lldb::ScriptedThreadInterfaceSP	CreateScriptedThreadInterface ()
virtual lldb::ScriptedFrameInterfaceSP	CreateScriptedFrameInterface ()
virtual lldb::ScriptedFrameProviderInterfaceSP	CreateScriptedFrameProviderInterface ()
virtual lldb::ScriptedThreadPlanInterfaceSP	CreateScriptedThreadPlanInterface ()
virtual lldb::OperatingSystemInterfaceSP	CreateOperatingSystemInterface ()
virtual lldb::ScriptedPlatformInterfaceUP	GetScriptedPlatformInterface ()
virtual lldb::ScriptedHookInterfaceSP	CreateScriptedHookInterface ()
virtual lldb::ScriptedBreakpointInterfaceSP	CreateScriptedBreakpointInterface ()
virtual lldb::ScriptedStackFrameRecognizerInterfaceSP	CreateScriptedStackFrameRecognizerInterface ()
virtual lldb::ScriptedCommandInterfaceSP	CreateScriptedCommandInterface ()
virtual lldb::ScriptedStringSummaryInterfaceSP	CreateScriptedStringSummaryInterface ()
virtual lldb::ScriptedSyntheticChildrenInterfaceSP	CreateScriptedSyntheticChildrenInterface ()
virtual StructuredData::ObjectSP	CreateStructuredDataFromScriptObject (ScriptObject obj)
virtual SanitizedScriptingModuleName	GetSanitizedScriptingModuleName (llvm::StringRef name)
lldb::DataExtractorSP	GetDataExtractorFromSBData (const lldb::SBData &data) const
Status	GetStatusFromSBError (const lldb::SBError &error) const
Event *	GetOpaqueTypeFromSBEvent (const lldb::SBEvent &event) const
lldb::StreamSP	GetOpaqueTypeFromSBStream (const lldb::SBStream &stream) const
lldb::ThreadSP	GetOpaqueTypeFromSBThread (const lldb::SBThread &exe_ctx) const
lldb::StackFrameSP	GetOpaqueTypeFromSBFrame (const lldb::SBFrame &frame) const
SymbolContext	GetOpaqueTypeFromSBSymbolContext (const lldb::SBSymbolContext &sym_ctx) const
lldb::BreakpointSP	GetOpaqueTypeFromSBBreakpoint (const lldb::SBBreakpoint &breakpoint) const
lldb::BreakpointLocationSP	GetOpaqueTypeFromSBBreakpointLocation (const lldb::SBBreakpointLocation &break_loc) const
CommandReturnObject *	GetOpaqueTypeFromSBCommandReturnObject (const lldb::SBCommandReturnObject &cmd_retobj) const
lldb::DebuggerSP	GetOpaqueTypeFromSBDebugger (const lldb::SBDebugger &debugger) const
lldb::ProcessAttachInfoSP	GetOpaqueTypeFromSBAttachInfo (const lldb::SBAttachInfo &attach_info) const
lldb::ProcessLaunchInfoSP	GetOpaqueTypeFromSBLaunchInfo (const lldb::SBLaunchInfo &launch_info) const
std::optional< MemoryRegionInfo >	GetOpaqueTypeFromSBMemoryRegionInfo (const lldb::SBMemoryRegionInfo &mem_region) const
lldb::ExecutionContextRefSP	GetOpaqueTypeFromSBExecutionContext (const lldb::SBExecutionContext &exe_ctx) const
lldb::StackFrameListSP	GetOpaqueTypeFromSBFrameList (const lldb::SBFrameList &exe_ctx) const
lldb::ValueObjectSP	GetOpaqueTypeFromSBValue (const lldb::SBValue &value) const
lldb::TargetSP	GetOpaqueTypeFromSBTarget (const lldb::SBTarget &target) const
Debugger &	GetDebugger ()
	Get the debugger associated with this script interpreter.
const Debugger &	GetDebugger () const
Public Member Functions inherited from lldb_private::PluginInterface
	PluginInterface ()=default
virtual	~PluginInterface ()=default
virtual llvm::StringRef	GetPluginName ()=0
	PluginInterface (const PluginInterface &)=delete
PluginInterface &	operator= (const PluginInterface &)=delete

Static Public Member Functions
static std::string	LanguageToString (lldb::ScriptLanguage language)
static lldb::ScriptLanguage	StringToLanguage (const llvm::StringRef &string)
static llvm::StringLiteral	ExtensionToString (lldb::ScriptedExtension extension)
static lldb::ScriptedExtension	StringToExtension (llvm::StringRef string)

Protected Attributes
Debugger &	m_debugger
lldb::ScriptLanguage	m_script_lang

Detailed Description

Definition at line 152 of file ScriptInterpreter.h.

Member Enumeration Documentation

ScriptReturnType

enum lldb_private::ScriptInterpreter::ScriptReturnType

Enumerator
eScriptReturnTypeCharPtr
eScriptReturnTypeBool
eScriptReturnTypeShortInt
eScriptReturnTypeShortIntUnsigned
eScriptReturnTypeInt
eScriptReturnTypeIntUnsigned
eScriptReturnTypeLongInt
eScriptReturnTypeLongIntUnsigned
eScriptReturnTypeLongLong
eScriptReturnTypeLongLongUnsigned
eScriptReturnTypeFloat
eScriptReturnTypeDouble
eScriptReturnTypeChar
eScriptReturnTypeCharStrOrNone
eScriptReturnTypeOpaqueObject

Definition at line 154 of file ScriptInterpreter.h.

Constructor & Destructor Documentation

ScriptInterpreter()

ScriptInterpreter::ScriptInterpreter	(	Debugger &	debugger,
		lldb::ScriptLanguage	script_lang )

Definition at line 34 of file ScriptInterpreter.cpp.

References m_debugger, and m_script_lang.

Referenced by lldb_private::ScriptInterpreterLua::ScriptInterpreterLua(), lldb_private::ScriptInterpreterNone::ScriptInterpreterNone(), and lldb_private::ScriptInterpreterPython::ScriptInterpreterPython().

~ScriptInterpreter()

lldb_private::ScriptInterpreter::~ScriptInterpreter ( )

overridedefault

Member Function Documentation

AcquireInterpreterLock()

std::unique_ptr< ScriptInterpreterLocker > ScriptInterpreter::AcquireInterpreterLock ( )

virtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 299 of file ScriptInterpreter.cpp.

CheckObjectExists()

virtual bool lldb_private::ScriptInterpreter::CheckObjectExists ( const char * name )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 389 of file ScriptInterpreter.h.

Referenced by CommandObjectFrameRecognizerAdd::DoExecute(), and CommandObjectTypeFilterAdd::CommandOptions::OptionParsingStarting().

Clear()

virtual void lldb_private::ScriptInterpreter::Clear ( )

inlinevirtual

Definition at line 338 of file ScriptInterpreter.h.

CollectDataForBreakpointCommandCallback()

void ScriptInterpreter::CollectDataForBreakpointCommandCallback ( std::vector< std::reference_wrapper< BreakpointOptions > > & options, CommandReturnObject & result )

virtual

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPythonImpl.

Definition at line 38 of file ScriptInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendError().

CollectDataForWatchpointCommandCallback()

void ScriptInterpreter::CollectDataForWatchpointCommandCallback ( WatchpointOptions * wp_options, CommandReturnObject & result )

virtual

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPythonImpl.

Definition at line 45 of file ScriptInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendError().

CreateOperatingSystemInterface()

virtual lldb::OperatingSystemInterfaceSP lldb_private::ScriptInterpreter::CreateOperatingSystemInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 448 of file ScriptInterpreter.h.

CreateScriptedBreakpointInterface()

virtual lldb::ScriptedBreakpointInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedBreakpointInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 461 of file ScriptInterpreter.h.

Referenced by lldb_private::BreakpointResolverScripted::CreateImplementationIfNeeded().

CreateScriptedCommandInterface()

virtual lldb::ScriptedCommandInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedCommandInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 470 of file ScriptInterpreter.h.

Referenced by CommandObjectCommandsScriptAdd::DoExecute().

CreateScriptedFrameInterface()

virtual lldb::ScriptedFrameInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedFrameInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 434 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedFrame::Create().

CreateScriptedFrameProviderInterface()

virtual lldb::ScriptedFrameProviderInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedFrameProviderInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 439 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedFrameProvider::CreateInstance(), and CommandObjectTargetFrameProviderRegister::DoExecute().

CreateScriptedHookInterface()

virtual lldb::ScriptedHookInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedHookInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 456 of file ScriptInterpreter.h.

Referenced by lldb_private::Target::HookScripted::SetScriptCallback(), and lldb_private::Target::StopHookScripted::SetScriptCallback().

CreateScriptedProcessInterface()

virtual lldb::ScriptedProcessInterfaceUP lldb_private::ScriptInterpreter::CreateScriptedProcessInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 426 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedProcess::ScriptedProcess().

CreateScriptedStackFrameRecognizerInterface()

virtual lldb::ScriptedStackFrameRecognizerInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedStackFrameRecognizerInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 466 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedStackFrameRecognizer::ScriptedStackFrameRecognizer().

CreateScriptedStringSummaryInterface()

virtual lldb::ScriptedStringSummaryInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedStringSummaryInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 475 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedSummaryFormat::FormatObject().

CreateScriptedSyntheticChildrenInterface()

virtual lldb::ScriptedSyntheticChildrenInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedSyntheticChildrenInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 480 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedSyntheticChildren::FrontEnd::FrontEnd().

CreateScriptedThreadInterface()

virtual lldb::ScriptedThreadInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedThreadInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 430 of file ScriptInterpreter.h.

CreateScriptedThreadPlanInterface()

virtual lldb::ScriptedThreadPlanInterfaceSP lldb_private::ScriptInterpreter::CreateScriptedThreadPlanInterface ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 444 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptedThreadPlan::ScriptedThreadPlan().

CreateStructuredDataFromScriptObject()

virtual StructuredData::ObjectSP lldb_private::ScriptInterpreter::CreateStructuredDataFromScriptObject ( ScriptObject obj )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 485 of file ScriptInterpreter.h.

Referenced by lldb::SBStructuredData::SBStructuredData().

ExecuteInterpreterLoop()

virtual void lldb_private::ScriptInterpreter::ExecuteInterpreterLoop ( )

pure virtual

Implemented in lldb_private::ScriptInterpreterLua, lldb_private::ScriptInterpreterNone, and lldb_private::ScriptInterpreterPythonImpl.

Referenced by CommandObjectScriptingRun::DoExecute().

ExecuteMultipleLines()

virtual Status lldb_private::ScriptInterpreter::ExecuteMultipleLines ( const char * in_string, const ExecuteScriptOptions & options = ExecuteScriptOptions() )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 211 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

ExecuteOneLine()

virtual bool lldb_private::ScriptInterpreter::ExecuteOneLine ( llvm::StringRef command, CommandReturnObject * result, const ExecuteScriptOptions & options = ExecuteScriptOptions() )

pure virtual

Implemented in lldb_private::ScriptInterpreterLua, lldb_private::ScriptInterpreterNone, and lldb_private::ScriptInterpreterPythonImpl.

Referenced by CommandObjectScriptingRun::DoExecute().

ExecuteOneLineWithReturn()

virtual bool lldb_private::ScriptInterpreter::ExecuteOneLineWithReturn ( llvm::StringRef in_string, ScriptReturnType return_type, void * ret_value, const ExecuteScriptOptions & options = ExecuteScriptOptions() )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 205 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptInterpreterPython::GetExtensionSchema().

ExportFunctionDefinitionToInterpreter()

virtual Status lldb_private::ScriptInterpreter::ExportFunctionDefinitionToInterpreter ( StringList & function_def )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 218 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

ExtensionToImportPath()

virtual llvm::Expected< std::string > lldb_private::ScriptInterpreter::ExtensionToImportPath ( lldb::ScriptedExtension extension )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPython.

Definition at line 415 of file ScriptInterpreter.h.

ExtensionToString()

llvm::StringLiteral ScriptInterpreter::ExtensionToString ( lldb::ScriptedExtension extension )

static

Definition at line 211 of file ScriptInterpreter.cpp.

References lldb::eScriptedExtensionInvalid, lldb::eScriptedExtensionOperatingSystem, lldb::eScriptedExtensionParsedCommand, lldb::eScriptedExtensionScriptedBreakpointResolver, lldb::eScriptedExtensionScriptedCommand, lldb::eScriptedExtensionScriptedFrame, lldb::eScriptedExtensionScriptedFrameProvider, lldb::eScriptedExtensionScriptedHook, lldb::eScriptedExtensionScriptedPlatform, lldb::eScriptedExtensionScriptedProcess, lldb::eScriptedExtensionScriptedStackFrameRecognizer, lldb::eScriptedExtensionScriptedStringSummary, lldb::eScriptedExtensionScriptedSyntheticChildren, lldb::eScriptedExtensionScriptedThread, and lldb::eScriptedExtensionScriptedThreadPlan.

Referenced by lldb_private::PluginManager::AutoCompleteScriptedExtension(), CommandObjectScriptingExtensionList::DoExecute(), and lldb_private::ScriptInterpreterPython::GetExtensionSchema().

FormatterCallbackFunction()

virtual bool lldb_private::ScriptInterpreter::FormatterCallbackFunction ( const char * function_name, lldb::TypeImplSP type_impl_sp )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 333 of file ScriptInterpreter.h.

Referenced by lldb_private::TypeMatcher::Matches().

GenerateBreakpointCommandCallbackData()

virtual Status lldb_private::ScriptInterpreter::GenerateBreakpointCommandCallbackData ( StringList & input, std::string & output, bool has_extra_args, bool is_callback )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 222 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

GenerateExtensionTemplate()

llvm::Expected< FileSpec > ScriptInterpreter::GenerateExtensionTemplate ( const std::string & name, std::vector< ExtensionTemplateRequest > & extensions, bool generate_non_abstract_methods, std::string output_file )

virtual

Reimplemented in lldb_private::ScriptInterpreterPython.

Definition at line 55 of file ScriptInterpreter.cpp.

Referenced by CommandObjectScriptingExtensionGenerate::DoExecute().

GenerateFunction()

virtual Status lldb_private::ScriptInterpreter::GenerateFunction ( const char * signature, const StringList & input, bool is_callback )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 273 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

GenerateScriptAliasFunction()

virtual bool lldb_private::ScriptInterpreter::GenerateScriptAliasFunction ( StringList & input, std::string & output )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 247 of file ScriptInterpreter.h.

Referenced by CommandObjectCommandsScriptAdd::IOHandlerInputComplete().

GenerateTypeScriptFunction() [1/2]

virtual bool lldb_private::ScriptInterpreter::GenerateTypeScriptFunction ( const char * oneliner, std::string & output, const void * name_token = nullptr )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 235 of file ScriptInterpreter.h.

Referenced by lldb::SBTypeCategory::AddTypeSummary(), and CommandObjectTypeSummaryAdd::IOHandlerInputComplete().

GenerateTypeScriptFunction() [2/2]

virtual bool lldb_private::ScriptInterpreter::GenerateTypeScriptFunction ( StringList & input, std::string & output, const void * name_token = nullptr )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 241 of file ScriptInterpreter.h.

GenerateTypeSynthClass() [1/2]

virtual bool lldb_private::ScriptInterpreter::GenerateTypeSynthClass ( const char * oneliner, std::string & output, const void * name_token = nullptr )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 257 of file ScriptInterpreter.h.

GenerateTypeSynthClass() [2/2]

virtual bool lldb_private::ScriptInterpreter::GenerateTypeSynthClass ( StringList & input, std::string & output, const void * name_token = nullptr )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 252 of file ScriptInterpreter.h.

Referenced by lldb::SBTypeCategory::AddTypeSynthetic(), and CommandObjectTypeSynthAdd::IOHandlerInputComplete().

GenerateWatchpointCommandCallbackData()

virtual bool lldb_private::ScriptInterpreter::GenerateWatchpointCommandCallbackData ( StringList & input, std::string & output, bool is_callback )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 229 of file ScriptInterpreter.h.

GetDataExtractorFromSBData()

lldb::DataExtractorSP ScriptInterpreter::GetDataExtractorFromSBData

(

const lldb::SBData &

data

)

const

Definition at line 85 of file ScriptInterpreter.cpp.

References lldb::SBData::m_opaque_sp.

GetDebugger() [1/2]

Debugger & lldb_private::ScriptInterpreter::GetDebugger ( )

inline

Get the debugger associated with this script interpreter.

Definition at line 583 of file ScriptInterpreter.h.

References m_debugger.

Referenced by lldb_private::ScriptedSyntheticChildren::FrontEnd::FrontEnd(), and lldb_private::ScriptedStackFrameRecognizer::ScriptedStackFrameRecognizer().

GetDebugger() [2/2]

const Debugger & lldb_private::ScriptInterpreter::GetDebugger ( ) const

inline

Definition at line 584 of file ScriptInterpreter.h.

References m_debugger.

GetDocumentationForItem()

virtual bool lldb_private::ScriptInterpreter::GetDocumentationForItem ( const char * item, std::string & dest )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 384 of file ScriptInterpreter.h.

Referenced by CommandObjectPythonFunction::GetHelpLong().

GetDynamicSettings()

virtual StructuredData::DictionarySP lldb_private::ScriptInterpreter::GetDynamicSettings ( StructuredData::ObjectSP plugin_module_sp, Target * target, const char * setting_name, lldb_private::Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 268 of file ScriptInterpreter.h.

References error().

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::ParsePythonTargetDefinition().

GetInterpreterInfo()

StructuredData::DictionarySP ScriptInterpreter::GetInterpreterInfo ( )

virtual

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPython.

Definition at line 51 of file ScriptInterpreter.cpp.

Referenced by lldb::SBDebugger::GetScriptInterpreterInfo().

GetLanguage()

lldb::ScriptLanguage lldb_private::ScriptInterpreter::GetLanguage ( )

inline

Definition at line 424 of file ScriptInterpreter.h.

References m_script_lang.

Referenced by lldb_private::BreakpointOptions::CreateFromStructuredData().

GetMaxPositionalArgumentsForCallable()

virtual llvm::Expected< unsigned > lldb_private::ScriptInterpreter::GetMaxPositionalArgumentsForCallable ( const llvm::StringRef & callable_name )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 405 of file ScriptInterpreter.h.

GetOpaqueTypeFromSBAttachInfo()

lldb::ProcessAttachInfoSP ScriptInterpreter::GetOpaqueTypeFromSBAttachInfo

(

const lldb::SBAttachInfo &

attach_info

)

const

Definition at line 110 of file ScriptInterpreter.cpp.

References lldb::SBAttachInfo::m_opaque_sp.

GetOpaqueTypeFromSBBreakpoint()

lldb::BreakpointSP ScriptInterpreter::GetOpaqueTypeFromSBBreakpoint

(

const lldb::SBBreakpoint &

breakpoint

)

const

Definition at line 89 of file ScriptInterpreter.cpp.

References lldb::SBBreakpoint::m_opaque_wp.

GetOpaqueTypeFromSBBreakpointLocation()

lldb::BreakpointLocationSP ScriptInterpreter::GetOpaqueTypeFromSBBreakpointLocation

(

const lldb::SBBreakpointLocation &

break_loc

)

const

Definition at line 95 of file ScriptInterpreter.cpp.

References lldb::SBBreakpointLocation::m_opaque_wp.

GetOpaqueTypeFromSBCommandReturnObject()

CommandReturnObject * ScriptInterpreter::GetOpaqueTypeFromSBCommandReturnObject

(

const lldb::SBCommandReturnObject &

cmd_retobj

)

const

Definition at line 100 of file ScriptInterpreter.cpp.

References lldb::SBCommandReturnObject::m_opaque_up.

GetOpaqueTypeFromSBDebugger()

lldb::DebuggerSP ScriptInterpreter::GetOpaqueTypeFromSBDebugger

(

const lldb::SBDebugger &

debugger

)

const

Definition at line 105 of file ScriptInterpreter.cpp.

References lldb::SBDebugger::m_opaque_sp.

GetOpaqueTypeFromSBEvent()

Event * ScriptInterpreter::GetOpaqueTypeFromSBEvent

(

const lldb::SBEvent &

event

)

const

Definition at line 144 of file ScriptInterpreter.cpp.

GetOpaqueTypeFromSBExecutionContext()

lldb::ExecutionContextRefSP ScriptInterpreter::GetOpaqueTypeFromSBExecutionContext

(

const lldb::SBExecutionContext &

exe_ctx

)

const

Definition at line 175 of file ScriptInterpreter.cpp.

References lldb::SBExecutionContext::m_exe_ctx_sp.

GetOpaqueTypeFromSBFrame()

lldb::StackFrameSP ScriptInterpreter::GetOpaqueTypeFromSBFrame

(

const lldb::SBFrame &

frame

)

const

Definition at line 137 of file ScriptInterpreter.cpp.

References lldb::SBFrame::m_opaque_sp.

GetOpaqueTypeFromSBFrameList()

lldb::StackFrameListSP ScriptInterpreter::GetOpaqueTypeFromSBFrameList

(

const lldb::SBFrameList &

exe_ctx

)

const

Definition at line 180 of file ScriptInterpreter.cpp.

References lldb::SBFrameList::m_opaque_sp.

GetOpaqueTypeFromSBLaunchInfo()

lldb::ProcessLaunchInfoSP ScriptInterpreter::GetOpaqueTypeFromSBLaunchInfo

(

const lldb::SBLaunchInfo &

launch_info

)

const

Definition at line 115 of file ScriptInterpreter.cpp.

References lldb::SBLaunchInfo::m_opaque_sp.

GetOpaqueTypeFromSBMemoryRegionInfo()

std::optional< lldb_private::MemoryRegionInfo > ScriptInterpreter::GetOpaqueTypeFromSBMemoryRegionInfo

(

const lldb::SBMemoryRegionInfo &

mem_region

)

const

Definition at line 167 of file ScriptInterpreter.cpp.

References lldb::SBMemoryRegionInfo::m_opaque_up.

GetOpaqueTypeFromSBStream()

lldb::StreamSP ScriptInterpreter::GetOpaqueTypeFromSBStream

(

const lldb::SBStream &

stream

)

const

Definition at line 148 of file ScriptInterpreter.cpp.

References lldb::SBStream::m_opaque_up.

GetOpaqueTypeFromSBSymbolContext()

SymbolContext ScriptInterpreter::GetOpaqueTypeFromSBSymbolContext

(

const lldb::SBSymbolContext &

sym_ctx

)

const

Definition at line 159 of file ScriptInterpreter.cpp.

References lldb::SBSymbolContext::m_opaque_up.

GetOpaqueTypeFromSBTarget()

lldb::TargetSP ScriptInterpreter::GetOpaqueTypeFromSBTarget

(

const lldb::SBTarget &

target

)

const

Definition at line 185 of file ScriptInterpreter.cpp.

References lldb::SBTarget::m_opaque_sp.

GetOpaqueTypeFromSBThread()

lldb::ThreadSP ScriptInterpreter::GetOpaqueTypeFromSBThread

(

const lldb::SBThread &

exe_ctx

)

const

Definition at line 129 of file ScriptInterpreter.cpp.

GetOpaqueTypeFromSBValue()

lldb::ValueObjectSP ScriptInterpreter::GetOpaqueTypeFromSBValue

(

const lldb::SBValue &

value

)

const

Definition at line 191 of file ScriptInterpreter.cpp.

References lldb_private::ValueLocker::GetLockedSP(), and lldb::SBValue::m_opaque_sp.

GetSanitizedScriptingModuleName()

ScriptInterpreter::SanitizedScriptingModuleName ScriptInterpreter::GetSanitizedScriptingModuleName ( llvm::StringRef name )

virtual

Definition at line 304 of file ScriptInterpreter.cpp.

References IsReservedWord().

Referenced by lldb_private::PlatformDarwin::LocateExecutableScriptingResourcesFromDSYM(), and lldb_private::Platform::LocateExecutableScriptingResourcesFromSafePaths().

GetScriptedPlatformInterface()

virtual lldb::ScriptedPlatformInterfaceUP lldb_private::ScriptInterpreter::GetScriptedPlatformInterface ( )

inlinevirtual

Definition at line 452 of file ScriptInterpreter.h.

GetScriptedSummary()

virtual bool lldb_private::ScriptInterpreter::GetScriptedSummary ( const char * function_name, lldb::ValueObjectSP valobj, StructuredData::ObjectSP & callee_wrapper_sp, const TypeSummaryOptions & options, std::string & retval )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 322 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptSummaryFormat::FormatObject().

GetScriptInterpreterPtyName()

const char * lldb_private::ScriptInterpreter::GetScriptInterpreterPtyName

(

)

GetStatusFromSBError()

Status ScriptInterpreter::GetStatusFromSBError

(

const lldb::SBError &

error

)

const

Definition at line 122 of file ScriptInterpreter.cpp.

References error(), and lldb_private::Status.

Interrupt()

virtual bool lldb_private::ScriptInterpreter::Interrupt ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 197 of file ScriptInterpreter.h.

Referenced by lldb_private::CommandInterpreter::IOHandlerInterrupt().

IsReservedWord()

virtual bool lldb_private::ScriptInterpreter::IsReservedWord ( const char * word )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 398 of file ScriptInterpreter.h.

Referenced by GetSanitizedScriptingModuleName().

LanguageToString()

std::string ScriptInterpreter::LanguageToString ( lldb::ScriptLanguage language )

static

Definition at line 70 of file ScriptInterpreter.cpp.

References lldb::eScriptLanguageLua, lldb::eScriptLanguageNone, lldb::eScriptLanguagePython, and lldb::eScriptLanguageUnknown.

Referenced by lldb_private::BreakpointOptions::CreateFromStructuredData(), lldb_private::BreakpointOptions::CommandBaton::GetDescription(), CommandObjectScriptingExtensionList::GetLanguagesForExtension(), lldb_private::BreakpointOptions::CommandData::SerializeToStructuredData(), and StringToLanguage().

LoadPluginModule()

virtual StructuredData::ObjectSP lldb_private::ScriptInterpreter::LoadPluginModule ( const FileSpec & file_spec, lldb_private::Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 263 of file ScriptInterpreter.h.

References error().

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::ParsePythonTargetDefinition().

LoadScriptingModule()

bool ScriptInterpreter::LoadScriptingModule ( const char * filename, const LoadScriptOptions & options, lldb_private::Status & error, StructuredData::ObjectSP * module_sp = nullptr, FileSpec extra_search_dir = {}, lldb::TargetSP loaded_into_target_sp = {} )

virtual

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPythonImpl.

Definition at line 61 of file ScriptInterpreter.cpp.

References error(), and lldb_private::Status::FromErrorString().

Referenced by LoadScriptingModule().

RunScriptBasedCommand()

virtual bool lldb_private::ScriptInterpreter::RunScriptBasedCommand ( const char * impl_function, llvm::StringRef args, ScriptedCommandSynchronicity synchronicity, lldb_private::CommandReturnObject & cmd_retobj, Status & error, const lldb_private::ExecutionContext & exe_ctx )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 343 of file ScriptInterpreter.h.

References error().

Referenced by CommandObjectPythonFunction::DoExecute().

RunScriptFormatKeyword() [1/5]

virtual bool lldb_private::ScriptInterpreter::RunScriptFormatKeyword ( const char * impl_function, Process * process, std::string & output, Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 351 of file ScriptInterpreter.h.

References error(), and lldb_private::Status::FromErrorString().

Referenced by RunScriptFormatKeyword().

RunScriptFormatKeyword() [2/5]

virtual bool lldb_private::ScriptInterpreter::RunScriptFormatKeyword ( const char * impl_function, StackFrame * frame, std::string & output, Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 370 of file ScriptInterpreter.h.

References error(), and lldb_private::Status::FromErrorString().

RunScriptFormatKeyword() [3/5]

virtual bool lldb_private::ScriptInterpreter::RunScriptFormatKeyword ( const char * impl_function, Target * target, std::string & output, Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 364 of file ScriptInterpreter.h.

References error(), and lldb_private::Status::FromErrorString().

RunScriptFormatKeyword() [4/5]

virtual bool lldb_private::ScriptInterpreter::RunScriptFormatKeyword ( const char * impl_function, Thread * thread, std::string & output, Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 358 of file ScriptInterpreter.h.

References error(), and lldb_private::Status::FromErrorString().

RunScriptFormatKeyword() [5/5]

virtual bool lldb_private::ScriptInterpreter::RunScriptFormatKeyword ( const char * impl_function, ValueObject * value, std::string & output, Status & error )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 377 of file ScriptInterpreter.h.

References error(), and lldb_private::Status::FromErrorString().

SetBreakpointCommandCallback() [1/3]

virtual Status lldb_private::ScriptInterpreter::SetBreakpointCommandCallback ( BreakpointOptions & bp_options, const char * callback_text, bool is_callback )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPythonImpl.

Definition at line 292 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

SetBreakpointCommandCallback() [2/3]

virtual Status lldb_private::ScriptInterpreter::SetBreakpointCommandCallback ( BreakpointOptions & bp_options, std::unique_ptr< BreakpointOptions::CommandData > & data_up )

inlinevirtual

This one is for deserialization:

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 299 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

SetBreakpointCommandCallback() [3/3]

Status ScriptInterpreter::SetBreakpointCommandCallback	(	std::vector< std::reference_wrapper< BreakpointOptions > > &	bp_options_vec,
		const char *	callback_text )

Set the specified text as the callback for the breakpoint.

Definition at line 272 of file ScriptInterpreter.cpp.

References error(), and SetBreakpointCommandCallback().

Referenced by lldb_private::BreakpointOptions::CreateFromStructuredData(), and SetBreakpointCommandCallback().

SetBreakpointCommandCallbackFunction() [1/2]

virtual Status lldb_private::ScriptInterpreter::SetBreakpointCommandCallbackFunction ( BreakpointOptions & bp_options, const char * function_name, StructuredData::ObjectSP extra_args_sp )

inlinevirtual

Set a script function as the callback for the breakpoint.

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPythonImpl.

Definition at line 311 of file ScriptInterpreter.h.

References lldb_private::Status::FromErrorString().

SetBreakpointCommandCallbackFunction() [2/2]

Status ScriptInterpreter::SetBreakpointCommandCallbackFunction	(	std::vector< std::reference_wrapper< BreakpointOptions > > &	bp_options_vec,
		const char *	function_name,
		StructuredData::ObjectSP	extra_args_sp )

Definition at line 285 of file ScriptInterpreter.cpp.

References error(), and SetBreakpointCommandCallbackFunction().

Referenced by SetBreakpointCommandCallbackFunction().

SetWatchpointCommandCallback()

virtual void lldb_private::ScriptInterpreter::SetWatchpointCommandCallback ( WatchpointOptions * wp_options, const char * user_input, bool is_callback )

inlinevirtual

Set a one-liner as the callback for the watchpoint.

Reimplemented in lldb_private::ScriptInterpreterLua, and lldb_private::ScriptInterpreterPythonImpl.

Definition at line 318 of file ScriptInterpreter.h.

StringToExtension()

lldb::ScriptedExtension ScriptInterpreter::StringToExtension ( llvm::StringRef string )

static

Definition at line 248 of file ScriptInterpreter.cpp.

References lldb::eScriptedExtensionInvalid, lldb::eScriptedExtensionOperatingSystem, lldb::eScriptedExtensionParsedCommand, lldb::eScriptedExtensionScriptedBreakpointResolver, lldb::eScriptedExtensionScriptedCommand, lldb::eScriptedExtensionScriptedFrame, lldb::eScriptedExtensionScriptedFrameProvider, lldb::eScriptedExtensionScriptedHook, lldb::eScriptedExtensionScriptedPlatform, lldb::eScriptedExtensionScriptedProcess, lldb::eScriptedExtensionScriptedStackFrameRecognizer, lldb::eScriptedExtensionScriptedStringSummary, lldb::eScriptedExtensionScriptedSyntheticChildren, lldb::eScriptedExtensionScriptedThread, and lldb::eScriptedExtensionScriptedThreadPlan.

Referenced by CommandObjectScriptingExtensionGenerate::DoExecute(), CommandObjectScriptingExtensionList::DoExecute(), and lldb_private::ScriptInterpreterPython::GetExtensionSchema().

StringToLanguage()

lldb::ScriptLanguage ScriptInterpreter::StringToLanguage ( const llvm::StringRef & string )

static

Definition at line 200 of file ScriptInterpreter.cpp.

References lldb::eScriptLanguageLua, lldb::eScriptLanguageNone, lldb::eScriptLanguagePython, lldb::eScriptLanguageUnknown, and LanguageToString().

Referenced by lldb_private::BreakpointOptions::CommandData::CreateFromStructuredData().

Member Data Documentation

m_debugger

Debugger& lldb_private::ScriptInterpreter::m_debugger

protected

Definition at line 587 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptInterpreterLua::CollectDataForBreakpointCommandCallback(), lldb_private::ScriptInterpreterLua::CollectDataForWatchpointCommandCallback(), lldb_private::ScriptInterpreterPythonImpl::CollectDataForWatchpointCommandCallback(), lldb_private::ScriptInterpreterLua::ExecuteInterpreterLoop(), lldb_private::ScriptInterpreterNone::ExecuteInterpreterLoop(), lldb_private::ScriptInterpreterLua::ExecuteOneLine(), lldb_private::ScriptInterpreterNone::ExecuteOneLine(), GetDebugger(), GetDebugger(), ScriptInterpreter(), lldb_private::ScriptInterpreterPythonImpl::ScriptInterpreterPythonImpl(), and lldb_private::ScriptInterpreterPythonImpl::SetBreakpointCommandCallbackFunction().

m_script_lang

lldb::ScriptLanguage lldb_private::ScriptInterpreter::m_script_lang

protected

Definition at line 588 of file ScriptInterpreter.h.

Referenced by GetLanguage(), and ScriptInterpreter().

---

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

• ScriptInterpreter.h
• ScriptInterpreter.cpp