c4::yml::NodeType Struct Reference

Wraps a type_bits mask of NodeTypeBits flags with some syntactic sugar and predicates. More...

#include <node_type.hpp>

Public Member Functions
auto convert to type_bits
	operator type_bits & () noexcept
	operator type_bits const & () const noexcept
ctor
	NodeType () noexcept
	NodeType (type_bits t) noexcept
query / set
bool	has_any (type_bits t) const noexcept
bool	has_all (type_bits t) const noexcept
bool	has_none (type_bits t) const noexcept
void	set (type_bits t) noexcept
void	add (type_bits t) noexcept
void	rem (type_bits t) noexcept
void	addrem (type_bits bits_to_add, type_bits bits_to_remove) noexcept
void	clear () noexcept
node type predicates
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
node style predicates
bool	is_container_styled () const noexcept
bool	is_block () const noexcept
bool	is_flow_sl () const noexcept
bool	is_flow_ml1 () const noexcept
bool	is_flow_mln () const noexcept
bool	is_flow_mlx () const noexcept
bool	is_flow () const noexcept
bool	has_flow_space () 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 (type_bits style) noexcept
void	set_key_style (type_bits style) noexcept
void	set_val_style (type_bits style) noexcept
void	clear_style () noexcept

Public Attributes
type_bits	m_bits

convert to string
const char *	type_str () const noexcept
	return a preset string based on the node type
size_t	type_str (substr buf) const noexcept
	fill a string with the node type flags.
csubstr	type_str_sub (substr buf) const noexcept
	fill a string with the node type flags.
static const char *	type_str (type_bits t) noexcept
	return a preset string based on the node type
static size_t	type_str (substr buf, type_bits t) noexcept
	fill a string with the node type flags.
static csubstr	type_str_sub (substr buf, type_bits t) noexcept
	fill a string with the node type flags.

Detailed Description

Wraps a type_bits mask of NodeTypeBits flags with some syntactic sugar and predicates.

Definition at line 213 of file node_type.hpp.

Constructor & Destructor Documentation

NodeType() [1/2]

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

inlinenoexcept

Definition at line 234 of file node_type.hpp.

: m_bits(NOTYPE) {}

Referenced by key_style(), and val_style().

NodeType() [2/2]

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

inlinenoexcept

Definition at line 235 of file node_type.hpp.

: m_bits(t) {}

Member Function Documentation

operator type_bits &()

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

inlinenoexcept

Definition at line 224 of file node_type.hpp.

{ return m_bits; }

operator type_bits const &()

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

inlinenoexcept

Definition at line 225 of file node_type.hpp.

{ return m_bits; }

has_any()

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

inlinenoexcept

Definition at line 244 of file node_type.hpp.

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

has_all()

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

inlinenoexcept

Definition at line 245 of file node_type.hpp.

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

has_none()

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

inlinenoexcept

Definition at line 246 of file node_type.hpp.

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

set()

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

inlinenoexcept

Definition at line 248 of file node_type.hpp.

{ m_bits = t; }

add()

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

inlinenoexcept

Definition at line 249 of file node_type.hpp.

{ m_bits |= t; }

Referenced by c4::yml::Tree::set_root_as_stream().

rem()

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

inlinenoexcept

Definition at line 250 of file node_type.hpp.

{ m_bits &= ~t; }

Referenced by c4::yml::Tree::set_root_as_stream().

addrem()

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

inlinenoexcept

Definition at line 251 of file node_type.hpp.

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

clear()

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

inlinenoexcept

Definition at line 253 of file node_type.hpp.

{ m_bits = NOTYPE; }

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 263 of file node_type.hpp.

{ return type_str(m_bits); }

Referenced by type_str(), and type_str_sub().

type_str() [2/4]

const char * c4::yml::NodeType::type_str ( type_bits 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 268 of file node_type.hpp.

{ return type_str(buf, m_bits); }

Referenced by type_str().

type_str() [4/4]

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

staticnoexcept

fill a string with the node type flags.

Definition at line 108 of file node_type.cpp.

{
    detail::SubstrWriter_ writer(buf);
    for(type_and_name const tn : type_names)
    {
        if((flags & tn.bits) == tn.bits)
        {
            if(writer.pos)
                writer.append('|');
            writer.append(tn.str);
            flags = flags & ~tn.bits; // remove the flag
        }
    }
    if(!writer.pos)
        writer.append("NOTYPE");
    if(writer.pos < buf.len)
        buf[writer.pos] = '\0';
    return writer.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 273 of file node_type.hpp.

{ return type_str_sub(buf, m_bits); }

Referenced by type_str_sub().

type_str_sub() [2/2]

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

inlinestaticnoexcept

fill a string with the node type flags.

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

Definition at line 275 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 290 of file node_type.hpp.

{ return m_bits == NOTYPE; }

is_stream()

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

inlinenoexcept

Definition at line 291 of file node_type.hpp.

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

Referenced by c4::yml::Tree::set_root_as_stream().

is_doc()

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

inlinenoexcept

Definition at line 292 of file node_type.hpp.

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

Referenced by c4::yml::Tree::ancestor_doc().

is_container()

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

inlinenoexcept

Definition at line 293 of file node_type.hpp.

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

Referenced by c4::yml::Tree::set_root_as_stream().

is_map()

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

inlinenoexcept

Definition at line 294 of file node_type.hpp.

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

Referenced by c4::yml::Tree::change_type(), c4::yml::Tree::duplicate_children_no_rep(), and c4::yml::Tree::merge_with().

is_seq()

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

inlinenoexcept

Definition at line 295 of file node_type.hpp.

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

Referenced by c4::yml::Tree::change_type(), c4::yml::Tree::duplicate_children_no_rep(), and c4::yml::Tree::merge_with().

has_key()

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

inlinenoexcept

Definition at line 296 of file node_type.hpp.

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

Referenced by c4::yml::Tree::change_type(), and c4::yml::Tree::set_root_as_stream().

has_val()

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

inlinenoexcept

Definition at line 297 of file node_type.hpp.

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

Referenced by c4::yml::Tree::merge_with().

is_val()

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

inlinenoexcept

Definition at line 298 of file node_type.hpp.

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

Referenced by c4::yml::Tree::change_type(), and c4::yml::Tree::merge_with().

is_keyval()

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

inlinenoexcept

Definition at line 299 of file node_type.hpp.

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

Referenced by c4::yml::Tree::merge_with().

key_is_null()

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

inlinenoexcept

Definition at line 300 of file node_type.hpp.

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

val_is_null()

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

inlinenoexcept

Definition at line 301 of file node_type.hpp.

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

has_key_tag()

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

inlinenoexcept

Definition at line 302 of file node_type.hpp.

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

has_val_tag()

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

inlinenoexcept

Definition at line 303 of file node_type.hpp.

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

has_key_anchor()

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

inlinenoexcept

Definition at line 304 of file node_type.hpp.

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

has_val_anchor()

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

inlinenoexcept

Definition at line 305 of file node_type.hpp.

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

has_anchor()

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

inlinenoexcept

Definition at line 306 of file node_type.hpp.

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

is_key_ref()

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

inlinenoexcept

Definition at line 307 of file node_type.hpp.

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

is_val_ref()

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

inlinenoexcept

Definition at line 308 of file node_type.hpp.

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

is_ref()

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

inlinenoexcept

Definition at line 309 of file node_type.hpp.

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

is_key_unfiltered()

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

inlinenoexcept

Definition at line 311 of file node_type.hpp.

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

is_val_unfiltered()

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

inlinenoexcept

Definition at line 312 of file node_type.hpp.

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

is_container_styled()

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

inlinenoexcept

Definition at line 321 of file node_type.hpp.

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

is_block()

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

inlinenoexcept

Definition at line 322 of file node_type.hpp.

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

is_flow_sl()

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

inlinenoexcept

Definition at line 323 of file node_type.hpp.

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

is_flow_ml1()

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

inlinenoexcept

Definition at line 324 of file node_type.hpp.

{ return (m_bits & (FLOW_ML1)) != 0; }

is_flow_mln()

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

inlinenoexcept

Definition at line 325 of file node_type.hpp.

{ return (m_bits & (FLOW_MLN)) != 0; }

Referenced by sample_style_flow_formatting().

is_flow_mlx()

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

inlinenoexcept

Definition at line 326 of file node_type.hpp.

{ return (m_bits & (FLOW_ML1|FLOW_MLN)) != 0; }

is_flow()

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

inlinenoexcept

Definition at line 327 of file node_type.hpp.

{ return (m_bits & (FLOW_ML1|FLOW_MLN|FLOW_SL)) != 0; }

has_flow_space()

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

inlinenoexcept

Definition at line 328 of file node_type.hpp.

{ return (m_bits & (FLOW_SPC)) != 0; }

is_key_styled()

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

inlinenoexcept

Definition at line 330 of file node_type.hpp.

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

is_val_styled()

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

inlinenoexcept

Definition at line 331 of file node_type.hpp.

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

is_key_literal()

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

inlinenoexcept

Definition at line 332 of file node_type.hpp.

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

is_val_literal()

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

inlinenoexcept

Definition at line 333 of file node_type.hpp.

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

is_key_folded()

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

inlinenoexcept

Definition at line 334 of file node_type.hpp.

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

is_val_folded()

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

inlinenoexcept

Definition at line 335 of file node_type.hpp.

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

is_key_squo()

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

inlinenoexcept

Definition at line 336 of file node_type.hpp.

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

is_val_squo()

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

inlinenoexcept

Definition at line 337 of file node_type.hpp.

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

is_key_dquo()

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

inlinenoexcept

Definition at line 338 of file node_type.hpp.

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

is_val_dquo()

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

inlinenoexcept

Definition at line 339 of file node_type.hpp.

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

is_key_plain()

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

inlinenoexcept

Definition at line 340 of file node_type.hpp.

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

is_val_plain()

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

inlinenoexcept

Definition at line 341 of file node_type.hpp.

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

is_key_quoted()

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

inlinenoexcept

Definition at line 342 of file node_type.hpp.

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

is_val_quoted()

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

inlinenoexcept

Definition at line 343 of file node_type.hpp.

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

is_quoted()

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

inlinenoexcept

Definition at line 344 of file node_type.hpp.

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

key_style()

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

inlinenoexcept

Definition at line 346 of file node_type.hpp.

{ return (m_bits & (KEY_STYLE)); }

val_style()

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

inlinenoexcept

Definition at line 347 of file node_type.hpp.

{ return (m_bits & (VAL_STYLE)); }

set_container_style()

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

inlinenoexcept

Definition at line 349 of file node_type.hpp.

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

set_key_style()

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

inlinenoexcept

Definition at line 350 of file node_type.hpp.

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

set_val_style()

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

inlinenoexcept

Definition at line 351 of file node_type.hpp.

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

clear_style()

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

inlinenoexcept

Definition at line 352 of file node_type.hpp.

{ m_bits &= ~STYLE; }

Member Data Documentation

m_bits

type_bits c4::yml::NodeType::m_bits

Definition at line 217 of file node_type.hpp.

Referenced by NodeType(), NodeType(), add(), addrem(), c4::yml::Tree::change_type(), clear(), clear_style(), has_all(), has_anchor(), has_any(), has_flow_space(), has_key(), has_key_anchor(), has_key_tag(), has_none(), has_val(), has_val_anchor(), has_val_tag(), is_block(), is_container(), is_container_styled(), is_doc(), is_flow(), is_flow_ml1(), is_flow_mln(), is_flow_mlx(), is_flow_sl(), is_key_dquo(), is_key_folded(), is_key_literal(), is_key_plain(), is_key_quoted(), is_key_ref(), is_key_squo(), is_key_styled(), is_key_unfiltered(), is_keyval(), is_map(), is_notype(), is_quoted(), is_ref(), is_seq(), is_stream(), is_val(), is_val_dquo(), is_val_folded(), is_val_literal(), is_val_plain(), is_val_quoted(), is_val_ref(), is_val_squo(), is_val_styled(), is_val_unfiltered(), key_is_null(), key_style(), operator type_bits &(), operator type_bits const &(), rem(), set(), set_container_style(), set_key_style(), set_val_style(), type_str(), type_str(), type_str_sub(), val_is_null(), and val_style().

---

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

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