// Copyright 2023 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the copyright holder 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 HOLDER 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 SRC_TINT_LANG_MSL_WRITER_HELPER_TEST_H_
#define SRC_TINT_LANG_MSL_WRITER_HELPER_TEST_H_

#include <iostream>
#include <string>

#include "gtest/gtest.h"
#include "src/tint/lang/core/ir/builder.h"
#include "src/tint/lang/core/ir/validator.h"
#include "src/tint/lang/msl/validate/validate.h"
#include "src/tint/lang/msl/writer/printer/printer.h"
#include "src/tint/lang/msl/writer/writer.h"

namespace tint::msl::writer {

/// Metal header declaration
constexpr auto kMetalHeader = R"(#include <metal_stdlib>
using namespace metal;
)";

/// Metal array declaration
constexpr auto kMetalArray = R"(
template<typename T, size_t N>
struct tint_array {
  const constant T& operator[](size_t i) const constant { return elements[i]; }
  device T& operator[](size_t i) device { return elements[i]; }
  const device T& operator[](size_t i) const device { return elements[i]; }
  thread T& operator[](size_t i) thread { return elements[i]; }
  const thread T& operator[](size_t i) const thread { return elements[i]; }
  threadgroup T& operator[](size_t i) threadgroup { return elements[i]; }
  const threadgroup T& operator[](size_t i) const threadgroup { return elements[i]; }
  T elements[N];
};
)";

/// Base helper class for testing the MSL writer implementation.
template <typename BASE>
class MslWriterTestHelperBase : public BASE {
  public:
    /// The test module.
    core::ir::Module mod;
    /// The test builder.
    core::ir::Builder b{mod};
    /// The type manager.
    core::type::Manager& ty{mod.Types()};

  protected:
    /// Generated MSL
    Output output_;

    /// Run the writer on the IR module and validate the result.
    /// @param options the writer options
    /// @returns true if generation and validation succeeded
    Result<SuccessType> Generate(
        Options options = {},
        validate::MslVersion msl_version = validate::MslVersion::kMsl_2_3) {
        mod.enable_validation_asserts = true;

        if (options.entry_point_name.empty()) {
            options.entry_point_name = "entry";
        }

        auto result = writer::Generate(mod, options);
        TINT_CHECK_RESULT(result);
        output_ = result.Get();

        return Validate(msl_version);
    }

    /// Run the printer on the MSL IR module and validate the result.
    /// @param options the writer options
    /// @returns true if generation and validation succeeded
    Result<SuccessType> Print(Options options = {},
                              validate::MslVersion msl_version = validate::MslVersion::kMsl_2_3) {
        auto result = writer::Print(mod, options);
        TINT_CHECK_RESULT(result);
        output_ = result.Get();

        return Validate(msl_version);
    }

    /// Validate the output.
    /// @param msl_version the MSL version to validate against
    /// @returns true if validation succeeded
    Result<SuccessType> Validate([[maybe_unused]] validate::MslVersion msl_version) {
#if TINT_BUILD_IS_MAC
        TINT_CHECK_RESULT(validate::ValidateUsingMetal(output_.msl, msl_version));
#endif
        return Success;
    }

    /// @returns the metal header string
    std::string MetalHeader() const { return kMetalHeader; }
    /// @return the metal array string
    std::string MetalArray() const { return kMetalArray; }
};

/// Printer tests
using MslWriterTest = MslWriterTestHelperBase<testing::Test>;

/// Printer param tests
template <typename T>
using MslWriterTestWithParam = MslWriterTestHelperBase<testing::TestWithParam<T>>;

}  // namespace tint::msl::writer

#endif  // SRC_TINT_LANG_MSL_WRITER_HELPER_TEST_H_
