[pigeon] adds Internal options (flutter#8709)

Separates the user facing options from the internal use of options to avoid exposing settings we don't need the users to access. fixes flutter/flutter#161634

Also adds option to prevent merging of pigeon definition file options. fixes flutter/flutter#163159

Also removes injection of overflow members for testing from public facing api surface.

Author: tarrinneal

packages/pigeon/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 25.0.0
+
+* **Breaking Change** Removes `oneLanguage` field from `PigeonOptions`.
+* Separates internal options classes from user facing options.
+* Adds `mergeDefinitionFileOptions` parameter to `runWithOptions` method.
+* Relocates `injectOverflowTypes` to non-public facing method.
+
 ## 24.2.2
 
 * Updates compileSdk 34 to flutter.compileSdkVersion.

packages/pigeon/lib/src/cpp/cpp_generator.dart

@@ -2,11 +2,13 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'package:path/path.dart' as path;
+
 import '../ast.dart';
 import '../functional.dart';
 import '../generator.dart';
 import '../generator_tools.dart';
-import '../pigeon_lib.dart' show Error;
+import '../pigeon_lib.dart';
 
 /// General comment opening token.
 const String _commentPrefix = '//';
@@ -51,7 +53,7 @@ class CppOptions {
     this.headerOutPath,
   });
 
-  /// The path to the header that will get placed in the source filed (example:
+  /// The path to the header that will get placed in the source file (example:
   /// "foo.h").
   final String? headerIncludePath;
 
@@ -93,15 +95,61 @@ class CppOptions {
   }
 }
 
+/// Options that control how C++ code will be generated.
+///
+/// For internal use only.
+class InternalCppOptions {
+  /// Creates a [InternalCppOptions] object.
+  const InternalCppOptions({
+    required this.headerIncludePath,
+    required this.cppHeaderOut,
+    required this.cppSourceOut,
+    this.namespace,
+    this.copyrightHeader,
+    this.headerOutPath,
+  });
+
+  /// Creates InternalCppOptions from CppOptions.
+  InternalCppOptions.fromCppOptions(
+    CppOptions options, {
+    required this.cppHeaderOut,
+    required this.cppSourceOut,
+    Iterable<String>? copyrightHeader,
+  })  : headerIncludePath =
+            options.headerIncludePath ?? path.basename(cppHeaderOut),
+        namespace = options.namespace,
+        copyrightHeader = options.copyrightHeader ?? copyrightHeader,
+        headerOutPath = options.headerOutPath;
+
+  /// The path to the header that will get placed in the source file (example:
+  /// "foo.h").
+  final String headerIncludePath;
+
+  /// Path to the ".h" C++ file that will be generated.
+  final String cppHeaderOut;
+
+  /// Path to the ".cpp" C++ file that will be generated.
+  final String cppSourceOut;
+
+  /// The namespace where the generated class will live.
+  final String? namespace;
+
+  /// A copyright header that will get prepended to generated code.
+  final Iterable<String>? copyrightHeader;
+
+  /// The path to the output header file location.
+  final String? headerOutPath;
+}
+
 /// Class that manages all Cpp code generation.
-class CppGenerator extends Generator<OutputFileOptions<CppOptions>> {
+class CppGenerator extends Generator<OutputFileOptions<InternalCppOptions>> {
   /// Constructor.
   const CppGenerator();
 
   /// Generates C++ file of type specified in [generatorOptions]
   @override
   void generate(
-    OutputFileOptions<CppOptions> generatorOptions,
+    OutputFileOptions<InternalCppOptions> generatorOptions,
     Root root,
     StringSink sink, {
     required String dartPackageName,
@@ -127,13 +175,13 @@ class CppGenerator extends Generator<OutputFileOptions<CppOptions>> {
 }
 
 /// Writes C++ header (.h) file to sink.
-class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
+class CppHeaderGenerator extends StructuredGenerator<InternalCppOptions> {
   /// Constructor.
   const CppHeaderGenerator();
 
   @override
   void writeFilePrologue(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -148,7 +196,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeFileImports(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -185,7 +233,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeEnum(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     Enum anEnum, {
@@ -208,7 +256,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeGeneralUtilities(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -226,7 +274,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeDataClasses(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -252,7 +300,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeDataClass(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     Class classDefinition, {
@@ -399,7 +447,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeGeneralCodec(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -443,7 +491,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeFlutterApi(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     AstFlutterApi api, {
@@ -498,7 +546,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeHostApi(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     AstHostApi api, {
@@ -660,7 +708,7 @@ $friendLines
 
   @override
   void writeCloseNamespace(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -674,13 +722,13 @@ $friendLines
 }
 
 /// Writes C++ source (.cpp) file to sink.
-class CppSourceGenerator extends StructuredGenerator<CppOptions> {
+class CppSourceGenerator extends StructuredGenerator<InternalCppOptions> {
   /// Constructor.
   const CppSourceGenerator();
 
   @override
   void writeFilePrologue(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -697,7 +745,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeFileImports(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -721,7 +769,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeOpenNamespace(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -733,7 +781,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeGeneralUtilities(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -763,7 +811,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeDataClass(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     Class classDefinition, {
@@ -817,7 +865,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeClassEncode(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     Class classDefinition, {
@@ -848,7 +896,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
 
   @override
   void writeClassDecode(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     Class classDefinition, {
@@ -919,7 +967,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
   }
 
   void _writeCodecOverflowUtilities(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     List<EnumeratedType> types, {
@@ -986,7 +1034,7 @@ EncodableValue $_overflowClassName::FromEncodableList(
 
   @override
   void writeGeneralCodec(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -1081,7 +1129,7 @@ EncodableValue $_overflowClassName::FromEncodableList(
 
   @override
   void writeFlutterApi(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     AstFlutterApi api, {
@@ -1215,7 +1263,7 @@ EncodableValue $_overflowClassName::FromEncodableList(
 
   @override
   void writeHostApi(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent,
     AstHostApi api, {
@@ -1439,7 +1487,7 @@ return EncodableValue(EncodableList{
     });
   }
 
-  void _writeCppSourceClassField(CppOptions generatorOptions, Root root,
+  void _writeCppSourceClassField(InternalCppOptions generatorOptions, Root root,
       Indent indent, Class classDefinition, NamedType field) {
     final HostDatatype hostDatatype =
         getFieldHostDatatype(field, _shortBaseCppTypeForBuiltinDartType);
@@ -1570,7 +1618,7 @@ ${prefix}reply(EncodableValue(std::move(wrapped)));''';
 
   @override
   void writeCloseNamespace(
-    CppOptions generatorOptions,
+    InternalCppOptions generatorOptions,
     Root root,
     Indent indent, {
     required String dartPackageName,
@@ -2085,7 +2133,7 @@ void _writeAccessBlock(
 }
 
 /// Validates an AST to make sure the cpp generator supports everything.
-List<Error> validateCpp(CppOptions options, Root root) {
+List<Error> validateCpp(InternalCppOptions options, Root root) {
   final List<Error> result = <Error>[];
   for (final Api api in root.apis) {
     for (final Method method in api.methods) {