c4::yml::Callbacks Struct Reference

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 540 of file common.hpp.

Constructor & Destructor Documentation

Callbacks() [1/2]

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
{
}

Callbacks() [2/2]

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

set_user_data()

Callbacks & c4::yml::Callbacks::set_user_data

(

void *

user_data

)

Set the user data.

Definition at line 144 of file common.cpp.

{
    m_user_data = user_data;
    return *this;
}

set_allocate()

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.

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

set_free()

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.

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

set_error_basic()

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.

{
    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;
}

set_error_parse()

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.

{
    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;
}

set_error_visit()

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.

{
    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;
}

operator!=()

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

inline

Definition at line 592 of file common.hpp.

{ return !operator==(that); }

operator==()

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

inline

Definition at line 593 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

m_user_data

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

data to be forwarded in every call to a callback

Definition at line 542 of file common.hpp.

m_allocate

pfn_allocate c4::yml::Callbacks::m_allocate

a pointer to an allocate handler function

Definition at line 543 of file common.hpp.

m_free

pfn_free c4::yml::Callbacks::m_free

a pointer to a free handler function

Definition at line 544 of file common.hpp.

m_error_basic

pfn_error_basic c4::yml::Callbacks::m_error_basic

a pointer to a basic error handler function

Definition at line 545 of file common.hpp.

m_error_parse

pfn_error_parse c4::yml::Callbacks::m_error_parse

a pointer to a parse error handler function

Definition at line 546 of file common.hpp.

m_error_visit

pfn_error_visit c4::yml::Callbacks::m_error_visit

a pointer to a visit error handler function

Definition at line 547 of file common.hpp.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.13.0/src/c4/yml/common.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.13.0/src/c4/yml/common.cpp