#include <Parser.hpp>

Inheritance diagram for Ark::internal::Parser:

Collaboration diagram for Ark::internal::Parser:

Public Member Functions
	Parser (unsigned debug, bool interpret=true)
	Constructs a new Parser object.

void	process (const std::string &filename, const std::string &code)
	Parse the given code.

const Node &	ast () const noexcept

const std::vector< Import > &	imports () const

Public Member Functions inherited from Ark::internal::BaseParser
	BaseParser ()=default

Private Member Functions
Node &	setNodePosAndFilename (Node &node, const std::optional< FilePosition > &cursor=std::nullopt) const
	Update a node given a file position.

std::optional< Node >	node ()

std::optional< Node >	letMutSet ()

std::optional< Node >	del ()

std::optional< Node >	condition ()

std::optional< Node >	loop ()

std::optional< Node >	import_ ()

std::optional< Node >	block ()

std::optional< Node >	functionArgs ()

std::optional< Node >	function ()

std::optional< Node >	macroCondition ()

std::optional< Node >	macroArgs ()

std::optional< Node >	macro ()

std::optional< Node >	functionCall ()

std::optional< Node >	list ()

std::optional< Node >	number ()

std::optional< Node >	string ()

std::optional< Node >	field ()

std::optional< Node >	symbol ()

std::optional< Node >	spread ()

std::optional< Node >	nil ()

std::optional< Node >	atom ()
	Try to parse an atom (number, string, spread, field, symbol, nil)

std::optional< Node >	anyAtomOf (std::initializer_list< NodeType > types)
	Try to parse an atom, if any, match its type against the given list.

std::optional< Node >	nodeOrValue ()
	Try to parse an atom first, if it fails try to parse a node.

std::optional< Node >	wrapped (std::optional< Node >(Parser::*parser)(), const std::string &name)
	Try to parse using a given parser, prefixing and suffixing it with (...), handling comments around the parsed node.

Private Attributes
bool	m_interpret
	interpret escape codes in strings

Logger	m_logger

Node	m_ast

std::vector< Import >	m_imports

unsigned	m_allow_macro_behavior
	Toggled on when inside a macro definition, off afterward.

Additional Inherited Members
Protected Member Functions inherited from Ark::internal::BaseParser
void	initParser (const std::string &filename, const std::string &code)

FilePosition	getCursor () const

void	error (const std::string &error, std::string exp)

void	errorWithNextToken (const std::string &message)
	Fetch the next token (space and paren delimited) to generate an error.

void	errorMissingSuffix (char suffix, const std::string &node_name)
	Generate an error for a given node when a suffix is missing.

long	getCount ()

std::size_t	getSize () const

bool	isEOF () const

void	backtrack (long n)

bool	accept (const CharPred &t, std::string *s=nullptr)
	check if a Character Predicate was able to parse, call next() if matching

bool	expect (const CharPred &t, std::string *s=nullptr)
	heck if a Character Predicate was able to parse, call next() if matching ; throw a CodeError if it doesn't match

bool	space (std::string *s=nullptr)

bool	inlineSpace (std::string *s=nullptr)

bool	comment (std::string *s=nullptr)

bool	spaceComment (std::string *s=nullptr)

bool	newlineOrComment (std::string *s=nullptr)

bool	prefix (char c)

bool	suffix (char c)

bool	number (std::string *s=nullptr)

bool	signedNumber (std::string *s=nullptr)

bool	hexNumber (unsigned length, std::string *s=nullptr)

bool	name (std::string *s=nullptr)

bool	sequence (const std::string &s)

bool	packageName (std::string *s=nullptr)

bool	anyUntil (const CharPred &delim, std::string *s=nullptr)
	Match any char that do not match the predicate.

bool	oneOf (std::initializer_list< std::string > words, std::string *s=nullptr)
	Fetch a token and try to match one of the given words.

Protected Attributes inherited from Ark::internal::BaseParser
std::string	m_filename

Detailed Description

Definition at line 30 of file Parser.hpp.

Constructor & Destructor Documentation

◆ Parser()

Ark::internal::Parser::Parser	(	unsigned	debug,
		bool	interpret = true )

explicit

Constructs a new Parser object.

Parameters

debug	debug level
interpret	interpret escape codes in strings

Definition at line 7 of file Parser.cpp.

Member Function Documentation

◆ anyAtomOf()

std::optional< Node > Ark::internal::Parser::anyAtomOf ( std::initializer_list< NodeType > types )

private

Try to parse an atom, if any, match its type against the given list.

Parameters

types autorized types

Returns: std::optional<Node> std::nullopt if the parsed atom didn't match the given types

Definition at line 859 of file Parser.cpp.

References atom(), Ark::internal::BaseParser::getCursor(), and setNodePosAndFilename().

Referenced by functionCall().

◆ ast()

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

nodiscardnoexcept

Returns: const Node& resulting AST after processing the given code

Definition at line 48 of file Parser.cpp.

References m_ast.

Referenced by Ark::Welder::computeAST(), Ark::internal::ImportSolver::parseImport(), Formatter::run(), and Formatter::runWithString().

◆ atom()

std::optional< Node > Ark::internal::Parser::atom ( )

private

Try to parse an atom (number, string, spread, field, symbol, nil)

Returns: std::optional<Node> std::nullopt if no atom could be parsed

Definition at line 828 of file Parser.cpp.

References Ark::internal::BaseParser::backtrack(), field(), Ark::internal::BaseParser::getCount(), m_allow_macro_behavior, nil(), number(), spread(), string(), and symbol().

Referenced by anyAtomOf(), functionCall(), and nodeOrValue().

◆ block()

std::optional< Node > Ark::internal::Parser::block ( )

private

Definition at line 408 of file Parser.cpp.

References Ark::internal::BaseParser::accept(), Ark::internal::Begin, Ark::internal::BaseParser::comment(), Ark::internal::BaseParser::expect(), Ark::internal::BaseParser::isEOF(), Ark::internal::List, Ark::internal::BaseParser::newlineOrComment(), nodeOrValue(), Ark::internal::BaseParser::oneOf(), and setNodePosAndFilename().

Referenced by node().

◆ condition()

std::optional< Node > Ark::internal::Parser::condition ( )

private

Definition at line 199 of file Parser.cpp.

References Ark::internal::BaseParser::comment(), condition(), Ark::internal::BaseParser::errorWithNextToken(), Ark::internal::If, Ark::internal::List, Ark::internal::BaseParser::newlineOrComment(), nodeOrValue(), Ark::internal::BaseParser::oneOf(), and setNodePosAndFilename().

Referenced by condition(), loop(), macroCondition(), and node().

◆ del()

std::optional< Node > Ark::internal::Parser::del ( )

private

Definition at line 176 of file Parser.cpp.

References Ark::internal::BaseParser::comment(), Ark::internal::Del, Ark::internal::BaseParser::errorWithNextToken(), Ark::internal::List, Ark::internal::BaseParser::name(), Ark::internal::BaseParser::newlineOrComment(), Ark::internal::BaseParser::oneOf(), setNodePosAndFilename(), Ark::internal::Symbol, and symbol().

Referenced by node().

◆ field()

std::optional< Node > Ark::internal::Parser::field ( )

inlineprivate

Definition at line 196 of file Parser.hpp.

Referenced by atom().

◆ function()

std::optional< Node > Ark::internal::Parser::function ( )

private

Definition at line 501 of file Parser.cpp.

References Ark::internal::BaseParser::backtrack(), Ark::internal::BaseParser::comment(), Ark::internal::BaseParser::errorWithNextToken(), Ark::internal::Fun, functionArgs(), Ark::internal::BaseParser::getCount(), Ark::internal::List, m_allow_macro_behavior, Ark::internal::BaseParser::newlineOrComment(), nodeOrValue(), Ark::internal::Node::nodeType(), Ark::internal::BaseParser::oneOf(), setNodePosAndFilename(), Ark::internal::Node::string(), and Ark::internal::Symbol.

Referenced by node().

◆ functionArgs()

std::optional< Node > Ark::internal::Parser::functionArgs ( )

private

◆ functionCall()

std::optional< Node > Ark::internal::Parser::functionCall ( )

private

Definition at line 752 of file Parser.cpp.

References Ark::internal::BaseParser::accept(), anyAtomOf(), atom(), Ark::internal::BaseParser::comment(), Ark::internal::BaseParser::expect(), Ark::internal::Field, Ark::internal::BaseParser::getCursor(), Ark::internal::BaseParser::isEOF(), Ark::internal::List, Ark::internal::BaseParser::newlineOrComment(), node(), nodeOrValue(), setNodePosAndFilename(), and Ark::internal::Symbol.

Referenced by node().

◆ import_()

std::optional< Node > Ark::internal::Parser::import_ ( )

private

Definition at line 272 of file Parser.cpp.

Referenced by node().

◆ imports()

const std::vector< Import > & Ark::internal::Parser::imports ( ) const

nodiscard

Returns: const std::vector<Import>& list of imports detected by the parser

Definition at line 53 of file Parser.cpp.

References m_imports.

Referenced by Ark::Welder::computeAST(), and Ark::internal::ImportSolver::parseImport().

◆ letMutSet()

std::optional< Node > Ark::internal::Parser::letMutSet ( )

private

◆ list()

std::optional< Node > Ark::internal::Parser::list ( )

private

Definition at line 797 of file Parser.cpp.

References Ark::internal::BaseParser::accept(), Ark::internal::BaseParser::comment(), Ark::internal::BaseParser::expect(), Ark::internal::BaseParser::isEOF(), Ark::internal::List, Ark::internal::BaseParser::newlineOrComment(), nodeOrValue(), setNodePosAndFilename(), and Ark::internal::Symbol.

Referenced by node().

◆ loop()

std::optional< Node > Ark::internal::Parser::loop ( )

private

Definition at line 242 of file Parser.cpp.

References Ark::internal::BaseParser::comment(), condition(), Ark::internal::BaseParser::errorWithNextToken(), Ark::internal::List, Ark::internal::BaseParser::newlineOrComment(), nodeOrValue(), Ark::internal::BaseParser::oneOf(), setNodePosAndFilename(), and Ark::internal::While.

Referenced by node().

◆ macro()

std::optional< Node > Ark::internal::Parser::macro ( )

private

Definition at line 677 of file Parser.cpp.

Referenced by node().

◆ macroArgs()

std::optional< Node > Ark::internal::Parser::macroArgs ( )

private

Definition at line 612 of file Parser.cpp.

References Ark::internal::BaseParser::accept(), Ark::internal::BaseParser::backtrack(), Ark::internal::BaseParser::comment(), Ark::internal::BaseParser::errorWithNextToken(), Ark::internal::BaseParser::getCount(), Ark::internal::BaseParser::isEOF(), Ark::internal::List, Ark::internal::BaseParser::name(), Ark::internal::BaseParser::newlineOrComment(), Ark::internal::BaseParser::sequence(), setNodePosAndFilename(), Ark::internal::Spread, and Ark::internal::Symbol.

Referenced by macro().

◆ macroCondition()

std::optional< Node > Ark::internal::Parser::macroCondition ( )

private

Definition at line 571 of file Parser.cpp.

References Ark::internal::BaseParser::comment(), condition(), Ark::internal::BaseParser::errorWithNextToken(), Ark::internal::If, Ark::internal::Macro, Ark::internal::BaseParser::newlineOrComment(), nodeOrValue(), Ark::internal::BaseParser::oneOf(), and setNodePosAndFilename().

Referenced by node().

◆ nil()

std::optional< Node > Ark::internal::Parser::nil ( )

inlineprivate

Definition at line 242 of file Parser.hpp.

References Ark::internal::Node::attachNearestCommentBefore().

Referenced by atom().

◆ node()

std::optional< Node > Ark::internal::Parser::node ( )

private

Definition at line 69 of file Parser.cpp.

References Ark::internal::BaseParser::backtrack(), block(), condition(), del(), function(), functionCall(), Ark::internal::BaseParser::getCount(), import_(), letMutSet(), list(), loop(), macro(), macroCondition(), and wrapped().

Referenced by functionArgs(), functionCall(), nodeOrValue(), process(), and setNodePosAndFilename().

◆ nodeOrValue()

std::optional< Node > Ark::internal::Parser::nodeOrValue ( )

private

Try to parse an atom first, if it fails try to parse a node.

Returns: std::optional<Node> std::nullopt if no atom or node could be parsed

Definition at line 874 of file Parser.cpp.

References atom(), Ark::internal::BaseParser::getCursor(), node(), and setNodePosAndFilename().

Referenced by block(), condition(), function(), functionCall(), letMutSet(), list(), loop(), macro(), and macroCondition().

◆ number()

std::optional< Node > Ark::internal::Parser::number ( )

inlineprivate

Definition at line 89 of file Parser.hpp.

Referenced by atom().

◆ process()

void Ark::internal::Parser::process	(	const std::string &	filename,
		const std::string &	code )

Parse the given code.

Parameters

filename	can be left empty, used for error generation
code	content of the file

Definition at line 14 of file Parser.cpp.

Referenced by Ark::Welder::computeAST(), Ark::internal::ImportSolver::parseImport(), Formatter::run(), and Formatter::runWithString().

◆ setNodePosAndFilename()

Node & Ark::internal::Parser::setNodePosAndFilename	(	Node &	node,
		const std::optional< FilePosition > &	cursor = std::nullopt ) const

private

Update a node given a file position.

Parameters

node	node to update
cursor	the node position in file

Returns: Node& the modified node

Definition at line 58 of file Parser.cpp.

References Ark::internal::BaseParser::getCursor(), Ark::internal::BaseParser::m_filename, node(), and Ark::internal::Node::setPos().

Referenced by anyAtomOf(), block(), condition(), del(), function(), functionArgs(), functionCall(), import_(), letMutSet(), list(), loop(), macro(), macroArgs(), macroCondition(), nodeOrValue(), and wrapped().

◆ spread()

std::optional< Node > Ark::internal::Parser::spread ( )

inlineprivate

Definition at line 230 of file Parser.hpp.

Referenced by atom().

◆ string()

std::optional< Node > Ark::internal::Parser::string ( )

inlineprivate

Definition at line 105 of file Parser.hpp.

References utf8::decode().

Referenced by atom().

◆ symbol()

std::optional< Node > Ark::internal::Parser::symbol ( )

inlineprivate

Definition at line 222 of file Parser.hpp.

Referenced by atom(), del(), functionArgs(), import_(), letMutSet(), and macro().

◆ wrapped()

std::optional< Node > Ark::internal::Parser::wrapped	(	std::optional< Node >(Parser::*	parser )(),
		const std::string &	name )

private

Try to parse using a given parser, prefixing and suffixing it with (...), handling comments around the parsed node.

Parameters

parser	parser method returning a std::optional<Node>
name	construction name, eg "let", "condition"

Returns: std::optional<Node> std::nullopt if the parser didn't match

Definition at line 891 of file Parser.cpp.

References Ark::internal::BaseParser::comment(), Ark::internal::BaseParser::errorMissingSuffix(), Ark::internal::BaseParser::getCursor(), Ark::internal::BaseParser::name(), Ark::internal::BaseParser::newlineOrComment(), Ark::internal::BaseParser::prefix(), setNodePosAndFilename(), Ark::internal::BaseParser::spaceComment(), and Ark::internal::BaseParser::suffix().

Referenced by node().

Member Data Documentation

◆ m_allow_macro_behavior

unsigned Ark::internal::Parser::m_allow_macro_behavior

private

Toggled on when inside a macro definition, off afterward.

Definition at line 64 of file Parser.hpp.

Referenced by atom(), function(), letMutSet(), and macro().

◆ m_ast

Node Ark::internal::Parser::m_ast

private

Definition at line 62 of file Parser.hpp.

Referenced by ast(), and process().

◆ m_imports

std::vector<Import> Ark::internal::Parser::m_imports

private

Definition at line 63 of file Parser.hpp.

Referenced by import_(), and imports().

◆ m_interpret

bool Ark::internal::Parser::m_interpret

private

interpret escape codes in strings

Definition at line 60 of file Parser.hpp.

◆ m_logger

Logger Ark::internal::Parser::m_logger

private

Definition at line 61 of file Parser.hpp.

Referenced by process().

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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Parser()

Member Function Documentation

◆ anyAtomOf()

◆ ast()

◆ atom()

◆ block()

◆ condition()

◆ del()

◆ field()

◆ function()

◆ functionArgs()

◆ functionCall()

◆ import_()

◆ imports()

◆ letMutSet()

◆ list()

◆ loop()

◆ macro()

◆ macroArgs()

◆ macroCondition()

◆ nil()

◆ node()

◆ nodeOrValue()

◆ number()

◆ process()

◆ setNodePosAndFilename()

◆ spread()

◆ string()

◆ symbol()

◆ wrapped()

Member Data Documentation

◆ m_allow_macro_behavior

◆ m_ast

◆ m_imports

◆ m_interpret

◆ m_logger