Update ImageDataProvider contract

Clarify in the contract that ImageDataProvider implementations are
expected
to return linearly scaled ImageData based on the zoom level.

This commit also extends the strict checks for verifying linear scaling
to GTK and Cocoa implementations.

Author: arunjose696

bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java

@@ -27,6 +27,7 @@
  */
 public abstract class Device implements Drawable {
 
+	protected static boolean strictChecks = System.getProperty("org.eclipse.swt.internal.enableStrictChecks") != null;
 	/* Debugging */
 	public static boolean DEBUG;
 	boolean debug = DEBUG;

bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Image.java

@@ -850,6 +850,9 @@ public Image(Device device, ImageDataProvider imageDataProvider) {
 	try {
 		init (data, 100);
 		init ();
+		if (Device.strictChecks) {
+			DPIUtil.validateLinearScaling(imageDataProvider);
+		}
 		ImageData data2x = imageDataProvider.getImageData (200);
 		if (data2x != null) {
 			alphaInfo_200 = new AlphaInfo();
@@ -1822,12 +1825,15 @@ public String toString () {
  * @noreference This method is not intended to be referenced by clients.
  */
 public static void drawScaled(GC gc, ImageData imageData, int width, int height, float scaleFactor) {
+	boolean originalStrictChecks = Device.strictChecks;
+	Device.strictChecks = false;
 	Image imageToDraw = new Image(gc.device, (ImageDataProvider) zoom ->  imageData);
 	gc.drawImage (imageToDraw, 0, 0, CocoaDPIUtil.pixelToPoint (width), CocoaDPIUtil.pixelToPoint (height),
 			/* E.g. destWidth here is effectively DPIUtil.autoScaleDown (scaledWidth), but avoiding rounding errors.
 			 * Nevertheless, we still have some rounding errors due to the point-based API GC#drawImage(..).
 			 */
 			0, 0, Math.round (CocoaDPIUtil.pixelToPoint (width * scaleFactor)), Math.round (CocoaDPIUtil.pixelToPoint (height * scaleFactor)));
+	Device.strictChecks = originalStrictChecks;
 	imageToDraw.dispose();
 }
 

bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/graphics/ImageDataProvider.java

@@ -28,16 +28,31 @@ public interface ImageDataProvider {
 
 	/**
 	 * Returns the image data for the given zoom level.
-	 * <p>
-	 * If no image is available for a particular zoom level, this method should
-	 * return <code>null</code>. For <code>zoom == 100</code>, returning
-	 * <code>null</code> is not allowed, and SWT will throw an exception.
+	 *
+	 * <ul>
+     *   <li>
+     *     If no image is available for a particular zoom level, this method should
+     *     return <code>null</code>. For <code>zoom == 100</code>, returning
+     *     <code>null</code> is not allowed, and SWT will throw an exception.
+     *   </li>
+     *   <li>
+     *     Implementations are expected to return {@link ImageData} that is
+     *     <b>linearly scaled</b> with respect to the zoom level.
+     *     For example, if <code>getImageData(100)</code> returns an image of
+     *     width <code>w</code> and height <code>h</code>, then
+     *     <code>getImageData(200)</code> must return an {@link ImageData}
+     *     of width <code>2 * w</code> and height <code>2 * h</code>,
+     *     if a non-{@code null} result is returned.
+     *   </li>
+     * </ul>
+	 *
 	 *
 	 * @param zoom
 	 *            The zoom level in % of the standard resolution (which is 1
 	 *            physical monitor pixel == 1 SWT logical point). Typically 100,
 	 *            150, or 200.
-	 * @return the image data, or <code>null</code> if <code>zoom != 100</code>
+	 * @return the linearly scaled image data for the given zoom level,
+	 *         or <code>null</code> if <code>zoom != 100</code>
 	 *         and no image is available for the given zoom level.
 	 * @since 3.104
 	 */

bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/internal/DPIUtil.java

@@ -223,6 +223,26 @@ public static int mapZoomToDPI (int zoom) {
 	return roundedDpi;
 }
 
+public static void validateLinearScaling(ImageDataProvider provider) {
+	final int baseZoom = 100;
+	final int scaledZoom = 200;
+	final int scaleFactor = scaledZoom / baseZoom;
+	ImageData baseImageData = provider.getImageData(baseZoom);
+	ImageData scaledImageData = provider.getImageData(scaledZoom);
+
+	if (scaledImageData == null) {
+		return;
+	}
+
+	if (scaledImageData.width != scaleFactor * baseImageData.width
+			|| scaledImageData.height != scaleFactor * baseImageData.height) {
+		System.err.println(String.format(
+				"***WARNING: ImageData should be linearly scaled across zooms but size is (%d, %d) at 100%% and (%d, %d) at 200%%.",
+				baseImageData.width, baseImageData.height, scaledImageData.width, scaledImageData.height));
+		new Error().printStackTrace(System.err);
+	}
+}
+
 /**
  * Represents an element, such as some image data, at a specific zoom level.
  *

bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Device.java

@@ -33,6 +33,7 @@
  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
  */
 public abstract class Device implements Drawable {
+	protected static boolean strictChecks = System.getProperty("org.eclipse.swt.internal.enableStrictChecks") != null;
 	/**
 	 * @noreference This field is not intended to be referenced by clients.
 	 * @since 3.105

bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Image.java

@@ -672,6 +672,9 @@ public Image(Device device, ImageDataProvider imageDataProvider) {
 	currentDeviceZoom = DPIUtil.getDeviceZoom();
 	initFromImageDataProvider(currentDeviceZoom);
 	init ();
+	if (Device.strictChecks) {
+		DPIUtil.validateLinearScaling(imageDataProvider);
+	}
 }
 
 /**
@@ -1583,12 +1586,15 @@ public String toString () {
  * @noreference This method is not intended to be referenced by clients.
  */
 public static void drawScaled(GC gc, ImageData imageData, int width, int height, float scaleFactor) {
+	boolean originalStrictChecks = Device.strictChecks;
+	Device.strictChecks = false;
 	Image imageToDraw = new Image(gc.device, (ImageDataProvider) zoom -> imageData);
 	gc.drawImage (imageToDraw, 0, 0, width, height,
 			/* E.g. destWidth here is effectively DPIUtil.autoScaleDown (scaledWidth), but avoiding rounding errors.
 			 * Nevertheless, we still have some rounding errors due to the point-based API GC#drawImage(..).
 			 */
 			0, 0, Math.round (width * scaleFactor), Math.round (height * scaleFactor));
+	Device.strictChecks = originalStrictChecks;
 	imageToDraw.dispose();
 }
 

bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Display.java

@@ -116,8 +116,6 @@
  */
 public class Display extends Device implements Executor {
 
-	static boolean strictChecks = System.getProperty("org.eclipse.swt.internal.enableStrictChecks") != null;
-
 	private static final int SLOT_IN_USE = -2;
 	private static final int LAST_TABLE_INDEX = -1;
 
@@ -880,7 +878,7 @@ void addWidget (long handle, Widget widget) {
 		widgetTable = newWidgetTable;
 	}
 	int index = freeSlot + 1;
-	if(strictChecks) {
+	if(Display.strictChecks) {
 		long data = OS.g_object_get_qdata (handle, SWT_OBJECT_INDEX);
 		if(data > 0 && data != index) {
 			SWT.error(SWT.ERROR_INVALID_ARGUMENT, null, ". Potential leak of " + widget + debugInfoForIndex(data - 1));

bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java

@@ -34,7 +34,7 @@
  */
 public abstract class Device implements Drawable {
 
-	static boolean strictChecks = System.getProperty("org.eclipse.swt.internal.enableStrictChecks") != null;
+	protected static boolean strictChecks = System.getProperty("org.eclipse.swt.internal.enableStrictChecks") != null;
 
 	/* Debugging */
 	public static boolean DEBUG;

bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java

@@ -613,32 +613,12 @@ public Image(Device device, ImageDataProvider imageDataProvider) {
 				": ImageDataProvider [" + imageDataProvider + "] returns null ImageData at 100% zoom.");
 	}
 	if (Device.strictChecks) {
-		validateLinearScaling(imageDataProvider);
+		DPIUtil.validateLinearScaling(imageDataProvider);
 	}
 	init();
 	this.device.registerResourceWithZoomSupport(this);
 }
 
-private void validateLinearScaling(ImageDataProvider provider) {
-	final int baseZoom = 100;
-	final int scaledZoom = 200;
-	final int scaleFactor = scaledZoom / baseZoom;
-	ImageData baseImageData = provider.getImageData(baseZoom);
-	ImageData scaledImageData = provider.getImageData(scaledZoom);
-
-	if (scaledImageData == null) {
-		return;
-	}
-
-	if (scaledImageData.width != scaleFactor * baseImageData.width
-			|| scaledImageData.height != scaleFactor * baseImageData.height) {
-		System.err.println(String.format(
-				"***WARNING: ImageData should be linearly scaled across zooms but size is (%d, %d) at 100%% and (%d, %d) at 200%%.",
-				baseImageData.width, baseImageData.height, scaledImageData.width, scaledImageData.height));
-		new Error().printStackTrace(System.err);
-	}
-}
-
 /**
  * The provided ImageGcDrawer will be called on demand whenever a new variant of the
  * Image for an additional zoom is required. Depending on the OS-specific implementation