| // 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 'dart:async'; |
| |
| import 'package:analysis_server/src/protocol_server.dart' |
| show CompletionSuggestion, CompletionSuggestionKind; |
| import 'package:analysis_server/src/protocol_server.dart' as protocol |
| hide CompletionSuggestion, CompletionSuggestionKind; |
| import 'package:analysis_server/src/provisional/completion/dart/completion_dart.dart'; |
| import 'package:analysis_server/src/services/completion/dart/suggestion_builder.dart'; |
| import 'package:analysis_server/src/utilities/extensions/ast.dart'; |
| import 'package:analyzer/dart/analysis/features.dart'; |
| import 'package:analyzer/dart/ast/ast.dart'; |
| import 'package:analyzer/dart/element/element.dart'; |
| import 'package:analyzer/dart/element/nullability_suffix.dart'; |
| import 'package:analyzer/dart/element/type.dart'; |
| import 'package:analyzer/source/source_range.dart'; |
| import 'package:analyzer/src/dart/element/inheritance_manager3.dart'; |
| import 'package:analyzer_plugin/src/utilities/completion/completion_target.dart'; |
| import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; |
| import 'package:analyzer_plugin/utilities/range_factory.dart'; |
| |
| /// A completion contributor used to suggest replacing partial identifiers |
| /// inside a class declaration with templates for inherited members. |
| class OverrideContributor implements DartCompletionContributor { |
| @override |
| Future<List<CompletionSuggestion>> computeSuggestions( |
| DartCompletionRequest request, SuggestionBuilder builder) async { |
| var target = request.target; |
| var containingNode = target.containingNode; |
| var classDecl = |
| containingNode.thisOrAncestorOfType<ClassOrMixinDeclaration>(); |
| if (classDecl == null) { |
| return const <CompletionSuggestion>[]; |
| } |
| if (containingNode.inClassMemberBody) { |
| return const <CompletionSuggestion>[]; |
| } |
| |
| var comment = containingNode.thisOrAncestorOfType<Comment>(); |
| if (target.isCommentText || comment != null) { |
| return const <CompletionSuggestion>[]; |
| } |
| |
| var sourceRange = _getTargetSourceRange(target); |
| sourceRange ??= range.startOffsetEndOffset(request.offset, 0); |
| |
| var inheritance = InheritanceManager3(); |
| |
| // Generate a collection of inherited members |
| var classElem = classDecl.declaredElement; |
| var classType = _thisType(request, classElem); |
| var interface = inheritance.getInterface(classType); |
| var interfaceMap = interface.map; |
| var namesToOverride = |
| _namesToOverride(classElem.librarySource.uri, interface); |
| |
| // Build suggestions |
| var suggestions = <CompletionSuggestion>[]; |
| for (var name in namesToOverride) { |
| var element = interfaceMap[name]; |
| // Gracefully degrade if the overridden element has not been resolved. |
| if (element.returnType != null) { |
| var invokeSuper = interface.isSuperImplemented(name); |
| var suggestion = |
| await _buildSuggestion(request, sourceRange, element, invokeSuper); |
| if (suggestion != null) { |
| suggestions.add(suggestion); |
| } |
| } |
| } |
| return suggestions; |
| } |
| |
| /// Build a suggestion to replace [sourceRange] in the given [request] with an |
| /// override of the given [element]. |
| Future<CompletionSuggestion> _buildSuggestion( |
| DartCompletionRequest request, |
| SourceRange sourceRange, |
| ExecutableElement element, |
| bool invokeSuper) async { |
| var displayTextBuffer = StringBuffer(); |
| var builder = DartChangeBuilder(request.result.session); |
| await builder.addFileEdit(request.result.path, (builder) { |
| builder.addReplacement(sourceRange, (builder) { |
| builder.writeOverride( |
| element, |
| displayTextBuffer: displayTextBuffer, |
| invokeSuper: invokeSuper, |
| ); |
| }); |
| }); |
| |
| var fileEdits = builder.sourceChange.edits; |
| if (fileEdits.length != 1) return null; |
| |
| var sourceEdits = fileEdits[0].edits; |
| if (sourceEdits.length != 1) return null; |
| |
| var replacement = sourceEdits[0].replacement; |
| var completion = replacement.trim(); |
| var overrideAnnotation = '@override'; |
| if (_hasOverride(request.target.containingNode) && |
| completion.startsWith(overrideAnnotation)) { |
| completion = completion.substring(overrideAnnotation.length).trim(); |
| } |
| if (completion.isEmpty) { |
| return null; |
| } |
| |
| var selectionRange = builder.selectionRange; |
| if (selectionRange == null) { |
| return null; |
| } |
| var offsetDelta = sourceRange.offset + replacement.indexOf(completion); |
| var displayText = |
| displayTextBuffer.isNotEmpty ? displayTextBuffer.toString() : null; |
| var suggestion = CompletionSuggestion( |
| CompletionSuggestionKind.OVERRIDE, |
| request.useNewRelevance ? Relevance.override : DART_RELEVANCE_HIGH, |
| completion, |
| selectionRange.offset - offsetDelta, |
| selectionRange.length, |
| element.hasDeprecated, |
| false, |
| displayText: displayText); |
| suggestion.element = protocol.convertElement(element); |
| return suggestion; |
| } |
| |
| SimpleIdentifier _getTargetIdFromVarList(VariableDeclarationList fields) { |
| var variables = fields.variables; |
| if (variables.length == 1) { |
| var variable = variables[0]; |
| var targetId = variable.name; |
| if (targetId.name.isEmpty) { |
| // analyzer parser |
| // Actual: class C { foo^ } |
| // Parsed: class C { foo^ _s_ } |
| // where _s_ is a synthetic id inserted by the analyzer parser |
| return targetId; |
| } else if (fields.keyword == null && |
| fields.type == null && |
| variable.initializer == null) { |
| // fasta parser does not insert a synthetic identifier |
| return targetId; |
| } |
| } |
| return null; |
| } |
| |
| /// If the target looks like a partial identifier inside a class declaration |
| /// then return that identifier [SourceRange], otherwise return `null`. |
| SourceRange _getTargetSourceRange(CompletionTarget target) { |
| var containingNode = target.containingNode; |
| if (containingNode is ClassOrMixinDeclaration) { |
| if (target.entity is FieldDeclaration) { |
| var fieldDecl = target.entity as FieldDeclaration; |
| var simpleIdentifier = _getTargetIdFromVarList(fieldDecl.fields); |
| if (simpleIdentifier != null) { |
| return range.node(simpleIdentifier); |
| } |
| } |
| } else if (containingNode is FieldDeclaration) { |
| if (target.entity is VariableDeclarationList) { |
| var simpleIdentifier = _getTargetIdFromVarList(target.entity); |
| if (simpleIdentifier != null) { |
| return range.node(simpleIdentifier); |
| } |
| } |
| } |
| return null; |
| } |
| |
| /// Return `true` if the given [node] has an `override` annotation. |
| bool _hasOverride(AstNode node) { |
| if (node is AnnotatedNode) { |
| var metadata = node.metadata; |
| for (var annotation in metadata) { |
| if (annotation.name.name == 'override' && |
| annotation.arguments == null) { |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| /// Return the list of names that belong to the [interface] of a class, but |
| /// are not yet declared in the class. |
| List<Name> _namesToOverride(Uri libraryUri, Interface interface) { |
| var namesToOverride = <Name>[]; |
| for (var name in interface.map.keys) { |
| if (name.isAccessibleFor(libraryUri)) { |
| if (!interface.declared.containsKey(name)) { |
| namesToOverride.add(name); |
| } |
| } |
| } |
| return namesToOverride; |
| } |
| |
| InterfaceType _thisType( |
| DartCompletionRequest request, |
| ClassElement thisElement, |
| ) { |
| var typeParameters = thisElement.typeParameters; |
| var typeArguments = const <DartType>[]; |
| if (typeParameters.isNotEmpty) { |
| var nullabilitySuffix = request.featureSet.isEnabled(Feature.non_nullable) |
| ? NullabilitySuffix.none |
| : NullabilitySuffix.star; |
| typeArguments = typeParameters.map((t) { |
| return t.instantiate(nullabilitySuffix: nullabilitySuffix); |
| }).toList(); |
| } |
| |
| return thisElement.instantiate( |
| typeArguments: typeArguments, |
| nullabilitySuffix: NullabilitySuffix.none, |
| ); |
| } |
| } |