Migrate convert_getter_to_method and convert_method_to_getter

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

Author: bwilkerson

pkg/analysis_server/analyzer_use_new_elements.txt

@@ -49,8 +49,6 @@ lib/src/services/flutter/widget_descriptions.dart
 lib/src/services/kythe/kythe_visitors.dart
 lib/src/services/refactoring/agnostic/change_method_signature.dart
 lib/src/services/refactoring/framework/formal_parameter.dart
-lib/src/services/refactoring/legacy/convert_getter_to_method.dart
-lib/src/services/refactoring/legacy/convert_method_to_getter.dart
 lib/src/services/refactoring/legacy/extract_local.dart
 lib/src/services/refactoring/legacy/extract_method.dart
 lib/src/services/refactoring/legacy/extract_widget.dart

pkg/analysis_server/lib/src/protocol_server.dart

@@ -44,6 +44,16 @@ void doSourceChange_addElementEdit(
   doSourceChange_addSourceEdit(change, source, edit);
 }
 
+/// Adds [edit] to the file containing the given [fragment].
+void doSourceChange_addFragmentEdit(
+  SourceChange change,
+  engine.Fragment fragment,
+  SourceEdit edit,
+) {
+  var source = fragment.libraryFragment!.source;
+  doSourceChange_addSourceEdit(change, source, edit);
+}
+
 /// Adds [edit] for the given [source] to the [change].
 void doSourceChange_addSourceEdit(
   SourceChange change,
@@ -302,15 +312,15 @@ Location? newLocation_fromElement2(engine.Element2? element) {
   if (element == null) {
     return null;
   }
-    if (element is engine.FormalParameterElement &&
-        element.enclosingElement2 == null) {
-      return null;
-    }
-    var fragment = element.firstFragment;
-    var offset = fragment.nameOffset2 ?? 0;
-    var length = fragment.name2?.length ?? 0;
-    var range = engine.SourceRange(offset, length);
-    return _locationForArgs2(fragment, range);
+  if (element is engine.FormalParameterElement &&
+      element.enclosingElement2 == null) {
+    return null;
+  }
+  var fragment = element.firstFragment;
+  var offset = fragment.nameOffset2 ?? 0;
+  var length = fragment.name2?.length ?? 0;
+  var range = engine.SourceRange(offset, length);
+  return _locationForArgs2(fragment, range);
 }
 
 /// Create a Location based on an [engine.SearchMatch].

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

@@ -11,7 +11,7 @@ import 'package:analysis_server/src/services/search/search_engine.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/src/dart/analysis/session_helper.dart';
 import 'package:analyzer/src/util/file_paths.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';
@@ -22,7 +22,7 @@ class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
   final RefactoringWorkspace workspace;
   final SearchEngine searchEngine;
   final AnalysisSession session;
-  final PropertyAccessorElement element;
+  final GetterElement element;
 
   late SourceChange change;
 
@@ -51,19 +51,19 @@ class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
   Future<SourceChange> createChange() async {
     change = SourceChange(refactoringName);
     // function
-    if (element.enclosingElement3 is CompilationUnitElement) {
+    if (element.enclosingElement2 is LibraryElement2) {
       await _updateElementDeclaration(element);
       await _updateElementReferences(element);
     }
     // method
-    var field = element.variable2;
-    if (field is FieldElement &&
-        (field.enclosingElement3 is InterfaceElement ||
-            field.enclosingElement3 is ExtensionElement)) {
-      var elements = await getHierarchyMembers(searchEngine, field);
-      await Future.forEach(elements, (Element member) async {
-        if (member is FieldElement) {
-          var getter = member.getter;
+    var field = element.variable3;
+    if (field is FieldElement2 &&
+        (field.enclosingElement2 is InterfaceElement2 ||
+            field.enclosingElement2 is ExtensionElement2)) {
+      var elements = await getHierarchyMembers2(searchEngine, field);
+      await Future.forEach(elements, (Element2 member) async {
+        if (member is FieldElement2) {
+          var getter = member.getter2;
           if (getter != null && !getter.isSynthetic) {
             await _updateElementDeclaration(getter);
             return _updateElementReferences(getter);
@@ -82,13 +82,13 @@ class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
 
   /// Checks if [element] is valid to perform this refactor.
   RefactoringStatus _checkElement() {
-    if (!workspace.containsElement(element)) {
+    if (!workspace.containsElement2(element)) {
       return RefactoringStatus.fatal(
         'Only getters in your workspace can be converted.',
       );
     }
 
-    if (!element.isGetter || element.isSynthetic) {
+    if (element.isSynthetic) {
       return RefactoringStatus.fatal(
         'Only explicit getters can be converted to methods.',
       );
@@ -100,14 +100,20 @@ class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
     return _checkElement();
   }
 
-  Future<void> _updateElementDeclaration(
-    PropertyAccessorElement element,
-  ) async {
+  Future<void> _updateElementDeclaration(GetterElement element) async {
     // prepare "get" keyword
     Token? getKeyword;
-    {
+    for (
+      GetterFragment? fragment = element.firstFragment;
+      fragment != null;
+      fragment = fragment.nextFragment as GetterFragment?
+    ) {
+      var nameRange = range.fragmentName(fragment);
+      if (nameRange == null) {
+        return;
+      }
       var sessionHelper = AnalysisSessionHelper(session);
-      var result = await sessionHelper.getElementDeclaration(element);
+      var result = await sessionHelper.getElementDeclaration2(fragment);
       var declaration = result?.node;
       if (declaration is MethodDeclaration) {
         getKeyword = declaration.propertyKeyword;
@@ -116,34 +122,31 @@ class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
       } else {
         return;
       }
-    }
-    // remove "get "
-    if (getKeyword != null) {
-      var getRange = range.startOffsetEndOffset(
-        getKeyword.offset,
-        element.nameOffset,
-      );
-      var edit = newSourceEdit_range(getRange, '');
-      doSourceChange_addElementEdit(change, element, edit);
-    }
-    // add parameters "()"
-    {
-      var edit = SourceEdit(range.elementName(element).end, 0, '()');
-      doSourceChange_addElementEdit(change, element, edit);
+      // remove "get "
+      if (getKeyword != null) {
+        var getRange = range.startOffsetEndOffset(
+          getKeyword.offset,
+          fragment.nameOffset2!,
+        );
+        var edit = newSourceEdit_range(getRange, '');
+        doSourceChange_addFragmentEdit(change, fragment, edit);
+      }
+      // add parameters "()"
+      var edit = SourceEdit(nameRange.end, 0, '()');
+      doSourceChange_addFragmentEdit(change, fragment, edit);
     }
   }
 
-  Future<void> _updateElementReferences(Element element) async {
-    var matches = await searchEngine.searchReferences(element);
+  Future<void> _updateElementReferences(Element2 element) async {
+    var matches = await searchEngine.searchReferences2(element);
     var references = getSourceReferences(matches);
     for (var reference in references) {
       // Don't update references in macro-generated files.
       if (isMacroGenerated(reference.file)) continue;
-      var refElement = reference.element;
       var refRange = reference.range;
       // insert "()"
       var edit = SourceEdit(refRange.end, 0, '()');
-      doSourceChange_addElementEdit(change, refElement, edit);
+      doSourceChange_addSourceEdit(change, reference.unitSource, edit);
     }
   }
 }

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

@@ -10,7 +10,7 @@ import 'package:analysis_server/src/services/search/hierarchy.dart';
 import 'package:analysis_server/src/services/search/search_engine.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/dart/ast/ast.dart';
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:analyzer/src/dart/analysis/session_helper.dart';
 import 'package:analyzer/src/dart/ast/utilities.dart';
@@ -23,7 +23,7 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
   final RefactoringWorkspace workspace;
   final SearchEngine searchEngine;
   final AnalysisSessionHelper sessionHelper;
-  final ExecutableElement element;
+  final ExecutableElement2 element;
 
   late SourceChange change;
 
@@ -53,15 +53,15 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
     change = SourceChange(refactoringName);
     // FunctionElement
     var element = this.element;
-    if (element is FunctionElement) {
+    if (element is TopLevelFunctionElement) {
       await _updateElementDeclaration(element);
       await _updateElementReferences(element);
     }
     // MethodElement
-    if (element is MethodElement) {
-      var elements = await getHierarchyMembers(searchEngine, element);
-      await Future.forEach(elements, (Element element) async {
-        await _updateElementDeclaration(element);
+    if (element is MethodElement2) {
+      var elements = await getHierarchyMembers2(searchEngine, element);
+      await Future.forEach(elements, (Element2 element) async {
+        await _updateElementDeclaration(element as ExecutableElement2);
         return _updateElementReferences(element);
       });
     }
@@ -76,22 +76,16 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
 
   /// Checks if [element] is valid to perform this refactor.
   RefactoringStatus _checkElement() {
-    if (!workspace.containsElement(element)) {
+    if (!workspace.containsElement2(element)) {
       return RefactoringStatus.fatal(
         'Only methods in your workspace can be converted.',
       );
     }
 
     // check Element type
-    if (element is FunctionElement) {
-      if (element.enclosingElement3 is! CompilationUnitElement) {
-        return RefactoringStatus.fatal(
-          'Only top-level functions can be converted to getters.',
-        );
-      }
-    } else if (element is! MethodElement) {
+    if (element is! MethodElement2 && element is! TopLevelFunctionElement) {
       return RefactoringStatus.fatal(
-        'Only class methods or top-level functions can be converted to getters.',
+        'Only methods or top-level functions can be converted to getters.',
       );
     }
     // returns a value
@@ -101,7 +95,7 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
       );
     }
     // no parameters
-    if (element.parameters.isNotEmpty) {
+    if (element.formalParameters.isNotEmpty) {
       return RefactoringStatus.fatal(
         'Only methods without parameters can be converted to getters.',
       );
@@ -110,11 +104,15 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
     return RefactoringStatus();
   }
 
-  Future<void> _updateElementDeclaration(Element element) async {
+  Future<void> _updateElementDeclaration(ExecutableElement2 element) async {
     // prepare parameters
     FormalParameterList? parameters;
-    {
-      var result = await sessionHelper.getElementDeclaration(element);
+    for (
+      ExecutableFragment? fragment = element.firstFragment;
+      fragment != null;
+      fragment = fragment.nextFragment as GetterFragment?
+    ) {
+      var result = await sessionHelper.getElementDeclaration2(fragment);
       var declaration = result?.node;
       if (declaration is MethodDeclaration) {
         parameters = declaration.parameters;
@@ -123,48 +121,48 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
       } else {
         return;
       }
-    }
-    if (parameters == null) {
-      return;
-    }
-    // insert "get "
-    {
-      var edit = SourceEdit(element.nameOffset, 0, 'get ');
-      doSourceChange_addElementEdit(change, element, edit);
-    }
-    // remove parameters
-    {
-      var edit = newSourceEdit_range(range.node(parameters), '');
-      doSourceChange_addElementEdit(change, element, edit);
+      if (parameters == null) {
+        return;
+      }
+      // insert "get "
+      {
+        var edit = SourceEdit(fragment.nameOffset2 ?? -1, 0, 'get ');
+        doSourceChange_addFragmentEdit(change, fragment, edit);
+      }
+      // remove parameters
+      {
+        var edit = newSourceEdit_range(range.node(parameters), '');
+        doSourceChange_addFragmentEdit(change, fragment, edit);
+      }
     }
   }
 
-  Future<void> _updateElementReferences(Element element) async {
-    var matches = await searchEngine.searchReferences(element);
+  Future<void> _updateElementReferences(Element2 element) async {
+    var matches = await searchEngine.searchReferences2(element);
     var references = getSourceReferences(matches);
     for (var reference in references) {
       // Don't update references in macro-generated files.
       if (isMacroGenerated(reference.file)) continue;
 
-      var refElement = reference.element;
+      var refElement = reference.element2;
       var refRange = reference.range;
       // prepare invocation
-      MethodInvocation? invocation;
-      {
-        var resolvedUnit = await sessionHelper.getResolvedUnitByElement(
-          refElement,
-        );
-        var refUnit = resolvedUnit?.unit;
-        var refNode = NodeLocator(refRange.offset).searchWithin(refUnit);
-        invocation = refNode?.thisOrAncestorOfType<MethodInvocation>();
-      }
+
+      var resolvedUnit = await sessionHelper.getResolvedUnitByElement2(
+        refElement,
+      );
+      var refUnit = resolvedUnit?.unit;
+      if (refUnit == null) continue;
+      var refNode = NodeLocator(refRange.offset).searchWithin(refUnit);
+      var invocation = refNode?.thisOrAncestorOfType<MethodInvocation>();
+
       // we need invocation
       if (invocation != null) {
         var edit = newSourceEdit_range(
           range.startOffsetEndOffset(refRange.end, invocation.end),
           '',
         );
-        doSourceChange_addElementEdit(change, refElement, edit);
+        doSourceChange_addSourceEdit(change, reference.unitSource, edit);
       }
     }
   }

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

@@ -46,11 +46,7 @@ abstract class ConvertGetterToMethodRefactoring implements Refactoring {
     AnalysisSession session,
     GetterElement element,
   ) {
-    return ConvertGetterToMethodRefactoringImpl(
-      workspace,
-      session,
-      element.asElement as PropertyAccessorElement,
-    );
+    return ConvertGetterToMethodRefactoringImpl(workspace, session, element);
   }
 
   /// Return `true` if refactoring is available, possibly without checking all
@@ -73,11 +69,7 @@ abstract class ConvertMethodToGetterRefactoring implements Refactoring {
     AnalysisSession session,
     ExecutableElement2 element,
   ) {
-    return ConvertMethodToGetterRefactoringImpl(
-      workspace,
-      session,
-      element.asElement,
-    );
+    return ConvertMethodToGetterRefactoringImpl(workspace, session, element);
   }
 
   /// Return `true` if refactoring is available, possibly without checking all
@@ -410,6 +402,11 @@ class RefactoringWorkspace {
     return containsFile(element.source!.fullName);
   }
 
+  /// Whether the [element] is defined in a file that is in a context root.
+  bool containsElement2(Element2 element) {
+    return containsFile(element.firstFragment.libraryFragment!.source.fullName);
+  }
+
   /// Whether the file with the given [path] is in a context root.
   bool containsFile(String path) {
     return drivers.any((driver) {