LLDB mainline
lldb::SBCommandReturnObject Class Reference

#include <SBCommandReturnObject.h>

Public Member Functions

 SBCommandReturnObject ()
 SBCommandReturnObject (const lldb::SBCommandReturnObject &rhs)
 ~SBCommandReturnObject ()
lldb::SBCommandReturnObjectoperator= (const lldb::SBCommandReturnObject &rhs)
 operator bool () const
bool IsValid () const
const char * GetCommand ()
 Get the command as the user typed it.
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)
lldb::SBValueList GetValues (lldb::DynamicValueType use_dynamic)

Public Attributes

bool transfer_ownership

Protected Member Functions

 SBCommandReturnObject (lldb_private::CommandReturnObject &ref)
lldb_private::CommandReturnObjectoperator-> () const
lldb_private::CommandReturnObjectget () const
lldb_private::CommandReturnObjectoperator* () const

Private Member Functions

lldb_private::CommandReturnObjectref () const

Private Attributes

std::unique_ptr< lldb_private::SBCommandReturnObjectImplm_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 ( )

◆ SBCommandReturnObject() [2/3]

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

◆ ~SBCommandReturnObject()

SBCommandReturnObject::~SBCommandReturnObject ( )
default

◆ SBCommandReturnObject() [3/3]

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

Definition at line 57 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_up, and ref().

Member Function Documentation

◆ __attribute__()

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

◆ AppendMessage()

void SBCommandReturnObject::AppendMessage ( const char * message)

◆ AppendWarning()

void SBCommandReturnObject::AppendWarning ( const char * message)

◆ Clear()

◆ get()

CommandReturnObject * SBCommandReturnObject::get ( ) const
protected

Definition at line 226 of file SBCommandReturnObject.cpp.

References m_opaque_up.

Referenced by GetError(), GetOutput(), and lldb_private::python::SWIGBridge.

◆ GetCommand()

const char * SBCommandReturnObject::GetCommand ( )

Get the command as the user typed it.

Empty string if commands were run on behalf of lldb.

Definition at line 90 of file SBCommandReturnObject.cpp.

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

Referenced by GetCommand(), and ~SBCommandReturnObject().

◆ GetDescription()

◆ GetError() [1/2]

const char * SBCommandReturnObject::GetError ( )

◆ GetError() [2/2]

const char * SBCommandReturnObject::GetError ( bool only_if_no_immediate)

Definition at line 330 of file SBCommandReturnObject.cpp.

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

◆ GetErrorData()

SBStructuredData SBCommandReturnObject::GetErrorData ( )

◆ GetErrorSize()

size_t SBCommandReturnObject::GetErrorSize ( )

◆ GetOutput() [1/2]

const char * SBCommandReturnObject::GetOutput ( )

◆ GetOutput() [2/2]

const char * SBCommandReturnObject::GetOutput ( bool only_if_no_immediate)

Definition at line 321 of file SBCommandReturnObject.cpp.

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

◆ GetOutputSize()

size_t SBCommandReturnObject::GetOutputSize ( )

◆ GetStatus()

◆ GetValues()

SBValueList SBCommandReturnObject::GetValues ( lldb::DynamicValueType use_dynamic)

◆ HasResult()

bool SBCommandReturnObject::HasResult ( )

◆ IsValid()

bool SBCommandReturnObject::IsValid ( ) const

Definition at line 79 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA.

Referenced by ~SBCommandReturnObject().

◆ 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 83 of file SBCommandReturnObject.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator*()

CommandReturnObject & SBCommandReturnObject::operator* ( ) const
protected

Definition at line 230 of file SBCommandReturnObject.cpp.

References m_opaque_up.

Referenced by lldb_private::python::SWIGBridge.

◆ operator->()

CommandReturnObject * SBCommandReturnObject::operator-> ( ) const
protected

Definition at line 222 of file SBCommandReturnObject.cpp.

References m_opaque_up.

Referenced by lldb_private::python::SWIGBridge.

◆ operator=()

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

◆ PutCString()

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

◆ PutError() [1/2]

size_t SBCommandReturnObject::PutError ( FileSP BORROWED)

Definition at line 166 of file SBCommandReturnObject.cpp.

References GetError(), and LLDB_INSTRUMENT_VA.

◆ PutError() [2/2]

size_t SBCommandReturnObject::PutError ( SBFile file)

◆ PutOutput() [1/2]

size_t SBCommandReturnObject::PutOutput ( FileSP BORROWED)

Definition at line 142 of file SBCommandReturnObject.cpp.

References GetOutput(), and LLDB_INSTRUMENT_VA.

◆ PutOutput() [2/2]

size_t SBCommandReturnObject::PutOutput ( SBFile file)

◆ ref()

◆ SetError() [1/2]

void SBCommandReturnObject::SetError ( const char * error_cstr)

◆ SetError() [2/2]

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

◆ SetImmediateErrorFile() [1/2]

void SBCommandReturnObject::SetImmediateErrorFile ( FileSP BORROWED)

◆ SetImmediateErrorFile() [2/2]

◆ SetImmediateOutputFile() [1/2]

void SBCommandReturnObject::SetImmediateOutputFile ( FileSP BORROWED)

◆ SetImmediateOutputFile() [2/2]

◆ SetStatus()

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

◆ Succeeded()

bool SBCommandReturnObject::Succeeded ( )

◆ lldb_private::CommandPluginInterfaceImplementation

Definition at line 145 of file SBCommandReturnObject.h.

◆ lldb_private::python::SWIGBridge

friend class lldb_private::python::SWIGBridge
friend

Definition at line 146 of file SBCommandReturnObject.h.

References get(), operator*(), operator->(), ref(), and SBCommandReturnObject().

◆ SBCommandInterpreter

friend class SBCommandInterpreter
friend

Definition at line 142 of file SBCommandReturnObject.h.

References SBCommandInterpreter.

Referenced by SBCommandInterpreter.

◆ SBOptions

friend class SBOptions
friend

Definition at line 143 of file SBCommandReturnObject.h.

References SBOptions.

Referenced by SBOptions.

Member Data Documentation

◆ m_opaque_up

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

◆ transfer_ownership

bool lldb::SBCommandReturnObject::transfer_ownership

Definition at line 108 of file SBCommandReturnObject.h.

Referenced by LLDB_DEPRECATED_FIXME().


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