Sample helpers

Functions and classes used in the examples of this sample. More...

Modules
	Serialize/deserialize scalar types
	Serialize/deserialize container types
	To serialize/deserialize container types to a tree, implement the appropriate functions:

Classes
struct	sample::ErrorHandlerExample
	this is an example error handler, required for some of the quickstart examples. More...
struct	sample::ScopedErrorHandlerExample
	Shows how to easily create a scoped error handler. More...
struct	sample::GlobalAllocatorExample
struct	sample::PerTreeMemoryExample
	an example for a per-tree memory allocator More...

Macros
#define	CHECK(predicate)   assert(predicate)

Functions
bool	sample::report_check (int line, const char *predicate, bool result)
template<class CharContainer >
CharContainer	sample::file_get_contents (const char *filename)
	load a file from disk and return a newly created CharContainer More...
template<class CharContainer >
size_t	sample::file_get_contents (const char *filename, CharContainer *v)
	load a file from disk into an existing CharContainer More...
template<class CharContainer >
void	sample::file_put_contents (const char *filename, CharContainer const &v, const char *access)
	save a buffer into a file More...
void	sample::file_put_contents (const char *filename, const char *buf, size_t sz, const char *access)
	save a buffer into a file More...
int	sample::report_checks ()
	sample::C4_IF_EXCEPTIONS_ (, static std::jmp_buf s_jmp_env;static std::string s_jmp_msg;) template< class Fn > bool ErrorHandlerExample
	this C-style callback is the one stored and used by ryml. More...
void	sample::ErrorHandlerExample::on_error (const char *msg, size_t len, ryml::Location loc)
	this is the where the callback implementation goes. More...

Detailed Description

Functions and classes used in the examples of this sample.

Macro Definition Documentation

CHECK

#define CHECK

(

predicate

)

assert(predicate)

Definition at line 234 of file quickstart.cpp.

Function Documentation

report_check()

bool sample::report_check	(	int	line,
		const char *	predicate,
		bool	result
	)

Definition at line 5365 of file quickstart.cpp.

                                                                 : "));

file_get_contents() [1/2]

template<class CharContainer >

CharContainer sample::file_get_contents

(

const char *

filename

)

load a file from disk and return a newly created CharContainer

Definition at line 5493 of file quickstart.cpp.

{
#if RYML_USE_ASSERT
    return check_error_occurs(fn);
#else
    (void)fn; // do nothing otherwise, as there would be undefined behavior

References sample::ErrorHandlerExample::check_error_occurs().

file_get_contents() [2/2]

template<class CharContainer >

size_t sample::file_get_contents	(	const char *	filename,
		CharContainer *	v
	)

load a file from disk into an existing CharContainer

Definition at line 5474 of file quickstart.cpp.

{
    bool expected_error_occurred = false;
    C4_IF_EXCEPTIONS_(try, if(setjmp(s_jmp_env) == 0)) // selectively picks based on availability of exceptions
    {
        fn();
    }
    C4_IF_EXCEPTIONS_(catch(...), else)
    {
        expected_error_occurred = true;
    }

References sample::C4_IF_EXCEPTIONS_().

file_put_contents() [1/2]

template<class CharContainer >

void sample::file_put_contents	(	const char *	filename,
		CharContainer const &	v,
		const char *	access = "wb"
	)

save a buffer into a file

Definition at line 5502 of file quickstart.cpp.

{

Referenced by sample::sample_parse_file().

file_put_contents() [2/2]

void sample::file_put_contents	(	const char *	filename,
		const char *	buf,
		size_t	sz,
		const char *	access
	)

save a buffer into a file

Definition at line 5508 of file quickstart.cpp.

{
    std::string full_msg = ryml::formatrs<std::string>(
        "{}:{}:{} ({}B): ERROR: {}",
        loc.name, loc.line, loc.col, loc.offset, ryml::csubstr(msg, len));

report_checks()

int sample::report_checks

(

)

Definition at line 5379 of file quickstart.cpp.

                                                                 : "));

C4_IF_EXCEPTIONS_()

sample::C4_IF_EXCEPTIONS_

(

static std::jmp_buf s_jmp_env;static std::string s_jmp_msg;

)

this C-style callback is the one stored and used by ryml.

It is a trampoline function calling on_error()

Definition at line 5392 of file quickstart.cpp.

                                                                 : "));
    CHECK(loc.line == 13u);
    CHECK(loc.col == 4u);
    loc = tree2["seq with key"][3][0].location(parser);
    CHECK(parser.location_contents(loc).begins_with("nested first: "));
    CHECK(loc.line == 13u);
    CHECK(loc.col == 4u);
}
 
 

Referenced by sample::file_get_contents().

on_error()

void sample::ErrorHandlerExample::on_error	(	const char *	msg,
		size_t	len,
		ryml::Location	loc
	)

this is the where the callback implementation goes.

Remember that it must not return.

Definition at line 5431 of file quickstart.cpp.

            {
static int num_checks = 0;
static int num_failed_checks = 0;
} // namespace /*anon*/
 
 
bool report_check(int line, const char *predicate, bool result)
{