[jnigen] Throw when output folder contains non JNIgen files (#2063)

HosseinYousefi · web-flow · commit dce9d731d90a · 2025-03-05T17:05:14.000+01:00
diff --git a/pkgs/jnigen/CHANGELOG.md b/pkgs/jnigen/CHANGELOG.md
@@ -1,6 +1,8 @@
 ## 0.14.2-wip
 
 - The name `factory` can now also be used in a method name without renaming.
+- Throw when output folder contains non JNIgen files. Users with existing
+  package bindings will need to delete them once for it to start working.
 
 ## 0.14.1
 
@@ -9,7 +11,8 @@
   bindings.
 - Fix a bug where Kotlin suspendable functions that returned the result without
   ever suspending would timeout in Dart.
-- Retrieval of dependencies uses Gradle (`GradleTools`) en lieu of Maven (`MavenTools`).
+- Retrieval of dependencies uses Gradle (`GradleTools`) in lieu of Maven
+  (`MavenTools`).
 - Updated `bin\download_maven_jars.dart` to use `GradleTools`.
 
 ## 0.14.0
diff --git a/pkgs/jnigen/README.md b/pkgs/jnigen/README.md
@@ -3,6 +3,10 @@
 [![pub package](https://img.shields.io/pub/v/jnigen.svg)](https://pub.dev/packages/jnigen)
 [![package publisher](https://img.shields.io/pub/publisher/jnigen.svg)](https://pub.dev/packages/jnigen/publisher)
 
+## Migrating to 0.14.2
+
+When regenerating bindings after an upgrade to JNIgen in the one file per class mode, you will need to delete the old bindings once to fix `A file that was not generated by JNIgen was found in ...` error.
+
 ## Introduction
 Experimental bindings generator for Java bindings through dart:ffi and JNI.
 
@@ -270,10 +274,6 @@ However there are 2 caveats to this caveat.
 
 The JAR files (`$SDK_ROOT/platforms/android-$VERSION/android.jar`) can be used instead. But compiled JARs do not include JavaDoc and method parameter names. This JAR is automatically included by Gradle when `android_sdk_config` >> `add_gradle_deps` is specified.
 
-## Migrating to 0.8.0
-
-Check [`jni`'s changelog](https://github.com/dart-lang/native/blob/main/pkgs/jni/CHANGELOG.md#080-wip) and [`jnigen`'s changelog](https://github.com/dart-lang/native/blob/main/pkgs/jnigen/CHANGELOG.md#080-wip).
-
 ## Contributing
 See the wiki for architecture-related documents.
 
diff --git a/pkgs/jnigen/example/in_app_java/lib/android_utils.dart b/pkgs/jnigen/example/in_app_java/lib/android_utils.dart
@@ -1,4 +1,4 @@
-// Autogenerated by jnigen. DO NOT EDIT!
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
 
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
diff --git a/pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart b/pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart
@@ -1,4 +1,4 @@
-// Autogenerated by jnigen. DO NOT EDIT!
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
 
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
diff --git a/pkgs/jnigen/example/notification_plugin/lib/notifications.dart b/pkgs/jnigen/example/notification_plugin/lib/notifications.dart
@@ -1,9 +1,9 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart b/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart
@@ -1,3 +1,5 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Generated from Apache PDFBox library which is licensed under the Apache License 2.0.
 // The following copyright from the original authors applies.
 //
@@ -16,8 +18,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart b/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart
@@ -1,3 +1,5 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Generated from Apache PDFBox library which is licensed under the Apache License 2.0.
 // The following copyright from the original authors applies.
 //
@@ -16,8 +18,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/_package.dart b/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/_package.dart
@@ -1,2 +1,3 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
 export 'PDDocument.dart';
 export 'PDDocumentInformation.dart';
diff --git a/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart b/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart
@@ -1,3 +1,5 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Generated from Apache PDFBox library which is licensed under the Apache License 2.0.
 // The following copyright from the original authors applies.
 //
@@ -16,8 +18,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/_package.dart b/pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/_package.dart
@@ -1 +1,2 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
 export 'PDFTextStripper.dart';
diff --git a/pkgs/jnigen/lib/src/bindings/dart_generator.dart b/pkgs/jnigen/lib/src/bindings/dart_generator.dart
@@ -2,6 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:meta/meta.dart';
@@ -13,6 +14,11 @@ import '../util/string_util.dart';
 import 'resolver.dart';
 import 'visitor.dart';
 
+/// Version of jnigen. Keep in sync with `pubspec.yaml` removing the `-wip`
+/// suffix.
+@visibleForTesting
+const String version = '0.14.2';
+
 // Import prefixes.
 const _jni = r'jni$_';
 const _core = r'core$_';
@@ -132,8 +138,9 @@ class DartGenerator extends Visitor<Classes, Future<void>> {
 
   DartGenerator(this.config);
 
-  static const autoGeneratedNotice = '// Autogenerated by jnigen. '
-      'DO NOT EDIT!\n\n';
+  // Do not change this.
+  static const autoGeneratedNotice = '// AUTO GENERATED BY JNIGEN $version. '
+      'DO NOT EDIT!\n';
   static const defaultImports = '''
 import 'dart:core' show Object, String, bool, double, int;
 import 'dart:core' as $_core;
@@ -175,8 +182,6 @@ import 'package:jni/jni.dart' as $_jni;
 // ignore_for_file: use_super_parameters
 
 ''';
-  static const preImportBoilerplate =
-      autoGeneratedNotice + defaultLintSuppressions + defaultImports;
 
   /// Run dart format command on [path].
   Future<void> _runDartFormat(String path) async {
@@ -203,8 +208,8 @@ import 'package:jni/jni.dart' as $_jni;
       await file.create(recursive: true);
       log.info('Generating bindings');
       final s = file.openWrite();
-      s.writeln(preamble);
       s.writeln(autoGeneratedNotice);
+      s.writeln(preamble);
       s.writeln(defaultLintSuppressions);
       s.writeln(defaultImports);
       final resolver = Resolver(
@@ -233,6 +238,28 @@ import 'package:jni/jni.dart' as $_jni;
     }
 
     log.info('Using dart root = $root');
+    {
+      final rootDirectory = Directory.fromUri(root);
+      if (rootDirectory.existsSync()) {
+        final files = rootDirectory.listSync(recursive: true).whereType<File>();
+        final filesToRemove = <File>[];
+        for (final file in files) {
+          final stream = file.openRead();
+          final firstLine = await stream
+              .transform(const Utf8Decoder())
+              .transform(const LineSplitter())
+              .first;
+          if (firstLine.startsWith('// AUTO GENERATED BY JNIGEN ')) {
+            log.fine('Removing old file ${file.path}');
+            filesToRemove.add(file);
+          } else {
+            throw StateError('''
+A file that was not generated by JNIgen was found in ${root.path}: ${file.path}.''');
+          }
+        }
+        await filesToRemove.map((file) => file.delete()).wait;
+      }
+    }
     for (var fileClassName in files.keys) {
       final relativeFileName = '${fileClassName.replaceAll('.', '/')}.dart';
       final dartFileUri = root.resolve(relativeFileName);
@@ -241,8 +268,8 @@ import 'package:jni/jni.dart' as $_jni;
 
       final classesInFile = files[fileClassName]!;
       final dartFileStream = dartFile.openWrite();
-      dartFileStream.writeln(preamble);
       dartFileStream.writeln(autoGeneratedNotice);
+      dartFileStream.writeln(preamble);
       dartFileStream.writeln(defaultLintSuppressions);
       dartFileStream.writeln(defaultImports);
       final s = StringBuffer();
@@ -268,7 +295,7 @@ import 'package:jni/jni.dart' as $_jni;
       exportFile.createSync(recursive: true);
       final exports =
           packages[package]!.map((cls) => "export '$cls.dart';").join('\n');
-      exportFile.writeAsStringSync(exports);
+      exportFile.writeAsStringSync(autoGeneratedNotice + exports);
     }
     await _runDartFormat(root.toFilePath());
     log.info('Completed.');
diff --git a/pkgs/jnigen/pubspec.yaml b/pkgs/jnigen/pubspec.yaml
@@ -4,6 +4,7 @@
 
 name: jnigen
 description: A Dart bindings generator for Java and Kotlin that uses JNI under the hood to interop with Java virtual machine.
+# Keep in sync with `version` in `dart_generator.dart`.
 version: 0.14.2-wip
 repository: https://github.com/dart-lang/native/tree/main/pkgs/jnigen
 issue_tracker: https://github.com/dart-lang/native/issues?q=is%3Aissue+is%3Aopen+label%3Apackage%3Ajnigen
diff --git a/pkgs/jnigen/test/generation_test.dart b/pkgs/jnigen/test/generation_test.dart
@@ -0,0 +1,42 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'package:jnigen/jnigen.dart';
+import 'package:path/path.dart';
+import 'package:test/test.dart';
+
+void main() {
+  test('Warn if non-jnigen-generated files exist in directory', () async {
+    final root = await Directory.current.createTemp();
+    final nonGenerated =
+        await File.fromUri(root.uri.resolve('non_gen.dart')).create();
+    await nonGenerated.writeAsString('void main() {}');
+    final generated = await File.fromUri(root.uri.resolve('gen.dart')).create();
+    await generated
+        .writeAsString('// AUTO GENERATED BY JNIGEN 1.2.3. DO NOT EDIT!\n');
+    final sourcePath =
+        join(Directory.current.path, 'test', 'simple_package_test', 'java');
+    print(sourcePath);
+    await expectLater(
+      () => generateJniBindings(
+        Config(
+          outputConfig: OutputConfig(
+              dartConfig: DartCodeOutputConfig(
+                  path: root.uri, structure: OutputStructure.packageStructure)),
+          classes: ['com.github.dart_lang.jnigen.simple_package'],
+          sourcePath: [Uri.directory(sourcePath)],
+        ),
+      ),
+      throwsA(allOf([
+        isA<StateError>(),
+        predicate(
+            (error) => error.toString().contains('not generated by JNIgen')),
+        predicate((error) => error.toString().contains('non_gen.dart')),
+      ])),
+    );
+    await root.delete(recursive: true);
+  });
+}
diff --git a/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonFactory.dart b/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonFactory.dart
@@ -1,3 +1,5 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Generated from jackson-core which is licensed under the Apache License 2.0.
 // The following copyright from the original authors applies.
 // See https://github.com/FasterXML/jackson-core/blob/2.14/LICENSE
@@ -15,8 +17,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonParser.dart b/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonParser.dart
@@ -1,3 +1,5 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Generated from jackson-core which is licensed under the Apache License 2.0.
 // The following copyright from the original authors applies.
 // See https://github.com/FasterXML/jackson-core/blob/2.14/LICENSE
@@ -15,8 +17,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonToken.dart b/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonToken.dart
@@ -1,3 +1,5 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Generated from jackson-core which is licensed under the Apache License 2.0.
 // The following copyright from the original authors applies.
 // See https://github.com/FasterXML/jackson-core/blob/2.14/LICENSE
@@ -15,8 +17,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/_package.dart b/pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/_package.dart
@@ -1,3 +1,4 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
 export 'JsonFactory.dart';
 export 'JsonParser.dart';
 export 'JsonToken.dart';
diff --git a/pkgs/jnigen/test/kotlin_test/bindings/kotlin.dart b/pkgs/jnigen/test/kotlin_test/bindings/kotlin.dart
@@ -1,9 +1,9 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Copyright (c) 2023, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/test/simple_package_test/bindings/simple_package.dart b/pkgs/jnigen/test/simple_package_test/bindings/simple_package.dart
@@ -1,9 +1,9 @@
+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!
+
 // Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-// Autogenerated by jnigen. DO NOT EDIT!
-
 // ignore_for_file: annotate_overrides
 // ignore_for_file: argument_type_not_assignable
 // ignore_for_file: camel_case_extensions
diff --git a/pkgs/jnigen/test/user_visitor_test.dart b/pkgs/jnigen/test/user_visitor_test.dart
diff --git a/pkgs/jnigen/test/version_test.dart b/pkgs/jnigen/test/version_test.dart
@@ -0,0 +1,23 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'package:test/test.dart';
+
+void main() {
+  test('Versions in pubspec.yaml and dart_generator.dart match', () {
+    final pubspecVersion = RegExp(r'version: (.*)')
+        .firstMatch(File('pubspec.yaml').readAsStringSync())!
+        .group(1)!;
+    final dartGeneratorVersion = RegExp(r"const String version = '(.*)';")
+        .firstMatch(
+            File('lib/src/bindings/dart_generator.dart').readAsStringSync())!
+        .group(1)!;
+    final pubspecVersionWithoutWip = pubspecVersion.endsWith('-wip')
+        ? pubspecVersion.substring(0, pubspecVersion.length - '-wip'.length)
+        : pubspecVersion;
+    expect(pubspecVersionWithoutWip, dartGeneratorVersion);
+  });
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Autogenerated by jnigen. DO NOT EDIT!`
	`1`	`+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!`
`2`	`2`
`3`	`3`	`// ignore_for_file: annotate_overrides`
`4`	`4`	`// ignore_for_file: argument_type_not_assignable`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!`
`1`	`2`	`export 'PDDocument.dart';`
`2`	`3`	`export 'PDDocumentInformation.dart';`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+// AUTO GENERATED BY JNIGEN 0.14.2. DO NOT EDIT!`
`1`	`2`	`export 'PDFTextStripper.dart';`