#include <ScriptedCommandPythonInterface.h>

Inheritance diagram for lldb_private::ScriptedCommandPythonInterface:

Public Member Functions
	ScriptedCommandPythonInterface (ScriptInterpreterPythonImpl &interpreter)
llvm::Expected< StructuredData::GenericSP >	CreatePluginObject (llvm::StringRef class_name, lldb::DebuggerSP debugger_sp) override
llvm::SmallVector< AbstractMethodRequirement >	GetAbstractMethodRequirements () const override
bool	RunRawCommand (llvm::StringRef args, ScriptedCommandSynchronicity synchronicity, CommandReturnObject &cmd_retobj, Status &error, const ExecutionContext &exe_ctx) override
bool	RunParsedCommand (Args &args, ScriptedCommandSynchronicity synchronicity, CommandReturnObject &cmd_retobj, Status &error, const ExecutionContext &exe_ctx) override
std::optional< std::string >	GetRepeatCommand (Args &args) override
StructuredData::DictionarySP	HandleArgumentCompletion (std::vector< std::string > &args, size_t args_pos, size_t char_in_arg) override
StructuredData::DictionarySP	HandleOptionArgumentCompletion (llvm::StringRef &long_option, size_t char_in_arg) override
bool	GetShortHelp (std::string &dest) override
bool	GetLongHelp (std::string &dest) override
uint32_t	GetFlags () override
StructuredData::ObjectSP	GetOptionsDefinition () override
StructuredData::ObjectSP	GetArgumentsDefinition () override
void	OptionParsingStarted () override
bool	SetOptionValue (ExecutionContext *exe_ctx, llvm::StringRef long_option, llvm::StringRef value) override
llvm::StringRef	GetPluginName () override
Public Member Functions inherited from lldb_private::ScriptedCommandInterface
bool	UserCanRunDirectly () const override
	Whether the user can invoke this extension directly, the way a scripted command can.
Public Member Functions inherited from lldb_private::ScriptedInterface
	ScriptedInterface ()=default
virtual	~ScriptedInterface ()=default
StructuredData::GenericSP	GetScriptObjectInstance ()
const std::optional< ScriptedMetadata > &	GetScriptedMetadata () const
virtual llvm::SmallVector< llvm::StringLiteral >	GetOptionalMethods () const
	Methods a script may legitimately leave out, for which LLDB has a documented answer.
llvm::SmallVector< llvm::StringLiteral > const	GetAbstractMethods () const
Public Member Functions inherited from lldb_private::ScriptedPythonInterface
	ScriptedPythonInterface (ScriptInterpreterPythonImpl &interpreter)
	~ScriptedPythonInterface () override=default
llvm::Expected< FileSpec >	GetScriptedModulePath () override
llvm::Expected< std::map< llvm::StringLiteral, AbstractMethodCheckerPayload > >	CheckAbstractMethodImplementation (const python::PythonObject &obj_class) const
llvm::Error	CheckAbstractMethods (const python::PythonObject &obj_class, llvm::StringRef qualified_class_name) const
	Diagnose every abstract-method violation on obj_class at once.
template<typename... Args>
llvm::Expected< StructuredData::GenericSP >	CreatePluginObject (const ScriptedMetadata &scripted_metadata, StructuredData::Generic *script_obj, Args... args)
template<typename T = StructuredData::ObjectSP, typename... Args>
llvm::Expected< T >	CallStaticMethod (llvm::StringRef class_name, llvm::StringRef method_name, Args &&...args)
	Call a static method on a Python class without creating an instance.
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 llvm::StringRef	GetPluginNameStatic ()
Static Public Member Functions inherited from lldb_private::ScriptedInterface
template<typename Ret>
static Ret	ErrorWithMessage (llvm::StringRef caller_name, llvm::StringRef user_msg, Status &error, LLDBLog log_category=LLDBLog::Process)
static bool	CreateInstance (lldb::ScriptLanguage language, ScriptedInterfaceUsages usages)

Private Attributes
lldb::DebuggerSP	m_debugger_sp

Additional Inherited Members
Public Types inherited from lldb_private::ScriptedPythonInterface
enum class	AbstractMethodCheckerCases { eNotImplemented , eNotAllocated , eNotCallable , eUnknownArgumentCount , eInvalidArgumentCount , eValid }
Protected Member Functions inherited from lldb_private::ScriptedPythonInterface
template<typename T = StructuredData::ObjectSP, typename... Args>
llvm::Expected< std::optional< T > >	DispatchToOptional (llvm::StringRef method_name, Args &&...args)
	Call an optional method_name, reporting "the script doesn't implement it" as `std::nullopt` rather than as a failure.
template<typename T = StructuredData::ObjectSP>
llvm::Expected< T >	ExtractValueFromPythonObject (python::PythonObject &p)
template<typename T = StructuredData::ObjectSP, typename... Args>
llvm::Expected< T >	Dispatch (llvm::StringRef method_name, Args &&...args)
	Call method_name on the scripted object.
template<typename... Args>
Status	GetStatusFromMethod (llvm::StringRef method_name, Args &&...args)
	Call method_name and fold both failure channels into one Status: a failure to call the method at all, and the SBError the method returned.
template<typename T>
T	Transform (T object)
python::PythonObject	Transform (bool arg)
python::PythonObject	Transform (const Status &arg)
python::PythonObject	Transform (Status &&arg)
python::PythonObject	Transform (const StructuredDataImpl &arg)
template<typename T, typename = std::enable_if_t< std::is_base_of_v<StructuredData::Object, T>>>
python::PythonObject	Transform (std::shared_ptr< T > arg)
python::PythonObject	Transform (lldb::ExecutionContextRefSP arg)
python::PythonObject	Transform (lldb::TargetSP arg)
python::PythonObject	Transform (lldb::BreakpointSP arg)
python::PythonObject	Transform (lldb::BreakpointLocationSP arg)
python::PythonObject	Transform (lldb::ProcessSP arg)
python::PythonObject	Transform (lldb::ThreadSP arg)
python::PythonObject	Transform (lldb::StackFrameListSP arg)
python::PythonObject	Transform (lldb::ThreadPlanSP arg)
python::PythonObject	Transform (lldb::ProcessAttachInfoSP arg)
python::PythonObject	Transform (lldb::ProcessLaunchInfoSP arg)
python::PythonObject	Transform (Event *arg)
python::PythonObject	Transform (const SymbolContext &arg)
python::PythonObject	Transform (lldb::StreamSP arg)
python::PythonObject	Transform (lldb::StackFrameSP arg)
python::PythonObject	Transform (lldb::DataExtractorSP arg)
python::PythonObject	Transform (lldb::DescriptionLevel arg)
python::PythonObject	Transform (lldb::StepType arg)
python::PythonObject	Transform (lldb::ValueObjectSP arg)
python::PythonObject	Transform (lldb::DebuggerSP arg)
python::PythonObject	Transform (const std::vector< std::string > &arg)
python::ScopedPythonObject< lldb::SBCommandReturnObject >	Transform (CommandReturnObject *arg)
python::PythonObject	Transform (const TypeSummaryOptions &arg)
template<typename T, typename U>
void	ReverseTransform (T &original_arg, U transformed_arg, Status &error)
template<typename T>
void	ReverseTransform (T &original_arg, python::PythonObject transformed_arg, Status &error)
template<typename T>
void	ReverseTransform (const T &original_arg, python::PythonObject transformed_arg, Status &error)
void	ReverseTransform (bool &original_arg, python::PythonObject transformed_arg, Status &error)
template<std::size_t... I, typename... Args>
auto	TransformTuple (const std::tuple< Args... > &args, std::index_sequence< I... >)
template<typename... Args>
auto	TransformArgs (const std::tuple< Args... > &args)
template<typename T, typename U>
void	TransformBack (T &original_arg, U transformed_arg, Status &error)
template<typename T, typename SB>
void	TransformBack (T &original_arg, python::ScopedPythonObject< SB > &transformed_arg, Status &error)
template<std::size_t... I, typename... Ts, typename... Us>
bool	ReassignPtrsOrRefsArgs (std::tuple< Ts... > &original_args, std::tuple< Us... > &transformed_args, std::index_sequence< I... >)
template<typename... Ts, typename... Us>
bool	ReassignPtrsOrRefsArgs (std::tuple< Ts... > &original_args, std::tuple< Us... > &transformed_args)
template<typename T, typename... Args>
void	FormatArgs (std::string &fmt, T arg, Args... args) const
template<typename T>
void	FormatArgs (std::string &fmt, T arg) const
void	FormatArgs (std::string &fmt) const
template<>
llvm::Expected< Status >	ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< Event * >	ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< CommandReturnObject * >	ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< SymbolContext >	ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< Status >	ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< Event * >	ExtractValueFromPythonObject (python::PythonObject &p)
template<>
llvm::Expected< SymbolContext >	ExtractValueFromPythonObject (python::PythonObject &p)
Static Protected Member Functions inherited from lldb_private::ScriptedPythonInterface
static std::string	ExtractPythonError (llvm::Error error)
	Extract detailed error message including Python backtrace if available.
template<typename... Ts>
static llvm::Error	LogAndError (llvm::StringRef caller_name, const char *format, Ts &&...ts)
	Log message against caller_name and return it as an error.
template<typename T>
static T	LogAndDefault (llvm::Expected< T > value_or_err, llvm::StringRef caller)
	Log the failure in value_or_err and fall back to a default-constructed `T`.
template<std::size_t N, typename Tuple, typename Fn, std::size_t... I>
static void	ApplyPrefixImpl (Tuple &&t, Fn &&fn, std::index_sequence< I... >)
template<std::size_t N, typename Tuple, typename Fn>
static void	ApplyPrefix (Tuple &&t, Fn &&fn)
template<typename Tuple, std::size_t... Is, typename Fn>
static void	CallWithArity (size_t call_arity, Tuple &&t, std::index_sequence< Is... >, Fn &&fn)
Protected Attributes inherited from lldb_private::ScriptedInterface
StructuredData::GenericSP	m_object_instance_sp
std::optional< ScriptedMetadata >	m_scripted_metadata
Protected Attributes inherited from lldb_private::ScriptedPythonInterface
ScriptInterpreterPythonImpl &	m_interpreter

Detailed Description

Definition at line 17 of file ScriptedCommandPythonInterface.h.

Constructor & Destructor Documentation

◆ ScriptedCommandPythonInterface()

ScriptedCommandPythonInterface::ScriptedCommandPythonInterface ( ScriptInterpreterPythonImpl & interpreter )

Definition at line 29 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::ScriptedPythonInterface().

Member Function Documentation

◆ CreatePluginObject()

llvm::Expected< StructuredData::GenericSP > ScriptedCommandPythonInterface::CreatePluginObject	(	llvm::StringRef	class_name,
		lldb::DebuggerSP	debugger_sp )

overridevirtual

Implements lldb_private::ScriptedCommandInterface.

Definition at line 34 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::CreatePluginObject(), and m_debugger_sp.

◆ GetAbstractMethodRequirements()

llvm::SmallVector< AbstractMethodRequirement > lldb_private::ScriptedCommandPythonInterface::GetAbstractMethodRequirements ( ) const

inlineoverridevirtual

Implements lldb_private::ScriptedInterface.

Definition at line 28 of file ScriptedCommandPythonInterface.h.

◆ GetArgumentsDefinition()

StructuredData::ObjectSP ScriptedCommandPythonInterface::GetArgumentsDefinition ( )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 204 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ GetFlags()

uint32_t ScriptedCommandPythonInterface::GetFlags ( )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 188 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ GetLongHelp()

bool ScriptedCommandPythonInterface::GetLongHelp ( std::string & dest )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 178 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ GetOptionsDefinition()

StructuredData::ObjectSP ScriptedCommandPythonInterface::GetOptionsDefinition ( )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 198 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ GetPluginName()

llvm::StringRef lldb_private::ScriptedCommandPythonInterface::GetPluginName ( )

inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 74 of file ScriptedCommandPythonInterface.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

llvm::StringRef lldb_private::ScriptedCommandPythonInterface::GetPluginNameStatic ( )

inlinestatic

Definition at line 70 of file ScriptedCommandPythonInterface.h.

Referenced by GetPluginName(), and Initialize().

◆ GetRepeatCommand()

std::optional< std::string > ScriptedCommandPythonInterface::GetRepeatCommand ( Args & args )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 116 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), lldb_private::Args::GetQuotedCommandString(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ GetShortHelp()

bool ScriptedCommandPythonInterface::GetShortHelp ( std::string & dest )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 168 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ HandleArgumentCompletion()

StructuredData::DictionarySP ScriptedCommandPythonInterface::HandleArgumentCompletion	(	std::vector< std::string > &	args,
		size_t	args_pos,
		size_t	char_in_arg )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 128 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), lldb::eStructuredDataTypeInvalid, and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ HandleOptionArgumentCompletion()

StructuredData::DictionarySP ScriptedCommandPythonInterface::HandleOptionArgumentCompletion	(	llvm::StringRef &	long_option,
		size_t	char_in_arg )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 142 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), lldb::eStructuredDataTypeBoolean, lldb::eStructuredDataTypeInvalid, and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ Initialize()

void ScriptedCommandPythonInterface::Initialize ( )

static

Definition at line 229 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedInterface::CreateInstance(), lldb::eScriptedExtensionScriptedCommand, lldb::eScriptLanguagePython, GetPluginNameStatic(), and lldb_private::PluginManager::RegisterPlugin().

Referenced by lldb_private::ScriptInterpreterPythonInterfaces::Initialize().

◆ OptionParsingStarted()

void ScriptedCommandPythonInterface::OptionParsingStarted ( )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 208 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptedPythonInterface::Dispatch(), and lldb_private::ScriptedPythonInterface::LogAndDefault().

◆ RunParsedCommand()

bool ScriptedCommandPythonInterface::RunParsedCommand	(	Args &	args,
		ScriptedCommandSynchronicity	synchronicity,
		CommandReturnObject &	cmd_retobj,
		Status &	error,
		const ExecutionContext &	exe_ctx )

overridevirtual

Reimplemented from lldb_private::ScriptedCommandInterface.

Definition at line 82 of file ScriptedCommandPythonInterface.cpp.

References lldb_private::ScriptInterpreterPythonImpl::Locker::AcquireLock, lldb_private::ScriptedPythonInterface::Dispatch(), lldb::eReturnStatusFailed, error(), lldb_private::ScriptInterpreterPythonImpl::Locker::FreeLock, lldb_private::Status::FromError(), lldb_private::Status::FromErrorString(), lldb_private::CommandReturnObject::GetInteractive(), lldb_private::CommandReturnObject::GetStatus(), lldb_private::ScriptInterpreterPythonImpl::Locker::InitSession, m_debugger_sp, lldb_private::ScriptedPythonInterface::m_interpreter, lldb_private::ScriptInterpreterPythonImpl::Locker::NoSTDIN, and lldb_private::ScriptInterpreterPythonImpl::Locker::TearDownSession.

◆ RunRawCommand()

bool ScriptedCommandPythonInterface::RunRawCommand	(	llvm::StringRef	args,
		ScriptedCommandSynchronicity	synchronicity,
		CommandReturnObject &	cmd_retobj,
		Status &	error,
		const ExecutionContext &	exe_ctx )