Add autocompletion framework

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

@@ -31,10 +31,13 @@
 
 package org.scijava.script;
 
+import javax.script.ScriptEngine;
 import javax.script.ScriptEngineFactory;
 
 import org.scijava.plugin.AbstractRichPlugin;
 import org.scijava.plugin.PluginInfo;
+import org.scijava.script.autocompletion.AutoCompleter;
+import org.scijava.script.autocompletion.DefaultAutoCompleter;
 
 /**
  * Abstract superclass for {@link ScriptLanguage} implementations.

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

@@ -31,6 +31,8 @@
 
 package org.scijava.script;
 
+import org.scijava.script.autocompletion.DefaultAutoCompleter;
+import org.scijava.script.autocompletion.AutoCompleter;
 import java.util.List;
 
 import javax.script.ScriptEngine;

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

@@ -31,6 +31,7 @@
 
 package org.scijava.script;
 
+import org.scijava.script.autocompletion.AutoCompleter;
 import java.util.Collections;
 import java.util.List;
 
@@ -41,6 +42,7 @@
 import org.scijava.plugin.Plugin;
 import org.scijava.plugin.RichPlugin;
 import org.scijava.plugin.SingletonPlugin;
+import org.scijava.script.autocompletion.DefaultAutoCompleter;
 import org.scijava.util.VersionUtils;
 
 /**
@@ -150,5 +152,9 @@ else if (key.equals(ScriptEngine.LANGUAGE_VERSION)) {
 	default String getEngineVersion() {
 		return "0.0";
 	}
+
+    default AutoCompleter getAutoCompleter() {
+        return new DefaultAutoCompleter(this);
+    }
 
 }

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

@@ -0,0 +1,141 @@
+/*
+ * #%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.autocompletion;
+
+import java.lang.reflect.Field;
+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;
+import org.scijava.script.ScriptLanguage;
+
+/**
+ *
+ * @author Hadrien Mary
+ */
+public abstract class AbstractAutoCompleter implements AutoCompleter {
+
+    protected ScriptLanguage scriptLanguage = null;
+
+    public AbstractAutoCompleter(ScriptLanguage scriptLanguage) {
+        this.scriptLanguage = scriptLanguage;
+    }
+
+    @Override
+    public AutoCompletionResult autocomplete(String code, ScriptEngine engine) {
+        return autocomplete(code, 0, engine);
+    }
+
+    @Override
+    public AutoCompletionResult autocomplete(String code, int index, ScriptEngine engine) {
+
+        List<String> matches = new ArrayList<>();
+        int startIndex = 0;
+
+        if (code.endsWith(".")) {
+            // Autocompletion with all the attributes of the object
+            matches.addAll(this.engineAttributesCompleter(code, index, engine));
+
+        } else if (code.contains(".")) {
+            List codeList = Arrays.asList(code.split("\\."));
+            String objectString = (String) codeList.get(codeList.size() - 2);
+            String fieldBeginWith = (String) codeList.get(codeList.size() - 1);
+            matches.addAll(this.engineAttributesCompleter(objectString + ".", fieldBeginWith, index, engine));
+
+        } else {
+            // Autocompletion with variables in the engine scope
+            matches.addAll(this.engineVariablesCompleter(code, index, engine));
+        }
+
+        // Remove duplicates
+        matches.stream()
+                .distinct()
+                .collect(Collectors.toList());
+
+        // Sort alphabetcially
+        Collections.sort(matches, new SortIgnoreCase());
+
+        // Return results. For now we ignore index and startIndex.
+        return new AutoCompletionResult(matches, startIndex);
+    }
+
+    private List<String> engineVariablesCompleter(String code, int index, ScriptEngine engine) {
+        List<String> matches = new ArrayList<>();
+
+        Bindings bindings = engine.getBindings(ScriptContext.ENGINE_SCOPE);
+
+        for (String key : bindings.keySet()) {
+            if (key.toLowerCase().startsWith(code.toLowerCase())) {
+                matches.add(key);
+            };
+        }
+        return matches;
+
+    }
+
+    private List<String> engineAttributesCompleter(String objectString, int index, ScriptEngine engine) {
+        return this.engineAttributesCompleter(objectString, "", index, engine);
+    }
+
+    private List<String> engineAttributesCompleter(String objectString, String fieldBeginWith, int index, ScriptEngine engine) {
+        List<String> matches = new ArrayList<>();
+
+        Bindings bindings = engine.getBindings(ScriptContext.ENGINE_SCOPE);
+
+        for (String key : bindings.keySet()) {
+            if (objectString.endsWith(key + ".")) {
+                Object obj = bindings.get(key);
+                for (Field field : obj.getClass().getDeclaredFields()) {
+                    if (field.getName().toLowerCase().startsWith(fieldBeginWith.toLowerCase())) {
+                        matches.add(objectString + field.getName());
+                    }
+                }
+            }
+        }
+
+        return matches;
+    }
+
+    public class SortIgnoreCase implements Comparator<Object> {
+
+        @Override
+        public int compare(Object o1, Object o2) {
+            String s1 = (String) o1;
+            String s2 = (String) o2;
+            return s1.toLowerCase().compareTo(s2.toLowerCase());
+        }
+    }
+}

src/main/java/org/scijava/script/autocompletion/AutoCompleter.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.autocompletion;
+
+import javax.script.ScriptEngine;
+
+/**
+ *
+ * @author Hadrien Mary
+ */
+public interface AutoCompleter {
+
+    public AutoCompletionResult autocomplete(String code, ScriptEngine engine);
+
+    public AutoCompletionResult autocomplete(String code, int startIndex, ScriptEngine engine);
+}

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

@@ -0,0 +1,36 @@
+/*
+ * 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.autocompletion;
+
+import java.util.List;
+
+/**
+ *
+ * @author hadim
+ */
+public class AutoCompletionResult {
+
+    protected List<String> matches;
+    protected int startIndex;
+
+    public AutoCompletionResult(List<String> matches) {
+        this(matches, 0);
+    }
+
+    public AutoCompletionResult(List<String> matches, int startIndex) {
+        this.matches = matches;
+        this.startIndex = startIndex;
+    }
+
+    public int getStartIndex() {
+        return this.startIndex;
+    }
+
+    public List<String> getMatches() {
+        return this.matches;
+    }
+
+}

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

@@ -0,0 +1,45 @@
+/*
+ * #%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.autocompletion;
+
+import org.scijava.script.ScriptLanguage;
+
+/**
+ *
+ * @author Hadrien Mary
+ */
+public class DefaultAutoCompleter extends AbstractAutoCompleter {
+
+    public DefaultAutoCompleter(ScriptLanguage scriptLanguage) {
+        super(scriptLanguage);
+    }
+
+}

src/test/java/org/scijava/script/ScriptEngineTest.java

@@ -31,6 +31,8 @@
 
 package org.scijava.script;
 
+import org.scijava.script.autocompletion.DefaultAutoCompleter;
+import org.scijava.script.autocompletion.AutoCompleter;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 

src/test/java/org/scijava/script/ScriptFinderTest.java

@@ -31,6 +31,8 @@
 
 package org.scijava.script;
 
+import org.scijava.script.autocompletion.DefaultAutoCompleter;
+import org.scijava.script.autocompletion.AutoCompleter;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 

src/test/java/org/scijava/script/ScriptInfoTest.java

@@ -31,6 +31,8 @@
 
 package org.scijava.script;
 
+import org.scijava.script.autocompletion.DefaultAutoCompleter;
+import org.scijava.script.autocompletion.AutoCompleter;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertSame;