Merge branch 'scripting-cleanup'

This provides miscellaneous fixes to the SciJava script framework.
In particular, it fixes a big problem with the implicit result output.

Author: ctrueden

src/main/java/org/scijava/script/AbstractAutoCompleter.java

@@ -8,13 +8,13 @@
  * %%
  * 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

src/main/java/org/scijava/script/AutoCompletionResult.java

@@ -1,7 +1,32 @@
-/*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+/*-
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2017 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.script;

src/main/java/org/scijava/script/CodeGenerator.java

@@ -35,7 +35,9 @@
  * Code Generator Interface
  * 
  * @author Grant Harris
+ * @deprecated To be removed in SciJava Common 3.0.0.
  */
+@Deprecated
 public interface CodeGenerator {
 
 	/** Adds delimiter character between arguments (typically a ','). */

src/main/java/org/scijava/script/CodeGeneratorJava.java

@@ -35,7 +35,9 @@
  * {@link CodeGenerator} for Java.
  * 
  * @author Grant Harris
+ * @deprecated To be removed in SciJava Common 3.0.0.
  */
+@Deprecated
 public class CodeGeneratorJava implements CodeGenerator {
 
 	static final String lsep = System.getProperty("line.separator");

src/main/java/org/scijava/script/DefaultScriptInterpreter.java

@@ -42,6 +42,7 @@
 import org.scijava.log.LogService;
 import org.scijava.plugin.Parameter;
 import org.scijava.prefs.PrefService;
+import org.scijava.util.LastRecentlyUsed;
 
 /**
  * The default implementation of a {@link ScriptInterpreter}.
@@ -363,4 +364,113 @@ private static <T> T callMethod(final Object object, final String methodName,
 		return null;
 	}
 
+	// -- Helper classes --
+	
+	/** Container for a script language's interpreter history. */
+	private static class History {
+
+		@SuppressWarnings("unused")
+		protected static final long serialVersionUID = 2L;
+
+		private static final String PREFIX = "History.";
+		private final int MAX_ENTRIES = 1000;
+
+		private final PrefService prefs;
+		private final String name;
+		private final LastRecentlyUsed<String> entries =
+			new LastRecentlyUsed<>(MAX_ENTRIES);
+		private String currentCommand = "";
+		private int position = -1;
+
+		/**
+		 * Constructs a history object for a given scripting language.
+		 * 
+		 * @param name the name of the scripting language
+		 */
+		public History(final PrefService prefs, final String name) {
+			this.prefs = prefs;
+			this.name = name;
+		}
+
+		/**
+		 * Read back a persisted history.
+		 */
+		public void read() {
+			entries.clear();
+			for (final String item : prefs.getIterable(getClass(), PREFIX + name)) {
+				entries.addToEnd(item);
+			}
+		}
+
+		/**
+		 * Persist the history.
+		 * 
+		 * @see PrefService
+		 */
+		public void write() {
+			prefs.putIterable(getClass(), entries, PREFIX + name);
+		}
+
+		/**
+		 * Adds the most recently issued command.
+		 * 
+		 * @param command the most recent command to add to the history
+		 */
+		public void add(final String command) {
+			entries.add(command);
+			position = -1;
+			currentCommand = "";
+		}
+
+		public boolean replace(final String command) {
+			if (position < 0) {
+				currentCommand = command;
+				return false;
+			}
+			return entries.replace(position, command);
+		}
+
+		/**
+		 * Navigates to the next (more recent) command.
+		 * <p>
+		 * This method wraps around, i.e. it returns {@code null} when there is no
+		 * more-recent command in the history.
+		 * </p>
+		 * 
+		 * @return the next command
+		 */
+		public String next() {
+			position = entries.next(position);
+			return position < 0 ? currentCommand : entries.get(position);
+		}
+
+		/**
+		 * Navigates to the previous (i.e less recent) command.
+		 * <p>
+		 * This method wraps around, i.e. it returns {@code null} when there is no
+		 * less-recent command in the history.
+		 * </p>
+		 * 
+		 * @return the previous command
+		 */
+		public String previous() {
+			position = entries.previous(position);
+			return position < 0 ? currentCommand : entries.get(position);
+		}
+
+		@Override
+		public String toString() {
+			final StringBuilder builder = new StringBuilder();
+			int pos = -1;
+			for (;;) {
+				pos = entries.previous(pos);
+				if (pos < 0) break;
+				if (builder.length() > 0) builder.append(" -> ");
+				if (this.position == pos) builder.append("[");
+				builder.append(entries.get(pos));
+				if (this.position == pos) builder.append("]");
+			}
+			return builder.toString();
+		}
+	}
 }

src/main/java/org/scijava/script/History.java

@@ -38,7 +38,9 @@
  * the parameters that were passed to it.
  * 
  * @author Grant Harris
+ * @deprecated To be removed in SciJava Common 3.0.0.
  */
+@Deprecated
 public class InvocationObject {
 
 	public String moduleCalled;

src/main/java/org/scijava/script/InvocationObject.java

@@ -35,7 +35,9 @@
  * Holds a parameter, its type and value, for a recorded macro.
  * 
  * @author Grant Harris
+ * @deprecated To be removed in SciJava Common 3.0.0.
  */
+@Deprecated
 public class ParameterObject {
 
 	public ParameterObject(final String param, final Class<?> type,

src/main/java/org/scijava/script/ParameterObject.java

@@ -432,7 +432,7 @@ private void parseParam(final String param,
 			varName = tokens[1];
 		}
 		final Class<?> type = scriptService.lookupClass(typeName);
-		addItem(varName, type, attrs);
+		addItem(varName, type, attrs, true);
 
 		if (ScriptModule.RETURN_VALUE.equals(varName)) {
 			// NB: The return value variable is declared as an explicit OUTPUT.
@@ -460,11 +460,11 @@ private void checkValid(final boolean valid, final String param)
 	private void addReturnValue() {
 		final HashMap<String, Object> attrs = new HashMap<>();
 		attrs.put("type", "OUTPUT");
-		addItem(ScriptModule.RETURN_VALUE, Object.class, attrs);
+		addItem(ScriptModule.RETURN_VALUE, Object.class, attrs, false);
 	}
 
 	private <T> void addItem(final String name, final Class<T> type,
-		final Map<String, Object> attrs)
+		final Map<String, Object> attrs, final boolean explicit)
 	{
 		final DefaultMutableModuleItem<T> item =
 			new DefaultMutableModuleItem<>(this, name, type);
@@ -477,7 +477,7 @@ private <T> void addItem(final String name, final Class<T> type,
 			registerOutput(item);
 			// NB: Only append the return value as an extra
 			// output when no explicit outputs are declared.
-			appendReturnValue = false;
+			if (explicit) appendReturnValue = false;
 		}
 	}