Deprecation of ClassMetadata wrapper for Class formatters so a stand-alone class is recognizable.

tool/input_sdk/private/debugger.dart

 // Copyright (c) 2015, 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.
 
 library dart._debugger;
 
 import 'dart:_foreign_helper' show JS;
 import 'dart:_runtime' as dart;
 import 'dart:core';
 import 'dart:collection';
@@ skipping 10 matching lines @@
 /// the Dart formatter.
 ///
 /// We'd like this to be an enum, but we can't because it's a dev_compiler bug.
 class JsonMLConfig {
   const JsonMLConfig(this.name);
 
   final String name;
   static const none = const JsonMLConfig("none");
   static const skipDart = const JsonMLConfig("skipDart");
   static const keyToString = const JsonMLConfig("keyToString");
+  static const asClass = const JsonMLConfig("asClass");
 }
 
 int _maxSpanLength = 100;
-
 var _devtoolsFormatter = new JsonMLFormatter(new DartFormatter());
 
 String _typeof(object) => JS('String', 'typeof #', object);
 
 List<String> getOwnPropertyNames(object) => JS('List<String>',
     'dart.list(Object.getOwnPropertyNames(#), #)', object, String);
 
 List getOwnPropertySymbols(object) =>
     JS('List', 'Object.getOwnPropertySymbols(#)', object);
 
 // TODO(jacobr): move this to dart:js and fully implement.
 class JSNative {
   // Name may be a String or a Symbol.
   static getProperty(object, name) => JS('', '#[#]', object, name);
   // Name may be a String or a Symbol.
   static setProperty(object, name, value) =>
       JS('', '#[#]=#', object, name, value);
 }
 
+void addMetadataChildren(object, Set<NameValuePair> ret) {
+  ret.add(new NameValuePair(
+      name: getTypeName(_getType(object)),
+      value: object,
+      config: JsonMLConfig.asClass));
+}
+
 String getObjectTypeName(object) {
   var reifiedType = dart.getReifiedType(object);
   if (reifiedType == null) {
     if (_typeof(object) == 'function') {
       return '[[Raw JavaScript Function]]';
     }
     return '<Error getting type name>';
   }
   return getTypeName(reifiedType);
 }
 
 String getTypeName(Type type) {
   var name = dart.typeName(type);
   // Hack to cleanup names for List<dynamic>
   // TODO(jacobr): it would be nice if there was a way we could distinguish
   // between a List<dynamic> created from Dart and an Array passed in from
   // JavaScript.
   if (name == 'JSArray<dynamic>' || name == 'JSObject<Array>')
     return 'List<dynamic>';
   return name;
 }
 
-String safePreview(object) {
+Object _getType(object) =>
+    object is Type ? object : dart.getReifiedType(object);
+
+String safePreview(object, config) {
   try {
-    var preview = _devtoolsFormatter._simpleFormatter.preview(object);
+    var preview = _devtoolsFormatter._simpleFormatter.preview(object, config);
     if (preview != null) return preview;
     return object.toString();
   } catch (e) {
     return '<Exception thrown> $e';
   }
 }
 
 String symbolName(symbol) {
   var name = symbol.toString();
   assert(name.startsWith('Symbol('));
@@ skipping 87 matching lines @@
   final String name;
   final Object object;
 }
 
 class NamedConstructor {
   NamedConstructor(this.object);
 
   final Object object;
 }
 
-class ClassMetadata {
-  ClassMetadata(this.object, {this.name});
-
-  final Object object;
-  final String name;
-
-  String get typeName =>
-      name ??
-      getTypeName(object is Type ? object : dart.getReifiedType(object));
-}
-
 class HeritageClause {
   HeritageClause(this.name, this.types);
 
   final String name;
   final List types;
 }
 
-Object safeGetProperty(Object protoChain, String name) {
+Object safeGetProperty(Object protoChain, Object name) {
   try {
     return JSNative.getProperty(protoChain, name);
   } catch (e) {
     return '<Exception thrown> $e';
   }
 }
 
 safeProperties(object) => new Map.fromIterable(
     getOwnPropertyNames(object)
         .where((each) => safeGetProperty(object, each) != null),
@@ skipping 78 matching lines @@
 
   void setMaxSpanLengthForTestingOnly(int spanLength) {
     _maxSpanLength = spanLength;
   }
 
   header(object, config) {
     customFormattersOn = true;
     if (config == JsonMLConfig.skipDart || isNativeJavaScriptObject(object)) {
       return null;
     }
-
-    var c = _simpleFormatter.preview(object);
+    var c = _simpleFormatter.preview(object, config);
     if (c == null) return null;
 
     if (config == JsonMLConfig.keyToString) {
       c = object.toString();
     }
 
     // Indicate this is a Dart Object by using a Dart background color.
     // This is stylistically a bit ugly but it eases distinguishing Dart and
     // JS objects.
     var element = new JsonMLElement('span')
       ..setStyle('background-color: #d9edf7;')
       ..createTextChild(c);
     return element.toJsonML();
   }
 
-  bool hasBody(object) => _simpleFormatter.hasChildren(object);
+  bool hasBody(object, config) => _simpleFormatter.hasChildren(object, config);
 
-  body(object) {
+  body(object, config) {
     var body = new JsonMLElement('ol')
       ..setStyle('list-style-type: none;'
           'padding-left: 0px;'
           'margin-top: 0px;'
           'margin-bottom: 0px;'
           'margin-left: 12px;');
     if (object is StackTrace) {
       body.addStyle('color: rgb(196, 26, 22);');
     }
-    var children = _simpleFormatter.children(object);
+    var children = _simpleFormatter.children(object, config);
     for (NameValuePair child in children) {
       var li = body.createChild('li');
       var nameSpan = new JsonMLElement('span')
         ..createTextChild(
             child.displayName.isNotEmpty ? '${child.displayName}: ' : '')
         ..setStyle('color: rgb(136, 19, 145);');
       if (_typeof(child.value) == 'object' ||
           _typeof(child.value) == 'function') {
         nameSpan.addStyle("padding-left: 13px;");
 
         li.appendChild(nameSpan);
         var objectTag = li.createObjectTag(child.value);
         objectTag.addAttribute('config', child.config);
-        if (!_simpleFormatter.hasChildren(child.value)) {
+        if (!_simpleFormatter.hasChildren(child.value, child.config)) {
           li.setStyle("padding-left: 13px;");
         }
       } else {
         li.setStyle("padding-left: 13px;");
         li.createChild('span')
           ..appendChild(nameSpan)
-          ..createTextChild(safePreview(child.value));
+          ..createTextChild(safePreview(child.value, child.config));
       }
     }
     return body.toJsonML();
   }
 }
 
 abstract class Formatter {
-  bool accept(object);
+  bool accept(object, config);
   String preview(object);
   bool hasChildren(object);
   List<NameValuePair> children(object);
 }
 
 class DartFormatter {
   List<Formatter> _formatters;
 
   DartFormatter() {
     // The order of formatters matters as formatters earlier in the list take
     // precedence.
     _formatters = [
+      new ClassFormatter(),
       new NamedConstructorFormatter(),
-      new FunctionFormatter(),
       new MapFormatter(),
       new IterableFormatter(),
+      new IterableSpanFormatter(),
       new MapEntryFormatter(),
-      new IterableSpanFormatter(),
       new StackTraceFormatter(),
-      new ClassMetadataFormatter(),
+      new FunctionFormatter(),
       new HeritageClauseFormatter(),
       new LibraryModuleFormatter(),
       new LibraryFormatter(),
       new ObjectFormatter(),
     ];
   }
 
-  String preview(object) {
+  String preview(object, config) {
     try {
       if (object == null ||
           object is num ||
           object is String ||
           isNativeJavaScriptObject(object)) {
         return object.toString();
       }
-
       for (var formatter in _formatters) {
-        if (formatter.accept(object)) return formatter.preview(object);
+        if (formatter.accept(object, config)) return formatter.preview(object);
       }
     } catch (e, trace) {
       // Log formatter internal errors as unfortunately the devtools cannot
       // be used to debug formatter errors.
       html.window.console.error("Caught exception $e\n trace:\n$trace");
     }
 
     return null;
   }
 
-  bool hasChildren(object) {
+  bool hasChildren(object, config) {
     if (object == null) return false;
     try {
       for (var formatter in _formatters) {
-        if (formatter.accept(object)) return formatter.hasChildren(object);
+        if (formatter.accept(object, config))
+          return formatter.hasChildren(object);
       }
     } catch (e, trace) {
       // See comment for preview.
       html.window.console
           .error("[hasChildren] Caught exception $e\n trace:\n$trace");
     }
     return false;
   }
 
-  List<NameValuePair> children(object) {
+  List<NameValuePair> children(object, config) {
     try {
       if (object != null) {
         for (var formatter in _formatters) {
-          if (formatter.accept(object)) return formatter.children(object);
+          if (formatter.accept(object, config))
+            return formatter.children(object);
         }
       }
     } catch (e, trace) {
       // See comment for preview.
       html.window.console.error("Caught exception $e\n trace:\n$trace");
     }
     return <NameValuePair>[];
   }
 }
 
 /// Default formatter for Dart Objects.
 class ObjectFormatter extends Formatter {
   static Set<String> _customNames = new Set()
     ..add('constructor')
     ..add('prototype')
     ..add('__proto__');
-  bool accept(object) => !isNativeJavaScriptObject(object);
+  bool accept(object, config) => !isNativeJavaScriptObject(object);
 
   String preview(object) => getObjectTypeName(object);
 
   bool hasChildren(object) => true;
 
   List<NameValuePair> children(object) {
     var properties = new LinkedHashSet<NameValuePair>();
     // Set of property names used to avoid duplicates.
     addMetadataChildren(object, properties);
 
@@ skipping 41 matching lines @@
         if (hasMethod(object, name)) {
           continue;
         }
         var value = safeGetProperty(object, name);
         properties.add(new NameValuePair(name: name, value: value));
       }
     }
 
     return properties.toList();
   }
-
-  addMetadataChildren(object, Set<NameValuePair> ret) {
-    var child = new ClassMetadata(object);
-    ret.add(new NameValuePair(name: child.typeName, value: child));
-  }
 }
 
 /// Formatter for module Dart Library objects.
-class LibraryModuleFormatter extends ObjectFormatter {
+class LibraryModuleFormatter implements Formatter {
   String libraryName;
 
-  accept(object) {
+  accept(object, config) {
     libraryName = dart.getDartLibraryName(object);
     return libraryName != null;
   }
 
   bool hasChildren(object) => true;
 
   String preview(object) {
     var libraryNames = libraryName.split('/');
     // Library names are received with a repeat directory name, so strip the
     // last directory entry here to make the path cleaner. For example, the
@@ skipping 12 matching lines @@
       // Replace __ with / to make file paths more readable. Then
       // 'src__result__error' becomes 'src/result/error'.
       name = '${name.replaceAll("__", "/")}.dart';
       children.add(new NameValuePair(
           name: name, value: new Library(name, value), hideName: true));
     }
     return children.toList();
   }
 }
 
-/// Formatter for Dart Library objects.
-class LibraryFormatter extends ObjectFormatter {
+class LibraryFormatter implements Formatter {
   var genericParameters = new HashMap<String, String>();
 
-  accept(object) => object is Library;
+  accept(object, config) => object is Library;
 
   bool hasChildren(object) => true;
 
   String preview(object) => object.name;
 
   List<NameValuePair> children(object) {
     var children = new LinkedHashSet<NameValuePair>();
     var nonGenericProperties = new LinkedHashMap<String, Object>();
     var objectProperties = safeProperties(object.object);
     objectProperties.forEach((name, value) {
@@ skipping 26 matching lines @@
             .replaceAll(new RegExp(r'[(|)]'), '');
   }
 
   classChild(String name, Object child) {
     var typeName = getTypeName(child);
     // Generic class names are generated with a $ at the end, so the
     // corresponding non-generic class can be identified by adding $.
     var parameterName = '$name\$';
     if (genericParameters.keys.contains(parameterName)) {
       typeName = '$typeName<${genericParameters[parameterName]}>';
+      // TODO(bmilligan): Add a symbol to classes with generic types at their
+      // creation so they can be recognized independently by the debugger.
+      JSNative.setProperty(child, 'genericTypeName', typeName);
     }
-    return new NameValuePair(
-        name: typeName, value: new ClassMetadata(child, name: typeName));
+    return new NameValuePair(name: typeName, value: child);
   }
 }
 
 /// Formatter for Dart Function objects.
 /// Dart functions happen to be regular JavaScript Function objects but
 /// we can distinguish them based on whether they have been tagged with
 /// runtime type information.
-class FunctionFormatter extends Formatter {
-  accept(object) {
+class FunctionFormatter implements Formatter {
+  accept(object, config) {
     if (_typeof(object) != 'function') return false;
     return dart.getReifiedType(object) != null;
   }
 
   bool hasChildren(object) => true;
 
   String preview(object) {
     return dart.typeName(dart.getReifiedType(object));
   }
 
   List<NameValuePair> children(object) => <NameValuePair>[
         new NameValuePair(name: 'signature', value: preview(object)),
         new NameValuePair(
             name: 'JavaScript Function',
             value: object,
             config: JsonMLConfig.skipDart)
       ];
 }
 
 /// Formatter for Dart Map objects.
-class MapFormatter extends ObjectFormatter {
-  accept(object) => object is Map;
+class MapFormatter implements Formatter {
+  accept(object, config) => object is Map;
 
   bool hasChildren(object) => true;
 
   String preview(object) {
     Map map = object;
     return '${getObjectTypeName(map)} length ${map.length}';
   }
 
   List<NameValuePair> children(object) {
     // TODO(jacobr): be lazier about enumerating contents of Maps that are not
     // the build in LinkedHashMap class.
     // TODO(jacobr): handle large Maps better.
     Map map = object;
     var entries = new LinkedHashSet<NameValuePair>();
     map.forEach((key, value) {
       var entryWrapper = new MapEntry(key: key, value: value);
       entries.add(new NameValuePair(
           name: entries.length.toString(), value: entryWrapper));
     });
     addMetadataChildren(object, entries);
     return entries.toList();
   }
 }
 
 /// Formatter for Dart Iterable objects including List and Set.
-class IterableFormatter extends ObjectFormatter {
-  bool accept(object) => object is Iterable;
+class IterableFormatter implements Formatter {
+  bool accept(object, config) => object is Iterable;
 
   String preview(object) {
     Iterable iterable = object;
     try {
       var length = iterable.length;
       return '${getObjectTypeName(iterable)} length $length';
     } catch (_) {
       return '${getObjectTypeName(iterable)}';
     }
   }
 
   bool hasChildren(object) => true;
 
   List<NameValuePair> children(object) {
     // TODO(jacobr): be lazier about enumerating contents of Iterables that
     // are not the built in Set or List types.
     // TODO(jacobr): handle large Iterables better.
     // TODO(jacobr): consider only using numeric indices
     var children = new LinkedHashSet<NameValuePair>();
     children.addAll(new IterableSpan(0, object.length, object).children());
     // TODO(jacobr): provide a link to show regular class properties here.
     // required for subclasses of iterable, etc.
     addMetadataChildren(object, children);
     return children.toList();
   }
 }
 
-// This class does double duting displaying metadata for
-class ClassMetadataFormatter implements Formatter {
-  accept(object) => object is ClassMetadata;
-
-  Object _getType(object) {
-    if (object is Type) return object;
-    return dart.getReifiedType(object);
-  }
-
-  String preview(object) {
-    ClassMetadata entry = object;
-    var type =
-        entry.object is Type ? entry.object : dart.getReifiedType(entry.object);
-    var implements = dart.getImplements(type);
-    if (implements != null) {
-      var typeNames = implements().map(getTypeName);
-      return '${entry.typeName} implements ${typeNames.join(", ")}';
-    } else {
-      return entry.typeName;
-    }
-  }
-
-  bool hasChildren(object) => true;
-
-  List<NameValuePair> children(object) {
-    ClassMetadata entry = object;
-    var classObject = entry.object;
-    // TODO(jacobr): add other entries describing the class such as
-    // links to the superclass, mixins, implemented interfaces, and methods.
-    var type = _getType(classObject);
-    var children = <NameValuePair>[];
-
-    var mixins = dart.getMixins(type);
-    if (mixins != null && mixins.isNotEmpty) {
-      children.add(new NameValuePair(
-          name: '[[Mixins]]', value: new HeritageClause('mixins', mixins)));
-    }
-
-    var hiddenProperties = ['length', 'name', 'prototype'];
-    // Addition of NameValuePairs for static variables and named constructors.
-    for (var name in getOwnPropertyNames(classObject)) {
-      // TODO(bmilligan): Perform more principled checks to filter out spurious
-      // members.
-      if (hiddenProperties.contains(name)) continue;
-      var value = safeGetProperty(classObject, name);
-      if (value != null && dart.getIsNamedConstructor(value) != null) {
-        value = new NamedConstructor(value);
-        name = '${entry.typeName}.$name';
-      }
-      children.add(new NameValuePair(name: name, value: value));
-    }
-
-    // TODO(bmilligan): Replace the hard coding of $identityHash.
-    var hiddenPrototypeProperties = ['constructor', 'new', r'$identityHash'];
-    // Addition of class methods.
-    var prototype = JS('var', '#["prototype"]', classObject);
-    if (prototype != null) {
-      for (var name in getOwnPropertyNames(prototype)) {
-        if (hiddenPrototypeProperties.contains(name)) continue;
-        // Simulate dart.bind by using dart.tag and tear off the function
-        // so it will be recognized by the FunctionFormatter.
-        var function = safeGetProperty(prototype, name);
-        var constructor = safeGetProperty(prototype, 'constructor');
-        var sigObj = dart.getMethodSig(constructor);
-        if (sigObj != null) {
-          var value = safeGetProperty(sigObj, name);
-          if (getTypeName(dart.getReifiedType(value)) != 'Null') {
-            dart.tag(function, value);
-            children.add(new NameValuePair(name: name, value: function));
-          }
-        }
-      }
-    }
-    // TODO(jacobr): provide a link to the base class or perhaps the entire
-    // base class hierarchy as a flat list.
-    // TODO(jacobr): add constructors, methods, extended class, and static
-    return children;
-  }
-}
-
 class NamedConstructorFormatter implements Formatter {
-  accept(object) => object is NamedConstructor;
+  accept(object, config) => object is NamedConstructor;
 
   // TODO(bmilligan): Display the signature of the named constructor as the
   // preview.
   String preview(object) => 'Named Constructor';
 
   bool hasChildren(object) => true;
 
   List<NameValuePair> children(object) => <NameValuePair>[
         new NameValuePair(
             name: 'JavaScript Function',
             value: object,
             config: JsonMLConfig.skipDart)
       ];
 }
 
 /// Formatter for synthetic MapEntry objects used to display contents of a Map
 /// cleanly.
 class MapEntryFormatter implements Formatter {
-  accept(object) => object is MapEntry;
+  accept(object, config) => object is MapEntry;
 
   String preview(object) {
     MapEntry entry = object;
-    return '${safePreview(entry.key)} => ${safePreview(entry.value)}';
+    return '${safePreview(entry.key, JsonMLConfig.none)} => ${safePreview(entry.value, JsonMLConfig.none)}';
   }
 
   bool hasChildren(object) => true;
 
   List<NameValuePair> children(object) => <NameValuePair>[
         new NameValuePair(
             name: 'key', value: object.key, config: JsonMLConfig.keyToString),
         new NameValuePair(name: 'value', value: object.value)
       ];
 }
 
 /// Formatter for Dart Iterable objects including List and Set.
 class HeritageClauseFormatter implements Formatter {
-  bool accept(object) => object is HeritageClause;
+  bool accept(object, config) => object is HeritageClause;
 
   String preview(object) {
     HeritageClause clause = object;
     var typeNames = clause.types.map(getTypeName);
     return '${clause.name} ${typeNames.join(", ")}';
   }
 
   bool hasChildren(object) => true;
 
   List<NameValuePair> children(object) {
     HeritageClause clause = object;
     var children = <NameValuePair>[];
     for (var type in clause.types) {
-      children.add(new NameValuePair(value: new ClassMetadata(type)));
+      children
+          .add(new NameValuePair(value: type, config: JsonMLConfig.asClass));
     }
     return children;
   }
 }
 
 /// Formatter for synthetic IterableSpan objects used to display contents of
 /// an Iterable cleanly.
 class IterableSpanFormatter implements Formatter {
-  accept(object) => object is IterableSpan;
+  accept(object, config) => object is IterableSpan;
 
   String preview(object) {
     return '[${object.start}...${object.end-1}]';
   }
 
   bool hasChildren(object) => true;
 
   List<NameValuePair> children(object) => object.children();
 }
 
 class StackTraceFormatter implements Formatter {
-  accept(object) => object is StackTrace;
+  accept(object, config) => object is StackTrace;
 
   String preview(object) => 'StackTrace';
 
   bool hasChildren(object) => true;
 
   // Using the stack_trace formatting would be ideal, but adding the
   // dependency or re-writing the code is too messy, so each line of the
   // StackTrace will be added as its own child.
   List<NameValuePair> children(object) => object
       .toString()
       .split('\n')
       .map((line) => new NameValuePair(
           value: line.replaceFirst(new RegExp(r'^\s+at\s'), ''),
           hideName: true))
       .toList();
 }
 
+class ClassFormatter implements Formatter {
+  accept(object, config) => object is Type || config == JsonMLConfig.asClass;
+
+  String preview(object) {
+    var typeName = safeGetProperty(object, 'genericTypeName');
+    if (typeName != null) return typeName;
+    var type = _getType(object);
+    var implements = dart.getImplements(type);
+    typeName = getTypeName(type);
+    if (implements != null) {
+      var typeNames = implements().map(getTypeName);
+      return '${typeName} implements ${typeNames.join(", ")}';
+    } else {
+      return typeName;
+    }
+  }
+
+  bool hasChildren(object) => true;
+
+  List<NameValuePair> children(object) {
+    // TODO(jacobr): add other entries describing the class such as
+    // links to the superclass, mixins, implemented interfaces, and methods.
+    var type = _getType(object);
+    var children = <NameValuePair>[];
+    var typeName = getTypeName(_getType(object));
+    var mixins = dart.getMixins(type);
+    if (mixins != null && mixins.isNotEmpty) {
+      children.add(new NameValuePair(
+          name: '[[Mixins]]', value: new HeritageClause('mixins', mixins)));
+    }
+
+    var hiddenProperties = ['length', 'name', 'prototype', 'genericTypeName'];
+    // Addition of NameValuePairs for static variables and named constructors.
+    for (var name in getOwnPropertyNames(object)) {
+      // TODO(bmilligan): Perform more principled checks to filter out spurious
+      // members.
+      if (hiddenProperties.contains(name)) continue;
+      var value = safeGetProperty(object, name);
+      if (value != null && dart.getIsNamedConstructor(value) != null) {
+        value = new NamedConstructor(value);
+        name = '${typeName}.$name';
+      }
+      children.add(new NameValuePair(name: name, value: value));
+    }
+
+    // TODO(bmilligan): Replace the hard coding of $identityHash.
+    var hiddenPrototypeProperties = ['constructor', 'new', r'$identityHash'];
+    // Addition of class methods.
+    var prototype = JS('var', '#["prototype"]', object);
+    if (prototype != null) {
+      for (var name in getOwnPropertyNames(prototype)) {
+        if (hiddenPrototypeProperties.contains(name)) continue;
+        // Simulate dart.bind by using dart.tag and tear off the function
+        // so it will be recognized by the FunctionFormatter.
+        var function = safeGetProperty(prototype, name);
+        var constructor = safeGetProperty(prototype, 'constructor');
+        var sigObj = dart.getMethodSig(constructor);
+        if (sigObj != null) {
+          var value = safeGetProperty(sigObj, name);
+          if (getTypeName(dart.getReifiedType(value)) != 'Null') {
+            dart.tag(function, value);
+            children.add(new NameValuePair(name: name, value: function));
+          }
+        }
+      }
+    }
+    return children;
+  }
+}
+
 /// This entry point is automatically invoked by the code generated by
 /// Dart Dev Compiler
 registerDevtoolsFormatter() {
   var formatters = [_devtoolsFormatter];
   JS('', 'dart.global.devtoolsFormatters = #', formatters);
 }