[migrate] server/protocol_dart.dart

I didn't rename all of the functions because I thought it would be easier to review if I did it in two steps.

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

Author: bwilkerson

pkg/analysis_server/lib/plugin/protocol/protocol_dart.dart

@@ -2,46 +2,17 @@
 // 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.
 
-// ignore_for_file: analyzer_use_new_elements
-
 /// Utilities for converting Dart entities into analysis server's protocol
 /// entities.
 library;
 
 import 'package:analysis_server/src/protocol_server.dart';
-import 'package:analyzer/dart/element/element.dart' as engine;
 import 'package:analyzer/dart/element/element2.dart' as engine;
 import 'package:analyzer/dart/element/type.dart';
+import 'package:analyzer/src/dart/element/element.dart';
 import 'package:analyzer/src/utilities/extensions/element.dart';
 import 'package:path/path.dart' as path;
 
-/// Return a protocol [Element] corresponding to the given [engine.Element].
-Element convertElement(engine.Element element) {
-  var kind = convertElementToElementKind(element);
-  var name = getElementDisplayName(element);
-  var elementTypeParameters = _getTypeParametersString(element);
-  var aliasedType = getAliasedTypeString(element);
-  var elementParameters = getParametersString(element);
-  var elementReturnType = getReturnTypeString(element);
-  return Element(
-    kind,
-    name,
-    Element.makeFlags(
-      isPrivate: element.isPrivate,
-      isDeprecated: element.hasDeprecated,
-      isAbstract: _isAbstract(element),
-      isConst: _isConst(element),
-      isFinal: _isFinal(element),
-      isStatic: _isStatic(element),
-    ),
-    location: newLocation_fromElement(element),
-    typeParameters: elementTypeParameters,
-    aliasedType: aliasedType,
-    parameters: elementParameters,
-    returnType: elementReturnType,
-  );
-}
-
 Element convertElement2(engine.Element2 element) {
   var kind = convertElementToElementKind2(element);
   var name = getElementDisplayName2(element);
@@ -75,7 +46,7 @@ Element convertElement2(engine.Element2 element) {
 ///
 /// This does not take into account that an instance of [engine.ClassElement]
 /// can be an enum and an instance of [engine.FieldElement] can be an enum
-/// constant. Use [convertElementToElementKind] where possible.
+/// constant. Use [convertElementToElementKind2] where possible.
 ElementKind convertElementKind(engine.ElementKind kind) {
   if (kind == engine.ElementKind.CLASS) {
     return ElementKind.CLASS;
@@ -149,19 +120,6 @@ ElementKind convertElementKind(engine.ElementKind kind) {
   return ElementKind.UNKNOWN;
 }
 
-/// Return an [ElementKind] corresponding to the given [engine.Element].
-ElementKind convertElementToElementKind(engine.Element element) {
-  if (element is engine.EnumElement) {
-    return ElementKind.ENUM;
-  } else if (element is engine.MixinElement) {
-    return ElementKind.MIXIN;
-  }
-  if (element is engine.FieldElement && element.isEnumConstant) {
-    return ElementKind.ENUM_CONSTANT;
-  }
-  return convertElementKind(element.kind);
-}
-
 /// Return an [ElementKind] corresponding to the given [engine.Element2].
 ElementKind convertElementToElementKind2(engine.Element2 element) {
   if (element is engine.EnumElement2) {
@@ -175,12 +133,30 @@ ElementKind convertElementToElementKind2(engine.Element2 element) {
   return convertElementKind(element.kind);
 }
 
-String getElementDisplayName(engine.Element element) {
-  if (element is engine.CompilationUnitElement) {
-    return path.basename(element.source.fullName);
-  } else {
-    return element.displayName;
-  }
+Element convertLibraryFragment(CompilationUnitElementImpl fragment) {
+  var kind = convertElementToElementKind2(fragment);
+  var name = getElementDisplayName2(fragment);
+  var elementTypeParameters = _getTypeParametersString2(fragment);
+  var aliasedType = getAliasedTypeString2(fragment);
+  var elementParameters = getParametersString2(fragment);
+  var elementReturnType = getReturnTypeString2(fragment);
+  return Element(
+    kind,
+    name,
+    Element.makeFlags(
+      isPrivate: fragment.isPrivate,
+      isDeprecated: fragment.hasDeprecated,
+      isAbstract: _isAbstract2(fragment),
+      isConst: _isConst2(fragment),
+      isFinal: _isFinal2(fragment),
+      isStatic: _isStatic2(fragment),
+    ),
+    location: newLocation_fromFragment(fragment),
+    typeParameters: elementTypeParameters,
+    aliasedType: aliasedType,
+    parameters: elementParameters,
+    returnType: elementReturnType,
+  );
 }
 
 String getElementDisplayName2(engine.Element2 element) {
@@ -191,55 +167,6 @@ String getElementDisplayName2(engine.Element2 element) {
   }
 }
 
-String? getParametersString(engine.Element element) {
-  // TODO(scheglov): expose the corresponding feature from ExecutableElement
-  List<engine.ParameterElement> parameters;
-  if (element is engine.ExecutableElement) {
-    // valid getters don't have parameters
-    if (element.kind == engine.ElementKind.GETTER &&
-        element.parameters.isEmpty) {
-      return null;
-    }
-    parameters = element.parameters.toList();
-  } else if (element is engine.TypeAliasElement) {
-    var aliasedType = element.aliasedType;
-    if (aliasedType is FunctionType) {
-      parameters = aliasedType.parameters.toList();
-    } else {
-      return null;
-    }
-  } else {
-    return null;
-  }
-
-  parameters.sort(_preferRequiredParams);
-
-  var sb = StringBuffer();
-  var closeOptionalString = '';
-  for (var parameter in parameters) {
-    if (sb.isNotEmpty) {
-      sb.write(', ');
-    }
-    if (closeOptionalString.isEmpty) {
-      if (parameter.isNamed) {
-        sb.write('{');
-        closeOptionalString = '}';
-      } else if (parameter.isOptionalPositional) {
-        sb.write('[');
-        closeOptionalString = ']';
-      }
-    }
-    if (parameter.isRequiredNamed) {
-      sb.write('required ');
-    } else if (parameter.hasRequired) {
-      sb.write('@required ');
-    }
-    parameter.appendToWithoutDelimiters(sb);
-  }
-  sb.write(closeOptionalString);
-  return '($sb)';
-}
-
 String? getParametersString2(engine.Element2 element) {
   // TODO(scheglov): expose the corresponding feature from ExecutableElement
   List<engine.FormalParameterElement> parameters;
@@ -289,19 +216,6 @@ String? getParametersString2(engine.Element2 element) {
   return '($sb)';
 }
 
-String? _getTypeParametersString(engine.Element element) {
-  List<engine.TypeParameterElement>? typeParameters;
-  if (element is engine.InterfaceElement) {
-    typeParameters = element.typeParameters;
-  } else if (element is engine.TypeAliasElement) {
-    typeParameters = element.typeParameters;
-  }
-  if (typeParameters == null || typeParameters.isEmpty) {
-    return null;
-  }
-  return '<${typeParameters.join(', ')}>';
-}
-
 String? _getTypeParametersString2(engine.Element2 element) {
   List<engine.TypeParameterElement2>? typeParameters;
   if (element is engine.InterfaceElement2) {
@@ -315,22 +229,6 @@ String? _getTypeParametersString2(engine.Element2 element) {
   return '<${typeParameters.join(', ')}>';
 }
 
-bool _isAbstract(engine.Element element) {
-  if (element is engine.ClassElement) {
-    return element.isAbstract;
-  }
-  if (element is engine.MethodElement) {
-    return element.isAbstract;
-  }
-  if (element is engine.MixinElement) {
-    return true;
-  }
-  if (element is engine.PropertyAccessorElement) {
-    return element.isAbstract;
-  }
-  return false;
-}
-
 bool _isAbstract2(engine.Element2 element) {
   if (element is engine.ClassElement2) {
     return element.isAbstract;
@@ -344,16 +242,6 @@ bool _isAbstract2(engine.Element2 element) {
   return false;
 }
 
-bool _isConst(engine.Element element) {
-  if (element is engine.ConstructorElement) {
-    return element.isConst;
-  }
-  if (element is engine.VariableElement) {
-    return element.isConst;
-  }
-  return false;
-}
-
 bool _isConst2(engine.Element2 element) {
   if (element is engine.ConstructorElement2) {
     return element.isConst;
@@ -364,30 +252,13 @@ bool _isConst2(engine.Element2 element) {
   return false;
 }
 
-bool _isFinal(engine.Element element) {
-  if (element is engine.VariableElement) {
-    return element.isFinal;
-  }
-  return false;
-}
-
 bool _isFinal2(engine.Element2 element) {
   if (element is engine.VariableElement2) {
     return element.isFinal;
   }
   return false;
 }
 
-bool _isStatic(engine.Element element) {
-  if (element is engine.ExecutableElement) {
-    return element.isStatic;
-  }
-  if (element is engine.PropertyInducingElement) {
-    return element.isStatic;
-  }
-  return false;
-}
-
 bool _isStatic2(engine.Element2 element) {
   if (element is engine.ExecutableElement2) {
     return element.isStatic;
@@ -398,26 +269,6 @@ bool _isStatic2(engine.Element2 element) {
   return false;
 }
 
-/// Sort required named parameters before optional ones.
-int _preferRequiredParams(
-  engine.ParameterElement e1,
-  engine.ParameterElement e2,
-) {
-  var rank1 =
-      (e1.isRequiredNamed || e1.hasRequired)
-          ? 0
-          : !e1.isNamed
-          ? -1
-          : 1;
-  var rank2 =
-      (e2.isRequiredNamed || e2.hasRequired)
-          ? 0
-          : !e2.isNamed
-          ? -1
-          : 1;
-  return rank1 - rank2;
-}
-
 /// Sort required named parameters before optional ones.
 int _preferRequiredParams2(
   engine.FormalParameterElement e1,

pkg/analysis_server/lib/src/handler/legacy/search_find_element_references.dart

@@ -49,7 +49,7 @@ class SearchFindElementReferencesHandler extends LegacyHandler {
     var result = protocol.SearchFindElementReferencesResult();
     if (element != null) {
       result.id = searchId;
-      result.element = protocol.convertElement(element);
+      result.element = protocol.convertElement2(element.asElement2!);
     }
     sendResult(result);
     // search elements

pkg/analysis_server/lib/src/protocol_server.dart

@@ -21,6 +21,7 @@ import 'package:analyzer/error/error.dart' as engine;
 import 'package:analyzer/source/error_processor.dart';
 import 'package:analyzer/source/source.dart' as engine;
 import 'package:analyzer/source/source_range.dart' as engine;
+import 'package:analyzer/src/dart/element/element.dart';
 import 'package:analyzer/src/utilities/extensions/element.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart';
 
@@ -333,6 +334,21 @@ Location? newLocation_fromElement2(engine.Element2? element) {
   return _locationForArgs2(fragment, range);
 }
 
+/// Creates a location based on the [fragment].
+Location? newLocation_fromFragment(engine.Fragment? fragment) {
+  if (fragment == null) {
+    return null;
+  }
+  if (fragment is engine.FormalParameterFragment &&
+      fragment.enclosingFragment == null) {
+    return null;
+  }
+  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].
 Location newLocation_fromMatch(engine.SearchMatch match) {
   var unitElement = _getUnitElement(match.element2.asElement!);
@@ -423,10 +439,12 @@ List<Element> _computePath(engine.Element element) {
   if (element2 != null) {
     for (var fragment in element2.firstFragment.withAncestors) {
       if (fragment case engine.Element e) {
-        path.add(convertElement(e));
         if (fragment is engine.LibraryFragment) {
-          path.add(convertElement2(fragment.element));
+          path.add(
+            convertLibraryFragment(fragment as CompilationUnitElementImpl),
+          );
         }
+        path.add(convertElement2(e.asElement2!));
       }
     }
   }

pkg/analysis_server/test/plugin/protocol_dart_test.dart

@@ -133,9 +133,9 @@ class A {
   }
 
   void test_dynamic() {
-    var engineElement = engine.DynamicElementImpl.instance;
+    var engineElement = engine.DynamicElementImpl2.instance;
     // create notification Element
-    var element = convertElement(engineElement);
+    var element = convertElement2(engineElement);
     expect(element.kind, ElementKind.UNKNOWN);
     expect(element.name, 'dynamic');
     expect(element.location, isNull);

pkg/analysis_server/test/search/element_references_test.dart

@@ -402,7 +402,7 @@ enum E {
   E(this.fff); // 02
   E.named() : fff = 0; // 03
   void foo() {
-    fff = 0; // 04 
+    fff = 0; // 04
     fff += 0; // 05
     fff; // 06
     fff(); // 07