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 229 of file quickstart.cpp.

Function Documentation

report_check()

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

Definition at line 5198 of file quickstart.cpp.

{
    ++num_checks;
    const char *msg = predicate ? "OK! " : "OK!";
    if(!result)
    {
        ++num_failed_checks;
        msg = predicate ?  "ERROR: " : "ERROR";
    }
    std::cout << __FILE__ << ':' << line << ": " << msg << (predicate ? predicate : "") << std::endl;
    return result;
}

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 5326 of file quickstart.cpp.

{
    CharContainer cc;
    file_get_contents(filename, &cc);
    return cc;
}

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 5307 of file quickstart.cpp.

{
    std::FILE *fp = std::fopen(filename, "rb");
    RYML_CHECK_MSG(fp != nullptr, "could not open file");
    std::fseek(fp, 0, SEEK_END);
    long sz = std::ftell(fp);
    v->resize(static_cast<typename CharContainer::size_type>(sz));
    if(sz)
    {
        std::rewind(fp);
        size_t ret = std::fread(&(*v)[0], 1, v->size(), fp);
        RYML_CHECK(ret == (size_t)sz);
    }
    std::fclose(fp);
    return v->size();
}

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 5335 of file quickstart.cpp.

{
    file_put_contents(filename, v.empty() ? "" : &v[0], v.size(), access);
}

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 5341 of file quickstart.cpp.

{
    std::FILE *fp = std::fopen(filename, access);
    RYML_CHECK_MSG(fp != nullptr, "could not open file");
    std::fwrite(buf, 1, sz, fp);
    std::fclose(fp);
}

Referenced by sample::sample_parse_file().

report_checks()

int sample::report_checks

(

)

Definition at line 5212 of file quickstart.cpp.

{
    std::cout << "Completed " << num_checks << " checks." << std::endl;
    if(num_failed_checks)
        std::cout << "ERROR: " << num_failed_checks << '/' << num_checks << " checks failed." << std::endl;
    else
        std::cout << "SUCCESS!" << std::endl;
    return num_failed_checks;
}

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 5225 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;
    }
    return expected_error_occurred;
}
template<class Fn>
C4_NODISCARD bool ErrorHandlerExample::check_assertion_occurs(Fn &&fn) const
{
#if RYML_USE_ASSERT
    return check_error_occurs(fn);
#else
    (void)fn; // do nothing otherwise, as there would be undefined behavior
    return true;
#endif
}
 
/** this C-style callback is the one stored and used by ryml. It is a
 * trampoline function calling on_error() */
C4_NORETURN void ErrorHandlerExample::s_error(const char* msg, size_t len, ryml::Location loc, void *this_)
{
    ((ErrorHandlerExample*)this_)->on_error(msg, len, loc);
}

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 5264 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));
    C4_IF_EXCEPTIONS(
        // this will execute if exceptions are enabled.
        throw std::runtime_error(full_msg);
        ,
        // this will execute if exceptions are disabled. It will
        // jump to the function calling the corresponding setjmp().
        s_jmp_msg = full_msg;
        std::longjmp(s_jmp_env, 1);
    );
}

References c4::yml::Location::col, c4::yml::Location::line, c4::yml::Location::name, and c4::yml::Location::offset.