"lldb/Expression/ClangUtilityFunction.h" Encapsulates a single expression for use with Clang More...

#include <ClangUtilityFunction.h>

Inheritance diagram for lldb_private::ClangUtilityFunction:

Classes
class	ClangUtilityFunctionHelper

Public Member Functions
bool	isA (const void *ClassID) const override

	ClangUtilityFunction (ExecutionContextScope &exe_scope, std::string text, std::string name, bool enable_debugging)
	Constructor.

	~ClangUtilityFunction () override

ExpressionTypeSystemHelper *	GetTypeSystemHelper () override

ClangExpressionDeclMap *	DeclMap ()

void	ResetDeclMap ()

void	ResetDeclMap (ExecutionContext &exe_ctx, bool keep_result_in_memory)

bool	Install (DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx) override
	Install the utility function into a process.

Public Member Functions inherited from lldb_private::UtilityFunction
bool	isA (const void *ClassID) const override

	UtilityFunction (ExecutionContextScope &exe_scope, std::string text, std::string name, bool enable_debugging)
	Constructor.

	~UtilityFunction () override

virtual bool	Install (DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx)=0
	Install the utility function into a process.

bool	ContainsAddress (lldb::addr_t address)
	Check whether the given address is inside the function.

const char *	Text () override
	Return the string that the parser should parse.

const char *	FunctionName () override
	Return the function name that should be used for executing the expression.

ExpressionVariableList *	LocalVariables ()
	Return the object that the parser should use when registering local variables.

bool	NeedsValidation () override
	Return true if validation code should be inserted into the expression.

bool	NeedsVariableResolution () override
	Return true if external variables in the expression should be resolved.

FunctionCaller *	MakeFunctionCaller (const CompilerType &return_type, const ValueList &arg_value_list, lldb::ThreadSP compilation_thread, Status &error)

FunctionCaller *	GetFunctionCaller ()

Public Member Functions inherited from lldb_private::Expression
	Expression (Target &target)

	Expression (ExecutionContextScope &exe_scope)

virtual	~Expression ()=default
	Destructor.

virtual const char *	Text ()=0
	Return the string that the parser should parse.

virtual const char *	FunctionName ()=0
	Return the function name that should be used for executing the expression.

virtual lldb::LanguageType	Language () const
	Return the language that should be used when parsing.

virtual Materializer *	GetMaterializer ()
	Return the Materializer that the parser should use when registering external values.

virtual ResultType	DesiredResultType ()
	Return the desired result type of the function, or eResultTypeAny if indifferent.

virtual bool	NeedsValidation ()=0
	Flags.

virtual bool	NeedsVariableResolution ()=0
	Return true if external variables in the expression should be resolved.

virtual EvaluateExpressionOptions *	GetOptions ()

lldb::addr_t	StartAddress ()
	Return the address of the function's JIT-compiled code, or LLDB_INVALID_ADDRESS if the function is not JIT compiled.

virtual void	WillStartExecuting ()
	Called to notify the expression that it is about to be executed.

virtual void	DidFinishExecuting ()
	Called to notify the expression that its execution has finished.

virtual ExpressionTypeSystemHelper *	GetTypeSystemHelper ()

virtual bool	isA (const void *ClassID) const =0

Static Public Member Functions
static bool	classof (const Expression *obj)

Static Public Member Functions inherited from lldb_private::UtilityFunction
static bool	classof (const Expression *obj)

Private Attributes
ClangUtilityFunctionHelper	m_type_system_helper
	The map to use when parsing and materializing the expression.

Static Private Attributes
static char	ID

Additional Inherited Members
Public Types inherited from lldb_private::Expression
enum	ResultType { eResultTypeAny , eResultTypeId }

Protected Attributes inherited from lldb_private::UtilityFunction
std::shared_ptr< IRExecutionUnit >	m_execution_unit_sp

lldb::ModuleWP	m_jit_module_wp

std::string	m_function_text
	The text of the function. Must be a well-formed translation unit.

std::string	m_function_name
	The name of the function.

std::unique_ptr< FunctionCaller >	m_caller_up

Protected Attributes inherited from lldb_private::Expression
lldb::TargetWP	m_target_wp

lldb::ProcessWP	m_jit_process_wp
	Expression's always have to have a target...

lldb::addr_t	m_jit_start_addr
	An expression might have a process, but it doesn't need to (e.g.

lldb::addr_t	m_jit_end_addr
	The address of the JITted function within the JIT allocation.

Detailed Description

"lldb/Expression/ClangUtilityFunction.h" Encapsulates a single expression for use with Clang

LLDB uses expressions for various purposes, notably to call functions and as a backend for the expr command. ClangUtilityFunction encapsulates a self-contained function meant to be used from other code. Utility functions can perform error-checking for ClangUserExpressions, or can simply provide a way to push a function into the target for the debugger to call later on.

Definition at line 34 of file ClangUtilityFunction.h.

Constructor & Destructor Documentation

◆ ClangUtilityFunction()

ClangUtilityFunction::ClangUtilityFunction	(	ExecutionContextScope &	exe_scope,
		std::string	text,
		std::string	name,
		bool	enable_debugging
	)

Constructor.

Parameters

[in]	text	The text of the function. Must be a full translation unit.
[in]	name	The name of the function, as used in the text.
[in]	enable_debugging	Enable debugging of this function.

Definition at line 32 of file ClangUtilityFunction.cpp.

References lldb_private::NativeFile::Close(), lldb_private::File::eOpenOptionWriteOnly, lldb_private::ClangExpressionSourceCode::g_expression_prefix, lldb_private::ClangExpressionSourceCode::g_expression_suffix, lldb_private::UtilityFunction::m_function_text, and lldb_private::NativeFile::Write().