#include <NameResolutionPass.hpp>

Inheritance diagram for Ark::internal::NameResolutionPass:

Collaboration diagram for Ark::internal::NameResolutionPass:

Public Member Functions
	NameResolutionPass (unsigned debug)
	Create a NameResolutionPass.

void	process (const Node &ast)
	Start visiting the given AST, checking for mutability violation and unbound variables.

const Node &	ast () const noexcept
	Unused overload that return the input AST (untouched as this pass only generates errors)

std::string	addDefinedSymbol (const std::string &sym, bool is_mutable)
	Register a symbol as defined, so that later we can throw errors on undefined symbols.

Public Member Functions inherited from Ark::internal::Pass
	Pass (std::string name, unsigned debug_level)
	Construct a new Pass object.

virtual	~Pass ()=default

void	configureLogger (std::ostream &os)
	Set a custom output stream for the logger.

Private Member Functions
void	visit (Node &node, bool register_declarations)
	Recursively visit nodes.

void	visitKeyword (Node &node, Keyword keyword, bool register_declarations)

void	addSymbolNode (const Node &symbol, const std::string &old_name="")
	Register a given node in the symbol table.

bool	mayBeFromPlugin (const std::string &name) const noexcept
	Checking if a symbol may be coming from a plugin.

std::string	updateSymbolWithFullyQualifiedName (Node &symbol)

void	checkForUndefinedSymbol () const
	Checks for undefined symbols, not present in the defined symbols table.

std::string	offerSuggestion (const std::string &str) const
	Suggest a symbol of what the user may have meant to input.

Private Attributes
Node	m_ast

std::unordered_set< std::string >	m_language_symbols
	Precomputed set of language symbols that can't be used to define variables.

std::vector< Node >	m_symbol_nodes

std::unordered_set< std::string >	m_defined_symbols

std::vector< std::string >	m_plugin_names

ScopeResolver	m_scope_resolver

Additional Inherited Members
Protected Attributes inherited from Ark::internal::Pass
Logger	m_logger

Detailed Description

Definition at line 25 of file NameResolutionPass.hpp.

Constructor & Destructor Documentation

◆ NameResolutionPass()

Ark::internal::NameResolutionPass::NameResolutionPass ( unsigned debug )

explicit

Create a NameResolutionPass.

Parameters

debug debug level

Definition at line 9 of file NameResolutionPass.cpp.

References Ark::internal::Language::And, Ark::internal::Language::Apply, Ark::internal::Builtins::builtins, Ark::internal::Language::listInstructions, m_language_symbols, Ark::internal::Language::operators, Ark::internal::Language::Or, Ark::internal::Language::SysArgs, Ark::internal::Language::SysProgramName, and Ark::internal::Language::SysVersion.

Member Function Documentation

◆ addDefinedSymbol()

std::string Ark::internal::NameResolutionPass::addDefinedSymbol	(	const std::string &	sym,
		bool	is_mutable )

Register a symbol as defined, so that later we can throw errors on undefined symbols.

Parameters

sym
is_mutable	true if the symbol is inside mut/set, false otherwise (let)

Definition at line 50 of file NameResolutionPass.cpp.

References m_defined_symbols, m_scope_resolver, and Ark::internal::ScopeResolver::registerInCurrent().

Referenced by Ark::Welder::computeASTFromStringWithKnownSymbols(), Ark::Welder::registerSymbol(), and visitKeyword().

◆ addSymbolNode()

void Ark::internal::NameResolutionPass::addSymbolNode	(	const Node &	symbol,
		const std::string &	old_name = "" )

private

Register a given node in the symbol table.

Parameters

symbol
old_name	old name for symbol, to replace it with the new one if it was renamed

Definition at line 270 of file NameResolutionPass.cpp.

References Ark::internal::Node::filename(), m_language_symbols, m_symbol_nodes, Ark::internal::Node::position(), Ark::internal::FileSpan::start, and Ark::internal::Node::string().

Referenced by visit().

◆ ast()

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

nodiscardnoexcept

Unused overload that return the input AST (untouched as this pass only generates errors)

Returns: const Node& ast

Definition at line 45 of file NameResolutionPass.cpp.

References m_ast.

Referenced by Ark::Welder::computeAST(), and process().

◆ checkForUndefinedSymbol()

void Ark::internal::NameResolutionPass::checkForUndefinedSymbol ( ) const

private

Checks for undefined symbols, not present in the defined symbols table.

Definition at line 344 of file NameResolutionPass.cpp.

References Ark::internal::HiddenSymbolSuffix, m_defined_symbols, m_symbol_nodes, mayBeFromPlugin(), and offerSuggestion().

Referenced by process().

◆ mayBeFromPlugin()

bool Ark::internal::NameResolutionPass::mayBeFromPlugin ( const std::string & name ) const

nodiscardprivatenoexcept

Checking if a symbol may be coming from a plugin.

Parameters

name	symbol name

Returns: true the symbol may be from a plugin, loaded at runtime; false

Definition at line 300 of file NameResolutionPass.cpp.

References Ark::Utils::splitString().

Referenced by checkForUndefinedSymbol().

◆ offerSuggestion()

std::string Ark::internal::NameResolutionPass::offerSuggestion ( const std::string & str ) const

nodiscardprivate

Suggest a symbol of what the user may have meant to input.

Parameters

str	the string

Returns: std::string

Definition at line 380 of file NameResolutionPass.cpp.

References Ark::internal::HiddenSymbolSuffix, Ark::Utils::levenshteinDistance(), m_defined_symbols, and m_language_symbols.

Referenced by checkForUndefinedSymbol().

◆ process()

void Ark::internal::NameResolutionPass::process ( const Node & ast )

Start visiting the given AST, checking for mutability violation and unbound variables.

Parameters

ast	AST to analyze

Definition at line 27 of file NameResolutionPass.cpp.

References ast(), checkForUndefinedSymbol(), Ark::internal::Logger::debug(), Ark::internal::Node::debugPrint(), m_ast, Ark::internal::Pass::m_logger, Ark::internal::Logger::shouldDebug(), Ark::internal::Logger::traceEnd(), Ark::internal::Logger::traceStart(), and visit().

Referenced by Ark::Welder::computeAST().

◆ updateSymbolWithFullyQualifiedName()

std::string Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName ( Node & symbol )

private

Definition at line 311 of file NameResolutionPass.cpp.

References Ark::internal::ScopeResolver::canFullyQualifyName(), Ark::internal::Node::debugPrint(), Ark::internal::Node::filename(), Ark::internal::HiddenSymbolSuffix, m_ast, m_language_symbols, Ark::internal::Pass::m_logger, m_scope_resolver, Ark::internal::Node::position(), Ark::internal::Node::setString(), Ark::internal::Logger::shouldTrace(), and Ark::internal::Node::string().

Referenced by visit(), and visitKeyword().

◆ visit()

void Ark::internal::NameResolutionPass::visit	(	Node &	node,
		bool	register_declarations )

private

Recursively visit nodes.

Parameters

node	node to visit
register_declarations	whether or not the visit should register declarations

Definition at line 57 of file NameResolutionPass.cpp.

References addSymbolNode(), Ark::internal::Language::AppendInPlace, Ark::internal::Node::arkNamespace(), Ark::internal::Language::ConcatInPlace, Ark::internal::Node::constList(), Ark::internal::ScopeResolver::createNewNamespace(), Ark::internal::ScopeResolver::currentScope(), Ark::internal::Field, Ark::internal::Node::filename(), Ark::internal::ScopeResolver::getFullyQualifiedNameInNearestScope(), Ark::internal::ScopeResolver::isImmutable(), Ark::internal::Keyword, Ark::internal::List, Ark::internal::Node::list(), m_scope_resolver, Ark::internal::Namespace, Ark::internal::Node::nodeType(), Ark::internal::ScopeResolver::saveNamespaceAndRemove(), Ark::internal::Node::setString(), Ark::internal::Node::string(), Ark::internal::Symbol, Ark::internal::Language::UpdateRef, updateSymbolWithFullyQualifiedName(), visit(), and visitKeyword().

Referenced by process(), visit(), and visitKeyword().

◆ visitKeyword()

void Ark::internal::NameResolutionPass::visitKeyword	(	Node &	node,
		Keyword	keyword,
		bool	register_declarations )

private

Parameters

node	a list node whose first child is a keyword
keyword
register_declarations	whether or not the visit should register declarations

Definition at line 163 of file NameResolutionPass.cpp.

References addDefinedSymbol(), Ark::internal::Capture, Ark::internal::Node::constList(), Ark::internal::ScopeResolver::createNew(), Ark::internal::Node::filename(), Ark::internal::Fun, Ark::internal::Import, Ark::internal::ScopeResolver::isImmutable(), Ark::internal::ScopeResolver::isInScope(), Ark::internal::ScopeResolver::isRegistered(), Ark::internal::Let, Ark::internal::List, Ark::internal::Node::list(), m_defined_symbols, m_language_symbols, m_plugin_names, m_scope_resolver, Ark::internal::Mut, Ark::internal::MutArg, Ark::internal::RefArg, Ark::internal::ScopeResolver::removeLastScope(), Ark::internal::Set, Ark::internal::Symbol, updateSymbolWithFullyQualifiedName(), visit(), and Ark::internal::While.

Referenced by visit().

Member Data Documentation

◆ m_ast

Node Ark::internal::NameResolutionPass::m_ast

private

Definition at line 55 of file NameResolutionPass.hpp.

Referenced by ast(), process(), and updateSymbolWithFullyQualifiedName().

◆ m_defined_symbols

std::unordered_set<std::string> Ark::internal::NameResolutionPass::m_defined_symbols

private

Definition at line 58 of file NameResolutionPass.hpp.

Referenced by addDefinedSymbol(), checkForUndefinedSymbol(), offerSuggestion(), and visitKeyword().

◆ m_language_symbols

std::unordered_set<std::string> Ark::internal::NameResolutionPass::m_language_symbols

private

Precomputed set of language symbols that can't be used to define variables.

Definition at line 56 of file NameResolutionPass.hpp.

Referenced by addSymbolNode(), NameResolutionPass(), offerSuggestion(), updateSymbolWithFullyQualifiedName(), and visitKeyword().

◆ m_plugin_names

std::vector<std::string> Ark::internal::NameResolutionPass::m_plugin_names

private

Definition at line 59 of file NameResolutionPass.hpp.

Referenced by visitKeyword().

◆ m_scope_resolver

ScopeResolver Ark::internal::NameResolutionPass::m_scope_resolver

private

Definition at line 60 of file NameResolutionPass.hpp.

Referenced by addDefinedSymbol(), updateSymbolWithFullyQualifiedName(), visit(), and visitKeyword().

◆ m_symbol_nodes

std::vector<Node> Ark::internal::NameResolutionPass::m_symbol_nodes

private

Definition at line 57 of file NameResolutionPass.hpp.

Referenced by addSymbolNode(), and checkForUndefinedSymbol().

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

/Users/fola/Documents/ArkScript/Ark/include/Ark/Compiler/NameResolution/NameResolutionPass.hpp
/Users/fola/Documents/ArkScript/Ark/src/arkreactor/Compiler/NameResolution/NameResolutionPass.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NameResolutionPass()

Member Function Documentation

◆ addDefinedSymbol()

◆ addSymbolNode()

◆ ast()

◆ checkForUndefinedSymbol()

◆ mayBeFromPlugin()

◆ offerSuggestion()

◆ process()

◆ updateSymbolWithFullyQualifiedName()

◆ visit()

◆ visitKeyword()

Member Data Documentation

◆ m_ast

◆ m_defined_symbols

◆ m_language_symbols

◆ m_plugin_names

◆ m_scope_resolver

◆ m_symbol_nodes