rapidyaml: c4::yml::Tree Class Reference

size_t m_arena_pos

Definition: tree.hpp:1684

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

inline

Query for zero size.

The tree can be empty only when constructed with explicitly zero-capacity.

Definition at line 343 of file tree.hpp.

Referenced by c4::yml::Emitter< Writer >::emit_as(), normalize_tags(), normalize_tags_long(), c4::yml::operator<<(), and resolve_tags().

343 { return m_size == 0; }

id_type m_size

Definition: tree.hpp:1678

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

inline

Definition at line 345 of file tree.hpp.

Referenced by sample_quick_overview().

345 { return m_size; }

id_type m_size

Definition: tree.hpp:1678

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

inline

Definition at line 346 of file tree.hpp.

Referenced by c4::yml::Emitter< Writer >::emit_as(), and c4::yml::EventHandlerTree::reset().

346 { return m_cap; }

id_type m_cap

Definition: tree.hpp:1677

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

inline

Definition at line 347 of file tree.hpp.

347 { RYML_ASSERT_BASIC_(m_cap >= m_size); return m_cap - m_size; }

id_type m_size

Definition: tree.hpp:1678

id_type m_cap

Definition: tree.hpp:1677

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

inline

Definition at line 349 of file tree.hpp.

Referenced by c4::yml::Emitter< Writer >::emit_as(), c4::yml::EventHandlerTree::reset(), resolve_tag(), resolve_tags(), sample_docs(), sample_error_visit_location(), and sample_quick_overview().

349 { return m_callbacks; }

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 350 of file tree.hpp.

350 { m_callbacks = cb; }

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

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

Definition at line 361 of file tree.hpp.

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

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

inline

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

Definition at line 370 of file tree.hpp.

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

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 380 of file tree.hpp.

Referenced by change_type(), clear_style(), find_child(), merge_with(), c4::yml::read(), c4::yml::read_key(), set_root_as_stream(), and set_style_conditionally().

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

an index to none

Definition: common.hpp:131

c4::yml::Tree::m_buf

NodeData * m_buf

Definition: tree.hpp:1676

Callbacks m_callbacks

Definition: tree.hpp:1686

id_type m_cap

Definition: tree.hpp:1677

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 383 of file tree.hpp.

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

an index to none

Definition: common.hpp:131

c4::yml::Tree::m_buf

NodeData * m_buf

Definition: tree.hpp:1676

Callbacks m_callbacks

Definition: tree.hpp:1686

id_type m_cap

Definition: tree.hpp:1677

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

inline

Get the id of the root node. The tree must not be empty. The tree can be empty only when constructed with explicitly zero-capacity.

Definition at line 386 of file tree.hpp.

Referenced by c4::yml::Emitter< Writer >::emit_as(), lookup_path(), merge_with(), normalize_tags(), normalize_tags_long(), c4::yml::operator<<(), c4::yml::parse_in_arena(), c4::yml::parse_in_place(), c4::yml::parse_json_in_arena(), c4::yml::parse_json_in_place(), reorder(), sample_docs(), sample_emit_to_container(), sample_emit_to_file(), sample_quick_overview(), sample_user_container_types(), and set_root_as_stream().

386 { RYML_ASSERT_VISIT_CB_(m_callbacks, m_size > 0, this, id_type(0)); return 0; }

id_type m_size

Definition: tree.hpp:1678

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:124

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Get the id of the root node, or NONE if the tree is empty.

Definition at line 388 of file tree.hpp.

Referenced by c4::yml::emitrs_json(), and c4::yml::emitrs_yaml().

388 { return m_size ? 0 : id_type(NONE); }

an index to none

Definition: common.hpp:131

id_type m_size

Definition: tree.hpp:1678

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:124

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

inline

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

Definition at line 392 of file tree.hpp.

Referenced by sample_error_visit(), sample_error_visit_location(), sample_serialize_basic(), and set_root_as_stream().

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

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_CB_(m_callbacks, id != NONE && id >= 0 && id < m_cap, this, id);
     return NodeRef(this, id);
 }

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_CB_(m_callbacks, id != NONE && id >= 0 && id < m_cap, this, id);
     return ConstNodeRef(this, id);
 }

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_CB_(m_callbacks, id != NONE && id >= 0 && id < m_cap, this, id);
     return ConstNodeRef(this, id);
 }

NodeRef c4::yml::Tree::rootref ( )

Get the root as a NodeRef . Note that a non-const Tree implicitly converts to NodeRef.

Definition at line 56 of file tree.cpp.

Referenced by sample_anchors_and_aliases_create(), sample_base64(), sample_docs(), sample_empty_null_values(), sample_float_precision(), sample_json(), sample_location_tracking(), sample_parse_reuse_tree(), sample_parse_style(), sample_quick_overview(), sample_std_types(), sample_style(), sample_style_flow_formatting(), sample_style_flow_ml_indent(), sample_tags(), and sample_tree_arena().

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

ConstNodeRef c4::yml::Tree::rootref ( ) const

Get the root as a ConstNodeRef . Note that Tree implicitly converts to ConstNodeRef.

Definition at line 60 of file tree.cpp.

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

ConstNodeRef c4::yml::Tree::crootref ( ) const

Get the root as a ConstNodeRef . Note that Tree implicitly converts to ConstNodeRef.

Definition at line 65 of file tree.cpp.

Referenced by sample_iterate_tree(), sample_parse_in_arena(), sample_parse_in_place(), and sample_parse_reuse_tree().

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

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.

Referenced by sample_docs().

 {
     return ref(doc(i));
 }

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 ConstNodeRef(this, doc(i));
 }

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 ConstNodeRef(this, doc(i));
 }

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];
 }

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 crootref()[key];
 }

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 within the parent

Definition at line 95 of file tree.cpp.

 {
     return rootref()[i];
 }

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 within the parent

Definition at line 99 of file tree.cpp.

 {
     return crootref()[i];
 }

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

inline

Definition at line 452 of file tree.hpp.

Referenced by change_type(), duplicate_children_no_rep(), merge_with(), and set_root_as_stream().

452 { return _p(node)->m_type; }

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 454 of file tree.hpp.

Referenced by duplicate_children_no_rep(), merge_with(), sample_quick_overview(), and sample_tree_arena().

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeScalar::scalar

bool has_key(id_type node) const

Definition: tree.hpp:482

csubstr scalar

Definition: tree.hpp:172

Callbacks m_callbacks

Definition: tree.hpp:1686

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 455 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

csubstr tag

Definition: tree.hpp:171

c4::yml::Tree::has_key_tag

Callbacks m_callbacks

Definition: tree.hpp:1686

bool has_key_tag(id_type node) const

Definition: tree.hpp:486

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 456 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

c4::yml::Tree::is_key_ref

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_key_ref(id_type node) const

Definition: tree.hpp:491

Callbacks m_callbacks

Definition: tree.hpp:1686

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 457 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

c4::yml::Tree::has_key_anchor

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key_anchor(id_type node) const

Definition: tree.hpp:488

Callbacks m_callbacks

Definition: tree.hpp:1686

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 458 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key(id_type node) const

Definition: tree.hpp:482

Callbacks m_callbacks

Definition: tree.hpp:1686

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 460 of file tree.hpp.

Referenced by c4::yml::read(), sample_base64(), sample_docs(), and sample_tree_arena().

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

bool has_val(id_type node) const

Definition: tree.hpp:483

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeScalar::scalar

NodeScalar m_val

Definition: tree.hpp:292

csubstr scalar

Definition: tree.hpp:172

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 461 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeScalar m_val

Definition: tree.hpp:292

csubstr tag

Definition: tree.hpp:171

c4::yml::Tree::has_val_tag

Callbacks m_callbacks

Definition: tree.hpp:1686

bool has_val_tag(id_type node) const

Definition: tree.hpp:487

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

inline

Definition at line 462 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

c4::yml::Tree::is_val_ref

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_ref(id_type node) const

Definition: tree.hpp:492

NodeScalar m_val

Definition: tree.hpp:292

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 463 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

c4::yml::Tree::has_val_anchor

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_val_anchor(id_type node) const

Definition: tree.hpp:489

NodeScalar m_val

Definition: tree.hpp:292

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 464 of file tree.hpp.

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

bool has_val(id_type node) const

Definition: tree.hpp:483

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeScalar m_val

Definition: tree.hpp:292

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 473 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bits

type_bits bits

Definition: node_type.cpp:70

c4::yml::NodeType::has_any

NodeType m_type

Definition: tree.hpp:289

bool has_any(type_bits t) const noexcept

Definition: node_type.hpp:244

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

inline

Definition at line 474 of file tree.hpp.

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

c4::yml::NodeType::has_all

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bits

type_bits bits

Definition: node_type.cpp:70

bool has_all(type_bits t) const noexcept

Definition: node_type.hpp:245

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 475 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bits

type_bits bits

Definition: node_type.cpp:70

c4::yml::NodeType::has_none

NodeType m_type

Definition: tree.hpp:289

bool has_none(type_bits t) const noexcept

Definition: node_type.hpp:246

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

inline

Definition at line 477 of file tree.hpp.

Referenced by sample_docs().

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

c4::yml::NodeType::is_stream

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_stream() const noexcept

Definition: node_type.hpp:291

c4::yml::NodeType::is_doc

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 478 of file tree.hpp.

Referenced by sample_docs().

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

bool is_doc() const noexcept

Definition: node_type.hpp:292

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 479 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_container

NodeType m_type

Definition: tree.hpp:289

bool is_container() const noexcept

Definition: node_type.hpp:293

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

inline

Definition at line 480 of file tree.hpp.

Referenced by c4::yml::read(), read(), c4::yml::EventHandlerTree::reset(), sample_docs(), and sample_quick_overview().

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

c4::yml::NodeType::is_map

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_map() const noexcept

Definition: node_type.hpp:294

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 481 of file tree.hpp.

Referenced by c4::yml::read(), read(), sample_docs(), and sample_quick_overview().

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

c4::yml::NodeType::is_seq

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_seq() const noexcept

Definition: node_type.hpp:295

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 482 of file tree.hpp.

Referenced by merge_with(), and c4::yml::EventHandlerTree::reset().

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_key

NodeType m_type

Definition: tree.hpp:289

bool has_key() const noexcept

Definition: node_type.hpp:296

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

inline

Definition at line 483 of file tree.hpp.

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

c4::yml::NodeType::has_val

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_val() const noexcept

Definition: node_type.hpp:297

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 484 of file tree.hpp.

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

c4::yml::NodeType::is_val

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val() const noexcept

Definition: node_type.hpp:298

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 485 of file tree.hpp.

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

c4::yml::NodeType::is_keyval

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_keyval() const noexcept

Definition: node_type.hpp:299

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 486 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_key_tag

NodeType m_type

Definition: tree.hpp:289

bool has_key_tag() const noexcept

Definition: node_type.hpp:302

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

inline

Definition at line 487 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_val_tag

NodeType m_type

Definition: tree.hpp:289

bool has_val_tag() const noexcept

Definition: node_type.hpp:303

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

inline

Definition at line 488 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_key_anchor

NodeType m_type

Definition: tree.hpp:289

bool has_key_anchor() const noexcept

Definition: node_type.hpp:304

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

inline

Definition at line 489 of file tree.hpp.

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

c4::yml::NodeType::has_val_anchor

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_val_anchor() const noexcept

Definition: node_type.hpp:305

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 490 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_anchor

NodeType m_type

Definition: tree.hpp:289

bool has_anchor() const noexcept

Definition: node_type.hpp:306

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

inline

Definition at line 491 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_key_ref

NodeType m_type

Definition: tree.hpp:289

bool is_key_ref() const noexcept

Definition: node_type.hpp:307

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

inline

Definition at line 492 of file tree.hpp.

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

c4::yml::NodeType::is_val_ref

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_ref() const noexcept

Definition: node_type.hpp:308

c4::yml::NodeType::is_ref

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 493 of file tree.hpp.

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

bool is_ref() const noexcept

Definition: node_type.hpp:309

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 495 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::Tree::is_seq

bool is_seq(id_type node) const

Definition: tree.hpp:481

c4::yml::Tree::has_parent

Callbacks m_callbacks

Definition: tree.hpp:1686

bool has_parent(id_type node) const

Definition: tree.hpp:531

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

inline

Definition at line 496 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::Tree::is_map

bool is_map(id_type node) const

Definition: tree.hpp:480

c4::yml::Tree::has_parent

Callbacks m_callbacks

Definition: tree.hpp:1686

bool has_parent(id_type node) const

Definition: tree.hpp:531

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 499 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeScalar m_val

Definition: tree.hpp:292

NodeScalar m_key

Definition: tree.hpp:291

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 504 of file tree.hpp.

504 { RYML_ASSERT_VISIT_CB_(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)); }

c4::yml::scalar_is_null

bool scalar_is_null(csubstr s) noexcept

YAML-sense query of nullity.

Definition: scalar_charconv.hpp:28

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key(id_type node) const

Definition: tree.hpp:482

Callbacks m_callbacks

Definition: tree.hpp:1686

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 508 of file tree.hpp.

508 { RYML_ASSERT_VISIT_CB_(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)); }

c4::yml::scalar_is_null

bool scalar_is_null(csubstr s) noexcept

YAML-sense query of nullity.

Definition: scalar_charconv.hpp:28

bool has_val(id_type node) const

Definition: tree.hpp:483

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

Callbacks m_callbacks

Definition: tree.hpp:1686

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 512 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_key_unfiltered

NodeType m_type

Definition: tree.hpp:289

bool is_key_unfiltered() const noexcept

Definition: node_type.hpp:311

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 515 of file tree.hpp.

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

c4::yml::NodeType::is_val_unfiltered

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_unfiltered() const noexcept

Definition: node_type.hpp:312

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 517 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_key_anchor

NodeType m_type

Definition: tree.hpp:289

bool has_key_anchor() const noexcept

Definition: node_type.hpp:304

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

inline

Definition at line 518 of file tree.hpp.

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

c4::yml::NodeType::has_val_anchor

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_val_anchor() const noexcept

Definition: node_type.hpp:305

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 519 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_anchor

NodeType m_type

Definition: tree.hpp:289

bool has_anchor() const noexcept

Definition: node_type.hpp:306

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

inline

Definition at line 520 of file tree.hpp.

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

c4::yml::NodeType::is_ref

bool is_ref() const noexcept

Definition: node_type.hpp:309

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::has_anchor

NodeType m_type

Definition: tree.hpp:289

bool has_anchor() const noexcept

Definition: node_type.hpp:306

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

inline

Definition at line 529 of file tree.hpp.

Referenced by depth_asc(), duplicate(), move(), c4::yml::EventHandlerTree::reset(), and sample_docs().

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

an index to none

Definition: common.hpp:131

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

Callbacks m_callbacks

Definition: tree.hpp:1686

id_type m_parent

Definition: tree.hpp:294

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

inline

Definition at line 531 of file tree.hpp.

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

an index to none

Definition: common.hpp:131

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_parent

Definition: tree.hpp:294

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 1304 of file tree.cpp.

Referenced by duplicate_children_no_rep().

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

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

inline

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

Definition at line 537 of file tree.hpp.

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

c4::yml::Tree::has_children

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::VAL

a scalar: has a scalar (ie string) value, possibly empty. must be a leaf node, and cannot be MAP or S...

Definition: node_type.hpp:34

bool has_children(id_type node) const

true if node has any children

Definition: tree.hpp:544

c4::yml::NodeScalar::empty

bool empty() const noexcept

Definition: tree.hpp:200

NodeType m_type

Definition: tree.hpp:289

NodeScalar m_val

Definition: tree.hpp:292

NodeScalar m_key

Definition: tree.hpp:291

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 540 of file tree.hpp.

Referenced by duplicate_children(), and duplicate_children_no_rep().

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_parent

Definition: tree.hpp:294

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 542 of file tree.hpp.

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

csubstr const & key(id_type node) const

Definition: tree.hpp:454

c4::yml::Tree::find_child

an index to none

Definition: common.hpp:131

id_type find_child(id_type node, csubstr const &key) const

find child by name, or NONE if no child is found with this key like Tree::child(), but return a ReadResult with the status

Definition: tree.cpp:1249

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

inline

true if node has any children

Definition at line 544 of file tree.hpp.

Referenced by merge_with(), and set_root_as_stream().

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

an index to none

Definition: common.hpp:131

c4::yml::NodeData::m_first_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_first_child

Definition: tree.hpp:295

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 547 of file tree.hpp.

Referenced by move().

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_parent

Definition: tree.hpp:294

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 549 of file tree.hpp.

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

csubstr const & key(id_type node) const

Definition: tree.hpp:454

c4::yml::Tree::find_sibling

an index to none

Definition: common.hpp:131

id_type find_sibling(id_type node, csubstr const &key) const

Definition: tree.hpp:595

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

inline

true if node is not a single child

Definition at line 551 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;
     }

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

inline

Definition at line 569 of file tree.hpp.

Referenced by depth_asc(), duplicate_children_no_rep(), is_ancestor(), move(), and c4::yml::EventHandlerTree::reset().

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_parent

Definition: tree.hpp:294

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

inline

Definition at line 571 of file tree.hpp.

Referenced by duplicate_children_no_rep().

571 { return _p(node)->m_prev_sibling; }

c4::yml::NodeData::m_prev_sibling

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_prev_sibling

Definition: tree.hpp:298

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

inline

Definition at line 572 of file tree.hpp.

Referenced by child(), child_pos(), duplicate_children(), duplicate_children_no_rep(), find_child(), merge_with(), num_children(), c4::yml::read(), read(), sample_docs(), sample_quick_overview(), and set_root_as_stream().

572 { return _p(node)->m_next_sibling; }

c4::yml::NodeData::m_next_sibling

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_next_sibling

Definition: tree.hpp:297

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

O(num_children)

Definition at line 1216 of file tree.cpp.

Referenced by sample_docs(), and sample_user_container_types().

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

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

Definition at line 1224 of file tree.cpp.

 {
     RYML_ASSERT_VISIT_CB_(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;
 }

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

inline

Definition at line 577 of file tree.hpp.

Referenced by child(), child_pos(), duplicate_children(), duplicate_children_no_rep(), find_child(), merge_with(), num_children(), c4::yml::read(), read(), sample_docs(), sample_quick_overview(), and set_root_as_stream().

577 { return _p(node)->m_first_child; }

c4::yml::NodeData::m_first_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_first_child

Definition: tree.hpp:295

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

inline

Definition at line 578 of file tree.hpp.

Referenced by duplicate_contents().

578 { return _p(node)->m_last_child; }

c4::yml::NodeData::m_last_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_last_child

Definition: tree.hpp:296

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

find child by position, or NONE if there are less than pos children posi

Definition at line 1237 of file tree.cpp.

Referenced by sample_docs().

 {
     RYML_ASSERT_VISIT_CB_(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;
 }

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

find child by name, or NONE if no child is found with this key like Tree::child(), but return a ReadResult with the status

Definition at line 1249 of file tree.cpp.

Referenced by merge_with(), sample_docs(), and sample_quick_overview().

 {
     C4_SUPPRESS_WARNING_PUSH
     #if defined(__clang__)
     #elif defined(__GNUC__)
     #   if __GNUC__ >= 6
             C4_SUPPRESS_WARNING_GCC("-Wnull-dereference")
     #   endif
     #   if __GNUC__ > 9
             C4_SUPPRESS_WARNING_GCC("-Wanalyzer-null-dereference")
     #   endif
     #endif
     RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE, this, node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, _p(node)->m_type.m_bits & MAP, 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;
     C4_SUPPRESS_WARNING_POP
 }

ReadResult c4::yml::Tree::child_r	(	id_type	node,
		id_type	pos,
		id_type *	child_id
	)		const

inline

Definition at line 582 of file tree.hpp.

582 { return ReadResult(node, *child_id = child(node, pos)); }

c4::yml::Tree::child

id_type child(id_type node, id_type pos) const

find child by position, or NONE if there are less than pos children posi

Definition: tree.cpp:1237

ReadResult c4::yml::Tree::find_child_r	(	id_type	node,
		csubstr const &	key,
		id_type *	child_id
	)		const

inline

like Tree::find_child(), but return a ReadResult with the status

Definition at line 584 of file tree.hpp.

584 { return ReadResult(node, *child_id = find_child(node, key)); }

c4::yml::Tree::find_child

csubstr const & key(id_type node) const

Definition: tree.hpp:454

id_type find_child(id_type node, csubstr const &key) const

find child by name, or NONE if no child is found with this key like Tree::child(), but return a ReadResult with the status

Definition: tree.cpp:1249

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

inline

O(num_siblings)

counts with this

Definition at line 588 of file tree.hpp.

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

c4::yml::Tree::num_children

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type num_children(id_type node) const

O(num_children)

Definition: tree.cpp:1216

c4::yml::Tree::num_siblings

bool is_root(id_type node) const

Definition: tree.hpp:529

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

inline

does not count with this

Definition at line 590 of file tree.hpp.

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

id_type num_siblings(id_type node) const

O(num_siblings)

Definition: tree.hpp:588

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:124

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 591 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::Tree::root_id

id_type root_id() const

Get the id of the root node. The tree must not be empty. The tree can be empty only when constructed ...

Definition: tree.hpp:386

c4::yml::Tree::child_pos

id_type child_pos(id_type node, id_type ch) const

Definition: tree.cpp:1224

Callbacks m_callbacks

Definition: tree.hpp:1686

bool is_root(id_type node) const

Definition: tree.hpp:529

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

inline

Definition at line 592 of file tree.hpp.

Referenced by sample_quick_overview().

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

c4::yml::NodeData::m_first_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_first_child

Definition: tree.hpp:295

bool is_root(id_type node) const

Definition: tree.hpp:529

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

inline

Definition at line 593 of file tree.hpp.

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

c4::yml::NodeData::m_last_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type m_last_child

Definition: tree.hpp:296

bool is_root(id_type node) const

Definition: tree.hpp:529

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

inline

Definition at line 594 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::Tree::child

id_type child(id_type node, id_type pos) const

find child by position, or NONE if there are less than pos children posi

Definition: tree.cpp:1237

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

inline

Definition at line 595 of file tree.hpp.

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

csubstr const & key(id_type node) const

Definition: tree.hpp:454

c4::yml::Tree::find_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type find_child(id_type node, csubstr const &key) const

find child by name, or NONE if no child is found with this key like Tree::child(), but return a ReadResult with the status

Definition: tree.cpp:1249

ReadResult c4::yml::Tree::sibling_r	(	id_type	node,
		id_type	pos,
		id_type *	sibling_id
	)		const

inline

like Tree::sibling(), but return a ReadResult with the status

Definition at line 597 of file tree.hpp.

597 { return child_r(_p(node)->m_parent, pos, sibling_id); }

c4::yml::Tree::child_r

ReadResult child_r(id_type node, id_type pos, id_type *child_id) const

Definition: tree.hpp:582

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

ReadResult c4::yml::Tree::find_sibling_r	(	id_type	node,
		csubstr const &	key,
		id_type *	sibling_id
	)		const

inline

like Tree::find_sibling(), but return a ReadResult if with the status

Definition at line 599 of file tree.hpp.

599 { return find_child_r(_p(node)->m_parent, key, sibling_id); }

csubstr const & key(id_type node) const

Definition: tree.hpp:454

c4::yml::Tree::find_child_r

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

ReadResult find_child_r(id_type node, csubstr const &key, id_type *child_id) const

like Tree::find_child(), but return a ReadResult with the status

Definition: tree.hpp:584

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 1292 of file tree.cpp.

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

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 1286 of file tree.cpp.

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

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 605 of file tree.hpp.

Referenced by sample_docs().

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

c4::yml::Tree::is_stream

bool is_stream(id_type node) const

Definition: tree.hpp:477

c4::yml::Tree::root_id

id_type root_id() const

Get the id of the root node. The tree must not be empty. The tree can be empty only when constructed ...

Definition: tree.hpp:386

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:124

c4::yml::Tree::child

id_type child(id_type node, id_type pos) const

find child by position, or NONE if there are less than pos children posi

Definition: tree.cpp:1237

Callbacks m_callbacks

Definition: tree.hpp:1686

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 608 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;
     }

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

inline

Definition at line 628 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_container_styled

NodeType m_type

Definition: tree.hpp:289

bool is_container_styled() const noexcept

Definition: node_type.hpp:321

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

inline

Definition at line 629 of file tree.hpp.

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

c4::yml::NodeType::is_block

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_block() const noexcept

Definition: node_type.hpp:322

c4::yml::NodeType::is_flow_sl

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 630 of file tree.hpp.

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

bool is_flow_sl() const noexcept

Definition: node_type.hpp:323

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 632 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_flow_ml1

NodeType m_type

Definition: tree.hpp:289

bool is_flow_ml1() const noexcept

Definition: node_type.hpp:324

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

inline

Definition at line 633 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_flow_ml1

NodeType m_type

Definition: tree.hpp:289

bool is_flow_ml1() const noexcept

Definition: node_type.hpp:324

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

inline

Definition at line 634 of file tree.hpp.

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

c4::yml::NodeType::is_flow_mln

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_flow_mln() const noexcept

Definition: node_type.hpp:325

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 635 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_flow_mlx

NodeType m_type

Definition: tree.hpp:289

bool is_flow_mlx() const noexcept

Definition: node_type.hpp:326

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

inline

Definition at line 636 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_flow

NodeType m_type

Definition: tree.hpp:289

bool is_flow() const noexcept

Definition: node_type.hpp:327

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

inline

Definition at line 637 of file tree.hpp.

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

c4::yml::NodeType::has_flow_space

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_flow_space() const noexcept

Definition: node_type.hpp:328

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 639 of file tree.hpp.

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

c4::yml::NodeType::is_key_styled

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_key_styled() const noexcept

Definition: node_type.hpp:330

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 640 of file tree.hpp.

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

c4::yml::NodeType::is_val_styled

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_styled() const noexcept

Definition: node_type.hpp:331

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 641 of file tree.hpp.

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

c4::yml::NodeType::is_key_literal

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_key_literal() const noexcept

Definition: node_type.hpp:332

c4::yml::NodeType::is_val_literal

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 642 of file tree.hpp.

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

bool is_val_literal() const noexcept

Definition: node_type.hpp:333

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 643 of file tree.hpp.

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

c4::yml::NodeType::is_key_folded

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_key_folded() const noexcept

Definition: node_type.hpp:334

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 644 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_val_folded

NodeType m_type

Definition: tree.hpp:289

bool is_val_folded() const noexcept

Definition: node_type.hpp:335

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

inline

Definition at line 645 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_key_squo

NodeType m_type

Definition: tree.hpp:289

bool is_key_squo() const noexcept

Definition: node_type.hpp:336

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

inline

Definition at line 646 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_val_squo

NodeType m_type

Definition: tree.hpp:289

bool is_val_squo() const noexcept

Definition: node_type.hpp:337

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

inline

Definition at line 647 of file tree.hpp.

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

c4::yml::NodeType::is_key_dquo

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_key_dquo() const noexcept

Definition: node_type.hpp:338

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 648 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_val_dquo

NodeType m_type

Definition: tree.hpp:289

bool is_val_dquo() const noexcept

Definition: node_type.hpp:339

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

inline

Definition at line 649 of file tree.hpp.

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

c4::yml::NodeType::is_key_plain

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_key_plain() const noexcept

Definition: node_type.hpp:340

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 650 of file tree.hpp.

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

c4::yml::NodeType::is_val_plain

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_plain() const noexcept

Definition: node_type.hpp:341

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 651 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::is_key_quoted

NodeType m_type

Definition: tree.hpp:289

bool is_key_quoted() const noexcept

Definition: node_type.hpp:342

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

inline

Definition at line 652 of file tree.hpp.

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

c4::yml::NodeType::is_val_quoted

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_quoted() const noexcept

Definition: node_type.hpp:343

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 653 of file tree.hpp.

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

c4::yml::NodeType::is_quoted

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_quoted() const noexcept

Definition: node_type.hpp:344

NodeType m_type

Definition: tree.hpp:289

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

inline

Definition at line 655 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key(id_type node) const

Definition: tree.hpp:482

c4::yml::NodeType::key_style

NodeType m_type

Definition: tree.hpp:289

NodeType key_style() const noexcept

Definition: node_type.hpp:346

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 656 of file tree.hpp.

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

bool has_val(id_type node) const

Definition: tree.hpp:483

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::NodeType::val_style

NodeType m_type

Definition: tree.hpp:289

NodeType val_style() const noexcept

Definition: node_type.hpp:347

Callbacks m_callbacks

Definition: tree.hpp:1686

c4::yml::Tree::is_container

bool is_root(id_type node) const

Definition: tree.hpp:529

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

inline

Definition at line 658 of file tree.hpp.

Referenced by sample_style_flow_ml_indent().

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

bool is_container(id_type node) const

Definition: tree.hpp:479

c4::yml::NodeType::set_container_style

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

void set_container_style(type_bits style) noexcept

Definition: node_type.hpp:349

NodeType m_type

Definition: tree.hpp:289

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 659 of file tree.hpp.

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

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key(id_type node) const

Definition: tree.hpp:482

NodeType m_type

Definition: tree.hpp:289

c4::yml::NodeType::set_key_style

Callbacks m_callbacks

Definition: tree.hpp:1686

void set_key_style(type_bits style) noexcept

Definition: node_type.hpp:350

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

inline

Definition at line 660 of file tree.hpp.

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

bool has_val(id_type node) const

Definition: tree.hpp:483

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

NodeType m_type

Definition: tree.hpp:289

c4::yml::NodeType::set_val_style

Callbacks m_callbacks

Definition: tree.hpp:1686

void set_val_style(type_bits style) noexcept

Definition: node_type.hpp:351

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

Definition at line 1404 of file tree.cpp.

Referenced by sample_style().

 {
     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);
 }

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 1414 of file tree.cpp.

Referenced by sample_style().

 {
     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);
 }

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

inline

Definition at line 675 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, is_root(node), this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, (_p(node)->m_type & (DOC|MAP|VAL)) == 0, this, node);
         _p(node)->m_type |= STREAM;
     }

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

inline

Definition at line 682 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, is_root(node) || (is_root(parent(node)) && is_stream(parent(node))), this, node);
         _p(node)->m_type |= DOC;
     }

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

inline

Definition at line 688 of file tree.hpp.

Referenced by lookup_path_or_modify(), sample_anchors_and_aliases_create(), sample_lightning_overview(), sample_tree_arena(), c4::yml::write(), and write().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, (_p(node)->m_type & (SEQ|MAP)) == 0, this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, (parent(node) == NONE || (_p(parent(node))->m_type & (SEQ|MAP))), this, node);
         NodeData *C4_RESTRICT nd = _p(node);
         nd->m_type |= VAL;
         nd->m_val.scalar = val;
     }

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

inline

Definition at line 696 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, (_p(node)->m_type & (SEQ|MAP)) == 0, this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, (parent(node) == NONE || (_p(parent(node))->m_type & (SEQ|MAP))), this, node);
         NodeData *C4_RESTRICT nd = _p(node);
         nd->m_type |= VAL|more_flags;
         nd->m_val.scalar = val;
     }

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

inline

Definition at line 705 of file tree.hpp.

Referenced by merge_with(), write(), and c4::yml::write_key().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, (parent(node) != NONE && (_p(parent(node))->m_type & MAP)), this, node);
         NodeData *C4_RESTRICT nd = _p(node);
         nd->m_type |= KEY;
         nd->m_key.scalar = key;
     }

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

inline

Definition at line 712 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, (parent(node) != NONE && (_p(parent(node))->m_type & MAP)), this, node);
         NodeData *C4_RESTRICT nd = _p(node);
         nd->m_type |= KEY|more_flags;
         nd->m_key.scalar = key;
     }

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

inline

Definition at line 720 of file tree.hpp.

Referenced by merge_with(), and write().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, (_p(node)->m_type & (VAL|MAP)) == 0, this, node);
         _p(node)->m_type |= SEQ;
     }

void c4::yml::Tree::set_seq	(	id_type	node,
		NodeType	more_flags
	)

inline

Definition at line 725 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, ((_p(node)->m_type|more_flags) & (VAL|MAP)) == 0, this, node);
         _p(node)->m_type |= SEQ|more_flags;
     }

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

inline

Definition at line 731 of file tree.hpp.

Referenced by merge_with(), c4::yml::write(), and write().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, (_p(node)->m_type & (VAL|SEQ)) == 0, this, node);
         _p(node)->m_type |= MAP;
     }

void c4::yml::Tree::set_map	(	id_type	node,
		NodeType	more_flags
	)

inline

Definition at line 736 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, ((_p(node)->m_type|more_flags) & (VAL|SEQ)) == 0, this, node);
         _p(node)->m_type |= MAP|more_flags;
     }

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

inline

Definition at line 742 of file tree.hpp.

Referenced by sample_serialize_basic().

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

c4::yml::KEYTAG

the key has a tag

Definition: node_type.hpp:43

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key(id_type node) const

Definition: tree.hpp:482

csubstr tag

Definition: tree.hpp:171

Callbacks m_callbacks

Definition: tree.hpp:1686

c4::yml::Tree::is_container

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 743 of file tree.hpp.

Referenced by sample_serialize_basic().

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

bool is_container(id_type node) const

Definition: tree.hpp:479

bool has_val(id_type node) const

Definition: tree.hpp:483

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::VALTAG

the val has a tag

Definition: node_type.hpp:44

NodeScalar m_val

Definition: tree.hpp:292

csubstr tag

Definition: tree.hpp:171

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 745 of file tree.hpp.

Referenced by sample_anchors_and_aliases_create(), and sample_serialize_basic().

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

csubstr anchor

Definition: tree.hpp:173

c4::yml::Tree::is_key_ref

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::KEYANCH

the key has an &anchor

Definition: node_type.hpp:41

bool is_key_ref(id_type node) const

Definition: tree.hpp:491

c4::basic_substring::triml

basic_substring triml(const C c) const

trim left

Definition: substr.hpp:629

Callbacks m_callbacks

Definition: tree.hpp:1686

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 746 of file tree.hpp.

Referenced by sample_anchors_and_aliases_create(), and sample_serialize_basic().

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

c4::yml::VALANCH

the val has an &anchor

Definition: node_type.hpp:42

csubstr anchor

Definition: tree.hpp:173

c4::yml::Tree::is_val_ref

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool is_val_ref(id_type node) const

Definition: tree.hpp:492

c4::basic_substring::triml

basic_substring triml(const C c) const

trim left

Definition: substr.hpp:629

NodeScalar m_val

Definition: tree.hpp:292

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 747 of file tree.hpp.

747 { RYML_ASSERT_VISIT_CB_(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); }

c4::yml::detail::RoNodeMethods::has_key

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_key() const RYML_NOEXCEPT

Forward to Tree::has_key().

Definition: node.hpp:210

c4::yml::Tree::ref

NodeRef ref(id_type node)

Get a NodeRef of a node by id.

Definition: tree.cpp:70

c4::yml::KEY

the scalar to the left of : in a map's member

Definition: node_type.hpp:33

c4::yml::KEYREF

a *reference: the key references an &anchor

Definition: node_type.hpp:39

c4::yml::Tree::has_key_anchor

bool has_key_anchor(id_type node) const

Definition: tree.hpp:488

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 748 of file tree.hpp.

Referenced by sample_anchors_and_aliases_create().

748 { RYML_ASSERT_VISIT_CB_(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); }

c4::yml::Tree::has_val_anchor

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

bool has_val_anchor(id_type node) const

Definition: tree.hpp:489

c4::yml::VAL

a scalar: has a scalar (ie string) value, possibly empty. must be a leaf node, and cannot be MAP or S...

Definition: node_type.hpp:34

c4::yml::Tree::ref

NodeRef ref(id_type node)

Get a NodeRef of a node by id.

Definition: tree.cpp:70

c4::yml::VALREF

a *reference: the val references an &anchor

Definition: node_type.hpp:40

c4::yml::detail::RoNodeMethods::has_val

Callbacks m_callbacks

Definition: tree.hpp:1686

bool has_val() const RYML_NOEXCEPT

Forward to Tree::has_val().

Definition: node.hpp:209

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

inline

Definition at line 750 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

void clear() noexcept

Definition: substr.hpp:265

c4::yml::KEYANCH

the key has an &anchor

Definition: node_type.hpp:41

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 751 of file tree.hpp.

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

c4::yml::VALANCH

the val has an &anchor

Definition: node_type.hpp:42

csubstr anchor

Definition: tree.hpp:173

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

void clear() noexcept

Definition: substr.hpp:265

NodeScalar m_val

Definition: tree.hpp:292

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

inline

Definition at line 752 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

void clear() noexcept

Definition: substr.hpp:265

c4::yml::KEYREF

a *reference: the key references an &anchor

Definition: node_type.hpp:39

NodeScalar m_key

Definition: tree.hpp:291

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

inline

Definition at line 753 of file tree.hpp.

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

csubstr anchor

Definition: tree.hpp:173

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

void clear() noexcept

Definition: substr.hpp:265

c4::yml::VALREF

a *reference: the val references an &anchor

Definition: node_type.hpp:40

NodeScalar m_val

Definition: tree.hpp:292

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

inline

Definition at line 754 of file tree.hpp.

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

c4::yml::VALANCH

the val has an &anchor

Definition: node_type.hpp:42

csubstr anchor

Definition: tree.hpp:173

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

void clear() noexcept

Definition: substr.hpp:265

c4::yml::KEYANCH

the key has an &anchor

Definition: node_type.hpp:41

c4::yml::VALREF

a *reference: the val references an &anchor

Definition: node_type.hpp:40

c4::yml::KEYREF

a *reference: the key references an &anchor

Definition: node_type.hpp:39

NodeScalar m_val

Definition: tree.hpp:292

c4::yml::Tree::m_tag_directives

NodeScalar m_key

Definition: tree.hpp:291

template<class T >

void c4::yml::Tree::save	(	id_type	node,
		T const &	val
	)

inline

Definition at line 772 of file tree.hpp.

Referenced by sample_serialize_basic(), and sample_user_container_types().

     {
         if C4_LIKELY(node != NONE && node < m_cap && node >= 0)
         {
             write(this, node, val);
             return;
         }
         err_visit_(node);
     }

template<class T >

void c4::yml::Tree::save	(	id_type	node,
		T const &	val,
		NodeType	more_flags
	)

inline

Definition at line 782 of file tree.hpp.

     {
         if C4_LIKELY(node != NONE && node < m_cap && node >= 0)
         {
             write(this, node, val);
             _p(node)->m_type |= more_flags;
             return;
         }
         err_visit_(node);
     }

template<class T >

void c4::yml::Tree::save_key	(	id_type	node,
		T const &	key
	)

inline

Definition at line 794 of file tree.hpp.

Referenced by sample_serialize_basic().

     {
         if C4_LIKELY(node != NONE && node < m_cap && node >= 0)
         {
             write_key(this, node, key);
             return;
         }
         err_visit_(node);
     }

template<class T >

void c4::yml::Tree::save_key	(	id_type	node,
		T const &	key,
		NodeType	more_flags
	)

inline

Definition at line 804 of file tree.hpp.

     {
         if C4_LIKELY(node != NONE && node < m_cap && node >= 0)
         {
             write_key(this, node, key);
             _p(node)->m_type |= more_flags;
             return;
         }
         err_visit_(node);
     }

template<class T >

void c4::yml::Tree::set_serialized	(	id_type	node,
		T const &	val
	)

inline

Definition at line 823 of file tree.hpp.

Referenced by sample_base64(), sample_empty_null_values(), sample_serialize_basic(), c4::yml::write(), and write().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         write(this, node, val);
     }

template<class T >

void c4::yml::Tree::set_serialized	(	id_type	node,
		T const &	val,
		NodeType	more_flags
	)

inline

Definition at line 829 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         write(this, node, val);
         _p(node)->m_type |= more_flags;
     }

template<class T >

void c4::yml::Tree::set_key_serialized	(	id_type	node,
		T const &	key
	)

inline

Definition at line 837 of file tree.hpp.

Referenced by sample_serialize_basic(), c4::yml::write(), write(), and c4::yml::write_key().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         write_key(this, node, key);
     }

template<class T >

void c4::yml::Tree::set_key_serialized	(	id_type	node,
		T const &	key,
		NodeType	more_flags
	)

inline

Definition at line 843 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         write_key(this, node, key);
         _p(node)->m_type |= more_flags;
     }

static ReadResult c4::yml::Tree::to_result_	(	bool	,
		id_type	node
	)

inlinestaticnoexcept

Definition at line 861 of file tree.hpp.

861 { return ReadResult(node); }

static ReadResult c4::yml::Tree::to_result_	(	ReadResult	notlegacy,
		id_type
	)

inlinestaticnoexcept

Definition at line 862 of file tree.hpp.

862 { return notlegacy; }

template<class T >

void c4::yml::Tree::load	(	id_type	node,
		T *	v,
		bool	check_readable = `true`
	)		const

inline

(1) deserialize the node's contents (val or container) to the given variable, forwarding to the user-overrideable read() function (see Read from Tree).

This function differs from Tree::deserialize() in that here the error callback is called if the deserialization failed, or (optionally) the node is not readable.

Definition at line 871 of file tree.hpp.

Referenced by sample_base64(), sample_error_visit(), sample_error_visit_location(), sample_fundamental_types(), sample_serialize_basic(), and sample_user_container_types().

     {
         const bool can_read_val = (node != NONE && node < m_cap && node >= 0 && (_p(node)->m_type & (VAL|MAP|SEQ)));
         RYML_ASSERT_VISIT_CB_(m_callbacks, can_read_val, this, node);
         if C4_LIKELY(!check_readable || can_read_val)
         {
             const ReadResult result(read(this, node, v), node);
             if C4_LIKELY(result)
                 return;
             else
                 node = result.node;
         }
         err_visit_(node);
     }

template<class Wrapper >

void c4::yml::Tree::load	(	id_type	node,
		Wrapper const &	w,
		bool	check_readable = `true`
	)		const

inline

(2) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 888 of file tree.hpp.

     {
         RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
         const bool can_read_val = (node != NONE && node < m_cap && node >= 0 && (_p(node)->m_type & (VAL|MAP|SEQ)));
         RYML_ASSERT_VISIT_CB_(m_callbacks, can_read_val, this, node);
         if C4_LIKELY(!check_readable || can_read_val)
         {
             const ReadResult result(read(this, node, w), node);
             if C4_LIKELY(result)
                 return;
             else
                 node = result.node;
         }
         err_visit_(node);
     }

template<class T >

void c4::yml::Tree::load_key	(	id_type	node,
		T *	k,
		bool	check_readable = `true`
	)		const

inline

(1) deserialize the node's key (necessarily a scalar) to the given variable, forwarding to the user-overrideable read_key() function (see Read from ConstNodeRef).

This function differs from Tree::deserialize_key() in that here the error callback is called if the deserialization failed, or (optionally) the node is not readable.

Definition at line 912 of file tree.hpp.

Referenced by sample_base64(), and sample_serialize_basic().

     {
         const bool can_read_key = (node != NONE && node < m_cap && node >= 0 && (_p(node)->m_type & KEY));
         RYML_ASSERT_VISIT_CB_(m_callbacks, can_read_key, this, node);
         if C4_LIKELY(!check_readable || can_read_key)
         {
             const ReadResult result(read_key(this, node, k), node);
             if C4_LIKELY(result)
                 return;
             else
                 node = result.node;
         }
         err_visit_(node);
     }

template<class Wrapper >

void c4::yml::Tree::load_key	(	id_type	node,
		Wrapper const &	w,
		bool	check_readable = `true`
	)		const

inline

(2) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 929 of file tree.hpp.

     {
         RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
         bool can_read_key = (node != NONE && node < m_cap && node >= 0 && (_p(node)->m_type & KEY));
         RYML_ASSERT_VISIT_CB_(m_callbacks, can_read_key, this, node);
         if C4_LIKELY(!check_readable || can_read_key)
         {
             const ReadResult result(read_key(this, node, w), node);
             if C4_LIKELY(result)
                 return;
             else
                 node = result.node;
         }
         err_visit_(node);
     }

template<class T >

ReadResult c4::yml::Tree::deserialize	(	id_type	node,
		T *	v
	)		const

inline

(1) deserialize a node's contents to a variable

Definition at line 954 of file tree.hpp.

Referenced by c4::yml::read(), read(), sample_base64(), and sample_serialize_basic().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, _p(node)->m_type & (VAL|MAP|SEQ), this, node);
         // use the adapter ctor to accomodate legacy read() implementations
         return ReadResult(read(this, node, v), node);
     }

template<class Wrapper >

ReadResult c4::yml::Tree::deserialize	(	id_type	node,
		Wrapper const &	w
	)		const

inline

(2) like (1), but for a wrapper type like those used in tag functions

Definition at line 964 of file tree.hpp.

     {
         RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, _p(node)->m_type & (VAL|MAP|SEQ), this, node);
         // use the adapter ctor to accomodate legacy read() implementations
         return ReadResult(read(this, node, w), node);
     }

template<class T >

ReadResult c4::yml::Tree::deserialize_key	(	id_type	node,
		T *	v
	)		const

inline

(1) deserialize a node's key to a variable

Definition at line 975 of file tree.hpp.

Referenced by c4::yml::read(), read(), and sample_serialize_basic().

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, has_key(node), this, node);
         // use the adapter ctor to accomodate legacy read_key() implementations
         return ReadResult(read_key(this, node, v), node);
     }

template<class Wrapper >

ReadResult c4::yml::Tree::deserialize_key	(	id_type	node,
		Wrapper const &	w
	)		const

inline

(2) like (1), but for a wrapper type like those used in tag functions

Definition at line 985 of file tree.hpp.

     {
         RYML_CHECK_TYPE_IS_WRAPPER_LIKE_(Wrapper);
         RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE && node >= 0 && node < m_cap, this, node);
         RYML_ASSERT_VISIT_CB_(m_callbacks, has_key(node), this, node);
         // use the adapter ctor to accomodate legacy read_key() implementations
         return ReadResult(read_key(this, node, w), node);
     }

template<class T >

ReadResult c4::yml::Tree::deserialize_child	(	id_type	node,
		csubstr	child_key,
		T *	v
	)		const

inline

(1) find a child by name and deserialize its contents to the given variable (ie call .deserialize() on the child if it exists).

Otherwise, the variable is kept unchanged.

Returns: a ReadResult set with this node's id if no child exists, or the ReadResult from the deserialization.

See also: see also Tree::find_child_r()

Definition at line 1011 of file tree.hpp.

Referenced by read().

     {
         id_type ch;
         ReadResult r = find_child_r(node, child_key, &ch);
         if(r)
             r = deserialize(ch, v);
         return r;
     }

template<class T >

ReadResult c4::yml::Tree::deserialize_child	(	id_type	node,
		csubstr	child_key,
		T *	v,
		T const &	fallback
	)		const

inline

(2) like (1), but assign from fallback if no such child exists.

Definition at line 1021 of file tree.hpp.

     {
         id_type ch;
         if(find_child_r(node, child_key, &ch))
             return deserialize(ch, v);
         *v = fallback;
         return ReadResult();
     }

template<class Wrapper >

ReadResult c4::yml::Tree::deserialize_child	(	id_type	node,
		csubstr	child_key,
		Wrapper const &	wrapper
	)		const

inline

(3) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 1031 of file tree.hpp.

     {
         id_type ch;
         ReadResult r = find_child_r(node, child_key, &ch);
         if(r)
             r = deserialize(ch, wrapper);
         return r;
     }

template<class T >

ReadResult c4::yml::Tree::deserialize_child	(	id_type	node,
		id_type	child_pos,
		T *	v
	)		const

inline

(1) find a child by position and deserialize its contents to the given variable (ie call .deserialize() on the child if it exists).

Otherwise, the variable is kept unchanged.

Returns: a ReadResult set with this node's id if no child exists, or the ReadResult from the deserialization.

See also: see also Tree::child_r()

Definition at line 1050 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, is_container(node), this, node); // this assertion is needed because child_r() does not assert, contrary to find_child_r()
         id_type ch;
         ReadResult r = child_r(node, child_pos, &ch);
         if(r)
             r = deserialize(ch, v);
         return r;
     }

template<class T >

ReadResult c4::yml::Tree::deserialize_child	(	id_type	node,
		id_type	child_pos,
		T *	v,
		T const &	fallback
	)		const

inline

(2) like (1), but assign from fallback if no such child exists

Definition at line 1061 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, is_container(node), this, node); // this assertion is needed because child_r() does not assert, contrary to find_child_r()
         id_type ch;
         if(child_r(node, child_pos, &ch))
             return deserialize(ch, v);
         *v = fallback;
         return ReadResult();
     }

template<class Wrapper >

ReadResult c4::yml::Tree::deserialize_child	(	id_type	node,
		id_type	child_pos,
		Wrapper const &	wrapper
	)		const

inline

(3) like (1), but for wrapper tag types such as c4::fmt::base64()

Definition at line 1073 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, is_container(node), this, node); // this assertion is needed because child_r() does not assert, contrary to find_child_r()
         id_type ch;
         ReadResult r = child_r(node, child_pos, &ch);
         if(r)
             r = deserialize(ch, wrapper);
         return r;
     }

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 573 of file tree.cpp.

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

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 1206 of file tree.cpp.

Referenced by resolve(), sample_anchors_and_aliases(), and sample_anchors_and_aliases_create().

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

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 1198 of file tree.cpp.

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

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 1553 of file tree.cpp.

Referenced by sample_tag_directives().

 {
     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_CB_(callbacks(), extra_size == 0);
     }
 }

void c4::yml::Tree::normalize_tags ( )

Definition at line 1571 of file tree.cpp.

Referenced by sample_tags().

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

void c4::yml::Tree::normalize_tags_long ( )

Definition at line 1578 of file tree.cpp.

Referenced by sample_tags().

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

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

Definition at line 1434 of file tree.cpp.

 {
     return m_tag_directives.size();
 }

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

Definition at line 1444 of file tree.cpp.

Referenced by sample_error_basic().

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

void c4::yml::Tree::clear_tag_directives ( )

Definition at line 1439 of file tree.cpp.

 {
     m_tag_directives.clear();
 }

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 1456 of file tree.cpp.

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

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 1145 of file tree.hpp.

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

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

inline

Definition at line 1151 of file tree.hpp.

1151 { return m_tag_directives.directives(); }

TagDirectives m_tag_directives

Definition: tree.hpp:1688

c4::yml::TagDirectives::directives

TagDirectiveRange directives() const noexcept

Definition: tag.hpp:137

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 1168 of file tree.hpp.

     {
         RYML_ASSERT_VISIT_CB_(m_callbacks, parent != NONE, this, parent);
         RYML_ASSERT_VISIT_CB_(m_callbacks, is_container(parent) || is_root(parent), this, parent);
         RYML_ASSERT_VISIT_CB_(m_callbacks, after == NONE || (_p(after)->m_parent == parent), this, parent);
         id_type child = _claim();
         _set_hierarchy(child, parent, after);
         return 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 1178 of file tree.hpp.

1178 { return insert_child(parent, NONE); }

c4::yml::Tree::insert_child

an index to none

Definition: common.hpp:131

c4::yml::Tree::parent

id_type parent(id_type node) const

Definition: tree.hpp:569

id_type insert_child(id_type parent, id_type after)

create and insert a new child of parent.

Definition: tree.hpp:1168

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 1180 of file tree.hpp.

Referenced by merge_with(), set_root_as_stream(), c4::yml::write(), and write().

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

c4::yml::Tree::insert_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

c4::yml::Tree::parent

id_type parent(id_type node) const

Definition: tree.hpp:569

id_type insert_child(id_type parent, id_type after)

create and insert a new child of parent.

Definition: tree.hpp:1168

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

inline

Definition at line 1181 of file tree.hpp.

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

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 1191 of file tree.hpp.

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

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 1196 of file tree.hpp.

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

c4::yml::Tree::prepend_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type prepend_child(id_type parent)

create and insert a node as the first child of parent

Definition: tree.hpp:1178

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

inline

Definition at line 1197 of file tree.hpp.

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

c4::yml::Tree::append_child

NodeData * _p(id_type node)

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

Definition: tree.hpp:380

id_type append_child(id_type parent)

create and insert a node as the last child of parent

Definition: tree.hpp:1180

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 1202 of file tree.hpp.

Referenced by move().

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

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

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

Definition at line 917 of file tree.cpp.

Referenced by change_type(), and merge_with().

 {
     RYML_ASSERT_VISIT_CB_(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_CB_(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
 }

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

change the node's position in the parent

Definition at line 817 of file tree.cpp.

Referenced by duplicate_children_no_rep(), c4::yml::NodeRef::move(), and set_root_as_stream().

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

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 830 of file tree.cpp.

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

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 843 of file tree.cpp.

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

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 855 of file tree.cpp.

 {
     id_type root = root_id();
     NodeType ty = type(root);
     if(ty.is_stream())
         return;
     _c4dbgpf("set_root_as_stream. rootty={}", type(root).m_bits);
     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(ty.is_container())
         {
             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_CB_(m_callbacks, !ty.has_key(), 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;
     }
 }

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

Definition at line 940 of file tree.cpp.

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

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

inline

Definition at line 1247 of file tree.hpp.

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

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 960 of file tree.cpp.

Referenced by c4::yml::NodeRef::duplicate(), duplicate_children(), duplicate_children_no_rep(), and move().

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

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 965 of file tree.cpp.

 {
     RYML_ASSERT_VISIT_CB_(m_callbacks, src != nullptr, src, node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE, src, node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, parent != NONE, this, parent);
     RYML_ASSERT_VISIT_CB_(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;
 }

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 983 of file tree.cpp.

Referenced by duplicate(), c4::yml::NodeRef::duplicate_children(), and duplicate_contents().

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

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 988 of file tree.cpp.

 {
     RYML_ASSERT_VISIT_CB_(m_callbacks, src != nullptr, src, node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE, src, node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, parent != NONE, this, parent);
     RYML_ASSERT_VISIT_CB_(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;
 }

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 1020 of file tree.cpp.

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

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

Definition at line 1025 of file tree.cpp.

 {
     RYML_ASSERT_VISIT_CB_(m_callbacks, node != NONE, src, node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, parent != NONE, this, parent);
     RYML_ASSERT_VISIT_CB_(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_CB_(m_callbacks, after_pos != NONE, this, node);
     }
 
     // for each child to be duplicated...
     id_type prev = after;
     NodeType pty = type(parent);
     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_CB_(m_callbacks, this != src || (parent != i && !is_ancestor(parent, i)), this, parent);
         if(pty.is_seq())
         {
             _c4dbgpf("duplicate_no_rep: {} is seq", parent);
             prev = duplicate(src, i, parent, prev);
         }
         else
         {
             _c4dbgpf("duplicate_no_rep: {} is map", parent);
             RYML_ASSERT_VISIT_CB_(m_callbacks, pty.is_map(), 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;
 }

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

Definition at line 1005 of file tree.cpp.

 {
     duplicate_contents(this, node, where);
 }

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

Definition at line 1010 of file tree.cpp.

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

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

Definition at line 1121 of file tree.cpp.

Referenced by lookup_path_or_modify().

 {
     RYML_ASSERT_VISIT_CB_(m_callbacks, src != nullptr, src, src_node);
     if(src_node == NONE)
         src_node = src->root_id();
     if(dst_node == NONE)
         dst_node = root_id();
     NodeType srcty = src->type(src_node);
     NodeType dstty = type(dst_node);
     RYML_ASSERT_VISIT_CB_(m_callbacks, srcty.has_val() || srcty.is_seq() || srcty.is_map(), src, src_node);
     if(srcty.has_val())
     {
         type_bits mask_src = ~STYLE; // keep the existing style if it is already a val
         if( ! dstty.has_val())
         {
             if(has_children(dst_node))
                 remove_children(dst_node);
             mask_src |= VAL_STYLE; // copy the src style
         }
         if(srcty.is_keyval())
         {
             _copy_props(dst_node, src, src_node, mask_src);
         }
         else
         {
             RYML_ASSERT_VISIT_CB_(m_callbacks, srcty.is_val(), src, src_node);
             _copy_props_wo_key(dst_node, src, src_node, mask_src);
         }
     }
     else if(srcty.is_seq())
     {
         if( ! dstty.is_seq())
         {
             if(has_children(dst_node))
                 remove_children(dst_node);
             _clear_type(dst_node);
             if(src->has_key(src_node))
                 set_key(dst_node, src->key(src_node));
             set_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_CB_(m_callbacks, srcty.is_map(), src, src_node);
         if( ! dstty.is_map())
         {
             if(has_children(dst_node))
                 remove_children(dst_node);
             _clear_type(dst_node);
             if(src->has_key(src_node))
                 set_key(dst_node, src->key(src_node));
             set_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 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 1913 of file tree.cpp.

Referenced by sample_error_visit_location(), and sample_location_tracking().

 {
     // 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);
 }

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

inline

get the current size of the tree's internal arena

Definition at line 1309 of file tree.hpp.

1309 { return m_arena_pos; }

size_t m_arena_pos

Definition: tree.hpp:1684

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

inline

get the current capacity of the tree's internal arena

Definition at line 1311 of file tree.hpp.

Referenced by sample_tree_arena().

1311 { return m_arena.len; }

substr m_arena

Definition: tree.hpp:1683

c4::basic_substring::len

size_t len

the length of the substring

Definition: substr.hpp:218

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

inline

get the current slack of the tree's internal arena

Definition at line 1313 of file tree.hpp.

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

substr m_arena

Definition: tree.hpp:1683

an index to none

Definition: common.hpp:131

c4::basic_substring::len

size_t len

the length of the substring

Definition: substr.hpp:218

size_t m_arena_pos

Definition: tree.hpp:1684

Callbacks m_callbacks

Definition: tree.hpp:1686

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

inline

Definition at line 1314 of file tree.hpp.

1314 { return m_arena_pos; }

size_t m_arena_pos

Definition: tree.hpp:1684

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

inline

get the current arena

Definition at line 1317 of file tree.hpp.

Referenced by sample_empty_null_values(), sample_fundamental_types(), sample_quick_overview(), sample_tree_arena(), and sample_user_container_types().

1317 { return m_arena.first(m_arena_pos); }

c4::basic_substring::first

substr m_arena

Definition: tree.hpp:1683

basic_substring first(size_t num) const noexcept

return the first num elements: [0,num[

Definition: substr.hpp:529

size_t m_arena_pos

Definition: tree.hpp:1684

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

inline

get the current arena

Definition at line 1319 of file tree.hpp.

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

c4::basic_substring::first

substr m_arena

Definition: tree.hpp:1683

basic_substring first(size_t num) const noexcept

return the first num elements: [0,num[

Definition: substr.hpp:529

size_t m_arena_pos

Definition: tree.hpp:1684

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

inline

get the free space at the end of the arena

Definition at line 1322 of file tree.hpp.

Referenced by c4::yml::serialize_to_arena_scalar().

1322 { return m_arena.sub(m_arena_pos); }

substr m_arena

Definition: tree.hpp:1683

c4::basic_substring::sub

basic_substring sub(size_t first) const noexcept

return [first,len[

Definition: substr.hpp:502

size_t m_arena_pos

Definition: tree.hpp:1684

substr c4::yml::Tree::arena_rem ( )

inline

get the free space at the end of the arena

Definition at line 1324 of file tree.hpp.

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

substr m_arena

Definition: tree.hpp:1683

c4::basic_substring::sub

basic_substring sub(size_t first) const noexcept

return [first,len[

Definition: substr.hpp:502