LLVM: llvm::yaml::Output Class Reference (original) (raw)

The Output class is used to generate a yaml document from in-memory structs and vectors. More...

#include "[llvm/Support/YAMLTraits.h](YAMLTraits%5F8h%5Fsource.html)"

Public Member Functions
Output (raw_ostream &, void *Ctxt=nullptr, int WrapColumn=70)
~Output () override
void setWriteDefaultValues (bool Write)
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.
bool outputting () const override
bool mapTag (StringRef, bool) override
void beginMapping () override
void endMapping () override
bool preflightKey (StringRef Key, bool, bool, bool &, void *&) override
void postflightKey (void *) override
std::vector< StringRef > keys () override
void beginFlowMapping () override
void endFlowMapping () override
unsigned beginSequence () override
void endSequence () override
bool preflightElement (unsigned, void *&) override
void postflightElement (void *) override
unsigned beginFlowSequence () override
bool preflightFlowElement (unsigned, void *&) override
void postflightFlowElement (void *) override
void endFlowSequence () override
void beginEnumScalar () override
bool matchEnumScalar (StringRef, bool) override
bool matchEnumFallback () override
void endEnumScalar () override
bool beginBitSetScalar (bool &) override
bool bitSetMatch (StringRef, bool) override
void endBitSetScalar () override
void scalarString (StringRef &, QuotingType) override
void blockScalarString (StringRef &) override
void scalarTag (std::string &) override
NodeKind getNodeKind () override
void setError (const Twine &message) override
std::error_code error () override
bool canElideEmptySequence () override
void beginDocuments ()
bool preflightDocument (unsigned)
void postflightDocument ()
void endDocuments ()
Public Member Functions inherited from llvm::yaml::IO
IO (void *Ctxt=nullptr)
virtual ~IO ()
virtual void setAllowUnknownKeys (bool Allow)
template<typename T>
void enumCase (T &Val, StringRef Str, const T ConstVal)
template<typename T>
void enumCase (T &Val, StringRef Str, const uint32_t ConstVal)
template<typename FBT, typename T>
void enumFallback (T &Val)
template<typename T>
void bitSetCase (T &Val, StringRef Str, const T ConstVal)
template<typename T>
void bitSetCase (T &Val, StringRef Str, const uint32_t ConstVal)
template<typename T>
void maskedBitSetCase (T &Val, StringRef Str, T ConstVal, T Mask)
template<typename T>
void maskedBitSetCase (T &Val, StringRef Str, uint32_t ConstVal, uint32_t Mask)
void * getContext () const
void setContext (void *)
template<typename T>
void mapRequired (StringRef Key, T &Val)
template<typename T, typename Context>
void mapRequired (StringRef Key, T &Val, Context &Ctx)
template<typename T>
void mapOptional (StringRef Key, T &Val)
template<typename T, typename DefaultT>
void mapOptional (StringRef Key, T &Val, const DefaultT &Default)
template<typename T, typename Context>
void mapOptionalWithContext (StringRef Key, T &Val, Context &Ctx)
template<typename T, typename Context>
void mapOptionalWithContext (StringRef Key, std::optional< T > &Val, Context &Ctx)
template<typename T, typename Context, typename DefaultT>
void mapOptionalWithContext (StringRef Key, T &Val, const DefaultT &Default, Context &Ctx)

The Output class is used to generate a yaml document from in-memory structs and vectors.

Definition at line 1469 of file YAMLTraits.h.

Output::Output ( raw_ostream & yout,
void * Ctxt = nullptr,
int WrapColumn = 70 )

◆ ~Output()

Output::~Output ( ) overridedefault

◆ beginBitSetScalar()

bool Output::beginBitSetScalar ( bool & DoClear) overridevirtual

◆ beginDocuments()

void Output::beginDocuments ( )

◆ beginEnumScalar()

void Output::beginEnumScalar ( ) overridevirtual

◆ beginFlowMapping()

void Output::beginFlowMapping ( ) overridevirtual

◆ beginFlowSequence()

unsigned Output::beginFlowSequence ( ) overridevirtual

◆ beginMapping()

void Output::beginMapping ( ) overridevirtual

◆ beginSequence()

unsigned Output::beginSequence ( ) overridevirtual

◆ bitSetMatch()

◆ blockScalarString()

void Output::blockScalarString ( StringRef & S) overridevirtual

◆ canElideEmptySequence()

bool Output::canElideEmptySequence ( ) overridevirtual

◆ endBitSetScalar()

void Output::endBitSetScalar ( ) overridevirtual

◆ endDocuments()

void Output::endDocuments ( )

◆ endEnumScalar()

void Output::endEnumScalar ( ) overridevirtual

◆ endFlowMapping()

void Output::endFlowMapping ( ) overridevirtual

◆ endFlowSequence()

void Output::endFlowSequence ( ) overridevirtual

◆ endMapping()

void Output::endMapping ( ) overridevirtual

◆ endSequence()

void Output::endSequence ( ) overridevirtual

◆ error()

std::error_code Output::error ( ) overridevirtual

◆ getNodeKind()

NodeKind Output::getNodeKind ( ) overridevirtual

◆ keys()

std::vector< StringRef > Output::keys ( ) overridevirtual

◆ mapTag()

◆ matchEnumFallback()

bool Output::matchEnumFallback ( ) overridevirtual

◆ matchEnumScalar()

◆ outputting()

bool Output::outputting ( ) const overridevirtual

◆ postflightDocument()

void Output::postflightDocument ( )

◆ postflightElement()

void Output::postflightElement ( void * ) overridevirtual

◆ postflightFlowElement()

void Output::postflightFlowElement ( void * ) overridevirtual

◆ postflightKey()

void Output::postflightKey ( void * ) overridevirtual

◆ preflightDocument()

◆ preflightElement()

bool Output::preflightElement ( unsigned , void *& SaveInfo ) overridevirtual

◆ preflightFlowElement()

bool Output::preflightFlowElement ( unsigned , void *& SaveInfo ) overridevirtual

◆ preflightKey()

bool Output::preflightKey ( StringRef Key, bool Required, bool SameAsDefault, bool & UseDefault, void *& SaveInfo ) overridevirtual

◆ scalarString()

◆ scalarTag()

void Output::scalarTag ( std::string & Tag) overridevirtual

◆ setError()

void Output::setError ( const Twine & message) overridevirtual

◆ setWriteDefaultValues()

void llvm::yaml::Output::setWriteDefaultValues ( bool Write) inline

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.

Definition at line 1479 of file YAMLTraits.h.

References llvm::Write.

Referenced by printMF().

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