DeCo. Deprecate Element.isSynthetic, migrate analyzer/ to more specific flags.

scheglov · Commit Queue · commit c4fcd14b6b6c · 2025-12-04T09:34:10.000-08:00
Change-Id: I4975083e7ad64b4ec790f49da70e2060e86722ea Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/465984 Reviewed-by: Samuel Rawlins <srawlins@google.com> Reviewed-by: Johnni Winther <johnniwinther@google.com> Commit-Queue: Konstantin Shcheglov <scheglov@google.com>
diff --git a/pkg/analyzer/CHANGELOG.md b/pkg/analyzer/CHANGELOG.md
@@ -29,6 +29,7 @@
   Use `isOriginDeclaration`, `isOriginGetterSetter`, `isOriginDeclaringFormalParameter`, `isOriginEnumValues` instead.
 * Deprecate `PropertyAccessorElement.isSynthetic`.
   Use `isOriginDeclaration`, `isOriginInterface`, `isOriginVariable` instead.
+* Deprecate `Element.isSynthetic`, use `isOriginXyz` properties instead.
 
 ## 9.0.0
 * Remove deprecated field `Diagnostic.data`.
diff --git a/pkg/analyzer/api.txt b/pkg/analyzer/api.txt
@@ -3453,7 +3453,7 @@ package:analyzer/dart/element/element.dart:
     id (getter: int)
     isPrivate (getter: bool)
     isPublic (getter: bool)
-    isSynthetic (getter: bool)
+    isSynthetic (getter: bool, deprecated)
     kind (getter: ElementKind)
     library (getter: LibraryElement?)
     lookupName (getter: String?)
@@ -3611,7 +3611,7 @@ package:analyzer/dart/element/element.dart:
     isAugmentation (getter: bool)
     isGenerator (getter: bool)
     isSynchronous (getter: bool)
-    isSynthetic (getter: bool)
+    isSynthetic (getter: bool, deprecated)
     libraryFragment (getter: LibraryFragment)
     nextFragment (getter: ExecutableFragment?)
     previousFragment (getter: ExecutableFragment?)
diff --git a/pkg/analyzer/lib/dart/element/element.dart b/pkg/analyzer/lib/dart/element/element.dart
@@ -507,6 +507,7 @@ abstract class Element {
   /// A synthetic element is an element that is not represented in the source
   /// code explicitly, but is implied by the source code, such as the default
   /// constructor for a class that does not explicitly define any constructors.
+  @Deprecated('Use isOriginX instead')
   bool get isSynthetic;
 
   /// The kind of this element.
@@ -1155,6 +1156,7 @@ abstract class ExecutableFragment implements FunctionTypedFragment {
   /// A synthetic fragment is a fragment that is not represented in the source
   /// code explicitly, but is implied by the source code, such as the default
   /// constructor for a class that does not explicitly define any constructors.
+  @Deprecated('Use isOriginX instead')
   bool get isSynthetic;
 
   @override
diff --git a/pkg/analyzer/lib/src/dart/analysis/search.dart b/pkg/analyzer/lib/src/dart/analysis/search.dart
@@ -342,15 +342,15 @@ class Search {
     var elements = <Element>[];
 
     void addElement(Element element) {
-      if (!element.isSynthetic && element.displayName == name) {
+      if (element.displayName == name) {
         elements.add(element);
       }
     }
 
     void addElements(InterfaceElement element) {
-      element.getters.forEach(addElement);
-      element.setters.forEach(addElement);
-      element.fields.forEach(addElement);
+      element.getters.where((e) => e.isOriginDeclaration).forEach(addElement);
+      element.setters.where((e) => e.isOriginDeclaration).forEach(addElement);
+      element.fields.where((e) => e.isOriginDeclaration).forEach(addElement);
       element.methods.forEach(addElement);
     }
 
@@ -552,7 +552,7 @@ class Search {
     var elements = <Element>[];
 
     void addElement(Element element) {
-      if (!element.isSynthetic && regExp.hasMatch(element.displayName)) {
+      if (regExp.hasMatch(element.displayName)) {
         elements.add(element);
       }
     }
@@ -562,15 +562,17 @@ class Search {
       var libraryResult = await _driver.getLibraryByUri(file.uriStr);
       if (libraryResult is LibraryElementResult) {
         var element = libraryResult.element;
-        element.getters.forEach(addElement);
+        element.getters.where((e) => e.isOriginDeclaration).forEach(addElement);
         element.classes.forEach(addElement);
         element.enums.forEach(addElement);
         element.extensions.forEach(addElement);
         element.extensionTypes.forEach(addElement);
         element.topLevelFunctions.forEach(addElement);
         element.mixins.forEach(addElement);
-        element.setters.forEach(addElement);
-        element.topLevelVariables.forEach(addElement);
+        element.setters.where((e) => e.isOriginDeclaration).forEach(addElement);
+        element.topLevelVariables
+            .where((e) => e.isOriginDeclaration)
+            .forEach(addElement);
         element.typeAliases.forEach(addElement);
       }
     }
diff --git a/pkg/analyzer/lib/src/dart/element/element.dart b/pkg/analyzer/lib/src/dart/element/element.dart
@@ -8828,6 +8828,11 @@ sealed class PropertyAccessorFragmentImpl extends ExecutableFragmentImpl
   @override
   PropertyAccessorElementImpl get element;
 
+  @Deprecated('Use isOriginX instead.')
+  @override
+  @trackedIncludedInId
+  bool get isSynthetic => super.isSynthetic;
+
   @override
   MetadataImpl get metadata {
     _ensureReadResolution();
@@ -8839,11 +8844,8 @@ sealed class PropertyAccessorFragmentImpl extends ExecutableFragmentImpl
     if (nameOffset case var nameOffset?) {
       return nameOffset;
     }
-    if (isSynthetic) {
+    if (isOriginVariable) {
       var variable = element.variable;
-      if (variable.isSynthetic) {
-        return enclosingFragment.offset;
-      }
       return variable._firstFragment.offset;
     }
     return firstTokenOffset!;
@@ -8916,16 +8918,20 @@ abstract class PropertyInducingElementImpl extends VariableElementImpl
   @override
   @trackedIndirectly
   Element get nonSynthetic {
-    if (isSynthetic) {
+    if (isOriginDeclaration) {
+      return this;
+    } else if (this case FieldElementImpl(
+      isOriginDeclaringFormalParameter: true,
+    )) {
+      return this;
+    } else {
       if (enclosingElement case EnumElementImpl enclosingElement) {
         // TODO(scheglov): remove 'index'?
         if (name == 'index' || name == 'values') {
           return enclosingElement;
         }
       }
       return (getter ?? setter)!;
-    } else {
-      return this;
     }
   }
 
diff --git a/pkg/analyzer/lib/src/dart/element/member.dart b/pkg/analyzer/lib/src/dart/element/member.dart
@@ -179,6 +179,7 @@ abstract class SubstitutedElementImpl implements Element {
   @override
   bool get isPublic => baseElement.isPublic;
 
+  @Deprecated('Use isOriginX instead')
   @override
   bool get isSynthetic => baseElement.isSynthetic;
 
@@ -788,7 +789,7 @@ class SubstitutedGetterElementImpl
 
   @override
   Element get nonSynthetic {
-    if (isSynthetic) {
+    if (isOriginVariable) {
       return variable.nonSynthetic;
     } else {
       return this;
@@ -992,7 +993,7 @@ class SubstitutedSetterElementImpl
 
   @override
   Element get nonSynthetic {
-    if (isSynthetic) {
+    if (isOriginVariable) {
       return variable.nonSynthetic;
     } else {
       return this;
diff --git a/pkg/analyzer/lib/src/error/element_usage_detector.dart b/pkg/analyzer/lib/src/error/element_usage_detector.dart
@@ -53,7 +53,7 @@ class ElementUsageDetector<TagInfo extends Object> {
       return;
     }
     // Implicit getters/setters.
-    if (element.isSynthetic && element is PropertyAccessorElement) {
+    if (element is PropertyAccessorElement && element.isOriginVariable) {
       element = element.variable;
     }
     var tagInfo = elementUsageSet.getTagInfo(element);
diff --git a/pkg/analyzer/lib/src/error/unused_local_elements_verifier.dart b/pkg/analyzer/lib/src/error/unused_local_elements_verifier.dart
@@ -846,9 +846,6 @@ class UnusedLocalElementsVerifier extends RecursiveAstVisitor<void> {
         return true;
       }
     }
-    if (element.isSynthetic) {
-      return true;
-    }
     if (element is FieldElement) {
       var getter = element.getter;
       if (getter == null) {
@@ -868,9 +865,6 @@ class UnusedLocalElementsVerifier extends RecursiveAstVisitor<void> {
   }
 
   bool _isUsedElement(Element element) {
-    if (element.isSynthetic) {
-      return true;
-    }
     if (element is LocalVariableElement ||
         element is LocalFunctionElement && !element.isStatic) {
       // local variable or function
@@ -941,9 +935,6 @@ class UnusedLocalElementsVerifier extends RecursiveAstVisitor<void> {
     if (_isPubliclyAccessible(element)) {
       return true;
     }
-    if (element.isSynthetic) {
-      return true;
-    }
     if (_hasPragmaVmEntryPoint(element)) {
       return true;
     }
diff --git a/pkg/analyzer/lib/src/error/use_result_verifier.dart b/pkg/analyzer/lib/src/error/use_result_verifier.dart
@@ -175,7 +175,7 @@ class UseResultVerifier {
 
   static ElementAnnotation? _getUseResultMetadata(Element element) {
     // Implicit getters/setters.
-    if (element.isSynthetic && element is PropertyAccessorElement) {
+    if (element is PropertyAccessorElement && element.isOriginVariable) {
       element = element.variable;
     }
 
diff --git a/pkg/analyzer/lib/src/fine/manifest_item.dart b/pkg/analyzer/lib/src/fine/manifest_item.dart
@@ -1077,7 +1077,9 @@ sealed class ManifestItem<E extends ElementImpl> {
 
   @mustCallSuper
   bool match(MatchContext context, E element) {
-    return flags.isSynthetic == element.isSynthetic &&
+    return
+    // ignore: deprecated_member_use_from_same_package
+    flags.isSynthetic == element.isSynthetic &&
         metadata.match(context, element.effectiveMetadata);
   }
 
@@ -2140,6 +2142,7 @@ extension type _ManifestItemFlags._(int _bits) {
 
   factory _ManifestItemFlags.encode(ElementImpl element) {
     var bits = 0;
+    // ignore: deprecated_member_use_from_same_package
     if (element.isSynthetic) {
       bits |= _maskFor(_ManifestItemFlag.isSynthetic);
     }
diff --git a/pkg/analyzer/lib/src/generated/resolver.dart b/pkg/analyzer/lib/src/generated/resolver.dart
@@ -1757,7 +1757,7 @@ class ResolverVisitor extends ThrowingAstVisitor<void>
         node is PropertyAccess ||
         node is SimpleIdentifier) {
       if (element is InternalSetterElement) {
-        if (element.isSynthetic) {
+        if (element.isOriginVariable) {
           writeType = element.variable.type;
         } else {
           var parameters = element.formalParameters;
diff --git a/pkg/analyzer/lib/src/summary2/element_builder.dart b/pkg/analyzer/lib/src/summary2/element_builder.dart
@@ -434,7 +434,7 @@ class ElementBuilder {
     FragmentImpl? lastFragment,
     GetterFragmentImpl getterFragment,
   ) {
-    assert(!getterFragment.isSynthetic);
+    assert(getterFragment.isOriginDeclaration);
 
     var instanceFragment =
         getterFragment.enclosingFragment as InstanceFragmentImpl;
@@ -544,7 +544,7 @@ class ElementBuilder {
     FragmentImpl? lastFragment,
     SetterFragmentImpl setterFragment,
   ) {
-    assert(!setterFragment.isSynthetic);
+    assert(setterFragment.isOriginDeclaration);
 
     var instanceFragment =
         setterFragment.enclosingFragment as InstanceFragmentImpl;
@@ -665,7 +665,7 @@ class ElementBuilder {
     FragmentImpl? lastFragment,
     GetterFragmentImpl getterFragment,
   ) {
-    assert(!getterFragment.isSynthetic);
+    assert(getterFragment.isOriginDeclaration);
     libraryFragment.addGetter(getterFragment);
 
     var lastVariableElement = _topLevelVariableElement(lastFragment);
@@ -715,7 +715,7 @@ class ElementBuilder {
     FragmentImpl? lastFragment,
     SetterFragmentImpl setterFragment,
   ) {
-    assert(!setterFragment.isSynthetic);
+    assert(setterFragment.isOriginDeclaration);
     libraryFragment.addSetter(setterFragment);
 
     var lastVariableElement = _topLevelVariableElement(lastFragment);
diff --git a/pkg/analyzer/lib/src/summary2/top_level_inference.dart b/pkg/analyzer/lib/src/summary2/top_level_inference.dart
@@ -154,22 +154,8 @@ class _InitializerInference {
   }
 
   void _addVariableNode(PropertyInducingElementImpl element) {
-    if (element.isSynthetic) {
-      var shouldInfer = false;
-      if (element is FieldElementImpl) {
-        // For enums `values` is purely synthetic.
-        if (element.isEnumValues) {
-          shouldInfer = true;
-        }
-        // For declaring formal parameters the field is synthetic.
-        // But we want to infer the type from the default value.
-        if (element.declaringFormalParameter != null) {
-          shouldInfer = true;
-        }
-      }
-      if (!shouldInfer) {
-        return;
-      }
+    if (element.isOriginGetterSetter) {
+      return;
     }
 
     if (!element.hasImplicitType) return;
diff --git a/pkg/analyzer/lib/src/summary2/types_builder.dart b/pkg/analyzer/lib/src/summary2/types_builder.dart
@@ -383,12 +383,12 @@ class TypesBuilder {
     switch (element) {
       case GetterElementImpl():
         var variable = element.variable;
-        if (variable.isSynthetic) {
+        if (variable.isOriginGetterSetter) {
           variable.type = element.returnType;
         }
       case SetterElementImpl():
         var variable = element.variable;
-        if (variable.isSynthetic && variable.getter == null) {
+        if (variable.isOriginGetterSetter && variable.getter == null) {
           var valueType = element.valueFormalParameter.type;
           variable.type = valueType;
         }
diff --git a/pkg/analyzer/test/src/summary/element_text.dart b/pkg/analyzer/test/src/summary/element_text.dart
@@ -997,6 +997,7 @@ class _Element2Writer extends _AbstractElementWriter {
     _sink.writeIndentedLine(() {
       _writeObjectId(f);
       _sink.writeIf(f.isAugmentation, 'augment ');
+      // ignore: deprecated_member_use_from_same_package
       _sink.writeIf(f.isSynthetic, 'synthetic ');
 
       _assertHasExactlyOneTrue([f.isOriginDeclaration, f.isOriginVariable]);
@@ -1606,6 +1607,7 @@ class _Element2Writer extends _AbstractElementWriter {
     _sink.writeIndentedLine(() {
       _writeObjectId(f);
       _sink.writeIf(f.isAugmentation, 'augment ');
+      // ignore: deprecated_member_use_from_same_package
       _sink.writeIf(f.isSynthetic, 'synthetic ');
 
       _assertHasExactlyOneTrue([

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class ElementUsageDetector<TagInfo extends Object> {`
`53`	`53`	`return;`
`54`	`54`	`}`
`55`	`55`	`// Implicit getters/setters.`
`56`		`- if (element.isSynthetic && element is PropertyAccessorElement) {`
	`56`	`+ if (element is PropertyAccessorElement && element.isOriginVariable) {`
`57`	`57`	`element = element.variable;`
`58`	`58`	`}`
`59`	`59`	`var tagInfo = elementUsageSet.getTagInfo(element);`
Original file line number	Diff line number	Diff line change
`@@ -846,9 +846,6 @@ class UnusedLocalElementsVerifier extends RecursiveAstVisitor<void> {`
`846`	`846`	`return true;`
`847`	`847`	`}`
`848`	`848`	`}`
`849`		`- if (element.isSynthetic) {`
`850`		`- return true;`
`851`		`- }`
`852`	`849`	`if (element is FieldElement) {`
`853`	`850`	`var getter = element.getter;`
`854`	`851`	`if (getter == null) {`
`@@ -868,9 +865,6 @@ class UnusedLocalElementsVerifier extends RecursiveAstVisitor<void> {`
`868`	`865`	`}`
`869`	`866`
`870`	`867`	`bool _isUsedElement(Element element) {`
`871`		`- if (element.isSynthetic) {`
`872`		`- return true;`
`873`		`- }`
`874`	`868`	`if (element is LocalVariableElement \|\|`
`875`	`869`	`element is LocalFunctionElement && !element.isStatic) {`
`876`	`870`	`// local variable or function`
`@@ -941,9 +935,6 @@ class UnusedLocalElementsVerifier extends RecursiveAstVisitor<void> {`
`941`	`935`	`if (_isPubliclyAccessible(element)) {`
`942`	`936`	`return true;`
`943`	`937`	`}`
`944`		`- if (element.isSynthetic) {`
`945`		`- return true;`
`946`		`- }`
`947`	`938`	`if (_hasPragmaVmEntryPoint(element)) {`
`948`	`939`	`return true;`
`949`	`940`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ class UseResultVerifier {`
`175`	`175`
`176`	`176`	`static ElementAnnotation? _getUseResultMetadata(Element element) {`
`177`	`177`	`// Implicit getters/setters.`
`178`		`- if (element.isSynthetic && element is PropertyAccessorElement) {`
	`178`	`+ if (element is PropertyAccessorElement && element.isOriginVariable) {`
`179`	`179`	`element = element.variable;`
`180`	`180`	`}`
`181`	`181`