Add support for surrogates when serializing and deserializing for native ports

runtime/vm/snapshot_test.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 "include/dart_debugger_api.h"
 #include "platform/assert.h"
 #include "vm/bigint_operations.h"
 #include "vm/class_finalizer.h"
 #include "vm/dart_api_impl.h"
 #include "vm/dart_api_message.h"
@@ skipping 1239 matching lines @@
   const Object& list = Object::Handle(Api::UnwrapHandle(result));
   writer.WriteMessage(list);
   intptr_t buffer_len = writer.BytesWritten();
 
   // Read object back from the snapshot into a C structure.
   ApiMessageReader api_reader(buffer, buffer_len, &zone_allocator);
   return api_reader.ReadMessage();
 }
 
 
+static void CheckString(Dart_Handle string, const char* expected) {
+  StackZone zone(Isolate::Current());
+  uint8_t* buffer;
+  MessageWriter writer(&buffer, &zone_allocator);
+  String& str = String::Handle();
+  str ^= Api::UnwrapHandle(string);
+  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(expected, root->value.as_string);
+  CheckEncodeDecodeMessage(root);
+}
+
+
 UNIT_TEST_CASE(DartGeneratedMessages) {
   static const char* kCustomIsolateScriptChars =
       "getSmi() {\n"
       "  return 42;\n"
       "}\n"
       "getBigint() {\n"
       "  return -0x424242424242424242424242424242424242;\n"
       "}\n"
       "getAsciiString() {\n"
       "  return \"Hello, world!\";\n"
       "}\n"
       "getNonAsciiString() {\n"
       "  return \"Blåbærgrød\";\n"
       "}\n"
+      "getNonBMPString() {\n"
+      "  return \"\\u{10000}\\u{1F601}\\u{1F637}\\u{20000}\";\n"

[erikcorry, 2012/11/23 14:25:47]

😁

+      "}\n"
+      "getLeadSurrogateString() {\n"
+      "  return new String.fromCharCodes([0xd800]);\n"
+      "}\n"
+      "getTrailSurrogateString() {\n"
+      "  return \"\\u{10000}\".substring(1);\n"
+      "}\n"
+      "getSurrogatesString() {\n"
+      "  return new String.fromCharCodes([0xdc00, 0xdc00, 0xd800, 0xd800]);\n"
+      "}\n"
+      "getCrappyString() {\n"
+      "  return new String.fromCharCodes([0xd800, 32, 0xdc00, 32]);\n"
+      "}\n"
       "getList() {\n"
       "  return new List(kArrayLength);\n"
       "}\n";
 
   TestCase::CreateTestIsolate();
   Isolate* isolate = Isolate::Current();
   EXPECT(isolate != NULL);
   Dart_EnterScope();
 
   Dart_Handle lib = TestCase::LoadTestScript(kCustomIsolateScriptChars,
                                              NULL);
   EXPECT_VALID(lib);
   Dart_Handle smi_result;
   smi_result = Dart_Invoke(lib, NewString("getSmi"), 0, NULL);
   EXPECT_VALID(smi_result);
   Dart_Handle bigint_result;
   bigint_result = Dart_Invoke(lib, NewString("getBigint"), 0, NULL);
   EXPECT_VALID(bigint_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));
 
+  Dart_Handle non_bmp_string_result;
+  non_bmp_string_result =
+      Dart_Invoke(lib, NewString("getNonBMPString"), 0, NULL);
+  EXPECT_VALID(non_bmp_string_result);
+  EXPECT(Dart_IsString(non_bmp_string_result));
+
+  Dart_Handle lead_surrogate_string_result;
+  lead_surrogate_string_result =
+      Dart_Invoke(lib, NewString("getLeadSurrogateString"), 0, NULL);
+  EXPECT_VALID(lead_surrogate_string_result);
+  EXPECT(Dart_IsString(lead_surrogate_string_result));
+
+  Dart_Handle trail_surrogate_string_result;
+  trail_surrogate_string_result =
+      Dart_Invoke(lib, NewString("getTrailSurrogateString"), 0, NULL);
+  EXPECT_VALID(trail_surrogate_string_result);
+  EXPECT(Dart_IsString(trail_surrogate_string_result));
+
+  Dart_Handle surrogates_string_result;
+  surrogates_string_result =
+      Dart_Invoke(lib, NewString("getSurrogatesString"), 0, NULL);
+  EXPECT_VALID(surrogates_string_result);
+  EXPECT(Dart_IsString(surrogates_string_result));
+
+  Dart_Handle crappy_string_result;
+  crappy_string_result =
+      Dart_Invoke(lib, NewString("getCrappyString"), 0, NULL);
+  EXPECT_VALID(crappy_string_result);
+  EXPECT(Dart_IsString(crappy_string_result));
+
   {
     DARTSCOPE_NOCHECKS(isolate);
 
     {
       StackZone zone(Isolate::Current());
       uint8_t* buffer;
       MessageWriter writer(&buffer, &zone_allocator);
       Smi& smi = Smi::Handle();
       smi ^= Api::UnwrapHandle(smi_result);
       writer.WriteMessage(smi);
@@ skipping 20 matching lines @@
       // 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::kBigint, root->type);
       EXPECT_STREQ("-424242424242424242424242424242424242",
                    root->value.as_bigint);
       CheckEncodeDecodeMessage(root);
     }
-    {
-      StackZone zone(Isolate::Current());
-      uint8_t* buffer;
-      MessageWriter writer(&buffer, &zone_allocator);
-      String& str = String::Handle();
-      str ^= Api::UnwrapHandle(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("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);
-    }
+    CheckString(ascii_string_result, "Hello, world!");
+    CheckString(non_ascii_string_result, "Blåbærgrød");
+    CheckString(non_bmp_string_result,
+                "\xf0\x90\x80\x80"
+                "\xf0\x9f\x98\x81"
+                "\xf0\x9f\x98\xb7"
+                "\xf0\xa0\x80\x80");
+    CheckString(lead_surrogate_string_result, "\xed\xa0\x80");
+    CheckString(trail_surrogate_string_result, "\xed\xb0\x80");
+    CheckString(crappy_string_result,
+                "\xed\xa0\x80\x20\xed\xb0\x80\x20");
+    CheckString(surrogates_string_result,
+                "\xed\xb0\x80\xed\xb0\x80\xed\xa0\x80\xed\xa0\x80");
   }
   Dart_ExitScope();
   Dart_ShutdownIsolate();
 }
 
 
 UNIT_TEST_CASE(DartGeneratedListMessages) {
   const int kArrayLength = 10;
   static const char* kScriptChars =
       "final int kArrayLength = 10;\n"
@@ skipping 675 matching lines @@
       "      }\n"
       "    }\n"
       "    messageCount++;\n"
       "    if (messageCount == 9) throw new Exception(exception);\n"
       "  });\n"
       "  return port.toSendPort();\n"
       "}\n";
   Dart_Handle lib = TestCase::LoadTestScript(kScriptChars, NULL);
   Dart_EnterScope();
 
-  // xxx
   Dart_Handle send_port = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(send_port);
   Dart_Handle result = Dart_GetField(send_port, NewString("_id"));
   ASSERT(!Dart_IsError(result));
   ASSERT(Dart_IsInteger(result));
   int64_t send_port_id;
   Dart_Handle result2 = Dart_IntegerToInt64(result, &send_port_id);
   ASSERT(!Dart_IsError(result2));
 
   // Setup single object message.
@@ skipping 15 matching lines @@
   EXPECT(Dart_PostCObject(send_port_id, &object));
 
   object.type = Dart_CObject::kString;
   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));
 
-  // Try to post an invalid UTF-8 sequence (lead surrogate).
-  const char* data = "\xED\xA0\x80";  // U+D800
-  object.type = Dart_CObject::kString;
-  object.value.as_string = const_cast<char*>(data);
-  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));
 
   object.type = Dart_CObject::kArray;
   object.value.as_array.length = 0;
   EXPECT(Dart_PostCObject(send_port_id, &object));
 
   static const int kArrayLength = 10;
   Dart_CObject* array =
@@ skipping 19 matching lines @@
   EXPECT(Dart_ErrorHasException(result));
   EXPECT_SUBSTRING("Exception: nulltruefalse123456æøå3.14[]100123456789\n",
                    Dart_GetError(result));
 
   Dart_ExitScope();
 }
 
 #endif  // defined(TARGET_ARCH_IA32) || defined(TARGET_ARCH_X64).
 
 }  // namespace dart