| // 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 'package:analyzer/src/context/cache.dart'; | |
| import 'package:analyzer/src/generated/engine.dart'; | |
| import 'package:analyzer/src/generated/source.dart'; | |
| import 'package:analyzer/src/task/api/general.dart'; | |
| import 'package:analyzer/src/task/api/model.dart'; | |
| /** | |
| * A task that gets the contents of the source associated with an analysis | |
| * target. | |
| */ | |
| class GetContentTask extends SourceBasedAnalysisTask { | |
| /** | |
| * The task descriptor describing this kind of task. | |
| */ | |
| static final TaskDescriptor DESCRIPTOR = new TaskDescriptor('GetContentTask', | |
| createTask, buildInputs, <ResultDescriptor>[CONTENT, MODIFICATION_TIME]); | |
| /** | |
| * Initialize a newly created task to access the content of the source | |
| * associated with the given [target] in the given [context]. | |
| */ | |
| GetContentTask(AnalysisContext context, AnalysisTarget target) | |
| : super(context, target); | |
| @override | |
| TaskDescriptor get descriptor => DESCRIPTOR; | |
| @override | |
| internalPerform() { | |
| Source source = getRequiredSource(); | |
| String content; | |
| int modificationTime; | |
| try { | |
| TimestampedData<String> data = context.getContents(source); | |
| content = data.data; | |
| modificationTime = data.modificationTime; | |
| } catch (exception) { | |
| content = ''; | |
| modificationTime = -1; | |
| } | |
| _validateModificationTime(source, modificationTime); | |
| outputs[CONTENT] = content; | |
| outputs[MODIFICATION_TIME] = modificationTime; | |
| } | |
| /** | |
| * Validate that the [target] cache entry has the same modification time | |
| * as the given. Otherwise throw a new [ModificationTimeMismatchError] and | |
| * instruct to invalidate targets content. | |
| */ | |
| void _validateModificationTime(Source source, int modificationTime) { | |
| AnalysisContext context = this.context; | |
| if (context is InternalAnalysisContext) { | |
| CacheEntry entry = context.getCacheEntry(target); | |
| if (entry != null && entry.modificationTime != modificationTime) { | |
| entry.modificationTime = modificationTime; | |
| entry.setState(CONTENT, CacheState.INVALID); | |
| entry.setState(MODIFICATION_TIME, CacheState.INVALID); | |
| throw new ModificationTimeMismatchError(source); | |
| } | |
| } | |
| } | |
| /** | |
| * Return a map from the names of the inputs of this kind of task to the task | |
| * input descriptors describing those inputs for a task with the given [target]. | |
| */ | |
| static Map<String, TaskInput> buildInputs(AnalysisTarget target) { | |
| return <String, TaskInput>{}; | |
| } | |
| /** | |
| * Create a [GetContentTask] based on the given [target] in the given | |
| * [context]. | |
| */ | |
| static GetContentTask createTask( | |
| AnalysisContext context, AnalysisTarget target) { | |
| return new GetContentTask(context, target); | |
| } | |
| } | |
| /** | |
| * A base class for analysis tasks whose target is expected to be a source. | |
| */ | |
| abstract class SourceBasedAnalysisTask extends AnalysisTask { | |
| /** | |
| * Initialize a newly created task to perform analysis within the given | |
| * [context] in order to produce results for the given [target]. | |
| */ | |
| SourceBasedAnalysisTask(AnalysisContext context, AnalysisTarget target) | |
| : super(context, target); | |
| @override | |
| String get description { | |
| Source source = target.source; | |
| String sourceName = source == null ? '<unknown source>' : source.fullName; | |
| return '${descriptor.name} for source $sourceName'; | |
| } | |
| } |