Skip to content

[Win32] Ensure consistent image data returned for data-based images #1996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1878,14 +1878,18 @@ ImageData getScaledImageData (int zoom) {

protected ImageHandle newImageHandle(int zoom) {
ImageData resizedData = getImageData(zoom);
if (type == SWT.ICON && resizedData.getTransparencyType() != SWT.TRANSPARENCY_MASK) {
return newImageHandle(resizedData, zoom);
}

protected final ImageHandle newImageHandle(ImageData data, int zoom) {
if (type == SWT.ICON && data.getTransparencyType() != SWT.TRANSPARENCY_MASK) {
// If the original type was an icon with transparency mask and re-scaling leads
// to image data without transparency mask, this will create invalid images
// so this fallback will "repair" the image data by explicitly passing
// the transparency mask created from the scaled image data
return initIconHandle(device, resizedData, resizedData.getTransparencyMask(), zoom);
return initIconHandle(device, data, data.getTransparencyMask(), zoom);
} else {
return init(resizedData, zoom);
return init(data, zoom);
}
}

Expand Down Expand Up @@ -1933,26 +1937,43 @@ AbstractImageProviderWrapper createCopy(Image image) {
}

private abstract class ImageFromImageDataProviderWrapper extends AbstractImageProviderWrapper {
private final Map<Integer, ImageData> cachedImageData = new HashMap<>();

protected abstract ElementAtZoom<ImageData> loadImageData(int zoom);

void initImage() {
// As the init call configured some Image attributes (e.g. type)
// it must be called
ImageData imageDataAt100 = getImageData(100);
init(imageDataAt100, 100);
destroyHandleForZoom(100);
getImageData(100);
}

@Override
ImageData newImageData(int zoom) {
if (!zoomLevelToImageHandle.isEmpty()) {
return getScaledImageData(zoom);
Function<Integer, ImageData> imageDataRetrieval = zoomToRetrieve -> {
ImageHandle handle = initializeHandleFromSource(zoomToRetrieve);
ImageData data = handle.getImageData();
destroyHandleForZoom(zoomToRetrieve);
return data;
};
return cachedImageData.computeIfAbsent(zoom, imageDataRetrieval);
}

@Override
protected ImageHandle newImageHandle(int zoom) {
ImageData cachedData = cachedImageData.remove(zoom);
if (cachedData != null) {
return newImageHandle(cachedData, zoom);
}
ElementAtZoom<ImageData> loadedImageData = loadImageData(zoom);
ImageData scaledImageData = DPIUtil.scaleImageData(device, loadedImageData, zoom);
return adaptImageDataIfDisabledOrGray(scaledImageData);
return initializeHandleFromSource(zoom);
}

private ImageHandle initializeHandleFromSource(int zoom) {
ElementAtZoom<ImageData> imageDataAtZoom = loadImageData(zoom);
ImageData imageData = DPIUtil.scaleImageData(device, imageDataAtZoom.element(), zoom, imageDataAtZoom.zoom());
imageData = adaptImageDataIfDisabledOrGray(imageData);
return newImageHandle(imageData, zoom);
}

}

private class PlainImageDataProviderWrapper extends ImageFromImageDataProviderWrapper {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1033,6 +1033,31 @@ public void test_imageDataSameViaDifferentProviders() {
dataProviderImage.dispose();
}

@Test
public void test_imageDataSameViaProviderAndSimpleData() {
assumeFalse("Cocoa generates inconsistent image data", SwtTestUtil.isCocoa);
String imagePath = getPath("collapseall.png");
ImageFileNameProvider imageFileNameProvider = __ -> {
return imagePath;
};
ImageDataProvider dataProvider = __ -> {
try (InputStream imageStream = Files.newInputStream(Path.of(imagePath))) {
return new ImageData(imageStream);
} catch (IOException e) {
}
return null;
};
Image fileNameProviderImage = new Image(display, imageFileNameProvider);
Image dataImage = new Image(display, dataProvider.getImageData(100));
ImageData dataFromFileNameProviderImage = fileNameProviderImage.getImageData(100);
ImageData dataFromImageWithSimpleData = dataImage.getImageData(100);
assertEquals(0, imageDataComparator().compare(dataFromFileNameProviderImage, dataFromImageWithSimpleData));

fileNameProviderImage.dispose();
dataImage.dispose();
}


private Comparator<ImageData> imageDataComparator() {
return Comparator.<ImageData>comparingInt(d -> d.width) //
.thenComparing(d -> d.height) //
Expand Down
Loading