Position in a source file; pass around as value. More...

#include <fe/loc.h>

Public Member Functions
	Pos ()=default
	Creates an invalid Position.
	Pos (uint16_t row)
	Pos (uint16_t row, uint16_t col)
	operator bool () const
	Is a valid Position?
auto	operator<=> (const Pos &) const =default
void	dump () const

Public Attributes
uint16_t	row = 0
uint16_t	col = 0

Friends
std::ostream &	operator<< (std::ostream &os, Pos pos)
	fe/loc.h only declares the stream output and dump helpers.

Detailed Description

Position in a source file; pass around as value.

We are only using uint16_t for row/col because this allows us to have sizeof(Loc) == 16: two machine words, which common 64 bit calling conventions (x86-64 System V, AArch64) still pass and return in registers - with uint32_t, every Loc would go through memory instead.

Warning: Rows/cols beyond 65535 wrap around - and row 0 doubles as the "invalid" sentinel, so Positions in such files silently degrade to invalid/wrong ones.

Definition at line 15 of file loc.h.

Constructor & Destructor Documentation

◆ Pos() [1/3]

fe::Pos::Pos ( )

default

Creates an invalid Position.

Referenced by operator<<, and operator<=>().

◆ Pos() [2/3]

fe::Pos::Pos ( uint16_t row )

inline

Definition at line 17 of file loc.h.

References row.

◆ Pos() [3/3]

fe::Pos::Pos	(	uint16_t	row,
		uint16_t	col )

inline

Definition at line 19 of file loc.h.

References col, and row.

Member Function Documentation

◆ dump()

void fe::Pos::dump ( ) const

Definition at line 27 of file loc.cpp.h.

◆ operator bool()

fe::Pos::operator bool ( ) const

inlineexplicit

Is a valid Position?

Definition at line 23 of file loc.h.

References row.

◆ operator<=>()

auto fe::Pos::operator<=> ( const Pos & ) const

default

References Pos().

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		Pos	pos )

friend

fe/loc.h only declares the stream output and dump helpers.

Include fe/loc.cpp.h in exactly one translation unit for the default implementation, or provide your own definitions instead.

Definition at line 10 of file loc.cpp.h.

References col, Pos(), and row.

Member Data Documentation

◆ col

uint16_t fe::Pos::col = 0

Definition at line 28 of file loc.h.

Referenced by operator<<, and Pos().

◆ row

uint16_t fe::Pos::row = 0

Definition at line 27 of file loc.h.

Referenced by operator bool(), operator<<, Pos(), and Pos().

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

fe/loc.h
fe/loc.cpp.h

Public Member Functions

Public Attributes

Friends