Compiler.hpp

Go to the documentation of this file.

/**
 * @file Compiler.hpp
 * @author Alexandre Plateau ([email protected])
 * @brief ArkScript compiler is in charge of transforming the AST into bytecode
 * @version 3.1
 * @date 2020-10-27
 *
 * @copyright Copyright (c) 2020-2024
 *
 */
 
#ifndef ARK_COMPILER_COMPILER_HPP
#define ARK_COMPILER_COMPILER_HPP
 
#include <vector>
#include <string>
#include <cinttypes>
#include <optional>
 
#include <Ark/Platform.hpp>
#include <Ark/Logger.hpp>
#include <Ark/Compiler/Instructions.hpp>
#include <Ark/Compiler/IntermediateRepresentation/Entity.hpp>
#include <Ark/Compiler/AST/Node.hpp>
#include <Ark/Compiler/ValTableElem.hpp>
 
namespace Ark::internal
{
    class State;
    class Welder;
 
    /**
     * @brief The ArkScript bytecode compiler
     *
     */
    class ARK_API Compiler final
    {
    public:
        /**
         * @brief Construct a new Compiler object
         *
         * @param debug the debug level
         */
        explicit Compiler(unsigned debug);
 
        /**
         * @brief Start the compilation
         *
         * @param ast
         */
        void process(const Node& ast);
 
        /**
         * @brief Return the IR blocks (one per scope)
         *
         * @return const std::vector<Block>&
         */
        [[nodiscard]] const std::vector<IR::Block>& intermediateRepresentation() const noexcept;
 
        /**
         * @brief Return the symbol table pre-computed
         *
         * @return const std::vector<std::string>&
         */
        [[nodiscard]] const std::vector<std::string>& symbols() const noexcept;
 
        /**
         * @brief Return the value table pre-computed
         *
         * @return const std::vector<ValTableElem>&
         */
        [[nodiscard]] const std::vector<ValTableElem>& values() const noexcept;
 
    private:
        struct Page
        {
            std::size_t index;
            bool is_temp;
        };
 
        // tables: symbols, values, plugins and codes
        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;
 
        unsigned m_debug;  ///< the debug level of the compiler
        Logger m_logger;
 
        /**
         * @brief helper functions to get a temp or finalized code page
         *
         * @param page page descriptor
         * @return std::vector<IR::Block>&
         */
        IR::Block& page(const Page page) noexcept
        {
            if (!page.is_temp)
                return m_code_pages[page.index];
            return m_temp_pages[page.index];
        }
 
        /**
         * @brief Checking if a symbol is an operator
         *
         * @param name symbol name
         * @return std::optional<Instruction> operator instruction
         */
        static std::optional<Instruction> getOperator(const std::string& name) noexcept;
 
        /**
         * @brief Checking if a symbol is a builtin
         *
         * @param name symbol name
         * @return std::optional<uint16_t> builtin number
         */
        static std::optional<uint16_t> getBuiltin(const std::string& name) noexcept;
 
        /**
         * @brief Checking if a symbol is a list instruction
         *
         * @param name
         * @return std::optional<Instruction> list instruction
         */
        static std::optional<Instruction> getListInstruction(const std::string& name) noexcept;
 
        /**
         * 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
         * @param node node to check
         * @return true if the node produces an output on the stack (fun, if, begin)
         * @return false otherwise (let, mut, set, while, import, del)
         */
        static bool nodeProducesOutput(const Node& node);
 
        /**
         * @brief Check if a given instruction is unary (takes only one argument)
         *
         * @param inst
         * @return true the instruction is unary
         * @return false
         */
        static bool isUnaryInst(Instruction inst) noexcept;
 
        /**
         * @brief Check if a given instruction is ternary (takes three arguments)
         *
         * @param inst
         * @return true the instruction is ternary
         * @return false
         */
        static bool isTernaryInst(Instruction inst) noexcept;
 
        /**
         * @brief Display a warning message
         *
         * @param message
         * @param node
         */
        static void compilerWarning(const std::string& message, const Node& node);
 
        /**
         * @brief Throw a nice error message
         *
         * @param message
         * @param node
         */
        [[noreturn]] static void throwCompilerError(const std::string& message, const Node& node);
 
        /**
         * @brief Compile an expression (a node) recursively
         *
         * @param x the Node to compile
         * @param p the current page number we're on
         * @param is_result_unused
         * @param is_terminal
         * @param var_name
         */
        void compileExpression(const Node& x, Page p, bool is_result_unused, bool is_terminal, const std::string& var_name = "");
 
        void compileSymbol(const Node& x, Page p, bool is_result_unused);
        void compileListInstruction(const Node& c0, const Node& x, Page p, bool is_result_unused);
        void compileIf(const Node& x, Page p, bool is_result_unused, bool is_terminal, const std::string& var_name);
        void compileFunction(const Node& x, Page p, bool is_result_unused, const std::string& var_name);
        void compileLetMutSet(Keyword n, const Node& x, Page p);
        void compileWhile(const Node& x, Page p);
        void compilePluginImport(const Node& x, Page p);
        void handleCalls(const Node& x, Page p, bool is_result_unused, bool is_terminal, const std::string& var_name);
 
        /**
         * @brief Register a given node in the symbol table
         * @details Can throw if the table is full
         *
         * @param sym
         * @return uint16_t
         */
        uint16_t addSymbol(const Node& sym);
 
        /**
         * @brief Register a given node in the value table
         * @details Can throw if the table is full
         *
         * @param x
         * @return uint16_t
         */
        uint16_t addValue(const Node& x);
 
        /**
         * @brief Register a page id (function reference) in the value table
         * @details Can throw if the table is full
         *
         * @param page_id
         * @param current A reference to the current node, for context
         * @return std::size_t
         */
        uint16_t addValue(std::size_t page_id, const Node& current);
    };
}
 
#endif