[cfe] Add FileUriConstantExpression

This adds FileUriConstantExpression, a subclass of ConstantExpression, to support correct file offset of annotations for augmentations and patches.
The FileUriExpression is used to carry the file uri of the expression
before constant evaluation.

TEST=general/patch_annotations

Change-Id: I0dc8a0cb97dd530fd1960785d38c2d5e4883c3dd
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/311660
Commit-Queue: Johnni Winther <[email protected]>
Reviewed-by: Jens Johansen <[email protected]>
Reviewed-by: Alexander Markov <[email protected]>

Author: johnniwinther

pkg/front_end/lib/src/fasta/builder/metadata_builder.dart

@@ -25,15 +25,22 @@ class MetadataBuilder {
       BodyBuilderContext bodyBuilderContext,
       SourceLibraryBuilder library,
       Uri fileUri,
-      Scope scope) {
+      Scope scope,
+      {bool createFileUriExpression = false}) {
     if (metadata == null) return;
     BodyBuilder bodyBuilder = library.loader
         .createBodyBuilderForOutlineExpression(
             library, bodyBuilderContext, scope, fileUri);
     for (int i = 0; i < metadata.length; ++i) {
       MetadataBuilder annotationBuilder = metadata[i];
-      parent.addAnnotation(
-          bodyBuilder.parseAnnotation(annotationBuilder.beginToken));
+      Expression annotation =
+          bodyBuilder.parseAnnotation(annotationBuilder.beginToken);
+      if (createFileUriExpression) {
+        parent.addAnnotation(new FileUriExpression(annotation, fileUri)
+          ..fileOffset = annotationBuilder.beginToken.charOffset);
+      } else {
+        parent.addAnnotation(annotation);
+      }
     }
     bodyBuilder.inferAnnotations(parent, parent.annotations);
     bodyBuilder.performBacklogComputations(allowFurtherDelays: false);

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

@@ -2225,9 +2225,15 @@ class ConstantsTransformer extends RemovingTransformer {
         constant.expression is InvalidExpression) {
       return constant.expression;
     }
-    return new ConstantExpression(
-        constant, node.getStaticType(staticTypeContext))
-      ..fileOffset = node.fileOffset;
+    ConstantExpression constantExpression =
+        new ConstantExpression(constant, node.getStaticType(staticTypeContext))
+          ..fileOffset = node.fileOffset;
+    if (node is FileUriExpression) {
+      return new FileUriConstantExpression(constantExpression.constant,
+          type: constantExpression.type, fileUri: node.fileUri)
+        ..fileOffset = node.fileOffset;
+    }
+    return constantExpression;
   }
 
   bool shouldInline(Expression initializer) {

pkg/front_end/lib/src/fasta/kernel/kernel_helper.dart

@@ -301,37 +301,51 @@ class TypeDependency {
   }
 }
 
+/// Removes [FileUriExpression] nodes for annotations whose file URI is
+/// [annotatableFileUri], the file URI of the [annotatable].
+///
+/// This is an optimization to avoid unnecessary [FileUriConstantExpression]
+/// nodes in the generated AST.
+void adjustAnnotationFileUri(Annotatable annotatable, Uri annotatableFileUri) {
+  List<Expression> annotations = annotatable.annotations;
+  for (int i = 0; i < annotations.length; i++) {
+    Expression annotation = annotations[i];
+    if (annotation is FileUriExpression &&
+        annotation.fileUri == annotatableFileUri) {
+      annotations[i] = annotation.expression..parent = annotatable;
+    }
+  }
+}
+
 /// Copies properties, function parameters and body from the [patch] constructor
 /// to its [origin].
 void finishConstructorPatch(Constructor origin, Constructor patch) {
-  // TODO(ahe): restore file-offset once we track both origin and patch file
-  // URIs. See https://github.com/dart-lang/sdk/issues/31579
   origin.fileUri = patch.fileUri;
   origin.startFileOffset = patch.startFileOffset;
   origin.fileOffset = patch.fileOffset;
   origin.fileEndOffset = patch.fileEndOffset;
-  origin.annotations.forEach((m) => m.fileOffset = patch.fileOffset);
 
   origin.isExternal = patch.isExternal;
   origin.function = patch.function;
   origin.function.parent = origin;
   origin.initializers = patch.initializers;
   setParents(origin.initializers, origin);
+
+  adjustAnnotationFileUri(origin, origin.fileUri);
 }
 
 /// Copies properties, function parameters and body from the [patch] procedure
 /// to its [origin].
 void finishProcedurePatch(Procedure origin, Procedure patch) {
-  // TODO(ahe): restore file-offset once we track both origin and patch file
-  // URIs. See https://github.com/dart-lang/sdk/issues/31579
   origin.fileUri = patch.fileUri;
   origin.fileStartOffset = patch.fileStartOffset;
   origin.fileOffset = patch.fileOffset;
   origin.fileEndOffset = patch.fileEndOffset;
-  origin.annotations.forEach((m) => m.fileOffset = patch.fileOffset);
 
   origin.isAbstract = patch.isAbstract;
   origin.isExternal = patch.isExternal;
   origin.function = patch.function;
   origin.function.parent = origin;
+
+  adjustAnnotationFileUri(origin, origin.fileUri);
 }

pkg/front_end/lib/src/fasta/source/source_class_builder.dart

@@ -372,7 +372,8 @@ class SourceClassBuilder extends ClassBuilderImpl
     }
 
     MetadataBuilder.buildAnnotations(isPatch ? origin.cls : cls, metadata,
-        bodyBuilderContext, libraryBuilder, fileUri, libraryBuilder.scope);
+        bodyBuilderContext, libraryBuilder, fileUri, libraryBuilder.scope,
+        createFileUriExpression: isPatch);
     if (typeVariables != null) {
       for (int i = 0; i < typeVariables!.length; i++) {
         typeVariables![i].buildOutlineExpressions(
@@ -1116,11 +1117,7 @@ class SourceClassBuilder extends ClassBuilderImpl
   }
 
   int buildBodyNodes() {
-    // TODO(ahe): restore file-offset once we track both origin and patch file
-    // URIs. See https://github.com/dart-lang/sdk/issues/31579
-    if (isPatch) {
-      cls.annotations.forEach((m) => m.fileOffset = origin.cls.fileOffset);
-    }
+    adjustAnnotationFileUri(cls, cls.fileUri);
 
     int count = 0;
 

pkg/front_end/lib/src/fasta/source/source_constructor_builder.dart

@@ -932,6 +932,15 @@ class DeclaredSourceConstructorBuilder
   // TODO(johnniwinther): Add annotations to tear-offs.
   @override
   Iterable<Annotatable> get annotatables => [constructor];
+
+  @override
+  bool get isAugmented {
+    if (isPatch) {
+      return origin._patches!.last != this;
+    } else {
+      return _patches != null;
+    }
+  }
 }
 
 class SyntheticSourceConstructorBuilder extends DillConstructorBuilder
@@ -1293,6 +1302,9 @@ class SourceInlineClassConstructorBuilder
   // TODO(johnniwinther): Add annotations to tear-offs.
   @override
   Iterable<Annotatable> get annotatables => [_constructor];
+
+  @override
+  bool get isAugmented => false;
 }
 
 class InlineClassInitializerToStatementConverter

pkg/front_end/lib/src/fasta/source/source_factory_builder.dart

@@ -321,6 +321,15 @@ class SourceFactoryBuilder extends SourceFunctionBuilderImpl {
   // TODO(johnniwinther): Add annotations to tear-offs.
   @override
   Iterable<Annotatable> get annotatables => [_procedure];
+
+  @override
+  bool get isAugmented {
+    if (isPatch) {
+      return origin._patches!.last != this;
+    } else {
+      return _patches != null;
+    }
+  }
 }
 
 class RedirectingFactoryBuilder extends SourceFactoryBuilder {

pkg/front_end/lib/src/fasta/source/source_function_builder.dart

@@ -206,6 +206,10 @@ abstract class SourceFunctionBuilderImpl extends SourceMemberBuilderImpl
   @override
   bool get isAssignable => false;
 
+  /// Returns `true` if this member is augmented, either by being the origin
+  /// of a augmented member or by not being the last among augmentations.
+  bool get isAugmented;
+
   @override
   Scope computeFormalParameterScope(Scope parent) {
     if (formals == null) return parent;
@@ -479,7 +483,8 @@ abstract class SourceFunctionBuilderImpl extends SourceMemberBuilderImpl
           classOrExtensionBuilder?.scope ?? libraryBuilder.scope;
       for (Annotatable annotatable in annotatables) {
         MetadataBuilder.buildAnnotations(annotatable, metadata,
-            bodyBuilderContext, libraryBuilder, fileUri, parentScope);
+            bodyBuilderContext, libraryBuilder, fileUri, parentScope,
+            createFileUriExpression: isAugmented);
       }
       if (typeVariables != null) {
         for (int i = 0; i < typeVariables!.length; i++) {

pkg/front_end/lib/src/fasta/source/source_library_builder.dart

@@ -3343,7 +3343,8 @@ class SourceLibraryBuilder extends LibraryBuilderImpl {
     }
 
     MetadataBuilder.buildAnnotations(
-        library, metadata, bodyBuilderContext, this, fileUri, scope);
+        library, metadata, bodyBuilderContext, this, fileUri, scope,
+        createFileUriExpression: isPatch);
 
     Iterator<Builder> iterator = localMembersIterator;
     while (iterator.moveNext()) {

pkg/front_end/lib/src/fasta/source/source_loader.dart

@@ -933,6 +933,8 @@ severity: $severity
         // and the VM does not support that. Also, what would, for instance,
         // setting a breakpoint on line 42 of some import uri mean, if the uri
         // represented several files?
+        // TODO(johnniwinther): Replace this with something that supports
+        // augmentation libraries.
         List<String> newPathSegments =
             new List<String>.of(importUri.pathSegments);
         newPathSegments.add(libraryBuilder.fileUri.pathSegments.last);

pkg/front_end/lib/src/fasta/source/source_procedure_builder.dart

@@ -640,6 +640,15 @@ class SourceProcedureBuilder extends SourceFunctionBuilderImpl
   // TODO(johnniwinther): Add annotations to tear-offs.
   @override
   Iterable<Annotatable> get annotatables => [procedure];
+
+  @override
+  bool get isAugmented {
+    if (isPatch) {
+      return origin._patches!.last != this;
+    } else {
+      return _patches != null;
+    }
+  }
 }
 
 class SourceProcedureMember extends BuilderClassMember {

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

@@ -526,7 +526,10 @@ class InferenceVisitorImpl extends InferenceVisitorBase
   @override
   ExpressionInferenceResult visitFileUriExpression(
       FileUriExpression node, DartType typeContext) {
-    return _unhandledExpression(node, typeContext);
+    ExpressionInferenceResult result =
+        inferExpression(node.expression, typeContext);
+    node.expression = result.expression..parent = node;
+    return new ExpressionInferenceResult(result.inferredType, node);
   }
 
   @override

pkg/front_end/test/utils/kernel_chain.dart

@@ -518,6 +518,7 @@ class ComponentResult {
   }
 
   bool isUserLibraryImportUri(Uri? importUri) {
+    // TODO(johnniwinther): Support patch libraries user libraries.
     return userLibraries.contains(importUri);
   }
 

pkg/front_end/testcases/dart2js/tear_off_patch/main.dart.strong.expect

@@ -29,7 +29,7 @@ import "dart:_internal";
 
 typedef Alias<T extends core::num> = test::Class<T>;
 typedef AliasImpl<T extends core::num> = test::ClassImpl<T>;
-@#C13
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C13
 class Class<T extends core::Object? = dynamic> extends core::Object {
   @#C13
   constructor •({core::bool defaultValue = #C14, required test::Class::T% value = #C15}) → test::Class<test::Class::T%>
@@ -54,7 +54,7 @@ class Class<T extends core::Object? = dynamic> extends core::Object {
   static method /* from org-dartlang-testcase:///patch_lib.dart */ _#redirect2#tearOff<T extends core::Object? = dynamic>({core::bool defaultValue = #C14, required test::Class::_#redirect2#tearOff::T% value = #C15}) → test::Class<test::Class::_#redirect2#tearOff::T%>
     return new test::ClassImpl::patched<test::Class::_#redirect2#tearOff::T%>(defaultValue: defaultValue, value: value);
 }
-@#C13
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C13
 class ClassImpl<T extends core::Object? = dynamic> extends core::Object implements test::Class<test::ClassImpl::T%> {
   constructor •({core::bool defaultValue = #C14, required test::ClassImpl::T% value = #C15}) → test::ClassImpl<test::ClassImpl::T%>
     : super core::Object::•()

pkg/front_end/testcases/dart2js/tear_off_patch/main.dart.weak.expect

@@ -29,7 +29,7 @@ import "dart:_internal";
 
 typedef Alias<T extends core::num> = test::Class<T>;
 typedef AliasImpl<T extends core::num> = test::ClassImpl<T>;
-@#C13
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C13
 class Class<T extends core::Object? = dynamic> extends core::Object {
   @#C13
   constructor •({core::bool defaultValue = #C14, required test::Class::T% value = #C15}) → test::Class<test::Class::T%>
@@ -54,7 +54,7 @@ class Class<T extends core::Object? = dynamic> extends core::Object {
   static method /* from org-dartlang-testcase:///patch_lib.dart */ _#redirect2#tearOff<T extends core::Object? = dynamic>({core::bool defaultValue = #C14, required test::Class::_#redirect2#tearOff::T% value = #C15}) → test::Class<test::Class::_#redirect2#tearOff::T%>
     return new test::ClassImpl::patched<test::Class::_#redirect2#tearOff::T%>(defaultValue: defaultValue, value: value);
 }
-@#C13
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C13
 class ClassImpl<T extends core::Object? = dynamic> extends core::Object implements test::Class<test::ClassImpl::T%> {
   constructor •({core::bool defaultValue = #C14, required test::ClassImpl::T% value = #C15}) → test::ClassImpl<test::ClassImpl::T%>
     : super core::Object::•()

pkg/front_end/testcases/dart2js/tear_off_patch/main.dart.weak.modular.expect

@@ -29,7 +29,7 @@ import "dart:_internal";
 
 typedef Alias<T extends core::num> = test::Class<T>;
 typedef AliasImpl<T extends core::num> = test::ClassImpl<T>;
-@#C13
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C13
 class Class<T extends core::Object? = dynamic> extends core::Object {
   @#C13
   constructor •({core::bool defaultValue = #C14, required test::Class::T% value = #C15}) → test::Class<test::Class::T%>
@@ -54,7 +54,7 @@ class Class<T extends core::Object? = dynamic> extends core::Object {
   static method /* from org-dartlang-testcase:///patch_lib.dart */ _#redirect2#tearOff<T extends core::Object? = dynamic>({core::bool defaultValue = #C14, required test::Class::_#redirect2#tearOff::T% value = #C15}) → test::Class<test::Class::_#redirect2#tearOff::T%>
     return new test::ClassImpl::patched<test::Class::_#redirect2#tearOff::T%>(defaultValue: defaultValue, value: value);
 }
-@#C13
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C13
 class ClassImpl<T extends core::Object? = dynamic> extends core::Object implements test::Class<test::ClassImpl::T%> {
   constructor •({core::bool defaultValue = #C14, required test::ClassImpl::T% value = #C15}) → test::ClassImpl<test::ClassImpl::T%>
     : super core::Object::•()

pkg/front_end/testcases/dart2js/tear_off_patch/main.dart.weak.outline.expect

@@ -62,11 +62,11 @@ static method _#AliasImpl#patched#tearOff<T extends core::num>({has-declared-ini
 
 
 Extra constant evaluation status:
-Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:6:46 -> InstanceConstant(const _Patch{})
+Evaluated: FileUriExpression @ org-dartlang-testcase:///patch_lib.dart:8:1 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:7:8 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:8:27 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:12:21 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:15:10 -> InstanceConstant(const _Patch{})
-Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:18:36 -> InstanceConstant(const _Patch{})
+Evaluated: FileUriExpression @ org-dartlang-testcase:///patch_lib.dart:27:1 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:19:45 -> InstanceConstant(const _Patch{})
 Extra constant evaluation: evaluated: 49, effectively constant: 7

pkg/front_end/testcases/dartdevc/factory_patch/main.dart.strong.expect

@@ -15,7 +15,7 @@ import "dart:core" as core;
 
 import "dart:_internal";
 
-@#C1
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C1
 class Class extends core::Object {
   final field core::bool defaultValue /* from org-dartlang-testcase:///patch_lib.dart */;
   const constructor _internal({core::bool defaultValue = #C2}) → test::Class

pkg/front_end/testcases/dartdevc/factory_patch/main.dart.weak.expect

@@ -15,7 +15,7 @@ import "dart:core" as core;
 
 import "dart:_internal";
 
-@#C1
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C1
 class Class extends core::Object {
   final field core::bool defaultValue /* from org-dartlang-testcase:///patch_lib.dart */;
   const constructor _internal({core::bool defaultValue = #C2}) → test::Class

pkg/front_end/testcases/dartdevc/factory_patch/main.dart.weak.modular.expect

@@ -15,7 +15,7 @@ import "dart:core" as core;
 
 import "dart:_internal";
 
-@#C1
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C1
 class Class extends core::Object {
   final field core::bool defaultValue /* from org-dartlang-testcase:///patch_lib.dart */;
   const constructor _internal({core::bool defaultValue = #C2}) → test::Class

pkg/front_end/testcases/dartdevc/factory_patch/main.dart.weak.outline.expect

@@ -33,7 +33,7 @@ class Class extends core::Object {
 
 
 Extra constant evaluation status:
-Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:6:49 -> InstanceConstant(const _Patch{})
+Evaluated: FileUriExpression @ org-dartlang-testcase:///patch_lib.dart:8:1 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ org-dartlang-testcase:///origin_lib.dart:8:26 -> InstanceConstant(const _Patch{})
 Evaluated: StaticGet @ (unknown position in org-dartlang-testcase:///origin_lib.dart) -> InstanceConstant(const _Patch{})
 Extra constant evaluation: evaluated: 10, effectively constant: 3

pkg/front_end/testcases/general/constructor_patch/main.dart.strong.expect

@@ -35,7 +35,7 @@ import "dart:core" as core;
 
 import "dart:_internal";
 
-@#C3
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C3
 class Class extends core::Object /*hasConstConstructor*/  {
   final field core::bool defaultValue /* from org-dartlang-testcase:///patch_lib.dart */;
   constructor _privateInjected() → test::Class
@@ -60,7 +60,7 @@ class Class extends core::Object /*hasConstConstructor*/  {
     : test::Class::defaultValue = true, super core::Object::•()
     ;
 }
-@#C3
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C3
 class Class2 extends core::Object {
   final field core::int injectedField /* from org-dartlang-testcase:///patch_lib.dart */;
   field core::int field;

pkg/front_end/testcases/general/constructor_patch/main.dart.weak.expect

@@ -35,7 +35,7 @@ import "dart:core" as core;
 
 import "dart:_internal";
 
-@#C3
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C3
 class Class extends core::Object /*hasConstConstructor*/  {
   final field core::bool defaultValue /* from org-dartlang-testcase:///patch_lib.dart */;
   constructor _privateInjected() → test::Class
@@ -60,7 +60,7 @@ class Class extends core::Object /*hasConstConstructor*/  {
     : test::Class::defaultValue = true, super core::Object::•()
     ;
 }
-@#C3
+@/* from org-dartlang-testcase:///patch_lib.dart */ #C3
 class Class2 extends core::Object {
   final field core::int injectedField /* from org-dartlang-testcase:///patch_lib.dart */;
   field core::int field;