#include <SBCommandReturnObject.h>

Public Member Functions
	SBCommandReturnObject ()

	SBCommandReturnObject (const lldb::SBCommandReturnObject &rhs)

	~SBCommandReturnObject ()

lldb::SBCommandReturnObject &	operator= (const lldb::SBCommandReturnObject &rhs)

	operator bool () const

bool	IsValid () const

const char *	GetOutput ()

const char *	GetError ()

SBStructuredData	GetErrorData ()

	LLDB_DEPRECATED_FIXME ("Use PutOutput(SBFile) or PutOutput(FileSP)", "PutOutput(SBFile)") size_t PutOutput(FILE *fh)

size_t	PutOutput (SBFile file)

size_t	PutOutput (FileSP BORROWED)

size_t	GetOutputSize ()

size_t	GetErrorSize ()

	LLDB_DEPRECATED_FIXME ("Use PutError(SBFile) or PutError(FileSP)", "PutError(SBFile)") size_t PutError(FILE *fh)

size_t	PutError (SBFile file)

size_t	PutError (FileSP BORROWED)

void	Clear ()

lldb::ReturnStatus	GetStatus ()

void	SetStatus (lldb::ReturnStatus status)

bool	Succeeded ()

bool	HasResult ()

void	AppendMessage (const char *message)

void	AppendWarning (const char *message)

bool	GetDescription (lldb::SBStream &description)

	LLDB_DEPRECATED_FIXME ("Use SetImmediateOutputFile(SBFile) or SetImmediateOutputFile(FileSP)", "SetImmediateOutputFile(SBFile)") void SetImmediateOutputFile(FILE *fh)

	LLDB_DEPRECATED_FIXME ("Use SetImmediateErrorFile(SBFile) or SetImmediateErrorFile(FileSP)", "SetImmediateErrorFile(SBFile)") void SetImmediateErrorFile(FILE *fh)

	LLDB_DEPRECATED_FIXME ("Use SetImmediateOutputFile(SBFile) or SetImmediateOutputFile(FileSP)", "SetImmediateOutputFile(SBFile)") void SetImmediateOutputFile(FILE *fh

	LLDB_DEPRECATED_FIXME ("Use SetImmediateErrorFile(SBFile) or SetImmediateErrorFile(FileSP)", "SetImmediateErrorFile(SBFile)") void SetImmediateErrorFile(FILE *fh

void	SetImmediateOutputFile (SBFile file)

void	SetImmediateErrorFile (SBFile file)

void	SetImmediateOutputFile (FileSP BORROWED)

void	SetImmediateErrorFile (FileSP BORROWED)

void	PutCString (const char *string, int len=-1)

	__attribute__ ((format(printf, 2, 3))) size_t Printf(const char *format

const char *	GetOutput (bool only_if_no_immediate)

const char *	GetError (bool only_if_no_immediate)

void	SetError (lldb::SBError &error, const char *fallback_error_cstr=nullptr)

void	SetError (const char *error_cstr)

Public Attributes
bool	transfer_ownership

Protected Member Functions
	SBCommandReturnObject (lldb_private::CommandReturnObject &ref)

lldb_private::CommandReturnObject *	operator-> () const

lldb_private::CommandReturnObject *	get () const

lldb_private::CommandReturnObject &	operator* () const

Private Member Functions
lldb_private::CommandReturnObject &	ref () const

Private Attributes
std::unique_ptr< lldb_private::SBCommandReturnObjectImpl >	m_opaque_up

Friends
class	SBCommandInterpreter

class	SBOptions

class	lldb_private::CommandPluginInterfaceImplementation

class	lldb_private::python::SWIGBridge

Detailed Description

Definition at line 28 of file SBCommandReturnObject.h.

Constructor & Destructor Documentation

◆ SBCommandReturnObject() [1/3]

SBCommandReturnObject::SBCommandReturnObject ( )

Definition at line 49 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA.

◆ SBCommandReturnObject() [2/3]

SBCommandReturnObject::SBCommandReturnObject ( const lldb::SBCommandReturnObject & rhs )

Definition at line 59 of file SBCommandReturnObject.cpp.

References lldb_private::clone(), LLDB_INSTRUMENT_VA, and m_opaque_up.

◆ ~SBCommandReturnObject()

SBCommandReturnObject::~SBCommandReturnObject ( )

default

◆ SBCommandReturnObject() [3/3]

SBCommandReturnObject::SBCommandReturnObject ( lldb_private::CommandReturnObject & ref )

protected

Definition at line 54 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, and ref().

Member Function Documentation

◆ attribute()

lldb::SBCommandReturnObject::__attribute__ ( (format(printf, 2, 3)) ) const

◆ AppendMessage()

void SBCommandReturnObject::AppendMessage ( const char * message )

Definition at line 200 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::AppendMessage(), LLDB_INSTRUMENT_VA, and ref().

Referenced by lldb::SBProcess::AppendEventStateReport().

◆ AppendWarning()

void SBCommandReturnObject::AppendWarning ( const char * message )

Definition at line 206 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::AppendWarning(), LLDB_INSTRUMENT_VA, and ref().

◆ Clear()

void SBCommandReturnObject::Clear ( )

Definition at line 170 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::Clear(), LLDB_INSTRUMENT_VA, and ref().

Referenced by lldb::SBCommandInterpreter::HandleCommand(), lldb::SBCommandInterpreter::ResolveCommand(), lldb::SBCommandInterpreter::SourceInitFileInCurrentWorkingDirectory(), lldb::SBCommandInterpreter::SourceInitFileInGlobalDirectory(), and lldb::SBCommandInterpreter::SourceInitFileInHomeDirectory().

◆ get()

CommandReturnObject * SBCommandReturnObject::get ( ) const

protected

Definition at line 216 of file SBCommandReturnObject.cpp.

References m_opaque_up.

Referenced by GetError(), and GetOutput().

◆ GetDescription()

bool SBCommandReturnObject::GetDescription ( lldb::SBStream & description )

Definition at line 228 of file SBCommandReturnObject.cpp.

References lldb::eReturnStatusInvalid, lldb::eReturnStatusStarted, GetError(), GetErrorSize(), GetOutput(), GetOutputSize(), lldb_private::CommandReturnObject::GetStatus(), LLDB_INSTRUMENT_VA, lldb_private::Stream::Printf(), lldb_private::Stream::PutCString(), lldb::SBStream::ref(), ref(), and Succeeded().

◆ GetError() [1/2]

const char * SBCommandReturnObject::GetError ( )

Definition at line 94 of file SBCommandReturnObject.cpp.

References lldb_private::ConstString::AsCString(), LLDB_INSTRUMENT_VA, and ref().

Referenced by GetDescription(), GetError(), and PutError().

◆ GetError() [2/2]

const char * SBCommandReturnObject::GetError ( bool only_if_no_immediate )

Definition at line 320 of file SBCommandReturnObject.cpp.

References get(), GetError(), LLDB_INSTRUMENT_VA, and ref().

◆ GetErrorData()

SBStructuredData SBCommandReturnObject::GetErrorData ( )

Definition at line 101 of file SBCommandReturnObject.cpp.

References GetErrorData(), LLDB_INSTRUMENT_VA, lldb::SBStructuredData::m_impl_up, and ref().

Referenced by GetErrorData().

◆ GetErrorSize()

size_t SBCommandReturnObject::GetErrorSize ( )

Definition at line 116 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::GetErrorString(), LLDB_INSTRUMENT_VA, and ref().

Referenced by GetDescription().

◆ GetOutput() [1/2]

const char * SBCommandReturnObject::GetOutput ( )

Definition at line 87 of file SBCommandReturnObject.cpp.

References lldb_private::ConstString::AsCString(), LLDB_INSTRUMENT_VA, and ref().

Referenced by GetDescription(), GetOutput(), and PutOutput().

◆ GetOutput() [2/2]

const char * SBCommandReturnObject::GetOutput ( bool only_if_no_immediate )

Definition at line 311 of file SBCommandReturnObject.cpp.

References get(), GetOutput(), LLDB_INSTRUMENT_VA, and ref().

◆ GetOutputSize()

size_t SBCommandReturnObject::GetOutputSize ( )

Definition at line 110 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::GetOutputString(), LLDB_INSTRUMENT_VA, and ref().

Referenced by GetDescription().

◆ GetStatus()

lldb::ReturnStatus SBCommandReturnObject::GetStatus ( )

Definition at line 176 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::GetStatus(), LLDB_INSTRUMENT_VA, and ref().

Referenced by lldb::SBCommandInterpreter::HandleCommand().

◆ HasResult()

bool SBCommandReturnObject::HasResult ( )

Definition at line 194 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::HasResult(), LLDB_INSTRUMENT_VA, and ref().

◆ IsValid()

bool SBCommandReturnObject::IsValid ( ) const

Definition at line 76 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA.

◆ LLDB_DEPRECATED_FIXME() [1/6]

lldb::SBCommandReturnObject::LLDB_DEPRECATED_FIXME	(	"Use PutError(SBFile) or PutError(FileSP)"	,
		"PutError(SBFile)"
	)

◆ LLDB_DEPRECATED_FIXME() [2/6]

lldb::SBCommandReturnObject::LLDB_DEPRECATED_FIXME	(	"Use PutOutput(SBFile) or PutOutput(FileSP)"	,
		"PutOutput(SBFile)"
	)

◆ LLDB_DEPRECATED_FIXME() [3/6]

lldb::SBCommandReturnObject::LLDB_DEPRECATED_FIXME	(	"Use SetImmediateErrorFile(SBFile) or SetImmediateErrorFile(FileSP)"	,
		"SetImmediateErrorFile(SBFile)"
	)

◆ LLDB_DEPRECATED_FIXME() [4/6]

lldb::SBCommandReturnObject::LLDB_DEPRECATED_FIXME	(	"Use SetImmediateErrorFile(SBFile) or SetImmediateErrorFile(FileSP)"	,
		"SetImmediateErrorFile(SBFile)"
	)

◆ LLDB_DEPRECATED_FIXME() [5/6]

lldb::SBCommandReturnObject::LLDB_DEPRECATED_FIXME	(	"Use SetImmediateOutputFile(SBFile) or SetImmediateOutputFile(FileSP)"	,
		"SetImmediateOutputFile(SBFile)"
	)

◆ LLDB_DEPRECATED_FIXME() [6/6]

lldb::SBCommandReturnObject::LLDB_DEPRECATED_FIXME	(	"Use SetImmediateOutputFile(SBFile) or SetImmediateOutputFile(FileSP)"	,
		"SetImmediateOutputFile(SBFile)"
	)

◆ operator bool()

SBCommandReturnObject::operator bool ( ) const

explicit

Definition at line 80 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator*()

CommandReturnObject & SBCommandReturnObject::operator* ( ) const

protected

Definition at line 220 of file SBCommandReturnObject.cpp.

References m_opaque_up.

◆ operator->()

CommandReturnObject * SBCommandReturnObject::operator-> ( ) const

protected

Definition at line 212 of file SBCommandReturnObject.cpp.

References m_opaque_up.

◆ operator=()

SBCommandReturnObject & SBCommandReturnObject::operator= ( const lldb::SBCommandReturnObject & rhs )

Definition at line 65 of file SBCommandReturnObject.cpp.

References lldb_private::clone(), LLDB_INSTRUMENT_VA, and m_opaque_up.

◆ PutCString()

void SBCommandReturnObject::PutCString	(	const char *	string,
		int	len = `-1`
	)

Definition at line 299 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::AppendMessage(), LLDB_INSTRUMENT_VA, and ref().

◆ PutError() [1/2]

size_t SBCommandReturnObject::PutError ( FileSP BORROWED )

Definition at line 156 of file SBCommandReturnObject.cpp.

References GetError(), and LLDB_INSTRUMENT_VA.

◆ PutError() [2/2]

size_t SBCommandReturnObject::PutError ( SBFile file )

Definition at line 163 of file SBCommandReturnObject.cpp.

References GetError(), LLDB_INSTRUMENT_VA, and lldb::SBFile::m_opaque_sp.

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

◆ PutOutput() [1/2]

size_t SBCommandReturnObject::PutOutput ( FileSP BORROWED )

Definition at line 132 of file SBCommandReturnObject.cpp.

References GetOutput(), and LLDB_INSTRUMENT_VA.

◆ PutOutput() [2/2]

size_t SBCommandReturnObject::PutOutput ( SBFile file )

Definition at line 139 of file SBCommandReturnObject.cpp.

References GetOutput(), LLDB_INSTRUMENT_VA, and lldb::SBFile::m_opaque_sp.

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

◆ ref()

CommandReturnObject & SBCommandReturnObject::ref ( ) const

private

◆ SetError() [1/2]

void SBCommandReturnObject::SetError ( const char * error_cstr )

Definition at line 346 of file SBCommandReturnObject.cpp.

References lldb_private::CommandReturnObject::AppendError(), LLDB_INSTRUMENT_VA, and ref().

◆ SetError() [2/2]

void SBCommandReturnObject::SetError	(	lldb::SBError &	error,
		const char *	fallback_error_cstr = `nullptr`
	)

Definition at line 336 of file SBCommandReturnObject.cpp.

References error(), lldb_private::Status::FromErrorString(), LLDB_INSTRUMENT_VA, ref(), and lldb_private::CommandReturnObject::SetError().

◆ SetImmediateErrorFile() [1/2]

void SBCommandReturnObject::SetImmediateErrorFile ( FileSP BORROWED )

Definition at line 294 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, and SetImmediateErrorFile().

◆ SetImmediateErrorFile() [2/2]

void SBCommandReturnObject::SetImmediateErrorFile ( SBFile file )

Definition at line 284 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, lldb::SBFile::m_opaque_sp, ref(), and lldb_private::CommandReturnObject::SetImmediateErrorFile().

Referenced by SetImmediateErrorFile().

◆ SetImmediateOutputFile() [1/2]

void SBCommandReturnObject::SetImmediateOutputFile ( FileSP BORROWED )

Definition at line 289 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, and SetImmediateOutputFile().

◆ SetImmediateOutputFile() [2/2]

void SBCommandReturnObject::SetImmediateOutputFile ( SBFile file )

Definition at line 279 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, lldb::SBFile::m_opaque_sp, ref(), and lldb_private::CommandReturnObject::SetImmediateOutputFile().

Referenced by SetImmediateOutputFile().

◆ SetStatus()

void SBCommandReturnObject::SetStatus ( lldb::ReturnStatus status )

Definition at line 182 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, ref(), and lldb_private::CommandReturnObject::SetStatus().

◆ Succeeded()

bool SBCommandReturnObject::Succeeded ( )

Definition at line 188 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, ref(), and lldb_private::CommandReturnObject::Succeeded().

Referenced by GetDescription().

Friends And Related Function Documentation

◆ lldb_private::CommandPluginInterfaceImplementation

friend class lldb_private::CommandPluginInterfaceImplementation

friend

Definition at line 139 of file SBCommandReturnObject.h.

◆ lldb_private::python::SWIGBridge

friend class lldb_private::python::SWIGBridge

friend

Definition at line 140 of file SBCommandReturnObject.h.

◆ SBCommandInterpreter

friend class SBCommandInterpreter

friend

Definition at line 136 of file SBCommandReturnObject.h.

◆ SBOptions

friend class SBOptions

friend

Definition at line 137 of file SBCommandReturnObject.h.

Member Data Documentation

◆ m_opaque_up

std::unique_ptr<lldb_private::SBCommandReturnObjectImpl> lldb::SBCommandReturnObject::m_opaque_up

private

Definition at line 153 of file SBCommandReturnObject.h.

Referenced by get(), operator*(), operator->(), operator=(), ref(), and SBCommandReturnObject().

◆ transfer_ownership

bool lldb::SBCommandReturnObject::transfer_ownership

Definition at line 104 of file SBCommandReturnObject.h.

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

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SBCommandReturnObject() [1/3]

◆ SBCommandReturnObject() [2/3]

◆ ~SBCommandReturnObject()

◆ SBCommandReturnObject() [3/3]

Member Function Documentation

◆ __attribute__()

◆ AppendMessage()

◆ AppendWarning()

◆ Clear()

◆ get()

◆ GetDescription()

◆ GetError() [1/2]

◆ GetError() [2/2]

◆ GetErrorData()

◆ GetErrorSize()

◆ GetOutput() [1/2]

◆ GetOutput() [2/2]

◆ GetOutputSize()

◆ GetStatus()

◆ HasResult()

◆ IsValid()

◆ LLDB_DEPRECATED_FIXME() [1/6]

◆ LLDB_DEPRECATED_FIXME() [2/6]

◆ LLDB_DEPRECATED_FIXME() [3/6]

◆ LLDB_DEPRECATED_FIXME() [4/6]

◆ LLDB_DEPRECATED_FIXME() [5/6]

◆ LLDB_DEPRECATED_FIXME() [6/6]

◆ operator bool()

◆ operator*()

◆ operator->()

◆ operator=()

◆ PutCString()

◆ PutError() [1/2]

◆ PutError() [2/2]

◆ PutOutput() [1/2]

◆ PutOutput() [2/2]

◆ ref()

◆ SetError() [1/2]

◆ SetError() [2/2]

◆ SetImmediateErrorFile() [1/2]

◆ SetImmediateErrorFile() [2/2]

◆ SetImmediateOutputFile() [1/2]

◆ SetImmediateOutputFile() [2/2]

◆ SetStatus()

◆ Succeeded()

Friends And Related Function Documentation

◆ lldb_private::CommandPluginInterfaceImplementation

◆ lldb_private::python::SWIGBridge

◆ SBCommandInterpreter

◆ SBOptions

Member Data Documentation

◆ m_opaque_up

◆ transfer_ownership

◆ attribute()