Elements. Migrate lib/src/services/search/search_engine.dart and related.

Change-Id: I7c0501eb6e84313d3eb179f41e8bdaf6190004ce
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/400860
Reviewed-by: Phil Quitslund <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Konstantin Shcheglov <[email protected]>

Author: scheglov

pkg/analysis_server/analyzer_use_new_elements.txt

@@ -17,13 +17,10 @@ lib/src/services/refactoring/framework/formal_parameter.dart
 lib/src/services/refactoring/legacy/extract_method.dart
 lib/src/services/refactoring/legacy/move_file.dart
 lib/src/services/refactoring/legacy/refactoring.dart
-lib/src/services/refactoring/legacy/refactoring_internal.dart
 lib/src/services/refactoring/legacy/refactoring_manager.dart
 lib/src/services/refactoring/legacy/rename.dart
 lib/src/services/refactoring/legacy/rename_import.dart
 lib/src/services/search/element_visitors.dart
-lib/src/services/search/search_engine.dart
-lib/src/services/search/search_engine_internal.dart
 test/abstract_single_unit.dart
 test/services/refactoring/legacy/abstract_rename.dart
 test/services/search/element_visitors_test.dart

pkg/analysis_server/lib/src/protocol_server.dart

@@ -326,7 +326,7 @@ Location? newLocation_fromElement2(engine.Element2? element) {
 
 /// Create a Location based on an [engine.SearchMatch].
 Location newLocation_fromMatch(engine.SearchMatch match) {
-  var unitElement = _getUnitElement(match.element);
+  var unitElement = _getUnitElement(match.element2.asElement!);
   return _locationForArgs(unitElement, match.sourceRange);
 }
 
@@ -366,7 +366,7 @@ OverriddenMember newOverriddenMember_fromEngine(engine.Element2 member) {
 SearchResult newSearchResult_fromMatch(engine.SearchMatch match) {
   var kind = newSearchResultKind_fromEngine(match.kind);
   var location = newLocation_fromMatch(match);
-  var path = _computePath(match.element);
+  var path = _computePath(match.element2.asElement!);
   return SearchResult(location, kind, !match.isResolved, path);
 }
 

pkg/analysis_server/lib/src/services/refactoring/agnostic/change_method_signature.dart

@@ -690,7 +690,7 @@ class _SignatureUpdater {
 
   /// Returns the resolved unit with [reference].
   Future<ResolvedUnitResult?> referenceUnitResult(SearchMatch reference) async {
-    var element = reference.element;
+    var element = reference.element2.asElement!;
     return await sessionHelper.getResolvedUnitByElement(element);
   }
 
@@ -970,7 +970,7 @@ class _SignatureUpdater {
     required ExecutableElement element,
     required ChangeBuilder builder,
   }) async {
-    var references = await searchEngine.searchReferences(element);
+    var references = await searchEngine.searchReferences2(element.asElement2);
     for (var reference in references) {
       var unitResult = await referenceUnitResult(reference);
       if (unitResult == null) {

pkg/analysis_server/lib/src/services/refactoring/legacy/move_file.dart

@@ -14,7 +14,9 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
+import 'package:analyzer/src/dart/analysis/search.dart';
 import 'package:analyzer/src/dart/ast/ast.dart';
+import 'package:analyzer/src/utilities/extensions/element.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';
 import 'package:path/path.dart' as path show posix, Context;
@@ -280,14 +282,12 @@ class MoveFileRefactoringImpl extends RefactoringImpl
     }
 
     // Finally, locate all other incoming references to this file.
-    var matches = await refactoringWorkspace.searchEngine.searchReferences(
-      element,
-    );
-    var references = getSourceReferences(matches);
+    var references = await refactoringWorkspace.searchEngine
+        .searchLibraryFragmentReferences(element.asElement2);
     for (var reference in references) {
       recordReference(
         range: reference.range,
-        sourceFile: reference.file,
+        sourceFile: reference.libraryFragment.source.fullName,
         targetFile: oldPath,
         quotedUriValue: _extractUriString(reference),
       );
@@ -341,9 +341,9 @@ class MoveFileRefactoringImpl extends RefactoringImpl
     );
   }
 
-  /// Extracts the existing URI string from a [SourceReference].
-  String _extractUriString(SourceReference reference) {
-    var source = reference.element.source!;
+  /// Extracts the existing URI string from a [LibraryFragmentSearchMatch].
+  String _extractUriString(LibraryFragmentSearchMatch reference) {
+    var source = reference.libraryFragment.source;
     return source.contents.data.substring(
       reference.range.offset,
       reference.range.end,

pkg/analysis_server/lib/src/services/refactoring/legacy/refactoring_internal.dart

@@ -8,7 +8,6 @@ import 'package:analysis_server/src/protocol_server.dart' hide Element;
 import 'package:analysis_server/src/services/correction/status.dart';
 import 'package:analysis_server/src/services/refactoring/legacy/refactoring.dart';
 import 'package:analysis_server/src/services/search/search_engine.dart';
-import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/source/source_range.dart';
@@ -68,8 +67,6 @@ class SourceReference {
 
   SourceReference(this._match);
 
-  Element get element => _match.element;
-
   Element2 get element2 => _match.element2;
 
   /// The full path of the file containing the match.
@@ -90,9 +87,6 @@ class SourceReference {
 
   bool get isResolved => _match.isResolved;
 
-  /// Return the [LibraryElement] for the [file].
-  LibraryElement get libraryElement => _match.libraryElement;
-
   /// Return the [LibraryElement2] for the [file].
   LibraryElement2 get libraryElement2 => _match.libraryElement2;
 

pkg/analysis_server/lib/src/services/refactoring/legacy/rename.dart

@@ -65,7 +65,7 @@ class RenameProcessor {
   void addReferenceEdits(List<SearchMatch> matches) {
     var references = getSourceReferences(matches);
     for (var reference in references) {
-      if (!workspace.containsElement(reference.element)) {
+      if (!workspace.containsElement2(reference.element2)) {
         continue;
       }
       reference.addEdit(change, newName);
@@ -76,7 +76,7 @@ class RenameProcessor {
   Future<void> renameElement(Element element) {
     addDeclarationEdit(element);
     return workspace.searchEngine
-        .searchReferences(element)
+        .searchReferences2(element.asElement2!)
         .then(addReferenceEdits);
   }
 

pkg/analysis_server/lib/src/services/refactoring/legacy/rename_import.dart

@@ -6,13 +6,14 @@ import 'package:analysis_server/src/protocol_server.dart';
 import 'package:analysis_server/src/services/correction/status.dart';
 import 'package:analysis_server/src/services/refactoring/legacy/naming_conventions.dart';
 import 'package:analysis_server/src/services/refactoring/legacy/refactoring.dart';
-import 'package:analysis_server/src/services/refactoring/legacy/refactoring_internal.dart';
 import 'package:analysis_server/src/services/refactoring/legacy/rename.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/source/source_range.dart';
+import 'package:analyzer/src/dart/analysis/search.dart';
 import 'package:analyzer/src/dart/ast/utilities.dart';
+import 'package:analyzer/src/utilities/extensions/element.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';
 
 /// A [Refactoring] for renaming [LibraryImportElement]s.
@@ -79,25 +80,34 @@ class RenameImportRefactoringImpl extends RenameRefactoringImpl {
       }
     }
     // update references
-    var matches = await searchEngine.searchReferences(element);
-    var references = getSourceReferences(matches);
+    var references = await searchEngine.searchLibraryImportReferences(
+      element.asElement2,
+    );
     for (var reference in references) {
       if (newName.isEmpty) {
-        reference.addEdit(change, '');
+        doSourceChange_addSourceEdit(
+          change,
+          reference.libraryFragment.source,
+          newSourceEdit_range(reference.range, ''),
+        );
       } else {
         var identifier = await _getInterpolationIdentifier(reference);
         if (identifier != null) {
-          doSourceChange_addElementEdit(
+          doSourceChange_addFragmentEdit(
             change,
-            reference.element,
+            reference.libraryFragment,
             SourceEdit(
               identifier.offset,
               identifier.length,
               '{$newName.${identifier.name}}',
             ),
           );
         } else {
-          reference.addEdit(change, '$newName.');
+          doSourceChange_addSourceEdit(
+            change,
+            reference.libraryFragment.source,
+            newSourceEdit_range(reference.range, '$newName.'),
+          );
         }
       }
     }
@@ -120,9 +130,9 @@ class RenameImportRefactoringImpl extends RenameRefactoringImpl {
   /// an [InterpolationExpression] without surrounding curly brackets, return
   /// it. Otherwise return `null`.
   Future<SimpleIdentifier?> _getInterpolationIdentifier(
-    SourceReference reference,
+    LibraryFragmentSearchMatch reference,
   ) async {
-    var source = reference.element.source!;
+    var source = reference.libraryFragment.source;
     var unitResult = sessionHelper.session.getParsedUnit(source.fullName);
     if (unitResult is! ParsedUnitResult) {
       return null;

pkg/analysis_server/lib/src/services/search/search_engine.dart

@@ -2,7 +2,6 @@
 // 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/element/element.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/source/source_range.dart';
@@ -76,18 +75,6 @@ class MatchKind {
 /// The interface [SearchEngine] defines the behavior of objects that can be
 /// used to search for various pieces of information.
 abstract class SearchEngine {
-  /// Adds all subtypes of the given [type] into [allSubtypes].
-  ///
-  /// If [allSubtypes] already contains an element it is assumed that it
-  /// contains the entire subtree and the element won't be search on further.
-  ///
-  /// [type] - the [InterfaceElement] being subtyped by the found matches.
-  Future<void> appendAllSubtypes(
-    InterfaceElement type,
-    Set<InterfaceElement> allSubtypes,
-    OperationPerformanceImpl performance,
-  );
-
   /// Adds all subtypes of the given [type] into [allSubtypes].
   ///
   /// If [allSubtypes] already contains an element it is assumed that it
@@ -98,16 +85,21 @@ abstract class SearchEngine {
     OperationPerformanceImpl performance,
   );
 
-  /// If the [type] has subtypes, return the set of names of members which these
-  /// subtypes declare, possibly empty.  If the [type] does not have subtypes,
-  /// return `null`.
-  Future<Set<String>?> membersOfSubtypes(InterfaceElement type);
-
   /// If the [type] has subtypes, return the set of names of members which these
   /// subtypes declare, possibly empty.  If the [type] does not have subtypes,
   /// return `null`.
   Future<Set<String>?> membersOfSubtypes2(InterfaceElement2 type);
 
+  /// Returns references to the given [fragment].
+  Future<List<LibraryFragmentSearchMatch>> searchLibraryFragmentReferences(
+    LibraryFragment fragment,
+  );
+
+  /// Returns references to the given [import].
+  Future<List<LibraryFragmentSearchMatch>> searchLibraryImportReferences(
+    LibraryImport import,
+  );
+
   /// Returns declarations of class members with the given name.
   ///
   /// [name] - the name being declared by the found matches.
@@ -119,14 +111,6 @@ abstract class SearchEngine {
   /// [name] - the name being referenced by the found matches.
   Future<List<SearchMatch>> searchMemberReferences(String name);
 
-  /// Return the prefixes used to reference the [element] in any of the
-  /// compilation units in the [library]. The returned set will include an empty
-  /// string if the element is referenced without a prefix.
-  Future<Set<String>> searchPrefixesUsedInLibrary(
-    LibraryElement library,
-    Element element,
-  );
-
   /// Return the prefixes used to reference the [element] in any of the
   /// compilation units in the [library]. The returned set will include an empty
   /// string if the element is referenced without a prefix.
@@ -135,28 +119,12 @@ abstract class SearchEngine {
     Element2 element,
   );
 
-  /// Returns references to the given [Element].
-  ///
-  /// [element] - the [Element] being referenced by the found matches.
-  Future<List<SearchMatch>> searchReferences(Element element);
-
   /// Returns references to the given [element].
   Future<List<SearchMatch>> searchReferences2(Element2 element);
 
   /// Returns direct subtypes of the given [type].
   ///
-  /// [type] - the [ClassElement] being subtyped by the found matches.
-  /// [cache] - the [SearchEngineCache] used to speeding up the computation. If
-  ///    empty it will be filled out and can be used on any subsequent query.
-  Future<List<SearchMatch>> searchSubtypes(
-    InterfaceElement type,
-    SearchEngineCache cache, {
-    OperationPerformanceImpl? performance,
-  });
-
-  /// Returns direct subtypes of the given [type].
-  ///
-  /// [type] - the [ClassElement] being subtyped by the found matches.
+  /// [type] - the [InterfaceElement2] being subtyped by the found matches.
   /// [cache] - the [SearchEngineCache] used to speeding up the computation. If
   ///    empty it will be filled out and can be used on any subsequent query.
   Future<List<SearchMatch>> searchSubtypes2(
@@ -182,9 +150,6 @@ class SearchEngineCache {
 /// Instances of the class [SearchMatch] represent a match found by
 /// [SearchEngine].
 abstract class SearchMatch {
-  /// Return the [Element] containing the match.
-  Element get element;
-
   /// Return the element containing the match.
   Element2 get element2;
 
@@ -194,15 +159,12 @@ abstract class SearchMatch {
   /// Is `true` if field or method access is done using qualifier.
   bool get isQualified;
 
-  /// Is `true` if the match is a resolved reference to some [Element].
+  /// Is `true` if the match is a resolved reference to some [Element2].
   bool get isResolved;
 
   /// The kind of the match.
   MatchKind get kind;
 
-  /// Return the [LibraryElement] for the [file].
-  LibraryElement get libraryElement;
-
   /// Return the library element for the [file].
   LibraryElement2 get libraryElement2;