c4::yml::FilterProcessorInplaceEndExtending Struct Reference

Filters in place. More...

#include <filter_processor.hpp>

Public Member Functions
	FilterProcessorInplaceEndExtending (substr src_, size_t wcap_) noexcept
void	setwpos (size_t wpos_) noexcept
void	setpos (size_t rpos_, size_t wpos_) noexcept
void	set_at_end () noexcept
bool	has_more_chars () const noexcept
bool	has_more_chars (size_t maxpos) const noexcept
FilterResult	result () const noexcept
csubstr	sofar () const noexcept
csubstr	rem () const noexcept
char	curr () const noexcept
char	next () const noexcept
void	skip () noexcept
void	skip (size_t num) noexcept
void	set_at (size_t pos, char c) noexcept
void	set (char c) noexcept
void	set (char c, size_t num) noexcept
void	copy () noexcept
void	copy (size_t num) noexcept
void	translate_esc (char c) noexcept
void	translate_esc_bulk (const char *s, size_t nw, size_t nr) noexcept
void	translate_esc_extending (const char *s, size_t nw, size_t nr) noexcept

Public Attributes
substr	src
	the subject string
size_t	wcap
	write capacity - the capacity of the subject string's buffer
size_t	rpos
	read position
size_t	wpos
	write position

Detailed Description

Filters in place.

While the result may be larger than the source, any extending happens only at the end of the string. Consequently, it's impossible for characters to be left unfiltered.

See also

FilterProcessorInplaceMidExtending

Definition at line 166 of file filter_processor.hpp.

Constructor & Destructor Documentation

FilterProcessorInplaceEndExtending()

c4::yml::FilterProcessorInplaceEndExtending::FilterProcessorInplaceEndExtending ( substr src_, size_t wcap_ )

inlinenoexcept

Definition at line 173 of file filter_processor.hpp.

        : src(src_)
        , wcap(wcap_)
        , rpos(0)
        , wpos(0)
    {
        RYML_ASSERT_BASIC_(wcap >= src.len);
    }

Member Function Documentation

setwpos()

void c4::yml::FilterProcessorInplaceEndExtending::setwpos ( size_t wpos_ )

inlinenoexcept

Definition at line 182 of file filter_processor.hpp.

{ wpos = wpos_; }

setpos()

void c4::yml::FilterProcessorInplaceEndExtending::setpos ( size_t rpos_, size_t wpos_ )

inlinenoexcept

Definition at line 183 of file filter_processor.hpp.

{ rpos = rpos_; wpos = wpos_; }

set_at_end()

void c4::yml::FilterProcessorInplaceEndExtending::set_at_end ( )

inlinenoexcept

Definition at line 184 of file filter_processor.hpp.

{ skip(src.len - rpos); }

has_more_chars() [1/2]

bool c4::yml::FilterProcessorInplaceEndExtending::has_more_chars ( ) const

inlinenoexcept

Definition at line 186 of file filter_processor.hpp.

{ return rpos < src.len; }

has_more_chars() [2/2]

bool c4::yml::FilterProcessorInplaceEndExtending::has_more_chars ( size_t maxpos ) const

inlinenoexcept

Definition at line 187 of file filter_processor.hpp.

{ RYML_ASSERT_BASIC_(maxpos <= src.len); return rpos < maxpos; }

result()

FilterResult c4::yml::FilterProcessorInplaceEndExtending::result ( ) const

inlinenoexcept

Definition at line 189 of file filter_processor.hpp.

    {
        _c4dbgip("inplace: wpos={} wcap={} small={}", wpos, wcap, wpos > rpos);
        FilterResult ret;
        ret.str.str = (wpos <= wcap) ? src.str : nullptr;
        ret.str.len = wpos;
        return ret;
    }

sofar()

csubstr c4::yml::FilterProcessorInplaceEndExtending::sofar ( ) const

inlinenoexcept

Definition at line 197 of file filter_processor.hpp.

{ return csubstr(src.str, wpos <= wcap ? wpos : wcap); }

rem()

csubstr c4::yml::FilterProcessorInplaceEndExtending::rem ( ) const

inlinenoexcept

Definition at line 198 of file filter_processor.hpp.

{ return src.sub(rpos); }

curr()

char c4::yml::FilterProcessorInplaceEndExtending::curr ( ) const

inlinenoexcept

Definition at line 200 of file filter_processor.hpp.

{ RYML_ASSERT_BASIC_(rpos < src.len); return src[rpos]; }

next()

char c4::yml::FilterProcessorInplaceEndExtending::next ( ) const

inlinenoexcept

Definition at line 201 of file filter_processor.hpp.

{ return rpos+1 < src.len ? src[rpos+1] : '\0'; }

skip() [1/2]

void c4::yml::FilterProcessorInplaceEndExtending::skip ( )

inlinenoexcept

Definition at line 203 of file filter_processor.hpp.

{ ++rpos; }

Referenced by set_at_end().

skip() [2/2]

void c4::yml::FilterProcessorInplaceEndExtending::skip ( size_t num )

inlinenoexcept

Definition at line 204 of file filter_processor.hpp.

{ rpos += num; }

set_at()

void c4::yml::FilterProcessorInplaceEndExtending::set_at ( size_t pos, char c )

inlinenoexcept

Definition at line 206 of file filter_processor.hpp.

    {
        RYML_ASSERT_BASIC_(pos < wpos);
        const size_t save = wpos;
        wpos = pos;
        set(c);
        wpos = save;
    }

set() [1/2]

void c4::yml::FilterProcessorInplaceEndExtending::set ( char c )

inlinenoexcept

Definition at line 214 of file filter_processor.hpp.

    {
        if(wpos < wcap)  // respect write-capacity
            src.str[wpos] = c;
        ++wpos;
    }

Referenced by set_at().

set() [2/2]

void c4::yml::FilterProcessorInplaceEndExtending::set ( char c, size_t num )

inlinenoexcept

Definition at line 220 of file filter_processor.hpp.

    {
        RYML_ASSERT_BASIC_(num);
        if(wpos + num <= wcap)  // respect write-capacity
            memset(src.str + wpos, c, num);
        wpos += num;
    }

copy() [1/2]

void c4::yml::FilterProcessorInplaceEndExtending::copy ( )

inlinenoexcept

Definition at line 228 of file filter_processor.hpp.

    {
        RYML_ASSERT_BASIC_(wpos <= rpos);
        RYML_ASSERT_BASIC_(rpos < src.len);
        if(wpos < wcap)  // respect write-capacity
            src.str[wpos] = src.str[rpos];
        ++rpos;
        ++wpos;
    }

copy() [2/2]

void c4::yml::FilterProcessorInplaceEndExtending::copy ( size_t num )

inlinenoexcept

Definition at line 237 of file filter_processor.hpp.

    {
        RYML_ASSERT_BASIC_(num);
        RYML_ASSERT_BASIC_(rpos+num <= src.len);
        RYML_ASSERT_BASIC_(wpos <= rpos);
        if(wpos + num <= wcap)  // respect write-capacity
        {
            if(wpos + num <= rpos) // there is no overlap
                memcpy(src.str + wpos, src.str + rpos, num);
            else                   // there is overlap
                memmove(src.str + wpos, src.str + rpos, num);
        }
        rpos += num;
        wpos += num;
    }

translate_esc()

void c4::yml::FilterProcessorInplaceEndExtending::translate_esc ( char c )

inlinenoexcept

Definition at line 253 of file filter_processor.hpp.

    {
        RYML_ASSERT_BASIC_(rpos + 2 <= src.len);
        RYML_ASSERT_BASIC_(wpos <= rpos);
        if(wpos < wcap) // respect write-capacity
            src.str[wpos] = c;
        rpos += 2; // add 1u to account for the escape character
        ++wpos;
    }

translate_esc_bulk()

void c4::yml::FilterProcessorInplaceEndExtending::translate_esc_bulk ( const char * s, size_t nw, size_t nr )

inlinenoexcept

Definition at line 263 of file filter_processor.hpp.

    {
        RYML_ASSERT_BASIC_(nw > 0);
        RYML_ASSERT_BASIC_(nr > 0);
        RYML_ASSERT_BASIC_(nw <= nr + 1u);
        RYML_ASSERT_BASIC_(rpos+nr <= src.len);
        RYML_ASSERT_BASIC_(wpos <= rpos);
        const size_t wpos_next = wpos + nw;
        const size_t rpos_next = rpos + nr + 1u; // add 1u to account for the escape character
        RYML_ASSERT_BASIC_(wpos_next <= rpos_next);
        if(wpos_next <= wcap)
            memcpy(src.str + wpos, s, nw);
        rpos = rpos_next;
        wpos = wpos_next;
    }

Referenced by translate_esc_extending().

translate_esc_extending()

void c4::yml::FilterProcessorInplaceEndExtending::translate_esc_extending ( const char * s, size_t nw, size_t nr )

inlinenoexcept

Definition at line 279 of file filter_processor.hpp.

    {
        translate_esc_bulk(s, nw, nr);
    }

Member Data Documentation

src

substr c4::yml::FilterProcessorInplaceEndExtending::src

the subject string

Definition at line 168 of file filter_processor.hpp.

Referenced by FilterProcessorInplaceEndExtending(), copy(), copy(), curr(), has_more_chars(), has_more_chars(), next(), rem(), result(), set(), set(), set_at_end(), sofar(), translate_esc(), and translate_esc_bulk().

wcap

size_t c4::yml::FilterProcessorInplaceEndExtending::wcap

write capacity - the capacity of the subject string's buffer

Definition at line 169 of file filter_processor.hpp.

Referenced by FilterProcessorInplaceEndExtending(), copy(), copy(), result(), set(), set(), sofar(), translate_esc(), and translate_esc_bulk().

rpos

size_t c4::yml::FilterProcessorInplaceEndExtending::rpos

read position

Definition at line 170 of file filter_processor.hpp.

Referenced by copy(), copy(), curr(), has_more_chars(), has_more_chars(), next(), rem(), result(), set_at_end(), setpos(), skip(), skip(), translate_esc(), and translate_esc_bulk().

wpos

size_t c4::yml::FilterProcessorInplaceEndExtending::wpos

write position

Definition at line 171 of file filter_processor.hpp.

Referenced by copy(), copy(), result(), set(), set(), set_at(), setpos(), setwpos(), sofar(), translate_esc(), and translate_esc_bulk().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/latest/src/c4/yml/filter_processor.hpp