Stands in for a script language without an interpreter, reporting why it is unavailable. More...

#include <ScriptInterpreterNone.h>

Inheritance diagram for lldb_private::ScriptInterpreterNone:

Public Member Functions
	ScriptInterpreterNone (Debugger &debugger, lldb::ScriptLanguage requested_language)
	~ScriptInterpreterNone () override
bool	ExecuteOneLine (llvm::StringRef command, CommandReturnObject *result, const ExecuteScriptOptions &options=ExecuteScriptOptions()) override
llvm::Error	ExecuteInterpreterLoop () override
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={}) override
void	CollectDataForBreakpointCommandCallback (std::vector< std::reference_wrapper< BreakpointOptions > > &options, CommandReturnObject &result) override
llvm::Error	SetBreakpointCommandCallback (BreakpointOptions &bp_options, const char *callback_text, bool is_callback) override
llvm::Error	SetBreakpointCommandCallbackFunction (BreakpointOptions &bp_options, const char *function_name, StructuredData::ObjectSP extra_args_sp) override
	Set a script function as the callback for the breakpoint.
void	CollectDataForWatchpointCommandCallback (WatchpointOptions *wp_options, CommandReturnObject &result) override
llvm::Error	SetWatchpointCommandCallback (WatchpointOptions wp_options, const char user_input, bool is_callback) override
	Set a one-liner as the callback for the watchpoint.
llvm::StringRef	GetPluginName () override
Public Member Functions inherited from lldb_private::ScriptInterpreter
	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	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 llvm::Error	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)
llvm::Error	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 llvm::Error	SetBreakpointCommandCallback (BreakpointOptions &bp_options, std::unique_ptr< BreakpointOptions::CommandData > &data_up)
	This one is for deserialization:
llvm::Error	SetBreakpointCommandCallbackFunction (std::vector< std::reference_wrapper< BreakpointOptions > > &bp_options_vec, const char *function_name, StructuredData::ObjectSP extra_args_sp)
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)
const lldb::ScriptedInstanceRegistrySP &	GetScriptedInstanceRegistry () const
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)
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
	PluginInterface (const PluginInterface &)=delete
PluginInterface &	operator= (const PluginInterface &)=delete

Static Public Member Functions
static void	Initialize ()
static void	Terminate ()
static lldb::ScriptInterpreterSP	CreateInstance (Debugger &debugger, lldb::ScriptLanguage requested_language)
static llvm::StringRef	GetPluginNameStatic ()
static llvm::StringRef	GetPluginDescriptionStatic ()
Static Public Member Functions inherited from lldb_private::ScriptInterpreter
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)

Private Member Functions
llvm::Error	GetUnavailableError () const
	Returns the error recorded for the requested language, or success.

Private Attributes
lldb::ScriptLanguage	m_requested_language

Additional Inherited Members
Public Types inherited from lldb_private::ScriptInterpreter
enum	ScriptReturnType { eScriptReturnTypeCharPtr , eScriptReturnTypeBool , eScriptReturnTypeShortInt , eScriptReturnTypeShortIntUnsigned , eScriptReturnTypeInt , eScriptReturnTypeIntUnsigned , eScriptReturnTypeLongInt , eScriptReturnTypeLongIntUnsigned , eScriptReturnTypeLongLong , eScriptReturnTypeLongLongUnsigned , eScriptReturnTypeFloat , eScriptReturnTypeDouble , eScriptReturnTypeChar , eScriptReturnTypeCharStrOrNone , eScriptReturnTypeOpaqueObject }
Protected Attributes inherited from lldb_private::ScriptInterpreter
Debugger &	m_debugger
lldb::ScriptLanguage	m_script_lang

Detailed Description

Stands in for a script language without an interpreter, reporting why it is unavailable.

Definition at line 18 of file ScriptInterpreterNone.h.

Constructor & Destructor Documentation

◆ ScriptInterpreterNone()

ScriptInterpreterNone::ScriptInterpreterNone	(	Debugger &	debugger,
		lldb::ScriptLanguage	requested_language )

Definition at line 22 of file ScriptInterpreterNone.cpp.

References lldb::eScriptLanguageNone, m_requested_language, lldb_private::ScriptInterpreter::ScriptInterpreter(), and ScriptInterpreterNone().

Referenced by ScriptInterpreterNone().

◆ ~ScriptInterpreterNone()

ScriptInterpreterNone::~ScriptInterpreterNone ( )

overridedefault

References error().

Member Function Documentation

◆ CollectDataForBreakpointCommandCallback()

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

overridevirtual

Reimplemented from lldb_private::ScriptInterpreter.

Definition at line 92 of file ScriptInterpreterNone.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::ScriptInterpreter::CollectDataForBreakpointCommandCallback(), and GetUnavailableError().

◆ CollectDataForWatchpointCommandCallback()

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

overridevirtual

Reimplemented from lldb_private::ScriptInterpreter.

Definition at line 101 of file ScriptInterpreterNone.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::ScriptInterpreter::CollectDataForWatchpointCommandCallback(), and GetUnavailableError().

◆ CreateInstance()

lldb::ScriptInterpreterSP ScriptInterpreterNone::CreateInstance	(	Debugger &	debugger,
		lldb::ScriptLanguage	requested_language )

static

Definition at line 147 of file ScriptInterpreterNone.cpp.

Referenced by Initialize(), and Terminate().

◆ ExecuteInterpreterLoop()

llvm::Error ScriptInterpreterNone::ExecuteInterpreterLoop ( )

overridevirtual

Implements lldb_private::ScriptInterpreter.

Definition at line 73 of file ScriptInterpreterNone.cpp.

References CreateNoScriptingError(), error(), and GetUnavailableError().

◆ ExecuteOneLine()

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

overridevirtual

Implements lldb_private::ScriptInterpreter.

Definition at line 59 of file ScriptInterpreterNone.cpp.

References lldb_private::CommandReturnObject::AppendError(), CreateNoScriptingError(), error(), GetUnavailableError(), and lldb_private::ScriptInterpreter::m_debugger.

◆ GetPluginDescriptionStatic()

llvm::StringRef ScriptInterpreterNone::GetPluginDescriptionStatic ( )

static

Definition at line 152 of file ScriptInterpreterNone.cpp.

Referenced by Initialize().

◆ GetPluginName()

llvm::StringRef lldb_private::ScriptInterpreterNone::GetPluginName ( )

inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 71 of file ScriptInterpreterNone.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

llvm::StringRef lldb_private::ScriptInterpreterNone::GetPluginNameStatic ( )

inlinestatic

Definition at line 66 of file ScriptInterpreterNone.h.

Referenced by GetPluginName(), and Initialize().

◆ GetUnavailableError()

llvm::Error ScriptInterpreterNone::GetUnavailableError ( ) const

private

Returns the error recorded for the requested language, or success.

Definition at line 40 of file ScriptInterpreterNone.cpp.

References error(), lldb_private::PluginManager::GetScriptInterpreterError(), IsBuiltWith(), lldb_private::ScriptInterpreter::LanguageToString(), and m_requested_language.

Referenced by CollectDataForBreakpointCommandCallback(), CollectDataForWatchpointCommandCallback(), ExecuteInterpreterLoop(), ExecuteOneLine(), LoadScriptingModule(), SetBreakpointCommandCallback(), SetBreakpointCommandCallbackFunction(), and SetWatchpointCommandCallback().

◆ Initialize()

void ScriptInterpreterNone::Initialize ( )

static

Definition at line 136 of file ScriptInterpreterNone.cpp.

References CreateInstance(), lldb::eScriptLanguageNone, GetPluginDescriptionStatic(), GetPluginNameStatic(), and lldb_private::PluginManager::RegisterPlugin().

◆ LoadScriptingModule()

bool ScriptInterpreterNone::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 = {} )

overridevirtual

Reimplemented from lldb_private::ScriptInterpreter.

Definition at line 79 of file ScriptInterpreterNone.cpp.

References error(), lldb_private::Status::FromError(), GetUnavailableError(), and lldb_private::ScriptInterpreter::LoadScriptingModule().

◆ SetBreakpointCommandCallback()

llvm::Error ScriptInterpreterNone::SetBreakpointCommandCallback	(	BreakpointOptions &	bp_options,
		const char *	callback_text,
		bool	is_callback )

overridevirtual

Reimplemented from lldb_private::ScriptInterpreter.

Definition at line 110 of file ScriptInterpreterNone.cpp.

References GetUnavailableError(), and lldb_private::ScriptInterpreter::SetBreakpointCommandCallback().

◆ SetBreakpointCommandCallbackFunction()

llvm::Error ScriptInterpreterNone::SetBreakpointCommandCallbackFunction	(	BreakpointOptions &	bp_options,
		const char *	function_name,
		StructuredData::ObjectSP	extra_args_sp )

overridevirtual

Set a script function as the callback for the breakpoint.

Reimplemented from lldb_private::ScriptInterpreter.

Definition at line 119 of file ScriptInterpreterNone.cpp.

References GetUnavailableError(), and lldb_private::ScriptInterpreter::SetBreakpointCommandCallbackFunction().

◆ SetWatchpointCommandCallback()

llvm::Error ScriptInterpreterNone::SetWatchpointCommandCallback	(	WatchpointOptions *	wp_options,
		const char *	user_input,
		bool	is_callback )

overridevirtual

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

Reimplemented from lldb_private::ScriptInterpreter.

Definition at line 128 of file ScriptInterpreterNone.cpp.

References GetUnavailableError(), and lldb_private::ScriptInterpreter::SetWatchpointCommandCallback().

◆ Terminate()

void ScriptInterpreterNone::Terminate ( )

static

Definition at line 142 of file ScriptInterpreterNone.cpp.

References CreateInstance(), and lldb_private::PluginManager::UnregisterPlugin().

Member Data Documentation

◆ m_requested_language

lldb::ScriptLanguage lldb_private::ScriptInterpreterNone::m_requested_language

private

Definition at line 77 of file ScriptInterpreterNone.h.

Referenced by GetUnavailableError(), and ScriptInterpreterNone().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScriptInterpreterNone()

◆ ~ScriptInterpreterNone()

Member Function Documentation

◆ CollectDataForBreakpointCommandCallback()

◆ CollectDataForWatchpointCommandCallback()

◆ CreateInstance()

◆ ExecuteInterpreterLoop()

◆ ExecuteOneLine()

◆ GetPluginDescriptionStatic()

◆ GetPluginName()

◆ GetPluginNameStatic()

◆ GetUnavailableError()

◆ Initialize()

◆ LoadScriptingModule()

◆ SetBreakpointCommandCallback()

◆ SetBreakpointCommandCallbackFunction()

◆ SetWatchpointCommandCallback()

◆ Terminate()

Member Data Documentation

◆ m_requested_language