c4::yml::Tree Class Reference

#include <tree.hpp>

Classes
struct	lookup_result

Public Member Functions
id_type	_claim ()
construction and assignment
	Tree ()
	Tree (Callbacks const &cb)
	Tree (id_type node_capacity, size_t arena_capacity=RYML_DEFAULT_TREE_ARENA_CAPACITY)
	Tree (id_type node_capacity, size_t arena_capacity, Callbacks const &cb)
	~Tree ()
	Tree (Tree const &that)
	Tree (Tree &&that) noexcept
Tree &	operator= (Tree const &that)
Tree &	operator= (Tree &&that) noexcept
memory and sizing
void	reserve (id_type node_capacity=RYML_DEFAULT_TREE_CAPACITY)
void	clear ()
	clear the tree and zero every node
void	clear_arena ()
bool	empty () const
id_type	size () const
id_type	capacity () const
id_type	slack () const
Callbacks const &	callbacks () const
void	callbacks (Callbacks const &cb)
node getters
id_type	id (NodeData const *n) const
	get the index of a node belonging to this tree. n can be nullptr, in which case NONE is returned
NodeData *	get (id_type node)
	get a pointer to a node's NodeData. i can be NONE, in which case a nullptr is returned
NodeData const *	get (id_type node) const
	get a pointer to a node's NodeData. i can be NONE, in which case a nullptr is returned.
NodeData *	_p (id_type node)
	An if-less form of get() that demands a valid node index. This function is implementation only; use at your own risk.
NodeData const *	_p (id_type node) const
	An if-less form of get() that demands a valid node index. This function is implementation only; use at your own risk.
id_type	root_id () const
	Get the id of the root node. The tree must not be empty.
NodeRef	ref (id_type node)
	Get a NodeRef of a node by id.
ConstNodeRef	ref (id_type node) const
	Get a NodeRef of a node by id.
ConstNodeRef	cref (id_type node) const
	Get a NodeRef of a node by id.
NodeRef	rootref ()
	Get the root as a NodeRef.
ConstNodeRef	rootref () const
	Get the root as a ConstNodeRef.
ConstNodeRef	crootref () const
	Get the root as a ConstNodeRef.
NodeRef	docref (id_type i)
	get the i-th document of the stream
ConstNodeRef	docref (id_type i) const
	get the i-th document of the stream
ConstNodeRef	cdocref (id_type i) const
	get the i-th document of the stream
NodeRef	operator[] (csubstr key)
	find a root child (ie child of root) by name, return it as a NodeRef
ConstNodeRef	operator[] (csubstr key) const
	find a root child (ie child of root) by name, return it as a NodeRef
NodeRef	operator[] (id_type i)
	find a root child (ie child of root) by index: return the root node's i-th child as a NodeRef
ConstNodeRef	operator[] (id_type i) const
	find a root child (ie child of root) by index: return the root node's i-th child as a NodeRef
node property getters
NodeType	type (id_type node) const
const char *	type_str (id_type node) const
csubstr const &	key (id_type node) const
csubstr const &	key_tag (id_type node) const
csubstr const &	key_ref (id_type node) const
csubstr const &	key_anchor (id_type node) const
NodeScalar const &	keysc (id_type node) const
csubstr const &	val (id_type node) const
csubstr const &	val_tag (id_type node) const
csubstr const &	val_ref (id_type node) const
csubstr const &	val_anchor (id_type node) const
NodeScalar const &	valsc (id_type node) const
node type predicates
bool	type_has_any (id_type node, NodeType_e bits) const
bool	type_has_all (id_type node, NodeType_e bits) const
bool	type_has_none (id_type node, NodeType_e bits) const
bool	is_stream (id_type node) const
bool	is_doc (id_type node) const
bool	is_container (id_type node) const
bool	is_map (id_type node) const
bool	is_seq (id_type node) const
bool	has_key (id_type node) const
bool	has_val (id_type node) const
bool	is_val (id_type node) const
bool	is_keyval (id_type node) const
bool	has_key_tag (id_type node) const
bool	has_val_tag (id_type node) const
bool	has_key_anchor (id_type node) const
bool	has_val_anchor (id_type node) const
bool	has_anchor (id_type node) const
bool	is_key_ref (id_type node) const
bool	is_val_ref (id_type node) const
bool	is_ref (id_type node) const
bool	parent_is_seq (id_type node) const
bool	parent_is_map (id_type node) const
bool	has_anchor (id_type node, csubstr a) const
	true when the node has an anchor named a
bool	key_is_null (id_type node) const
	true if the node key is empty, or its scalar verifies scalar_is_null().
bool	val_is_null (id_type node) const
	true if the node val is empty, or its scalar verifies scalar_is_null().
bool	is_key_unfiltered (id_type node) const
	true if the key was a scalar requiring filtering and was left unfiltered during the parsing (see ParserOptions)
bool	is_val_unfiltered (id_type node) const
	true if the val was a scalar requiring filtering and was left unfiltered during the parsing (see ParserOptions)
bool	is_key_anchor (id_type node) const
bool	is_val_anchor (id_type node) const
bool	is_anchor (id_type node) const
bool	is_anchor_or_ref (id_type node) const
hierarchy getters
id_type	parent (id_type node) const
id_type	prev_sibling (id_type node) const
id_type	next_sibling (id_type node) const
id_type	num_children (id_type node) const
	O(num_children).
id_type	child_pos (id_type node, id_type ch) const
id_type	first_child (id_type node) const
id_type	last_child (id_type node) const
id_type	child (id_type node, id_type pos) const
id_type	find_child (id_type node, csubstr const &key) const
id_type	num_siblings (id_type node) const
	O(num_siblings).
id_type	num_other_siblings (id_type node) const
	does not count with this
id_type	sibling_pos (id_type node, id_type sib) const
id_type	first_sibling (id_type node) const
id_type	last_sibling (id_type node) const
id_type	sibling (id_type node, id_type pos) const
id_type	find_sibling (id_type node, csubstr const &key) const
id_type	depth_asc (id_type node) const
	O(log(num_tree_nodes)) get the ascending depth of the node: number of levels between root and node.
id_type	depth_desc (id_type node) const
	O(num_tree_nodes) get the descending depth of the node: number of levels between node and deepest child.
id_type	doc (id_type i) const
	gets the i document node index.
id_type	ancestor_doc (id_type node) const
	get the document which is a parent document of node i, or the root if the tree is not a stream
node style predicates and modifiers. see the corresponding predicate in NodeType
bool	is_container_styled (id_type node) const
bool	is_block (id_type node) const
bool	is_flow_sl (id_type node) const
bool	is_flow_ml (id_type node) const
bool	is_flow (id_type node) const
bool	is_key_styled (id_type node) const
bool	is_val_styled (id_type node) const
bool	is_key_literal (id_type node) const
bool	is_val_literal (id_type node) const
bool	is_key_folded (id_type node) const
bool	is_val_folded (id_type node) const
bool	is_key_squo (id_type node) const
bool	is_val_squo (id_type node) const
bool	is_key_dquo (id_type node) const
bool	is_val_dquo (id_type node) const
bool	is_key_plain (id_type node) const
bool	is_val_plain (id_type node) const
bool	is_key_quoted (id_type node) const
bool	is_val_quoted (id_type node) const
bool	is_quoted (id_type node) const
NodeType	key_style (id_type node) const
NodeType	val_style (id_type node) const
void	set_container_style (id_type node, NodeType_e style)
void	set_key_style (id_type node, NodeType_e style)
void	set_val_style (id_type node, NodeType_e style)
void	clear_style (id_type node, bool recurse=false)
void	set_style_conditionally (id_type node, NodeType type_mask, NodeType rem_style_flags, NodeType add_style_flags, bool recurse=false)
node type modifiers
void	to_keyval (id_type node, csubstr key, csubstr val, type_bits more_flags=0)
void	to_map (id_type node, csubstr key, type_bits more_flags=0)
void	to_seq (id_type node, csubstr key, type_bits more_flags=0)
void	to_val (id_type node, csubstr val, type_bits more_flags=0)
void	to_map (id_type node, type_bits more_flags=0)
void	to_seq (id_type node, type_bits more_flags=0)
void	to_doc (id_type node, type_bits more_flags=0)
void	to_stream (id_type node, type_bits more_flags=0)
void	set_key (id_type node, csubstr key)
void	set_val (id_type node, csubstr val)
void	set_key_tag (id_type node, csubstr tag)
void	set_val_tag (id_type node, csubstr tag)
void	set_key_anchor (id_type node, csubstr anchor)
void	set_val_anchor (id_type node, csubstr anchor)
void	set_key_ref (id_type node, csubstr ref)
void	set_val_ref (id_type node, csubstr ref)
void	rem_key_anchor (id_type node)
void	rem_val_anchor (id_type node)
void	rem_key_ref (id_type node)
void	rem_val_ref (id_type node)
void	rem_anchor_ref (id_type node)
tree modifiers
void	reorder ()
	reorder the tree in memory so that all the nodes are stored in a linear sequence when visited in depth-first order.
anchors and references/aliases
void	resolve (ReferenceResolver *rr, bool clear_anchors=true)
	Resolve references (aliases <- anchors), by forwarding to ReferenceResolver::resolve(); refer to ReferenceResolver::resolve() for further details.
void	resolve (bool clear_anchors=true)
	Resolve references (aliases <- anchors), by forwarding to ReferenceResolver::resolve(); refer to ReferenceResolver::resolve() for further details.
tags and tag directives
void	resolve_tags (TagCache &cache, bool all=true)
	Resolve tags in the tree such as "!!str" -> "<tag:yaml.org,2002:str>", "!foo" -> "<!foo>" and custom tags as well, ie tags of the form "!handle!tag" for which there is a corresponding "%TAG" directive.
void	normalize_tags ()
void	normalize_tags_long ()
id_type	num_tag_directives () const
void	add_tag_directive (csubstr handle, csubstr prefix, id_type id)
void	clear_tag_directives ()
size_t	resolve_tag (substr output, csubstr tag, id_type node_id) const
	resolve the given tag, appearing at node_id.
csubstr	resolve_tag_sub (substr output, csubstr tag, id_type node_id) const
	Wrapper for Tree::resolve_tag(), returning a substring.
c4::yml::TagDirectiveRange	tag_directives () const
modifying hierarchy
id_type	insert_child (id_type parent, id_type after)
	create and insert a new child of parent.
id_type	prepend_child (id_type parent)
	create and insert a node as the first child of parent
id_type	append_child (id_type parent)
	create and insert a node as the last child of parent
id_type	_append_child__unprotected (id_type parent)
id_type	insert_sibling (id_type node, id_type after)
	create and insert a new sibling of n. insert after "after"
id_type	prepend_sibling (id_type node)
	create and insert a node as the first node of parent
id_type	append_sibling (id_type node)
void	remove (id_type node)
	remove an entire branch at once: ie remove the children and the node itself
void	remove_children (id_type node)
	remove all the node's children, but keep the node itself
bool	change_type (id_type node, NodeType type)
	change the type of the node to one of MAP, SEQ or VAL.
bool	change_type (id_type node, type_bits type)
void	move (id_type node, id_type after)
	change the node's position in the parent
void	move (id_type node, id_type new_parent, id_type after)
	change the node's parent and position
id_type	move (Tree *src, id_type node, id_type new_parent, id_type after)
	change the node's parent and position to a different tree
void	set_root_as_stream ()
	ensure the first node is a stream.
id_type	duplicate (id_type node, id_type new_parent, id_type after)
	recursively duplicate a node from this tree into a new parent, placing it after one of its children
id_type	duplicate (Tree const *src, id_type node, id_type new_parent, id_type after)
	recursively duplicate a node from a different tree into a new parent, placing it after one of its children
id_type	duplicate_children (id_type node, id_type parent, id_type after)
	recursively duplicate the node's children (but not the node)
id_type	duplicate_children (Tree const *src, id_type node, id_type parent, id_type after)
	recursively duplicate the node's children (but not the node), where the node is from a different tree
id_type	duplicate_children_no_rep (id_type node, id_type parent, id_type after)
	duplicate the node's children (but not the node) in a new parent, but omit repetitions where a duplicated node has the same key (in maps) or value (in seqs).
id_type	duplicate_children_no_rep (Tree const *src, id_type node, id_type parent, id_type after)
void	duplicate_contents (id_type node, id_type where)
void	duplicate_contents (Tree const *src, id_type node, id_type where)
void	merge_with (Tree const *src, id_type src_node=NONE, id_type dst_root=NONE)
internal string arena
size_t	arena_size () const
	get the current size of the tree's internal arena
size_t	arena_capacity () const
	get the current capacity of the tree's internal arena
size_t	arena_slack () const
	get the current slack of the tree's internal arena
size_t	arena_pos () const
csubstr	arena () const
	get the current arena
substr	arena ()
	get the current arena
bool	in_arena (csubstr s) const
	return true if the given substring is part of the tree's string arena
template<class T>
csubstr	to_arena (T const &a)
	serialize the given variable to the tree's arena, growing it as needed to accomodate the serialization.
substr	copy_to_arena (csubstr s)
	copy the given string to the tree's arena, growing the arena by the required size.
substr	alloc_arena (size_t sz)
	grow the tree's string arena by the given size and return a substr of the added portion
void	reserve_arena (size_t arena_cap=RYML_DEFAULT_TREE_ARENA_CAPACITY)
	ensure the tree's internal string arena is at least the given capacity
lookup
lookup_result	lookup_path (csubstr path, id_type start=NONE) const
	for example foo.bar[0].baz
id_type	lookup_path_or_modify (csubstr default_value, csubstr path, id_type start=NONE)
	defaulted lookup: lookup path; if the lookup fails, recursively modify the tree so that the corresponding lookup_path() would return the default value.
id_type	lookup_path_or_modify (Tree const *src, id_type src_node, csubstr path, id_type start=NONE)
	defaulted lookup: lookup path; if the lookup fails, recursively modify the tree so that the corresponding lookup_path() would return the branch src_node (from the tree src).

Public Attributes
NodeData *	m_buf
id_type	m_cap
id_type	m_size
id_type	m_free_head
id_type	m_free_tail
substr	m_arena
size_t	m_arena_pos
Callbacks	m_callbacks
TagDirectives	m_tag_directives

hierarchy predicates
bool	is_root (id_type node) const
bool	has_parent (id_type node) const
bool	is_ancestor (id_type node, id_type ancestor) const
	true when ancestor is parent or parent of a parent of node
bool	empty (id_type node) const
	true when key and val are empty, and has no children
bool	has_child (id_type node, id_type ch) const
	true if node has a child with id ch
bool	has_child (id_type node, csubstr key) const
	true if node has a child with key key
bool	has_children (id_type node) const
	true if node has any children key
bool	has_sibling (id_type node, id_type sib) const
	true if node has a sibling with id sib
bool	has_sibling (id_type node, csubstr key) const
	true if one of the node's siblings has the given key
bool	has_other_siblings (id_type node) const
	true if node is not a single child
static bool	has_siblings (id_type)

locations
Location	location (Parser const &p, id_type node) const
	Get the location of a node from the parse used to parse this tree.

Detailed Description

Definition at line 249 of file tree.hpp.

Constructor & Destructor Documentation

Tree() [1/6]

c4::yml::Tree::Tree ( )

inline

Definition at line 256 of file tree.hpp.

: Tree(get_callbacks()) {}

Tree() [2/6]

c4::yml::Tree::Tree

(

Callbacks const &

cb

)

Definition at line 119 of file tree.cpp.

    : Tree(RYML_DEFAULT_TREE_CAPACITY, RYML_DEFAULT_TREE_ARENA_CAPACITY, cb)
{
}

Tree() [3/6]

c4::yml::Tree::Tree ( id_type node_capacity, size_t arena_capacity = RYML_DEFAULT_TREE_ARENA_CAPACITY )

inline

Definition at line 258 of file tree.hpp.

: Tree(node_capacity, arena_capacity, get_callbacks()) {}

Tree() [4/6]

c4::yml::Tree::Tree	(	id_type	node_capacity,
		size_t	arena_capacity,
		Callbacks const &	cb )

Definition at line 124 of file tree.cpp.

    : m_buf(nullptr)
    , m_cap(0)
    , m_size(0)
    , m_free_head(NONE)
    , m_free_tail(NONE)
    , m_arena()
    , m_arena_pos(0)
    , m_callbacks(cb)
    , m_tag_directives()
{
    if(node_capacity)
        reserve(node_capacity);
    if(arena_capacity)
        reserve_arena(arena_capacity);
}

~Tree()

c4::yml::Tree::~Tree

(

)

Definition at line 141 of file tree.cpp.

{
    _free();
}

Tree() [5/6]

c4::yml::Tree::Tree

(

Tree const &

that

)

Definition at line 147 of file tree.cpp.

                           : m_callbacks(that.m_callbacks)
{
    _clear();
    _copy(that);
}

Tree() [6/6]

c4::yml::Tree::Tree ( Tree && that )

noexcept

Definition at line 153 of file tree.cpp.

                                : m_callbacks(that.m_callbacks)
{
    _clear();
    _move(that);
}

Member Function Documentation

operator=() [1/2]

Tree & c4::yml::Tree::operator=

(

Tree const &

that

)

Definition at line 159 of file tree.cpp.

{
    if(&that != this)
    {
        _free();
        m_callbacks = that.m_callbacks;
        _copy(that);
    }
    return *this;
}

operator=() [2/2]

Tree & c4::yml::Tree::operator= ( Tree && that )

noexcept

Definition at line 170 of file tree.cpp.

{
    if(&that != this)
    {
        _free();
        m_callbacks = that.m_callbacks;
        _move(that);
    }
    return *this;
}

reserve()

void c4::yml::Tree::reserve

(

id_type

node_capacity = RYML_DEFAULT_TREE_CAPACITY

)

Definition at line 292 of file tree.cpp.

{
    if(cap > m_cap)
    {
        NodeData *buf = _RYML_CB_ALLOC_HINT(m_callbacks, NodeData, (size_t)cap, m_buf);
        if(m_buf)
        {
            memcpy(buf, m_buf, (size_t)m_cap * sizeof(NodeData));
            _RYML_CB_FREE(m_callbacks, m_buf, NodeData, (size_t)m_cap);
        }
        id_type first = m_cap, del = cap - m_cap;
        m_cap = cap;
        m_buf = buf;
        _clear_range(first, del);
        if(m_free_head != NONE)
        {
            _RYML_ASSERT_VISIT_(m_callbacks, m_buf != nullptr, this, NONE);
            _RYML_ASSERT_VISIT_(m_callbacks, m_free_tail != NONE, this, NONE);
            m_buf[m_free_tail].m_next_sibling = first;
            m_buf[first].m_prev_sibling = m_free_tail;
            m_free_tail = cap-1;
        }
        else
        {
            _RYML_ASSERT_VISIT_(m_callbacks, m_free_tail == NONE, this, NONE);
            m_free_head = first;
            m_free_tail = cap-1;
        }
        _RYML_ASSERT_VISIT_(m_callbacks, m_free_head == NONE || (m_free_head >= 0 && m_free_head < cap), this, NONE);
        _RYML_ASSERT_VISIT_(m_callbacks, m_free_tail == NONE || (m_free_tail >= 0 && m_free_tail < cap), this, NONE);
 
        if( ! m_size)
            _claim_root();
    }
}

clear()

void c4::yml::Tree::clear

(

)

clear the tree and zero every node

Note

does NOT clear the arena

See also

clear_arena()

Definition at line 330 of file tree.cpp.

{
    _clear_range(0, m_cap);
    m_size = 0;
    if(m_buf)
    {
        _RYML_ASSERT_VISIT_(m_callbacks, m_cap >= 0, this, NONE);
        m_free_head = 0;
        m_free_tail = m_cap-1;
        _claim_root();
    }
    else
    {
        m_free_head = NONE;
        m_free_tail = NONE;
    }
    m_tag_directives.clear();
}

clear_arena()

void c4::yml::Tree::clear_arena ( )

inline

Definition at line 282 of file tree.hpp.

{ m_arena_pos = 0; }

empty() [1/2]

bool c4::yml::Tree::empty ( ) const

inline

Definition at line 284 of file tree.hpp.

{ return m_size == 0; }

size()

id_type c4::yml::Tree::size ( ) const

inline

Definition at line 286 of file tree.hpp.

{ return m_size; }

capacity()

id_type c4::yml::Tree::capacity ( ) const

inline

Definition at line 287 of file tree.hpp.

{ return m_cap; }

slack()

id_type c4::yml::Tree::slack ( ) const

inline

Definition at line 288 of file tree.hpp.

{ _RYML_ASSERT_BASIC(m_cap >= m_size); return m_cap - m_size; }

callbacks() [1/2]

Callbacks const & c4::yml::Tree::callbacks ( ) const

inline

Definition at line 290 of file tree.hpp.

{ return m_callbacks; }

callbacks() [2/2]

void c4::yml::Tree::callbacks ( Callbacks const & cb )

inline

Definition at line 291 of file tree.hpp.

{ m_callbacks = cb; }

id()

id_type c4::yml::Tree::id ( NodeData const * n ) const

inline

get the index of a node belonging to this tree. n can be nullptr, in which case NONE is returned

Definition at line 302 of file tree.hpp.

    {
        if( ! n)
            return NONE;
        _RYML_ASSERT_VISIT_(m_callbacks, n >= m_buf && n < m_buf + m_cap, this, NONE);
        return static_cast<id_type>(n - m_buf);
    }

get() [1/2]

NodeData * c4::yml::Tree::get ( id_type node )

inline

get a pointer to a node's NodeData. i can be NONE, in which case a nullptr is returned

Definition at line 312 of file tree.hpp.

    {
        if(node == NONE)
            return nullptr;
        _RYML_ASSERT_VISIT_(m_callbacks, node >= 0 && node < m_cap, this, node);
        return m_buf + node;
    }

get() [2/2]

NodeData const * c4::yml::Tree::get ( id_type node ) const

inline

get a pointer to a node's NodeData. i can be NONE, in which case a nullptr is returned.

Definition at line 321 of file tree.hpp.

    {
        if(node == NONE)
            return nullptr;
        _RYML_ASSERT_VISIT_(m_callbacks, node >= 0 && node < m_cap, this, node);
        return m_buf + node;
    }

_p() [1/2]

NodeData * c4::yml::Tree::_p ( id_type node )

inline

An if-less form of get() that demands a valid node index. This function is implementation only; use at your own risk.

Definition at line 331 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node); return m_buf + node; } // NOLINT(readability-make-member-function-const)

_p() [2/2]

NodeData const * c4::yml::Tree::_p ( id_type node ) const

inline

An if-less form of get() that demands a valid node index. This function is implementation only; use at your own risk.

Definition at line 334 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node); return m_buf + node; }

root_id()

id_type c4::yml::Tree::root_id ( ) const

inline

Get the id of the root node. The tree must not be empty.

Definition at line 337 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, m_cap > 0 && m_size > 0, this, id_type(0)); return 0; }

ref() [1/2]

NodeRef c4::yml::Tree::ref

(

id_type

node

)

Get a NodeRef of a node by id.

Definition at line 70 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, id != NONE && id >= 0 && id < m_cap, this, id);
    return NodeRef(this, id);
}

ref() [2/2]

ConstNodeRef c4::yml::Tree::ref

(

id_type

node

)

const

Get a NodeRef of a node by id.

Definition at line 75 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, id != NONE && id >= 0 && id < m_cap, this, id);
    return ConstNodeRef(this, id);
}

cref()

ConstNodeRef c4::yml::Tree::cref

(

id_type

node

)

const

Get a NodeRef of a node by id.

Definition at line 80 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, id != NONE && id >= 0 && id < m_cap, this, id);
    return ConstNodeRef(this, id);
}

rootref() [1/2]

NodeRef c4::yml::Tree::rootref

(

)

Get the root as a NodeRef.

Definition at line 56 of file tree.cpp.

{
    return NodeRef(this, root_id());
}

rootref() [2/2]

ConstNodeRef c4::yml::Tree::rootref

(

)

const

Get the root as a ConstNodeRef.

Definition at line 60 of file tree.cpp.

{
    return ConstNodeRef(this, root_id());
}

crootref()

ConstNodeRef c4::yml::Tree::crootref

(

)

const

Get the root as a ConstNodeRef.

Definition at line 65 of file tree.cpp.

{
    return ConstNodeRef(this, root_id());
}

docref() [1/2]

NodeRef c4::yml::Tree::docref

(

id_type

i

)

get the i-th document of the stream

Note

i is NOT the node id, but the doc position within the stream

Definition at line 104 of file tree.cpp.

{
    return ref(doc(i));
}

docref() [2/2]

ConstNodeRef c4::yml::Tree::docref

(

id_type

i

)

const

get the i-th document of the stream

Note

i is NOT the node id, but the doc position within the stream

Definition at line 108 of file tree.cpp.

{
    return cref(doc(i));
}

cdocref()

ConstNodeRef c4::yml::Tree::cdocref

(

id_type

i

)

const

get the i-th document of the stream

Note

i is NOT the node id, but the doc position within the stream

Definition at line 112 of file tree.cpp.

{
    return cref(doc(i));
}

operator[]() [1/4]

NodeRef c4::yml::Tree::operator[]

(

csubstr

key

)

find a root child (ie child of root) by name, return it as a NodeRef

Note

requires the root to be a map.

Definition at line 86 of file tree.cpp.

{
    return rootref()[key];
}

operator[]() [2/4]

ConstNodeRef c4::yml::Tree::operator[]

(

csubstr

key

)

const

find a root child (ie child of root) by name, return it as a NodeRef

Note

requires the root to be a map.

Definition at line 90 of file tree.cpp.

{
    return rootref()[key];
}

operator[]() [3/4]

NodeRef c4::yml::Tree::operator[]

(

id_type

i

)

find a root child (ie child of root) by index: return the root node's i-th child as a NodeRef

Note

i is NOT the node id, but the child's position

Definition at line 95 of file tree.cpp.

{
    return rootref()[i];
}

operator[]() [4/4]

ConstNodeRef c4::yml::Tree::operator[]

(

id_type

i

)

const

find a root child (ie child of root) by index: return the root node's i-th child as a NodeRef

Note

i is NOT the node id, but the child's position

Definition at line 99 of file tree.cpp.

{
    return rootref()[i];
}

type()

NodeType c4::yml::Tree::type ( id_type node ) const

inline

Definition at line 384 of file tree.hpp.

{ return _p(node)->m_type; }

type_str()

const char * c4::yml::Tree::type_str ( id_type node ) const

inline

Definition at line 385 of file tree.hpp.

{ return NodeType::type_str(_p(node)->m_type); }

key()

csubstr const & c4::yml::Tree::key ( id_type node ) const

inline

Definition at line 387 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); return _p(node)->m_key.scalar; }

key_tag()

csubstr const & c4::yml::Tree::key_tag ( id_type node ) const

inline

Definition at line 388 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key_tag(node), this, node); return _p(node)->m_key.tag; }

key_ref()

csubstr const & c4::yml::Tree::key_ref ( id_type node ) const

inline

Definition at line 389 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, is_key_ref(node), this, node); return _p(node)->m_key.anchor; }

key_anchor()

csubstr const & c4::yml::Tree::key_anchor ( id_type node ) const

inline

Definition at line 390 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key_anchor(node), this, node); return _p(node)->m_key.anchor; }

keysc()

NodeScalar const & c4::yml::Tree::keysc ( id_type node ) const

inline

Definition at line 391 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); return _p(node)->m_key; }

val()

csubstr const & c4::yml::Tree::val ( id_type node ) const

inline

Definition at line 393 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node), this, node); return _p(node)->m_val.scalar; }

val_tag()

csubstr const & c4::yml::Tree::val_tag ( id_type node ) const

inline

Definition at line 394 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val_tag(node), this, node); return _p(node)->m_val.tag; }

val_ref()

csubstr const & c4::yml::Tree::val_ref ( id_type node ) const

inline

Definition at line 395 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, is_val_ref(node), this, node); return _p(node)->m_val.anchor; }

val_anchor()

csubstr const & c4::yml::Tree::val_anchor ( id_type node ) const

inline

Definition at line 396 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val_anchor(node), this, node); return _p(node)->m_val.anchor; }

valsc()

NodeScalar const & c4::yml::Tree::valsc ( id_type node ) const

inline

Definition at line 397 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node), this, node); return _p(node)->m_val; }

type_has_any()

bool c4::yml::Tree::type_has_any ( id_type node, NodeType_e bits ) const

inline

Definition at line 406 of file tree.hpp.

{ return _p(node)->m_type.has_any(bits); }

type_has_all()

bool c4::yml::Tree::type_has_all ( id_type node, NodeType_e bits ) const

inline

Definition at line 407 of file tree.hpp.

{ return _p(node)->m_type.has_all(bits); }

type_has_none()

bool c4::yml::Tree::type_has_none ( id_type node, NodeType_e bits ) const

inline

Definition at line 408 of file tree.hpp.

{ return _p(node)->m_type.has_none(bits); }

is_stream()

bool c4::yml::Tree::is_stream ( id_type node ) const

inline

Definition at line 410 of file tree.hpp.

{ return _p(node)->m_type.is_stream(); }

is_doc()

bool c4::yml::Tree::is_doc ( id_type node ) const

inline

Definition at line 411 of file tree.hpp.

{ return _p(node)->m_type.is_doc(); }

is_container()

bool c4::yml::Tree::is_container ( id_type node ) const

inline

Definition at line 412 of file tree.hpp.

{ return _p(node)->m_type.is_container(); }

is_map()

bool c4::yml::Tree::is_map ( id_type node ) const

inline

Definition at line 413 of file tree.hpp.

{ return _p(node)->m_type.is_map(); }

is_seq()

bool c4::yml::Tree::is_seq ( id_type node ) const

inline

Definition at line 414 of file tree.hpp.

{ return _p(node)->m_type.is_seq(); }

has_key()

bool c4::yml::Tree::has_key ( id_type node ) const

inline

Definition at line 415 of file tree.hpp.

{ return _p(node)->m_type.has_key(); }

has_val()

bool c4::yml::Tree::has_val ( id_type node ) const

inline

Definition at line 416 of file tree.hpp.

{ return _p(node)->m_type.has_val(); }

is_val()

bool c4::yml::Tree::is_val ( id_type node ) const

inline

Definition at line 417 of file tree.hpp.

{ return _p(node)->m_type.is_val(); }

is_keyval()

bool c4::yml::Tree::is_keyval ( id_type node ) const

inline

Definition at line 418 of file tree.hpp.

{ return _p(node)->m_type.is_keyval(); }

has_key_tag()

bool c4::yml::Tree::has_key_tag ( id_type node ) const

inline

Definition at line 419 of file tree.hpp.

{ return _p(node)->m_type.has_key_tag(); }

has_val_tag()

bool c4::yml::Tree::has_val_tag ( id_type node ) const

inline

Definition at line 420 of file tree.hpp.

{ return _p(node)->m_type.has_val_tag(); }

has_key_anchor()

bool c4::yml::Tree::has_key_anchor ( id_type node ) const

inline

Definition at line 421 of file tree.hpp.

{ return _p(node)->m_type.has_key_anchor(); }

has_val_anchor()

bool c4::yml::Tree::has_val_anchor ( id_type node ) const

inline

Definition at line 422 of file tree.hpp.

{ return _p(node)->m_type.has_val_anchor(); }

has_anchor() [1/2]

bool c4::yml::Tree::has_anchor ( id_type node ) const

inline

Definition at line 423 of file tree.hpp.

{ return _p(node)->m_type.has_anchor(); }

is_key_ref()

bool c4::yml::Tree::is_key_ref ( id_type node ) const

inline

Definition at line 424 of file tree.hpp.

{ return _p(node)->m_type.is_key_ref(); }

is_val_ref()

bool c4::yml::Tree::is_val_ref ( id_type node ) const

inline

Definition at line 425 of file tree.hpp.

{ return _p(node)->m_type.is_val_ref(); }

is_ref()

bool c4::yml::Tree::is_ref ( id_type node ) const

inline

Definition at line 426 of file tree.hpp.

{ return _p(node)->m_type.is_ref(); }

parent_is_seq()

bool c4::yml::Tree::parent_is_seq ( id_type node ) const

inline

Definition at line 428 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_parent(node), this, node); return is_seq(_p(node)->m_parent); }

parent_is_map()

bool c4::yml::Tree::parent_is_map ( id_type node ) const

inline

Definition at line 429 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_parent(node), this, node); return is_map(_p(node)->m_parent); }

has_anchor() [2/2]

bool c4::yml::Tree::has_anchor ( id_type node, csubstr a ) const

inline

true when the node has an anchor named a

Definition at line 432 of file tree.hpp.

{ return _p(node)->m_key.anchor == a || _p(node)->m_val.anchor == a; }

key_is_null()

bool c4::yml::Tree::key_is_null ( id_type node ) const

inline

true if the node key is empty, or its scalar verifies scalar_is_null().

Warning

the node must verify Tree::has_key() (asserted) (ie must be a member of a map)

See also

https://github.com/biojppm/rapidyaml/issues/413

Definition at line 437 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); NodeData const* C4_RESTRICT n = _p(node); return !n->m_type.is_key_quoted() && (n->m_type.key_is_null() || scalar_is_null(n->m_key.scalar)); }

val_is_null()

bool c4::yml::Tree::val_is_null ( id_type node ) const

inline

true if the node val is empty, or its scalar verifies scalar_is_null().

Warning

the node must verify Tree::has_val() (asserted) (ie must be a scalar / must not be a container)

See also

https://github.com/biojppm/rapidyaml/issues/413

Definition at line 441 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node), this, node); NodeData const* C4_RESTRICT n = _p(node); return !n->m_type.is_val_quoted() && (n->m_type.val_is_null() || scalar_is_null(n->m_val.scalar)); }

is_key_unfiltered()

bool c4::yml::Tree::is_key_unfiltered ( id_type node ) const

inline

true if the key was a scalar requiring filtering and was left unfiltered during the parsing (see ParserOptions)

Definition at line 445 of file tree.hpp.

{ return _p(node)->m_type.is_key_unfiltered(); }

is_val_unfiltered()

bool c4::yml::Tree::is_val_unfiltered ( id_type node ) const

inline

true if the val was a scalar requiring filtering and was left unfiltered during the parsing (see ParserOptions)

Definition at line 448 of file tree.hpp.

{ return _p(node)->m_type.is_val_unfiltered(); }

is_key_anchor()

bool c4::yml::Tree::is_key_anchor ( id_type node ) const

inline

Definition at line 450 of file tree.hpp.

{ return _p(node)->m_type.has_key_anchor(); }

is_val_anchor()

bool c4::yml::Tree::is_val_anchor ( id_type node ) const

inline

Definition at line 451 of file tree.hpp.

{ return _p(node)->m_type.has_val_anchor(); }

is_anchor()

bool c4::yml::Tree::is_anchor ( id_type node ) const

inline

Definition at line 452 of file tree.hpp.

{ return _p(node)->m_type.has_anchor(); }

is_anchor_or_ref()

bool c4::yml::Tree::is_anchor_or_ref ( id_type node ) const

inline

Definition at line 453 of file tree.hpp.

{ return _p(node)->m_type.has_anchor() || _p(node)->m_type.is_ref(); }

is_root()

bool c4::yml::Tree::is_root ( id_type node ) const

inline

Definition at line 462 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, _p(node)->m_parent != NONE || node == 0, this, node); return _p(node)->m_parent == NONE; }

has_parent()

bool c4::yml::Tree::has_parent ( id_type node ) const

inline

Definition at line 464 of file tree.hpp.

{ return _p(node)->m_parent != NONE; }

is_ancestor()

bool c4::yml::Tree::is_ancestor	(	id_type	node,
		id_type	ancestor ) const

true when ancestor is parent or parent of a parent of node

Definition at line 1317 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    id_type p = parent(node);
    while(p != NONE)
    {
        if(p == ancestor)
            return true;
        p = parent(p);
    }
    return false;
}

empty() [2/2]

bool c4::yml::Tree::empty ( id_type node ) const

inline

true when key and val are empty, and has no children

Definition at line 470 of file tree.hpp.

{ return ! has_children(node) && _p(node)->m_key.empty() && (( ! (_p(node)->m_type & VAL)) || _p(node)->m_val.empty()); }

has_child() [1/2]

bool c4::yml::Tree::has_child ( id_type node, id_type ch ) const

inline

true if node has a child with id ch

Definition at line 473 of file tree.hpp.

{ return _p(ch)->m_parent == node; }

has_child() [2/2]

bool c4::yml::Tree::has_child ( id_type node, csubstr key ) const

inline

true if node has a child with key key

Definition at line 475 of file tree.hpp.

{ return find_child(node, key) != NONE; }

has_children()

bool c4::yml::Tree::has_children ( id_type node ) const

inline

true if node has any children key

Definition at line 477 of file tree.hpp.

{ return _p(node)->m_first_child != NONE; }

has_sibling() [1/2]

bool c4::yml::Tree::has_sibling ( id_type node, id_type sib ) const

inline

true if node has a sibling with id sib

Definition at line 480 of file tree.hpp.

{ return _p(node)->m_parent == _p(sib)->m_parent; }

has_sibling() [2/2]

bool c4::yml::Tree::has_sibling ( id_type node, csubstr key ) const

inline

true if one of the node's siblings has the given key

Definition at line 482 of file tree.hpp.

{ return find_sibling(node, key) != NONE; }

has_other_siblings()

bool c4::yml::Tree::has_other_siblings ( id_type node ) const

inline

true if node is not a single child

Definition at line 484 of file tree.hpp.

    {
        NodeData const *n = _p(node);
        if(C4_LIKELY(n->m_parent != NONE))
        {
            n = _p(n->m_parent);
            return n->m_first_child != n->m_last_child;
        }
        return false;
    }

has_siblings()

bool c4::yml::Tree::has_siblings ( id_type )

inlinestatic

Definition at line 495 of file tree.hpp.

{ return true; }

parent()

id_type c4::yml::Tree::parent ( id_type node ) const

inline

Definition at line 504 of file tree.hpp.

{ return _p(node)->m_parent; }

prev_sibling()

id_type c4::yml::Tree::prev_sibling ( id_type node ) const

inline

Definition at line 506 of file tree.hpp.

{ return _p(node)->m_prev_sibling; }

next_sibling()

id_type c4::yml::Tree::next_sibling ( id_type node ) const

inline

Definition at line 507 of file tree.hpp.

{ return _p(node)->m_next_sibling; }

num_children()

id_type c4::yml::Tree::num_children

(

id_type

node

)

const

O(num_children).

Definition at line 1212 of file tree.cpp.

{
    id_type count = 0;
    for(id_type i = first_child(node); i != NONE; i = next_sibling(i))
        ++count;
    return count;
}

child_pos()

id_type c4::yml::Tree::child_pos	(	id_type	node,
		id_type	ch ) const

Definition at line 1232 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    id_type count = 0;
    for(id_type i = first_child(node); i != NONE; i = next_sibling(i))
    {
        if(i == ch)
            return count;
        ++count;
    }
    return NONE;
}

first_child()

id_type c4::yml::Tree::first_child ( id_type node ) const

inline

Definition at line 512 of file tree.hpp.

{ return _p(node)->m_first_child; }

last_child()

id_type c4::yml::Tree::last_child ( id_type node ) const

inline

Definition at line 513 of file tree.hpp.

{ return _p(node)->m_last_child; }

child()

id_type c4::yml::Tree::child	(	id_type	node,
		id_type	pos ) const

Definition at line 1220 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    id_type count = 0;
    for(id_type i = first_child(node); i != NONE; i = next_sibling(i))
    {
        if(count++ == pos)
            return i;
    }
    return NONE;
}

find_child()

id_type c4::yml::Tree::find_child	(	id_type	node,
		csubstr const &	key ) const

Definition at line 1257 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, is_map(node), this, node);
    if(get(node)->m_first_child == NONE)
    {
        _RYML_ASSERT_VISIT_(m_callbacks, _p(node)->m_last_child == NONE, this, node);
        return NONE;
    }
    else
    {
        _RYML_ASSERT_VISIT_(m_callbacks, _p(node)->m_last_child != NONE, this, node);
    }
    for(id_type i = first_child(node); i != NONE; i = next_sibling(i))
    {
        if(_p(i)->m_key.scalar == name)
        {
            return i;
        }
    }
    return NONE;
}

num_siblings()

id_type c4::yml::Tree::num_siblings ( id_type node ) const

inline

O(num_siblings).

counts with this

Definition at line 519 of file tree.hpp.

{ return is_root(node) ? 1 : num_children(_p(node)->m_parent); }

num_other_siblings()

id_type c4::yml::Tree::num_other_siblings ( id_type node ) const

inline

does not count with this

Definition at line 521 of file tree.hpp.

{ id_type ns = num_siblings(node); _RYML_ASSERT_VISIT_(m_callbacks, ns > 0, this, node); return ns-1; }

sibling_pos()

id_type c4::yml::Tree::sibling_pos ( id_type node, id_type sib ) const

inline

Definition at line 522 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks,  ! is_root(node) || node == root_id(), this, node); return child_pos(_p(node)->m_parent, sib); }

first_sibling()

id_type c4::yml::Tree::first_sibling ( id_type node ) const

inline

Definition at line 523 of file tree.hpp.

{ return is_root(node) ? node : _p(_p(node)->m_parent)->m_first_child; }

last_sibling()

id_type c4::yml::Tree::last_sibling ( id_type node ) const

inline

Definition at line 524 of file tree.hpp.

{ return is_root(node) ? node : _p(_p(node)->m_parent)->m_last_child; }

sibling()

id_type c4::yml::Tree::sibling ( id_type node, id_type pos ) const

inline

Definition at line 525 of file tree.hpp.

{ return child(_p(node)->m_parent, pos); }

find_sibling()

id_type c4::yml::Tree::find_sibling ( id_type node, csubstr const & key ) const

inline

Definition at line 526 of file tree.hpp.

{ return find_child(_p(node)->m_parent, key); }

depth_asc()

id_type c4::yml::Tree::depth_asc

(

id_type

node

)

const

O(log(num_tree_nodes)) get the ascending depth of the node: number of levels between root and node.

Definition at line 1305 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    id_type depth = 0;
    while(!is_root(node))
    {
        ++depth;
        node = parent(node);
    }
    return depth;
}

depth_desc()

id_type c4::yml::Tree::depth_desc

(

id_type

node

)

const

O(num_tree_nodes) get the descending depth of the node: number of levels between node and deepest child.

Definition at line 1299 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    return depth_desc_(*this, node);
}

doc()

id_type c4::yml::Tree::doc ( id_type i ) const

inline

gets the i document node index.

requires that the root node is a stream.

Definition at line 532 of file tree.hpp.

{ id_type rid = root_id(); _RYML_ASSERT_VISIT_(m_callbacks, is_stream(rid), this, rid); return child(rid, i); }

ancestor_doc()

id_type c4::yml::Tree::ancestor_doc ( id_type node ) const

inline

get the document which is a parent document of node i, or the root if the tree is not a stream

Definition at line 535 of file tree.hpp.

    {
        NodeData const *nd;
        do
        {
            nd = _p(node);
            if(nd->m_type.is_doc() || nd->m_parent == NONE)
                break;
            node = nd->m_parent;
        } while(nd->m_parent != NONE);
        return node;
    }

is_container_styled()

bool c4::yml::Tree::is_container_styled ( id_type node ) const

inline

Definition at line 555 of file tree.hpp.

{ return _p(node)->m_type.is_container_styled(); }

is_block()

bool c4::yml::Tree::is_block ( id_type node ) const

inline

Definition at line 556 of file tree.hpp.

{ return _p(node)->m_type.is_block(); }

is_flow_sl()

bool c4::yml::Tree::is_flow_sl ( id_type node ) const

inline

Definition at line 557 of file tree.hpp.

{ return _p(node)->m_type.is_flow_sl(); }

is_flow_ml()

bool c4::yml::Tree::is_flow_ml ( id_type node ) const

inline

Definition at line 558 of file tree.hpp.

{ return _p(node)->m_type.is_flow_ml(); }

is_flow()

bool c4::yml::Tree::is_flow ( id_type node ) const

inline

Definition at line 559 of file tree.hpp.

{ return _p(node)->m_type.is_flow(); }

is_key_styled()

bool c4::yml::Tree::is_key_styled ( id_type node ) const

inline

Definition at line 561 of file tree.hpp.

{ return _p(node)->m_type.is_key_styled(); }

is_val_styled()

bool c4::yml::Tree::is_val_styled ( id_type node ) const

inline

Definition at line 562 of file tree.hpp.

{ return _p(node)->m_type.is_val_styled(); }

is_key_literal()

bool c4::yml::Tree::is_key_literal ( id_type node ) const

inline

Definition at line 563 of file tree.hpp.

{ return _p(node)->m_type.is_key_literal(); }

is_val_literal()

bool c4::yml::Tree::is_val_literal ( id_type node ) const

inline

Definition at line 564 of file tree.hpp.

{ return _p(node)->m_type.is_val_literal(); }

is_key_folded()

bool c4::yml::Tree::is_key_folded ( id_type node ) const

inline

Definition at line 565 of file tree.hpp.

{ return _p(node)->m_type.is_key_folded(); }

is_val_folded()

bool c4::yml::Tree::is_val_folded ( id_type node ) const

inline

Definition at line 566 of file tree.hpp.

{ return _p(node)->m_type.is_val_folded(); }

is_key_squo()

bool c4::yml::Tree::is_key_squo ( id_type node ) const

inline

Definition at line 567 of file tree.hpp.

{ return _p(node)->m_type.is_key_squo(); }

is_val_squo()

bool c4::yml::Tree::is_val_squo ( id_type node ) const

inline

Definition at line 568 of file tree.hpp.

{ return _p(node)->m_type.is_val_squo(); }

is_key_dquo()

bool c4::yml::Tree::is_key_dquo ( id_type node ) const

inline

Definition at line 569 of file tree.hpp.

{ return _p(node)->m_type.is_key_dquo(); }

is_val_dquo()

bool c4::yml::Tree::is_val_dquo ( id_type node ) const

inline

Definition at line 570 of file tree.hpp.

{ return _p(node)->m_type.is_val_dquo(); }

is_key_plain()

bool c4::yml::Tree::is_key_plain ( id_type node ) const

inline

Definition at line 571 of file tree.hpp.

{ return _p(node)->m_type.is_key_plain(); }

is_val_plain()

bool c4::yml::Tree::is_val_plain ( id_type node ) const

inline

Definition at line 572 of file tree.hpp.

{ return _p(node)->m_type.is_val_plain(); }

is_key_quoted()

bool c4::yml::Tree::is_key_quoted ( id_type node ) const

inline

Definition at line 573 of file tree.hpp.

{ return _p(node)->m_type.is_key_quoted(); }

is_val_quoted()

bool c4::yml::Tree::is_val_quoted ( id_type node ) const

inline

Definition at line 574 of file tree.hpp.

{ return _p(node)->m_type.is_val_quoted(); }

is_quoted()

bool c4::yml::Tree::is_quoted ( id_type node ) const

inline

Definition at line 575 of file tree.hpp.

{ return _p(node)->m_type.is_quoted(); }

key_style()

NodeType c4::yml::Tree::key_style ( id_type node ) const

inline

Definition at line 577 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); return _p(node)->m_type.key_style(); }

val_style()

NodeType c4::yml::Tree::val_style ( id_type node ) const

inline

Definition at line 578 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node) || is_root(node), this, node); return _p(node)->m_type.val_style(); }

set_container_style()

void c4::yml::Tree::set_container_style ( id_type node, NodeType_e style )

inline

Definition at line 580 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, is_container(node), this, node); _p(node)->m_type.set_container_style(style); }

set_key_style()

void c4::yml::Tree::set_key_style ( id_type node, NodeType_e style )

inline

Definition at line 581 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); _p(node)->m_type.set_key_style(style); }

set_val_style()

void c4::yml::Tree::set_val_style ( id_type node, NodeType_e style )

inline

Definition at line 582 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node), this, node); _p(node)->m_type.set_val_style(style); }

clear_style()

void c4::yml::Tree::clear_style	(	id_type	node,
		bool	recurse = false )

Definition at line 1406 of file tree.cpp.

{
    NodeData *C4_RESTRICT d = _p(node);
    d->m_type.clear_style();
    if(!recurse)
        return;
    for(id_type child = d->m_first_child; child != NONE; child = next_sibling(child))
        clear_style(child, recurse);
}

set_style_conditionally()

void c4::yml::Tree::set_style_conditionally	(	id_type	node,
		NodeType	type_mask,
		NodeType	rem_style_flags,
		NodeType	add_style_flags,
		bool	recurse = false )

Definition at line 1416 of file tree.cpp.

{
    NodeData *C4_RESTRICT d = _p(node);
    if((d->m_type & type_mask) == type_mask)
    {
        d->m_type &= ~(NodeType)rem_style_flags;
        d->m_type |= (NodeType)add_style_flags;
    }
    if(!recurse)
        return;
    for(id_type child = d->m_first_child; child != NONE; child = next_sibling(child))
        set_style_conditionally(child, type_mask, rem_style_flags, add_style_flags, recurse);
}

to_keyval()

void c4::yml::Tree::to_keyval	(	id_type	node,
		csubstr	key,
		csubstr	val,
		type_bits	more_flags = 0 )

Definition at line 1342 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent(node) == NONE || parent_is_map(node), this, node);
    _set_flags(node, KEYVAL|more_flags);
    _p(node)->m_key = key;
    _p(node)->m_val = val;
}

to_map() [1/2]

void c4::yml::Tree::to_map	(	id_type	node,
		csubstr	key,
		type_bits	more_flags = 0 )

Definition at line 1360 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent(node) == NONE || parent_is_map(node), this, node);
    _set_flags(node, KEY|MAP|more_flags);
    _p(node)->m_key = key;
    _p(node)->m_val.clear();
}

to_seq() [1/2]

void c4::yml::Tree::to_seq	(	id_type	node,
		csubstr	key,
		type_bits	more_flags = 0 )

Definition at line 1378 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent(node) == NONE || parent_is_map(node), this, node);
    _set_flags(node, KEY|SEQ|more_flags);
    _p(node)->m_key = key;
    _p(node)->m_val.clear();
}

to_val()

void c4::yml::Tree::to_val	(	id_type	node,
		csubstr	val,
		type_bits	more_flags = 0 )

Definition at line 1333 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent(node) == NONE || ! parent_is_map(node), this, node);
    _set_flags(node, VAL|more_flags);
    _p(node)->m_key.clear();
    _p(node)->m_val = val;
}

to_map() [2/2]

void c4::yml::Tree::to_map	(	id_type	node,
		type_bits	more_flags = 0 )

Definition at line 1351 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent(node) == NONE || ! parent_is_map(node), this, node); // parent must not have children with keys
    _set_flags(node, MAP|more_flags);
    _p(node)->m_key.clear();
    _p(node)->m_val.clear();
}

to_seq() [2/2]

void c4::yml::Tree::to_seq	(	id_type	node,
		type_bits	more_flags = 0 )

Definition at line 1369 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent(node) == NONE || parent_is_seq(node), this, node);
    _set_flags(node, SEQ|more_flags);
    _p(node)->m_key.clear();
    _p(node)->m_val.clear();
}

to_doc()

void c4::yml::Tree::to_doc	(	id_type	node,
		type_bits	more_flags = 0 )

Definition at line 1387 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _set_flags(node, DOC|more_flags);
    _p(node)->m_key.clear();
    _p(node)->m_val.clear();
}

to_stream()

void c4::yml::Tree::to_stream	(	id_type	node,
		type_bits	more_flags = 0 )

Definition at line 1395 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks,  ! has_children(node), this, node);
    _set_flags(node, STREAM|more_flags);
    _p(node)->m_key.clear();
    _p(node)->m_val.clear();
}

set_key()

void c4::yml::Tree::set_key ( id_type node, csubstr key )

inline

Definition at line 606 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); _p(node)->m_key.scalar = key; }

set_val()

void c4::yml::Tree::set_val ( id_type node, csubstr val )

inline

Definition at line 607 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node), this, node); _p(node)->m_val.scalar = val; }

set_key_tag()

void c4::yml::Tree::set_key_tag ( id_type node, csubstr tag )

inline

Definition at line 609 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_key(node), this, node); _p(node)->m_key.tag = tag; _add_flags(node, KEYTAG); }

set_val_tag()

void c4::yml::Tree::set_val_tag ( id_type node, csubstr tag )

inline

Definition at line 610 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, has_val(node) || is_container(node), this, node); _p(node)->m_val.tag = tag; _add_flags(node, VALTAG); }

set_key_anchor()

void c4::yml::Tree::set_key_anchor ( id_type node, csubstr anchor )

inline

Definition at line 612 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks,  ! is_key_ref(node), this, node); _p(node)->m_key.anchor = anchor.triml('&'); _add_flags(node, KEYANCH); }

set_val_anchor()

void c4::yml::Tree::set_val_anchor ( id_type node, csubstr anchor )

inline

Definition at line 613 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks,  ! is_val_ref(node), this, node); _p(node)->m_val.anchor = anchor.triml('&'); _add_flags(node, VALANCH); }

set_key_ref()

void c4::yml::Tree::set_key_ref ( id_type node, csubstr ref )

inline

Definition at line 614 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks,  ! has_key_anchor(node), this, node); NodeData* C4_RESTRICT n = _p(node); n->m_key.set_ref_maybe_replacing_scalar(ref, n->m_type.has_key()); _add_flags(node, KEY|KEYREF); }

set_val_ref()

void c4::yml::Tree::set_val_ref ( id_type node, csubstr ref )

inline

Definition at line 615 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks,  ! has_val_anchor(node), this, node); NodeData* C4_RESTRICT n = _p(node); n->m_val.set_ref_maybe_replacing_scalar(ref, n->m_type.has_val()); _add_flags(node, VAL|VALREF); }

rem_key_anchor()

void c4::yml::Tree::rem_key_anchor ( id_type node )

inline

Definition at line 617 of file tree.hpp.

{ _p(node)->m_key.anchor.clear(); _rem_flags(node, KEYANCH); }

rem_val_anchor()

void c4::yml::Tree::rem_val_anchor ( id_type node )

inline

Definition at line 618 of file tree.hpp.

{ _p(node)->m_val.anchor.clear(); _rem_flags(node, VALANCH); }

rem_key_ref()

void c4::yml::Tree::rem_key_ref ( id_type node )

inline

Definition at line 619 of file tree.hpp.

{ _p(node)->m_key.anchor.clear(); _rem_flags(node, KEYREF); }

rem_val_ref()

void c4::yml::Tree::rem_val_ref ( id_type node )

inline

Definition at line 620 of file tree.hpp.

{ _p(node)->m_val.anchor.clear(); _rem_flags(node, VALREF); }

rem_anchor_ref()

void c4::yml::Tree::rem_anchor_ref ( id_type node )

inline

Definition at line 621 of file tree.hpp.

{ _p(node)->m_key.anchor.clear(); _p(node)->m_val.anchor.clear(); _rem_flags(node, KEYANCH|VALANCH|KEYREF|VALREF); }

reorder()

void c4::yml::Tree::reorder

(

)

reorder the tree in memory so that all the nodes are stored in a linear sequence when visited in depth-first order.

This will invalidate existing ids, since the node id is its position in the tree's node array.

Definition at line 576 of file tree.cpp.

{
    id_type r = root_id();
    _do_reorder(&r, 0);
}

resolve() [1/2]

void c4::yml::Tree::resolve	(	ReferenceResolver *	rr,
		bool	clear_anchors = true )

Resolve references (aliases <- anchors), by forwarding to ReferenceResolver::resolve(); refer to ReferenceResolver::resolve() for further details.

Definition at line 1202 of file tree.cpp.

{
    if(m_size == 0)
        return;
    rr->resolve(this, clear_anchors);
}

resolve() [2/2]

void c4::yml::Tree::resolve

(

bool

clear_anchors = true

)

Resolve references (aliases <- anchors), by forwarding to ReferenceResolver::resolve(); refer to ReferenceResolver::resolve() for further details.

This overload uses a throwaway resolver object.

Definition at line 1194 of file tree.cpp.

{
    if(m_size == 0)
        return;
    ReferenceResolver rr;
    resolve(&rr, clear_anchors);
}

resolve_tags()

void c4::yml::Tree::resolve_tags	(	TagCache &	cache,
		bool	all = true )

Resolve tags in the tree such as "!!str" -> "<tag:yaml.org,2002:str>", "!foo" -> "<!foo>" and custom tags as well, ie tags of the form "!handle!tag" for which there is a corresponding "%TAG" directive.

Parameters

cache	an object of type TagCache to minimize memory usage by avoiding repeated instantiation of the resolved tags in the tree's arena.
all	if true, resolve all tags; if false resolve only custom tags, ie those that have a prefix such as "!m!tag" with a matching "TAG" directive

Definition at line 1555 of file tree.cpp.

{
    if(empty())
        return;
    // try to resolve. While doing so, get the extra size needed for
    // the arena, if the arena is currently too small.
    size_t extra_size = _resolve_tags(this, cache, all);
    // if the arena requires extra size, grow it and then resolve the
    // missing entries
    if(extra_size)
    {
        _c4dbgpf("tag: extrasize={} -- retry! {}->{}", extra_size, m_arena.len, m_arena.len + extra_size);
        _grow_arena(extra_size);
        extra_size = _resolve_tags(this, cache, all);
        _RYML_ASSERT_BASIC_(callbacks(), extra_size == 0);
    }
}

normalize_tags()

void c4::yml::Tree::normalize_tags

(

)

Definition at line 1573 of file tree.cpp.

{
    if(empty())
        return;
    _normalize_tags(this, root_id());
}

normalize_tags_long()

void c4::yml::Tree::normalize_tags_long

(

)

Definition at line 1580 of file tree.cpp.

{
    if(empty())
        return;
    _normalize_tags_long(this, root_id());
}

num_tag_directives()

id_type c4::yml::Tree::num_tag_directives

(

)

const

Definition at line 1436 of file tree.cpp.

{
    return m_tag_directives.size();
}

add_tag_directive()

void c4::yml::Tree::add_tag_directive	(	csubstr	handle,
		csubstr	prefix,
		id_type	id )

Definition at line 1446 of file tree.cpp.

{
    _RYML_CHECK_BASIC_(m_callbacks,
                       !handle.empty()
                       &&
                       !prefix.empty()
                       &&
                       is_valid_tag_handle(handle)
                       &&
                       m_tag_directives.add(handle, prefix, id));
}

clear_tag_directives()

void c4::yml::Tree::clear_tag_directives

(

)

Definition at line 1441 of file tree.cpp.

{
    m_tag_directives.clear();
}

resolve_tag()

size_t c4::yml::Tree::resolve_tag	(	substr	output,
		csubstr	tag,
		id_type	node_id ) const

resolve the given tag, appearing at node_id.

Write the result into output.

Returns

the number of characters required for the resolved tag

Definition at line 1458 of file tree.cpp.

{
    size_t reqsz = 0;
    m_tag_directives.resolve(output, &reqsz, tag, node_id, Location{}, callbacks());
    return reqsz;
}

resolve_tag_sub()

csubstr c4::yml::Tree::resolve_tag_sub ( substr output, csubstr tag, id_type node_id ) const

inline

Wrapper for Tree::resolve_tag(), returning a substring.

Definition at line 686 of file tree.hpp.

    {
        size_t needed = resolve_tag(output, tag, node_id);
        return needed <= output.len ? output.first(needed) : output;
    }

tag_directives()

c4::yml::TagDirectiveRange c4::yml::Tree::tag_directives ( ) const

inline

Definition at line 692 of file tree.hpp.

{ return m_tag_directives.directives(); }

insert_child()

id_type c4::yml::Tree::insert_child ( id_type parent, id_type after )

inline

create and insert a new child of parent.

insert after the (to-be) sibling after, which must be a child of parent. To insert as the first child, set after to NONE

Definition at line 709 of file tree.hpp.

    {
        _RYML_ASSERT_VISIT_(m_callbacks, parent != NONE, this, parent);
        _RYML_ASSERT_VISIT_(m_callbacks, is_container(parent) || is_root(parent), this, parent);
        _RYML_ASSERT_VISIT_(m_callbacks, after == NONE || (_p(after)->m_parent == parent), this, parent);
        id_type child = _claim();
        _set_hierarchy(child, parent, after);
        return child;
    }

prepend_child()

id_type c4::yml::Tree::prepend_child ( id_type parent )

inline

create and insert a node as the first child of parent

Definition at line 719 of file tree.hpp.

{ return insert_child(parent, NONE); }

append_child()

id_type c4::yml::Tree::append_child ( id_type parent )

inline

create and insert a node as the last child of parent

Definition at line 721 of file tree.hpp.

{ return insert_child(parent, _p(parent)->m_last_child); }

_append_child__unprotected()

id_type c4::yml::Tree::_append_child__unprotected ( id_type parent )

inline

Definition at line 722 of file tree.hpp.

    {
        id_type child = _claim();
        _set_hierarchy(child, parent, _p(parent)->m_last_child);
        return child;
    }

insert_sibling()

id_type c4::yml::Tree::insert_sibling ( id_type node, id_type after )

inline

create and insert a new sibling of n. insert after "after"

Definition at line 742 of file tree.hpp.

    {
        return insert_child(_p(node)->m_parent, after);
    }

prepend_sibling()

id_type c4::yml::Tree::prepend_sibling ( id_type node )

inline

create and insert a node as the first node of parent

Definition at line 747 of file tree.hpp.

{ return prepend_child(_p(node)->m_parent); }

append_sibling()

id_type c4::yml::Tree::append_sibling ( id_type node )

inline

Definition at line 748 of file tree.hpp.

{ return append_child(_p(node)->m_parent); }

remove()

void c4::yml::Tree::remove ( id_type node )

inline

remove an entire branch at once: ie remove the children and the node itself

Definition at line 753 of file tree.hpp.

    {
        remove_children(node);
        _release(node);
    }

remove_children()

void c4::yml::Tree::remove_children

(

id_type

node

)

remove all the node's children, but keep the node itself

Definition at line 918 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, get(node) != nullptr, this, node);
    C4_SUPPRESS_WARNING_GCC_PUSH
    #if defined(__GNUC__) && __GNUC__ >= 6
    C4_SUPPRESS_WARNING_GCC("-Wnull-dereference")
    #endif
    id_type ich = get(node)->m_first_child;
    while(ich != NONE)
    {
        remove_children(ich);
        _RYML_ASSERT_VISIT_(m_callbacks, get(ich) != nullptr, this, node);
        id_type next = get(ich)->m_next_sibling;
        _release(ich);
        if(ich == get(node)->m_last_child)
            break;
        ich = next;
    }
    C4_SUPPRESS_WARNING_GCC_POP
}

change_type() [1/2]

bool c4::yml::Tree::change_type	(	id_type	node,
		NodeType	type )

change the type of the node to one of MAP, SEQ or VAL.

type must have one and only one of MAP,SEQ,VAL; type may possibly have KEY, but if it does, then the node must also have KEY. Changing to the same type is a no-op. Otherwise, changing to a different type will initialize the node with an empty value of the desired type: changing to VAL will initialize with a null scalar (~), changing to MAP will initialize with an empty map ({}), and changing to SEQ will initialize with an empty seq ([]).

Definition at line 939 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, type.is_val() || type.is_map() || type.is_seq(), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, type.is_val() + type.is_map() + type.is_seq() == 1, this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, type.has_key() == has_key(node) || (has_key(node) && !type.has_key()), this, node);
    NodeData *d = _p(node);
    if(type.is_map() && is_map(node))
        return false;
    else if(type.is_seq() && is_seq(node))
        return false;
    else if(type.is_val() && is_val(node))
        return false;
    d->m_type = (d->m_type & (~(MAP|SEQ|VAL|CONTAINER_STYLE|KEY_STYLE|VAL_STYLE))) | type;
    remove_children(node);
    return true;
}

change_type() [2/2]

bool c4::yml::Tree::change_type ( id_type node, type_bits type )

inline

Definition at line 773 of file tree.hpp.

    {
        return change_type(node, (NodeType)type);
    }

move() [1/3]

void c4::yml::Tree::move	(	id_type	node,
		id_type	after )

change the node's position in the parent

Definition at line 819 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, node != after, this, node);
    _RYML_ASSERT_VISIT_(m_callbacks,  ! is_root(node), this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, (after == NONE) || (has_sibling(node, after) && has_sibling(after, node)), this, node);
 
    _rem_hierarchy(node);
    _set_hierarchy(node, parent(node), after);
}

move() [2/3]

void c4::yml::Tree::move	(	id_type	node,
		id_type	new_parent,
		id_type	after )

change the node's parent and position

Definition at line 832 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, node != after, this, node);
    _RYML_ASSERT_VISIT_(m_callbacks, new_parent != NONE, this, new_parent);
    _RYML_ASSERT_VISIT_(m_callbacks, new_parent != node, this, new_parent);
    _RYML_ASSERT_VISIT_(m_callbacks, new_parent != after, this, new_parent);
    _RYML_ASSERT_VISIT_(m_callbacks,  ! is_root(node), this, node);
 
    _rem_hierarchy(node);
    _set_hierarchy(node, new_parent, after);
}

move() [3/3]

id_type c4::yml::Tree::move	(	Tree *	src,
		id_type	node,
		id_type	new_parent,
		id_type	after )

change the node's parent and position to a different tree

Returns

the index of the new node in the destination tree

Definition at line 845 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, src != nullptr, this, new_parent);
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, this, new_parent);
    _RYML_ASSERT_VISIT_(m_callbacks, new_parent != NONE, this, new_parent);
    _RYML_ASSERT_VISIT_(m_callbacks, new_parent != after, this, new_parent);
 
    id_type dup = duplicate(src, node, new_parent, after);
    src->remove(node);
    return dup;
}

set_root_as_stream()

void c4::yml::Tree::set_root_as_stream

(

)

ensure the first node is a stream.

Eg, change this tree

DOCMAP MAP KEYVAL KEYVAL SEQ VAL

to

STREAM DOCMAP MAP KEYVAL KEYVAL SEQ VAL

If the root is already a stream, this is a no-op.

Definition at line 857 of file tree.cpp.

{
    id_type root = root_id();
    if(is_stream(root))
        return;
    _c4dbgpf("set_root_as_stream. rootty={}", type(root).type);
    bool empty_root = ((type(root) & (SEQ|MAP|VAL)) == 0);
    for(TagDirective &C4_RESTRICT td : m_tag_directives)
    {
        if(td.doc_id >= m_cap || _p(td.doc_id)->m_parent == NONE)
        {
            _c4dbgpf("tagd[{}]: id={}->NONE", &td-m_tag_directives.m_directives, td.doc_id);
            td.doc_id = NONE;
        }
    }
    // don't use _add_flags() because it's checked and will fail
    id_type next_doc;
    if(!has_children(root))
    {
        if(is_container(root))
        {
            next_doc = append_child(root);
            _copy_props_wo_key(next_doc, root);
            _p(next_doc)->m_type.add(DOC);
        }
        else
        {
            _p(root)->m_type.add(SEQ);
            next_doc = append_child(root);
            _copy_props_wo_key(next_doc, root);
            _p(next_doc)->m_type.add(DOC);
            _p(next_doc)->m_type.rem(SEQ);
        }
    }
    else
    {
        _RYML_ASSERT_VISIT_(m_callbacks, !has_key(root), this, root);
        next_doc = append_child(root);
        _copy_props_wo_key(next_doc, root);
        _add_flags(next_doc, DOC);
        for(id_type prev = NONE, ch = first_child(root), next = next_sibling(ch); ch != NONE; )
        {
            if(ch == next_doc)
                break;
            move(ch, next_doc, prev);
            prev = ch;
            ch = next;
            next = next_sibling(next);
        }
    }
    _p(root)->m_type = STREAM;
    for(TagDirective &C4_RESTRICT td : m_tag_directives)
    {
        id_type id = (td.doc_id != NONE) ? next_doc : (empty_root ? first_child(root) : m_free_head);
        _c4dbgpf("tagd[{}]: id={}->{}", &td-m_tag_directives.m_directives, td.doc_id, id);
        td.doc_id = id;
    }
}

duplicate() [1/2]

id_type c4::yml::Tree::duplicate	(	id_type	node,
		id_type	new_parent,
		id_type	after )

recursively duplicate a node from this tree into a new parent, placing it after one of its children

Returns

the index of the copy

Definition at line 958 of file tree.cpp.

{
    return duplicate(this, node, parent, after);
}

duplicate() [2/2]

id_type c4::yml::Tree::duplicate	(	Tree const *	src,
		id_type	node,
		id_type	new_parent,
		id_type	after )

recursively duplicate a node from a different tree into a new parent, placing it after one of its children

Returns

the index of the copy

Definition at line 963 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, src != nullptr, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent != NONE, this, parent);
    _RYML_ASSERT_VISIT_(m_callbacks,  ! src->is_root(node), src, node);
 
    id_type copy = _claim();
 
    _copy_props(copy, src, node);
    _set_hierarchy(copy, parent, after);
    duplicate_children(src, node, copy, NONE);
 
    return copy;
}

duplicate_children() [1/2]

id_type c4::yml::Tree::duplicate_children	(	id_type	node,
		id_type	parent,
		id_type	after )

recursively duplicate the node's children (but not the node)

Returns

the index of the last duplicated child

Definition at line 980 of file tree.cpp.

{
    return duplicate_children(this, node, parent, after);
}

duplicate_children() [2/2]

id_type c4::yml::Tree::duplicate_children	(	Tree const *	src,
		id_type	node,
		id_type	parent,
		id_type	after )

recursively duplicate the node's children (but not the node), where the node is from a different tree

Returns

the index of the last duplicated child

Definition at line 985 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, src != nullptr, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent != NONE, this, parent);
    _RYML_ASSERT_VISIT_(m_callbacks, after == NONE || has_child(parent, after), this, parent);
 
    id_type prev = after;
    for(id_type i = src->first_child(node); i != NONE; i = src->next_sibling(i))
    {
        prev = duplicate(src, i, parent, prev);
    }
 
    return prev;
}

duplicate_children_no_rep() [1/2]

id_type c4::yml::Tree::duplicate_children_no_rep	(	id_type	node,
		id_type	parent,
		id_type	after )

duplicate the node's children (but not the node) in a new parent, but omit repetitions where a duplicated node has the same key (in maps) or value (in seqs).

If one of the duplicated children has the same key (in maps) or value (in seqs) as one of the parent's children, the one that is placed closest to the end will prevail.

Definition at line 1017 of file tree.cpp.

{
    return duplicate_children_no_rep(this, node, parent, after);
}

duplicate_children_no_rep() [2/2]

id_type c4::yml::Tree::duplicate_children_no_rep	(	Tree const *	src,
		id_type	node,
		id_type	parent,
		id_type	after )

Definition at line 1022 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, parent != NONE, this, parent);
    _RYML_ASSERT_VISIT_(m_callbacks, after == NONE || has_child(parent, after), this, parent);
 
    // don't loop using pointers as there may be a relocation
 
    // find the position where "after" is
    id_type after_pos = NONE;
    if(after != NONE)
    {
        for(id_type i = first_child(parent), icount = 0; i != NONE; ++icount, i = next_sibling(i))
        {
            if(i == after)
            {
                after_pos = icount;
                break;
            }
        }
        _RYML_ASSERT_VISIT_(m_callbacks, after_pos != NONE, this, node);
    }
 
    // for each child to be duplicated...
    id_type prev = after;
    for(id_type i = src->first_child(node); i != NONE; i = src->next_sibling(i))
    {
        _c4dbgpf("duplicate_no_rep: {} -> {}/{}", i, parent, prev);
        _RYML_CHECK_VISIT_(m_callbacks, this != src || (parent != i && !is_ancestor(parent, i)), this, parent);
        if(is_seq(parent))
        {
            _c4dbgpf("duplicate_no_rep: {} is seq", parent);
            prev = duplicate(src, i, parent, prev);
        }
        else
        {
            _c4dbgpf("duplicate_no_rep: {} is map", parent);
            _RYML_ASSERT_VISIT_(m_callbacks, is_map(parent), this, parent);
            // does the parent already have a node with key equal to that of the current duplicate?
            id_type dstnode_dup = NONE, dstnode_dup_pos = NONE;
            {
                csubstr srckey = src->key(i);
                for(id_type j = first_child(parent), jcount = 0; j != NONE; ++jcount, j = next_sibling(j))
                {
                    if(key(j) == srckey)
                    {
                        _c4dbgpf("duplicate_no_rep: found matching key '{}' src={}/{} dst={}/{}", srckey, node, i, parent, j);
                        dstnode_dup = j;
                        dstnode_dup_pos = jcount;
                        break;
                    }
                }
            }
            _c4dbgpf("duplicate_no_rep: dstnode_dup={} dstnode_dup_pos={} after_pos={}", dstnode_dup, dstnode_dup_pos, after_pos);
            if(dstnode_dup == NONE) // there is no repetition; just duplicate
            {
                _c4dbgpf("duplicate_no_rep: no repetition, just duplicate i={} parent={} prev={}", i, parent, prev);
                prev = duplicate(src, i, parent, prev);
            }
            else  // yes, there is a repetition
            {
                if(after_pos != NONE && dstnode_dup_pos <= after_pos)
                {
                    // the dst duplicate is located before the node which will be inserted,
                    // and will be overridden by the duplicate. So replace it.
                    _c4dbgpf("duplicate_no_dstnode_dup: replace {}/{} with {}/{}", parent, dstnode_dup, node, i);
                    if(prev == dstnode_dup)
                        prev = prev_sibling(dstnode_dup);
                    remove(dstnode_dup);
                    prev = duplicate(src, i, parent, prev);
                }
                else if(prev == NONE)
                {
                    _c4dbgpf("duplicate_no_dstnode_dup: {}=prev <- {}", prev, dstnode_dup);
                    // first iteration with prev = after = NONE and dstnode_dupetition
                    prev = dstnode_dup;
                }
                else if(dstnode_dup != prev)
                {
                    // dstnode_dup is located after the node which will be inserted
                    // and overrides it. So move the dstnode_dup into this node's place.
                    _c4dbgpf("duplicate_no_dstnode_dup: move({}, {})", dstnode_dup, prev);
                    move(dstnode_dup, prev);
                    prev = dstnode_dup;
                }
            } // there's a dstnode_dupetition
        }
    }
 
    return prev;
}

duplicate_contents() [1/2]

void c4::yml::Tree::duplicate_contents	(	id_type	node,
		id_type	where )

Definition at line 1002 of file tree.cpp.

{
    duplicate_contents(this, node, where);
}

duplicate_contents() [2/2]

void c4::yml::Tree::duplicate_contents	(	Tree const *	src,
		id_type	node,
		id_type	where )

Definition at line 1007 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, src != nullptr, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, node != NONE, src, node);
    _RYML_ASSERT_VISIT_(m_callbacks, where != NONE, this, where);
    _copy_props_wo_key(where, src, node);
    duplicate_children(src, node, where, last_child(where));
}

merge_with()

void c4::yml::Tree::merge_with	(	Tree const *	src,
		id_type	src_node = NONE,
		id_type	dst_root = NONE )

Definition at line 1117 of file tree.cpp.

{
    _RYML_ASSERT_VISIT_(m_callbacks, src != nullptr, src, src_node);
    if(src_node == NONE)
        src_node = src->root_id();
    if(dst_node == NONE)
        dst_node = root_id();
    _RYML_ASSERT_VISIT_(m_callbacks, src->has_val(src_node) || src->is_seq(src_node) || src->is_map(src_node), src, src_node);
    if(src->has_val(src_node))
    {
        type_bits mask_src = ~STYLE; // keep the existing style if it is already a val
        if( ! has_val(dst_node))
        {
            if(has_children(dst_node))
                remove_children(dst_node);
            mask_src |= VAL_STYLE; // copy the src style
        }
        if(src->is_keyval(src_node))
        {
            _copy_props(dst_node, src, src_node, mask_src);
        }
        else
        {
            _RYML_ASSERT_VISIT_(m_callbacks, src->is_val(src_node), src, src_node);
            _copy_props_wo_key(dst_node, src, src_node, mask_src);
        }
    }
    else if(src->is_seq(src_node))
    {
        if( ! is_seq(dst_node))
        {
            if(has_children(dst_node))
                remove_children(dst_node);
            _clear_type(dst_node);
            if(src->has_key(src_node))
                to_seq(dst_node, src->key(src_node));
            else
                to_seq(dst_node);
            _p(dst_node)->m_type = src->_p(src_node)->m_type;
        }
        for(id_type sch = src->first_child(src_node); sch != NONE; sch = src->next_sibling(sch))
        {
            id_type dch = append_child(dst_node);
            _copy_props_wo_key(dch, src, sch);
            merge_with(src, sch, dch);
        }
    }
    else
    {
        _RYML_ASSERT_VISIT_(m_callbacks, src->is_map(src_node), src, src_node);
        if( ! is_map(dst_node))
        {
            if(has_children(dst_node))
                remove_children(dst_node);
            _clear_type(dst_node);
            if(src->has_key(src_node))
                to_map(dst_node, src->key(src_node));
            else
                to_map(dst_node);
            _p(dst_node)->m_type = src->_p(src_node)->m_type;
        }
        for(id_type sch = src->first_child(src_node); sch != NONE; sch = src->next_sibling(sch))
        {
            id_type dch = find_child(dst_node, src->key(sch));
            if(dch == NONE)
            {
                dch = append_child(dst_node);
                _copy_props(dch, src, sch);
            }
            merge_with(src, sch, dch);
        }
    }
}

location()

Location c4::yml::Tree::location	(	Parser const &	p,
		id_type	node ) const

Get the location of a node from the parse used to parse this tree.

Definition at line 1914 of file tree.cpp.

{
    // try hard to avoid getting the location from a null string.
    Location loc;
    if(_location_from_node(parser, node, &loc, 0))
        return loc;
    return parser.val_location(parser.source().str);
}

arena_size()

size_t c4::yml::Tree::arena_size ( ) const

inline

get the current size of the tree's internal arena

Definition at line 876 of file tree.hpp.

{ return m_arena_pos; }

arena_capacity()

size_t c4::yml::Tree::arena_capacity ( ) const

inline

get the current capacity of the tree's internal arena

Definition at line 878 of file tree.hpp.

{ return m_arena.len; }

arena_slack()

size_t c4::yml::Tree::arena_slack ( ) const

inline

get the current slack of the tree's internal arena

Definition at line 880 of file tree.hpp.

{ _RYML_ASSERT_VISIT_(m_callbacks, m_arena.len >= m_arena_pos, this, NONE); return m_arena.len - m_arena_pos; }

arena_pos()

size_t c4::yml::Tree::arena_pos ( ) const

inline

Definition at line 881 of file tree.hpp.

{ return m_arena_pos; }

arena() [1/2]

csubstr c4::yml::Tree::arena ( ) const

inline

get the current arena

Definition at line 884 of file tree.hpp.

{ return m_arena.first(m_arena_pos); }

arena() [2/2]

substr c4::yml::Tree::arena ( )

inline

get the current arena

Definition at line 886 of file tree.hpp.

{ return m_arena.first(m_arena_pos); } // NOLINT(readability-make-member-function-const)

in_arena()

bool c4::yml::Tree::in_arena ( csubstr s ) const

inline

return true if the given substring is part of the tree's string arena

Definition at line 889 of file tree.hpp.

    {
        return m_arena.is_super(s);
    }

to_arena()

template<class T>

csubstr c4::yml::Tree::to_arena ( T const & a )

inline

serialize the given variable to the tree's arena, growing it as needed to accomodate the serialization.

Note

To customize how the type gets serialized to a string, you can overload c4::to_chars(substr, T const&)

To customize how the type gets serialized to the arena, you can overload serialize_scalar()

Growing the arena may cause relocation of the entire existing arena, and thus change the contents of individual nodes, and thus cost O(numnodes)+O(arenasize). To avoid this cost, ensure that the arena is reserved to an appropriate size using Tree::reserve_arena().

See also

alloc_arena()

Definition at line 911 of file tree.hpp.

    {
        return serialize_to_arena(this, a);
    }

copy_to_arena()

substr c4::yml::Tree::copy_to_arena ( csubstr s )

inline

copy the given string to the tree's arena, growing the arena by the required size.

Note

this method differs from to_arena() in that it returns a mutable substr, and further it does not deal with some corner cases for null/empty strings

Growing the arena may cause relocation of the entire existing arena, and thus change the contents of individual nodes, and thus cost O(numnodes)+O(arenasize). To avoid this cost, ensure that the arena is reserved to an appropriate size before using Tree::reserve_arena()

See also

reserve_arena()

alloc_arena()

Definition at line 932 of file tree.hpp.

    {
        _RYML_ASSERT_VISIT_(m_callbacks, !s.overlaps(m_arena), this, NONE);
        substr cp = alloc_arena(s.len);
        _RYML_ASSERT_VISIT_(m_callbacks, cp.len == s.len, this, NONE);
        _RYML_ASSERT_VISIT_(m_callbacks, !s.overlaps(cp), this, NONE);
        #if (!defined(__clang__)) && (defined(__GNUC__) && __GNUC__ >= 10)
        C4_SUPPRESS_WARNING_GCC_PUSH
        C4_SUPPRESS_WARNING_GCC("-Wstringop-overflow=") // no need for terminating \0
        C4_SUPPRESS_WARNING_GCC("-Wrestrict") // there's an assert to ensure no violation of restrict behavior
        #endif
        if(s.len)
            memcpy(cp.str, s.str, s.len);
        #if (!defined(__clang__)) && (defined(__GNUC__) && __GNUC__ >= 10)
        C4_SUPPRESS_WARNING_GCC_POP
        #endif
        return cp;
    }

alloc_arena()

substr c4::yml::Tree::alloc_arena ( size_t sz )

inline

grow the tree's string arena by the given size and return a substr of the added portion

Note

Growing the arena may cause relocation of the entire existing arena, and thus change the contents of individual nodes, and thus cost O(numnodes)+O(arenasize). To avoid this cost, ensure that the arena is reserved to an appropriate size using .reserve_arena().

See also

reserve_arena()

Definition at line 961 of file tree.hpp.

    {
        if(sz > arena_slack())
            _grow_arena(sz - arena_slack());
        substr s = _request_span(sz);
        return s;
    }

reserve_arena()

void c4::yml::Tree::reserve_arena ( size_t arena_cap = RYML_DEFAULT_TREE_ARENA_CAPACITY )

inline

ensure the tree's internal string arena is at least the given capacity

Warning

This operation may be expensive, with a potential complexity of O(numNodes)+O(arenasize).

Growing the arena may cause relocation of the entire existing arena, and thus change the contents of individual nodes.

Definition at line 973 of file tree.hpp.

    {
        if(arena_cap > m_arena.len)
        {
            substr buf;
            buf.str = _RYML_CB_ALLOC(m_callbacks, char, arena_cap);
            buf.len = arena_cap;
            if(m_arena.str)
            {
                _RYML_ASSERT_VISIT_(m_callbacks, m_arena.len >= 0, this, NONE);
                _relocate(buf); // does a memcpy and changes nodes using the arena
                _RYML_CB_FREE(m_callbacks, m_arena.str, char, m_arena.len);
            }
            m_arena = buf;
        }
    }

lookup_path()

Tree::lookup_result c4::yml::Tree::lookup_path	(	csubstr	path,
		id_type	start = NONE ) const

for example foo.bar[0].baz

Definition at line 1610 of file tree.cpp.

{
    if(start == NONE)
        start = root_id();
    lookup_result r(path, start);
    if(path.empty())
        return r;
    _lookup_path(&r);
    if(r.target == NONE && r.closest == start)
        r.closest = NONE;
    return r;
}

lookup_path_or_modify() [1/2]

id_type c4::yml::Tree::lookup_path_or_modify	(	csubstr	default_value,
		csubstr	path,
		id_type	start = NONE )

defaulted lookup: lookup path; if the lookup fails, recursively modify the tree so that the corresponding lookup_path() would return the default value.

See also

lookup_path()

Definition at line 1623 of file tree.cpp.

{
    id_type target = _lookup_path_or_create(path, start);
    if(parent_is_map(target))
        to_keyval(target, key(target), default_value);
    else
        to_val(target, default_value);
    return target;
}

lookup_path_or_modify() [2/2]

id_type c4::yml::Tree::lookup_path_or_modify	(	Tree const *	src,
		id_type	src_node,
		csubstr	path,
		id_type	start = NONE )

defaulted lookup: lookup path; if the lookup fails, recursively modify the tree so that the corresponding lookup_path() would return the branch src_node (from the tree src).

See also

lookup_path()

Definition at line 1633 of file tree.cpp.

{
    id_type target = _lookup_path_or_create(path, start);
    merge_with(src, src_node, target);
    return target;
}

_claim()

id_type c4::yml::Tree::_claim

(

)

Definition at line 414 of file tree.cpp.

{
    if(m_free_head == NONE || m_buf == nullptr)
    {
        id_type sz = 2 * m_cap;
        sz = sz ? sz : 16;
        reserve(sz);
        _RYML_ASSERT_VISIT_(m_callbacks, m_free_head != NONE, this, NONE);
    }
 
    _RYML_ASSERT_VISIT_(m_callbacks, m_size < m_cap, this, NONE);
    _RYML_ASSERT_VISIT_(m_callbacks, m_free_head >= 0 && m_free_head < m_cap, this, NONE);
 
    id_type ichild = m_free_head;
    NodeData *child = m_buf + ichild;
 
    ++m_size;
    m_free_head = child->m_next_sibling;
    if(m_free_head == NONE)
    {
        m_free_tail = NONE;
        _RYML_ASSERT_VISIT_(m_callbacks, m_size == m_cap, this, NONE);
    }
 
    _clear(ichild);
 
    return ichild;
}

Member Data Documentation

m_buf

NodeData* c4::yml::Tree::m_buf

Definition at line 1331 of file tree.hpp.

m_cap

id_type c4::yml::Tree::m_cap

Definition at line 1332 of file tree.hpp.

m_size

id_type c4::yml::Tree::m_size

Definition at line 1333 of file tree.hpp.

m_free_head

id_type c4::yml::Tree::m_free_head

Definition at line 1335 of file tree.hpp.

m_free_tail

id_type c4::yml::Tree::m_free_tail

Definition at line 1336 of file tree.hpp.

m_arena

substr c4::yml::Tree::m_arena

Definition at line 1338 of file tree.hpp.

m_arena_pos

size_t c4::yml::Tree::m_arena_pos

Definition at line 1339 of file tree.hpp.

m_callbacks

Callbacks c4::yml::Tree::m_callbacks

Definition at line 1341 of file tree.hpp.

m_tag_directives

TagDirectives c4::yml::Tree::m_tag_directives

Definition at line 1343 of file tree.hpp.

---

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

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