Add strict check 200% image data is double the size of 100% image data

A strict check to be used only for debugging means, this ensures the
imageData is scaled linearly for 100 and 200 zooms.

Author: arunjose696

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

@@ -290,9 +290,10 @@ private static ImageData autoScaleImageData (Device device, final ImageData imag
 	int height = imageData.height;
 	int scaledWidth = Math.round (width * scaleFactor);
 	int scaledHeight = Math.round (height * scaleFactor);
+	int defaultZoomLevel = 100;
 	boolean useSmoothScaling = isSmoothScalingEnabled() && imageData.getTransparencyType() != SWT.TRANSPARENCY_MASK;
 	if (useSmoothScaling) {
-		Image original = new Image (device, (ImageDataProvider) zoom -> imageData);
+		Image original = new Image(device, (ImageDataProvider) zoom -> (zoom == defaultZoomLevel) ? imageData : null);
 		ImageGcDrawer drawer =  new ImageGcDrawer() {
 			@Override
 			public void drawOn(GC gc, int imageWidth, int imageHeight) {
@@ -306,7 +307,7 @@ public int getGcStyle() {
 			}
 		};
 		Image resultImage = new Image (device, drawer, scaledWidth, scaledHeight);
-		ImageData result = resultImage.getImageData (100);
+		ImageData result = resultImage.getImageData (defaultZoomLevel);
 		original.dispose ();
 		resultImage.dispose ();
 		return result;

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

@@ -610,10 +610,29 @@ public Image(Device device, ImageDataProvider imageDataProvider) {
 		SWT.error(SWT.ERROR_INVALID_ARGUMENT, null,
 				": ImageDataProvider [" + imageDataProvider + "] returns null ImageData at 100% zoom.");
 	}
+	if (Device.strictChecks) {
+		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("ImageData should be linearly scaled across zooms.");
+	}
+}
+
 /**
  * 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
@@ -1707,7 +1726,7 @@ private long configureGC(GCData data, int zoom) {
 		SWT.error(SWT.ERROR_INVALID_ARGUMENT);
 	}
 
-	if (Device.strictChecks) {
+	if(Device.strictChecks) {
 		checkImageTypeForValidCustomDrawing(zoom);
 	}
 	/* Create a compatible HDC for the device */
@@ -1885,6 +1904,11 @@ public Collection<Integer> getPreservedZoomLevels() {
 	abstract AbstractImageProviderWrapper createCopy(Image image);
 
 	ImageData getScaledImageData (int zoom) {
+		// if a GC is initialized with an Image (memGC != null), the image data must not be resized, because it would
+		// be a destructive operation. Therefor, always the current image data must be returned
+		if (memGC != null) {
+			return getImageDataAtCurrentZoom();
+		}
 		TreeSet<Integer> availableZooms = new TreeSet<>(zoomLevelToImageHandle.keySet());
 		int closestZoom = Optional.ofNullable(availableZooms.higher(zoom)).orElse(availableZooms.lower(zoom));
 		return DPIUtil.scaleImageData(device, getImageMetadata(closestZoom).getImageData(), zoom, closestZoom);
@@ -2118,11 +2142,6 @@ ImageData newImageData(int zoom) {
 		if (zoomLevelToImageHandle.isEmpty()) {
 			return createBaseHandle(zoom).getImageData();
 		}
-		// if a GC is initialized with an Image (memGC != null), the image data must not be resized, because it would
-		// be a destructive operation. Therefor, a new handle is created for the requested zoom
-		if (memGC != null) {
-			return newImageHandle(zoom).getImageData();
-		}
 		return getScaledImageData(zoom);
 	}
 
@@ -2131,28 +2150,18 @@ protected ImageHandle newImageHandle(int zoom) {
 		if (zoomLevelToImageHandle.isEmpty()) {
 			return createBaseHandle(zoom);
 		}
-		if (memGC != null) {
-			GC currentGC = memGC;
-			memGC = null;
-			createHandle(zoom);
-			currentGC.refreshFor(new DrawableWrapper(Image.this, zoom), zoom);
-			return zoomLevelToImageHandle.get(zoom);
-		}
 		return super.newImageHandle(zoom);
 	}
+
 	private ImageHandle createBaseHandle(int zoom) {
+		long handle = initBaseHandle(zoom);
 		baseZoom = zoom;
-		return createHandle(zoom);
-	}
-
-	private ImageHandle createHandle(int zoom) {
-		long handle = initHandle(zoom);
 		ImageHandle imageHandle = new ImageHandle(handle, zoom);
 		zoomLevelToImageHandle.put(zoom, imageHandle);
 		return imageHandle;
 	}
 
-	private long initHandle(int zoom) {
+	private long initBaseHandle(int zoom) {
 		if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED);
 		int scaledWidth = DPIUtil.scaleUp (width, zoom);
 		int scaledHeight = DPIUtil.scaleUp (height, zoom);
@@ -2564,6 +2573,7 @@ protected ImageHandle newImageHandle(int zoom) {
 		}
 		GC gc = new GC(new DrawableWrapper(image, zoom), gcStyle);
 		try {
+			gc.data.nativeZoom = zoom;
 			drawer.drawOn(gc, width, height);
 			ImageData imageData = image.getImageMetadata(zoom).getImageData();
 			drawer.postProcess(imageData);
@@ -2575,6 +2585,26 @@ protected ImageHandle newImageHandle(int zoom) {
 		}
 	}
 
+	private class DrawableWrapper implements Drawable {
+		private final Image image;
+		private final int zoom;
+
+		public DrawableWrapper(Image image, int zoom) {
+			this.image = image;
+			this.zoom = zoom;
+		}
+
+		@Override
+		public long internal_new_GC(GCData data) {
+			return this.image.configureGC(data, zoom);
+		}
+
+		@Override
+		public void internal_dispose_GC(long handle, GCData data) {
+			this.image.internal_dispose_GC(handle, data);
+		}
+	}
+
 	@Override
 	Object getProvider() {
 		return drawer;
@@ -2597,26 +2627,6 @@ public boolean equals(Object otherProvider) {
 	}
 }
 
-private static class DrawableWrapper implements Drawable {
-	private final Image image;
-	private final int zoom;
-
-	public DrawableWrapper(Image image, int zoom) {
-		this.image = image;
-		this.zoom = zoom;
-	}
-
-	@Override
-	public long internal_new_GC(GCData data) {
-		return this.image.configureGC(data, zoom);
-	}
-
-	@Override
-	public void internal_dispose_GC(long handle, GCData data) {
-		this.image.internal_dispose_GC(handle, data);
-	}
-}
-
 private class ImageHandle {
 	private long handle;
 	private final int zoom;

tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/Test_org_eclipse_swt_graphics_Image.java

@@ -1043,13 +1043,15 @@ public void test_imageDataIsCached() {
 public void test_imageDataSameViaDifferentProviders() {
 	assumeFalse("Cocoa generates inconsistent image data", SwtTestUtil.isCocoa);
 	String imagePath = getPath("collapseall.png");
-	ImageFileNameProvider imageFileNameProvider = __ -> {
-		return imagePath;
+	ImageFileNameProvider imageFileNameProvider = zoom -> {
+		return (zoom == 100) ? imagePath : null;
 	};
-	ImageDataProvider dataProvider = __ -> {
-		try (InputStream imageStream = Files.newInputStream(Path.of(imagePath))) {
-			return new ImageData(imageStream);
-		} catch (IOException e) {
+	ImageDataProvider dataProvider = zoom -> {
+		if (zoom == 100) {
+			try (InputStream imageStream = Files.newInputStream(Path.of(imagePath))) {
+				return new ImageData(imageStream);
+			} catch (IOException e) {
+			}
 		}
 		return null;
 	};

tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/Test_org_eclipse_swt_graphics_ImageData.java

@@ -24,6 +24,9 @@
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThrows;
+import static org.junit.Assert.fail;
+import static org.junit.Assume.assumeNotNull;
+import static org.junit.Assume.assumeTrue;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -32,8 +35,10 @@
 
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.SWTException;
+import org.eclipse.swt.graphics.GC;
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.swt.graphics.ImageData;
+import org.eclipse.swt.graphics.ImageDataProvider;
 import org.eclipse.swt.graphics.PaletteData;
 import org.eclipse.swt.graphics.RGB;
 import org.eclipse.swt.tests.graphics.ImageDataTestHelper;
@@ -799,6 +804,40 @@ public void test_setAlphaIII() {
 	assertSWTProblem("Incorrect exception thrown for putWidth < 0", SWT.ERROR_INVALID_ARGUMENT, ex);
 }
 
+@Test
+public void test_ImageCreationFailsWithNonScalingImageDataProviderWhenStrictCheckIsEnabled() {
+	assumeNotNull(System.getProperty("org.eclipse.swt.internal.enableStrictChecks"));
+	Display display = Display.getDefault();
+	GC gc = new GC(display);
+	try {
+		ImageDataProvider wrongDataProvider = (zoom) -> new ImageData(16, 16, 32, new PaletteData());
+		Image image = new Image(display, wrongDataProvider);
+		image.dispose();
+		fail("Expected an exception due to non-linearly scaled image data provider");
+	} catch (IllegalArgumentException | SWTException e) {
+	} finally {
+		gc.dispose();
+		display.dispose();
+	}
+}
+
+@Test
+public void test_ImageCreationSucceedsWithNonScalingImageDataProviderWhenStrictCheckIsDisabled() {
+	assumeTrue(System.getProperty("org.eclipse.swt.internal.enableStrictChecks") == null);
+	Display display = Display.getDefault();
+	GC gc = new GC(display);
+	try {
+		ImageDataProvider wrongDataProvider = (zoom) -> new ImageData(16, 16, 32, new PaletteData());
+		Image image = new Image(display, wrongDataProvider);
+		image.dispose();
+	} catch (IllegalArgumentException | SWTException e) {
+		fail("Image creation is expected to succeed without strict checks, even for a non-scaling ImageDataProvider.");
+	} finally {
+		gc.dispose();
+		display.dispose();
+	}
+}
+
 @Test
 public void test_setPixelIII() {
 	int value;

tests/org.eclipse.swt.tests/JUnit Tests/org/eclipse/swt/tests/junit/Test_org_eclipse_swt_internal_SVGRasterizer.java

@@ -54,17 +54,11 @@ public void test_ConstructorLorg_eclipse_swt_graphics_Device_ImageFileNameProvid
 
 	@Test
 	public void test_ConstructorLorg_eclipse_swt_graphics_Device_ImageDataProvider() {
-		ImageDataProvider validImageDataProvider = zoom -> {
-			String fileName = "collapseall.svg";
-			return new ImageData(getPath(fileName));
-		};
+		ImageDataProvider validImageDataProvider = zoom -> (zoom == 100) ? new ImageData(getPath("collapseall.svg")) : null;
 		Image image = new Image(Display.getDefault(), validImageDataProvider);
 		image.dispose();
 
-		ImageDataProvider corruptImageDataProvider = zoom -> {
-			String fileName = "corrupt.svg";
-			return new ImageData(getPath(fileName));
-		};
+		ImageDataProvider corruptImageDataProvider = zoom -> (zoom == 100) ? new ImageData(getPath("corrupt.svg")) : null;
 		SWTException e = assertThrows(SWTException.class,
 				() -> new Image(Display.getDefault(), corruptImageDataProvider));
 		assertSWTProblem("Incorrect exception thrown for provider with corrupt images", SWT.ERROR_INVALID_IMAGE, e);