Sample helpers

Helper utilities used in the 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	ErrorHandlerExample
	an example error handler, required for some of the quickstart examples. More...
struct	ScopedErrorHandlerExample
	Shows how to create a scoped error handler. More...
struct	GlobalAllocatorExample
struct	PerTreeMemoryExample
	an example for a per-tree memory allocator More...

Macros
#define	CHECK(predicate)   assert(predicate)
	a quick'n'dirty assertion to verify a predicate More...

Functions
template<class CharContainer >
CharContainer	file_get_contents (const char *filename)
	load a file from disk and return a newly created CharContainer More...
template<class CharContainer >
size_t	file_get_contents (const char *filename, CharContainer *v)
	load a file from disk into an existing CharContainer More...
template<class CharContainer >
void	file_put_contents (const char *filename, CharContainer const &v, const char *access)
	save a buffer into a file More...
void	file_put_contents (const char *filename, const char *buf, size_t sz, const char *access)
	save a buffer into a file More...
bool	report_check (int line, const char *predicate, bool result)
int	report_checks ()
void	stopexec (std::string const &s)
	interrupt execution More...
template<class Fn >
bool	ErrorHandlerExample::check_assertion_occurs (Fn &&fn)
	checking that an assertion occurs while calling fn. More...
template<class Fn >
bool	ErrorHandlerExample::check_error_occurs (Fn &&fn)
	checking that an error occurs while calling fn More...
void	ErrorHandlerExample::on_error_basic (ryml::csubstr msg, ryml::ErrorDataBasic const &errdata)
	this is where the callback implementation goes. More...
void	ErrorHandlerExample::on_error_parse (ryml::csubstr msg, ryml::ErrorDataParse const &errdata)
	this is where the callback implementation goes. More...
void	ErrorHandlerExample::on_error_visit (ryml::csubstr msg, ryml::ErrorDataVisit const &errdata)
	this is where the callback implementation goes. More...
static void	ErrorHandlerExample::s_error_basic (ryml::csubstr msg, ryml::ErrorDataBasic const &errdata, void *this_)
	trampoline function to call the object's method More...
static void	ErrorHandlerExample::s_error_parse (ryml::csubstr msg, ryml::ErrorDataParse const &errdata, void *this_)
	trampoline function to call the object's method More...
static void	ErrorHandlerExample::s_error_visit (ryml::csubstr msg, ryml::ErrorDataVisit const &errdata, void *this_)
	trampoline function to call the object's method More...
ryml::Callbacks	ErrorHandlerExample::callbacks ()
	a helper to create the Callbacks object for the custom error handler More...
void	ErrorHandlerExample::check_enabled () const
	test that this handler is currently set More...
void	ErrorHandlerExample::check_disabled () const
	test that this handler is currently not set More...

Variables
static std::jmp_buf	s_jmp_env
static std::string	s_jmp_msg

Detailed Description

Helper utilities used in the sample.

Macro Definition Documentation

CHECK

#define CHECK

(

predicate

)

assert(predicate)

a quick'n'dirty assertion to verify a predicate

Definition at line 278 of file quickstart.cpp.

Function Documentation

file_get_contents() [1/2]

template<class CharContainer >

CharContainer file_get_contents

(

const char *

filename

)

load a file from disk and return a newly created CharContainer

Definition at line 6210 of file quickstart.cpp.

file_get_contents() [2/2]

template<class CharContainer >

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

load a file from disk into an existing CharContainer

Definition at line 6191 of file quickstart.cpp.

                       {};
    saved_visit_id = ryml::NONE;
    bool got_error = false;
    #ifdef C4_EXCEPTIONS
    try
    {
        std::forward<Fn>(fn)();
    }
    catch(std::exception const&)
    {
        got_error = true;
    }
    #else
    if(setjmp(s_jmp_env) == 0)
    {
        std::forward<Fn>(fn)();

file_put_contents() [1/2]

template<class CharContainer >

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

save a buffer into a file

Definition at line 6219 of file quickstart.cpp.

{
    #ifdef C4_EXCEPTIONS
    throw std::runtime_error(s);
    #else

References s_jmp_env, and s_jmp_msg.

file_put_contents() [2/2]

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

save a buffer into a file

Definition at line 6225 of file quickstart.cpp.

{

report_check()

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

Definition at line 5986 of file quickstart.cpp.

                                                     {"));
    CHECK(loc.offset == 0u);
    CHECK(loc.line == 0u);
    CHECK(loc.col == 0u);
    // on the next call, we only pay O(log(numlines)) because the
    // rebuild is already available:
    loc = tree["aa"].location(parser);
    CHECK(parser.location_contents(loc).begins_with("aa"));
    CHECK(loc.offset == 2u);
    CHECK(loc.line == 1u);
    CHECK(loc.col == 0u);
    // KEYSEQ in flow style: points at the key

report_checks()

int report_checks

(

)

Definition at line 6000 of file quickstart.cpp.

stopexec()

void stopexec

(

std::string const &

s

)

interrupt execution

Definition at line 6069 of file quickstart.cpp.

                                                                 : "));

check_assertion_occurs()

template<class Fn >

bool ErrorHandlerExample::check_assertion_occurs

(

Fn &&

fn

)

checking that an assertion occurs while calling fn.

assertions are enabled if RYML_USE_ASSERT is defined.

Definition at line 6023 of file quickstart.cpp.

check_error_occurs()

template<class Fn >

bool ErrorHandlerExample::check_error_occurs

(

Fn &&

fn

)

checking that an error occurs while calling fn

Definition at line 6035 of file quickstart.cpp.

     : buffer
to: be parsed
map with key:
  first: value
  second: value
seq with key:
  - first value
  - second value
  -
    - nested first value
    - nested second value
  -
    nested first: value
    nested second: value
)");
    // (Likewise, the docval tree can no longer be used to query.)
    //
    // For key-less block-style maps, the location of the container
    // points at the first child's key. For example, in this case
    // the root does not have a key, so its location is taken
    // to be at the first child:
    loc = tree2.rootref().location(parser);
    CHECK(parser.location_contents(loc).begins_with("a new"));
    CHECK(loc.offset == 1u);
    CHECK(loc.line == 1u);
    CHECK(loc.col == 0u);
    // note the first child points exactly at the same place:
    loc = tree2["a new"].location(parser);
    CHECK(parser.location_contents(loc).begins_with("a new"));

on_error_basic()

void ErrorHandlerExample::on_error_basic	(	ryml::csubstr	msg,
		ryml::ErrorDataBasic const &	errdata
	)

this is where the callback implementation goes.

Remember that it must not return.

Definition at line 6081 of file quickstart.cpp.

                                                                 : "));

on_error_parse()

void ErrorHandlerExample::on_error_parse	(	ryml::csubstr	msg,
		ryml::ErrorDataParse const &	errdata
	)

this is where the callback implementation goes.

Remember that it must not return.

See also

ryml::format_location_context

Definition at line 6096 of file quickstart.cpp.

                                                                 : "));
    CHECK(loc.line == 13u);

on_error_visit()

void ErrorHandlerExample::on_error_visit	(	ryml::csubstr	msg,
		ryml::ErrorDataVisit const &	errdata
	)

this is where the callback implementation goes.

Remember that it must not return.

Definition at line 6116 of file quickstart.cpp.

            {
static int num_checks = 0;
static int num_failed_checks = 0;
} // namespace /*anon*/
 

s_error_basic()

void ErrorHandlerExample::s_error_basic ( ryml::csubstr  msg, ryml::ErrorDataBasic const &  errdata, void *  this_  )

static

trampoline function to call the object's method

Definition at line 6136 of file quickstart.cpp.

{
    ++num_checks;
    const char *msg = predicate ? "OK! " : "OK!";
    if(!result)

s_error_parse()

void ErrorHandlerExample::s_error_parse ( ryml::csubstr  msg, ryml::ErrorDataParse const &  errdata, void *  this_  )

static

trampoline function to call the object's method

Definition at line 6141 of file quickstart.cpp.

                                : " : "FAIL";
    }
    std::cout << __FILE__ << ':' << line << ": " << msg << (predicate ? predicate : "") << std::endl;

s_error_visit()

void ErrorHandlerExample::s_error_visit ( ryml::csubstr  msg, ryml::ErrorDataVisit const &  errdata, void *  this_  )

static

trampoline function to call the object's method

Definition at line 6146 of file quickstart.cpp.

{

callbacks()

ryml::Callbacks ErrorHandlerExample::callbacks

(

)

a helper to create the Callbacks object for the custom error handler

Definition at line 6155 of file quickstart.cpp.

check_enabled()

void ErrorHandlerExample::check_enabled

(

)

const

test that this handler is currently set

Definition at line 6165 of file quickstart.cpp.

{

check_disabled()

void ErrorHandlerExample::check_disabled

(

)

const

test that this handler is currently not set

Definition at line 6175 of file quickstart.cpp.

Variable Documentation

s_jmp_env

std::jmp_buf s_jmp_env

static

Definition at line 6015 of file quickstart.cpp.

s_jmp_msg

std::string s_jmp_msg

static

Definition at line 6016 of file quickstart.cpp.