Add SVG support to ImageBrowser

This commit enables the display of SVGs in the `ImageBrowser`.
When both a PNG and an SVG version of an icon are present, only the SVG
will be shown. To allow this behavior a new filter is introduced which
decides depending on the coming icons in the cache and existing filters
if a PNG should be added or suppressed.
Using the existing text pattern filter to only view specific icons (e.g.
"*.png" for only PNGs) continues to work as expected with this
implementation.

Author: Michael Bangas

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/views/imagebrowser/ImageBrowserView.java

@@ -22,6 +22,7 @@
 import java.util.Collection;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.regex.Pattern;
 
 import org.eclipse.core.commands.ExecutionException;
 import org.eclipse.core.commands.NotEnabledException;
@@ -91,6 +92,7 @@ public class ImageBrowserView extends ViewPart implements IImageTarget {
 
 	private static final String COMMAND_SAVE_TO_WORKSPACE = "org.eclipse.pde.ui.imagebrowser.saveToWorkspace"; //$NON-NLS-1$
 	protected final static String VIEW_ID = "org.eclipse.pde.ui.ImageBrowserView"; //$NON-NLS-1$
+	private static final Pattern FILE_EXTENSION = Pattern.compile("\\.[^.]+$"); //$NON-NLS-1$
 
 	private final UpdateUI mUIJob = new UpdateUI();
 
@@ -118,6 +120,7 @@ public class ImageBrowserView extends ViewPart implements IImageTarget {
 
 	private Text txtFilter;
 	private IFilter textPatternFilter;
+	private IFilter svgFilter = null;
 	private PageNavigationControl pageNavigationControl;
 
 	private ImageElement imageElement;
@@ -144,6 +147,20 @@ public ImageBrowserView() {
 		mFilters.add(enabledIcons);
 		textPatternFilter = new StringFilter("*"); //$NON-NLS-1$
 		mFilters.add(textPatternFilter);
+		svgFilter = element -> {
+			String fileName = element.getPath();
+			if (!fileName.endsWith(".svg")) { //$NON-NLS-1$
+				String replacementSVGName = FILE_EXTENSION.matcher(fileName).replaceAll(".svg"); //$NON-NLS-1$
+				ImageElement replacementSVG = repository.getImageElement(replacementSVGName);
+				if (replacementSVG != null) {
+					return new ArrayList<>(mFilters).stream()
+							.anyMatch(filter -> filter != svgFilter && !filter.accept(replacementSVG));
+				}
+				return true;
+			}
+			return true;
+		};
+		mFilters.add(svgFilter);
 	}
 
 	@Override
@@ -191,11 +208,15 @@ public void createPartControl(final Composite parent) {
 			mFilters.clear();
 			mFilters.add(textPatternFilter);
 			Combo source = (Combo) e.getSource();
-			switch (source.getSelectionIndex()) {
+			int selectionIndex = source.getSelectionIndex();
+			switch (selectionIndex) {
 				case 0 -> mFilters.add(enabledIcons);
 				case 1 -> mFilters.add(disabledIcons);
 				case 2 -> mFilters.add(wizard);
 			}
+			if (selectionIndex != source.getItemCount() - 1) {
+				mFilters.add(svgFilter);
+			}
 			page = 0; // reset to 1st page
 			scanImages();
 		}));

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/views/imagebrowser/repositories/AbstractRepository.java

@@ -22,10 +22,10 @@
 import java.util.Collection;
 import java.util.Enumeration;
 import java.util.HashSet;
-import java.util.LinkedList;
-import java.util.List;
+import java.util.LinkedHashMap;
 import java.util.Optional;
 import java.util.Properties;
+import java.util.SequencedMap;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
@@ -45,7 +45,7 @@
 
 public abstract class AbstractRepository extends Job {
 
-	protected List<ImageElement> mElementsCache = new LinkedList<>();
+	private SequencedMap<String, ImageElement> mElementsCache = new LinkedHashMap<>();
 
 	private final IImageTarget mTarget;
 
@@ -55,7 +55,7 @@ public AbstractRepository(IImageTarget target) {
 		mTarget = target;
 	}
 
-	private static final String[] KNOWN_EXTENSIONS = new String[] {".gif", ".png"}; //$NON-NLS-1$ //$NON-NLS-2$
+	private static final String[] KNOWN_EXTENSIONS = new String[] { ".gif", ".png", ".svg" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 
 	@Override
 	protected synchronized IStatus run(IProgressMonitor monitor) {
@@ -69,15 +69,21 @@ protected synchronized IStatus run(IProgressMonitor monitor) {
 				}
 			} else {
 				// return 1 image from cache
-				mTarget.notifyImage(mElementsCache.remove(0));
+				mTarget.notifyImage(mElementsCache.sequencedValues().removeFirst());
 			}
 		}
 
 		return Status.OK_STATUS;
 	}
 
 	public synchronized void clearCache() {
-		mElementsCache.clear();
+		if (mElementsCache != null) {
+			mElementsCache.clear();
+		}
+	}
+
+	public ImageElement getImageElement(String key) {
+		return mElementsCache.get(key);
 	}
 
 	protected abstract boolean populateCache(IProgressMonitor monitor);
@@ -211,6 +217,6 @@ protected Optional<String> getPluginName(final InputStream manifest) throws IOEx
 	}
 
 	protected void addImageElement(ImageElement element) {
-		mElementsCache.add(element);
+		mElementsCache.put(element.getPath(), element);
 	}
 }

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/views/imagebrowser/repositories/TargetPlatformRepository.java

@@ -122,9 +122,7 @@ protected synchronized IStatus run(IProgressMonitor monitor) {
 			fBundles.clear();
 			fBundles = null;
 		}
-		if (mElementsCache != null) {
-			mElementsCache.clear();
-		}
+		clearCache();
 		return Status.OK_STATUS;
 	}
 

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/views/imagebrowser/repositories/WorkspaceRepository.java

@@ -118,9 +118,7 @@ protected synchronized IStatus run(IProgressMonitor monitor) {
 			fProjects.clear();
 			fProjects = null;
 		}
-		if (mElementsCache != null) {
-			mElementsCache.clear();
-		}
+		clearCache();
 		return Status.OK_STATUS;
 	}