bugfix: possible premature garbage collection of VehicleConstraint

stephengold · Jan 6, 2025 · cae18db · cae18db
1 parent e19afcd
commit cae18db
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 17 deletions.
diff --git a/src/main/java/com/github/stephengold/joltjni/VehicleConstraint.java b/src/main/java/com/github/stephengold/joltjni/VehicleConstraint.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -128,7 +128,7 @@ public Wheel getWheel(int wheelIndex) {
         long constraintVa = va();
         long wheelVa = getWheel(constraintVa, wheelIndex);
         int ordinal = Constraint.getControllerType(constraintVa);
-        Wheel result = Wheel.newWheel(wheelVa, ordinal);
+        Wheel result = Wheel.newWheel(wheelVa, ordinal, this);
 
         return result;
     }

diff --git a/src/main/java/com/github/stephengold/joltjni/Wheel.java b/src/main/java/com/github/stephengold/joltjni/Wheel.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -41,13 +41,15 @@ public class Wheel extends NonCopyable {
     // constructors
 
     /**
-     * Instantiate with the specified native object assigned but not owned.
+     * Instantiate with the specified container and native object.
      *
+     * @param container the containing object, or {@code null} if none
      * @param wheelVa the virtual address of the native object to assign (not
      * zero)
      */
-    Wheel(long wheelVa) {
-        setVirtualAddress(wheelVa);
+    Wheel(VehicleConstraint container, long wheelVa) {
+        super(container, wheelVa);
+
         long settingsVa = getSettings(wheelVa);
         if (this instanceof WheelTv) {
             this.settings = new WheelSettingsTv(settingsVa).toRef();
@@ -75,9 +77,11 @@ public ConstWheelSettings getSettings() {
      *
      * @param wheelVa the virtual address of the native object, or zero
      * @param ordinal the type of {@code VehicleController}
+     * @param container the containing object, or {@code null} if none
      * @return a new JVM object, or {@code null} if {@code wheelVa} was zero
      */
-    public static Wheel newWheel(long wheelVa, int ordinal) {
+    public static Wheel newWheel(
+            long wheelVa, int ordinal, VehicleConstraint container) {
         if (wheelVa == 0L) {
             return null;
         }
@@ -86,10 +90,10 @@ public static Wheel newWheel(long wheelVa, int ordinal) {
         switch (ordinal) {
             case VehicleController.motorcycleType:
             case VehicleController.wheeledVehicleType:
-                result = new WheelWv(wheelVa);
+                result = new WheelWv(container, wheelVa);
                 break;
             case VehicleController.trackedVehicleType:
-                result = new WheelTv(wheelVa);
+                result = new WheelTv(container, wheelVa);
                 break;
             default:
                 throw new IllegalArgumentException("ordinal = " + ordinal);

diff --git a/src/main/java/com/github/stephengold/joltjni/WheelTv.java b/src/main/java/com/github/stephengold/joltjni/WheelTv.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -31,12 +31,13 @@ public class WheelTv extends Wheel {
     // constructors
 
     /**
-     * Instantiate with the specified native object assigned but not owned.
+     * Instantiate with the specified container and native object.
      *
+     * @param container the containing object, or {@code null} if none
      * @param wheelVa the virtual address of the native object to assign (not
      * zero)
      */
-    WheelTv(long wheelVa) {
-        super(wheelVa);
+    WheelTv(VehicleConstraint container, long wheelVa) {
+        super(container, wheelVa);
     }
 }
diff --git a/src/main/java/com/github/stephengold/joltjni/WheelWv.java b/src/main/java/com/github/stephengold/joltjni/WheelWv.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -31,12 +31,13 @@ public class WheelWv extends Wheel {
     // constructors
 
     /**
-     * Instantiate with the specified native object assigned but not owned.
+     * Instantiate with the specified container and native object.
      *
+     * @param container the containing object, or {@code null} if none
      * @param wheelVa the virtual address of the native object to assign (not
      * zero)
      */
-    WheelWv(long wheelVa) {
-        super(wheelVa);
+    WheelWv(VehicleConstraint container, long wheelVa) {
+        super(container, wheelVa);
     }
 }