Merge remote-tracking branch 'origin/overengineered-goodness'

dscho · dscho · commit 366e00007dbd · 2014-05-15T17:06:19.000-05:00
The 'overengineered goodness' is the handler plugin type that will allow
us to launch all kinds of classes using the Java "script" engine, even
if the JavaEngine actually has no clue about those classes.

Most notably, we will be able to launch ImageJ 1.x plugins by providing
a handler implementation in imagej-legacy.

Signed-off-by: Johannes Schindelin &lt;johannes.schindelin@gmx.de&gt;

Conflicts:
	src/main/java/org/scijava/plugins/scripting/java/JavaEngine.java
diff --git a/src/main/java/org/scijava/plugins/scripting/java/AbstractJavaRunner.java b/src/main/java/org/scijava/plugins/scripting/java/AbstractJavaRunner.java
@@ -0,0 +1,53 @@
+/*
+ * #%L
+ * JSR-223-compliant Java scripting language plugin.
+ * %%
+ * Copyright (C) 2008 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.plugins.scripting.java;
+
+import org.scijava.plugin.AbstractHandlerPlugin;
+
+/**
+ * Abstract superclass of {@link JavaRunner} implementations.
+ * 
+ * @author Curtis Rueden
+ */
+public abstract class AbstractJavaRunner extends
+	AbstractHandlerPlugin<Class<?>> implements JavaRunner
+{
+
+	// -- Typed methods --
+
+	@Override
+	@SuppressWarnings({ "rawtypes", "unchecked" })
+	public Class<Class<?>> getType() {
+		return (Class) Class.class;
+	}
+
+}
diff --git a/src/main/java/org/scijava/plugins/scripting/java/CommandJavaRunner.java b/src/main/java/org/scijava/plugins/scripting/java/CommandJavaRunner.java
@@ -0,0 +1,74 @@
+/*
+ * #%L
+ * JSR-223-compliant Java scripting language plugin.
+ * %%
+ * Copyright (C) 2008 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.plugins.scripting.java;
+
+import org.scijava.command.Command;
+import org.scijava.command.CommandInfo;
+import org.scijava.command.CommandService;
+import org.scijava.plugin.Parameter;
+import org.scijava.plugin.Plugin;
+import org.scijava.plugin.PluginService;
+
+/**
+ * Runs the given {@link Command} class.
+ * 
+ * @author Curtis Rueden
+ */
+@Plugin(type = JavaRunner.class)
+public class CommandJavaRunner extends AbstractJavaRunner {
+
+	@Parameter
+	private PluginService pluginService;
+
+	@Parameter
+	private CommandService commandService;
+
+	// -- JavaRunner methods --
+
+	@Override
+	public void run(final Class<?> c) {
+		@SuppressWarnings("unchecked")
+		final Class<? extends Command> commandClass =  (Class<? extends Command>) c;
+		final Plugin annotation = c.getAnnotation(Plugin.class);
+		final CommandInfo info = new CommandInfo(commandClass, annotation);
+		pluginService.addPlugin(info);
+		commandService.run(info, true);
+	}
+
+	// -- Typed methods --
+
+	@Override
+	public boolean supports(final Class<?> c) {
+		return Command.class.isAssignableFrom(c);
+	}
+
+}
diff --git a/src/main/java/org/scijava/plugins/scripting/java/DefaultJavaService.java b/src/main/java/org/scijava/plugins/scripting/java/DefaultJavaService.java
@@ -0,0 +1,83 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.plugins.scripting.java;
+
+import javax.script.ScriptException;
+
+import org.scijava.log.LogService;
+import org.scijava.plugin.AbstractHandlerService;
+import org.scijava.plugin.Parameter;
+import org.scijava.plugin.Plugin;
+import org.scijava.service.Service;
+
+/**
+ * Default service for managing available {@link JavaRunner} plugins.
+ * 
+ * @author Curtis Rueden
+ */
+@Plugin(type = Service.class)
+public class DefaultJavaService extends
+	AbstractHandlerService<Class<?>, JavaRunner> implements JavaService
+{
+
+	@Parameter
+	private LogService log;
+
+	// -- JavaService methods --
+
+	@Override
+	public void run(final Class<?> c) throws ScriptException {
+		for (final JavaRunner runner : getInstances()) {
+			if (runner.supports(c)) {
+				runner.run(c);
+				return;
+			}
+		}
+		log.error("Unknown class type: " + c.getName());
+	}
+
+	// -- PTService methods --
+
+	@Override
+	public Class<JavaRunner> getPluginType() {
+		return JavaRunner.class;
+	}
+
+	// -- Typed methods --
+
+	@Override
+	@SuppressWarnings({ "rawtypes", "unchecked" })
+	public Class<Class<?>> getType() {
+		return (Class) Class.class;
+	}
+
+}
diff --git a/src/main/java/org/scijava/plugins/scripting/java/JavaEngine.java b/src/main/java/org/scijava/plugins/scripting/java/JavaEngine.java
@@ -43,7 +43,6 @@
 import java.io.Reader;
 import java.io.StringReader;
 import java.io.Writer;
-import java.lang.reflect.Method;
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.util.ArrayList;
@@ -63,14 +62,11 @@
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.transform.stream.StreamResult;
 
-import org.scijava.command.Command;
-import org.scijava.command.CommandInfo;
 import org.scijava.command.CommandService;
 import org.scijava.minimaven.BuildEnvironment;
 import org.scijava.minimaven.Coordinate;
 import org.scijava.minimaven.MavenProject;
 import org.scijava.plugin.Parameter;
-import org.scijava.plugin.Plugin;
 import org.scijava.plugin.PluginService;
 import org.scijava.script.AbstractScriptEngine;
 import org.scijava.util.FileUtils;
@@ -100,6 +96,9 @@ public class JavaEngine extends AbstractScriptEngine {
 	@Parameter
 	private CommandService commandService;
 
+	@Parameter
+	JavaService javaService;
+
 	@Override
 	public Object eval(String script) throws ScriptException {
 		return eval(new StringReader(script));
@@ -142,23 +141,7 @@ public Object eval(Reader reader) throws ScriptException {
 
 				// launch main class
 				final Class<?> clazz = classLoader.loadClass(mainClass);
-				if (Command.class.isAssignableFrom(clazz)) {
-					final Plugin annotation = clazz.getAnnotation(Plugin.class);
-					final CommandInfo info = new CommandInfo(mainClass,
-							annotation) {
-
-						@Override
-						public Class<? extends Command> loadClass() {
-							return (Class<? extends Command>) clazz;
-						}
-					};
-					pluginService.addPlugin(info);
-					commandService.run(info, true);
-				} else {
-					Method main = clazz.getMethod("main",
-							new Class[] { String[].class });
-					main.invoke(null, new Object[] { new String[0] });
-				}
+				javaService.run(clazz);
 			} finally {
 				builder.cleanup();
 			}
diff --git a/src/main/java/org/scijava/plugins/scripting/java/JavaRunner.java b/src/main/java/org/scijava/plugins/scripting/java/JavaRunner.java
@@ -0,0 +1,58 @@
+/*
+ * #%L
+ * JSR-223-compliant Java scripting language plugin.
+ * %%
+ * Copyright (C) 2008 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.plugins.scripting.java;
+
+import javax.script.ScriptException;
+
+import org.scijava.plugin.HandlerPlugin;
+import org.scijava.plugin.Plugin;
+
+/**
+ * A plugin which extends an Java script language's execution handling. A
+ * {@code JavaRunner} knows how to execute certain classes, beyond just Java's
+ * usual {@code main} method.
+ * <p>
+ * Java runner plugins discoverable at runtime must implement this interface and
+ * be annotated with @{@link Plugin} with attribute {@link Plugin#type()} =
+ * {@link JavaRunner}.class. While it possible to create an console argument
+ * plugin merely by implementing this interface, it is encouraged to instead
+ * extend {@link AbstractJavaRunner}, for convenience.
+ * </p>
+ * 
+ * @author Curtis Rueden
+ */
+public interface JavaRunner extends HandlerPlugin<Class<?>> {
+
+	/** Executes the given class. */
+	void run(Class<?> c) throws ScriptException;
+
+}
diff --git a/src/main/java/org/scijava/plugins/scripting/java/JavaService.java b/src/main/java/org/scijava/plugins/scripting/java/JavaService.java
@@ -0,0 +1,51 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.plugins.scripting.java;
+
+import javax.script.ScriptException;
+
+import org.scijava.plugin.HandlerService;
+import org.scijava.service.SciJavaService;
+
+/**
+ * Interface for service that manages available {@link JavaRunner} plugins.
+ * 
+ * @author Curtis Rueden
+ */
+public interface JavaService extends
+	HandlerService<Class<?>, JavaRunner>, SciJavaService
+{
+
+	/** Executes the given class using the most appropriate handler. */
+	void run(Class<?> c) throws ScriptException;
+
+}
diff --git a/src/main/java/org/scijava/plugins/scripting/java/MainJavaRunner.java b/src/main/java/org/scijava/plugins/scripting/java/MainJavaRunner.java
