ReflectionAnalyzer.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 "Visitor.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Container/Map.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/Reflection.hpp"
#include "CeresEngine/Material/ShaderCompiler/Targets.hpp"
#include "CeresEngine/Material/ShaderCompiler/Variant.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Token.hpp"
#include "CeresEngine/Material/ShaderCompiler/AST/TypeDenoter.hpp"
#include "CeresEngine/Material/ShaderCompiler/Report/ReportHandler.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    class ReflectionAnalyzer : private Visitor {
    private:
        ReportHandler mReportHandler;
 
        ShaderTarget mShaderTarget = ShaderTarget::VertexShader;
        Program* mProgram = nullptr;
 
        Reflection::ReflectionData* mData = nullptr;
 
        bool mEnableWarnings = false;
 
        Map<const StructDeclaration*, std::size_t> mRecordIndicesMap;
 
    public:
        ReflectionAnalyzer(Log* log);
 
        // Collect all reflection data from the program AST.
        void reflect(Program& program, const ShaderTarget shaderTarget, Reflection::ReflectionData& reflectionData, bool enableWarnings);
 
    private:
        void warning(const String& msg, const AST* ast = nullptr);
 
        [[nodiscard]] Int32 getBindingPoint(const Vector<RegisterPtr>& slotRegisters) const;
 
        Int32 evaluateConstExpressionInt(Expression& expression);
        float evaluateConstExpressionFloat(Expression& expression);
 
    private: // Visitor implementation
        DECLARATION_VISIT_PROC(Program);
 
        DECLARATION_VISIT_PROC(SamplerDeclaration);
        DECLARATION_VISIT_PROC(StructDeclaration);
 
        DECLARATION_VISIT_PROC(FunctionDeclaration);
        DECLARATION_VISIT_PROC(UniformBufferDeclaration);
        DECLARATION_VISIT_PROC(BufferDeclarationStatement);
 
        DECLARATION_VISIT_PROC(VarDeclaration);
 
    private: // Helper functions for code reflection
        void reflectSamplerValue(const SamplerValue* ast, Reflection::SamplerStateDesc& desc);
        void reflectSamplerValueFilter(const String& value, Reflection::Filter& filter, const AST* ast = nullptr);
        void reflectSamplerValueTextureAddressMode(const String& value, Reflection::TextureAddressMode& addressMode, const AST* ast = nullptr);
        void reflectSamplerValueComparisonFunc(const String& value, Reflection::ComparisonFunc& comparisonFunc, const AST* ast = nullptr);
 
        void reflectAttributes(const Vector<AttributePtr>& attribs);
        void reflectAttributesNumThreads(const Attribute* ast);
 
        void reflectField(VarDeclaration* ast, Reflection::Field& field, UInt32& accumSize, UInt32& accumPadding);
        void reflectFieldType(Reflection::Field& field, const TypeDenoter& typeDen);
 
        // Returns the index of the record that is associated with the specified structure declaration object, or -1 on failure.
        Int32 findRecordIndex(const StructDeclaration* structDeclaration) const;
    };
 
} // namespace CeresEngine::ShaderCompiler