#include <ClangExpressionSourceCode.h>

Inheritance diagram for lldb_private::ClangExpressionSourceCode:

Public Types
enum class	WrapKind { CppMemberFunction , ObjCInstanceMethod , ObjCStaticMethod , Function }
	The possible ways an expression can be wrapped. More...

Public Member Functions
bool	GetText (std::string &text, ExecutionContext &exe_ctx, bool add_locals, bool force_add_all_locals, llvm::ArrayRef< std::string > modules) const
	Generates the source code that will evaluate the expression.

bool	GetOriginalBodyBounds (std::string transformed_text, size_t &start_loc, size_t &end_loc)

Public Member Functions inherited from lldb_private::ExpressionSourceCode
bool	NeedsWrapping () const

const char *	GetName () const

Static Public Member Functions
static ClangExpressionSourceCode *	CreateWrapped (llvm::StringRef filename, llvm::StringRef prefix, llvm::StringRef body, WrapKind wrap_kind)

Static Public Attributes
static const llvm::StringRef	g_prefix_file_name = PREFIX_NAME
	The file name we use for the wrapper code that we inject before the user expression.

static const char *	g_expression_prefix

static const char *	g_expression_suffix

Protected Member Functions
	ClangExpressionSourceCode (llvm::StringRef filename, llvm::StringRef name, llvm::StringRef prefix, llvm::StringRef body, Wrapping wrap, WrapKind wrap_kind)

Protected Member Functions inherited from lldb_private::ExpressionSourceCode
	ExpressionSourceCode (llvm::StringRef name, llvm::StringRef prefix, llvm::StringRef body, Wrapping wrap)

Private Member Functions
void	AddLocalVariableDecls (StreamString &stream, const std::string &expr, StackFrame *frame) const
	Writes "using" declarations for local variables into the specified stream.

Private Attributes
std::string	m_start_marker
	String marking the start of the user expression.

std::string	m_end_marker
	String marking the end of the user expression.

const WrapKind	m_wrap_kind
	How the expression has been wrapped.

Additional Inherited Members
Protected Types inherited from lldb_private::ExpressionSourceCode
enum	Wrapping : bool { Wrap = true , NoWrap = false }

Protected Attributes inherited from lldb_private::ExpressionSourceCode
std::string	m_name

std::string	m_prefix

std::string	m_body

Wrapping	m_wrap

Detailed Description

Definition at line 24 of file ClangExpressionSourceCode.h.

Member Enumeration Documentation

◆ WrapKind

enum class lldb_private::ClangExpressionSourceCode::WrapKind

strong

The possible ways an expression can be wrapped.

Enumerator
CppMemberFunction	Wrapped in a non-static member function of a C++ class.
ObjCInstanceMethod	Wrapped in an instance Objective-C method.
ObjCStaticMethod	Wrapped in a static Objective-C method.
Function	Wrapped in a non-member function. Note that this is also used for static member functions of a C++ class.

Definition at line 33 of file ClangExpressionSourceCode.h.

Constructor & Destructor Documentation

◆ ClangExpressionSourceCode()

lldb_private::ClangExpressionSourceCode::ClangExpressionSourceCode	(	llvm::StringRef	filename,
		llvm::StringRef	name,
		llvm::StringRef	prefix,
		llvm::StringRef	body,
		Wrapping	wrap,
		WrapKind	wrap_kind
	)

protected

Definition at line 193 of file ClangExpressionSourceCode.cpp.

References g_expression_suffix, m_end_marker, and m_start_marker.

Member Function Documentation

◆ AddLocalVariableDecls()

void ClangExpressionSourceCode::AddLocalVariableDecls	(	StreamString &	stream,
		const std::string &	expr,
		StackFrame *	frame
	)		const

private

Writes "using" declarations for local variables into the specified stream.

Behaviour is undefined if 'frame == nullptr'.

Parameters

[out]	stream	Stream that this function generates "using" declarations into.
[in]	expr	Expression source that we're evaluating.
[in]	frame	StackFrame which carries information about the local variables that we're generating "using" declarations for.

Definition at line 310 of file ClangExpressionSourceCode.cpp.

References lldb_private::ConstString::AsCString(), CppMemberFunction, lldb_private::StackFrame::GetInScopeVariableList(), lldb_private::ConstString::GetStringRef(), m_wrap_kind, ObjCInstanceMethod, ObjCStaticMethod, and lldb_private::Stream::Printf().

Referenced by GetText().

◆ CreateWrapped()

static ClangExpressionSourceCode * lldb_private::ClangExpressionSourceCode::CreateWrapped	(	llvm::StringRef	filename,
		llvm::StringRef	prefix,
		llvm::StringRef	body,
		WrapKind	wrap_kind
	)

inlinestatic

Definition at line 45 of file ClangExpressionSourceCode.h.

References lldb_private::ExpressionSourceCode::Wrap.

Referenced by lldb_private::ClangUserExpression::CreateSourceCode().

◆ GetOriginalBodyBounds()

bool ClangExpressionSourceCode::GetOriginalBodyBounds	(	std::string	transformed_text,
		size_t &	start_loc,
		size_t &	end_loc
	)

Definition at line 521 of file ClangExpressionSourceCode.cpp.

References m_end_marker, and m_start_marker.

◆ GetText()

bool ClangExpressionSourceCode::GetText	(	std::string &	text,
		ExecutionContext &	exe_ctx,
		bool	add_locals,
		bool	force_add_all_locals,
		llvm::ArrayRef< std::string >	modules
	)		const

Generates the source code that will evaluate the expression.

Parameters

text	output parameter containing the source code string.
exe_ctx	The execution context in which the expression will be evaluated.
add_locals	True iff local variables should be injected into the expression source code.
force_add_all_locals	True iff all local variables should be injected even if they are not used in the expression.
modules	A list of (C++) modules that the expression should import.