| // Copyright (c) 2017, 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/dart/analysis/results.dart'; |
| import 'package:analyzer/file_system/file_system.dart'; |
| import 'package:analyzer_plugin/protocol/protocol.dart'; |
| import 'package:analyzer_plugin/protocol/protocol_generated.dart'; |
| import 'package:analyzer_plugin/src/utilities/assist/assist.dart'; |
| import 'package:analyzer_plugin/utilities/generator.dart'; |
| |
| /// An object that [AssistContributor]s use to record assists. |
| /// |
| /// Clients may not extend, implement or mix-in this class. |
| abstract class AssistCollector { |
| /// Record a new [assist]. |
| void addAssist(PrioritizedSourceChange assist); |
| } |
| |
| /// An object used to produce assists. |
| /// |
| /// Clients may implement this class when implementing plugins. |
| abstract class AssistContributor { |
| /// Contribute assists for the location in the file specified by the given |
| /// [request] into the given [collector]. |
| Future<void> computeAssists( |
| covariant AssistRequest request, AssistCollector collector); |
| } |
| |
| /// A generator that will generate an 'edit.getAssists' response. |
| /// |
| /// Clients may not extend, implement or mix-in this class. |
| class AssistGenerator { |
| /// The contributors to be used to generate the assists. |
| final List<AssistContributor> contributors; |
| |
| /// Initialize a newly created assists generator to use the given |
| /// [contributors]. |
| AssistGenerator(this.contributors); |
| |
| /// Create an 'edit.getAssists' response for the location in the file specified |
| /// by the given [request]. If any of the contributors throws an exception, |
| /// also create a non-fatal 'plugin.error' notification. |
| Future<GeneratorResult<EditGetAssistsResult>> generateAssistsResponse( |
| AssistRequest request) async { |
| var notifications = <Notification>[]; |
| var collector = AssistCollectorImpl(); |
| for (var contributor in contributors) { |
| try { |
| await contributor.computeAssists(request, collector); |
| } catch (exception, stackTrace) { |
| notifications.add(PluginErrorParams( |
| false, exception.toString(), stackTrace.toString()) |
| .toNotification()); |
| } |
| } |
| var result = EditGetAssistsResult(collector.assists); |
| return GeneratorResult(result, notifications); |
| } |
| } |
| |
| /// A description of a class of assists. Instances are intended to hold the |
| /// information that is common across a number of assists and to be shared by |
| /// those assists. |
| /// |
| /// Clients may not extend, implement or mix-in this class. |
| class AssistKind { |
| /// The unique identifier of this kind of assist. May be used by client editors, |
| /// for example to allow key-binding specific fixes (or groups of). |
| final String id; |
| |
| /// The priority of this kind of assist for the kind of error being addressed. |
| final int priority; |
| |
| /// A human-readable description of the changes that will be applied by this |
| /// kind of assist. The message can contain parameters, where each parameter is |
| /// represented by a zero-based index inside curly braces. For example, the |
| /// message `"Create a component named '{0}' in '{1}'"` contains two parameters. |
| final String message; |
| |
| /// Initialize a newly created kind of assist to have the given [id], |
| /// [priority] and [message]. |
| const AssistKind(this.id, this.priority, this.message); |
| |
| @override |
| String toString() => id; |
| } |
| |
| /// The information about a requested set of assists. |
| /// |
| /// Clients may not extend, implement or mix-in this class. |
| abstract class AssistRequest { |
| /// Return the length of the selection within the source for which assists are |
| /// being requested. |
| int get length; |
| |
| /// Return the offset of the selection within the source for which assists are |
| /// being requested. |
| int get offset; |
| |
| /// Return the resource provider associated with this request. |
| ResourceProvider get resourceProvider; |
| } |
| |
| /// The information about a requested set of assists when computing assists in a |
| /// `.dart` file. |
| /// |
| /// Clients may not extend, implement or mix-in this class. |
| abstract class DartAssistRequest implements AssistRequest { |
| /// The analysis result for the file in which the assists are being requested. |
| ResolvedUnitResult get result; |
| } |