Merge branch 'autocompletion-framework'

This branch adds autocompletion support to the ScriptLanguage API,
courtesy of Hadrien Mary.

Closes #264.

Author: ctrueden

src/main/java/org/scijava/parse/DefaultParseService.java

@@ -36,7 +36,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.scijava.parse.Variable;
 import org.scijava.parse.eval.DefaultEvaluator;
 import org.scijava.plugin.Plugin;
 import org.scijava.service.AbstractService;

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

@@ -0,0 +1,157 @@
+/*
+ * #%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;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import javax.script.Bindings;
+import javax.script.ScriptContext;
+import javax.script.ScriptEngine;
+
+/**
+ * Abstract base class for {@link AutoCompleter} implementations.
+ * 
+ * @author Hadrien Mary
+ */
+public abstract class AbstractAutoCompleter implements AutoCompleter {
+
+	@SuppressWarnings("unused")
+	private ScriptLanguage scriptLanguage;
+
+	public AbstractAutoCompleter(final ScriptLanguage scriptLanguage) {
+		this.scriptLanguage = scriptLanguage;
+	}
+
+	@Override
+	public AutoCompletionResult autocomplete(final String code, final int index,
+		final ScriptEngine engine)
+	{
+
+		final List<String> matches = new ArrayList<>();
+		final int startIndex = 0;
+
+		if (code.endsWith(".")) {
+			// Autocompletion with all the attributes of the object
+			matches.addAll(engineAttributesCompleter(code, index, engine));
+
+		}
+		else if (code.contains(".")) {
+			final List<String> codeList = Arrays.asList(code.split("\\."));
+			final String objectString = codeList.get(codeList.size() - 2);
+			final String prefix = codeList.get(codeList.size() - 1);
+			matches.addAll(engineAttributesCompleter(objectString + ".",
+				prefix, index, engine));
+
+		}
+		else {
+			// Autocompletion with variables in the engine scope
+			matches.addAll(engineVariablesCompleter(code, index, engine));
+		}
+
+		// Remove duplicates
+		final List<String> unique = //
+			matches.stream().distinct().collect(Collectors.toList());
+
+		// Sort alphabetically, ignoring case
+		Collections.sort(unique, new Comparator<Object>() {
+
+			@Override
+			public int compare(final Object o1, final Object o2) {
+				final String s1 = (String) o1;
+				final String s2 = (String) o2;
+				return s1.toLowerCase().compareTo(s2.toLowerCase());
+			}
+		});
+
+		// Return results. For now we ignore index and startIndex.
+		return new AutoCompletionResult(unique, startIndex);
+	}
+
+	private List<String> engineVariablesCompleter(final String code,
+		@SuppressWarnings("unused") final int index, final ScriptEngine engine)
+	{
+		final List<String> matches = new ArrayList<>();
+
+		final Bindings bindings = engine.getBindings(ScriptContext.ENGINE_SCOPE);
+
+		for (final String key : bindings.keySet()) {
+			if (key.toLowerCase().startsWith(code.toLowerCase())) {
+				matches.add(key);
+			}
+		}
+		return matches;
+
+	}
+
+	private List<String> engineAttributesCompleter(final String objectString,
+		final int index, final ScriptEngine engine)
+	{
+		return engineAttributesCompleter(objectString, "", index, engine);
+	}
+
+	private List<String> engineAttributesCompleter(final String objectString,
+		final String prefix, @SuppressWarnings("unused") final int index,
+		final ScriptEngine engine)
+	{
+		final List<String> matches = new ArrayList<>();
+		final String lPrefix = prefix.toLowerCase();
+
+		final Bindings bindings = engine.getBindings(ScriptContext.ENGINE_SCOPE);
+
+		for (final String key : bindings.keySet()) {
+			if (objectString.endsWith(key + ".")) {
+				final Object obj = bindings.get(key);
+				// check for public field completions
+				for (final Field field : obj.getClass().getFields()) {
+					if (field.getName().toLowerCase().startsWith(lPrefix)) {
+						matches.add(objectString + field.getName());
+					}
+				}
+				// check for public method completions
+				for (final Method method : obj.getClass().getMethods()) {
+					if (method.getName().toLowerCase().startsWith(lPrefix)) {
+						matches.add(objectString + method.getName() + "(");
+					}
+				}
+			}
+		}
+
+		return matches;
+	}
+}

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

@@ -0,0 +1,50 @@
+/*
+ * #%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;
+
+import javax.script.ScriptEngine;
+
+/**
+ * Helper for generating autocomplete suggestions for code fragments.
+ *
+ * @author Hadrien Mary
+ */
+public interface AutoCompleter {
+
+	default AutoCompletionResult autocomplete(final String code,
+		final ScriptEngine engine)
+	{
+		return autocomplete(code, 0, engine);
+	}
+
+	AutoCompletionResult autocomplete(String code, int startIndex,
+		ScriptEngine engine);
+}

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

@@ -0,0 +1,40 @@
+/*
+ * 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.
+ */
+
+package org.scijava.script;
+
+import java.util.List;
+
+/**
+ * Data structure housing suggestions given by {@link AutoCompleter} helpers.
+ * 
+ * @author Hadrien Mary
+ */
+public class AutoCompletionResult {
+
+	private List<String> matches;
+	private int startIndex;
+
+	public AutoCompletionResult(final List<String> matches) {
+		this(matches, 0);
+	}
+
+	public AutoCompletionResult(final List<String> matches,
+		final int startIndex)
+	{
+		this.matches = matches;
+		this.startIndex = startIndex;
+	}
+
+	public int getStartIndex() {
+		return startIndex;
+	}
+
+	public List<String> getMatches() {
+		return matches;
+	}
+
+}

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

@@ -0,0 +1,44 @@
+/*
+ * #%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;
+
+/**
+ * Default implementation of {@link AutoCompleter}.
+ *
+ * @author Hadrien Mary
+ */
+public class DefaultAutoCompleter extends AbstractAutoCompleter {
+
+	public DefaultAutoCompleter(final ScriptLanguage scriptLanguage) {
+		super(scriptLanguage);
+	}
+}

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

@@ -65,6 +65,8 @@
  * </p>
  * 
  * @author Johannes Schindelin
+ * @author Curtis Rueden
+ * @author Hadrien Mary
  */
 public interface ScriptLanguage extends ScriptEngineFactory, RichPlugin,
 	SingletonPlugin
@@ -86,6 +88,14 @@ default Object decode(final Object object) {
 		return object;
 	}
 
+	/**
+	 * Gets a helper object capable of generating autocomplete suggestions for a
+	 * code fragment.
+	 */
+	default AutoCompleter getAutoCompleter() {
+		return new DefaultAutoCompleter(this);
+	}
+
 	// -- ScriptEngineFactory methods --
 
 	@Override

src/test/java/org/scijava/command/CommandInfoTest.java

@@ -47,7 +47,6 @@
 import org.scijava.command.CommandInfoTest.CommandWithEnumParam.Choice;
 import org.scijava.module.ModuleItem;
 import org.scijava.plugin.Parameter;
-import org.scijava.plugin.Plugin;
 
 /**
  * Tests {@link CommandInfo}.