Merge branch 'console-refactor'

Consolidates logic for ConsoleArgument implementations, facilitating the
split of the RunArgument command to a dedicated command and script
version.

Author: hinerm

src/main/java/org/scijava/command/console/RunArgument.java

@@ -31,23 +31,21 @@
 
 package org.scijava.command.console;
 
-import java.io.File;
-import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.Map;
 
 import org.scijava.command.CommandInfo;
 import org.scijava.command.CommandService;
 import org.scijava.console.AbstractConsoleArgument;
 import org.scijava.console.ConsoleArgument;
+import org.scijava.console.ConsoleUtils;
 import org.scijava.log.LogService;
 import org.scijava.plugin.Parameter;
 import org.scijava.plugin.Plugin;
-import org.scijava.script.ScriptService;
 
 /**
  * Handles the {@code --run} command line argument.
- * 
+ *
  * @author Curtis Rueden
  * @author Johannes Schindelin
  * @author Mark Hiner hinerm at gmail.com
@@ -58,62 +56,63 @@ public class RunArgument extends AbstractConsoleArgument {
 	@Parameter
 	private CommandService commandService;
 
-	@Parameter
-	private ScriptService scriptService;
-
 	@Parameter
 	private LogService logService;
 
+	// -- Constructor --
+
+	public RunArgument() {
+		super(2, "--run", "--class");
+	}
+
 	// -- ConsoleArgument methods --
 
 	@Override
 	public void handle(final LinkedList<String> args) {
-		if (!supports(args)) return;
+		if (!supports(args))
+			return;
 
 		args.removeFirst(); // --run
 		final String commandToRun = args.removeFirst();
-		final String optionString = args.isEmpty() ? "" : args.removeFirst();
+		final String paramString = args.isEmpty() ? "" : args.removeFirst();
 
-		run(commandToRun, optionString);
+		run(commandToRun, paramString);
 	}
 
 	// -- Typed methods --
 
 	@Override
 	public boolean supports(final LinkedList<String> args) {
-		return args != null && args.size() >= 2 && args.getFirst().equals("--run");
+		if (!super.supports(args))
+			return false;
+		return getInfo(args.get(1)) != null;
 	}
 
 	// -- Helper methods --
 
 	/** Implements the {@code --run} command line argument. */
 	private void run(final String commandToRun, final String optionString) {
-		final Map<String, Object> inputMap = new HashMap<String, Object>();
-
-		if (!optionString.isEmpty()) {
-			final String[] pairs = optionString.split(",");
-			for (final String pair : pairs) {
-				final String[] split = pair.split("=");
-				if (split.length != 2) {
-					logService.error("Parameters must be formatted as a comma-separated list of key=value pairs");
-					return;
-				}
-				inputMap.put(split[0], split[1]);
-			}
-		}
+		// get the command info
+		final CommandInfo info = getInfo(commandToRun);
 
-		// first check if this is a script
-		final File scriptFile = new File(commandToRun);
-		if (scriptFile.exists() && scriptService.canHandleFile(commandToRun)) {
-			try {
-				scriptService.run(scriptFile, true, inputMap);
-			} catch (final Exception exc) {
-				logService.error(exc);
-			}
+		// couldn't find anything to run
+		if (info == null)
 			return;
+
+		// TODO: parse the optionString a la ImageJ1
+		final Map<String, Object> inputMap = ConsoleUtils.parseParameterString(optionString, logService);
+
+		try {
+			commandService.run(info, true, inputMap).get();
+		} catch (final Exception exc) {
+			logService.error(exc);
 		}
+	}
 
-		// Not a script, check if it's a command class
+	/**
+	 * Try to convert the given string to a {@link CommandInfo}
+	 */
+	private CommandInfo getInfo(final String commandToRun) {
 		CommandInfo info = commandService.getCommand(commandToRun);
 		if (info == null) {
 			// command was not a class name; search for command by title instead
@@ -125,11 +124,6 @@ private void run(final String commandToRun, final String optionString) {
 				}
 			}
 		}
-
-		// couldn't find anything to run
-		if (info == null) return;
-		// TODO: parse the optionString a la ImageJ1
-		commandService.run(info, true, inputMap);
+		return info;
 	}
-
 }

src/main/java/org/scijava/console/AbstractConsoleArgument.java

@@ -31,7 +31,9 @@
 
 package org.scijava.console;
 
+import java.util.HashSet;
 import java.util.LinkedList;
+import java.util.Set;
 
 import org.scijava.plugin.AbstractHandlerPlugin;
 
@@ -43,13 +45,43 @@
 public abstract class AbstractConsoleArgument extends
 	AbstractHandlerPlugin<LinkedList<String>> implements ConsoleArgument
 {
+	private int numArgs;
+	private Set<String> aliasFlags;
+
+	public AbstractConsoleArgument() {
+		this(1, new String[0]);
+	}
+
+	public AbstractConsoleArgument(final String... aliases) {
+		this(1, aliases);
+	}
+	
+	public AbstractConsoleArgument(final int requiredArgs, final String... aliases) {
+		numArgs = requiredArgs;
+		aliasFlags = new HashSet<String>();
+		for (final String s : aliases) aliasFlags.add(s);
+	}
 
 	// -- Typed methods --
 
+	@Override
+	public boolean supports(final LinkedList<String> args) {
+		if (args == null || args.size() < numArgs) return false;
+		return isAlias(args);
+	}
+
 	@Override
 	@SuppressWarnings({ "rawtypes", "unchecked" })
 	public Class<LinkedList<String>> getType() {
 		return (Class) String.class;
 	}
 
+	/**
+	 * @return true if there are no aliases for this {@code ConsoleArgument}, or
+	 *         at least one alias matches the first argument in the provided
+	 *         list
+	 */
+	protected boolean isAlias(final LinkedList<String> args) {
+		return aliasFlags.isEmpty() || aliasFlags.contains(args.getFirst());
+	}
 }

src/main/java/org/scijava/console/ConsoleUtils.java

@@ -0,0 +1,66 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2016 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.console;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.scijava.log.LogService;
+
+/**
+ * Helper class for {@link ConsoleArgument}s.
+ *
+ * @author Mark Hiner hinerm at gmail.com
+ */
+public final class ConsoleUtils {
+
+	public static Map<String, Object> parseParameterString(final String parameterString) {
+		return parseParameterString(parameterString, null);
+	}
+
+	public static Map<String, Object> parseParameterString(final String parameterString, final LogService logService) {
+		final Map<String, Object> inputMap = new HashMap<String, Object>();
+
+		if (!parameterString.isEmpty()) {
+			final String[] pairs = parameterString.split(",");
+			for (final String pair : pairs) {
+				final String[] split = pair.split("=");
+				if (split.length == 2)
+					inputMap.put(split[0], split[1]);
+				else if (logService != null)
+					logService.error("Parameters must be formatted as a comma-separated list of key=value pairs");
+
+			}
+		}
+
+		return inputMap;
+	}
+}

src/main/java/org/scijava/console/HeadlessArgument.java

@@ -0,0 +1,76 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2016 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.console;
+
+import java.util.LinkedList;
+
+import org.scijava.Context;
+import org.scijava.plugin.Parameter;
+import org.scijava.plugin.Plugin;
+import org.scijava.ui.UIService;
+
+/**
+ * Handles the {@code --headless} argument to signal that no UI will be opened
+ * and the enclosing {@link Context} will not be used after the
+ * {@link ConsoleService} argument processing is complete.
+ *
+ * @author Mark Hiner hinerm at gmail.com
+ */
+@Plugin(type = ConsoleArgument.class)
+public class HeadlessArgument extends AbstractConsoleArgument {
+
+	@Parameter(required = false)
+	private UIService uiService;
+
+	// -- Constructor --
+
+	public HeadlessArgument() {
+		super(1, "--headless");
+	}
+
+	// -- ConsoleArgument methods --
+
+	@Override
+	public void handle(final LinkedList<String> args) {
+		if (!supports(args)) return;
+
+		args.removeFirst(); // --headless
+
+		uiService.setHeadless(true);
+	}
+	// -- Typed methods --
+
+	@Override
+	public boolean supports(final LinkedList<String> args) {
+		return uiService != null && super.supports(args);
+	}
+
+}

src/main/java/org/scijava/console/SystemPropertyArgument.java

@@ -49,6 +49,12 @@ public class SystemPropertyArgument extends AbstractConsoleArgument {
 	private static final String SYS_PROP_REGEX = "-D([\\w\\._-]+)(=(.*))?";
 	private static final Pattern SYS_PROP_PAT = Pattern.compile(SYS_PROP_REGEX);
 
+	// -- Constructor --
+
+	public SystemPropertyArgument() {
+		super(1);
+	}
+
 	// -- ConsoleArgument methods --
 
 	@Override
@@ -69,7 +75,7 @@ public void handle(final LinkedList<String> args) {
 
 	@Override
 	public boolean supports(final LinkedList<String> args) {
-		if (args == null || args.isEmpty()) return false;
+		if (!super.supports(args)) return false;
 		final String arg = args.getFirst();
 		if (!arg.startsWith("-D")) return false;
 		return SYS_PROP_PAT.matcher(arg).matches();

src/main/java/org/scijava/io/console/OpenArgument.java

@@ -59,6 +59,12 @@ public class OpenArgument extends AbstractConsoleArgument {
 	@Parameter
 	private LogService log;
 
+	// -- Constructor --
+
+	public OpenArgument() {
+		super(2, "--open");
+	}
+
 	// -- ConsoleArgument methods --
 
 	@Override
@@ -76,12 +82,4 @@ public void handle(final LinkedList<String> args) {
 			log.error(exc);
 		}
 	}
-
-	// -- Typed methods --
-
-	@Override
-	public boolean supports(final LinkedList<String> args) {
-		return args != null && args.size() >= 2 && args.getFirst().equals("--open");
-	}
-
 }