rapidyaml  0.10.0
parse and emit YAML, and do it fast
Public Member Functions | Public Attributes | List of all members
c4::yml::Location Struct Reference

a source file position More...

#include <common.hpp>

Public Member Functions

 operator bool () const
 
 operator LineCol const & () const
 
 Location ()=default
 
 Location (size_t l, size_t c)
 
 Location (size_t b, size_t l, size_t c)
 
 Location (csubstr n, size_t l, size_t c)
 
 Location (csubstr n, size_t b, size_t l, size_t c)
 
 Location (const char *n, size_t l, size_t c)
 
 Location (const char *n, size_t b, size_t l, size_t c)
 

Public Attributes

size_t offset
 number of bytes from the beginning of the source buffer More...
 
size_t line
 line More...
 
size_t col
 column More...
 
csubstr name
 file name More...
 

Detailed Description

a source file position

Definition at line 297 of file common.hpp.

Constructor & Destructor Documentation

◆ Location() [1/7]

c4::yml::Location::Location ( )
default

◆ Location() [2/7]

c4::yml::Location::Location ( size_t  l,
size_t  c 
)
inline

Definition at line 312 of file common.hpp.

312 : offset( ), line(l), col(c), name( ) {}
c4::yml::Location::col
size_t col
column
Definition: common.hpp:304
c4::yml::Location::line
size_t line
line
Definition: common.hpp:302
c4::yml::Location::offset
size_t offset
number of bytes from the beginning of the source buffer
Definition: common.hpp:300
c4::yml::Location::name
csubstr name
file name
Definition: common.hpp:306

◆ Location() [3/7]

c4::yml::Location::Location ( size_t  b,
size_t  l,
size_t  c 
)
inline

Definition at line 313 of file common.hpp.

313 : offset(b), line(l), col(c), name( ) {}

◆ Location() [4/7]

c4::yml::Location::Location ( csubstr  n,
size_t  l,
size_t  c 
)
inline

Definition at line 314 of file common.hpp.

314 : offset( ), line(l), col(c), name(n) {}

◆ Location() [5/7]

c4::yml::Location::Location ( csubstr  n,
size_t  b,
size_t  l,
size_t  c 
)
inline

Definition at line 315 of file common.hpp.

315 : offset(b), line(l), col(c), name(n) {}

◆ Location() [6/7]

c4::yml::Location::Location ( const char *  n,
size_t  l,
size_t  c 
)
inline

Definition at line 316 of file common.hpp.

316 : offset( ), line(l), col(c), name(to_csubstr(n)) {}
c4::to_csubstr
csubstr to_csubstr(substr s) noexcept
neutral version for use in generic code
Definition: substr.hpp:2186

◆ Location() [7/7]

c4::yml::Location::Location ( const char *  n,
size_t  b,
size_t  l,
size_t  c 
)
inline

Definition at line 317 of file common.hpp.

317 : offset(b), line(l), col(c), name(to_csubstr(n)) {}

Member Function Documentation

◆ operator bool()

c4::yml::Location::operator bool ( ) const
inline

Definition at line 308 of file common.hpp.

308 { return !name.empty() || line != 0 || offset != 0 || col != 0; }

◆ operator LineCol const &()

c4::yml::Location::operator LineCol const & ( ) const
inline

Definition at line 309 of file common.hpp.

309 { return reinterpret_cast<LineCol const&>(*this); } // NOLINT

Member Data Documentation

◆ offset

size_t c4::yml::Location::offset

number of bytes from the beginning of the source buffer

Definition at line 300 of file common.hpp.

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

◆ line

size_t c4::yml::Location::line

line

Definition at line 302 of file common.hpp.

Referenced by c4::yml::report_error_impl(), sample::sample_quick_overview(), and c4::yml::ParserState::start_parse().

◆ col

size_t c4::yml::Location::col

column

Definition at line 304 of file common.hpp.

Referenced by c4::yml::report_error_impl(), sample::sample_quick_overview(), and c4::yml::ParserState::start_parse().

◆ name

csubstr c4::yml::Location::name

file name

Definition at line 306 of file common.hpp.

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

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