Filters an input string into a different output string. More...

#include <filter_processor.hpp>

Public Member Functions
	FilterProcessorSrcDst (csubstr src_, substr dst_) 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
csubstr	rem () const noexcept
csubstr	sofar () const noexcept
FilterResult	result () const noexcept
char	curr () const noexcept
char	next () const noexcept
bool	skipped_chars () 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
csubstr	src
substr	dst
size_t	rpos
	read position
size_t	wpos
	write position

Detailed Description

Filters an input string into a different output string.

Definition at line 54 of file filter_processor.hpp.

Constructor & Destructor Documentation

◆ FilterProcessorSrcDst()

c4::yml::FilterProcessorSrcDst::FilterProcessorSrcDst	(	csubstr	src_,
		substr	dst_ )

inlinenoexcept

Definition at line 61 of file filter_processor.hpp.

        : src(src_)
        , dst(dst_)
        , rpos(0)
        , wpos(0)
    {
        _RYML_ASSERT_BASIC(!dst.overlaps(src));
    }

Member Function Documentation

◆ setwpos()

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

inlinenoexcept

Definition at line 70 of file filter_processor.hpp.

70{ wpos = wpos_; }

◆ setpos()

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

inlinenoexcept

Definition at line 71 of file filter_processor.hpp.

71{ rpos = rpos_; wpos = wpos_; }

◆ set_at_end()

void c4::yml::FilterProcessorSrcDst::set_at_end ( )

inlinenoexcept

Definition at line 72 of file filter_processor.hpp.

72{ skip(src.len - rpos); }

c4::yml::FilterProcessorSrcDst::skip

void skip() noexcept

Definition filter_processor.hpp:91

◆ has_more_chars() [1/2]

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

inlinenoexcept

Definition at line 74 of file filter_processor.hpp.

74{ return rpos < src.len; }

◆ has_more_chars() [2/2]

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

inlinenoexcept

Definition at line 75 of file filter_processor.hpp.

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

◆ rem()

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

inlinenoexcept

Definition at line 77 of file filter_processor.hpp.

77{ return src.sub(rpos); }

◆ sofar()

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

inlinenoexcept

Definition at line 78 of file filter_processor.hpp.

78{ return csubstr(dst.str, wpos <= dst.len ? wpos : dst.len); }

c4::csubstr

basic_substring< const char > csubstr

an immutable string view

Definition substr.hpp:2357

◆ result()

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

inlinenoexcept

Definition at line 79 of file filter_processor.hpp.

    {
        FilterResult ret;
        ret.str.str = wpos <= dst.len ? dst.str : nullptr;
        ret.str.len = wpos;
        return ret;
    }

◆ curr()

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

inlinenoexcept

Definition at line 87 of file filter_processor.hpp.

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

◆ next()

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

inlinenoexcept

Definition at line 88 of file filter_processor.hpp.

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

◆ skipped_chars()

bool c4::yml::FilterProcessorSrcDst::skipped_chars ( ) const

inlinenoexcept

Definition at line 89 of file filter_processor.hpp.

89{ return wpos != rpos; }

◆ skip() [1/2]

void c4::yml::FilterProcessorSrcDst::skip ( )

inlinenoexcept

Definition at line 91 of file filter_processor.hpp.

91{ ++rpos; }

◆ skip() [2/2]

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

inlinenoexcept

Definition at line 92 of file filter_processor.hpp.

92{ rpos += num; }

◆ set_at()

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

inlinenoexcept

Definition at line 94 of file filter_processor.hpp.

    {
        _RYML_ASSERT_BASIC(pos < wpos);
        dst.str[pos] = c;
    }

◆ set() [1/2]

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

inlinenoexcept

Definition at line 99 of file filter_processor.hpp.

    {
        if(wpos < dst.len)
            dst.str[wpos] = c;
        ++wpos;
    }

◆ set() [2/2]

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

inlinenoexcept

Definition at line 105 of file filter_processor.hpp.

    {
        _RYML_ASSERT_BASIC(num > 0);
        if(wpos + num <= dst.len)
            memset(dst.str + wpos, c, num);
        wpos += num;
    }

◆ copy() [1/2]

void c4::yml::FilterProcessorSrcDst::copy ( )

inlinenoexcept

Definition at line 113 of file filter_processor.hpp.

    {
        _RYML_ASSERT_BASIC(rpos < src.len);
        if(wpos < dst.len)
            dst.str[wpos] = src.str[rpos];
        ++wpos;
        ++rpos;
    }

◆ copy() [2/2]

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

inlinenoexcept

Definition at line 121 of file filter_processor.hpp.

    {
        _RYML_ASSERT_BASIC(num);
        _RYML_ASSERT_BASIC(rpos+num <= src.len);
        if(wpos + num <= dst.len)
            memcpy(dst.str + wpos, src.str + rpos, num);
        wpos += num;
        rpos += num;
    }

◆ translate_esc()

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

inlinenoexcept

Definition at line 131 of file filter_processor.hpp.

    {
        if(wpos < dst.len)
            dst.str[wpos] = c;
        ++wpos;
        rpos += 2;
    }

◆ translate_esc_bulk()

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

inlinenoexcept

Definition at line 138 of file filter_processor.hpp.

    {
        _RYML_ASSERT_BASIC(nw > 0);
        _RYML_ASSERT_BASIC(nr > 0);
        _RYML_ASSERT_BASIC(rpos+nr <= src.len);
        if(wpos+nw <= dst.len)
            memcpy(dst.str + wpos, s, nw);
        wpos += nw;
        rpos += 1 + nr;
    }

◆ translate_esc_extending()

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

inlinenoexcept

Definition at line 148 of file filter_processor.hpp.

    {
        translate_esc_bulk(s, nw, nr);
    }

Member Data Documentation

◆ src

csubstr c4::yml::FilterProcessorSrcDst::src

Definition at line 56 of file filter_processor.hpp.

◆ dst

substr c4::yml::FilterProcessorSrcDst::dst

Definition at line 57 of file filter_processor.hpp.

◆ rpos

size_t c4::yml::FilterProcessorSrcDst::rpos

read position

Definition at line 58 of file filter_processor.hpp.

◆ wpos

size_t c4::yml::FilterProcessorSrcDst::wpos

write position

Definition at line 59 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.14.0/src/c4/yml/filter_processor.hpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FilterProcessorSrcDst()

Member Function Documentation

◆ setwpos()

◆ setpos()

◆ set_at_end()

◆ has_more_chars() [1/2]

◆ has_more_chars() [2/2]

◆ rem()

◆ sofar()

◆ result()

◆ curr()

◆ next()

◆ skipped_chars()

◆ skip() [1/2]

◆ skip() [2/2]

◆ set_at()

◆ set() [1/2]

◆ set() [2/2]

◆ copy() [1/2]

◆ copy() [2/2]

◆ translate_esc()

◆ translate_esc_bulk()

◆ translate_esc_extending()

Member Data Documentation

◆ src

◆ dst

◆ rpos

◆ wpos