[pigeon] Creates new Generator classes for each language

packages/pigeon/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.2.16
+
+* Creates new Generator classes for each language.
+
 ## 4.2.15
 
 * Relocates generator classes. (Reverted)

packages/pigeon/lib/cpp_generator.dart

@@ -4,6 +4,7 @@
 
 import 'ast.dart';
 import 'functional.dart';
+import 'generator.dart';
 import 'generator_tools.dart';
 import 'pigeon_lib.dart' show Error;
 
@@ -20,11 +21,8 @@ const String _defaultCodecSerializer = 'flutter::StandardCodecSerializer';
 /// Options that control how C++ code will be generated.
 class CppOptions {
   /// Creates a [CppOptions] object
-  const CppOptions({
-    this.header,
-    this.namespace,
-    this.copyrightHeader,
-  });
+  const CppOptions(
+      {this.header, this.namespace, this.copyrightHeader, this.cppHeaderOut});
 
   /// The path to the header that will get placed in the source filed (example:
   /// "foo.h").
@@ -36,14 +34,17 @@ class CppOptions {
   /// A copyright header that will get prepended to generated code.
   final Iterable<String>? copyrightHeader;
 
+  ///
+  final String? cppHeaderOut;
+
   /// Creates a [CppOptions] from a Map representation where:
   /// `x = CppOptions.fromMap(x.toMap())`.
   static CppOptions fromMap(Map<String, Object> map) {
     return CppOptions(
-      header: map['header'] as String?,
-      namespace: map['namespace'] as String?,
-      copyrightHeader: map['copyrightHeader'] as Iterable<String>?,
-    );
+        header: map['header'] as String?,
+        namespace: map['namespace'] as String?,
+        copyrightHeader: map['copyrightHeader'] as Iterable<String>?,
+        cppHeaderOut: map['cppHeaderOut'] as String?);
   }
 
   /// Converts a [CppOptions] to a Map representation where:
@@ -64,6 +65,31 @@ class CppOptions {
   }
 }
 
+/// Class that manages all Cpp header code generation.
+class CppHeaderGenerator extends Generator<CppOptions> {
+  /// Instantiates a Cpp Generator.
+  CppHeaderGenerator();
+
+  /// Generates Cpp header files with specified [CppOptions]
+  @override
+  void generate(CppOptions languageOptions, Root root, StringSink sink) {
+    generateCppHeader(
+        languageOptions.cppHeaderOut, languageOptions, root, sink);
+  }
+}
+
+/// Class that manages all Cpp code generation.
+class CppSourceGenerator extends Generator<CppOptions> {
+  /// Instantiates a Cpp Generator.
+  CppSourceGenerator();
+
+  /// Generates Cpp files with specified [CppOptions]
+  @override
+  void generate(CppOptions languageOptions, Root root, StringSink sink) {
+    generateCppSource(languageOptions, root, sink);
+  }
+}
+
 String _getCodecSerializerName(Api api) => '${api.name}CodecSerializer';
 
 const String _pointerPrefix = 'pointer';

packages/pigeon/lib/dart_generator.dart

@@ -9,6 +9,7 @@ import 'package:yaml/yaml.dart' as yaml;
 
 import 'ast.dart';
 import 'functional.dart';
+import 'generator.dart';
 import 'generator_tools.dart';
 
 /// Documentation comment open symbol.
@@ -24,18 +25,30 @@ const String _standardMessageCodec = 'StandardMessageCodec';
 /// Options that control how Dart code will be generated.
 class DartOptions {
   /// Constructor for DartOptions.
-  const DartOptions({this.copyrightHeader});
+  DartOptions({
+    this.copyrightHeader,
+    this.dartOutPath,
+    this.testOutPath,
+  });
 
   /// A copyright header that will get prepended to generated code.
   final Iterable<String>? copyrightHeader;
 
+  /// Path to output generated Dart file for tests.
+  String? dartOutPath;
+
+  /// Path to output generated Test file for tests.
+  String? testOutPath;
+
   /// Creates a [DartOptions] from a Map representation where:
   /// `x = DartOptions.fromMap(x.toMap())`.
   static DartOptions fromMap(Map<String, Object> map) {
     final Iterable<dynamic>? copyrightHeader =
         map['copyrightHeader'] as Iterable<dynamic>?;
     return DartOptions(
       copyrightHeader: copyrightHeader?.cast<String>(),
+      dartOutPath: map['dartOutPath'] as String?,
+      testOutPath: map['testOutPath'] as String?,
     );
   }
 
@@ -44,6 +57,8 @@ class DartOptions {
   Map<String, Object> toMap() {
     final Map<String, Object> result = <String, Object>{
       if (copyrightHeader != null) 'copyrightHeader': copyrightHeader!,
+      if (dartOutPath != null) 'dartOutPath': dartOutPath!,
+      if (testOutPath != null) 'testOutPath': testOutPath!,
     };
     return result;
   }
@@ -55,6 +70,38 @@ class DartOptions {
   }
 }
 
+/// Class that manages all Dart code generation.
+class DartGenerator extends Generator<DartOptions> {
+  /// Instantiates a Dart Generator.
+  DartGenerator();
+
+  /// Generates Dart files with specified [DartOptions]
+  @override
+  void generate(DartOptions languageOptions, Root root, StringSink sink) {
+    generateDart(languageOptions, root, sink);
+  }
+}
+
+/// Class that manages all Dart code generation.
+class DartTestGenerator extends Generator<DartOptions> {
+  /// Instantiates a Dart Generator.
+  DartTestGenerator();
+
+  /// Generates Dart files with specified [DartOptions]
+  @override
+  void generate(DartOptions languageOptions, Root root, StringSink sink) {
+    final String dartOutPath = languageOptions.dartOutPath ?? '';
+    final String testOutPath = languageOptions.testOutPath ?? '';
+    generateTestDart(
+      languageOptions,
+      root,
+      sink,
+      dartOutPath: dartOutPath,
+      testOutPath: testOutPath,
+    );
+  }
+}
+
 String _escapeForDartSingleQuotedString(String raw) {
   return raw
       .replaceAll(r'\', r'\\')

packages/pigeon/lib/generator.dart

@@ -0,0 +1,16 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'ast.dart';
+
+/// A Super class of generator classes.
+///
+/// This is meant to provide structure and direction for future generator work.
+abstract class Generator<T> {
+  /// Instantiates a Generator.
+  const Generator();
+
+  /// Generates files for specified language with specified [languageOptions]
+  void generate(T languageOptions, Root root, StringSink sink);
+}

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 = '4.2.15';
+const String pigeonVersion = '4.2.16';
 
 /// Read all the content from [stdin] to a String.
 String readStdin() {

packages/pigeon/lib/java_generator.dart

@@ -4,6 +4,7 @@
 
 import 'ast.dart';
 import 'functional.dart';
+import 'generator.dart';
 import 'generator_tools.dart';
 import 'pigeon_lib.dart' show TaskQueueType;
 
@@ -84,6 +85,18 @@ class JavaOptions {
   }
 }
 
+/// Class that manages all Java code generation.
+class JavaGenerator extends Generator<JavaOptions> {
+  /// Instantiates a Java Generator.
+  JavaGenerator();
+
+  /// Generates Java files with specified [JavaOptions]
+  @override
+  void generate(JavaOptions languageOptions, Root root, StringSink sink) {
+    generateJava(languageOptions, root, sink);
+  }
+}
+
 /// Calculates the name of the codec that will be generated for [api].
 String _getCodecName(Api api) => '${api.name}Codec';
 

packages/pigeon/lib/kotlin_generator.dart

@@ -4,6 +4,7 @@
 
 import 'ast.dart';
 import 'functional.dart';
+import 'generator.dart';
 import 'generator_tools.dart';
 import 'pigeon_lib.dart' show TaskQueueType;
 
@@ -64,6 +65,18 @@ class KotlinOptions {
   }
 }
 
+/// Class that manages all Kotlin code generation.
+class KotlinGenerator extends Generator<KotlinOptions> {
+  /// Instantiates a Kotlin Generator.
+  KotlinGenerator();
+
+  /// Generates Kotlin files with specified [KotlinOptions]
+  @override
+  void generate(KotlinOptions languageOptions, Root root, StringSink sink) {
+    generateKotlin(languageOptions, root, sink);
+  }
+}
+
 /// Calculates the name of the codec that will be generated for [api].
 String _getCodecName(Api api) => '${api.name}Codec';
 

packages/pigeon/lib/objc_generator.dart

@@ -4,6 +4,7 @@
 
 import 'ast.dart';
 import 'functional.dart';
+import 'generator.dart';
 import 'generator_tools.dart';
 import 'pigeon_lib.dart' show Error, TaskQueueType;
 
@@ -63,6 +64,30 @@ class ObjcOptions {
   }
 }
 
+/// Class that manages all Objc header code generation.
+class ObjcHeaderGenerator extends Generator<ObjcOptions> {
+  /// Instantiates a Objc Generator.
+  ObjcHeaderGenerator();
+
+  /// Generates Objc header files with specified [ObjcOptions]
+  @override
+  void generate(ObjcOptions languageOptions, Root root, StringSink sink) {
+    generateObjcHeader(languageOptions, root, sink);
+  }
+}
+
+/// Class that manages all Objc code generation.
+class ObjcSourceGenerator extends Generator<ObjcOptions> {
+  /// Instantiates a Objc Generator.
+  ObjcSourceGenerator();
+
+  /// Generates Objc files with specified [ObjcOptions]
+  @override
+  void generate(ObjcOptions languageOptions, Root root, StringSink sink) {
+    generateObjcSource(languageOptions, root, sink);
+  }
+}
+
 /// Calculates the ObjC class name, possibly prefixed.
 String _className(String? prefix, String className) {
   if (prefix != null) {