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 More...
size_t	wcap
	write capacity - the capacity of the subject string's buffer More...
size_t	rpos
	read position More...
size_t	wpos
	write position More...

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 172 of file filter_processor.hpp.

Constructor & Destructor Documentation

FilterProcessorInplaceEndExtending()

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

inlinenoexcept

Definition at line 179 of file filter_processor.hpp.

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

References src, and wcap.

Member Function Documentation

setwpos()

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

inlinenoexcept

Definition at line 188 of file filter_processor.hpp.

{ wpos = wpos_; }

References wpos.

setpos()

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

inlinenoexcept

Definition at line 189 of file filter_processor.hpp.

{ rpos = rpos_; wpos = wpos_; }

References rpos, and wpos.

set_at_end()

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

inlinenoexcept

Definition at line 190 of file filter_processor.hpp.

{ skip(src.len - rpos); }

References rpos, skip(), and src.

has_more_chars() [1/2]

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

inlinenoexcept

Definition at line 192 of file filter_processor.hpp.

{ return rpos < src.len; }

References rpos, and src.

has_more_chars() [2/2]

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

inlinenoexcept

Definition at line 193 of file filter_processor.hpp.

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

References rpos, and src.

result()

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

inlinenoexcept

Definition at line 195 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;
    }

References rpos, src, c4::yml::FilterResult::str, wcap, and wpos.

sofar()

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

inlinenoexcept

Definition at line 203 of file filter_processor.hpp.

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

References src, wcap, and wpos.

rem()

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

inlinenoexcept

Definition at line 204 of file filter_processor.hpp.

{ return src.sub(rpos); }

References rpos, and src.

curr()

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

inlinenoexcept

Definition at line 206 of file filter_processor.hpp.

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

References rpos, and src.

next()

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

inlinenoexcept

Definition at line 207 of file filter_processor.hpp.

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

References rpos, and src.

skip() [1/2]

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

inlinenoexcept

Definition at line 209 of file filter_processor.hpp.

{ ++rpos; }

References rpos.

skip() [2/2]

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

inlinenoexcept

Definition at line 210 of file filter_processor.hpp.

{ rpos += num; }

References rpos.

set_at()

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

inlinenoexcept

Definition at line 212 of file filter_processor.hpp.

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

References set(), and wpos.

set() [1/2]

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

inlinenoexcept

Definition at line 220 of file filter_processor.hpp.

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

References src, wcap, and wpos.

set() [2/2]

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

inlinenoexcept

Definition at line 226 of file filter_processor.hpp.

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

References src, wcap, and wpos.

copy() [1/2]

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

inlinenoexcept

Definition at line 234 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;
    }

References rpos, src, wcap, and wpos.

copy() [2/2]

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

inlinenoexcept

Definition at line 243 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;
    }

References rpos, src, wcap, and wpos.

translate_esc()

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

inlinenoexcept

Definition at line 259 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;
    }

References rpos, src, wcap, and wpos.

translate_esc_bulk()

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

inlinenoexcept

Definition at line 269 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;
    }

References rpos, src, wcap, and wpos.

translate_esc_extending()

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

inlinenoexcept

Definition at line 285 of file filter_processor.hpp.

    {
        translate_esc_bulk(s, nw, nr);
    }

References translate_esc_bulk().

Member Data Documentation

src

substr c4::yml::FilterProcessorInplaceEndExtending::src

the subject string

Definition at line 174 of file filter_processor.hpp.

wcap

size_t c4::yml::FilterProcessorInplaceEndExtending::wcap

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

Definition at line 175 of file filter_processor.hpp.

rpos

size_t c4::yml::FilterProcessorInplaceEndExtending::rpos

read position

Definition at line 176 of file filter_processor.hpp.

wpos

size_t c4::yml::FilterProcessorInplaceEndExtending::wpos

write position

Definition at line 177 of file filter_processor.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/filter_processor.hpp