c4::yml::EventHandlerStack< HandlerImpl, HandlerState > Struct Template Reference

Use this class a base of implementations of event handler to simplify the stack logic. More...

#include <event_handler_stack.hpp>

Public Types
using	state = HandlerState

Public Attributes
detail::stack< state >	m_stack
state *	m_curr
	current stack level: top of the stack. cached here for easier access. More...
state *	m_parent
	parent of the current stack level. More...
substr	m_src

Protected Member Functions
	EventHandlerStack ()
	EventHandlerStack (Callbacks const &cb)
void	_stack_start_parse (const char *filename, substr ymlsrc)
void	_stack_finish_parse ()
void	_stack_reset_root ()
void	_stack_reset_non_root ()
void	_stack_push ()
void	_stack_pop ()
bool	_stack_should_push_on_begin_doc () const
bool	_stack_should_pop_on_end_doc () const

Detailed Description

template<class HandlerImpl, class HandlerState>
struct c4::yml::EventHandlerStack< HandlerImpl, HandlerState >

Use this class a base of implementations of event handler to simplify the stack logic.

Definition at line 37 of file event_handler_stack.hpp.

Member Typedef Documentation

state

template<class HandlerImpl , class HandlerState >

using c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::state = HandlerState

Definition at line 42 of file event_handler_stack.hpp.

Constructor & Destructor Documentation

EventHandlerStack() [1/2]

template<class HandlerImpl , class HandlerState >

c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::EventHandlerStack ( )

inlineprotected

Definition at line 53 of file event_handler_stack.hpp.

: m_stack(), m_curr(), m_parent(), m_src() {} // NOLINT

EventHandlerStack() [2/2]

template<class HandlerImpl , class HandlerState >

c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::EventHandlerStack ( Callbacks const &  cb )

inlineprotected

Definition at line 54 of file event_handler_stack.hpp.

: m_stack(cb), m_curr(), m_parent(), m_src() {} // NOLINT

Member Function Documentation

_stack_start_parse()

template<class HandlerImpl , class HandlerState >

void c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_start_parse ( const char *  filename, substr  ymlsrc  )

inlineprotected

Definition at line 58 of file event_handler_stack.hpp.

    {
        _RYML_ASSERT_BASIC_(m_stack.m_callbacks, m_curr != nullptr);
        m_curr->start_parse(filename, m_curr->node_id);
        m_src = ymlsrc;
    }

References c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_src, and c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack.

_stack_finish_parse()

template<class HandlerImpl , class HandlerState >

void c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_finish_parse ( )

inlineprotected

Definition at line 65 of file event_handler_stack.hpp.

    {
    }

_stack_reset_root()

template<class HandlerImpl , class HandlerState >

void c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_reset_root ( )

inlineprotected

Definition at line 71 of file event_handler_stack.hpp.

    {
        m_stack.clear();
        m_stack.push({});
        m_parent = nullptr;
        m_curr = &m_stack.top();
    }

References c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_parent, and c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack.

_stack_reset_non_root()

template<class HandlerImpl , class HandlerState >

void c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_reset_non_root ( )

inlineprotected

Definition at line 79 of file event_handler_stack.hpp.

    {
        m_stack.clear();
        m_stack.push({}); // parent
        m_stack.push({}); // node
        m_parent = &m_stack.top(1);
        m_curr = &m_stack.top();
    }

References c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_parent, and c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack.

_stack_push()

template<class HandlerImpl , class HandlerState >

void c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_push ( )

inlineprotected

Definition at line 88 of file event_handler_stack.hpp.

    {
        m_stack.push_top();
        m_parent = &m_stack.top(1); // don't use m_curr. watch out for relocations inside the prev push
        m_curr = &m_stack.top();
        m_curr->reset_after_push();
    }

References c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_parent, and c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack.

_stack_pop()

template<class HandlerImpl , class HandlerState >

void c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_pop ( )

inlineprotected

Definition at line 96 of file event_handler_stack.hpp.

    {
        _RYML_ASSERT_BASIC_(m_stack.m_callbacks, m_parent);
        _RYML_ASSERT_BASIC_(m_stack.m_callbacks, m_stack.size() > 1);
        m_parent->reset_before_pop(*m_curr);
        m_stack.pop();
        m_parent = m_stack.size() > 1 ? &m_stack.top(1) : nullptr;
        m_curr = &m_stack.top();
        #ifdef RYML_DBG
        if(m_parent)
            _c4dbgpf("popped! top is now node={} (parent={})", m_curr->node_id, m_parent->node_id);
        else
            _c4dbgpf("popped! top is now node={} @ ROOT", m_curr->node_id);
        #endif
    }

References c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_parent, and c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack.

_stack_should_push_on_begin_doc()

template<class HandlerImpl , class HandlerState >

bool c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_should_push_on_begin_doc ( ) const

inlineprotected

Definition at line 121 of file event_handler_stack.hpp.

    {
        const bool is_root = (m_stack.size() == 1u);
        return is_root && (m_curr->has_children || _has_any_(DOC|VAL|MAP|SEQ));
    }

References _has_any_, c4::yml::DOC, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr, c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack, c4::yml::MAP, c4::yml::SEQ, and c4::yml::VAL.

_stack_should_pop_on_end_doc()

template<class HandlerImpl , class HandlerState >

bool c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::_stack_should_pop_on_end_doc ( ) const

inlineprotected

Definition at line 127 of file event_handler_stack.hpp.

    {
        const bool is_root = (m_stack.size() == 1u);
        return !is_root && _has_any_(DOC);
    }

References _has_any_, c4::yml::DOC, and c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack.

Member Data Documentation

m_stack

template<class HandlerImpl , class HandlerState >

detail::stack<state> c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_stack

Definition at line 46 of file event_handler_stack.hpp.

m_curr

template<class HandlerImpl , class HandlerState >

state* c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_curr

current stack level: top of the stack. cached here for easier access.

Definition at line 47 of file event_handler_stack.hpp.

m_parent

template<class HandlerImpl , class HandlerState >

state* c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_parent

parent of the current stack level.

Definition at line 48 of file event_handler_stack.hpp.

m_src

template<class HandlerImpl , class HandlerState >

substr c4::yml::EventHandlerStack< HandlerImpl, HandlerState >::m_src

Definition at line 49 of file event_handler_stack.hpp.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.12.0/src/c4/yml/event_handler_stack.hpp