Remove usage of deprecated std::codecvt

It was causing issues building Dawn in Skia. The error message helpfully
suggests using WideCharToMultiByte instead.

Bug: dawn:706
Change-Id: I87dee1192123f49cc8e7243a29df446389454df4
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/44560
Commit-Queue: Corentin Wallez <cwallez@chromium.org>
Auto-Submit: Corentin Wallez <cwallez@chromium.org>
Reviewed-by: Ben Clayton <bclayton@google.com>
Reviewed-by: Austin Eng <enga@chromium.org>

src/common/BUILD.gn

@@ -198,7 +198,6 @@ if (is_win || is_linux || is_chromeos || is_mac || is_fuchsia || is_android) {
       "ityp_stack_vec.h",
       "ityp_vector.h",
       "vulkan_platform.h",
-      "windows_with_undefs.h",
       "xlib_with_undefs.h",
     ]
 
@@ -207,6 +206,14 @@ if (is_win || is_linux || is_chromeos || is_mac || is_fuchsia || is_android) {
       "${dawn_root}/src/dawn:dawn_headers",
       "${dawn_root}/src/dawn:dawncpp_headers",
     ]
+
+    if (is_win) {
+      sources += [
+        "WindowsUtils.cpp",
+        "WindowsUtils.h",
+        "windows_with_undefs.h",
+      ]
+    }
     if (dawn_enable_vulkan) {
       public_deps = [ "${dawn_root}/third_party/khronos:vulkan_headers" ]
     }

src/common/CMakeLists.txt

@@ -61,9 +61,17 @@ target_sources(dawn_common PRIVATE
     "ityp_stack_vec.h"
     "ityp_vector.h"
     "vulkan_platform.h"
-    "windows_with_undefs.h"
     "xlib_with_undefs.h"
 )
+
+if (WIN32)
+    target_sources(dawn_common PRIVATE
+        "WindowsUtils.cpp"
+        "WindowsUtils.h"
+        "windows_with_undefs.h"
+    )
+endif()
+
 target_link_libraries(dawn_common PRIVATE dawn_internal_config)
 
 # TODO Android Log support

src/common/WindowsUtils.cpp

@@ -0,0 +1,32 @@
+// 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.
+
+#include "common/WindowsUtils.h"
+
+#include "common/windows_with_undefs.h"
+
+#include <memory>
+
+std::string WCharToUTF8(const wchar_t* input) {
+    // The -1 argument asks WideCharToMultiByte to use the null terminator to know the size of
+    // input. It will return a size that includes the null terminator.
+    int requiredSize = WideCharToMultiByte(CP_UTF8, 0, input, -1, nullptr, 0, nullptr, nullptr);
+
+    // When we can use C++17 this can be changed to use string.data() instead.
+    std::unique_ptr<char[]> result = std::make_unique<char[]>(requiredSize);
+    WideCharToMultiByte(CP_UTF8, 0, input, -1, result.get(), requiredSize, nullptr, nullptr);
+
+    // This will allocate the returned std::string and then destroy result.
+    return std::string(result.get(), result.get() + (requiredSize - 1));
+}

src/common/WindowsUtils.h

@@ -0,0 +1,22 @@
+// 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 COMMON_WINDOWSUTILS_H_
+#define COMMON_WINDOWSUTILS_H_
+
+#include <string>
+
+std::string WCharToUTF8(const wchar_t* input);
+
+#endif  // COMMON_WINDOWSUTILS_H_

src/dawn_native/d3d12/AdapterD3D12.cpp

@@ -15,28 +15,17 @@
 #include "dawn_native/d3d12/AdapterD3D12.h"
 
 #include "common/Constants.h"
+#include "common/WindowsUtils.h"
 #include "dawn_native/Instance.h"
 #include "dawn_native/d3d12/BackendD3D12.h"
 #include "dawn_native/d3d12/D3D12Error.h"
 #include "dawn_native/d3d12/DeviceD3D12.h"
 #include "dawn_native/d3d12/PlatformFunctions.h"
 
-#include <locale>
 #include <sstream>
 
 namespace dawn_native { namespace d3d12 {
 
-    // utility wrapper to adapt locale-bound facets for wstring/wbuffer convert
-    template <class Facet>
-    struct DeletableFacet : Facet {
-        template <class... Args>
-        DeletableFacet(Args&&... args) : Facet(std::forward<Args>(args)...) {
-        }
-
-        ~DeletableFacet() {
-        }
-    };
-
     Adapter::Adapter(Backend* backend, ComPtr<IDXGIAdapter3> hardwareAdapter)
         : AdapterBase(backend->GetInstance(), wgpu::BackendType::D3D12),
           mHardwareAdapter(hardwareAdapter),
@@ -80,6 +69,7 @@ namespace dawn_native { namespace d3d12 {
 
         mPCIInfo.deviceId = adapterDesc.DeviceId;
         mPCIInfo.vendorId = adapterDesc.VendorId;
+        mPCIInfo.name = WCharToUTF8(adapterDesc.Description);
 
         DAWN_TRY_ASSIGN(mDeviceInfo, GatherDeviceInfo(*this));
 
@@ -90,11 +80,6 @@ namespace dawn_native { namespace d3d12 {
                                                : wgpu::AdapterType::DiscreteGPU;
         }
 
-        // Get the adapter's name as a UTF8 string.
-        std::wstring_convert<DeletableFacet<std::codecvt<wchar_t, char, std::mbstate_t>>> converter(
-            "Error converting");
-        mPCIInfo.name = converter.to_bytes(adapterDesc.Description);
-
         // Convert the adapter's D3D12 driver version to a readable string like "24.21.13.9793".
         LARGE_INTEGER umdVersion;
         if (mHardwareAdapter->CheckInterfaceSupport(__uuidof(IDXGIDevice), &umdVersion) !=

src/tests/BUILD.gn

@@ -238,6 +238,10 @@ test("dawn_unittests") {
     "unittests/wire/WireWGPUDevicePropertiesTests.cpp",
   ]
 
+  if (is_win) {
+    sources += [ "unittests/WindowsUtilsTests.cpp" ]
+  }
+
   if (dawn_enable_d3d12) {
     sources += [ "unittests/d3d12/CopySplitTests.cpp" ]
   }

src/tests/unittests/WindowsUtilsTests.cpp

@@ -0,0 +1,34 @@
+// 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.
+
+#include <gtest/gtest.h>
+
+#include "common/WindowsUtils.h"
+
+TEST(WindowsUtilsTests, WCharToUTF8) {
+    // Test the empty string
+    ASSERT_EQ("", WCharToUTF8(L""));
+
+    // Test ASCII characters
+    ASSERT_EQ("abc", WCharToUTF8(L"abc"));
+
+    // Test ASCII characters
+    ASSERT_EQ("abc", WCharToUTF8(L"abc"));
+
+    // Test two-byte utf8 character
+    ASSERT_EQ("\xd1\x90", WCharToUTF8(L"\x450"));
+
+    // Test three-byte utf8 codepoint
+    ASSERT_EQ("\xe1\x81\x90", WCharToUTF8(L"\x1050"));
+}