relative paths and appDir comments

Author: tarrinneal

packages/pigeon/lib/src/kotlin/jnigen_config_generator.dart

@@ -59,6 +59,7 @@ class JnigenConfigGenerator extends Generator<InternalJnigenConfigOptions> {
             summarizerOptions: SummarizerOptions(backend: SummarizerBackend.asm),
             outputConfig: OutputConfig(
               dartConfig: DartCodeOutputConfig(
+                // Path is relative to appDirectory.
                 path: Uri.file('${path.relative(path.withoutExtension(generatorOptions.dartOptions.dartOut ?? './lib/pigeons/'), from: generatorOptions.appDirectory ?? './')}.jni.dart'),
               structure: OutputStructure.singleFile,
             ),

packages/pigeon/lib/src/kotlin/kotlin_generator.dart

@@ -62,7 +62,9 @@ class KotlinOptions {
   /// Whether to use Jni when possible.
   final bool useJni;
 
-  /// The directory that the app exists in, this is required for Jni APIs.
+  /// The directory that the app exists in.
+  ///
+  /// Defaults to './' if not specified.
   final String? appDirectory;
 
   /// The name of the error class used for passing custom error parameters.

packages/pigeon/lib/src/pigeon_lib_internal.dart

@@ -573,7 +573,7 @@ class FfigenConfigGeneratorAdapter implements GeneratorAdapter {
       swiftOptions,
       options.basePath,
       dartOptions.dartOut,
-      swiftOptions.swiftOut,
+      options.appDirectory,
     );
 
     generator.generate(
@@ -586,11 +586,11 @@ class FfigenConfigGeneratorAdapter implements GeneratorAdapter {
 
   @override
   IOSink? shouldGenerate(InternalPigeonOptions options, FileType _) =>
-      options.swiftOptions?.appDirectory != null &&
-          (options.swiftOptions?.useFfi ?? false)
+      (options.swiftOptions?.useFfi ?? false)
       ? _openSink(
           'ffigen_config.dart',
-          basePath: options.swiftOptions?.appDirectory ?? '',
+          basePath:
+              options.swiftOptions?.appDirectory ?? options.appDirectory ?? '',
         )
       : null;
 
@@ -809,7 +809,11 @@ class JnigenConfigGeneratorAdapter implements GeneratorAdapter {
   IOSink? shouldGenerate(InternalPigeonOptions options, FileType _) =>
       options.kotlinOptions?.kotlinOut != null &&
           (options.kotlinOptions?.useJni ?? false)
-      ? _openSink('jnigen_config.dart', basePath: options.appDirectory ?? '')
+      ? _openSink(
+          'jnigen_config.dart',
+          basePath:
+              options.kotlinOptions?.appDirectory ?? options.appDirectory ?? '',
+        )
       : null;
 
   @override

packages/pigeon/lib/src/swift/ffigen_config_generator.dart

@@ -156,15 +156,16 @@ import 'package:swiftgen/swiftgen.dart';
       ),
     ),
     inputs: <SwiftGenInput>[ObjCCompatibleSwiftFileInput(files: <Uri>[
-        Uri.file('${generatorOptions.swiftOptions.swiftOut}')
+        Uri.file('${path.relative(generatorOptions.swiftOptions.swiftOut, from: generatorOptions.exampleAppDirectory ?? './')}')
       ])
     ],
     include: (Declaration d) =>
         classes.contains(d.name) || enums.contains(d.name),
     output: Output(
       module: '${generatorOptions.swiftOptions.ffiModuleName ?? ''}',
-      dartFile: Uri.file('${path.posix.join(generatorOptions.basePath ?? '', path.withoutExtension(generatorOptions.dartOut ?? ''))}.ffi.dart'),
-      objectiveCFile: Uri.file('${path.posix.join(objcDir, '${path.posix.basenameWithoutExtension(generatorOptions.swiftOptions.swiftOut)}.m')}'),
+      // Path is relative to appDirectory.
+      dartFile: Uri.file('${path.relative(path.withoutExtension(generatorOptions.dartOut ?? ''), from: generatorOptions.exampleAppDirectory ?? './')}.ffi.dart'),
+      objectiveCFile: Uri.file('${path.relative(path.posix.join(objcDir, '${path.posix.basenameWithoutExtension(generatorOptions.swiftOptions.swiftOut)}.m'), from: generatorOptions.exampleAppDirectory ?? './')}'),
       preamble: \'''
 // ${generatorOptions.swiftOptions.copyrightHeader?.join('\n// ') ?? ''}
 

packages/pigeon/lib/src/swift/swift_generator.dart

@@ -57,7 +57,9 @@ class SwiftOptions {
   /// The module name that the FFi classes will use. Required if useFfi is true.
   final String? ffiModuleName;
 
-  /// The directory that the app exists in, this is required for FFI APIs.
+  /// The directory that the app exists in.
+  ///
+  /// Defaults to './' if not specified.
   final String? appDirectory;
 
   /// The path to the Apple SDK to use for FFI generation.

packages/pigeon/pigeons/ni_tests.dart

@@ -9,8 +9,15 @@ import 'package:pigeon/pigeon.dart';
 @ConfigurePigeon(
   PigeonOptions(
     dartOptions: DartOptions(),
-    kotlinOptions: KotlinOptions(useJni: true),
-    swiftOptions: SwiftOptions(useFfi: true, ffiModuleName: 'test_plugin'),
+    kotlinOptions: KotlinOptions(
+      useJni: true,
+      appDirectory: 'platform_tests/test_plugin/example/',
+    ),
+    swiftOptions: SwiftOptions(
+      useFfi: true,
+      ffiModuleName: 'test_plugin',
+      appDirectory: 'platform_tests/test_plugin/example/',
+    ),
   ),
 )
 enum NIAnEnum { one, two, three, fortyTwo, fourHundredTwentyTwo }

packages/pigeon/platform_tests/test_plugin/example/ffigen_config.dart

@@ -70,7 +70,7 @@ Future<void> main(List<String> args) async {
       ObjCCompatibleSwiftFileInput(
         files: <Uri>[
           Uri.file(
-            '/Users/tarrinneal/work/packages/packages/pigeon/platform_tests/test_plugin/darwin/test_plugin/Sources/test_plugin/NiTests.gen.swift',
+            '../darwin/test_plugin/Sources/test_plugin/NiTests.gen.swift',
           ),
         ],
       ),
@@ -79,11 +79,12 @@ Future<void> main(List<String> args) async {
         classes.contains(d.name) || enums.contains(d.name),
     output: Output(
       module: 'test_plugin',
+      // Path is relative to appDirectory.
       dartFile: Uri.file(
-        '/Users/tarrinneal/work/packages/packages/pigeon/platform_tests/shared_test_plugin_code/lib/src/generated/ni_tests.gen.ffi.dart',
+        '../../shared_test_plugin_code/lib/src/generated/ni_tests.gen.ffi.dart',
       ),
       objectiveCFile: Uri.file(
-        '/Users/tarrinneal/work/packages/packages/pigeon/platform_tests/test_plugin/darwin/test_plugin/Sources/test_plugin_objc/NiTests.gen.m',
+        '../darwin/test_plugin/Sources/test_plugin_objc/NiTests.gen.m',
       ),
       preamble: '''
   // Copyright 2013 The Flutter Authors

packages/pigeon/platform_tests/test_plugin/example/jnigen_config.dart

@@ -12,6 +12,7 @@ void main() async {
       summarizerOptions: SummarizerOptions(backend: SummarizerBackend.asm),
       outputConfig: OutputConfig(
         dartConfig: DartCodeOutputConfig(
+          // Path is relative to appDirectory.
           path: Uri.file(
             '../../shared_test_plugin_code/lib/src/generated/ni_tests.gen.jni.dart',
           ),