Use the distinguished class, ApiFailure, to signal when a Dart_Result is

runtime/vm/dart_api_impl.cc

Index: runtime/vm/dart_api_impl.cc
===================================================================
--- runtime/vm/dart_api_impl.cc	(revision 478)
+++ runtime/vm/dart_api_impl.cc	(working copy)
@@ -27,6 +27,51 @@
 
 namespace dart {
 
+DART_EXPORT bool Dart_IsValidResult(const Dart_Result& result) {
+  assert(Isolate::Current() != NULL);

[Ivan Posva, 2011/10/18 20:44:28]

ASSERT

[turnidge, 2011/10/18 22:03:12]

Done.

+  if (result.type_ == kRetObject) {
+    Zone zone;  // Setup a VM zone as we are creating some handles.
+    HandleScope scope;  // Setup a VM handle scope.
+
+    // Make sure that the object isn't an ApiFailure.
+    const Object& obj =
+        Object::Handle(Api::UnwrapHandle(result.retval_.obj_value));
+    return !obj.IsApiFailure();
+  }
+  return true;
+}
+
+DART_EXPORT const char* Dart_GetErrorCString(const Dart_Result& result) {
+  assert(Isolate::Current() != NULL);

[Ivan Posva, 2011/10/18 20:44:28]

ditto

[turnidge, 2011/10/18 22:03:12]

Done.

+  assert(result.type_ == kRetObject);
+  Zone zone;  // Setup a VM zone as we are creating some handles.
+  HandleScope scope;  // Setup a VM handle scope.
+  const ApiFailure& failure =
+      ApiFailure::CheckedHandle(Api::UnwrapHandle(result.retval_.obj_value));

[Ivan Posva, 2011/10/18 20:44:28]

If the result does not contain an ApiFailure object we will fail here and abort.
Is that really what we want?

[turnidge, 2011/10/18 22:03:12]

Well, it's potentially inconsistent as it currently stands.  If somebody calls
Dart_GetErrrorCString when the Dart_Result contains an int, the ASSERT above
will fire -- why should we not fail if they also try to get the error string
from a non-error reference?

That said, once all results are handles, this inconsistency will go away, so I
will make it more resilient.

+  const String& message = String::Handle(failure.message());
+  const char* msg = message.ToCString();
+  intptr_t len = strlen(msg) + 1;
+  char* msg_copy = reinterpret_cast<char*>(Api::Allocate(len));
+  OS::SNPrint(msg_copy, len, "%s", msg);
+  return msg_copy;
+}
+
+
+DART_EXPORT Dart_Result Dart_ErrorResult(const char* value) {
+  assert(Isolate::Current() != NULL);

[Ivan Posva, 2011/10/18 20:44:28]

ditto

[turnidge, 2011/10/18 22:03:12]

Done.

+
+  Zone zone;  // Setup a VM zone as we are creating some handles.
+  HandleScope scope;  // Setup a VM handle scope.
+  const String& message = String::Handle(String::New(value));
+  const Object& obj = Object::Handle(ApiFailure::New(message));
+
+  Dart_Result result;
+  result.type_ = kRetObject;
+  result.retval_.obj_value = Api::NewLocalHandle(obj);
+  return result;
+}
+
+
 // TODO(iposva): This is a placeholder for the eventual external Dart API.
 DART_EXPORT bool Dart_Initialize(int argc,
                                  char** argv,
@@ -74,12 +119,9 @@
   // may get deallocated when we return back from the Dart API call.
   const String& error = String::Handle(
       Isolate::Current()->object_store()->sticky_error());
-  const char* errmsg = error.ToCString();
-  intptr_t errlen = strlen(errmsg) + 1;
-  char* msg = reinterpret_cast<char*>(Api::Allocate(errlen));
-  OS::SNPrint(msg, errlen, "%s", errmsg);
-  result->type_ = kRetError;
-  result->retval_.errmsg = msg;
+  const Object& obj = Object::Handle(ApiFailure::New(error));
+  result->type_ = kRetObject;
+  result->retval_.obj_value = Api::NewLocalHandle(obj);
 }
 
 
@@ -1089,13 +1131,13 @@
 DART_EXPORT Dart_Result Dart_ThrowException(Dart_Handle exception) {
   Isolate* isolate = Isolate::Current();
   ASSERT(isolate != NULL);
+  Zone zone;  // Setup a VM zone as we are creating some handles.
+  HandleScope scope;  // Setup a VM handle scope.
   if (isolate->top_exit_frame_info() == 0) {
     // There are no dart frames on the stack so it would be illegal to
     // throw an exception here.
     RETURN_FAILURE("No Dart frames on stack, cannot throw exception");
   }
-  Zone zone;  // Setup a VM zone as we are creating some handles.
-  HandleScope scope;  // Setup a VM handle scope.
   const Instance& excp = Instance::CheckedHandle(Api::UnwrapHandle(exception));
   // Unwind all the API scopes till the exit frame before throwing an
   // exception.