Skip to content

Commit b7904e0

Browse files
committed
Add the UI-agnostic part of the script interpreters
The newly-introduced ScriptInterpreter class provides all the functionality of a script interpreter sans the graphical user interface. It can execute statements and persists a history of most recently executed statements. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
1 parent e89f212 commit b7904e0

File tree

2 files changed

+182
-0
lines changed

2 files changed

+182
-0
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2014 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
package org.scijava.script;
32+
33+
import javax.script.ScriptEngine;
34+
import javax.script.ScriptException;
35+
36+
import org.scijava.prefs.PrefService;
37+
38+
/**
39+
* The default implementation of a {@link ScriptInterpreter}.
40+
*
41+
* @author Johannes Schindelin
42+
*/
43+
public class DefaultScriptInterpreter implements ScriptInterpreter {
44+
45+
private ScriptEngine engine;
46+
private History history;
47+
private String currentCommand = "";
48+
49+
/**
50+
* Constructs a new {@link DefaultScriptInterpreter}.
51+
*
52+
* @param scriptService the script service
53+
* @param engine the script engine
54+
*/
55+
public DefaultScriptInterpreter(final PrefService prefs, final ScriptService scriptService, final ScriptEngine engine) {
56+
this.engine = engine;
57+
history = new History(prefs, engine.getClass().getName());
58+
readHistory();
59+
}
60+
61+
@Override
62+
public synchronized void readHistory() {
63+
if (history == null) return;
64+
history.read();
65+
}
66+
67+
@Override
68+
public synchronized void writeHistory() {
69+
if (history == null) return;
70+
history.write();
71+
}
72+
73+
@Override
74+
public synchronized String walkHistory(final String currentCommand, boolean forward) {
75+
this.currentCommand = currentCommand;
76+
if (history == null) return currentCommand;
77+
history.replace(currentCommand);
78+
return forward ? history.next() : history.previous();
79+
}
80+
81+
/**
82+
* Evaluates a command.
83+
*
84+
* @param command the command to evaluate
85+
* @throws ScriptException
86+
*/
87+
@Override
88+
public void eval(String command) throws ScriptException {
89+
if (history != null) history.add(command);
90+
if (engine == null) throw new java.lang.IllegalArgumentException();
91+
engine.eval(command);
92+
}
93+
94+
/**
95+
* Returns the current script engine.
96+
*
97+
* @return
98+
*/
99+
@Override
100+
public ScriptEngine getEngine() {
101+
return engine;
102+
}
103+
104+
}
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2014 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
32+
package org.scijava.script;
33+
34+
import javax.script.ScriptEngine;
35+
import javax.script.ScriptException;
36+
37+
/**
38+
* The contract for script interpreters.
39+
*
40+
* @author Johannes Schindelin
41+
*/
42+
public interface ScriptInterpreter {
43+
44+
/**
45+
* Reads the persisted history of the current script interpreter.
46+
*/
47+
public void readHistory();
48+
49+
/**
50+
* Persists the history of the current script interpreter.
51+
*/
52+
public void writeHistory();
53+
54+
/**
55+
* Obtains the next/previous command in the command history.
56+
*
57+
* @param currentCommand the current command (will be stored in the history)
58+
* @param forward if true, the next history entry is returned (more recent),
59+
* if false, the previous one
60+
* @return the next/previous command
61+
*/
62+
public String walkHistory(final String currentCommand, boolean forward);
63+
64+
/**
65+
* Evaluates a command.
66+
*
67+
* @param command the command to evaluate
68+
* @throws ScriptException
69+
*/
70+
public void eval(String command) throws ScriptException;
71+
72+
/**
73+
* Returns the associated {@link ScriptEngine}
74+
*
75+
* @return the script engine
76+
*/
77+
public ScriptEngine getEngine();
78+
}

0 commit comments

Comments
 (0)