A parser of mixed symbol pattern where symbols are std::string More...

#include <symbol/turingStyleMixedSymbolPatternParser.h>

Public Types
enum	TokenKind { TokenKind::SEPARATOR, TokenKind::LEFT, TokenKind::RIGHT, TokenKind::IDENT, TokenKind::NONE, TokenKind::NON, TokenKind::ANY, TokenKind::TRUE, TokenKind::EOS }
	Category of tokens. More...

typedef std::tuple< TokenKind, size_t, size_t >	Token
	Type of tokens: the first component is the category, the second is the starting character, and the third is the last character (included).

Public Member Functions
	TuringStyleMixedSymbolPatternParser ()
	Builds TuringStyleMixedSymbolPatternParser with default parameters. More...

	TuringStyleMixedSymbolPatternParser (char left, char right, char separator, std::string blank, std::set< char > ignore, std::string variablePrefix, std::string escapePrefix)
	Builds TuringStyleMixedSymbolPatternParser with custom parameters. More...

void	checkInitialization () const
	Check if parameters of the parser are consistent. This function is called by constructors. More...

SymbolPattern	parse (const std::string &pattern) const
	Parse a string into a symbol pattern. The usual entry point. More...

std::pair< bool, std::string >	isVariableNode (const std::string &node) const
	Test is a raw node name is a variable name. A node name is a variable name if it starts with the variable name prefix. More...

std::pair< SymbolPattern, size_t >	parse_negative_pattern (const std::string &pattern, const std::vector< Token > &tokens, size_t position) const
	Parse a negative list of symbols. More...

std::pair< SymbolPattern, size_t >	parse_positive_pattern (const std::string &pattern, const std::vector< Token > &tokens, size_t position) const
	Parse a positive list of symbols. More...

std::string	sub (const std::string &pattern, const TuringStyleMixedSymbolPatternParser::Token &token) const
	Get the text of a token. More...

std::vector< Token >	tokenize (const std::string &pattern) const
	Fully lex a string, without recognizing keyword. More...

Token	tokenize (const std::string &pattern, size_t start) const
	Lex a single token. More...

std::optional< Token >	translateKeyword (const std::string &pattern, const TuringStyleMixedSymbolPatternParser::Token &token) const
	Translate a single token by recognizing keyword. More...

void	translateKeywords (const std::string &pattern, std::vector< Token > &tokens) const
	Translate a full sequence of tokens. More...

Friends
template<typename CharT , typename Traits = std::char_traits <CharT>>
std::basic_ostream< CharT, Traits > &	operator<< (std::basic_ostream< CharT, Traits > &os, const TokenKind &tokenKind)
	Debug printer of TokenKind. More...

template<typename CharT , typename Traits >
std::basic_ostream< CharT, Traits > &	operator<< (std::basic_ostream< CharT, Traits > &os, const Token &token)
	Debug printer of Token. More...

Detailed Description

A parser of mixed symbol pattern where symbols are std::string

We use a Turing-style syntax:
pattern ::=
| "empty"
| letter{"," letter}*
| "non("letter{"," letter}*")"
| "any" | "true"
For instance (spaces and tab are not significant):

"a, b, c" => "accepts a, b and c".
"a, b, _c" => "accepts a and b, and the symbol associated to key c".
"" => "accepts nothing"
"non(a, b, _c)" => "accepts everything but a and b, and the symbol associated to key c"
"non()" => "accepts everything"
"true" => "accepts everything"
"blank" => designates the blank symbol, usually "" (empty, and thus not parsable), can be used in positive and negative pattern.
"any" => "accepts everything but blank symbol", equivalent to "non(blank)"
non(blank, a) => "accepts everything but the blank symbol, and a".

To specify a symbol named as a keyword, it should be escaped:

"blank" -> ""
"\blank" -> "blank"
"\\blank" -> "\blank"

All symbols can be specified when instantiating the parser, as long as there is no conflict.

Definition at line 35 of file turingStyleMixedSymbolPatternParser.h.

Member Enumeration Documentation

◆ TokenKind

enum TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::TokenKind

strong

Category of tokens.

Enumerator
SEPARATOR	Separator of symbols, usually, the comma.
LEFT	Left parenthesis.
RIGHT	Right parenthesis.
IDENT	Symbols.
NONE	"none" keyword.
NON	"non" keyword.
ANY	"any" keyword.
TRUE	"true" keyword.
EOS	The token at the end of the string.

Definition at line 41 of file turingStyleMixedSymbolPatternParser.h.

Constructor & Destructor Documentation

◆ TuringStyleMixedSymbolPatternParser() [1/2]

TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::TuringStyleMixedSymbolPatternParser ( )

Builds TuringStyleMixedSymbolPatternParser with default parameters.

We have:

left = '('
right = ')'
separator = ','
blank = ""
ignore = {' ', '\n'}
variablePrefix = "_"
escapePrefix = "\"

Definition at line 61 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

◆ TuringStyleMixedSymbolPatternParser() [2/2]

TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::TuringStyleMixedSymbolPatternParser	(	char	left,
		char	right,
		char	separator,
		std::string	blank,
		std::set< char >	ignore,
		std::string	variablePrefix,
		std::string	escapePrefix
	)

Builds TuringStyleMixedSymbolPatternParser with custom parameters.

Parameters

[in]	left	the left parenthesis.
[in]	right	the right parenthesis.
[in]	separator	the separators of symbols.
[in]	blank	the blank symbol, represented by "blank" keyword.
[in]	ignore	set of characters to ignore.
[in]	variablePrefix	The prefix of names that denotes keys. The prefix is removed from the name.
[in]	escapePrefix	The prefix to add before an identifier to force it to be recognize as an identifier, even if it is also a keyword.

Definition at line 65 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ checkInitialization()

void TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::checkInitialization ( ) const

Check if parameters of the parser are consistent. This function is called by constructors.

Exceptions

TuringStyleMixedSymbolPatternParserBadInitializationException if parameters are conflicting.

Definition at line 5 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the caller graph for this function:

◆ isVariableNode()

std::pair< bool, std::string > TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::isVariableNode ( const std::string & node ) const

Test is a raw node name is a variable name. A node name is a variable name if it starts with the variable name prefix.

Parameters

[in] node the name of the node.

Returns: a pair. If node is not a variable name, the returned pair is (false, node), otherwise, it is (true, variableName) where variable name is obtained from node by removing the variable name prefix.

Definition at line 112 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the caller graph for this function:

◆ parse()

TuringStyleMixedSymbolPatternParser::SymbolPattern TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::parse ( const std::string & pattern ) const

Parse a string into a symbol pattern. The usual entry point.

Parameters

[in] pattern the string to parse.

Returns: The parsed pattern.

Exceptions

TuringStyleMixedSymbolPatternSyntaxErrorException if there is a syntax error.

Definition at line 70 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

◆ parse_negative_pattern()

std::pair< TuringStyleMixedSymbolPatternParser::SymbolPattern, size_t > TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::parse_negative_pattern	(	const std::string &	pattern,
		const std::vector< Token > &	tokens,
		size_t	position
	)		const

Parse a negative list of symbols.

Parameters

[in]	pattern	the full string to parse.
[in]	tokens	the sequence of tokens.
[in]	position	the position in `tokens` to start parsing.

Returns: The parsed pattern and the new position.

Exceptions

TuringStyleMixedSymbolPatternSyntaxErrorException if there is a syntax error.

Definition at line 124 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse_positive_pattern()

std::pair< TuringStyleMixedSymbolPatternParser::SymbolPattern, size_t > TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::parse_positive_pattern	(	const std::string &	pattern,
		const std::vector< Token > &	tokens,
		size_t	position
	)		const

Parse a positive list of symbols.

Parameters

[in]	pattern	the full string to parse.
[in]	tokens	the sequence of tokens.
[in]	position	the position in `tokens` to start parsing.

Returns: The parsed pattern and the new position.

Exceptions

TuringStyleMixedSymbolPatternSyntaxErrorException if there is a syntax error.

Definition at line 197 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sub()

std::string TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::sub	(	const std::string &	pattern,
		const TuringStyleMixedSymbolPatternParser::Token &	token
	)		const

Get the text of a token.

Parameters

[in]	pattern	the full string.
[in]	token	the token we want the string.

Returns: the text of the token.

Definition at line 262 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the caller graph for this function:

◆ tokenize() [1/2]

std::vector< TuringStyleMixedSymbolPatternParser::Token > TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::tokenize ( const std::string & pattern ) const

Fully lex a string, without recognizing keyword.

Parameters

[in] pattern the string to parse.

Returns: the vector of raw tokens.

Definition at line 269 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the caller graph for this function:

◆ tokenize() [2/2]

TuringStyleMixedSymbolPatternParser::Token TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::tokenize	(	const std::string &	pattern,
		size_t	start
	)		const

Lex a single token.

Parameters

[in]	pattern	the full string to parse.
[in]	start	the starting position.

Returns: the token parsed from position start.

Definition at line 282 of file turingStyleMixedSymbolPatternParser.cpp.

◆ translateKeyword()

std::optional< TuringStyleMixedSymbolPatternParser::Token > TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::translateKeyword	(	const std::string &	pattern,
		const TuringStyleMixedSymbolPatternParser::Token &	token
	)		const

Translate a single token by recognizing keyword.

Parameters

[in]	pattern	the full string to parse.
[in]	token	the token to translate.

Returns: an empty option if no translation is required, the new token otherwise.

This function translate IDENT token into dedicated keyword tokens.

Definition at line 298 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translateKeywords()

void TuringSim::Symbol::TuringStyleMixedSymbolPatternParser::translateKeywords	(	const std::string &	pattern,
		std::vector< Token > &	tokens
	)		const

Translate a full sequence of tokens.

Parameters

[in]	pattern	the full string to parse.
[in,out]	tokens	the list of tokens, modified in-place.

Definition at line 318 of file turingStyleMixedSymbolPatternParser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/2]

template<typename CharT , typename Traits >

std::basic_ostream<CharT, Traits>& operator<<	(	std::basic_ostream< CharT, Traits > &	os,
		const Token &	token
	)

friend

Debug printer of Token.

Template Parameters

CharT	the char type.
Traits	`std::basic_ostream` trait.

Parameters

[in,out]	os	the output stream
[in]	token	the token to print.

Returns: the updated stream

Definition at line 204 of file turingStyleMixedSymbolPatternParser.h.

◆ operator<< [2/2]

template<typename CharT , typename Traits = std::char_traits <CharT>>

std::basic_ostream<CharT, Traits>& operator<<	(	std::basic_ostream< CharT, Traits > &	os,
		const TokenKind &	tokenKind
	)

friend

Debug printer of TokenKind.

Template Parameters

CharT	the char type.
Traits	`std::basic_ostream` trait.

Parameters

[in,out]	os	the output stream
[in]	tokenKind	the token kind to print.

Returns: the updated stream

Definition at line 163 of file turingStyleMixedSymbolPatternParser.h.

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

include/symbol/turingStyleMixedSymbolPatternParser.h
src/symbol/turingStyleMixedSymbolPatternParser.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ TokenKind

Constructor & Destructor Documentation

◆ TuringStyleMixedSymbolPatternParser() [1/2]

◆ TuringStyleMixedSymbolPatternParser() [2/2]

Member Function Documentation

◆ checkInitialization()

◆ isVariableNode()

◆ parse()

◆ parse_negative_pattern()

◆ parse_positive_pattern()

◆ sub()

◆ tokenize() [1/2]

◆ tokenize() [2/2]

◆ translateKeyword()

◆ translateKeywords()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]