API. Add DartObject.constructorInvocation

The internal (see deprecation) accessor is currently used by
source_gen and Angular. And it was also requested by Flutter Preview.

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

Author: scheglov

pkg/analyzer/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 8.1.0-dev
+* Add `DartObject.constructorInvocation` with the constructor and arguments.
+
 ## 8.0.0
 * Remove deprecated element model V1.
 * Remove deprecated `DartType.isStructurallyEqualTo`.

pkg/analyzer/api.txt

@@ -3241,8 +3241,15 @@ package:analyzer/dart/ast/visitor.dart:
     visitWithClause (method: R? Function(WithClause))
     visitYieldStatement (method: R? Function(YieldStatement))
 package:analyzer/dart/constant/value.dart:
+  ConstructorInvocation (class extends Object):
+    new (constructor: ConstructorInvocation Function())
+    constructor (getter: ConstructorElement)
+    constructor2 (getter: ConstructorElement, deprecated)
+    namedArguments (getter: Map<String, DartObject>)
+    positionalArguments (getter: List<DartObject>)
   DartObject (class extends Object):
     new (constructor: DartObject Function())
+    constructorInvocation (getter: ConstructorInvocation?)
     hasKnownValue (getter: bool)
     isNull (getter: bool)
     type (getter: DartType?)

pkg/analyzer/lib/dart/constant/value.dart

@@ -16,6 +16,22 @@ import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:meta/meta.dart';
 
+/// Information about a const constructor invocation.
+abstract class ConstructorInvocation {
+  /// The constructor that was called.
+  ConstructorElement get constructor;
+
+  /// The constructor that was called.
+  @Deprecated('Use constructor instead')
+  ConstructorElement get constructor2;
+
+  /// The values of named arguments.
+  Map<String, DartObject> get namedArguments;
+
+  /// The values of positional arguments.
+  List<DartObject> get positionalArguments;
+}
+
 /// A representation of the value of a compile-time constant expression.
 ///
 /// Note that, unlike the mirrors system, the object being represented does *not*
@@ -26,6 +42,10 @@ import 'package:meta/meta.dart';
 ///
 /// Clients may not extend, implement or mix-in this class.
 abstract class DartObject {
+  /// If this object was created by invoking a const constructor, information
+  /// about how the const constructor was invoked; otherwise `null`.
+  ConstructorInvocation? get constructorInvocation;
+
   /// Return `true` if the value of the object being represented is known.
   ///
   /// This method will return `false` if

pkg/analyzer/lib/src/dart/constant/evaluation.dart

@@ -362,7 +362,7 @@ class ConstantEvaluationEngine {
     List<Expression> arguments,
     ConstructorElementMixin2 constructor,
     ConstantVisitor constantVisitor, {
-    ConstructorInvocation? invocation,
+    ConstructorInvocationImpl? invocation,
   }) {
     var result = _InstanceCreationEvaluator.evaluate(
       this,
@@ -411,7 +411,7 @@ class ConstantEvaluationEngine {
     List<Expression> arguments,
     ConstructorElementMixin2 constructor,
     ConstantVisitor constantVisitor, {
-    ConstructorInvocation? invocation,
+    ConstructorInvocationImpl? invocation,
   }) {
     return _InstanceCreationEvaluator.evaluate(
       this,
@@ -2848,7 +2848,7 @@ class _InstanceCreationEvaluator {
 
   final List<TypeImpl>? _typeArguments;
 
-  final ConstructorInvocation _invocation;
+  final ConstructorInvocationImpl _invocation;
 
   final Map<String, NamedExpression> _namedNodes;
 
@@ -2877,7 +2877,7 @@ class _InstanceCreationEvaluator {
     required Map<String, NamedExpression> namedNodes,
     required Map<String, DartObjectImpl> namedValues,
     required List<DartObjectImpl> argumentValues,
-    required ConstructorInvocation invocation,
+    required ConstructorInvocationImpl invocation,
   }) : _namedNodes = namedNodes,
        _namedValues = namedValues,
        _argumentValues = argumentValues,
@@ -3577,7 +3577,7 @@ class _InstanceCreationEvaluator {
     List<TypeImpl>? typeArguments,
     List<Expression> arguments,
     ConstantVisitor constantVisitor, {
-    ConstructorInvocation? invocation,
+    ConstructorInvocationImpl? invocation,
   }) {
     if (!constructor.isConst) {
       Token? keyword;
@@ -3604,7 +3604,7 @@ class _InstanceCreationEvaluator {
       );
     }
 
-    var argumentValues = <DartObjectImpl>[];
+    var positionalValues = <DartObjectImpl>[];
     var namedNodes = <String, NamedExpression>{};
     var namedValues = <String, DartObjectImpl>{};
     for (var i = 0; i < arguments.length; i++) {
@@ -3639,13 +3639,13 @@ class _InstanceCreationEvaluator {
           return argumentConstant;
         }
 
-        argumentValues.add(argumentConstant);
+        positionalValues.add(argumentConstant);
       }
     }
 
-    invocation ??= ConstructorInvocation(
+    invocation ??= ConstructorInvocationImpl(
       constructor,
-      argumentValues,
+      positionalValues,
       namedValues,
     );
 
@@ -3659,7 +3659,7 @@ class _InstanceCreationEvaluator {
       typeArguments,
       namedNodes: namedNodes,
       namedValues: namedValues,
-      argumentValues: argumentValues,
+      argumentValues: positionalValues,
       invocation: invocation,
     );
 

pkg/analyzer/lib/src/dart/constant/value.dart

@@ -24,6 +24,7 @@ import 'package:analyzer/src/dart/element/extensions.dart';
 import 'package:analyzer/src/dart/element/type.dart';
 import 'package:analyzer/src/dart/element/type_system.dart';
 import 'package:analyzer/src/error/codes.dart';
+import 'package:analyzer/src/utilities/extensions/object.dart';
 import 'package:meta/meta.dart';
 
 /// The state of an object representing a boolean value.
@@ -140,36 +141,25 @@ class BoolState extends InstanceState {
 /// [InvalidConstant] represents an invalid result with error information.
 sealed class Constant {}
 
-/// Information about a const constructor invocation.
-class ConstructorInvocation {
-  /// The constructor that was called.
-  final ConstructorElement constructor2;
+class ConstructorInvocationImpl implements ConstructorInvocation {
+  @override
+  final ConstructorElement constructor;
 
-  /// Values of specified arguments, actual values for positional, and `null`
-  /// for named (which are provided as [namedArguments]).
-  final List<DartObjectImpl?> _argumentValues;
+  @override
+  final List<DartObjectImpl> positionalArguments;
 
-  /// The named arguments passed to the constructor.
+  @override
   final Map<String, DartObjectImpl> namedArguments;
 
-  ConstructorInvocation(
-    this.constructor2,
-    this._argumentValues,
+  ConstructorInvocationImpl(
+    this.constructor,
+    this.positionalArguments,
     this.namedArguments,
   );
 
-  /// The positional arguments passed to the constructor.
-  List<DartObjectImpl> get positionalArguments {
-    var result = <DartObjectImpl>[];
-    for (var argument in _argumentValues) {
-      if (argument != null) {
-        result.add(argument);
-      } else {
-        break;
-      }
-    }
-    return result;
-  }
+  @Deprecated('Use constructor instead')
+  @override
+  ConstructorElement get constructor2 => constructor;
 }
 
 /// A representation of an instance of a Dart class.
@@ -254,6 +244,11 @@ class DartObjectImpl implements DartObject, Constant {
     }
   }
 
+  @override
+  ConstructorInvocationImpl? get constructorInvocation {
+    return state.ifTypeOrNull<GenericState>()?.invocation;
+  }
+
   Map<String, DartObjectImpl>? get fields => state.fields;
 
   @override
@@ -559,12 +554,9 @@ class DartObjectImpl implements DartObject, Constant {
 
   /// Gets the constructor that was called to create this value, if this is a
   /// const constructor invocation. Otherwise returns null.
-  ConstructorInvocation? getInvocation() {
-    var state = this.state;
-    if (state is GenericState) {
-      return state.invocation;
-    }
-    return null;
+  @Deprecated('Use constructorInvocation instead')
+  ConstructorInvocationImpl? getInvocation() {
+    return constructorInvocation;
   }
 
   /// Return the result of invoking the '&gt;' operator on this object with the
@@ -1505,7 +1497,7 @@ class GenericState extends InstanceState {
   final Map<String, DartObjectImpl> _fieldMap;
 
   /// Information about the constructor invoked to generate this instance.
-  final ConstructorInvocation? invocation;
+  final ConstructorInvocationImpl? invocation;
 
   @override
   final bool isUnknown;

pkg/analyzer/pubspec.yaml

@@ -1,5 +1,5 @@
 name: analyzer
-version: 8.0.0
+version: 8.1.0-dev
 description: >-
   This package provides a library that performs static analysis of Dart code.
 repository: https://github.com/dart-lang/sdk/tree/main/pkg/analyzer