dawn-cmake/src/ast/variable_test.cc

// 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.

#include "gtest/gtest-spi.h"
#include "src/ast/constant_id_decoration.h"
#include "src/ast/test_helper.h"

namespace tint {
namespace ast {
namespace {

using VariableTest = TestHelper;

TEST_F(VariableTest, Creation) {
  auto* v = Var("my_var", ty.i32(), StorageClass::kFunction);

  EXPECT_EQ(v->symbol(), Symbol(1));
  EXPECT_EQ(v->declared_storage_class(), StorageClass::kFunction);
  EXPECT_EQ(v->declared_type(), ty.i32());
  EXPECT_EQ(v->source().range.begin.line, 0u);
  EXPECT_EQ(v->source().range.begin.column, 0u);
  EXPECT_EQ(v->source().range.end.line, 0u);
  EXPECT_EQ(v->source().range.end.column, 0u);
}

TEST_F(VariableTest, CreationWithSource) {
  auto* v = Var(
      Source{Source::Range{Source::Location{27, 4}, Source::Location{27, 5}}},
      "i", ty.f32(), StorageClass::kPrivate, nullptr, DecorationList{});

  EXPECT_EQ(v->symbol(), Symbol(1));
  EXPECT_EQ(v->declared_storage_class(), StorageClass::kPrivate);
  EXPECT_EQ(v->declared_type(), ty.f32());
  EXPECT_EQ(v->source().range.begin.line, 27u);
  EXPECT_EQ(v->source().range.begin.column, 4u);
  EXPECT_EQ(v->source().range.end.line, 27u);
  EXPECT_EQ(v->source().range.end.column, 5u);
}

TEST_F(VariableTest, CreationEmpty) {
  auto* v = Var(
      Source{Source::Range{Source::Location{27, 4}, Source::Location{27, 7}}},
      "a_var", ty.i32(), StorageClass::kWorkgroup, nullptr, DecorationList{});

  EXPECT_EQ(v->symbol(), Symbol(1));
  EXPECT_EQ(v->declared_storage_class(), StorageClass::kWorkgroup);
  EXPECT_EQ(v->declared_type(), ty.i32());
  EXPECT_EQ(v->source().range.begin.line, 27u);
  EXPECT_EQ(v->source().range.begin.column, 4u);
  EXPECT_EQ(v->source().range.end.line, 27u);
  EXPECT_EQ(v->source().range.end.column, 7u);
}

TEST_F(VariableTest, Assert_MissingSymbol) {
  EXPECT_FATAL_FAILURE(
      {
        ProgramBuilder b;
        b.Var("", b.ty.i32(), StorageClass::kNone);
      },
      "internal compiler error");
}

TEST_F(VariableTest, Assert_NullType) {
  EXPECT_FATAL_FAILURE(
      {
        ProgramBuilder b;
        b.Var("x", nullptr, StorageClass::kNone);
      },
      "internal compiler error");
}

TEST_F(VariableTest, to_str) {
  auto* v = Var("my_var", ty.f32(), StorageClass::kFunction);
  EXPECT_EQ(str(v), R"(Variable{
  my_var
  function
  __f32
}
)");
}

TEST_F(VariableTest, WithDecorations) {
  auto* var = Var("my_var", ty.i32(), StorageClass::kFunction, nullptr,
                  DecorationList{
                      create<LocationDecoration>(1),
                      create<BuiltinDecoration>(Builtin::kPosition),
                      create<ConstantIdDecoration>(1200),
                  });

  EXPECT_TRUE(var->HasLocationDecoration());
  EXPECT_TRUE(var->HasBuiltinDecoration());
  EXPECT_TRUE(var->HasConstantIdDecoration());

  auto* location = var->GetLocationDecoration();
  ASSERT_NE(nullptr, location);
  EXPECT_EQ(1u, location->value());
}

TEST_F(VariableTest, BindingPoint) {
  auto* var = Var("my_var", ty.i32(), StorageClass::kFunction, nullptr,
                  DecorationList{
                      create<BindingDecoration>(2),
                      create<GroupDecoration>(1),
                  });
  EXPECT_TRUE(var->binding_point());
  ASSERT_NE(var->binding_point().binding, nullptr);
  ASSERT_NE(var->binding_point().group, nullptr);
  EXPECT_EQ(var->binding_point().binding->value(), 2u);
  EXPECT_EQ(var->binding_point().group->value(), 1u);
}

TEST_F(VariableTest, BindingPointoDecorations) {
  auto* var = Var("my_var", ty.i32(), StorageClass::kFunction, nullptr,
                  DecorationList{});
  EXPECT_FALSE(var->binding_point());
  EXPECT_EQ(var->binding_point().group, nullptr);
  EXPECT_EQ(var->binding_point().binding, nullptr);
}

TEST_F(VariableTest, BindingPointMissingGroupDecoration) {
  auto* var = Var("my_var", ty.i32(), StorageClass::kFunction, nullptr,
                  DecorationList{
                      create<BindingDecoration>(2),
                  });
  EXPECT_FALSE(var->binding_point());
  ASSERT_NE(var->binding_point().binding, nullptr);
  EXPECT_EQ(var->binding_point().binding->value(), 2u);
  EXPECT_EQ(var->binding_point().group, nullptr);
}

TEST_F(VariableTest, BindingPointMissingBindingDecoration) {
  auto* var = Var("my_var", ty.i32(), StorageClass::kFunction, nullptr,
                  DecorationList{create<GroupDecoration>(1)});
  EXPECT_FALSE(var->binding_point());
  ASSERT_NE(var->binding_point().group, nullptr);
  EXPECT_EQ(var->binding_point().group->value(), 1u);
  EXPECT_EQ(var->binding_point().binding, nullptr);
}

TEST_F(VariableTest, ConstantId) {
  auto* var = Var("my_var", ty.i32(), StorageClass::kFunction, nullptr,
                  DecorationList{
                      create<ConstantIdDecoration>(1200),
                  });

  EXPECT_EQ(var->constant_id(), 1200u);
}

TEST_F(VariableTest, Decorated_to_str) {
  auto* var = Var("my_var", ty.f32(), StorageClass::kFunction, Expr("expr"),
                  DecorationList{
                      create<BindingDecoration>(2),
                      create<GroupDecoration>(1),
                  });

  EXPECT_EQ(str(var), R"(Variable{
  Decorations{
    BindingDecoration{2}
    GroupDecoration{1}
  }
  my_var
  function
  __f32
  {
    Identifier[not set]{expr}
  }
}
)");
}

}  // namespace
}  // namespace ast
}  // namespace tint