update merging logic, relocate overflow class injection, add test

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

@@ -2,6 +2,8 @@
 // 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';
@@ -113,7 +115,8 @@ class InternalCppOptions {
     this.cppHeaderOut,
     this.cppSourceOut,
     Iterable<String>? copyrightHeader,
-  })  : headerIncludePath = options.headerIncludePath,
+  })  : headerIncludePath =
+            options.headerIncludePath ?? path.basename(cppHeaderOut!),
         namespace = options.namespace,
         copyrightHeader = options.copyrightHeader ?? copyrightHeader,
         headerOutPath = options.headerOutPath;

packages/pigeon/lib/src/gobject/gobject_generator.dart

@@ -2,6 +2,8 @@
 // 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 '../generator.dart';
 import '../generator_tools.dart';
@@ -89,7 +91,8 @@ class InternalGObjectOptions {
     this.gobjectHeaderOut,
     this.gobjectSourceOut,
     Iterable<String>? copyrightHeader,
-  })  : headerIncludePath = options.headerIncludePath,
+  })  : headerIncludePath =
+            options.headerIncludePath ?? path.basename(gobjectHeaderOut!),
         module = options.module,
         copyrightHeader = options.copyrightHeader ?? copyrightHeader,
         headerOutPath = options.headerOutPath;

packages/pigeon/lib/src/objc/objc_generator.dart

@@ -2,6 +2,8 @@
 // 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';
@@ -110,7 +112,8 @@ class InternalObjcOptions {
     this.objcSourceOut,
     String? fileSpecificClassNameComponent,
     Iterable<String>? copyrightHeader,
-  })  : headerIncludePath = options.headerIncludePath,
+  })  : headerIncludePath =
+            options.headerIncludePath ?? path.basename(objcHeaderOut!),
         prefix = options.prefix,
         copyrightHeader = options.copyrightHeader ?? copyrightHeader,
         fileSpecificClassNameComponent =

packages/pigeon/lib/src/pigeon_lib.dart

@@ -22,6 +22,7 @@ import 'package:analyzer/dart/ast/visitor.dart' as dart_ast_visitor;
 import 'package:analyzer/error/error.dart' show AnalysisError;
 import 'package:args/args.dart';
 import 'package:collection/collection.dart' as collection;
+import 'package:meta/meta.dart' show visibleForTesting;
 import 'package:path/path.dart' as path;
 import 'package:pub_semver/pub_semver.dart';
 
@@ -2677,8 +2678,8 @@ ${_argParser.usage}''';
     PigeonOptions options, {
     List<GeneratorAdapter>? adapters,
     String? sdkPath,
-    bool injectOverflowTypes = false,
     bool mergeDefinitionFileOptions = true,
+    @visibleForTesting ParseResults? parseResults,
   }) async {
     final Pigeon pigeon = Pigeon.setup();
     if (options.debugGenerators ?? false) {
@@ -2703,21 +2704,8 @@ ${_argParser.usage}''';
       return 0;
     }
 
-    final ParseResults parseResults =
-        pigeon.parseFile(options.input!, sdkPath: sdkPath);
-
-    if (injectOverflowTypes) {
-      final List<Enum> addedEnums = List<Enum>.generate(
-        totalCustomCodecKeysAllowed - 1,
-        (final int tag) {
-          return Enum(
-              name: 'FillerEnum$tag',
-              members: <EnumMember>[EnumMember(name: 'FillerMember$tag')]);
-        },
-      );
-      addedEnums.addAll(parseResults.root.enums);
-      parseResults.root.enums = addedEnums;
-    }
+    parseResults =
+        parseResults ?? pigeon.parseFile(options.input!, sdkPath: sdkPath);
 
     final List<Error> errors = <Error>[];
     errors.addAll(parseResults.errors);
@@ -2734,37 +2722,10 @@ ${_argParser.usage}''';
           mergeMaps(options.toMap(), parseResults.pigeonOptions!));
     }
 
-    if (options.objcHeaderOut != null) {
-      options = options.merge(PigeonOptions(
-          objcOptions: (options.objcOptions ?? const ObjcOptions()).merge(
-              ObjcOptions(
-                  headerIncludePath: options.objcOptions?.headerIncludePath ??
-                      path.basename(options.objcHeaderOut!)))));
-    }
-
-    if (options.cppHeaderOut != null) {
-      options = options.merge(PigeonOptions(
-          cppOptions: (options.cppOptions ?? const CppOptions()).merge(
-              CppOptions(
-                  headerIncludePath: options.cppOptions?.headerIncludePath ??
-                      path.basename(options.cppHeaderOut!)))));
-    }
-
-    if (options.gobjectHeaderOut != null) {
-      options = options.merge(PigeonOptions(
-          gobjectOptions: (options.gobjectOptions ?? const GObjectOptions())
-              .merge(GObjectOptions(
-                  headerIncludePath:
-                      path.basename(options.gobjectHeaderOut!)))));
-    }
-
     final InternalPigeonOptions internalOptions =
         InternalPigeonOptions.fromPigeonOptions(options);
 
     for (final GeneratorAdapter adapter in safeGeneratorAdapters) {
-      if (injectOverflowTypes && adapter is GObjectGeneratorAdapter) {
-        continue;
-      }
       final IOSink? sink =
           adapter.shouldGenerate(internalOptions, FileType.source);
       if (sink != null) {

packages/pigeon/pigeons/enum.dart

@@ -5,7 +5,8 @@
 import 'package:pigeon/pigeon.dart';
 
 @ConfigurePigeon(PigeonOptions(
-  objcOptions: ObjcOptions(prefix: 'PGN'),
+  // This is here to test option merging.
+  objcOptions: ObjcOptions(prefix: 'ThisShouldntEndUpInTheOutput'),
 ))
 
 /// This comment is to test enum documentation comments.

packages/pigeon/test/pigeon_lib_test.dart

@@ -1376,7 +1376,7 @@ abstract class Api {
     await completer.future;
   });
 
-  test('run with InternalPigeonOptions', () async {
+  test('run with PigeonOptions', () async {
     final Completer<void> completer = Completer<void>();
     withTempFile('foo.dart', (File input) async {
       final _ValidatorGeneratorAdapter generator =

packages/pigeon/tool/shared/generation.dart

@@ -6,6 +6,7 @@ import 'dart:io' show Platform;
 
 import 'package:path/path.dart' as p;
 import 'package:pigeon/pigeon.dart';
+import 'package:pigeon/src/ast.dart';
 import 'package:pigeon/src/generator_tools.dart';
 
 import 'process_utils.dart';
@@ -204,10 +205,15 @@ Future<int> generateTestPigeons(
       objcSourceOut: skipLanguages.contains(GeneratorLanguage.objc)
           ? null
           : '$alternateOutputBase/ios/Classes/$pascalCaseName.gen.m',
-      objcPrefix: input == 'core_tests' ? 'FLT' : '',
+      objcPrefix: input == 'core_tests'
+          ? 'FLT'
+          : input == 'enum'
+              ? 'PGN'
+              : '',
       suppressVersion: true,
       dartPackageName: 'pigeon_integration_tests',
       injectOverflowTypes: includeOverflow && input == 'core_tests',
+      mergeDefinitionFileOptions: input != 'enum',
     );
     if (generateCode != 0) {
       return generateCode;
@@ -224,10 +230,15 @@ Future<int> generateTestPigeons(
       objcSourceOut: skipLanguages.contains(GeneratorLanguage.objc)
           ? null
           : '$alternateOutputBase/macos/Classes/$pascalCaseName.gen.m',
-      objcPrefix: input == 'core_tests' ? 'FLT' : '',
+      objcPrefix: input == 'core_tests'
+          ? 'FLT'
+          : input == 'enum'
+              ? 'PGN'
+              : '',
       suppressVersion: true,
       dartPackageName: 'pigeon_integration_tests',
       injectOverflowTypes: includeOverflow && input == 'core_tests',
+      mergeDefinitionFileOptions: input != 'enum',
     );
     if (generateCode != 0) {
       return generateCode;
@@ -263,6 +274,7 @@ Future<int> runPigeon({
   String? basePath,
   String? dartPackageName,
   bool injectOverflowTypes = false,
+  bool mergeDefinitionFileOptions = true,
 }) async {
   // Temporarily suppress the version output via the global flag if requested.
   // This is done because having the version in all the generated test output
@@ -276,6 +288,22 @@ Future<int> runPigeon({
   if (suppressVersion) {
     includeVersionInGeneratedWarning = false;
   }
+
+  // parse results in advance when overflow is included to avoid exposing as public option
+  final ParseResults parseResults = Pigeon().parseFile(input);
+  if (injectOverflowTypes) {
+    final List<Enum> addedEnums = List<Enum>.generate(
+      totalCustomCodecKeysAllowed - 1,
+      (final int tag) {
+        return Enum(
+            name: 'FillerEnum$tag',
+            members: <EnumMember>[EnumMember(name: 'FillerMember$tag')]);
+      },
+    );
+    addedEnums.addAll(parseResults.root.enums);
+    parseResults.root.enums = addedEnums;
+  }
+
   final int result = await Pigeon.runWithOptions(
     PigeonOptions(
       input: input,
@@ -286,9 +314,10 @@ Future<int> runPigeon({
       cppHeaderOut: cppHeaderOut,
       cppSourceOut: cppSourceOut,
       cppOptions: CppOptions(namespace: cppNamespace),
-      gobjectHeaderOut: gobjectHeaderOut,
-      gobjectSourceOut: gobjectSourceOut,
-      gobjectOptions: GObjectOptions(module: gobjectModule),
+      gobjectHeaderOut: injectOverflowTypes ? null : gobjectHeaderOut,
+      gobjectSourceOut: injectOverflowTypes ? null : gobjectSourceOut,
+      gobjectOptions:
+          injectOverflowTypes ? null : GObjectOptions(module: gobjectModule),
       javaOut: javaOut,
       javaOptions: JavaOptions(package: javaPackage),
       kotlinOut: kotlinOut,
@@ -308,7 +337,9 @@ Future<int> runPigeon({
       basePath: basePath,
       dartPackageName: dartPackageName,
     ),
-    injectOverflowTypes: injectOverflowTypes,
+    // ignore: invalid_use_of_visible_for_testing_member
+    parseResults: injectOverflowTypes ? parseResults : null,
+    mergeDefinitionFileOptions: mergeDefinitionFileOptions,
   );
   includeVersionInGeneratedWarning = originalWarningSetting;
   return result;