[jnigen] Refactor into Visitor pattern (#200)

Introducing a top-level `Classes` class which includes all the classes we're trying to generate as yet another element, makes each step of the code generation pipeline, feel the same. For example exclusion of classes and methods are now both done via actually removing the objects instead of setting an `isIncluded` flag. This `Classes` object will go through a pipeline of: 1. `Excluder` – excludes the unwanted classes, the private ones and the ones specified by the user. 2. `Linker` – links up the objects together to create a graph. 3. `Renamer` – renames the classes, methods, fields, ... not to clash with other reserved names. 4. `DartGenerator` – generates and writes to files.
dart-lang · Mar 16, 2023 · ca24df4 · ca24df4
1 parent 40da950
commit ca24df4
Show file tree

Hide file tree

Showing 47 changed files with 2,874 additions and 2,751 deletions.
diff --git a/pkgs/jnigen/analysis_options.yaml b/pkgs/jnigen/analysis_options.yaml
@@ -15,4 +15,6 @@ linter:
     - prefer_final_locals
     - prefer_const_declarations
     - unawaited_futures
+    - prefer_const_constructors
+    - prefer_relative_imports
 
diff --git a/pkgs/jnigen/example/in_app_java/lib/android_utils.dart b/pkgs/jnigen/example/in_app_java/lib/android_utils.dart
@@ -10,7 +10,9 @@
 // ignore_for_file: overridden_fields
 // ignore_for_file: unnecessary_cast
 // ignore_for_file: unused_element
+// ignore_for_file: unused_field
 // ignore_for_file: unused_import
+// ignore_for_file: unused_shown_name
 
 import "dart:isolate" show ReceivePort;
 import "dart:ffi" as ffi;
@@ -34,7 +36,6 @@ class AndroidUtils extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $AndroidUtilsType();
-
   static final _showToast = jniLookup<
           ffi.NativeFunction<
               jni.JniResult Function(ffi.Pointer<ffi.Void>,
@@ -82,7 +83,6 @@ class Build extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $BuildType();
-
   static final _get_BOARD =
       jniLookup<ffi.NativeFunction<jni.JniResult Function()>>(
               "get_Build__BOARD")
@@ -339,7 +339,7 @@ class Build extends jni.JObject {
       const jni.JStringType().fromRef(_get_TYPE().object);
 
   /// from: static public final java.lang.String UNKNOWN
-  static const UNKNOWN = "unknown";
+  static const UNKNOWN = r"""unknown""";
 
   static final _get_USER =
       jniLookup<ffi.NativeFunction<jni.JniResult Function()>>("get_Build__USER")
@@ -355,6 +355,7 @@ class Build extends jni.JObject {
           .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   Build() : super.fromRef(_ctor().object);
 
   static final _getSerial =
@@ -414,10 +415,7 @@ class HashMap<K extends jni.JObject, V extends jni.JObject>
     extends jni.JObject {
   late final jni.JObjType? _$type;
   @override
-  jni.JObjType get $type => _$type ??= type(
-        $K,
-        $V,
-      );
+  jni.JObjType get $type => _$type ??= type($K, $V);
 
   final jni.JObjType<K> $K;
   final jni.JObjType<V> $V;
@@ -445,6 +443,7 @@ class HashMap<K extends jni.JObject, V extends jni.JObject>
       .asFunction<jni.JniResult Function(int, double)>();
 
   /// from: public void <init>(int i, float f)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   HashMap(this.$K, this.$V, int i, double f)
       : super.fromRef(_ctor(i, f).object);
 
@@ -454,13 +453,15 @@ class HashMap<K extends jni.JObject, V extends jni.JObject>
           .asFunction<jni.JniResult Function(int)>();
 
   /// from: public void <init>(int i)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   HashMap.ctor1(this.$K, this.$V, int i) : super.fromRef(_ctor1(i).object);
 
   static final _ctor2 =
       jniLookup<ffi.NativeFunction<jni.JniResult Function()>>("HashMap__ctor2")
           .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   HashMap.ctor2(this.$K, this.$V) : super.fromRef(_ctor2().object);
 
   static final _ctor3 = jniLookup<
@@ -469,6 +470,7 @@ class HashMap<K extends jni.JObject, V extends jni.JObject>
       .asFunction<jni.JniResult Function(ffi.Pointer<ffi.Void>)>();
 
   /// from: public void <init>(java.util.Map map)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   HashMap.ctor3(this.$K, this.$V, jni.JObject map)
       : super.fromRef(_ctor3(map.reference).object);
 

diff --git a/pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart b/pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart
@@ -10,7 +10,9 @@
 // ignore_for_file: overridden_fields
 // ignore_for_file: unnecessary_cast
 // ignore_for_file: unused_element
+// ignore_for_file: unused_field
 // ignore_for_file: unused_import
+// ignore_for_file: unused_shown_name
 
 import "dart:isolate" show ReceivePort;
 import "dart:ffi" as ffi;
@@ -34,12 +36,12 @@ class Example extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $ExampleType();
-
   static final _ctor =
       jniLookup<ffi.NativeFunction<jni.JniResult Function()>>("Example__ctor")
           .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   Example() : super.fromRef(_ctor().object);
 
   static final _thinkBeforeAnswering = jniLookup<
@@ -54,8 +56,8 @@ class Example extends jni.JObject {
   /// The returned object must be deleted after use, by calling the `delete` method.
   Future<jni.JString> thinkBeforeAnswering() async {
     final $p = ReceivePort();
-    final $c = jni.Jni.newPortContinuation($p);
-    _thinkBeforeAnswering(reference, $c).object;
+    final $c = jni.JObject.fromRef(jni.Jni.newPortContinuation($p));
+    _thinkBeforeAnswering(reference, $c.reference).object;
     final $o = jni.JObjectPtr.fromAddress(await $p.first);
     final $k = const jni.JStringType().getClass().reference;
     if (jni.Jni.env.IsInstanceOf($o, $k) == 0) {

diff --git a/pkgs/jnigen/example/notification_plugin/lib/notifications.dart b/pkgs/jnigen/example/notification_plugin/lib/notifications.dart
@@ -14,7 +14,9 @@
 // ignore_for_file: overridden_fields
 // ignore_for_file: unnecessary_cast
 // ignore_for_file: unused_element
+// ignore_for_file: unused_field
 // ignore_for_file: unused_import
+// ignore_for_file: unused_shown_name
 
 import "dart:isolate" show ReceivePort;
 import "dart:ffi" as ffi;
@@ -38,12 +40,12 @@ class Notifications extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $NotificationsType();
-
   static final _ctor = jniLookup<ffi.NativeFunction<jni.JniResult Function()>>(
           "Notifications__ctor")
       .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   Notifications() : super.fromRef(_ctor().object);
 
   static final _showNotification = jniLookup<

diff --git a/...nigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart b/...nigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart
@@ -28,15 +28,17 @@
 // ignore_for_file: overridden_fields
 // ignore_for_file: unnecessary_cast
 // ignore_for_file: unused_element
+// ignore_for_file: unused_field
 // ignore_for_file: unused_import
+// ignore_for_file: unused_shown_name
 
 import "dart:isolate" show ReceivePort;
 import "dart:ffi" as ffi;
 import "package:jni/internal_helpers_for_jnigen.dart";
 import "package:jni/jni.dart" as jni;
 
 import "PDDocumentInformation.dart" as pddocumentinformation_;
-import "../../../../_init.dart" show jniLookup;
+import "../../../../_init.dart";
 
 /// from: org.apache.pdfbox.pdmodel.PDDocument
 ///
@@ -54,12 +56,12 @@ class PDDocument extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $PDDocumentType();
-
   static final _ctor = jniLookup<ffi.NativeFunction<jni.JniResult Function()>>(
           "PDDocument__ctor")
       .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Creates an empty PDF document.
   /// You need to add at least one page for the document to be valid.
@@ -72,6 +74,7 @@ class PDDocument extends jni.JObject {
       .asFunction<jni.JniResult Function(ffi.Pointer<ffi.Void>)>();
 
   /// from: public void <init>(org.apache.pdfbox.io.MemoryUsageSetting memUsageSetting)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Creates an empty PDF document.
   /// You need to add at least one page for the document to be valid.
@@ -86,6 +89,7 @@ class PDDocument extends jni.JObject {
       .asFunction<jni.JniResult Function(ffi.Pointer<ffi.Void>)>();
 
   /// from: public void <init>(org.apache.pdfbox.cos.COSDocument doc)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Constructor that uses an existing document. The COSDocument that is passed in must be valid.
   ///@param doc The COSDocument that this document wraps.
@@ -101,6 +105,7 @@ class PDDocument extends jni.JObject {
               ffi.Pointer<ffi.Void>, ffi.Pointer<ffi.Void>)>();
 
   /// from: public void <init>(org.apache.pdfbox.cos.COSDocument doc, org.apache.pdfbox.io.RandomAccessRead source)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Constructor that uses an existing document. The COSDocument that is passed in must be valid.
   ///@param doc The COSDocument that this document wraps.
@@ -119,6 +124,7 @@ class PDDocument extends jni.JObject {
               ffi.Pointer<ffi.Void>)>();
 
   /// from: public void <init>(org.apache.pdfbox.cos.COSDocument doc, org.apache.pdfbox.io.RandomAccessRead source, org.apache.pdfbox.pdmodel.encryption.AccessPermission permission)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Constructor that uses an existing document. The COSDocument that is passed in must be valid.
   ///@param doc The COSDocument that this document wraps.

diff --git a/...le/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart b/...le/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart
@@ -28,14 +28,16 @@
 // ignore_for_file: overridden_fields
 // ignore_for_file: unnecessary_cast
 // ignore_for_file: unused_element
+// ignore_for_file: unused_field
 // ignore_for_file: unused_import
+// ignore_for_file: unused_shown_name
 
 import "dart:isolate" show ReceivePort;
 import "dart:ffi" as ffi;
 import "package:jni/internal_helpers_for_jnigen.dart";
 import "package:jni/jni.dart" as jni;
 
-import "../../../../_init.dart" show jniLookup;
+import "../../../../_init.dart";
 
 /// from: org.apache.pdfbox.pdmodel.PDDocumentInformation
 ///
@@ -55,12 +57,12 @@ class PDDocumentInformation extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $PDDocumentInformationType();
-
   static final _ctor = jniLookup<ffi.NativeFunction<jni.JniResult Function()>>(
           "PDDocumentInformation__ctor")
       .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Default Constructor.
   PDDocumentInformation() : super.fromRef(_ctor().object);
@@ -72,6 +74,7 @@ class PDDocumentInformation extends jni.JObject {
       .asFunction<jni.JniResult Function(ffi.Pointer<ffi.Void>)>();
 
   /// from: public void <init>(org.apache.pdfbox.cos.COSDictionary dic)
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Constructor that is used for a preexisting dictionary.
   ///@param dic The underlying dictionary.

diff --git a/...gen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart b/...gen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart
@@ -28,15 +28,17 @@
 // ignore_for_file: overridden_fields
 // ignore_for_file: unnecessary_cast
 // ignore_for_file: unused_element
+// ignore_for_file: unused_field
 // ignore_for_file: unused_import
+// ignore_for_file: unused_shown_name
 
 import "dart:isolate" show ReceivePort;
 import "dart:ffi" as ffi;
 import "package:jni/internal_helpers_for_jnigen.dart";
 import "package:jni/jni.dart" as jni;
 
 import "../pdmodel/PDDocument.dart" as pddocument_;
-import "../../../../_init.dart" show jniLookup;
+import "../../../../_init.dart";
 
 /// from: org.apache.pdfbox.text.PDFTextStripper
 ///
@@ -58,7 +60,6 @@ class PDFTextStripper extends jni.JObject {
 
   /// The type which includes information such as the signature of this class.
   static const type = $PDFTextStripperType();
-
   static final _get_LINE_SEPARATOR = jniLookup<
           ffi.NativeFunction<
               jni.JniResult Function(
@@ -86,6 +87,14 @@ class PDFTextStripper extends jni.JObject {
     jni.JObjectPtr,
   )>();
 
+  static final _set_charactersByArticle = jniLookup<
+              ffi.NativeFunction<
+                  jni.JThrowablePtr Function(
+                      jni.JObjectPtr, ffi.Pointer<ffi.Void>)>>(
+          "set_PDFTextStripper__charactersByArticle")
+      .asFunction<
+          jni.JThrowablePtr Function(jni.JObjectPtr, ffi.Pointer<ffi.Void>)>();
+
   /// from: protected java.util.ArrayList<java.util.List<org.apache.pdfbox.text.TextPosition>> charactersByArticle
   /// The returned object must be deleted after use, by calling the `delete` method.
   ///
@@ -103,13 +112,6 @@ class PDFTextStripper extends jni.JObject {
   /// Most PDFs won't have any beads, so charactersByArticle will contain a single entry.
   jni.JObject get charactersByArticle => const jni.JObjectType()
       .fromRef(_get_charactersByArticle(reference).object);
-  static final _set_charactersByArticle = jniLookup<
-              ffi.NativeFunction<
-                  jni.JThrowablePtr Function(
-                      jni.JObjectPtr, ffi.Pointer<ffi.Void>)>>(
-          "set_PDFTextStripper__charactersByArticle")
-      .asFunction<
-          jni.JThrowablePtr Function(jni.JObjectPtr, ffi.Pointer<ffi.Void>)>();
 
   /// from: protected java.util.ArrayList<java.util.List<org.apache.pdfbox.text.TextPosition>> charactersByArticle
   /// The returned object must be deleted after use, by calling the `delete` method.
@@ -139,17 +141,18 @@ class PDFTextStripper extends jni.JObject {
     jni.JObjectPtr,
   )>();
 
-  /// from: protected org.apache.pdfbox.pdmodel.PDDocument document
-  /// The returned object must be deleted after use, by calling the `delete` method.
-  pddocument_.PDDocument get document => const pddocument_.$PDDocumentType()
-      .fromRef(_get_document(reference).object);
   static final _set_document = jniLookup<
           ffi.NativeFunction<
               jni.JThrowablePtr Function(jni.JObjectPtr,
                   ffi.Pointer<ffi.Void>)>>("set_PDFTextStripper__document")
       .asFunction<
           jni.JThrowablePtr Function(jni.JObjectPtr, ffi.Pointer<ffi.Void>)>();
 
+  /// from: protected org.apache.pdfbox.pdmodel.PDDocument document
+  /// The returned object must be deleted after use, by calling the `delete` method.
+  pddocument_.PDDocument get document => const pddocument_.$PDDocumentType()
+      .fromRef(_get_document(reference).object);
+
   /// from: protected org.apache.pdfbox.pdmodel.PDDocument document
   /// The returned object must be deleted after use, by calling the `delete` method.
   set document(pddocument_.PDDocument value) =>
@@ -165,17 +168,18 @@ class PDFTextStripper extends jni.JObject {
     jni.JObjectPtr,
   )>();
 
-  /// from: protected java.io.Writer output
-  /// The returned object must be deleted after use, by calling the `delete` method.
-  jni.JObject get output =>
-      const jni.JObjectType().fromRef(_get_output(reference).object);
   static final _set_output = jniLookup<
           ffi.NativeFunction<
               jni.JThrowablePtr Function(jni.JObjectPtr,
                   ffi.Pointer<ffi.Void>)>>("set_PDFTextStripper__output")
       .asFunction<
           jni.JThrowablePtr Function(jni.JObjectPtr, ffi.Pointer<ffi.Void>)>();
 
+  /// from: protected java.io.Writer output
+  /// The returned object must be deleted after use, by calling the `delete` method.
+  jni.JObject get output =>
+      const jni.JObjectType().fromRef(_get_output(reference).object);
+
   /// from: protected java.io.Writer output
   /// The returned object must be deleted after use, by calling the `delete` method.
   set output(jni.JObject value) => _set_output(reference, value.reference);
@@ -185,6 +189,7 @@ class PDFTextStripper extends jni.JObject {
       .asFunction<jni.JniResult Function()>();
 
   /// from: public void <init>()
+  /// The returned object must be deleted after use, by calling the `delete` method.
   ///
   /// Instantiate a new PDFTextStripper object.
   ///@throws IOException If there is an error loading the properties.

diff --git a/pkgs/jnigen/lib/src/bindings/bindings.dart b/pkgs/jnigen/lib/src/bindings/bindings.dart