Skip to content

Replace and deprecate Image creating methods accepting Strings as file-system paths #1767

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Replace and deprecate Image creating methods accepting Strings as file-system paths #1767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5073e92
Use Path to represent file-system paths for ImageData creation
HannesWell Jan 25, 2025
6f0e9a0
Migrate off deprecated ImageData methods
HannesWell Mar 2, 2025
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
109 changes: 70 additions & 39 deletions bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Image.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@


import java.io.*;
import java.nio.file.Path;
import java.util.*;
import java.util.function.*;

Expand Down Expand Up @@ -129,9 +130,9 @@ public final class Image extends Resource implements Drawable {
static final int DEFAULT_SCANLINE_PAD = 4;

/**
* ImageFileNameProvider to provide file names at various Zoom levels
* ImageFileProvider to provide files at various Zoom levels
*/
private ImageFileNameProvider imageFileNameProvider;
private ImagePathProvider imageFileProvider;

/**
* ImageDataProvider to provide ImageData at various Zoom levels
Expand Down Expand Up @@ -390,11 +391,11 @@ public Image(Device device, Image srcImage, int flag) {
/* Create the 100% representation for the new image from source image & apply flag */
createRepFromSourceAndApplyFlag(srcImage.getRepresentation (100), srcWidth, srcHeight, flag);

imageFileNameProvider = srcImage.imageFileNameProvider;
imageFileProvider = srcImage.imageFileProvider;
imageDataProvider = srcImage.imageDataProvider;
imageGcDrawer = srcImage.imageGcDrawer;
this.styleFlag = srcImage.styleFlag | flag;
if (imageFileNameProvider != null || imageDataProvider != null ||srcImage.imageGcDrawer != null) {
if (imageFileProvider != null || imageDataProvider != null ||srcImage.imageGcDrawer != null) {
/* If source image has 200% representation then create the 200% representation for the new image & apply flag */
NSBitmapImageRep rep200 = srcImage.getRepresentation (200);
if (rep200 != null) createRepFromSourceAndApplyFlag(rep200, srcWidth * 2, srcHeight * 2, flag);
Expand Down Expand Up @@ -652,18 +653,11 @@ public Image(Device device, ImageData source, ImageData mask) {
* </p>
* <pre>
* static Image loadImage (Display display, Class clazz, String string) {
* InputStream stream = clazz.getResourceAsStream (string);
* if (stream == null) return null;
* Image image = null;
* try {
* image = new Image (display, stream);
* } catch (SWTException ex) {
* } finally {
* try {
* stream.close ();
* } catch (IOException ex) {}
* }
* return image;
* try (InputStream stream = clazz.getResourceAsStream(string)){
* if (stream == null) return null;
* return new Image (display, stream);
* } catch (SWTException | IOException ex) {
* }
* }
* </pre>
* <p>
Expand Down Expand Up @@ -698,8 +692,8 @@ public Image(Device device, InputStream stream) {
if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
try {
byte[] input = stream.readAllBytes();
initWithSupplier(zoom -> ImageDataLoader.canLoadAtZoom(new ByteArrayInputStream(input), FileFormat.DEFAULT_ZOOM, zoom),
zoom -> ImageDataLoader.load(new ByteArrayInputStream(input), FileFormat.DEFAULT_ZOOM, zoom).element());
initWithSupplier(zoom -> ImageLoader.canLoadAtZoom(new ByteArrayInputStream(input), FileFormat.DEFAULT_ZOOM, zoom),
zoom -> ImageData.load(new ByteArrayInputStream(input), FileFormat.DEFAULT_ZOOM, zoom).element());
init();
} catch (IOException e) {
SWT.error(SWT.ERROR_INVALID_ARGUMENT, e);
Expand Down Expand Up @@ -746,10 +740,11 @@ public Image(Device device, String filename) {
if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
try {
if (filename == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
initNative(filename);
Path file = Path.of(filename);
initNative(file);
if (this.handle == null) {
initWithSupplier(zoom -> ImageDataLoader.canLoadAtZoom(filename, FileFormat.DEFAULT_ZOOM, zoom),
zoom -> ImageDataLoader.load(filename, FileFormat.DEFAULT_ZOOM, zoom).element());
initWithSupplier(zoom -> ImageLoader.canLoadAtZoom(file, FileFormat.DEFAULT_ZOOM, zoom),
zoom -> ImageData.load(file, FileFormat.DEFAULT_ZOOM, zoom).element());
}
init();
} finally {
Expand Down Expand Up @@ -785,28 +780,63 @@ public Image(Device device, String filename) {
* <li>ERROR_NO_HANDLES if a handle could not be obtained for image creation</li>
* </ul>
* @since 3.104
* @deprecated Instead use {@link #Image(Device, ImagePathProvider)}
*/
@Deprecated(since = "2025-06")
public Image(Device device, ImageFileNameProvider imageFileNameProvider) {
this(device, ImageData.asImageFileProvider(imageFileNameProvider));
}

/**
* Constructs an instance of this class by loading its representation
* from the file retrieved from the {@link ImagePathProvider}. Throws an
* error if an error occurs while loading the image, or if the result
* is an image of an unsupported type.
* <p>
* This constructor is provided for convenience for loading image as
* per DPI level.
*
* @param device the device on which to create the image
* @param imageFileProvider the {@link ImagePathProvider} object that is
* to be used to get the file
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
* <li>ERROR_NULL_ARGUMENT - if the ImageFileNameProvider is null</li>
* <li>ERROR_INVALID_ARGUMENT - if the fileName provided by ImageFileNameProvider is null at 100% zoom</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_IO - if an IO error occurs while reading from the file</li>
* <li>ERROR_INVALID_IMAGE - if the image file contains invalid data </li>
* <li>ERROR_UNSUPPORTED_DEPTH - if the image file describes an image with an unsupported depth</li>
* <li>ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format</li>
* </ul>
* @exception SWTError <ul>
* <li>ERROR_NO_HANDLES if a handle could not be obtained for image creation</li>
* </ul>
* @since 3.130
*/
public Image(Device device, ImagePathProvider imageFileProvider) {
super(device);
if (imageFileNameProvider == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
this.imageFileNameProvider = imageFileNameProvider;
String filename = imageFileNameProvider.getImagePath(100);
if (filename == null) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
if (imageFileProvider == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
this.imageFileProvider = imageFileProvider;
Path file = imageFileProvider.getImagePath(100);
if (file == null) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
NSAutoreleasePool pool = null;
if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
try {
initNative(filename);
if (this.handle == null) init(ImageDataLoader.load(filename, 100, 100).element());
initNative(file);
if (this.handle == null) init(ImageData.load(file, 100, 100).element());
init();
String filename2x = imageFileNameProvider.getImagePath(200);
if (filename2x != null) {
Path file2x = imageFileProvider.getImagePath(200);
if (file2x != null) {
alphaInfo_200 = new AlphaInfo();
id id = NSImageRep.imageRepWithContentsOfFile(NSString.stringWith(filename2x));
id id = NSImageRep.imageRepWithContentsOfFile(NSString.stringWith(file2x.toString()));
NSImageRep rep = new NSImageRep(id);
handle.addRepresentation(rep);
} else if (ImageDataLoader.canLoadAtZoom(filename, 100, 200)) {
} else if (ImageLoader.canLoadAtZoom(file, 100, 200)) {
// Try to natively scale up the image (e.g. possible if it's an SVG)
ImageData imageData2x = ImageDataLoader.load(filename, 100, 200).element();
ImageData imageData2x = ImageData.load(file, 100, 200).element();
alphaInfo_200 = new AlphaInfo();
NSBitmapImageRep rep = createRepresentation (imageData2x, alphaInfo_200);
handle.addRepresentation(rep);
Expand Down Expand Up @@ -885,7 +915,7 @@ public Image(Device device, ImageDataProvider imageDataProvider) {
* <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
* <li>ERROR_NULL_ARGUMENT - if the ImageGcDrawer is null</li>
* </ul>
* @since 3.129
* @since 3.130
*/
public Image(Device device, ImageGcDrawer imageGcDrawer, int width, int height) {
super(device);
Expand Down Expand Up @@ -928,7 +958,7 @@ private ImageData drawWithImageGcDrawer(ImageGcDrawer imageGcDrawer, int width,

private AlphaInfo _getAlphaInfoAtCurrentZoom (NSBitmapImageRep rep) {
int deviceZoom = DPIUtil.getDeviceZoom();
if (deviceZoom != 100 && (imageFileNameProvider != null || imageDataProvider != null)) {
if (deviceZoom != 100 && (imageFileProvider != null || imageDataProvider != null)) {
if (alphaInfo_100.alphaData != null && alphaInfo_200 != null) {
if (alphaInfo_200.alphaData == null) initAlpha_200(rep);
return alphaInfo_200;
Expand Down Expand Up @@ -1202,8 +1232,8 @@ public boolean equals (Object object) {
if (device != image.device || alphaInfo_100.transparentPixel != image.alphaInfo_100.transparentPixel) return false;
if (imageDataProvider != null && image.imageDataProvider != null) {
return styleFlag == image.styleFlag && imageDataProvider.equals (image.imageDataProvider);
} else if (imageFileNameProvider != null && image.imageFileNameProvider != null) {
return styleFlag == image.styleFlag && imageFileNameProvider.equals (image.imageFileNameProvider);
} else if (imageFileProvider != null && image.imageFileProvider != null) {
return styleFlag == image.styleFlag && imageFileProvider.equals (image.imageFileProvider);
} else if (imageGcDrawer != null && image.imageGcDrawer != null) {
return styleFlag == image.styleFlag && imageGcDrawer.equals(image.imageGcDrawer) && width == image.width
&& height == image.height;
Expand Down Expand Up @@ -1441,8 +1471,8 @@ NSBitmapImageRep createImageRep(NSSize targetSize) {
public int hashCode () {
if (imageDataProvider != null) {
return imageDataProvider.hashCode();
} else if (imageFileNameProvider != null) {
return imageFileNameProvider.hashCode();
} else if (imageFileProvider != null) {
return imageFileProvider.hashCode();
} else if (imageGcDrawer != null) {
return Objects.hash(imageGcDrawer, height, width);
} else {
Expand Down Expand Up @@ -1546,7 +1576,8 @@ void initAlpha_100(NSBitmapImageRep nativeRep) {

}

void initNative(String filename) {
void initNative(Path file) {
String filename = file.toString();
NSAutoreleasePool pool = null;
NSImage nativeImage = null;

Expand Down
Loading
Loading