From 99f22f72c34f3a3d52abc5ccb012c77bc16cc63e Mon Sep 17 00:00:00 2001
From: Amartya Parijat <amartya.parijat@yatta.de>
Date: Wed, 18 Sep 2024 17:46:49 +0200
Subject: [PATCH] Destroy unused handles od resources

This Contribution destroys those handles for the resources which were
created for zoom levels which no monitor has anymore. The process is
triggered on a DPI_CHANGED event.

contributes to #62 and #127
---
 .../org/eclipse/swt/graphics/Device.java      |   3 +
 .../org/eclipse/swt/graphics/Resource.java    |  16 ++-
 .../gtk/org/eclipse/swt/graphics/Device.java  |   3 +
 .../org/eclipse/swt/graphics/Device.java      | 104 +++++++++++-------
 .../win32/org/eclipse/swt/graphics/Image.java |  25 ++++-
 .../win32/org/eclipse/swt/graphics/Path.java  |  11 ++
 .../org/eclipse/swt/graphics/Pattern.java     |  45 +++++---
 .../org/eclipse/swt/graphics/Region.java      |  11 ++
 .../org/eclipse/swt/graphics/Transform.java   |  11 ++
 .../org/eclipse/swt/widgets/Control.java      |   1 +
 10 files changed, 172 insertions(+), 58 deletions(-)

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java
index ef30e780765..fabbc880925 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java	
@@ -693,6 +693,9 @@ public boolean loadFont (String path) {
 }
 
 void new_Object (Object object) {
+	if (!tracking) {
+		return;
+	}
 	synchronized (trackingLock) {
 		for (int i=0; i<objects.length; i++) {
 			if (objects [i] == null) {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/graphics/Resource.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/graphics/Resource.java
index cb47f9ddb39..7d495a3f30a 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/graphics/Resource.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/graphics/Resource.java	
@@ -13,6 +13,7 @@
  *******************************************************************************/
 package org.eclipse.swt.graphics;
 
+import java.util.*;
 import java.util.function.*;
 
 import org.eclipse.swt.*;
@@ -123,6 +124,19 @@ public Resource() {
 void destroy() {
 }
 
+/**
+ * This method is supposed to be overridden by those resources which contain
+ * multiple handles for different zoom levels. The method destroys handles of
+ * the resource for all the zoom levels expect for the those passed in the
+ * argument.
+ *
+ * @param zoomLevels The zoom levels for which the handles are supposed to be
+ *                   retained.
+ */
+void destroyHandlesExcept(Set<Integer> zoomLevels) {
+
+}
+
 /**
  * Disposes of the operating system resources associated with
  * this resource. Applications must dispose of all resources
@@ -158,7 +172,7 @@ void ignoreNonDisposed() {
 }
 
 void init() {
-	if (device.tracking) device.new_Object(this);
+	device.new_Object(this);
 }
 
 void initNonDisposeTracking() {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Device.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Device.java
index 3363ea5ae86..82b74976a1b 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Device.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Device.java	
@@ -911,6 +911,9 @@ long logProc (long log_domain, long log_level, long message, long user_data) {
 }
 
 void new_Object (Object object) {
+	if (!tracking) {
+		return;
+	}
 	synchronized (trackingLock) {
 		for (int i=0; i<objects.length; i++) {
 			if (objects [i] == null) {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java
index f43b6bbc582..5b85f6fa6e1 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java	
@@ -14,10 +14,13 @@
 package org.eclipse.swt.graphics;
 
 
+import java.util.*;
+
 import org.eclipse.swt.*;
 import org.eclipse.swt.internal.*;
 import org.eclipse.swt.internal.gdip.*;
 import org.eclipse.swt.internal.win32.*;
+import org.eclipse.swt.widgets.*;
 
 /**
  * This class is the abstract superclass of all device objects,
@@ -117,6 +120,7 @@ public Device(DeviceData data) {
 			debug = data.debug;
 			tracking = data.tracking;
 		}
+		initializeObjects();
 		if (tracking) {
 			startTracking();
 		}
@@ -148,7 +152,7 @@ public void setTracking(boolean tracking) {
 	if (tracking == this.tracking) {
 		return;
 	}
-	this.tracking = tracking;
+	initializeObjects();
 	if (tracking) {
 		startTracking();
 	} else {
@@ -156,18 +160,17 @@ public void setTracking(boolean tracking) {
 	}
 }
 
-private void startTracking() {
-	errors = new Error [128];
+private void initializeObjects() {
 	objects = new Object [128];
 	trackingLock = new Object ();
 }
 
+private void startTracking() {
+	errors = new Error [128];
+}
+
 private void stopTracking() {
-	synchronized (trackingLock) {
-		objects = null;
-		errors = null;
-		trackingLock = null;
-	}
+	errors = null;
 }
 
 
@@ -336,13 +339,13 @@ public void dispose () {
 
 			destroy ();
 			disposed = true;
-			if (tracking) {
-				synchronized (trackingLock) {
-					printErrors ();
-					objects = null;
+			synchronized (trackingLock) {
+				printErrors ();
+				objects = null;
+				if (tracking) {
 					errors = null;
-					trackingLock = null;
 				}
+				trackingLock = null;
 			}
 		}
 	}
@@ -353,7 +356,9 @@ void dispose_Object (Object object) {
 		for (int i=0; i<objects.length; i++) {
 			if (objects [i] == object) {
 				objects [i] = null;
-				errors [i] = null;
+				if(tracking) {
+					errors [i] = null;
+				}
 				return;
 			}
 		}
@@ -436,26 +441,27 @@ public DeviceData getDeviceData () {
 	DeviceData data = new DeviceData ();
 	data.debug = debug;
 	data.tracking = tracking;
-	if (tracking) {
-		synchronized (trackingLock) {
-			int count = 0, length = objects.length;
-			for (int i=0; i<length; i++) {
-				if (objects [i] != null) count++;
-			}
-			int index = 0;
-			data.objects = new Object [count];
+	synchronized (trackingLock) {
+		int count = 0, length = objects.length;
+		for (int i=0; i<length; i++) {
+			if (objects [i] != null) count++;
+		}
+		int index = 0;
+		data.objects = new Object [count];
+		if (tracking) {
 			data.errors = new Error [count];
-			for (int i=0; i<length; i++) {
-				if (objects [i] != null) {
-					data.objects [index] = objects [i];
+		} else {
+			data.errors = new Error [0];
+		}
+		for (int i=0; i<length; i++) {
+			if (objects [i] != null) {
+				data.objects [index] = objects [i];
+				if (tracking) {
 					data.errors [index] = errors [i];
-					index++;
 				}
+				index++;
 			}
 		}
-	} else {
-		data.objects = new Object [0];
-		data.errors = new Error [0];
 	}
 	return data;
 }
@@ -820,7 +826,9 @@ void new_Object (Object object) {
 		for (int i=0; i<objects.length; i++) {
 			if (objects [i] == null) {
 				objects [i] = object;
-				errors [i] = new Error ();
+				if (tracking) {
+					errors [i] = new Error ();
+				}
 				return;
 			}
 		}
@@ -828,10 +836,12 @@ void new_Object (Object object) {
 		System.arraycopy (objects, 0, newObjects, 0, objects.length);
 		newObjects [objects.length] = object;
 		objects = newObjects;
-		Error [] newErrors = new Error [errors.length + 128];
-		System.arraycopy (errors, 0, newErrors, 0, errors.length);
-		newErrors [errors.length] = new Error ();
-		errors = newErrors;
+		if (tracking) {
+			Error [] newErrors = new Error [errors.length + 128];
+			System.arraycopy (errors, 0, newErrors, 0, errors.length);
+			newErrors [errors.length] = new Error ();
+			errors = newErrors;
+		}
 	}
 }
 
@@ -839,7 +849,7 @@ void printErrors () {
 	if (!DEBUG) return;
 	if (tracking) {
 		synchronized (trackingLock) {
-			if (objects == null || errors == null) return;
+			if (objects == null && errors == null) return;
 			int objectCount = 0;
 			int colors = 0, cursors = 0, fonts = 0, gcs = 0, images = 0;
 			int paths = 0, patterns = 0, regions = 0, textLayouts = 0, transforms = 0;
@@ -874,8 +884,10 @@ void printErrors () {
 					string = string.substring (0, string.length () - 2);
 					System.err.println (string);
 				}
-				for (Error error : errors) {
-					if (error != null) error.printStackTrace (System.err);
+				if(tracking) {
+					for (Error error : errors) {
+						if (error != null) error.printStackTrace (System.err);
+					}
 				}
 			}
 		}
@@ -947,4 +959,22 @@ public void setWarnings (boolean warnings) {
 protected int getDeviceZoom () {
 	return DPIUtil.mapDPIToZoom ( _getDPIx ());
 }
+
+/**
+ * Destroys the handles of all the resources in the resource tracker by
+ * identifying the zoom levels which is not valid for any monitor
+ *
+ * @noreference This method is not intended to be referenced by clients.
+ */
+public static void win32_destroyUnusedHandles(Display display) {
+	Set<Integer> availableZoomLevels = new HashSet<>();
+	for (Monitor monitor : display.getMonitors()) {
+	    availableZoomLevels.add(DPIUtil.getZoomForAutoscaleProperty(monitor.getZoom()));
+	}
+	for (Object object: ((Device) display).objects) {
+		if (object instanceof Resource resource) {
+			resource.destroyHandlesExcept(availableZoomLevels);
+		}
+	}
+}
 }
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java
index afed0488e7e..6d1153e4f73 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java	
@@ -1186,16 +1186,31 @@ void destroy () {
 
 private void destroyHandle () {
 	for (Long handle : zoomLevelToHandle.values()) {
-		if (type == SWT.ICON) {
-			OS.DestroyIcon (handle);
-		} else {
-			OS.DeleteObject (handle);
-		}
+		destroyHandle(handle);
 	}
 	zoomLevelToHandle.clear();
 	handle = 0;
 }
 
+@Override
+void destroyHandlesExcept(Set<Integer> zoomLevels) {
+	zoomLevelToHandle.entrySet().removeIf(entry -> {
+		if (!zoomLevels.contains(entry.getKey()) && entry.getKey() != DPIUtil.getZoomForAutoscaleProperty(initialNativeZoom)) {
+			destroyHandle(entry.getValue());
+            return true;
+        }
+        return false;
+	});
+}
+
+private void destroyHandle(long handle) {
+	if (type == SWT.ICON) {
+		OS.DestroyIcon (handle);
+	} else {
+		OS.DeleteObject (handle);
+	}
+}
+
 /**
  * Compares the argument to the receiver, and returns true
  * if they represent the <em>same</em> object using a class
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Path.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Path.java
index 54d392f09a6..79ef7756065 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Path.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Path.java	
@@ -438,6 +438,17 @@ void destroy() {
 	zoomLevelToHandle.clear();
 }
 
+@Override
+void destroyHandlesExcept(Set<Integer> zoomLevels) {
+	zoomLevelToHandle.entrySet().removeIf(entry -> {
+		if (!zoomLevels.contains(entry.getKey()) && entry.getKey() != initialZoom) {
+			Gdip.GraphicsPath_delete(entry.getValue());
+            return true;
+        }
+        return false;
+	});
+}
+
 /**
  * Replaces the first four elements in the parameter with values that
  * describe the smallest rectangle that will completely contain the
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Pattern.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Pattern.java
index 02a065f325f..0c1c43725af 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Pattern.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Pattern.java	
@@ -260,21 +260,7 @@ void setImageHandle(Image image, int zoom) {
 @Override
 void destroy() {
 	for (long handle: zoomLevelToHandle.values()) {
-		int type = Gdip.Brush_GetType(handle);
-		switch (type) {
-			case Gdip.BrushTypeSolidColor:
-				Gdip.SolidBrush_delete(handle);
-				break;
-			case Gdip.BrushTypeHatchFill:
-				Gdip.HatchBrush_delete(handle);
-				break;
-			case Gdip.BrushTypeLinearGradient:
-				Gdip.LinearGradientBrush_delete(handle);
-				break;
-			case Gdip.BrushTypeTextureFill:
-				Gdip.TextureBrush_delete(handle);
-				break;
-		}
+		destroyHandle(handle);
 	}
 	zoomLevelToHandle.clear();
 	if (bitmapDestructor != null) {
@@ -283,6 +269,35 @@ void destroy() {
 	}
 }
 
+@Override
+void destroyHandlesExcept(Set<Integer> zoomLevels) {
+	zoomLevelToHandle.entrySet().removeIf(entry -> {
+		if (!zoomLevels.contains(entry.getKey()) && entry.getKey() != initialZoom) {
+			destroyHandle(entry.getValue());
+            return true;
+        }
+        return false;
+	});
+}
+
+private void destroyHandle(long handle) {
+	int type = Gdip.Brush_GetType(handle);
+	switch (type) {
+		case Gdip.BrushTypeSolidColor:
+			Gdip.SolidBrush_delete(handle);
+			break;
+		case Gdip.BrushTypeHatchFill:
+			Gdip.HatchBrush_delete(handle);
+			break;
+		case Gdip.BrushTypeLinearGradient:
+			Gdip.LinearGradientBrush_delete(handle);
+			break;
+		case Gdip.BrushTypeTextureFill:
+			Gdip.TextureBrush_delete(handle);
+			break;
+	}
+}
+
 /**
  * Returns <code>true</code> if the Pattern has been disposed,
  * and <code>false</code> otherwise.
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java
index 6c726998146..7c0d161de96 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java	
@@ -227,6 +227,17 @@ void destroy () {
 	operations.clear();
 }
 
+@Override
+void destroyHandlesExcept(Set<Integer> zoomLevels) {
+	zoomToHandle.entrySet().removeIf(entry -> {
+		if (!zoomLevels.contains(entry.getKey()) && entry.getKey() != initialZoom) {
+			OS.DeleteObject(entry.getValue());
+            return true;
+        }
+        return false;
+	});
+}
+
 /**
  * Compares the argument to the receiver, and returns true
  * if they represent the <em>same</em> object using a class
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java
index 058974d7a0f..987fd761441 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java	
@@ -159,6 +159,17 @@ void destroy() {
 	zoomLevelToHandle.clear();
 }
 
+@Override
+void destroyHandlesExcept(Set<Integer> zoomLevels) {
+	zoomLevelToHandle.entrySet().removeIf(entry -> {
+		if (!zoomLevels.contains(entry.getKey()) && entry.getKey() != initialZoom) {
+			Gdip.Matrix_delete(entry.getValue());
+            return true;
+        }
+        return false;
+	});
+}
+
 /**
  * Fills the parameter with the values of the transformation matrix
  * that the receiver represents, in the order {m11, m12, m21, m22, dx, dy}.
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java
index 03c32a4c72d..9bb56a990f2 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java	
@@ -4901,6 +4901,7 @@ LRESULT WM_DPICHANGED (long wParam, long lParam) {
 	// Map DPI to Zoom and compare
 	int newNativeZoom = DPIUtil.mapDPIToZoom (OS.HIWORD (wParam));
 	if (getDisplay().isRescalingAtRuntime()) {
+		Device.win32_destroyUnusedHandles(getDisplay());
 		int oldNativeZoom = nativeZoom;
 		if (newNativeZoom != oldNativeZoom) {
 			DPIUtil.setDeviceZoom (newNativeZoom);