Lazily format LanguageError messages (fix issue 15069).

runtime/vm/object.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 "vm/object.h"
 
 #include "include/dart_api.h"
 #include "platform/assert.h"
 #include "vm/assembler.h"
 #include "vm/cpu.h"
@@ skipping 1664 matching lines @@
   result.set_num_type_arguments(0);
   result.set_num_own_type_arguments(0);
   result.set_num_native_fields(0);
   result.set_token_pos(Scanner::kDummyTokenIndex);
   result.InitEmptyFields();
   Isolate::Current()->RegisterClass(result);
   return result.raw();
 }
 
 
-static RawError* FormatError(const Error& prev_error,
-                             const Script& script,
-                             intptr_t token_pos,
-                             const char* format, ...) {
-  va_list args;
-  va_start(args, format);
-  if (prev_error.IsNull()) {
-    return Parser::FormatError(script, token_pos, "Error", format, args);
-  } else {
-    return Parser::FormatErrorWithAppend(prev_error, script, token_pos,
-                                         "Error", format, args);
-  }
-}
-
 
 static void ReportTooManyTypeArguments(const Class& cls) {
   const Error& error = Error::Handle(
-      FormatError(Error::Handle(),  // No previous error.
-                  Script::Handle(cls.script()), cls.token_pos(),
-                  "too many type parameters declared in class '%s' or in its "
-                  "super classes",
-                  String::Handle(cls.Name()).ToCString()));
+      LanguageError::NewFormatted(
+          Error::Handle(),  // No previous error.
+          Script::Handle(cls.script()),
+          cls.token_pos(),
+          LanguageError::kError,
+          Heap::kNew,
+          "too many type parameters declared in class '%s' or in its "
+          "super classes",
+          String::Handle(cls.Name()).ToCString()));
   Isolate::Current()->long_jump_base()->Jump(1, error);
   UNREACHABLE();
 }
 
 
 void Class::set_num_type_arguments(intptr_t value) const {
   if (!Utils::IsInt(16, value)) {
     ReportTooManyTypeArguments(*this);
   }
   raw_ptr()->num_type_arguments_ = value;
@@ skipping 516 matching lines @@
       // the loop below.
       // However, an implicitly created constructor should not be preserved if
       // the patch provides a constructor or a factory. Wait for now.
       if (orig_func.raw() != orig_implicit_ctor.raw()) {
         new_functions.Add(orig_func);
       }
     } else if (func.UserVisibleSignature() !=
                orig_func.UserVisibleSignature()) {
       // Compare user visible signatures to ignore different implicit parameters
       // when patching a constructor with a factory.
-      *error = FormatError(*error,  // No previous error.
-                           Script::Handle(patch.script()), func.token_pos(),
-                           "signature mismatch: '%s'", member_name.ToCString());
+      *error = LanguageError::NewFormatted(
+          *error,  // No previous error.
+          Script::Handle(patch.script()),
+          func.token_pos(),
+          LanguageError::kError,
+          Heap::kNew,
+          "signature mismatch: '%s'", member_name.ToCString());
       return false;
     }
   }
   for (intptr_t i = 0; i < patch_len; i++) {
     func ^= patch_list.At(i);
     if (func.IsConstructor() || func.IsFactory()) {
       // Do not preserve the original implicit constructor, if any.
       orig_implicit_ctor = Function::null();
     }
     func.set_owner(patch_class);
@@ skipping 18 matching lines @@
   new_list = Array::New(patch_len + orig_len);
   for (intptr_t i = 0; i < patch_len; i++) {
     field ^= patch_list.At(i);
     field.set_owner(*this);
     member_name = field.name();
     // TODO(iposva): Verify non-public fields only.
 
     // Verify no duplicate additions.
     orig_field ^= LookupField(member_name);
     if (!orig_field.IsNull()) {
-      *error = FormatError(*error,  // No previous error.
-                           Script::Handle(patch.script()), field.token_pos(),
-                           "duplicate field: %s", member_name.ToCString());
+      *error = LanguageError::NewFormatted(
+          *error,  // No previous error.
+          Script::Handle(patch.script()),
+          field.token_pos(),
+          LanguageError::kError,
+          Heap::kNew,
+          "duplicate field: %s", member_name.ToCString());
       return false;
     }
     new_list.SetAt(i, field);
   }
   for (intptr_t i = 0; i < orig_len; i++) {
     field ^= orig_list.At(i);
     new_list.SetAt(patch_len + i, field);
   }
   SetFields(new_list);
 
@@ skipping 2548 matching lines @@
 bool Function::HasCompatibleParametersWith(const Function& other,
                                            Error* bound_error) const {
   ASSERT(FLAG_error_on_bad_override);
   ASSERT((bound_error != NULL) && bound_error->IsNull());
   // Check that this function's signature type is a subtype of the other
   // function's signature type.
   if (!TypeTest(kIsSubtypeOf, Object::null_abstract_type_arguments(),
                 other, Object::null_abstract_type_arguments(), bound_error)) {
     // For more informative error reporting, use the location of the other
     // function here, since the caller will use the location of this function.
-    *bound_error = FormatError(
+    *bound_error = LanguageError::NewFormatted(
         *bound_error,  // A bound error if non null.
         Script::Handle(other.script()),
         other.token_pos(),
+        LanguageError::kError,
+        Heap::kNew,
         "signature type '%s' of function '%s' is not a subtype of signature "
         "type '%s' of function '%s'",
         String::Handle(UserVisibleSignature()).ToCString(),
         String::Handle(UserVisibleName()).ToCString(),
         String::Handle(other.UserVisibleSignature()).ToCString(),
         String::Handle(other.UserVisibleName()).ToCString());
     return false;
   }
   // We should also check that if the other function explicitly specifies a
   // default value for a formal parameter, this function does not specify a
@@ skipping 5803 matching lines @@
 
 RawLanguageError* LanguageError::New() {
   ASSERT(Object::language_error_class() != Class::null());
   RawObject* raw = Object::Allocate(LanguageError::kClassId,
                                     LanguageError::InstanceSize(),
                                     Heap::kOld);
   return reinterpret_cast<RawLanguageError*>(raw);
 }
 
 
-RawLanguageError* LanguageError::New(const String& message, Heap::Space space) {
+RawLanguageError* LanguageError::New(const Error& prev_error,
+                                     const Script& script,
+                                     intptr_t token_pos,
+                                     Kind kind,
+                                     const String& message,
+                                     Heap::Space space) {
   ASSERT(Object::language_error_class() != Class::null());
   LanguageError& result = LanguageError::Handle();
   {
     RawObject* raw = Object::Allocate(LanguageError::kClassId,
                                       LanguageError::InstanceSize(),
                                       space);
     NoGCScope no_gc;
     result ^= raw;
   }
+  result.set_previous_error(prev_error);
+  result.set_script(script);
+  result.set_token_pos(token_pos);
+  result.set_kind(kind);
   result.set_message(message);
   return result.raw();
 }
 
 
-void LanguageError::set_message(const String& message) const {
-  StorePointer(&raw_ptr()->message_, message.raw());
+RawLanguageError* LanguageError::NewFormattedV(const Error& prev_error,
+                                               const Script& script,
+                                               intptr_t token_pos,
+                                               Kind kind,
+                                               Heap::Space space,
+                                               const char* format,
+                                               va_list args) {
+  const String& msg = String::Handle(String::NewFormattedV(format, args));
+  return LanguageError::New(prev_error, script, token_pos, kind, msg, space);
+}
+
+
+RawLanguageError* LanguageError::NewFormatted(const Error& prev_error,
+                                              const Script& script,
+                                              intptr_t token_pos,
+                                              Kind kind,
+                                              Heap::Space space,
+                                              const char* format, ...) {
+  va_list args;
+  va_start(args, format);
+  RawLanguageError* result = LanguageError::NewFormattedV(
+      prev_error, script, token_pos, kind, space, format, args);
+  NoGCScope no_gc;

[Ivan Posva, 2013/11/15 04:42:13]

What is this NoGCScope for?

[regis, 2013/11/15 18:27:38]

To save a handle. Same as in String::NewFormatted.

+  va_end(args);
+  return result;
+}
+
+
+RawLanguageError* LanguageError::New(const String& formatted_message,
+                                     Heap::Space space) {
+  ASSERT(Object::language_error_class() != Class::null());
+  LanguageError& result = LanguageError::Handle();
+  {
+    RawObject* raw = Object::Allocate(LanguageError::kClassId,
+                                      LanguageError::InstanceSize(),
+                                      space);
+    NoGCScope no_gc;
+    result ^= raw;
+  }
+  result.set_formatted_message(formatted_message);
+  return result.raw();
+}
+
+
+void LanguageError::set_previous_error(const Error& value) const {
+  StorePointer(&raw_ptr()->previous_error_, value.raw());
+}
+
+
+void LanguageError::set_script(const Script& value) const {
+  StorePointer(&raw_ptr()->script_, value.raw());
+}
+
+
+void LanguageError::set_token_pos(intptr_t value) const {
+  ASSERT(value >= 0);
+  raw_ptr()->token_pos_ = value;
+}
+
+
+void LanguageError::set_kind(uint8_t value) const {
+  raw_ptr()->kind_ = value;
+}
+
+
+void LanguageError::set_message(const String& value) const {
+  StorePointer(&raw_ptr()->message_, value.raw());
+}
+
+
+void LanguageError::set_formatted_message(const String& value) const {
+  StorePointer(&raw_ptr()->formatted_message_, value.raw());
+}
+
+
+RawString* LanguageError::FormatMessage() const {
+  if (formatted_message() != String::null()) {
+    return formatted_message();
+  }
+  const char* message_header;
+  switch (kind()) {
+    case kWarning: message_header = "warning"; break;
+    case kError: message_header = "error"; break;
+    case kMalformedType: message_header = "malformed type"; break;
+    case kMalboundedType: message_header = "malbounded type"; break;
+    default: message_header = ""; UNREACHABLE();
+  }
+  String& result = String::Handle();
+  String& msg = String::Handle(message());
+  const Script& scr = Script::Handle(script());
+  if (!scr.IsNull()) {
+    const String& script_url = String::Handle(scr.url());
+    if (token_pos() >= 0) {
+      intptr_t line, column;
+      scr.GetTokenLocation(token_pos(), &line, &column);
+      // Only report the line position if we have the original source. We still
+      // need to get a valid column so that we can report the ^ mark below the
+      // snippet.
+      if (scr.HasSource()) {
+        result = String::NewFormatted("'%s': %s: line %" Pd " pos %" Pd ": ",
+                                      script_url.ToCString(),
+                                      message_header,
+                                      line,
+                                      column);
+      } else {
+        result = String::NewFormatted("'%s': %s: line %" Pd ": ",
+                                      script_url.ToCString(),
+                                      message_header,
+                                      line);
+      }
+      // Append the formatted error or warning message.
+      result = String::Concat(result, msg);
+      const String& new_line = String::Handle(String::New("\n"));

[Ivan Posva, 2013/11/15 04:42:13]

Please just use Symbols::NewLine() where we use this variable.

[regis, 2013/11/15 18:27:38]

Done.

+      // Append the source line.
+      const String& script_line = String::Handle(scr.GetLine(line));
+      ASSERT(!script_line.IsNull());
+      result = String::Concat(result, new_line);
+      result = String::Concat(result, script_line);
+      result = String::Concat(result, new_line);
+      // Append the column marker.
+      const String& column_line = String::Handle(
+          String::NewFormatted("%*s\n", static_cast<int>(column), "^"));
+      result = String::Concat(result, column_line);
+    } else {
+      // Token position is unknown.
+      result = String::NewFormatted("'%s': %s: ",
+                                    script_url.ToCString(),
+                                    message_header);
+      result = String::Concat(result, msg);
+    }
+  } else {
+    // Script is unknown.
+    // Append the formatted error or warning message.
+    result = String::NewFormatted("%s: ", message_header);
+    result = String::Concat(result, msg);
+  }
+  // Prepend previous error message.
+  const Error& prev_error = Error::Handle(previous_error());
+  if (!prev_error.IsNull()) {
+    msg = String::New(prev_error.ToErrorCString());
+    result = String::Concat(msg, result);
+  }
+  set_formatted_message(result);
+  return result.raw();
 }
 
 
 const char* LanguageError::ToErrorCString() const {
-  const String& msg_str = String::Handle(message());
+  const String& msg_str = String::Handle(FormatMessage());
   return msg_str.ToCString();
 }
 
 
 const char* LanguageError::ToCString() const {
   return "LanguageError";
 }
 
 
 void LanguageError::PrintToJSONStream(JSONStream* stream, bool ref) const {
@@ skipping 1413 matching lines @@
           upper_bound.UserVisibleName());
       const AbstractType& declared_bound = AbstractType::Handle(bound());
       const String& declared_bound_name = String::Handle(
           declared_bound.UserVisibleName());
       const String& type_param_name = String::Handle(UserVisibleName());
       const Class& cls = Class::Handle(parameterized_class());
       const String& class_name = String::Handle(cls.Name());
       const Script& script = Script::Handle(cls.script());
       // Since the bound may have been canonicalized, its token index is
       // meaningless, therefore use the token index of this type parameter.
-      *bound_error = FormatError(
+      *bound_error = LanguageError::NewFormatted(
           *bound_error,
           script,
           token_pos(),
+          LanguageError::kMalboundedType,
+          Heap::kNew,
           "type parameter '%s' of class '%s' must extend bound '%s', "
           "but type argument '%s' is not a subtype of '%s'\n",
           type_param_name.ToCString(),
           class_name.ToCString(),
           declared_bound_name.ToCString(),
           bounded_type_name.ToCString(),
           upper_bound_name.ToCString());
     }
   }
   return false;
@@ skipping 3632 matching lines @@
   return "_MirrorReference";
 }
 
 
 void MirrorReference::PrintToJSONStream(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
 }
 
 
 }  // namespace dart