Support Types in instance-ref/instance-view

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 6347 matching lines @@
   jsobj.AddProperty("is_static", is_static());
   jsobj.AddProperty("is_const", is_const());
   jsobj.AddProperty("is_optimizable", is_optimizable());
   jsobj.AddProperty("is_inlinable", IsInlineable());
   jsobj.AddProperty("unoptimized_code", Object::Handle(unoptimized_code()));
   jsobj.AddProperty("usage_counter", usage_counter());
   jsobj.AddProperty("optimized_call_site_count", optimized_call_site_count());
   jsobj.AddProperty("code", Object::Handle(CurrentCode()));
   jsobj.AddProperty("deoptimizations",
                     static_cast<intptr_t>(deoptimization_counter()));
+
+  const Script& script = Script::Handle(this->script());
+  if (!script.IsNull()) {
+    jsobj.AddProperty("script", script);
+    jsobj.AddProperty("token_pos", token_pos());
+    jsobj.AddProperty("end_token_pos", end_token_pos());
+  }
 }
 
 
 void ClosureData::set_context_scope(const ContextScope& value) const {
   StorePointer(&raw_ptr()->context_scope_, value.raw());
 }
 
 
 void ClosureData::set_implicit_static_closure(const Instance& closure) const {
   ASSERT(!closure.IsNull());
@@ skipping 278 matching lines @@
   jsobj.AddPropertyF("id", "classes/%" Pd "/fields/%" Pd "", cid, id);
   jsobj.AddProperty("name", internal_field_name);
   jsobj.AddProperty("user_name", field_name);
   if (is_static()) {
     const Instance& valueObj = Instance::Handle(value());
     jsobj.AddProperty("value", valueObj);
   }
 
   jsobj.AddProperty("owner", cls);
 
-  // TODO(turnidge): Once the vmservice supports returning types,
-  // return the type here instead of the class.
   AbstractType& declared_type = AbstractType::Handle(type());
-  if (declared_type.HasResolvedTypeClass()) {
-    cls = declared_type.type_class();
-    jsobj.AddProperty("declared_type", cls);
-  }
-
+  jsobj.AddProperty("declared_type", declared_type);
   jsobj.AddProperty("static", is_static());
   jsobj.AddProperty("final", is_final());
   jsobj.AddProperty("const", is_const());
   if (ref) {
     return;
   }
   jsobj.AddProperty("guard_nullable", is_nullable());
   if (guarded_cid() == kIllegalCid) {
     jsobj.AddProperty("guard_class", "unknown");
   } else if (guarded_cid() == kDynamicCid) {
@@ skipping 5781 matching lines @@
   } else if (raw() == Object::sentinel().raw()) {
     return "<not initialized>";
   } else if (raw() == Object::transition_sentinel().raw()) {
     return "<being initialized>";
   } else {
     return ToCString();
   }
 }
 
 
-void Instance::PrintToJSONStream(JSONStream* stream, bool ref) const {
-  JSONObject jsobj(stream);
+void Instance::PrintSharedInstanceJSON(JSONObject* jsobj, bool ref) const {
+  jsobj->AddProperty("type", JSONType(ref));
   Class& cls = Class::Handle(this->clazz());
-
-  // TODO(turnidge): Handle <optimized out> like other null-like values.
-  if (IsNull()) {
-    jsobj.AddProperty("type", ref ? "@Null" : "Null");
-    jsobj.AddProperty("id", "objects/null");
-    jsobj.AddProperty("preview", "null");
-    return;
-  } else if (raw() == Object::sentinel().raw()) {
-    jsobj.AddProperty("type", ref ? "@Null" : "Null");
-    jsobj.AddProperty("id", "objects/not-initialized");
-    jsobj.AddProperty("preview", "<not initialized>");
-    return;
-  } else if (raw() == Object::transition_sentinel().raw()) {
-    jsobj.AddProperty("type", ref ? "@Null" : "Null");
-    jsobj.AddProperty("id", "objects/being-initialized");
-    jsobj.AddProperty("preview", "<being initialized>");
-    return;
-  } else if (raw() == Symbols::OptimizedOut().raw()) {
-    // TODO(turnidge): This is a hack.  The user could have this
-    // special string in their program.  Fixing this involves updating
-    // the debugging api a bit.
-    jsobj.AddProperty("type", ref ? "@Null" : "Null");
-    jsobj.AddProperty("id", "objects/optimized-out");
-    jsobj.AddProperty("preview", "<optimized out>");
-    return;
-  } else {
-    ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-    const intptr_t id = ring->GetIdForObject(raw());
-    if (IsClosure()) {
-      const Function& closureFunc = Function::Handle(Closure::function(*this));
-      jsobj.AddProperty("closureFunc", closureFunc);
-      jsobj.AddProperty("type", ref ? "@Closure" : "Closure");
-    } else {
-      jsobj.AddProperty("type", JSONType(ref));
-    }
-    jsobj.AddPropertyF("id", "objects/%" Pd "", id);
-    jsobj.AddProperty("class", cls);
-    jsobj.AddProperty("preview", ToUserCString(40));
-  }
+  jsobj->AddProperty("class", cls);
   if (ref) {
     return;
   }
 
+  jsobj->AddProperty("size", raw()->Size());
+
   // Walk the superclass chain, adding all instance fields.
   {
     Instance& fieldValue = Instance::Handle();
-    JSONArray jsarr(&jsobj, "fields");
+    JSONArray jsarr(jsobj, "fields");
     while (!cls.IsNull()) {
       const Array& field_array = Array::Handle(cls.fields());
       Field& field = Field::Handle();
       if (!field_array.IsNull()) {
         for (intptr_t i = 0; i < field_array.Length(); i++) {
           field ^= field_array.At(i);
           if (!field.is_static()) {
             fieldValue ^= GetField(field);
             JSONObject jsfield(&jsarr);
             jsfield.AddProperty("decl", field);
             jsfield.AddProperty("value", fieldValue);
           }
         }
       }
       cls = cls.SuperClass();
     }
   }
 
   if (NumNativeFields() > 0) {
-    JSONArray jsarr(&jsobj, "nativeFields");
+    JSONArray jsarr(jsobj, "nativeFields");
     for (intptr_t i = 0; i < NumNativeFields(); i++) {
       intptr_t value = GetNativeField(i);
       JSONObject jsfield(&jsarr);
       jsfield.AddProperty("index", i);
       jsfield.AddProperty("value", value);
     }
   }
-
-  jsobj.AddProperty("size", raw()->Size());
 }
 
 
+void Instance::PrintToJSONStream(JSONStream* stream, bool ref) const {
+  JSONObject jsobj(stream);
+
+  // Handle certain special instance values.
+  if (IsNull()) {
+    jsobj.AddProperty("type", ref ? "@Null" : "Null");
+    jsobj.AddProperty("id", "objects/null");
+    jsobj.AddProperty("preview", "null");
+    return;
+  } else if (raw() == Object::sentinel().raw()) {
+    jsobj.AddProperty("type", ref ? "@Null" : "Null");
+    jsobj.AddProperty("id", "objects/not-initialized");
+    jsobj.AddProperty("preview", "<not initialized>");
+    return;
+  } else if (raw() == Object::transition_sentinel().raw()) {
+    jsobj.AddProperty("type", ref ? "@Null" : "Null");
+    jsobj.AddProperty("id", "objects/being-initialized");
+    jsobj.AddProperty("preview", "<being initialized>");
+    return;
+  } else if (raw() == Symbols::OptimizedOut().raw()) {
+    // TODO(turnidge): This is a hack.  The user could have this
+    // special string in their program.  Fixing this involves updating
+    // the debugging api a bit.
+    jsobj.AddProperty("type", ref ? "@Null" : "Null");
+    jsobj.AddProperty("id", "objects/optimized-out");
+    jsobj.AddProperty("preview", "<optimized out>");
+    return;
+  }
+
+  PrintSharedInstanceJSON(&jsobj, ref);
+  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
+  const intptr_t id = ring->GetIdForObject(raw());
+  if (IsClosure()) {
+    const Function& closureFunc = Function::Handle(Closure::function(*this));
+    jsobj.AddProperty("closureFunc", closureFunc);
+  }
+  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddProperty("preview", ToUserCString(40));
+  if (ref) {
+    return;
+  }
+}
+
+
 bool AbstractType::IsResolved() const {
   // AbstractType is an abstract class.
   UNREACHABLE();
   return false;
 }
 
 
 bool AbstractType::HasResolvedTypeClass() const {
   // AbstractType is an abstract class.
   UNREACHABLE();
@@ skipping 919 matching lines @@
       OS::SNPrint(chars, len, format, class_name, args_cstr);
       return chars;
     }
   } else {
     return "Unresolved Type";
   }
 }
 
 
 void Type::PrintToJSONStream(JSONStream* stream, bool ref) const {
-  // TODO(koda): Decide whether to assign stable ids to non-canonical types.
-  if (!IsCanonical()) {
-    return Object::PrintToJSONStream(stream, ref);
+  JSONObject jsobj(stream);
+  PrintSharedInstanceJSON(&jsobj, ref);
+  if (IsCanonical()) {
+    const Class& type_cls = Class::Handle(type_class());
+    intptr_t id = type_cls.FindCanonicalTypeIndex(*this);
+    ASSERT(id >= 0);
+    intptr_t cid = type_cls.id();
+    jsobj.AddPropertyF("id", "classes/%" Pd "/types/%" Pd "", cid, id);
+    jsobj.AddProperty("type_class", type_cls);
+  } else {
+    ObjectIdRing* ring = Isolate::Current()->object_id_ring();
+    const intptr_t id = ring->GetIdForObject(raw());
+    jsobj.AddPropertyF("id", "objects/%" Pd "", id);
   }
-  ASSERT(IsCanonical());
-  JSONObject jsobj(stream);
-  jsobj.AddProperty("type", JSONType(ref));
-  const Class& type_cls = Class::Handle(type_class());
-  intptr_t id = type_cls.FindCanonicalTypeIndex(*this);
-  ASSERT(id >= 0);
-  intptr_t cid = type_cls.id();
-  jsobj.AddPropertyF("id", "classes/%" Pd "/types/%" Pd "", cid, id);
   const char* name = String::Handle(Name()).ToCString();
   const char* user_name = String::Handle(UserVisibleName()).ToCString();
   jsobj.AddProperty("name", name);
   jsobj.AddProperty("user_name", user_name);
   if (ref) {
     return;
   }
-  jsobj.AddProperty("type_class", type_cls);
   jsobj.AddProperty("type_arguments", TypeArguments::Handle(arguments()));
 }
 
 
 bool TypeRef::IsInstantiated(GrowableObjectArray* trail) const {
   if (TestAndAddToTrail(&trail)) {
     return true;
   }
   return AbstractType::Handle(type()).IsInstantiated(trail);
 }
@@ skipping 149 matching lines @@
       type()).arguments() == TypeArguments::null()) ? "" : "<...>";
   intptr_t len = OS::SNPrint(NULL, 0, format, type_cstr, args_cstr) + 1;
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(chars, len, format, type_cstr, args_cstr);
   return chars;
 }
 
 
 void TypeRef::PrintToJSONStream(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
+  PrintSharedInstanceJSON(&jsobj, ref);
   ObjectIdRing* ring = Isolate::Current()->object_id_ring();
   const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddProperty("type", JSONType(ref));
   jsobj.AddPropertyF("id", "objects/%" Pd "", id);
   const char* name = String::Handle(Name()).ToCString();
   const char* user_name = String::Handle(UserVisibleName()).ToCString();
   jsobj.AddProperty("name", name);
   jsobj.AddProperty("user_name", user_name);
   if (ref) {
     return;
   }
   jsobj.AddProperty("ref_type", AbstractType::Handle(type()));
 }
@@ skipping 193 matching lines @@
   intptr_t len = OS::SNPrint(
       NULL, 0, format, name_cstr, index(), cls_cstr, bound_cstr) + 1;
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(chars, len, format, name_cstr, index(), cls_cstr, bound_cstr);
   return chars;
 }
 
 
 void TypeParameter::PrintToJSONStream(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
+  PrintSharedInstanceJSON(&jsobj, ref);
   ObjectIdRing* ring = Isolate::Current()->object_id_ring();
   const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddProperty("type", JSONType(ref));
   jsobj.AddPropertyF("id", "objects/%" Pd "", id);
   const char* name = String::Handle(Name()).ToCString();
   const char* user_name = String::Handle(UserVisibleName()).ToCString();
   jsobj.AddProperty("name", name);
   jsobj.AddProperty("user_name", user_name);
-  const Class& cls = Class::Handle(parameterized_class());
-  jsobj.AddProperty("parameterized_class", cls);
+  const Class& param_cls = Class::Handle(parameterized_class());
+  jsobj.AddProperty("parameterized_class", param_cls);
   if (ref) {
     return;
   }
   jsobj.AddProperty("index", index());
   const AbstractType& upper_bound = AbstractType::Handle(bound());
   jsobj.AddProperty("upper_bound", upper_bound);
 }
 
 
 bool BoundedType::IsMalformed() const {
@@ skipping 167 matching lines @@
       NULL, 0, format, type_cstr, bound_cstr, type_param_cstr, cls_cstr) + 1;
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(
       chars, len, format, type_cstr, bound_cstr, type_param_cstr, cls_cstr);
   return chars;
 }
 
 
 void BoundedType::PrintToJSONStream(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
+  PrintSharedInstanceJSON(&jsobj, ref);
   ObjectIdRing* ring = Isolate::Current()->object_id_ring();
   const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddProperty("type", JSONType(ref));
   jsobj.AddPropertyF("id", "objects/%" Pd "", id);
   const char* name = String::Handle(Name()).ToCString();
   const char* user_name = String::Handle(UserVisibleName()).ToCString();
   jsobj.AddProperty("name", name);
   jsobj.AddProperty("user_name", user_name);
   if (ref) {
     return;
   }
   jsobj.AddProperty("bounded_type", AbstractType::Handle(type()));
   jsobj.AddProperty("upper_bound", AbstractType::Handle(bound()));
@@ skipping 2670 matching lines @@
       "_ImmutableList len:%" Pd : "_List len:%" Pd;
   intptr_t len = OS::SNPrint(NULL, 0, format, Length()) + 1;
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(chars, len, format, Length());
   return chars;
 }
 
 
 void Array::PrintToJSONStream(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
-  Class& cls = Class::Handle(this->clazz());
+  PrintSharedInstanceJSON(&jsobj, ref);
   ObjectIdRing* ring = Isolate::Current()->object_id_ring();
   const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddProperty("type", JSONType(ref));
   jsobj.AddPropertyF("id", "objects/%" Pd "", id);
-  jsobj.AddProperty("class", cls);
   jsobj.AddProperty("length", Length());
   if (ref) {
     return;
   }
   {
     JSONArray jsarr(&jsobj, "elements");
     for (intptr_t index = 0; index < Length(); index++) {
       JSONObject jselement(&jsarr);
       jselement.AddProperty("index", index);
 
@@ skipping 313 matching lines @@
   }
   ASSERT(pos <= max_len);
   buffer[pos] = '\0';
   return buffer;
 }
 
 
 void GrowableObjectArray::PrintToJSONStream(JSONStream* stream,
                                             bool ref) const {
   JSONObject jsobj(stream);
-  Class& cls = Class::Handle(this->clazz());
+  PrintSharedInstanceJSON(&jsobj, ref);
   ObjectIdRing* ring = Isolate::Current()->object_id_ring();
   const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddProperty("type", JSONType(ref));
   jsobj.AddPropertyF("id", "objects/%" Pd "", id);
-  jsobj.AddProperty("class", cls);
   jsobj.AddProperty("length", Length());
   if (ref) {
     return;
   }
   {
     JSONArray jsarr(&jsobj, "elements");
     for (intptr_t index = 0; index < Length(); index++) {
       JSONObject jselement(&jsarr);
       jselement.AddProperty("index", index);
 
@@ skipping 853 matching lines @@
   return "_MirrorReference";
 }
 
 
 void MirrorReference::PrintToJSONStream(JSONStream* stream, bool ref) const {
   Instance::PrintToJSONStream(stream, ref);
 }
 
 
 }  // namespace dart