class Output
Declaration
class Output : public IO { /* full declaration omitted */ };
Description
The Output class is used to generate a yaml document from in-memory structs and vectors.
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1579
Inherits from: IO
Member Variables
- private llvm::raw_ostream& Out
- private int WrapColumn
- private SmallVector<llvm::yaml::Output::InState, 8> StateStack
- private int Column = 0
- private int ColumnAtFlowStart = 0
- private int ColumnAtMapFlowStart = 0
- private bool NeedBitValueComma = false
- private bool NeedFlowSequenceComma = false
- private bool EnumerationMatchFound = false
- private bool WriteDefaultValues = false
- private llvm::StringRef Padding
- private llvm::StringRef PaddingBeforeContainer
Method Overview
- public Output(llvm::raw_ostream &, void * Ctxt = nullptr, int WrapColumn = 70)
- public bool beginBitSetScalar(bool &)
- public void beginDocuments()
- public void beginEnumScalar()
- public void beginFlowMapping()
- public unsigned int beginFlowSequence()
- public void beginMapping()
- public unsigned int beginSequence()
- public bool bitSetMatch(const char *, bool)
- public void blockScalarString(llvm::StringRef &)
- public bool canElideEmptySequence()
- public void endBitSetScalar()
- public void endDocuments()
- public void endEnumScalar()
- public void endFlowMapping()
- public void endFlowSequence()
- public void endMapping()
- public void endSequence()
- private void flowKey(llvm::StringRef Key)
- public llvm::yaml::NodeKind getNodeKind()
- private static bool inFlowMapAnyKey(llvm::yaml::Output::InState State)
- private static bool inFlowSeqAnyElement(llvm::yaml::Output::InState State)
- private static bool inMapAnyKey(llvm::yaml::Output::InState State)
- private static bool inSeqAnyElement(llvm::yaml::Output::InState State)
- public std::vector<StringRef> keys()
- public bool mapTag(llvm::StringRef, bool)
- public bool matchEnumFallback()
- public bool matchEnumScalar(const char *, bool)
- private void newLineCheck(bool EmptySequence = false)
- private void output(llvm::StringRef s)
- private void outputNewLine()
- private void outputUpToEndOfLine(llvm::StringRef s)
- public bool outputting() const
- private void paddedKey(llvm::StringRef key)
- public void postflightDocument()
- public void postflightElement(void *)
- public void postflightFlowElement(void *)
- public void postflightKey(void *)
- public bool preflightDocument(unsigned int)
- public bool preflightElement(unsigned int, void *&)
- public bool preflightFlowElement(unsigned int, void *&)
- public bool preflightKey(const char * key, bool, bool, bool &, void *&)
- public void scalarString(llvm::StringRef &, llvm::yaml::QuotingType)
- public void scalarTag(std::string &)
- public void setError(const llvm::Twine & message)
- public void setWriteDefaultValues(bool Write)
- public ~Output()
Inherited from IO:
- public beginBitSetScalar
- public beginEnumScalar
- public beginFlowMapping
- public beginFlowSequence
- public beginMapping
- public beginSequence
- public bitSetCase
- public bitSetCase
- public bitSetMatch
- public blockScalarString
- public canElideEmptySequence
- public endBitSetScalar
- public endEnumScalar
- public endFlowMapping
- public endFlowSequence
- public endMapping
- public endSequence
- public enumCase
- public enumCase
- public enumFallback
- public getContext
- public getNodeKind
- public keys
- public mapOptional
- public mapOptional
- public mapOptionalWithContext
- public mapOptionalWithContext
- public mapOptionalWithContext
- public mapOptionalWithContext
- public mapRequired
- public mapRequired
- public mapTag
- public maskedBitSetCase
- public maskedBitSetCase
- public matchEnumFallback
- public matchEnumScalar
- public outputting
- public postflightElement
- public postflightFlowElement
- public postflightKey
- public preflightElement
- public preflightFlowElement
- public preflightKey
- public scalarString
- public scalarTag
- public setAllowUnknownKeys
- public setContext
- public setError
Methods
¶Output(llvm::raw_ostream&,
void* Ctxt = nullptr,
int WrapColumn = 70)
Output(llvm::raw_ostream&,
void* Ctxt = nullptr,
int WrapColumn = 70)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1581
Parameters
- llvm::raw_ostream&
- void* Ctxt = nullptr
- int WrapColumn = 70
¶bool beginBitSetScalar(bool&)
bool beginBitSetScalar(bool&)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1612
Parameters
- bool&
¶void beginDocuments()
void beginDocuments()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1624
¶void beginEnumScalar()
void beginEnumScalar()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1608
¶void beginFlowMapping()
void beginFlowMapping()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1598
¶unsigned int beginFlowSequence()
unsigned int beginFlowSequence()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1604
¶void beginMapping()
void beginMapping()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1593
¶unsigned int beginSequence()
unsigned int beginSequence()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1600
¶bool bitSetMatch(const char*, bool)
bool bitSetMatch(const char*, bool)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1613
Parameters
- const char*
- bool
¶void blockScalarString(llvm::StringRef&)
void blockScalarString(llvm::StringRef&)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1616
Parameters
¶bool canElideEmptySequence()
bool canElideEmptySequence()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1620
¶void endBitSetScalar()
void endBitSetScalar()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1614
¶void endDocuments()
void endDocuments()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1627
¶void endEnumScalar()
void endEnumScalar()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1611
¶void endFlowMapping()
void endFlowMapping()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1599
¶void endFlowSequence()
void endFlowSequence()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1607
¶void endMapping()
void endMapping()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1594
¶void endSequence()
void endSequence()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1601
¶void flowKey(llvm::StringRef Key)
void flowKey(llvm::StringRef Key)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1635
Parameters
- llvm::StringRef Key
¶llvm::yaml::NodeKind getNodeKind()
llvm::yaml::NodeKind getNodeKind()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1618
¶static bool inFlowMapAnyKey(
llvm::yaml::Output::InState State)
static bool inFlowMapAnyKey(
llvm::yaml::Output::InState State)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1651
Parameters
- llvm::yaml::Output::InState State
¶static bool inFlowSeqAnyElement(
llvm::yaml::Output::InState State)
static bool inFlowSeqAnyElement(
llvm::yaml::Output::InState State)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1649
Parameters
- llvm::yaml::Output::InState State
¶static bool inMapAnyKey(
llvm::yaml::Output::InState State)
static bool inMapAnyKey(
llvm::yaml::Output::InState State)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1650
Parameters
- llvm::yaml::Output::InState State
¶static bool inSeqAnyElement(
llvm::yaml::Output::InState State)
static bool inSeqAnyElement(
llvm::yaml::Output::InState State)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1648
Parameters
- llvm::yaml::Output::InState State
¶std::vector<StringRef> keys()
std::vector<StringRef> keys()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1597
¶bool mapTag(llvm::StringRef, bool)
bool mapTag(llvm::StringRef, bool)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1592
Parameters
- llvm::StringRef
- bool
¶bool matchEnumFallback()
bool matchEnumFallback()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1610
¶bool matchEnumScalar(const char*, bool)
bool matchEnumScalar(const char*, bool)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1609
Parameters
- const char*
- bool
¶void newLineCheck(bool EmptySequence = false)
void newLineCheck(bool EmptySequence = false)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1632
Parameters
- bool EmptySequence = false
¶void output(llvm::StringRef s)
void output(llvm::StringRef s)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1630
Parameters
¶void outputNewLine()
void outputNewLine()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1633
¶void outputUpToEndOfLine(llvm::StringRef s)
void outputUpToEndOfLine(llvm::StringRef s)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1631
Parameters
¶bool outputting() const
bool outputting() const
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1591
¶void paddedKey(llvm::StringRef key)
void paddedKey(llvm::StringRef key)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1634
Parameters
- llvm::StringRef key
¶void postflightDocument()
void postflightDocument()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1626
¶void postflightElement(void*)
void postflightElement(void*)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1603
Parameters
- void*
¶void postflightFlowElement(void*)
void postflightFlowElement(void*)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1606
Parameters
- void*
¶void postflightKey(void*)
void postflightKey(void*)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1596
Parameters
- void*
¶bool preflightDocument(unsigned int)
bool preflightDocument(unsigned int)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1625
Parameters
- unsigned int
¶bool preflightElement(unsigned int, void*&)
bool preflightElement(unsigned int, void*&)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1602
Parameters
- unsigned int
- void*&
¶bool preflightFlowElement(unsigned int, void*&)
bool preflightFlowElement(unsigned int, void*&)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1605
Parameters
- unsigned int
- void*&
¶bool preflightKey(const char* key,
bool,
bool,
bool&,
void*&)
bool preflightKey(const char* key,
bool,
bool,
bool&,
void*&)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1595
Parameters
- const char* key
- bool
- bool
- bool&
- void*&
¶void scalarString(llvm::StringRef&,
llvm::yaml::QuotingType)
void scalarString(llvm::StringRef&,
llvm::yaml::QuotingType)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1615
Parameters
- llvm::StringRef&
- llvm::yaml::QuotingType
¶void scalarTag(std::string&)
void scalarTag(std::string&)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1617
Parameters
¶void setError(const llvm::Twine& message)
void setError(const llvm::Twine& message)
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1619
Parameters
- const llvm::Twine& message
¶void setWriteDefaultValues(bool Write)
void setWriteDefaultValues(bool Write)
Description
Set whether or not to output optional values which are equal to the default value. By default, when outputting if you attempt to write a value that is equal to the default, the value gets ignored. Sometimes, it is useful to be able to see these in the resulting YAML anyway.
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1589
Parameters
- bool Write
¶~Output()
~Output()
Declared at: llvm/include/llvm/Support/YAMLTraits.h:1582