[tint] Add a diag::List to tint::Failure

Use this to describe _why_ the function failed.

Use this in most places that currently errors with std::string.
This preserves the diagnostic metadata, which would otherwise get baked into a string.

Remove Diagnostic::code. It was never used, and is just consuming memory.

Make Diagnostic use tint::Vector instead of std::vector.

Add some magic so that 'operator<<(STREAM, Failure)' can be used with unformattable SUCCESS / FAILURE types.
Simplifies test that check for success.

Change-Id: I2e474c5387c3fbe68cb6b6c48b123d2597ef82e6
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/152546
Kokoro: Kokoro <[email protected]>
Reviewed-by: dan sinclair <[email protected]>

Author: ben-clayton

src/dawn/native/CompilationMessages.cpp

@@ -148,11 +148,7 @@ MaybeError OwnedCompilationMessages::AddMessage(const tint::diag::Diagnostic& di
                                            fileStart + offsetInBytes, lengthInBytes)));
     }
 
-    if (diagnostic.code) {
-        mMessageStrings.push_back(std::string(diagnostic.code) + ": " + diagnostic.message);
-    } else {
-        mMessageStrings.push_back(diagnostic.message);
-    }
+    mMessageStrings.push_back(diagnostic.message);
 
     mMessages.push_back({nullptr, nullptr, tintSeverityToMessageType(diagnostic.severity), lineNum,
                          linePosInBytes, offsetInBytes, lengthInBytes, linePosInUTF16,

src/dawn/native/d3d/ShaderUtils.cpp

@@ -254,7 +254,8 @@ MaybeError TranslateToHLSL(d3d::HlslCompilationRequest r,
 
     TRACE_EVENT0(tracePlatform.UnsafeGetValue(), General, "tint::hlsl::writer::Generate");
     auto result = tint::hlsl::writer::Generate(transformedProgram, options);
-    DAWN_INVALID_IF(!result, "An error occured while generating HLSL: %s", result.Failure());
+    DAWN_INVALID_IF(!result, "An error occurred while generating HLSL:\n%s",
+                    result.Failure().reason.str());
 
     compiledShader->usesVertexIndex = usesVertexIndex;
     compiledShader->usesInstanceIndex = usesInstanceIndex;

src/dawn/native/metal/ShaderModuleMTL.mm

@@ -281,8 +281,8 @@
 
             TRACE_EVENT0(r.platform.UnsafeGetValue(), General, "tint::msl::writer::Generate");
             auto result = tint::msl::writer::Generate(program, options);
-            DAWN_INVALID_IF(!result, "An error occured while generating MSL: %s.",
-                            result.Failure());
+            DAWN_INVALID_IF(!result, "An error occurred while generating MSL:\n%s",
+                            result.Failure().reason.str());
 
             // Metal uses Clang to compile the shader as C++14. Disable everything in the -Wall
             // category. -Wunused-variable in particular comes up a lot in generated code, and some

src/dawn/native/opengl/ShaderModuleGL.cpp

@@ -299,8 +299,8 @@ ResultOrError<GLuint> ShaderModule::CompileShader(
             tintOptions.texture_builtins_from_uniform = r.textureBuiltinsFromUniform;
 
             auto result = tint::glsl::writer::Generate(program, tintOptions, r.entryPointName);
-            DAWN_INVALID_IF(!result, "An error occured while generating GLSL: %s.",
-                            result.Failure());
+            DAWN_INVALID_IF(!result, "An error occurred while generating GLSL:\n%s",
+                            result.Failure().reason.str());
 
             return GLSLCompilation{{std::move(result->glsl), needsPlaceholderSampler,
                                     result->needs_internal_uniform_buffer,

src/dawn/native/vulkan/ShaderModuleVk.cpp

@@ -359,8 +359,8 @@ ResultOrError<ShaderModule::ModuleAndSpirv> ShaderModule::GetHandleAndSpirv(
 
             TRACE_EVENT0(r.platform.UnsafeGetValue(), General, "tint::spirv::writer::Generate()");
             auto tintResult = tint::spirv::writer::Generate(program, options);
-            DAWN_INVALID_IF(!tintResult, "An error occured while generating SPIR-V: %s.",
-                            tintResult.Failure());
+            DAWN_INVALID_IF(!tintResult, "An error occurred while generating SPIR-V\n%s",
+                            tintResult.Failure().reason.str());
 
             CompiledSpirv result;
             result.spirv = std::move(tintResult.Get().spirv);

src/dawn/tests/mocks/platform/CachingInterfaceMock.h

@@ -34,7 +34,7 @@
         EXPECT_EQ(N, after - before);         \
     } while (0)
 
-// Check that |HitN| cache hits occured, and |AddN| entries were added.
+// Check that |HitN| cache hits occurred, and |AddN| entries were added.
 // Usage: EXPECT_CACHE_STATS(myMockCache, Hit(42), Add(3), ...)
 // Hit / Add help readability, and enforce the args are passed correctly in the expected order.
 #define EXPECT_CACHE_STATS(cache, HitN, AddN, statement)                    \

src/dawn/tests/unittests/native/CommandBufferEncodingTests.cpp

@@ -274,7 +274,7 @@ TEST_F(CommandBufferEncodingTests, ComputePassEncoderIndirectDispatchStateRestor
 }
 
 // Test that after restoring state, it is fully applied to the state tracker
-// and does not leak state changes that occured between a snapshot and the
+// and does not leak state changes that occurred between a snapshot and the
 // state restoration.
 TEST_F(CommandBufferEncodingTests, StateNotLeakedAfterRestore) {
     wgpu::CommandEncoder encoder = device.CreateCommandEncoder();

src/tint/api/tint.cc

@@ -58,7 +58,7 @@ void Initialize() {
     tint::Program::printer = [](const tint::Program& program) {
         auto result = wgsl::writer::Generate(program, {});
         if (!result) {
-            return "error: " + result.Failure();
+            return result.Failure().reason.str();
         }
         return result->wgsl;
     };

src/tint/cmd/bench/main_bench.cc

@@ -109,7 +109,7 @@ std::variant<tint::Source::File, Error> LoadInputFile(std::string name) {
             }
             auto result = tint::wgsl::writer::Generate(program, {});
             if (!result) {
-                return Error{result.Failure()};
+                return Error{result.Failure().reason.str()};
             }
             return tint::Source::File(path, result->wgsl);
         }

src/tint/cmd/tint/main.cc

@@ -400,9 +400,9 @@ of the hash codes in the comma separated list of hashes)");
         options.ShowHelp(std::cout);
     };
 
-    auto result = options.Parse(std::cerr, arguments);
+    auto result = options.Parse(arguments);
     if (!result) {
-        std::cerr << std::endl;
+        std::cerr << result.Failure() << std::endl;
         show_usage();
         return false;
     }