Skip to content

Commit 6d098fe

Browse files
ronyflaaghaisas
ronyfla
authored and
aghaisas
committedMar 31, 2020
8234959: FXMLLoader does not populate ENGINE_SCOPE Bindings with FILENAME and ARGV
Reviewed-by: kcr, aghaisas
·
25+1115.0.1+0
1 parent d7f13f4 commit 6d098fe

File tree

15 files changed

+912
-13
lines changed

15 files changed

+912
-13
lines changed
 

‎build.gradle

+4-2
Original file line numberDiff line numberDiff line change
@@ -3571,6 +3571,7 @@ project(":systemTests") {
35713571
testapp4
35723572
testapp5
35733573
testapp6
3574+
testscriptapp1
35743575
}
35753576

35763577
def nonModSrcSets = [
@@ -3583,7 +3584,8 @@ project(":systemTests") {
35833584
sourceSets.testapp3,
35843585
sourceSets.testapp4,
35853586
sourceSets.testapp5,
3586-
sourceSets.testapp6
3587+
sourceSets.testapp6,
3588+
sourceSets.testscriptapp1
35873589
]
35883590

35893591
project.ext.buildModule = false
@@ -3683,7 +3685,7 @@ project(":systemTests") {
36833685
}
36843686
test.dependsOn(createTestApps);
36853687

3686-
def modtestapps = [ "testapp2", "testapp3", "testapp4", "testapp5", "testapp6" ]
3688+
def modtestapps = [ "testapp2", "testapp3", "testapp4", "testapp5", "testapp6", "testscriptapp1" ]
36873689
modtestapps.each { testapp ->
36883690
def testappCapital = testapp.capitalize()
36893691
def copyTestAppTask = task("copy${testappCapital}", type: Copy) {

‎modules/javafx.fxml/src/main/java/javafx/fxml/FXMLLoader.java

+14-10
Original file line numberDiff line numberDiff line change
@@ -618,8 +618,8 @@ public void processEventHandlerAttributes() throws LoadException {
618618
throw constructLoadException("Error resolving " + attribute.name + "='" + attribute.value
619619
+ "', either the event handler is not in the Namespace or there is an error in the script.");
620620
}
621-
622-
eventHandler = new ScriptEventHandler(handlerName, scriptEngine);
621+
eventHandler = new ScriptEventHandler(handlerName, scriptEngine, location.getPath()
622+
+ "-" + attribute.name + "_attribute_in_element_ending_at_line_" + getLineNumber());
623623
}
624624

625625
// Add the handler
@@ -1557,6 +1557,8 @@ public void processStartElement() throws IOException {
15571557

15581558
location = new URL(FXMLLoader.this.location, source);
15591559
}
1560+
Bindings engineBindings = engine.getBindings(ScriptContext.ENGINE_SCOPE);
1561+
engineBindings.put(engine.FILENAME, location.getPath());
15601562

15611563
InputStreamReader scriptReader = null;
15621564
try {
@@ -1582,6 +1584,9 @@ public void processEndElement() throws IOException {
15821584
if (value != null && !staticLoad) {
15831585
// Evaluate the script
15841586
try {
1587+
Bindings engineBindings = scriptEngine.getBindings(ScriptContext.ENGINE_SCOPE);
1588+
engineBindings.put(scriptEngine.FILENAME, location.getPath() + "-script_starting_at_line_"
1589+
+ (getLineNumber() - (int) ((String) value).codePoints().filter(c -> c == '\n').count()));
15851590
scriptEngine.eval((String)value);
15861591
} catch (ScriptException exception) {
15871592
System.err.println(exception.getMessage());
@@ -1675,30 +1680,29 @@ public void handle(T event) {
16751680
private static class ScriptEventHandler implements EventHandler<Event> {
16761681
public final String script;
16771682
public final ScriptEngine scriptEngine;
1683+
public final String filename;
16781684

1679-
public ScriptEventHandler(String script, ScriptEngine scriptEngine) {
1685+
public ScriptEventHandler(String script, ScriptEngine scriptEngine, String filename) {
16801686
this.script = script;
16811687
this.scriptEngine = scriptEngine;
1688+
this.filename = filename;
16821689
}
16831690

16841691
@Override
16851692
public void handle(Event event) {
16861693
// Don't pollute the page namespace with values defined in the script
16871694
Bindings engineBindings = scriptEngine.getBindings(ScriptContext.ENGINE_SCOPE);
16881695
Bindings localBindings = scriptEngine.createBindings();
1689-
localBindings.put(EVENT_KEY, event);
16901696
localBindings.putAll(engineBindings);
1691-
scriptEngine.setBindings(localBindings, ScriptContext.ENGINE_SCOPE);
1692-
1697+
localBindings.put(EVENT_KEY, event);
1698+
localBindings.put(scriptEngine.ARGV, new Object[]{event});
1699+
localBindings.put(scriptEngine.FILENAME, filename);
16931700
// Execute the script
16941701
try {
1695-
scriptEngine.eval(script);
1702+
scriptEngine.eval(script, localBindings);
16961703
} catch (ScriptException exception){
16971704
throw new RuntimeException(exception);
16981705
}
1699-
1700-
// Restore the original bindings
1701-
scriptEngine.setBindings(engineBindings, ScriptContext.ENGINE_SCOPE);
17021706
}
17031707
}
17041708

‎tests/system/src/test/java/test/launchertest/ModuleLauncherTest.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -43,6 +43,8 @@ public class ModuleLauncherTest {
4343
private static final String modulePath4 = System.getProperty("launchertest.testapp4.module.path");
4444
private static final String modulePath5 = System.getProperty("launchertest.testapp5.module.path");
4545
private static final String modulePath6 = System.getProperty("launchertest.testapp6.module.path");
46+
private static final String modulePathScript1 = System.getProperty("launchertest.testscriptapp1.module.path");
47+
4648
private static final String moduleName = "mymod";
4749

4850
private final int testExitCode = ERROR_NONE;
@@ -274,4 +276,9 @@ public void testModuleFXMLQualOpened() throws Exception {
274276
doTestLaunchModule(modulePath6, "myapp6.AppFXMLQualOpened");
275277
}
276278

279+
@Test (timeout = 15000)
280+
public void testFXMLScriptDeployment() throws Exception {
281+
doTestLaunchModule(modulePathScript1, "myapp1.FXMLScriptDeployment");
282+
}
283+
277284
}

‎tests/system/src/testscriptapp1/java/mymod/module-info.java

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
module mymod {
27+
requires javafx.controls;
28+
requires javafx.fxml;
29+
30+
requires java.scripting;
31+
provides javax.script.ScriptEngineFactory with pseudoScriptEngine.RgfPseudoScriptEngineFactory;
32+
exports pseudoScriptEngine;
33+
exports myapp1;
34+
}

‎tests/system/src/testscriptapp1/java/mymod/myapp1/Constants.java

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/*
2+
* Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package myapp1; // verbatim from myapp6
27+
28+
public class Constants {
29+
30+
public static final int SHOWTIME = 2500;
31+
32+
// NOTE: these constants must match those in test.launchertest.Constants
33+
public static final int ERROR_NONE = 2;
34+
public static final int ERROR_UNEXPECTED_EXCEPTION = 4;
35+
36+
public static final int ERROR_ASSERTION_FAILURE = 28;
37+
}

‎tests/system/src/testscriptapp1/java/mymod/myapp1/FXMLScriptDeployment.java

+286
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,286 @@
1+
/*
2+
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package myapp1;
27+
28+
import java.io.IOException;
29+
import java.net.URL;
30+
import java.util.ArrayList;
31+
import java.util.Iterator;
32+
import java.util.List;
33+
import java.util.Set;
34+
import java.util.TreeMap;
35+
36+
import javafx.application.Application;
37+
import javafx.application.Platform;
38+
import javafx.event.ActionEvent;
39+
import javafx.fxml.FXMLLoader;
40+
import javafx.scene.Node;
41+
import javafx.scene.Parent;
42+
import javafx.scene.Scene;
43+
import javafx.scene.control.Button;
44+
import javafx.scene.input.MouseButton;
45+
import javafx.scene.input.MouseEvent;
46+
import javafx.scene.layout.AnchorPane;
47+
import javafx.stage.Stage;
48+
49+
import javax.script.Bindings;
50+
import javax.script.ScriptContext;
51+
52+
import static myapp1.Constants.*;
53+
import pseudoScriptEngine.InvocationInfos;
54+
import pseudoScriptEngine.RgfPseudoScriptEngine;
55+
56+
/**
57+
* Modular test application for testing FXML.
58+
* This is launched by ModuleLauncherTest.
59+
*/
60+
public class FXMLScriptDeployment extends Application {
61+
62+
static boolean bDebug = false; // true; // display invocation list
63+
64+
/** Runs the application and invokes the tests.
65+
* @param args the command line arguments, if any given the RgfPseudoScriptEngine invocation logs get displayed
66+
* which are used in the asserCorrectInvocations() method
67+
*/
68+
public static void main(String[] args) {
69+
try {
70+
// any argument will cause the bDebug flag to be set to true
71+
if (args.length > 0) {
72+
bDebug = true;
73+
}
74+
new FXMLScriptDeployment().launch();
75+
// for debugging, allows to study invocation logs in detail
76+
if (bDebug) { dumpEvalInformation(); }
77+
assertCorrectInvocations();
78+
} catch (AssertionError ex) {
79+
System.err.println("ASSERTION ERROR: caught unexpected exception: " + ex);
80+
ex.printStackTrace(System.err);
81+
System.exit(ERROR_ASSERTION_FAILURE);
82+
} catch (Error | Exception ex) {
83+
System.err.println("ERROR: caught unexpected exception: " + ex);
84+
ex.printStackTrace(System.err);
85+
System.exit(ERROR_UNEXPECTED_EXCEPTION);
86+
}
87+
System.exit(ERROR_NONE); // not in stop() method as we need to run the assertions first
88+
}
89+
90+
@Override
91+
public void start(Stage mainStage) {
92+
URL fxmlUrl = null;
93+
Parent rootNode = null;
94+
Scene scene = null;
95+
Button btn = null;
96+
try {
97+
fxmlUrl = Util.getURL(FXMLScriptDeployment.class, "demo_01");
98+
rootNode = FXMLLoader.load(fxmlUrl);
99+
scene = new Scene(rootNode);
100+
btn = (Button) scene.lookup("#idButton");
101+
}
102+
catch (Exception ioe) {
103+
ioe.printStackTrace();
104+
System.exit(ERROR_UNEXPECTED_EXCEPTION);
105+
}
106+
// fire three events on the button
107+
btn.fire();
108+
btn.fireEvent(new ActionEvent());
109+
btn.fireEvent(new MouseEvent(MouseEvent.MOUSE_CLICKED,
110+
0, // double x,
111+
0, // double y,
112+
0, // double screenX,
113+
0, // double screenY,
114+
MouseButton.PRIMARY, // MouseButton button,
115+
0, // int clickCount,
116+
false, // boolean shiftDown,
117+
false, // boolean controlDown,
118+
false, // boolean altDown,
119+
false, // boolean metaDown,
120+
true, // boolean primaryButtonDown,
121+
false, // boolean middleButtonDown,
122+
false, // boolean secondaryButtonDown,
123+
false, // boolean synthesized,
124+
false, // boolean popupTrigger,
125+
false, // boolean stillSincePress,
126+
null // PickResult pickResult
127+
)
128+
);
129+
130+
// mainStage.setScene(scene);
131+
// mainStage.show();
132+
Platform.exit();
133+
}
134+
135+
// show engine invocations with script text and their Bindings
136+
static void dumpEvalInformation() {
137+
System.err.println("\nListing eval() invocation information (invocationList):");
138+
139+
Iterator<RgfPseudoScriptEngine> it = RgfPseudoScriptEngine.getEnginesUsed().iterator();
140+
while (it.hasNext()) {
141+
RgfPseudoScriptEngine rpse = it.next();
142+
ArrayList invocationList = rpse.getInvocationList();
143+
System.err.println("ScriptEngine: [" + rpse + "]");
144+
145+
Iterator<InvocationInfos> itEval = invocationList.iterator();
146+
int count = 1;
147+
while (itEval.hasNext()) {
148+
System.err.println("\teval() invocation # " + count + ": ");
149+
InvocationInfos entry = itEval.next();
150+
System.err.println(entry.toDebugFormat("\t\t")); // indentation
151+
count++;
152+
System.err.println();
153+
}
154+
}
155+
}
156+
157+
static void assertCorrectInvocations() {
158+
// test only creates one engine for a script controller
159+
Util.assertTrue("exactly one pseudo script engine instance",
160+
RgfPseudoScriptEngine.getEnginesUsed().size() == 1);
161+
RgfPseudoScriptEngine rpse = RgfPseudoScriptEngine.getEnginesUsed().get(0);
162+
163+
ArrayList invocationList = rpse.getInvocationList();
164+
Util.assertTrue("exactly nine script engine invocations", invocationList.size() == 9);
165+
166+
final String FILENAME = "javax.script.filename";
167+
final String ARGV = "javax.script.argv";
168+
final String EVENT = "event";
169+
final String IDBUTTON = "idButton";
170+
final String IDROOT = "idRoot";
171+
final String LOCATION = "location"; // always FXML File hosting script controller code
172+
final String RESOURCES = "resources"; // always null in this test
173+
174+
for (Integer invocation = 1; invocation <= invocationList.size(); invocation++) {
175+
InvocationInfos entry = (InvocationInfos) invocationList.get(invocation - 1);
176+
String script = entry.script;
177+
TreeMap<Integer,TreeMap> scopes = (TreeMap) entry.bindings;
178+
179+
TreeMap<String,Object> engineBindings = scopes.get(100);
180+
TreeMap<String,Object> globalBindings = scopes.get(200);
181+
182+
Object obj = null;
183+
Button btn = null;
184+
185+
// global Bindings
186+
Util.assertExists(IDROOT + " in global scope Bindings", globalBindings.containsKey(IDROOT));
187+
obj = globalBindings.get(IDROOT);
188+
Util.assertType(IDROOT, AnchorPane.class, obj);
189+
190+
Util.assertExists(LOCATION + " in global scope Bindings", globalBindings.containsKey(LOCATION));
191+
obj = globalBindings.get(LOCATION);
192+
Util.assertType(LOCATION, URL.class, obj);
193+
194+
Util.assertExists(RESOURCES + " in global scope Bindings", globalBindings.containsKey(RESOURCES));
195+
obj = globalBindings.get(RESOURCES);
196+
Util.assertNull(RESOURCES,obj);
197+
198+
if (invocation == 1) {
199+
Util.assertNotExists(IDBUTTON + " in global scope Bindings", globalBindings.containsKey(IDBUTTON));
200+
}
201+
else {
202+
Util.assertExists(IDBUTTON + " in global scope Bindings", globalBindings.containsKey(IDBUTTON));
203+
obj = globalBindings.get(IDBUTTON);
204+
Util.assertType(IDBUTTON, Button.class, obj);
205+
btn = (Button) obj;
206+
}
207+
208+
// engine Bindings
209+
Util.assertExists(FILENAME + " in engine scope Bindings", engineBindings.containsKey(FILENAME));
210+
if (invocation < 7) { // no event objects, no arguments
211+
Util.assertNotExists(ARGV + " in engine scope Bindings", engineBindings.containsKey(ARGV));
212+
Util.assertNotExists(EVENT + " in engine scope Bindings", engineBindings.containsKey(EVENT));
213+
}
214+
else { // this has events on the Button
215+
Util.assertExists(ARGV + " in engine scope Bindings", engineBindings.containsKey(ARGV));
216+
Object[] argv = (Object[]) engineBindings.get(ARGV);
217+
218+
Util.assertExists(EVENT + " in engine scope Bindings", engineBindings.containsKey(EVENT));
219+
obj = engineBindings.get(EVENT);
220+
221+
Util.assertSame("argv[0] == event", argv[0], obj);
222+
223+
if (invocation == 9) {
224+
Util.assertType(EVENT, MouseEvent.class, obj);
225+
MouseEvent ev = (MouseEvent) obj;
226+
Util.assertSame("MouseEvent.getSource() == btn", ev.getSource(), btn);
227+
Util.assertSame("MouseEvent.MOUSE_CLICKED", MouseEvent.MOUSE_CLICKED, ev.getEventType());
228+
} else {
229+
Util.assertType(EVENT, ActionEvent.class, obj);
230+
ActionEvent ev = (ActionEvent) obj;
231+
Util.assertSame("ActionEvent.getSource() == btn", ev.getSource(), btn);
232+
}
233+
}
234+
235+
// check filename and script
236+
String filename = (String) engineBindings.get(FILENAME);
237+
boolean ok = false;
238+
switch (invocation) {
239+
case 1:
240+
Util.assertEndsWith ("demo_01_topscript.rpsl", filename);
241+
Util.assertStartsWith("demo_01_topscript.rpsl file - pseudo script", script);
242+
break;
243+
244+
case 2:
245+
Util.assertEndsWith ("demo_01_middlescript.rpsl", filename);
246+
Util.assertStartsWith("demo_01_middlescript.rpsl file - pseudo script", script);
247+
break;
248+
249+
case 3:
250+
Util.assertEndsWith("demo_01.fxml-script_starting_at_line_52", filename);
251+
Util.assertStartsWith("demo_01.fxml embedded script rpsl - line # 52", script);
252+
break;
253+
254+
case 4:
255+
Util.assertEndsWith ("demo_01_bottomscript.rpsl", filename);
256+
Util.assertStartsWith("demo_01_bottomscript.rpsl file - pseudo script", script);
257+
break;
258+
259+
case 5:
260+
Util.assertEndsWith("demo_01.fxml-script_starting_at_line_56", filename);
261+
Util.assertStartsWith("something (line # 56)", script);
262+
break;
263+
264+
case 6:
265+
Util.assertEndsWith("demo_01.fxml-script_starting_at_line_59", filename);
266+
Util.assertStartsWith("demo_01.fxml (line # 59):", script);
267+
break;
268+
269+
case 7: // same as case 8 (same button clicked)
270+
Util.assertEndsWith("demo_01.fxml-onAction_attribute_in_element_ending_at_line_46", filename);
271+
Util.assertStartsWith("demo_01.fxml embedded event - ActionEvent - line # 45 -", script);
272+
break;
273+
274+
case 8: // same as case 7 (same button clicked)
275+
Util.assertEndsWith("demo_01.fxml-onAction_attribute_in_element_ending_at_line_46", filename);
276+
Util.assertStartsWith("demo_01.fxml embedded event - ActionEvent - line # 45 -", script);
277+
break;
278+
279+
case 9:
280+
Util.assertEndsWith("demo_01.fxml-onMouseClicked_attribute_in_element_ending_at_line_46", filename);
281+
Util.assertStartsWith("demo_01.fxml embedded event - MouseClicked - line # 44", script);
282+
break;
283+
}
284+
}
285+
}
286+
}

‎tests/system/src/testscriptapp1/java/mymod/myapp1/Util.java

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
/*
2+
* Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package myapp1; // from myapp6
27+
28+
import java.net.URL;
29+
30+
public class Util {
31+
32+
public static final URL getURL(Class clazz, String name) {
33+
final String theName = name + ".fxml";
34+
final URL fxmlFile = clazz.getResource(theName);
35+
if (fxmlFile == null) {
36+
throw new AssertionError("(getURL()) unable to open: " + theName);
37+
}
38+
return fxmlFile;
39+
}
40+
41+
public static void assertNull(String message, Object o) {
42+
if (o != null) {
43+
throw new AssertionError("(assertNull) " + message + ", expected null object, but was non-null");
44+
}
45+
}
46+
47+
public static void assertNotNull(Object o) {
48+
if (o == null) {
49+
throw new AssertionError("(assertNotNull) expected non-null object, but was null");
50+
}
51+
}
52+
53+
public static void assertEndsWith(String expected, String observed) {
54+
if ((expected == null && observed != null) || !observed.endsWith(expected)) {
55+
throw new AssertionError("(assertEndsWith) " + "expected: <" + expected + "> but was: <" + observed + ">");
56+
}
57+
}
58+
59+
public static void assertStartsWith(String expected, String observed) {
60+
if ((expected == null && observed != null) || !observed.startsWith(expected)) {
61+
throw new AssertionError("(assertStartsWith) " + "expected: <" + expected + "> but was: <" + observed + ">");
62+
}
63+
}
64+
65+
66+
public static void assertSame(String message, Object expected, Object observed) {
67+
if (expected != observed) {
68+
throw new AssertionError("(assertSame) "+ message + ", expected: <" + expected + "> but was: <" + observed + ">");
69+
}
70+
}
71+
72+
public static void assertTrue(String message, boolean cond) {
73+
if (!cond) {
74+
throw new AssertionError("(assertTrue): " + message);
75+
}
76+
}
77+
78+
public static void assertFalse(String message, boolean cond) {
79+
if (cond) {
80+
throw new AssertionError("(assertFalse): " + message);
81+
}
82+
}
83+
84+
public static void assertExists(String message, boolean cond) {
85+
if (!cond) {
86+
throw new AssertionError("(assertExists): " + message);
87+
}
88+
}
89+
90+
public static void assertNotExists(String message, boolean cond) {
91+
if (cond) {
92+
throw new AssertionError("(assertNotExists): " + message);
93+
}
94+
}
95+
96+
public static void assertType(String message, Class clz, Object obj) {
97+
if (obj == null) {
98+
throw new AssertionError("(assertType): " + message+": \"obj\" is null");
99+
}
100+
else if (clz == null) {
101+
throw new AssertionError("(assertType): " + message+": \"clz\" is null");
102+
}
103+
104+
if (! clz.isInstance(obj)) {
105+
throw new AssertionError("(assertType): " + message
106+
+ ", object " + obj +
107+
" is not an instance of class " +
108+
clz + " -> " + clz.getName() + "]");
109+
}
110+
}
111+
112+
private Util() {
113+
}
114+
}

‎tests/system/src/testscriptapp1/java/mymod/pseudoScriptEngine/InvocationInfos.java

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
/*
2+
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package pseudoScriptEngine;
27+
28+
import javax.script.Bindings;
29+
import javax.script.ScriptContext;
30+
import java.time.Instant;
31+
import java.util.ArrayList;
32+
import java.util.Set;
33+
import java.util.TreeMap;
34+
35+
36+
/** Stores PseudoScriptEngine related invocation information for asserting and debugging. */
37+
public class InvocationInfos {
38+
public String script;
39+
public TreeMap<Integer,TreeMap<String,Object>> bindings;
40+
public Instant dateTime;
41+
42+
InvocationInfos(String script, ScriptContext context) {
43+
this.dateTime = Instant.now();
44+
this.script = script;
45+
this.bindings = new TreeMap();
46+
// get and save each Bindings
47+
for (Integer scope : context.getScopes()) {
48+
Bindings binding = context.getBindings(scope);
49+
bindings.put(scope, binding == null ? new TreeMap<String,Object>() : new TreeMap<String,Object>(binding));
50+
}
51+
}
52+
53+
/**
54+
* Creates and returns a string having all information formatted to ease debugging.
55+
* @return string formatted to ease debugging
56+
*/
57+
public String toDebugFormat(String indentation) {
58+
StringBuilder sb = new StringBuilder();
59+
String indent = (indentation == null ? "\t\t" : indentation);
60+
sb.append(indent).append("at: [").append(dateTime.toString()).append("]\n");
61+
sb.append(indent).append("script: [").append(script) .append("]\n");
62+
63+
for (Integer scope : (Set<Integer>) bindings.keySet()) {
64+
sb.append(indent).append("Bindings for scope # ").append(scope);
65+
if (scope == 100) sb.append(" (ENGINE_SCOPE):");
66+
else if (scope == 200) sb.append(" (GLOBAL_SCOPE):");
67+
else sb.append(':');
68+
sb.append('\n');
69+
70+
TreeMap<String,Object> treeMap = bindings.get(scope);
71+
for (String k : (Set<String>) treeMap.keySet()) {
72+
sb.append(indent).append("\t[").append(k).append("]:\t[").append(treeMap.get(k)).append("]\n");
73+
}
74+
}
75+
return sb.toString();
76+
}
77+
}

‎tests/system/src/testscriptapp1/java/mymod/pseudoScriptEngine/RgfPseudoScriptEngine.java

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
/*
2+
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package pseudoScriptEngine;
27+
28+
import javax.script.Bindings;
29+
import javax.script.ScriptContext;
30+
import javax.script.ScriptEngine;
31+
import javax.script.ScriptEngineFactory;
32+
33+
import javax.script.AbstractScriptEngine;
34+
import javax.script.SimpleScriptContext;
35+
import javax.script.SimpleBindings;
36+
37+
import java.util.ArrayList;
38+
import java.util.Set;
39+
import java.util.TreeMap;
40+
import java.io.Reader;
41+
import java.io.BufferedReader;
42+
import java.io.IOException;
43+
44+
import java.time.Instant;
45+
46+
public class RgfPseudoScriptEngine extends AbstractScriptEngine {
47+
static final boolean bDebug = false; // true;
48+
49+
/** Allows to log and access the ScriptEngine instances with their evalDataList. */
50+
static final ArrayList<RgfPseudoScriptEngine> enginesUsed = new ArrayList();
51+
public static ArrayList<RgfPseudoScriptEngine> getEnginesUsed() {
52+
return enginesUsed;
53+
}
54+
55+
public RgfPseudoScriptEngine() {
56+
enginesUsed.add(this);
57+
}
58+
59+
public ScriptEngineFactory getFactory() {
60+
return new RgfPseudoScriptEngineFactory();
61+
}
62+
63+
/** ArrayList of eval() (invocation) information. */
64+
final ArrayList<InvocationInfos> invocationList = new ArrayList();
65+
66+
/** Returns ArrayList of eval() (invocation) information.
67+
* @return invocationList
68+
*/
69+
public ArrayList<InvocationInfos> getInvocationList() {
70+
return invocationList;
71+
}
72+
73+
public Bindings createBindings() {
74+
return new SimpleBindings();
75+
}
76+
77+
public Object eval(Reader reader, ScriptContext context) {
78+
if (bDebug) System.err.println("[debug: " + this + ".eval(Reader,ScriptContext), ScriptContext=" + context + "]");
79+
80+
return eval(readReader(reader), context);
81+
}
82+
83+
84+
public Object eval(String script, ScriptContext context) {
85+
if (bDebug) System.err.print("[debug: " + this + ".eval(String,ScriptContext), ScriptContext=" + context + "]");
86+
87+
// create copies of the Bindings for later inspection as they may
88+
// get reused and changed on each eval() invocation
89+
TreeMap<Integer,TreeMap> bindings = new TreeMap();
90+
for (Integer scope : context.getScopes()) {
91+
Bindings binding = context.getBindings(scope);
92+
bindings.put(scope, binding == null ? new TreeMap<String,Object>() : new TreeMap<String,Object>(binding));
93+
}
94+
invocationList.add(new InvocationInfos(script,context));
95+
if (bDebug) System.err.println(" | invocationList.size()=" + invocationList.size());
96+
return invocationList;
97+
}
98+
99+
100+
String readReader(Reader reader) {
101+
if (reader == null) {
102+
return "";
103+
}
104+
105+
BufferedReader bufferedReader = new BufferedReader(reader);
106+
StringBuilder sb = new StringBuilder();
107+
// caters for possible IOException in read() and close()
108+
try {
109+
try {
110+
char[] charBuffer = new char[1024];
111+
int r = 0;
112+
113+
while ((r = bufferedReader.read(charBuffer)) != -1) {
114+
sb.append(charBuffer, 0, r);
115+
}
116+
} finally {
117+
bufferedReader.close();
118+
}
119+
} catch (IOException ioe) {
120+
throw new RuntimeException(ioe.getMessage(), ioe);
121+
}
122+
return sb.toString();
123+
}
124+
}

‎tests/system/src/testscriptapp1/java/mymod/pseudoScriptEngine/RgfPseudoScriptEngineFactory.java

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
/*
2+
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package pseudoScriptEngine;
27+
28+
import javax.script.ScriptEngine;
29+
import javax.script.ScriptEngineFactory;
30+
31+
import java.lang.StringBuilder;
32+
import java.util.Arrays;
33+
import java.util.List;
34+
35+
36+
public class RgfPseudoScriptEngineFactory implements ScriptEngineFactory {
37+
static final String ENGINE_NAME = "RgfPseudoScriptLanguage (RPSL) 1.0.0";
38+
static final String SHORT_ENGINE_NAME = "rpsl";
39+
static final String ENGINE_VERSION = "100.20200228";
40+
static final List<String> EXTENSIONS = Arrays.asList("rpsl", "RPSL");
41+
static final String LANGUAGE_NAME = "RgfPseudoScriptLanguage";
42+
static final String LANGUAGE_VERSION = "1.0.0.100.20200228";
43+
static final List<String> MIME_TYPES = Arrays.asList("text/rpsl", "application/x-rpsl");
44+
static final String THREADING = "MULTITHREADED";
45+
static final List<String> ENGINE_NAMES = Arrays.asList(SHORT_ENGINE_NAME, "RgfPseudoSL");
46+
47+
public String getEngineName() {
48+
return ENGINE_NAME;
49+
}
50+
51+
public String getEngineVersion() {
52+
return ENGINE_VERSION;
53+
}
54+
55+
public List<String> getExtensions() {
56+
return EXTENSIONS;
57+
}
58+
59+
public String getLanguageName() {
60+
return LANGUAGE_NAME;
61+
}
62+
63+
public String getLanguageVersion() {
64+
return LANGUAGE_VERSION;
65+
}
66+
67+
public String getName() {
68+
return ENGINE_NAME;
69+
}
70+
71+
public String getMethodCallSyntax(String obj, String m, String... args) {
72+
return "obj~(m, ...) /* ooRexx style */ ";
73+
}
74+
75+
public List<String> getMimeTypes() {
76+
return MIME_TYPES;
77+
}
78+
79+
public List<String> getNames() {
80+
return ENGINE_NAMES;
81+
}
82+
83+
public String getOutputStatement(String toDisplay) {
84+
String tmpDisplay = toStringLiteral(toDisplay);
85+
return "say " + tmpDisplay + " /* Rexx style (duplicate quotes within string) */ ";
86+
}
87+
88+
String toStringLiteral(String toDisplay) {
89+
if (toDisplay == null) {
90+
return "\"\"";
91+
}
92+
return '"' + toDisplay.replace("\"","\"\"") + '"';
93+
}
94+
95+
public Object getParameter(final String key) {
96+
switch (key) {
97+
case "THREADING":
98+
return THREADING;
99+
100+
case ScriptEngine.NAME:
101+
return SHORT_ENGINE_NAME;
102+
103+
case ScriptEngine.ENGINE:
104+
return ENGINE_NAME;
105+
106+
case ScriptEngine.ENGINE_VERSION:
107+
return ENGINE_VERSION;
108+
109+
case ScriptEngine.LANGUAGE:
110+
return LANGUAGE_NAME;
111+
112+
case ScriptEngine.LANGUAGE_VERSION:
113+
return LANGUAGE_VERSION;
114+
115+
default:
116+
return null;
117+
}
118+
}
119+
120+
public String getProgram(String... statements) {
121+
if (statements == null) {
122+
return "";
123+
}
124+
125+
StringBuilder sb = new StringBuilder();
126+
for (int i = 0; i < statements.length; i++) {
127+
if (statements[i] == null) {
128+
sb.append("\tsay 'null'; /* Rexx style */ \n");
129+
}
130+
else {
131+
sb.append("\t" + statements[i] + ";\n");
132+
}
133+
}
134+
return sb.toString();
135+
}
136+
137+
public ScriptEngine getScriptEngine() {
138+
return new RgfPseudoScriptEngine();
139+
}
140+
}

‎tests/system/src/testscriptapp1/resources/mymod/META-INF/services/javax.script.ScriptEngineFactory

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
pseudoScriptEngine.RgfPseudoScriptEngineFactory
2+

‎tests/system/src/testscriptapp1/resources/mymod/myapp1/demo_01.fxml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<!--
4+
/*
5+
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
6+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7+
*
8+
* This code is free software; you can redistribute it and/or modify it
9+
* under the terms of the GNU General Public License version 2 only, as
10+
* published by the Free Software Foundation. Oracle designates this
11+
* particular file as subject to the "Classpath" exception as provided
12+
* by Oracle in the LICENSE file that accompanied this code.
13+
*
14+
* This code is distributed in the hope that it will be useful, but WITHOUT
15+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17+
* version 2 for more details (a copy is included in the LICENSE file that
18+
* accompanied this code).
19+
*
20+
* You should have received a copy of the GNU General Public License version
21+
* 2 along with this work; if not, write to the Free Software Foundation,
22+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
23+
*
24+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
25+
* or visit www.oracle.com if you need additional information or have any
26+
* questions.
27+
*/
28+
-->
29+
30+
<?import javafx.scene.control.Button?>
31+
<?import javafx.scene.layout.AnchorPane?>
32+
33+
<!-- line # 33 --> <?language rpsl?>
34+
35+
<AnchorPane fx:id="idRoot" prefHeight="240.0" prefWidth="480.0"
36+
xmlns:fx="http://javafx.com/fxml/1">
37+
38+
<!-- line # 38 --> <fx:script source="demo_01_topscript.rpsl" />
39+
40+
<children>
41+
42+
<!-- line # 42 --> <Button fx:id="idButton" text="Press me!"
43+
layoutX="210.0" layoutY="137.0"
44+
onMouseClicked="demo_01.fxml embedded event - MouseClicked - line # 44 (PCDATA)"
45+
onAction="demo_01.fxml embedded event - ActionEvent - line # 45 - LF entity (&amp;#10;) forces linebreak in attribute value: &#10;
46+
(this is on a new line) these characters in attribute values need to be escaped: &lt;, &gt;, &amp;, these if used as delimiters: &quot;, &apos; (PCDATA)" />
47+
48+
<!-- line # 48 --> <fx:script source="demo_01_middlescript.rpsl" />
49+
50+
</children>
51+
52+
<!-- line # 52 --> <fx:script>demo_01.fxml embedded script rpsl - line # 52</fx:script>
53+
54+
<!-- line # 54 --> <fx:script source="demo_01_bottomscript.rpsl" />
55+
56+
<!-- line # 56 --> <fx:script>something (line # 56)(PCDATA)
57+
in a=&amp;b (line # 57)
58+
the b&gt;1 (line # 58)
59+
news c&lt;2 (line # 59) </fx:script> <fx:script><![CDATA[demo_01.fxml (line # 59):
60+
CDATA-section ("<![CDATA[") allows any characters including <, > and & !! (no need to escape (line # 60)
61+
these special characters; it is plain CDATA which does not get processed, just passed on (line # 61)
62+
including LF etc. (line # 62)
63+
in a=&b (line # 63)
64+
the b>1 (line # 64)
65+
news c<2 (line # 65)
66+
Watch out that in the code there is no string that exactly matches the end tag (line # 66)
67+
for a CDATA-section (close-square-bracket+close-square-bracket+greater-character (line # 67) ]]></fx:script>
68+
69+
</AnchorPane>

‎tests/system/src/testscriptapp1/resources/mymod/myapp1/demo_01_bottomscript.rpsl

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
demo_01_bottomscript.rpsl file - pseudo script in external file, starts with the filename

‎tests/system/src/testscriptapp1/resources/mymod/myapp1/demo_01_middlescript.rpsl

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
demo_01_middlescript.rpsl file - pseudo script in external file, starts with the filename

‎tests/system/src/testscriptapp1/resources/mymod/myapp1/demo_01_topscript.rpsl

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
demo_01_topscript.rpsl file - pseudo script in external file, starts with the filename

0 commit comments

Comments
 (0)
Please sign in to comment.