parse a mutable YAML source buffer (re)using an existing parser. More...

Functions
void	c4::yml::parse_in_place (Parser parser, csubstr filename, substr yaml, Tree t, id_type node_id)
	(1) parse YAML into an existing tree node.
void	c4::yml::parse_in_place (Parser parser, substr yaml, Tree t, id_type node_id)
	(2) like (1) but no filename will be reported
void	c4::yml::parse_in_place (Parser parser, csubstr filename, substr yaml, Tree t)
	(3) parse YAML into the root node of an existing tree.
void	c4::yml::parse_in_place (Parser parser, substr yaml, Tree t)
	(4) like (3) but no filename will be reported
void	c4::yml::parse_in_place (Parser *parser, csubstr filename, substr yaml, NodeRef node)
	(5) like (1) but the node is given as a NodeRef
void	c4::yml::parse_in_place (Parser *parser, substr yaml, NodeRef node)
	(6) like (5) but no filename will be reported
Tree	c4::yml::parse_in_place (Parser *parser, csubstr filename, substr yaml)
	(7) create a new tree, and parse YAML into its root node.
Tree	c4::yml::parse_in_place (Parser *parser, substr yaml)
	(8) like (7) but no filename will be reported
void	c4::yml::parse_json_in_place (Parser parser, csubstr filename, substr json, Tree t, id_type node_id)
	(1) parse JSON into an existing tree node. The filename will be used in any error messages arising during the parse.
void	c4::yml::parse_json_in_place (Parser parser, substr json, Tree t, id_type node_id)
	(2) like (1) but no filename will be reported
void	c4::yml::parse_json_in_place (Parser parser, csubstr filename, substr json, Tree t)
	(3) parse JSON into an existing tree, into its root node.
void	c4::yml::parse_json_in_place (Parser parser, substr json, Tree t)
	(4) like (3) but no filename will be reported
void	c4::yml::parse_json_in_place (Parser *parser, csubstr filename, substr json, NodeRef node)
	(5) like (1) but the node is given as a NodeRef
void	c4::yml::parse_json_in_place (Parser *parser, substr json, NodeRef node)
	(6) like (5) but no filename will be reported
Tree	c4::yml::parse_json_in_place (Parser *parser, csubstr filename, substr json)
	(7) create a new tree, and parse JSON into its root node.
Tree	c4::yml::parse_json_in_place (Parser *parser, substr json)
	(8) like (7) but no filename will be reported

Detailed Description

parse a mutable YAML source buffer (re)using an existing parser.

Scalars requiring filtering are mutated in place (except in the rare cases where the filtered scalar is longer than the original scalar, or where filtering was disabled before the call). These overloads accept an existing parser object, and provide the opportunity to use special parser options.

See also: ParserOptions

Function Documentation

◆ parse_in_place() [1/8]

void c4::yml::parse_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	yaml,
		Tree *	t,
		id_type	node_id )

(1) parse YAML into an existing tree node.

                                                                     The filename will be used in any error messages
                                                                     arising during the parse. The callbacks in the
                                                                     tree are kept, and used to allocate
                                                                     the tree members, if any allocation is required.

Definition at line 38 of file parse.cpp.

{
    _reset_tree_handler(parser, t, node_id);
    parser->parse_in_place_ev(filename, yaml);
}

◆ parse_in_place() [2/8]

void c4::yml::parse_in_place	(	Parser *	parser,
		substr	yaml,
		Tree *	t,
		id_type	node_id )

(2) like (1) but no filename will be reported

Definition at line 52 of file parse.cpp.

52{ parse_in_place(parser, {}, yaml, t, node_id); }

c4::yml::parse_in_place

void parse_in_place(Parser *parser, csubstr filename, substr yaml, Tree *t, id_type node_id)

(1) parse YAML into an existing tree node.

Definition parse.cpp:38

◆ parse_in_place() [3/8]

void c4::yml::parse_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	yaml,
		Tree *	t )

(3) parse YAML into the root node of an existing tree.

                                                      The filename will be used in any error messages
                                                      arising during the parse. The callbacks in the
                                                      tree are kept, and used to allocate
                                                      the tree members, if any allocation is required.

Definition at line 53 of file parse.cpp.

53{ _RYML_CHECK_BASIC(t); if(t->empty()) { t->reserve(); } parse_in_place(parser, filename, yaml, t, t->root_id()); }

c4::yml::Tree::root_id

id_type root_id() const

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

Definition tree.hpp:337

c4::yml::Tree::reserve

void reserve(id_type node_capacity=RYML_DEFAULT_TREE_CAPACITY)

Definition tree.cpp:292

c4::yml::Tree::empty

bool empty() const

Definition tree.hpp:284

◆ parse_in_place() [4/8]

void c4::yml::parse_in_place	(	Parser *	parser,
		substr	yaml,
		Tree *	t )

(4) like (3) but no filename will be reported

Definition at line 54 of file parse.cpp.

54{ _RYML_CHECK_BASIC(t); if(t->empty()) { t->reserve(); } parse_in_place(parser, {} , yaml, t, t->root_id()); }

◆ parse_in_place() [5/8]

void c4::yml::parse_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	yaml,
		NodeRef	node )

(5) like (1) but the node is given as a NodeRef

Definition at line 55 of file parse.cpp.

55{ _RYML_CHECK_BASIC(!node.invalid()); parse_in_place(parser, filename, yaml, node.tree(), node.id()); }

c4::yml::NodeRef::tree

Tree * tree() noexcept

Definition node.hpp:1089

c4::yml::NodeRef::id

id_type id() const noexcept

Definition node.hpp:1092

c4::yml::NodeRef::invalid

bool invalid() const noexcept

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

Definition node.hpp:1038

◆ parse_in_place() [6/8]

void c4::yml::parse_in_place	(	Parser *	parser,
		substr	yaml,
		NodeRef	node )

(6) like (5) but no filename will be reported

Definition at line 56 of file parse.cpp.

56{ _RYML_CHECK_BASIC(!node.invalid()); parse_in_place(parser, {} , yaml, node.tree(), node.id()); }

◆ parse_in_place() [7/8]

Tree c4::yml::parse_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	yaml )

(7) create a new tree, and parse YAML into its root node.

                                               The filename will be used in any error messages
                                               arising during the parse. The tree is created with
                                               the callbacks currently in the parser.

Definition at line 57 of file parse.cpp.

57{ _RYML_CHECK_BASIC(parser); _RYML_CHECK_BASIC(parser->m_evt_handler); Tree tree(parser->callbacks()); parse_in_place(parser, filename, yaml, &tree, tree.root_id()); return tree; }

c4::yml::ParseEngine::callbacks

Callbacks const & callbacks() const

Get the current callbacks in the parser.

Definition parse_engine.hpp:326

c4::yml::Tree

Definition tree.hpp:250

◆ parse_in_place() [8/8]

Tree c4::yml::parse_in_place	(	Parser *	parser,
		substr	yaml )

(8) like (7) but no filename will be reported

Definition at line 58 of file parse.cpp.

58{ _RYML_CHECK_BASIC(parser); _RYML_CHECK_BASIC(parser->m_evt_handler); Tree tree(parser->callbacks()); parse_in_place(parser, {} , yaml, &tree, tree.root_id()); return tree; }

◆ parse_json_in_place() [1/8]

void c4::yml::parse_json_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	json,
		Tree *	t,
		id_type	node_id )

(1) parse JSON into an existing tree node. The filename will be used in any error messages arising during the parse.

Definition at line 44 of file parse.cpp.

{
    _reset_tree_handler(parser, t, node_id);
    parser->parse_json_in_place_ev(filename, json);
}

◆ parse_json_in_place() [2/8]

void c4::yml::parse_json_in_place	(	Parser *	parser,
		substr	json,
		Tree *	t,
		id_type	node_id )

(2) like (1) but no filename will be reported

Definition at line 72 of file parse.cpp.

72{ parse_json_in_place(parser, {}, json, t, node_id); }

c4::yml::parse_json_in_place

void parse_json_in_place(Parser *parser, csubstr filename, substr json, Tree *t, id_type node_id)

(1) parse JSON into an existing tree node. The filename will be used in any error messages arising du...

Definition parse.cpp:44

◆ parse_json_in_place() [3/8]

void c4::yml::parse_json_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	json,
		Tree *	t )

(3) parse JSON into an existing tree, into its root node.

Definition at line 73 of file parse.cpp.

73{ _RYML_CHECK_BASIC(t); if(t->empty()) { t->reserve(); } parse_json_in_place(parser, filename, json, t, t->root_id()); }

◆ parse_json_in_place() [4/8]

void c4::yml::parse_json_in_place	(	Parser *	parser,
		substr	json,
		Tree *	t )

(4) like (3) but no filename will be reported

Definition at line 74 of file parse.cpp.

74{ _RYML_CHECK_BASIC(t); if(t->empty()) { t->reserve(); } parse_json_in_place(parser, {} , json, t, t->root_id()); }

◆ parse_json_in_place() [5/8]

void c4::yml::parse_json_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	json,
		NodeRef	node )

(5) like (1) but the node is given as a NodeRef

Definition at line 75 of file parse.cpp.

75{ _RYML_CHECK_BASIC(!node.invalid()); parse_json_in_place(parser, filename, json, node.tree(), node.id()); }

◆ parse_json_in_place() [6/8]

void c4::yml::parse_json_in_place	(	Parser *	parser,
		substr	json,
		NodeRef	node )

(6) like (5) but no filename will be reported

Definition at line 76 of file parse.cpp.

76{ _RYML_CHECK_BASIC(!node.invalid()); parse_json_in_place(parser, {} , json, node.tree(), node.id()); }

◆ parse_json_in_place() [7/8]

Tree c4::yml::parse_json_in_place	(	Parser *	parser,
		csubstr	filename,
		substr	json )

(7) create a new tree, and parse JSON into its root node.

Definition at line 77 of file parse.cpp.

77{ _RYML_CHECK_BASIC(parser); _RYML_CHECK_BASIC(parser->m_evt_handler); Tree tree(parser->callbacks()); parse_json_in_place(parser, filename, json, &tree, tree.root_id()); return tree; }

◆ parse_json_in_place() [8/8]

Tree c4::yml::parse_json_in_place	(	Parser *	parser,
		substr	json )