IntrinsicAdept.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Array.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/ASTEnums.hpp"
#include "CeresEngine/Material/ShaderCompiler/AST/TypeDenoter.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Visitor/Visitor.hpp"
 
#include <array>
 
namespace CeresEngine::ShaderCompiler {
 
// Converts the Intrinsic enum value into a zero-based integral.
#define INTRINSIC_IDX(I) (static_cast<std::size_t>(I) - static_cast<std::size_t>(Intrinsic::Abort))
 
    // Base class for intrinsic type analysis.
    class IntrinsicAdept {
    public:
        IntrinsicAdept(const IntrinsicAdept&) = delete;
        IntrinsicAdept& operator=(const IntrinsicAdept&) = delete;
 
        virtual ~IntrinsicAdept();
 
        // Returns the active intrinsic adept instance.
        static const IntrinsicAdept& get();
 
        // Returns the identifier of the specified intrinsic or "<undefined>" if the input ID is out of range.
        [[nodiscard]] const String& getIntrinsicIdent(const Intrinsic intrinsic) const;
 
        // Returns the return type denoter of the specified intrinsic with its arguments or throws an error if the call is ambiguous.
        [[nodiscard]] virtual TypeDenoterPtr getIntrinsicReturnType(const Intrinsic intrinsic, const Vector<ExpressionPtr>& args,
            const TypeDenoterPtr& prefixTypeDenoter = nullptr) const = 0;
 
        // Returns a list of all parameter types of the specified intrinsic with its arguments or throws an error if the call is ambiguous.
        [[nodiscard]] virtual Vector<TypeDenoterPtr> getIntrinsicParameterTypes(const Intrinsic intrinsic, const Vector<ExpressionPtr>& args) const = 0;
 
        // Returns a list of indices that refer to all output parameters of the specified intrinsic.
        [[nodiscard]] virtual Vector<std::size_t> getIntrinsicOutputParameterIndices(const Intrinsic intrinsic) const = 0;
 
    protected:
        IntrinsicAdept();
 
        // Sets the identifier of the specified intrinsic.
        void setIntrinsicIdent(const Intrinsic intrinsic, const String& ident);
 
        // Fill all remaining intrinsic identifiers for overloaded intrinsics.
        void fillOverloadedIntrinsicIdents();
 
        [[noreturn]] void throwAmbiguousIntrinsicCall(const Intrinsic intrinsic, const Vector<ExpressionPtr>& args);
 
    private:
        static const std::size_t numIntrinsics = (INTRINSIC_IDX(Intrinsic::StreamOutputRestartStrip) + 1u);
 
        Array<String, numIntrinsics> mIntrinsicIdents;
    };
 
} // namespace CeresEngine::ShaderCompiler