[pigeon] Creates writePrologue method on Generator classes

packages/pigeon/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.0.1
+
+* Adds writeHeaders method to Generator classes and updates tests to use new Generators.
+
 ## 5.0.0
 
 * Creates new Generator classes for each language.

packages/pigeon/lib/cpp_generator.dart

@@ -75,16 +75,33 @@ class CppGenerator extends Generator<OutputFileOptions<CppOptions>> {
   /// Instantiates a Cpp Generator.
   CppGenerator();
 
-  /// Generates Cpp files with specified [OutputFileOptions<CppOptions>]
+  /// Generates Cpp header files with specified [CppOptions]
   @override
-  void generate(OutputFileOptions<CppOptions> languageOptions, Root root,
+  void generate(OutputFileOptions<CppOptions> generatorOptions, Root root,
       StringSink sink) {
-    final FileType fileType = languageOptions.fileType;
+    final FileType fileType = generatorOptions.fileType;
     assert(fileType == FileType.header || fileType == FileType.source);
+
+    final Indent indent = Indent(sink);
     if (fileType == FileType.header) {
-      generateCppHeader(languageOptions.languageOptions, root, sink);
+      writeFilePrologue(generatorOptions, root, sink, indent);
+      generateCppHeader(generatorOptions.languageOptions, root, sink, indent);
     } else {
-      generateCppSource(languageOptions.languageOptions, root, sink);
+      writeFilePrologue(generatorOptions, root, sink, indent);
+      generateCppSource(generatorOptions.languageOptions, root, sink, indent);
+    }
+  }
+
+  @override
+  void writeFilePrologue(OutputFileOptions<CppOptions> generatorOptions,
+      Root root, StringSink sink, Indent indent) {
+    final FileType fileType = generatorOptions.fileType;
+    if (fileType == FileType.header) {
+      writeCppHeaderPrologue(
+          generatorOptions.languageOptions, root, sink, indent);
+    } else {
+      writeCppSourcePrologue(
+          generatorOptions.languageOptions, root, sink, indent);
     }
   }
 }
@@ -1049,18 +1066,23 @@ void _writeSystemHeaderIncludeBlock(Indent indent, List<String> headers) {
   }
 }
 
-/// Generates the ".h" file for the AST represented by [root] to [sink] with the
-/// provided [options] and [headerFileName].
-void generateCppHeader(CppOptions options, Root root, StringSink sink) {
-  final String? headerFileName = options.headerOutPath;
-  final Indent indent = Indent(sink);
+/// Writes Cpp header file header to sink.
+void writeCppHeaderPrologue(
+    CppOptions options, Root root, StringSink sink, Indent indent) {
   if (options.copyrightHeader != null) {
     addLines(indent, options.copyrightHeader!, linePrefix: '// ');
   }
   indent.writeln('$_commentPrefix $generatedCodeWarning');
   indent.writeln('$_commentPrefix $seeAlsoWarning');
   indent.addln('');
-  final String guardName = _getGuardName(headerFileName, options.namespace);
+}
+
+/// Generates the ".h" file for the AST represented by [root] to [sink] with the
+/// provided [options] and [headerFileName].
+void generateCppHeader(
+    CppOptions options, Root root, StringSink sink, Indent indent) {
+  final String guardName =
+      _getGuardName(options.headerIncludePath, options.namespace);
   indent.writeln('#ifndef $guardName');
   indent.writeln('#define $guardName');
 
@@ -1140,10 +1162,9 @@ void generateCppHeader(CppOptions options, Root root, StringSink sink) {
   indent.writeln('#endif  // $guardName');
 }
 
-/// Generates the ".cpp" file for the AST represented by [root] to [sink] with the
-/// provided [options].
-void generateCppSource(CppOptions options, Root root, StringSink sink) {
-  final Indent indent = Indent(sink);
+/// Writes Cpp source file header to sink.
+void writeCppSourcePrologue(
+    CppOptions options, Root root, StringSink sink, Indent indent) {
   if (options.copyrightHeader != null) {
     addLines(indent, options.copyrightHeader!, linePrefix: '// ');
   }
@@ -1152,7 +1173,12 @@ void generateCppSource(CppOptions options, Root root, StringSink sink) {
   indent.addln('');
   indent.addln('#undef _HAS_EXCEPTIONS');
   indent.addln('');
+}
 
+/// Generates the ".cpp" file for the AST represented by [root] to [sink] with the
+/// provided [options].
+void generateCppSource(
+    CppOptions options, Root root, StringSink sink, Indent indent) {
   indent.writeln('#include "${options.headerIncludePath}"');
   indent.addln('');
   _writeSystemHeaderIncludeBlock(indent, <String>[

packages/pigeon/lib/dart_generator.dart

@@ -77,20 +77,30 @@ class DartGenerator extends Generator<DartOptions> {
 
   /// Generates Dart files with specified [DartOptions]
   @override
-  void generate(DartOptions languageOptions, Root root, StringSink sink,
-      {FileType fileType = FileType.na}) {
-    assert(fileType == FileType.na);
-    generateDart(languageOptions, root, sink);
+  void generate(DartOptions generatorOptions, Root root, StringSink sink) {
+    final Indent indent = Indent(sink);
+
+    writeFilePrologue(generatorOptions, root, sink, indent);
+    generateDart(generatorOptions, root, sink, indent);
+  }
+
+  @override
+  void writeFilePrologue(
+      DartOptions generatorOptions, Root root, StringSink sink, Indent indent) {
+    writePrologue(generatorOptions, root, sink, indent);
   }
 
   /// Generates Dart files for testing with specified [DartOptions]
   void generateTest(DartOptions languageOptions, Root root, StringSink sink) {
+    final Indent indent = Indent(sink);
     final String sourceOutPath = languageOptions.sourceOutPath ?? '';
     final String testOutPath = languageOptions.testOutPath ?? '';
+    writeTestHeader(languageOptions, root, sink, indent);
     generateTestDart(
       languageOptions,
       root,
       sink,
+      indent,
       sourceOutPath: sourceOutPath,
       testOutPath: testOutPath,
     );
@@ -501,25 +511,26 @@ String _addGenericTypesNullable(TypeDeclaration type) {
   return type.isNullable ? '$genericdType?' : genericdType;
 }
 
+/// Writes file header to sink.
+void writePrologue(DartOptions opt, Root root, StringSink sink, Indent indent) {
+  if (opt.copyrightHeader != null) {
+    addLines(indent, opt.copyrightHeader!, linePrefix: '// ');
+  }
+  indent.writeln('// $generatedCodeWarning');
+  indent.writeln('// $seeAlsoWarning');
+  indent.writeln(
+    '// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import',
+  );
+  indent.addln('');
+}
+
 /// Generates Dart source code for the given AST represented by [root],
 /// outputting the code to [sink].
-void generateDart(DartOptions opt, Root root, StringSink sink) {
+void generateDart(DartOptions opt, Root root, StringSink sink, Indent indent) {
   final List<String> customClassNames =
       root.classes.map((Class x) => x.name).toList();
   final List<String> customEnumNames =
       root.enums.map((Enum x) => x.name).toList();
-  final Indent indent = Indent(sink);
-
-  void writeHeader() {
-    if (opt.copyrightHeader != null) {
-      addLines(indent, opt.copyrightHeader!, linePrefix: '// ');
-    }
-    indent.writeln('// $generatedCodeWarning');
-    indent.writeln('// $seeAlsoWarning');
-    indent.writeln(
-      '// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import',
-    );
-  }
 
   void writeEnums() {
     for (final Enum anEnum in root.enums) {
@@ -678,7 +689,6 @@ $resultAt != null
     }
   }
 
-  writeHeader();
   writeImports();
   writeEnums();
   for (final Class klass in root.classes) {
@@ -740,18 +750,9 @@ String _posixify(String inputPath) {
   return context.fromUri(path.toUri(path.absolute(inputPath)));
 }
 
-/// Generates Dart source code for test support libraries based on the given AST
-/// represented by [root], outputting the code to [sink]. [sourceOutPath] is the
-/// path of the generated dart code to be tested. [testOutPath] is where the
-/// test code will be generated.
-void generateTestDart(
-  DartOptions opt,
-  Root root,
-  StringSink sink, {
-  required String sourceOutPath,
-  required String testOutPath,
-}) {
-  final Indent indent = Indent(sink);
+/// Writes file header to sink.
+void writeTestHeader(
+    DartOptions opt, Root root, StringSink sink, Indent indent) {
   if (opt.copyrightHeader != null) {
     addLines(indent, opt.copyrightHeader!, linePrefix: '// ');
   }
@@ -761,6 +762,20 @@ void generateTestDart(
     '// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, unnecessary_import',
   );
   indent.writeln('// ignore_for_file: avoid_relative_lib_imports');
+}
+
+/// Generates Dart source code for test support libraries based on the given AST
+/// represented by [root], outputting the code to [sink]. [dartOutPath] is the
+/// path of the generated dart code to be tested. [testOutPath] is where the
+/// test code will be generated.
+void generateTestDart(
+  DartOptions opt,
+  Root root,
+  StringSink sink,
+  Indent indent, {
+  required String sourceOutPath,
+  required String testOutPath,
+}) {
   indent.writeln("import 'dart:async';");
   indent.writeln(
     "import 'dart:typed_data' show Float64List, Int32List, Int64List, Uint8List;",

packages/pigeon/lib/generator.dart

@@ -3,11 +3,29 @@
 // found in the LICENSE file.
 
 import 'ast.dart';
+import 'generator_tools.dart';
 
 /// A superclass of generator classes.
 ///
 /// This provides the structure that is common across generators for different languages.
 abstract class Generator<T> {
-  /// Generates files for specified language with specified [languageOptions]
-  void generate(T languageOptions, Root root, StringSink sink);
+  /// Generates files for specified language with specified [generatorOptions]
+  ///
+  /// This method, when overridden, should follow a generic structure that is currently:
+  /// 1. Create Indent
+  /// 2. Write File Headers
+  /// 3. Generate File
+  void generate(
+    T generatorOptions,
+    Root root,
+    StringSink sink,
+  );
+
+  /// Adds specified file headers.
+  void writeFilePrologue(
+    T generatorOptions,
+    Root root,
+    StringSink sink,
+    Indent indent,
+  );
 }

packages/pigeon/lib/generator_tools.dart

@@ -9,7 +9,7 @@ import 'dart:mirrors';
 import 'ast.dart';
 
 /// The current version of pigeon. This must match the version in pubspec.yaml.
-const String pigeonVersion = '5.0.0';
+const String pigeonVersion = '5.0.1';
 
 /// Read all the content from [stdin] to a String.
 String readStdin() {
@@ -510,7 +510,7 @@ enum FileType {
   na,
 }
 
-/// Options for [Generator]'s that have multiple output file types.
+/// Options for [Generator]s that have multiple output file types.
 ///
 /// Specifies which file to write as well as wraps all language options.
 class OutputFileOptions<T> {

packages/pigeon/lib/java_generator.dart

@@ -92,10 +92,17 @@ class JavaGenerator extends Generator<JavaOptions> {
 
   /// Generates Java files with specified [JavaOptions]
   @override
-  void generate(JavaOptions languageOptions, Root root, StringSink sink,
-      {FileType fileType = FileType.na}) {
-    assert(fileType == FileType.na);
-    generateJava(languageOptions, root, sink);
+  void generate(JavaOptions generatorOptions, Root root, StringSink sink) {
+    final Indent indent = Indent(sink);
+
+    writeFilePrologue(generatorOptions, root, sink, indent);
+    generateJava(generatorOptions, root, sink, indent);
+  }
+
+  @override
+  void writeFilePrologue(
+      JavaOptions generatorOptions, Root root, StringSink sink, Indent indent) {
+    writePrologue(generatorOptions, root, sink, indent);
   }
 }
 
@@ -536,22 +543,25 @@ String _castObject(
   }
 }
 
+/// Writes file header to sink.
+void writePrologue(
+    JavaOptions options, Root root, StringSink sink, Indent indent) {
+  if (options.copyrightHeader != null) {
+    addLines(indent, options.copyrightHeader!, linePrefix: '// ');
+  }
+  indent.writeln('// $generatedCodeWarning');
+  indent.writeln('// $seeAlsoWarning');
+  indent.addln('');
+}
+
 /// Generates the ".java" file for the AST represented by [root] to [sink] with the
 /// provided [options].
-void generateJava(JavaOptions options, Root root, StringSink sink) {
+void generateJava(
+    JavaOptions options, Root root, StringSink sink, Indent indent) {
   final Set<String> rootClassNameSet =
       root.classes.map((Class x) => x.name).toSet();
   final Set<String> rootEnumNameSet =
       root.enums.map((Enum x) => x.name).toSet();
-  final Indent indent = Indent(sink);
-
-  void writeHeader() {
-    if (options.copyrightHeader != null) {
-      addLines(indent, options.copyrightHeader!, linePrefix: '// ');
-    }
-    indent.writeln('// $generatedCodeWarning');
-    indent.writeln('// $seeAlsoWarning');
-  }
 
   void writeImports() {
     indent.writeln('import android.util.Log;');
@@ -766,8 +776,6 @@ void generateJava(JavaOptions options, Root root, StringSink sink) {
 }''');
   }
 
-  writeHeader();
-  indent.addln('');
   if (options.package != null) {
     indent.writeln('package ${options.package};');
   }