pkg/analyzer/tool/messages/generate.dart - sdk.git - Git at Google

 // 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
 // BSD-style license that can be found in the LICENSE file.

 /// This file contains code to generate scanner and parser message
 /// based on the information in pkg/front_end/messages.yaml.
 ///
 /// For each message in messages.yaml that contains an 'index:' field,
 /// this tool generates an error with the name specified by the 'analyzerCode:'
 /// field and an entry in the fastaAnalyzerErrorList for that generated error.
 /// The text in the 'analyzerCode:' field must contain the name of the class
 /// containing the error and the name of the error separated by a `.`
 /// (e.g. ParserErrorCode.EQUALITY_CANNOT_BE_EQUALITY_OPERAND).
 ///
 /// It is expected that 'pkg/front_end/tool/fasta generate-messages'
 /// has already been successfully run.
 import 'dart:convert';
 import 'dart:io';

 import 'package:_fe_analyzer_shared/src/scanner/scanner.dart';
 import 'package:analyzer_utilities/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
 import 'package:path/path.dart';

 import 'error_code_info.dart';

 main() async {
   await GeneratedContent.generateAll(analyzerPkgPath, allTargets);

   _SyntacticErrorGenerator()
     ..checkForManualChanges()
     ..printSummary();
 }

 /// A list of all targets generated by this code generator.
 final List<GeneratedContent> allTargets = _analyzerGeneratedFiles();

 /// Generates a list of [GeneratedContent] objects describing all the analyzer
 /// files that need to be generated.
 List<GeneratedContent> _analyzerGeneratedFiles() {
   var classesByFile = <String, List<ErrorClassInfo>>{};
   for (var errorClassInfo in errorClasses) {
     (classesByFile[errorClassInfo.filePath] ??= []).add(errorClassInfo);
   }
   return [
     for (var entry in classesByFile.entries)
       GeneratedFile(entry.key, (String pkgPath) async {
         final codeGenerator = _AnalyzerErrorGenerator(entry.value);
         codeGenerator.generate();
         return codeGenerator.out.toString();
       })
   ];
 }

 /// Code generator for analyzer error classes.
 class _AnalyzerErrorGenerator {
   final List<ErrorClassInfo> errorClasses;
   final 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
 // BSD-style license that can be found in the LICENSE file.

 // THIS FILE IS GENERATED. DO NOT EDIT.
 //
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 ''');

   _AnalyzerErrorGenerator(this.errorClasses);

   void generate() {
     var imports = {'package:analyzer/error/error.dart'};
     bool shouldGenerateFastaAnalyzerErrorCodes = false;
     for (var errorClass in errorClasses) {
       imports.addAll(errorClass.extraImports);
       if (errorClass.includeCfeMessages) {
         shouldGenerateFastaAnalyzerErrorCodes = true;
       }
     }
     out.writeln();
     for (var importPath in imports.toList()..sort()) {
       out.writeln("import ${json.encode(importPath)};");
     }
     out.writeln();
     out.writeln("// It is hard to visually separate each code's _doc comment_ "
         "from its published");
     out.writeln('// _documentation comment_ when each is written as an '
         'end-of-line comment.');
     out.writeln('// ignore_for_file: slash_for_doc_comments');
     if (shouldGenerateFastaAnalyzerErrorCodes) {
       out.writeln();
       _generateFastaAnalyzerErrorCodeList();
     }
     for (var errorClass in errorClasses.toList()
       ..sort((a, b) => a.name.compareTo(b.name))) {
       out.writeln();
       out.write('class ${errorClass.name} extends ${errorClass.superclass} {');
       var entries = [
         ...analyzerMessages[errorClass.name]!.entries,
         if (errorClass.includeCfeMessages)
           ...cfeToAnalyzerErrorCodeTables.analyzerCodeToInfo.entries
       ];
       for (var entry in entries..sort((a, b) => a.key.compareTo(b.key))) {
         var errorName = entry.key;
         var errorCodeInfo = entry.value;
         out.writeln();
         out.write(errorCodeInfo.toAnalyzerComments(indent: '  '));
         out.writeln('  static const ${errorClass.name} $errorName =');
         out.writeln(errorCodeInfo.toAnalyzerCode(errorClass.name, errorName));
       }
       out.writeln();
       out.writeln('/// Initialize a newly created error code to have the given '
           '[name].');
       out.writeln(
           'const ${errorClass.name}(String name, String problemMessage, {');
       out.writeln('String? correctionMessage,');
       out.writeln('bool hasPublishedDocs = false,');
       out.writeln('bool isUnresolvedIdentifier = false,');
       out.writeln('String? uniqueName,');
       out.writeln('}) : super(');
       out.writeln('correctionMessage: correctionMessage,');
       out.writeln('hasPublishedDocs: hasPublishedDocs,');
       out.writeln('isUnresolvedIdentifier: isUnresolvedIdentifier,');
       out.writeln('name: name,');
       out.writeln('problemMessage: problemMessage,');
       out.writeln("uniqueName: '${errorClass.name}.\${uniqueName ?? name}',");
       out.writeln(');');
       out.writeln();
       out.writeln('@override');
       out.writeln('ErrorSeverity get errorSeverity => '
           '${errorClass.severityCode};');
       out.writeln();
       out.writeln('@override');
       out.writeln('ErrorType get type => ${errorClass.typeCode};');
       out.writeln('}');
     }
   }

   void _generateFastaAnalyzerErrorCodeList() {
     out.writeln('final fastaAnalyzerErrorCodes = <ErrorCode?>[');
     for (var entry in cfeToAnalyzerErrorCodeTables.indexToInfo) {
       var name = cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode[entry];
       out.writeln('${name == null ? 'null' : 'ParserErrorCode.$name'},');
     }
     out.writeln('];');
   }
 }

 class _SyntacticErrorGenerator {
   final String errorConverterSource;
   final String parserSource;

   factory _SyntacticErrorGenerator() {
     String frontEndSharedPkgPath =
         normalize(join(pkg_root.packageRoot, '_fe_analyzer_shared'));

     String errorConverterSource = File(join(analyzerPkgPath,
             joinAll(posix.split('lib/src/fasta/error_converter.dart'))))
         .readAsStringSync();
     String parserSource = File(join(frontEndSharedPkgPath,
             joinAll(posix.split('lib/src/parser/parser.dart'))))
         .readAsStringSync();

     return _SyntacticErrorGenerator._(errorConverterSource, parserSource);
   }

   _SyntacticErrorGenerator._(this.errorConverterSource, this.parserSource);

   void checkForManualChanges() {
     // Check for ParserErrorCodes that could be removed from
     // error_converter.dart now that those ParserErrorCodes are auto generated.
     int converterCount = 0;
     for (var errorCode
         in cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.values) {
       if (errorConverterSource.contains('"$errorCode"')) {
         if (converterCount == 0) {
           print('');
           print('The following ParserErrorCodes could be removed'
               ' from error_converter.dart:');
         }
         print('  $errorCode');
         ++converterCount;
       }
     }
     if (converterCount > 3) {
       print('  $converterCount total');
     }

     // Fail if there are manual changes to be made, but do so
     // in a fire and forget manner so that the files are still generated.
     if (converterCount > 0) {
       print('');
       throw 'Error: missing manual code changes';
     }
   }

   void printSummary() {
     // Build a map of error message to ParserErrorCode
     final messageToName = <String, String>{};
     for (var entry in analyzerMessages['ParserErrorCode']!.entries) {
       String message =
           entry.value.problemMessage.replaceAll(RegExp(r'\{\d+\}'), '');
       messageToName[message] = entry.key;
     }

     String messageFromEntryTemplate(ErrorCodeInfo entry) {
       String problemMessage = entry.problemMessage;
       String message = problemMessage.replaceAll(RegExp(r'#\w+'), '');
       return message;
     }

     // Remove entries that have already been translated
     for (ErrorCodeInfo entry
         in cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.keys) {
       messageToName.remove(messageFromEntryTemplate(entry));
     }

     // Print the # of autogenerated ParserErrorCodes.
     print('${cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.length} of '
         '${messageToName.length} ParserErrorCodes generated.');

     // List the ParserErrorCodes that could easily be auto generated
     // but have not been already.
     final analyzerToFasta = <String, List<String>>{};
     frontEndMessages.forEach((fastaName, entry) {
       final analyzerName = messageToName[messageFromEntryTemplate(entry)];
       if (analyzerName != null) {
         analyzerToFasta
             .putIfAbsent(analyzerName, () => <String>[])
             .add(fastaName);
       }
     });
     if (analyzerToFasta.isNotEmpty) {
       print('');
       print('The following ParserErrorCodes could be auto generated:');
       for (String analyzerName in analyzerToFasta.keys.toList()..sort()) {
         List<String> fastaNames = analyzerToFasta[analyzerName]!;
         if (fastaNames.length == 1) {
           print('  $analyzerName = ${fastaNames.first}');
         } else {
           print('  $analyzerName = $fastaNames');
         }
       }
       if (analyzerToFasta.length > 3) {
         print('  ${analyzerToFasta.length} total');
       }
     }

     // List error codes in the parser that have not been translated.
     final untranslatedFastaErrorCodes = <String>{};
     Token token = scanString(parserSource).tokens;
     while (!token.isEof) {
       if (token.isIdentifier) {
         String? fastaErrorCode;
         String lexeme = token.lexeme;
         if (lexeme.length > 7) {
           if (lexeme.startsWith('message')) {
             fastaErrorCode = lexeme.substring(7);
           } else if (lexeme.length > 8) {
             if (lexeme.startsWith('template')) {
               fastaErrorCode = lexeme.substring(8);
             }
           }
         }
         if (fastaErrorCode != null &&
             cfeToAnalyzerErrorCodeTables.frontEndCodeToInfo[fastaErrorCode] ==
                 null) {
           untranslatedFastaErrorCodes.add(fastaErrorCode);
         }
       }
       token = token.next!;
     }
     if (untranslatedFastaErrorCodes.isNotEmpty) {
       print('');
       print('The following error codes in the parser are not auto generated:');
       final sorted = untranslatedFastaErrorCodes.toList()..sort();
       for (String fastaErrorCode in sorted) {
         String analyzerCode = '';
         String problemMessage = '';
         var entry = frontEndMessages[fastaErrorCode];
         if (entry != null) {
           // TODO(paulberry): handle multiple analyzer codes
           if (entry.index == null && entry.analyzerCode.length == 1) {
             analyzerCode = entry.analyzerCode.single;
             problemMessage = entry.problemMessage;
           }
         }
         print('  ${fastaErrorCode.padRight(30)} --> $analyzerCode'
             '\n      $problemMessage');
       }
     }
   }
 }
	// 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
	// BSD-style license that can be found in the LICENSE file.

	/// This file contains code to generate scanner and parser message
	/// based on the information in pkg/front_end/messages.yaml.
	///
	/// For each message in messages.yaml that contains an 'index:' field,
	/// this tool generates an error with the name specified by the 'analyzerCode:'
	/// field and an entry in the fastaAnalyzerErrorList for that generated error.
	/// The text in the 'analyzerCode:' field must contain the name of the class
	/// containing the error and the name of the error separated by a `.`
	/// (e.g. ParserErrorCode.EQUALITY_CANNOT_BE_EQUALITY_OPERAND).
	///
	/// It is expected that 'pkg/front_end/tool/fasta generate-messages'
	/// has already been successfully run.
	import 'dart:convert';
	import 'dart:io';

	import 'package:_fe_analyzer_shared/src/scanner/scanner.dart';
	import 'package:analyzer_utilities/package_root.dart' as pkg_root;
	import 'package:analyzer_utilities/tools.dart';
	import 'package:path/path.dart';

	import 'error_code_info.dart';

	main() async {
	await GeneratedContent.generateAll(analyzerPkgPath, allTargets);

	_SyntacticErrorGenerator()
	..checkForManualChanges()
	..printSummary();
	}

	/// A list of all targets generated by this code generator.
	final List<GeneratedContent> allTargets = _analyzerGeneratedFiles();

	/// Generates a list of [GeneratedContent] objects describing all the analyzer
	/// files that need to be generated.
	List<GeneratedContent> _analyzerGeneratedFiles() {
	var classesByFile = <String, List<ErrorClassInfo>>{};
	for (var errorClassInfo in errorClasses) {
	(classesByFile[errorClassInfo.filePath] ??= []).add(errorClassInfo);
	}
	return [
	for (var entry in classesByFile.entries)
	GeneratedFile(entry.key, (String pkgPath) async {
	final codeGenerator = _AnalyzerErrorGenerator(entry.value);
	codeGenerator.generate();
	return codeGenerator.out.toString();
	})
	];
	}

	/// Code generator for analyzer error classes.
	class _AnalyzerErrorGenerator {
	final List<ErrorClassInfo> errorClasses;
	final 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
	// BSD-style license that can be found in the LICENSE file.

	// THIS FILE IS GENERATED. DO NOT EDIT.
	//
	// Instead modify 'pkg/analyzer/messages.yaml' and run
	// 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
	''');

	_AnalyzerErrorGenerator(this.errorClasses);

	void generate() {
	var imports = {'package:analyzer/error/error.dart'};
	bool shouldGenerateFastaAnalyzerErrorCodes = false;
	for (var errorClass in errorClasses) {
	imports.addAll(errorClass.extraImports);
	if (errorClass.includeCfeMessages) {
	shouldGenerateFastaAnalyzerErrorCodes = true;
	}
	}
	out.writeln();
	for (var importPath in imports.toList()..sort()) {
	out.writeln("import ${json.encode(importPath)};");
	}
	out.writeln();
	out.writeln("// It is hard to visually separate each code's _doc comment_ "
	"from its published");
	out.writeln('// _documentation comment_ when each is written as an '
	'end-of-line comment.');
	out.writeln('// ignore_for_file: slash_for_doc_comments');
	if (shouldGenerateFastaAnalyzerErrorCodes) {
	out.writeln();
	_generateFastaAnalyzerErrorCodeList();
	}
	for (var errorClass in errorClasses.toList()
	..sort((a, b) => a.name.compareTo(b.name))) {
	out.writeln();
	out.write('class ${errorClass.name} extends ${errorClass.superclass} {');
	var entries = [
	...analyzerMessages[errorClass.name]!.entries,
	if (errorClass.includeCfeMessages)
	...cfeToAnalyzerErrorCodeTables.analyzerCodeToInfo.entries
	];
	for (var entry in entries..sort((a, b) => a.key.compareTo(b.key))) {
	var errorName = entry.key;
	var errorCodeInfo = entry.value;
	out.writeln();
	out.write(errorCodeInfo.toAnalyzerComments(indent: ' '));
	out.writeln(' static const ${errorClass.name} $errorName =');
	out.writeln(errorCodeInfo.toAnalyzerCode(errorClass.name, errorName));
	}
	out.writeln();
	out.writeln('/// Initialize a newly created error code to have the given '
	'[name].');
	out.writeln(
	'const ${errorClass.name}(String name, String problemMessage, {');
	out.writeln('String? correctionMessage,');
	out.writeln('bool hasPublishedDocs = false,');
	out.writeln('bool isUnresolvedIdentifier = false,');
	out.writeln('String? uniqueName,');
	out.writeln('}) : super(');
	out.writeln('correctionMessage: correctionMessage,');
	out.writeln('hasPublishedDocs: hasPublishedDocs,');
	out.writeln('isUnresolvedIdentifier: isUnresolvedIdentifier,');
	out.writeln('name: name,');
	out.writeln('problemMessage: problemMessage,');
	out.writeln("uniqueName: '${errorClass.name}.\${uniqueName ?? name}',");
	out.writeln(');');
	out.writeln();
	out.writeln('@override');
	out.writeln('ErrorSeverity get errorSeverity => '
	'${errorClass.severityCode};');
	out.writeln();
	out.writeln('@override');
	out.writeln('ErrorType get type => ${errorClass.typeCode};');
	out.writeln('}');
	}
	}

	void _generateFastaAnalyzerErrorCodeList() {
	out.writeln('final fastaAnalyzerErrorCodes = <ErrorCode?>[');
	for (var entry in cfeToAnalyzerErrorCodeTables.indexToInfo) {
	var name = cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode[entry];
	out.writeln('${name == null ? 'null' : 'ParserErrorCode.$name'},');
	}
	out.writeln('];');
	}
	}

	class _SyntacticErrorGenerator {
	final String errorConverterSource;
	final String parserSource;

	factory _SyntacticErrorGenerator() {
	String frontEndSharedPkgPath =
	normalize(join(pkg_root.packageRoot, '_fe_analyzer_shared'));

	String errorConverterSource = File(join(analyzerPkgPath,
	joinAll(posix.split('lib/src/fasta/error_converter.dart'))))
	.readAsStringSync();
	String parserSource = File(join(frontEndSharedPkgPath,
	joinAll(posix.split('lib/src/parser/parser.dart'))))
	.readAsStringSync();

	return _SyntacticErrorGenerator._(errorConverterSource, parserSource);
	}

	_SyntacticErrorGenerator._(this.errorConverterSource, this.parserSource);

	void checkForManualChanges() {
	// Check for ParserErrorCodes that could be removed from
	// error_converter.dart now that those ParserErrorCodes are auto generated.
	int converterCount = 0;
	for (var errorCode
	in cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.values) {
	if (errorConverterSource.contains('"$errorCode"')) {
	if (converterCount == 0) {
	print('');
	print('The following ParserErrorCodes could be removed'
	' from error_converter.dart:');
	}
	print(' $errorCode');
	++converterCount;
	}
	}
	if (converterCount > 3) {
	print(' $converterCount total');
	}

	// Fail if there are manual changes to be made, but do so
	// in a fire and forget manner so that the files are still generated.
	if (converterCount > 0) {
	print('');
	throw 'Error: missing manual code changes';
	}
	}

	void printSummary() {
	// Build a map of error message to ParserErrorCode
	final messageToName = <String, String>{};
	for (var entry in analyzerMessages['ParserErrorCode']!.entries) {
	String message =
	entry.value.problemMessage.replaceAll(RegExp(r'\{\d+\}'), '');
	messageToName[message] = entry.key;
	}

	String messageFromEntryTemplate(ErrorCodeInfo entry) {
	String problemMessage = entry.problemMessage;
	String message = problemMessage.replaceAll(RegExp(r'#\w+'), '');
	return message;
	}

	// Remove entries that have already been translated
	for (ErrorCodeInfo entry
	in cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.keys) {
	messageToName.remove(messageFromEntryTemplate(entry));
	}

	// Print the # of autogenerated ParserErrorCodes.
	print('${cfeToAnalyzerErrorCodeTables.infoToAnalyzerCode.length} of '
	'${messageToName.length} ParserErrorCodes generated.');

	// List the ParserErrorCodes that could easily be auto generated
	// but have not been already.
	final analyzerToFasta = <String, List<String>>{};
	frontEndMessages.forEach((fastaName, entry) {
	final analyzerName = messageToName[messageFromEntryTemplate(entry)];
	if (analyzerName != null) {
	analyzerToFasta
	.putIfAbsent(analyzerName, () => <String>[])
	.add(fastaName);
	}
	});
	if (analyzerToFasta.isNotEmpty) {
	print('');
	print('The following ParserErrorCodes could be auto generated:');
	for (String analyzerName in analyzerToFasta.keys.toList()..sort()) {
	List<String> fastaNames = analyzerToFasta[analyzerName]!;
	if (fastaNames.length == 1) {
	print(' $analyzerName = ${fastaNames.first}');
	} else {
	print(' $analyzerName = $fastaNames');
	}
	}
	if (analyzerToFasta.length > 3) {
	print(' ${analyzerToFasta.length} total');
	}
	}

	// List error codes in the parser that have not been translated.
	final untranslatedFastaErrorCodes = <String>{};
	Token token = scanString(parserSource).tokens;
	while (!token.isEof) {
	if (token.isIdentifier) {
	String? fastaErrorCode;
	String lexeme = token.lexeme;
	if (lexeme.length > 7) {
	if (lexeme.startsWith('message')) {
	fastaErrorCode = lexeme.substring(7);
	} else if (lexeme.length > 8) {
	if (lexeme.startsWith('template')) {
	fastaErrorCode = lexeme.substring(8);
	}
	}
	}
	if (fastaErrorCode != null &&
	cfeToAnalyzerErrorCodeTables.frontEndCodeToInfo[fastaErrorCode] ==
	null) {
	untranslatedFastaErrorCodes.add(fastaErrorCode);
	}
	}
	token = token.next!;
	}
	if (untranslatedFastaErrorCodes.isNotEmpty) {
	print('');
	print('The following error codes in the parser are not auto generated:');
	final sorted = untranslatedFastaErrorCodes.toList()..sort();
	for (String fastaErrorCode in sorted) {
	String analyzerCode = '';
	String problemMessage = '';
	var entry = frontEndMessages[fastaErrorCode];
	if (entry != null) {
	// TODO(paulberry): handle multiple analyzer codes
	if (entry.index == null && entry.analyzerCode.length == 1) {
	analyzerCode = entry.analyzerCode.single;
	problemMessage = entry.problemMessage;
	}
	}
	print(' ${fastaErrorCode.padRight(30)} --> $analyzerCode'
	'\n $problemMessage');
	}
	}
	}
	}