Typedefs
using	DataType = int32_t
	data type for integer events. More...

Enumerations
enum	EventFlags : DataType { BSTR = (1 << 0) , ESTR = (1 << 1) , BDOC = (1 << 2) , EDOC = (1 << 3) , BMAP = (1 << 4) , EMAP = (1 << 5) , BSEQ = (1 << 6) , ESEQ = (1 << 7) , SCLR = (1 << 8) , ANCH = (1 << 9) , ALIA = (1 << 10) , TAG_ = (1 << 11) , PLAI = (1 << 12) , SQUO = (1 << 13) , DQUO = (1 << 14) , LITL = (1 << 15) , FOLD = (1 << 16) , FLOW = (1 << 17) , BLCK = (1 << 18) , KEY_ = (1 << 19) , VAL_ = (1 << 20) , EXPL = (1 << 21) , YAML = (1 << 22) , TAGD = (1 << 23) , TAGV = (1 << 24) , AREN = (1 << 25) , PSTR = (1 << 26) , UNFILT = (1 << 27) , LAST = UNFILT , MASK = (LAST << 1) - 1 , WSTR = SCLR\|ALIA\|ANCH\|TAG_\|TAGD\|TAGV\|YAML }
	enumeration of integer event bits. More...

Functions
size_t	to_chars (substr buf, yml::extra::ievt::DataType flags)
	Convert bit mask of ievt::EventFlags to text. More...

csubstr	to_chars_sub (substr buf, yml::extra::ievt::DataType flags)
	Convert bit mask of ievt::EventFlags to text. More...

Typedef Documentation

◆ DataType

using c4::yml::extra::ievt::DataType = typedef int32_t

data type for integer events.

This is set to a 32 bit signed integer to allow compatibility with a wide range of processing languages.

Definition at line 41 of file event_handler_ints.hpp.

Enumeration Type Documentation

◆ EventFlags

enum c4::yml::extra::ievt::EventFlags : DataType

enumeration of integer event bits.

Enumerator
BSTR	+STR begin stream
ESTR	-STR end stream
BDOC	+DOC begin doc
EDOC	-DOC end doc
BMAP	+MAP begin map
EMAP	-MAP end map
BSEQ	+SEQ begin seq
ESEQ	-SEQ end seq
SCLR	=VAL scalar
ANCH	&anchor
ALIA	*ref =ALI alias (reference)
TAG_	!tag
PLAI	plain scalar
SQUO	single-quoted scalar (')
DQUO	double-quoted scalar ("")
LITL	block literal scalar (\|)
FOLD	block folded scalar (>)
FLOW	flow container: [] for seqs or {} for maps
BLCK	block container
KEY_	as key
VAL_	as value
EXPL	`---` (with BDOC) or `...` (with EDOC)
YAML	`YAML <version>`
TAGD	tag directive name : `TAG <name> .......`
TAGV	tag directive value: `TAG ...... <value>`
AREN	IMPORTANT. Marks events whose string was placed in the arena. This happens when the filtered string is larger than the original string in the YAML code (eg from tags that resolve to a larger string, or from "\L" or "\P" in double quotes, which expand from two to three bytes). Because of this size expansion, the filtered string cannot be placed in the original source and needs to be placed in the arena.
PSTR	special flag to enable look-back in the event array. it signifies that the previous event has a string, meaning that the jump back to that event is 3 positions. without this flag it would be impossible to jump to the previous event.
UNFILT	special flag to mark a scalar as unfiltered (when the parser is set not to filter).
LAST	the last flag defined above
MASK	a mask of all bits in this enumeration with string: mask of all the events that encode a string following the event. in the event has a string. the next two integers will provide respectively the string's offset and length. See also PSTR.
WSTR

Definition at line 44 of file event_handler_ints.hpp.

              : DataType {
  
     // Event types
     BSTR = (1 <<  0),  ///< +STR begin stream
     ESTR = (1 <<  1),  ///< -STR end stream
     BDOC = (1 <<  2),  ///< +DOC begin doc
     EDOC = (1 <<  3),  ///< -DOC end doc
     BMAP = (1 <<  4),  ///< +MAP begin map
     EMAP = (1 <<  5),  ///< -MAP end map
     BSEQ = (1 <<  6),  ///< +SEQ begin seq
     ESEQ = (1 <<  7),  ///< -SEQ end seq
     SCLR = (1 <<  8),  ///< =VAL scalar
     ANCH = (1 <<  9),  ///< &anchor
     ALIA = (1 << 10),  ///< *ref =ALI alias (reference)
     TAG_ = (1 << 11),  ///< !tag
  
     // Style flags
     PLAI = (1 << 12),  ///< plain scalar
     SQUO = (1 << 13),  ///< single-quoted scalar (')
     DQUO = (1 << 14),  ///< double-quoted scalar ("")
     LITL = (1 << 15),  ///< block literal scalar (|)
     FOLD = (1 << 16),  ///< block folded scalar (>)
     FLOW = (1 << 17),  ///< flow container: [] for seqs or {} for maps
     BLCK = (1 << 18),  ///< block container
  
     // Structure flags
     KEY_ = (1 << 19),  ///< as key
     VAL_ = (1 << 20),  ///< as value
     EXPL = (1 << 21),  ///< `---` (with BDOC) or
                        ///< `...` (with EDOC)
  
     // Directive flags
     YAML = (1 << 22),  ///< `%YAML <version>`
     TAGD = (1 << 23),  ///< tag directive name : `%TAG <name> .......`
     TAGV = (1 << 24),  ///< tag directive value: `%TAG ...... <value>`
  
     // Buffer flags
     /// IMPORTANT. Marks events whose string was placed in the
     /// arena. This happens when the filtered string is larger than the
     /// original string in the YAML code (eg from tags that resolve to
     /// a larger string, or from "\L" or "\P" in double quotes, which
     /// expand from two to three bytes). Because of this size
     /// expansion, the filtered string cannot be placed in the original
     /// source and needs to be placed in the arena.
     AREN = (1 << 25),
     /// special flag to enable look-back in the event array. it
     /// signifies that the previous event has a string, meaning that
     /// the jump back to that event is 3 positions. without this flag it
     /// would be impossible to jump to the previous event.
     PSTR = (1 << 26),
     /// special flag to mark a scalar as unfiltered (when the parser
     /// is set not to filter).
     UNFILT = (1 << 27),
  
     // Utility flags/masks
     LAST = UNFILT,              ///< the last flag defined above
     MASK = (LAST << 1) - 1,     ///< a mask of all bits in this enumeration
     /// with string: mask of all the events that encode a string
     /// following the event. in the event has a string. the next two
     /// integers will provide respectively the string's offset and
     /// length. See also @ref PSTR.
     WSTR = SCLR|ALIA|ANCH|TAG_|TAGD|TAGV|YAML,
 } EventFlags;

Function Documentation

◆ to_chars()

size_t c4::yml::extra::ievt::to_chars	(	substr	buf,
		ievt::DataType	flags
	)

Convert bit mask of ievt::EventFlags to text.

Definition at line 68 of file ints_utils.cpp.

 {
     return c4::bm2str<ievt::EventFlags>((flags & ievt::MASK), buf.str, buf.len);
 }

References MASK.

Referenced by c4::yml::Tree::to_arena(), c4::yml::to_chars_float(), and to_chars_sub().

◆ to_chars_sub()

csubstr c4::yml::extra::ievt::to_chars_sub	(	substr	buf,
		ievt::DataType	flags
	)

Convert bit mask of ievt::EventFlags to text.

Definition at line 72 of file ints_utils.cpp.

 {
     size_t reqsize = ievt::to_chars(buf, flags);
     RYML_CHECK(reqsize > 0u);
     RYML_CHECK(reqsize < buf.len);
     return buf.first(reqsize - 1u);
 }

References to_chars().

Referenced by c4::yml::extra::events_ints_print().

Typedefs

Enumerations