#include <ScriptInterpreter.h>

Inheritance diagram for lldb_private::ScriptInterpreter:

[legend]

Collaboration diagram for lldb_private::ScriptInterpreter:

[legend]

Classes
struct	ExecuteScriptOptions

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)

	~ScriptInterpreter () override

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)

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

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	CreateSyntheticScriptedProvider (const char *class_name, lldb::ValueObjectSP valobj)

virtual StructuredData::GenericSP	CreateScriptCommandObject (const char *class_name)

virtual StructuredData::GenericSP	CreateFrameRecognizer (const char *class_name)

virtual lldb::ValueObjectListSP	GetRecognizedArguments (const StructuredData::ObjectSP &implementor, lldb::StackFrameSP frame_sp)

virtual StructuredData::GenericSP	OSPlugin_CreatePluginObject (const char *class_name, lldb::ProcessSP process_sp)

virtual StructuredData::DictionarySP	OSPlugin_RegisterInfo (StructuredData::ObjectSP os_plugin_object_sp)

virtual StructuredData::ArraySP	OSPlugin_ThreadsInfo (StructuredData::ObjectSP os_plugin_object_sp)

virtual StructuredData::StringSP	OSPlugin_RegisterContextData (StructuredData::ObjectSP os_plugin_object_sp, lldb::tid_t thread_id)

virtual StructuredData::DictionarySP	OSPlugin_CreateThread (StructuredData::ObjectSP os_plugin_object_sp, lldb::tid_t tid, lldb::addr_t context)

virtual StructuredData::ObjectSP	CreateScriptedThreadPlan (const char *class_name, lldb::ThreadPlanSP thread_plan_sp)

virtual bool	ScriptedThreadPlanExplainsStop (StructuredData::ObjectSP implementor_sp, Event *event, bool &script_error)

virtual bool	ScriptedThreadPlanShouldStop (StructuredData::ObjectSP implementor_sp, Event *event, bool &script_error)

virtual bool	ScriptedThreadPlanIsStale (StructuredData::ObjectSP implementor_sp, bool &script_error)

virtual lldb::StateType	ScriptedThreadPlanGetRunState (StructuredData::ObjectSP implementor_sp, bool &script_error)

virtual StructuredData::GenericSP	CreateScriptedBreakpointResolver (const char class_name, StructuredDataImpl args_data, lldb::BreakpointSP &bkpt_sp)

virtual bool	ScriptedBreakpointResolverSearchCallback (StructuredData::GenericSP implementor_sp, SymbolContext *sym_ctx)

virtual lldb::SearchDepth	ScriptedBreakpointResolverSearchDepth (StructuredData::GenericSP implementor_sp)

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)

virtual void	CollectDataForBreakpointCommandCallback (std::vector< BreakpointOptions *> &options, CommandReturnObject &result)

virtual void	CollectDataForWatchpointCommandCallback (WatchpointOptions *wp_options, CommandReturnObject &result)

Status	SetBreakpointCommandCallback (std::vector< BreakpointOptions > &bp_options_vec, const char callback_text)
	Set the specified text as the callback for the breakpoint. More...

virtual Status	SetBreakpointCommandCallback (BreakpointOptions bp_options, const char callback_text)

virtual Status	SetBreakpointCommandCallback (BreakpointOptions *bp_options, std::unique_ptr< BreakpointOptions::CommandData > &data_up)
	This one is for deserialization: More...

void	SetBreakpointCommandCallbackFunction (std::vector< BreakpointOptions > &bp_options_vec, const char function_name)

virtual void	SetBreakpointCommandCallbackFunction (BreakpointOptions bp_options, const char function_name)
	Set a one-liner as the callback for the breakpoint. More...

virtual void	SetWatchpointCommandCallback (WatchpointOptions wp_options, const char oneliner)
	Set a one-liner as the callback for the watchpoint. More...

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

virtual void	Clear ()

virtual size_t	CalculateNumChildren (const StructuredData::ObjectSP &implementor, uint32_t max)

virtual lldb::ValueObjectSP	GetChildAtIndex (const StructuredData::ObjectSP &implementor, uint32_t idx)

virtual int	GetIndexOfChildWithName (const StructuredData::ObjectSP &implementor, const char *child_name)

virtual bool	UpdateSynthProviderInstance (const StructuredData::ObjectSP &implementor)

virtual bool	MightHaveChildrenSynthProviderInstance (const StructuredData::ObjectSP &implementor)

virtual lldb::ValueObjectSP	GetSyntheticValue (const StructuredData::ObjectSP &implementor)

virtual ConstString	GetSyntheticTypeName (const StructuredData::ObjectSP &implementor)

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	RunScriptBasedCommand (StructuredData::GenericSP impl_obj_sp, 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	GetShortHelpForCommandObject (StructuredData::GenericSP cmd_obj_sp, std::string &dest)

virtual uint32_t	GetFlagsForCommandObject (StructuredData::GenericSP cmd_obj_sp)

virtual bool	GetLongHelpForCommandObject (StructuredData::GenericSP cmd_obj_sp, std::string &dest)

virtual bool	CheckObjectExists (const char *name)

virtual bool	LoadScriptingModule (const char filename, bool can_reload, bool init_session, lldb_private::Status &error, StructuredData::ObjectSP module_sp=nullptr)

virtual bool	IsReservedWord (const char *word)

virtual std::unique_ptr< ScriptInterpreterLocker >	AcquireInterpreterLock ()

const char *	GetScriptInterpreterPtyName ()

int	GetMasterFileDescriptor ()

virtual void	ResetOutputFileHandle (FILE *new_fh)

lldb::ScriptLanguage	GetLanguage ()

Public Member Functions inherited from lldb_private::PluginInterface
virtual	~PluginInterface ()

virtual ConstString	GetPluginName ()=0

virtual uint32_t	GetPluginVersion ()=0

Static Public Member Functions
static std::string	LanguageToString (lldb::ScriptLanguage language)

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

Protected Attributes
Debugger &	m_debugger

lldb::ScriptLanguage	m_script_lang

Detailed Description

Definition at line 35 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 37 of file ScriptInterpreter.h.

Constructor & Destructor Documentation

◆ ScriptInterpreter()

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

Definition at line 24 of file ScriptInterpreter.cpp.

◆ ~ScriptInterpreter()

ScriptInterpreter::~ScriptInterpreter ( )

override

Definition at line 28 of file ScriptInterpreter.cpp.

Member Function Documentation

◆ AcquireInterpreterLock()

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

virtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 93 of file ScriptInterpreter.cpp.

Referenced by OperatingSystemPython::CreateRegisterContextForThread(), OperatingSystemPython::CreateThread(), and OperatingSystemPython::UpdateThreadList().

◆ CalculateNumChildren()

virtual size_t lldb_private::ScriptInterpreter::CalculateNumChildren	(	const StructuredData::ObjectSP &	implementor,
		uint32_t	max
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 335 of file ScriptInterpreter.h.

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

◆ CheckObjectExists()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 444 of file ScriptInterpreter.h.

Referenced by CommandObjectTypeSynthClear::CommandObjectTypeSynthClear(), and CommandObjectFrameRecognizerAdd::DoExecute().

◆ Clear()

virtual void lldb_private::ScriptInterpreter::Clear ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 330 of file ScriptInterpreter.h.

◆ CollectDataForBreakpointCommandCallback()

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

virtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 30 of file ScriptInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb::eReturnStatusFailed, and lldb_private::CommandReturnObject::SetStatus().

Referenced by CommandObjectBreakpointCommandAdd::DoExecute().

◆ CollectDataForWatchpointCommandCallback()

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

virtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 38 of file ScriptInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb::eReturnStatusFailed, and lldb_private::CommandReturnObject::SetStatus().

◆ CreateFrameRecognizer()

virtual StructuredData::GenericSP lldb_private::ScriptInterpreter::CreateFrameRecognizer ( const char * class_name )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 171 of file ScriptInterpreter.h.

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

◆ CreateScriptCommandObject()

virtual StructuredData::GenericSP lldb_private::ScriptInterpreter::CreateScriptCommandObject ( const char * class_name )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 166 of file ScriptInterpreter.h.

Referenced by CommandObjectCommandsScriptAdd::DoExecute().

◆ CreateScriptedBreakpointResolver()

virtual StructuredData::GenericSP lldb_private::ScriptInterpreter::CreateScriptedBreakpointResolver	(	const char *	class_name,
		StructuredDataImpl *	args_data,
		lldb::BreakpointSP &	bkpt_sp
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 244 of file ScriptInterpreter.h.

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

◆ CreateScriptedThreadPlan()

virtual StructuredData::ObjectSP lldb_private::ScriptInterpreter::CreateScriptedThreadPlan	(	const char *	class_name,
		lldb::ThreadPlanSP	thread_plan_sp
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 210 of file ScriptInterpreter.h.

Referenced by lldb_private::ThreadPlanPython::DidPush().

◆ CreateSyntheticScriptedProvider()

virtual StructuredData::ObjectSP lldb_private::ScriptInterpreter::CreateSyntheticScriptedProvider	(	const char *	class_name,
		lldb::ValueObjectSP	valobj
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 160 of file ScriptInterpreter.h.

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

◆ ExecuteInterpreterLoop()

virtual void lldb_private::ScriptInterpreter::ExecuteInterpreterLoop ( )

pure virtual

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

Referenced by lldb_private::CommandObjectScript::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 105 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ ExecuteOneLine()

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

pure virtual

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

Referenced by lldb_private::CommandObjectScript::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 99 of file ScriptInterpreter.h.

◆ ExportFunctionDefinitionToInterpreter()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 114 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ GenerateBreakpointCommandCallbackData()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 120 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ GenerateFunction()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 274 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ GenerateScriptAliasFunction()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 144 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 132 of file ScriptInterpreter.h.

Referenced by lldb::SBTypeCategory::AddTypeSummary(), CommandObjectTypeFormatList::CommandObjectTypeFormatList(), 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 138 of file ScriptInterpreter.h.

◆ GenerateTypeSynthClass() [1/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 149 of file ScriptInterpreter.h.

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

◆ GenerateTypeSynthClass() [2/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 154 of file ScriptInterpreter.h.

◆ GenerateWatchpointCommandCallbackData()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 127 of file ScriptInterpreter.h.

◆ GetChildAtIndex()

virtual lldb::ValueObjectSP lldb_private::ScriptInterpreter::GetChildAtIndex	(	const StructuredData::ObjectSP &	implementor,
		uint32_t	idx
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 341 of file ScriptInterpreter.h.

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

◆ GetDocumentationForItem()

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 421 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 269 of file ScriptInterpreter.h.

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

◆ GetFlagsForCommandObject()

virtual uint32_t lldb_private::ScriptInterpreter::GetFlagsForCommandObject ( StructuredData::GenericSP cmd_obj_sp )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 434 of file ScriptInterpreter.h.

◆ GetIndexOfChildWithName()

virtual int lldb_private::ScriptInterpreter::GetIndexOfChildWithName	(	const StructuredData::ObjectSP &	implementor,
		const char *	child_name
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 346 of file ScriptInterpreter.h.

References UINT32_MAX.

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

◆ GetLanguage()

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

inline

Definition at line 468 of file ScriptInterpreter.h.

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

◆ GetLongHelpForCommandObject()

virtual bool lldb_private::ScriptInterpreter::GetLongHelpForCommandObject	(	StructuredData::GenericSP	cmd_obj_sp,
		std::string &	dest
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 438 of file ScriptInterpreter.h.

Referenced by CommandObjectScriptingObject::GetHelpLong().

◆ GetMasterFileDescriptor()

int lldb_private::ScriptInterpreter::GetMasterFileDescriptor ( )

◆ GetRecognizedArguments()

virtual lldb::ValueObjectListSP lldb_private::ScriptInterpreter::GetRecognizedArguments	(	const StructuredData::ObjectSP &	implementor,
		lldb::StackFrameSP	frame_sp
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 175 of file ScriptInterpreter.h.

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

◆ 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 ( )

◆ GetShortHelpForCommandObject()

virtual bool lldb_private::ScriptInterpreter::GetShortHelpForCommandObject	(	StructuredData::GenericSP	cmd_obj_sp,
		std::string &	dest
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 427 of file ScriptInterpreter.h.

Referenced by lldb_private::BreakpointResolverScripted::GetDescription(), and CommandObjectScriptingObject::GetHelp().

◆ GetSyntheticTypeName()

virtual ConstString lldb_private::ScriptInterpreter::GetSyntheticTypeName ( const StructuredData::ObjectSP & implementor )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 367 of file ScriptInterpreter.h.

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

◆ GetSyntheticValue()

virtual lldb::ValueObjectSP lldb_private::ScriptInterpreter::GetSyntheticValue ( const StructuredData::ObjectSP & implementor )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 362 of file ScriptInterpreter.h.

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

◆ Interrupt()

virtual bool lldb_private::ScriptInterpreter::Interrupt ( )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 91 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 454 of file ScriptInterpreter.h.

◆ LanguageToString()

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

static

Definition at line 45 of file ScriptInterpreter.cpp.

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

Referenced by lldb_private::BreakpointOptions::CreateFromStructuredData(), lldb_private::BreakpointOptions::CommandBaton::GetDescription(), 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 264 of file ScriptInterpreter.h.

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

◆ LoadScriptingModule()

virtual bool lldb_private::ScriptInterpreter::LoadScriptingModule	(	const char *	filename,
		bool	can_reload,
		bool	init_session,
		lldb_private::Status &	error,
		StructuredData::ObjectSP *	module_sp = `nullptr`
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 447 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

Referenced by lldb_private::Module::LoadScriptingResourceInTarget(), and OperatingSystemPython::OperatingSystemPython().

◆ MightHaveChildrenSynthProviderInstance()

virtual bool lldb_private::ScriptInterpreter::MightHaveChildrenSynthProviderInstance ( const StructuredData::ObjectSP & implementor )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 356 of file ScriptInterpreter.h.

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

◆ OSPlugin_CreatePluginObject()

virtual StructuredData::GenericSP lldb_private::ScriptInterpreter::OSPlugin_CreatePluginObject	(	const char *	class_name,
		lldb::ProcessSP	process_sp
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 182 of file ScriptInterpreter.h.

Referenced by OperatingSystemPython::OperatingSystemPython().

◆ OSPlugin_CreateThread()

virtual StructuredData::DictionarySP lldb_private::ScriptInterpreter::OSPlugin_CreateThread	(	StructuredData::ObjectSP	os_plugin_object_sp,
		lldb::tid_t	tid,
		lldb::addr_t	context
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 204 of file ScriptInterpreter.h.

Referenced by OperatingSystemPython::CreateThread().

◆ OSPlugin_RegisterContextData()

virtual StructuredData::StringSP lldb_private::ScriptInterpreter::OSPlugin_RegisterContextData	(	StructuredData::ObjectSP	os_plugin_object_sp,
		lldb::tid_t	thread_id
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 198 of file ScriptInterpreter.h.

Referenced by OperatingSystemPython::CreateRegisterContextForThread().

◆ OSPlugin_RegisterInfo()

virtual StructuredData::DictionarySP lldb_private::ScriptInterpreter::OSPlugin_RegisterInfo ( StructuredData::ObjectSP os_plugin_object_sp )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 188 of file ScriptInterpreter.h.

Referenced by OperatingSystemPython::GetDynamicRegisterInfo().

◆ OSPlugin_ThreadsInfo()

virtual StructuredData::ArraySP lldb_private::ScriptInterpreter::OSPlugin_ThreadsInfo ( StructuredData::ObjectSP os_plugin_object_sp )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 193 of file ScriptInterpreter.h.

Referenced by OperatingSystemPython::UpdateThreadList().

◆ ResetOutputFileHandle()

virtual void lldb_private::ScriptInterpreter::ResetOutputFileHandle ( FILE * new_fh )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 466 of file ScriptInterpreter.h.

◆ RunScriptBasedCommand() [1/2]

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 372 of file ScriptInterpreter.h.

Referenced by CommandObjectPythonFunction::DoExecute(), and CommandObjectScriptingObject::DoExecute().

◆ RunScriptBasedCommand() [2/2]

virtual bool lldb_private::ScriptInterpreter::RunScriptBasedCommand	(	StructuredData::GenericSP	impl_obj_sp,
		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 380 of file ScriptInterpreter.h.

◆ 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 388 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

Referenced by RunScriptFormatKeyword().

◆ RunScriptFormatKeyword() [2/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 395 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ 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 401 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ RunScriptFormatKeyword() [4/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 407 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ 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 414 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ ScriptedBreakpointResolverSearchCallback()

virtual bool lldb_private::ScriptInterpreter::ScriptedBreakpointResolverSearchCallback	(	StructuredData::GenericSP	implementor_sp,
		SymbolContext *	sym_ctx
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 251 of file ScriptInterpreter.h.

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

◆ ScriptedBreakpointResolverSearchDepth()

virtual lldb::SearchDepth lldb_private::ScriptInterpreter::ScriptedBreakpointResolverSearchDepth ( StructuredData::GenericSP implementor_sp )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 258 of file ScriptInterpreter.h.

References lldb::eSearchDepthModule.

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

◆ ScriptedThreadPlanExplainsStop()

virtual bool lldb_private::ScriptInterpreter::ScriptedThreadPlanExplainsStop	(	StructuredData::ObjectSP	implementor_sp,
		Event *	event,
		bool &	script_error
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 216 of file ScriptInterpreter.h.

Referenced by lldb_private::ThreadPlanPython::DoPlanExplainsStop().

◆ ScriptedThreadPlanGetRunState()

virtual lldb::StateType lldb_private::ScriptInterpreter::ScriptedThreadPlanGetRunState	(	StructuredData::ObjectSP	implementor_sp,
		bool &	script_error
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 237 of file ScriptInterpreter.h.

References lldb::eStateStepping.

Referenced by lldb_private::ThreadPlanPython::GetPlanRunState().

◆ ScriptedThreadPlanIsStale()

virtual bool lldb_private::ScriptInterpreter::ScriptedThreadPlanIsStale	(	StructuredData::ObjectSP	implementor_sp,
		bool &	script_error
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 230 of file ScriptInterpreter.h.

Referenced by lldb_private::ThreadPlanPython::IsPlanStale().

◆ ScriptedThreadPlanShouldStop()

virtual bool lldb_private::ScriptInterpreter::ScriptedThreadPlanShouldStop	(	StructuredData::ObjectSP	implementor_sp,
		Event *	event,
		bool &	script_error
	)

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 223 of file ScriptInterpreter.h.

Referenced by lldb_private::ThreadPlanPython::ShouldStop().

◆ SetBreakpointCommandCallback() [1/3]

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

Set the specified text as the callback for the breakpoint.

Definition at line 72 of file ScriptInterpreter.cpp.

References lldb_private::Status::Success().

Referenced by lldb_private::BreakpointOptions::CreateFromStructuredData(), CommandObjectBreakpointCommandAdd::DoExecute(), and lldb_private::ScriptInterpreterPythonImpl::SetBreakpointCommandCallbackFunction().

◆ SetBreakpointCommandCallback() [2/3]

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

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 293 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ SetBreakpointCommandCallback() [3/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 301 of file ScriptInterpreter.h.

References lldb_private::Status::SetErrorString().

◆ SetBreakpointCommandCallbackFunction() [1/2]

void ScriptInterpreter::SetBreakpointCommandCallbackFunction	(	std::vector< BreakpointOptions *> &	bp_options_vec,
		const char *	function_name
	)

Definition at line 84 of file ScriptInterpreter.cpp.

Referenced by CommandObjectBreakpointCommandAdd::DoExecute().

◆ SetBreakpointCommandCallbackFunction() [2/2]

virtual void lldb_private::ScriptInterpreter::SetBreakpointCommandCallbackFunction	(	BreakpointOptions *	bp_options,
		const char *	function_name
	)

inlinevirtual

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

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 315 of file ScriptInterpreter.h.

◆ SetWatchpointCommandCallback()

virtual void lldb_private::ScriptInterpreter::SetWatchpointCommandCallback	(	WatchpointOptions *	wp_options,
		const char *	oneliner
	)

inlinevirtual

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

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 319 of file ScriptInterpreter.h.

◆ StringToLanguage()

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

static

Definition at line 64 of file ScriptInterpreter.cpp.

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

◆ UpdateSynthProviderInstance()

virtual bool lldb_private::ScriptInterpreter::UpdateSynthProviderInstance ( const StructuredData::ObjectSP & implementor )

inlinevirtual

Reimplemented in lldb_private::ScriptInterpreterPythonImpl.

Definition at line 352 of file ScriptInterpreter.h.

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

Member Data Documentation

◆ m_debugger

Debugger& lldb_private::ScriptInterpreter::m_debugger

protected

Definition at line 471 of file ScriptInterpreter.h.

◆ m_script_lang

lldb::ScriptLanguage lldb_private::ScriptInterpreter::m_script_lang

protected

Definition at line 472 of file ScriptInterpreter.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ScriptReturnType

Constructor & Destructor Documentation

◆ ScriptInterpreter()

◆ ~ScriptInterpreter()

Member Function Documentation

◆ AcquireInterpreterLock()

◆ CalculateNumChildren()

◆ CheckObjectExists()

◆ Clear()

◆ CollectDataForBreakpointCommandCallback()

◆ CollectDataForWatchpointCommandCallback()

◆ CreateFrameRecognizer()

◆ CreateScriptCommandObject()

◆ CreateScriptedBreakpointResolver()

◆ CreateScriptedThreadPlan()

◆ CreateSyntheticScriptedProvider()

◆ ExecuteInterpreterLoop()

◆ ExecuteMultipleLines()

◆ ExecuteOneLine()

◆ ExecuteOneLineWithReturn()

◆ ExportFunctionDefinitionToInterpreter()

◆ GenerateBreakpointCommandCallbackData()

◆ GenerateFunction()

◆ GenerateScriptAliasFunction()

◆ GenerateTypeScriptFunction() [1/2]

◆ GenerateTypeScriptFunction() [2/2]

◆ GenerateTypeSynthClass() [1/2]

◆ GenerateTypeSynthClass() [2/2]

◆ GenerateWatchpointCommandCallbackData()

◆ GetChildAtIndex()

◆ GetDocumentationForItem()

◆ GetDynamicSettings()

◆ GetFlagsForCommandObject()

◆ GetIndexOfChildWithName()

◆ GetLanguage()

◆ GetLongHelpForCommandObject()

◆ GetMasterFileDescriptor()

◆ GetRecognizedArguments()

◆ GetScriptedSummary()

◆ GetScriptInterpreterPtyName()

◆ GetShortHelpForCommandObject()

◆ GetSyntheticTypeName()

◆ GetSyntheticValue()

◆ Interrupt()

◆ IsReservedWord()

◆ LanguageToString()

◆ LoadPluginModule()

◆ LoadScriptingModule()

◆ MightHaveChildrenSynthProviderInstance()

◆ OSPlugin_CreatePluginObject()

◆ OSPlugin_CreateThread()

◆ OSPlugin_RegisterContextData()

◆ OSPlugin_RegisterInfo()

◆ OSPlugin_ThreadsInfo()

◆ ResetOutputFileHandle()

◆ RunScriptBasedCommand() [1/2]

◆ RunScriptBasedCommand() [2/2]

◆ RunScriptFormatKeyword() [1/5]

◆ RunScriptFormatKeyword() [2/5]

◆ RunScriptFormatKeyword() [3/5]

◆ RunScriptFormatKeyword() [4/5]

◆ RunScriptFormatKeyword() [5/5]

◆ ScriptedBreakpointResolverSearchCallback()

◆ ScriptedBreakpointResolverSearchDepth()

◆ ScriptedThreadPlanExplainsStop()

◆ ScriptedThreadPlanGetRunState()

◆ ScriptedThreadPlanIsStale()

◆ ScriptedThreadPlanShouldStop()

◆ SetBreakpointCommandCallback() [1/3]

◆ SetBreakpointCommandCallback() [2/3]

◆ SetBreakpointCommandCallback() [3/3]

◆ SetBreakpointCommandCallbackFunction() [1/2]

◆ SetBreakpointCommandCallbackFunction() [2/2]