Index: pkg/analyzer_experimental/lib/src/generated/source.dart |
=================================================================== |
--- pkg/analyzer_experimental/lib/src/generated/source.dart (revision 23549) |
+++ pkg/analyzer_experimental/lib/src/generated/source.dart (working copy) |
@@ -7,45 +7,52 @@ |
import 'sdk.dart' show DartSdk; |
import 'engine.dart' show AnalysisContext; |
+ |
/** |
* Instances of the class {@code SourceFactory} resolve possibly relative URI's against an existing{@link Source source}. |
* @coverage dart.engine.source |
*/ |
class SourceFactory { |
+ |
/** |
* The analysis context that this source factory is associated with. |
*/ |
AnalysisContext _context; |
+ |
/** |
* The resolvers used to resolve absolute URI's. |
*/ |
List<UriResolver> _resolvers; |
+ |
/** |
* A cache of content used to override the default content of a source. |
*/ |
ContentCache _contentCache; |
+ |
/** |
* Initialize a newly created source factory. |
* @param contentCache the cache holding content used to override the default content of a source |
* @param resolvers the resolvers used to resolve absolute URI's |
*/ |
SourceFactory.con1(ContentCache contentCache2, List<UriResolver> resolvers2) { |
- _jtd_constructor_333_impl(contentCache2, resolvers2); |
+ _jtd_constructor_340_impl(contentCache2, resolvers2); |
} |
- _jtd_constructor_333_impl(ContentCache contentCache2, List<UriResolver> resolvers2) { |
+ _jtd_constructor_340_impl(ContentCache contentCache2, List<UriResolver> resolvers2) { |
this._contentCache = contentCache2; |
this._resolvers = resolvers2; |
} |
+ |
/** |
* Initialize a newly created source factory. |
* @param resolvers the resolvers used to resolve absolute URI's |
*/ |
SourceFactory.con2(List<UriResolver> resolvers) { |
- _jtd_constructor_334_impl(resolvers); |
+ _jtd_constructor_341_impl(resolvers); |
} |
- _jtd_constructor_334_impl(List<UriResolver> resolvers) { |
- _jtd_constructor_333_impl(new ContentCache(), resolvers); |
+ _jtd_constructor_341_impl(List<UriResolver> resolvers) { |
+ _jtd_constructor_340_impl(new ContentCache(), resolvers); |
} |
+ |
/** |
* Return a source object representing the given absolute URI, or {@code null} if the URI is not a |
* valid URI or if it is not an absolute URI. |
@@ -54,7 +61,7 @@ |
*/ |
Source forUri(String absoluteUri) { |
try { |
- Uri uri = Uri.parse(absoluteUri); |
+ Uri uri = parseUriWithException(absoluteUri); |
if (uri.isAbsolute) { |
return resolveUri2(null, uri); |
} |
@@ -62,6 +69,7 @@ |
} |
return null; |
} |
+ |
/** |
* Return a source object that is equal to the source object used to obtain the given encoding. |
* @param encoding the encoding of a source object |
@@ -78,7 +86,7 @@ |
throw new IllegalArgumentException("Invalid source kind in encoding: ${kind}"); |
} |
try { |
- Uri uri = Uri.parse(encoding.substring(1)); |
+ Uri uri = parseUriWithException(encoding.substring(1)); |
for (UriResolver resolver in _resolvers) { |
Source result = resolver.fromEncoding(_contentCache, kind, uri); |
if (result != null) { |
@@ -90,16 +98,19 @@ |
throw new IllegalArgumentException("Invalid URI in encoding"); |
} |
} |
+ |
/** |
* Return a cache of content used to override the default content of a source. |
* @return a cache of content used to override the default content of a source |
*/ |
ContentCache get contentCache => _contentCache; |
+ |
/** |
* Return the analysis context that this source factory is associated with. |
* @return the analysis context that this source factory is associated with |
*/ |
AnalysisContext get context => _context; |
+ |
/** |
* Return the {@link DartSdk} associated with this {@link SourceFactory}, or {@code null} if there |
* is no such SDK. |
@@ -115,6 +126,7 @@ |
} |
return null; |
} |
+ |
/** |
* Return a source object representing the URI that results from resolving the given (possibly |
* relative) contained URI against the URI associated with an existing source object, or{@code null} if either the contained URI is invalid or if it cannot be resolved against the |
@@ -125,12 +137,28 @@ |
*/ |
Source resolveUri(Source containingSource, String containedUri) { |
try { |
- return resolveUri2(containingSource, Uri.parse(containedUri)); |
+ return resolveUri2(containingSource, parseUriWithException(containedUri)); |
} on URISyntaxException catch (exception) { |
return null; |
} |
} |
+ |
/** |
+ * Return an absolute URI that represents the given source. |
+ * @param source the source to get URI for |
+ * @return the absolute URI representing the given source, may be {@code null} |
+ */ |
+ Uri restoreUri(Source source) { |
+ for (UriResolver resolver in _resolvers) { |
+ Uri uri = resolver.restoreAbsolute(source); |
+ if (uri != null) { |
+ return uri; |
+ } |
+ } |
+ return null; |
+ } |
+ |
+ /** |
* Set the contents of the given source to the given contents. This has the effect of overriding |
* the default contents of the source. If the contents are {@code null} the override is removed so |
* that the default contents will be returned. |
@@ -140,6 +168,7 @@ |
void setContents(Source source, String contents) { |
_contentCache.setContents(source, contents); |
} |
+ |
/** |
* Set the analysis context that this source factory is associated with to the given context. |
* <p> |
@@ -150,6 +179,7 @@ |
void set context(AnalysisContext context2) { |
this._context = context2; |
} |
+ |
/** |
* Return the contents of the given source, or {@code null} if this factory does not override the |
* contents of the source. |
@@ -159,6 +189,7 @@ |
* @return the contents of the given source |
*/ |
String getContents(Source source) => _contentCache.getContents(source); |
+ |
/** |
* Return the modification stamp of the given source, or {@code null} if this factory does not |
* override the contents of the source. |
@@ -168,6 +199,7 @@ |
* @return the modification stamp of the given source |
*/ |
int getModificationStamp(Source source) => _contentCache.getModificationStamp(source); |
+ |
/** |
* Return a source object representing the URI that results from resolving the given (possibly |
* relative) contained URI against the URI associated with an existing source object, or{@code null} if either the contained URI is invalid or if it cannot be resolved against the |
@@ -190,6 +222,7 @@ |
} |
} |
} |
+ |
/** |
* The abstract class {@code UriResolver} defines the behavior of objects that are used to resolve |
* URI's for a source factory. Subclasses of this class are expected to resolve a single scheme of |
@@ -197,12 +230,8 @@ |
* @coverage dart.engine.source |
*/ |
abstract class UriResolver { |
+ |
/** |
- * Initialize a newly created resolver. |
- */ |
- UriResolver() : super() { |
- } |
- /** |
* If this resolver should be used for URI's of the given kind, resolve the given absolute URI. |
* The URI does not need to have the scheme handled by this resolver if the kind matches. Return a{@link Source source} representing the file to which it was resolved, or {@code null} if it |
* could not be resolved. |
@@ -213,6 +242,7 @@ |
* @return a {@link Source source} representing the file to which given URI was resolved |
*/ |
Source fromEncoding(ContentCache contentCache, UriKind kind, Uri uri); |
+ |
/** |
* Resolve the given absolute URI. Return a {@link Source source} representing the file to which |
* it was resolved, or {@code null} if it could not be resolved. |
@@ -221,17 +251,27 @@ |
* @return a {@link Source source} representing the file to which given URI was resolved |
*/ |
Source resolveAbsolute(ContentCache contentCache, Uri uri); |
+ |
+ /** |
+ * Return an absolute URI that represents the given source. |
+ * @param source the source to get URI for |
+ * @return the absolute URI representing the given source, may be {@code null} |
+ */ |
+ Uri restoreAbsolute(Source source) => null; |
} |
+ |
/** |
* The interface {@code Source} defines the behavior of objects representing source code that can be |
* compiled. |
* @coverage dart.engine.source |
*/ |
abstract class Source { |
+ |
/** |
* An empty array of sources. |
*/ |
static List<Source> EMPTY_ARRAY = new List<Source>(0); |
+ |
/** |
* Return {@code true} if the given object is a source that represents the same source code as |
* this source. |
@@ -241,11 +281,13 @@ |
* @see Object#equals(Object) |
*/ |
bool operator ==(Object object); |
+ |
/** |
* Return {@code true} if this source exists. |
* @return {@code true} if this source exists |
*/ |
bool exists(); |
+ |
/** |
* Get the contents of this source and pass it to the given receiver. Exactly one of the methods |
* defined on the receiver will be invoked unless an exception is thrown. The method that will be |
@@ -255,6 +297,7 @@ |
* @throws Exception if the contents of this source could not be accessed |
*/ |
void getContents(Source_ContentReceiver receiver); |
+ |
/** |
* Return an encoded representation of this source that can be used to create a source that is |
* equal to this source. |
@@ -262,6 +305,7 @@ |
* @see SourceFactory#fromEncoding(String) |
*/ |
String get encoding; |
+ |
/** |
* Return the full (long) version of the name that can be displayed to the user to denote this |
* source. For example, for a source representing a file this would typically be the absolute path |
@@ -269,6 +313,7 @@ |
* @return a name that can be displayed to the user to denote this source |
*/ |
String get fullName; |
+ |
/** |
* Return the modification stamp for this source. A modification stamp is a non-negative integer |
* with the property that if the contents of the source have not been modified since the last time |
@@ -278,12 +323,14 @@ |
* @return the modification stamp for this source |
*/ |
int get modificationStamp; |
+ |
/** |
* Return a short version of the name that can be displayed to the user to denote this source. For |
* example, for a source representing a file this would typically be the name of the file. |
* @return a name that can be displayed to the user to denote this source |
*/ |
String get shortName; |
+ |
/** |
* Return the kind of URI from which this source was originally derived. If this source was |
* created from an absolute URI, then the returned kind will reflect the scheme of the absolute |
@@ -292,17 +339,20 @@ |
* @return the kind of URI from which this source was originally derived |
*/ |
UriKind get uriKind; |
+ |
/** |
* Return a hash code for this source. |
* @return a hash code for this source |
* @see Object#hashCode() |
*/ |
int get hashCode; |
+ |
/** |
* Return {@code true} if this source is in one of the system libraries. |
* @return {@code true} if this is in a system library |
*/ |
bool isInSystemLibrary(); |
+ |
/** |
* Resolve the relative URI against the URI associated with this source object. Return a{@link Source source} representing the URI to which it was resolved, or {@code null} if it |
* could not be resolved. |
@@ -317,17 +367,20 @@ |
*/ |
Source resolveRelative(Uri relativeUri); |
} |
+ |
/** |
* The interface {@code ContentReceiver} defines the behavior of objects that can receive the |
* content of a source. |
*/ |
abstract class Source_ContentReceiver { |
+ |
/** |
* Accept the contents of a source represented as a character buffer. |
* @param contents the contents of the source |
* @param modificationTime the time at which the contents were last set |
*/ |
void accept(CharBuffer contents, int modificationTime); |
+ |
/** |
* Accept the contents of a source represented as a string. |
* @param contents the contents of the source |
@@ -335,25 +388,30 @@ |
*/ |
void accept2(String contents, int modificationTime); |
} |
+ |
/** |
* The enumeration {@code SourceKind} defines the different kinds of sources that are known to the |
* analysis engine. |
* @coverage dart.engine.source |
*/ |
class SourceKind implements Comparable<SourceKind> { |
+ |
/** |
* A source containing HTML. The HTML might or might not contain Dart scripts. |
*/ |
static final SourceKind HTML = new SourceKind('HTML', 0); |
+ |
/** |
* A Dart compilation unit that is not a part of another library. Libraries might or might not |
* contain any directives, including a library directive. |
*/ |
static final SourceKind LIBRARY = new SourceKind('LIBRARY', 1); |
+ |
/** |
* A Dart compilation unit that is part of another library. Parts contain a part-of directive. |
*/ |
static final SourceKind PART = new SourceKind('PART', 2); |
+ |
/** |
* An unknown kind of source. Used both when it is not possible to identify the kind of a source |
* and also when the kind of a source is not known without performing a computation and the client |
@@ -361,47 +419,60 @@ |
*/ |
static final SourceKind UNKNOWN = new SourceKind('UNKNOWN', 3); |
static final List<SourceKind> values = [HTML, LIBRARY, PART, UNKNOWN]; |
- final String __name; |
- final int __ordinal; |
- int get ordinal => __ordinal; |
- SourceKind(this.__name, this.__ordinal) { |
+ |
+ /// The name of this enum constant, as declared in the enum declaration. |
+ final String name; |
+ |
+ /// The position in the enum declaration. |
+ final int ordinal; |
+ SourceKind(this.name, this.ordinal) { |
} |
- int compareTo(SourceKind other) => __ordinal - other.__ordinal; |
- String toString() => __name; |
+ int compareTo(SourceKind other) => ordinal - other.ordinal; |
+ String toString() => name; |
} |
+ |
/** |
* The enumeration {@code UriKind} defines the different kinds of URI's that are known to the |
* analysis engine. These are used to keep track of the kind of URI associated with a given source. |
* @coverage dart.engine.source |
*/ |
class UriKind implements Comparable<UriKind> { |
+ |
/** |
* A 'dart:' URI. |
*/ |
static final UriKind DART_URI = new UriKind('DART_URI', 0, 0x64); |
+ |
/** |
* A 'file:' URI. |
*/ |
static final UriKind FILE_URI = new UriKind('FILE_URI', 1, 0x66); |
+ |
/** |
* A 'package:' URI. |
*/ |
static final UriKind PACKAGE_URI = new UriKind('PACKAGE_URI', 2, 0x70); |
static final List<UriKind> values = [DART_URI, FILE_URI, PACKAGE_URI]; |
- final String __name; |
- final int __ordinal; |
- int get ordinal => __ordinal; |
+ |
+ /// The name of this enum constant, as declared in the enum declaration. |
+ final String name; |
+ |
+ /// The position in the enum declaration. |
+ final int ordinal; |
+ |
/** |
* The single character encoding used to identify this kind of URI. |
*/ |
int _encoding = 0; |
+ |
/** |
* Initialize a newly created URI kind to have the given encoding. |
* @param encoding the single character encoding used to identify this kind of URI. |
*/ |
- UriKind(this.__name, this.__ordinal, int encoding) { |
+ UriKind(this.name, this.ordinal, int encoding) { |
this._encoding = encoding; |
} |
+ |
/** |
* Return the URI kind represented by the given encoding, or {@code null} if there is no kind with |
* the given encoding. |
@@ -421,29 +492,34 @@ |
} |
return null; |
} |
+ |
/** |
* Return the single character encoding used to identify this kind of URI. |
* @return the single character encoding used to identify this kind of URI |
*/ |
int get encoding => _encoding; |
- int compareTo(UriKind other) => __ordinal - other.__ordinal; |
- String toString() => __name; |
+ int compareTo(UriKind other) => ordinal - other.ordinal; |
+ String toString() => name; |
} |
+ |
/** |
* A source range defines an {@link Element}'s source coordinates relative to its {@link Source}. |
* @coverage dart.engine.utilities |
*/ |
class SourceRange { |
+ |
/** |
* The 0-based index of the first character of the source code for this element, relative to the |
* source buffer in which this element is contained. |
*/ |
int _offset = 0; |
+ |
/** |
* The number of characters of the source code for this element, relative to the source buffer in |
* which this element is contained. |
*/ |
int _length = 0; |
+ |
/** |
* Initialize a newly created source range using the given offset and the given length. |
* @param offset the given offset |
@@ -453,22 +529,27 @@ |
this._offset = offset; |
this._length = length; |
} |
+ |
/** |
* @return {@code true} if <code>x</code> is in \[offset, offset + length) interval. |
*/ |
bool contains(int x) => _offset <= x && x < _offset + _length; |
+ |
/** |
* @return {@code true} if <code>x</code> is in (offset, offset + length) interval. |
*/ |
bool containsExclusive(int x) => _offset < x && x < _offset + _length; |
+ |
/** |
* @return {@code true} if <code>otherRange</code> covers this {@link SourceRange}. |
*/ |
bool coveredBy(SourceRange otherRange) => otherRange.covers(this); |
+ |
/** |
* @return {@code true} if this {@link SourceRange} covers <code>otherRange</code>. |
*/ |
bool covers(SourceRange otherRange) => offset <= otherRange.offset && otherRange.end <= end; |
+ |
/** |
* @return {@code true} if this {@link SourceRange} ends in <code>otherRange</code>. |
*/ |
@@ -483,15 +564,18 @@ |
SourceRange sourceRange = obj as SourceRange; |
return sourceRange.offset == _offset && sourceRange.length == _length; |
} |
+ |
/** |
* @return the 0-based index of the after-last character of the source code for this element, |
* relative to the source buffer in which this element is contained. |
*/ |
int get end => _offset + _length; |
+ |
/** |
* @return the expanded instance of {@link SourceRange}, which has the same center. |
*/ |
SourceRange getExpanded(int delta) => new SourceRange(_offset - delta, delta + _length + delta); |
+ |
/** |
* Returns the number of characters of the source code for this element, relative to the source |
* buffer in which this element is contained. |
@@ -499,10 +583,12 @@ |
* buffer in which this element is contained |
*/ |
int get length => _length; |
+ |
/** |
* @return the instance of {@link SourceRange} with end moved on "delta". |
*/ |
SourceRange getMoveEnd(int delta) => new SourceRange(_offset, _length + delta); |
+ |
/** |
* Returns the 0-based index of the first character of the source code for this element, relative |
* to the source buffer in which this element is contained. |
@@ -510,7 +596,13 @@ |
* to the source buffer in which this element is contained |
*/ |
int get offset => _offset; |
+ |
+ /** |
+ * @return the expanded translated of {@link SourceRange}, with moved start and the same length. |
+ */ |
+ SourceRange getTranslated(int delta) => new SourceRange(_offset + delta, _length); |
int get hashCode => 31 * _offset + _length; |
+ |
/** |
* @return {@code true} if this {@link SourceRange} intersects with given. |
*/ |
@@ -526,6 +618,7 @@ |
} |
return true; |
} |
+ |
/** |
* @return {@code true} if this {@link SourceRange} starts in <code>otherRange</code>. |
*/ |
@@ -540,6 +633,7 @@ |
return builder.toString(); |
} |
} |
+ |
/** |
* The interface {@code SourceContainer} is used by clients to define a collection of sources |
* <p> |
@@ -550,6 +644,7 @@ |
* @coverage dart.engine.source |
*/ |
abstract class SourceContainer { |
+ |
/** |
* Determine if the specified source is part of the receiver's collection of sources. |
* @param source the source in question |
@@ -557,25 +652,30 @@ |
*/ |
bool contains(Source source); |
} |
+ |
/** |
* Instances of the class {@code DartUriResolver} resolve {@code dart} URI's. |
* @coverage dart.engine.source |
*/ |
class DartUriResolver extends UriResolver { |
+ |
/** |
* The Dart SDK against which URI's are to be resolved. |
*/ |
DartSdk _sdk; |
+ |
/** |
* The name of the {@code dart} scheme. |
*/ |
static String _DART_SCHEME = "dart"; |
+ |
/** |
* Return {@code true} if the given URI is a {@code dart:} URI. |
* @param uri the URI being tested |
* @return {@code true} if the given URI is a {@code dart:} URI |
*/ |
- static bool isDartUri(Uri uri) => uri.scheme == _DART_SCHEME; |
+ static bool isDartUri(Uri uri) => _DART_SCHEME == uri.scheme; |
+ |
/** |
* Initialize a newly created resolver to resolve Dart URI's against the given platform within the |
* given Dart SDK. |
@@ -590,6 +690,7 @@ |
} |
return null; |
} |
+ |
/** |
* Return the {@link DartSdk} against which URIs are to be resolved. |
* @return the {@link DartSdk} against which URIs are to be resolved. |
@@ -602,16 +703,19 @@ |
return _sdk.mapDartUri(contentCache, uri.toString()); |
} |
} |
+ |
/** |
* Instances of the class {@code LineInfo} encapsulate information about line and column information |
* within a source file. |
* @coverage dart.engine.utilities |
*/ |
class LineInfo { |
+ |
/** |
* An array containing the offsets of the first character of each line in the source code. |
*/ |
List<int> _lineStarts; |
+ |
/** |
* Initialize a newly created set of line information to represent the data encoded in the given |
* array. |
@@ -625,6 +729,7 @@ |
} |
this._lineStarts = lineStarts; |
} |
+ |
/** |
* Return the location information for the character at the given offset. |
* @param offset the offset of the character for which location information is to be returned |
@@ -640,19 +745,23 @@ |
return new LineInfo_Location(lineCount, offset - _lineStarts[lineCount - 1] + 1); |
} |
} |
+ |
/** |
* Instances of the class {@code Location} represent the location of a character as a line and |
* column pair. |
*/ |
class LineInfo_Location { |
+ |
/** |
* The one-based index of the line containing the character. |
*/ |
int _lineNumber = 0; |
+ |
/** |
* The one-based index of the column containing the character. |
*/ |
int _columnNumber = 0; |
+ |
/** |
* Initialize a newly created location to represent the location of the character at the given |
* line and column position. |
@@ -663,38 +772,39 @@ |
this._lineNumber = lineNumber; |
this._columnNumber = columnNumber; |
} |
+ |
/** |
* Return the one-based index of the column containing the character. |
* @return the one-based index of the column containing the character |
*/ |
int get columnNumber => _columnNumber; |
+ |
/** |
* Return the one-based index of the line containing the character. |
* @return the one-based index of the line containing the character |
*/ |
int get lineNumber => _lineNumber; |
} |
+ |
/** |
* Instances of class {@code ContentCache} hold content used to override the default content of a{@link Source}. |
* @coverage dart.engine.source |
*/ |
class ContentCache { |
+ |
/** |
* A table mapping sources to the contents of those sources. This is used to override the default |
* contents of a source. |
*/ |
Map<Source, String> _contentMap = new Map<Source, String>(); |
+ |
/** |
* A table mapping sources to the modification stamps of those sources. This is used when the |
* default contents of a source has been overridden. |
*/ |
Map<Source, int> _stampMap = new Map<Source, int>(); |
+ |
/** |
- * Initialize a newly created cache to be empty. |
- */ |
- ContentCache() : super() { |
- } |
- /** |
* Return the contents of the given source, or {@code null} if this cache does not override the |
* contents of the source. |
* <p> |
@@ -703,6 +813,7 @@ |
* @return the contents of the given source |
*/ |
String getContents(Source source) => _contentMap[source]; |
+ |
/** |
* Return the modification stamp of the given source, or {@code null} if this cache does not |
* override the contents of the source. |
@@ -712,6 +823,7 @@ |
* @return the modification stamp of the given source |
*/ |
int getModificationStamp(Source source) => _stampMap[source]; |
+ |
/** |
* Set the contents of the given source to the given contents. This has the effect of overriding |
* the default contents of the source. If the contents are {@code null} the override is removed so |
@@ -728,4 +840,4 @@ |
_stampMap[source] = JavaSystem.currentTimeMillis(); |
} |
} |
-} |
+} |