Repository navigation
Allow rewriting image URLs via an IImageURLModifier strategy #4399
+361
−10
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||
| /******************************************************************************* | ||||||
| * Copyright (c) 2026 vogella GmbH and others. | ||||||
| * | ||||||
| * This program and the accompanying materials | ||||||
| * are made available under the terms of the Eclipse Public License 2.0 | ||||||
| * which accompanies this distribution, and is available at | ||||||
| * https://www.eclipse.org/legal/epl-2.0/ | ||||||
| * | ||||||
| * SPDX-License-Identifier: EPL-2.0 | ||||||
| * | ||||||
| * Contributors: | ||||||
| * Lars Vogel <Lars.Vogel@vogella.com> - initial API and implementation | ||||||
| *******************************************************************************/ | ||||||
| package org.eclipse.jface.internal.provisional.resource; | ||||||
|
|
||||||
| import java.net.URL; | ||||||
|
|
||||||
| /** | ||||||
| * Rewrites image URLs before they are loaded, so icons can be substituted | ||||||
| * without changing the code that creates the image descriptors. The E4 | ||||||
| * workbench installs the highest ranked OSGi service of this type. | ||||||
| * | ||||||
| * @see ImageURLModifiers#setURLModifier(IImageURLModifier) | ||||||
| */ | ||||||
| @FunctionalInterface | ||||||
| public interface IImageURLModifier { | ||||||
|
|
||||||
| /** | ||||||
| * Returns the URL to load instead of the given one, or <code>null</code> to | ||||||
| * keep it. Called for every image load, so it must be fast and thread-safe. | ||||||
| * | ||||||
| * @param originalURL the URL the image would be loaded from | ||||||
| * @return the replacement URL, or <code>null</code> to keep the original | ||||||
| */ | ||||||
| URL modifyURL(URL originalURL); | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
to make the optional nature of the return value clear. |
||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,44 @@ | ||||||
| /******************************************************************************* | ||||||
| * Copyright (c) 2026 vogella GmbH and others. | ||||||
| * | ||||||
| * This program and the accompanying materials | ||||||
| * are made available under the terms of the Eclipse Public License 2.0 | ||||||
| * which accompanies this distribution, and is available at | ||||||
| * https://www.eclipse.org/legal/epl-2.0/ | ||||||
| * | ||||||
| * SPDX-License-Identifier: EPL-2.0 | ||||||
| * | ||||||
| * Contributors: | ||||||
| * Lars Vogel <Lars.Vogel@vogella.com> - initial API and implementation | ||||||
| *******************************************************************************/ | ||||||
| package org.eclipse.jface.internal.provisional.resource; | ||||||
|
|
||||||
| /** | ||||||
| * Holds the {@link IImageURLModifier} consulted when an image is loaded from a | ||||||
| * URL. | ||||||
| */ | ||||||
| public final class ImageURLModifiers { | ||||||
|
Contributor
There was a problem hiding this comment. In general I wonder if this whole logic is not better placed at |
||||||
|
|
||||||
| /** Read from any thread. */ | ||||||
| private static volatile IImageURLModifier urlModifier; | ||||||
|
|
||||||
| private ImageURLModifiers() { | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Installs the modifier consulted when an image is loaded from a URL. Images | ||||||
| * created before are not reloaded. | ||||||
| * | ||||||
| * @param modifier the modifier, or <code>null</code> to remove it | ||||||
| */ | ||||||
| public static void setURLModifier(IImageURLModifier modifier) { | ||||||
| urlModifier = modifier; | ||||||
|
Contributor
There was a problem hiding this comment. Should we allow this to change anytime during the lifecycle or go a similar way like URL Protocol factories does that is you can only set a value if it is currently unset / |
||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @return the installed modifier, or <code>null</code> if none is installed | ||||||
| */ | ||||||
| public static IImageURLModifier getURLModifier() { | ||||||
|
Contributor
There was a problem hiding this comment. I think @ruspl-afed would say we should not add any (provisional) API that returns null for missing and instead use
Suggested change
|
||||||
| return urlModifier; | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,6 +33,7 @@ | |
| import org.eclipse.e4.ui.tests.workbench.ExtensionsSortTests; | ||
| import org.eclipse.e4.ui.tests.workbench.HandlerActivationTest; | ||
| import org.eclipse.e4.ui.tests.workbench.HandlerTest; | ||
| import org.eclipse.e4.ui.tests.workbench.ImageURLModifierTrackerTest; | ||
| import org.eclipse.e4.ui.tests.workbench.InjectionEventTest; | ||
| import org.eclipse.e4.ui.tests.workbench.MApplicationCommandAccessTest; | ||
| import org.eclipse.e4.ui.tests.workbench.MMenuItemTest; | ||
|
|
@@ -101,6 +102,7 @@ | |
| ExtensionsSortTests.class, | ||
| HandlerActivationTest.class, | ||
| ModelAssemblerTests.class, | ||
| ImageURLModifierTrackerTest.class, | ||
| ModelAssemblerFragmentOrderingTests.class, | ||
| E4ResourceTest.class, | ||
| AreaRendererTest.class, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2026 vogella GmbH and others. | ||
| * | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License 2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Lars Vogel <Lars.Vogel@vogella.com> - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.e4.ui.tests.workbench; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| import java.net.URI; | ||
| import java.net.URL; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.core.runtime.Adapters; | ||
| import org.eclipse.core.runtime.Platform; | ||
| import org.eclipse.jface.internal.provisional.resource.IImageURLModifier; | ||
| import org.eclipse.jface.resource.ImageDescriptor; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.osgi.framework.Bundle; | ||
| import org.osgi.framework.BundleContext; | ||
| import org.osgi.framework.Constants; | ||
| import org.osgi.framework.FrameworkUtil; | ||
| import org.osgi.framework.ServiceRegistration; | ||
|
|
||
| /** | ||
| * Tests that the E4 workbench installs the highest ranked | ||
| * {@link IImageURLModifier} service in JFace. | ||
| */ | ||
| public class ImageURLModifierTrackerTest { | ||
|
|
||
| private final BundleContext context = FrameworkUtil.getBundle(ImageURLModifierTrackerTest.class) | ||
| .getBundleContext(); | ||
| private final List<ServiceRegistration<IImageURLModifier>> registrations = new ArrayList<>(); | ||
| private ImageDescriptor descriptor; | ||
|
|
||
| @BeforeAll | ||
| public static void startWorkbenchBundle() throws Exception { | ||
| // lazily activated, and earlier tests may not have loaded its classes | ||
| Platform.getBundle("org.eclipse.e4.ui.workbench.swt").start(Bundle.START_TRANSIENT); | ||
| } | ||
|
|
||
| @BeforeEach | ||
| public void setUp() throws Exception { | ||
| descriptor = ImageDescriptor.createFromURL(URI.create("file:/original.png").toURL()); | ||
| } | ||
|
|
||
| @AfterEach | ||
| public void tearDown() { | ||
| for (ServiceRegistration<IImageURLModifier> registration : registrations) { | ||
| try { | ||
| registration.unregister(); | ||
| } catch (IllegalStateException e) { | ||
| // already unregistered by the test | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testHighestRankedModifierIsInstalled() { | ||
| register("a", 1); | ||
| register("b", 5); | ||
| register("c", 3); | ||
|
|
||
| assertEquals("file:/b.png", resolvedURL()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRemovingInstalledModifierFallsBackToNext() { | ||
| register("a", 1); | ||
| ServiceRegistration<IImageURLModifier> b = register("b", 5); | ||
|
|
||
| b.unregister(); | ||
| assertEquals("file:/a.png", resolvedURL()); | ||
|
|
||
| registrations.get(0).unregister(); | ||
| assertEquals("file:/original.png", resolvedURL()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRankingChangeIsApplied() { | ||
| ServiceRegistration<IImageURLModifier> a = register("a", 1); | ||
| register("b", 5); | ||
|
|
||
| a.setProperties(FrameworkUtil.asDictionary(Map.of(Constants.SERVICE_RANKING, 10))); | ||
|
|
||
| assertEquals("file:/a.png", resolvedURL()); | ||
| } | ||
|
|
||
| private ServiceRegistration<IImageURLModifier> register(String name, int ranking) { | ||
| IImageURLModifier modifier = _ -> { | ||
| try { | ||
| return URI.create("file:/" + name + ".png").toURL(); | ||
| } catch (Exception e) { | ||
| throw new IllegalStateException(e); | ||
| } | ||
| }; | ||
| ServiceRegistration<IImageURLModifier> registration = context.registerService(IImageURLModifier.class, | ||
| modifier, FrameworkUtil.asDictionary(Map.of(Constants.SERVICE_RANKING, ranking))); | ||
| registrations.add(registration); | ||
| return registration; | ||
| } | ||
|
|
||
| private String resolvedURL() { | ||
| return Adapters.adapt(descriptor, URL.class).toExternalForm(); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think implementation details do not belong herem what someone else outside the bundle do with the service interface is out of scope.