[cfe] Add UriOffsetLength

This adds a UriOffsetLength that passes uri, offset and length of a source locations. This is used to support
field/getter/setterUriOffset to prepare for getter/setter and final
field/setter pairs to be contained in the same builder object, while
still allowing messaging to point to the specific aspect.

UriOffsetLength is furthermore used on ClassMember which improves the
precision of messages from hierarchy checks.

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

Author: johnniwinther

pkg/front_end/lib/src/base/crash.dart

@@ -146,6 +146,6 @@ Future<T> withCrashReporting<T>(
       rethrow;
     }
     UriOffset? uriOffset = currentUriOffset();
-    return reportCrash(e, s, uriOffset?.uri, uriOffset?.fileOffset);
+    return reportCrash(e, s, uriOffset?.fileUri, uriOffset?.fileOffset);
   }
 }

pkg/front_end/lib/src/base/scope.dart

@@ -371,8 +371,10 @@ NamedBuilder computeAmbiguousDeclarationForImport(
   // We report the error lazily (setting suppressMessage to false) because the
   // spec 18.1 states that 'It is not an error if N is introduced by two or
   // more imports but never referred to.'
-  return new InvalidTypeDeclarationBuilder(name,
-      message.withLocation(uriOffset.uri, uriOffset.fileOffset, name.length),
+  return new InvalidTypeDeclarationBuilder(
+      name,
+      message.withLocation(
+          uriOffset.fileUri, uriOffset.fileOffset, name.length),
       suppressMessage: false);
 }
 

pkg/front_end/lib/src/base/uri_offset.dart

@@ -2,9 +2,62 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-class UriOffset {
-  final Uri uri;
+import 'messages.dart';
+
+/// Source location pointer used for messaging.
+class UriOffset implements UriOffsetLength {
+  /// The file URI of the location.
+  @override
+  final Uri fileUri;
+
+  /// The character offset for the location with [fileUri].
+  @override
   final int fileOffset;
 
-  UriOffset(this.uri, this.fileOffset);
+  UriOffset(this.fileUri, this.fileOffset);
+
+  @override
+  int get length => noLength;
+}
+
+/// Source location pointer used for messaging.
+class UriOffsetLength {
+  /// The file URI of the location.
+  final Uri fileUri;
+
+  /// The character offset for the location with [fileUri].
+  final int fileOffset;
+
+  /// The length of the location.
+  ///
+  /// This is used to emitted the correct number of `^` characters in the
+  /// message output for the source location.
+  final int length;
+
+  UriOffsetLength(this.fileUri, this.fileOffset, this.length);
+}
+
+extension ProblemReportingExtension on ProblemReporting {
+  /// Helper method for calling [ProblemReporting.addProblem] with a
+  /// [UriOffsetLength].
+  void addProblem2(Message message, UriOffsetLength uriOffset,
+      {bool wasHandled = false,
+      List<LocatedMessage>? context,
+      Severity? severity,
+      bool problemOnLibrary = false}) {
+    addProblem(
+        message, uriOffset.fileOffset, uriOffset.length, uriOffset.fileUri,
+        wasHandled: wasHandled,
+        context: context,
+        severity: severity,
+        problemOnLibrary: problemOnLibrary);
+  }
+}
+
+extension MessageExtension on Message {
+  /// Helper method for calling [Message.withLocation] with a [UriOffsetLength].
+  LocatedMessage withLocation2(UriOffsetLength uriOffset) {
+    return withLocation(
+        uriOffset.fileUri, uriOffset.fileOffset, uriOffset.length);
+  }
 }

pkg/front_end/lib/src/builder/declaration_builder.dart

@@ -24,9 +24,6 @@ abstract class IDeclarationBuilder implements ITypeDeclarationBuilder {
   MemberBuilder? findConstructorOrFactory(
       String name, int charOffset, Uri uri, LibraryBuilder accessingLibrary);
 
-  void addProblem(Message message, int charOffset, int length,
-      {bool wasHandled = false, List<LocatedMessage>? context});
-
   /// Returns the type of `this` in an instance of this declaration.
   ///
   /// This is non-null for class and mixin declarations and `null` for
@@ -92,11 +89,4 @@ abstract class DeclarationBuilderImpl extends TypeDeclarationBuilderImpl
 
     return declaration;
   }
-
-  @override
-  void addProblem(Message message, int charOffset, int length,
-      {bool wasHandled = false, List<LocatedMessage>? context}) {
-    libraryBuilder.addProblem(message, charOffset, length, fileUri,
-        wasHandled: wasHandled, context: context);
-  }
 }

pkg/front_end/lib/src/builder/member_builder.dart

@@ -167,16 +167,10 @@ abstract class MemberBuilderImpl extends NamedBuilderImpl
 abstract class BuilderClassMember implements ClassMember {
   MemberBuilderImpl get memberBuilder;
 
-  @override
-  int get charOffset => memberBuilder.fileOffset;
-
   @override
   DeclarationBuilder get declarationBuilder =>
       memberBuilder.declarationBuilder!;
 
-  @override
-  Uri get fileUri => memberBuilder.fileUri;
-
   @override
   // Coverage-ignore(suite): Not run.
   bool get isExtensionTypeMember => memberBuilder.isExtensionTypeMember;

pkg/front_end/lib/src/builder/property_builder.dart

@@ -2,6 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import '../base/uri_offset.dart';
 import 'builder.dart';
 import 'member_builder.dart';
 
@@ -23,6 +24,14 @@ abstract class PropertyBuilder implements MemberBuilder {
   /// Returns a [SetterQuality] enum value that describes what kind of setter
   /// this property has, if any.
   SetterQuality get setterQuality;
+
+  /// Returns the [UriOffsetLength]  for the introductory declaration of the
+  /// getter aspect, if any.
+  UriOffsetLength? get getterUriOffset;
+
+  /// Returns the [UriOffsetLength] for the introductory declaration of the
+  /// setter aspect, if any.
+  UriOffsetLength? get setterUriOffset;
 }
 
 /// Enum for the different ways a property can have a field aspect.

pkg/front_end/lib/src/dill/dill_builder_mixins.dart

@@ -5,6 +5,7 @@
 import 'package:kernel/ast.dart';
 import 'package:kernel/class_hierarchy.dart';
 
+import '../base/uri_offset.dart';
 import '../builder/builder.dart';
 import '../builder/constructor_builder.dart';
 import '../builder/declaration_builders.dart';
@@ -97,16 +98,16 @@ mixin DillFieldBuilderMixin implements DillMemberBuilder, PropertyBuilder {
   List<ClassMember>? _localSetters;
 
   @override
-  List<ClassMember> get localMembers =>
-      _localMembers ??= !member.isInternalImplementation
-          ? [new DillClassMember(this, ClassMemberKind.Getter)]
-          : const [];
+  List<ClassMember> get localMembers => _localMembers ??= !member
+          .isInternalImplementation
+      ? [new DillClassMember(this, ClassMemberKind.Getter, getterUriOffset!)]
+      : const [];
 
   @override
-  List<ClassMember> get localSetters =>
-      _localSetters ??= hasSetter && !member.isInternalImplementation
-          ? [new DillClassMember(this, ClassMemberKind.Setter)]
-          : const [];
+  List<ClassMember> get localSetters => _localSetters ??= hasSetter &&
+          !member.isInternalImplementation
+      ? [new DillClassMember(this, ClassMemberKind.Setter, setterUriOffset!)]
+      : const [];
 }
 
 mixin DillGetterBuilderMixin implements DillMemberBuilder, PropertyBuilder {
@@ -135,13 +136,17 @@ mixin DillGetterBuilderMixin implements DillMemberBuilder, PropertyBuilder {
   @override
   NamedBuilder? get setable => null;
 
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength? get setterUriOffset => null;
+
   List<ClassMember>? _localMembers;
 
   @override
-  List<ClassMember> get localMembers =>
-      _localMembers ??= !member.isInternalImplementation
-          ? [new DillClassMember(this, ClassMemberKind.Getter)]
-          : const [];
+  List<ClassMember> get localMembers => _localMembers ??= !member
+          .isInternalImplementation
+      ? [new DillClassMember(this, ClassMemberKind.Getter, getterUriOffset!)]
+      : const [];
 
   @override
   List<ClassMember> get localSetters => const [];
@@ -177,16 +182,20 @@ mixin DillSetterBuilderMixin implements DillMemberBuilder, PropertyBuilder {
   @override
   NamedBuilder get setable => this;
 
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength? get getterUriOffset => null;
+
   List<ClassMember>? _localSetters;
 
   @override
   List<ClassMember> get localMembers => const [];
 
   @override
-  List<ClassMember> get localSetters =>
-      _localSetters ??= !member.isInternalImplementation
-          ? [new DillClassMember(this, ClassMemberKind.Setter)]
-          : const [];
+  List<ClassMember> get localSetters => _localSetters ??= !member
+          .isInternalImplementation
+      ? [new DillClassMember(this, ClassMemberKind.Setter, setterUriOffset!)]
+      : const [];
 }
 
 mixin DillMethodBuilderMixin implements DillMemberBuilder, MethodBuilder {
@@ -212,10 +221,12 @@ mixin DillMethodBuilderMixin implements DillMemberBuilder, MethodBuilder {
 
   List<ClassMember>? _localMembers;
 
+  UriOffsetLength get uriOffset;
+
   @override
   List<ClassMember> get localMembers =>
       _localMembers ??= !member.isInternalImplementation
-          ? [new DillClassMember(this, ClassMemberKind.Method)]
+          ? [new DillClassMember(this, ClassMemberKind.Method, uriOffset)]
           : const [];
 
   @override
@@ -252,10 +263,12 @@ mixin DillOperatorBuilderMixin implements DillMemberBuilder, MethodBuilder {
 
   List<ClassMember>? _localMembers;
 
+  UriOffsetLength get uriOffset;
+
   @override
   List<ClassMember> get localMembers =>
       _localMembers ??= !member.isInternalImplementation
-          ? [new DillClassMember(this, ClassMemberKind.Method)]
+          ? [new DillClassMember(this, ClassMemberKind.Method, uriOffset)]
           : const [];
 
   @override

pkg/front_end/lib/src/dill/dill_extension_member_builder.dart

@@ -3,7 +3,9 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:kernel/ast.dart';
+import 'package:kernel/names.dart';
 
+import '../base/uri_offset.dart';
 import '../builder/method_builder.dart';
 import '../builder/property_builder.dart';
 import 'dill_builder_mixins.dart';
@@ -74,6 +76,17 @@ class DillExtensionFieldBuilder extends DillExtensionMemberBuilder
   // Coverage-ignore(suite): Not run.
   GetterQuality get getterQuality => GetterQuality.Implicit;
 
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength get getterUriOffset =>
+      new UriOffsetLength(fileUri, fileOffset, _descriptor.name.text.length);
+
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength? get setterUriOffset => hasSetter
+      ? new UriOffsetLength(fileUri, fileOffset, _descriptor.name.text.length)
+      : null;
+
   @override
   // Coverage-ignore(suite): Not run.
   bool get hasConstField => _field.isConst;
@@ -117,6 +130,11 @@ class DillExtensionSetterBuilder extends DillExtensionMemberBuilder
   @override
   SetterQuality get setterQuality =>
       procedure.isExternal ? SetterQuality.External : SetterQuality.Concrete;
+
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength get setterUriOffset =>
+      new UriOffsetLength(fileUri, fileOffset, _descriptor.name.text.length);
 }
 
 class DillExtensionGetterBuilder extends DillExtensionMemberBuilder
@@ -160,6 +178,11 @@ class DillExtensionGetterBuilder extends DillExtensionMemberBuilder
 
   @override
   SetterQuality get setterQuality => SetterQuality.Absent;
+
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength get getterUriOffset =>
+      new UriOffsetLength(fileUri, fileOffset, _descriptor.name.text.length);
 }
 
 class DillExtensionOperatorBuilder extends DillExtensionMemberBuilder
@@ -189,6 +212,11 @@ class DillExtensionOperatorBuilder extends DillExtensionMemberBuilder
   @override
   // Coverage-ignore(suite): Not run.
   Iterable<Reference> get exportedMemberReferences => [_procedure.reference];
+
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength get uriOffset => new UriOffsetLength(fileUri, fileOffset,
+      _descriptor.name == unaryMinusName ? 1 : _descriptor.name.text.length);
 }
 
 class DillExtensionStaticMethodBuilder extends DillExtensionMemberBuilder
@@ -226,6 +254,11 @@ class DillExtensionStaticMethodBuilder extends DillExtensionMemberBuilder
   @override
   // Coverage-ignore(suite): Not run.
   Iterable<Reference> get exportedMemberReferences => [_procedure.reference];
+
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength get uriOffset =>
+      new UriOffsetLength(fileUri, fileOffset, _descriptor.name.text.length);
 }
 
 class DillExtensionInstanceMethodBuilder extends DillExtensionMemberBuilder
@@ -266,4 +299,9 @@ class DillExtensionInstanceMethodBuilder extends DillExtensionMemberBuilder
   @override
   // Coverage-ignore(suite): Not run.
   Reference get invokeTargetReference => _procedure.reference;
+
+  @override
+  // Coverage-ignore(suite): Not run.
+  UriOffsetLength get uriOffset =>
+      new UriOffsetLength(fileUri, fileOffset, _descriptor.name.text.length);
 }