The Input class is used to parse a yaml document into in-memory structs and vectors. More...

#include "llvm/Support/YAMLTraits.h"

Inheritance diagram for llvm::yaml::Input:

Public Member Functions
	Input (StringRef InputContent, void Ctxt=nullptr, SourceMgr::DiagHandlerTy DiagHandler=nullptr, void DiagHandlerCtxt=nullptr)
	Input (MemoryBufferRef Input, void Ctxt=nullptr, SourceMgr::DiagHandlerTy DiagHandler=nullptr, void DiagHandlerCtxt=nullptr)
	~Input () override
std::error_code	error () override
bool	setCurrentDocument ()
bool	nextDocument ()
const Node *	getCurrentNode () const
	Returns the current node that's being parsed by the YAML Parser.
void	setAllowUnknownKeys (bool Allow) override
Public Member Functions inherited from llvm::yaml::IO
	IO (void *Ctxt=nullptr)
virtual	~IO ()
template<typename T>
void	enumCase (T &Val, const char *Str, const T ConstVal)
template<typename T>
void	enumCase (T &Val, const char *Str, const uint32_t ConstVal)
template<typename FBT, typename T>
void	enumFallback (T &Val)
template<typename T>
void	bitSetCase (T &Val, const char *Str, const T ConstVal)
template<typename T>
void	bitSetCase (T &Val, const char *Str, const uint32_t ConstVal)
template<typename T>
void	maskedBitSetCase (T &Val, const char *Str, T ConstVal, T Mask)
template<typename T>
void	maskedBitSetCase (T &Val, const char *Str, uint32_t ConstVal, uint32_t Mask)
void *	getContext () const
void	setContext (void *)
template<typename T>
void	mapRequired (const char *Key, T &Val)
template<typename T, typename Context>
void	mapRequired (const char *Key, T &Val, Context &Ctx)
template<typename T>
void	mapOptional (const char *Key, T &Val)
template<typename T, typename DefaultT>
void	mapOptional (const char *Key, T &Val, const DefaultT &Default)
template<typename T, typename Context>
void	mapOptionalWithContext (const char *Key, T &Val, Context &Ctx)
template<typename T, typename Context>
void	mapOptionalWithContext (const char *Key, std::optional< T > &Val, Context &Ctx)
template<typename T, typename Context, typename DefaultT>
void	mapOptionalWithContext (const char *Key, T &Val, const DefaultT &Default, Context &Ctx)

Detailed Description

The Input class is used to parse a yaml document into in-memory structs and vectors.

It works by using YAMLParser to do a syntax parse of the entire yaml document, then the Input class builds a graph of HNodes which wraps each yaml Node. The extra layer is buffering. The low level yaml parser only lets you look at each node once. The buffering layer lets you search and interate multiple times. This is necessary because the mapRequired() method calls may not be in the same order as the keys in the document.

Definition at line 1324 of file YAMLTraits.h.

Constructor & Destructor Documentation

◆ Input() [1/2]

Input::Input	(	StringRef	InputContent,
		void *	Ctxt = nullptr,
		SourceMgr::DiagHandlerTy	DiagHandler = nullptr,
		void *	DiagHandlerCtxt = nullptr )

Definition at line 57 of file YAMLTraits.cpp.

References DiagHandler(), and llvm::yaml::IO::IO().

Referenced by Input().

◆ Input() [2/2]

Input::Input	(	MemoryBufferRef	Input,
		void *	Ctxt = nullptr,
		SourceMgr::DiagHandlerTy	DiagHandler = nullptr,
		void *	DiagHandlerCtxt = nullptr )

Definition at line 65 of file YAMLTraits.cpp.

References DiagHandler(), Input(), and llvm::yaml::IO::IO().

◆ ~Input()

Input::~Input ( )

overridedefault

Member Function Documentation

◆ error()

std::error_code Input::error ( )

overridevirtual

Implements llvm::yaml::IO.

Definition at line 75 of file YAMLTraits.cpp.

Referenced by llvm::yaml::convertYAML(), llvm::DWARFYAML::emitDebugSections(), llvm::AMDGPU::HSAMD::fromString(), llvm::msgpack::Document::fromYAML(), llvm::MachO::TextAPIReader::get(), llvm::gsym::CallSiteInfoLoader::loadYAML(), llvm::yaml::operator>>(), llvm::memprof::YAMLMemProfReader::parse(), and llvm::ifs::readIFSFromBuffer().

◆ getCurrentNode()

const Node * Input::getCurrentNode ( ) const

Returns the current node that's being parsed by the YAML Parser.

Definition at line 106 of file YAMLTraits.cpp.

◆ nextDocument()

bool Input::nextDocument ( )

Definition at line 102 of file YAMLTraits.cpp.

Referenced by llvm::yaml::convertYAML(), llvm::OutlinedHashTreeRecord::deserializeYAML(), llvm::StableFunctionMapRecord::deserializeYAML(), and llvm::yaml::operator>>().

◆ setAllowUnknownKeys()

void Input::setAllowUnknownKeys ( bool Allow )

overridevirtual

Reimplemented from llvm::yaml::IO.

Definition at line 473 of file YAMLTraits.cpp.

◆ setCurrentDocument()

bool Input::setCurrentDocument ( )

Definition at line 81 of file YAMLTraits.cpp.

References llvm::invalid_argument, llvm::isa(), llvm::make_error_code(), N, and setCurrentDocument().

Referenced by llvm::yaml::operator>>(), llvm::yaml::operator>>(), llvm::yaml::operator>>(), and setCurrentDocument().

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

include/llvm/Support/YAMLTraits.h
lib/Support/YAMLTraits.cpp

Public Member Functions