The parser is responsible of constructing the Abstract Syntax Tree from a token list. More...

#include <Parser.hpp>

Collaboration diagram for Ark::internal::Parser:

Public Member Functions
	Parser (unsigned debug, uint16_t options, const std::vector< std::string > &lib_env) noexcept
	Construct a new Parser object.

void	feed (const std::string &code, const std::string &filename=ARK_NO_NAME_FILE)
	Give the code to parse.

const Node &	ast () const noexcept
	Return the generated AST.

const std::vector< std::string > &	getImports () const noexcept
	Return the list of files imported by the code given to the parser.

Private Member Functions
void	sugar (std::vector< Token > &tokens) noexcept
	Applying syntactic sugar: {...} => (begin...), [...] => (list ...)

Node	parse (std::list< Token > &tokens, bool authorize_capture=false, bool authorize_field_read=false, bool in_macro=false)
	Parse a list of tokens recursively.

void	parseIf (Node &, std::list< Token > &, bool)

void	parseLetMut (Node &, Token &, std::list< Token > &, bool)

void	parseSet (Node &, Token &, std::list< Token > &, bool)

void	parseFun (Node &, Token &, std::list< Token > &, bool)

void	parseWhile (Node &, Token &, std::list< Token > &, bool)

void	parseBegin (Node &, std::list< Token > &, bool)

void	parseImport (Node &, std::list< Token > &)

void	parseQuote (Node &, std::list< Token > &, bool)

void	parseDel (Node &, std::list< Token > &)

Node	parseShorthand (Token &, std::list< Token > &, bool)

void	checkForInvalidTokens (Node &, Token &, bool, bool, bool)

Token	nextToken (std::list< Token > &tokens)
	Get the next token if possible, from a list of tokens.

Node	atom (const Token &token)
	Convert a token to a node.

bool	checkForInclude (Node &n, Node &parent, std::size_t pos=0)
	Search for all the includes in a given node, in its sub-nodes and replace them by the code of the included file.

std::string	seekFile (const std::string &file)
	Seek a file in the lib folder and everywhere.

void	expect (bool pred, const std::string &message, Token token)
	Throw a parse exception is the given predicated is false.

void	throwParseError (const std::string &message, Token token)
	Throw a parse error related to a token (seek it in the related file and highlight the error)

Private Attributes
unsigned	m_debug

std::vector< std::string >	m_libenv

uint16_t	m_options

Lexer	m_lexer

Node	m_ast

Token	m_last_token

std::string	m_file

std::string	m_code

std::vector< std::string >	m_parent_include

Friends
std::ostream &	operator<< (std::ostream &os, const Parser &P) noexcept

Detailed Description

The parser is responsible of constructing the Abstract Syntax Tree from a token list.

Definition at line 43 of file Parser.hpp.

Constructor & Destructor Documentation

◆ Parser()

Ark::internal::Parser::Parser	(	unsigned	debug,
		uint16_t	options,
		const std::vector< std::string > &	lib_env
	)

noexcept

Construct a new Parser object.

Parameters

debug	the debug level
options	the parsing options
lib_env	fallback library search path

Definition at line 13 of file Parser.cpp.

Member Function Documentation

◆ ast()

const Node & Ark::internal::Parser::ast ( ) const

noexcept

Return the generated AST.

Returns: const Node&

Definition at line 59 of file Parser.cpp.

References m_ast.

Referenced by checkForInclude(), Ark::Compiler::feed(), and Ark::JsonCompiler::feed().

◆ atom()

Node Ark::internal::Parser::atom ( const Token & token )

private

Convert a token to a node.

Parameters

token the token to converts

Returns: Node

Definition at line 411 of file Parser.cpp.

References Ark::internal::Begin, Ark::internal::Capture, Ark::internal::Token::col, Ark::internal::Del, Ark::internal::Fun, Ark::internal::GetField, Ark::internal::If, Ark::internal::Import, Ark::internal::Keyword, Ark::internal::Let, Ark::internal::Token::line, m_file, Ark::internal::make_node(), Ark::internal::Mut, Ark::internal::Number, Ark::internal::Quote, Ark::internal::Set, Ark::internal::Node::setString(), Ark::internal::Shorthand, Ark::internal::similarNodetypeFromTokentype(), Ark::internal::Spread, Ark::internal::String, Ark::internal::Symbol, throwParseError(), Ark::internal::Token::token, Ark::internal::Token::type, and Ark::internal::While.

Referenced by parse(), parseDel(), parseIf(), parseImport(), parseLetMut(), parseSet(), and parseWhile().

◆ checkForInclude()

bool Ark::internal::Parser::checkForInclude	(	Node &	n,
		Node &	parent,
		std::size_t	pos = `0`
	)

private

Search for all the includes in a given node, in its sub-nodes and replace them by the code of the included file.

Parameters

n
parent	the parent node of the current one
pos	the position of the child node in the parent node list

Returns: true if we found an import and replaced it by the corresponding code

Definition at line 480 of file Parser.cpp.

References ast(), Ark::Utils::canonicalRelPath(), checkForInclude(), Ark::internal::Node::constList(), feed(), Ark::internal::Import, Ark::internal::Node::keyword(), Ark::internal::Keyword, Ark::internal::Node::list(), Ark::internal::List, m_debug, m_file, m_libenv, m_options, m_parent_include, Ark::internal::Node::nodeType(), Ark::Utils::readFile(), seekFile(), and Ark::internal::String.

Referenced by checkForInclude(), and feed().

◆ checkForInvalidTokens()

void Ark::internal::Parser::checkForInvalidTokens	(	Node &	atomized,
		Token &	token,
		bool	previous_token_was_lparen,
		bool	authorize_capture,
		bool	authorize_field_read
	)

private

Definition at line 377 of file Parser.cpp.

References Ark::internal::List, Ark::internal::Node::nodeType(), Ark::internal::Number, Ark::internal::String, and throwParseError().

Referenced by parse().

◆ expect()

void Ark::internal::Parser::expect	(	bool	pred,
		const std::string &	message,
		internal::Token	token
	)

private

Throw a parse exception is the given predicated is false.

Parameters

pred
message	error message to use
token	concerned token

Definition at line 579 of file Parser.cpp.

References throwParseError().

Referenced by nextToken(), parse(), parseBegin(), parseDel(), parseFun(), parseIf(), parseImport(), parseLetMut(), parseQuote(), parseSet(), and parseWhile().

◆ feed()

void Ark::internal::Parser::feed	(	const std::string &	code,
		const std::string &	filename = `ARK_NO_NAME_FILE`
	)

Give the code to parse.

Parameters

code	the ArkScript code
filename	the name of the file

Definition at line 21 of file Parser.cpp.

References ARK_NO_NAME_FILE, Ark::internal::Begin, Ark::Utils::canonicalRelPath(), checkForInclude(), Ark::internal::Lexer::feed(), Ark::internal::Node::list(), Ark::internal::List, m_ast, m_code, m_debug, m_file, m_last_token, m_lexer, m_parent_include, parse(), Ark::internal::Node::setFilename(), sugar(), and Ark::internal::Lexer::tokens().

Referenced by checkForInclude(), Ark::Compiler::feed(), and Ark::JsonCompiler::feed().

◆ getImports()

const std::vector< std::string > & Ark::internal::Parser::getImports ( ) const

noexcept

Return the list of files imported by the code given to the parser.

Each path of each imported file is relative to the filename given when feeding the parser.

Returns: const std::vector<std::string>&

Definition at line 64 of file Parser.cpp.

References m_parent_include.

◆ nextToken()

Token Ark::internal::Parser::nextToken ( std::list< Token > & tokens )

private

Get the next token if possible, from a list of tokens.

The list of tokens is modified.

Parameters

tokens list of tokens to get the next token from

Returns: Token

Definition at line 401 of file Parser.cpp.

References expect(), and m_last_token.

Referenced by parse(), parseDel(), parseIf(), parseImport(), parseLetMut(), parseSet(), and parseWhile().

◆ parse()

Node Ark::internal::Parser::parse	(	std::list< Token > &	tokens,
		bool	authorize_capture = `false`,
		bool	authorize_field_read = `false`,
		bool	in_macro = `false`
	)

private

Parse a list of tokens recursively.

Parameters

tokens
authorize_capture	if we are authorized to consume TokenType::Capture tokens
authorize_field_read	if we are authorized to consume TokenType::GetField tokens
in_macro	if we are in a macro, there a bunch of things we can tolerate

Returns: Node

Definition at line 102 of file Parser.cpp.

References atom(), Ark::internal::Capture, checkForInvalidTokens(), Ark::internal::Token::col, expect(), Ark::internal::GetField, Ark::internal::Grouping, Ark::internal::Identifier, Ark::internal::Keyword, Ark::internal::Token::line, m_file, m_last_token, Ark::internal::make_node_list(), nextToken(), Ark::internal::Number, Ark::internal::Operator, Ark::internal::operators, parse(), parseBegin(), parseDel(), parseFun(), parseIf(), parseImport(), parseLetMut(), parseQuote(), parseSet(), parseShorthand(), parseWhile(), Ark::internal::Node::push_back(), Ark::internal::Shorthand, Ark::internal::Spread, Ark::internal::String, throwParseError(), Ark::internal::Token::token, and Ark::internal::Token::type.

Referenced by feed(), parse(), parseBegin(), parseFun(), parseIf(), parseLetMut(), parseQuote(), parseSet(), parseShorthand(), and parseWhile().

◆ parseBegin()

void Ark::internal::Parser::parseBegin	(	Node &	block,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 308 of file Parser.cpp.

References expect(), m_last_token, parse(), and Ark::internal::Node::push_back().

Referenced by parse().

◆ parseDel()

void Ark::internal::Parser::parseDel	(	Node &	block,
		std::list< Token > &	tokens
	)

private

Definition at line 336 of file Parser.cpp.

References atom(), expect(), Ark::internal::Identifier, nextToken(), Ark::internal::Node::push_back(), and throwParseError().

Referenced by parse().

◆ parseFun()

void Ark::internal::Parser::parseFun	(	Node &	block,
		Token &	token,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 276 of file Parser.cpp.

References expect(), Ark::internal::Grouping, Ark::internal::Node::list(), m_last_token, parse(), Ark::internal::Node::push_back(), throwParseError(), and Ark::internal::Token::token.

Referenced by parse().

◆ parseIf()

void Ark::internal::Parser::parseIf	(	Node &	block,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 204 of file Parser.cpp.

References atom(), expect(), Ark::internal::Grouping, Ark::internal::Identifier, m_last_token, nextToken(), Ark::internal::Number, parse(), Ark::internal::Node::push_back(), Ark::internal::Spread, Ark::internal::String, and throwParseError().

Referenced by parse().

◆ parseImport()

void Ark::internal::Parser::parseImport	(	Node &	block,
		std::list< Token > &	tokens
	)

private

Definition at line 321 of file Parser.cpp.

References atom(), expect(), nextToken(), Ark::internal::Node::push_back(), Ark::internal::String, and throwParseError().

Referenced by parse().

◆ parseLetMut()

void Ark::internal::Parser::parseLetMut	(	Node &	block,
		Token &	token,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 227 of file Parser.cpp.

References atom(), expect(), Ark::internal::Identifier, Ark::internal::Node::list(), m_last_token, nextToken(), parse(), Ark::internal::Node::push_back(), throwParseError(), and Ark::internal::Token::token.

Referenced by parse().

◆ parseQuote()

void Ark::internal::Parser::parseQuote	(	Node &	block,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 330 of file Parser.cpp.

References expect(), parse(), and Ark::internal::Node::push_back().

Referenced by parse().

◆ parseSet()

void Ark::internal::Parser::parseSet	(	Node &	block,
		Token &	token,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 250 of file Parser.cpp.

References atom(), expect(), Ark::internal::GetField, Ark::internal::Identifier, Ark::internal::Node::list(), m_last_token, nextToken(), parse(), Ark::internal::Node::push_back(), throwParseError(), and Ark::internal::Token::token.

Referenced by parse().

◆ parseShorthand()

Node Ark::internal::Parser::parseShorthand	(	Token &	token,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 345 of file Parser.cpp.

References Ark::internal::Token::col, Ark::internal::Token::line, Ark::internal::Node::list(), Ark::internal::List, m_debug, m_file, Ark::internal::Macro, Ark::internal::make_node(), Ark::internal::make_node_list(), Ark::internal::Node::nodeType(), parse(), Ark::internal::Node::push_back(), Ark::internal::Quote, throwParseError(), and Ark::internal::Token::token.

Referenced by parse().

◆ parseWhile()

void Ark::internal::Parser::parseWhile	(	Node &	block,
		Token &	token,
		std::list< Token > &	tokens,
		bool	in_macro
	)

private

Definition at line 291 of file Parser.cpp.

References atom(), expect(), Ark::internal::Grouping, Ark::internal::Identifier, Ark::internal::Node::list(), nextToken(), Ark::internal::Number, parse(), Ark::internal::Node::push_back(), Ark::internal::String, throwParseError(), and Ark::internal::Token::token.

Referenced by parse().

◆ seekFile()

std::string Ark::internal::Parser::seekFile ( const std::string & file )

private

Seek a file in the lib folder and everywhere.

Parameters

file

Returns: std::string

Definition at line 547 of file Parser.cpp.

References Ark::Utils::fileExists(), Ark::Utils::getDirectoryFromPath(), Ark::Utils::getFilenameFromPath(), m_debug, m_file, and m_libenv.

Referenced by checkForInclude().

◆ sugar()

void Ark::internal::Parser::sugar ( std::vector< Token > & tokens )

privatenoexcept

Applying syntactic sugar: {...} => (begin...), [...] => (list ...)

Parameters

tokens a list of tokens

Definition at line 69 of file Parser.cpp.

References Ark::internal::Grouping, Ark::internal::Identifier, and Ark::internal::Keyword.

Referenced by feed().

◆ throwParseError()

void Ark::internal::Parser::throwParseError	(	const std::string &	message,
		internal::Token	token
	)

private

Throw a parse error related to a token (seek it in the related file and highlight the error)

Parameters

message
token

Definition at line 585 of file Parser.cpp.

References ARK_NO_NAME_FILE, Ark::internal::Token::col, Ark::internal::Token::line, m_code, m_file, Ark::internal::makeTokenBasedErrorCtx(), Ark::internal::Token::token, Ark::internal::tokentype_string, and Ark::internal::Token::type.

Referenced by atom(), checkForInvalidTokens(), expect(), parse(), parseDel(), parseFun(), parseIf(), parseImport(), parseLetMut(), parseSet(), parseShorthand(), and parseWhile().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Parser &	P
	)

friend

Definition at line 597 of file Parser.cpp.

Member Data Documentation

◆ m_ast

Node Ark::internal::Parser::m_ast

private

Definition at line 86 of file Parser.hpp.

Referenced by ast(), and feed().

◆ m_code

std::string Ark::internal::Parser::m_code

private

Definition at line 92 of file Parser.hpp.

Referenced by feed(), and throwParseError().

◆ m_debug

unsigned Ark::internal::Parser::m_debug

private

Definition at line 82 of file Parser.hpp.

Referenced by checkForInclude(), feed(), parseShorthand(), and seekFile().

◆ m_file

std::string Ark::internal::Parser::m_file

private

Definition at line 90 of file Parser.hpp.

Referenced by atom(), checkForInclude(), feed(), parse(), parseShorthand(), seekFile(), and throwParseError().

◆ m_last_token

Token Ark::internal::Parser::m_last_token

private

Definition at line 87 of file Parser.hpp.

Referenced by feed(), nextToken(), parse(), parseBegin(), parseFun(), parseIf(), parseLetMut(), and parseSet().

◆ m_lexer

Lexer Ark::internal::Parser::m_lexer

private

Definition at line 85 of file Parser.hpp.

Referenced by feed().

◆ m_libenv

std::vector<std::string> Ark::internal::Parser::m_libenv

private

Definition at line 83 of file Parser.hpp.

Referenced by checkForInclude(), and seekFile().

◆ m_options

uint16_t Ark::internal::Parser::m_options

private

Definition at line 84 of file Parser.hpp.

Referenced by checkForInclude().

◆ m_parent_include

std::vector<std::string> Ark::internal::Parser::m_parent_include

private

Definition at line 94 of file Parser.hpp.

Referenced by checkForInclude(), feed(), and getImports().

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

/Users/fola/Documents/ArkScript/Ark/include/Ark/Compiler/AST/Parser.hpp
/Users/fola/Documents/ArkScript/Ark/src/arkreactor/Compiler/AST/Parser.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Parser()

Member Function Documentation

◆ ast()

◆ atom()

◆ checkForInclude()

◆ checkForInvalidTokens()

◆ expect()

◆ feed()

◆ getImports()

◆ nextToken()

◆ parse()

◆ parseBegin()

◆ parseDel()

◆ parseFun()

◆ parseIf()

◆ parseImport()

◆ parseLetMut()

◆ parseQuote()

◆ parseSet()

◆ parseShorthand()

◆ parseWhile()

◆ seekFile()

◆ sugar()

◆ throwParseError()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ m_ast

◆ m_code

◆ m_debug

◆ m_file

◆ m_last_token

◆ m_lexer

◆ m_libenv

◆ m_options

◆ m_parent_include