Generator.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/DataTypes.hpp"
 
#include "CeresEngine/Foundation/CodeWriter.hpp"
#include "CeresEngine/Foundation/Flags.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/ShaderCompiler.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/Report/ReportHandler.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Visitor/VisitorTracker.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    // Output code generator base class.
    class Generator : protected VisitorTracker {
    public:
        Generator(Log* log);
 
        bool generateCode(Program& program, const ShaderInput& inputDesc, const ShaderOutput& outputDesc, Log* log = nullptr);
 
    protected:
        virtual void generateCodePrimary(Program& program, const ShaderInput& inputDesc, const ShaderOutput& outputDesc) = 0;
 
        void error(const String& msg, const AST* ast = nullptr, bool breakWithException = true);
        void warning(const String& msg, const AST* ast = nullptr);
 
        void beginLn();
        void endLn();
 
        void beginAlignedLines();
        void endAlignedLines();
 
        void separator();
 
        void writeScopeOpen(bool compact = false, bool endWithSemicolon = false, bool useBraces = true);
        void writeScopeClose();
        void writeScopeContinue();
 
        [[nodiscard]] bool isOpenLine() const;
 
        void write(const String& text);
        void writeLn(const String& text);
 
        void incrementIndent();
        void decrementIndent();
 
        void pushOptions(const CodeWriter::Options& options);
        void popOptions();
 
        // Push the specified text to the write-prefix which will be written in front of the text of the next "Write"/"WriteLn" call.
        void pushWritePrefix(const String& text);
        void popWritePrefix(const String& text = "");
 
        // Returns true, if the current (top most) write prefix was written out.
        [[nodiscard]] bool isTopWritePrefix() const;
 
        void blank();
 
        // Returns the current date and time point (can be used in a headline comment).
        [[nodiscard]] String getTimePoint() const;
 
        // Returns the AST root node.
        [[nodiscard]] inline Program* getProgram() const { return mProgram; }
 
        // Returns the shader target.
        [[nodiscard]] inline ShaderTarget getShaderTarget() const { return mShaderTarget; }
 
        // Returns true if the specified warnings flags are enabled.
        [[nodiscard]] bool isWarningEnabled(UInt32 flags) const;
 
        [[nodiscard]] bool isVertexShader() const;
        [[nodiscard]] bool isTessControlShader() const;
        [[nodiscard]] bool isTessEvaluationShader() const;
        [[nodiscard]] bool isGeometryShader() const;
        [[nodiscard]] bool isFragmentShader() const;
        [[nodiscard]] bool isComputeShader() const;
 
    private:
        struct WritePrefix {
            String text; // Specifies the prefix text.
            bool written; // Specifies whether this prefix has already been written out.
        };
 
        // Writes all prefixes that have not already been written.
        void flushWritePrefixes();
 
        CodeWriter mWriter;
        ReportHandler mReportHandler;
 
        Program* mProgram = nullptr;
 
        ShaderTarget mShaderTarget = ShaderTarget::VertexShader;
        RawFlags mWarnings;
 
        bool mAllowBlanks = true;
        bool mAllowLineSeparation = true;
 
        Vector<WritePrefix> mWritePrefixStack;
    };
 
} // namespace CeresEngine::ShaderCompiler