Ark::internal::Node Class Reference

A node of an Abstract Syntax Tree for ArkScript. More...

#include <Node.hpp>

Collaboration diagram for Ark::internal::Node:

Public Types
using	Value = std::variant<double, std::string, Keyword, std::vector<Node>, Namespace>

Public Member Functions
	Node ()=default
	Node (NodeType node_type, const std::string &value)
	Node (NodeType node_type)
	Node (double value)
	Node (long value)
	Node (Keyword value)
	Node (Namespace namespace_)
const std::string &	string () const noexcept
	Return the string held by the value (if the node type allows it)
double	number () const noexcept
	Return the number held by the value (if the node type allows it)
Keyword	keyword () const noexcept
	Return the keyword held by the value (if the node type allows it)
Namespace &	arkNamespace () noexcept
	Return the namespace held by the value (if the node type allows it)
const Namespace &	constArkNamespace () const noexcept
	Return the namespace held by the value (if the node type allows it)
void	push_back (const Node &node) noexcept
	Every node has a list as well as a value so we can push_back on all node no matter their type.
std::vector< Node > &	list () noexcept
	Return the list of sub-nodes held by the node.
const std::vector< Node > &	constList () const noexcept
	Return the list of sub-nodes held by the node.
NodeType	nodeType () const noexcept
	Return the node type.
bool	isListLike () const noexcept
	Check if the node is a list like node.
bool	isStringLike () const noexcept
	Check if the node is a string like node.
void	updateValueAndType (const Node &source) noexcept
	Copy a node to the current one, while keeping the filename and position in the file.
void	setNodeType (NodeType type) noexcept
	Set the Node Type object.
void	setString (const std::string &value) noexcept
	Set the String object.
void	setPos (std::size_t line, std::size_t col) noexcept
	Set the Position of the node in the text.
void	setFilename (const std::string &filename) noexcept
	Set the original Filename where the node was.
Node &	attachNearestCommentBefore (const std::string &comment)
	Set the comment field with the nearest comment before this node.
Node &	attachCommentAfter (const std::string &comment)
	Set the comment_after field with the nearest comment after this node.
std::size_t	line () const noexcept
	Get the line at which this node was created.
std::size_t	col () const noexcept
	Get the column at which this node was created.
const std::string &	filename () const noexcept
	Return the filename in which this node was created.
const std::string &	comment () const noexcept
	Return the comment attached to this node, if any.
const std::string &	commentAfter () const noexcept
	Return the comment attached after this node, if any.
std::string	repr () const noexcept
	Compute a representation of the node without any comments or additional sugar, colors, types.
std::ostream &	debugPrint (std::ostream &os) const noexcept
	Print a node to an output stream with added type annotations.

Private Attributes
NodeType	m_type
Value	m_value
std::size_t	m_line = 0
std::size_t	m_col = 0
std::string	m_filename
std::string	m_comment
std::string	m_after_comment
	Comment after node.

Friends
bool	operator== (const Node &A, const Node &B)
bool	operator< (const Node &A, const Node &B)

Detailed Description

A node of an Abstract Syntax Tree for ArkScript.

Definition at line 30 of file Node.hpp.

Member Typedef Documentation

Value

using Ark::internal::Node::Value = std::variant<double, std::string, Keyword, std::vector<Node>, Namespace>

Definition at line 33 of file Node.hpp.

Constructor & Destructor Documentation

Node() [1/7]

Ark::internal::Node::Node ( )

default

Node() [2/7]

Ark::internal::Node::Node	(	NodeType	node_type,
		const std::string &	value )

Definition at line 10 of file Node.cpp.

Node() [3/7]

Ark::internal::Node::Node ( NodeType node_type )

explicit

Definition at line 14 of file Node.cpp.

References Ark::internal::Field, Ark::internal::List, m_type, m_value, and Ark::internal::Macro.

Node() [4/7]

Ark::internal::Node::Node ( double value )

explicit

Definition at line 21 of file Node.cpp.

Node() [5/7]

Ark::internal::Node::Node ( long value )

explicit

Definition at line 25 of file Node.cpp.

Node() [6/7]

Ark::internal::Node::Node ( Keyword value )

explicit

Definition at line 29 of file Node.cpp.

Node() [7/7]

Ark::internal::Node::Node ( Namespace namespace_ )

explicit

Definition at line 33 of file Node.cpp.

Member Function Documentation

arkNamespace()

Namespace & Ark::internal::Node::arkNamespace ( )

nodiscardnoexcept

Return the namespace held by the value (if the node type allows it)

Returns

Namespace&

Definition at line 52 of file Node.cpp.

References m_value.

Referenced by Ark::internal::Optimizer::countAndPruneDeadCode(), Ark::internal::ImportSolver::findAndReplaceImports(), Ark::internal::MacroProcessor::processNode(), and Ark::internal::NameResolutionPass::visit().

attachCommentAfter()

Node & Ark::internal::Node::attachCommentAfter

(

const std::string &

comment

)

Set the comment_after field with the nearest comment after this node.

Parameters

comment

Returns

Node& reference to this node after updating it

Definition at line 125 of file Node.cpp.

References comment(), and m_after_comment.

attachNearestCommentBefore()

Node & Ark::internal::Node::attachNearestCommentBefore

(

const std::string &

comment

)

Set the comment field with the nearest comment before this node.

Parameters

comment

Returns

Node& reference to this node after updating it

Definition at line 119 of file Node.cpp.

References comment(), and m_comment.

Referenced by Ark::internal::Parser::functionArgs(), Ark::internal::Parser::import_(), and Ark::internal::Parser::nil().

col()

std::size_t Ark::internal::Node::col ( ) const

nodiscardnoexcept

Get the column at which this node was created.

Returns

std::size_t

Definition at line 140 of file Node.cpp.

References m_col.

Referenced by JsonCompiler::_compile(), Ark::internal::NameResolutionPass::addSymbolNode(), Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Ark::Diagnostics::makeContextWithNode(), Ark::internal::Compiler::throwCompilerError(), Ark::internal::MacroProcessor::throwMacroProcessingError(), and Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName().

comment()

const std::string & Ark::internal::Node::comment ( ) const

nodiscardnoexcept

Return the comment attached to this node, if any.

Returns

const std::string&

Definition at line 150 of file Node.cpp.

References m_comment.

Referenced by attachCommentAfter(), attachNearestCommentBefore(), Formatter::format(), Formatter::formatFunction(), Formatter::formatImport(), and Formatter::shouldSplitOnNewline().

commentAfter()

const std::string & Ark::internal::Node::commentAfter ( ) const

nodiscardnoexcept

Return the comment attached after this node, if any.

Returns

const std::string&

Definition at line 155 of file Node.cpp.

References m_after_comment.

Referenced by Formatter::format().

constArkNamespace()

const Namespace & Ark::internal::Node::constArkNamespace ( ) const

nodiscardnoexcept

Return the namespace held by the value (if the node type allows it)

Returns

const Namespace&

Definition at line 57 of file Node.cpp.

References m_value.

Referenced by Ark::internal::Compiler::compileExpression(), and repr().

constList()

const std::vector< Node > & Ark::internal::Node::constList ( ) const

nodiscardnoexcept

Return the list of sub-nodes held by the node.

Returns

const std::vector<Node>&

Definition at line 72 of file Node.cpp.

References m_value.

Referenced by JsonCompiler::_compile(), Ark::internal::ConditionalExecutor::applyMacro(), Ark::internal::FunctionExecutor::applyMacro(), Ark::internal::FunctionExecutor::canHandle(), Ark::internal::MacroProcessor::checkMacroArgCountEq(), Ark::internal::MacroProcessor::checkMacroArgCountGe(), Ark::internal::Compiler::compileExpression(), Ark::internal::Compiler::compileFunction(), Ark::internal::Compiler::compileIf(), Ark::internal::Compiler::compileLetMutSet(), Ark::internal::Compiler::compileListInstruction(), Ark::internal::Compiler::compilePluginImport(), Ark::internal::Compiler::compileWhile(), Ark::internal::Optimizer::countAndPruneDeadCode(), Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Formatter::format(), Formatter::formatBegin(), Formatter::formatBlock(), Formatter::formatCall(), Formatter::formatCondition(), Formatter::formatDel(), Formatter::formatFunction(), Formatter::formatImport(), Formatter::formatLoop(), Formatter::formatMacro(), Formatter::formatVariable(), Ark::internal::Compiler::handleCalls(), Ark::internal::MacroProcessor::handleMacroNode(), Ark::internal::MacroProcessor::isBeginNode(), Ark::internal::MacroProcessor::isConstEval(), Formatter::isFuncCall(), Formatter::isListStartingWithKeyword(), Formatter::lineOfLastNodeIn(), Ark::internal::Compiler::nodeProducesOutput(), Formatter::processAst(), Ark::internal::MacroProcessor::processNode(), Ark::internal::MacroProcessor::registerFuncDef(), Ark::internal::MacroProcessor::removeBegin(), repr(), Formatter::shouldAddNewLineBetweenNodes(), Formatter::shouldSplitOnNewline(), JsonCompiler::toJsonList(), Ark::internal::NameResolutionPass::visit(), and Ark::internal::NameResolutionPass::visitKeyword().

debugPrint()

std::ostream & Ark::internal::Node::debugPrint ( std::ostream & os ) const

nodiscardnoexcept

Print a node to an output stream with added type annotations.

Parameters

os

Returns

Definition at line 233 of file Node.cpp.

References Ark::internal::Begin, Ark::internal::Capture, Ark::internal::Del, Ark::internal::Field, Ark::internal::Fun, Ark::internal::If, Ark::internal::Import, Ark::internal::Keyword, Ark::internal::Let, Ark::internal::List, Ark::internal::Macro, Ark::internal::Mut, Ark::internal::Namespace, Ark::internal::Number, Ark::internal::Set, Ark::internal::Spread, Ark::internal::String, Ark::internal::Symbol, Ark::internal::Unused, and Ark::internal::While.

Referenced by Ark::internal::MacroProcessor::process(), Ark::internal::NameResolutionPass::process(), and Ark::internal::Optimizer::process().

filename()

const std::string & Ark::internal::Node::filename ( ) const

nodiscardnoexcept

Return the filename in which this node was created.

Returns

const std::string&

Definition at line 145 of file Node.cpp.

References m_filename.

Referenced by JsonCompiler::_compile(), Ark::internal::NameResolutionPass::addSymbolNode(), Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Ark::Diagnostics::makeContextWithNode(), Ark::internal::Compiler::throwCompilerError(), Ark::internal::MacroProcessor::throwMacroProcessingError(), Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName(), Ark::internal::NameResolutionPass::visit(), and Ark::internal::NameResolutionPass::visitKeyword().

isListLike()

bool Ark::internal::Node::isListLike ( ) const

nodiscardnoexcept

Check if the node is a list like node.

Returns

true if the node is either a list or a macro

false

Definition at line 82 of file Node.cpp.

References Ark::internal::List, m_type, and Ark::internal::Macro.

Referenced by Ark::internal::Optimizer::countAndPruneDeadCode(), Formatter::formatFunction(), Formatter::isFuncCall(), Formatter::isListStartingWithKeyword(), Formatter::lineOfLastNodeIn(), Ark::internal::MacroProcessor::removeBegin(), Formatter::shouldSplitOnNewline(), and Ark::internal::FunctionExecutor::unify().

isStringLike()

bool Ark::internal::Node::isStringLike ( ) const

nodiscardnoexcept

Check if the node is a string like node.

Returns

true if the node is either a symbol, a string or a spread

false

Definition at line 87 of file Node.cpp.

References m_type, Ark::internal::Spread, Ark::internal::String, and Ark::internal::Symbol.

Referenced by Ark::Diagnostics::makeContextWithNode().

keyword()

Keyword Ark::internal::Node::keyword ( ) const

nodiscardnoexcept

Return the keyword held by the value (if the node type allows it)

Returns

Keyword

Definition at line 47 of file Node.cpp.

References m_value.

Referenced by JsonCompiler::_compile(), Formatter::format(), Formatter::formatBlock(), Ark::internal::MacroProcessor::removeBegin(), and repr().

line()

std::size_t Ark::internal::Node::line ( ) const

nodiscardnoexcept

Get the line at which this node was created.

Returns

std::size_t

Definition at line 135 of file Node.cpp.

References m_line.

Referenced by JsonCompiler::_compile(), Ark::internal::NameResolutionPass::addSymbolNode(), Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Formatter::lineOfLastNodeIn(), Ark::Diagnostics::makeContextWithNode(), Ark::internal::Compiler::throwCompilerError(), Ark::internal::MacroProcessor::throwMacroProcessingError(), and Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName().

list()

std::vector< Node > & Ark::internal::Node::list ( )

noexcept

Return the list of sub-nodes held by the node.

Returns

std::vector<Node>&

Definition at line 67 of file Node.cpp.

References m_value.

Referenced by Ark::internal::ConditionalExecutor::applyMacro(), Ark::internal::FunctionExecutor::applyMacro(), Ark::internal::ConditionalExecutor::canHandle(), Ark::internal::Optimizer::countAndPruneDeadCode(), Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Ark::internal::MacroProcessor::handleMacroNode(), Ark::internal::Parser::import_(), Ark::internal::Parser::process(), Ark::internal::MacroProcessor::processNode(), Ark::internal::Optimizer::pruneUnusedGlobalVariables(), Ark::internal::MacroProcessor::removeBegin(), Ark::internal::FunctionExecutor::unify(), Ark::internal::NameResolutionPass::visit(), and Ark::internal::NameResolutionPass::visitKeyword().

nodeType()

NodeType Ark::internal::Node::nodeType ( ) const

nodiscardnoexcept

Return the node type.

Returns

NodeType

Definition at line 77 of file Node.cpp.

References m_type.

Referenced by JsonCompiler::_compile(), Ark::internal::ConditionalExecutor::applyMacro(), Ark::internal::ConditionalExecutor::canHandle(), Ark::internal::FunctionExecutor::canHandle(), Ark::internal::SymbolExecutor::canHandle(), Ark::internal::Compiler::compileExpression(), Ark::internal::Optimizer::countAndPruneDeadCode(), Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Formatter::format(), Formatter::formatBlock(), Ark::internal::Parser::function(), Ark::internal::MacroProcessor::handleMacroNode(), Ark::internal::MacroProcessor::isBeginNode(), Ark::internal::MacroProcessor::isConstEval(), Ark::internal::MacroProcessor::isTruthy(), Ark::internal::Compiler::nodeProducesOutput(), Ark::internal::Optimizer::process(), Ark::internal::MacroProcessor::processNode(), Ark::internal::MacroProcessor::registerFuncDef(), Ark::internal::MacroProcessor::removeBegin(), Ark::internal::FunctionExecutor::unify(), and Ark::internal::NameResolutionPass::visit().

number()

double Ark::internal::Node::number ( ) const

nodiscardnoexcept

Return the number held by the value (if the node type allows it)

Returns

double

Definition at line 42 of file Node.cpp.

References m_value.

Referenced by JsonCompiler::_compile(), Ark::internal::MacroProcessor::evaluate(), Formatter::format(), Ark::internal::MacroProcessor::isTruthy(), and repr().

push_back()

void Ark::internal::Node::push_back ( const Node & node )

noexcept

Every node has a list as well as a value so we can push_back on all node no matter their type.

Parameters

node	a sub-node to push on the list held by the current node

Definition at line 62 of file Node.cpp.

Referenced by Ark::internal::MacroProcessor::evaluate(), Ark::internal::ImportSolver::findAndReplaceImports(), Ark::internal::Parser::import_(), and Ark::internal::Parser::process().

repr()

std::string Ark::internal::Node::repr ( ) const

nodiscardnoexcept

Compute a representation of the node without any comments or additional sugar, colors, types.

Returns

String representation of the node

Definition at line 160 of file Node.cpp.

References Ark::internal::Namespace::ast, Ark::internal::Capture, constArkNamespace(), constList(), Ark::internal::Field, Ark::internal::Keyword, keyword(), Ark::internal::keywords, Ark::internal::List, m_type, Ark::internal::Macro, Ark::internal::Namespace, Ark::internal::Number, number(), Ark::internal::Spread, Ark::internal::String, string(), Ark::internal::Symbol, and Ark::internal::Unused.

Referenced by Ark::internal::MacroProcessor::evaluate(), Ark::Diagnostics::makeContextWithNode(), Ark::internal::Compiler::throwCompilerError(), Ark::internal::MacroProcessor::throwMacroProcessingError(), and Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName().

setFilename()

void Ark::internal::Node::setFilename ( const std::string & filename )

noexcept

Set the original Filename where the node was.

Parameters

filename

Definition at line 114 of file Node.cpp.

Referenced by Ark::internal::MacroProcessor::evaluate().

setNodeType()

void Ark::internal::Node::setNodeType ( NodeType type )

noexcept

Set the Node Type object.

Parameters

type

Definition at line 98 of file Node.cpp.

Referenced by Ark::internal::ConditionalExecutor::applyMacro(), Ark::internal::MacroProcessor::evaluate(), and Ark::internal::FunctionExecutor::unify().

setPos()

void Ark::internal::Node::setPos ( std::size_t line, std::size_t col )

noexcept

Set the Position of the node in the text.

Parameters

line
col

Definition at line 108 of file Node.cpp.

Referenced by Ark::internal::MacroProcessor::evaluate(), and Ark::internal::Parser::setNodePosAndFilename().

setString()

void Ark::internal::Node::setString ( const std::string & value )

noexcept

Set the String object.

Parameters

value

Definition at line 103 of file Node.cpp.

Referenced by Ark::internal::MacroProcessor::evaluate(), and Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName().

string()

const std::string & Ark::internal::Node::string ( ) const

nodiscardnoexcept

Return the string held by the value (if the node type allows it)

Returns

const std::string&

Definition at line 37 of file Node.cpp.

References m_value.

Referenced by JsonCompiler::_compile(), Ark::internal::Compiler::addSymbol(), Ark::internal::NameResolutionPass::addSymbolNode(), Ark::internal::FunctionExecutor::applyMacro(), Ark::internal::SymbolExecutor::applyMacro(), Ark::internal::Compiler::compileListInstruction(), Ark::internal::Compiler::compileSymbol(), Ark::internal::Optimizer::countAndPruneDeadCode(), Ark::internal::MacroProcessor::evaluate(), Formatter::format(), Ark::internal::Parser::function(), Ark::internal::MacroProcessor::handleMacroNode(), Ark::internal::MacroProcessor::isConstEval(), Ark::internal::MacroProcessor::isTruthy(), Ark::Diagnostics::makeContextWithNode(), Ark::internal::MacroProcessor::registerFuncDef(), repr(), Ark::internal::FunctionExecutor::unify(), Ark::internal::NameResolutionPass::updateSymbolWithFullyQualifiedName(), and Ark::internal::NameResolutionPass::visit().

updateValueAndType()

void Ark::internal::Node::updateValueAndType ( const Node & source )

noexcept

Copy a node to the current one, while keeping the filename and position in the file.

Parameters

source

node to copy type and value from

Definition at line 92 of file Node.cpp.

Referenced by Ark::internal::ConditionalExecutor::applyMacro(), Ark::internal::FunctionExecutor::applyMacro(), Ark::internal::SymbolExecutor::applyMacro(), and Ark::internal::MacroProcessor::evaluate().

Friends And Related Symbol Documentation

operator<

bool operator< ( const Node & A, const Node & B )

friend

Definition at line 342 of file Node.cpp.

operator==

bool operator== ( const Node & A, const Node & B )

friend

Definition at line 332 of file Node.cpp.

Member Data Documentation

m_after_comment

std::string Ark::internal::Node::m_after_comment

private

Comment after node.

Definition at line 228 of file Node.hpp.

Referenced by attachCommentAfter(), and commentAfter().

m_col

std::size_t Ark::internal::Node::m_col = 0

private

Definition at line 225 of file Node.hpp.

Referenced by col().

m_comment

std::string Ark::internal::Node::m_comment

private

Definition at line 227 of file Node.hpp.

Referenced by attachNearestCommentBefore(), and comment().

m_filename

std::string Ark::internal::Node::m_filename

private

Definition at line 226 of file Node.hpp.

Referenced by filename().

m_line

std::size_t Ark::internal::Node::m_line = 0

private

Definition at line 225 of file Node.hpp.

Referenced by line().

m_type

NodeType Ark::internal::Node::m_type

private

Definition at line 222 of file Node.hpp.

Referenced by isListLike(), isStringLike(), Node(), nodeType(), and repr().

m_value

Value Ark::internal::Node::m_value

private

Definition at line 223 of file Node.hpp.

Referenced by arkNamespace(), constArkNamespace(), constList(), keyword(), list(), Node(), number(), and string().

---

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

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