Merge SourceLocation and Source

pkg/dartdoc/lib/src/mirrors/dart2js_mirror.dart

 // 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.
 
 library mirrors_dart2js;
 
 import 'dart:io';
 import 'dart:uri';
 
 import '../../../../../lib/compiler/compiler.dart' as diagnostics;
 import '../../../../../lib/compiler/implementation/elements/elements.dart';
 import '../../../../../lib/compiler/implementation/resolution/resolution.dart'
     show ResolverTask, ResolverVisitor;
 import '../../../../../lib/compiler/implementation/apiimpl.dart' as api;
 import '../../../../../lib/compiler/implementation/scanner/scannerlib.dart';
 import '../../../../../lib/compiler/implementation/ssa/ssa.dart';
 import '../../../../../lib/compiler/implementation/dart2jslib.dart';
 import '../../../../../lib/compiler/implementation/filenames.dart';
 import '../../../../../lib/compiler/implementation/source_file.dart';
 import '../../../../../lib/compiler/implementation/tree/tree.dart';
 import '../../../../../lib/compiler/implementation/util/util.dart';
 import '../../../../../lib/compiler/implementation/util/uri_extras.dart';
 import '../../../../../lib/compiler/implementation/dart2js.dart';
+import '../../../../../lib/compiler/implementation/util/characters.dart';
 
 // TODO(rnystrom): Use "package:" URL (#4968).
 import '../../mirrors.dart';
 import 'util.dart';
 
 //------------------------------------------------------------------------------
 // Utility types and functions for the dart2js mirror system
 //------------------------------------------------------------------------------
 
 bool _isPrivate(String name) {
@@ skipping 387 matching lines @@
 
   Dart2JsElementMirror(this.mirrors, this._element) {
     assert (mirrors !== null);
     assert (_element !== null);
   }
 
   String get simpleName => _element.name.slowToString();
 
   String get displayName => simpleName;
 
-  SourceLocation get location => new Dart2JsLocation(
+  SourceLocation get location => new Dart2JsSourceLocation(
       _element.getCompilationUnit().script,
       mirrors.compiler.spanFromElement(_element));
 
   String toString() => _element.toString();
 
   int get hashCode => qualifiedName.hashCode;
 }
 
 abstract class Dart2JsProxyMirror extends Dart2JsDeclarationMirror {
   final Dart2JsMirrorSystem mirrors;
@@ skipping 168 matching lines @@
     }
   }
 
   Map<String, ClassMirror> get classes {
     _ensureClasses();
     return new ImmutableMapWrapper<String, ClassMirror>(_classes);
   }
 
   SourceLocation get location {
     var script = _library.getCompilationUnit().script;
-    return new Dart2JsLocation(
+    return new Dart2JsSourceLocation(
         script,
         new SourceSpan(script.uri, 0, script.text.length));
   }
 }
 
-class Dart2JsLocation implements SourceLocation {
-  Script _script;
-  SourceSpan _span;
+class Dart2JsSourceLocation implements SourceLocation {
+  final Script _script;
+  final SourceSpan _span;
 
-  Dart2JsLocation(this._script, this._span);
+  Dart2JsSourceLocation(this._script, this._span);
 
-  int get start => _span.begin;
+  int get line {
+    var sourceFile = _script.file is SourceFile;

[kasperl, 2012/11/01 10:13:29]

I'd factor out the computation part into a computeLine method and cache the
result on first access.

[Johnni Winther, 2012/11/01 12:01:58]

Done.

+    if (sourceFile != null) {
+      return sourceFile.getLine(offset);
+    }
+    var index = 0;
+    var lineNumber = 0;
+    while (index < sourceText.length) {
+      lineNumber++;
+      index = sourceText.indexOf('\n', index) + 1;

[kasperl, 2012/11/01 10:13:29]

I don't think this works on all platforms. I'd recommend looking for a pattern
like 

    const RegExp("\r\n?|\n\r?")

instead. See https://codereview.chromium.org/11174003.

[Johnni Winther, 2012/11/01 12:01:58]

Done.

+      if (index <= 0) break;
+    }
+    return lineNumber;
+  }
 
-  int get end => _span.end;
+  int get column {

[kasperl, 2012/11/01 10:13:29]

I'd factor out the computation part into a computeColumn method and cache the
result on first access.

[Johnni Winther, 2012/11/01 12:01:58]

Done.

+    if (length == 0) return 0;
 
-  Source get source => new Dart2JsSource(_script);
+    var sourceFile = _script.file is SourceFile;
+    if (sourceFile != null) {
+      return sourceFile.getColumn(sourceFile.getLine(offset), offset);
+    }
 
-  String get text => _script.text.substring(start, end);
-}
+    int index = offset-1;

[kasperl, 2012/11/01 10:13:29]

offset - 1 (spacing)

[Johnni Winther, 2012/11/01 12:01:58]

Done.

+    var columnNumber = 0;
+    while (0 <= index && index < sourceText.length) {
+      var charCode = sourceText.charCodeAt(index);
+      if (charCode == $CR || charCode == $LF) {
+        break;
+      }
+      index--;
+      columnNumber++;
+    }
+    return column;

[kasperl, 2012/11/01 10:13:29]

Hmm. This looks broken. Isn't this self-recursive? Shouldn't this be
columnNumber? Is this tested?

[Johnni Winther, 2012/11/01 12:01:58]

Yes. Fixed.

 
-class Dart2JsSource implements Source {
-  Script _script;
+  }
 
-  Dart2JsSource(this._script);
+  int get offset => _span.begin;
 
-  Uri get uri => _script.uri;
+  int get length => _span.end - _span.end;
 
-  String get text => _script.text;
+  String get text => _script.text.substring(_span.begin, _span.end);
+
+  Uri get sourceUri => _script.uri;
+
+  String get sourceText => _script.text;
 }
 
 class Dart2JsParameterMirror extends Dart2JsMemberMirror
     implements ParameterMirror {
   final MethodMirror _method;
   final bool isOptional;
   final bool isNamed;
 
   factory Dart2JsParameterMirror(Dart2JsMirrorSystem system,
                                  MethodMirror method,
@@ skipping 98 matching lines @@
   DeclarationMirror get owner => library;
 
   String get qualifiedName => '${library.qualifiedName}.${simpleName}';
 
   SourceLocation get location {
     if (_class is PartialClassElement) {
       var node = _class.parseNode(mirrors.compiler);
       if (node !== null) {
         var script = _class.getCompilationUnit().script;
         var span = mirrors.compiler.spanFromNode(node, script.uri);
-        return new Dart2JsLocation(script, span);
+        return new Dart2JsSourceLocation(script, span);
       }
     }
     return super.location;
   }
 
   void _ensureMembers() {
     if (_members == null) {
       _members = <String, Dart2JsMemberMirror>{};
       _class.forEachMember((_, e) {
         for (var member in _convertElementMemberToMemberMirrors(this, e)) {
@@ skipping 114 matching lines @@
 
   TypedefType get _typedef => _type;
 
   String get qualifiedName => '${library.qualifiedName}.${simpleName}';
 
   SourceLocation get location {
     var node = _typedef.element.parseNode(_diagnosticListener);
     if (node !== null) {
       var script = _typedef.element.getCompilationUnit().script;
       var span = mirrors.compiler.spanFromNode(node, script.uri);
-      return new Dart2JsLocation(script, span);
+      return new Dart2JsSourceLocation(script, span);
     }
     return super.location;
   }
 
   LibraryMirror get library => _library;
 
   bool get isTypedef => true;
 
   List<TypeMirror> get typeArguments {
     throw new UnsupportedError(
@@ skipping 103 matching lines @@
     implements Dart2JsTypeMirror {
   final DartType _type;
 
   Dart2JsTypeElementMirror(Dart2JsMirrorSystem system, this._type)
     : super(system);
 
   String get simpleName => _type.name.slowToString();
 
   SourceLocation get location {
     var script = _type.element.getCompilationUnit().script;
-    return new Dart2JsLocation(script,
+    return new Dart2JsSourceLocation(script,
                                mirrors.compiler.spanFromElement(_type.element));

[kasperl, 2012/11/01 10:13:29]

Indentation is off now.

[Johnni Winther, 2012/11/01 12:01:58]

Done.

   }
 
   DeclarationMirror get owner => library;
 
   LibraryMirror get library {
     return mirrors._getLibrary(_type.element.getLibrary());
   }
 
   bool get isObject => false;
 
@@ skipping 389 matching lines @@
 
   bool get isOperator => _kind == Dart2JsMethodKind.OPERATOR;
 
   String get operatorName => _operatorName;
 
   SourceLocation get location {
     var node = _function.parseNode(_diagnosticListener);
     if (node !== null) {
       var script = _function.getCompilationUnit().script;
       var span = mirrors.compiler.spanFromNode(node, script.uri);
-      return new Dart2JsLocation(script, span);
+      return new Dart2JsSourceLocation(script, span);
     }
     return super.location;
   }
 
 }
 
 class Dart2JsFieldMirror extends Dart2JsMemberMirror implements VariableMirror {
   Dart2JsContainerMirror _objectMirror;
   VariableElement _variable;
 
@@ skipping 20 matching lines @@
 
   TypeMirror get type => _convertTypeToTypeMirror(mirrors,
       _variable.computeType(mirrors.compiler),
       mirrors.compiler.types.dynamicType);
 
   SourceLocation get location {
     var script = _variable.getCompilationUnit().script;
     var node = _variable.variables.parseNode(_diagnosticListener);
     if (node !== null) {
       var span = mirrors.compiler.spanFromNode(node, script.uri);
-      return new Dart2JsLocation(script, span);
+      return new Dart2JsSourceLocation(script, span);
     } else {
       var span = mirrors.compiler.spanFromElement(_variable);
-      return new Dart2JsLocation(script, span);
+      return new Dart2JsSourceLocation(script, span);
     }
   }
 }