SyntaxNode Class Reference

Syntax definition node More...

#include <cc/syntax_node/SyntaxNode>

Inheritance diagram for SyntaxNode:

Public Member Functions
	SyntaxNode ()=default
	Create an null syntax node.
	SyntaxNode (char ch)
	SyntaxNode (const char *s)
	SyntaxNode (const SyntaxRule *rule)
	SyntaxNode (Function< bool(char)> &&match)
long	matchNext (const String &text, long offset, Token &production) const
	Match text at offset against this node.
long	matchLength () const
	Match length for this node (or -1 if variable)
String	hint () const
	Hint for generating syntax error messages (Expect failed)
List< String >	explain () const
	Convert to a human-readable form.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
template<class T >
bool	is () const
	Check if this object is of type T.
template<class T >
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.
long	useCount () const
	Reference count.

Protected Member Functions
	SyntaxNode (State *newState)
State &	me ()
const State &	me () const
Protected Member Functions inherited from Object
template<class T >
T	weak () const
template<class T >
void	initOnce ()
	Create the object state when called the first time.
template<class T >
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)

Additional Inherited Members
Static Protected Member Functions inherited from Object
template<class T >
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T >
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Syntax definition node

Constructor & Destructor Documentation

SyntaxNode()

SyntaxNode ( )

default

Create an null syntax node.

Member Function Documentation

matchNext()

long matchNext	(	const String &	text,
		long	offset,
		Token &	production ) const

Match text at offset against this node.

Returns

End of match (offset of next character beyond the match), or -1 if match failed

matchLength()

long matchLength

(

)

const

Match length for this node (or -1 if variable)

hint()

String hint

(

)

const

Hint for generating syntax error messages (Expect failed)

explain()

List< String > explain

(

)

const

Convert to a human-readable form.