Add utilities for printing Dawn enums and bitmasks
This is a header-only utility so it can be easily included and
used anyhere. Include it in DawnTest.h to automatically pick up
definitions to print test parameters.
Also, work around bot limitations for very-long test names.
Bug: none
Change-Id: I940263ab0a4cc415b06fa04749694f16ff08335c
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/51841
Auto-Submit: Austin Eng <enga@chromium.org>
Reviewed-by: Stephen White <senorblanco@chromium.org>
Commit-Queue: Austin Eng <enga@chromium.org>
diff --git a/generator/templates/webgpu_cpp_print.h b/generator/templates/webgpu_cpp_print.h
new file mode 100644
index 0000000..5434b61
--- /dev/null
+++ b/generator/templates/webgpu_cpp_print.h
@@ -0,0 +1,90 @@
+//* Copyright 2021 The Dawn 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 WEBGPU_CPP_PRINT_H_
+#define WEBGPU_CPP_PRINT_H_
+
+#include "dawn/webgpu_cpp.h"
+
+#include <iomanip>
+#include <ios>
+#include <ostream>
+#include <type_traits>
+
+namespace wgpu {
+
+ {% for type in by_category["enum"] %}
+ template <typename CharT, typename Traits>
+ std::basic_ostream<CharT, Traits>& operator<<(std::basic_ostream<CharT, Traits>& o, {{as_cppType(type.name)}} value) {
+ switch (value) {
+ {% for value in type.values %}
+ case {{as_cppType(type.name)}}::{{as_cppEnum(value.name)}}:
+ o << "{{as_cppType(type.name)}}::{{as_cppEnum(value.name)}}";
+ break;
+ {% endfor %}
+ default:
+ o << "{{as_cppType(type.name)}}::" << std::showbase << std::hex << std::setfill('0') << std::setw(4) << static_cast<typename std::underlying_type<{{as_cppType(type.name)}}>::type>(value);
+ }
+ return o;
+ }
+ {% endfor %}
+
+ {% for type in by_category["bitmask"] %}
+ template <typename CharT, typename Traits>
+ std::basic_ostream<CharT, Traits>& operator<<(std::basic_ostream<CharT, Traits>& o, {{as_cppType(type.name)}} value) {
+ o << "{{as_cppType(type.name)}}::";
+ if (!static_cast<bool>(value)) {
+ {% for value in type.values if value.value == 0 %}
+ // 0 is often explicitly declared as None.
+ o << "{{as_cppEnum(value.name)}}";
+ {% else %}
+ o << std::showbase << std::hex << std::setfill('0') << std::setw(4) << 0;
+ {% endfor %}
+ return o;
+ }
+
+ bool moreThanOneBit = !HasZeroOrOneBits(value);
+ if (moreThanOneBit) {
+ o << "(";
+ }
+
+ bool first = true;
+ {% for value in type.values if value.value != 0 %}
+ if (value & {{as_cppType(type.name)}}::{{as_cppEnum(value.name)}}) {
+ if (!first) {
+ o << "|";
+ }
+ first = false;
+ o << "{{as_cppEnum(value.name)}}";
+ value &= ~{{as_cppType(type.name)}}::{{as_cppEnum(value.name)}};
+ }
+ {% endfor %}
+
+ if (static_cast<bool>(value)) {
+ if (!first) {
+ o << "|";
+ }
+ o << std::showbase << std::hex << std::setfill('0') << std::setw(4) << static_cast<typename std::underlying_type<{{as_cppType(type.name)}}>::type>(value);
+ }
+
+ if (moreThanOneBit) {
+ o << ")";
+ }
+ return o;
+ }
+ {% endfor %}
+
+} // namespace wgpu
+
+#endif // WEBGPU_CPP_PRINT_H_
