Introduce span with line context

lib/src/span.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.
 
 library source_span.span;
 
 import 'location.dart';
+import 'span_context.dart';
 import 'span_mixin.dart';
 
 /// A class that describes a segment of source text.
 abstract class SourceSpan implements Comparable<SourceSpan> {
   /// The start location of this span.
   final SourceLocation start;
 
   /// The end location of this span, exclusive.
   final SourceLocation end;
 
@@ skipping 51 matching lines @@
       throw new ArgumentError("Source URLs \"${start.sourceUrl}\" and "
           " \"${end.sourceUrl}\" don't match.");
     } else if (end.offset < start.offset) {
       throw new ArgumentError('End $end must come after start $start.');
     } else if (text.length != start.distance(end)) {
       throw new ArgumentError('Text "$text" must be ${start.distance(end)} '
           'characters long.');
     }
   }
 }
+
+/// A class that describes a segment of source text.

[nweiz, 2015/03/24 23:01:17]

Update this doc comment.

[Siggi Cherem (dart-lang), 2015/03/25 00:33:25]

Done.

+class SourceSpanWithContext extends SourceSpanBase
+    implements SourceSpanContext {
+  /// Line containing the source-span

[nweiz, 2015/03/24 23:01:17]

"The text of the line containing this span.

If the span covers multiple lines, this should only contain the first."

I've considered for a while having multi-line spans produce multi-line messages,
so maybe this variable's name should be updated to be forwards-compatible with
those semantics. Maybe just [context]?

[Siggi Cherem (dart-lang), 2015/03/25 00:33:25]

Sounds good. Done

+  final String contextLine;
+
+  /// Creates a new span from [start] to [end] (exclusive) containing [text], in
+  /// the context of [contextLine].
+  ///
+  /// [start] and [end] must have the same source URL and [start] must come
+  /// before [end]. [text] must have a number of characters equal to the
+  /// distance between [start] and [end]. [contextLine] must contain [text], and
+  /// [text] should start at `start.column`.
+  SourceSpanWithContext(SourceLocation start, SourceLocation end, String text,
+      this.contextLine) : super(start, end, text) {

[nweiz, 2015/03/24 23:01:17]

Nit: put the super call on its own line.

[Siggi Cherem (dart-lang), 2015/03/25 00:33:25]

Done. This made me realized I was not running the formatter, so I went ahead and
ran it on the entire package

[nweiz, 2015/03/25 01:10:39]

I actually prefer to have format-everything CLs separate from functional CLs,
since they create a lot of churn. Also, it looks like a lot of the formatting
changes for this package are the same or worse than the original (especially in
the tests), so I'd rather not include them.

[Siggi Cherem (dart-lang), 2015/03/26 21:07:29]

OK reverted all other formatter changes.

In dev_compiler we are running the formatter on every CL so we don't think about
it anymroe

+    var index = contextLine.indexOf(text);
+    if (index != start.column) {
+      throw new ArgumentError('The context line "$contextLine" must '
+          'contain "$text" starting at column ${start.column + 1}.');

[nweiz, 2015/03/24 23:01:17]

I'd throw separate errors for [contextLine] not containing [text] and for the
column being wrong, so that it's easier for users to figure out what's going
wrong.

[Siggi Cherem (dart-lang), 2015/03/25 00:33:25]

Done.

+    }
+  }
+}