[messages] Move cfeToAnalyzerErrorCodeTables to package:analyzer_utilities

Moves the class `CfeToAnalyzerErrorCodeTables`, and its associated top
level variable, `cfeToAnalyzerErrorCodeTables` from
`pkg/analyzer/tool/messages/error_code_info.dart` to
`pkg/analyzer_utilities/lib/messages.dart`, so that they can be used
by the front end diagnostic code generator.

In the process, they are renamed to `SharedToAnalyzerErrorCodeTables`
and `sharedToAnalyzerErrorCodeTables`, to more precisely reflect the
fact that they deal with _shared_ diagnostic codes.

In a follow-up CL I plan to rework `SharedToAnalyzerErrorCodeTables`
so that it automatically generates the `index` values that map between
CFE and analyzer errors. This will make it easier to maintain the
entries in `pkg/_fe_analyzer_shared/messages.yaml`, since we won't
have to manually figure out the next index value and assign it.

Change-Id: I6a6a696432d9f0b26fd86f753be3083a4de881b0
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/449606
Reviewed-by: Johnni Winther <[email protected]>
Commit-Queue: Paul Berry <[email protected]>

Author: stereotype441

pkg/analyzer/test/verify_diagnostics_test.dart

@@ -232,7 +232,7 @@ class DocumentationValidator {
         errorClassIncludingCfeMessages = errorClass;
         await _validateMessages(
           errorClass.name,
-          cfeToAnalyzerErrorCodeTables.analyzerCodeToInfo,
+          sharedToAnalyzerErrorCodeTables.analyzerCodeToInfo,
         );
       }
     }

pkg/analyzer/tool/messages/error_code_info.dart

@@ -166,10 +166,6 @@ final String analyzerPkgPath = normalize(
   join(pkg_root.packageRoot, 'analyzer'),
 );
 
-/// A set of tables mapping between front end and analyzer error codes.
-final CfeToAnalyzerErrorCodeTables cfeToAnalyzerErrorCodeTables =
-    CfeToAnalyzerErrorCodeTables._(frontEndAndSharedMessages);
-
 /// The path to the `linter` package.
 final String linterPkgPath = normalize(join(pkg_root.packageRoot, 'linter'));
 
@@ -306,81 +302,3 @@ class AnalyzerErrorCodeInfo extends ErrorCodeInfo {
 
   AnalyzerErrorCodeInfo._fromYaml(super.yaml) : super.fromYaml();
 }
-
-/// Data tables mapping between CFE errors and their corresponding automatically
-/// generated analyzer errors.
-class CfeToAnalyzerErrorCodeTables {
-  /// List of CFE errors for which analyzer errors should be automatically
-  /// generated, organized by their `index` property.
-  final List<ErrorCodeInfo?> indexToInfo = [];
-
-  /// Map whose values are the CFE errors for which analyzer errors should be
-  /// automatically generated, and whose keys are the corresponding analyzer
-  /// error name.  (Names are simple identifiers; they are not prefixed by the
-  /// class name `ParserErrorCode`)
-  final Map<String, ErrorCodeInfo> analyzerCodeToInfo = {};
-
-  /// Map whose values are the CFE errors for which analyzer errors should be
-  /// automatically generated, and whose keys are the front end error name.
-  final Map<String, ErrorCodeInfo> frontEndCodeToInfo = {};
-
-  /// Map whose keys are the CFE errors for which analyzer errors should be
-  /// automatically generated, and whose values are the corresponding analyzer
-  /// error name.  (Names are simple identifiers; they are not prefixed by the
-  /// class name `ParserErrorCode`)
-  final Map<ErrorCodeInfo, String> infoToAnalyzerCode = {};
-
-  /// Map whose keys are the CFE errors for which analyzer errors should be
-  /// automatically generated, and whose values are the front end error name.
-  final Map<ErrorCodeInfo, String> infoToFrontEndCode = {};
-
-  CfeToAnalyzerErrorCodeTables._(Map<String, CfeStyleErrorCodeInfo> messages) {
-    for (var entry in messages.entries) {
-      var errorCodeInfo = entry.value;
-      var index = errorCodeInfo.index;
-      if (index == null || errorCodeInfo.analyzerCodes.length != 1) {
-        continue;
-      }
-      var frontEndCode = entry.key;
-      if (index < 1) {
-        throw '''
-$frontEndCode specifies index $index but indices must be 1 or greater.
-For more information run:
-dart pkg/front_end/tool/generate_messages.dart
-''';
-      }
-      if (indexToInfo.length <= index) {
-        indexToInfo.length = index + 1;
-      }
-      var previousEntryForIndex = indexToInfo[index];
-      if (previousEntryForIndex != null) {
-        throw 'Index $index used by both '
-            '${infoToFrontEndCode[previousEntryForIndex]} and $frontEndCode';
-      }
-      indexToInfo[index] = errorCodeInfo;
-      frontEndCodeToInfo[frontEndCode] = errorCodeInfo;
-      infoToFrontEndCode[errorCodeInfo] = frontEndCode;
-      var analyzerCodeLong = errorCodeInfo.analyzerCodes.single;
-      var expectedPrefix = 'ParserErrorCode.';
-      if (!analyzerCodeLong.startsWith(expectedPrefix)) {
-        throw 'Expected all analyzer error codes to be prefixed with '
-            '${json.encode(expectedPrefix)}.  Found '
-            '${json.encode(analyzerCodeLong)}.';
-      }
-      var analyzerCode = analyzerCodeLong.substring(expectedPrefix.length);
-      infoToAnalyzerCode[errorCodeInfo] = analyzerCode;
-      var previousEntryForAnalyzerCode = analyzerCodeToInfo[analyzerCode];
-      if (previousEntryForAnalyzerCode != null) {
-        throw 'Analyzer code $analyzerCode used by both '
-            '${infoToFrontEndCode[previousEntryForAnalyzerCode]} and '
-            '$frontEndCode';
-      }
-      analyzerCodeToInfo[analyzerCode] = errorCodeInfo;
-    }
-    for (int i = 1; i < indexToInfo.length; i++) {
-      if (indexToInfo[i] == null) {
-        throw 'Indices are not consecutive; no error code has index $i.';
-      }
-    }
-  }
-}

pkg/analyzer/tool/messages/generate.dart

@@ -131,7 +131,7 @@ part of ${json.encode(file.parentLibrary)};
       var entries = [
         ...analyzerMessages[errorClass.name]!.entries,
         if (errorClass.includeCfeMessages)
-          ...cfeToAnalyzerErrorCodeTables.analyzerCodeToInfo.entries,
+          ...sharedToAnalyzerErrorCodeTables.analyzerCodeToInfo.entries,
       ].where((error) => !error.value.isRemoved);
       for (var entry in entries) {
         var errorName = entry.key;
@@ -200,8 +200,8 @@ DiagnosticType get type => ${errorClass.typeCode};
 
   void _generateFastaAnalyzerErrorCodeList() {
     out.writeln('final fastaAnalyzerErrorCodes = <DiagnosticCode?>[');
-    for (var entry in cfeToAnalyzerErrorCodeTables.indexToInfo) {
-      var name = cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode[entry]
+    for (var entry in sharedToAnalyzerErrorCodeTables.indexToInfo) {
+      var name = sharedToAnalyzerErrorCodeTables.infoToAnalyzerCode[entry]
           ?.toCamelCase();
       out.writeln('${name == null ? 'null' : 'ParserErrorCode.$name'},');
     }
@@ -332,7 +332,7 @@ class _SyntacticErrorGenerator {
     // error_converter.dart now that those ParserErrorCodes are auto generated.
     int converterCount = 0;
     for (var errorCode
-        in cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.values) {
+        in sharedToAnalyzerErrorCodeTables.infoToAnalyzerCode.values) {
       if (errorConverterSource.contains('"$errorCode"')) {
         if (converterCount == 0) {
           print('');
@@ -376,14 +376,14 @@ class _SyntacticErrorGenerator {
 
     // Remove entries that have already been translated
     for (ErrorCodeInfo entry
-        in cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.keys) {
+        in sharedToAnalyzerErrorCodeTables.infoToAnalyzerCode.keys) {
       messageToName.remove(messageFromEntryTemplate(entry));
     }
 
     // Print the # of autogenerated ParserErrorCodes.
     print(
       '${messageToName.length} of '
-      '${cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.length} ParserErrorCodes generated.',
+      '${sharedToAnalyzerErrorCodeTables.infoToAnalyzerCode.length} ParserErrorCodes generated.',
     );
 
     // List the ParserErrorCodes that could easily be auto generated

pkg/analyzer_utilities/lib/messages.dart

@@ -63,6 +63,10 @@ final RegExp placeholderPattern = RegExp(
   '#([-a-zA-Z0-9_]+)(?:%([0-9]*).([0-9]+))?',
 );
 
+/// A set of tables mapping between shared and analyzer error codes.
+final SharedToAnalyzerErrorCodeTables sharedToAnalyzerErrorCodeTables =
+    SharedToAnalyzerErrorCodeTables._(frontEndAndSharedMessages);
+
 /// Convert a template string (which uses placeholders matching
 /// [placeholderPattern]) to an analyzer internal template string (which uses
 /// placeholders like `{0}`).
@@ -982,6 +986,86 @@ class SharedErrorCodeInfo extends CfeStyleErrorCodeInfo {
   int get index => super.index!;
 }
 
+/// Data tables mapping between shared errors and their corresponding
+/// automatically generated analyzer errors.
+class SharedToAnalyzerErrorCodeTables {
+  /// List of CFE errors for which analyzer errors should be automatically
+  /// generated, organized by their `index` property.
+  final List<ErrorCodeInfo?> indexToInfo = [];
+
+  /// Map whose values are the CFE errors for which analyzer errors should be
+  /// automatically generated, and whose keys are the corresponding analyzer
+  /// error name.  (Names are simple identifiers; they are not prefixed by the
+  /// class name `ParserErrorCode`)
+  final Map<String, ErrorCodeInfo> analyzerCodeToInfo = {};
+
+  /// Map whose values are the CFE errors for which analyzer errors should be
+  /// automatically generated, and whose keys are the front end error name.
+  final Map<String, ErrorCodeInfo> frontEndCodeToInfo = {};
+
+  /// Map whose keys are the CFE errors for which analyzer errors should be
+  /// automatically generated, and whose values are the corresponding analyzer
+  /// error name.  (Names are simple identifiers; they are not prefixed by the
+  /// class name `ParserErrorCode`)
+  final Map<ErrorCodeInfo, String> infoToAnalyzerCode = {};
+
+  /// Map whose keys are the CFE errors for which analyzer errors should be
+  /// automatically generated, and whose values are the front end error name.
+  final Map<ErrorCodeInfo, String> infoToFrontEndCode = {};
+
+  SharedToAnalyzerErrorCodeTables._(
+    Map<String, CfeStyleErrorCodeInfo> messages,
+  ) {
+    for (var entry in messages.entries) {
+      var errorCodeInfo = entry.value;
+      var index = errorCodeInfo.index;
+      if (index == null || errorCodeInfo.analyzerCodes.length != 1) {
+        continue;
+      }
+      var frontEndCode = entry.key;
+      if (index < 1) {
+        throw '''
+$frontEndCode specifies index $index but indices must be 1 or greater.
+For more information run:
+dart pkg/front_end/tool/generate_messages.dart
+''';
+      }
+      if (indexToInfo.length <= index) {
+        indexToInfo.length = index + 1;
+      }
+      var previousEntryForIndex = indexToInfo[index];
+      if (previousEntryForIndex != null) {
+        throw 'Index $index used by both '
+            '${infoToFrontEndCode[previousEntryForIndex]} and $frontEndCode';
+      }
+      indexToInfo[index] = errorCodeInfo;
+      frontEndCodeToInfo[frontEndCode] = errorCodeInfo;
+      infoToFrontEndCode[errorCodeInfo] = frontEndCode;
+      var analyzerCodeLong = errorCodeInfo.analyzerCodes.single;
+      var expectedPrefix = 'ParserErrorCode.';
+      if (!analyzerCodeLong.startsWith(expectedPrefix)) {
+        throw 'Expected all analyzer error codes to be prefixed with '
+            '${json.encode(expectedPrefix)}.  Found '
+            '${json.encode(analyzerCodeLong)}.';
+      }
+      var analyzerCode = analyzerCodeLong.substring(expectedPrefix.length);
+      infoToAnalyzerCode[errorCodeInfo] = analyzerCode;
+      var previousEntryForAnalyzerCode = analyzerCodeToInfo[analyzerCode];
+      if (previousEntryForAnalyzerCode != null) {
+        throw 'Analyzer code $analyzerCode used by both '
+            '${infoToFrontEndCode[previousEntryForAnalyzerCode]} and '
+            '$frontEndCode';
+      }
+      analyzerCodeToInfo[analyzerCode] = errorCodeInfo;
+    }
+    for (int i = 1; i < indexToInfo.length; i++) {
+      if (indexToInfo[i] == null) {
+        throw 'Indices are not consecutive; no error code has index $i.';
+      }
+    }
+  }
+}
+
 /// A [Conversion] that invokes a top level function via the `conversions`
 /// import prefix.
 class SimpleConversion implements Conversion {