ArkScript
A small, lisp-inspired, functional scripting language
Classes | Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Ark::internal::ASTLowerer Class Referencefinal

The ArkScript AST to IR compiler. More...

#include <ASTLowerer.hpp>

Collaboration diagram for Ark::internal::ASTLowerer:
[legend]

Classes

struct  Page
 

Public Member Functions

 ASTLowerer (unsigned debug)
 Construct a new ASTLowerer object.
 
void process (Node &ast)
 Start the compilation.
 
const std::vector< IR::Block > & intermediateRepresentation () const noexcept
 Return the IR blocks (one per scope)
 
const std::vector< std::string > & symbols () const noexcept
 Return the symbol table pre-computed.
 
const std::vector< ValTableElem > & values () const noexcept
 Return the value table pre-computed.
 

Private Member Functions

IR::Block & page (const Page page) noexcept
 helper functions to get a temp or finalized code page
 
void compileExpression (Node &x, Page p, bool is_result_unused, bool is_terminal)
 Compile an expression (a node) recursively.
 
void compileSymbol (Node &x, Page p, bool is_result_unused)
 
void compileListInstruction (Node &x, Page p, bool is_result_unused)
 
void compileIf (Node &x, Page p, bool is_result_unused, bool is_terminal)
 
void compileFunction (Node &x, Page p, bool is_result_unused)
 
void compileLetMutSet (Keyword n, Node &x, Page p)
 
void compileWhile (Node &x, Page p)
 
void compilePluginImport (Node &x, Page p)
 
void pushFunctionCallArguments (Node &call, Page p, bool is_tail_call)
 
void handleCalls (Node &x, Page p, bool is_result_unused, bool is_terminal)
 
uint16_t addSymbol (const Node &sym)
 Register a given node in the symbol table.
 
uint16_t addValue (const Node &x)
 Register a given node in the value table.
 
uint16_t addValue (std::size_t page_id, const Node &current)
 Register a page id (function reference) in the value table.
 

Static Private Member Functions

static std::optional< Instruction > getOperator (const std::string &name) noexcept
 Checking if a symbol is an operator.
 
static std::optional< uint16_t > getBuiltin (const std::string &name) noexcept
 Checking if a symbol is a builtin.
 
static std::optional< Instruction > getListInstruction (const std::string &name) noexcept
 Checking if a symbol is a list instruction.
 
static bool nodeProducesOutput (const Node &node)
 
static bool isUnaryInst (Instruction inst) noexcept
 Check if a given instruction is unary (takes only one argument)
 
static bool isTernaryInst (Instruction inst) noexcept
 Check if a given instruction is ternary (takes three arguments)
 
static void warning (const std::string &message, const Node &node)
 Display a warning message.
 
static void buildAndThrowError (const std::string &message, const Node &node)
 Throw a nice error message.
 

Private Attributes

LocalsLocator m_locals_locator
 
std::vector< std::string > m_symbols
 
std::vector< ValTableElem > m_values
 
std::vector< IR::Block > m_code_pages
 
std::vector< IR::Block > m_temp_pages
 we need temporary code pages for some compilations passes
 
IR::label_t m_current_label = 0
 
std::stack< std::string > m_opened_vars
 stack of vars we are currently declaring
 
Logger m_logger
 

Detailed Description

The ArkScript AST to IR compiler.

Definition at line 37 of file ASTLowerer.hpp.

Constructor & Destructor Documentation

◆ ASTLowerer()

Ark::internal::ASTLowerer::ASTLowerer ( unsigned debug)
explicit

Construct a new ASTLowerer object.

Parameters
debugthe debug level

Definition at line 18 of file ASTLowerer.cpp.

Member Function Documentation

◆ addSymbol()

uint16_t Ark::internal::ASTLowerer::addSymbol ( const Node & sym)
private

Register a given node in the symbol table.

Can throw if the table is full

Parameters
sym
Returns
uint16_t

Definition at line 712 of file ASTLowerer.cpp.

References buildAndThrowError(), m_symbols, and Ark::internal::Node::string().

Referenced by compileExpression(), compileFunction(), compileLetMutSet(), compileSymbol(), and handleCalls().

◆ addValue() [1/2]

uint16_t Ark::internal::ASTLowerer::addValue ( const Node & x)
private

Register a given node in the value table.

Can throw if the table is full

Parameters
x
Returns
uint16_t

Definition at line 728 of file ASTLowerer.cpp.

References buildAndThrowError(), and m_values.

Referenced by compileExpression(), compileFunction(), and compilePluginImport().

◆ addValue() [2/2]

uint16_t Ark::internal::ASTLowerer::addValue ( std::size_t page_id,
const Node & current )
private

Register a page id (function reference) in the value table.

Can throw if the table is full

Parameters
page_id
currentA reference to the current node, for context
Returns
std::size_t

Definition at line 744 of file ASTLowerer.cpp.

References buildAndThrowError(), and m_values.

◆ buildAndThrowError()

void Ark::internal::ASTLowerer::buildAndThrowError ( const std::string & message,
const Node & node )
staticprivate

Throw a nice error message.

Parameters
message
node

Definition at line 133 of file ASTLowerer.cpp.

References Ark::internal::Node::col(), Ark::internal::Node::filename(), Ark::internal::Node::line(), and Ark::internal::Node::repr().

Referenced by addSymbol(), addValue(), addValue(), compileExpression(), compileFunction(), compileLetMutSet(), compileListInstruction(), compileSymbol(), compileWhile(), handleCalls(), and pushFunctionCallArguments().

◆ compileExpression()

void Ark::internal::ASTLowerer::compileExpression ( Node & x,
Page p,
bool is_result_unused,
bool is_terminal )
private

Compile an expression (a node) recursively.

Parameters
xthe Node to compile
pthe current page number we're on
is_result_unused
is_terminal

Definition at line 138 of file ASTLowerer.cpp.

References addSymbol(), addValue(), Ark::internal::Namespace::ast, Ark::internal::Begin, buildAndThrowError(), Ark::internal::BUILTIN, compileExpression(), compileFunction(), compileIf(), compileLetMutSet(), compileListInstruction(), compilePluginImport(), compileSymbol(), compileWhile(), Ark::internal::Node::constArkNamespace(), Ark::internal::Node::constList(), Ark::internal::DEL, Ark::internal::Del, Ark::internal::Field, Ark::internal::Node::filename(), Ark::internal::Fun, Ark::internal::GET_FIELD, getBuiltin(), getListInstruction(), handleCalls(), Ark::internal::If, Ark::internal::Import, Ark::internal::Keyword, Ark::internal::Let, Ark::internal::Node::line(), Ark::internal::List, Ark::internal::Node::list(), Ark::internal::LOAD_CONST, Ark::internal::Mut, Ark::internal::Namespace, Ark::internal::Node::nodeType(), Ark::internal::Number, page(), Ark::internal::Set, Ark::internal::String, Ark::Value::string(), Ark::internal::Symbol, Ark::internal::typeToString(), Ark::internal::Unused, and Ark::internal::While.

Referenced by compileExpression(), compileFunction(), compileIf(), compileLetMutSet(), compileListInstruction(), compileWhile(), handleCalls(), process(), and pushFunctionCallArguments().

◆ compileFunction()

void Ark::internal::ASTLowerer::compileFunction ( Node & x,
Page p,
bool is_result_unused )
private

Definition at line 362 of file ASTLowerer.cpp.

References Ark::internal::LocalsLocator::addLocal(), addSymbol(), addValue(), buildAndThrowError(), Ark::internal::CAPTURE, Ark::internal::Capture, Ark::internal::LocalsLocator::Closure, compileExpression(), Ark::internal::Node::constList(), Ark::internal::LocalsLocator::createScope(), Ark::internal::LocalsLocator::deleteScope(), Ark::internal::LocalsLocator::Function, Ark::internal::Node::isAnonymousFunction(), Ark::internal::List, Ark::internal::Node::list(), Ark::internal::LOAD_CONST, m_code_pages, m_locals_locator, m_opened_vars, Ark::internal::MAKE_CLOSURE, page(), Ark::internal::POP, Ark::internal::RET, Ark::internal::STORE, Ark::internal::Symbol, Ark::internal::typeToString(), and warning().

Referenced by compileExpression().

◆ compileIf()

void Ark::internal::ASTLowerer::compileIf ( Node & x,
Page p,
bool is_result_unused,
bool is_terminal )
private

Definition at line 328 of file ASTLowerer.cpp.

References compileExpression(), Ark::internal::Node::constList(), Ark::internal::LocalsLocator::dropVarsForBranch(), Ark::internal::IR::Entity::Goto(), Ark::internal::IR::Entity::GotoIf(), Ark::internal::IR::Entity::Label(), Ark::internal::Node::list(), m_current_label, m_locals_locator, page(), and Ark::internal::LocalsLocator::saveScopeLengthForBranch().

Referenced by compileExpression().

◆ compileLetMutSet()

void Ark::internal::ASTLowerer::compileLetMutSet ( Keyword n,
Node & x,
Page p )
private

Definition at line 425 of file ASTLowerer.cpp.

References Ark::internal::LocalsLocator::addLocal(), addSymbol(), buildAndThrowError(), compileExpression(), Ark::internal::Node::constList(), Ark::internal::Node::filename(), Ark::internal::Let, Ark::internal::Node::line(), Ark::internal::Node::list(), m_locals_locator, m_opened_vars, Ark::internal::Mut, page(), Ark::internal::SET_VAL, Ark::internal::STORE, Ark::internal::Symbol, and Ark::internal::typeToString().

Referenced by compileExpression().

◆ compileListInstruction()

void Ark::internal::ASTLowerer::compileListInstruction ( Node & x,
Page p,
bool is_result_unused )
private

Definition at line 267 of file ASTLowerer.cpp.

References Ark::internal::APPEND, Ark::internal::APPEND_IN_PLACE, buildAndThrowError(), compileExpression(), Ark::internal::CONCAT, Ark::internal::CONCAT_IN_PLACE, Ark::internal::Node::constList(), getListInstruction(), Ark::internal::LIST, Ark::internal::Node::list(), nodeProducesOutput(), page(), Ark::internal::POP, Ark::internal::POP_LIST, Ark::internal::POP_LIST_IN_PLACE, Ark::internal::SET_AT_2_INDEX, Ark::internal::SET_AT_INDEX, and warning().

Referenced by compileExpression().

◆ compilePluginImport()

void Ark::internal::ASTLowerer::compilePluginImport ( Node & x,
Page p )
private

Definition at line 493 of file ASTLowerer.cpp.

References addValue(), Ark::internal::Node::constList(), Ark::internal::Node::filename(), Ark::internal::Node::line(), page(), Ark::internal::PLUGIN, and Ark::internal::String.

Referenced by compileExpression().

◆ compileSymbol()

void Ark::internal::ASTLowerer::compileSymbol ( Node & x,
Page p,
bool is_result_unused )
private

Definition at line 243 of file ASTLowerer.cpp.

References addSymbol(), buildAndThrowError(), Ark::internal::BUILTIN, getBuiltin(), getOperator(), Ark::internal::LOAD_SYMBOL, Ark::internal::LOAD_SYMBOL_BY_INDEX, Ark::internal::LocalsLocator::lookupLastScopeByName(), m_locals_locator, page(), Ark::internal::POP, Ark::internal::Node::string(), and warning().

Referenced by compileExpression().

◆ compileWhile()

void Ark::internal::ASTLowerer::compileWhile ( Node & x,
Page p )
private

Definition at line 460 of file ASTLowerer.cpp.

References buildAndThrowError(), compileExpression(), Ark::internal::Node::constList(), Ark::internal::CREATE_SCOPE, Ark::internal::LocalsLocator::createScope(), Ark::internal::LocalsLocator::deleteScope(), Ark::internal::Node::filename(), Ark::internal::IR::Entity::Goto(), Ark::internal::IR::Entity::GotoIf(), Ark::internal::IR::Entity::Label(), Ark::internal::Node::line(), Ark::internal::Node::list(), m_current_label, m_locals_locator, page(), Ark::internal::POP_SCOPE, and Ark::internal::RESET_SCOPE_JUMP.

Referenced by compileExpression().

◆ getBuiltin()

std::optional< uint16_t > Ark::internal::ASTLowerer::getBuiltin ( const std::string & name)
staticprivatenoexcept

Checking if a symbol is a builtin.

Parameters
namesymbol name
Returns
std::optional<uint16_t> builtin number

Definition at line 59 of file ASTLowerer.cpp.

References Ark::internal::Builtins::builtins.

Referenced by compileExpression(), and compileSymbol().

◆ getListInstruction()

std::optional< Instruction > Ark::internal::ASTLowerer::getListInstruction ( const std::string & name)
staticprivatenoexcept

Checking if a symbol is a list instruction.

Parameters
name
Returns
std::optional<Instruction> list instruction

Definition at line 70 of file ASTLowerer.cpp.

References Ark::internal::LIST, and Ark::internal::Language::listInstructions.

Referenced by compileExpression(), and compileListInstruction().

◆ getOperator()

std::optional< Instruction > Ark::internal::ASTLowerer::getOperator ( const std::string & name)
staticprivatenoexcept

Checking if a symbol is an operator.

Parameters
namesymbol name
Returns
std::optional<Instruction> operator instruction

Definition at line 51 of file ASTLowerer.cpp.

References Ark::internal::FIRST_OPERATOR, and Ark::internal::Language::operators.

Referenced by compileSymbol(), and handleCalls().

◆ handleCalls()

void Ark::internal::ASTLowerer::handleCalls ( Node & x,
Page p,
bool is_result_unused,
bool is_terminal )
private

Definition at line 539 of file ASTLowerer.cpp.

References Ark::internal::ADD, addSymbol(), Ark::internal::Language::And, Ark::internal::ASSERT, Ark::internal::AT_AT, buildAndThrowError(), Ark::internal::CALL, Ark::internal::Capture, compileExpression(), Ark::internal::Node::constList(), Ark::internal::DIV, Ark::internal::Node::filename(), Ark::internal::FIRST_OPERATOR, Ark::internal::GET_CURRENT_PAGE_ADDR, getOperator(), Ark::internal::IR::Entity::Goto(), isTernaryInst(), isUnaryInst(), Ark::internal::JUMP, Ark::internal::IR::Entity::Label(), Ark::internal::Node::line(), Ark::internal::Node::list(), m_current_label, m_opened_vars, m_temp_pages, Ark::internal::MOD, Ark::internal::MUL, nodeProducesOutput(), Ark::internal::Node::nodeType(), Ark::internal::Language::operators, Ark::internal::Language::Or, page(), Ark::internal::POP, Ark::internal::PUSH_RETURN_ADDRESS, pushFunctionCallArguments(), Ark::internal::Node::repr(), Ark::internal::SHORTCIRCUIT_AND, Ark::internal::SHORTCIRCUIT_OR, Ark::internal::Node::string(), Ark::internal::SUB, and Ark::internal::Symbol.

Referenced by compileExpression().

◆ intermediateRepresentation()

const std::vector< IR::Block > & Ark::internal::ASTLowerer::intermediateRepresentation ( ) const
nodiscardnoexcept

Return the IR blocks (one per scope)

Returns
const std::vector<Block>&

Definition at line 36 of file ASTLowerer.cpp.

References m_code_pages.

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

◆ isTernaryInst()

bool Ark::internal::ASTLowerer::isTernaryInst ( Instruction inst)
staticprivatenoexcept

Check if a given instruction is ternary (takes three arguments)

Parameters
inst
Returns
true the instruction is ternary
false

Definition at line 116 of file ASTLowerer.cpp.

References Ark::internal::AT_AT.

Referenced by handleCalls().

◆ isUnaryInst()

bool Ark::internal::ASTLowerer::isUnaryInst ( Instruction inst)
staticprivatenoexcept

Check if a given instruction is unary (takes only one argument)

Parameters
inst
Returns
true the instruction is unary
false

Definition at line 96 of file ASTLowerer.cpp.

References Ark::internal::EMPTY, Ark::internal::HEAD, Ark::internal::ISNIL, Ark::internal::LEN, Ark::internal::NOT, Ark::internal::TAIL, Ark::internal::TO_NUM, Ark::internal::TO_STR, and Ark::internal::TYPE.

Referenced by handleCalls().

◆ nodeProducesOutput()

bool Ark::internal::ASTLowerer::nodeProducesOutput ( const Node & node)
staticprivate

Checks if a node is a list and has a keyboard as its first node, indicating if it's producing a value on the stack or not

Parameters
nodenode to check
Returns
true if the node produces an output on the stack (fun, if, begin)
false otherwise (let, mut, set, while, import, del)

Definition at line 78 of file ASTLowerer.cpp.

References Ark::internal::Begin, Ark::internal::Node::constList(), Ark::internal::Fun, Ark::internal::If, Ark::internal::Keyword, Ark::internal::List, nodeProducesOutput(), Ark::internal::Node::nodeType(), Ark::internal::Symbol, and Ark::internal::Language::UpdateRef.

Referenced by compileListInstruction(), handleCalls(), nodeProducesOutput(), and pushFunctionCallArguments().

◆ page()

IR::Block & Ark::internal::ASTLowerer::page ( const Page page)
inlineprivatenoexcept

helper functions to get a temp or finalized code page

Parameters
pagepage descriptor
Returns
std::vector<IR::Block>&

Definition at line 100 of file ASTLowerer.hpp.

Referenced by compileExpression(), compileFunction(), compileIf(), compileLetMutSet(), compileListInstruction(), compilePluginImport(), compileSymbol(), compileWhile(), and handleCalls().

◆ process()

void Ark::internal::ASTLowerer::process ( Node & ast)

Start the compilation.

Parameters
ast

Definition at line 22 of file ASTLowerer.cpp.

References compileExpression(), m_code_pages, m_logger, Ark::internal::Logger::traceEnd(), and Ark::internal::Logger::traceStart().

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

◆ pushFunctionCallArguments()

void Ark::internal::ASTLowerer::pushFunctionCallArguments ( Node & call,
Page p,
bool is_tail_call )
private

Definition at line 512 of file ASTLowerer.cpp.

References buildAndThrowError(), compileExpression(), Ark::internal::Node::constList(), Ark::internal::Node::list(), and nodeProducesOutput().

Referenced by handleCalls().

◆ symbols()

const std::vector< std::string > & Ark::internal::ASTLowerer::symbols ( ) const
nodiscardnoexcept

Return the symbol table pre-computed.

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

Definition at line 41 of file ASTLowerer.cpp.

References m_symbols.

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

◆ values()

const std::vector< ValTableElem > & Ark::internal::ASTLowerer::values ( ) const
nodiscardnoexcept

Return the value table pre-computed.

Returns
const std::vector<ValTableElem>&

Definition at line 46 of file ASTLowerer.cpp.

References m_values.

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

◆ warning()

void Ark::internal::ASTLowerer::warning ( const std::string & message,
const Node & node )
staticprivate

Display a warning message.

Parameters
message
node

Definition at line 128 of file ASTLowerer.cpp.

References Ark::Diagnostics::makeContextWithNode().

Referenced by compileFunction(), compileListInstruction(), and compileSymbol().

Member Data Documentation

◆ m_code_pages

std::vector<IR::Block> Ark::internal::ASTLowerer::m_code_pages
private

Definition at line 87 of file ASTLowerer.hpp.

Referenced by compileFunction(), intermediateRepresentation(), and process().

◆ m_current_label

IR::label_t Ark::internal::ASTLowerer::m_current_label = 0
private

Definition at line 89 of file ASTLowerer.hpp.

Referenced by compileIf(), compileWhile(), and handleCalls().

◆ m_locals_locator

LocalsLocator Ark::internal::ASTLowerer::m_locals_locator
private

Definition at line 82 of file ASTLowerer.hpp.

Referenced by compileFunction(), compileIf(), compileLetMutSet(), compileSymbol(), and compileWhile().

◆ m_logger

Logger Ark::internal::ASTLowerer::m_logger
private

Definition at line 92 of file ASTLowerer.hpp.

Referenced by process().

◆ m_opened_vars

std::stack<std::string> Ark::internal::ASTLowerer::m_opened_vars
private

stack of vars we are currently declaring

Definition at line 90 of file ASTLowerer.hpp.

Referenced by compileFunction(), compileLetMutSet(), and handleCalls().

◆ m_symbols

std::vector<std::string> Ark::internal::ASTLowerer::m_symbols
private

Definition at line 85 of file ASTLowerer.hpp.

Referenced by addSymbol(), and symbols().

◆ m_temp_pages

std::vector<IR::Block> Ark::internal::ASTLowerer::m_temp_pages
private

we need temporary code pages for some compilations passes

Definition at line 88 of file ASTLowerer.hpp.

Referenced by handleCalls().

◆ m_values

std::vector<ValTableElem> Ark::internal::ASTLowerer::m_values
private

Definition at line 86 of file ASTLowerer.hpp.

Referenced by addValue(), addValue(), and values().

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