Node types

Classes
struct	c4::yml::NodeType
	Wraps a type_bits mask of NodeTypeBits flags with some syntactic sugar and predicates. More...

Typedefs
using	c4::yml::type_bits = uint32_t
	the integral type necessary to cover all the bits for NodeType_e More...

Enumerations
enum	c4::yml::NodeTypeBits : type_bits {   c4::yml::NOTYPE = 0, c4::yml::KEY = b_(0), c4::yml::VAL = b_(1), c4::yml::MAP = b_(2),   c4::yml::SEQ = b_(3), c4::yml::DOC = b_(4), c4::yml::STREAM = b_(5)|SEQ, c4::yml::KEYREF = b_(6),   c4::yml::VALREF = b_(7), c4::yml::KEYANCH = b_(8), c4::yml::VALANCH = b_(9), c4::yml::KEYTAG = b_(10),   c4::yml::VALTAG = b_(11), c4::yml::KEYNIL = b_(12), c4::yml::VALNIL = b_(13), c4::yml::TYMASK_ = b_(14)-1,   c4::yml::KEY_UNFILT = b_(14), c4::yml::VAL_UNFILT = b_(15), c4::yml::FLOW_SL = b_(16), c4::yml::FLOW_ML1 = b_(17),   c4::yml::FLOW_MLN = b_(18), c4::yml::FLOW_SPC = b_(19), c4::yml::BLOCK = b_(20), c4::yml::KEY_LITERAL = b_(21),   c4::yml::VAL_LITERAL = b_(22), c4::yml::KEY_FOLDED = b_(23), c4::yml::VAL_FOLDED = b_(24), c4::yml::KEY_SQUO = b_(25),   c4::yml::VAL_SQUO = b_(26), c4::yml::KEY_DQUO = b_(27), c4::yml::VAL_DQUO = b_(28), c4::yml::KEY_PLAIN = b_(29),   c4::yml::VAL_PLAIN = b_(30), c4::yml::KEYVAL = KEY|VAL, c4::yml::KEYSEQ = KEY|SEQ, c4::yml::KEYMAP = KEY|MAP,   c4::yml::DOCMAP = DOC|MAP, c4::yml::DOCSEQ = DOC|SEQ, c4::yml::DOCVAL = DOC|VAL, c4::yml::SCALAR_LITERAL = KEY_LITERAL|VAL_LITERAL,   c4::yml::SCALAR_FOLDED = KEY_FOLDED|VAL_FOLDED, c4::yml::SCALAR_SQUO = KEY_SQUO|VAL_SQUO, c4::yml::SCALAR_DQUO = KEY_DQUO|VAL_DQUO, c4::yml::SCALAR_PLAIN = KEY_PLAIN|VAL_PLAIN,   c4::yml::KEYQUO = KEY_SQUO|KEY_DQUO|KEY_FOLDED|KEY_LITERAL, c4::yml::VALQUO = VAL_SQUO|VAL_DQUO|VAL_FOLDED|VAL_LITERAL, c4::yml::KEY_STYLE = KEYQUO|KEY_PLAIN, c4::yml::VAL_STYLE = VALQUO|VAL_PLAIN,   c4::yml::SCALAR_STYLE = KEY_STYLE|VAL_STYLE, c4::yml::FLOW_MLX = FLOW_ML1|FLOW_MLN, c4::yml::CONTAINER_STYLE_FLOW = FLOW_SL|FLOW_MLX|FLOW_SPC, c4::yml::CONTAINER_STYLE_BLOCK = BLOCK,   c4::yml::CONTAINER_STYLE = CONTAINER_STYLE_FLOW|CONTAINER_STYLE_BLOCK, c4::yml::STYLE = SCALAR_STYLE | CONTAINER_STYLE }
	a bit mask for marking node types and styles More...

Detailed Description

Typedef Documentation

using c4::yml::type_bits = typedef uint32_t

the integral type necessary to cover all the bits for NodeType_e

Definition at line 26 of file node_type.hpp.

Enumeration Type Documentation

enum c4::yml::NodeTypeBits : type_bits

a bit mask for marking node types and styles

Enumerator
NOTYPE	no node type or style is set
KEY	the scalar to the left of : in a map's member
VAL	a scalar: has a scalar (ie string) value, possibly empty. must be a leaf node, and cannot be MAP or SEQ
MAP	a map: a parent of KEYVAL/KEYSEQ/KEYMAP nodes
SEQ	a seq: a parent of VAL/SEQ/MAP nodes
DOC	a document
STREAM	a stream: a seq of docs
KEYREF	a *reference: the key references an &anchor
VALREF	a *reference: the val references an &anchor
KEYANCH	the key has an &anchor
VALANCH	the val has an &anchor
KEYTAG	the key has a tag
VALTAG	the val has a tag
KEYNIL	the key is null (eg { : b} results in a null key)
VALNIL	the val is null (eg {a : } results in a null val)
TYMASK_	all the bits up to here
KEY_UNFILT	the key scalar was left unfiltered; the parser was set not to filter. See also ParserOptions::scalar_filtering()
VAL_UNFILT	the val scalar was left unfiltered; the parser was set not to filter. See also ParserOptions::scalar_filtering()
FLOW_SL	mark container with single-line flow style < - seqs as < < [val1,val2] < < when FLOW_SPC is not set, or < < [val1, val2] < < when FLOW_SPC is set (or EmitOptions::force_flow_spc() is set) < - maps as < < {key1: val1,key2: val2} < < when FLOW_SPC is not set, or < < {key1: val1, key2: val2} < < when FLOW_SPC is set (or EmitOptions::force_flow_spc() is set)
FLOW_ML1	mark container with multi-line flow style, 1 element per line < - seqs as < < [ < val1, < val2 < ] < < - maps as < < { < key: val, < key2: val2 < } <
FLOW_MLN	mark container with multi-line flow style, n elements per line, < wrapped (as set by EmitOptions::max_cols()): < - seqs as < < [ < val,val,... < val,val,... < val,val,... < ... < val < ] < < when FLOW_SPC is not set, or < < [ < val, val,... < val, val,... < val, val,... < ... < val < ] < < when FLOW_SPC is set (or EmitOptions::force_flow_spc() is set) < - maps as < < { < key: val,key: val,... < key: val,key: val,... < ... < key: val < } < < when FLOW_SPC is not set, or < < { < key: val, key: val,... < key: val, key: val,... < ... < key: val < } < < when FLOW_SPC is set (or EmitOptions::force_flow_spc() is set)
FLOW_SPC	mark container with spaces after comma when in flow mode. < Applies to both FLOW_SL and FLOW_MLN (but not < to FLOW_ML1), and can be overriden globally by < EmitOptions::force_flow_spc().
BLOCK	mark container with block style < - seqs as < < - val1 < - val2 < < - maps as < < key1: val1 < key2: val2 <
KEY_LITERAL	mark key scalar as multiline, block literal |
VAL_LITERAL	mark val scalar as multiline, block literal |
KEY_FOLDED	mark key scalar as multiline, block folded >
VAL_FOLDED	mark val scalar as multiline, block folded >
KEY_SQUO	mark key scalar as single quoted '
VAL_SQUO	mark val scalar as single quoted '
KEY_DQUO	mark key scalar as double quoted "
VAL_DQUO	mark val scalar as double quoted "
KEY_PLAIN	mark key scalar as plain scalar (unquoted, even when multiline)
VAL_PLAIN	mark val scalar as plain scalar (unquoted, even when multiline)
KEYVAL	mask of KEY|VAL
KEYSEQ	mask of KEY|SEQ
KEYMAP	mask of KEY|MAP
DOCMAP	mask of DOC|MAP
DOCSEQ	mask of DOC|SEQ
DOCVAL	mask of DOC|VAL
SCALAR_LITERAL	mask of KEY_LITERAL|VAL_LITERAL,
SCALAR_FOLDED	mask of KEY_FOLDED|VAL_FOLDED,
SCALAR_SQUO	mask of KEY_SQUO|VAL_SQUO,
SCALAR_DQUO	mask of KEY_DQUO|VAL_DQUO,
SCALAR_PLAIN	mask of KEY_PLAIN|VAL_PLAIN,
KEYQUO	key style is one of `'">|`. mask of KEY_SQUO|KEY_DQUO|KEY_FOLDED|KEY_LITERAL
VALQUO	val style is one of `'">|`. mask of VAL_SQUO|VAL_DQUO|VAL_FOLDED|VAL_LITERAL
KEY_STYLE	mask of KEYQUO|KEY_PLAIN : all the key scalar styles for key (not container styles!)
VAL_STYLE	mask of VALQUO|VAL_PLAIN : all the val scalar styles for val (not container styles!)
SCALAR_STYLE	mask of KEY_STYLE|VAL_STYLE : all the key+val scalar styles
FLOW_MLX	mask of FLOW_ML1|FLOW_MLN : all the flow multiline styles
CONTAINER_STYLE_FLOW	mask of FLOW_SL|FLOW_MLX|FLOW_SPC : all flow flags
CONTAINER_STYLE_BLOCK	alias to BLOCK
CONTAINER_STYLE	mask of CONTAINER_STYLE_FLOW|CONTAINER_STYLE_BLOCK : all container style flags
STYLE	mask of SCALAR_STYLE | CONTAINER_STYLE : all style flags

Definition at line 30 of file node_type.hpp.

             : type_bits { // NOLINT
    #define b_(v) (type_bits(1) << v) // a convenience define, undefined below // NOLINT
    NOTYPE  = 0,         ///< no node type or style is set
    KEY     = b_(0),     ///< the scalar to the left of `:` in a map's member
    VAL     = b_(1),     ///< a scalar: has a scalar (ie string) value, possibly empty. must be a leaf node, and cannot be MAP or SEQ
    MAP     = b_(2),     ///< a map: a parent of KEYVAL/KEYSEQ/KEYMAP nodes
    SEQ     = b_(3),     ///< a seq: a parent of VAL/SEQ/MAP nodes
    DOC     = b_(4),     ///< a document
    STREAM  = b_(5)|SEQ, ///< a stream: a seq of docs
    KEYREF  = b_(6),     ///< a *reference: the key references an &anchor
    VALREF  = b_(7),     ///< a *reference: the val references an &anchor
    KEYANCH = b_(8),     ///< the key has an &anchor
    VALANCH = b_(9),     ///< the val has an &anchor
    KEYTAG  = b_(10),    ///< the key has a tag
    VALTAG  = b_(11),    ///< the val has a tag
    KEYNIL  = b_(12),    ///< the key is null (eg `{ : b}` results in a null key)
    VALNIL  = b_(13),    ///< the val is null (eg `{a : }` results in a null val)
    TYMASK_ = b_(14)-1,  ///< all the bits up to here
    //
    // unfiltered flags:
    //
    KEY_UNFILT  = b_(14), ///< the key scalar was left unfiltered; the parser was set not to filter. @see @ref ParserOptions::scalar_filtering()
    VAL_UNFILT  = b_(15), ///< the val scalar was left unfiltered; the parser was set not to filter. @see @ref ParserOptions::scalar_filtering()
    //
    // style flags:
    //
    FLOW_SL     = b_(16), ///< mark container with single-line flow style
                          ///<  - seqs as
                          ///<    @code{yaml}
                          ///<    [val1,val2]
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is not set, or
                          ///<    @code{yaml}
                          ///<    [val1, val2]
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is set (or @ref EmitOptions::force_flow_spc() is set)
                          ///<  - maps as
                          ///<    @code{yaml}
                          ///<    {key1: val1,key2: val2}
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is not set, or
                          ///<    @code{yaml}
                          ///<    {key1: val1, key2: val2}
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is set (or @ref EmitOptions::force_flow_spc() is set)
    FLOW_ML1    = b_(17), ///< mark container with multi-line flow style, 1 element per line
                          ///<  - seqs as
                          ///<    @code{yaml}
                          ///<    [
                          ///<      val1,
                          ///<      val2
                          ///<    ]
                          ///<    @endcode
                          ///<  - maps as
                          ///<    @code{yaml}
                          ///<    {
                          ///<      key: val,
                          ///<      key2: val2
                          ///<    }
                          ///<    @endcode
    FLOW_MLN    = b_(18), ///< mark container with multi-line flow style, n elements per line,
                          ///< wrapped (as set by @ref EmitOptions::max_cols()):
                          ///<  - seqs as
                          ///<    @code{yaml}
                          ///<    [
                          ///<      val,val,...
                          ///<      val,val,...
                          ///<      val,val,...
                          ///<      ...
                          ///<      val
                          ///<    ]
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is not set, or
                          ///<    @code{yaml}
                          ///<    [
                          ///<      val, val,...
                          ///<      val, val,...
                          ///<      val, val,...
                          ///<      ...
                          ///<      val
                          ///<    ]
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is set (or @ref EmitOptions::force_flow_spc() is set)
                          ///<  - maps as
                          ///<    @code{yaml}
                          ///<    {
                          ///<      key: val,key: val,...
                          ///<      key: val,key: val,...
                          ///<      ...
                          ///<      key: val
                          ///<    }
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is not set, or
                          ///<    @code{yaml}
                          ///<    {
                          ///<      key: val, key: val,...
                          ///<      key: val, key: val,...
                          ///<      ...
                          ///<      key: val
                          ///<    }
                          ///<    @endcode
                          ///<    when @ref FLOW_SPC is set (or @ref EmitOptions::force_flow_spc() is set)
    FLOW_SPC    = b_(19), ///< mark container with spaces after comma when in flow mode.
                          ///< Applies to both @ref FLOW_SL and @ref FLOW_MLN (but not
                          ///< to @ref FLOW_ML1), and can be overriden globally by
                          ///< @ref EmitOptions::force_flow_spc().
    BLOCK       = b_(20), ///< mark container with block style
                          ///<  - seqs as
                          ///<    @code{yaml}
                          ///<    - val1
                          ///<    - val2
                          ///<    @endcode
                          ///<  - maps as
                          ///<    @code{yaml}
                          ///<    key1: val1
                          ///<    key2: val2
                          ///<    @endcode
    KEY_LITERAL = b_(21), ///< mark key scalar as multiline, block literal |
    VAL_LITERAL = b_(22), ///< mark val scalar as multiline, block literal |
    KEY_FOLDED  = b_(23), ///< mark key scalar as multiline, block folded >
    VAL_FOLDED  = b_(24), ///< mark val scalar as multiline, block folded >
    KEY_SQUO    = b_(25), ///< mark key scalar as single quoted '
    VAL_SQUO    = b_(26), ///< mark val scalar as single quoted '
    KEY_DQUO    = b_(27), ///< mark key scalar as double quoted "
    VAL_DQUO    = b_(28), ///< mark val scalar as double quoted "
    KEY_PLAIN   = b_(29), ///< mark key scalar as plain scalar (unquoted, even when multiline)
    VAL_PLAIN   = b_(30), ///< mark val scalar as plain scalar (unquoted, even when multiline)
    //
    // type combination masks:
    //
    KEYVAL  = KEY|VAL, ///< mask of @ref KEY|@ref VAL
    KEYSEQ  = KEY|SEQ, ///< mask of @ref KEY|@ref SEQ
    KEYMAP  = KEY|MAP, ///< mask of @ref KEY|@ref MAP
    DOCMAP  = DOC|MAP, ///< mask of @ref DOC|@ref MAP
    DOCSEQ  = DOC|SEQ, ///< mask of @ref DOC|@ref SEQ
    DOCVAL  = DOC|VAL, ///< mask of @ref DOC|@ref VAL
    //
    // style combination masks:
    //
    SCALAR_LITERAL = KEY_LITERAL|VAL_LITERAL,  ///< mask of @ref KEY_LITERAL|@ref VAL_LITERAL,
    SCALAR_FOLDED  = KEY_FOLDED|VAL_FOLDED,  ///< mask of @ref KEY_FOLDED|@ref VAL_FOLDED,
    SCALAR_SQUO    = KEY_SQUO|VAL_SQUO,  ///< mask of @ref KEY_SQUO|@ref VAL_SQUO,
    SCALAR_DQUO    = KEY_DQUO|VAL_DQUO,  ///< mask of @ref KEY_DQUO|@ref VAL_DQUO,
    SCALAR_PLAIN   = KEY_PLAIN|VAL_PLAIN,  ///< mask of @ref KEY_PLAIN|@ref VAL_PLAIN,
    KEYQUO         = KEY_SQUO|KEY_DQUO|KEY_FOLDED|KEY_LITERAL, ///< key style is one of `'">|`. mask of @ref KEY_SQUO|@ref KEY_DQUO|@ref KEY_FOLDED|@ref KEY_LITERAL
    VALQUO         = VAL_SQUO|VAL_DQUO|VAL_FOLDED|VAL_LITERAL, ///< val style is one of `'">|`. mask of @ref VAL_SQUO|@ref VAL_DQUO|@ref VAL_FOLDED|@ref VAL_LITERAL
    KEY_STYLE      = KEYQUO|KEY_PLAIN, ///< mask of @ref KEYQUO|@ref KEY_PLAIN : all the key scalar styles for key (not container styles!)
    VAL_STYLE      = VALQUO|VAL_PLAIN, ///< mask of @ref VALQUO|@ref VAL_PLAIN : all the val scalar styles for val (not container styles!)
    SCALAR_STYLE   = KEY_STYLE|VAL_STYLE, ///< mask of @ref KEY_STYLE|@ref VAL_STYLE : all the key+val scalar styles
    FLOW_MLX       = FLOW_ML1|FLOW_MLN, ///< mask of @ref FLOW_ML1|@ref FLOW_MLN : all the flow multiline styles
    CONTAINER_STYLE_FLOW  = FLOW_SL|FLOW_MLX|FLOW_SPC, ///< mask of @ref FLOW_SL|@ref FLOW_MLX|@ref FLOW_SPC : all flow flags
    CONTAINER_STYLE_BLOCK = BLOCK, ///< alias to @ref BLOCK
    CONTAINER_STYLE       = CONTAINER_STYLE_FLOW|CONTAINER_STYLE_BLOCK, ///< mask of @ref CONTAINER_STYLE_FLOW|@ref CONTAINER_STYLE_BLOCK : all container style flags
    STYLE          = SCALAR_STYLE | CONTAINER_STYLE, ///< mask of @ref SCALAR_STYLE | @ref CONTAINER_STYLE : all style flags
    //
    // mixed masks
    /** @cond dev */
    KEYMASK_ = KEY | KEYQUO | KEYANCH | KEYREF | KEYTAG,
    VALMASK_ = VAL | VALQUO | VALANCH | VALREF | VALTAG,
    #undef b_
    #ifdef RYML_HAS_DEPRECATED_ENUMS_
    FLOW_ML RYML_DEPRECATED("use one of FLOW_ML{1,N,X}") = FLOW_ML1,
    #endif
    /** @endcond */
} NodeTypeBits;