[pigeon] writeEnum method added to Generator class

packages/pigeon/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 5.0.3
+
+* Adds writeEnum method to Generator classes.
+
+## 5.0.2
+
+* Adds writeImports method to Generator classes.
+
+## 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,63 @@ 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);
+    writeFilePrologue(generatorOptions, root, sink, indent);
+    writeFileImports(generatorOptions, root, sink, indent);
+
+    for (final Enum anEnum in root.enums) {
+      writeEnum(generatorOptions, root, sink, indent, anEnum);
+    }
+
+    indent.addln('');
+
+    if (fileType == FileType.header) {
+      generateCppHeader(generatorOptions.languageOptions, root, sink, indent);
+    } else {
+      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);
+    }
+  }
+
+  @override
+  void writeFileImports(OutputFileOptions<CppOptions> generatorOptions,
+      Root root, StringSink sink, Indent indent) {
+    final FileType fileType = generatorOptions.fileType;
     if (fileType == FileType.header) {
-      generateCppHeader(languageOptions.languageOptions, root, sink);
+      writeCppHeaderImports(
+          generatorOptions.languageOptions, root, sink, indent);
     } else {
-      generateCppSource(languageOptions.languageOptions, root, sink);
+      writeCppSourceImports(
+          generatorOptions.languageOptions, root, sink, indent);
+    }
+  }
+
+  @override
+  void writeEnum(OutputFileOptions<CppOptions> generatorOptions, Root root,
+      StringSink sink, Indent indent, Enum anEnum) {
+    final FileType fileType = generatorOptions.fileType;
+    if (fileType == FileType.header) {
+      writeCppHeaderEnum(
+          generatorOptions.languageOptions, root, sink, indent, anEnum);
     }
   }
 }
@@ -1049,18 +1096,22 @@ 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);
+}
+
+/// Writes Cpp header file imports to sink.
+void writeCppHeaderImports(
+    CppOptions options, Root root, StringSink sink, Indent indent) {
+  final String guardName =
+      _getGuardName(options.headerIncludePath, options.namespace);
   indent.writeln('#ifndef $guardName');
   indent.writeln('#define $guardName');
 
@@ -1077,40 +1128,48 @@ void generateCppHeader(CppOptions options, Root root, StringSink sink) {
     'optional',
   ]);
   indent.addln('');
-
   if (options.namespace != null) {
     indent.writeln('namespace ${options.namespace} {');
   }
-
-  // When generating for a Pigeon unit test, add a test fixture friend class to
-  // allow unit testing private methods, since testing serialization via public
-  // methods is essentially an end-to-end test.
-  String? testFixtureClass;
+  indent.addln('');
   if (options.namespace?.endsWith('_pigeontest') ?? false) {
-    testFixtureClass =
+    final String testFixtureClass =
         '${_pascalCaseFromSnakeCase(options.namespace!.replaceAll('_pigeontest', ''))}Test';
     indent.writeln('class $testFixtureClass;');
   }
-
   indent.addln('');
   indent.writeln('$_commentPrefix Generated class from Pigeon.');
+}
 
-  for (final Enum anEnum in root.enums) {
-    indent.writeln('');
-    addDocumentationComments(
-        indent, anEnum.documentationComments, _docCommentSpec);
-    indent.write('enum class ${anEnum.name} ');
-    indent.scoped('{', '};', () {
-      enumerate(anEnum.members, (int index, final EnumMember member) {
-        addDocumentationComments(
-            indent, member.documentationComments, _docCommentSpec);
-        indent.writeln(
-            '${member.name} = $index${index == anEnum.members.length - 1 ? '' : ','}');
-      });
+/// Writes Cpp header enum to sink.
+void writeCppHeaderEnum(CppOptions options, Root root, StringSink sink,
+    Indent indent, Enum anEnum) {
+  indent.writeln('');
+  addDocumentationComments(
+      indent, anEnum.documentationComments, _docCommentSpec);
+  indent.write('enum class ${anEnum.name} ');
+  indent.scoped('{', '};', () {
+    enumerate(anEnum.members, (int index, final EnumMember member) {
+      addDocumentationComments(
+          indent, member.documentationComments, _docCommentSpec);
+      indent.writeln(
+          '${member.name} = $index${index == anEnum.members.length - 1 ? '' : ','}');
     });
-  }
+  });
+}
 
-  indent.addln('');
+/// 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) {
+  // When generating for a Pigeon unit test, add a test fixture friend class to
+  // allow unit testing private methods, since testing serialization via public
+  // methods is essentially an end-to-end test.
+  String? testFixtureClass;
+  if (options.namespace?.endsWith('_pigeontest') ?? false) {
+    testFixtureClass =
+        '${_pascalCaseFromSnakeCase(options.namespace!.replaceAll('_pigeontest', ''))}Test';
+  }
 
   _writeErrorOr(indent, friends: root.apis.map((Api api) => api.name));
 
@@ -1136,14 +1195,14 @@ void generateCppHeader(CppOptions options, Root root, StringSink sink) {
   if (options.namespace != null) {
     indent.writeln('}  // namespace ${options.namespace}');
   }
-
+  final String guardName =
+      _getGuardName(options.headerIncludePath, options.namespace);
   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 +1211,11 @@ void generateCppSource(CppOptions options, Root root, StringSink sink) {
   indent.addln('');
   indent.addln('#undef _HAS_EXCEPTIONS');
   indent.addln('');
+}
 
+/// Writes Cpp source file imports to sink.
+void writeCppSourceImports(
+    CppOptions options, Root root, StringSink sink, Indent indent) {
   indent.writeln('#include "${options.headerIncludePath}"');
   indent.addln('');
   _writeSystemHeaderIncludeBlock(indent, <String>[
@@ -1172,7 +1235,12 @@ void generateCppSource(CppOptions options, Root root, StringSink sink) {
   if (options.namespace != null) {
     indent.writeln('namespace ${options.namespace} {');
   }
+}
 
+/// 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) {
   for (final Class klass in root.classes) {
     _writeDataClassImplementation(indent, klass, root);
   }