#include <FormatEntity.h>

Classes
struct	Definition

Public Types

enum class Type {
Invalid , ParentNumber , ParentString , EscapeCode ,
Root , String , Scope , Variable ,
VariableSynthetic , ScriptVariable , ScriptVariableSynthetic , AddressLoad ,
AddressFile , AddressLoadOrFile , ProcessID , ProcessFile ,
ScriptProcess , ThreadID , ThreadProtocolID , ThreadIndexID ,
ThreadName , ThreadQueue , ThreadStopReason , ThreadStopReasonRaw ,
ThreadReturnValue , ThreadCompletedExpression , ScriptThread , ThreadInfo ,
TargetArch , TargetFile , ScriptTarget , ModuleFile ,
File , Lang , FrameIndex , FrameNoDebug ,
FrameRegisterPC , FrameRegisterSP , FrameRegisterFP , FrameRegisterFlags ,
FrameRegisterByName , FrameIsArtificial , FrameKind , ScriptFrame ,
FunctionID , FunctionDidChange , FunctionInitialFunction , FunctionName ,
FunctionNameWithArgs , FunctionNameNoArgs , FunctionMangledName , FunctionPrefix ,
FunctionScope , FunctionBasename , FunctionNameQualifiers , FunctionTemplateArguments ,
FunctionFormattedArguments , FunctionReturnLeft , FunctionReturnRight , FunctionQualifiers ,
FunctionSuffix , FunctionAddrOffset , FunctionAddrOffsetConcrete , FunctionLineOffset ,
FunctionPCOffset , FunctionInitial , FunctionChanged , FunctionIsOptimized ,
FunctionIsInlined , LineEntryFile , LineEntryLineNumber , LineEntryColumn ,
LineEntryStartAddress , LineEntryEndAddress , CurrentPCArrow , ProgressCount ,
ProgressMessage , Separator
}

Public Member Functions
	Entry (Type t=Type::Invalid, const char s=nullptr, const char f=nullptr)
	Entry (llvm::StringRef s)
	Entry (char ch)
void	AppendChar (char ch)
void	AppendText (const llvm::StringRef &s)
void	AppendText (const char *cstr)
void	AppendEntry (const Entry &&entry)
void	StartAlternative ()
void	Clear ()
void	Dump (Stream &s, int depth=0) const
bool	operator== (const Entry &rhs) const
	operator bool () const
std::vector< Entry > &	GetChildren ()

Static Public Member Functions
template<size_t N>
static constexpr Definition	DefinitionWithChildren (const char *name, const FormatEntity::Entry::Type t, const Definition(&children)[N], bool keep_separator=false)
static const char *	TypeToCString (Type t)

Public Attributes
std::string	string
std::string	printf_format
Type	type = Type::Invalid
lldb::Format	fmt = lldb::eFormatDefault
lldb::addr_t	number = 0
bool	deref = false

llvm::SmallVector< std::vector< Entry >, 1 >	children_stack
	A stack of children entries, used by Scope entries to provide alterantive children.
size_t	level = 0

Detailed Description

Definition at line 39 of file FormatEntity.h.

Member Enumeration Documentation

◆ Type

enum class lldb_private::FormatEntity::Entry::Type

strong

Enumerator
Invalid
ParentNumber
ParentString
EscapeCode
Root
String
Scope
Variable
VariableSynthetic
ScriptVariable
ScriptVariableSynthetic
AddressLoad
AddressFile
AddressLoadOrFile
ProcessID
ProcessFile
ScriptProcess
ThreadID
ThreadProtocolID
ThreadIndexID
ThreadName
ThreadQueue
ThreadStopReason
ThreadStopReasonRaw
ThreadReturnValue
ThreadCompletedExpression
ScriptThread
ThreadInfo
TargetArch
TargetFile
ScriptTarget
ModuleFile
File
Lang
FrameIndex
FrameNoDebug
FrameRegisterPC
FrameRegisterSP
FrameRegisterFP
FrameRegisterFlags
FrameRegisterByName
FrameIsArtificial
FrameKind
ScriptFrame
FunctionID
FunctionDidChange
FunctionInitialFunction
FunctionName
FunctionNameWithArgs
FunctionNameNoArgs
FunctionMangledName
FunctionPrefix
FunctionScope
FunctionBasename
FunctionNameQualifiers
FunctionTemplateArguments
FunctionFormattedArguments
FunctionReturnLeft
FunctionReturnRight
FunctionQualifiers
FunctionSuffix
FunctionAddrOffset
FunctionAddrOffsetConcrete
FunctionLineOffset
FunctionPCOffset
FunctionInitial
FunctionChanged
FunctionIsOptimized
FunctionIsInlined
LineEntryFile
LineEntryLineNumber
LineEntryColumn
LineEntryStartAddress
LineEntryEndAddress
CurrentPCArrow
ProgressCount
ProgressMessage
Separator

Definition at line 40 of file FormatEntity.h.

Constructor & Destructor Documentation

◆ Entry() [1/3]

FormatEntity::Entry::Entry	(	Type	t = Type::Invalid,
		const char *	s = nullptr,
		const char *	f = nullptr )

Definition at line 289 of file FormatEntity.cpp.

References children_stack, printf_format, and string.

Referenced by AppendEntry(), lldb_private::FormatEntity::Entry::Definition::Definition(), and operator==().

◆ Entry() [2/3]

FormatEntity::Entry::Entry ( llvm::StringRef s )

Definition at line 293 of file FormatEntity.cpp.

References children_stack, and string.

◆ Entry() [3/3]

FormatEntity::Entry::Entry ( char ch )

Definition at line 296 of file FormatEntity.cpp.

References children_stack, printf_format, and string.

Member Function Documentation

◆ AppendChar()

void FormatEntity::Entry::AppendChar ( char ch )

Definition at line 305 of file FormatEntity.cpp.

References GetChildren(), and String.

Referenced by ParseInternal().

◆ AppendEntry()

void FormatEntity::Entry::AppendEntry ( const Entry && entry )

Definition at line 325 of file FormatEntity.cpp.

References Entry(), and GetChildren().

Referenced by ParseInternal().

◆ AppendText() [1/2]

void FormatEntity::Entry::AppendText ( const char * cstr )

Definition at line 321 of file FormatEntity.cpp.

References AppendText().

◆ AppendText() [2/2]

void FormatEntity::Entry::AppendText ( const llvm::StringRef & s )

Definition at line 313 of file FormatEntity.cpp.

References GetChildren(), and String.

Referenced by AppendText(), and ParseInternal().

◆ Clear()

void lldb_private::FormatEntity::Entry::Clear ( )

inline

Definition at line 179 of file FormatEntity.h.

References children_stack, deref, lldb::eFormatDefault, fmt, Invalid, level, number, printf_format, and type.

Referenced by lldb_private::FormatEntity::Parse().

◆ DefinitionWithChildren()

template<size_t N>

constexpr Definition lldb_private::FormatEntity::Entry::DefinitionWithChildren	(	const char *	name,
		const FormatEntity::Entry::Type	t,
		const Definition(&)	children[N],
		bool	keep_separator = false )

inlinestaticconstexpr

Definition at line 158 of file FormatEntity.h.

◆ Dump()

void FormatEntity::Entry::Dump	(	Stream &	s,
		int	depth = 0 ) const

Definition at line 426 of file FormatEntity.cpp.

References children_stack, deref, lldb::eFormatDefault, lldb_private::Stream::EOL(), fmt, lldb_private::FormatManager::GetFormatAsCString(), number, lldb_private::Stream::Printf(), printf_format, type, and TypeToCString().

◆ GetChildren()

std::vector< Entry > & FormatEntity::Entry::GetChildren ( )

Definition at line 300 of file FormatEntity.cpp.

References children_stack, and level.

Referenced by AppendChar(), AppendEntry(), and AppendText().

◆ operator bool()

lldb_private::FormatEntity::Entry::operator bool ( ) const

inline

Definition at line 211 of file FormatEntity.h.

References Invalid, and type.

◆ operator==()

bool lldb_private::FormatEntity::Entry::operator== ( const Entry & rhs ) const

inline

Definition at line 195 of file FormatEntity.h.

References children_stack, deref, Entry(), fmt, printf_format, string, and type.

◆ StartAlternative()

void FormatEntity::Entry::StartAlternative ( )

Definition at line 330 of file FormatEntity.cpp.

References children_stack, level, Scope, and type.

Referenced by ParseInternal().

◆ TypeToCString()

const char * FormatEntity::Entry::TypeToCString ( Type t )

static

Definition at line 340 of file FormatEntity.cpp.

References AddressFile, AddressLoad, AddressLoadOrFile, CurrentPCArrow, ENUM_TO_CSTR, EscapeCode, File, FrameIndex, FrameIsArtificial, FrameKind, FrameNoDebug, FrameRegisterByName, FrameRegisterFlags, FrameRegisterFP, FrameRegisterPC, FrameRegisterSP, FunctionAddrOffset, FunctionAddrOffsetConcrete, FunctionBasename, FunctionChanged, FunctionDidChange, FunctionFormattedArguments, FunctionID, FunctionInitial, FunctionInitialFunction, FunctionIsInlined, FunctionIsOptimized, FunctionLineOffset, FunctionMangledName, FunctionName, FunctionNameNoArgs, FunctionNameQualifiers, FunctionNameWithArgs, FunctionPCOffset, FunctionPrefix, FunctionQualifiers, FunctionReturnLeft, FunctionReturnRight, FunctionScope, FunctionSuffix, FunctionTemplateArguments, Invalid, Lang, LineEntryColumn, LineEntryEndAddress, LineEntryFile, LineEntryLineNumber, LineEntryStartAddress, ModuleFile, ParentNumber, ParentString, ProcessFile, ProcessID, ProgressCount, ProgressMessage, Root, Scope, ScriptFrame, ScriptProcess, ScriptTarget, ScriptThread, ScriptVariable, ScriptVariableSynthetic, Separator, String, TargetArch, TargetFile, ThreadCompletedExpression, ThreadID, ThreadIndexID, ThreadInfo, ThreadName, ThreadProtocolID, ThreadQueue, ThreadReturnValue, ThreadStopReason, ThreadStopReasonRaw, Variable, and VariableSynthetic.

Referenced by Dump().

Member Data Documentation

◆ children_stack

llvm::SmallVector<std::vector<Entry>, 1> lldb_private::FormatEntity::Entry::children_stack

A stack of children entries, used by Scope entries to provide alterantive children.

All other entries have a stack of size 1.

Definition at line 221 of file FormatEntity.h.

Referenced by Clear(), Dump(), Entry(), Entry(), Entry(), lldb_private::FormatEntity::Format(), GetChildren(), operator==(), and StartAlternative().

◆ deref

bool lldb_private::FormatEntity::Entry::deref = false

Definition at line 228 of file FormatEntity.h.

Referenced by Clear(), Dump(), DumpValue(), operator==(), and ParseInternal().

◆ fmt

lldb::Format lldb_private::FormatEntity::Entry::fmt = lldb::eFormatDefault

Definition at line 226 of file FormatEntity.h.

Referenced by Clear(), Dump(), DumpValue(), operator==(), and ParseInternal().

◆ level

size_t lldb_private::FormatEntity::Entry::level = 0

Definition at line 222 of file FormatEntity.h.

Referenced by Clear(), GetChildren(), and StartAlternative().

◆ number

lldb::addr_t lldb_private::FormatEntity::Entry::number = 0

Definition at line 227 of file FormatEntity.h.

Referenced by Clear(), Dump(), DumpValue(), lldb_private::FormatEntity::Format(), ParseEntry(), and ParseInternal().

◆ printf_format

std::string lldb_private::FormatEntity::Entry::printf_format

Definition at line 216 of file FormatEntity.h.

Referenced by Clear(), Dump(), DumpValue(), Entry(), Entry(), lldb_private::FormatEntity::Format(), FormatThreadExtendedInfoRecurse(), operator==(), and ParseInternal().

◆ string

std::string lldb_private::FormatEntity::Entry::string

Definition at line 215 of file FormatEntity.h.

Referenced by DumpValue(), Entry(), Entry(), Entry(), lldb_private::FormatEntity::Format(), FormatThreadExtendedInfoRecurse(), operator==(), ParseEntry(), and ParseInternal().

◆ type

Type lldb_private::FormatEntity::Entry::type = Type::Invalid

Definition at line 225 of file FormatEntity.h.

Referenced by Clear(), Dump(), DumpValue(), lldb_private::FormatEntity::Format(), operator bool(), operator==(), lldb_private::FormatEntity::Parse(), ParseEntry(), ParseInternal(), and StartAlternative().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Entry() [1/3]

◆ Entry() [2/3]

◆ Entry() [3/3]

Member Function Documentation

◆ AppendChar()

◆ AppendEntry()

◆ AppendText() [1/2]

◆ AppendText() [2/2]

◆ Clear()

◆ DefinitionWithChildren()

◆ Dump()

◆ GetChildren()

◆ operator bool()

◆ operator==()

◆ StartAlternative()

◆ TypeToCString()

Member Data Documentation

◆ children_stack

◆ deref

◆ fmt

◆ level

◆ number

◆ printf_format

◆ string

◆ type