Continue improving the documentation for the vm service protocol.

runtime/observatory/lib/src/service/object.dart

 // Copyright (c) 2014, 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.
 
 part of service;
 
 /// A [ServiceObject] represents a persistent object within the vm.
 abstract class ServiceObject extends Observable {
   static int LexicalSortName(ServiceObject o1, ServiceObject o2) {
     return o1.name.compareTo(o2.name);
@@ skipping 1804 matching lines @@
 class FunctionKind {
   final String _strValue;
   FunctionKind._internal(this._strValue);
   toString() => _strValue;
   bool isSynthetic() => [kCollected, kNative, kStub, kTag].contains(this);
   bool isDart() => !isSynthetic();
   bool isStub() => (this == kStub);
   bool hasDartCode() => isDart() || isStub();
   static FunctionKind fromJSON(String value) {
     switch(value) {
-      case 'kRegularFunction': return kRegularFunction;
-      case 'kClosureFunction': return kClosureFunction;
-      case 'kGetterFunction': return kGetterFunction;
-      case 'kSetterFunction': return kSetterFunction;
-      case 'kConstructor': return kConstructor;
-      case 'kImplicitGetter': return kImplicitGetterFunction;
-      case 'kImplicitSetter': return kImplicitSetterFunction;
-      case 'kImplicitStaticFinalGetter': return kImplicitStaticFinalGetter;
-      case 'kIrregexpFunction': return kIrregexpFunction;
-      case 'kStaticInitializer': return kStaticInitializer;
-      case 'kMethodExtractor': return kMethodExtractor;
-      case 'kNoSuchMethodDispatcher': return kNoSuchMethodDispatcher;
-      case 'kInvokeFieldDispatcher': return kInvokeFieldDispatcher;
+      case 'RegularFunction': return kRegularFunction;
+      case 'ClosureFunction': return kClosureFunction;
+      case 'GetterFunction': return kGetterFunction;
+      case 'SetterFunction': return kSetterFunction;
+      case 'Constructor': return kConstructor;
+      case 'ImplicitGetter': return kImplicitGetterFunction;
+      case 'ImplicitSetter': return kImplicitSetterFunction;
+      case 'ImplicitStaticFinalGetter': return kImplicitStaticFinalGetter;
+      case 'IrregexpFunction': return kIrregexpFunction;
+      case 'StaticInitializer': return kStaticInitializer;
+      case 'MethodExtractor': return kMethodExtractor;
+      case 'NoSuchMethodDispatcher': return kNoSuchMethodDispatcher;
+      case 'InvokeFieldDispatcher': return kInvokeFieldDispatcher;
       case 'Collected': return kCollected;
       case 'Native': return kNative;
       case 'Stub': return kStub;
       case 'Tag': return kTag;
     }
     Logger.root.severe('Unrecognized function kind: $value');
     throw new FallThroughError();
   }
 
   static FunctionKind kRegularFunction = new FunctionKind._internal('function');
@@ skipping 10 matching lines @@
   static FunctionKind kNoSuchMethodDispatcher = new FunctionKind._internal('noSuchMethod dispatcher');
   static FunctionKind kInvokeFieldDispatcher = new FunctionKind._internal('invoke field dispatcher');
   static FunctionKind kCollected = new FunctionKind._internal('Collected');
   static FunctionKind kNative = new FunctionKind._internal('Native');
   static FunctionKind kTag = new FunctionKind._internal('Tag');
   static FunctionKind kStub = new FunctionKind._internal('Stub');
   static FunctionKind kUNKNOWN = new FunctionKind._internal('UNKNOWN');
 }
 
 class ServiceFunction extends ServiceObject with Coverage {
-  @observable Class owningClass;
-  @observable Library owningLibrary;
+  // owner is a Library, Class, or ServiceFunction.
+  @observable ServiceObject dartOwner;
+  @observable Library library;
   @observable bool isStatic;
   @observable bool isConst;
-  @observable ServiceFunction parent;
   @observable Script script;
   @observable int tokenPos;
   @observable int endTokenPos;
   @observable Code code;
   @observable Code unoptimizedCode;
   @observable bool isOptimizable;
   @observable bool isInlinable;
   @observable FunctionKind kind;
   @observable int deoptimizations;
   @observable String qualifiedName;
   @observable int usageCounter;
   @observable bool isDart;
   @observable ProfileFunction profile;
 
   bool get canCache => true;
   bool get immutable => false;
 
   ServiceFunction._empty(ServiceObject owner) : super._empty(owner);
 
   void _update(ObservableMap map, bool mapIsRef) {
     name = map['name'];
     vmName = (map.containsKey('vmName') ? map['vmName'] : name);
 
     _upgradeCollection(map, isolate);
 
-    owningClass = map.containsKey('owningClass') ? map['owningClass'] : null;
-    owningLibrary = map.containsKey('owningLibrary') ? map['owningLibrary'] : null;
+    dartOwner = map['owner'];
     kind = FunctionKind.fromJSON(map['kind']);
     isDart = !kind.isSynthetic();
 
-    if (parent == null) {
-      qualifiedName = (owningClass != null) ?
-          "${owningClass.name}.${name}" :
-          name;
+    if (dartOwner is ServiceFunction) {
+      library = dartOwner.library;
+      qualifiedName = "${dartOwner.qualifiedName}.${name}";
+
+    } else if (dartOwner is Class) {
+      library = dartOwner.library;
+      qualifiedName = "${dartOwner.name}.${name}";
+
     } else {
-      qualifiedName = "${parent.qualifiedName}.${name}";
+      library = dartOwner;
+      qualifiedName = name;
     }
 
     if (mapIsRef) {
       return;
     }
 
     _loaded = true;
     isStatic = map['static'];
     isConst = map['const'];
-    parent = map['parent'];
     script = map['script'];
     tokenPos = map['tokenPos'];
     endTokenPos = map['endTokenPos'];
-    code = _convertNull(map['code']);
-    unoptimizedCode = _convertNull(map['unoptimizedCode']);
-    isOptimizable = map['optimizable'];
-    isInlinable = map['inlinable'];
-    deoptimizations = map['deoptimizations'];
-    usageCounter = map['usageCounter'];
+    code = map['code'];
+    isOptimizable = map['_optimizable'];
+    isInlinable = map['_inlinable'];
+    unoptimizedCode = map['_unoptimizedCode'];
+    deoptimizations = map['_deoptimizations'];
+    usageCounter = map['_usageCounter'];
   }
 }
 
 
 class Field extends ServiceObject {
-  @observable var /* Library or Class */ owner;
+  // Library or Class.
+  @observable ServiceObject dartOwner;
+  @observable Library library;
   @observable Instance declaredType;
   @observable bool isStatic;
   @observable bool isFinal;
   @observable bool isConst;
   @observable Instance value;
   @observable String name;
   @observable String vmName;
 
   @observable bool guardNullable;
   @observable String guardClass;
   @observable String guardLength;
   @observable Script script;
   @observable int tokenPos;
 
   Field._empty(ServiceObjectOwner owner) : super._empty(owner);
 
   void _update(ObservableMap map, bool mapIsRef) {
     // Extract full properties.
     _upgradeCollection(map, isolate);
 
     name = map['name'];
     vmName = (map.containsKey('vmName') ? map['vmName'] : name);
-    owner = map['owner'];
+    dartOwner = map['owner'];
     declaredType = map['declaredType'];
     isStatic = map['static'];
     isFinal = map['final'];
     isConst = map['const'];
     value = map['value'];
 
+    if (dartOwner is Class) {
+      library = dartOwner.library;
+
+    } else {
+      library = dartOwner;
+    }
+
     if (mapIsRef) {
       return;
     }
 
-    guardNullable = map['guardNullable'];
-    guardClass = map['guardClass'];
-    guardLength = map['guardLength'];
+    guardNullable = map['_guardNullable'];
+    guardClass = map['_guardClass'];
+    guardLength = map['_guardLength'];
     script = map['script'];
     tokenPos = map['tokenPos'];
 
     _loaded = true;
   }
 
-  String toString() => 'Field(${owner.name}.$name)';
+  String toString() => 'Field(${darOwner.name}.$name)';
 }
 
 
 class ScriptLine extends Observable {
   final Script script;
   final int line;
   final String text;
   @observable int hits;
   @observable bool possibleBpt = true;
   @observable bool breakpointResolved = false;
@@ skipping 115 matching lines @@
   String toString() => "CallSiteEntry(${receiverContainer.name}, $count)";
 }
 
 class Script extends ServiceObject with Coverage {
   Set<CallSite> callSites = new Set<CallSite>();
   final lines = new ObservableList<ScriptLine>();
   final _hits = new Map<int, int>();
   @observable String kind;
   @observable int firstTokenPos;
   @observable int lastTokenPos;
-  @observable Library owningLibrary;
+  @observable Library library;
   bool get canCache => true;
   bool get immutable => true;
 
   String _shortUrl;
   String _url;
 
   Script._empty(ServiceObjectOwner owner) : super._empty(owner);
 
   ScriptLine getLine(int line) {
     assert(line >= 1);
@@ skipping 13 matching lines @@
     kind = map['kind'];
     _url = map['name'];
     _shortUrl = _url.substring(_url.lastIndexOf('/') + 1);
     name = _shortUrl;
     vmName = _url;
     if (mapIsRef) {
       return;
     }
     _parseTokenPosTable(map['tokenPosTable']);
     _processSource(map['source']);
-    owningLibrary = map['owningLibrary'];
+    library = map['library'];
   }
 
   void _parseTokenPosTable(List<List<int>> table) {
     if (table == null) {
       return;
     }
     _tokenToLine.clear();
     _tokenToCol.clear();
     firstTokenPos = null;
     lastTokenPos = null;
@@ skipping 390 matching lines @@
     if (kind == CodeKind.Dart) {
       // We only reload Dart code.
       return super.reload();
     }
     return new Future.value(this);
   }
 
   void _update(ObservableMap m, bool mapIsRef) {
     name = m['name'];
     vmName = (m.containsKey('vmName') ? m['vmName'] : name);
-    isOptimized = m['optimized'] != null ? m['optimized'] : false;
+    isOptimized = m['_optimized'];
     kind = CodeKind.fromString(m['kind']);
-    startAddress = int.parse(m['start'], radix:16);
-    endAddress = int.parse(m['end'], radix:16);
-    function = isolate.getFromMap(m['function']);
     if (mapIsRef) {
       return;
     }
     _loaded = true;
-    objectPool = isolate.getFromMap(m['objectPool']);
-    var disassembly = m['disassembly'];
+    startAddress = int.parse(m['_startAddress'], radix:16);
+    endAddress = int.parse(m['_endAddress'], radix:16);
+    function = isolate.getFromMap(m['function']);
+    objectPool = isolate.getFromMap(m['_objectPool']);
+    var disassembly = m['_disassembly'];
     if (disassembly != null) {
       _processDisassembly(disassembly);
     }
-    var descriptors = m['descriptors'];
+    var descriptors = m['_descriptors'];
     if (descriptors != null) {
       descriptors = descriptors['members'];
       _processDescriptors(descriptors);
     }
     hasDisassembly = (instructions.length != 0) && (kind == CodeKind.Dart);
     inlinedFunctions.clear();
-    var inlinedFunctionsTable = m['inlinedFunctions'];
-    var inlinedIntervals = m['inlinedIntervals'];
+    var inlinedFunctionsTable = m['_inlinedFunctions'];
+    var inlinedIntervals = m['_inlinedIntervals'];
     if (inlinedFunctionsTable != null) {
       // Iterate and upgrade each ServiceFunction.
       for (var i = 0; i < inlinedFunctionsTable.length; i++) {
         // Upgrade each function and set it back in the list.
         var func = isolate.getFromMap(inlinedFunctionsTable[i]);
         inlinedFunctionsTable[i] = func;
         if (!inlinedFunctions.contains(func)) {
           inlinedFunctions.add(func);
         }
       }
@@ skipping 288 matching lines @@
   void _onPoll(_) {
     // Reload metrics and add a sample to each.
     for (var metric in metrics) {
       metric.reload().then((m) {
         m.addSample(new MetricSample(m.value));
       });
     }
   }
 }
 
-// Convert any ServiceMaps representing a null instance into an actual null.
-_convertNull(obj) {
-  if (obj.isNull) {
-    return null;
-  }
-  return obj;
-}
-
 // Returns true if [map] is a service map. i.e. it has the following keys:
 // 'id' and a 'type'.
 bool _isServiceMap(ObservableMap m) {
   return (m != null) && (m['type'] != null);
 }
 
 bool _hasRef(String type) => type.startsWith('@');
 String _stripRef(String type) => (_hasRef(type) ? type.substring(1) : type);
 
 /// Recursively upgrades all [ServiceObject]s inside [collection] which must
@@ skipping 27 matching lines @@
     var v = list[i];
     if ((v is ObservableMap) && _isServiceMap(v)) {
       list[i] = owner.getFromMap(v);
     } else if (v is ObservableList) {
       _upgradeObservableList(v, owner);
     } else if (v is ObservableMap) {
       _upgradeObservableMap(v, owner);
     }
   }
 }