Deprecate Element.nonSynthetic2, use nonSynthetic instead.

fshcheglov · Commit Queue · commit 1dc17b9a22fb · 2025-06-20T08:57:19.000-07:00
Change-Id: Ie47d5f1e1fbaa7473747c5b43333a9c0cd689f74 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/435664 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Reviewed-by: Paul Berry <paulberry@google.com> Commit-Queue: Paul Berry <paulberry@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
diff --git a/pkg/analysis_server/lib/src/computer/computer_call_hierarchy.dart b/pkg/analysis_server/lib/src/computer/computer_call_hierarchy.dart
@@ -143,7 +143,7 @@ class CallHierarchyItem {
   }
 
   static Element _nonSynthetic(Element element) {
-    element = element.nonSynthetic2;
+    element = element.nonSynthetic;
     if (element.isSynthetic) {
       element = element.enclosingElement ?? element;
     }
diff --git a/pkg/analysis_server/lib/src/computer/computer_lazy_type_hierarchy.dart b/pkg/analysis_server/lib/src/computer/computer_lazy_type_hierarchy.dart
@@ -216,7 +216,7 @@ class TypeHierarchyItem {
   /// Returns the [SourceRange] of the code for [element].
   static SourceRange _codeRangeForElement(Element element) {
     // Non-synthetic elements should always have code locations.
-    var firstFragment = element.nonSynthetic2.firstFragment as FragmentImpl;
+    var firstFragment = element.nonSynthetic.firstFragment as FragmentImpl;
     return SourceRange(firstFragment.codeOffset!, firstFragment.codeLength!);
   }
 
@@ -227,7 +227,7 @@ class TypeHierarchyItem {
 
   /// Returns the [SourceRange] of the name for [element].
   static SourceRange _nameRangeForElement(Element element) {
-    var fragment = element.nonSynthetic2.firstFragment;
+    var fragment = element.nonSynthetic.firstFragment;
 
     // Some non-synthetic items can still have invalid nameOffsets (for example
     // a compilation unit). This should never happen here, but guard against it.
diff --git a/pkg/analysis_server/lib/src/computer/computer_overrides.dart b/pkg/analysis_server/lib/src/computer/computer_overrides.dart
@@ -51,14 +51,14 @@ class DartUnitOverridesComputer {
         var superMember =
             superElements.isNotEmpty
                 ? proto.newOverriddenMember_fromEngine(
-                  superElements.first.nonSynthetic2,
+                  superElements.first.nonSynthetic,
                 )
                 : null;
         var interfaceMembers =
             interfaceElements
                 .map(
                   (member) => proto.newOverriddenMember_fromEngine(
-                    member.nonSynthetic2,
+                    member.nonSynthetic,
                   ),
                 )
                 .toList();
diff --git a/pkg/analysis_server/lib/src/lsp/handlers/handler_definition.dart b/pkg/analysis_server/lib/src/lsp/handlers/handler_definition.dart
@@ -218,7 +218,7 @@ class DefinitionHandler
     // variable to get the codeOffset/codeLength.
     if (codeFragment is PropertyAccessorFragment &&
         codeFragment.element.isSynthetic) {
-      codeFragment = codeFragment.element.nonSynthetic2.firstFragment;
+      codeFragment = codeFragment.element.nonSynthetic.firstFragment;
     }
 
     // For extension types, the primary constructor has a range that covers only
diff --git a/pkg/analysis_server/lib/src/lsp/handlers/handler_implementation.dart b/pkg/analysis_server/lib/src/lsp/handlers/handler_implementation.dart
@@ -94,7 +94,7 @@ class ImplementationHandler
                     // Filter based on type, so when searching for members we don't
                     // include any intermediate classes that don't have
                     // implementations for the method.
-                    ? helper.findMemberElement(element)?.nonSynthetic2
+                    ? helper.findMemberElement(element)?.nonSynthetic
                     : element;
               })
               .nonNulls
diff --git a/pkg/analysis_server/lib/src/lsp/handlers/handler_references.dart b/pkg/analysis_server/lib/src/lsp/handlers/handler_references.dart
@@ -51,7 +51,7 @@ class ReferencesHandler
   }
 
   List<Location> _getDeclarations(Element element) {
-    return element.nonSynthetic2.fragments
+    return element.nonSynthetic.fragments
         .map((fragment) => fragmentToLocation(uriConverter, fragment))
         .nonNulls
         .toList();
diff --git a/pkg/analysis_server/lib/src/lsp/handlers/handler_type_definition.dart b/pkg/analysis_server/lib/src/lsp/handlers/handler_type_definition.dart
@@ -116,7 +116,7 @@ class TypeDefinitionHandler
 
         // TODO(dantup): Consider returning all fragments for the type instead
         //  of only the first.
-        var targetFragment = element.nonSynthetic2.firstFragment;
+        var targetFragment = element.nonSynthetic.firstFragment;
         var targetUnit = targetFragment.libraryFragment;
         if (targetUnit == null) {
           return success(_emptyResult);
diff --git a/pkg/analysis_server/lib/src/search/type_hierarchy.dart b/pkg/analysis_server/lib/src/search/type_hierarchy.dart
@@ -68,7 +68,7 @@ class TypeHierarchyComputer {
       }
       // create a subclass item
       var subMemberElement = helper.findMemberElement(subElement);
-      var subMemberElementDeclared = subMemberElement?.nonSynthetic2;
+      var subMemberElementDeclared = subMemberElement?.nonSynthetic;
       subItem = TypeHierarchyItem(
         convertElement(subElement),
         memberElement:
@@ -120,7 +120,7 @@ class TypeHierarchyComputer {
         displayName = '${classElement.displayName}<$typeArgumentsStr>';
       }
       var memberElement = helper.findMemberElement(classElement);
-      var memberElementDeclared = memberElement?.nonSynthetic2;
+      var memberElementDeclared = memberElement?.nonSynthetic;
       item = TypeHierarchyItem(
         convertElement(classElement),
         displayName: displayName,
diff --git a/pkg/analyzer/CHANGELOG.md b/pkg/analyzer/CHANGELOG.md
@@ -47,6 +47,7 @@
 * Deprecate `InterfaceFragment.constructors2`, use `constructors` instead.
 * Deprecate `JoinPatternVariableElement.variables2`, use `variables` instead.
 * Deprecate `Annotatable.metadata2`, use `metadata` instead.
+* Deprecate `Element.nonSynthetic2`, use `nonSynthetic` instead.
 
 ## 7.4.1
 * Restore `InstanceElement.augmented` getter.
diff --git a/pkg/analyzer/api.txt b/pkg/analyzer/api.txt
@@ -3373,7 +3373,8 @@ package:analyzer/dart/element/element.dart:
     library2 (getter: LibraryElement?)
     lookupName (getter: String?)
     name3 (getter: String?)
-    nonSynthetic2 (getter: Element)
+    nonSynthetic (getter: Element)
+    nonSynthetic2 (getter: Element, deprecated)
     session (getter: AnalysisSession?)
     accept2 (method: T? Function<T>(ElementVisitor2<T>))
     displayString2 (method: String Function({bool multiline, bool preferTypeAlias}))
diff --git a/pkg/analyzer/lib/dart/element/element.dart b/pkg/analyzer/lib/dart/element/element.dart
@@ -673,6 +673,17 @@ abstract class Element {
   /// element is returned. For example, for a synthetic getter of a
   /// non-synthetic field the field is returned; for a synthetic constructor
   /// the enclosing class is returned.
+  Element get nonSynthetic;
+
+  /// The non-synthetic element that caused this element to be created.
+  ///
+  /// If this element is not synthetic, then the element itself is returned.
+  ///
+  /// If this element is synthetic, then the corresponding non-synthetic
+  /// element is returned. For example, for a synthetic getter of a
+  /// non-synthetic field the field is returned; for a synthetic constructor
+  /// the enclosing class is returned.
+  @Deprecated('Use nonSynthetic instead')
   Element get nonSynthetic2;
 
   /// The analysis session in which this element is defined.
diff --git a/pkg/analyzer/lib/error/listener.dart b/pkg/analyzer/lib/error/listener.dart
@@ -116,7 +116,7 @@ class DiagnosticReporter {
     List<DiagnosticMessage>? contextMessages,
     Object? data,
   }) {
-    var nonSynthetic = element.nonSynthetic2;
+    var nonSynthetic = element.nonSynthetic;
     atOffset(
       diagnosticCode: diagnosticCode,
       offset: nonSynthetic.firstFragment.nameOffset2 ?? -1,
diff --git a/pkg/analyzer/lib/src/dart/element/element.dart b/pkg/analyzer/lib/src/dart/element/element.dart
@@ -863,7 +863,7 @@ class ConstructorElementImpl extends ExecutableElementImpl
   }
 
   @override
-  Element get nonSynthetic2 {
+  Element get nonSynthetic {
     if (isSynthetic) {
       return enclosingElement;
     } else {
@@ -2083,7 +2083,11 @@ abstract class ElementImpl implements Element {
   }
 
   @override
-  Element get nonSynthetic2 => this;
+  Element get nonSynthetic => this;
+
+  @Deprecated('Use nonSynthetic instead')
+  @override
+  Element get nonSynthetic2 => nonSynthetic;
 
   /// The reference of this element, used during reading summaries.
   ///
@@ -4508,11 +4512,11 @@ class GetterElementImpl extends PropertyAccessorElementImpl
   }
 
   @override
-  Element get nonSynthetic2 {
+  Element get nonSynthetic {
     if (!isSynthetic) {
       return this;
     } else if (variable3 case var variable?) {
-      return variable.nonSynthetic2;
+      return variable.nonSynthetic;
     }
     throw StateError('Synthetic getter has no variable');
   }
@@ -4705,7 +4709,7 @@ abstract class InstanceElementImpl extends ElementImpl
   String? get name3 => firstFragment.name2;
 
   @override
-  Element get nonSynthetic2 => isSynthetic ? enclosingElement : this as Element;
+  Element get nonSynthetic => isSynthetic ? enclosingElement : this as Element;
 
   @override
   AnalysisSession? get session => firstFragment.session;
@@ -6205,7 +6209,7 @@ class LibraryElementImpl extends ElementImpl
   String? get name3 => name;
 
   @override
-  LibraryElementImpl get nonSynthetic2 => this;
+  LibraryElementImpl get nonSynthetic => this;
 
   @override
   Namespace get publicNamespace {
@@ -8142,7 +8146,6 @@ enum Modifier {
   /// enclosing element. This includes not only explicitly specified type
   /// annotations, but also inferred types.
   NO_ENCLOSING_TYPE_PARAMETER_REFERENCE,
-
   PROMOTABLE,
 
   /// Indicates whether the type of a [PropertyInducingFragmentImpl] should be
@@ -8230,7 +8233,7 @@ class MultiplyDefinedElementImpl extends ElementImpl
   LibraryElement get library2 => libraryFragment.element;
 
   @override
-  Element get nonSynthetic2 => this;
+  Element get nonSynthetic => this;
 
   @override
   AnalysisSession get session => libraryFragment.session;
@@ -9202,7 +9205,7 @@ abstract class PropertyInducingElementImpl extends VariableElementImpl
   }
 
   @override
-  Element get nonSynthetic2 {
+  Element get nonSynthetic {
     if (isSynthetic) {
       if (enclosingElement case EnumElementImpl enclosingElement) {
         // TODO(scheglov): remove 'index'?
@@ -9493,11 +9496,11 @@ class SetterElementImpl extends PropertyAccessorElementImpl
   }
 
   @override
-  Element get nonSynthetic2 {
+  Element get nonSynthetic {
     if (!isSynthetic) {
       return this;
     } else if (variable3 case var variable?) {
-      return variable.nonSynthetic2;
+      return variable.nonSynthetic;
     }
     throw StateError('Synthetic setter has no variable');
   }
diff --git a/pkg/analyzer/lib/src/dart/element/member.dart b/pkg/analyzer/lib/src/dart/element/member.dart
@@ -291,7 +291,11 @@ abstract class ExecutableMember extends Member
   int get nameOffset => declaration.nameOffset;
 
   @override
-  Element get nonSynthetic2 => _element2;
+  Element get nonSynthetic => _element2;
+
+  @Deprecated('Use nonSynthetic instead')
+  @override
+  Element get nonSynthetic2 => nonSynthetic;
 
   @override
   List<ParameterElementMixin> get parameters {
@@ -568,7 +572,11 @@ class FieldMember extends VariableMember
   String? get name3 => _element2.name3;
 
   @override
-  Element get nonSynthetic2 => _element2.nonSynthetic2;
+  Element get nonSynthetic => _element2.nonSynthetic;
+
+  @Deprecated('Use nonSynthetic instead')
+  @override
+  Element get nonSynthetic2 => nonSynthetic;
 
   @override
   SetterElement2OrMember? get setter2 {
@@ -688,11 +696,11 @@ class GetterMember extends PropertyAccessorMember
   String? get lookupName => _element2.lookupName;
 
   @override
-  Element get nonSynthetic2 {
+  Element get nonSynthetic {
     if (!isSynthetic) {
       return this;
     } else if (variable3 case var variable?) {
-      return variable.nonSynthetic2;
+      return variable.nonSynthetic;
     }
     throw StateError('Synthetic getter has no variable');
   }
@@ -1048,7 +1056,11 @@ class ParameterMember extends VariableMember
   String get nameShared => name3!;
 
   @override
-  Element get nonSynthetic2 => _element2;
+  Element get nonSynthetic => _element2;
+
+  @Deprecated('Use nonSynthetic instead')
+  @override
+  Element get nonSynthetic2 => nonSynthetic;
 
   @deprecated
   @override
@@ -1351,11 +1363,11 @@ class SetterMember extends PropertyAccessorMember
   String? get lookupName => _element2.lookupName;
 
   @override
-  Element get nonSynthetic2 {
+  Element get nonSynthetic {
     if (!isSynthetic) {
       return this;
     } else if (variable3 case var variable?) {
-      return variable.nonSynthetic2;
+      return variable.nonSynthetic;
     }
     throw StateError('Synthetic setter has no variable');
   }
diff --git a/pkg/analyzer/lib/src/diagnostic/diagnostic_factory.dart b/pkg/analyzer/lib/src/diagnostic/diagnostic_factory.dart
@@ -52,9 +52,9 @@ class DiagnosticFactory {
     Element originalElement,
     List<Object> arguments,
   ) {
-    var duplicate = duplicateElement.nonSynthetic2;
+    var duplicate = duplicateElement.nonSynthetic;
     var duplicateFragment = duplicate.firstFragment;
-    var original = originalElement.nonSynthetic2;
+    var original = originalElement.nonSynthetic;
     var originalFragment = original.firstFragment;
     return Diagnostic.tmp(
       source: duplicateFragment.libraryFragment!.source,
@@ -324,7 +324,7 @@ class DiagnosticFactory {
     // Elements enclosing members that can participate in overrides are always
     // named, so we can safely assume `_thisMember.enclosingElement3.name` and
     // `superMember.enclosingElement3.name` are non-`null`.
-    var superFragment = superMember.nonSynthetic2.firstFragment;
+    var superFragment = superMember.nonSynthetic.firstFragment;
     return Diagnostic.tmp(
       source: source,
       offset: errorNode.offset,
diff --git a/pkg/analyzer/lib/src/generated/error_verifier.dart b/pkg/analyzer/lib/src/generated/error_verifier.dart
@@ -3375,7 +3375,7 @@ class ErrorVerifier extends RecursiveAstVisitor<void>
     void report(String memberName, List<ExecutableElement> candidates) {
       var contextMessages =
           candidates.map<DiagnosticMessage>((executable) {
-            var nonSynthetic = executable.nonSynthetic2;
+            var nonSynthetic = executable.nonSynthetic;
             var container = executable.enclosingElement as InterfaceElement;
             return DiagnosticMessageImpl(
               filePath:
diff --git a/pkg/analyzer/lib/src/generated/ffi_verifier.dart b/pkg/analyzer/lib/src/generated/ffi_verifier.dart
@@ -1745,7 +1745,7 @@ class FfiVerifier extends RecursiveAstVisitor<void> {
     var validTarget = false;
 
     var referencedElement = switch (argument) {
-      IdentifierImpl() => argument.element?.nonSynthetic2,
+      IdentifierImpl() => argument.element?.nonSynthetic,
       _ => null,
     };
 
diff --git a/pkg/analyzer/lib/src/generated/resolver.dart b/pkg/analyzer/lib/src/generated/resolver.dart
@@ -5972,7 +5972,7 @@ class _WhyNotPromotedVisitor
         DiagnosticMessageImpl(
           filePath: property.firstFragment.libraryFragment.source.fullName,
           message: message,
-          offset: property.nonSynthetic2.firstFragment.nameOffset2!,
+          offset: property.nonSynthetic.firstFragment.nameOffset2!,
           length: property.name3!.length,
           url: reason.documentationLink.url,
         ),
@@ -6011,7 +6011,7 @@ class _WhyNotPromotedVisitor
         var message =
             "'$propertyName' couldn't be promoted because there is a "
             "conflicting $kind in $enclosingKindName '$enclosingName'";
-        var nonSyntheticElement = conflictingElement.nonSynthetic2;
+        var nonSyntheticElement = conflictingElement.nonSynthetic;
         var nonSyntheticFragment = nonSyntheticElement.firstFragment;
         var source = nonSyntheticFragment.libraryFragment?.source;
         messages.add(
@@ -6110,7 +6110,7 @@ class _WhyNotPromotedVisitor
           "'$propertyName' couldn't be promoted "
           "because field promotion is only available in Dart 3.2 and "
           "above.",
-      offset: property.nonSynthetic2.firstFragment.nameOffset2!,
+      offset: property.nonSynthetic.firstFragment.nameOffset2!,
       length: property.name3!.length,
       url: NonPromotionDocumentationLink.fieldPromotionUnavailable.url,
     );
diff --git a/pkg/analyzer/lib/src/hint/sdk_constraint_verifier.dart b/pkg/analyzer/lib/src/hint/sdk_constraint_verifier.dart
@@ -165,7 +165,7 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     AstNode target, {
     SyntacticEntity? errorEntity,
   }) {
-    element = element?.nonSynthetic2;
+    element = element?.nonSynthetic;
     if (element case HasSinceSdkVersion hasSince) {
       var sinceSdkVersion = hasSince.sinceSdkVersion;
       if (sinceSdkVersion != null) {
diff --git a/pkg/analyzer/lib/src/services/top_level_declarations.dart b/pkg/analyzer/lib/src/services/top_level_declarations.dart
@@ -55,8 +55,8 @@ class TopLevelDeclarations {
       }
 
       var elementLibrary = elementResult.element2;
-      if (_findElement(elementLibrary, element.displayName)?.nonSynthetic2 ==
-          element.nonSynthetic2) {
+      if (_findElement(elementLibrary, element.displayName)?.nonSynthetic ==
+          element.nonSynthetic) {
         resultCache?[element] = elementLibrary;
         return elementLibrary;
       }
diff --git a/pkg/analyzer/test/src/dart/micro/simple_file_resolver_test.dart b/pkg/analyzer/test/src/dart/micro/simple_file_resolver_test.dart
diff --git a/pkg/analyzer/test/src/summary/element_text.dart b/pkg/analyzer/test/src/summary/element_text.dart
diff --git a/pkg/analyzer_plugin/lib/src/utilities/navigation/navigation_dart.dart b/pkg/analyzer_plugin/lib/src/utilities/navigation/navigation_dart.dart

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ class CallHierarchyItem {`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`static Element _nonSynthetic(Element element) {`
`146`		`- element = element.nonSynthetic2;`
	`146`	`+ element = element.nonSynthetic;`
`147`	`147`	`if (element.isSynthetic) {`
`148`	`148`	`element = element.enclosingElement ?? element;`
`149`	`149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,7 @@ class DefinitionHandler`
`218`	`218`	`// variable to get the codeOffset/codeLength.`
`219`	`219`	`if (codeFragment is PropertyAccessorFragment &&`
`220`	`220`	`codeFragment.element.isSynthetic) {`
`221`		`- codeFragment = codeFragment.element.nonSynthetic2.firstFragment;`
	`221`	`+ codeFragment = codeFragment.element.nonSynthetic.firstFragment;`
`222`	`222`	`}`
`223`	`223`
`224`	`224`	`// For extension types, the primary constructor has a range that covers only`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ class ReferencesHandler`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`List<Location> _getDeclarations(Element element) {`
`54`		`- return element.nonSynthetic2.fragments`
	`54`	`+ return element.nonSynthetic.fragments`
`55`	`55`	`.map((fragment) => fragmentToLocation(uriConverter, fragment))`
`56`	`56`	`.nonNulls`
`57`	`57`	`.toList();`