ScriptService: allow menu prefix with a script dir

It may be the case that you want to set a menu path prefix to use for
all scripts within the given directory. Let's support this, particularly
for backwards compatibility with ImageJ 1.x.

Author: ctrueden

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

@@ -52,6 +52,7 @@
 import org.scijava.Context;
 import org.scijava.Gateway;
 import org.scijava.InstantiableException;
+import org.scijava.MenuPath;
 import org.scijava.Priority;
 import org.scijava.command.CommandService;
 import org.scijava.log.LogService;
@@ -98,6 +99,9 @@ public class DefaultScriptService extends
 	/** List of directories to scan for scripts. */
 	private ArrayList<File> scriptDirs;
 
+	/** Menu prefix to use for each script directory, if any. */
+	private HashMap<File, MenuPath> menuPrefixes;
+
 	/** Index of available scripts, by script <em>file</em>. */
 	private HashMap<File, ScriptInfo> scripts;
 
@@ -133,11 +137,24 @@ public List<File> getScriptDirectories() {
 		return Collections.unmodifiableList(scriptDirs());
 	}
 
+	@Override
+	public MenuPath getMenuPrefix(final File scriptDirectory) {
+		return menuPrefixes().get(scriptDirectory);
+	}
+
 	@Override
 	public void addScriptDirectory(final File scriptDirectory) {
 		scriptDirs().add(scriptDirectory);
 	}
 
+	@Override
+	public void addScriptDirectory(final File scriptDirectory,
+		final MenuPath menuPrefix)
+	{
+		scriptDirs().add(scriptDirectory);
+		menuPrefixes().put(scriptDirectory, menuPrefix);
+	}
+
 	@Override
 	public void removeScriptDirectory(final File scriptDirectory) {
 		scriptDirs().remove(scriptDirectory);
@@ -283,6 +300,12 @@ private List<File> scriptDirs() {
 		return scriptDirs;
 	}
 
+	/** Gets {@link #menuPrefixes}, initializing if needed. */
+	private HashMap<File, MenuPath> menuPrefixes() {
+		if (menuPrefixes == null) initMenuPrefixes();
+		return menuPrefixes;
+	}
+
 	/** Gets {@link #scripts}, initializing if needed. */
 	private HashMap<File, ScriptInfo> scripts() {
 		if (scripts == null) initScripts();
@@ -338,6 +361,12 @@ private synchronized void initScriptDirs() {
 		scriptDirs = dirs;
 	}
 
+	/** Initializes {@link #menuPrefixes}. */
+	private synchronized void initMenuPrefixes() {
+		if (menuPrefixes != null) return;
+		menuPrefixes = new HashMap<File, MenuPath>();
+	}
+
 	/** Initializes {@link #scripts}. */
 	private synchronized void initScripts() {
 		if (scripts != null) return; // already initialized

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

@@ -84,7 +84,9 @@ public void findScripts(final List<ScriptInfo> scripts) {
 					directory.getAbsolutePath());
 				continue;
 			}
-			scriptCount += discoverScripts(scripts, directory, new MenuPath());
+			final MenuPath prefix = scriptService.getMenuPrefix(directory);
+			final MenuPath menuPath = prefix == null ? new MenuPath() : prefix;
+			scriptCount += discoverScripts(scripts, directory, menuPath);
 		}
 
 		log.info("Found " + scriptCount + " scripts");

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

@@ -43,6 +43,7 @@
 import javax.script.ScriptEngineFactory;
 import javax.script.ScriptException;
 
+import org.scijava.MenuPath;
 import org.scijava.module.process.PostprocessorPlugin;
 import org.scijava.module.process.PreprocessorPlugin;
 import org.scijava.plugin.Plugin;
@@ -95,9 +96,20 @@ public interface ScriptService extends SingletonService<ScriptLanguage>,
 	/** Gets the base directories to scan for scripts. */
 	List<File> getScriptDirectories();
 
+	/**
+	 * Gets the menu path prefix for the given script directory, or null if none.
+	 */
+	MenuPath getMenuPrefix(File scriptDirectory);
+
 	/** Adds a base directory to scan for scripts. */
 	void addScriptDirectory(File scriptDirectory);
 
+	/**
+	 * Adds a base directory to scan for scripts, placing discovered scripts
+	 * beneath the given menu path prefix.
+	 */
+	void addScriptDirectory(File scriptDirectory, final MenuPath menuPrefix);
+
 	/** Removes a base directory to scan for scripts. */
 	void removeScriptDirectory(File scriptDirectory);