[kernel] Add RedirectingFactoryInvocation

This adds an internal wrapper expression for redirecting factory invocations. This holds a reference to the original redirecting factory constructor along with the resulting invocation of the generative or factory constructor. The node is removed during constant evaluation and only available to backends through the pre-modular transformations.

TEST=existing

Change-Id: I35c19766117ab2942aefddb4ccebcd2df66babf3
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/454820
Commit-Queue: Johnni Winther <[email protected]>
Reviewed-by: Chloe Stefantsova <[email protected]>
Reviewed-by: Alexander Markov <[email protected]>

Author: johnniwinther

pkg/front_end/lib/src/kernel/constant_evaluator.dart

@@ -2360,6 +2360,16 @@ class ConstantsTransformer extends RemovingTransformer {
     return super.visitConstructorInvocation(node, removalSentinel);
   }
 
+  @override
+  TreeNode visitRedirectingFactoryInvocation(
+    RedirectingFactoryInvocation node,
+    TreeNode? removalSentinel,
+  ) {
+    return transformOrRemove(node.expression, removalSentinel) ??
+        // Coverage-ignore(suite): Not run.
+        node.expression;
+  }
+
   @override
   TreeNode visitStaticInvocation(
     StaticInvocation node,
@@ -5930,6 +5940,13 @@ class ConstantEvaluator
       "Unsupported auxiliary expression ${node} (${node.runtimeType}).",
     );
   }
+
+  @override
+  Constant visitRedirectingFactoryInvocation(
+    RedirectingFactoryInvocation node,
+  ) {
+    return node.expression.accept(this);
+  }
 }
 
 class StatementConstantEvaluator

pkg/front_end/lib/src/type_inference/inference_results.dart

@@ -171,6 +171,11 @@ class SuccessfulInferenceResult implements InvocationInferenceResult {
     List<VariableDeclaration>? hoistedArguments = this.hoistedArguments;
     if (hoistedArguments == null || hoistedArguments.isEmpty) {
       return expression;
+    } else if (expression is RedirectingFactoryInvocation) {
+      return InvocationInferenceResult._insertHoistedExpressions(
+        expression,
+        hoistedArguments,
+      );
     } else {
       assert(
         expression is InvocationExpression || expression is InvalidExpression,

pkg/front_end/lib/src/type_inference/inference_visitor.dart

@@ -769,6 +769,15 @@ class InferenceVisitorImpl extends InferenceVisitorBase
     return ensureAssignableResult(typeContext, inferredResult);
   }
 
+  @override
+  // Coverage-ignore(suite): Not run.
+  ExpressionInferenceResult visitRedirectingFactoryInvocation(
+    RedirectingFactoryInvocation node,
+    DartType typeContext,
+  ) {
+    return _unhandledExpression(node, typeContext);
+  }
+
   @override
   // Coverage-ignore(suite): Not run.
   ExpressionInferenceResult visitListConcatenation(
@@ -2558,10 +2567,9 @@ class InferenceVisitorImpl extends InferenceVisitorBase
     required bool isConst,
     required bool hasInferredTypeArguments,
   }) {
-    Procedure initialTarget = target;
     Expression replacementNode;
 
-    _RedirectionTarget redirectionTarget = _getRedirectionTarget(initialTarget);
+    _RedirectionTarget redirectionTarget = _getRedirectionTarget(target);
     Member resolvedTarget = redirectionTarget.target;
     if (redirectionTarget.typeArguments.any((type) => type is UnknownType)) {
       return null;
@@ -2578,7 +2586,7 @@ class InferenceVisitorImpl extends InferenceVisitorBase
         ..fileOffset = fileOffset;
     } else {
       Substitution substitution = Substitution.fromPairs(
-        initialTarget.function.typeParameters,
+        target.function.typeParameters,
         arguments.types,
       );
       for (int i = 0; i < redirectionTarget.typeArguments.length; i++) {
@@ -2594,8 +2602,11 @@ class InferenceVisitorImpl extends InferenceVisitorBase
       arguments.types.length = redirectionTarget.typeArguments.length;
 
       replacementNode = _buildRedirectingFactoryTargetInvocation(
-        resolvedTarget,
-        new Arguments(
+        redirectingFactoryTarget: target.reference != resolvedTarget.reference
+            ? target
+            : null,
+        effectiveTarget: resolvedTarget,
+        arguments: new Arguments(
           arguments.positional,
           types: arguments.types,
           named: arguments.named,
@@ -2608,25 +2619,26 @@ class InferenceVisitorImpl extends InferenceVisitorBase
     return replacementNode;
   }
 
-  Expression _buildRedirectingFactoryTargetInvocation(
-    Member target,
-    Arguments arguments, {
+  Expression _buildRedirectingFactoryTargetInvocation({
+    required Procedure? redirectingFactoryTarget,
+    required Member effectiveTarget,
+    required Arguments arguments,
     required bool isConst,
     required int fileOffset,
     required bool hasInferredTypeArguments,
   }) {
     Expression? result = problemReporting.checkStaticArguments(
       compilerContext: compilerContext,
-      target: target,
+      target: effectiveTarget,
       arguments: arguments,
       fileOffset: fileOffset,
       fileUri: fileUri,
     );
     if (result != null) {
       return result;
     }
-    if (target is Constructor) {
-      if (isConst && !target.isConst) {
+    if (effectiveTarget is Constructor) {
+      if (isConst && !effectiveTarget.isConst) {
         // Coverage-ignore-block(suite): Not run.
         return problemReporting.buildProblem(
           compilerContext: compilerContext,
@@ -2638,16 +2650,27 @@ class InferenceVisitorImpl extends InferenceVisitorBase
       }
       problemReporting.checkBoundsInConstructorInvocation(
         libraryFeatures: libraryFeatures,
-        constructor: target,
+        constructor: effectiveTarget,
         typeArguments: arguments.types,
         typeEnvironment: typeSchemaEnvironment,
         fileUri: fileUri,
         fileOffset: fileOffset,
       );
-      return new ConstructorInvocation(target, arguments, isConst: isConst)
-        ..fileOffset = fileOffset;
+      ConstructorInvocation constructorInvocation = new ConstructorInvocation(
+        effectiveTarget,
+        arguments,
+        isConst: isConst,
+      )..fileOffset = fileOffset;
+      if (redirectingFactoryTarget != null) {
+        return new RedirectingFactoryInvocation(
+          redirectingFactoryTarget,
+          constructorInvocation,
+        )..fileOffset = fileOffset;
+      } else {
+        return constructorInvocation;
+      }
     } else {
-      Procedure procedure = target as Procedure;
+      Procedure procedure = effectiveTarget as Procedure;
       if (isConst && !procedure.isConst) {
         // Coverage-ignore-block(suite): Not run.
         if (procedure.isExtensionTypeMember) {
@@ -2673,15 +2696,26 @@ class InferenceVisitorImpl extends InferenceVisitorBase
       }
       problemReporting.checkBoundsInFactoryInvocation(
         libraryFeatures: libraryFeatures,
-        factory: target,
+        factory: effectiveTarget,
         typeArguments: arguments.types,
         typeEnvironment: typeSchemaEnvironment,
         fileUri: fileUri,
         fileOffset: fileOffset,
         inferred: hasInferredTypeArguments,
       );
-      return new StaticInvocation(target, arguments, isConst: isConst)
-        ..fileOffset = fileOffset;
+      StaticInvocation factoryInvocation = new StaticInvocation(
+        effectiveTarget,
+        arguments,
+        isConst: isConst,
+      )..fileOffset = fileOffset;
+      if (redirectingFactoryTarget != null) {
+        return new RedirectingFactoryInvocation(
+          redirectingFactoryTarget,
+          factoryInvocation,
+        )..fileOffset = fileOffset;
+      } else {
+        return factoryInvocation;
+      }
     }
   }
 

pkg/front_end/testcases/constructor_tearoffs/lowering/const_redirect.dart.strong.outline.expect

@@ -25,9 +25,9 @@ typedef Alias = self::Const;
 typedef ImplAlias<T extends core::num> = self::_ConstImpl<T>;
 class Class extends core::Object /*hasConstConstructor*/  {
   final field core::List<self::Const> constants;
-  constructor •({core::List<self::Const> constants = const <self::Const>[const self::_ConstImpl::•<dynamic>(), const self::_ConstImpl::•<dynamic>(), const self::_ConstImpl::•<core::String>()]}) → self::Class
+  constructor •({core::List<self::Const> constants = const <self::Const>[/*original=self::Const::impl*/ const self::_ConstImpl::•<dynamic>(), /*original=self::Const::impl*/ const self::_ConstImpl::•<dynamic>(), const self::_ConstImpl::•<core::String>()]}) → self::Class
     ;
-  const constructor named({core::List<self::Const> constants = const <self::Const>[const self::_ConstImpl::•<dynamic>(), const self::_ConstImpl::•<dynamic>(), const self::_ConstImpl::•<core::String>()]}) → self::Class
+  const constructor named({core::List<self::Const> constants = const <self::Const>[/*original=self::Const::impl*/ const self::_ConstImpl::•<dynamic>(), /*original=self::Const::impl*/ const self::_ConstImpl::•<dynamic>(), const self::_ConstImpl::•<core::String>()]}) → self::Class
     : self::Class::constants = constants, super core::Object::•()
     ;
   static synthetic method _#new#tearOff({has-declared-initializer core::List<self::Const> constants}) → self::Class

pkg/front_end/testcases/dart2js/extension_types/external_with_annotations.dart.strong.outline.expect

@@ -74,7 +74,7 @@ extension type B(js_::JSObject /* erasure=_interceptors::JSObject */ a) implemen
   static factory namedParams = self::B|constructor#namedParams;
   static factory tearoff namedParams = self::B|constructor#_#namedParams#tearOff;
 }
-static const field core::pragma annotation = const core::pragma::_("a pragma");
+static const field core::pragma annotation = /*original=core::pragma::•*/ const core::pragma::_("a pragma");
 static extension-type-member synthetic method B|constructor#_#_#tearOff(js_::JSObject /* erasure=_interceptors::JSObject */ a) → self::B /* erasure=_interceptors::JSObject */
   return self::B|constructor#_(a);
 static extension-type-member method B|constructor#_(js_::JSObject /* erasure=_interceptors::JSObject */ a) → self::B /* erasure=_interceptors::JSObject */
@@ -322,5 +322,5 @@ Evaluated: ConstructorInvocation @ org-dartlang-testcase:///external_with_annota
 Evaluated: StaticGet @ org-dartlang-testcase:///external_with_annotations.dart:171:4 -> InstanceConstant(const pragma{pragma.name: "a pragma", pragma.options: null})
 Evaluated: ConstructorInvocation @ org-dartlang-testcase:///external_with_annotations.dart:174:4 -> InstanceConstant(const JS{JS.name: "renamedSS1.SS2.SS3"})
 Evaluated: StaticGet @ org-dartlang-testcase:///external_with_annotations.dart:175:4 -> InstanceConstant(const pragma{pragma.name: "a pragma", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///external_with_annotations.dart:239:20 -> InstanceConstant(const pragma{pragma.name: "a pragma", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///external_with_annotations.dart:239:20 -> InstanceConstant(const pragma{pragma.name: "a pragma", pragma.options: null})
 Extra constant evaluation: evaluated: 115, effectively constant: 85

pkg/front_end/testcases/dart2js/issue53804.dart.strong.outline.expect

@@ -7,7 +7,7 @@ class A extends core::Object {
   field core::double? f2;
   synthetic constructor •() → self::A
     ;
-  @core::pragma::_("vm:never-inline")
+  @/*original=core::pragma::•*/ const core::pragma::_("vm:never-inline")
   method foo() → core::String
     ;
   static synthetic method _#new#tearOff() → self::A
@@ -18,5 +18,5 @@ static method main() → void
 
 
 Extra constant evaluation status:
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///issue53804.dart:9:4 -> InstanceConstant(const pragma{pragma.name: "vm:never-inline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///issue53804.dart:9:4 -> InstanceConstant(const pragma{pragma.name: "vm:never-inline", pragma.options: null})
 Extra constant evaluation: evaluated: 2, effectively constant: 1

pkg/front_end/testcases/dart2js/issue54115.dart.strong.outline.expect

@@ -8,20 +8,20 @@ class C extends core::Object {
     ;
   static synthetic method _#new#tearOff(core::int? _x) → self::C
     return new self::C::•(_x);
-  @core::pragma::_("dart2js:never-inline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:never-inline")
   method manual() → void
     ;
-  @core::pragma::_("dart2js:never-inline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:never-inline")
   method pattern() → void
     ;
-  @core::pragma::_("dart2js:never-inline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:never-inline")
   method promote() → void
     ;
 }
 
 
 Extra constant evaluation status:
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///issue54115.dart:9:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:never-inline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///issue54115.dart:18:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:never-inline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///issue54115.dart:26:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:never-inline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///issue54115.dart:9:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:never-inline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///issue54115.dart:18:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:never-inline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///issue54115.dart:26:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:never-inline", pragma.options: null})
 Extra constant evaluation: evaluated: 5, effectively constant: 3

pkg/front_end/testcases/dart2js/late_fields_with_annotation.dart.strong.outline.expect

@@ -3,15 +3,15 @@ import self as self;
 import "dart:core" as core;
 
 class C extends core::Object {
-  @core::pragma::_("dart2js:late:trust")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:late:trust")
   late field core::int a;
-  @core::pragma::_("dart2js:late:check")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:late:check")
   late final [setter] field core::int b;
-  @core::pragma::_("dart2js:late:trust")
-  @core::pragma::_("dart2js:tryInline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:late:trust")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:tryInline")
   late field core::int c;
-  @core::pragma::_("dart2js:late:check")
-  @core::pragma::_("dart2js:noInline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:late:check")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:noInline")
   late final field core::int d;
   synthetic constructor •() → self::C
     ;
@@ -32,10 +32,10 @@ static method testInitializedFinalInstanceField() → void
 
 
 Extra constant evaluation status:
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:13:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:trust", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:16:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:check", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:19:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:trust", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:20:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:tryInline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:23:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:check", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:24:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:13:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:trust", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:16:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:check", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:19:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:trust", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:20:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:tryInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:23:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:late:check", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///late_fields_with_annotation.dart:24:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
 Extra constant evaluation: evaluated: 7, effectively constant: 6

pkg/front_end/testcases/enhanced_enums/issue49429.dart.strong.outline.expect

@@ -10,7 +10,7 @@ class A extends core::Object /*hasConstConstructor*/  {
     return new self::A::•();
 }
 class E extends core::_Enum /*isEnum*/  {
-  enum-element static const field self::E element = const self::E::•(0, "element", const self::A::•());
+  enum-element static const field self::E element = const self::E::•(0, "element", /*original=self::A::redir*/ const self::A::•());
   static const field core::List<self::E> values = const <self::E>[self::E::element];
   const constructor •(core::int #index, core::String #name, self::A a) → self::E
     : super core::_Enum::•(#index, #name)

pkg/front_end/testcases/extensions/annotations.dart.strong.outline.expect

@@ -5,10 +5,10 @@ import "dart:core" as core;
 class Class extends core::Object {
   synthetic constructor •() → self::Class
     ;
-  @core::pragma::_("dart2js:noInline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:noInline")
   method instanceMethod() → dynamic
     ;
-  @core::pragma::_("dart2js:noInline")
+  @/*original=core::pragma::•*/ const core::pragma::_("dart2js:noInline")
   static method staticMethod() → dynamic
     ;
 }
@@ -17,25 +17,25 @@ extension Extension on self::Class {
   method tearoff extensionInstanceMethod = self::Extension|get#extensionInstanceMethod;
   static method extensionStaticMethod = self::Extension|extensionStaticMethod;
 }
-@core::pragma::_("dart2js:noInline")
+@/*original=core::pragma::•*/ const core::pragma::_("dart2js:noInline")
 static extension-member method Extension|extensionInstanceMethod(lowered final self::Class #this) → dynamic
   ;
 static extension-member method Extension|get#extensionInstanceMethod(lowered final self::Class #this) → () → dynamic
   return () → dynamic => self::Extension|extensionInstanceMethod(#this);
-@core::pragma::_("dart2js:noInline")
+@/*original=core::pragma::•*/ const core::pragma::_("dart2js:noInline")
 static extension-member method Extension|extensionStaticMethod() → dynamic
   ;
-@core::pragma::_("dart2js:noInline")
+@/*original=core::pragma::•*/ const core::pragma::_("dart2js:noInline")
 static method topLevelMethod() → dynamic
   ;
 static method main() → dynamic
   ;
 
 
 Extra constant evaluation status:
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///annotations.dart:6:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///annotations.dart:9:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///annotations.dart:14:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///annotations.dart:17:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
-Evaluated: ConstructorInvocation @ org-dartlang-testcase:///annotations.dart:21:2 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///annotations.dart:6:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///annotations.dart:9:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///annotations.dart:14:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///annotations.dart:17:4 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
+Evaluated: RedirectingFactoryInvocation @ org-dartlang-testcase:///annotations.dart:21:2 -> InstanceConstant(const pragma{pragma.name: "dart2js:noInline", pragma.options: null})
 Extra constant evaluation: evaluated: 8, effectively constant: 5