TokiLanguage Class Reference

Source code language definition. More...

#include <cc/TokiLanguage>

Inheritance diagram for TokiLanguage:

Public Member Functions
	TokiLanguage ()=default
	Create a null language.
	TokiLanguage (const String &displayName, const String &name, const Pattern &pathPattern, const TokiHighlightingSyntax &highlightingSyntax, const SyntaxDefinition &discoverySyntax=SyntaxDefinition{})
	Create a new language.
String	displayName () const
	Human readable name of the language.
String	name () const
	TokiLanguage name.
Pattern	pathPattern () const
	Pattern used to identify a source file path.
const TokiHighlightingSyntax &	highlightingSyntax () const
	Syntax used to highlight a source file.
const SyntaxDefinition &	discoverySyntax () const
	Syntax used to identify a source text.
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.
int	useCount () const
	Reference count.
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.

Protected Member Functions
	TokiLanguage (State *newState)
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
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.
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

Source code language definition.

Todo

allow additional path patterns

Constructor & Destructor Documentation

TokiLanguage() [1/2]

TokiLanguage ( )

default

Create a null language.

TokiLanguage() [2/2]

TokiLanguage	(	const String &	displayName,
		const String &	name,
		const Pattern &	pathPattern,
		const TokiHighlightingSyntax &	highlightingSyntax,
		const SyntaxDefinition &	discoverySyntax = SyntaxDefinition{} )

Create a new language.

Member Function Documentation

displayName()

String displayName

(

)

const

Human readable name of the language.

name()

String name

(

)

const

TokiLanguage name.

pathPattern()

Pattern pathPattern

(

)

const

Pattern used to identify a source file path.

highlightingSyntax()

const TokiHighlightingSyntax & highlightingSyntax

(

)

const

Syntax used to highlight a source file.

discoverySyntax()

const SyntaxDefinition & discoverySyntax

(

)

const

Syntax used to identify a source text.