Improve the encoding/decoding to/from system encoding on Windows

runtime/bin/utils_win.cc

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "platform/globals.h"
 #if defined(TARGET_OS_WINDOWS)
 
 #include <errno.h>  // NOLINT
 #include <time.h>  // NOLINT
 
@@ skipping 43 matching lines @@
   set_code(code);
 
   static const int kMaxMessageLength = 256;
   wchar_t message[kMaxMessageLength];
   FormatMessageIntoBuffer(code_, message, kMaxMessageLength);
   char* utf8 = StringUtils::WideToUtf8(message);
   SetMessage(utf8);
   free(utf8);
 }
 
-char* StringUtils::ConsoleStringToUtf8(char* str) {
-  int len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
-  wchar_t* unicode = new wchar_t[len+1];
-  MultiByteToWideChar(CP_ACP, 0, str, -1, unicode, len);
-  unicode[len] = '\0';
-  char* utf8 = StringUtils::WideToUtf8(unicode);
-  delete[] unicode;
+char* StringUtils::ConsoleStringToUtf8(char* str,
+                                       intptr_t len,
+                                       intptr_t* result_len) {
+  int wide_len = MultiByteToWideChar(CP_ACP, 0, str, len, NULL, 0);
+  wchar_t* wide = new wchar_t[wide_len];
+  MultiByteToWideChar(CP_ACP, 0, str, len, wide, wide_len);
+  char* utf8 = StringUtils::WideToUtf8(wide, wide_len, result_len);
+  delete[] wide;

[kustermann, 2015/06/22 11:11:21]

The extra copy is a bit unfortunate :-/

[Lasse Reichstein Nielsen, 2015/06/22 12:08:34]

But probably unavoidable if we want to use the system MultiByteToWideChar code
to decode the current codepage. I don't think there is a MultiByteToMultiByte
function.

   return utf8;
 }
 
-char* StringUtils::Utf8ToConsoleString(char* utf8) {
-  wchar_t* unicode = Utf8ToWide(utf8);
-  int len = WideCharToMultiByte(CP_ACP, 0, unicode, -1, NULL, 0, NULL, NULL);
-  char* ansi = reinterpret_cast<char*>(malloc(len + 1));
-  WideCharToMultiByte(CP_ACP, 0, unicode, -1, ansi, len, NULL, NULL);
-  ansi[len] = '\0';
-  free(unicode);
+char* StringUtils::Utf8ToConsoleString(char* utf8,
+                                       intptr_t len,
+                                       intptr_t* result_len) {
+  intptr_t wide_len;
+  wchar_t* wide = Utf8ToWide(utf8, len, &wide_len);

[kustermann, 2015/06/22 11:11:21]

Maybe qualify with StringUtils:: as you normally do?

[Søren Gjesse, 2015/06/23 11:17:59]

Done.

+  int system_len = WideCharToMultiByte(
+      CP_ACP, 0, wide, wide_len, NULL, 0, NULL, NULL);
+  char* ansi = reinterpret_cast<char*>(malloc(system_len + 1));

[kustermann, 2015/06/22 11:11:21]

Do we not want to handle allocation failures?

Also: It's inconsistent, sometimes 'new type[len]'/delete is used and sometimes
malloc/free

If you always stick to the C++ variants, you don't need to handle NULL return
values AFAIK

[Søren Gjesse, 2015/06/23 11:17:59]

Added a check here. However we don't handle failed allocations in general.
Regarding C++ new failing I think it also returns NULL. We compile with C++
exceptions turned off, so it will probably not throw bad_alloc.

+  WideCharToMultiByte(CP_ACP, 0, wide, wide_len, ansi, system_len, NULL, NULL);
+  ansi[system_len] = '\0';

[Lasse Reichstein Nielsen, 2015/06/22 12:08:34]

Should this only be set when result_len is NULL? 
And not if len is -1 (in that case the terminating NUL is part of the output
already).

[Søren Gjesse, 2015/06/23 11:17:59]

I removed this, as when len is -1 the NUL char is included in the length from
WideCharToMultiByte.

+  free(wide);
+  if (result_len != NULL) {
+    *result_len = system_len;
+  }
   return ansi;
 }
 
-char* StringUtils::WideToUtf8(wchar_t* wide) {
-  int len = WideCharToMultiByte(CP_UTF8, 0, wide, -1, NULL, 0, NULL, NULL);
-  char* utf8 = reinterpret_cast<char*>(malloc(len + 1));
-  WideCharToMultiByte(CP_UTF8, 0, wide, -1, utf8, len, NULL, NULL);
-  utf8[len] = '\0';
+char* StringUtils::WideToUtf8(wchar_t* wide,
+                              intptr_t len,
+                              intptr_t* result_len) {
+  int utf8_len = WideCharToMultiByte(
+      CP_UTF8, 0, wide, len, NULL, 0, NULL, NULL);
+  char* utf8 = reinterpret_cast<char*>(malloc(utf8_len + 1));
+  WideCharToMultiByte(CP_UTF8, 0, wide, len, utf8, utf8_len, NULL, NULL);
+  utf8[utf8_len] = '\0';

[Lasse Reichstein Nielsen, 2015/06/22 12:08:34]

Again, only include the extra NUL if result_len is NULL and len >= 0.

[Søren Gjesse, 2015/06/23 11:17:59]

Removed, see above.

+  if (result_len != NULL) {
+    *result_len = utf8_len;
+  }
   return utf8;
 }
 
 
-wchar_t* StringUtils::Utf8ToWide(char* utf8) {
-  int len = MultiByteToWideChar(CP_UTF8, 0, utf8, -1, NULL, 0);
-  wchar_t* unicode =
-      reinterpret_cast<wchar_t*>(malloc((len + 1) * sizeof(wchar_t)));
-  MultiByteToWideChar(CP_UTF8, 0, utf8, -1, unicode, len);
-  unicode[len] = '\0';
-  return unicode;
+wchar_t* StringUtils::Utf8ToWide(char* utf8,
+                                 intptr_t len,
+                                 intptr_t* result_len) {
+  int wide_len = MultiByteToWideChar(CP_UTF8, 0, utf8, len, NULL, 0);
+  wchar_t* wide =
+      reinterpret_cast<wchar_t*>(malloc((wide_len + 1) * sizeof(wchar_t)));

[kustermann, 2015/06/22 11:11:21]

The distinction between the number-of-bytes/number-of-characters is very subtle.
Why not use 'new wchar_t[wide_len + 1]'.

[Lasse Reichstein Nielsen, 2015/06/22 12:08:34]

Sadly because the function is documented as returning something allocated with
malloc, so there may be existing code freeing it with free.

+  MultiByteToWideChar(CP_UTF8, 0, utf8, len, wide, wide_len);
+  wide[wide_len] = '\0';

[kustermann, 2015/06/22 11:11:21]

Is this common to 0-terminate a 2-byte wide string?

[Søren Gjesse, 2015/06/23 11:17:59]

It is, all the w versions of string functions on Windows that deal with wchar_t
(e.g. wcslen) is using NUL termination.

+  if (result_len != NULL) {
+    *result_len = wide_len;
+  }
+  return wide;
 }
 
-const char* StringUtils::Utf8ToConsoleString(const char* utf8) {
-  return const_cast<const char*>(Utf8ToConsoleString(const_cast<char*>(utf8)));
+const char* StringUtils::Utf8ToConsoleString(
+    const char* utf8, intptr_t len, intptr_t* result_len) {
+  return const_cast<const char*>(
+      Utf8ToConsoleString(const_cast<char*>(utf8), len, result_len));
 }
 
-const char* StringUtils::ConsoleStringToUtf8(const char* str) {
-  return const_cast<const char*>(ConsoleStringToUtf8(const_cast<char*>(str)));
+const char* StringUtils::ConsoleStringToUtf8(
+    const char* str, intptr_t len, intptr_t* result_len) {
+  return const_cast<const char*>(
+      ConsoleStringToUtf8(const_cast<char*>(str), len, result_len));
 }
 
-const char* StringUtils::WideToUtf8(const wchar_t* wide) {
-  return const_cast<const char*>(WideToUtf8(const_cast<wchar_t*>(wide)));
+const char* StringUtils::WideToUtf8(
+    const wchar_t* wide, intptr_t len, intptr_t* result_len) {
+  return const_cast<const char*>(
+      WideToUtf8(const_cast<wchar_t*>(wide), len, result_len));
 }
 
-const wchar_t* StringUtils::Utf8ToWide(const char* utf8) {
-  return const_cast<const wchar_t*>(Utf8ToWide(const_cast<char*>(utf8)));
+const wchar_t* StringUtils::Utf8ToWide(
+    const char* utf8, intptr_t len, intptr_t* result_len) {
+  return const_cast<const wchar_t*>(
+      Utf8ToWide(const_cast<char*>(utf8), len, result_len));
 }
 
 wchar_t** ShellUtils::GetUnicodeArgv(int* argc) {
   wchar_t* command_line = GetCommandLineW();
   return CommandLineToArgvW(command_line, argc);
 }
 
 void ShellUtils::FreeUnicodeArgv(wchar_t** argv) {
   LocalFree(argv);
 }
@@ skipping 22 matching lines @@
 }
 
 void TimerUtils::Sleep(int64_t millis) {
   ::Sleep(millis);
 }
 
 }  // namespace bin
 }  // namespace dart
 
 #endif  // defined(TARGET_OS_WINDOWS)