Entity.hpp

Go to the documentation of this file.

/**
 * @file Entity.hpp
 * @author Lex Plateau (lexplt.dev@gmail.com)
 * @brief An entity in the IR is a bundle of information
 * @date 2024-10-05
 *
 * @copyright Copyright (c) 2024-2025
 *
 */
 
#ifndef ARK_COMPILER_INTERMEDIATEREPRESENTATION_ENTITY_HPP
#define ARK_COMPILER_INTERMEDIATEREPRESENTATION_ENTITY_HPP
 
#include <cinttypes>
#include <vector>
#include <string>
 
#include <Ark/Compiler/IntermediateRepresentation/Word.hpp>
#include <Ark/Compiler/Instructions.hpp>
 
namespace Ark::internal::IR
{
    enum class Kind
    {
        Label,
        Goto,
        GotoWithArg,
        Opcode,
        Opcode2Args,
        Opcode3Args
    };
 
    using label_t = std::size_t;
 
    /// The maximum value an argument can have when an IR entity has two arguments
    constexpr uint16_t MaxValueForDualArg = 0x0fff;
    constexpr uint16_t MaxValueForSmallNumber = 0x0800;
    static_assert(MaxValueForSmallNumber + MaxValueForSmallNumber - 1 == MaxValueForDualArg);
 
    class Entity
    {
    public:
        explicit Entity(Kind kind);
 
        explicit Entity(Instruction inst, uint16_t arg = 0);
 
        Entity(Instruction inst, uint16_t primary_arg, uint16_t secondary_arg);
 
        Entity(Instruction inst, uint8_t inst2, uint8_t inst3, uint8_t inst4);
 
        static Entity Label(label_t value);
 
        static Entity Goto(const Entity& label, Instruction inst = Instruction::JUMP);
 
        static Entity GotoWithArg(const Entity& label, Instruction inst, uint16_t primary_arg);
 
        static Entity GotoIf(const Entity& label, bool cond);
 
        [[nodiscard]] Word bytecode() const;
 
        [[nodiscard]] inline label_t label() const { return m_label; }
 
        [[nodiscard]] inline Kind kind() const { return m_kind; }
 
        [[nodiscard]] inline Instruction inst() const { return m_inst; }
 
        [[nodiscard]] inline uint16_t primaryArg() const { return m_primary_arg; }
 
        [[nodiscard]] inline uint16_t secondaryArg() const { return m_secondary_arg; }
 
        [[nodiscard]] inline uint16_t tertiaryArg() const { return m_tertiary_arg; }
 
        void setSourceLocation(const std::string& filename, std::size_t line);
 
        [[nodiscard]] inline bool hasValidSourceLocation() const { return !m_source_file.empty(); }
 
        [[nodiscard]] inline const std::string& filename() const { return m_source_file; }
 
        [[nodiscard]] inline std::size_t sourceLine() const { return m_source_line; }
 
    private:
        Kind m_kind;
        label_t m_label { 0 };
        Instruction m_inst { NOP };
        uint16_t m_primary_arg { 0 };
        uint16_t m_secondary_arg { 0 };
        uint16_t m_tertiary_arg { 0 };
        std::string m_source_file;
        std::size_t m_source_line { 0 };
    };
 
    using Block = std::vector<Entity>;
}
 
#endif  // ARK_COMPILER_INTERMEDIATEREPRESENTATION_ENTITY_HPP