lldb_private::ScriptInterpreter Class Reference

#include <ScriptInterpreter.h>

Inheritance diagram for lldb_private::ScriptInterpreter:

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, lldb::ScriptedPlatformInterfaceUP scripted_platform_interface_up=std::make_unique< ScriptedPlatformInterface >())
virtual StructuredData::DictionarySP	GetInterpreterInfo ()
	~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	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, const StructuredDataImpl &args_data, std::string &error_str, 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 bool	ScriptedThreadPlanGetStopDescription (StructuredData::ObjectSP implementor_sp, lldb_private::Stream *stream, bool &script_error)
virtual StructuredData::GenericSP	CreateScriptedBreakpointResolver (const char *class_name, const 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::GenericSP	CreateScriptedStopHook (lldb::TargetSP target_sp, const char *class_name, const StructuredDataImpl &args_data, Status &error)
virtual bool	ScriptedStopHookHandleStop (StructuredData::GenericSP implementor_sp, ExecutionContext &exc_ctx, lldb::StreamSP stream_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, 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 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, const LoadScriptOptions &options, lldb_private::Status &error, StructuredData::ObjectSP *module_sp=nullptr, FileSpec extra_search_dir={})
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)
lldb::ScriptLanguage	GetLanguage ()
virtual lldb::ScriptedProcessInterfaceUP	CreateScriptedProcessInterface ()
ScriptedPlatformInterface &	GetScriptedPlatformInterface ()
lldb::DataExtractorSP	GetDataExtractorFromSBData (const lldb::SBData &data) const
Status	GetStatusFromSBError (const lldb::SBError &error) const
lldb::BreakpointSP	GetOpaqueTypeFromSBBreakpoint (const lldb::SBBreakpoint &breakpoint) 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
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)

Protected Attributes
Debugger &	m_debugger
lldb::ScriptLanguage	m_script_lang
lldb::ScriptedPlatformInterfaceUP	m_scripted_platform_interface_up

Detailed Description

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

Constructor & Destructor Documentation

ScriptInterpreter()

ScriptInterpreter::ScriptInterpreter	(	Debugger &	debugger,
		lldb::ScriptLanguage	script_lang,
		lldb::ScriptedPlatformInterfaceUP	scripted_platform_interface_up = std::make_unique<ScriptedPlatformInterface>()
	)

Definition at line 30 of file ScriptInterpreter.cpp.

~ScriptInterpreter()

lldb_private::ScriptInterpreter::~ScriptInterpreter ( )

overridedefault

Member Function Documentation

AcquireInterpreterLock()

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

virtual

Definition at line 153 of file ScriptInterpreter.cpp.

CalculateNumChildren()

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

inlinevirtual

Definition at line 451 of file ScriptInterpreter.h.

CheckObjectExists()

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

inlinevirtual

Definition at line 560 of file ScriptInterpreter.h.

Referenced by CommandObjectFrameRecognizerAdd::DoExecute().

Clear()

virtual void lldb_private::ScriptInterpreter::Clear ( )

inlinevirtual

Definition at line 446 of file ScriptInterpreter.h.

CollectDataForBreakpointCommandCallback()

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

virtual

Reimplemented in lldb_private::ScriptInterpreterLua.

Definition at line 37 of file ScriptInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendError().

CollectDataForWatchpointCommandCallback()

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

virtual

Reimplemented in lldb_private::ScriptInterpreterLua.

Definition at line 44 of file ScriptInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendError().

CreateFrameRecognizer()

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

inlinevirtual

Definition at line 243 of file ScriptInterpreter.h.

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

CreateScriptCommandObject()

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

inlinevirtual

Definition at line 238 of file ScriptInterpreter.h.

Referenced by CommandObjectCommandsScriptAdd::DoExecute().

CreateScriptedBreakpointResolver()

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

inlinevirtual

Definition at line 326 of file ScriptInterpreter.h.

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

CreateScriptedProcessInterface()

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

inlinevirtual

Definition at line 586 of file ScriptInterpreter.h.

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

CreateScriptedStopHook()

virtual StructuredData::GenericSP lldb_private::ScriptInterpreter::CreateScriptedStopHook ( lldb::TargetSP  target_sp, const char *  class_name, const StructuredDataImpl &  args_data, Status &  error  )

inlinevirtual

Definition at line 346 of file ScriptInterpreter.h.

References error().

Referenced by lldb_private::Target::StopHookScripted::SetScriptCallback().

CreateScriptedThreadPlan()

virtual StructuredData::ObjectSP lldb_private::ScriptInterpreter::CreateScriptedThreadPlan ( const char *  class_name, const StructuredDataImpl &  args_data, std::string &  error_str, lldb::ThreadPlanSP  thread_plan_sp  )

inlinevirtual

Definition at line 282 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

Definition at line 232 of file ScriptInterpreter.h.

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

ExecuteInterpreterLoop()

virtual void lldb_private::ScriptInterpreter::ExecuteInterpreterLoop ( )

pure virtual

Implemented in lldb_private::ScriptInterpreterLua, 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

Definition at line 174 of file ScriptInterpreter.h.

References error().

ExecuteOneLine()

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

pure virtual

Implemented in lldb_private::ScriptInterpreterLua, 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

Definition at line 168 of file ScriptInterpreter.h.

ExportFunctionDefinitionToInterpreter()

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

inlinevirtual

Definition at line 183 of file ScriptInterpreter.h.

References error().

FormatterCallbackFunction()

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

inlinevirtual

Definition at line 441 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

Definition at line 189 of file ScriptInterpreter.h.

References error().

GenerateFunction()

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

inlinevirtual

Definition at line 373 of file ScriptInterpreter.h.

References error().

GenerateScriptAliasFunction()

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

inlinevirtual

Definition at line 216 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

Definition at line 204 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

Definition at line 210 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

Definition at line 226 of file ScriptInterpreter.h.

GenerateTypeSynthClass() [2/2]

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

inlinevirtual

Definition at line 221 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

Definition at line 198 of file ScriptInterpreter.h.

GetChildAtIndex()

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

inlinevirtual

Definition at line 457 of file ScriptInterpreter.h.

GetDataExtractorFromSBData()

lldb::DataExtractorSP ScriptInterpreter::GetDataExtractorFromSBData

(

const lldb::SBData &

data

)

const

Definition at line 79 of file ScriptInterpreter.cpp.

References lldb::SBData::m_opaque_sp.

GetDocumentationForItem()

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

inlinevirtual

Definition at line 537 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

Definition at line 368 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

Definition at line 550 of file ScriptInterpreter.h.

GetIndexOfChildWithName()

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

inlinevirtual

Definition at line 462 of file ScriptInterpreter.h.

References UINT32_MAX.

GetInterpreterInfo()

StructuredData::DictionarySP ScriptInterpreter::GetInterpreterInfo ( )

virtual

Reimplemented in lldb_private::ScriptInterpreterLua.

Definition at line 50 of file ScriptInterpreter.cpp.

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

GetLanguage()

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

inline

Definition at line 584 of file ScriptInterpreter.h.

References m_script_lang.

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

GetLongHelpForCommandObject()

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

inlinevirtual

Definition at line 554 of file ScriptInterpreter.h.

Referenced by CommandObjectScriptingObject::GetHelpLong().

GetMaxPositionalArgumentsForCallable()

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

inlinevirtual

Definition at line 575 of file ScriptInterpreter.h.

GetOpaqueTypeFromSBAttachInfo()

lldb::ProcessAttachInfoSP ScriptInterpreter::GetOpaqueTypeFromSBAttachInfo

(

const lldb::SBAttachInfo &

attach_info

)

const

Definition at line 88 of file ScriptInterpreter.cpp.

References lldb::SBAttachInfo::m_opaque_sp.

GetOpaqueTypeFromSBBreakpoint()

lldb::BreakpointSP ScriptInterpreter::GetOpaqueTypeFromSBBreakpoint

(

const lldb::SBBreakpoint &

breakpoint

)

const

Definition at line 83 of file ScriptInterpreter.cpp.

References lldb::SBBreakpoint::m_opaque_wp.

GetOpaqueTypeFromSBLaunchInfo()

lldb::ProcessLaunchInfoSP ScriptInterpreter::GetOpaqueTypeFromSBLaunchInfo

(

const lldb::SBLaunchInfo &

launch_info

)

const

Definition at line 93 of file ScriptInterpreter.cpp.

References lldb::SBLaunchInfo::m_opaque_sp.

GetOpaqueTypeFromSBMemoryRegionInfo()

std::optional< MemoryRegionInfo > ScriptInterpreter::GetOpaqueTypeFromSBMemoryRegionInfo

(

const lldb::SBMemoryRegionInfo &

mem_region

)

const

Definition at line 108 of file ScriptInterpreter.cpp.

References lldb::SBMemoryRegionInfo::m_opaque_up.

GetRecognizedArguments()

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

inlinevirtual

Definition at line 247 of file ScriptInterpreter.h.

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

GetScriptedPlatformInterface()

ScriptedPlatformInterface & lldb_private::ScriptInterpreter::GetScriptedPlatformInterface ( )

inline

Definition at line 590 of file ScriptInterpreter.h.

References m_scripted_platform_interface_up.

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

Definition at line 430 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

Definition at line 543 of file ScriptInterpreter.h.

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

GetStatusFromSBError()

Status ScriptInterpreter::GetStatusFromSBError

(

const lldb::SBError &

error

)

const

Definition at line 100 of file ScriptInterpreter.cpp.

References error().

GetSyntheticTypeName()

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

inlinevirtual

Definition at line 483 of file ScriptInterpreter.h.

GetSyntheticValue()

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

inlinevirtual

Definition at line 478 of file ScriptInterpreter.h.

Interrupt()

virtual bool lldb_private::ScriptInterpreter::Interrupt ( )

inlinevirtual

Definition at line 160 of file ScriptInterpreter.h.

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

IsReservedWord()

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

inlinevirtual

Definition at line 568 of file ScriptInterpreter.h.

Referenced by lldb_private::PlatformDarwin::LocateExecutableScriptingResources().

LanguageToString()

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

static

Definition at line 64 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(), lldb_private::BreakpointOptions::CommandData::SerializeToStructuredData(), and StringToLanguage().

LoadPluginModule()

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

inlinevirtual

Definition at line 363 of file ScriptInterpreter.h.

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

virtual

Reimplemented in lldb_private::ScriptInterpreterLua.

Definition at line 54 of file ScriptInterpreter.cpp.

References error().

Referenced by lldb_private::Module::LoadScriptingResourceInTarget().

MightHaveChildrenSynthProviderInstance()

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

inlinevirtual

Definition at line 472 of file ScriptInterpreter.h.

OSPlugin_CreatePluginObject()

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

inlinevirtual

Definition at line 254 of file ScriptInterpreter.h.

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

Definition at line 276 of file ScriptInterpreter.h.

OSPlugin_RegisterContextData()

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

inlinevirtual

Definition at line 270 of file ScriptInterpreter.h.

OSPlugin_RegisterInfo()

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

inlinevirtual

Definition at line 260 of file ScriptInterpreter.h.

OSPlugin_ThreadsInfo()

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

inlinevirtual

Definition at line 265 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

Definition at line 488 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

Definition at line 496 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

Definition at line 504 of file ScriptInterpreter.h.

References error().

Referenced by RunScriptFormatKeyword().

RunScriptFormatKeyword() [2/5]

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

inlinevirtual

Definition at line 523 of file ScriptInterpreter.h.

References error().

RunScriptFormatKeyword() [3/5]

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

inlinevirtual

Definition at line 517 of file ScriptInterpreter.h.

References error().

RunScriptFormatKeyword() [4/5]

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

inlinevirtual

Definition at line 511 of file ScriptInterpreter.h.

References error().

RunScriptFormatKeyword() [5/5]

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

inlinevirtual

Definition at line 530 of file ScriptInterpreter.h.

References error().

ScriptedBreakpointResolverSearchCallback()

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

inlinevirtual

Definition at line 333 of file ScriptInterpreter.h.

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

ScriptedBreakpointResolverSearchDepth()

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

inlinevirtual

Definition at line 340 of file ScriptInterpreter.h.

References lldb::eSearchDepthModule.

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

ScriptedStopHookHandleStop()

virtual bool lldb_private::ScriptInterpreter::ScriptedStopHookHandleStop ( StructuredData::GenericSP  implementor_sp, ExecutionContext &  exc_ctx, lldb::StreamSP  stream_sp  )

inlinevirtual

Definition at line 356 of file ScriptInterpreter.h.

Referenced by lldb_private::Target::StopHookScripted::HandleStop().

ScriptedThreadPlanExplainsStop()

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

inlinevirtual

Definition at line 290 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

Definition at line 311 of file ScriptInterpreter.h.

References lldb::eStateStepping.

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

ScriptedThreadPlanGetStopDescription()

virtual bool lldb_private::ScriptInterpreter::ScriptedThreadPlanGetStopDescription ( StructuredData::ObjectSP  implementor_sp, lldb_private::Stream *  stream, bool &  script_error  )

inlinevirtual

Definition at line 318 of file ScriptInterpreter.h.

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

ScriptedThreadPlanIsStale()

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

inlinevirtual

Definition at line 304 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

Definition at line 297 of file ScriptInterpreter.h.

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

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.

Definition at line 394 of file ScriptInterpreter.h.

References error().

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:

Definition at line 403 of file ScriptInterpreter.h.

References error().

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 126 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.

Definition at line 417 of file ScriptInterpreter.h.

References error().

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 139 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.

Definition at line 426 of file ScriptInterpreter.h.

StringToLanguage()

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

static

Definition at line 116 of file ScriptInterpreter.cpp.

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

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

UpdateSynthProviderInstance()

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

inlinevirtual

Definition at line 468 of file ScriptInterpreter.h.

Member Data Documentation

m_debugger

Debugger& lldb_private::ScriptInterpreter::m_debugger

protected

Definition at line 612 of file ScriptInterpreter.h.

Referenced by lldb_private::ScriptInterpreterLua::CollectDataForBreakpointCommandCallback(), lldb_private::ScriptInterpreterLua::CollectDataForWatchpointCommandCallback(), lldb_private::ScriptInterpreterLua::ExecuteInterpreterLoop(), lldb_private::ScriptInterpreterNone::ExecuteInterpreterLoop(), lldb_private::ScriptInterpreterLua::ExecuteOneLine(), and lldb_private::ScriptInterpreterNone::ExecuteOneLine().

m_script_lang

lldb::ScriptLanguage lldb_private::ScriptInterpreter::m_script_lang

protected

Definition at line 613 of file ScriptInterpreter.h.

Referenced by GetLanguage().

m_scripted_platform_interface_up

lldb::ScriptedPlatformInterfaceUP lldb_private::ScriptInterpreter::m_scripted_platform_interface_up

protected

Definition at line 614 of file ScriptInterpreter.h.

Referenced by GetScriptedPlatformInterface().

---

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

• ScriptInterpreter.h
• ScriptInterpreter.cpp