[cfe] Rename InvalidTypeDeclarationBuilder

This renames InvalidTypeDeclarationBuilder to InvalidBuilder to better
reflects its actual general purpose use. Also, suppressMessage fields
and parameters are renamed to errorHasBeenReported to better show the
motivation for the value.

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

Author: johnniwinther

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

@@ -339,8 +339,8 @@ NamedBuilder computeAmbiguousDeclarationForImport(
 
   // TODO(ahe): Can I move this to Scope or Prefix?
   if (declaration == other) return declaration;
-  if (declaration is InvalidTypeDeclarationBuilder) return declaration;
-  if (other is InvalidTypeDeclarationBuilder) return other;
+  if (declaration is InvalidBuilder) return declaration;
+  if (other is InvalidBuilder) return other;
   NamedBuilder? preferred;
   Uri uri = computeLibraryUri(declaration);
   Uri otherUri = computeLibraryUri(other);
@@ -369,14 +369,14 @@ NamedBuilder computeAmbiguousDeclarationForImport(
       // instead of including URIs in this message.
       firstUri,
       secondUri);
-  // 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
+  // We report the error lazily (setting errorHasBeenReported 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(
+  return new InvalidBuilder(
       name,
       message.withLocation(
           uriOffset.fileUri, uriOffset.fileOffset, name.length),
-      suppressMessage: false);
+      errorHasBeenReported: false);
 }
 
 // Coverage-ignore(suite): Not run.

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

@@ -33,7 +33,7 @@ part 'class_builder.dart';
 part 'declaration_builder.dart';
 part 'extension_builder.dart';
 part 'extension_type_declaration_builder.dart';
-part 'invalid_type_declaration_builder.dart';
+part 'invalid_builder.dart';
 part 'type_alias_builder.dart';
 part 'type_declaration_builder.dart';
 part 'type_parameter_builder.dart';

pkg/front_end/lib/src/builder/invalid_type_declaration_builder.dart renamed to pkg/front_end/lib/src/builder/invalid_builder.dart

@@ -4,8 +4,14 @@
 
 part of 'declaration_builders.dart';
 
-// TODO(johnniwinther): Make this a [ProblemBuilder].
-class InvalidTypeDeclarationBuilder extends TypeDeclarationBuilderImpl
+/// [InvalidBuilder] encapsulates an erroneous state as [Builder].
+///
+/// If [errorHasBeenReported] is `true`, the message has already been reported.
+/// Otherwise the [message] must be reported upon use.
+///
+/// This builder implements both [TypeDeclarationBuilder] and [MemberBuilder]
+/// so that it can be used both in types and in member lookups.
+class InvalidBuilder extends TypeDeclarationBuilderImpl
     with ErroneousMemberBuilderMixin
     implements TypeDeclarationBuilder {
   @override
@@ -15,10 +21,10 @@ class InvalidTypeDeclarationBuilder extends TypeDeclarationBuilderImpl
 
   final List<LocatedMessage>? context;
 
-  final bool suppressMessage;
+  final bool errorHasBeenReported;
 
-  InvalidTypeDeclarationBuilder(this.name, this.message,
-      {this.context, this.suppressMessage = true});
+  InvalidBuilder(this.name, this.message,
+      {this.context, this.errorHasBeenReported = true});
 
   @override
   int get typeParametersCount => 0;
@@ -59,7 +65,7 @@ class InvalidTypeDeclarationBuilder extends TypeDeclarationBuilderImpl
       Uri fileUri,
       int charOffset,
       {required bool hasExplicitTypeArguments}) {
-    if (!suppressMessage) {
+    if (!errorHasBeenReported) {
       library.addProblem(message.messageObject, message.charOffset,
           message.length, message.uri,
           context: context);

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

@@ -296,7 +296,7 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
   }
 
   void _check(ProblemReporting problemReporting) {
-    if (_declaration is InvalidTypeDeclarationBuilder) {
+    if (_declaration is InvalidBuilder) {
       return;
     }
     if (typeArguments != null) {
@@ -393,11 +393,9 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
   }
 
   @override
-  InvalidTypeDeclarationBuilder buildInvalidTypeDeclarationBuilder(
-      LocatedMessage message,
+  InvalidBuilder buildInvalidTypeDeclarationBuilder(LocatedMessage message,
       {List<LocatedMessage>? context}) {
-    return new InvalidTypeDeclarationBuilder(typeName.fullName, message,
-        context: context);
+    return new InvalidBuilder(typeName.fullName, message, context: context);
   }
 
   Supertype? _handleInvalidSupertype(LibraryBuilder library) {
@@ -649,8 +647,8 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
               <DartType>[type.typeArgument]);
         }
         return _handleInvalidAliasedSupertype(library, aliasBuilder, type);
-      case InvalidTypeDeclarationBuilder():
-        if (!declaration.suppressMessage) {
+      case InvalidBuilder():
+        if (!declaration.errorHasBeenReported) {
           // Coverage-ignore-block(suite): Not run.
           library.addProblem(
               declaration.message.messageObject,
@@ -686,8 +684,8 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
         }
         return _handleInvalidAliasedSupertype(
             libraryBuilder, aliasBuilder, type);
-      case InvalidTypeDeclarationBuilder():
-        if (!declaration.suppressMessage) {
+      case InvalidBuilder():
+        if (!declaration.errorHasBeenReported) {
           // Coverage-ignore-block(suite): Not run.
           libraryBuilder.addProblem(
               declaration.message.messageObject,
@@ -840,7 +838,7 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
         }
       case StructuralParameterBuilder():
       case ExtensionBuilder():
-      case InvalidTypeDeclarationBuilder():
+      case InvalidBuilder():
       case BuiltinTypeDeclarationBuilder():
     }
     return VarianceCalculationValue.calculatedUnrelated;
@@ -949,7 +947,7 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
         // Handled above.
         throw new UnsupportedError("Unexpected StructuralVariableBuilder");
       // Coverage-ignore(suite): Not run.
-      case InvalidTypeDeclarationBuilder():
+      case InvalidBuilder():
         // Don't substitute.
         break;
       // Coverage-ignore(suite): Not run.
@@ -1093,7 +1091,7 @@ abstract class NamedTypeBuilderImpl extends NamedTypeBuilder {
         case NominalParameterBuilder():
         case StructuralParameterBuilder():
         case ExtensionBuilder():
-        case InvalidTypeDeclarationBuilder():
+        case InvalidBuilder():
         case BuiltinTypeDeclarationBuilder():
       }
     } else {
@@ -1165,8 +1163,7 @@ class _ExplicitNamedTypeBuilder extends NamedTypeBuilderImpl {
         super._(
             typeName: new PredefinedTypeName(name),
             nullabilityBuilder: nullabilityBuilder,
-            declaration: new InvalidTypeDeclarationBuilder(name, message,
-                context: context),
+            declaration: new InvalidBuilder(name, message, context: context),
             fileUri: message.uri,
             charOffset: message.charOffset,
             instanceTypeParameterAccess:

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

@@ -199,7 +199,7 @@ abstract class TypeAliasBuilderImpl extends TypeDeclarationBuilderImpl
       case NominalParameterBuilder():
       case StructuralParameterBuilder():
       case BuiltinTypeDeclarationBuilder():
-      case InvalidTypeDeclarationBuilder():
+      case InvalidBuilder():
       case null:
         _unaliasedRhsType = type;
       case TypeAliasBuilder():
@@ -275,7 +275,7 @@ abstract class TypeAliasBuilderImpl extends TypeDeclarationBuilderImpl
         }
       case ExtensionBuilder():
       case BuiltinTypeDeclarationBuilder():
-      case InvalidTypeDeclarationBuilder():
+      case InvalidBuilder():
         // These types won't change after substitution, so we just return them.
         return unaliasedRhsType;
       case null:

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

@@ -533,8 +533,7 @@ abstract class NamedTypeBuilder extends TypeBuilder {
 
   NamedTypeBuilder withTypeArguments(List<TypeBuilder> arguments);
 
-  InvalidTypeDeclarationBuilder buildInvalidTypeDeclarationBuilder(
-      LocatedMessage message,
+  InvalidBuilder buildInvalidTypeDeclarationBuilder(LocatedMessage message,
       {List<LocatedMessage>? context});
 }
 

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

@@ -369,7 +369,7 @@ void _sortAllTypeParametersTopologicallyFromRoot(TypeBuilder root,
         // TODO(johnniwinther):: Handle this case.
         case ExtensionBuilder():
         case BuiltinTypeDeclarationBuilder():
-        case InvalidTypeDeclarationBuilder():
+        case InvalidBuilder():
         case null:
       }
     case FunctionTypeBuilder(

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

@@ -413,8 +413,7 @@ class DillLibraryBuilder extends LibraryBuilderImpl {
         if (!suppressFinalizationErrors) {
           addProblem(message, -1, noLength, null);
         }
-        declaration =
-            new InvalidTypeDeclarationBuilder(name, message.withoutLocation());
+        declaration = new InvalidBuilder(name, message.withoutLocation());
       }
       _exportNameSpace.addLocalMember(name, declaration, setter: false);
     });

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

@@ -2964,7 +2964,7 @@ class BodyBuilder extends StackListenerImpl
       Expression? rhs,
       LocatedMessage? message,
       int? length,
-      bool suppressMessage = false}) {
+      bool errorHasBeenReported = false}) {
     // TODO(johnniwinther): Use [arguments] and [rhs] to create an unresolved
     // access expression to include in the invalid expression.
     if (length == null) {
@@ -3037,7 +3037,7 @@ class BodyBuilder extends StackListenerImpl
     }
     return buildProblem(
         message.messageObject, message.charOffset, message.length,
-        context: context, suppressMessage: suppressMessage);
+        context: context, errorHasBeenReported: errorHasBeenReported);
   }
 
   Message warnUnresolvedMember(Name name, int charOffset,
@@ -3278,7 +3278,7 @@ class BodyBuilder extends StackListenerImpl
     if (getable != null) {
       if (getable is ProblemBuilder) {
         return getable;
-      } else if (getable is InvalidTypeDeclarationBuilder) {
+      } else if (getable is InvalidBuilder) {
         return new TypeUseGenerator(
             this,
             nameToken,
@@ -3430,7 +3430,7 @@ class BodyBuilder extends StackListenerImpl
     } else {
       if (setable is ProblemBuilder) {
         return setable;
-      } else if (setable is InvalidTypeDeclarationBuilder) {
+      } else if (setable is InvalidBuilder) {
         // Coverage-ignore-block(suite): Not run.
         return new TypeUseGenerator(
             this,
@@ -4087,7 +4087,7 @@ class BodyBuilder extends StackListenerImpl
     if (generator is! Generator) {
       push(buildProblem(
           cfe.messageNotAnLvalue, offsetForToken(token), lengthForToken(token),
-          suppressMessage: generator is InvalidExpression));
+          errorHasBeenReported: generator is InvalidExpression));
     } else {
       push(new DelayedAssignment(
           this, token, generator, value, token.stringValue!));
@@ -4461,7 +4461,7 @@ class BodyBuilder extends StackListenerImpl
     if (variableOrExpression is ParserRecovery) {
       problemInLoopOrSwitch ??= buildProblemStatement(
           cfe.messageSyntheticToken, variableOrExpression.charOffset,
-          suppressMessage: true);
+          errorHasBeenReported: true);
     }
     exitLoopOrSwitch(result);
   }
@@ -6713,7 +6713,7 @@ class BodyBuilder extends StackListenerImpl
                   arguments: arguments,
                   message: message,
                   kind: UnresolvedKind.Constructor);
-            case InvalidTypeDeclarationBuilder():
+            case InvalidBuilder():
               // Coverage-ignore(suite): Not run.
               LocatedMessage message = typeDeclarationBuilder.message;
               // Coverage-ignore(suite): Not run.
@@ -6755,7 +6755,7 @@ class BodyBuilder extends StackListenerImpl
                             .withArguments(numberOfTypeParameters),
                         nameToken.charOffset,
                         nameToken.length,
-                        suppressMessage: true));
+                        errorHasBeenReported: true));
               }
               List<DartType> dartTypeArguments = [];
               for (TypeBuilder typeBuilder in unaliasedTypeArgumentBuilders) {
@@ -6772,7 +6772,7 @@ class BodyBuilder extends StackListenerImpl
             // Coverage-ignore(suite): Not run.
             case ExtensionBuilder():
             // Coverage-ignore(suite): Not run.
-            case InvalidTypeDeclarationBuilder():
+            case InvalidBuilder():
             // Coverage-ignore(suite): Not run.
             case BuiltinTypeDeclarationBuilder():
             case null:
@@ -6826,7 +6826,7 @@ class BodyBuilder extends StackListenerImpl
                           .withArguments(numberOfTypeParameters),
                       nameToken.charOffset,
                       nameToken.length,
-                      suppressMessage: true));
+                      errorHasBeenReported: true));
             }
             List<DartType> dartTypeArguments = [];
             for (TypeBuilder typeBuilder in unaliasedTypeArgumentBuilders) {
@@ -6868,7 +6868,7 @@ class BodyBuilder extends StackListenerImpl
         case NominalParameterBuilder():
         case StructuralParameterBuilder():
         case ExtensionBuilder():
-        case InvalidTypeDeclarationBuilder():
+        case InvalidBuilder():
         // Coverage-ignore(suite): Not run.
         case BuiltinTypeDeclarationBuilder():
         case null:
@@ -6961,7 +6961,7 @@ class BodyBuilder extends StackListenerImpl
         } else {
           errorName ??= debugName(typeDeclarationBuilder.name, name);
         }
-      case InvalidTypeDeclarationBuilder():
+      case InvalidBuilder():
         LocatedMessage message = typeDeclarationBuilder.message;
         return evaluateArgumentsBefore(
             arguments,
@@ -7543,7 +7543,7 @@ class BodyBuilder extends StackListenerImpl
             buildProblem(cfe.messageNamedFunctionExpression,
                 declaration.fileOffset, noLength,
                 // Error has already been reported by the parser.
-                suppressMessage: true))
+                errorHasBeenReported: true))
           ..fileOffset = declaration.fileOffset);
       } else {
         push(statement);
@@ -9110,9 +9110,9 @@ class BodyBuilder extends StackListenerImpl
   @override
   InvalidExpression buildProblem(Message message, int charOffset, int length,
       {List<LocatedMessage>? context,
-      bool suppressMessage = false,
+      bool errorHasBeenReported = false,
       Expression? expression}) {
-    if (!suppressMessage) {
+    if (!errorHasBeenReported) {
       addProblem(message, charOffset, length,
           wasHandled: true, context: context);
     }
@@ -9130,7 +9130,8 @@ class BodyBuilder extends StackListenerImpl
     if (severity == Severity.error) {
       return wrapInLocatedProblem(
           expression, message.withLocation(uri, fileOffset, length),
-          context: context, suppressMessage: expression is InvalidExpression);
+          context: context,
+          errorHasBeenReported: expression is InvalidExpression);
     } else {
       // Coverage-ignore-block(suite): Not run.
       if (expression is! InvalidExpression) {
@@ -9142,7 +9143,7 @@ class BodyBuilder extends StackListenerImpl
 
   @override
   Expression wrapInLocatedProblem(Expression expression, LocatedMessage message,
-      {List<LocatedMessage>? context, bool suppressMessage = false}) {
+      {List<LocatedMessage>? context, bool errorHasBeenReported = false}) {
     // TODO(askesc): Produce explicit error expression wrapping the original.
     // See [issue 29717](https://github.com/dart-lang/sdk/issues/29717)
     int offset = expression.fileOffset;
@@ -9153,7 +9154,7 @@ class BodyBuilder extends StackListenerImpl
         message.messageObject, message.charOffset, message.length,
         context: context,
         expression: expression,
-        suppressMessage: suppressMessage);
+        errorHasBeenReported: errorHasBeenReported);
   }
 
   Expression buildAbstractClassInstantiationError(
@@ -9166,10 +9167,10 @@ class BodyBuilder extends StackListenerImpl
   Statement buildProblemStatement(Message message, int charOffset,
       {List<LocatedMessage>? context,
       int? length,
-      bool suppressMessage = false}) {
+      bool errorHasBeenReported = false}) {
     length ??= noLength;
     return new ExpressionStatement(buildProblem(message, charOffset, length,
-        context: context, suppressMessage: suppressMessage));
+        context: context, errorHasBeenReported: errorHasBeenReported));
   }
 
   Statement wrapInProblemStatement(Statement statement, Message message) {
@@ -9486,10 +9487,8 @@ class BodyBuilder extends StackListenerImpl
               LocatedMessage message = cfe.messageTypeVariableInConstantContext
                   .withLocation(builder.fileUri!, builder.charOffset!,
                       typeParameter.name!.length);
-              builder.bind(
-                  libraryBuilder,
-                  new InvalidTypeDeclarationBuilder(
-                      typeParameter.name!, message));
+              builder.bind(libraryBuilder,
+                  new InvalidBuilder(typeParameter.name!, message));
               addProblem(
                   message.messageObject, message.charOffset, message.length);
             }