diff --git a/com.vogella.ide.iconreplacer/.classpath b/com.vogella.ide.iconreplacer/.classpath new file mode 100644 index 0000000..7a42e53 --- /dev/null +++ b/com.vogella.ide.iconreplacer/.classpath @@ -0,0 +1,7 @@ + + + + + + + diff --git a/com.vogella.ide.iconreplacer/.project b/com.vogella.ide.iconreplacer/.project new file mode 100644 index 0000000..71aee4e --- /dev/null +++ b/com.vogella.ide.iconreplacer/.project @@ -0,0 +1,28 @@ + + + com.vogella.ide.iconreplacer + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + + org.eclipse.pde.PluginNature + org.eclipse.jdt.core.javanature + + diff --git a/com.vogella.ide.iconreplacer/META-INF/MANIFEST.MF b/com.vogella.ide.iconreplacer/META-INF/MANIFEST.MF new file mode 100644 index 0000000..16d5829 --- /dev/null +++ b/com.vogella.ide.iconreplacer/META-INF/MANIFEST.MF @@ -0,0 +1,17 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: Icon Replacer +Bundle-SymbolicName: com.vogella.ide.iconreplacer;singleton:=true +Bundle-Version: 1.0.0.qualifier +Bundle-Vendor: VOGELLA +Require-Bundle: org.eclipse.core.runtime, + org.eclipse.ui, + org.eclipse.equinox.app, + org.eclipse.jface +Bundle-RequiredExecutionEnvironment: JavaSE-25 +Import-Package: com.google.gson;version="[2.11.0,3.0.0)", + com.google.gson.reflect;version="[2.11.0,3.0.0)", + jakarta.inject;version="[2.0.0,3.0.0)", + org.osgi.framework;version="[1.10.0,2.0.0)", + org.osgi.framework.wiring;version="[1.2.0,2.0.0)" +Automatic-Module-Name: com.vogella.ide.iconreplacer diff --git a/com.vogella.ide.iconreplacer/build.properties b/com.vogella.ide.iconreplacer/build.properties new file mode 100644 index 0000000..a74eedf --- /dev/null +++ b/com.vogella.ide.iconreplacer/build.properties @@ -0,0 +1,6 @@ +source.. = src/ +output.. = bin/ +bin.includes = plugin.xml,\ + META-INF/,\ + .,\ + schema/ diff --git a/com.vogella.ide.iconreplacer/plugin.xml b/com.vogella.ide.iconreplacer/plugin.xml new file mode 100644 index 0000000..0eef9fc --- /dev/null +++ b/com.vogella.ide.iconreplacer/plugin.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/com.vogella.ide.iconreplacer/schema/iconpack.exsd b/com.vogella.ide.iconreplacer/schema/iconpack.exsd new file mode 100644 index 0000000..a7e39a3 --- /dev/null +++ b/com.vogella.ide.iconreplacer/schema/iconpack.exsd @@ -0,0 +1,103 @@ + + + + + + + + + Allows plug-ins to contribute an icon pack: a mapping file and a folder of + replacement SVG files. The mapping file uses the format: + + <pre> + { + "terminal.svg": [ + "org.eclipse.ui.console/icons/full/eview/console_view.svg" + ] + } + </pre> + + Each key is a filename in the icon pack folder; each value is an array of + <code>bundleSymbolicName/path</code> pairs to replace inside that bundle's JAR. + + + + + + + + + + + + + + + + + a fully qualified identifier of the target extension point + + + + + + + an optional identifier of the extension instance + + + + + + + an optional name of the extension instance + + + + + + + + + + + + Bundle-relative path (or absolute URL) to the icon-mapping.json file. + + + + + + + Bundle-relative path to the folder containing the replacement SVG files. + Must end with a '/'. + + + + + + + + + + + + 1.0.0 + + + + + + + + + <pre> +<extension point="com.vogella.ide.iconreplacer.iconpack"> + <iconpack + mappingFile="iconpacks/eclipse-dual-tone/icon-mapping.json" + iconFolder="iconpacks/eclipse-dual-tone/icons/"/> +</extension> + </pre> + + + + diff --git a/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/BundlePatcher.java b/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/BundlePatcher.java new file mode 100644 index 0000000..a56b9df --- /dev/null +++ b/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/BundlePatcher.java @@ -0,0 +1,113 @@ +package com.vogella.ide.iconreplacer; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.lang.reflect.Type; +import java.net.URL; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; +import java.util.zip.ZipOutputStream; + +import org.eclipse.core.runtime.FileLocator; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleContext; +import org.osgi.framework.FrameworkUtil; +import org.osgi.framework.wiring.FrameworkWiring; + +import com.google.gson.Gson; +import com.google.gson.reflect.TypeToken; + +public class BundlePatcher { + + public static void apply(URL mappingUrl, URL iconFolderUrl) throws Exception { + Map> mapping; + try (InputStreamReader reader = new InputStreamReader(mappingUrl.openStream(), StandardCharsets.UTF_8)) { + Type type = new TypeToken>>() {}.getType(); + mapping = new Gson().fromJson(reader, type); + } + + BundleContext ctx = FrameworkUtil.getBundle(BundlePatcher.class).getBundleContext(); + + // Group all replacements by bundle symbolic name so we rebuild each JAR once + Map> replacementsByBundle = new HashMap<>(); + + for (Map.Entry> entry : mapping.entrySet()) { + String iconFileName = entry.getKey(); + URL replacement = new URL(iconFolderUrl, iconFileName); + + for (String targetPath : entry.getValue()) { + int slash = targetPath.indexOf('/'); + if (slash < 0) { + continue; + } + String bsn = targetPath.substring(0, slash); + String iconPath = targetPath.substring(slash + 1); + + replacementsByBundle + .computeIfAbsent(bsn, k -> new HashMap<>()) + .put(iconPath, replacement); + } + } + + for (Map.Entry> bundleEntry : replacementsByBundle.entrySet()) { + String bsn = bundleEntry.getKey(); + Map replacements = bundleEntry.getValue(); + + Bundle bundle = findBundle(ctx, bsn); + if (bundle == null) { + continue; + } + + try (InputStream patched = rebuildJar(bundle, replacements)) { + bundle.update(patched); + } + } + + FrameworkWiring wiring = ctx.getBundle(0).adapt(FrameworkWiring.class); + wiring.refreshBundles(null); + } + + private static Bundle findBundle(BundleContext ctx, String symbolicName) { + for (Bundle b : ctx.getBundles()) { + if (symbolicName.equals(b.getSymbolicName())) { + return b; + } + } + return null; + } + + private static InputStream rebuildJar(Bundle bundle, Map replacements) + throws Exception { + File bundleFile = FileLocator.getBundleFileLocation(bundle) + .orElseThrow(() -> new IOException("Cannot locate bundle file for " + bundle.getSymbolicName())); + + ByteArrayOutputStream buffer = new ByteArrayOutputStream(); + try (ZipOutputStream zout = new ZipOutputStream(buffer); + ZipInputStream zin = new ZipInputStream(new FileInputStream(bundleFile))) { + ZipEntry entry; + while ((entry = zin.getNextEntry()) != null) { + zout.putNextEntry(new ZipEntry(entry.getName())); + URL replacement = replacements.get(entry.getName()); + if (replacement != null) { + try (InputStream in = replacement.openStream()) { + in.transferTo(zout); + } + } else { + zin.transferTo(zout); + } + zout.closeEntry(); + } + } + return new ByteArrayInputStream(buffer.toByteArray()); + } +} diff --git a/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/IconReplacerHandler.java b/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/IconReplacerHandler.java new file mode 100644 index 0000000..7d7b0bd --- /dev/null +++ b/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/IconReplacerHandler.java @@ -0,0 +1,71 @@ +package com.vogella.ide.iconreplacer; + +import java.net.URL; + +import org.eclipse.core.runtime.IConfigurationElement; +import org.eclipse.core.runtime.Platform; +import org.eclipse.jface.dialogs.MessageDialog; +import org.eclipse.swt.widgets.Shell; +import org.eclipse.ui.handlers.HandlerUtil; +import org.osgi.framework.Bundle; + +import org.eclipse.core.commands.AbstractHandler; +import org.eclipse.core.commands.ExecutionEvent; +import org.eclipse.core.commands.ExecutionException; + +public class IconReplacerHandler extends AbstractHandler { + + private static final String EXTENSION_POINT_ID = "com.vogella.ide.iconreplacer.iconpack"; + + @Override + public Object execute(ExecutionEvent event) throws ExecutionException { + Shell shell = HandlerUtil.getActiveShell(event); + + boolean confirmed = MessageDialog.openConfirm(shell, + "Apply Icon Pack", + "This will patch bundle JARs and restart Eclipse. Continue?"); + if (!confirmed) { + return null; + } + + try { + IConfigurationElement[] elements = + Platform.getExtensionRegistry().getConfigurationElementsFor(EXTENSION_POINT_ID); + + if (elements.length == 0) { + MessageDialog.openInformation(shell, "Apply Icon Pack", + "No icon pack contributions found."); + return null; + } + + for (IConfigurationElement element : elements) { + Bundle contributor = Platform.getBundle(element.getContributor().getName()); + String mappingFile = element.getAttribute("mappingFile"); + String iconFolder = element.getAttribute("iconFolder"); + + URL mappingUrl = contributor.getEntry(mappingFile); + URL iconFolderUrl = contributor.getEntry(iconFolder); + + if (mappingUrl == null) { + throw new IllegalArgumentException( + "Cannot find mappingFile '" + mappingFile + "' in bundle " + + contributor.getSymbolicName()); + } + if (iconFolderUrl == null) { + throw new IllegalArgumentException( + "Cannot find iconFolder '" + iconFolder + "' in bundle " + + contributor.getSymbolicName()); + } + + BundlePatcher.apply(mappingUrl, iconFolderUrl); + } + + RestartHelper.restartWithClean(); + + } catch (Exception e) { + MessageDialog.openError(shell, "Icon Replacement Failed", e.getMessage()); + } + + return null; + } +} diff --git a/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/RestartHelper.java b/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/RestartHelper.java new file mode 100644 index 0000000..0b057e9 --- /dev/null +++ b/com.vogella.ide.iconreplacer/src/com/vogella/ide/iconreplacer/RestartHelper.java @@ -0,0 +1,29 @@ +package com.vogella.ide.iconreplacer; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.ui.PlatformUI; + +public class RestartHelper { + + public static void restartWithClean() { + List commands = new ArrayList<>(); + String existingCmds = System.getProperty("eclipse.commands", ""); + for (String line : existingCmds.split("[\\r\\n]+")) { + String trimmed = line.trim(); + if (!trimmed.isEmpty() + && !trimmed.equals("-clean") + && !trimmed.equals("-clearPersistedState")) { + commands.add(trimmed); + } + } + commands.add("-clean"); + commands.add("-clearPersistedState"); + + System.setProperty("eclipse.exitcode", "24"); // 24 = RESTART + System.setProperty("eclipse.exitdata", String.join("\n", commands)); + + PlatformUI.getWorkbench().restart(); + } +} diff --git a/com.vogella.ide.parallelstart/.classpath b/com.vogella.ide.parallelstart/.classpath new file mode 100644 index 0000000..5050774 --- /dev/null +++ b/com.vogella.ide.parallelstart/.classpath @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/com.vogella.ide.parallelstart/.project b/com.vogella.ide.parallelstart/.project new file mode 100644 index 0000000..d2a5dd4 --- /dev/null +++ b/com.vogella.ide.parallelstart/.project @@ -0,0 +1,39 @@ + + + com.vogella.ide.parallelstart + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + org.eclipse.m2e.core.maven2Builder + + + + + org.eclipse.pde.ds.core.builder + + + + + + org.eclipse.m2e.core.maven2Nature + org.eclipse.pde.PluginNature + org.eclipse.jdt.core.javanature + + diff --git a/com.vogella.ide.parallelstart/.settings/org.eclipse.jdt.core.prefs b/com.vogella.ide.parallelstart/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 0000000..c540a97 --- /dev/null +++ b/com.vogella.ide.parallelstart/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,9 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=25 +org.eclipse.jdt.core.compiler.compliance=25 +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning +org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.source=25 diff --git a/com.vogella.ide.parallelstart/META-INF/MANIFEST.MF b/com.vogella.ide.parallelstart/META-INF/MANIFEST.MF new file mode 100644 index 0000000..50202b1 --- /dev/null +++ b/com.vogella.ide.parallelstart/META-INF/MANIFEST.MF @@ -0,0 +1,12 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: Parallel Startup Configurator +Bundle-SymbolicName: com.vogella.ide.parallelstart +Bundle-Version: 1.0.0.qualifier +Bundle-Vendor: VOGELLA +Bundle-RequiredExecutionEnvironment: JavaSE-25 +Automatic-Module-Name: com.vogella.ide.parallelstart +Import-Package: org.eclipse.osgi.container;version="1.0.0", + org.osgi.framework;version="1.10.0" +Service-Component: OSGI-INF/com.vogella.ide.parallelstart.ParallelStartConfigurator.xml +Bundle-ActivationPolicy: lazy diff --git a/com.vogella.ide.parallelstart/OSGI-INF/com.vogella.ide.parallelstart.ParallelStartConfigurator.xml b/com.vogella.ide.parallelstart/OSGI-INF/com.vogella.ide.parallelstart.ParallelStartConfigurator.xml new file mode 100644 index 0000000..1d13a7f --- /dev/null +++ b/com.vogella.ide.parallelstart/OSGI-INF/com.vogella.ide.parallelstart.ParallelStartConfigurator.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/com.vogella.ide.parallelstart/README.md b/com.vogella.ide.parallelstart/README.md new file mode 100644 index 0000000..963863f --- /dev/null +++ b/com.vogella.ide.parallelstart/README.md @@ -0,0 +1,36 @@ +# Parallel Startup Configurator + +Marks Eclipse platform bundles as safe for parallel activation during startup using the Equinox `Module.setParallelActivation(true)` API. + +## Required Framework Configuration + +Add to your `config.ini` or launch arguments: + +``` +equinox.start.level.thread.count=0 +equinox.start.level.restrict.parallel=true +``` + +- `equinox.start.level.thread.count` — number of threads for bundle activation. `0` means auto-detect based on available processors. Default is `1` (sequential). +- `equinox.start.level.restrict.parallel` — when `true`, only bundles explicitly marked via `setParallelActivation(true)` are activated in parallel. When `false` (default), all bundles within a start level activate in parallel. + +## How It Works + +Equinox processes start levels sequentially (level 1 completes before level 2 begins). Within each start level, bundles are grouped: + +1. Lazy parallel bundles (started concurrently) +2. Lazy sequential bundles (started one by one) +3. Eager parallel bundles (started concurrently) +4. Eager sequential bundles (started one by one) + +Each group completes before the next begins. The parallel activation flag is persisted in the framework's module database, so it only needs to be set once. + +## Limitations + +This plug-in uses an OSGi DS immediate component. DS itself must be activated before this component runs, so the parallel flags are not effective on the first cold start. All subsequent launches benefit from the persisted settings. + +For first-launch effectiveness, use a `BundleActivator` at start level 1 instead of DS. + +## Bundle Safety + +A bundle is safe for parallel activation if its activator is thread-safe and does not depend on side effects from other bundles' activators within the same start level. Standard OSGi service dependencies (via DS) are safe since service lookup is decoupled from activation order. diff --git a/com.vogella.ide.parallelstart/build.properties b/com.vogella.ide.parallelstart/build.properties new file mode 100644 index 0000000..c58ea21 --- /dev/null +++ b/com.vogella.ide.parallelstart/build.properties @@ -0,0 +1,5 @@ +source.. = src/ +output.. = bin/ +bin.includes = META-INF/,\ + .,\ + OSGI-INF/ diff --git a/com.vogella.ide.parallelstart/src/com/vogella/ide/parallelstart/ParallelStartConfigurator.java b/com.vogella.ide.parallelstart/src/com/vogella/ide/parallelstart/ParallelStartConfigurator.java new file mode 100644 index 0000000..28b7c9b --- /dev/null +++ b/com.vogella.ide.parallelstart/src/com/vogella/ide/parallelstart/ParallelStartConfigurator.java @@ -0,0 +1,140 @@ +package com.vogella.ide.parallelstart; + +import java.util.Set; +import java.util.logging.Logger; + +import org.eclipse.osgi.container.Module; +import org.osgi.framework.Bundle; +import org.osgi.framework.BundleContext; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.Component; + +/** + * Configures Eclipse platform bundles for parallel activation during startup. + * + *

+ * By default, Equinox activates bundles sequentially within each start level. + * When the framework properties {@code equinox.start.level.thread.count} and + * {@code equinox.start.level.restrict.parallel=true} are set, only bundles + * explicitly marked via {@link Module#setParallelActivation(boolean)} are + * activated in parallel. + *

+ * + *

+ * This component marks well-known Eclipse platform bundles as safe for parallel + * activation. The setting is persisted by the framework, so it only needs to + * take effect once. On subsequent launches the flags are already stored in the + * module database. + *

+ * + *

+ * Required framework configuration (e.g. in config.ini or launch args): + *

+ * + * 
+ * equinox.start.level.thread.count=0
+ * equinox.start.level.restrict.parallel=true
+ *
+ */ +@Component(immediate = true) +public class ParallelStartConfigurator { + + private static final Logger LOG = Logger.getLogger(ParallelStartConfigurator.class.getName()); + + /** + * Eclipse platform bundles considered safe for parallel activation. These + * bundles have thread-safe activators or use lazy/DS activation and do not + * depend on a specific activation order beyond what OSGi services guarantee. + */ + private static final Set PARALLEL_SAFE_BUNDLES = Set.of( + // Eclipse core runtime + "org.eclipse.core.runtime", + "org.eclipse.core.commands", + "org.eclipse.core.contenttype", + "org.eclipse.core.databinding", + "org.eclipse.core.databinding.beans", + "org.eclipse.core.databinding.observable", + "org.eclipse.core.databinding.property", + "org.eclipse.core.expressions", + "org.eclipse.core.filesystem", + "org.eclipse.core.jobs", + "org.eclipse.core.resources", + "org.eclipse.core.net", + + // Equinox + "org.eclipse.equinox.common", + "org.eclipse.equinox.preferences", + "org.eclipse.equinox.registry", + "org.eclipse.equinox.app", + "org.eclipse.equinox.event", + + // E4 platform + "org.eclipse.e4.core.commands", + "org.eclipse.e4.core.contexts", + "org.eclipse.e4.core.di", + "org.eclipse.e4.core.di.annotations", + "org.eclipse.e4.core.di.extensions", + "org.eclipse.e4.core.di.extensions.supplier", + "org.eclipse.e4.core.services", + "org.eclipse.e4.ui.bindings", + "org.eclipse.e4.ui.css.core", + "org.eclipse.e4.ui.css.swt", + "org.eclipse.e4.ui.css.swt.theme", + "org.eclipse.e4.ui.di", + "org.eclipse.e4.ui.model.workbench", + "org.eclipse.e4.ui.services", + "org.eclipse.e4.ui.workbench", + "org.eclipse.e4.ui.workbench.addons.swt", + "org.eclipse.e4.ui.workbench.renderers.swt", + "org.eclipse.e4.ui.workbench.swt", + "org.eclipse.e4.ui.workbench3", + "org.eclipse.e4.emf.xpath", + + // UI and JFace + "org.eclipse.jface", + "org.eclipse.jface.databinding", + "org.eclipse.jface.text", + "org.eclipse.ui", + "org.eclipse.ui.forms", + "org.eclipse.ui.navigator", + "org.eclipse.ui.views", + "org.eclipse.ui.workbench", + "org.eclipse.ui.ide", + + // Text and editors + "org.eclipse.text", + "org.eclipse.ui.editors", + "org.eclipse.ui.genericeditor", + "org.eclipse.ui.workbench.texteditor", + + // Help + "org.eclipse.help", + "org.eclipse.help.base", + "org.eclipse.help.ui", + + // EMF (commonly used, thread-safe activators) + "org.eclipse.emf.common", + "org.eclipse.emf.ecore", + "org.eclipse.emf.ecore.xmi", + + // Third-party libraries (typically stateless) + "org.eclipse.equinox.bidi", + "com.ibm.icu" + ); + + @Activate + void activate(BundleContext context) { + int count = 0; + for (Bundle bundle : context.getBundles()) { + String bsn = bundle.getSymbolicName(); + if (bsn != null && PARALLEL_SAFE_BUNDLES.contains(bsn)) { + Module module = bundle.adapt(Module.class); + if (module != null && !module.isParallelActivated()) { + module.setParallelActivation(true); + count++; + } + } + } + LOG.info("Marked " + count + " bundles for parallel activation"); + } +} diff --git a/com.vogella.lsp.asciidoc.server.tests/manual/Help.adoc b/com.vogella.lsp.asciidoc.server.tests/manual/Help.adoc index a6889f0..f8c9330 100644 --- a/com.vogella.lsp.asciidoc.server.tests/manual/Help.adoc +++ b/com.vogella.lsp.asciidoc.server.tests/manual/Help.adoc @@ -3,10 +3,6 @@ ddd image::Sample.png[] include::Help2.adoc[] -include::Testing.adoc[]] -include::[] +include::Testing.adoc[] -include:: - -image::Sample.png[] -image::Test.png[] \ No newline at end of file +image::Test.png[] diff --git a/com.vogella.lsp.asciidoc.server.tests/manual/Testing.adoc b/com.vogella.lsp.asciidoc.server.tests/manual/Testing.adoc index 630b30a..2e4208b 100644 --- a/com.vogella.lsp.asciidoc.server.tests/manual/Testing.adoc +++ b/com.vogella.lsp.asciidoc.server.tests/manual/Testing.adoc @@ -1,5 +1,5 @@ = Title -image::[] +image::Sample.png[] -linclude::[] \ No newline at end of file +include::Help.adoc[] diff --git a/com.vogella.lsp.asciidoc.server/src/com/vogella/lsp/asciidoc/server/AsciidocTextDocumentService.java b/com.vogella.lsp.asciidoc.server/src/com/vogella/lsp/asciidoc/server/AsciidocTextDocumentService.java index cb78060..ae75ad1 100644 --- a/com.vogella.lsp.asciidoc.server/src/com/vogella/lsp/asciidoc/server/AsciidocTextDocumentService.java +++ b/com.vogella.lsp.asciidoc.server/src/com/vogella/lsp/asciidoc/server/AsciidocTextDocumentService.java @@ -321,7 +321,7 @@ private void collectLinks(String baseUri, String lineContent, int lineIndex, Lis if (path.startsWith("http://") || path.startsWith("https://")) { // External link - use URL directly targetUri = path; - } else if (path.startsWith("./") || path.startsWith("../")) { + } else { // Internal file link - resolve relative path Location loc = resolveFileLocation(baseUri, path); if (loc != null) { diff --git a/icon-replacement-plugin.md b/icon-replacement-plugin.md new file mode 100644 index 0000000..5715a92 --- /dev/null +++ b/icon-replacement-plugin.md @@ -0,0 +1,233 @@ +# Icon Replacement Plugin Implementation + +## Overview + +This plugin replaces icons in the running Eclipse installation by patching existing +bundles using `Bundle.update(InputStream)` — no file locking issues since content +is streamed directly into Equinox's internal bundle cache. After patching, the IDE +restarts with `-clean -clearPersistedState` to apply changes. + +Icon packs are contributed via an extension point, pointing to an +[`icon-mapping.json`](https://github.com/eclipse-platform/ui-best-practices/blob/main/iconpacks/eclipse-dual-tone/icon-mapping.json) +file and a folder of replacement SVG files. + +The mapping format is: + +```json +{ + "terminal.svg": [ + "org.eclipse.ui.console/icons/full/eview/console_view.svg" + ] +} +``` + +Each key is a filename in the icon pack folder; each value is an array of +`bundleSymbolicName/path` pairs to replace. + +A similar (workspace-based) approach exists in `com.vogella.ide.icons.dualtone`. + +--- + +## 1. Extension Point (`com.vogella.ide.iconreplacer`) + +Define `schema/iconpack.exsd`: + +```xml + + + + + + + + +``` + +`plugin.xml` registration: + +```xml + +``` + +Consumers contribute like this: + +```xml + + + +``` + +--- + +## 2. Plugin Structure + +``` +com.vogella.ide.iconreplacer/ + META-INF/MANIFEST.MF + plugin.xml + schema/iconpack.exsd + src/com/vogella/ide/iconreplacer/ + IconReplacerHandler.java ← e4 handler, triggered by a command/menu entry + BundlePatcher.java ← patches a single bundle JAR + RestartHelper.java ← restarts with -clean -clearPersistedState +``` + +**`MANIFEST.MF`** — key dependencies: + +``` +Require-Bundle: + org.eclipse.core.runtime, + org.eclipse.ui, + org.eclipse.equinox.app, + com.google.gson +``` + +--- + +## 3. Reading Extension Point Contributions + +```java +IExtensionRegistry registry = Platform.getExtensionRegistry(); +IConfigurationElement[] elements = + registry.getConfigurationElementsFor("com.vogella.ide.iconreplacer.iconpack"); + +for (IConfigurationElement element : elements) { + Bundle contributor = Platform.getBundle(element.getContributor().getName()); + String mappingFile = element.getAttribute("mappingFile"); + String iconFolder = element.getAttribute("iconFolder"); + + URL mappingUrl = contributor.getEntry(mappingFile); + URL iconFolderUrl = contributor.getEntry(iconFolder); + // ... parse and apply +} +``` + +--- + +## 4. Parsing the Mapping and Patching Bundles + +**`BundlePatcher.java`** + +```java +// Parse icon-mapping.json with Gson +Type type = new TypeToken>>(){}.getType(); +Map> mapping = new Gson().fromJson(reader, type); + +BundleContext ctx = FrameworkUtil.getBundle(BundlePatcher.class).getBundleContext(); + +for (Map.Entry> entry : mapping.entrySet()) { + String iconFileName = entry.getKey(); // e.g. "terminal.svg" + URL replacement = iconFolderUrl.toURI().resolve(iconFileName).toURL(); + + for (String targetPath : entry.getValue()) { // e.g. "org.eclipse.ui.console/icons/..." + int slash = targetPath.indexOf('/'); + String bsn = targetPath.substring(0, slash); // bundle symbolic name + String iconPath = targetPath.substring(slash + 1); // path inside bundle + + Bundle bundle = findBundle(ctx, bsn); + if (bundle == null) continue; + + try (InputStream patched = rebuildJar(bundle, iconPath, replacement)) { + bundle.update(patched); // streams into Equinox cache — no file lock issue + } + } +} + +// Refresh all updated bundles +FrameworkWiring wiring = ctx.getBundle(0).adapt(FrameworkWiring.class); +wiring.refreshBundles(null); +``` + +**`rebuildJar`** — copies the existing bundle JAR into a new in-memory JAR, replacing +the target entry: + +```java +private InputStream rebuildJar(Bundle bundle, String replacedPath, URL replacement) + throws Exception { + ByteArrayOutputStream buffer = new ByteArrayOutputStream(); + try (ZipOutputStream zout = new ZipOutputStream(buffer)) { + // Copy all existing entries except the one being replaced + URL location = bundle.getEntry("/"); + try (ZipInputStream zin = new ZipInputStream( + new URL(bundle.getLocation()).openStream())) { + ZipEntry entry; + while ((entry = zin.getNextEntry()) != null) { + zout.putNextEntry(new ZipEntry(entry.getName())); + if (entry.getName().equals(replacedPath)) { + replacement.openStream().transferTo(zout); + } else { + zin.transferTo(zout); + } + zout.closeEntry(); + } + } + } + return new ByteArrayInputStream(buffer.toByteArray()); +} +``` + +> **Note:** `bundle.getLocation()` returns a `reference:file:` URL pointing to Equinox's +> internal cache copy of the JAR, not the original installation path. This is safe on all +> platforms — no file locking concerns even on Windows. + +--- + +## 5. Restart with `-clean -clearPersistedState` + +**`RestartHelper.java`** + +```java +public static void restartWithClean() { + List commands = new ArrayList<>(); + String existingCmds = System.getProperty("eclipse.commands", ""); + for (String line : existingCmds.split("[\r\n]+")) { + String trimmed = line.trim(); + if (!trimmed.isEmpty() + && !trimmed.equals("-clean") + && !trimmed.equals("-clearPersistedState")) { + commands.add(trimmed); + } + } + commands.add("-clean"); + commands.add("-clearPersistedState"); + + System.setProperty("eclipse.exitcode", "24"); // 24 = RESTART + System.setProperty("eclipse.exitdata", String.join("\n", commands)); + + PlatformUI.getWorkbench().restart(); +} +``` + +Call this after `wiring.refreshBundles(null)` completes. + +--- + +## 6. Handler (`IconReplacerHandler.java`) + +Wire everything together as an e4 handler: + +```java +@Execute +public void execute(Shell shell) { + boolean confirmed = MessageDialog.openConfirm(shell, + "Apply Icon Pack", + "This will patch bundle JARs and restart Eclipse. Continue?"); + if (!confirmed) return; + + try { + for (/* each extension point contribution */) { + BundlePatcher.apply(mappingUrl, iconFolderUrl); + } + RestartHelper.restartWithClean(); + } catch (Exception e) { + MessageDialog.openError(shell, "Icon Replacement Failed", e.getMessage()); + } +} +``` + +Expose via a `plugin.xml` command and menu contribution in the usual e4 way. diff --git a/pom.xml b/pom.xml index 0793c69..308bb4c 100644 --- a/pom.xml +++ b/pom.xml @@ -138,6 +138,8 @@ com.vogella.lsp.asciidoc.server com.vogella.lsp.asciidoc.server.tests z.ex.search + com.vogella.ide.iconreplacer + com.vogella.ide.parallelstart