LLDB mainline
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
lldb::SBStream Class Reference

#include <SBStream.h>

Public Member Functions

 SBStream ()
 
 SBStream (SBStream &&rhs)
 
 ~SBStream ()
 
 operator bool () const
 
bool IsValid () const
 
const char * GetData ()
 
size_t GetSize ()
 
 __attribute__ ((format(printf, 2, 3))) void Printf(const char *format
 
void Print (const char *str)
 
void RedirectToFile (const char *path, bool append)
 
void RedirectToFile (lldb::SBFile file)
 
void RedirectToFile (lldb::FileSP file)
 
void RedirectToFileHandle (FILE *fh, bool transfer_fh_ownership)
 
void RedirectToFileDescriptor (int fd, bool transfer_fh_ownership)
 
void Clear ()
 

Protected Member Functions

lldb_private::Stream * operator-> ()
 
lldb_private::Stream * get ()
 
lldb_private::Stream & ref ()
 

Private Member Functions

 SBStream (const SBStream &)=delete
 
const SBStream & operator= (const SBStream &)=delete
 

Private Attributes

std::unique_ptr< lldb_private::Stream > m_opaque_up
 
bool m_is_file = false
 

Friends

class SBAddress
 
class SBAddressRange
 
class SBAddressRangeList
 
class SBBlock
 
class SBBreakpoint
 
class SBBreakpointLocation
 
class SBBreakpointName
 
class SBCommandReturnObject
 
class SBCompileUnit
 
class SBData
 
class SBDebugger
 
class SBDeclaration
 
class SBEvent
 
class SBFileSpec
 
class SBFileSpecList
 
class SBFrame
 
class SBFunction
 
class SBInstruction
 
class SBInstructionList
 
class SBLaunchInfo
 
class SBLineEntry
 
class SBMemoryRegionInfo
 
class SBModule
 
class SBModuleSpec
 
class SBModuleSpecList
 
class SBProcess
 
class SBSection
 
class SBSourceManager
 
class SBStructuredData
 
class SBSymbol
 
class SBSymbolContext
 
class SBSymbolContextList
 
class SBTarget
 
class SBThread
 
class SBThreadPlan
 
class SBType
 
class SBTypeEnumMember
 
class SBTypeMemberFunction
 
class SBTypeMember
 
class SBValue
 
class SBWatchpoint
 
class lldb_private::ScriptInterpreter
 

Detailed Description

Definition at line 22 of file SBStream.h.

Constructor & Destructor Documentation

◆ SBStream() [1/3]

SBStream::SBStream ( )

Definition at line 23 of file SBStream.cpp.

References LLDB_INSTRUMENT_VA.

◆ SBStream() [2/3]

SBStream::SBStream ( SBStream &&  rhs)

Definition at line 27 of file SBStream.cpp.

◆ ~SBStream()

SBStream::~SBStream ( )
default

◆ SBStream() [3/3]

lldb::SBStream::SBStream ( const SBStream &  )
privatedelete

Member Function Documentation

◆ __attribute__()

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

◆ Clear()

void SBStream::Clear ( )

Definition at line 183 of file SBStream.cpp.

References Clear(), LLDB_INSTRUMENT_VA, m_is_file, and m_opaque_up.

Referenced by Clear().

◆ get()

lldb_private::Stream * SBStream::get ( )
protected

Definition at line 175 of file SBStream.cpp.

References m_opaque_up.

Referenced by lldb::SBSourceManager::DisplaySourceLinesWithLineNumbersAndColumn(), lldb::SBBreakpointName::GetDescription(), lldb::SBThreadPlan::GetDescription(), and lldb::SBBreakpoint::GetDescription().

◆ GetData()

const char * SBStream::GetData ( )

Definition at line 44 of file SBStream.cpp.

References lldb_private::ConstString::GetCString(), lldb_private::StreamString::GetData(), LLDB_INSTRUMENT_VA, m_is_file, and m_opaque_up.

Referenced by lldb::SBTypeSummary::CreateWithCallback(), lldb::SBDebugger::GetSelectedTarget(), lldb::SBValue::GetSummary(), lldb::SBCommandInterpreter::HandleCommandsFromFile(), lldb::SBStructuredData::SetFromJSON(), and lldb::SBDebugger::SetSelectedTarget().

◆ GetSize()

size_t SBStream::GetSize ( )

Definition at line 56 of file SBStream.cpp.

References GetSize(), LLDB_INSTRUMENT_VA, m_is_file, and m_opaque_up.

Referenced by lldb::SBTypeSummary::CreateWithCallback(), and GetSize().

◆ IsValid()

bool SBStream::IsValid ( ) const

Definition at line 32 of file SBStream.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator bool()

SBStream::operator bool ( ) const
explicit

Definition at line 36 of file SBStream.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator->()

lldb_private::Stream * SBStream::operator-> ( )
protected

Definition at line 173 of file SBStream.cpp.

References m_opaque_up.

◆ operator=()

const SBStream & lldb::SBStream::operator= ( const SBStream &  )
privatedelete

◆ Print()

void SBStream::Print ( const char *  str)

Definition at line 65 of file SBStream.cpp.

References LLDB_INSTRUMENT_VA.

Referenced by lldb::SBStructuredData::SetFromJSON().

◆ RedirectToFile() [1/3]

void SBStream::RedirectToFile ( const char *  path,
bool  append 
)

Definition at line 80 of file SBStream.cpp.

References lldb_private::File::eOpenOptionAppend, lldb_private::File::eOpenOptionCanCreate, lldb_private::File::eOpenOptionTruncate, lldb_private::File::eOpenOptionWriteOnly, lldb_private::GetLog(), lldb_private::StreamString::GetString(), lldb_private::FileSystem::Instance(), LLDB_INSTRUMENT_VA, LLDB_LOG_ERROR, m_is_file, m_opaque_up, and lldb_private::FileSystem::Open().

Referenced by RedirectToFile(), and RedirectToFileHandle().

◆ RedirectToFile() [2/3]

void SBStream::RedirectToFile ( lldb::FileSP  file)

Definition at line 128 of file SBStream.cpp.

References lldb_private::StreamString::GetString(), LLDB_INSTRUMENT_VA, m_is_file, and m_opaque_up.

◆ RedirectToFile() [3/3]

void SBStream::RedirectToFile ( lldb::SBFile  file)

Definition at line 123 of file SBStream.cpp.

References lldb::SBFile::GetFile(), LLDB_INSTRUMENT_VA, and RedirectToFile().

◆ RedirectToFileDescriptor()

void SBStream::RedirectToFileDescriptor ( int  fd,
bool  transfer_fh_ownership 
)

Definition at line 152 of file SBStream.cpp.

References lldb_private::StreamString::GetString(), LLDB_INSTRUMENT_VA, m_is_file, and m_opaque_up.

◆ RedirectToFileHandle()

void SBStream::RedirectToFileHandle ( FILE *  fh,
bool  transfer_fh_ownership 
)

Definition at line 117 of file SBStream.cpp.

References LLDB_INSTRUMENT_VA, and RedirectToFile().

◆ ref()

lldb_private::Stream & SBStream::ref ( )
protected

Definition at line 177 of file SBStream.cpp.

References m_opaque_up.

Referenced by lldb::SBStructuredData::GetAsJSON(), lldb::SBAddress::GetDescription(), lldb::SBBlock::GetDescription(), lldb::SBCommandReturnObject::GetDescription(), lldb::SBCompileUnit::GetDescription(), lldb::SBDebugger::GetDescription(), lldb::SBDeclaration::GetDescription(), lldb::SBEvent::GetDescription(), lldb::SBFrame::GetDescription(), lldb::SBInstruction::GetDescription(), lldb::SBInstructionList::GetDescription(), lldb::SBLineEntry::GetDescription(), lldb::SBMemoryRegionInfo::GetDescription(), lldb::SBModule::GetDescription(), lldb::SBModuleSpec::GetDescription(), lldb::SBModuleSpecList::GetDescription(), lldb::SBProcess::GetDescription(), lldb::SBSection::GetDescription(), lldb::SBSymbol::GetDescription(), lldb::SBSymbolContext::GetDescription(), lldb::SBSymbolContextList::GetDescription(), lldb::SBValue::GetDescription(), lldb::SBFileSpec::GetDescription(), lldb::SBThread::GetDescription(), lldb::SBAddressRangeList::GetDescription(), lldb::SBAddressRange::GetDescription(), lldb::SBBreakpointLocation::GetDescription(), lldb::SBWatchpoint::GetDescription(), lldb::SBData::GetDescription(), lldb::SBTarget::GetDescription(), lldb::SBTypeMember::GetDescription(), lldb::SBTypeMemberFunction::GetDescription(), lldb::SBType::GetDescription(), lldb::SBTypeEnumMember::GetDescription(), lldb::SBStructuredData::GetDescription(), lldb::SBFileSpecList::GetDescription(), lldb::SBFrame::GetDescriptionWithFormat(), lldb::SBThread::GetDescriptionWithFormat(), lldb::SBValue::GetExpressionPath(), lldb::SBThread::GetInfoItemByPathAsString(), lldb::SBThread::GetStatus(), lldb::SBProcess::GetStatus(), lldb::SBThread::GetStopReasonExtendedInfoAsJSON(), and lldb::SBInstruction::TestEmulation().

Friends And Related Function Documentation

◆ lldb_private::ScriptInterpreter

friend class lldb_private::ScriptInterpreter
friend

Definition at line 110 of file SBStream.h.

◆ SBAddress

friend class SBAddress
friend

Definition at line 68 of file SBStream.h.

◆ SBAddressRange

friend class SBAddressRange
friend

Definition at line 69 of file SBStream.h.

◆ SBAddressRangeList

friend class SBAddressRangeList
friend

Definition at line 70 of file SBStream.h.

◆ SBBlock

friend class SBBlock
friend

Definition at line 71 of file SBStream.h.

◆ SBBreakpoint

friend class SBBreakpoint
friend

Definition at line 72 of file SBStream.h.

◆ SBBreakpointLocation

friend class SBBreakpointLocation
friend

Definition at line 73 of file SBStream.h.

◆ SBBreakpointName

friend class SBBreakpointName
friend

Definition at line 74 of file SBStream.h.

◆ SBCommandReturnObject

friend class SBCommandReturnObject
friend

Definition at line 75 of file SBStream.h.

◆ SBCompileUnit

friend class SBCompileUnit
friend

Definition at line 76 of file SBStream.h.

◆ SBData

friend class SBData
friend

Definition at line 77 of file SBStream.h.

◆ SBDebugger

friend class SBDebugger
friend

Definition at line 78 of file SBStream.h.

◆ SBDeclaration

friend class SBDeclaration
friend

Definition at line 79 of file SBStream.h.

◆ SBEvent

friend class SBEvent
friend

Definition at line 80 of file SBStream.h.

◆ SBFileSpec

friend class SBFileSpec
friend

Definition at line 81 of file SBStream.h.

◆ SBFileSpecList

friend class SBFileSpecList
friend

Definition at line 82 of file SBStream.h.

◆ SBFrame

friend class SBFrame
friend

Definition at line 83 of file SBStream.h.

◆ SBFunction

friend class SBFunction
friend

Definition at line 84 of file SBStream.h.

◆ SBInstruction

friend class SBInstruction
friend

Definition at line 85 of file SBStream.h.

◆ SBInstructionList

friend class SBInstructionList
friend

Definition at line 86 of file SBStream.h.

◆ SBLaunchInfo

friend class SBLaunchInfo
friend

Definition at line 87 of file SBStream.h.

◆ SBLineEntry

friend class SBLineEntry
friend

Definition at line 88 of file SBStream.h.

◆ SBMemoryRegionInfo

friend class SBMemoryRegionInfo
friend

Definition at line 89 of file SBStream.h.

◆ SBModule

friend class SBModule
friend

Definition at line 90 of file SBStream.h.

◆ SBModuleSpec

friend class SBModuleSpec
friend

Definition at line 91 of file SBStream.h.

◆ SBModuleSpecList

friend class SBModuleSpecList
friend

Definition at line 92 of file SBStream.h.

◆ SBProcess

friend class SBProcess
friend

Definition at line 93 of file SBStream.h.

◆ SBSection

friend class SBSection
friend

Definition at line 94 of file SBStream.h.

◆ SBSourceManager

friend class SBSourceManager
friend

Definition at line 95 of file SBStream.h.

◆ SBStructuredData

friend class SBStructuredData
friend

Definition at line 96 of file SBStream.h.

◆ SBSymbol

friend class SBSymbol
friend

Definition at line 97 of file SBStream.h.

◆ SBSymbolContext

friend class SBSymbolContext
friend

Definition at line 98 of file SBStream.h.

◆ SBSymbolContextList

friend class SBSymbolContextList
friend

Definition at line 99 of file SBStream.h.

◆ SBTarget

friend class SBTarget
friend

Definition at line 100 of file SBStream.h.

◆ SBThread

friend class SBThread
friend

Definition at line 101 of file SBStream.h.

◆ SBThreadPlan

friend class SBThreadPlan
friend

Definition at line 102 of file SBStream.h.

◆ SBType

friend class SBType
friend

Definition at line 103 of file SBStream.h.

◆ SBTypeEnumMember

friend class SBTypeEnumMember
friend

Definition at line 104 of file SBStream.h.

◆ SBTypeMember

friend class SBTypeMember
friend

Definition at line 106 of file SBStream.h.

◆ SBTypeMemberFunction

friend class SBTypeMemberFunction
friend

Definition at line 105 of file SBStream.h.

◆ SBValue

friend class SBValue
friend

Definition at line 107 of file SBStream.h.

◆ SBWatchpoint

friend class SBWatchpoint
friend

Definition at line 108 of file SBStream.h.

Member Data Documentation

◆ m_is_file

bool lldb::SBStream::m_is_file = false
private

Definition at line 122 of file SBStream.h.

Referenced by Clear(), GetData(), GetSize(), RedirectToFile(), and RedirectToFileDescriptor().

◆ m_opaque_up

std::unique_ptr<lldb_private::Stream> lldb::SBStream::m_opaque_up
private

Definition at line 121 of file SBStream.h.

Referenced by Clear(), get(), GetData(), lldb_private::ScriptInterpreter::GetOpaqueTypeFromSBStream(), GetSize(), operator->(), RedirectToFile(), RedirectToFileDescriptor(), and ref().

The documentation for this class was generated from the following files:
Generated on Fri Dec 20 2024 17:28:34 for LLDB by doxygen 1.9.6