Delegating Image(Display, String) to ImageFileNameProvider to init Image

[ShahzaibIbrahim]

In GTK and Cocoa, an image based on an SVG passed as filename to Image(Device, String) will be drawn now sharply with this change.

Contributes to #2917

How to Test

Run this Snippet on Windows, Mac and Linux and compare the results:

import java.nio.file.Path;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageFileNameProvider;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

public class SVGImageTests {
    
    public static void main(String[] args) throws Exception {
        final Display display = new Display();

        final Shell shell = new Shell(display);
        shell.setText("SVG Image Test");
        shell.setLayout(new FillLayout());
        shell.setBounds(250, 50, 1000, 400);
        shell.setBackground(new Color(255, 255, 255));
        
        String imgPath = "image.svg";
        Path fullPath = Path.of(SVGImageTests.class.getResource(imgPath).toURI());

        // Image loaded in file path
        Image image2 = new Image(display, fullPath.toString());
        
        // Image loaded in ImageFileNameProvider
        Image image3 = new Image(display, (ImageFileNameProvider) zoom -> {
            return zoom == 100 ? fullPath.toString() : null;
        });
        
        shell.addPaintListener(e -> {            
            e.gc.drawImage(image2, 340, 10, 300, 300);
            e.gc.drawText("Image(Display, String)", 420, 300);
            
            e.gc.drawImage(image3, 660, 10, 300, 300);
            e.gc.drawText("Image(Display, ImageFileNameProvider)", 700, 300);
        });
        
        shell.open();

        while(!shell.isDisposed()) {
            if(!display.readAndDispatch()) {
                display.sleep();
            }
        }

        display.dispose();
    }
}

Use this SVG image for the Snippet:

Here's the outputs...

On Windows all Image methods result in sharp output:

On Mac only using ImageFileNameProvider is sharp:

On Linux only using ImageFileNameProvider is sharp:

After Fix

Image use for testing:

GTK:

Cocoa:

[fedejeanne]

On Mac it looks like this

[ShahzaibIbrahim]

On Mac it looks like this

Thank you @fedejeanne for testing on Mac. I will be using your screenshot for my PR description.

[github-actions]

Test Results (macos)

   54 files  ±0     54 suites  ±0   12m 5s ⏱️ + 2m 47s
4 513 tests ±0  4 270 ✅ ±0  243 💤 ±0  0 ❌ ±0 
  104 runs  ±0    104 ✅ ±0    0 💤 ±0  0 ❌ ±0 

Results for commit 538ea4b. ± Comparison against base commit 49718cc.

♻️ This comment has been updated with latest results.

[github-actions]

Test Results (linux)

   88 files  ±0     88 suites  ±0   14m 17s ⏱️ -7s
4 557 tests ±0  4 337 ✅ ±0  220 💤 ±0  0 ❌ ±0 
  211 runs  ±0    208 ✅ ±0    3 💤 ±0  0 ❌ ±0 

Results for commit 538ea4b. ± Comparison against base commit 49718cc.

♻️ This comment has been updated with latest results.

[Phillipus]

I tested my original Snippet on Mac and the quality is as good as ImageFileNameProvider:

[Phillipus]

And on Linux it also looks good:

[HeikoKlare]

This PR currently seems to lack a reference to the original issue (#2917). Would be nice to have it referenced in the commit and PR message.

I think it would also be great to add that snippet or a comparable one to the SWT snippets (may be done in a separate PR). If I am not mistaken, we have no snippet for testing SVG behavior yet, which is also why the snippets do not contain any SVG test image, so everytime you want to try something you have to copy one over. @Phillipus as you provided an extended version of the snippet in the reported issue, maybe you want to contribute it to the snippets project?

[Phillipus]

@Phillipus as you provided an extended version of the snippet in the reported issue, maybe you want to contribute it to the snippets project?

#2926

[ShahzaibIbrahim]

This PR currently seems to lack a reference to the original issue (#2917). Would be nice to have it referenced in the commit and PR message.

Adapted the commit message to reference original issue.

[HeikoKlare]

The change looks fine and straightforward. I have a minor comment regarding the kind of refactoring (consistency with existing code structure) in the Cocoa implementation.

[HeikoKlare]

Implementation still looks good and works as expected on MacOS as well. I only have minor comments left.

[HeikoKlare]

Code still looks good after recent changes
@ShahzaibIbrahim could you please use a proper tag for the issue reference, i.e., not use "resolves" but rather "contributes to" or the like? Since there is more necessary to resolve that issue (at least the other PR for input stream) this tag would currently close the issue (and is actually a bit misleading as it does not fully resolve the issue).

[HeikoKlare]

I adapted the PR message to not resolve the referenced issue that is only partly addressed by this. Except for that, this is fine now.

[Phillipus]

Pull request successfully merged and closed

Thank-you @ShahzaibIbrahim @HeikoKlare @fedejeanne