ASTPrinter.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/CodeWriter.hpp"
#include "CeresEngine/Foundation/Container/Map.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/ShaderCompiler.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Token.hpp"
 
#include <iostream>
 
namespace CeresEngine::ShaderCompiler {
 
    // AST debug printer.
    class ASTPrinter : private Visitor {
    private:
        struct PrintableTree {
            String row; // Source position row as string.
            String col; // Source position column as string.
            String label; // AST description label.
            String value; // AST description value.
            Vector<PrintableTree> children; // Child nodes.
        };
 
        PrintableTree mTreeRoot;
        Stack<PrintableTree*> mParentNodeStack;
        Vector<bool> mLastSubNodeStack;
        Stack<String> mMemberNameStack;
 
        std::size_t mMaxRowStrLen = 0, mMaxColStrLen = 0;
 
    public:
        void printAST(Program* program, std::ostream& output = std::cout);
 
    private:
        DECLARATION_VISIT_PROC(Program);
        DECLARATION_VISIT_PROC(CodeBlock);
        DECLARATION_VISIT_PROC(Attribute);
        DECLARATION_VISIT_PROC(SwitchCase);
        DECLARATION_VISIT_PROC(SamplerValue);
        DECLARATION_VISIT_PROC(Register);
        DECLARATION_VISIT_PROC(PackOffset);
        DECLARATION_VISIT_PROC(ArrayDimension);
        DECLARATION_VISIT_PROC(TypeSpecifier);
 
        DECLARATION_VISIT_PROC(VarDeclaration);
        DECLARATION_VISIT_PROC(BufferDeclaration);
        DECLARATION_VISIT_PROC(SamplerDeclaration);
        DECLARATION_VISIT_PROC(StructDeclaration);
        DECLARATION_VISIT_PROC(AliasDeclaration);
        DECLARATION_VISIT_PROC(FunctionDeclaration);
 
        DECLARATION_VISIT_PROC(VarDeclarationStatement);
        DECLARATION_VISIT_PROC(UniformBufferDeclaration);
        DECLARATION_VISIT_PROC(BufferDeclarationStatement);
        DECLARATION_VISIT_PROC(SamplerDeclarationStatement);
        DECLARATION_VISIT_PROC(AliasDeclarationStatement);
        DECLARATION_VISIT_PROC(BasicDeclarationStatement);
 
        DECLARATION_VISIT_PROC(NullStatement);
        DECLARATION_VISIT_PROC(CodeBlockStatement);
        DECLARATION_VISIT_PROC(ForLoopStatement);
        DECLARATION_VISIT_PROC(WhileLoopStatement);
        DECLARATION_VISIT_PROC(DoWhileLoopStatement);
        DECLARATION_VISIT_PROC(IfStatement);
        DECLARATION_VISIT_PROC(ElseStatement);
        DECLARATION_VISIT_PROC(SwitchStatement);
        DECLARATION_VISIT_PROC(ExpressionStatement);
        DECLARATION_VISIT_PROC(ReturnStatement);
        DECLARATION_VISIT_PROC(CtrlTransferStatement);
        DECLARATION_VISIT_PROC(LayoutStatement);
 
        DECLARATION_VISIT_PROC(NullExpression);
        DECLARATION_VISIT_PROC(SequenceExpression);
        DECLARATION_VISIT_PROC(LiteralExpression);
        DECLARATION_VISIT_PROC(TypeSpecifierExpression);
        DECLARATION_VISIT_PROC(TernaryExpression);
        DECLARATION_VISIT_PROC(BinaryExpression);
        DECLARATION_VISIT_PROC(UnaryExpression);
        DECLARATION_VISIT_PROC(PostUnaryExpression);
        DECLARATION_VISIT_PROC(CallExpression);
        DECLARATION_VISIT_PROC(BracketExpression);
        DECLARATION_VISIT_PROC(ObjectExpression);
        DECLARATION_VISIT_PROC(AssignExpression);
        DECLARATION_VISIT_PROC(ArrayExpression);
        DECLARATION_VISIT_PROC(CastExpression);
        DECLARATION_VISIT_PROC(InitializerExpression);
 
    private: // Helper functions
        template<typename T> void visitMember(T ast, const String& name) {
            if(ast) {
                pushMemberName(name);
                ast->visit(this, nullptr);
                popMemberName();
            }
        }
 
        template<typename T> void visitMember(const Vector<T>& astList, const String& name) {
            for(std::size_t i = 0; i < astList.size(); ++i) {
                visitMember(astList[i], name + "[" + String::from((UInt64)i) + "]");
            }
        }
 
        String writeLabel(const String& astName, TypedAST* ast = nullptr);
 
        void print(const PrintableTree& tree, std::ostream& output);
 
        bool pushPrintable(const AST* ast, const String& label, const String& value = "");
        void popPrintable();
 
        void printable(const AST* ast, const String& label, const String& value = "");
 
        PrintableTree* topPrintable();
 
        void pushMemberName(const String& name);
        void popMemberName();
 
        [[nodiscard]] const String& topMemberName() const;
    };
 
} // namespace CeresEngine::ShaderCompiler