FuncNameConverter.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 "VisitorTracker.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Flags.hpp"
#include "CeresEngine/Foundation/Function.hpp"
#include "CeresEngine/Foundation/Container/Map.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/ShaderCompiler.hpp"
 
#include <functional>
 
namespace CeresEngine::ShaderCompiler {
 
    // Function name mangling AST converter.
    class FuncNameConverter : public VisitorTracker {
    public:
        // Function signature compare callback interface, which returns true if the signatures are considered to be equal.
        using OnFuncSigantureCompare = Function<bool(const FunctionDeclaration& lhs, const FunctionDeclaration& rhs) const>;
 
    private:
        using FuncList = Vector<FunctionDeclaration*>;
 
        NameMangling mNameMangling;
        OnFuncSigantureCompare mOnFuncSignatureCompare;
        RawFlags mConversionFlags;
 
        Map<String, FuncList> mFuncDeclarationMap;
 
    public:
        // Conversion flags enumeration.
        enum : UInt32 {
            // Rename all member functions to "{Prefix}{OwnerStruct}_{FunctionName}"
            RenameMemberFunctions = (1 << 0),
 
            // Rename functions where the signatures are equal, specified by the signature compare callback.
            RenameFunctionSignatures = (1 << 1),
 
            All = (RenameMemberFunctions | RenameFunctionSignatures),
        };
 
        // Converts the function declaration identigiers in the specified AST.
        void convert(Program& program, const NameMangling& nameMangling, const OnFuncSigantureCompare& onFuncSignatureCompare, const RawFlags& conversionFlags);
 
    private: // Conversion
        void convertEqualFunctionSignatures(FuncList& funcList);
        void convertMemberFunctionName(FunctionDeclaration& funcDeclaration, UInt32& nameIndex);
 
    private: // Visitor implementation
        DECLARATION_VISIT_PROC(UniformBufferDeclaration);
        DECLARATION_VISIT_PROC(BufferDeclarationStatement);
        DECLARATION_VISIT_PROC(SamplerDeclarationStatement);
 
        DECLARATION_VISIT_PROC(FunctionDeclaration);
    };
 
} // namespace CeresEngine::ShaderCompiler