SLParser.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 "Parser.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Function.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/Log.hpp"
#include "CeresEngine/Material/ShaderCompiler/Variant.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Token.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Visitor/Visitor.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    // Syntax parser base class for HLSL and GLSL.
    class SLParser : public Parser {
    public:
        SLParser(Log* log = nullptr);
 
    protected:
        // Accepts the semicolon token (Accept(Tokens::Semicolon)).
        void semi();
 
    protected: // Parsing
        [[nodiscard]] virtual CodeBlockPtr parseCodeBlock() = 0;
        [[nodiscard]] virtual VarDeclarationStatementPtr parseParameter() = 0;
        [[nodiscard]] virtual StatementPtr parseLocalStatement() = 0;
        [[nodiscard]] virtual StatementPtr parseForLoopInitializer() = 0;
        [[nodiscard]] virtual SwitchCasePtr parseSwitchCase() = 0;
        [[nodiscard]] virtual VarDeclarationPtr parseVarDeclaration(VarDeclarationStatement* declarationStatementRef, const TokenPtr& identifierToken = nullptr) = 0;
 
        [[nodiscard]] ArrayDimensionPtr parseArrayDimension(bool allowDynamicDimension = false);
        [[nodiscard]] NullStatementPtr parseNullStatement();
        [[nodiscard]] CodeBlockStatementPtr parseCodeBlockStatement();
        [[nodiscard]] ForLoopStatementPtr parseForLoopStatement();
        [[nodiscard]] WhileLoopStatementPtr parseWhileLoopStatement();
        [[nodiscard]] DoWhileLoopStatementPtr parseDoWhileLoopStatement();
        [[nodiscard]] IfStatementPtr parseIfStatement();
        [[nodiscard]] ElseStatementPtr parseElseStatement();
        [[nodiscard]] SwitchStatementPtr parseSwitchStatement();
        [[nodiscard]] CtrlTransferStatementPtr parseCtrlTransferStatement();
        [[nodiscard]] ReturnStatementPtr parseReturnStatement();
        [[nodiscard]] ExpressionStatementPtr parseExpressionStatement(const ExpressionPtr& expression = nullptr);
 
        [[nodiscard]] ExpressionPtr parseExpression(); // expression
        [[nodiscard]] ExpressionPtr parseExpressionWithSequenceOpt(); // expression (, expression)*
        [[nodiscard]] ExpressionPtr parseArrayIndex(); // [ expression ]
        [[nodiscard]] ExpressionPtr parseInitializer(); // = expression
 
        [[nodiscard]] SequenceExpressionPtr parseSequenceExpression(const ExpressionPtr& firstExpression);
        [[nodiscard]] ArrayExpressionPtr parseArrayExpression(const ExpressionPtr& expression);
        [[nodiscard]] InitializerExpressionPtr parseInitializerExpression();
 
        [[nodiscard]] Vector<VarDeclarationPtr> parseVarDeclarationList(VarDeclarationStatement* declarationStatementRef, TokenPtr firstidentifierToken = nullptr);
        [[nodiscard]] Vector<VarDeclarationStatementPtr> parseParameterList();
        [[nodiscard]] Vector<StatementPtr> parseLocalStatementList();
        [[nodiscard]] Vector<ExpressionPtr> parseExpressionList(const Tokens listTerminatorToken, bool allowLastComma = false);
        [[nodiscard]] Vector<ArrayDimensionPtr> parseArrayDimensionList(bool allowDynamicDimension = false);
        [[nodiscard]] Vector<ExpressionPtr> parseArrayIndexList();
        [[nodiscard]] Vector<ExpressionPtr> parseArgumentList();
        [[nodiscard]] Vector<ExpressionPtr> parseInitializerList();
        [[nodiscard]] Vector<SwitchCasePtr> parseSwitchCaseList();
 
        [[nodiscard]] String parseIdent(TokenPtr identifierToken = nullptr, SourceArea* area = nullptr);
 
        [[nodiscard]] TypeDenoterPtr parseTypeDenoterWithArrayOpt(const TypeDenoterPtr& baseTypeDenoter);
        [[nodiscard]] VoidTypeDenoterPtr parseVoidTypeDenoter();
 
        [[nodiscard]] Variant parseAndEvaluateConstExpression();
        [[nodiscard]] Int32 parseAndEvaluateConstExpressionInt();
        [[nodiscard]] Int32 parseAndEvaluateVectorDimension();
 
        void parseStatementWithCommentOpt(Vector<StatementPtr>& statements, const UniqueFunction<StatementPtr() const>& parseFunction);
    };
 
} // namespace CeresEngine::ShaderCompiler