[builder] Change BndtoolsBuilder to facade pattern

Fixes bndtools#5004 Signed-off-by: Fr Jeremy Krieg <fr.jkrieg@greekwelfaresa.org.au>
kriegfrj · Jan 8, 2022 · 017eef9 · 017eef9
1 parent 3fe34bd
commit 017eef9
Show file tree

Hide file tree

Showing 68 changed files with 1,337 additions and 129 deletions.
diff --git a/bndtools.api/bnd.bnd b/bndtools.api/bnd.bnd
@@ -3,17 +3,22 @@
 
 -buildpath: \
 	osgi.annotation;version=latest;maven-scope=provided,\
-	osgi.core;version=latest;maven-scope=provided, \
+	osgi.core;version=latest;maven-scope=provided,\
 	aQute.libg;version=project,\
-    biz.aQute.bnd.util;version=latest, \
-    biz.aQute.bndlib;version=latest, \
+	biz.aQute.bnd.util;version=latest,\
+	biz.aQute.bndlib;version=latest,\
 	org.eclipse.core.resources,\
 	org.eclipse.core.runtime,\
-	org.eclipse.equinox.common, \
-	org.eclipse.equinox.registry, \
-    org.eclipse.swt,\
+	org.eclipse.equinox.common,\
+	org.eclipse.equinox.registry,\
+	org.eclipse.swt,\
 	org.eclipse.swt.cocoa.macosx.x86_64,\
-	org.eclipse.jface
+	org.eclipse.jface,\
+	org.eclipse.core.jobs,\
+	slf4j.api,\
+	org.eclipse.jface.text,\
+	org.eclipse.ui.ide,\
+	org.eclipse.jdt.core
 
 Import-Package: \
  ${eclipse.importpackage},\

diff --git a/...s/build/api/BuildErrorDetailsHandler.java → ...api/builder/BuildErrorDetailsHandler.java b/...s/build/api/BuildErrorDetailsHandler.java → ...api/builder/BuildErrorDetailsHandler.java
@@ -1,4 +1,4 @@
-package org.bndtools.build.api;
+package org.bndtools.api.builder;
 
 import java.util.List;
 

diff --git a/...org/bndtools/build/api/BuildListener.java → ...g/bndtools/api/builder/BuildListener.java b/...org/bndtools/build/api/BuildListener.java → ...g/bndtools/api/builder/BuildListener.java
@@ -1,4 +1,4 @@
-package org.bndtools.build.api;
+package org.bndtools.api.builder;
 
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.runtime.IPath;

diff --git a/bndtools.api/src/org/bndtools/api/builder/BuildLoggerConstants.java b/bndtools.api/src/org/bndtools/api/builder/BuildLoggerConstants.java
@@ -0,0 +1,9 @@
+package org.bndtools.api.builder;
+
+public interface BuildLoggerConstants {
+
+	int	LOG_FULL	= 2;
+	int	LOG_BASIC	= 1;
+	int	LOG_NONE	= 0;
+
+}
diff --git a/...bndtools/build/api/IProjectDecorator.java → ...dtools/api/builder/IProjectDecorator.java b/...bndtools/build/api/IProjectDecorator.java → ...dtools/api/builder/IProjectDecorator.java
@@ -1,4 +1,4 @@
-package org.bndtools.build.api;
+package org.bndtools.api.builder;
 
 import java.io.File;
 import java.util.Collection;

diff --git a/...rc/org/bndtools/build/api/MarkerData.java → .../org/bndtools/api/builder/MarkerData.java b/...rc/org/bndtools/build/api/MarkerData.java → .../org/bndtools/api/builder/MarkerData.java
@@ -1,4 +1,4 @@
-package org.bndtools.build.api;
+package org.bndtools.api.builder;
 
 import java.util.Map;
 

diff --git a/bndtools.api/src/org/bndtools/api/builder/package-info.java b/bndtools.api/src/org/bndtools/api/builder/package-info.java
@@ -0,0 +1,5 @@
+
+@Version("1.0.0")
+package org.bndtools.api.builder;
+
+import org.osgi.annotation.versioning.Version;
diff --git a/.../org/bndtools/facade/ExtensionFacade.java → .../org/bndtools/facade/ExtensionFacade.java b/.../org/bndtools/facade/ExtensionFacade.java → .../org/bndtools/facade/ExtensionFacade.java
diff --git a/...tools/facade/ExtensionServiceTracker.java → ...tools/facade/ExtensionServiceTracker.java b/...tools/facade/ExtensionServiceTracker.java → ...tools/facade/ExtensionServiceTracker.java
diff --git a/...src/org/bndtools/facade/package-info.java → ...src/org/bndtools/facade/package-info.java b/...src/org/bndtools/facade/package-info.java → ...src/org/bndtools/facade/package-info.java
@@ -1,3 +1,2 @@
-@org.osgi.annotation.bundle.Export
 @org.osgi.annotation.versioning.Version("1.0.0")
 package org.bndtools.facade;
diff --git a/bndtools.builder/_plugin.xml b/bndtools.builder/_plugin.xml
@@ -15,7 +15,7 @@
 		name="Bndtools Nature"
 		>
 		<runtime>
-			<run class="org.bndtools.builder.BndProjectNature" />
+			<run class="org.bndtools.facade.ExtensionFacade:org.eclipse.core.resources.IProjectNature:org.bndtools.builder.impl.BndProjectNature" />
 		</runtime>
 		<requires-nature id="org.eclipse.jdt.core.javanature" />
 		<builder id="bndtools.core.bndbuilder" />
@@ -27,8 +27,8 @@
 		name="Bndtools Builder"
 		>
 		<builder callOnEmptyDelta="false" hasNature="true">
-			<run class="org.bndtools.builder.BndtoolsBuilder" />
-            <dynamicReference class="org.bndtools.builder.BndtoolsDynamicReferenceProvider"  />
+			<run class="org.bndtools.builder.facade.BuilderFacade" />
+            <dynamicReference class="org.bndtools.facade.ExtensionFacade:org.eclipse.core.resources.IDynamicReferenceProvider:org.bndtools.builder.impl.BndtoolsDynamicReferenceProvider"  />
 		</builder>
 	</extension>
 
@@ -43,18 +43,18 @@
 		</compilationParticipant>
 	</extension>
 
-    <extension
+<!--    <extension
         point="org.eclipse.jdt.core.compilationParticipant"
         name="Bnd Source Generation Compilation Participant"
         >
-        <compilationParticipant class="org.bndtools.builder.BndSourceGenerateCompilationParticipant"
-            id="bndtools.builder.generate.compilationparticipant"
+        <compilationParticipant class="org.bndtools.facade.ExtensionFacade"
+            id="org.bndtools.builder.impl.BndSourceGenerateCompilationParticipant"
             modifiesEnvironment="true"
             createsProblems="true"
             >
         </compilationParticipant>
     </extension>
-
+    -->
 
 
 

diff --git a/bndtools.builder/bnd.bnd b/bndtools.builder/bnd.bnd
@@ -35,7 +35,8 @@
 	org.eclipse.equinox.common,\
 	org.eclipse.equinox.registry,\
 	org.eclipse.equinox.preferences,\
-	slf4j.api
+	slf4j.api,\
+	org.osgi.service.component.annotations
 
 -testpath: \
     ${junit},\
@@ -58,5 +59,15 @@ Import-Package: \
 	aQute.libg.*;-split-package:=merge-first, \
 	org.bndtools.utils.*
 
+Export-Package: \
+	org.bndtools.builder.classpath.*,\
+	org.bndtools.builder.decorator.*,\
+	org.bndtools.builder.facade.*,\
+	org.bndtools.builder.handlers.*,\
+	org.bndtools.builder.jobs.*,\
+	org.bndtools.builder.utils.*,\
+	org.bndtools.builder.validate.*
+
+
 -includeresource: \
 	plugin.xml=_plugin.xml
diff --git a/bndtools.builder/src/org/bndtools/builder/BuilderPlugin.java b/bndtools.builder/src/org/bndtools/builder/BuilderPlugin.java
@@ -1,10 +1,16 @@
 package org.bndtools.builder;
 
-import org.bndtools.build.api.IProjectDecorator;
+import org.bndtools.api.builder.IProjectDecorator;
 import org.bndtools.builder.decorator.ui.ProjectDecoratorImpl;
+import org.bndtools.builder.facade.BuilderFacade;
+import org.bndtools.facade.ExtensionFacade;
 import org.osgi.framework.BundleContext;
 
 public class BuilderPlugin extends org.eclipse.core.runtime.Plugin {
+	public static final String		PLUGIN_ID	= "bndtools.builder";
+
+	static final Class<?>			BUILDER_FACADE		= BuilderFacade.class;
+	static final Class<?>			EXTENSION_FACADE	= ExtensionFacade.class;
 
 	private static BuilderPlugin instance = null;
 

diff --git a/bndtools.builder/src/org/bndtools/builder/classpath/BndContainerInitializer.java b/bndtools.builder/src/org/bndtools/builder/classpath/BndContainerInitializer.java
@@ -20,8 +20,7 @@
 import org.bndtools.api.ILogger;
 import org.bndtools.api.Logger;
 import org.bndtools.api.ModelListener;
-import org.bndtools.builder.BndtoolsBuilder;
-import org.bndtools.builder.BuildLogger;
+import org.bndtools.api.builder.BuildLoggerConstants;
 import org.bndtools.builder.BuilderPlugin;
 import org.bndtools.utils.jar.PseudoJar;
 import org.eclipse.core.resources.IProject;
@@ -202,7 +201,7 @@ private static class Updater {
 			IAccessRule.K_DISCOURAGED | IAccessRule.IGNORE_IF_BETTER);
 		private static final IClasspathAttribute	EMPTY_INDEX			= JavaCore.newClasspathAttribute(
 			IClasspathAttribute.INDEX_LOCATION_ATTRIBUTE_NAME,
-			"platform:/plugin/" + BndtoolsBuilder.PLUGIN_ID + "/org/bndtools/builder/classpath/empty.index");
+			"platform:/plugin/" + BuilderPlugin.PLUGIN_ID + "/org/bndtools/builder/classpath/empty.index");
 		private static final IClasspathAttribute	TEST				= JavaCore.newClasspathAttribute("test",
 			Boolean.TRUE.toString());
 		private static final IClasspathAttribute	WITHOUT_TEST_CODE	= JavaCore
@@ -273,7 +272,7 @@ void updateClasspathContainer(boolean init) throws CoreException {
 
 		static void setClasspathContainer(IJavaProject javaProject, BndContainer container) throws JavaModelException {
 			BndPreferences prefs = new BndPreferences();
-			if (prefs.getBuildLogging() == BuildLogger.LOG_FULL) {
+			if (prefs.getBuildLogging() == BuildLoggerConstants.LOG_FULL) {
 				StringBuilder sb = new StringBuilder();
 				sb.append(container.getDescription())
 					.append(" for ")

diff --git a/bndtools.builder/src/org/bndtools/builder/classpath/BndContainerSourceManager.java b/bndtools.builder/src/org/bndtools/builder/classpath/BndContainerSourceManager.java
@@ -14,7 +14,6 @@
 import java.util.jar.JarInputStream;
 import java.util.jar.Manifest;
 
-import org.bndtools.builder.BndtoolsBuilder;
 import org.bndtools.builder.BuilderPlugin;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
@@ -77,7 +76,7 @@ public static void saveAttachedSources(final IProject project, final IClasspathE
 			try (OutputStream out = IO.outputStream(propertiesFile)) {
 				props.store(out, new Date().toString());
 			} catch (final IOException e) {
-				throw new CoreException(new Status(IStatus.ERROR, BndtoolsBuilder.PLUGIN_ID,
+				throw new CoreException(new Status(IStatus.ERROR, BuilderPlugin.PLUGIN_ID,
 					"Failure to write container source attachments", e));
 			}
 		}
@@ -200,7 +199,7 @@ private static Properties loadSourceAttachmentProperties(final IProject project)
 			try (InputStream in = IO.stream(propertiesFile)) {
 				props.load(in);
 			} catch (final IOException e) {
-				throw new CoreException(new Status(IStatus.ERROR, BndtoolsBuilder.PLUGIN_ID,
+				throw new CoreException(new Status(IStatus.ERROR, BuilderPlugin.PLUGIN_ID,
 					"Failure to read container source attachments", e));
 			}
 		}

diff --git a/bndtools.builder/src/org/bndtools/builder/decorator/ui/ComponentDecorator.java b/bndtools.builder/src/org/bndtools/builder/decorator/ui/ComponentDecorator.java
@@ -3,7 +3,7 @@
 import org.bndtools.api.BndtoolsConstants;
 import org.bndtools.api.ILogger;
 import org.bndtools.api.Logger;
-import org.bndtools.builder.ComponentMarker;
+import org.bndtools.builder.handlers.component.ComponentMarker;
 import org.bndtools.core.ui.icons.Icons;
 import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.resources.IResource;

diff --git a/bndtools.builder/src/org/bndtools/builder/decorator/ui/PackageDecorator.java b/bndtools.builder/src/org/bndtools/builder/decorator/ui/PackageDecorator.java
@@ -4,8 +4,8 @@
 
 import org.bndtools.api.ILogger;
 import org.bndtools.api.Logger;
-import org.bndtools.build.api.IProjectDecorator.BndProjectInfo;
-import org.bndtools.builder.BndtoolsBuilder;
+import org.bndtools.api.builder.IProjectDecorator.BndProjectInfo;
+import org.bndtools.builder.BuilderPlugin;
 import org.bndtools.core.ui.icons.Icons;
 import org.bndtools.utils.swt.SWTConcurrencyUtil;
 import org.eclipse.core.resources.IProject;
@@ -37,7 +37,7 @@
 public class PackageDecorator extends LabelProvider implements ILightweightLabelDecorator {
 	private static final ILogger		logger				= Logger.getLogger(PackageDecorator.class);
 	private static final String			packageDecoratorId	= "bndtools.packageDecorator";
-	private static final QualifiedName	packageDecoratorKey	= new QualifiedName(BndtoolsBuilder.PLUGIN_ID,
+	private static final QualifiedName		packageDecoratorKey	= new QualifiedName(BuilderPlugin.PLUGIN_ID,
 		packageDecoratorId);
 	private static final String			excluded			= " <excluded>";
 	private static final ImageDescriptor	exportedIcon		= Icons.desc("icons/plus-decorator.png");

diff --git a/bndtools.builder/src/org/bndtools/builder/decorator/ui/ProjectDecoratorImpl.java b/bndtools.builder/src/org/bndtools/builder/decorator/ui/ProjectDecoratorImpl.java
@@ -1,7 +1,7 @@
 package org.bndtools.builder.decorator.ui;
 
-import org.bndtools.build.api.IProjectDecorator;
-import org.bndtools.builder.ComponentMarker;
+import org.bndtools.api.builder.IProjectDecorator;
+import org.bndtools.builder.handlers.component.ComponentMarker;
 import org.eclipse.core.resources.IProject;
 import org.osgi.annotation.bundle.Capability;
 import org.osgi.namespace.service.ServiceNamespace;