//

// Copyright (C) 2016-2018 Google, Inc.

// Copyright (C) 2016 LunarG, Inc.

// Copyright (C) 2023 Mobica Limited.

//

// All rights reserved.

//

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions

// are met:

//

//    Redistributions of source code must retain the above copyright

//    notice, this list of conditions and the following disclaimer.

//

//    Redistributions in binary form must reproduce the above

//    copyright notice, this list of conditions and the following

//    disclaimer in the documentation and/or other materials provided

//    with the distribution.

//

//    Neither the name of Google, Inc., nor the names of its

//    contributors may be used to endorse or promote products derived

//    from this software without specific prior written permission.

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

// POSSIBILITY OF SUCH DAMAGE.

//

#ifndef HLSLGRAMMAR_H_

#define HLSLGRAMMAR_H_

#include "hlslParseHelper.h"

#include "hlslOpMap.h"

#include "hlslTokenStream.h"

namespace glslang {

    class TFunctionDeclarator;

    // Should just be the grammar aspect of HLSL.

    // Described in more detail in hlslGrammar.cpp.

    class HlslGrammar : public HlslTokenStream {

    public:

        HlslGrammar(HlslScanContext& scanner, HlslParseContext& parseContext)

            : HlslTokenStream(scanner), parseContext(parseContext), intermediate(parseContext.intermediate),

              typeIdentifiers(false), unitNode(nullptr) { }

        virtual ~HlslGrammar() { }

        bool parse();

    protected:

        HlslGrammar();

        HlslGrammar& operator=(const HlslGrammar&);

        void expected(const char*);

        void unimplemented(const char*);

        bool acceptIdentifier(HlslToken&);

        bool acceptCompilationUnit();

        bool acceptDeclarationList(TIntermNode*&);

        bool acceptDeclaration(TIntermNode*&);

        bool acceptControlDeclaration(TIntermNode*& node);

        bool acceptSamplerDeclarationDX9(TType&);

        bool acceptSamplerState();

        bool acceptFullySpecifiedType(TType&, const TAttributes&);

        bool acceptFullySpecifiedType(TType&, TIntermNode*& nodeList, const TAttributes&, bool forbidDeclarators = false);

        bool acceptPreQualifier(TQualifier&);

        bool acceptPostQualifier(TQualifier&);

        bool acceptLayoutQualifierList(TQualifier&);

        bool acceptType(TType&);

        bool acceptType(TType&, TIntermNode*& nodeList);

        bool acceptTemplateVecMatBasicType(TBasicType&, TPrecisionQualifier&);

        bool acceptVectorTemplateType(TType&);

        bool acceptMatrixTemplateType(TType&);

        bool acceptTessellationDeclType(TBuiltInVariable&);

        bool acceptTessellationPatchTemplateType(TType&);

        bool acceptStreamOutTemplateType(TType&, TLayoutGeometry&);

        bool acceptOutputPrimitiveGeometry(TLayoutGeometry&);

        bool acceptAnnotations(TQualifier&);

        bool acceptSamplerTypeDX9(TType &);

        bool acceptSamplerType(TType&);

        bool acceptTextureType(TType&);

        bool acceptSubpassInputType(TType&);

        bool acceptStructBufferType(TType&);

        bool acceptTextureBufferType(TType&);

        bool acceptConstantBufferType(TType&);

        bool acceptStruct(TType&, TIntermNode*& nodeList);

        bool acceptStructDeclarationList(TTypeList*&, TIntermNode*& nodeList, TVector<TFunctionDeclarator>&);

        bool acceptMemberFunctionDefinition(TIntermNode*& nodeList, const TType&, TString& memberName,

                                            TFunctionDeclarator&);

        bool acceptFunctionParameters(TFunction&);

        bool acceptParameterDeclaration(TFunction&);

        bool acceptFunctionDefinition(TFunctionDeclarator&, TIntermNode*& nodeList, TVector<HlslToken>* deferredTokens);

        bool acceptFunctionBody(TFunctionDeclarator& declarator, TIntermNode*& nodeList);

        bool acceptParenExpression(TIntermTyped*&);

        bool acceptExpression(TIntermTyped*&);

        bool acceptInitializer(TIntermTyped*&);

        bool acceptAssignmentExpression(TIntermTyped*&);

        bool acceptConditionalExpression(TIntermTyped*&);

        bool acceptBinaryExpression(TIntermTyped*&, PrecedenceLevel);

        bool acceptUnaryExpression(TIntermTyped*&);

        bool acceptPostfixExpression(TIntermTyped*&);

        bool acceptConstructor(TIntermTyped*&);

        bool acceptFunctionCall(const TSourceLoc&, TString& name, TIntermTyped*&, TIntermTyped* objectBase);

        bool acceptArguments(TFunction*, TIntermTyped*&);

        bool acceptLiteral(TIntermTyped*&);

        bool acceptSimpleStatement(TIntermNode*&);

        bool acceptCompoundStatement(TIntermNode*&);

        bool acceptScopedStatement(TIntermNode*&);

        bool acceptScopedCompoundStatement(TIntermNode*&);

        bool acceptStatement(TIntermNode*&);

        bool acceptNestedStatement(TIntermNode*&);

        void acceptAttributes(TAttributes&);

        bool acceptSelectionStatement(TIntermNode*&, const TAttributes&);

        bool acceptSwitchStatement(TIntermNode*&, const TAttributes&);

        bool acceptIterationStatement(TIntermNode*&, const TAttributes&);

        bool acceptJumpStatement(TIntermNode*&);

        bool acceptCaseLabel(TIntermNode*&);

        bool acceptDefaultLabel(TIntermNode*&);

        void acceptArraySpecifier(TArraySizes*&);

        bool acceptPostDecls(TQualifier&);

        bool acceptDefaultParameterDeclaration(const TType&, TIntermTyped*&);

        bool captureBlockTokens(TVector<HlslToken>& tokens);

        const char* getTypeString(EHlslTokenClass tokenClass) const;

        HlslParseContext& parseContext;  // state of parsing and helper functions for building the intermediate

        TIntermediate& intermediate;     // the final product, the intermediate representation, includes the AST

        bool typeIdentifiers;            // shader uses some types as identifiers

        TIntermNode* unitNode;

    };

} // end namespace glslang

#endif // HLSLGRAMMAR_H_