[messages] Decouple diagnosticCodeValues generation.

Refactors (a) the logic that generates analyzer message constants and
(b) the logic that generates the `diagnosticCodeValues` declaration,
so that they both are based on the pre-computed table
`DiagnosticTables.activeMessagesByPackage`.

Previously, (a) produced a list of the active messages as a side
effect, and this list was consumed by (b), so the operation of (a) and
(b) was tightly coupled.

Using `DiagnosticTables.activeMessagesByPackage` means the two
generators are loosely coupled. This paves the way for a follow-up CL
in which I will replace (a) with logic that generates the analyzer
messages as top level constants.

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

Author: stereotype441

pkg/analyzer/tool/messages/generate.dart

@@ -43,22 +43,20 @@ List<GeneratedContent> _analyzerGeneratedFiles() {
 
     (classesByFile[diagnosticClassInfo.file] ??= []).add(diagnosticClassInfo);
   }
-  var generatedCodes = <AnalyzerCode>[];
   return [
     for (var entry in classesByFile.entries)
       GeneratedFile(entry.key.path, (pkgRoot) async {
         var codeGenerator = _AnalyzerDiagnosticGenerator(
           entry.key,
           entry.value,
-          generatedCodes,
         );
         codeGenerator.generate();
         return codeGenerator.out.toString();
       }),
     GeneratedFile('analyzer/lib/src/diagnostic/diagnostic_code_values.g.dart', (
       pkgRoot,
     ) async {
-      var codeGenerator = _DiagnosticCodeValuesGenerator(generatedCodes);
+      var codeGenerator = _DiagnosticCodeValuesGenerator();
       codeGenerator.generate();
       return codeGenerator.out.toString();
     }),
@@ -71,8 +69,6 @@ class _AnalyzerDiagnosticGenerator {
 
   final List<GeneratedDiagnosticClassInfo> diagnosticClasses;
 
-  final List<AnalyzerCode> generatedCodes;
-
   final StringBuffer out = StringBuffer('''
 // Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
@@ -87,11 +83,7 @@ class _AnalyzerDiagnosticGenerator {
 // codes here.
 ''');
 
-  _AnalyzerDiagnosticGenerator(
-    this.file,
-    this.diagnosticClasses,
-    this.generatedCodes,
-  );
+  _AnalyzerDiagnosticGenerator(this.file, this.diagnosticClasses);
 
   void generate() {
     out.writeln('// ignore_for_file: deprecated_member_use_from_same_package');
@@ -121,20 +113,12 @@ part of ${json.encode(file.parentLibrary)};
       );
       var memberAccumulator = MemberAccumulator();
 
-      var entries = diagnosticTables.analyzerCodeToMessage.entries.where(
-        (diagnostic) =>
-            diagnostic.key.diagnosticClass == diagnosticClass &&
-            !diagnostic.value.isRemoved,
-      );
-      for (var entry in entries) {
-        var diagnosticCode = entry.key;
-        var message = entry.value;
+      for (var message
+          in diagnosticTables.activeMessagesByPackage[diagnosticClass
+              .package]!) {
+        if (message.analyzerCode.diagnosticClass != diagnosticClass) continue;
 
         LocatedError.wrap(span: message.keySpan, () {
-          if (message is! AliasMessage &&
-              diagnosticClass.package == AnalyzerDiagnosticPackage.analyzer) {
-            generatedCodes.add(diagnosticCode);
-          }
           message.toAnalyzerCode(
             diagnosticClass,
             memberAccumulator: memberAccumulator,
@@ -220,8 +204,6 @@ DiagnosticType get type => ${diagnosticClass.typeCode};
 }
 
 class _DiagnosticCodeValuesGenerator {
-  final List<AnalyzerCode> generatedCodes;
-
   final StringBuffer out = StringBuffer('''
 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
@@ -241,11 +223,7 @@ class _DiagnosticCodeValuesGenerator {
 // ignore_for_file: deprecated_member_use_from_same_package
 ''');
 
-  _DiagnosticCodeValuesGenerator(this.generatedCodes);
-
   void generate() {
-    generatedCodes.sort();
-
     out.writeln();
     out.writeln(r'''
 part of 'diagnostic_code_values.dart';
@@ -255,7 +233,10 @@ part of 'diagnostic_code_values.dart';
       "@AnalyzerPublicApi(message: 'exported by lib/error/error.dart')",
     );
     out.writeln('const List<DiagnosticCode> diagnosticCodeValues = [');
-    for (var analyzerCode in generatedCodes) {
+    for (var message
+        in diagnosticTables.activeMessagesByPackage[AnalyzerDiagnosticPackage
+            .analyzer]!) {
+      var analyzerCode = message.analyzerCode;
       var diagnosticName = analyzerCode.camelCaseName;
       out.writeln('  ${analyzerCode.diagnosticClass.name}.$diagnosticName,');
     }

pkg/analyzer_utilities/lib/messages.dart

@@ -481,6 +481,16 @@ class DiagnosticTables {
   /// List of front end diagnostics, sorted by front end code.
   final List<CfeStyleMessage> sortedFrontEndDiagnostics = [];
 
+  /// Map from [AnalyzerDiagnosticPackage] to the list of active diagnostic
+  /// messages for that package.
+  ///
+  /// A message is considered active is [MessageWithAnalyzerCode.isRemoved] is
+  /// `false` and the message is not an [AliasMessage].
+  ///
+  /// Each list is sorted by analyzer code.
+  final Map<AnalyzerDiagnosticPackage, List<MessageWithAnalyzerCode>>
+  activeMessagesByPackage = {};
+
   DiagnosticTables._(List<Message> messages) {
     var frontEndCodeDuplicateChecker = _DuplicateChecker<String>(
       kind: 'Front end code',
@@ -512,6 +522,14 @@ class DiagnosticTables {
                     analyzerCode.snakeCaseName] ??=
                 [])
             .add(message);
+        var diagnosticClass = analyzerCode.diagnosticClass;
+        if (diagnosticClass is GeneratedDiagnosticClassInfo &&
+            !message.isRemoved &&
+            message is! AliasMessage) {
+          (activeMessagesByPackage[diagnosticClass.package] ??= []).add(
+            message,
+          );
+        }
       }
     }
 
@@ -522,6 +540,9 @@ class DiagnosticTables {
 
     sortedSharedDiagnostics.sortBy((e) => e.analyzerCode.camelCaseName);
     sortedFrontEndDiagnostics.sortBy((e) => e.frontEndCode);
+    for (var value in activeMessagesByPackage.values) {
+      value.sortBy((e) => e.analyzerCode);
+    }
   }
 
   static void _checkSharedNames(