A c-style callbacks class to customize behavior on errors or allocation. More...

#include <common.hpp>

Public Member Functions
	Callbacks () noexcept
	Construct an object with the default callbacks. More...

	Callbacks (void *user_data, pfn_allocate alloc, pfn_free free, pfn_error_basic error_basic)

Callbacks &	set_user_data (void *user_data)
	Set the user data. More...

Callbacks &	set_allocate (pfn_allocate allocate=nullptr)
	Set or reset the allocate callback. More...

Callbacks &	set_free (pfn_free free=nullptr)
	Set or reset the free callback. More...

Callbacks &	set_error_basic (pfn_error_basic error_basic=nullptr)
	Set or reset the error_basic callback. More...

Callbacks &	set_error_parse (pfn_error_parse error_parse=nullptr)
	Set or reset the error_parse callback. More...

Callbacks &	set_error_visit (pfn_error_visit error_visit=nullptr)
	Set or reset the error_visit callback. More...

bool	operator!= (Callbacks const &that) const

bool	operator== (Callbacks const &that) const

Public Attributes
void *	m_user_data
	data to be forwarded in every call to a callback More...

pfn_allocate	m_allocate
	a pointer to an allocate handler function More...

pfn_free	m_free
	a pointer to a free handler function More...

pfn_error_basic	m_error_basic
	a pointer to a basic error handler function More...

pfn_error_parse	m_error_parse
	a pointer to a parse error handler function More...

pfn_error_visit	m_error_visit
	a pointer to a visit error handler function More...

Detailed Description

A c-style callbacks class to customize behavior on errors or allocation.

Can be used globally by the library and/or locally by Tree and Parser objects.

Definition at line 373 of file common.hpp.

Constructor & Destructor Documentation

c4::yml::Callbacks::Callbacks ( )

noexcept

Construct an object with the default callbacks.

If RYML_NO_DEFAULT_CALLBACKS is defined, the object will be set with null members.

Definition at line 105 of file common.cpp.

     :
     m_user_data(nullptr),
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_allocate(allocate_impl),
     m_free(free_impl),
     m_error_basic(error_basic_impl),
     m_error_parse(error_parse_impl),
     m_error_visit(error_visit_impl)
     #else
     m_allocate(nullptr),
     m_free(nullptr),
     m_error_basic(nullptr),
     m_error_parse(nullptr),
     m_error_visit(nullptr)
     #endif
 {
 }

c4::yml::Callbacks::Callbacks	(	void *	user_data,
		pfn_allocate	alloc,
		pfn_free	free,
		pfn_error_basic	error_basic
	)

Definition at line 124 of file common.cpp.

     :
     m_user_data(user_data),
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_allocate(alloc_ ? alloc_ : allocate_impl),
     m_free(free_ ? free_ : free_impl),
     m_error_basic(error_basic_ ? error_basic_ : error_basic_impl),
     m_error_parse(error_parse_impl),
     m_error_visit(error_visit_impl)
     #else
     m_allocate(alloc_),
     m_free(free_),
     m_error_basic(error_basic_),
     m_error_parse(nullptr),
     m_error_visit(nullptr)
     #endif
 {
 }

Member Function Documentation

Callbacks & c4::yml::Callbacks::set_user_data ( void * user_data )

Set the user data.

Definition at line 144 of file common.cpp.

Referenced by ErrorHandlerExample::callbacks(), and GlobalAllocatorExample::callbacks().

 {
     m_user_data = user_data;
     return *this;
 }

Callbacks & c4::yml::Callbacks::set_allocate ( pfn_allocate allocate = nullptr )

Set or reset the allocate callback.

When the parameter is null, m_allocate will fall back to ryml's default allocate implementation, unless RYML_NO_DEFAULT_CALLBACKS is defined.

Definition at line 150 of file common.cpp.

Referenced by GlobalAllocatorExample::callbacks(), and default_callbacks().

 {
     m_allocate = allocate;
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_allocate = m_allocate ? m_allocate : allocate_impl;
     #endif
     return *this;
 }

Callbacks & c4::yml::Callbacks::set_free ( pfn_free free = nullptr )

Set or reset the free callback.

When the parameter is null, m_free will fall back to ryml's default free implementation, unless RYML_NO_DEFAULT_CALLBACKS is defined.

Definition at line 159 of file common.cpp.

Referenced by GlobalAllocatorExample::callbacks().

 {
     m_free = free;
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_free = m_free ? m_free : free_impl;
     #endif
     return *this;
 }

Callbacks & c4::yml::Callbacks::set_error_basic ( pfn_error_basic error_basic = nullptr )

Set or reset the error_basic callback.

When the parameter is null, m_error_basic will fall back to ryml's default error_basic implementation, unless RYML_NO_DEFAULT_CALLBACKS is defined.

Definition at line 168 of file common.cpp.

Referenced by ErrorHandlerExample::callbacks().

 {
     m_error_basic = error_basic;
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_error_basic = m_error_basic ? m_error_basic : error_basic_impl;
     #endif
     return *this;
 }

Callbacks & c4::yml::Callbacks::set_error_parse ( pfn_error_parse error_parse = nullptr )

Set or reset the error_parse callback.

When the parameter is null, m_error_parse will fall back to ryml's default error_parse implementation, unless RYML_NO_DEFAULT_CALLBACKS is defined.

Definition at line 177 of file common.cpp.

Referenced by ErrorHandlerExample::callbacks().

 {
     m_error_parse = error_parse;
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_error_parse = m_error_parse ? m_error_parse : error_parse_impl;
     #endif
     return *this;
 }

Callbacks & c4::yml::Callbacks::set_error_visit ( pfn_error_visit error_visit = nullptr )

Set or reset the error_visit callback.

When the parameter is null, m_error_visit will fall back to ryml's default error_visit implementation, unless RYML_NO_DEFAULT_CALLBACKS is defined.

Definition at line 186 of file common.cpp.

Referenced by ErrorHandlerExample::callbacks().

 {
     m_error_visit = error_visit;
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_error_visit = m_error_visit ? m_error_visit : error_visit_impl;
     #endif
     return *this;
 }

bool c4::yml::Callbacks::operator!= ( Callbacks const & that ) const

inline

Definition at line 425 of file common.hpp.

425 { return !operator==(that); }

c4::yml::Callbacks::operator==

bool operator==(Callbacks const &that) const

Definition: common.hpp:426

bool c4::yml::Callbacks::operator== ( Callbacks const & that ) const

inline

Definition at line 426 of file common.hpp.

     {
         return (m_user_data == that.m_user_data &&
                 m_allocate == that.m_allocate &&
                 m_free == that.m_free &&
                 m_error_basic == that.m_error_basic &&
                 m_error_parse == that.m_error_parse &&
                 m_error_visit == that.m_error_visit);
     }

Member Data Documentation

void* c4::yml::Callbacks::m_user_data

data to be forwarded in every call to a callback

Definition at line 375 of file common.hpp.

Referenced by PerTreeMemoryExample::callbacks(), c4::yml::err_basic(), c4::yml::err_parse(), c4::yml::err_visit(), operator==(), and set_user_data().

pfn_allocate c4::yml::Callbacks::m_allocate

a pointer to an allocate handler function

Definition at line 376 of file common.hpp.

Referenced by PerTreeMemoryExample::callbacks(), ErrorHandlerExample::check_disabled(), ErrorHandlerExample::check_enabled(), operator==(), and set_allocate().

pfn_free c4::yml::Callbacks::m_free

a pointer to a free handler function

Definition at line 377 of file common.hpp.

Referenced by PerTreeMemoryExample::callbacks(), ErrorHandlerExample::check_disabled(), ErrorHandlerExample::check_enabled(), operator==(), and set_free().

pfn_error_basic c4::yml::Callbacks::m_error_basic

a pointer to a basic error handler function

Definition at line 378 of file common.hpp.

Referenced by ErrorHandlerExample::check_disabled(), ErrorHandlerExample::check_enabled(), c4::yml::err_basic(), c4::yml::err_parse(), c4::yml::err_visit(), operator==(), and set_error_basic().

pfn_error_parse c4::yml::Callbacks::m_error_parse

a pointer to a parse error handler function

Definition at line 379 of file common.hpp.

Referenced by ErrorHandlerExample::check_disabled(), ErrorHandlerExample::check_enabled(), c4::yml::err_parse(), operator==(), sample_error_parse(), and set_error_parse().

pfn_error_visit c4::yml::Callbacks::m_error_visit

a pointer to a visit error handler function

Definition at line 380 of file common.hpp.

Referenced by ErrorHandlerExample::check_disabled(), ErrorHandlerExample::check_enabled(), c4::yml::err_visit(), operator==(), sample_error_visit(), and set_error_visit().

The documentation for this struct was generated from the following files:

/tmp/B.egjz6vsx/BUILD/rapidyaml-0.16.0-build/rapidyaml-0.16.0/src/c4/yml/common.hpp
/tmp/B.egjz6vsx/BUILD/rapidyaml-0.16.0-build/rapidyaml-0.16.0/src/c4/yml/common.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation