//
// Copyright (c) 2019 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// TranslatorMetal:
//   A GLSL-based translator that outputs shaders that fit GL_KHR_vulkan_glsl.
//   It takes into account some considerations for Metal backend also.
//   The shaders are then fed into glslang to spit out SPIR-V (libANGLE-side).
//   See: https://www.khronos.org/registry/vulkan/specs/misc/GL_KHR_vulkan_glsl.txt
//
//   The SPIR-V will then be translated to Metal Shading Language later in Metal backend.
//

#ifndef LIBANGLE_RENDERER_METAL_TRANSLATORMETAL_H_
#define LIBANGLE_RENDERER_METAL_TRANSLATORMETAL_H_

#include "compiler/translator/TranslatorVulkan.h"
#include "compiler/translator/tree_util/DriverUniform.h"
#include "compiler/translator/tree_util/FlipRotateSpecConst.h"

namespace sh
{

class DriverUniformMetal : public DriverUniform
{
  public:
    DriverUniformMetal() : DriverUniform() {}
    ~DriverUniformMetal() override {}

    TIntermBinary *getFlipXYRef() const;
    TIntermBinary *getNegFlipXYRef() const;
    TIntermSwizzle *getNegFlipYRef() const;
    TIntermBinary *getCoverageMaskFieldRef() const;

  protected:
    TFieldList *createUniformFields(TSymbolTable *symbolTable) const override;
};

// TODO: http://anglebug.com/5339 Implement it using actual specialization constant. For now we are
// redirecting to driver uniforms
class FlipRotateSpecConstMetal : public FlipRotateSpecConst
{
  public:
    FlipRotateSpecConstMetal(DriverUniformMetal *driverUniform)
        : FlipRotateSpecConst(), mDriverUniform(driverUniform)
    {}
    ~FlipRotateSpecConstMetal() override {}

    TIntermTyped *getFlipXY() override;
    TIntermTyped *getNegFlipXY() override;
    TIntermTyped *getFlipY() override;
    TIntermTyped *getNegFlipY() override;

    void generateSymbol(TSymbolTable *symbolTable) override {}
    void outputLayoutString(TInfoSinkBase &sink) const override {}

  private:
    DriverUniformMetal *mDriverUniform;
};

class TranslatorMetal : public TranslatorVulkan
{
  public:
    TranslatorMetal(sh::GLenum type, ShShaderSpec spec);

  protected:
    ANGLE_NO_DISCARD bool translate(TIntermBlock *root,
                                    ShCompileOptions compileOptions,
                                    PerformanceDiagnostics *perfDiagnostics) override;

    ANGLE_NO_DISCARD bool transformDepthBeforeCorrection(
        TIntermBlock *root,
        const DriverUniform *driverUniforms) override;

    ANGLE_NO_DISCARD bool insertSampleMaskWritingLogic(TIntermBlock *root,
                                                       const DriverUniformMetal *driverUniforms);
    ANGLE_NO_DISCARD bool insertRasterizerDiscardLogic(TIntermBlock *root);
};

}  // namespace sh

#endif /* LIBANGLE_RENDERER_METAL_TRANSLATORMETAL_H_ */
