pkg/vm_service_client: add getSourceReport to VMServiceReference

lib/src/script.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.
 
 import 'dart:async';
 import 'dart:math' as math;
 
 import 'package:json_rpc_2/json_rpc_2.dart' as rpc;
 import 'package:source_span/source_span.dart';
 
 import 'breakpoint.dart';
 import 'class.dart';
 import 'library.dart';
 import 'object.dart';
 import 'scope.dart';
 import 'source_location.dart';
+import 'source_report.dart';
 
 VMScriptRef newVMScriptRef(Scope scope, Map json) {
   if (json == null) return null;
   assert(json["type"] == "@Script" || json["type"] == "Script");
   return new VMScriptRef._(scope, json);
 }
 
 VMScriptToken newVMScriptToken(String isolateId, String scriptId,
         int position) {
   if (position == null) return null;
   return new VMScriptToken._(isolateId, scriptId, position);
 }
 
+VMScriptToken newVMScriptTokenFromPosition(VMScriptRef script, int position) {
+  if (position == null) return null;
+  return new VMScriptToken._(script._scope.isolateId, script._id, position);
+}
+
 /// A reference to a script in the Dart VM.
 ///
 /// A script contains information about the actual text of a library. Usually
 /// there's only one script per library, but the `part` directive can produce
 /// libraries made up of multiple scripts.
 class VMScriptRef implements VMObjectRef {
   final Scope _scope;
 
   /// The ID for script library, which is unique relative to its isolate.
   final String _id;
@@ skipping 23 matching lines @@
     try {
       var response = await _scope.sendRequest("addBreakpoint", params);
       return newVMBreakpoint(_scope, response);
     } on rpc.RpcException catch (error) {
       // Error 102 indicates that the breakpoint couldn't be created.
       if (error.code == 102) return null;
       rethrow;
     }
   }
 
+  /// Generates a set of reports tied to this script.
+  ///
+  /// If [includeCoverageReport] is `true`, the report includes code coverage
+  /// information via [VMSourceReportRange.coverage] in
+  /// [VMSourceReport.ranges].
+  /// Otherwise, [VMSourceReportRange.coverage] is `null`.
+  ///
+  /// If [includePossibleBreakpoints] is `true`, the report includes a list of
+  /// token positions which correspond to possible breakpoints via
+  /// [VMSourceReportRange.possibleBreakpoints] in [VMSourceReport.ranges].
+  /// Otherwise, [VMSourceReportRange.possibleBreakpoints] is `null`.
+  ///
+  /// If [forceCompile] is `true`, all functions in the range of the report
+  /// will be compiled. If `false`, functions that are never used may not appear
+  /// in [VMSourceReportRange.misses].
+  /// Forcing compilation can cause a compilation error, which could terminate
+  /// the running Dart program.
+  ///
+  /// [location] can be provided to restrict analysis to a subrange of the
+  /// script.
+  Future<VMSourceReport> getSourceReport(
+      {bool includeCoverageReport: true,
+      bool includePossibleBreakpoints: true,
+      bool forceCompile: false,
+      VMSourceLocation location}) async {
+    var reports = <String>[];
+    if (includeCoverageReport) reports.add('Coverage');
+    if (includePossibleBreakpoints) reports.add('PossibleBreakpoints');
+
+    var params = <String, dynamic>{'scriptId': _id, 'reports': reports};
+    if (forceCompile) params['forceCompile'] = true;
+    if (location != null) {
+      params['tokenPos'] = location.token._position;
+      if (location.end != null) {
+        params['endTokenPos'] = location.end._position;

[nweiz, 2016/05/19 21:11:13]

A location without an end represents a single point in the program, whereas not
passing the end token here represents everything after the token, so this isn't
the correct behavior. I suspect nothing useful will happen if you pass a
single-position location, so it should probably just throw an [ArgumentError].
Also document that behavior.

[kevmoo, 2016/05/19 21:59:46]

Acknowledged.

+      }
+    }
+
+    var json = await _scope.sendRequest('getSourceReport', params);
+    return newSourceReport(_scope, json);
+  }
+
   bool operator ==(other) => other is VMScriptRef &&
       (_fixedId ? _id == other._id : super == other);
 
   int get hashCode => _fixedId ? _id.hashCode : super.hashCode;
 
   String toString() => uri.toString();
 }
 
 /// A script in the Dart VM.
 class VMScript extends VMScriptRef implements VMObject {
@@ skipping 277 matching lines @@
       return new _ScriptSpan(_script, startPosition, endPosition,
           startPosition == this._startPosition ? this._start : other._start,
           endPosition == this._endPosition ? this._end : other._end);
     } else {
       var start = math.min(this.start.offset, other.start.offset);
       var end = math.max(this.end.offset, other.end.offset);
       return file.span(start, end);
     }
   }
 }