analyzer: Change mock SDK Deprecated to use enum

Change-Id: If3ca71eda399292373e95a26530f8b2c54437779
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/445403
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: srawlins

pkg/analyzer/lib/src/dart/element/extensions.dart

@@ -86,7 +86,10 @@ extension Element2Extension on Element {
     var annotations = metadata.annotations.where((e) => e.isDeprecated);
     return annotations.any((annotation) {
       var value = annotation.computeConstantValue();
-      return value?.getField('_isUse')?.toBoolValue() ?? true;
+      var kindValue = value?.getField('_kind');
+      if (kindValue == null) return true;
+      var kind = kindValue.getField('_name')?.toStringValue();
+      return kind == 'use';
     });
   }
 
@@ -102,6 +105,12 @@ extension Element2Extension on Element {
                 this is! SuperFormalParameterElement)) &&
         library.hasWildcardVariablesFeatureEnabled;
   }
+
+  /// Whether this Element is annotated with a `Deprecated` annotation with a
+  /// `_DeprecationKind` of [kind].
+  bool isDeprecatedWithKind(String kind) => metadata.annotations
+      .where((e) => e.isDeprecated)
+      .any((e) => e.deprecationKind == kind);
 }
 
 extension Element2OrNullExtension on Element? {
@@ -111,11 +120,24 @@ extension Element2OrNullExtension on Element? {
   }
 }
 
-extension ElementAnnotationExtensions on ElementAnnotation {
+extension ElementAnnotationExtension on ElementAnnotation {
   static final Map<String, TargetKind> _targetKindsByName = {
     for (var kind in TargetKind.values) kind.name: kind,
   };
 
+  /// The kind of deprecation, if this annotation is a `Deprecated` annotation.
+  ///
+  /// `null` is returned if this is not a `Deprecated` annotation.
+  String? get deprecationKind {
+    if (!isDeprecated) return null;
+    return computeConstantValue()
+            ?.getField('_kind')
+            ?.getField('_name')
+            ?.toStringValue() ??
+        // For SDKs where the `Deprecated` class does not have a deprecation kind.
+        'use';
+  }
+
   /// Return the target kinds defined for this [ElementAnnotation].
   Set<TargetKind> get targetKinds {
     var element = this.element;

pkg/analyzer/lib/src/error/annotation_verifier.dart

@@ -117,34 +117,31 @@ class AnnotationVerifier {
 
   void _checkDeprecated(Annotation node) {
     var element = node.elementAnnotation;
-    var value = element?.computeConstantValue();
-    if (value == null) return;
+    if (element == null) return;
+    assert(element.isDeprecated);
+    var kind = element.deprecationKind;
+    if (kind == null) return;
 
     // The vast majority of deprecated annotations use the default constructor.
     // Check this case first.
-    if (value.getField('_isUse')?.toBoolValue() ?? true) return;
+    if (kind == 'use') return;
 
-    var isExtend = value.getField('_isExtend')?.toBoolValue() ?? false;
-    if (isExtend) {
+    if (kind == 'extend') {
       _checkDeprecatedExtend(node, node.parent);
       return;
     }
 
-    var isImplement = value.getField('_isImplement')?.toBoolValue() ?? false;
-    if (isImplement) {
+    if (kind == 'implement') {
       _checkDeprecatedImplement(node, node.parent);
       return;
     }
 
-    var isSubclass = value.getField('_isSubclass')?.toBoolValue() ?? false;
-    if (isSubclass) {
+    if (kind == 'subclass') {
       _checkDeprecatedSubclass(node, node.parent);
       return;
     }
 
-    var isInstantiate =
-        value.getField('_isInstantiate')?.toBoolValue() ?? false;
-    if (isInstantiate) {
+    if (kind == 'instantiate') {
       _checkDeprecatedInstantiate(node, node.parent);
       return;
     }

pkg/analyzer/lib/src/error/deprecated_functionality_verifier.dart

@@ -5,6 +5,7 @@
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/src/dart/ast/ast.dart';
+import 'package:analyzer/src/dart/element/extensions.dart';
 import 'package:analyzer/src/error/codes.dart';
 
 class DeprecatedFunctionalityVerifier {
@@ -31,7 +32,7 @@ class DeprecatedFunctionalityVerifier {
   void constructorName(ConstructorName node) {
     var classElement = node.type.element;
     if (classElement == null) return;
-    if (classElement.hasDeprecatedWithField('_isInstantiate')) {
+    if (classElement.isDeprecatedWithKind('instantiate')) {
       _diagnosticReporter.atNode(
         node,
         WarningCode.deprecatedInstantiate,
@@ -57,13 +58,13 @@ class DeprecatedFunctionalityVerifier {
     if (element == null) return;
     if (node.type?.element is InterfaceElement) {
       if (element.library == _currentLibrary) return;
-      if (element.hasDeprecatedWithField('_isExtend')) {
+      if (element.isDeprecatedWithKind('extend')) {
         _diagnosticReporter.atNode(
           node,
           WarningCode.deprecatedExtend,
           arguments: [element.name!],
         );
-      } else if (element.hasDeprecatedWithField('_isSubclass')) {
+      } else if (element.isDeprecatedWithKind('subclass')) {
         _diagnosticReporter.atNode(
           node,
           WarningCode.deprecatedSubclass,
@@ -80,13 +81,13 @@ class DeprecatedFunctionalityVerifier {
       if (element == null) continue;
       if (element.library == _currentLibrary) continue;
       if (namedType.type?.element is InterfaceElement) {
-        if (element.hasDeprecatedWithField('_isImplement')) {
+        if (element.isDeprecatedWithKind('implement')) {
           _diagnosticReporter.atNode(
             namedType,
             WarningCode.deprecatedImplement,
             arguments: [element.name!],
           );
-        } else if (element.hasDeprecatedWithField('_isSubclass')) {
+        } else if (element.isDeprecatedWithKind('subclass')) {
           _diagnosticReporter.atNode(
             namedType,
             WarningCode.deprecatedSubclass,
@@ -104,7 +105,7 @@ class DeprecatedFunctionalityVerifier {
       if (element == null) continue;
       if (element.library == _currentLibrary) continue;
       if (namedType.type?.element is InterfaceElement) {
-        if (element.hasDeprecatedWithField('_isSubclass')) {
+        if (element.isDeprecatedWithKind('subclass')) {
           _diagnosticReporter.atNode(
             namedType,
             WarningCode.deprecatedSubclass,
@@ -115,14 +116,3 @@ class DeprecatedFunctionalityVerifier {
     }
   }
 }
-
-extension on Element {
-  /// Whether this Element is annotated with a `Deprecated` annotation with a
-  /// `true` value for [fieldName].
-  bool hasDeprecatedWithField(String fieldName) {
-    return metadata.annotations.where((e) => e.isDeprecated).any((annotation) {
-      var value = annotation.computeConstantValue();
-      return value?.getField(fieldName)?.toBoolValue() ?? false;
-    });
-  }
-}

pkg/analyzer/lib/src/test_utilities/mock_sdk.dart

@@ -314,41 +314,21 @@ class DateTime extends Object {
 
 class Deprecated extends Object {
   final String message;
-  final bool _isUse;
-  final bool _isImplement;
-  final bool _isExtend;
-  final bool _isSubclass;
-  final bool _isInstantiate;
+  final _DeprecationKind _kind;
   const Deprecated(this.message)
-      : _isUse = true,
-        _isImplement = false,
-        _isExtend = false,
-        _isSubclass = false,
-        _isInstantiate = false;
+      : _kind = _DeprecationKind.use;
   const Deprecated.implement([this.message = "next release"])
-      : _isUse = false,
-        _isImplement = true,
-        _isExtend = false,
-        _isSubclass = false,
-        _isInstantiate = false;
+      : _kind = _DeprecationKind.implement;
   const Deprecated.extend([this.message = "next release"])
-      : _isUse = false,
-        _isImplement = false,
-        _isExtend = true,
-        _isSubclass = false,
-        _isInstantiate = false;
+      : _kind = _DeprecationKind.extend;
   const Deprecated.subclass([this.message = "next release"])
-      : _isUse = false,
-        _isImplement = false,
-        _isExtend = false,
-        _isSubclass = true,
-        _isInstantiate = false;
+      : _kind = _DeprecationKind.subclass;
   const Deprecated.instantiate([this.message = "next release"])
-      : _isUse = false,
-        _isImplement = false,
-        _isExtend = false,
-        _isSubclass = false,
-        _isInstantiate = true;
+      : _kind = _DeprecationKind.instantiate;
+}
+
+enum _DeprecationKind {
+  use, implement, extend, subclass, instantiate;
 }
 
 class pragma {