Convert LocalReferenceContributor to use SuggestionBuilder

Change-Id: I1065b6294b315abcf60b9e743a9c6961a3080978
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/147047
Reviewed-by: Jaime Wren <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>

Author: bwilkerson

pkg/analysis_server/lib/src/cider/completion.dart

@@ -9,6 +9,7 @@ import 'package:analysis_server/src/services/completion/completion_core.dart';
 import 'package:analysis_server/src/services/completion/completion_performance.dart';
 import 'package:analysis_server/src/services/completion/dart/completion_manager.dart';
 import 'package:analysis_server/src/services/completion/dart/local_library_contributor.dart';
+import 'package:analysis_server/src/services/completion/dart/suggestion_builder.dart';
 import 'package:analysis_server/src/services/completion/filtering/fuzzy_matcher.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart' show LibraryElement;
@@ -188,12 +189,14 @@ class CiderCompletionComputer {
   /// Compute all unprefixed suggestions for all elements exported from
   /// the library.
   List<CompletionSuggestion> _librarySuggestions(LibraryElement element) {
-    var visitor = LibraryElementSuggestionBuilder(_dartCompletionRequest, '');
+    var suggestionBuilder = SuggestionBuilder(_dartCompletionRequest);
+    var visitor = LibraryElementSuggestionBuilder(
+        _dartCompletionRequest, suggestionBuilder);
     var exportMap = element.exportNamespace.definedNames;
     for (var definedElement in exportMap.values) {
       definedElement.accept(visitor);
     }
-    return visitor.suggestions;
+    return visitor.suggestions..addAll(suggestionBuilder.suggestions);
   }
 }
 

pkg/analysis_server/lib/src/services/completion/dart/imported_reference_contributor.dart

@@ -36,8 +36,10 @@ class ImportedReferenceContributor extends DartCompletionContributor {
       var libraryElement = importElement.importedLibrary;
       if (libraryElement != null) {
         final newSuggestions = _buildSuggestions(
-            request, importElement.namespace,
+            request, builder, importElement.namespace,
             prefix: importElement.prefix?.name);
+        // TODO(brianwilkerson) Remove this filtering after every suggestion is
+        //  being generated via SuggestionBuilder.
         for (var suggestion in newSuggestions) {
           // Filter out multiply-exported elements (like Future and Stream).
           if (seenElements.add(suggestion.element)) {
@@ -49,10 +51,10 @@ class ImportedReferenceContributor extends DartCompletionContributor {
     return suggestions;
   }
 
-  List<CompletionSuggestion> _buildSuggestions(
-      DartCompletionRequest request, Namespace namespace,
+  List<CompletionSuggestion> _buildSuggestions(DartCompletionRequest request,
+      SuggestionBuilder builder, Namespace namespace,
       {String prefix}) {
-    var visitor = LibraryElementSuggestionBuilder(request, prefix);
+    var visitor = LibraryElementSuggestionBuilder(request, builder, prefix);
     for (var elem in namespace.definedNames.values) {
       elem.accept(visitor);
     }

pkg/analysis_server/lib/src/services/completion/dart/local_library_contributor.dart

@@ -4,20 +4,16 @@
 
 import 'dart:async';
 
+import 'package:analysis_server/src/protocol_server.dart'
+    show CompletionSuggestion, CompletionSuggestionKind;
 import 'package:analysis_server/src/provisional/completion/dart/completion_dart.dart';
-import 'package:analysis_server/src/services/completion/dart/feature_computer.dart';
 import 'package:analysis_server/src/services/completion/dart/suggestion_builder.dart'
-    show createSuggestion, ElementSuggestionBuilder, SuggestionBuilder;
-import 'package:analyzer/dart/analysis/features.dart';
+    show ElementSuggestionBuilder, SuggestionBuilder;
 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/dart/element/visitor.dart';
 import 'package:analyzer_plugin/src/utilities/completion/optype.dart';
 
-import '../../../protocol_server.dart'
-    show CompletionSuggestion, CompletionSuggestionKind;
-
 /// A visitor for building suggestions based upon the elements defined by
 /// a source file contained in the same library but not the same as
 /// the source in which the completions are being requested.
@@ -26,7 +22,9 @@ class LibraryElementSuggestionBuilder extends GeneralizingElementVisitor
   @override
   final DartCompletionRequest request;
 
-  final OpType optype;
+  final SuggestionBuilder builder;
+
+  final OpType opType;
 
   DartType contextType;
 
@@ -38,65 +36,31 @@ class LibraryElementSuggestionBuilder extends GeneralizingElementVisitor
   /// The set of libraries that have been, or are currently being, visited.
   final Set<LibraryElement> visitedLibraries = <LibraryElement>{};
 
-  LibraryElementSuggestionBuilder(this.request, [this.prefix])
-      : optype = request.opType {
+  LibraryElementSuggestionBuilder(this.request, this.builder, [this.prefix])
+      : opType = request.opType {
     contextType = request.featureComputer
         .computeContextType(request.target.containingNode);
     kind = request.target.isFunctionalArgument()
         ? CompletionSuggestionKind.IDENTIFIER
-        : optype.suggestKind;
+        : opType.suggestKind;
   }
 
   @override
   LibraryElement get containingLibrary => request.libraryElement;
 
   @override
   void visitClassElement(ClassElement element) {
-    if (optype.includeTypeNameSuggestions) {
-      // if includeTypeNameSuggestions, then use the filter
-      int relevance;
-      if (request.useNewRelevance) {
-        relevance = _relevanceForType(element.thisType);
-      } else if (element.hasDeprecated) {
-        relevance = DART_RELEVANCE_LOW;
-      } else {
-        relevance = optype.typeNameSuggestionsFilter(
-            _instantiateClassElement(element), DART_RELEVANCE_DEFAULT);
-      }
-      if (relevance != null) {
-        addSuggestion(element, prefix: prefix, relevance: relevance);
-      }
+    if (opType.includeTypeNameSuggestions) {
+      builder.suggestClass(element, kind: kind, prefix: prefix);
     }
-    if (optype.includeConstructorSuggestions) {
-      int relevance;
-      if (request.useNewRelevance) {
-        relevance = _relevanceForType(element.thisType);
-      } else if (element.hasDeprecated) {
-        relevance = DART_RELEVANCE_LOW;
-      } else {
-        relevance = optype.returnValueSuggestionsFilter(
-            _instantiateClassElement(element), DART_RELEVANCE_DEFAULT);
-      }
-      _addConstructorSuggestions(element, relevance);
+    if (opType.includeConstructorSuggestions) {
+      _addConstructorSuggestions(element);
     }
-    if (optype.includeReturnValueSuggestions) {
+    if (opType.includeReturnValueSuggestions) {
       if (element.isEnum) {
-        var enumName = element.displayName;
-        int relevance;
-        if (request.useNewRelevance) {
-          relevance = _relevanceForType(element.thisType);
-        } else if (element.hasDeprecated) {
-          relevance = DART_RELEVANCE_LOW;
-        } else {
-          relevance = optype.returnValueSuggestionsFilter(
-              _instantiateClassElement(element), DART_RELEVANCE_DEFAULT);
-        }
         for (var field in element.fields) {
           if (field.isEnumConstant) {
-            addSuggestion(field,
-                prefix: prefix,
-                relevance: relevance,
-                elementCompletion: '$enumName.${field.name}');
+            builder.suggestEnumConstant(field, prefix: prefix);
           }
         }
       }
@@ -115,15 +79,8 @@ class LibraryElementSuggestionBuilder extends GeneralizingElementVisitor
 
   @override
   void visitExtensionElement(ExtensionElement element) {
-    if (optype.includeReturnValueSuggestions) {
-      int relevance;
-      if (request.useNewRelevance) {
-        relevance = _relevanceForType(element.extendedType);
-      } else {
-        relevance =
-            element.hasDeprecated ? DART_RELEVANCE_LOW : DART_RELEVANCE_DEFAULT;
-      }
-      addSuggestion(element, prefix: prefix, relevance: relevance);
+    if (opType.includeReturnValueSuggestions) {
+      builder.suggestExtension(element, kind: kind, prefix: prefix);
     }
     element.visitChildren(this);
   }
@@ -138,43 +95,21 @@ class LibraryElementSuggestionBuilder extends GeneralizingElementVisitor
       return;
     }
     var returnType = element.returnType;
-    int relevance;
-    if (request.useNewRelevance) {
-      relevance = _relevanceForType(returnType);
-    } else {
-      relevance = element.hasDeprecated
-          ? DART_RELEVANCE_LOW
-          : (element.library == containingLibrary
-              ? DART_RELEVANCE_LOCAL_FUNCTION
-              : DART_RELEVANCE_DEFAULT);
-    }
     if (returnType != null && returnType.isVoid) {
-      if (optype.includeVoidReturnSuggestions) {
-        addSuggestion(element, prefix: prefix, relevance: relevance);
+      if (opType.includeVoidReturnSuggestions) {
+        builder.suggestTopLevelFunction(element, kind: kind, prefix: prefix);
       }
     } else {
-      if (optype.includeReturnValueSuggestions) {
-        addSuggestion(element, prefix: prefix, relevance: relevance);
+      if (opType.includeReturnValueSuggestions) {
+        builder.suggestTopLevelFunction(element, kind: kind, prefix: prefix);
       }
     }
   }
 
   @override
   void visitFunctionTypeAliasElement(FunctionTypeAliasElement element) {
-    if (optype.includeTypeNameSuggestions) {
-      int relevance;
-      if (request.useNewRelevance) {
-        // TODO(brianwilkerson) Figure out whether there are any features that
-        //  ought to be used here and what the right default value is.
-        relevance = 400;
-      } else {
-        relevance = element.hasDeprecated
-            ? DART_RELEVANCE_LOW
-            : (element.library == containingLibrary
-                ? DART_RELEVANCE_LOCAL_FUNCTION
-                : DART_RELEVANCE_DEFAULT);
-      }
-      addSuggestion(element, prefix: prefix, relevance: relevance);
+    if (opType.includeTypeNameSuggestions) {
+      builder.suggestFunctionTypeAlias(element, prefix: prefix);
     }
   }
 
@@ -187,96 +122,36 @@ class LibraryElementSuggestionBuilder extends GeneralizingElementVisitor
 
   @override
   void visitPropertyAccessorElement(PropertyAccessorElement element) {
-    if (optype.includeReturnValueSuggestions) {
-      int relevance;
-      if (request.useNewRelevance) {
-        relevance = _relevanceForType(element.returnType);
-      } else if (element.hasDeprecated) {
-        relevance = DART_RELEVANCE_LOW;
+    if (opType.includeReturnValueSuggestions) {
+      if (element.enclosingElement is ClassElement) {
+        // TODO(brianwilkerson) Verify that we cannot reach this point and
+        //  remove the dead code.
+        builder.suggestAccessor(element, inheritanceDistance: -1.0);
       } else {
-        if (element.library == containingLibrary) {
-          if (element.enclosingElement is ClassElement) {
-            relevance = DART_RELEVANCE_LOCAL_FIELD;
-          } else {
-            relevance = DART_RELEVANCE_LOCAL_TOP_LEVEL_VARIABLE;
-          }
-        } else {
-          relevance = DART_RELEVANCE_DEFAULT;
-        }
+        builder.suggestTopLevelPropertyAccessor(element, prefix: prefix);
       }
-      addSuggestion(element, prefix: prefix, relevance: relevance);
     }
   }
 
   @override
   void visitTopLevelVariableElement(TopLevelVariableElement element) {
-    if (optype.includeReturnValueSuggestions) {
-      int relevance;
-      if (request.useNewRelevance) {
-        relevance = _relevanceForType(element.type);
-      } else {
-        relevance = element.hasDeprecated
-            ? DART_RELEVANCE_LOW
-            : (element.library == containingLibrary
-                ? DART_RELEVANCE_LOCAL_TOP_LEVEL_VARIABLE
-                : DART_RELEVANCE_DEFAULT);
-      }
-      addSuggestion(element, prefix: prefix, relevance: relevance);
+    if (opType.includeReturnValueSuggestions && !element.isSynthetic) {
+      builder.suggestTopLevelVariable(element, prefix: prefix);
     }
   }
 
   /// Add constructor suggestions for the given class.
-  void _addConstructorSuggestions(ClassElement classElem, int relevance) {
-    var className = classElem.name;
+  void _addConstructorSuggestions(ClassElement classElem) {
     for (var constructor in classElem.constructors) {
       if (constructor.isPrivate) {
         continue;
       }
       if (classElem.isAbstract && !constructor.isFactory) {
         continue;
       }
-
-      var completion = constructor.displayName;
-      completion = completion.isNotEmpty ? '$className.$completion' : className;
-      if (prefix != null && prefix.isNotEmpty) {
-        completion = '$prefix.$completion';
-      }
-      var suggestion = createSuggestion(request, constructor,
-          completion: completion, relevance: relevance);
-      if (suggestion != null) {
-        suggestion.selectionOffset = suggestion.completion.length;
-        suggestions.add(suggestion);
-      }
+      builder.suggestConstructor(constructor, kind: kind, prefix: prefix);
     }
   }
-
-  InterfaceType _instantiateClassElement(ClassElement element) {
-    var typeParameters = element.typeParameters;
-    var typeArguments = const <DartType>[];
-    if (typeParameters.isNotEmpty) {
-      var typeProvider = request.libraryElement.typeProvider;
-      typeArguments = typeParameters.map((t) {
-        return typeProvider.dynamicType;
-      }).toList();
-    }
-
-    var nullabilitySuffix = request.featureSet.isEnabled(Feature.non_nullable)
-        ? NullabilitySuffix.none
-        : NullabilitySuffix.star;
-
-    return element.instantiate(
-      typeArguments: typeArguments,
-      nullabilitySuffix: nullabilitySuffix,
-    );
-  }
-
-  int _relevanceForType(DartType elementType) {
-    var contextTypeFeature =
-        request.featureComputer.contextTypeFeature(contextType, elementType);
-    // TODO(brianwilkerson) Figure out whether there are other features that
-    //  ought to be used here and what the right default value is.
-    return toRelevance(contextTypeFeature, 800);
-  }
 }
 
 /// A contributor that produces suggestions based on the top level members in
@@ -295,7 +170,7 @@ class LocalLibraryContributor extends DartCompletionContributor {
       return const <CompletionSuggestion>[];
     }
 
-    var visitor = LibraryElementSuggestionBuilder(request);
+    var visitor = LibraryElementSuggestionBuilder(request, builder);
     for (var unit in libraryUnits) {
       if (unit != null && unit.source != request.source) {
         unit.accept(visitor);