rapidyaml 0.14.0
parse and emit YAML, and do it fast
Loading...
Searching...
No Matches
c4::yml::NodeRef Class Reference
Node classes

A reference to a node in an existing yaml tree, offering a more convenient API than the index-based API used in the tree. More...

#include <node.hpp>

Public Types

using tree_type = Tree
using base_type = detail::RoNodeMethods<NodeRef, ConstNodeRef>

Public Member Functions

construction
 NodeRef () noexcept
 NodeRef (Tree &t) noexcept
 NodeRef (Tree *t) noexcept
 NodeRef (Tree *t, id_type id) noexcept
 NodeRef (Tree *t, id_type id, id_type seed_pos) noexcept
 NodeRef (Tree *t, id_type id, csubstr seed_key) noexcept
 NodeRef (std::nullptr_t) noexcept
void _clear_seed () noexcept
assignment
 NodeRef (NodeRef const &) noexcept=default
 NodeRef (NodeRef &&) noexcept=default
NodeRef & operator= (NodeRef const &) noexcept=default
NodeRef & operator= (NodeRef &&) noexcept=default
state_queries
bool invalid () const noexcept
 true if the object is not referring to any existing or seed node.
bool is_seed () const noexcept
 true if the object is not invalid and in seed state.
bool readable () const noexcept
 true if the object is not invalid and not in seed state.
bool valid () const
comparisons
bool operator== (NodeRef const &that) const
bool operator!= (NodeRef const &that) const
bool operator== (ConstNodeRef const &that) const
bool operator!= (ConstNodeRef const &that) const
node_property_getters
Tree * tree () noexcept
Tree const * tree () const noexcept
id_type id () const noexcept
node_modifiers
void create ()
void change_type (NodeType t)
void set_type (NodeType t)
void set_key (csubstr key)
void set_val (csubstr val)
void set_key_tag (csubstr key_tag)
void set_val_tag (csubstr val_tag)
void set_key_anchor (csubstr key_anchor)
void set_val_anchor (csubstr val_anchor)
void set_key_ref (csubstr key_ref)
void set_val_ref (csubstr val_ref)
void set_container_style (NodeType_e style)
void set_key_style (NodeType_e style)
void set_val_style (NodeType_e style)
void clear_style (bool recurse=false)
void set_style_conditionally (NodeType type_mask, NodeType rem_style_flags, NodeType add_style_flags, bool recurse=false)
void clear ()
void clear_key ()
void clear_val ()
void clear_children ()
void operator= (NodeType_e t)
void operator|= (NodeType_e t)
void operator= (NodeInit const &v)
void operator= (NodeScalar const &v)
void operator= (std::nullptr_t)
void operator= (csubstr v)
template<size_t N>
void operator= (const char(&v)[N])
serialization
template<class T>
csubstr to_arena (T const &s)
 serialize a variable to the arena
template<class T>
size_t set_key_serialized (T const &k)
size_t set_key_serialized (std::nullptr_t)
template<class T>
size_t set_val_serialized (T const &v)
size_t set_val_serialized (std::nullptr_t)
NodeRef & operator<< (csubstr s)
 serialize a variable, then assign the result to the node's val
template<class T>
NodeRef & operator<< (T const &v)
template<class T>
NodeRef & operator<< (Key< const T > const &v)
 serialize a variable, then assign the result to the node's key
template<class T>
NodeRef & operator<< (Key< T > const &v)
 serialize a variable, then assign the result to the node's key
modification of hierarchy
NodeRef insert_child (NodeRef after)
NodeRef insert_child (NodeInit const &i, NodeRef after)
NodeRef prepend_child ()
NodeRef prepend_child (NodeInit const &i)
NodeRef append_child ()
NodeRef append_child (NodeInit const &i)
NodeRef insert_sibling (ConstNodeRef const &after)
NodeRef insert_sibling (NodeInit const &i, ConstNodeRef const &after)
NodeRef prepend_sibling ()
NodeRef prepend_sibling (NodeInit const &i)
NodeRef append_sibling ()
NodeRef append_sibling (NodeInit const &i)
void remove_child (NodeRef &child)
void remove_child (id_type pos)
 remove the nth child of this node
void remove_child (csubstr key)
 remove a child by name
void move (ConstNodeRef const &after)
 change the node's position within its parent, placing it after after.
void move (NodeRef const &parent, ConstNodeRef const &after)
 move the node to a different parent (which may belong to a different tree), placing it after after.
NodeRef duplicate (ConstNodeRef const &after) const
 duplicate the current node somewhere within its parent, and place it after the node after.
NodeRef duplicate (NodeRef const &parent, ConstNodeRef const &after) const
 duplicate the current node somewhere into a different parent (possibly from a different tree), and place it after the node after.
void duplicate_children (NodeRef const &parent, ConstNodeRef const &after) const
node property getters
NodeData const * get () const RYML_NOEXCEPT
 returns the data or null when the id is NONE
auto get () RYML_NOEXCEPT -> NodeData *
 returns the data or null when the id is NONE
NodeType type () const RYML_NOEXCEPT
 Forward to Tree::type().
const char * type_str () const RYML_NOEXCEPT
 Forward to Tree::type_str().
csubstr key () const RYML_NOEXCEPT
 Forward to Tree::key().
csubstr key_tag () const RYML_NOEXCEPT
 Forward to Tree::key_tag().
csubstr key_ref () const RYML_NOEXCEPT
 Forward to Tree::key_ref().
csubstr key_anchor () const RYML_NOEXCEPT
 Forward to Tree::key_anchor().
csubstr val () const RYML_NOEXCEPT
 Forward to Tree::val().
csubstr val_tag () const RYML_NOEXCEPT
 Forward to Tree::val_tag().
csubstr val_ref () const RYML_NOEXCEPT
 Forward to Tree::val_ref().
csubstr val_anchor () const RYML_NOEXCEPT
 Forward to Tree::val_anchor().
NodeScalar const & keysc () const RYML_NOEXCEPT
 Forward to Tree::keysc().
NodeScalar const & valsc () const RYML_NOEXCEPT
 Forward to Tree::valsc().
bool key_is_null () const RYML_NOEXCEPT
 Forward to Tree::key_is_null().
bool val_is_null () const RYML_NOEXCEPT
 Forward to Tree::val_is_null().
bool is_key_unfiltered () const noexcept
 Forward to Tree::is_key_unfiltered().
bool is_val_unfiltered () const noexcept
 Forward to Tree::is_val_unfiltered().
node type predicates
bool empty () const RYML_NOEXCEPT
 Forward to Tree::empty().
bool is_stream () const RYML_NOEXCEPT
 Forward to Tree::is_stream().
bool is_doc () const RYML_NOEXCEPT
 Forward to Tree::is_doc().
bool is_container () const RYML_NOEXCEPT
 Forward to Tree::is_container().
bool is_map () const RYML_NOEXCEPT
 Forward to Tree::is_map().
bool is_seq () const RYML_NOEXCEPT
 Forward to Tree::is_seq().
bool has_val () const RYML_NOEXCEPT
 Forward to Tree::has_val().
bool has_key () const RYML_NOEXCEPT
 Forward to Tree::has_key().
bool is_val () const RYML_NOEXCEPT
 Forward to Tree::is_val().
bool is_keyval () const RYML_NOEXCEPT
 Forward to Tree::is_keyval().
bool has_key_tag () const RYML_NOEXCEPT
 Forward to Tree::has_key_tag().
bool has_val_tag () const RYML_NOEXCEPT
 Forward to Tree::has_val_tag().
bool has_key_anchor () const RYML_NOEXCEPT
 Forward to Tree::has_key_anchor().
bool has_val_anchor () const RYML_NOEXCEPT
 Forward to Tree::has_val_anchor().
bool has_anchor () const RYML_NOEXCEPT
 Forward to Tree::has_anchor().
bool is_key_ref () const RYML_NOEXCEPT
 Forward to Tree::is_key_ref().
bool is_val_ref () const RYML_NOEXCEPT
 Forward to Tree::is_val_ref().
bool is_ref () const RYML_NOEXCEPT
 Forward to Tree::is_ref().
bool parent_is_seq () const RYML_NOEXCEPT
 Forward to Tree::parent_is_seq().
bool parent_is_map () const RYML_NOEXCEPT
 Forward to Tree::parent_is_map().
bool is_key_anchor () const noexcept
bool is_val_hanchor () const noexcept
bool is_anchor () const noexcept
bool is_anchor_or_ref () const noexcept
style predicates
bool type_has_any (NodeType_e bits) const RYML_NOEXCEPT
 Forward to Tree::type_has_any().
bool type_has_all (NodeType_e bits) const RYML_NOEXCEPT
 Forward to Tree::type_has_all().
bool type_has_none (NodeType_e bits) const RYML_NOEXCEPT
 Forward to Tree::type_has_none().
NodeType key_style () const RYML_NOEXCEPT
 Forward to Tree::key_style().
NodeType val_style () const RYML_NOEXCEPT
 Forward to Tree::val_style().
bool is_container_styled () const RYML_NOEXCEPT
 Forward to Tree::is_container_styled().
bool is_block () const RYML_NOEXCEPT
 Forward to Tree::is_block().
bool is_flow_sl () const RYML_NOEXCEPT
 Forward to Tree::is_flow_sl().
bool is_flow_ml () const RYML_NOEXCEPT
 Forward to Tree::is_flow_ml().
bool is_flow () const RYML_NOEXCEPT
 Forward to Tree::is_flow().
bool is_key_styled () const RYML_NOEXCEPT
 Forward to Tree::is_key_styled().
bool is_val_styled () const RYML_NOEXCEPT
 Forward to Tree::is_val_styled().
bool is_key_literal () const RYML_NOEXCEPT
 Forward to Tree::is_key_literal().
bool is_val_literal () const RYML_NOEXCEPT
 Forward to Tree::is_val_literal().
bool is_key_folded () const RYML_NOEXCEPT
 Forward to Tree::is_key_folded().
bool is_val_folded () const RYML_NOEXCEPT
 Forward to Tree::is_val_folded().
bool is_key_squo () const RYML_NOEXCEPT
 Forward to Tree::is_key_squo().
bool is_val_squo () const RYML_NOEXCEPT
 Forward to Tree::is_val_squo().
bool is_key_dquo () const RYML_NOEXCEPT
 Forward to Tree::is_key_dquo().
bool is_val_dquo () const RYML_NOEXCEPT
 Forward to Tree::is_val_dquo().
bool is_key_plain () const RYML_NOEXCEPT
 Forward to Tree::is_key_plain().
bool is_val_plain () const RYML_NOEXCEPT
 Forward to Tree::is_val_plain().
bool is_key_quoted () const RYML_NOEXCEPT
 Forward to Tree::is_key_quoted().
bool is_val_quoted () const RYML_NOEXCEPT
 Forward to Tree::is_val_quoted().
bool is_quoted () const RYML_NOEXCEPT
 Forward to Tree::is_quoted().
hierarchy predicates
bool is_root () const RYML_NOEXCEPT
 Forward to Tree::is_root().
bool has_parent () const RYML_NOEXCEPT
 Forward to Tree::has_parent() Node must be readable.
bool is_ancestor (ConstNodeRef const &ancestor) const RYML_NOEXCEPT
 Forward to Tree::is_ancestor() Node must be readable.
bool has_child (ConstNodeRef const &n) const RYML_NOEXCEPT
 Forward to Tree::has_child().
bool has_child (id_type node) const RYML_NOEXCEPT
 Forward to Tree::has_child().
bool has_child (csubstr name) const RYML_NOEXCEPT
 Forward to Tree::has_child().
bool has_children () const RYML_NOEXCEPT
 Forward to Tree::has_children().
bool has_sibling (ConstNodeRef const &n) const RYML_NOEXCEPT
 Forward to Tree::has_sibling().
bool has_sibling (id_type node) const RYML_NOEXCEPT
 Forward to Tree::has_sibling().
bool has_sibling (csubstr name) const RYML_NOEXCEPT
 Forward to Tree::has_sibling().
bool has_other_siblings () const RYML_NOEXCEPT
 Forward to Tree::has_other_siblings().
bool has_siblings () const RYML_NOEXCEPT
hierarchy getters
auto doc (id_type i) RYML_NOEXCEPT -> NodeRef
 Forward to Tree::doc().
ConstNodeRef doc (id_type i) const RYML_NOEXCEPT
 Forward to Tree::doc().
auto parent () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::parent().
ConstNodeRef parent () const RYML_NOEXCEPT
 Forward to Tree::parent().
auto first_child () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::first_child().
ConstNodeRef first_child () const RYML_NOEXCEPT
 Forward to Tree::first_child().
auto last_child () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::last_child().
ConstNodeRef last_child () const RYML_NOEXCEPT
 Forward to Tree::last_child().
auto child (id_type pos) RYML_NOEXCEPT -> NodeRef
 Forward to Tree::child().
ConstNodeRef child (id_type pos) const RYML_NOEXCEPT
 Forward to Tree::child().
auto find_child (csubstr name) RYML_NOEXCEPT -> NodeRef
 Forward to Tree::find_child().
ConstNodeRef find_child (csubstr name) const RYML_NOEXCEPT
 Forward to Tree::find_child().
auto prev_sibling () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::prev_sibling().
ConstNodeRef prev_sibling () const RYML_NOEXCEPT
 Forward to Tree::prev_sibling().
auto next_sibling () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::next_sibling().
ConstNodeRef next_sibling () const RYML_NOEXCEPT
 Forward to Tree::next_sibling().
auto first_sibling () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::first_sibling().
ConstNodeRef first_sibling () const RYML_NOEXCEPT
 Forward to Tree::first_sibling().
auto last_sibling () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::last_sibling().
ConstNodeRef last_sibling () const RYML_NOEXCEPT
 Forward to Tree::last_sibling().
auto sibling (id_type pos) RYML_NOEXCEPT -> NodeRef
 Forward to Tree::sibling().
ConstNodeRef sibling (id_type pos) const RYML_NOEXCEPT
 Forward to Tree::sibling().
auto find_sibling (csubstr name) RYML_NOEXCEPT -> NodeRef
 Forward to Tree::find_sibling().
ConstNodeRef find_sibling (csubstr name) const RYML_NOEXCEPT
 Forward to Tree::find_sibling().
auto ancestor_doc () RYML_NOEXCEPT -> NodeRef
 Forward to Tree::ancestor_doc().
ConstNodeRef ancestor_doc () const RYML_NOEXCEPT
 Forward to Tree::ancestor_doc().
id_type num_children () const RYML_NOEXCEPT
 O(num_children).
id_type num_siblings () const RYML_NOEXCEPT
 O(num_children).
id_type num_other_siblings () const RYML_NOEXCEPT
 O(num_siblings).
id_type child_pos (ConstNodeRef const &n) const RYML_NOEXCEPT
 O(num_children).
id_type sibling_pos (ConstNodeRef const &n) const RYML_NOEXCEPT
 O(num_siblings).
id_type depth_asc () const RYML_NOEXCEPT
id_type depth_desc () const RYML_NOEXCEPT
 O(log(num_nodes)).
square_brackets

O(num_nodes).

Forward to Tree::depth_desc(). Node must be readable.

operator[]

auto operator[] (csubstr key) RYML_NOEXCEPT -> NodeRef
 Find child by key; complexity is O(num_children).
auto operator[] (id_type pos) RYML_NOEXCEPT -> NodeRef
 Find child by position; complexity is O(pos).
ConstNodeRef operator[] (csubstr key) const RYML_NOEXCEPT
 Find a child by key; complexity is O(num_children).
ConstNodeRef operator[] (id_type pos) const RYML_NOEXCEPT
 Find a child by position; complexity is O(pos).
at

These functions are the analogue to operator[], with the difference that they emit an error instead of an assertion.

That is, if any of the pre or post conditions is violated, an error is always emitted (resulting in a call to the error callback).

auto at (csubstr key) -> NodeRef
 Find child by key; complexity is O(num_children).
auto at (id_type pos) -> NodeRef
 Find child by position; complexity is O(pos).
ConstNodeRef at (csubstr key) const
 Get a child by name, with error checking; complexity is O(num_children).
ConstNodeRef at (id_type pos) const
 Get a child by position, with error checking; complexity is O(pos).
locations
Location location (Parser const &parser) const
deserialization
ConstNodeRef const & operator>> (T &v) const
 deserialize the node's val to the given variable, forwarding to the user-overrideable read() function.
ConstNodeRef const & operator>> (T const &wrapper) const
ConstNodeRef const & operator>> (Key< T > v) const
 deserialize the node's key to the given variable, forwarding to the user-overrideable read() function; use key() to disambiguate; for example: node >> ryml::key(var)
bool get_if (csubstr name, T *var) const
 look for a child by name, if it exists assign to var.
bool get_if (csubstr name, T *var, T const &fallback) const
 look for a child by name, if it exists assign to var, otherwise default to fallback.

Friends

struct detail::RoNodeMethods< NodeRef, ConstNodeRef >

iteration

using iterator
using const_iterator
using children_view
using const_children_view
auto begin () RYML_NOEXCEPT -> iterator
 get a mutable iterator to the first child.
const_iterator begin () const RYML_NOEXCEPT
 get an iterator to the first child
const_iterator cbegin () const RYML_NOEXCEPT
 get an iterator to the first child
auto end () RYML_NOEXCEPT -> iterator
 get an iterator to after the last child.
const_iterator end () const RYML_NOEXCEPT
 get an iterator to after the last child
const_iterator cend () const RYML_NOEXCEPT
 get an iterator to after the last child
auto children () RYML_NOEXCEPT -> children_view
 get an iterable view over children.
const_children_view children () const RYML_NOEXCEPT
 get an iterable view over children
const_children_view cchildren () const RYML_NOEXCEPT
 get an iterable view over children
auto siblings () RYML_NOEXCEPT -> children_view
 get an iterable view over all siblings (including the calling node)
const_children_view siblings () const RYML_NOEXCEPT
 get an iterable view over all siblings (including the calling node)
const_children_view csiblings () const RYML_NOEXCEPT
 get an iterable view over all siblings (including the calling node)
bool visit (Visitor fn, id_type indentation_level=0, bool skip_root=true) const RYML_NOEXCEPT
 visit every child node calling fn(node)
auto visit (Visitor fn, id_type indentation_level=0, bool skip_root=true) RYML_NOEXCEPT -> bool
 visit every child node calling fn(node)
bool visit_stacked (Visitor fn, id_type indentation_level=0, bool skip_root=true) const RYML_NOEXCEPT
 visit every child node calling fn(node, level)
auto visit_stacked (Visitor fn, id_type indentation_level=0, bool skip_root=true) RYML_NOEXCEPT -> bool
 visit every child node calling fn(node, level)

Detailed Description

A reference to a node in an existing yaml tree, offering a more convenient API than the index-based API used in the tree.

Unlike its imutable ConstNodeRef peer, a NodeRef can be used to mutate the tree, both by writing to existing nodes and by creating new nodes to subsequently write to. Semantically, a NodeRef object can be in one of three states:

invalid := not pointing at anything
readable := points at an existing tree/node
seed := points at an existing tree, and the node
may come to exist, if we write to it.

So both readable and seed are states where the node is also valid.

Tree t = parse_in_arena("{a: b}");
NodeRef invalid; // not pointing at anything.
NodeRef readable = t["a"]; // also valid, because "a" exists
NodeRef seed = t["none"]; // also valid, but is seed because "none" is not in the map
c4::yml::NodeRef::NodeRef
NodeRef() noexcept
Definition node.hpp:1007
c4::yml::NodeRef::invalid
bool invalid() const noexcept
true if the object is not referring to any existing or seed node.
Definition node.hpp:1038
c4::yml::NodeRef::readable
bool readable() const noexcept
true if the object is not invalid and not in seed state.
Definition node.hpp:1042
c4::yml::parse_in_arena
void parse_in_arena(Parser *parser, csubstr filename, csubstr yaml, Tree *t, id_type node_id)
(1) parse YAML into an existing tree node. The filename will be used in any error messages arising du...
Definition parse.cpp:92

When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree, provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef.

It is the owners's responsibility to verify that an existing node is readable before subsequently using it to read from the tree.

Warning
The lifetime of the tree must be larger than that of this object. It is up to the user to ensure that this happens.

Definition at line 966 of file node.hpp.

Member Typedef Documentation

◆ tree_type

using c4::yml::NodeRef::tree_type = Tree

Definition at line 970 of file node.hpp.

◆ base_type

using c4::yml::NodeRef::base_type = detail::RoNodeMethods<NodeRef, ConstNodeRef>

Definition at line 971 of file node.hpp.

◆ iterator

using c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::iterator
inherited

Definition at line 720 of file node.hpp.

◆ const_iterator

using c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::const_iterator
inherited

Definition at line 721 of file node.hpp.

◆ children_view

using c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::children_view
inherited

Definition at line 722 of file node.hpp.

◆ const_children_view

using c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::const_children_view
inherited

Definition at line 723 of file node.hpp.

Constructor & Destructor Documentation

◆ NodeRef() [1/9]

c4::yml::NodeRef::NodeRef ( )
inlinenoexcept

Definition at line 1007 of file node.hpp.

1007: m_tree(nullptr), m_id(NONE), m_seed() { _clear_seed(); }
c4::yml::NodeRef::_clear_seed
void _clear_seed() noexcept
Definition node.hpp:1015
c4::yml::NONE
@ NONE
an index to none
Definition common.hpp:256

◆ NodeRef() [2/9]

c4::yml::NodeRef::NodeRef ( Tree & t)
inlinenoexcept

Definition at line 1008 of file node.hpp.

1008: m_tree(&t), m_id(t .root_id()), m_seed() { _clear_seed(); }

◆ NodeRef() [3/9]

c4::yml::NodeRef::NodeRef ( Tree * t)
inlinenoexcept

Definition at line 1009 of file node.hpp.

1009: m_tree(t ), m_id(t->root_id()), m_seed() { _clear_seed(); }

◆ NodeRef() [4/9]

c4::yml::NodeRef::NodeRef ( Tree * t,
id_type id )
inlinenoexcept

Definition at line 1010 of file node.hpp.

1010: m_tree(t), m_id(id), m_seed() { _clear_seed(); }

◆ NodeRef() [5/9]

c4::yml::NodeRef::NodeRef ( Tree * t,
id_type id,
id_type seed_pos )
inlinenoexcept

Definition at line 1011 of file node.hpp.

1011: m_tree(t), m_id(id), m_seed() { m_seed.str = nullptr; m_seed.len = (size_t)seed_pos; }

◆ NodeRef() [6/9]

c4::yml::NodeRef::NodeRef ( Tree * t,
id_type id,
csubstr seed_key )
inlinenoexcept

Definition at line 1012 of file node.hpp.

1012: m_tree(t), m_id(id), m_seed(seed_key) {}

◆ NodeRef() [7/9]

c4::yml::NodeRef::NodeRef ( std::nullptr_t )
inlinenoexcept

Definition at line 1013 of file node.hpp.

1013: m_tree(nullptr), m_id(NONE), m_seed() {}

◆ NodeRef() [8/9]

c4::yml::NodeRef::NodeRef ( NodeRef const & )
defaultnoexcept

◆ NodeRef() [9/9]

c4::yml::NodeRef::NodeRef ( NodeRef && )
defaultnoexcept

Member Function Documentation

◆ _clear_seed()

void c4::yml::NodeRef::_clear_seed ( )
inlinenoexcept

Definition at line 1015 of file node.hpp.

1015{ /*do the following manually or an assert is triggered: */ m_seed.str = nullptr; m_seed.len = npos; }
c4::yml::npos
@ npos
a null string position
Definition common.hpp:263

◆ operator=() [1/8]

NodeRef & c4::yml::NodeRef::operator= ( NodeRef const & )
defaultnoexcept

◆ operator=() [2/8]

NodeRef & c4::yml::NodeRef::operator= ( NodeRef && )
defaultnoexcept

◆ invalid()

bool c4::yml::NodeRef::invalid ( ) const
inlinenoexcept

true if the object is not referring to any existing or seed node.

See also
the doc for NodeRef

Definition at line 1038 of file node.hpp.

1038{ return m_tree == nullptr || m_id == NONE; }

◆ is_seed()

bool c4::yml::NodeRef::is_seed ( ) const
inlinenoexcept

true if the object is not invalid and in seed state.

See also
the doc for NodeRef

Definition at line 1040 of file node.hpp.

1040{ return (m_tree != nullptr && m_id != NONE) && (m_seed.str != nullptr || m_seed.len != (size_t)NONE); }

◆ readable()

bool c4::yml::NodeRef::readable ( ) const
inlinenoexcept

true if the object is not invalid and not in seed state.

See also
the doc for NodeRef

Definition at line 1042 of file node.hpp.

1042{ return (m_tree != nullptr && m_id != NONE) && (m_seed.str == nullptr && m_seed.len == (size_t)NONE); }

◆ valid()

bool c4::yml::NodeRef::valid ( ) const
inline

Definition at line 1044 of file node.hpp.

1044{ return m_tree != nullptr && m_id != NONE; }

◆ operator==() [1/2]

bool c4::yml::NodeRef::operator== ( NodeRef const & that) const
inline

Definition at line 1053 of file node.hpp.

1054 {
1055 if(m_tree == that.m_tree && m_id == that.m_id)
1056 {
1057 bool seed = is_seed();
1058 if(seed == that.is_seed())
1059 {
1060 if(seed)
1061 {
1062 return (m_seed.len == that.m_seed.len)
1063 && (m_seed.str == that.m_seed.str
1064 || m_seed == that.m_seed); // do strcmp only in the last resort
1065 }
1066 return true;
1067 }
1068 }
1069 return false;
1070 }
c4::yml::NodeRef::is_seed
bool is_seed() const noexcept
true if the object is not invalid and in seed state.
Definition node.hpp:1040

◆ operator!=() [1/2]

bool c4::yml::NodeRef::operator!= ( NodeRef const & that) const
inline

Definition at line 1071 of file node.hpp.

1071{ return ! this->operator==(that); }
c4::yml::NodeRef::operator==
bool operator==(NodeRef const &that) const
Definition node.hpp:1053

◆ operator==() [2/2]

bool c4::yml::NodeRef::operator== ( ConstNodeRef const & that) const
inline

Definition at line 1073 of file node.hpp.

1073{ return m_tree == that.m_tree && m_id == that.m_id && !is_seed(); }

◆ operator!=() [2/2]

bool c4::yml::NodeRef::operator!= ( ConstNodeRef const & that) const
inline

Definition at line 1074 of file node.hpp.

1074{ return ! this->operator==(that); }

◆ tree() [1/2]

Tree * c4::yml::NodeRef::tree ( )
inlinenoexcept

Definition at line 1089 of file node.hpp.

1089{ return m_tree; }

◆ tree() [2/2]

Tree const * c4::yml::NodeRef::tree ( ) const
inlinenoexcept

Definition at line 1090 of file node.hpp.

1090{ return m_tree; }

◆ id()

id_type c4::yml::NodeRef::id ( ) const
inlinenoexcept

Definition at line 1092 of file node.hpp.

1092{ return m_id; }

◆ create()

void c4::yml::NodeRef::create ( )
inline

Definition at line 1101 of file node.hpp.

1101{ _apply_seed(); }

◆ change_type()

void c4::yml::NodeRef::change_type ( NodeType t)
inline

Definition at line 1103 of file node.hpp.

1103{ _C4RR(); m_tree->change_type(m_id, t); }
_C4RR
#define _C4RR()
Definition node.hpp:994

◆ set_type()

void c4::yml::NodeRef::set_type ( NodeType t)
inline

Definition at line 1105 of file node.hpp.

1105{ _apply_seed(); m_tree->_set_flags(m_id, t); }

◆ set_key()

void c4::yml::NodeRef::set_key ( csubstr key)
inline

Definition at line 1106 of file node.hpp.

1106{ _apply_seed(); m_tree->_set_key(m_id, key); }

◆ set_val()

void c4::yml::NodeRef::set_val ( csubstr val)
inline

Definition at line 1107 of file node.hpp.

1107{ _apply_seed(); m_tree->_set_val(m_id, val); }

◆ set_key_tag()

void c4::yml::NodeRef::set_key_tag ( csubstr key_tag)
inline

Definition at line 1108 of file node.hpp.

1108{ _apply_seed(); m_tree->set_key_tag(m_id, key_tag); }

◆ set_val_tag()

void c4::yml::NodeRef::set_val_tag ( csubstr val_tag)
inline

Definition at line 1109 of file node.hpp.

1109{ _apply_seed(); m_tree->set_val_tag(m_id, val_tag); }

◆ set_key_anchor()

void c4::yml::NodeRef::set_key_anchor ( csubstr key_anchor)
inline

Definition at line 1110 of file node.hpp.

1110{ _apply_seed(); m_tree->set_key_anchor(m_id, key_anchor); }

◆ set_val_anchor()

void c4::yml::NodeRef::set_val_anchor ( csubstr val_anchor)
inline

Definition at line 1111 of file node.hpp.

1111{ _apply_seed(); m_tree->set_val_anchor(m_id, val_anchor); }

◆ set_key_ref()

void c4::yml::NodeRef::set_key_ref ( csubstr key_ref)
inline

Definition at line 1112 of file node.hpp.

1112{ _apply_seed(); m_tree->set_key_ref(m_id, key_ref); }

◆ set_val_ref()

void c4::yml::NodeRef::set_val_ref ( csubstr val_ref)
inline

Definition at line 1113 of file node.hpp.

1113{ _apply_seed(); m_tree->set_val_ref(m_id, val_ref); }

◆ set_container_style()

void c4::yml::NodeRef::set_container_style ( NodeType_e style)
inline

Definition at line 1115 of file node.hpp.

1115{ _C4RR(); m_tree->set_container_style(m_id, style); }

◆ set_key_style()

void c4::yml::NodeRef::set_key_style ( NodeType_e style)
inline

Definition at line 1116 of file node.hpp.

1116{ _C4RR(); m_tree->set_key_style(m_id, style); }

◆ set_val_style()

void c4::yml::NodeRef::set_val_style ( NodeType_e style)
inline

Definition at line 1117 of file node.hpp.

1117{ _C4RR(); m_tree->set_val_style(m_id, style); }

◆ clear_style()

void c4::yml::NodeRef::clear_style ( bool recurse = false)
inline

Definition at line 1118 of file node.hpp.

1118{ _C4RR(); m_tree->clear_style(m_id, recurse); }

◆ set_style_conditionally()

void c4::yml::NodeRef::set_style_conditionally ( NodeType type_mask,
NodeType rem_style_flags,
NodeType add_style_flags,
bool recurse = false )
inline

Definition at line 1119 of file node.hpp.

1123 {
1124 _C4RR(); m_tree->set_style_conditionally(m_id, type_mask, rem_style_flags, add_style_flags, recurse);
1125 }

◆ clear()

void c4::yml::NodeRef::clear ( )
inline

Definition at line 1129 of file node.hpp.

1130 {
1131 if(is_seed())
1132 return;
1133 m_tree->remove_children(m_id);
1134 m_tree->_clear(m_id);
1135 }

◆ clear_key()

void c4::yml::NodeRef::clear_key ( )
inline

Definition at line 1137 of file node.hpp.

1138 {
1139 if(is_seed())
1140 return;
1141 m_tree->_clear_key(m_id);
1142 }

◆ clear_val()

void c4::yml::NodeRef::clear_val ( )
inline

Definition at line 1144 of file node.hpp.

1145 {
1146 if(is_seed())
1147 return;
1148 m_tree->_clear_val(m_id);
1149 }

◆ clear_children()

void c4::yml::NodeRef::clear_children ( )
inline

Definition at line 1151 of file node.hpp.

1152 {
1153 if(is_seed())
1154 return;
1155 m_tree->remove_children(m_id);
1156 }

◆ operator=() [3/8]

void c4::yml::NodeRef::operator= ( NodeType_e t)
inline

Definition at line 1158 of file node.hpp.

1159 {
1160 _apply_seed();
1161 m_tree->_add_flags(m_id, t);
1162 }

◆ operator|=()

void c4::yml::NodeRef::operator|= ( NodeType_e t)
inline

Definition at line 1164 of file node.hpp.

1165 {
1166 _apply_seed();
1167 m_tree->_add_flags(m_id, t);
1168 }

◆ operator=() [4/8]

void c4::yml::NodeRef::operator= ( NodeInit const & v)
inline

Definition at line 1170 of file node.hpp.

1171 {
1172 _apply_seed();
1173 _apply(v);
1174 }

◆ operator=() [5/8]

void c4::yml::NodeRef::operator= ( NodeScalar const & v)
inline

Definition at line 1176 of file node.hpp.

1177 {
1178 _apply_seed();
1179 _apply(v);
1180 }

◆ operator=() [6/8]

void c4::yml::NodeRef::operator= ( std::nullptr_t )
inline

Definition at line 1182 of file node.hpp.

1183 {
1184 _apply_seed();
1185 _apply(csubstr{});
1186 }
c4::csubstr
basic_substring< const char > csubstr
an immutable string view
Definition substr.hpp:2357

◆ operator=() [7/8]

void c4::yml::NodeRef::operator= ( csubstr v)
inline

Definition at line 1188 of file node.hpp.

1189 {
1190 _apply_seed();
1191 _apply(v);
1192 }

◆ operator=() [8/8]

template<size_t N>
void c4::yml::NodeRef::operator= ( const char(&) v[N])
inline

Definition at line 1195 of file node.hpp.

1196 {
1197 _apply_seed();
1198 csubstr sv;
1199 sv.assign<N>(v);
1200 _apply(sv);
1201 }
c4::basic_substring::assign
void assign(C(&s_)[N]) noexcept
Assign from an array.
Definition substr.hpp:300

◆ to_arena()

template<class T>
csubstr c4::yml::NodeRef::to_arena ( T const & s)
inline

serialize a variable to the arena

Definition at line 1212 of file node.hpp.

1213 {
1214 _RYML_ASSERT_BASIC(m_tree); // no need for valid or readable
1215 return m_tree->to_arena(s);
1216 }

◆ set_key_serialized() [1/2]

template<class T>
size_t c4::yml::NodeRef::set_key_serialized ( T const & k)
inline

Definition at line 1219 of file node.hpp.

1220 {
1221 _apply_seed();
1222 csubstr s = m_tree->to_arena(k);
1223 m_tree->_set_key(m_id, s);
1224 return s.len;
1225 }
c4::basic_substring::len
size_t len
the length of the substring
Definition substr.hpp:218

◆ set_key_serialized() [2/2]

size_t c4::yml::NodeRef::set_key_serialized ( std::nullptr_t )
inline

Definition at line 1226 of file node.hpp.

1227 {
1228 _apply_seed();
1229 m_tree->_set_key(m_id, csubstr{});
1230 return 0;
1231 }

◆ set_val_serialized() [1/2]

template<class T>
size_t c4::yml::NodeRef::set_val_serialized ( T const & v)
inline

Definition at line 1234 of file node.hpp.

1235 {
1236 _apply_seed();
1237 csubstr s = m_tree->to_arena(v);
1238 m_tree->_set_val(m_id, s);
1239 return s.len;
1240 }

◆ set_val_serialized() [2/2]

size_t c4::yml::NodeRef::set_val_serialized ( std::nullptr_t )
inline

Definition at line 1241 of file node.hpp.

1242 {
1243 _apply_seed();
1244 m_tree->_set_val(m_id, csubstr{});
1245 return 0;
1246 }

◆ operator<<() [1/4]

NodeRef & c4::yml::NodeRef::operator<< ( csubstr s)
inline

serialize a variable, then assign the result to the node's val

Definition at line 1249 of file node.hpp.

1250 {
1251 // this overload is needed to prevent ambiguity (there's also
1252 // operator<< for writing a substr to a stream)
1253 _apply_seed();
1254 write(this, s);
1255 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, val() == s, m_tree, m_id);
1256 return *this;
1257 }
c4::yml::write
void write(NodeRef *n, T const &v)
Definition node.hpp:1583

◆ operator<<() [2/4]

template<class T>
NodeRef & c4::yml::NodeRef::operator<< ( T const & v)
inline

Definition at line 1260 of file node.hpp.

1261 {
1262 _apply_seed();
1263 write(this, v);
1264 return *this;
1265 }

◆ operator<<() [3/4]

template<class T>
NodeRef & c4::yml::NodeRef::operator<< ( Key< const T > const & v)
inline

serialize a variable, then assign the result to the node's key

Definition at line 1269 of file node.hpp.

1270 {
1271 _apply_seed();
1272 set_key_serialized(v.k);
1273 return *this;
1274 }
c4::yml::NodeRef::set_key_serialized
size_t set_key_serialized(T const &k)
Definition node.hpp:1219

◆ operator<<() [4/4]

template<class T>
NodeRef & c4::yml::NodeRef::operator<< ( Key< T > const & v)
inline

serialize a variable, then assign the result to the node's key

Definition at line 1278 of file node.hpp.

1279 {
1280 _apply_seed();
1281 set_key_serialized(v.k);
1282 return *this;
1283 }

◆ insert_child() [1/2]

NodeRef c4::yml::NodeRef::insert_child ( NodeRef after)
inline

Definition at line 1332 of file node.hpp.

1333 {
1334 _C4RR();
1335 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, after.m_tree == m_tree, m_tree, m_id);
1336 NodeRef r(m_tree, m_tree->insert_child(m_id, after.m_id));
1337 return r;
1338 }

◆ insert_child() [2/2]

NodeRef c4::yml::NodeRef::insert_child ( NodeInit const & i,
NodeRef after )
inline

Definition at line 1340 of file node.hpp.

1341 {
1342 _C4RR();
1343 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, after.m_tree == m_tree, m_tree, m_id);
1344 NodeRef r(m_tree, m_tree->insert_child(m_id, after.m_id));
1345 r._apply(i);
1346 return r;
1347 }

◆ prepend_child() [1/2]

NodeRef c4::yml::NodeRef::prepend_child ( )
inline

Definition at line 1349 of file node.hpp.

1350 {
1351 _C4RR();
1352 NodeRef r(m_tree, m_tree->insert_child(m_id, NONE));
1353 return r;
1354 }

◆ prepend_child() [2/2]

NodeRef c4::yml::NodeRef::prepend_child ( NodeInit const & i)
inline

Definition at line 1356 of file node.hpp.

1357 {
1358 _C4RR();
1359 NodeRef r(m_tree, m_tree->insert_child(m_id, NONE));
1360 r._apply(i);
1361 return r;
1362 }

◆ append_child() [1/2]

NodeRef c4::yml::NodeRef::append_child ( )
inline

Definition at line 1364 of file node.hpp.

1365 {
1366 _C4RR();
1367 NodeRef r(m_tree, m_tree->append_child(m_id));
1368 return r;
1369 }

◆ append_child() [2/2]

NodeRef c4::yml::NodeRef::append_child ( NodeInit const & i)
inline

Definition at line 1371 of file node.hpp.

1372 {
1373 _C4RR();
1374 NodeRef r(m_tree, m_tree->append_child(m_id));
1375 r._apply(i);
1376 return r;
1377 }

◆ insert_sibling() [1/2]

NodeRef c4::yml::NodeRef::insert_sibling ( ConstNodeRef const & after)
inline

Definition at line 1379 of file node.hpp.

1380 {
1381 _C4RR();
1382 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, after.m_tree == m_tree, m_tree, m_id);
1383 NodeRef r(m_tree, m_tree->insert_sibling(m_id, after.m_id));
1384 return r;
1385 }

◆ insert_sibling() [2/2]

NodeRef c4::yml::NodeRef::insert_sibling ( NodeInit const & i,
ConstNodeRef const & after )
inline

Definition at line 1387 of file node.hpp.

1388 {
1389 _C4RR();
1390 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, after.m_tree == m_tree, m_tree, m_id);
1391 NodeRef r(m_tree, m_tree->insert_sibling(m_id, after.m_id));
1392 r._apply(i);
1393 return r;
1394 }

◆ prepend_sibling() [1/2]

NodeRef c4::yml::NodeRef::prepend_sibling ( )
inline

Definition at line 1396 of file node.hpp.

1397 {
1398 _C4RR();
1399 NodeRef r(m_tree, m_tree->prepend_sibling(m_id));
1400 return r;
1401 }

◆ prepend_sibling() [2/2]

NodeRef c4::yml::NodeRef::prepend_sibling ( NodeInit const & i)
inline

Definition at line 1403 of file node.hpp.

1404 {
1405 _C4RR();
1406 NodeRef r(m_tree, m_tree->prepend_sibling(m_id));
1407 r._apply(i);
1408 return r;
1409 }

◆ append_sibling() [1/2]

NodeRef c4::yml::NodeRef::append_sibling ( )
inline

Definition at line 1411 of file node.hpp.

1412 {
1413 _C4RR();
1414 NodeRef r(m_tree, m_tree->append_sibling(m_id));
1415 return r;
1416 }

◆ append_sibling() [2/2]

NodeRef c4::yml::NodeRef::append_sibling ( NodeInit const & i)
inline

Definition at line 1418 of file node.hpp.

1419 {
1420 _C4RR();
1421 NodeRef r(m_tree, m_tree->append_sibling(m_id));
1422 r._apply(i);
1423 return r;
1424 }

◆ remove_child() [1/3]

void c4::yml::NodeRef::remove_child ( NodeRef & child)
inline

Definition at line 1428 of file node.hpp.

1429 {
1430 _C4RR();
1431 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, has_child(child), m_tree, m_id);
1432 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, child.parent().id() == id(), m_tree, m_id);
1433 m_tree->remove(child.id());
1434 child.clear();
1435 }
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_child
bool has_child(ConstNodeRef const &n) const RYML_NOEXCEPT
Definition node.hpp:313
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::child
auto child(id_type pos) RYML_NOEXCEPT -> NodeRef
Definition node.hpp:351

◆ remove_child() [2/3]

void c4::yml::NodeRef::remove_child ( id_type pos)
inline

remove the nth child of this node

Definition at line 1438 of file node.hpp.

1439 {
1440 _C4RR();
1441 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, pos >= 0 && pos < num_children(), m_tree, m_id);
1442 id_type child = m_tree->child(m_id, pos);
1443 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, child != NONE, m_tree, m_id);
1444 m_tree->remove(child);
1445 }
c4::yml::id_type
RYML_ID_TYPE id_type
The type of a node id in the YAML tree; to override the default type, define the macro RYML_ID_TYPE t...
Definition common.hpp:249

◆ remove_child() [3/3]

void c4::yml::NodeRef::remove_child ( csubstr key)
inline

remove a child by name

Definition at line 1448 of file node.hpp.

1449 {
1450 _C4RR();
1451 id_type child = m_tree->find_child(m_id, key);
1452 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, child != NONE, m_tree, m_id);
1453 m_tree->remove(child);
1454 }

◆ move() [1/2]

void c4::yml::NodeRef::move ( ConstNodeRef const & after)
inline

change the node's position within its parent, placing it after after.

To move to the first position in the parent, simply pass an empty or default-constructed reference like this: n.move({}).

Definition at line 1462 of file node.hpp.

1463 {
1464 _C4RR();
1465 m_tree->move(m_id, after.m_id);
1466 }

◆ move() [2/2]

void c4::yml::NodeRef::move ( NodeRef const & parent,
ConstNodeRef const & after )
inline

move the node to a different parent (which may belong to a different tree), placing it after after.

When the destination parent is in a new tree, then this node's tree pointer is reset to the tree of the parent node.

Definition at line 1472 of file node.hpp.

1473 {
1474 _C4RR();
1475 if(parent.m_tree == m_tree)
1476 {
1477 m_tree->move(m_id, parent.m_id, after.m_id);
1478 }
1479 else
1480 {
1481 parent.m_tree->move(m_tree, m_id, parent.m_id, after.m_id);
1482 m_tree = parent.m_tree;
1483 }
1484 }

◆ duplicate() [1/2]

NodeRef c4::yml::NodeRef::duplicate ( ConstNodeRef const & after) const
inline

duplicate the current node somewhere within its parent, and place it after the node after.

To place into the first position of the parent, simply pass an empty or default-constructed reference like this: n.move({}).

Definition at line 1490 of file node.hpp.

1491 {
1492 _C4RR();
1493 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, m_tree == after.m_tree || after.m_id == NONE, m_tree, m_id);
1494 id_type dup = m_tree->duplicate(m_id, m_tree->parent(m_id), after.m_id);
1495 NodeRef r(m_tree, dup);
1496 return r;
1497 }

◆ duplicate() [2/2]

NodeRef c4::yml::NodeRef::duplicate ( NodeRef const & parent,
ConstNodeRef const & after ) const
inline

duplicate the current node somewhere into a different parent (possibly from a different tree), and place it after the node after.

To place into the first position of the parent, simply pass an empty or default-constructed reference like this: n.move({}).

Definition at line 1504 of file node.hpp.

1505 {
1506 _C4RR();
1507 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, parent.m_tree == after.m_tree || after.m_id == NONE, m_tree, m_id);
1508 if(parent.m_tree == m_tree)
1509 {
1510 id_type dup = m_tree->duplicate(m_id, parent.m_id, after.m_id);
1511 NodeRef r(m_tree, dup);
1512 return r;
1513 }
1514 else
1515 {
1516 id_type dup = parent.m_tree->duplicate(m_tree, m_id, parent.m_id, after.m_id);
1517 NodeRef r(parent.m_tree, dup);
1518 return r;
1519 }
1520 }

◆ duplicate_children()

void c4::yml::NodeRef::duplicate_children ( NodeRef const & parent,
ConstNodeRef const & after ) const
inline

Definition at line 1522 of file node.hpp.

1523 {
1524 _C4RR();
1525 _RYML_ASSERT_VISIT_(m_tree->m_callbacks, parent.m_tree == after.m_tree, m_tree, m_id);
1526 if(parent.m_tree == m_tree)
1527 {
1528 m_tree->duplicate_children(m_id, parent.m_id, after.m_id);
1529 }
1530 else
1531 {
1532 parent.m_tree->duplicate_children(m_tree, m_id, parent.m_id, after.m_id);
1533 }
1534 }

◆ get() [1/2]

NodeData const * c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::get ( ) const
inlineinherited

returns the data or null when the id is NONE

Definition at line 201 of file node.hpp.

201{ return ((Impl const*)this)->readable() ? tree_->get(id_) : nullptr; }
c4::yml::detail::RoNodeMethods::get
NodeData const * get() const RYML_NOEXCEPT
returns the data or null when the id is NONE
Definition node.hpp:201

◆ get() [2/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::get ( ) ->NodeData *
inlineinherited

returns the data or null when the id is NONE

Definition at line 205 of file node.hpp.

205{ return ((Impl const*)this)->readable() ? tree__->get(id__) : nullptr; }

◆ type()

NodeType c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::type ( ) const
inlineinherited

Forward to Tree::type().

Node must be readable.

Definition at line 207 of file node.hpp.

◆ type_str()

const char * c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::type_str ( ) const
inlineinherited

Forward to Tree::type_str().

Node must be readable.

Definition at line 208 of file node.hpp.

◆ key()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::key ( ) const
inlineinherited

Forward to Tree::key().

Node must be readable.

Definition at line 210 of file node.hpp.

◆ key_tag()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::key_tag ( ) const
inlineinherited

Forward to Tree::key_tag().

Node must be readable.

Definition at line 211 of file node.hpp.

◆ key_ref()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::key_ref ( ) const
inlineinherited

Forward to Tree::key_ref().

Node must be readable.

Definition at line 212 of file node.hpp.

◆ key_anchor()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::key_anchor ( ) const
inlineinherited

Forward to Tree::key_anchor().

Node must be readable.

Definition at line 213 of file node.hpp.

◆ val()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::val ( ) const
inlineinherited

Forward to Tree::val().

Node must be readable.

Definition at line 215 of file node.hpp.

◆ val_tag()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::val_tag ( ) const
inlineinherited

Forward to Tree::val_tag().

Node must be readable.

Definition at line 216 of file node.hpp.

◆ val_ref()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::val_ref ( ) const
inlineinherited

Forward to Tree::val_ref().

Node must be readable.

Definition at line 217 of file node.hpp.

◆ val_anchor()

csubstr c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::val_anchor ( ) const
inlineinherited

Forward to Tree::val_anchor().

Node must be readable.

Definition at line 218 of file node.hpp.

◆ keysc()

NodeScalar const & c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::keysc ( ) const
inlineinherited

Forward to Tree::keysc().

Node must be readable.

Definition at line 220 of file node.hpp.

◆ valsc()

NodeScalar const & c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::valsc ( ) const
inlineinherited

Forward to Tree::valsc().

Node must be readable.

Definition at line 221 of file node.hpp.

◆ key_is_null()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::key_is_null ( ) const
inlineinherited

Forward to Tree::key_is_null().

Node must be readable.

Definition at line 223 of file node.hpp.

◆ val_is_null()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::val_is_null ( ) const
inlineinherited

Forward to Tree::val_is_null().

Node must be readable.

Definition at line 224 of file node.hpp.

◆ is_key_unfiltered()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_unfiltered ( ) const
inlinenoexceptinherited

Forward to Tree::is_key_unfiltered().

Node must be readable.

Definition at line 226 of file node.hpp.

◆ is_val_unfiltered()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_unfiltered ( ) const
inlinenoexceptinherited

Forward to Tree::is_val_unfiltered().

Node must be readable.

Definition at line 227 of file node.hpp.

◆ empty()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::empty ( ) const
inlineinherited

Forward to Tree::empty().

Node must be readable.

Definition at line 236 of file node.hpp.

◆ is_stream()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_stream ( ) const
inlineinherited

Forward to Tree::is_stream().

Node must be readable.

Definition at line 237 of file node.hpp.

◆ is_doc()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_doc ( ) const
inlineinherited

Forward to Tree::is_doc().

Node must be readable.

Definition at line 238 of file node.hpp.

◆ is_container()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_container ( ) const
inlineinherited

Forward to Tree::is_container().

Node must be readable.

Definition at line 239 of file node.hpp.

◆ is_map()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_map ( ) const
inlineinherited

Forward to Tree::is_map().

Node must be readable.

Definition at line 240 of file node.hpp.

◆ is_seq()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_seq ( ) const
inlineinherited

Forward to Tree::is_seq().

Node must be readable.

Definition at line 241 of file node.hpp.

◆ has_val()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_val ( ) const
inlineinherited

Forward to Tree::has_val().

Node must be readable.

Definition at line 242 of file node.hpp.

◆ has_key()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_key ( ) const
inlineinherited

Forward to Tree::has_key().

Node must be readable.

Definition at line 243 of file node.hpp.

◆ is_val()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val ( ) const
inlineinherited

Forward to Tree::is_val().

Node must be readable.

Definition at line 244 of file node.hpp.

◆ is_keyval()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_keyval ( ) const
inlineinherited

Forward to Tree::is_keyval().

Node must be readable.

Definition at line 245 of file node.hpp.

◆ has_key_tag()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_key_tag ( ) const
inlineinherited

Forward to Tree::has_key_tag().

Node must be readable.

Definition at line 246 of file node.hpp.

◆ has_val_tag()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_val_tag ( ) const
inlineinherited

Forward to Tree::has_val_tag().

Node must be readable.

Definition at line 247 of file node.hpp.

◆ has_key_anchor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_key_anchor ( ) const
inlineinherited

Forward to Tree::has_key_anchor().

Node must be readable.

Definition at line 248 of file node.hpp.

◆ has_val_anchor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_val_anchor ( ) const
inlineinherited

Forward to Tree::has_val_anchor().

Node must be readable.

Definition at line 249 of file node.hpp.

◆ has_anchor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_anchor ( ) const
inlineinherited

Forward to Tree::has_anchor().

Node must be readable.

Definition at line 250 of file node.hpp.

◆ is_key_ref()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_ref ( ) const
inlineinherited

Forward to Tree::is_key_ref().

Node must be readable.

Definition at line 251 of file node.hpp.

◆ is_val_ref()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_ref ( ) const
inlineinherited

Forward to Tree::is_val_ref().

Node must be readable.

Definition at line 252 of file node.hpp.

◆ is_ref()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_ref ( ) const
inlineinherited

Forward to Tree::is_ref().

Node must be readable.

Definition at line 253 of file node.hpp.

◆ parent_is_seq()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::parent_is_seq ( ) const
inlineinherited

Forward to Tree::parent_is_seq().

Node must be readable.

Definition at line 254 of file node.hpp.

◆ parent_is_map()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::parent_is_map ( ) const
inlineinherited

Forward to Tree::parent_is_map().

Node must be readable.

Definition at line 255 of file node.hpp.

◆ is_key_anchor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_anchor ( ) const
inlinenoexceptinherited

Definition at line 257 of file node.hpp.

257{ _C4RR(); return tree_->has_key_anchor(id_); }
c4::yml::detail::RoNodeMethods::has_key_anchor
bool has_key_anchor() const RYML_NOEXCEPT
Forward to Tree::has_key_anchor().
Definition node.hpp:248

◆ is_val_hanchor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_hanchor ( ) const
inlinenoexceptinherited

Definition at line 258 of file node.hpp.

258{ _C4RR(); return tree_->has_val_anchor(id_); }
c4::yml::detail::RoNodeMethods::has_val_anchor
bool has_val_anchor() const RYML_NOEXCEPT
Forward to Tree::has_val_anchor().
Definition node.hpp:249

◆ is_anchor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_anchor ( ) const
inlinenoexceptinherited

Definition at line 259 of file node.hpp.

259{ _C4RR(); return tree_->has_anchor(id_); }
c4::yml::detail::RoNodeMethods::has_anchor
bool has_anchor() const RYML_NOEXCEPT
Forward to Tree::has_anchor().
Definition node.hpp:250

◆ is_anchor_or_ref()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_anchor_or_ref ( ) const
inlinenoexceptinherited

Definition at line 260 of file node.hpp.

260{ _C4RR(); return tree_->is_anchor_or_ref(id_); }
c4::yml::detail::RoNodeMethods::is_anchor_or_ref
bool is_anchor_or_ref() const noexcept
Definition node.hpp:260

◆ type_has_any()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::type_has_any ( NodeType_e bits) const
inlineinherited

Forward to Tree::type_has_any().

Node must be readable.

Definition at line 271 of file node.hpp.

◆ type_has_all()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::type_has_all ( NodeType_e bits) const
inlineinherited

Forward to Tree::type_has_all().

Node must be readable.

Definition at line 272 of file node.hpp.

◆ type_has_none()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::type_has_none ( NodeType_e bits) const
inlineinherited

Forward to Tree::type_has_none().

Node must be readable.

Definition at line 273 of file node.hpp.

◆ key_style()

NodeType c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::key_style ( ) const
inlineinherited

Forward to Tree::key_style().

Node must be readable.

Definition at line 275 of file node.hpp.

◆ val_style()

NodeType c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::val_style ( ) const
inlineinherited

Forward to Tree::val_style().

Node must be readable.

Definition at line 276 of file node.hpp.

◆ is_container_styled()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_container_styled ( ) const
inlineinherited

Forward to Tree::is_container_styled().

Node must be readable.

Definition at line 278 of file node.hpp.

◆ is_block()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_block ( ) const
inlineinherited

Forward to Tree::is_block().

Node must be readable.

Definition at line 279 of file node.hpp.

◆ is_flow_sl()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_flow_sl ( ) const
inlineinherited

Forward to Tree::is_flow_sl().

Node must be readable.

Definition at line 280 of file node.hpp.

◆ is_flow_ml()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_flow_ml ( ) const
inlineinherited

Forward to Tree::is_flow_ml().

Node must be readable.

Definition at line 281 of file node.hpp.

◆ is_flow()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_flow ( ) const
inlineinherited

Forward to Tree::is_flow().

Node must be readable.

Definition at line 282 of file node.hpp.

◆ is_key_styled()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_styled ( ) const
inlineinherited

Forward to Tree::is_key_styled().

Node must be readable.

Definition at line 284 of file node.hpp.

◆ is_val_styled()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_styled ( ) const
inlineinherited

Forward to Tree::is_val_styled().

Node must be readable.

Definition at line 285 of file node.hpp.

◆ is_key_literal()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_literal ( ) const
inlineinherited

Forward to Tree::is_key_literal().

Node must be readable.

Definition at line 286 of file node.hpp.

◆ is_val_literal()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_literal ( ) const
inlineinherited

Forward to Tree::is_val_literal().

Node must be readable.

Definition at line 287 of file node.hpp.

◆ is_key_folded()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_folded ( ) const
inlineinherited

Forward to Tree::is_key_folded().

Node must be readable.

Definition at line 288 of file node.hpp.

◆ is_val_folded()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_folded ( ) const
inlineinherited

Forward to Tree::is_val_folded().

Node must be readable.

Definition at line 289 of file node.hpp.

◆ is_key_squo()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_squo ( ) const
inlineinherited

Forward to Tree::is_key_squo().

Node must be readable.

Definition at line 290 of file node.hpp.

◆ is_val_squo()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_squo ( ) const
inlineinherited

Forward to Tree::is_val_squo().

Node must be readable.

Definition at line 291 of file node.hpp.

◆ is_key_dquo()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_dquo ( ) const
inlineinherited

Forward to Tree::is_key_dquo().

Node must be readable.

Definition at line 292 of file node.hpp.

◆ is_val_dquo()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_dquo ( ) const
inlineinherited

Forward to Tree::is_val_dquo().

Node must be readable.

Definition at line 293 of file node.hpp.

◆ is_key_plain()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_plain ( ) const
inlineinherited

Forward to Tree::is_key_plain().

Node must be readable.

Definition at line 294 of file node.hpp.

◆ is_val_plain()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_plain ( ) const
inlineinherited

Forward to Tree::is_val_plain().

Node must be readable.

Definition at line 295 of file node.hpp.

◆ is_key_quoted()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_key_quoted ( ) const
inlineinherited

Forward to Tree::is_key_quoted().

Node must be readable.

Definition at line 296 of file node.hpp.

◆ is_val_quoted()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_val_quoted ( ) const
inlineinherited

Forward to Tree::is_val_quoted().

Node must be readable.

Definition at line 297 of file node.hpp.

◆ is_quoted()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_quoted ( ) const
inlineinherited

Forward to Tree::is_quoted().

Node must be readable.

Definition at line 298 of file node.hpp.

◆ is_root()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_root ( ) const
inlineinherited

Forward to Tree::is_root().

Node must be readable.

Definition at line 309 of file node.hpp.

◆ has_parent()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_parent ( ) const
inlineinherited

Forward to Tree::has_parent() Node must be readable.

Definition at line 310 of file node.hpp.

◆ is_ancestor()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::is_ancestor ( ConstNodeRef const & ancestor) const
inlineinherited

Forward to Tree::is_ancestor() Node must be readable.

Definition at line 311 of file node.hpp.

◆ has_child() [1/3]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_child ( ConstNodeRef const & n) const
inlineinherited

Forward to Tree::has_child().

Node must be readable.

Definition at line 313 of file node.hpp.

◆ has_child() [2/3]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_child ( id_type node) const
inlineinherited

Forward to Tree::has_child().

Node must be readable.

Definition at line 314 of file node.hpp.

◆ has_child() [3/3]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_child ( csubstr name) const
inlineinherited

Forward to Tree::has_child().

Node must be readable.

Definition at line 315 of file node.hpp.

◆ has_children()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_children ( ) const
inlineinherited

Forward to Tree::has_children().

Node must be readable.

Definition at line 316 of file node.hpp.

◆ has_sibling() [1/3]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_sibling ( ConstNodeRef const & n) const
inlineinherited

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 318 of file node.hpp.

◆ has_sibling() [2/3]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_sibling ( id_type node) const
inlineinherited

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 319 of file node.hpp.

◆ has_sibling() [3/3]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_sibling ( csubstr name) const
inlineinherited

Forward to Tree::has_sibling().

Node must be readable.

Definition at line 320 of file node.hpp.

◆ has_other_siblings()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_other_siblings ( ) const
inlineinherited

Forward to Tree::has_other_siblings().

Node must be readable.

Definition at line 321 of file node.hpp.

◆ has_siblings()

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::has_siblings ( ) const
inlineinherited

Definition at line 323 of file node.hpp.

323{ _C4RR(); return tree_->has_siblings(id_); }
c4::yml::detail::RoNodeMethods::has_siblings
bool has_siblings() const RYML_NOEXCEPT
Definition node.hpp:323

◆ doc() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::doc ( id_type i) ->NodeRef
inlineinherited

Forward to Tree::doc().

Node must be readable.

Definition at line 335 of file node.hpp.

◆ doc() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::doc ( id_type i) const
inlineinherited

Forward to Tree::doc().

Node must be readable. succeeds even when the node may have invalid or seed id

Definition at line 336 of file node.hpp.

◆ parent() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::parent ( ) ->Impl
inlineinherited

Forward to Tree::parent().

Node must be readable.

Definition at line 339 of file node.hpp.

◆ parent() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::parent ( ) const
inlineinherited

Forward to Tree::parent().

Node must be readable.

Definition at line 340 of file node.hpp.

◆ first_child() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::first_child ( ) ->Impl
inlineinherited

Forward to Tree::first_child().

Node must be readable.

Definition at line 343 of file node.hpp.

◆ first_child() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::first_child ( ) const
inlineinherited

Forward to Tree::first_child().

Node must be readable.

Definition at line 344 of file node.hpp.

◆ last_child() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::last_child ( ) ->Impl
inlineinherited

Forward to Tree::last_child().

Node must be readable.

Definition at line 347 of file node.hpp.

◆ last_child() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::last_child ( ) const
inlineinherited

Forward to Tree::last_child().

Node must be readable.

Definition at line 348 of file node.hpp.

◆ child() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::child ( id_type pos) ->NodeRef
inlineinherited

Forward to Tree::child().

Node must be readable.

Definition at line 351 of file node.hpp.

◆ child() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::child ( id_type pos) const
inlineinherited

Forward to Tree::child().

Node must be readable.

Definition at line 352 of file node.hpp.

◆ find_child() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::find_child ( csubstr name) ->NodeRef
inlineinherited

Forward to Tree::find_child().

Node must be readable.

Definition at line 355 of file node.hpp.

◆ find_child() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::find_child ( csubstr name) const
inlineinherited

Forward to Tree::find_child().

Node must be readable.

Definition at line 356 of file node.hpp.

◆ prev_sibling() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::prev_sibling ( ) ->Impl
inlineinherited

Forward to Tree::prev_sibling().

Node must be readable.

Definition at line 359 of file node.hpp.

◆ prev_sibling() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::prev_sibling ( ) const
inlineinherited

Forward to Tree::prev_sibling().

Node must be readable.

Definition at line 360 of file node.hpp.

◆ next_sibling() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::next_sibling ( ) ->Impl
inlineinherited

Forward to Tree::next_sibling().

Node must be readable.

Definition at line 363 of file node.hpp.

◆ next_sibling() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::next_sibling ( ) const
inlineinherited

Forward to Tree::next_sibling().

Node must be readable.

Definition at line 364 of file node.hpp.

◆ first_sibling() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::first_sibling ( ) ->Impl
inlineinherited

Forward to Tree::first_sibling().

Node must be readable.

Definition at line 367 of file node.hpp.

◆ first_sibling() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::first_sibling ( ) const
inlineinherited

Forward to Tree::first_sibling().

Node must be readable.

Definition at line 368 of file node.hpp.

◆ last_sibling() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::last_sibling ( ) ->Impl
inlineinherited

Forward to Tree::last_sibling().

Node must be readable.

Definition at line 371 of file node.hpp.

◆ last_sibling() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::last_sibling ( ) const
inlineinherited

Forward to Tree::last_sibling().

Node must be readable.

Definition at line 372 of file node.hpp.

◆ sibling() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::sibling ( id_type pos) ->NodeRef
inlineinherited

Forward to Tree::sibling().

Node must be readable.

Definition at line 375 of file node.hpp.

◆ sibling() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::sibling ( id_type pos) const
inlineinherited

Forward to Tree::sibling().

Node must be readable.

Definition at line 376 of file node.hpp.

◆ find_sibling() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::find_sibling ( csubstr name) ->NodeRef
inlineinherited

Forward to Tree::find_sibling().

Node must be readable.

Definition at line 379 of file node.hpp.

◆ find_sibling() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::find_sibling ( csubstr name) const
inlineinherited

Forward to Tree::find_sibling().

Node must be readable.

Definition at line 380 of file node.hpp.

◆ ancestor_doc() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::ancestor_doc ( ) ->Impl
inlineinherited

Forward to Tree::ancestor_doc().

Node must be readable.

Definition at line 383 of file node.hpp.

◆ ancestor_doc() [2/2]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::ancestor_doc ( ) const
inlineinherited

Forward to Tree::ancestor_doc().

Node must be readable.

Definition at line 384 of file node.hpp.

◆ num_children()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::num_children ( ) const
inlineinherited

O(num_children).

Forward to Tree::num_children().

Definition at line 386 of file node.hpp.

◆ num_siblings()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::num_siblings ( ) const
inlineinherited

O(num_children).

Forward to Tree::num_siblings().

Definition at line 387 of file node.hpp.

◆ num_other_siblings()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::num_other_siblings ( ) const
inlineinherited

O(num_siblings).

Forward to Tree::num_other_siblings().

Definition at line 388 of file node.hpp.

◆ child_pos()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::child_pos ( ConstNodeRef const & n) const
inlineinherited

O(num_children).

Forward to Tree::child_pos().

Definition at line 389 of file node.hpp.

◆ sibling_pos()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::sibling_pos ( ConstNodeRef const & n) const
inlineinherited

O(num_siblings).

Forward to Tree::sibling_pos().

Definition at line 390 of file node.hpp.

◆ depth_asc()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::depth_asc ( ) const
inlineinherited

Definition at line 392 of file node.hpp.

392{ _C4RR(); return tree_->depth_asc(id_); } /** O(log(num_nodes)). Forward to Tree::depth_asc(). Node must be readable. */
c4::yml::detail::RoNodeMethods::depth_asc
id_type depth_asc() const RYML_NOEXCEPT
Definition node.hpp:392

◆ depth_desc()

id_type c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::depth_desc ( ) const
inlineinherited

O(log(num_nodes)).

Forward to Tree::depth_asc(). Node must be readable.

Definition at line 393 of file node.hpp.

393{ _C4RR(); return tree_->depth_desc(id_); } /** O(num_nodes). Forward to Tree::depth_desc(). Node must be readable. */
c4::yml::detail::RoNodeMethods::depth_desc
id_type depth_desc() const RYML_NOEXCEPT
O(log(num_nodes)).
Definition node.hpp:393

◆ operator[]() [1/4]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator[] ( csubstr key) ->NodeRef
inlineinherited

Find child by key; complexity is O(num_children).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning
the calling object must be readable. This precondition is asserted. The assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to call this method if the node is not readable.
See also
https://github.com/biojppm/rapidyaml/issues/389

Definition at line 422 of file node.hpp.

423 {
424 _C4RR();
425 id_type ch = tree__->find_child(id__, key);
426 return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, key);
427 }
c4::yml::detail::RoNodeMethods::find_child
auto find_child(csubstr name) RYML_NOEXCEPT -> Impl
Forward to Tree::find_child().
Definition node.hpp:355

◆ operator[]() [2/4]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator[] ( id_type pos) ->NodeRef
inlineinherited

Find child by position; complexity is O(pos).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning
the calling object must be readable. This precondition is asserted. The assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to call this method if the node is not readable.
See also
https://github.com/biojppm/rapidyaml/issues/389

Definition at line 448 of file node.hpp.

449 {
450 _C4RR();
451 id_type ch = tree__->child(id__, pos);
452 return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, pos);
453 }

◆ operator[]() [3/4]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator[] ( csubstr key) const
inlineinherited

Find a child by key; complexity is O(num_children).

Behaves similar to the non-const overload, but further asserts that the returned node is readable (because it can never be in a seed state). The assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to use the return value if it is not valid.

See also
https://github.com/biojppm/rapidyaml/issues/389

Definition at line 464 of file node.hpp.

465 {
466 _C4RR();
467 id_type ch = tree_->find_child(id_, key);
468 _RYML_ASSERT_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
469 return {tree_, ch};
470 }

◆ operator[]() [4/4]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator[] ( id_type pos) const
inlineinherited

Find a child by position; complexity is O(pos).

Behaves similar to the non-const overload, but further asserts that the returned node is readable (because it can never be in a seed state). This assertion is performed only if RYML_USE_ASSERT is set to true. As with the non-const overload, it is UB to use the return value if it is not valid.

See also
https://github.com/biojppm/rapidyaml/issues/389

Definition at line 481 of file node.hpp.

482 {
483 _C4RR();
484 id_type ch = tree_->child(id_, pos);
485 _RYML_ASSERT_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
486 return {tree_, ch};
487 }

◆ at() [1/4]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::at ( csubstr key) ->NodeRef
inlineinherited

Find child by key; complexity is O(num_children).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be subsequently used to write to the tree provided that its create() method is called prior to writing, which happens inside most mutating methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning
This method will call the error callback (regardless of build type or of the value of RYML_USE_ASSERT) whenever any of the following preconditions is violated: a) the object is valid (points at a tree and a node), b) the calling object must be readable (must not be in seed state), c) the calling object must be pointing at a MAP node. The preconditions are similar to the non-const operator[](csubstr), but instead of using assertions, this function directly checks those conditions and calls the error callback if any of the checks fail.
Note
since it is valid behavior for the returned node to be in seed state, the error callback is not invoked when this happens.

Definition at line 529 of file node.hpp.

530 {
531 _RYML_CHECK_BASIC(tree_ != nullptr);
532 _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < tree_->capacity()), tree_, id_);
533 _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
534 _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_map(id_), tree_, id_);
535 id_type ch = tree__->find_child(id__, key);
536 return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, key);
537 }
c4::yml::detail::RoNodeMethods::is_map
bool is_map() const RYML_NOEXCEPT
Forward to Tree::is_map().
Definition node.hpp:240

◆ at() [2/4]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::at ( id_type pos) ->NodeRef
inlineinherited

Find child by position; complexity is O(pos).

Returns the requested node, or an object in seed state if no such child is found (see NodeRef for an explanation of what is seed state). When the object is in seed state, using it to read from the tree is UB. The seed node can be used to write to the tree provided that its create() method is called prior to writing, which happens in most modifying methods in NodeRef. It is the caller's responsibility to verify that the returned node is readable before subsequently using it to read from the tree.

Warning
This method will call the error callback (regardless of build type or of the value of RYML_USE_ASSERT) whenever any of the following preconditions is violated: a) the object is valid (points at a tree and a node), b) the calling object must be readable (must not be in seed state), c) the calling object must be pointing at a MAP node. The preconditions are similar to the non-const operator[](id_type), but instead of using assertions, this function directly checks those conditions and calls the error callback if any of the checks fail.
Note
since it is valid behavior for the returned node to be in seed state, the error callback is not invoked when this happens.

Definition at line 565 of file node.hpp.

566 {
567 _RYML_CHECK_BASIC(tree_ != nullptr);
568 const id_type cap = tree_->capacity();
569 _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < cap), tree_, id_);
570 _RYML_CHECK_VISIT_(tree_->m_callbacks, (pos >= 0 && pos < cap), tree_, id_);
571 _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
572 _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_container(id_), tree_, id_);
573 id_type ch = tree__->child(id__, pos);
574 return ch != NONE ? Impl(tree__, ch) : Impl(tree__, id__, pos);
575 }
c4::yml::detail::RoNodeMethods::is_container
bool is_container() const RYML_NOEXCEPT
Forward to Tree::is_container().
Definition node.hpp:239

◆ at() [3/4]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::at ( csubstr key) const
inlineinherited

Get a child by name, with error checking; complexity is O(num_children).

Behaves as operator[](csubstr) const, but always raises an error (even when RYML_USE_ASSERT is set to false) when the returned node does not exist, or when this node is not readable, or when it is not a map. This behaviour is similar to std::vector::at(), but the error consists in calling the error callback instead of directly raising an exception.

Definition at line 586 of file node.hpp.

587 {
588 _RYML_CHECK_BASIC(tree_ != nullptr);
589 _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < tree_->capacity()), tree_, id_);
590 _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
591 _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_map(id_), tree_, id_);
592 id_type ch = tree_->find_child(id_, key);
593 _RYML_CHECK_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
594 return {tree_, ch};
595 }

◆ at() [4/4]

ConstNodeRef c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::at ( id_type pos) const
inlineinherited

Get a child by position, with error checking; complexity is O(pos).

Behaves as operator[](id_type) const, but always raises an error (even when RYML_USE_ASSERT is set to false) when the returned node does not exist, or when this node is not readable, or when it is not a container. This behaviour is similar to std::vector::at(), but the error consists in calling the error callback instead of directly raising an exception.

Definition at line 606 of file node.hpp.

607 {
608 _RYML_CHECK_BASIC(tree_ != nullptr);
609 const id_type cap = tree_->capacity();
610 _RYML_CHECK_VISIT_(tree_->m_callbacks, (id_ >= 0 && id_ < cap), tree_, id_);
611 _RYML_CHECK_VISIT_(tree_->m_callbacks, (pos >= 0 && pos < cap), tree_, id_);
612 _RYML_CHECK_VISIT_(tree_->m_callbacks, ((Impl const*)this)->readable(), tree_, id_);
613 _RYML_CHECK_VISIT_(tree_->m_callbacks, tree_->is_container(id_), tree_, id_);
614 const id_type ch = tree_->child(id_, pos);
615 _RYML_CHECK_VISIT_(tree_->m_callbacks, ch != NONE, tree_, id_);
616 return {tree_, ch};
617 }

◆ location()

Location c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::location ( Parser const & parser) const
inlineinherited

Definition at line 626 of file node.hpp.

627 {
628 _C4RR();
629 return tree_->location(parser, id_);
630 }
c4::yml::detail::RoNodeMethods::location
Location location(Parser const &parser) const
Definition node.hpp:626

◆ operator>>() [1/3]

ConstNodeRef const & c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator>> ( T & v) const
inlineinherited

deserialize the node's val to the given variable, forwarding to the user-overrideable read() function.

Definition at line 642 of file node.hpp.

643 {
644 _C4RR();
645 if( ! read((ConstImpl const&)*this, &v))
646 _RYML_ERR_VISIT_(tree_->m_callbacks, tree_, id_, "could not deserialize value");
647 return *((ConstImpl const*)this);
648 }
c4::yml::read
bool read(ConstNodeRef const &n, T *v)
Definition node.hpp:1589

◆ operator>>() [2/3]

ConstNodeRef const & c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator>> ( T const & wrapper) const
inlineinherited

Definition at line 650 of file node.hpp.

651 {
652 _C4RR();
653 if( ! read((ConstImpl const&)*this, wrapper))
654 _RYML_ERR_VISIT_(tree_->m_callbacks, tree_, id_, "could not deserialize value");
655 return *((ConstImpl const*)this);
656 }

◆ operator>>() [3/3]

ConstNodeRef const & c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::operator>> ( Key< T > v) const
inlineinherited

deserialize the node's key to the given variable, forwarding to the user-overrideable read() function; use key() to disambiguate; for example: node >> ryml::key(var)

Definition at line 662 of file node.hpp.

663 {
664 _C4RR();
665 if( ! readkey((ConstImpl const&)*this, &v.k))
666 _RYML_ERR_VISIT_(tree_->m_callbacks, tree_, id_, "could not deserialize key");
667 return *((ConstImpl const*)this);
668 }
c4::yml::readkey
bool readkey(ConstNodeRef const &n, T *v)
Definition node.hpp:1611

◆ get_if() [1/2]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::get_if ( csubstr name,
T * var ) const
inlineinherited

look for a child by name, if it exists assign to var.

return true if the child existed.

Definition at line 673 of file node.hpp.

674 {
675 _C4RR();
676 ConstImpl ch = find_child(name);
677 if(!ch.readable())
678 return false;
679 ch >> *var;
680 return true;
681 }

◆ get_if() [2/2]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::get_if ( csubstr name,
T * var,
T const & fallback ) const
inlineinherited

look for a child by name, if it exists assign to var, otherwise default to fallback.

return true if the child existed.

Definition at line 687 of file node.hpp.

688 {
689 _C4RR();
690 ConstImpl ch = find_child(name);
691 if(ch.readable())
692 {
693 ch >> *var;
694 return true;
695 }
696 else
697 {
698 *var = fallback;
699 return false;
700 }
701 }

◆ begin() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::begin ( ) ->iterator
inlineinherited

get a mutable iterator to the first child.

NOT AVAILABLE for ConstNodeRef.

Definition at line 726 of file node.hpp.

◆ begin() [2/2]

const_iterator c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::begin ( ) const
inlineinherited

get an iterator to the first child

Definition at line 727 of file node.hpp.

◆ cbegin()

const_iterator c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::cbegin ( ) const
inlineinherited

get an iterator to the first child

Definition at line 728 of file node.hpp.

◆ end() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::end ( ) ->iterator
inlineinherited

get an iterator to after the last child.

NOT AVAILABLE for ConstNodeRef.

Definition at line 731 of file node.hpp.

◆ end() [2/2]

const_iterator c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::end ( ) const
inlineinherited

get an iterator to after the last child

get an iterator to after the last child

Definition at line 733 of file node.hpp.

◆ cend()

const_iterator c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::cend ( ) const
inlineinherited

get an iterator to after the last child

get an iterator to after the last child

Definition at line 735 of file node.hpp.

◆ children() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::children ( ) ->children_view
inlineinherited

get an iterable view over children.

NOT AVAILABLE for ConstNodeRef.

Definition at line 738 of file node.hpp.

◆ children() [2/2]

const_children_view c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::children ( ) const
inlineinherited

get an iterable view over children

Definition at line 739 of file node.hpp.

◆ cchildren()

const_children_view c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::cchildren ( ) const
inlineinherited

get an iterable view over children

Definition at line 740 of file node.hpp.

◆ siblings() [1/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::siblings ( ) ->children_view
inlineinherited

get an iterable view over all siblings (including the calling node)

Definition at line 744 of file node.hpp.

745 {
746 _C4RR();
747 NodeData const *nd = tree__->get(id__);
748 return (nd->m_parent != NONE) ? // does it have a parent?
749 children_view(iterator(tree__, tree_->get(nd->m_parent)->m_first_child), iterator(tree__, NONE))
750 :
751 children_view(end(), end());
752 }
c4::yml::NodeData::m_first_child
id_type m_first_child
Definition tree.hpp:237
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::iterator
detail::child_iterator< NodeRef > iterator
Definition node.hpp:720
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::children_view
detail::children_view_< NodeRef > children_view
Definition node.hpp:722

◆ siblings() [2/2]

const_children_view c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::siblings ( ) const
inlineinherited

get an iterable view over all siblings (including the calling node)

Definition at line 754 of file node.hpp.

755 {
756 _C4RR();
757 NodeData const *nd = tree_->get(id_);
758 return (nd->m_parent != NONE) ? // does it have a parent?
759 const_children_view(const_iterator(tree_, tree_->get(nd->m_parent)->m_first_child), const_iterator(tree_, NONE))
760 :
761 const_children_view(end(), end());
762 }
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::const_children_view
detail::children_view_< ConstNodeRef > const_children_view
Definition node.hpp:723
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::const_iterator
detail::child_iterator< ConstNodeRef > const_iterator
Definition node.hpp:721

◆ csiblings()

const_children_view c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::csiblings ( ) const
inlineinherited

get an iterable view over all siblings (including the calling node)

Definition at line 764 of file node.hpp.

764{ return siblings(); }
c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::siblings
const_children_view siblings() const RYML_NOEXCEPT
Definition node.hpp:754

◆ visit() [1/2]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::visit ( Visitor fn,
id_type indentation_level = 0,
bool skip_root = true ) const
inlineinherited

visit every child node calling fn(node)

Definition at line 768 of file node.hpp.

769 {
770 _C4RR();
771 return detail::_visit(*(ConstImpl const*)this, fn, indentation_level, skip_root);
772 }

◆ visit() [2/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::visit ( Visitor fn,
id_type indentation_level = 0,
bool skip_root = true )->bool
inlineinherited

visit every child node calling fn(node)

Definition at line 775 of file node.hpp.

777 {
778 _C4RR();
779 return detail::_visit(*(Impl*)this, fn, indentation_level, skip_root);
780 }

◆ visit_stacked() [1/2]

bool c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::visit_stacked ( Visitor fn,
id_type indentation_level = 0,
bool skip_root = true ) const
inlineinherited

visit every child node calling fn(node, level)

Definition at line 784 of file node.hpp.

785 {
786 _C4RR();
787 return detail::_visit_stacked(*(ConstImpl const*)this, fn, indentation_level, skip_root);
788 }

◆ visit_stacked() [2/2]

auto c4::yml::detail::RoNodeMethods< NodeRef, ConstNodeRef >::visit_stacked ( Visitor fn,
id_type indentation_level = 0,
bool skip_root = true )->bool
inlineinherited

visit every child node calling fn(node, level)

Definition at line 791 of file node.hpp.

793 {
794 _C4RR();
795 return detail::_visit_stacked(*(Impl*)this, fn, indentation_level, skip_root);
796 }

◆ detail::RoNodeMethods< NodeRef, ConstNodeRef >

friend struct detail::RoNodeMethods< NodeRef, ConstNodeRef >
friend

Definition at line 990 of file node.hpp.

The documentation for this class was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.14.0/src/c4/yml/node.hpp