IR.h

Go to the documentation of this file.

//
// Created by XIaokang00010 on 2024/9/6.
//
 
#ifndef HOSHI_LANG_IR_H
#define HOSHI_LANG_IR_H
 
#include "share/def.hpp"
#include <any>
#include <compiler/compilerContext.h>
#include <compiler/frontend/ast.hpp>
#include <map>
#include <memory>
#include <set>
 
namespace yoi {
    class structDefInnerPair;
    class implInnerPair;
 
    struct IRBuildConfig {
        enum class BuildType : yoi::indexT { library = 0, executable } buildType;
        enum class BuildMode : yoi::indexT { debug = 0, release } buildMode;
        enum class UseObjectLinker : yoi::indexT { cc = 0, cl, none } useObjectLinker;
        yoi::wstr buildPlatform;
        yoi::wstr buildArch;
        bool preserveIntermediateFiles;
        yoi::vec<yoi::wstr> searchPaths;
        yoi::vec<yoi::wstr> additionalLinkingFiles;
        std::map<yoi::wstr, yoi::wstr> marcos;
        yoi::wstr buildCachePath;
        bool immediatelyClearupCache;
 
        struct Builder {
            BuildType buildType{BuildType::executable};
            BuildMode buildMode{BuildMode::debug};
            UseObjectLinker useObjectLinker{UseObjectLinker::cc};
            yoi::wstr buildPlatform;
            yoi::wstr buildArch;
            bool preserveIntermediateFiles{false};
            yoi::vec<yoi::wstr> searchPaths{L""};
            yoi::vec<yoi::wstr> additionalLinkingFiles;
            std::map<yoi::wstr, yoi::wstr> marcos;
            yoi::wstr buildCachePath{
              (std::filesystem::temp_directory_path() / 
                (L"zyy-" + std::to_wstring(std::chrono::system_clock::now().time_since_epoch().count()))).wstring()};
            bool immediatelyClearupCache{true};
 
            Builder() = default;
 
            Builder &setBuildType(BuildType buildType);
 
            Builder &setBuildMode(BuildMode buildMode);
 
            Builder &setUseObjectLinker(UseObjectLinker useObjectLinker);
 
            Builder &setBuildPlatform(const yoi::wstr &buildPlatform);
 
            Builder &setBuildArch(const yoi::wstr &buildArch);
 
            Builder &setPreserveIntermediateFiles(bool preserveIntermediateFiles);
 
            Builder &addSearchPath(const yoi::wstr &searchPath);
 
            Builder &setSearchPaths(const yoi::vec<yoi::wstr> &searchPaths);
 
            Builder &setMarco(const yoi::wstr &name, const yoi::wstr &value);
 
            Builder &setAdditionalLinkingFiles(const yoi::vec<yoi::wstr> &additionalLinkingFiles);
 
            Builder &setBuildCachePath(const yoi::wstr &buildCachePath);
 
            Builder &setImmediatelyClearupCache(bool immediatelyClearupCache);
 
            std::shared_ptr<IRBuildConfig> yield();
        };
    };
 
    struct IRDebugInfo {
        yoi::wstr sourceFile;
        yoi::indexT line;
        yoi::indexT column;
    };
 
    struct IRMetadata {
        std::map<yoi::wstr, std::any> metadata;
 
        template <typename T> T &getMetadata(const yoi::wstr &key) {
            return *std::any_cast<T>(&metadata.at(key));
        }
 
        template <typename T> const T &getMetadata(const yoi::wstr &key) const {
            return *std::any_cast<T>(&metadata.at(key));
        }
 
        template <typename T> void setMetadata(const yoi::wstr &key, const T &value) {
            metadata[key] = value;
        }
 
        void eraseMetadata(const yoi::wstr &key);
 
        bool hasMetadata(const yoi::wstr &key) const;
 
        yoi::wstr to_string() const;
    };
 
    class IRValueType {
      public:
        enum class ValueAttr : yoi::indexT { Nullable, Raw, PermanentInCurrentScope, Borrow, NoBorrow };
        enum class valueType : yoi::indexT {
            integerRaw = 0,
            decimalRaw,
            booleanRaw,
            shortRaw,
            unsignedRaw,
            characterObject,
            stringLiteral,
            structObject,
            null,
            integerObject,
            booleanObject,
            decimalObject,
            shortObject,
            unsignedObject,
            stringObject,
            virtualMethod,
            pointerObject, // a placeholder for void* in llvmCodegen for unified interface this pointer
            pointer,
            interfaceObject,
            none,
            charRaw,
            incompleteTemplateType,
            foreignInt32Type,
            foreignFloatType,
            bracedInitalizerList, // placeholder for basic casts
            datastructObject
        } type;
 
        yoi::indexT typeAffiliateModule;
        yoi::indexT typeIndex;
 
        yoi::vec<yoi::indexT> dimensions;
 
        yoi::vec<IRValueType> bracedTypes;
 
        std::set<ValueAttr> attributes;
 
        IRMetadata metadata;
 
        IRValueType();
 
        IRValueType(valueType type);
 
        IRValueType(valueType type, yoi::indexT typeAffiliateModule, yoi::indexT objectPrototypeIndex);
 
        IRValueType(valueType type, yoi::indexT typeAffiliateModule, yoi::indexT objectPrototypeIndex, const std::set<ValueAttr> &attributes);
 
        IRValueType(valueType type, const yoi::vec<yoi::indexT> &dimensions);
 
        IRValueType(valueType type, const yoi::vec<yoi::IRValueType> &bracedTypes);
 
        IRValueType(valueType type, yoi::indexT typeAffiliateModule, yoi::indexT objectPrototypeIndex, const yoi::vec<yoi::indexT> &dimensions);
 
        bool isBasicType() const;
 
        bool isBasicRawType() const;
 
        bool isForeignBasicType() const;
 
        bool is1ByteType() const;
 
        bool isArrayType() const;
 
        bool isDynamicArrayType() const;
 
        IRValueType getNormalizedForeignBasicType();
 
        IRValueType getElementType();
 
        IRValueType getArrayType(const yoi::vec<yoi::indexT> &dimensions);
 
        IRValueType getDynamicArrayType();
 
        IRValueType getBasicRawType() const;
 
        IRValueType getBasicObjectType() const;
 
        yoi::wstr to_string(bool showAttributes = false) const;
 
        bool operator==(const yoi::IRValueType &rhs) const;
 
        IRValueType &addAttribute(ValueAttr attr);
 
        IRValueType &removeAttribute(ValueAttr attr);
 
        bool hasAttribute(ValueAttr attr) const;
 
        yoi::indexT calculateDimensionSize() const;
    };
 
    class IROperand {
      public:
        enum class operandType {
            unknown = 0,
            integer,
            decimal,
            boolean,
            character,
            stringLiteral,
            codeBlock,
            index,
            shortInt,
            unsignedInt,
            /* a local var operand can only be used in a load_local instruction for loading a local variable, not
               available for other instructions */
            localVar,
            /* same for global var */
            globalVar,
            /* same for extern var */
            externVar,
            FINAL
        } type;
 
        static enum_range<operandType> IROperandTypeEnumRange;
 
        union operandValue {
            int64_t integer;
            double decimal;
            bool boolean;
            yoi::wchar character;
            yoi::indexT stringLiteralIndex;
            yoi::indexT symbolIndex;
            yoi::indexT codeBlockIndex;
            uint64_t unsignedV;
            short shortV;
 
            operandValue();
 
            operandValue(int64_t integer);
 
            operandValue(double decimal);
 
            operandValue(yoi::indexT indexV);
 
            operandValue(bool boolean);
 
            operandValue(yoi::wchar character);
 
            operandValue(short shortV);
        } value;
 
        std::shared_ptr<IRValueType> lvalueType;
 
        IROperand();
 
        IROperand(operandType type, operandValue value);
 
        IROperand(operandType type, std::shared_ptr<IRValueType> lvalueType);
 
        std::shared_ptr<IRValueType> getLvalueType();
 
        yoi::wstr to_string() const;
    };
 
    class IR {
      public:
        enum class Opcode {
            unknown = 0,
            load_local,
            negate,
            bitwise_not,
            mul,
            mod,
            div,
            increment,
            decrement,
            add,
            sub,
            right_shift,
            less_than,
            less_equal,
            greater_than,
            greater_equal,
            equal,
            direct_assign,
            not_equal,
            left_shift,
            bitwise_and,
            bitwise_xor,
            bitwise_or,
            jump,
            jump_if_true,
            jump_if_false,
            load_member,
            load_global,
            bind_elements_pred,
            bind_elements_post,
            bind_fields_pred,
            bind_fields_post,
            ret,
            ret_none,
            push_integer,
            push_decimal,
            push_boolean,
            push_character,
            push_null,
            push_short,
            push_unsigned,
            pop,
            basic_cast_int,
            basic_cast_deci,
            basic_cast_bool,
            basic_cast_char,
            basic_cast_short,
            basic_cast_unsigned,
            pointer_cast,
            push_string,
            store_global,
            store_local,
            store_member,             // only for struct
            store_field,              // only for data struct
            load_field,               // only for data struct
            initialize_field,         // once and for all initialization of data struct fields, push the struct itself as a result. act like constructor
            invoke,
            new_struct,
            construct_interface_impl,
            invoke_virtual,
            invoke_imported,
            invoke_dangling,
            store_element,
            load_element,
            new_array_int,
            new_array_deci,
            new_array_bool,
            new_array_char,
            new_array_str,
            new_array_short,
            new_array_unsigned,
            new_array_struct,
            new_array_interface,
            new_dynamic_array_int,
            new_dynamic_array_deci,
            new_dynamic_array_bool,
            new_dynamic_array_char,
            new_dynamic_array_str,
            new_dynamic_array_short,
            new_dynamic_array_unsigned,
            new_dynamic_array_struct,
            new_dynamic_array_interface,
            array_length,
            interfaceof,
            throws,
            push_exception_handler,
            pop_exception_handler,
            typeid_object_non_stack,
            typeid_interface_impl,
            dyn_cast_any,
            new_datastruct,
            yield,
            yield_none,
            resume,
            nop,
            FINAL,
        } opcode;
 
        static enum_range<Opcode> IROpCodeEnumRange;
 
        yoi::vec<IROperand> operands;
 
        IRDebugInfo debugInfo;
 
        IR() = default;
 
        IR(Opcode opcode, const yoi::vec<IROperand> &operands, IRDebugInfo debugInfo);
 
        yoi::wstr to_string() const;
    };
 
    class IRTypeAlias {
      public:
        yoi::wstr name;
        std::shared_ptr<IRValueType> type;
    };
 
    class IREnumerationType {
      public:
        enum class UnderlyingType : yoi::indexT { I8, I16, I64 };
        yoi::wstr name;
        yoi::indexTable<yoi::wstr, yoi::indexT> valueToIndexMap;
 
        IREnumerationType(const yoi::wstr &name, const yoi::indexTable<yoi::wstr, yoi::indexT> &valueToIndexMap);
 
        UnderlyingType getUnderlyingType();
 
        class Builder {
            yoi::wstr name;
            yoi::indexTable<yoi::wstr, yoi::indexT> valueToIndexMap;
 
          public:
            Builder() = default;
 
            Builder &setName(const yoi::wstr &name);
 
            Builder &addValue(const yoi::wstr &valueName, yoi::indexT valueIndex);
 
            std::shared_ptr<IREnumerationType> yield();
        };
    };
 
    class IRCodeBlock {
        yoi::vec<IR> codeBlock;
 
      public:
        IRCodeBlock() = default;
 
        void insert(const IR &ir);
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        yoi::vec<IR> &getIRArray();
    };
 
    class IRVariableTable {
        yoi::vec<std::shared_ptr<IRValueType>> variables;
        yoi::vec<std::map<yoi::wstr, yoi::indexT>> variableNameIndexMap;
        std::map<yoi::indexT, yoi::indexT> variableScopeMap;
        std::map<yoi::indexT, yoi::wstr> reversedVariableNameMap;
 
      public:
        IRVariableTable() = default;
 
        yoi::indexT createScope();
 
        yoi::indexT lookup(const yoi::wstr &name);
 
        std::shared_ptr<IRValueType> get(yoi::indexT index);
 
        std::shared_ptr<IRValueType> operator[](const yoi::wstr &name);
 
        void set(yoi::indexT index, const std::shared_ptr<IRValueType> &type);
 
        yoi::indexT put(const yoi::wstr &name, const std::shared_ptr<IRValueType> &type);
 
        void popScope();
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        yoi::vec<std::shared_ptr<IRValueType>> &getVariables();
 
        std::map<yoi::indexT, yoi::wstr> &getReversedVariableNameMap();
 
        yoi::indexT scopeIndex(yoi::indexT varIndex);
    };
 
    class IRFunctionDefinition {
      public:
        enum class FunctionAttrs {
            AlwaysInline,
            BuiltinImplementation,
            NoFFI,
            Variadic,
            Static,
            Constructor,
            Finalizer,
            Unreachable,
            Preserve,
            NoRawAndNullOptimization,
            Intrinsic,
            Throws,
            Generator
        };
 
        yoi::wstr name;
        yoi::vec<std::shared_ptr<IRValueType>> argumentTypes;
        std::shared_ptr<IRValueType> returnType;
        yoi::vec<std::shared_ptr<IRCodeBlock>> codeBlock;
        IRVariableTable variableTable;
        std::set<FunctionAttrs> attrs;
        IRDebugInfo debugInfo;
 
        yoi::indexT linkedModuleId;
 
        IRFunctionDefinition(const yoi::wstr &name,
                             const yoi::vec<std::pair<yoi::wstr, std::shared_ptr<IRValueType>>> &argumentTypes,
                             const std::shared_ptr<IRValueType> &returnType,
                             const yoi::vec<std::shared_ptr<IRCodeBlock>> &codeBlock,
                             const std::set<FunctionAttrs> &attrs,
                             const IRDebugInfo &debugInfo);
 
        IRVariableTable &getVariableTable();
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        bool hasAttribute(const FunctionAttrs &attr);
 
        struct Builder {
            yoi::wstr name;
            yoi::vec<std::pair<yoi::wstr, std::shared_ptr<IRValueType>>> argumentTypes;
            std::shared_ptr<IRValueType> returnType;
            std::set<FunctionAttrs> attrs;
            IRDebugInfo debugInfo;
 
            Builder() = default;
 
            Builder &setName(const yoi::wstr &name);
 
            Builder &addArgument(const yoi::wstr &argumentName, const std::shared_ptr<IRValueType> &argumentType);
 
            Builder &setReturnType(const std::shared_ptr<IRValueType> &returnType);
 
            Builder &setDebugInfo(const IRDebugInfo &debugInfo);
 
            Builder &addAttr(FunctionAttrs attr);
 
            std::shared_ptr<IRFunctionDefinition> yield();
        };
    };
 
    class IRTemplateBuilder {
      public:
        struct Argument {
            std::shared_ptr<IRValueType> templateType;
 
            yoi::vec<externModuleAccessExpression *> satisfyCondition;
 
            Argument(const std::shared_ptr<IRValueType> &templateType, const yoi::vec<externModuleAccessExpression *> &satisfyConditions);
 
            Argument(const std::shared_ptr<IRValueType> &templateType);
        };
 
        yoi::indexTable<yoi::wstr, Argument> templateArguments;
 
        IRTemplateBuilder() = default;
 
        IRTemplateBuilder &addTemplateArgument(const yoi::wstr &templateName,
                                               const std::shared_ptr<IRValueType> &templateType,
                                               const yoi::vec<externModuleAccessExpression *> &satisfyConditions = {});
    };
 
    class IRFunctionTemplate {
      public:
        std::shared_ptr<IRFunctionDefinition> templateDefinition;
        yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> templateArguments;
 
        IRFunctionTemplate(const std::shared_ptr<IRFunctionDefinition> &templateDefinition,
                           const yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> &templateArguments);
 
        class Builder : public IRTemplateBuilder {
          public:
            std::shared_ptr<IRFunctionDefinition> templateDefinition;
 
            Builder() = default;
 
            Builder &setTemplateDefinition(const std::shared_ptr<IRFunctionDefinition> &templateDefinition);
 
            std::shared_ptr<IRFunctionTemplate> yield();
        };
    };
 
    class IRDataStructDefinition {
      public:
        yoi::wstr name;
        yoi::vec<std::shared_ptr<IRValueType>> fieldTypes;
 
        std::map<yoi::wstr, yoi::indexT> fields;
 
        yoi::indexT linkedModuleId;
 
        IRDataStructDefinition(const yoi::wstr &name,
                               const yoi::vec<std::shared_ptr<IRValueType>> &fieldTypes,
                               const std::map<yoi::wstr, yoi::indexT> &fields,
                               yoi::indexT linkedModuleId);
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        struct Builder {
            yoi::wstr name;
            yoi::vec<std::shared_ptr<IRValueType>> fieldTypes;
            std::map<yoi::wstr, yoi::indexT> fields;
            yoi::indexT linkedModuleId;
 
            Builder() = default;
 
            Builder &setName(const yoi::wstr &name);
 
            Builder &addField(const yoi::wstr &fieldName, const std::shared_ptr<IRValueType> &fieldType);
 
            Builder &setLinkedModuleId(yoi::indexT linkedModuleId);
 
            std::shared_ptr<IRDataStructDefinition> yield();
        };
    };
 
    class IRStructDefinition {
      public:
        yoi::wstr name;
        yoi::vec<std::shared_ptr<IRValueType>> fieldTypes;
 
        struct nameInfo {
            enum class nameType { field, method } type;
            yoi::indexT index;
        };
        std::map<yoi::wstr, nameInfo> nameIndexMap;
 
        yoi::vec<yoi::wstr> templateParamNames;
        yoi::vec<std::shared_ptr<IRValueType>> storedTemplateArgs;
        std::map<yoi::wstr, yoi::structDefInnerPair *> templateMethodDecls;
        std::map<yoi::wstr, yoi::implInnerPair *> templateMethodDefs;
 
        yoi::indexT linkedModuleId;
 
        IRStructDefinition(const yoi::wstr &name,
                           const std::map<yoi::wstr, nameInfo> &nameIndexMap,
                           const vec<std::shared_ptr<IRValueType>> &fieldTypes,
                           const yoi::vec<yoi::wstr> &templateParamNames = {},
                           const yoi::vec<std::shared_ptr<IRValueType>> &storedTemplateArgs = {},
                           const std::map<yoi::wstr, yoi::structDefInnerPair *> &templateMethodDecls = {},
                           const std::map<yoi::wstr, yoi::implInnerPair *> &templateMethodDefs = {});
 
        const nameInfo &lookupName(const yoi::wstr &name);
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        struct Builder {
            yoi::wstr name;
            std::map<yoi::wstr, nameInfo> nameIndexMap;
            yoi::vec<std::shared_ptr<IRValueType>> fieldTypes;
 
            Builder() = default;
 
            yoi::vec<yoi::wstr> templateParamNames;
            yoi::vec<std::shared_ptr<IRValueType>> storedTemplateArgs;
            std::map<yoi::wstr, yoi::structDefInnerPair *> templateMethodDecls;
            std::map<yoi::wstr, yoi::implInnerPair *> templateMethodDefs;
 
            Builder &setName(const yoi::wstr &name);
 
            Builder &addField(const yoi::wstr &fieldName, const std::shared_ptr<IRValueType> &fieldType);
 
            Builder &addMethod(const yoi::wstr &methodName, yoi::indexT index);
 
            Builder &setStoredTemplateArgs(const yoi::vec<yoi::wstr> &paramNames, const yoi::vec<std::shared_ptr<IRValueType>> &args);
 
            Builder &addTemplateMethodDecl(const yoi::wstr &name, yoi::structDefInnerPair *decl);
 
            Builder &addTemplateMethodDef(const yoi::wstr &name, yoi::implInnerPair *def);
 
            std::shared_ptr<IRStructDefinition> yield();
        };
    };
 
    class IRStructTemplate {
      public:
        std::shared_ptr<IRStructDefinition> templateDefinition;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionTemplate>> templateMethods;
        yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> templateArguments;
 
        IRStructTemplate(const std::shared_ptr<IRStructDefinition> &templateDefinition,
                         const yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionTemplate>> &templateMethods,
                         const yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> &templateArguments);
 
        class Builder : public IRTemplateBuilder {
          public:
            std::shared_ptr<IRStructDefinition> templateDefinition;
            yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionTemplate>> templateMethods;
 
            Builder() = default;
 
            Builder &setTemplateDefinition(const std::shared_ptr<IRStructDefinition> &templateDefinition);
 
            Builder &setTemplateMethod(const yoi::wstr &methodName, const std::shared_ptr<IRFunctionTemplate> &methodTemplate);
 
            std::shared_ptr<IRStructTemplate> yield();
        };
    };
 
    class IRInterfaceImplementationDefinition {
      public:
        yoi::wstr name;
        std::tuple<IRValueType::valueType, yoi::indexT, yoi::indexT> implStructIndex;
        std::pair<yoi::indexT, yoi::indexT> implInterfaceIndex;
        yoi::vec<std::shared_ptr<IRValueType>> virtualMethods;
        std::map<yoi::wstr, yoi::indexT> virtualMethodIndexMap;
 
        yoi::indexT linkedModuleId;
 
        IRInterfaceImplementationDefinition(const yoi::wstr &name,
                                            std::tuple<IRValueType::valueType, yoi::indexT, yoi::indexT> implStructIndex,
                                            const std::pair<yoi::indexT, yoi::indexT> &implInterfaceIndex,
                                            const yoi::vec<std::shared_ptr<IRValueType>> &virtualMethods,
                                            const std::map<yoi::wstr, yoi::indexT> &virtualMethodIndexMap);
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        struct Builder {
            yoi::wstr name;
            std::tuple<IRValueType::valueType, yoi::indexT, yoi::indexT> implStructIndex;
            std::pair<yoi::indexT, yoi::indexT> implInterfaceIndex;
 
            yoi::vec<std::shared_ptr<IRValueType>> virtualMethods;
            std::map<yoi::wstr, yoi::indexT> virtualMethodIndexMap;
 
            Builder() = default;
 
            Builder &setName(const yoi::wstr &name);
 
            Builder &setImplStructIndex(std::tuple<IRValueType::valueType, yoi::indexT, yoi::indexT> implStructIndex);
 
            Builder &setImplInterfaceIndex(const std::pair<yoi::indexT, yoi::indexT> &implInterfaceIndex);
 
            Builder &addVirtualMethod(const yoi::wstr &methodName, const std::shared_ptr<IRValueType> &methodType);
 
            std::shared_ptr<IRInterfaceImplementationDefinition> yield();
        };
    };
 
    class IRInterfaceInstanceDefinition {
      public:
        yoi::wstr name;
        std::map<yoi::wstr, yoi::vec<yoi::indexT>> functionOverloadIndexies;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionDefinition>> methodMap;
        yoi::vec<std::tuple<IRValueType::valueType, yoi::indexT, yoi::indexT>> implementations;
 
        yoi::indexT linkedModuleId;
 
        IRInterfaceInstanceDefinition(const yoi::wstr &name,
                                      const std::map<yoi::wstr, yoi::vec<yoi::indexT>> &functionOverloadIndexies,
                                      const yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionDefinition>> &methodMap);
 
        yoi::wstr to_string(yoi::indexT indent = 0);
 
        struct Builder {
            yoi::wstr name;
            std::map<yoi::wstr, yoi::vec<yoi::indexT>> functionOverloadIndexies;
            yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionDefinition>> methodMap;
 
            Builder() = default;
 
            Builder &setName(const yoi::wstr &name);
 
            Builder &
            addMethod(const yoi::wstr &methodNameOri, const yoi::wstr &methodName, const std::shared_ptr<IRFunctionDefinition> &methodSignature);
 
            std::shared_ptr<IRInterfaceInstanceDefinition> yield();
        };
    };
 
    class IRInterfaceInstanceTemplate {
      public:
        std::shared_ptr<IRInterfaceInstanceDefinition> templateDefinition;
        yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> templateArguments;
 
        class Builder : public IRTemplateBuilder {
          public:
            std::shared_ptr<IRInterfaceInstanceDefinition> templateDefinition;
 
            Builder() = default;
 
            Builder &setTemplateDefinition(const std::shared_ptr<IRInterfaceInstanceDefinition> &templateDefinition);
 
            std::shared_ptr<IRInterfaceInstanceTemplate> yield();
        };
 
        IRInterfaceInstanceTemplate(const std::shared_ptr<IRInterfaceInstanceDefinition> &templateDefinition,
                                    const yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> &templateArguments);
    };
 
    class IRInterfaceImplementationTemplate {
      public:
        std::shared_ptr<IRInterfaceImplementationDefinition> templateDefinition;
        yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> templateArguments;
 
        class Builder : public IRTemplateBuilder {
          public:
            std::shared_ptr<IRInterfaceImplementationDefinition> templateDefinition;
            yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> templateArguments;
 
            Builder() = default;
 
            Builder &setTemplateDefinition(const std::shared_ptr<IRInterfaceImplementationDefinition> &templateDefinition);
 
            std::shared_ptr<IRInterfaceImplementationTemplate> yield();
        };
 
        IRInterfaceImplementationTemplate(const std::shared_ptr<IRInterfaceImplementationDefinition> &templateDefinition,
                                          const yoi::indexTable<yoi::wstr, IRTemplateBuilder::Argument> &templateArguments);
    };
 
    class IRStringLiteralPool {
      public:
        yoi::indexPool<yoi::wstr> pool;
 
        yoi::indexT addStringLiteral(const yoi::wstr &str);
 
        yoi::wstr &getStringLiteral(yoi::indexT index);
    };
 
    class IRExternEntry {
      public:
        enum class externType {
            globalVar,
            function,
            structType,
            datastructType,
            interfaceType,
            interfaceImplType,
            importedFunction,
        } type;
 
        yoi::wstr name;
        yoi::indexT affiliateModule;
        yoi::indexT itemIndex;
 
        IRExternEntry() = default;
 
        IRExternEntry(externType type, const yoi::wstr &name, yoi::indexT affiliateModule, yoi::indexT itemIndex);
 
        externType getExternType() const;
    };
 
    class IRConcept {
      public:
        yoi::wstr name;
        yoi::indexT affiliateModule;
 
        conceptDefinition *def;
    };
 
    class IRModule : std::enable_shared_from_this<IRModule> {
      public:
        yoi::indexT identifier;
        bool compiled;
        yoi::wstr modulePath;
        std::map<yoi::wstr, yoi::indexT> moduleImports;
        std::set<yoi::indexT> dependentModules;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionDefinition>> functionTable;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRStructDefinition>> structTable;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRValueType>> globalVariables;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRExternEntry>> externTable;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IREnumerationType>> enumerationTable;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRInterfaceInstanceDefinition>> interfaceTable;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRInterfaceImplementationDefinition>> interfaceImplementationTable;
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRDataStructDefinition>> dataStructTable;
 
        std::map<yoi::wstr, yoi::funcDefStmt *> funcTemplateAsts;
        std::map<yoi::wstr, yoi::structDefStmt *> structTemplateAsts;
        std::map<yoi::wstr, yoi::interfaceDefStmt *> templateInterfaceAsts;
        std::map<yoi::wstr, yoi::implStmt *> templateImplAsts; // Maps struct template name to its impl block
        std::map<yoi::wstr, yoi::vec<yoi::implStmt *>> templateInterfaceImplAsts;
        std::map<yoi::wstr, yoi::typeAliasStmt *> typeAliasTemplateAsts;
        std::map<yoi::wstr, IRValueType> typeAliases;
        std::map<yoi::wstr, yoi::vec<yoi::indexT>> functionOverloadIndexies;
        std::map<yoi::wstr, std::shared_ptr<IRConcept>> concepts;
 
        IRStringLiteralPool stringLiteralPool;
 
        yoi::wstr to_string(yoi::indexT indent = 0);
    };
 
    class IRBuilder {
        struct LoopContext {
            yoi::indexT breakTarget;
            yoi::indexT continueTarget;
        };
        std::shared_ptr<compilerContext> compilerCtx;
        std::shared_ptr<IRModule> currentModule;
        std::shared_ptr<IRFunctionDefinition> currentFunction;
        std::vector<std::shared_ptr<IRCodeBlock>> codeBlocks;
        std::vector<std::shared_ptr<yoi::IRValueType>> tempVarStack;
        yoi::indexT currentCodeBlockIndex;
        yoi::vec<std::tuple<yoi::indexT, yoi::indexT, yoi::indexT>> codeBlockInsertionStates;
        yoi::vec<IR> tempStateCodeBlock;
        yoi::vec<std::shared_ptr<yoi::IRValueType>> tempStateTempVarStack;
        IRDebugInfo currentDebugInfo;
        yoi::vec<LoopContext> loopContext;
 
      public:
        IRBuilder() = delete;
 
        IRBuilder(std::shared_ptr<compilerContext> compilerCtx,
                  std::shared_ptr<IRModule> currentModule,
                  std::shared_ptr<IRFunctionDefinition> currentFunction);
 
        void setDebugInfo(const IRDebugInfo &debugInfo);
 
        const IRDebugInfo &getCurrentDebugInfo();
 
        void pushLoopContext(yoi::indexT breakTarget, yoi::indexT continueTarget);
 
        void popLoopContext();
 
        yoi::indexT saveState();
 
        void discardState();
 
        void restoreState();
 
        void restoreStateTemporarily(); // rollback to the state with current state saved
 
        void commitState(); // commit the overriden state and pour the saved state back
 
        void discardStateUntil(yoi::indexT stateIndex);
 
        void pushTempVar(const std::shared_ptr<IRValueType> &type);
 
        yoi::indexT createCodeBlock();
 
        std::shared_ptr<IRFunctionDefinition> irFuncDefinition();
 
        IRCodeBlock &getCurrentCodeBlock();
 
        yoi::indexT getCurrentCodeBlockIndex();
 
        yoi::indexT switchCodeBlock(yoi::indexT index);
 
        IRCodeBlock &getCodeBlock(yoi::indexT index);
 
        void yield();
 
        void insert(const IR &ir, yoi::indexT insertionPoint = 0xffffffff);
 
        yoi::IROperand createLocalVar(const yoi::wstr &varName, const std::shared_ptr<IRValueType> &type);
 
        IRValueType getLocalVar(yoi::indexT index);
 
        std::shared_ptr<IRValueType> &getLhsFromTempVarStack();
 
        std::shared_ptr<IRValueType> &getRhsFromTempVarStack();
 
        void basicCast(const std::shared_ptr<IRValueType> &valType, yoi::indexT insertionPoint, bool lhs = false);
 
        void popOp();
 
        void uniqueArithmeticOp(IR::Opcode op);
 
        void arithmeticOp(IR::Opcode op);
 
        bool hasTerminated();
 
        void jumpOp(yoi::indexT target);
 
        void jumpIfOp(IR::Opcode op, yoi::indexT target);
 
        void pushOp(IR::Opcode op, const yoi::IROperand &constV);
 
        void loadOp(IR::Opcode op, const yoi::IROperand &source, const std::shared_ptr<IRValueType> &expectedType, yoi::indexT moduleIndex = -1);
 
        void loadFieldOp(yoi::vec<yoi::IROperand> &accessors, const std::shared_ptr<IRValueType> &expectedType);
 
        void loadMemberOp(const yoi::IROperand &memberIndex, const std::shared_ptr<IRValueType> &memberType);
 
        void storeOp(IR::Opcode op, const yoi::IROperand &operand, yoi::indexT moduleIndex = -1);
 
        void storeMemberOp(const yoi::IROperand &memberIndex);
 
        void storeFieldOp(yoi::vec<yoi::IROperand> &accessors);
 
        void invokeOp(yoi::indexT funcIndex,
                      yoi::indexT funcArgsCount,
                      const std::shared_ptr<IRValueType> &returnType,
                      bool externalInvocation = false,
                      yoi::indexT moduleIndex = -1);
 
        void invokeDanglingOp(yoi::indexT funcIndex,
                              yoi::indexT funcArgsCount,
                              const std::shared_ptr<IRValueType> &returnType,
                              bool externalInvocation = false,
                              yoi::indexT moduleIndex = -1);
 
        void invokeMethodOp(yoi::indexT funcIndex,
                            yoi::indexT methodArgsCount,
                            const std::shared_ptr<IRValueType> &returnType,
                            bool isStatic,
                            bool externalInvocation = false,
                            yoi::indexT moduleIndex = -1);
 
        void invokeVirtualOp(yoi::indexT funcIndex,
                             yoi::indexT interfaceIndex,
                             yoi::indexT methodArgsCount,
                             const std::shared_ptr<IRValueType> &returnType,
                             bool externalInvocation = false,
                             yoi::indexT moduleIndex = -1);
 
        void invokeImportedOp(yoi::indexT libIndex, yoi::indexT funcIndex, yoi::indexT funcArgsCount, const std::shared_ptr<IRValueType> &returnType);
 
        void retOp(bool returnWithNone = false);
 
        void newStructOp(yoi::indexT structIndex, bool isExternal = false, yoi::indexT moduleIndex = -1);
 
        void newDataStructOp(yoi::indexT structIndex, bool isExternal = false, yoi::indexT moduleIndex = -1);
 
        void initializeFieldsOp(yoi::indexT parameterCount);
 
        void newInterfaceOp(yoi::indexT interfaceIndex, bool isExternal = false, yoi::indexT moduleIndex = -1);
 
        void constructInterfaceImplOp(const std::pair<yoi::indexT, yoi::indexT> &interfaceId,
                                      yoi::indexT interfaceImplIndex,
                                      bool isExternal = false,
                                      yoi::indexT moduleIndex = -1);
 
        void newArrayOp(const std::shared_ptr<IRValueType> &elementType, const yoi::vec<yoi::indexT> &dimensions, yoi::indexT onstackElementCount);
 
        void newDynamicArrayOp(const std::shared_ptr<IRValueType> &elementType, yoi::indexT initializerSize = 0);
 
        void arrayLengthOp();
 
        void interfaceOfOp();
 
        void typeIdOp(const std::shared_ptr<IRValueType> &type);
 
        void typeIdOp();
 
        void dynCastOp(const std::shared_ptr<IRValueType> &type);
 
        void pointerCastOp();
 
        void breakOp();
 
        void continueOp();
 
        enum class ExtractType { All, First, Last };
 
        void bindElementsOp(yoi::indexT extractElementCount, ExtractType extractType);
 
        void bindFieldsOp(yoi::indexT extractFieldCount, ExtractType extractType);
 
        void yieldOp(bool yieldNone = false);
 
        void resumeOp();
 
        yoi::indexT getCurrentInsertionPoint();
 
        void popFromTempVarStack();
    };
 
    class IRObjectFile {
      public:
        /* one module that has renamed all functions and variables to their final names */
        std::shared_ptr<IRModule> compiledModule;
 
        yoi::indexT entryModule;
    };
 
    class IRFFITable {
      public:
        class ImportLibrary {
          public:
            yoi::wstr libraryPath;
 
            yoi::indexTable<yoi::wstr, std::shared_ptr<IRFunctionDefinition>> importedFunctionTable;
 
            ImportLibrary(const yoi::wstr &libraryPath);
        };
 
        yoi::indexTable<yoi::wstr, std::tuple<yoi::indexT, yoi::indexT, std::set<IRFunctionDefinition::FunctionAttrs>>> exportedFunctionTable;
 
        yoi::indexTable<yoi::wstr, std::shared_ptr<IRValueType>> foreignTypeTable;
 
        yoi::indexTable<yoi::wstr, ImportLibrary> importedLibraries;
 
        yoi::indexT addImportedFunction(const yoi::wstr &libraryName,
                                        const yoi::wstr &functionName,
                                        const std::shared_ptr<IRFunctionDefinition> &functionDefinition);
 
        void addForeignType(const yoi::wstr &foreignTypeName, const std::shared_ptr<IRValueType> &structType);
 
        void addExportedFunction(const yoi::wstr &exportName,
                                 yoi::indexT moduleIndex,
                                 yoi::indexT functionIndex,
                                 const std::set<IRFunctionDefinition::FunctionAttrs> &attrs);
    };
} // namespace yoi
 
#endif // HOSHI_LANG_IR_H