blob: 55ab4cc06fa4d3975d6d678d724e68c1b88ce21c [file] [log] [blame]
// Copyright 2020 The Tint Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SRC_TINT_LANG_HLSL_WRITER_AST_PRINTER_HELPER_TEST_H_
#define SRC_TINT_LANG_HLSL_WRITER_AST_PRINTER_HELPER_TEST_H_
#include <memory>
#include <string>
#include <utility>
#include "gtest/gtest.h"
#include "src/tint/lang/hlsl/writer/ast_printer/ast_printer.h"
#include "src/tint/lang/hlsl/writer/common/options.h"
#include "src/tint/lang/wgsl/ast/transform/manager.h"
#include "src/tint/lang/wgsl/ast/transform/renamer.h"
#include "src/tint/lang/wgsl/resolver/resolve.h"
namespace tint::hlsl::writer {
/// Helper class for testing
template <typename BODY>
class TestHelperBase : public BODY, public ProgramBuilder {
public:
TestHelperBase() = default;
~TestHelperBase() override = default;
/// @returns the default generator options for SanitizeAndBuild(), if no explicit options are
/// provided.
static Options DefaultOptions() {
Options opts;
opts.disable_robustness = true;
return opts;
}
/// Builds the program and returns a ASTPrinter from the program.
/// @note The generator is only built once. Multiple calls to Build() will
/// return the same ASTPrinter without rebuilding.
/// @return the built generator
ASTPrinter& Build() {
if (gen_) {
return *gen_;
}
[&] {
ASSERT_TRUE(IsValid()) << "Builder program is not valid\n" << Diagnostics().str();
}();
program = std::make_unique<Program>(resolver::Resolve(*this));
[&] { ASSERT_TRUE(program->IsValid()) << program->Diagnostics().str(); }();
gen_ = std::make_unique<ASTPrinter>(*program);
return *gen_;
}
/// Builds the program, runs the program through the HLSL sanitizer
/// and returns a ASTPrinter from the sanitized program.
/// @param options The HLSL generator options.
/// @note The generator is only built once. Multiple calls to Build() will
/// return the same ASTPrinter without rebuilding.
/// @return the built generator
ASTPrinter& SanitizeAndBuild(const Options& options = DefaultOptions()) {
if (gen_) {
return *gen_;
}
[&] {
ASSERT_TRUE(IsValid()) << "Builder program is not valid\n" << Diagnostics().str();
}();
program = std::make_unique<Program>(resolver::Resolve(*this));
[&] { ASSERT_TRUE(program->IsValid()) << program->Diagnostics().str(); }();
auto sanitized_result = Sanitize(*program, options);
[&] {
ASSERT_TRUE(sanitized_result.program.IsValid())
<< sanitized_result.program.Diagnostics().str();
}();
ast::transform::Manager transform_manager;
ast::transform::DataMap transform_data;
ast::transform::DataMap outputs;
transform_data.Add<ast::transform::Renamer::Config>(
ast::transform::Renamer::Target::kHlslKeywords,
/* preserve_unicode */ true);
transform_manager.Add<tint::ast::transform::Renamer>();
auto result = transform_manager.Run(sanitized_result.program, transform_data, outputs);
[&] { ASSERT_TRUE(result.IsValid()) << result.Diagnostics().str(); }();
*program = std::move(result);
gen_ = std::make_unique<ASTPrinter>(*program);
return *gen_;
}
/// The program built with a call to Build()
std::unique_ptr<Program> program;
private:
std::unique_ptr<ASTPrinter> gen_;
};
/// TestHelper the the base class for HLSL writer unit tests.
/// Use this form when you don't need to template any further.
using TestHelper = TestHelperBase<testing::Test>;
/// TestParamHelper the the base class for HLSL unit tests that take a templated
/// parameter.
template <typename T>
using TestParamHelper = TestHelperBase<testing::TestWithParam<T>>;
} // namespace tint::hlsl::writer
#endif // SRC_TINT_LANG_HLSL_WRITER_AST_PRINTER_HELPER_TEST_H_