rapidyaml  0.7.0
parse and emit YAML, and do it fast
Public Member Functions | Public Attributes | List of all members
c4::yml::EventHandlerTreeState Struct Reference
Parse utilities » Event Handlers

The stack state needed specifically by EventHandlerTree. More...

#include <event_handler_tree.hpp>

Inheritance diagram for c4::yml::EventHandlerTreeState:
c4::yml::ParserState

Public Member Functions

void start_parse (const char *file, id_type node_id_)
 
void reset_after_push ()
 
void reset_before_pop (ParserState const &to_pop)
 
bool at_line_beginning () const noexcept
 
bool indentation_eq () const noexcept
 
bool indentation_ge () const noexcept
 
bool indentation_gt () const noexcept
 
bool indentation_lt () const noexcept
 

Public Attributes

NodeData * tr_data
 
LineContents line_contents
 
Location pos
 
ParserFlag_t flags
 
size_t indref
 the reference indentation in the current block scope More...
 
id_type level
 
id_type node_id
 don't hold a pointer to the node as it will be relocated during tree resizes More...
 
size_t scalar_col
 
bool more_indented
 
bool has_children
 

Detailed Description

The stack state needed specifically by EventHandlerTree.

Definition at line 22 of file event_handler_tree.hpp.

Member Function Documentation

◆ start_parse()

void c4::yml::ParserState::start_parse ( const char *  file,
id_type  node_id_ 
)
inlineinherited

Definition at line 146 of file parser_state.hpp.

147  {
148  level = 0;
149  pos.name = to_csubstr(file);
150  pos.offset = 0;
151  pos.line = 1;
152  pos.col = 1;
153  node_id = node_id_;
154  more_indented = false;
155  scalar_col = 0;
156  indref = 0;
157  has_children = false;
158  }
c4::to_csubstr
csubstr to_csubstr(substr s) noexcept
neutral version for use in generic code
Definition: substr.hpp:2189
c4::yml::Location::col
size_t col
column
Definition: common.hpp:302
c4::yml::Location::line
size_t line
line
Definition: common.hpp:300
c4::yml::Location::offset
size_t offset
number of bytes from the beginning of the source buffer
Definition: common.hpp:298
c4::yml::Location::name
csubstr name
file name
Definition: common.hpp:304
c4::yml::ParserState::indref
size_t indref
the reference indentation in the current block scope
Definition: parser_state.hpp:137
c4::yml::ParserState::node_id
id_type node_id
don't hold a pointer to the node as it will be relocated during tree resizes
Definition: parser_state.hpp:139

References c4::yml::Location::col, c4::yml::ParserState::has_children, c4::yml::ParserState::indref, c4::yml::ParserState::level, c4::yml::Location::line, c4::yml::ParserState::more_indented, c4::yml::Location::name, c4::yml::ParserState::node_id, c4::yml::Location::offset, c4::yml::ParserState::pos, c4::yml::ParserState::scalar_col, and c4::to_csubstr().

◆ reset_after_push()

void c4::yml::ParserState::reset_after_push ( )
inlineinherited

Definition at line 160 of file parser_state.hpp.

161  {
162  node_id = NONE;
163  indref = npos;
164  more_indented = false;
165  ++level;
166  has_children = false;
167  }
c4::yml::npos
@ npos
a null string position
Definition: common.hpp:266
c4::yml::NONE
@ NONE
an index to none
Definition: common.hpp:259

References c4::yml::ParserState::has_children, c4::yml::ParserState::indref, c4::yml::ParserState::level, c4::yml::ParserState::more_indented, c4::yml::ParserState::node_id, c4::yml::NONE, and c4::yml::npos.

◆ reset_before_pop()

void c4::yml::ParserState::reset_before_pop ( ParserState const &  to_pop)
inlineinherited

Definition at line 169 of file parser_state.hpp.

170  {
171  pos = to_pop.pos;
172  line_contents = to_pop.line_contents;
173  }
c4::yml::ParserState::line_contents
LineContents line_contents
Definition: parser_state.hpp:134

References c4::yml::ParserState::line_contents, and c4::yml::ParserState::pos.

◆ at_line_beginning()

bool c4::yml::ParserState::at_line_beginning ( ) const
inlinenoexceptinherited

Definition at line 177 of file parser_state.hpp.

178  {
179  return line_contents.rem.str == line_contents.full.str;
180  }
c4::yml::LineContents::rem
substr rem
the stripped line remainder; initially starts at the first non-space character
Definition: parser_state.hpp:51
c4::yml::LineContents::full
substr full
the full line, including newlines on the right
Definition: parser_state.hpp:53

References c4::yml::LineContents::full, c4::yml::ParserState::line_contents, and c4::yml::LineContents::rem.

◆ indentation_eq()

bool c4::yml::ParserState::indentation_eq ( ) const
inlinenoexceptinherited

Definition at line 181 of file parser_state.hpp.

182  {
183  RYML_ASSERT(indref != npos);
184  return line_contents.indentation != npos && line_contents.indentation == indref;
185  }
c4::yml::LineContents::indentation
size_t indentation
the number of spaces on the beginning of the line
Definition: parser_state.hpp:52

References c4::yml::LineContents::indentation, c4::yml::ParserState::indref, c4::yml::ParserState::line_contents, and c4::yml::npos.

◆ indentation_ge()

bool c4::yml::ParserState::indentation_ge ( ) const
inlinenoexceptinherited

Definition at line 186 of file parser_state.hpp.

187  {
188  RYML_ASSERT(indref != npos);
189  return line_contents.indentation != npos && line_contents.indentation >= indref;
190  }

References c4::yml::LineContents::indentation, c4::yml::ParserState::indref, c4::yml::ParserState::line_contents, and c4::yml::npos.

◆ indentation_gt()

bool c4::yml::ParserState::indentation_gt ( ) const
inlinenoexceptinherited

Definition at line 191 of file parser_state.hpp.

192  {
193  RYML_ASSERT(indref != npos);
194  return line_contents.indentation != npos && line_contents.indentation > indref;
195  }

References c4::yml::LineContents::indentation, c4::yml::ParserState::indref, c4::yml::ParserState::line_contents, and c4::yml::npos.

◆ indentation_lt()

bool c4::yml::ParserState::indentation_lt ( ) const
inlinenoexceptinherited

Definition at line 196 of file parser_state.hpp.

197  {
198  RYML_ASSERT(indref != npos);
199  return line_contents.indentation != npos && line_contents.indentation < indref;
200  }

References c4::yml::LineContents::indentation, c4::yml::ParserState::indref, c4::yml::ParserState::line_contents, and c4::yml::npos.

Member Data Documentation

◆ tr_data

NodeData* c4::yml::EventHandlerTreeState::tr_data

Definition at line 24 of file event_handler_tree.hpp.

◆ line_contents

LineContents c4::yml::ParserState::line_contents
inherited

Definition at line 134 of file parser_state.hpp.

Referenced by c4::yml::ParserState::at_line_beginning(), c4::yml::ParserState::indentation_eq(), c4::yml::ParserState::indentation_ge(), c4::yml::ParserState::indentation_gt(), c4::yml::ParserState::indentation_lt(), and c4::yml::ParserState::reset_before_pop().

◆ pos

Location c4::yml::ParserState::pos
inherited

Definition at line 135 of file parser_state.hpp.

Referenced by c4::yml::ParserState::reset_before_pop(), and c4::yml::ParserState::start_parse().

◆ flags

ParserFlag_t c4::yml::ParserState::flags
inherited

Definition at line 136 of file parser_state.hpp.

◆ indref

size_t c4::yml::ParserState::indref
inherited

the reference indentation in the current block scope

Definition at line 137 of file parser_state.hpp.

Referenced by c4::yml::ParserState::indentation_eq(), c4::yml::ParserState::indentation_ge(), c4::yml::ParserState::indentation_gt(), c4::yml::ParserState::indentation_lt(), c4::yml::ParserState::reset_after_push(), and c4::yml::ParserState::start_parse().

◆ level

id_type c4::yml::ParserState::level
inherited

Definition at line 138 of file parser_state.hpp.

Referenced by c4::yml::ParserState::reset_after_push(), and c4::yml::ParserState::start_parse().

◆ node_id

id_type c4::yml::ParserState::node_id
inherited

don't hold a pointer to the node as it will be relocated during tree resizes

Definition at line 139 of file parser_state.hpp.

Referenced by c4::yml::ParserState::reset_after_push(), and c4::yml::ParserState::start_parse().

◆ scalar_col

size_t c4::yml::ParserState::scalar_col
inherited

Definition at line 140 of file parser_state.hpp.

Referenced by c4::yml::ParserState::start_parse().

◆ more_indented

bool c4::yml::ParserState::more_indented
inherited

Definition at line 141 of file parser_state.hpp.

Referenced by c4::yml::ParserState::reset_after_push(), and c4::yml::ParserState::start_parse().

◆ has_children

bool c4::yml::ParserState::has_children
inherited

Definition at line 142 of file parser_state.hpp.

Referenced by c4::yml::ParserState::reset_after_push(), and c4::yml::ParserState::start_parse().

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