From: plaa <plaa@180e2498-e6e9-4542-8430-84ac67f01cd8>
Date: Tue, 20 Mar 2012 20:19:38 +0000 (+0000)
Subject: Initial plugin framework
X-Git-Tag: upstream/12.09^2~412
X-Git-Url: https://git.gag.com/?a=commitdiff_plain;h=36c73699404df98fcaabd3ce187772ab3781f751;p=debian%2Fopenrocket

Initial plugin framework

git-svn-id: https://openrocket.svn.sourceforge.net/svnroot/openrocket/trunk@477 180e2498-e6e9-4542-8430-84ac67f01cd8
---

diff --git a/core/.classpath b/core/.classpath
index 10ef69c6..deeb71e4 100644
--- a/core/.classpath
+++ b/core/.classpath
@@ -25,5 +25,6 @@
 	<classpathentry kind="lib" path="lib-test/junit-dep-4.8.2.jar"/>
 	<classpathentry kind="lib" path="lib-test/uispec4j-2.3-jdk16.jar"/>
 	<classpathentry kind="lib" path="resources"/>
+	<classpathentry kind="lib" path="lib/jspf.core-1.0.2.jar" sourcepath="/home/sampo/Projects/lib/jspf/documentation/api"/>
 	<classpathentry kind="output" path="bin"/>
 </classpath>
diff --git a/core/lib/jspf.core-1.0.2.jar b/core/lib/jspf.core-1.0.2.jar
new file mode 100644
index 00000000..02dec5bc
Binary files /dev/null and b/core/lib/jspf.core-1.0.2.jar differ
diff --git a/core/src/net/sf/openrocket/plugin/AbstractService.java b/core/src/net/sf/openrocket/plugin/AbstractService.java
new file mode 100644
index 00000000..02719646
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/AbstractService.java
@@ -0,0 +1,45 @@
+package net.sf.openrocket.plugin;
+
+import java.util.Collections;
+import java.util.List;
+
+import net.sf.openrocket.util.BugException;
+
+/**
+ * An abstract service implementation that returns plugins of type P.
+ * 
+ * @param <P>	the plugin type that this service returns.
+ * @author Sampo Niskanen <sampo.niskanen@iki.fi>
+ */
+public abstract class AbstractService<P> implements Service {
+	
+	private final Class<P> type;
+	
+	protected AbstractService(Class<P> type) {
+		this.type = type;
+	}
+	
+	@SuppressWarnings("unchecked")
+	@Override
+	public <E> List<E> getPlugins(Class<E> e, Object... args) {
+		
+		if (e != type) {
+			return Collections.emptyList();
+		}
+		
+		List<P> plugins = getPlugins(args);
+		
+		// Check list content types to avoid mysterious bugs later on
+		for (P p : plugins) {
+			if (!type.isInstance(p)) {
+				throw new BugException("Requesting plugins of type " + type + " but received " +
+						((p != null) ? p.getClass() : "null"));
+			}
+		}
+		
+		return (List<E>) plugins;
+	}
+	
+	protected abstract List<P> getPlugins(Object... args);
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/JSPFPluginFactory.java b/core/src/net/sf/openrocket/plugin/JSPFPluginFactory.java
new file mode 100644
index 00000000..6b598b69
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/JSPFPluginFactory.java
@@ -0,0 +1,50 @@
+package net.sf.openrocket.plugin;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.List;
+
+import net.sf.openrocket.util.BugException;
+import net.xeoh.plugins.base.Plugin;
+import net.xeoh.plugins.base.PluginManager;
+import net.xeoh.plugins.base.impl.PluginManagerFactory;
+import net.xeoh.plugins.base.util.JSPFProperties;
+import net.xeoh.plugins.base.util.PluginManagerUtil;
+
+public class JSPFPluginFactory implements PluginFactory {
+	
+	private final PluginManager pluginManager;
+	
+	public JSPFPluginFactory() {
+		
+		final JSPFProperties props = new JSPFProperties();
+		
+		//		props.setProperty(PluginManager.class, "cache.enabled", "true");
+		//		props.setProperty(PluginManager.class, "cache.mode", "weak"); //optional
+		//		props.setProperty(PluginManager.class, "cache.file", "jspf.cache");
+		
+		try {
+			pluginManager = PluginManagerFactory.createPluginManager(props);
+			pluginManager.addPluginsFrom(new URI("classpath://*"));
+		} catch (URISyntaxException e) {
+			throw new BugException(e);
+		}
+	}
+	
+	@Override
+	public <E extends Plugin> List<E> getPlugins(Class<E> e, Object... args) {
+		
+		List<E> plugins = new ArrayList<E>();
+		
+		PluginManagerUtil pluginManagerUtil = new PluginManagerUtil(pluginManager);
+		plugins.addAll(pluginManagerUtil.getPlugins(e));
+		
+		for (Service s : pluginManagerUtil.getPlugins(Service.class)) {
+			plugins.addAll(s.getPlugins(e, args));
+		}
+		
+		return plugins;
+		
+	}
+}
diff --git a/core/src/net/sf/openrocket/plugin/PluginFactory.java b/core/src/net/sf/openrocket/plugin/PluginFactory.java
new file mode 100644
index 00000000..babf01da
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/PluginFactory.java
@@ -0,0 +1,11 @@
+package net.sf.openrocket.plugin;
+
+import java.util.List;
+
+import net.xeoh.plugins.base.Plugin;
+
+public interface PluginFactory {
+	
+	public <E extends Plugin> List<E> getPlugins(Class<E> e, Object... args);
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/Service.java b/core/src/net/sf/openrocket/plugin/Service.java
new file mode 100644
index 00000000..f19c6b16
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/Service.java
@@ -0,0 +1,13 @@
+package net.sf.openrocket.plugin;
+
+import java.util.List;
+
+import net.xeoh.plugins.base.Plugin;
+
+public interface Service extends Plugin {
+	
+	
+	public <E> List<E> getPlugins(Class<E> e, Object... args);
+	
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/example/ExampleMain.java b/core/src/net/sf/openrocket/plugin/example/ExampleMain.java
new file mode 100644
index 00000000..c45afee2
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/example/ExampleMain.java
@@ -0,0 +1,21 @@
+package net.sf.openrocket.plugin.example;
+
+import net.sf.openrocket.plugin.JSPFPluginFactory;
+import net.sf.openrocket.plugin.PluginFactory;
+
+public class ExampleMain {
+	
+	
+	public static void main(String[] args) {
+		PluginFactory factory = new JSPFPluginFactory();
+		
+		System.out.println("Plugins:");
+		System.out.println("---------");
+		for (ExamplePluginInterface plugin : factory.getPlugins(ExamplePluginInterface.class)) {
+			plugin.print();
+		}
+		System.out.println("---------");
+	}
+	
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/example/ExamplePlugin.java b/core/src/net/sf/openrocket/plugin/example/ExamplePlugin.java
new file mode 100644
index 00000000..4579f9e3
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/example/ExamplePlugin.java
@@ -0,0 +1,17 @@
+package net.sf.openrocket.plugin.example;
+
+
+public class ExamplePlugin implements ExamplePluginInterface {
+	
+	private final String str;
+	
+	public ExamplePlugin(String str) {
+		this.str = str;
+	}
+	
+	@Override
+	public void print() {
+		System.out.println("ExamplePlugin: " + str);
+	}
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/example/ExamplePluginInterface.java b/core/src/net/sf/openrocket/plugin/example/ExamplePluginInterface.java
new file mode 100644
index 00000000..ddf157dc
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/example/ExamplePluginInterface.java
@@ -0,0 +1,9 @@
+package net.sf.openrocket.plugin.example;
+
+import net.xeoh.plugins.base.Plugin;
+
+public interface ExamplePluginInterface extends Plugin {
+	
+	public void print();
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/example/ExampleService.java b/core/src/net/sf/openrocket/plugin/example/ExampleService.java
new file mode 100644
index 00000000..9960bcda
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/example/ExampleService.java
@@ -0,0 +1,24 @@
+package net.sf.openrocket.plugin.example;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import net.sf.openrocket.plugin.AbstractService;
+import net.xeoh.plugins.base.annotations.PluginImplementation;
+
+@PluginImplementation
+public class ExampleService extends AbstractService<ExamplePluginInterface> {
+	
+	protected ExampleService() {
+		super(ExamplePluginInterface.class);
+	}
+	
+	@Override
+	protected List<ExamplePluginInterface> getPlugins(Object... args) {
+		List<ExamplePluginInterface> plugins = new ArrayList<ExamplePluginInterface>();
+		plugins.add(new ExamplePlugin("a"));
+		plugins.add(new ExamplePlugin("b"));
+		return plugins;
+	}
+	
+}
diff --git a/core/src/net/sf/openrocket/plugin/example/ExampleSingletonPlugin.java b/core/src/net/sf/openrocket/plugin/example/ExampleSingletonPlugin.java
new file mode 100644
index 00000000..aa015180
--- /dev/null
+++ b/core/src/net/sf/openrocket/plugin/example/ExampleSingletonPlugin.java
@@ -0,0 +1,13 @@
+package net.sf.openrocket.plugin.example;
+
+import net.xeoh.plugins.base.annotations.PluginImplementation;
+
+@PluginImplementation
+public class ExampleSingletonPlugin implements ExamplePluginInterface {
+	
+	@Override
+	public void print() {
+		System.out.println("ExampleSingletonPlugin");
+	}
+	
+}