c4::yml::NodeType Struct Reference

wraps a NodeType_e element with some syntactic sugar and predicates More...

#include <node_type.hpp>

Public Member Functions
	NodeType () noexcept
	NodeType (NodeType_e t) noexcept
	NodeType (type_bits t) noexcept
bool	has_any (NodeType_e t) const noexcept
bool	has_all (NodeType_e t) const noexcept
bool	has_none (NodeType_e t) const noexcept
void	set (NodeType_e t) noexcept
void	add (NodeType_e t) noexcept
void	rem (NodeType_e t) noexcept
void	addrem (NodeType_e bits_to_add, NodeType_e bits_to_remove) noexcept
void	clear () noexcept
	operator NodeType_e & () noexcept
	operator NodeType_e const & () const noexcept
style functions
bool	is_container_styled () const noexcept
bool	is_block () const noexcept
bool	is_flow_sl () const noexcept
bool	is_flow_ml () const noexcept
bool	is_flow () const noexcept
bool	is_key_styled () const noexcept
bool	is_val_styled () const noexcept
bool	is_key_literal () const noexcept
bool	is_val_literal () const noexcept
bool	is_key_folded () const noexcept
bool	is_val_folded () const noexcept
bool	is_key_squo () const noexcept
bool	is_val_squo () const noexcept
bool	is_key_dquo () const noexcept
bool	is_val_dquo () const noexcept
bool	is_key_plain () const noexcept
bool	is_val_plain () const noexcept
bool	is_key_quoted () const noexcept
bool	is_val_quoted () const noexcept
bool	is_quoted () const noexcept
NodeType	key_style () const noexcept
NodeType	val_style () const noexcept
void	set_container_style (NodeType_e style) noexcept
void	set_key_style (NodeType_e style) noexcept
void	set_val_style (NodeType_e style) noexcept
void	clear_style () noexcept

Public Attributes
NodeType_e	type

node type queries
const char *	type_str () const noexcept
	return a preset string based on the node type More...
size_t	type_str (substr buf) const noexcept
	fill a string with the node type flags. More...
csubstr	type_str_sub (substr buf) const noexcept
	fill a string with the node type flags. More...
bool	is_notype () const noexcept
bool	is_stream () const noexcept
bool	is_doc () const noexcept
bool	is_container () const noexcept
bool	is_map () const noexcept
bool	is_seq () const noexcept
bool	has_key () const noexcept
bool	has_val () const noexcept
bool	is_val () const noexcept
bool	is_keyval () const noexcept
bool	key_is_null () const noexcept
bool	val_is_null () const noexcept
bool	has_key_tag () const noexcept
bool	has_val_tag () const noexcept
bool	has_key_anchor () const noexcept
bool	has_val_anchor () const noexcept
bool	has_anchor () const noexcept
bool	is_key_ref () const noexcept
bool	is_val_ref () const noexcept
bool	is_ref () const noexcept
bool	is_key_unfiltered () const noexcept
bool	is_val_unfiltered () const noexcept
bool	is_key_anchor () const noexcept
bool	is_val_anchor () const noexcept
bool	is_anchor () const noexcept
bool	is_anchor_or_ref () const noexcept
static const char *	type_str (NodeType_e t) noexcept
	return a preset string based on the node type More...
static size_t	type_str (substr buf, NodeType_e t) noexcept
	fill a string with the node type flags. More...
static csubstr	type_str_sub (substr buf, NodeType_e t) noexcept
	fill a string with the node type flags. More...

Detailed Description

wraps a NodeType_e element with some syntactic sugar and predicates

Definition at line 120 of file node_type.hpp.

Constructor & Destructor Documentation

NodeType() [1/3]

c4::yml::NodeType::NodeType ( )

inlinenoexcept

Definition at line 128 of file node_type.hpp.

: type(NOTYPE) {}

NodeType() [2/3]

c4::yml::NodeType::NodeType ( NodeType_e  t )

inlinenoexcept

Definition at line 129 of file node_type.hpp.

: type(t) {}

NodeType() [3/3]

c4::yml::NodeType::NodeType ( type_bits  t )

inlinenoexcept

Definition at line 130 of file node_type.hpp.

: type((NodeType_e)t) {}

Member Function Documentation

has_any()

bool c4::yml::NodeType::has_any ( NodeType_e  t ) const

inlinenoexcept

Definition at line 132 of file node_type.hpp.

{ return (type & t) != 0u; }

has_all()

bool c4::yml::NodeType::has_all ( NodeType_e  t ) const

inlinenoexcept

Definition at line 133 of file node_type.hpp.

{ return (type & t) == t; }

has_none()

bool c4::yml::NodeType::has_none ( NodeType_e  t ) const

inlinenoexcept

Definition at line 134 of file node_type.hpp.

{ return (type & t) == 0; }

set()

void c4::yml::NodeType::set ( NodeType_e  t )

inlinenoexcept

Definition at line 136 of file node_type.hpp.

{ type = t; }

add()

void c4::yml::NodeType::add ( NodeType_e  t )

inlinenoexcept

Definition at line 137 of file node_type.hpp.

{ type = (type|t); }

rem()

void c4::yml::NodeType::rem ( NodeType_e  t )

inlinenoexcept

Definition at line 138 of file node_type.hpp.

{ type = (type & ~t); }

addrem()

void c4::yml::NodeType::addrem ( NodeType_e  bits_to_add, NodeType_e  bits_to_remove  )

inlinenoexcept

Definition at line 139 of file node_type.hpp.

{ type |= bits_to_add; type &= ~bits_to_remove; }

clear()

void c4::yml::NodeType::clear ( )

inlinenoexcept

Definition at line 141 of file node_type.hpp.

{ type = NOTYPE; }

operator NodeType_e &()

c4::yml::NodeType::operator NodeType_e & ( )

inlinenoexcept

Definition at line 145 of file node_type.hpp.

{ return type; }

operator NodeType_e const &()

c4::yml::NodeType::operator NodeType_e const & ( ) const

inlinenoexcept

Definition at line 146 of file node_type.hpp.

{ return type; }

type_str() [1/4]

const char* c4::yml::NodeType::type_str ( ) const

inlinenoexcept

return a preset string based on the node type

Definition at line 154 of file node_type.hpp.

{ return type_str(type); }

type_str() [2/4]

const char * c4::yml::NodeType::type_str ( NodeType_e  t )

staticnoexcept

return a preset string based on the node type

Definition at line 12 of file node_type.cpp.

{
    switch(ty & _TYMASK)
    {
    case KEYVAL:
        return "KEYVAL";
    case KEY:
        return "KEY";
    case VAL:
        return "VAL";
    case MAP:
        return "MAP";
    case SEQ:
        return "SEQ";
    case KEYMAP:
        return "KEYMAP";
    case KEYSEQ:
        return "KEYSEQ";
    case DOCSEQ:
        return "DOCSEQ";
    case DOCMAP:
        return "DOCMAP";
    case DOCVAL:
        return "DOCVAL";
    case DOC:
        return "DOC";
    case STREAM:
        return "STREAM";
    case NOTYPE:
        return "NOTYPE";
    default:
        if((ty & KEYVAL) == KEYVAL)
            return "KEYVAL***";
        if((ty & KEYMAP) == KEYMAP)
            return "KEYMAP***";
        if((ty & KEYSEQ) == KEYSEQ)
            return "KEYSEQ***";
        if((ty & DOCSEQ) == DOCSEQ)
            return "DOCSEQ***";
        if((ty & DOCMAP) == DOCMAP)
            return "DOCMAP***";
        if((ty & DOCVAL) == DOCVAL)
            return "DOCVAL***";
        if(ty & KEY)
            return "KEY***";
        if(ty & VAL)
            return "VAL***";
        if(ty & MAP)
            return "MAP***";
        if(ty & SEQ)
            return "SEQ***";
        if(ty & DOC)
            return "DOC***";
        return "(unk)";
    }
}

type_str() [3/4]

size_t c4::yml::NodeType::type_str ( substr  buf ) const

inlinenoexcept

fill a string with the node type flags.

Definition at line 159 of file node_type.hpp.

{ return type_str(buf, type); }

type_str() [4/4]

size_t c4::yml::NodeType::type_str ( substr  buf, NodeType_e  t  )

staticnoexcept

fill a string with the node type flags.

Definition at line 69 of file node_type.cpp.

{
    size_t pos = 0;
    bool gotone = false;
 
    #define _prflag(fl, txt)                                    \
    do {                                                        \
        if((flags & (fl)) == (fl))                              \
        {                                                       \
            if(gotone)                                          \
            {                                                   \
                if(pos + 1 < buf.len)                           \
                    buf[pos] = '|';                             \
                ++pos;                                          \
            }                                                   \
            csubstr fltxt = txt;                                \
            if(pos + fltxt.len <= buf.len)                      \
                memcpy(buf.str + pos, fltxt.str, fltxt.len);    \
            pos += fltxt.len;                                   \
            gotone = true;                                      \
            flags = (flags & ~(fl)); /*remove the flag*/        \
        }                                                       \
    } while(0)
 
    _prflag(STREAM, "STREAM");
    _prflag(DOC, "DOC");
    // key properties
    _prflag(KEY, "KEY");
    _prflag(KEYNIL, "KNIL");
    _prflag(KEYTAG, "KTAG");
    _prflag(KEYANCH, "KANCH");
    _prflag(KEYREF, "KREF");
    _prflag(KEY_LITERAL, "KLITERAL");
    _prflag(KEY_FOLDED, "KFOLDED");
    _prflag(KEY_SQUO, "KSQUO");
    _prflag(KEY_DQUO, "KDQUO");
    _prflag(KEY_PLAIN, "KPLAIN");
    _prflag(KEY_UNFILT, "KUNFILT");
    // val properties
    _prflag(VAL, "VAL");
    _prflag(VALNIL, "VNIL");
    _prflag(VALTAG, "VTAG");
    _prflag(VALANCH, "VANCH");
    _prflag(VALREF, "VREF");
    _prflag(VAL_UNFILT, "VUNFILT");
    _prflag(VAL_LITERAL, "VLITERAL");
    _prflag(VAL_FOLDED, "VFOLDED");
    _prflag(VAL_SQUO, "VSQUO");
    _prflag(VAL_DQUO, "VDQUO");
    _prflag(VAL_PLAIN, "VPLAIN");
    _prflag(VAL_UNFILT, "VUNFILT");
    // container properties
    _prflag(MAP, "MAP");
    _prflag(SEQ, "SEQ");
    _prflag(FLOW_SL, "FLOWSL");
    _prflag(FLOW_ML, "FLOWML");
    _prflag(BLOCK, "BLCK");
    if(pos == 0)
        _prflag(NOTYPE, "NOTYPE");
 
    #undef _prflag
 
    return pos;
}

type_str_sub() [1/2]

csubstr c4::yml::NodeType::type_str_sub ( substr  buf ) const

inlinenoexcept

fill a string with the node type flags.

If the string is small, returns {null, len}

Definition at line 164 of file node_type.hpp.

{ return type_str_sub(buf, type); }

type_str_sub() [2/2]

static csubstr c4::yml::NodeType::type_str_sub ( substr  buf, NodeType_e  t  )

inlinestaticnoexcept

fill a string with the node type flags.

If the string is small, returns {null, len}

Definition at line 166 of file node_type.hpp.

    {
        csubstr ret;
        ret.len = type_str(buf, t);
        ret.str = ret.len < buf.len ? buf.str : nullptr;
        return ret;
    }

is_notype()

bool c4::yml::NodeType::is_notype ( ) const

inlinenoexcept

Definition at line 179 of file node_type.hpp.

{ return type == NOTYPE; }

is_stream()

bool c4::yml::NodeType::is_stream ( ) const

inlinenoexcept

Definition at line 180 of file node_type.hpp.

{ return ((type & STREAM) == STREAM) != 0; }

is_doc()

bool c4::yml::NodeType::is_doc ( ) const

inlinenoexcept

Definition at line 181 of file node_type.hpp.

{ return (type & DOC) != 0; }

is_container()

bool c4::yml::NodeType::is_container ( ) const

inlinenoexcept

Definition at line 182 of file node_type.hpp.

{ return (type & (MAP|SEQ|STREAM)) != 0; }

is_map()

bool c4::yml::NodeType::is_map ( ) const

inlinenoexcept

Definition at line 183 of file node_type.hpp.

{ return (type & MAP) != 0; }

is_seq()

bool c4::yml::NodeType::is_seq ( ) const

inlinenoexcept

Definition at line 184 of file node_type.hpp.

{ return (type & SEQ) != 0; }

has_key()

bool c4::yml::NodeType::has_key ( ) const

inlinenoexcept

Definition at line 185 of file node_type.hpp.

{ return (type & KEY) != 0; }

has_val()

bool c4::yml::NodeType::has_val ( ) const

inlinenoexcept

Definition at line 186 of file node_type.hpp.

{ return (type & VAL) != 0; }

is_val()

bool c4::yml::NodeType::is_val ( ) const

inlinenoexcept

Definition at line 187 of file node_type.hpp.

{ return (type & KEYVAL) == VAL; }

is_keyval()

bool c4::yml::NodeType::is_keyval ( ) const

inlinenoexcept

Definition at line 188 of file node_type.hpp.

{ return (type & KEYVAL) == KEYVAL; }

key_is_null()

bool c4::yml::NodeType::key_is_null ( ) const

inlinenoexcept

Definition at line 189 of file node_type.hpp.

{ return (type & KEYNIL) != 0; }

val_is_null()

bool c4::yml::NodeType::val_is_null ( ) const

inlinenoexcept

Definition at line 190 of file node_type.hpp.

{ return (type & VALNIL) != 0; }

has_key_tag()

bool c4::yml::NodeType::has_key_tag ( ) const

inlinenoexcept

Definition at line 191 of file node_type.hpp.

{ return (type & KEYTAG) != 0; }

has_val_tag()

bool c4::yml::NodeType::has_val_tag ( ) const

inlinenoexcept

Definition at line 192 of file node_type.hpp.

{ return (type & VALTAG) != 0; }

has_key_anchor()

bool c4::yml::NodeType::has_key_anchor ( ) const

inlinenoexcept

Definition at line 193 of file node_type.hpp.

{ return (type & KEYANCH) != 0; }

has_val_anchor()

bool c4::yml::NodeType::has_val_anchor ( ) const

inlinenoexcept

Definition at line 194 of file node_type.hpp.

{ return (type & VALANCH) != 0; }

has_anchor()

bool c4::yml::NodeType::has_anchor ( ) const

inlinenoexcept

Definition at line 195 of file node_type.hpp.

{ return (type & (KEYANCH|VALANCH)) != 0; }

is_key_ref()

bool c4::yml::NodeType::is_key_ref ( ) const

inlinenoexcept

Definition at line 196 of file node_type.hpp.

{ return (type & KEYREF) != 0; }

is_val_ref()

bool c4::yml::NodeType::is_val_ref ( ) const

inlinenoexcept

Definition at line 197 of file node_type.hpp.

{ return (type & VALREF) != 0; }

is_ref()

bool c4::yml::NodeType::is_ref ( ) const

inlinenoexcept

Definition at line 198 of file node_type.hpp.

{ return (type & (KEYREF|VALREF)) != 0; }

is_key_unfiltered()

bool c4::yml::NodeType::is_key_unfiltered ( ) const

inlinenoexcept

Definition at line 200 of file node_type.hpp.

{ return (type & (KEY_UNFILT)) != 0; }

is_val_unfiltered()

bool c4::yml::NodeType::is_val_unfiltered ( ) const

inlinenoexcept

Definition at line 201 of file node_type.hpp.

{ return (type & (VAL_UNFILT)) != 0; }

is_key_anchor()

bool c4::yml::NodeType::is_key_anchor ( ) const

inlinenoexcept

Definition at line 203 of file node_type.hpp.

{ return has_key_anchor(); }

is_val_anchor()

bool c4::yml::NodeType::is_val_anchor ( ) const

inlinenoexcept

Definition at line 204 of file node_type.hpp.

{ return has_val_anchor(); }

is_anchor()

bool c4::yml::NodeType::is_anchor ( ) const

inlinenoexcept

Definition at line 205 of file node_type.hpp.

{ return has_anchor(); }

is_anchor_or_ref()

bool c4::yml::NodeType::is_anchor_or_ref ( ) const

inlinenoexcept

Definition at line 206 of file node_type.hpp.

{ return has_anchor() || is_ref(); }

is_container_styled()

bool c4::yml::NodeType::is_container_styled ( ) const

inlinenoexcept

Definition at line 214 of file node_type.hpp.

{ return (type & (CONTAINER_STYLE)) != 0; }

is_block()

bool c4::yml::NodeType::is_block ( ) const

inlinenoexcept

Definition at line 215 of file node_type.hpp.

{ return (type & (BLOCK)) != 0; }

is_flow_sl()

bool c4::yml::NodeType::is_flow_sl ( ) const

inlinenoexcept

Definition at line 216 of file node_type.hpp.

{ return (type & (FLOW_SL)) != 0; }

is_flow_ml()

bool c4::yml::NodeType::is_flow_ml ( ) const

inlinenoexcept

Definition at line 217 of file node_type.hpp.

{ return (type & (FLOW_ML)) != 0; }

is_flow()

bool c4::yml::NodeType::is_flow ( ) const

inlinenoexcept

Definition at line 218 of file node_type.hpp.

{ return (type & (FLOW_ML|FLOW_SL)) != 0; }

is_key_styled()

bool c4::yml::NodeType::is_key_styled ( ) const

inlinenoexcept

Definition at line 220 of file node_type.hpp.

{ return (type & (KEY_STYLE)) != 0; }

is_val_styled()

bool c4::yml::NodeType::is_val_styled ( ) const

inlinenoexcept

Definition at line 221 of file node_type.hpp.

{ return (type & (VAL_STYLE)) != 0; }

is_key_literal()

bool c4::yml::NodeType::is_key_literal ( ) const

inlinenoexcept

Definition at line 222 of file node_type.hpp.

{ return (type & (KEY_LITERAL)) != 0; }

is_val_literal()

bool c4::yml::NodeType::is_val_literal ( ) const

inlinenoexcept

Definition at line 223 of file node_type.hpp.

{ return (type & (VAL_LITERAL)) != 0; }

is_key_folded()

bool c4::yml::NodeType::is_key_folded ( ) const

inlinenoexcept

Definition at line 224 of file node_type.hpp.

{ return (type & (KEY_FOLDED)) != 0; }

is_val_folded()

bool c4::yml::NodeType::is_val_folded ( ) const

inlinenoexcept

Definition at line 225 of file node_type.hpp.

{ return (type & (VAL_FOLDED)) != 0; }

is_key_squo()

bool c4::yml::NodeType::is_key_squo ( ) const

inlinenoexcept

Definition at line 226 of file node_type.hpp.

{ return (type & (KEY_SQUO)) != 0; }

is_val_squo()

bool c4::yml::NodeType::is_val_squo ( ) const

inlinenoexcept

Definition at line 227 of file node_type.hpp.

{ return (type & (VAL_SQUO)) != 0; }

is_key_dquo()

bool c4::yml::NodeType::is_key_dquo ( ) const

inlinenoexcept

Definition at line 228 of file node_type.hpp.

{ return (type & (KEY_DQUO)) != 0; }

is_val_dquo()

bool c4::yml::NodeType::is_val_dquo ( ) const

inlinenoexcept

Definition at line 229 of file node_type.hpp.

{ return (type & (VAL_DQUO)) != 0; }

is_key_plain()

bool c4::yml::NodeType::is_key_plain ( ) const

inlinenoexcept

Definition at line 230 of file node_type.hpp.

{ return (type & (KEY_PLAIN)) != 0; }

is_val_plain()

bool c4::yml::NodeType::is_val_plain ( ) const

inlinenoexcept

Definition at line 231 of file node_type.hpp.

{ return (type & (VAL_PLAIN)) != 0; }

is_key_quoted()

bool c4::yml::NodeType::is_key_quoted ( ) const

inlinenoexcept

Definition at line 232 of file node_type.hpp.

{ return (type & KEYQUO) != 0; }

is_val_quoted()

bool c4::yml::NodeType::is_val_quoted ( ) const

inlinenoexcept

Definition at line 233 of file node_type.hpp.

{ return (type & VALQUO) != 0; }

is_quoted()

bool c4::yml::NodeType::is_quoted ( ) const

inlinenoexcept

Definition at line 234 of file node_type.hpp.

{ return (type & (KEYQUO|VALQUO)) != 0; }

key_style()

NodeType c4::yml::NodeType::key_style ( ) const

inlinenoexcept

Definition at line 236 of file node_type.hpp.

{ return (type & (KEY_STYLE)); }

val_style()

NodeType c4::yml::NodeType::val_style ( ) const

inlinenoexcept

Definition at line 237 of file node_type.hpp.

{ return (type & (VAL_STYLE)); }

set_container_style()

void c4::yml::NodeType::set_container_style ( NodeType_e  style )

inlinenoexcept

Definition at line 239 of file node_type.hpp.

{ type = ((style & CONTAINER_STYLE) | (type & ~CONTAINER_STYLE)); }

set_key_style()

void c4::yml::NodeType::set_key_style ( NodeType_e  style )

inlinenoexcept

Definition at line 240 of file node_type.hpp.

{ type = ((style & KEY_STYLE) | (type & ~KEY_STYLE)); }

set_val_style()

void c4::yml::NodeType::set_val_style ( NodeType_e  style )

inlinenoexcept

Definition at line 241 of file node_type.hpp.

{ type = ((style & VAL_STYLE) | (type & ~VAL_STYLE)); }

clear_style()

void c4::yml::NodeType::clear_style ( )

inlinenoexcept

Definition at line 242 of file node_type.hpp.

{ type &= ~STYLE; }

Member Data Documentation

type

NodeType_e c4::yml::NodeType::type

Definition at line 124 of file node_type.hpp.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.13.0/src/c4/yml/node_type.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.13.0/src/c4/yml/node_type.cpp