c4::yml::TagDirectives Struct Reference

#include <tag.hpp>

Public Member Functions
bool	redefines_qmrk () const noexcept
TagDirective const *	add (csubstr handle, csubstr prefix, id_type doc_id) noexcept
void	clear () noexcept
id_type	size () const noexcept
TagDirective const *	lookup (csubstr tag, id_type id) const noexcept
TagDirective *	begin () noexcept
TagDirective *	end () noexcept
TagDirective const *	begin () const noexcept
TagDirective const *	end () const noexcept
TagDirectiveRange	directives () const noexcept
TagDirectiveRange	lookup_range (id_type doc_id) const noexcept
csubstr	resolve (substr buf, size_t *bufsz, csubstr tag, id_type doc_id, Location const &ymlloc, Callbacks const &callbacks, bool with_brackets=true) const

Public Attributes
TagDirective	m_directives [RYML_MAX_TAG_DIRECTIVES]

Detailed Description

Definition at line 123 of file tag.hpp.

Member Function Documentation

redefines_qmrk()

bool c4::yml::TagDirectives::redefines_qmrk ( ) const

noexcept

add()

TagDirective const * c4::yml::TagDirectives::add ( csubstr  handle, csubstr  prefix, id_type  doc_id  )

noexcept

Definition at line 358 of file tag.cpp.

{
    id_type pos = size();
    TagDirective *C4_RESTRICT td = nullptr;
    if(pos < RYML_MAX_TAG_DIRECTIVES)
    {
        td = &m_directives[pos];
        td->handle = handle;
        td->prefix = prefix;
        td->doc_id = doc_id;
        _c4dbgpf("tagd[{}]: added! handle={} prefix={} doc={}", pos, td->handle, td->prefix, td->doc_id);
    }
    return td;
}

References c4::yml::TagDirective::handle, and RYML_MAX_TAG_DIRECTIVES.

clear()

void c4::yml::TagDirectives::clear ( )

noexcept

Definition at line 373 of file tag.cpp.

{
    for(TagDirective &td : m_directives)
    {
        td.handle = {};
        td.prefix = {};
        td.doc_id = NONE;
    }
}

References m_directives, and c4::yml::NONE.

size()

id_type c4::yml::TagDirectives::size ( ) const

noexcept

Definition at line 348 of file tag.cpp.

{
    // this assumes we have a very small number of tag directives
    id_type i = 0;
    for(; i < RYML_MAX_TAG_DIRECTIVES; ++i)
        if(m_directives[i].handle.empty())
            break;
    return i;
}

References m_directives, and RYML_MAX_TAG_DIRECTIVES.

lookup()

TagDirective const * c4::yml::TagDirectives::lookup ( csubstr  tag, id_type  id  ) const

noexcept

Definition at line 419 of file tag.cpp.

{
    _c4dbgpf("tagd: searching for {}, doc_id={}", _prs(tag), doc_id);
    for(id_type i = 0; i < RYML_MAX_TAG_DIRECTIVES; ++i)
    {
        TagDirective const& C4_RESTRICT td = m_directives[i];
        if(td.handle.empty())
        {
            continue;
        }
        _c4dbgpf("tagd[{}]: handle={} prefix={} doc_id={}", i, td.handle, td.prefix, td.doc_id);
        if(tag.begins_with(td.handle))
        {
            if(td.handle == '!' && (
                   tag.begins_with("!!")
                   || tag.begins_with('<')
                   || tag.begins_with("!<")
                   || is_custom_tag(tag)))
                continue;
            _c4dbgpf("tagd[{}]: matches handle!", i);
            if(doc_id == td.doc_id)
            {
                _c4dbgpf("tagd[{}]: matches doc={}!", i, doc_id);
                return &td;
            }
        }
    }
    return nullptr;
}

References c4::yml::is_custom_tag(), and RYML_MAX_TAG_DIRECTIVES.

begin() [1/2]

TagDirective* c4::yml::TagDirectives::begin ( )

inlinenoexcept

Definition at line 131 of file tag.hpp.

{ return m_directives; };

end() [1/2]

TagDirective* c4::yml::TagDirectives::end ( )

inlinenoexcept

Definition at line 132 of file tag.hpp.

{ return m_directives + size(); };

begin() [2/2]

TagDirective const* c4::yml::TagDirectives::begin ( ) const

inlinenoexcept

Definition at line 133 of file tag.hpp.

{ return m_directives; };

end() [2/2]

TagDirective const* c4::yml::TagDirectives::end ( ) const

inlinenoexcept

Definition at line 134 of file tag.hpp.

{ return m_directives + size(); };

directives()

TagDirectiveRange c4::yml::TagDirectives::directives ( ) const

inlinenoexcept

Definition at line 135 of file tag.hpp.

{ return TagDirectiveRange{m_directives, m_directives + size()}; }

lookup_range()

TagDirectiveRange c4::yml::TagDirectives::lookup_range ( id_type  doc_id ) const

noexcept

Definition at line 383 of file tag.cpp.

{
    TagDirective const* first = nullptr;
    TagDirective const* last = nullptr;
    for(id_type i = 0; i < RYML_MAX_TAG_DIRECTIVES; ++i)
    {
        TagDirective const& C4_RESTRICT td = m_directives[i];
        if(doc_id == td.doc_id)
        {
            first = m_directives + i;
            break;
        }
        else if(td.handle.empty())
        {
            break;
        }
    }
    if(first)
    {
        last = m_directives + RYML_MAX_TAG_DIRECTIVES;
        for(TagDirective const* C4_RESTRICT td = first; td < last; ++td)
        {
            if(doc_id != td->doc_id || td->handle.empty())
            {
                last = td;
                break;
            }
        }
    }
    else
    {
        first = last = m_directives;
    }
    return TagDirectiveRange{first, last};
}

References RYML_MAX_TAG_DIRECTIVES.

resolve()

csubstr c4::yml::TagDirectives::resolve	(	substr	buf,
		size_t *	bufsz,
		csubstr	tag,
		id_type	doc_id,
		Location const &	ymlloc,
		Callbacks const &	callbacks,
		bool	with_brackets = true
	)		const

Note

the str member of the return value may be null, meaning that the buffer was not enough to fit the transformed tag.

the return value may actually be not a substring of the input buffer.

Definition at line 449 of file tag.cpp.

{
    _RYML_ASSERT_BASIC_(callbacks, !buf.overlaps(tag));
    TagDirective const* C4_RESTRICT td = lookup(tag, id);
    *bufsz = 0;
    csubstr handle, prefix, ret;
    const char *errmsg = nullptr;
    size_t len;
    if(td)
    {
        handle = td->handle;
        prefix = td->prefix;
    }
    else
    {
        _c4dbgp("tagd: no directive found");
        if(tag.begins_with('<'))
        {
            _c4dbgp("tagd: already resolved");
            if(C4_UNLIKELY(!tag.ends_with('>')))
            {
                errmsg = "malformed tag";
                goto err; // NOLINT
            }
            return tag;
        }
        else if(tag.begins_with("!<"))
        {
            _c4dbgp("tagd: already resolved");
            if(C4_UNLIKELY(!tag.ends_with('>')))
            {
                errmsg = "malformed tag";
                goto err; // NOLINT
            }
            return tag.sub(1);
        }
        else if(tag.begins_with("!!"))
        {
            _c4dbgp("tagd: !!");
            YamlTag_e tagenum = to_tag(tag);
            if(tagenum != TAG_NONE)
            {
                _c4dbgpf("tagd: standard tag: {} -> {}", tag, from_tag_long(tagenum));
                tag = from_tag_long(tagenum);
                return with_brackets ? tag : tag.offs(1, 1);
            }
            handle = "!!";
            prefix = "tag:yaml.org,2002:";
        }
        else if(C4_UNLIKELY(is_custom_tag(tag)))
        {
            _c4dbgp("tagd: custom_tag");
            _c4dbgpf("tag '{}' at id={}: no matching directive was found", tag, id);
            errmsg = "tag without matching directive";
            goto err; // NOLINT
        }
        else
        {
            _c4dbgp("tagd: !");
            handle = prefix = "!";
        }
    }
    len = transform_tag(buf, handle, prefix, tag, callbacks, ymlloc, with_brackets);
    *bufsz = len;
    if(len <= buf.len)
    {
        ret = buf.first(len);
    }
    else
    {
        _c4dbgp("tagd: not enough room");
        ret.str = nullptr;
        ret.len = len;
    }
    return ret;
err:
    if(ymlloc)
    {
        _RYML_ERR_PARSE_(callbacks, ymlloc, errmsg);
    }
    else
    {
        _RYML_ERR_BASIC_(callbacks, errmsg);
    }
}

References c4::yml::from_tag_long(), c4::yml::is_custom_tag(), lookup(), c4::yml::TAG_NONE, c4::yml::to_tag(), and c4::yml::transform_tag().

Member Data Documentation

m_directives

TagDirective c4::yml::TagDirectives::m_directives[RYML_MAX_TAG_DIRECTIVES]

Definition at line 125 of file tag.hpp.

---

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

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