Add support for non ASCII strings when communicating with native ports

runtime/vm/snapshot_test.cc

Index: runtime/vm/snapshot_test.cc
diff --git a/runtime/vm/snapshot_test.cc b/runtime/vm/snapshot_test.cc
index d0e57def9851c648dc2ae602cda810289685717c..6aa9fb8274f3317da872afcef393ccfeea56a989 100644
--- a/runtime/vm/snapshot_test.cc
+++ b/runtime/vm/snapshot_test.cc
@@ -11,6 +11,7 @@
 #include "vm/dart_api_state.h"
 #include "vm/snapshot.h"
 #include "vm/symbols.h"
+#include "vm/unicode.h"
 #include "vm/unit_test.h"
 
 namespace dart {
@@ -497,13 +498,12 @@ TEST_CASE(SerializeSingletons) {
 }
 
 
-TEST_CASE(SerializeString) {
+static void TestString(const char* cstr) {
   StackZone zone(Isolate::Current());
 
   // Write snapshot with object content.
   uint8_t* buffer;
   MessageWriter writer(&buffer, &zone_allocator);
-  static const char* cstr = "This string shall be serialized";
   String& str = String::Handle(String::New(cstr));
   writer.WriteMessage(str);
   intptr_t buffer_len = writer.BytesWritten();
@@ -525,6 +525,20 @@ TEST_CASE(SerializeString) {
 }
 
 
+TEST_CASE(SerializeString) {
+  TestString("This string shall be serialized");
+  TestString("æøå");  // This file is UTF-8 encoded.
+  char data[] = {0x01,
+                 0x7f,
+                 0xc2, 0x80,         // 0x80
+                 0xdf, 0xbf,         // 0x7ff
+                 0xe0, 0xa0, 0x80,   // 0x800
+                 0xef, 0xbf, 0xbf};  // 0xffff
+  TestString(data);
+  // TODO(sgjesse): Add tests with non-BMP characters.

[erikcorry, 2012/11/12 11:44:07]

You could add tests for isolated surrogates like 0xd800, 0xdbff right now.

[Søren Gjesse, 2012/11/12 16:18:10]

I can't do that. If I create a message with an valid UTF-8 encoded string, and
the UTF-8 encoding of r.g. 0xd800 is not considered valid by the Dart VM unicode
library.

However as messages posted from native threads can contain strings with invalid
UTF-8 sequences we need to check that when posting a Dart_CObject structure.
Added checking for thet when writing.

+}
+
+
 TEST_CASE(SerializeArray) {
   StackZone zone(Isolate::Current());
 
@@ -1255,9 +1269,12 @@ UNIT_TEST_CASE(DartGeneratedMessages) {
       "getBigint() {\n"
       "  return -0x424242424242424242424242424242424242;\n"
       "}\n"
-      "getString() {\n"
+      "getAsciiString() {\n"
       "  return \"Hello, world!\";\n"
       "}\n"
+      "getNonAsciiString() {\n"
+      "  return \"Blåbærgrød\";\n"
+      "}\n"
       "getList() {\n"
       "  return new List(kArrayLength);\n"
       "}\n";
@@ -1276,10 +1293,15 @@ UNIT_TEST_CASE(DartGeneratedMessages) {
   Dart_Handle bigint_result;
   bigint_result = Dart_Invoke(lib, NewString("getBigint"), 0, NULL);
   EXPECT_VALID(bigint_result);
-  Dart_Handle string_result;
-  string_result = Dart_Invoke(lib, NewString("getString"), 0, NULL);
-  EXPECT_VALID(string_result);
-  EXPECT(Dart_IsString(string_result));
+  Dart_Handle ascii_string_result;
+  ascii_string_result = Dart_Invoke(lib, NewString("getAsciiString"), 0, NULL);
+  EXPECT_VALID(ascii_string_result);
+  EXPECT(Dart_IsString(ascii_string_result));
+  Dart_Handle non_ascii_string_result;
+  non_ascii_string_result =
+      Dart_Invoke(lib, NewString("getNonAsciiString"), 0, NULL);
+  EXPECT_VALID(non_ascii_string_result);
+  EXPECT(Dart_IsString(non_ascii_string_result));
 
   {
     DARTSCOPE_NOCHECKS(isolate);
@@ -1326,7 +1348,7 @@ UNIT_TEST_CASE(DartGeneratedMessages) {
       uint8_t* buffer;
       MessageWriter writer(&buffer, &zone_allocator);
       String& str = String::Handle();
-      str ^= Api::UnwrapHandle(string_result);
+      str ^= Api::UnwrapHandle(ascii_string_result);
       writer.WriteMessage(str);
       intptr_t buffer_len = writer.BytesWritten();
 
@@ -1339,6 +1361,24 @@ UNIT_TEST_CASE(DartGeneratedMessages) {
       EXPECT_STREQ("Hello, world!", root->value.as_string);
       CheckEncodeDecodeMessage(root);
     }
+    {
+      StackZone zone(Isolate::Current());
+      uint8_t* buffer;
+      MessageWriter writer(&buffer, &zone_allocator);
+      String& str = String::Handle();
+      str ^= Api::UnwrapHandle(non_ascii_string_result);
+      writer.WriteMessage(str);
+      intptr_t buffer_len = writer.BytesWritten();
+
+      // Read object back from the snapshot into a C structure.
+      ApiNativeScope scope;
+      ApiMessageReader api_reader(buffer, buffer_len, &zone_allocator);
+      Dart_CObject* root = api_reader.ReadMessage();
+      EXPECT_NOTNULL(root);
+      EXPECT_EQ(Dart_CObject::kString, root->type);
+      EXPECT_STREQ("Blåbærgrød", root->value.as_string);
+      CheckEncodeDecodeMessage(root);
+    }
   }
   Dart_ExitScope();
   Dart_ShutdownIsolate();
@@ -2018,7 +2058,7 @@ UNIT_TEST_CASE(PostCObject) {
       "  var exception = '';\n"
       "  var port = new ReceivePort();\n"
       "  port.receive((message, replyTo) {\n"
-      "    if (messageCount < 7) {\n"
+      "    if (messageCount < 8) {\n"
       "      exception = '$exception${message}';\n"
       "    } else {\n"
       "      exception = '$exception${message.length}';\n"
@@ -2027,7 +2067,7 @@ UNIT_TEST_CASE(PostCObject) {
       "      }\n"
       "    }\n"
       "    messageCount++;\n"
-      "    if (messageCount == 8) throw new Exception(exception);\n"
+      "    if (messageCount == 9) throw new Exception(exception);\n"
       "  });\n"
       "  return port.toSendPort();\n"
       "}\n";
@@ -2066,6 +2106,10 @@ UNIT_TEST_CASE(PostCObject) {
   object.value.as_string = const_cast<char*>("456");
   EXPECT(Dart_PostCObject(send_port_id, &object));
 
+  object.type = Dart_CObject::kString;
+  object.value.as_string = const_cast<char*>("æøå");
+  EXPECT(Dart_PostCObject(send_port_id, &object));
+
   object.type = Dart_CObject::kDouble;
   object.value.as_double = 3.14;
   EXPECT(Dart_PostCObject(send_port_id, &object));
@@ -2096,7 +2140,7 @@ UNIT_TEST_CASE(PostCObject) {
   result = Dart_RunLoop();
   EXPECT(Dart_IsError(result));
   EXPECT(Dart_ErrorHasException(result));
-  EXPECT_SUBSTRING("Exception: nulltruefalse1234563.14[]100123456789\n",
+  EXPECT_SUBSTRING("Exception: nulltruefalse123456æøå3.14[]100123456789\n",
                    Dart_GetError(result));
 
   Dart_ExitScope();