From 3ee8c37cb6bf97775afe67e81a0b200e4661f0ec Mon Sep 17 00:00:00 2001 From: James Price Date: Fri, 9 Apr 2021 19:58:58 +0000 Subject: [PATCH] [wgsl-reader] Deprecate old syntax for entry point IO Bug: tint:697 Change-Id: Ia6e066678753ef12dc41a753ba33c924bb662148 Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/47480 Auto-Submit: James Price Reviewed-by: Ben Clayton Commit-Queue: James Price --- src/reader/wgsl/parser_impl.cc | 15 +++- .../wgsl/parser_impl_global_decl_test.cc | 10 +-- .../parser_impl_global_variable_decl_test.cc | 80 ++++++++++++++----- 3 files changed, 80 insertions(+), 25 deletions(-) diff --git a/src/reader/wgsl/parser_impl.cc b/src/reader/wgsl/parser_impl.cc index aa070f93d0..c873095957 100644 --- a/src/reader/wgsl/parser_impl.cc +++ b/src/reader/wgsl/parser_impl.cc @@ -461,9 +461,22 @@ Maybe ParserImpl::variable_decl() { auto explicit_sc = variable_storage_decoration(); if (explicit_sc.errored) return Failure::kErrored; - if (explicit_sc.matched) + if (explicit_sc.matched) { sc = explicit_sc.value; + // TODO(crbug.com/tint/697): Remove this. + if (sc == ast::StorageClass::kInput) { + deprecated(explicit_sc.source, + "use an entry point parameter instead of a variable in the " + "`in` storage class"); + } + if (sc == ast::StorageClass::kOutput) { + deprecated(explicit_sc.source, + "use an entry point return value instead of a variable in the " + "`out` storage class"); + } + } + auto decl = expect_variable_ident_decl("variable declaration"); if (decl.errored) return Failure::kErrored; diff --git a/src/reader/wgsl/parser_impl_global_decl_test.cc b/src/reader/wgsl/parser_impl_global_decl_test.cc index 6c187e1eb8..afef34e7ba 100644 --- a/src/reader/wgsl/parser_impl_global_decl_test.cc +++ b/src/reader/wgsl/parser_impl_global_decl_test.cc @@ -26,7 +26,7 @@ TEST_F(ParserImplTest, GlobalDecl_Semicolon) { } TEST_F(ParserImplTest, GlobalDecl_GlobalVariable) { - auto p = parser("var a : vec2 = vec2(1, 2);"); + auto p = parser("var a : vec2 = vec2(1, 2);"); p->expect_global_decl(); ASSERT_FALSE(p->has_error()) << p->error(); @@ -38,17 +38,17 @@ TEST_F(ParserImplTest, GlobalDecl_GlobalVariable) { } TEST_F(ParserImplTest, GlobalDecl_GlobalVariable_Invalid) { - auto p = parser("var a : vec2;"); + auto p = parser("var a : vec2;"); p->expect_global_decl(); ASSERT_TRUE(p->has_error()); - EXPECT_EQ(p->error(), "1:19: unknown constructed type 'invalid'"); + EXPECT_EQ(p->error(), "1:23: unknown constructed type 'invalid'"); } TEST_F(ParserImplTest, GlobalDecl_GlobalVariable_MissingSemicolon) { - auto p = parser("var a : vec2"); + auto p = parser("var a : vec2"); p->expect_global_decl(); ASSERT_TRUE(p->has_error()); - EXPECT_EQ(p->error(), "1:23: expected ';' for variable declaration"); + EXPECT_EQ(p->error(), "1:27: expected ';' for variable declaration"); } TEST_F(ParserImplTest, GlobalDecl_GlobalConstant) { diff --git a/src/reader/wgsl/parser_impl_global_variable_decl_test.cc b/src/reader/wgsl/parser_impl_global_variable_decl_test.cc index 7c2df95bb9..b175eea37c 100644 --- a/src/reader/wgsl/parser_impl_global_variable_decl_test.cc +++ b/src/reader/wgsl/parser_impl_global_variable_decl_test.cc @@ -20,7 +20,7 @@ namespace wgsl { namespace { TEST_F(ParserImplTest, GlobalVariableDecl_WithoutConstructor) { - auto p = parser("var a : f32"); + auto p = parser("var a : f32"); auto decos = p->decoration_list(); EXPECT_FALSE(decos.errored); EXPECT_FALSE(decos.matched); @@ -32,18 +32,18 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithoutConstructor) { EXPECT_EQ(e->symbol(), p->builder().Symbols().Get("a")); EXPECT_TRUE(e->declared_type()->Is()); - EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kOutput); + EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kPrivate); EXPECT_EQ(e->source().range.begin.line, 1u); - EXPECT_EQ(e->source().range.begin.column, 10u); + EXPECT_EQ(e->source().range.begin.column, 14u); EXPECT_EQ(e->source().range.end.line, 1u); - EXPECT_EQ(e->source().range.end.column, 11u); + EXPECT_EQ(e->source().range.end.column, 15u); ASSERT_EQ(e->constructor(), nullptr); } TEST_F(ParserImplTest, GlobalVariableDecl_WithConstructor) { - auto p = parser("var a : f32 = 1."); + auto p = parser("var a : f32 = 1."); auto decos = p->decoration_list(); EXPECT_FALSE(decos.errored); EXPECT_FALSE(decos.matched); @@ -55,12 +55,12 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithConstructor) { EXPECT_EQ(e->symbol(), p->builder().Symbols().Get("a")); EXPECT_TRUE(e->declared_type()->Is()); - EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kOutput); + EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kPrivate); EXPECT_EQ(e->source().range.begin.line, 1u); - EXPECT_EQ(e->source().range.begin.column, 10u); + EXPECT_EQ(e->source().range.begin.column, 14u); EXPECT_EQ(e->source().range.end.line, 1u); - EXPECT_EQ(e->source().range.end.column, 11u); + EXPECT_EQ(e->source().range.end.column, 15u); ASSERT_NE(e->constructor(), nullptr); ASSERT_TRUE(e->constructor()->Is()); @@ -68,7 +68,7 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithConstructor) { } TEST_F(ParserImplTest, GlobalVariableDecl_WithDecoration) { - auto p = parser("[[binding(2), group(1)]] var a : f32"); + auto p = parser("[[binding(2), group(1)]] var a : f32"); auto decos = p->decoration_list(); EXPECT_FALSE(decos.errored); EXPECT_TRUE(decos.matched); @@ -81,12 +81,12 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithDecoration) { EXPECT_EQ(e->symbol(), p->builder().Symbols().Get("a")); ASSERT_NE(e->declared_type(), nullptr); EXPECT_TRUE(e->declared_type()->Is()); - EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kOutput); + EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kUniform); EXPECT_EQ(e->source().range.begin.line, 1u); - EXPECT_EQ(e->source().range.begin.column, 35u); + EXPECT_EQ(e->source().range.begin.column, 39u); EXPECT_EQ(e->source().range.end.line, 1u); - EXPECT_EQ(e->source().range.end.column, 36u); + EXPECT_EQ(e->source().range.end.column, 40u); ASSERT_EQ(e->constructor(), nullptr); @@ -97,7 +97,7 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithDecoration) { } TEST_F(ParserImplTest, GlobalVariableDecl_WithDecoration_MulitpleGroups) { - auto p = parser("[[binding(2)]] [[group(1)]] var a : f32"); + auto p = parser("[[binding(2)]] [[group(1)]] var a : f32"); auto decos = p->decoration_list(); EXPECT_FALSE(decos.errored); EXPECT_TRUE(decos.matched); @@ -111,12 +111,12 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithDecoration_MulitpleGroups) { EXPECT_EQ(e->symbol(), p->builder().Symbols().Get("a")); ASSERT_NE(e->declared_type(), nullptr); EXPECT_TRUE(e->declared_type()->Is()); - EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kOutput); + EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kUniform); EXPECT_EQ(e->source().range.begin.line, 1u); - EXPECT_EQ(e->source().range.begin.column, 38u); + EXPECT_EQ(e->source().range.begin.column, 42u); EXPECT_EQ(e->source().range.end.line, 1u); - EXPECT_EQ(e->source().range.end.column, 39u); + EXPECT_EQ(e->source().range.end.column, 43u); ASSERT_EQ(e->constructor(), nullptr); @@ -127,7 +127,7 @@ TEST_F(ParserImplTest, GlobalVariableDecl_WithDecoration_MulitpleGroups) { } TEST_F(ParserImplTest, GlobalVariableDecl_InvalidDecoration) { - auto p = parser("[[binding()]] var a : f32"); + auto p = parser("[[binding()]] var a : f32"); auto decos = p->decoration_list(); EXPECT_TRUE(decos.errored); EXPECT_FALSE(decos.matched); @@ -143,7 +143,7 @@ TEST_F(ParserImplTest, GlobalVariableDecl_InvalidDecoration) { } TEST_F(ParserImplTest, GlobalVariableDecl_InvalidConstExpr) { - auto p = parser("var a : f32 = if (a) {}"); + auto p = parser("var a : f32 = if (a) {}"); auto decos = p->decoration_list(); EXPECT_FALSE(decos.errored); EXPECT_FALSE(decos.matched); @@ -152,7 +152,7 @@ TEST_F(ParserImplTest, GlobalVariableDecl_InvalidConstExpr) { EXPECT_TRUE(e.errored); EXPECT_FALSE(e.matched); EXPECT_EQ(e.value, nullptr); - EXPECT_EQ(p->error(), "1:20: unable to parse constant literal"); + EXPECT_EQ(p->error(), "1:24: unable to parse constant literal"); } TEST_F(ParserImplTest, GlobalVariableDecl_InvalidVariableDecl) { @@ -200,6 +200,48 @@ TEST_F(ParserImplTest, GlobalVariableDecl_TextureImplicitStorageClass) { EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kUniformConstant); } +TEST_F(ParserImplTest, GlobalVariableDecl_StorageClassIn_Deprecated) { + auto p = parser("[[location(0)]] var a : f32"); + auto f = p->function_header(); + auto decos = p->decoration_list(); + EXPECT_FALSE(decos.errored); + EXPECT_TRUE(decos.matched); + auto e = p->global_variable_decl(decos.value); + ASSERT_FALSE(p->has_error()) << p->error(); + + EXPECT_EQ(e->symbol(), p->builder().Symbols().Get("a")); + EXPECT_TRUE(e->declared_type()->Is()); + EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kInput); + + EXPECT_EQ( + p->builder().Diagnostics().str(), + R"(test.wgsl:1:21 warning: use of deprecated language feature: use an entry point parameter instead of a variable in the `in` storage class +[[location(0)]] var a : f32 + ^^ +)"); +} + +TEST_F(ParserImplTest, GlobalVariableDecl_StorageClassOut_Deprecated) { + auto p = parser("[[location(0)]] var a : f32"); + auto f = p->function_header(); + auto decos = p->decoration_list(); + EXPECT_FALSE(decos.errored); + EXPECT_TRUE(decos.matched); + auto e = p->global_variable_decl(decos.value); + ASSERT_FALSE(p->has_error()) << p->error(); + + EXPECT_EQ(e->symbol(), p->builder().Symbols().Get("a")); + EXPECT_TRUE(e->declared_type()->Is()); + EXPECT_EQ(e->declared_storage_class(), ast::StorageClass::kOutput); + + EXPECT_EQ( + p->builder().Diagnostics().str(), + R"(test.wgsl:1:21 warning: use of deprecated language feature: use an entry point return value instead of a variable in the `out` storage class +[[location(0)]] var a : f32 + ^^^ +)"); +} + } // namespace } // namespace wgsl } // namespace reader