CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
SyntaxDefinition Class Reference

Computer language syntax definition. More...

#include <cc/SyntaxDefinition>

Inheritance diagram for SyntaxDefinition:

Classes

class  State
 Internal state. More...
 

Public Types

using SyntaxNode = syntax::SyntaxNode
 

Public Member Functions

 SyntaxDefinition ()=default
 Create a null syntax definition.
 
 SyntaxDefinition (const SyntaxRule *entry)
 Create a new syntax definition.
 
Token match (const String &text, long offset=0) const
 Match this syntax definition against text starting at offset
 
Token parse (const String &text, long offset=0) const
 Match this syntax definition against text starting at offset
 
Token findIn (const String &text, long offset=0) const
 Find the next occurance of this pattern in text starting from offset.
 
List< StringbreakUp (const String &text) const
 Break up text into the non-matching parts.
 
 operator SyntaxRule () const
 Allow use this definition as a syntax rule within another definition.
 
SyntaxRule entry () const
 Get the entry rule of this definition.
 
- 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 >
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

 SyntaxDefinition (State *newState)
 
Stateme ()
 
const Stateme () const
 
- Protected Member Functions inherited from Object
template<class 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)
 
Objectoperator= (std::nullptr_t)
 

Syntax Rules

using SyntaxRule = cc::SyntaxRule
 Syntactic rule within a syntax definition.
 
using VoidRule = syntax::VoidRule
 Syntax rule which does not produce any token.
 

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< Stateme
 Internal object state
 

Detailed Description

Computer language syntax definition.

Member Typedef Documentation

◆ SyntaxRule

Syntactic rule within a syntax definition.

◆ VoidRule

Syntax rule which does not produce any token.

Constructor & Destructor Documentation

◆ SyntaxDefinition() [1/2]

SyntaxDefinition ( )
default

Create a null syntax definition.

◆ SyntaxDefinition() [2/2]

SyntaxDefinition ( const SyntaxRule * entry)

Create a new syntax definition.

Parameters
entryTop-level rule

Member Function Documentation

◆ match()

Token match ( const String & text,
long offset = 0 ) const

Match this syntax definition against text starting at offset

Returns
Root node of the syntax production tree

◆ parse()

Token parse ( const String & text,
long offset = 0 ) const

Match this syntax definition against text starting at offset

Returns
Root node of the syntax production tree
Exceptions
TextErrorText does not match this syntax definition

◆ findIn()

Token findIn ( const String & text,
long offset = 0 ) const

Find the next occurance of this pattern in text starting from offset.

◆ breakUp()

List< String > breakUp ( const String & text) const

Break up text into the non-matching parts.

◆ operator SyntaxRule()

operator SyntaxRule ( ) const

Allow use this definition as a syntax rule within another definition.

◆ entry()

SyntaxRule entry ( ) const

Get the entry rule of this definition.