#include "llvm/BinaryFormat/MsgPackDocument.h"

Inheritance diagram for llvm::msgpack::DocNode:

Public Types
typedef std::map< DocNode, DocNode >	MapTy
typedef std::vector< DocNode >	ArrayTy

Public Member Functions
	DocNode ()
bool	isMap () const
bool	isArray () const
bool	isScalar () const
bool	isString () const
bool	isEmpty () const
Type	getKind () const
Document *	getDocument () const
int64_t &	getInt ()
uint64_t &	getUInt ()
bool &	getBool ()
double &	getFloat ()
int64_t	getInt () const
uint64_t	getUInt () const
bool	getBool () const
double	getFloat () const
StringRef	getString () const
MemoryBufferRef	getBinary () const
ArrayDocNode &	getArray (bool Convert=false)
	Get an ArrayDocNode for an array node.
MapDocNode &	getMap (bool Convert=false)
	Get a MapDocNode for a map node.
LLVM_ABI std::string	toString () const
	Convert this node to a string, assuming it is scalar.
LLVM_ABI StringRef	fromString (StringRef S, StringRef Tag="")
	Convert the StringRef and use it to set this DocNode (assuming scalar).
DocNode &	operator= (const char *Val)
	Convenience assignment operators.
LLVM_ABI DocNode &	operator= (StringRef Val)
LLVM_ABI DocNode &	operator= (MemoryBufferRef Val)
LLVM_ABI DocNode &	operator= (bool Val)
LLVM_ABI DocNode &	operator= (int Val)
LLVM_ABI DocNode &	operator= (unsigned Val)
LLVM_ABI DocNode &	operator= (int64_t Val)
LLVM_ABI DocNode &	operator= (uint64_t Val)
LLVM_ABI DocNode &	operator= (double Val)

Protected Attributes
union {
int64_t Int
uint64_t UInt
bool Bool
double Float
StringRef Raw
ArrayTy * Array
MapTy * Map
};

Friends
bool	operator< (const DocNode &Lhs, const DocNode &Rhs)
	Comparison operator, used for map keys.
bool	operator== (const DocNode &Lhs, const DocNode &Rhs)
	Equality operator.
bool	operator!= (const DocNode &Lhs, const DocNode &Rhs)
	Inequality operator.

Detailed Description

A node in a MsgPack Document.

This is a simple copyable and passable-by-value type that does not own any memory.

Definition at line 39 of file MsgPackDocument.h.

Member Typedef Documentation

◆ ArrayTy

typedef std::vector<DocNode> llvm::msgpack::DocNode::ArrayTy

Definition at line 44 of file MsgPackDocument.h.

◆ MapTy

typedef std::map<DocNode, DocNode> llvm::msgpack::DocNode::MapTy

Definition at line 43 of file MsgPackDocument.h.

Constructor & Destructor Documentation

◆ DocNode()

llvm::msgpack::DocNode::DocNode ( )

inline

Member Function Documentation

◆ fromString()

StringRef DocNode::fromString	(	StringRef	S,
		StringRef	Tag = "" )

Convert the StringRef and use it to set this DocNode (assuming scalar).

If it is a string, copy the string into the Document's strings list so we do not rely on S having a lifetime beyond this call. Tag is "" or a YAML tag.

Definition at line 69 of file MsgPackDocumentYAML.cpp.

References assert(), getBool(), getDocument(), getFloat(), getInt(), llvm::msgpack::Document::getNode(), getUInt(), and llvm::Tag.

◆ getArray()

ArrayDocNode & llvm::msgpack::DocNode::getArray ( bool Convert = false )

inline

Get an ArrayDocNode for an array node.

If Convert, convert the node to an array node if necessary.

Definition at line 135 of file MsgPackDocument.h.

References llvm::msgpack::Array, assert(), and getKind().

Referenced by llvm::AMDGPU::HSAMD::MetadataStreamerMsgPackV4::emitKernel().

◆ getBinary()

MemoryBufferRef llvm::msgpack::DocNode::getBinary ( ) const

inline

Definition at line 128 of file MsgPackDocument.h.

References assert(), llvm::msgpack::Binary, getKind(), and Raw.

◆ getBool() [1/2]

bool & llvm::msgpack::DocNode::getBool ( )

inline

Definition at line 93 of file MsgPackDocument.h.

References assert(), Bool, llvm::msgpack::Boolean, and getKind().

Referenced by fromString().

◆ getBool() [2/2]

bool llvm::msgpack::DocNode::getBool ( ) const

inline

Definition at line 113 of file MsgPackDocument.h.

References assert(), Bool, llvm::msgpack::Boolean, and getKind().

◆ getDocument()

Document * llvm::msgpack::DocNode::getDocument ( ) const

inline

◆ getFloat() [1/2]

double & llvm::msgpack::DocNode::getFloat ( )

inline

Definition at line 98 of file MsgPackDocument.h.

References assert(), Float, llvm::msgpack::Float, and getKind().

Referenced by fromString().

◆ getFloat() [2/2]

double llvm::msgpack::DocNode::getFloat ( ) const

inline

Definition at line 118 of file MsgPackDocument.h.

References assert(), Float, llvm::msgpack::Float, and getKind().

◆ getInt() [1/2]

int64_t & llvm::msgpack::DocNode::getInt ( )

inline

Definition at line 83 of file MsgPackDocument.h.

References assert(), getKind(), Int, and llvm::msgpack::Int.

Referenced by fromString().

◆ getInt() [2/2]

int64_t llvm::msgpack::DocNode::getInt ( ) const

inline

Definition at line 103 of file MsgPackDocument.h.

References assert(), getKind(), Int, and llvm::msgpack::Int.

◆ getKind()

Type llvm::msgpack::DocNode::getKind ( ) const

inline

Definition at line 80 of file MsgPackDocument.h.

Referenced by llvm::msgpack::ArrayDocNode::ArrayDocNode(), getArray(), getBinary(), getBool(), getBool(), getFloat(), getFloat(), getInt(), getInt(), getMap(), getString(), getUInt(), getUInt(), isArray(), isEmpty(), isMap(), isString(), llvm::msgpack::MapDocNode::MapDocNode(), operator<, llvm::msgpack::Document::readFromBlob(), and toString().

◆ getMap()

MapDocNode & llvm::msgpack::DocNode::getMap ( bool Convert = false )

inline

Get a MapDocNode for a map node.

If Convert, convert the node to a map node if necessary.

Definition at line 146 of file MsgPackDocument.h.

References assert(), getKind(), and llvm::msgpack::Map.

Referenced by llvm::AMDGPU::HSAMD::V3::MetadataVerifier::verify().

◆ getString()

StringRef llvm::msgpack::DocNode::getString ( ) const

inline

Definition at line 123 of file MsgPackDocument.h.

References assert(), getKind(), Raw, and llvm::msgpack::String.

◆ getUInt() [1/2]

uint64_t & llvm::msgpack::DocNode::getUInt ( )

inline

Definition at line 88 of file MsgPackDocument.h.

References assert(), getKind(), UInt, and llvm::msgpack::UInt.

Referenced by fromString().

◆ getUInt() [2/2]

uint64_t llvm::msgpack::DocNode::getUInt ( ) const

inline

Definition at line 108 of file MsgPackDocument.h.

References assert(), getKind(), UInt, and llvm::msgpack::UInt.

◆ isArray()

bool llvm::msgpack::DocNode::isArray ( ) const

inline

Definition at line 72 of file MsgPackDocument.h.

References llvm::msgpack::Array, and getKind().

Referenced by isScalar(), and llvm::msgpack::Document::readFromBlob().

◆ isEmpty()

bool llvm::msgpack::DocNode::isEmpty ( ) const

inline

Definition at line 79 of file MsgPackDocument.h.

References llvm::msgpack::Empty, and getKind().

Referenced by operator<, and llvm::msgpack::Document::readFromBlob().

◆ isMap()

bool llvm::msgpack::DocNode::isMap ( ) const

inline

Definition at line 71 of file MsgPackDocument.h.

References getKind(), and llvm::msgpack::Map.

Referenced by isScalar(), llvm::msgpack::Document::readFromBlob(), and llvm::AMDGPU::HSAMD::V3::MetadataVerifier::verify().

◆ isScalar()

bool llvm::msgpack::DocNode::isScalar ( ) const

inline

Definition at line 73 of file MsgPackDocument.h.

References isArray(), and isMap().

◆ isString()

bool llvm::msgpack::DocNode::isString ( ) const

inline

Definition at line 74 of file MsgPackDocument.h.

References getKind(), and llvm::msgpack::String.

◆ operator=() [1/9]

DocNode & DocNode::operator= ( bool Val )

Definition at line 87 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [2/9]

DocNode & llvm::msgpack::DocNode::operator= ( const char * Val )

inline

Convenience assignment operators.

This only works if the destination DocNode has an associated Document, i.e. it was not constructed using the default constructor. The string one does not copy, so the string must remain valid for the lifetime of the Document. Use fromString to avoid that restriction.

Definition at line 208 of file MsgPackDocument.h.

References DocNode().

◆ operator=() [3/9]

DocNode & DocNode::operator= ( double Val )

Definition at line 107 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [4/9]

DocNode & DocNode::operator= ( int Val )

Definition at line 91 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [5/9]

DocNode & DocNode::operator= ( int64_t Val )

Definition at line 99 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [6/9]

DocNode & DocNode::operator= ( MemoryBufferRef Val )

Definition at line 83 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [7/9]

DocNode & DocNode::operator= ( StringRef Val )

Definition at line 79 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [8/9]

DocNode & DocNode::operator= ( uint64_t Val )

Definition at line 103 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ operator=() [9/9]

DocNode & DocNode::operator= ( unsigned Val )

Definition at line 95 of file MsgPackDocument.cpp.

References DocNode(), getDocument(), and llvm::msgpack::Document::getNode().

◆ toString()

std::string DocNode::toString ( ) const

Convert this node to a string, assuming it is scalar.

Convert this DocNode to a string, assuming it is scalar.

Definition at line 35 of file MsgPackDocumentYAML.cpp.

References Bool, llvm::msgpack::Boolean, Float, llvm::msgpack::Float, llvm::format(), getDocument(), getKind(), Int, llvm::msgpack::Int, llvm_unreachable, llvm::msgpack::Nil, Raw, llvm::raw_string_ostream::str(), llvm::msgpack::String, UInt, and llvm::msgpack::UInt.

◆ operator!=

bool operator!=	(	const DocNode &	Lhs,
		const DocNode &	Rhs )

friend

Inequality operator.

Definition at line 191 of file MsgPackDocument.h.

References DocNode().

◆ operator<

bool operator<	(	const DocNode &	Lhs,
		const DocNode &	Rhs )

friend

Comparison operator, used for map keys.

Definition at line 156 of file MsgPackDocument.h.

References llvm::msgpack::Binary, Bool, llvm::msgpack::Boolean, DocNode(), Float, llvm::msgpack::Float, getKind(), Int, llvm::msgpack::Int, isEmpty(), llvm_unreachable, llvm::msgpack::Nil, Raw, llvm::msgpack::String, UInt, and llvm::msgpack::UInt.

◆ operator==

bool operator==	(	const DocNode &	Lhs,
		const DocNode &	Rhs )

friend

Equality operator.

Definition at line 186 of file MsgPackDocument.h.

References DocNode().

Member Data Documentation

◆ [union]

union { ... } llvm::msgpack::DocNode

◆ Array

ArrayTy* llvm::msgpack::DocNode::Array

Definition at line 61 of file MsgPackDocument.h.

Referenced by llvm::msgpack::ArrayDocNode::back(), llvm::msgpack::ArrayDocNode::begin(), llvm::msgpack::ArrayDocNode::end(), llvm::msgpack::ArrayDocNode::operator[](), llvm::msgpack::ArrayDocNode::push_back(), and llvm::msgpack::ArrayDocNode::size().

◆ Bool

bool llvm::msgpack::DocNode::Bool

Definition at line 58 of file MsgPackDocument.h.

Referenced by getBool(), getBool(), operator<, and toString().

◆ Float

double llvm::msgpack::DocNode::Float

Definition at line 59 of file MsgPackDocument.h.

Referenced by getFloat(), getFloat(), operator<, and toString().

◆ Int

int64_t llvm::msgpack::DocNode::Int

Definition at line 56 of file MsgPackDocument.h.

Referenced by getInt(), getInt(), operator<, and toString().

◆ Map

MapTy* llvm::msgpack::DocNode::Map

Definition at line 62 of file MsgPackDocument.h.

Referenced by llvm::msgpack::MapDocNode::begin(), llvm::msgpack::MapDocNode::end(), llvm::msgpack::MapDocNode::erase(), llvm::msgpack::MapDocNode::erase(), llvm::msgpack::MapDocNode::erase(), llvm::msgpack::MapDocNode::find(), and llvm::msgpack::MapDocNode::size().

◆ Raw

StringRef llvm::msgpack::DocNode::Raw

Definition at line 60 of file MsgPackDocument.h.

Referenced by getBinary(), getString(), operator<, and toString().

◆ UInt

uint64_t llvm::msgpack::DocNode::UInt

Definition at line 57 of file MsgPackDocument.h.

Referenced by getUInt(), getUInt(), operator<, and toString().

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

include/llvm/BinaryFormat/MsgPackDocument.h
lib/BinaryFormat/MsgPackDocument.cpp
lib/BinaryFormat/MsgPackDocumentYAML.cpp

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ArrayTy

◆ MapTy

Constructor & Destructor Documentation

◆ DocNode()

Member Function Documentation

◆ fromString()

◆ getArray()

◆ getBinary()

◆ getBool() [1/2]

◆ getBool() [2/2]

◆ getDocument()

◆ getFloat() [1/2]

◆ getFloat() [2/2]

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getKind()

◆ getMap()

◆ getString()

◆ getUInt() [1/2]

◆ getUInt() [2/2]

◆ isArray()

◆ isEmpty()

◆ isMap()

◆ isScalar()

◆ isString()

◆ operator=() [1/9]

◆ operator=() [2/9]

◆ operator=() [3/9]

◆ operator=() [4/9]

◆ operator=() [5/9]

◆ operator=() [6/9]

◆ operator=() [7/9]

◆ operator=() [8/9]

◆ operator=() [9/9]

◆ toString()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<

◆ operator==

Member Data Documentation

◆ [union]

◆ Array

◆ Bool

◆ Float

◆ Int

◆ Map

◆ Raw

◆ UInt