Filters in place. More...

#include <filter_processor.hpp>

Public Member Functions
	FilterProcessorInplaceMidExtending (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

FilterResultExtending	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...

size_t	maxcap
	the max capacity needed for filtering the string. This may be larger than the final string size. More...

bool	unfiltered_chars
	number of characters that were not added to wpos from lack of capacity More...

Detailed Description

Filters in place.

The result may be larger than the source, and extending may happen anywhere. As a result some characters may be left unfiltered when there is no slack in the buffer and the write-position would overlap the read-position. Consequently, it's possible for characters to be left unfiltered. In YAML, this happens only with double-quoted strings, and only with a small number of escape sequences such as \L which is substituted by three bytes. These escape sequences cause a call to translate_esc_extending() which is the only entry point to this unfiltered situation.

See also: FilterProcessorInplaceMidExtending

Definition at line 279 of file filter_processor.hpp.

Constructor & Destructor Documentation

◆ FilterProcessorInplaceMidExtending()

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

inlinenoexcept

Definition at line 288 of file filter_processor.hpp.

         : src(src_)
         , wcap(wcap_)
         , rpos(0)
         , wpos(0)
         , maxcap(src.len)
         , unfiltered_chars(false)
     {
         RYML_ASSERT(wcap >= src.len);
     }

References src, and wcap.

Member Function Documentation

◆ setwpos()

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

inlinenoexcept

Definition at line 299 of file filter_processor.hpp.

299 { wpos = wpos_; }

References wpos.

◆ setpos()

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

inlinenoexcept

Definition at line 300 of file filter_processor.hpp.

300 { rpos = rpos_; wpos = wpos_; }

References rpos, and wpos.

◆ set_at_end()

void c4::yml::FilterProcessorInplaceMidExtending::set_at_end ( )

inlinenoexcept

Definition at line 301 of file filter_processor.hpp.

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

c4::yml::FilterProcessorInplaceMidExtending::skip

void skip() noexcept

Definition: filter_processor.hpp:321

References rpos, skip(), and src.

◆ has_more_chars() [1/2]

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

inlinenoexcept

Definition at line 303 of file filter_processor.hpp.

303 { return rpos < src.len; }

References rpos, and src.

◆ has_more_chars() [2/2]

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

inlinenoexcept

Definition at line 304 of file filter_processor.hpp.

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

References rpos, and src.

◆ result()

FilterResultExtending c4::yml::FilterProcessorInplaceMidExtending::result ( ) const

inlinenoexcept

Definition at line 306 of file filter_processor.hpp.

     {
         _c4dbgip("inplace: wpos={} wcap={} unfiltered={} maxcap={}", this->wpos, this->wcap, this->unfiltered_chars, this->maxcap);
         FilterResultExtending ret;
         ret.str.str = (wpos <= wcap && !unfiltered_chars) ? src.str : nullptr;
         ret.str.len = wpos;
         ret.reqlen = maxcap;
         return ret;
     }

References maxcap, src, unfiltered_chars, wcap, and wpos.

◆ sofar()

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

inlinenoexcept

Definition at line 315 of file filter_processor.hpp.

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

References src, wcap, and wpos.

◆ rem()

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

inlinenoexcept

Definition at line 316 of file filter_processor.hpp.

316 { return src.sub(rpos); }

References rpos, and src.

◆ curr()

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

inlinenoexcept

Definition at line 318 of file filter_processor.hpp.

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

References rpos, and src.

◆ next()

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

inlinenoexcept

Definition at line 319 of file filter_processor.hpp.

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

References rpos, and src.

◆ skip() [1/2]

void c4::yml::FilterProcessorInplaceMidExtending::skip ( )

inlinenoexcept

Definition at line 321 of file filter_processor.hpp.

321 { ++rpos; }

References rpos.

Referenced by set_at_end().

◆ skip() [2/2]

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

inlinenoexcept

Definition at line 322 of file filter_processor.hpp.

322 { rpos += num; }

References rpos.

◆ set_at()

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

inlinenoexcept

Definition at line 324 of file filter_processor.hpp.

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

References set(), and wpos.

◆ set() [1/2]

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

inlinenoexcept

Definition at line 332 of file filter_processor.hpp.

     {
         if(wpos < wcap)  // respect write-capacity
         {
             if((wpos <= rpos) && !unfiltered_chars)
                 src.str[wpos] = c;
         }
         else
         {
             _c4dbgip("inplace: add unwritten {}->{}   maxcap={}->{}!", unfiltered_chars, true, maxcap, (wpos+1u > maxcap ? wpos+1u : maxcap));
             unfiltered_chars = true;
         }
         ++wpos;
         maxcap = wpos > maxcap ? wpos : maxcap;
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

Referenced by set_at().

◆ set() [2/2]

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

inlinenoexcept

Definition at line 347 of file filter_processor.hpp.

     {
         RYML_ASSERT(num);
         if(wpos + num <= wcap)  // respect write-capacity
         {
             if((wpos <= rpos) && !unfiltered_chars)
                 memset(src.str + wpos, c, num);
         }
         else
         {
             _c4dbgip("inplace: add unwritten {}->{}   maxcap={}->{}!", unfiltered_chars, true, maxcap, (wpos+num > maxcap ? wpos+num : maxcap));
             unfiltered_chars = true;
         }
         wpos += num;
         maxcap = wpos > maxcap ? wpos : maxcap;
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

◆ copy() [1/2]

void c4::yml::FilterProcessorInplaceMidExtending::copy ( )

inlinenoexcept

Definition at line 364 of file filter_processor.hpp.

     {
         RYML_ASSERT(rpos < src.len);
         if(wpos < wcap)  // respect write-capacity
         {
             if((wpos < rpos) && !unfiltered_chars)  // write only if wpos is behind rpos
                 src.str[wpos] = src.str[rpos];
         }
         else
         {
             _c4dbgip("inplace: add unwritten {}->{} (wpos={}!=rpos={})={}  (wpos={}<wcap={})   maxcap={}->{}!", unfiltered_chars, true, wpos, rpos, wpos!=rpos, wpos, wcap, wpos<wcap, maxcap, (wpos+1u > maxcap ? wpos+1u : maxcap));
             unfiltered_chars = true;
         }
         ++rpos;
         ++wpos;
         maxcap = wpos > maxcap ? wpos : maxcap;
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

◆ copy() [2/2]

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

inlinenoexcept

Definition at line 381 of file filter_processor.hpp.

     {
         RYML_ASSERT(num);
         RYML_ASSERT(rpos+num <= src.len);
         if(wpos + num <= wcap)  // respect write-capacity
         {
             if((wpos < rpos) && !unfiltered_chars)  // write only if wpos is behind rpos
             {
                 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);
             }
         }
         else
         {
             _c4dbgip("inplace: add unwritten {}->{} (wpos={}!=rpos={})={}  (wpos={}<wcap={})  maxcap={}->{}!", unfiltered_chars, true, wpos, rpos, wpos!=rpos, wpos, wcap, wpos<wcap);
             unfiltered_chars = true;
         }
         rpos += num;
         wpos += num;
         maxcap = wpos > maxcap ? wpos : maxcap;
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

◆ translate_esc()

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

inlinenoexcept

Definition at line 405 of file filter_processor.hpp.

     {
         RYML_ASSERT(rpos + 2 <= src.len);
         if(wpos < wcap) // respect write-capacity
         {
             if((wpos <= rpos) && !unfiltered_chars)
                 src.str[wpos] = c;
         }
         else
         {
             _c4dbgip("inplace: add unfiltered {}->{}  maxcap={}->{}!", unfiltered_chars, true, maxcap, (wpos+1u > maxcap ? wpos+1u : maxcap));
             unfiltered_chars = true;
         }
         rpos += 2;
         ++wpos;
         maxcap = wpos > maxcap ? wpos : maxcap;
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

◆ translate_esc_bulk()

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

inlinenoexcept

Definition at line 423 of file filter_processor.hpp.

     {
         RYML_ASSERT(nw > 0);
         RYML_ASSERT(nr > 0);
         RYML_ASSERT(nr+1u >= nw);
         const size_t wpos_next = wpos + nw;
         const size_t rpos_next = rpos + nr + 1u; // add 1u to account for the escape character
         if(wpos_next <= wcap)  // respect write-capacity
         {
             if((wpos <= rpos) && !unfiltered_chars)  // write only if wpos is behind rpos
                 memcpy(src.str + wpos, s, nw);
         }
         else
         {
             _c4dbgip("inplace: add unwritten {}->{} (wpos={}!=rpos={})={}  (wpos={}<wcap={})  maxcap={}->{}!", unfiltered_chars, true, wpos, rpos, wpos!=rpos, wpos, wcap, wpos<wcap);
             unfiltered_chars = true;
         }
         rpos = rpos_next;
         wpos = wpos_next;
         maxcap = wpos > maxcap ? wpos : maxcap;
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

◆ translate_esc_extending()

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

inlinenoexcept

Definition at line 445 of file filter_processor.hpp.

     {
         RYML_ASSERT(nw > 0);
         RYML_ASSERT(nr > 0);
         RYML_ASSERT(rpos+nr <= src.len);
         const size_t wpos_next = wpos + nw;
         const size_t rpos_next = rpos + nr + 1u; // add 1u to account for the escape character
         if(wpos_next <= rpos_next) // read and write do not overlap. just do a vanilla copy.
         {
             if((wpos_next <= wcap) && !unfiltered_chars)
                 memcpy(src.str + wpos, s, nw);
             rpos = rpos_next;
             wpos = wpos_next;
             maxcap = wpos > maxcap ? wpos : maxcap;
         }
         else // there is overlap. move the (to-be-read) string to the right.
         {
             const size_t excess = wpos_next - rpos_next;
             RYML_ASSERT(wpos_next > rpos_next);
             if(src.len + excess <= wcap) // ensure we do not go past the end
             {
                 RYML_ASSERT(rpos+nr+excess <= src.len);
                 if(wpos_next <= wcap)
                 {
                     if(!unfiltered_chars)
                     {
                         memmove(src.str + wpos_next, src.str + rpos_next, src.len - rpos_next);
                         memcpy(src.str + wpos, s, nw);
                     }
                     rpos = wpos_next; // wpos, not rpos
                 }
                 else
                 {
                     rpos = rpos_next;
                     //const size_t unw = nw > (nr + 1u) ? nw - (nr + 1u) : 0;
                     _c4dbgip("inplace: add unfiltered {}->{}   maxcap={}->{}!", unfiltered_chars, true);
                     unfiltered_chars = true;
                 }
                 wpos = wpos_next;
                 // extend the string up to capacity
                 src.len += excess;
                 maxcap = wpos > maxcap ? wpos : maxcap;
             }
             else
             {
                 //const size_t unw = nw > (nr + 1u) ? nw - (nr + 1u) : 0;
                 RYML_ASSERT(rpos_next <= src.len);
                 const size_t required_size = wpos_next + (src.len - rpos_next);
                 _c4dbgip("inplace: add unfiltered {}->{}   maxcap={}->{}!", unfiltered_chars, true, maxcap, required_size > maxcap ? required_size : maxcap);
                 RYML_ASSERT(required_size > wcap);
                 unfiltered_chars = true;
                 maxcap = required_size > maxcap ? required_size : maxcap;
                 wpos = wpos_next;
                 rpos = rpos_next;
             }
         }
     }

References maxcap, rpos, src, unfiltered_chars, wcap, and wpos.

Member Data Documentation

◆ src

substr c4::yml::FilterProcessorInplaceMidExtending::src

the subject string

Definition at line 281 of file filter_processor.hpp.

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

◆ wcap

size_t c4::yml::FilterProcessorInplaceMidExtending::wcap

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

Definition at line 282 of file filter_processor.hpp.

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

◆ rpos

size_t c4::yml::FilterProcessorInplaceMidExtending::rpos

read position

Definition at line 283 of file filter_processor.hpp.

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

◆ wpos

size_t c4::yml::FilterProcessorInplaceMidExtending::wpos

write position

Definition at line 284 of file filter_processor.hpp.

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

◆ maxcap

size_t c4::yml::FilterProcessorInplaceMidExtending::maxcap

the max capacity needed for filtering the string. This may be larger than the final string size.

Definition at line 285 of file filter_processor.hpp.

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

◆ unfiltered_chars

bool c4::yml::FilterProcessorInplaceMidExtending::unfiltered_chars

number of characters that were not added to wpos from lack of capacity

Definition at line 286 of file filter_processor.hpp.

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

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

/home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.7.0/src/c4/yml/filter_processor.hpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FilterProcessorInplaceMidExtending()

Member Function Documentation

◆ setwpos()

◆ setpos()

◆ set_at_end()

◆ has_more_chars() [1/2]

◆ has_more_chars() [2/2]

◆ result()

◆ sofar()

◆ rem()

◆ curr()

◆ next()

◆ 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

◆ wcap

◆ rpos

◆ wpos

◆ maxcap

◆ unfiltered_chars