annotate truffle/com.oracle.truffle.sl/src/com/oracle/truffle/sl/nodes/SLStatementNode.java @ 22157:dc83cc1f94f2

Using fully qualified imports
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 16 Sep 2015 11:33:22 +0200
parents 503529c65456
children 20380d1d41f2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
1 /*
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
2 * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
4 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
5 * The Universal Permissive License (UPL), Version 1.0
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
6 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
7 * Subject to the condition set forth below, permission is hereby granted to any
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
8 * person obtaining a copy of this software, associated documentation and/or
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
9 * data (collectively the "Software"), free of charge and under any and all
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
10 * copyright rights in the Software, and any and all patent rights owned or
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
11 * freely licensable by each licensor hereunder covering either (i) the
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
12 * unmodified Software as contributed to or provided by such licensor, or (ii)
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
13 * the Larger Works (as defined below), to deal in both
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
14 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
15 * (a) the Software, and
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
16 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
17 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
18 * one is included with the Software each a "Larger Work" to which the Software
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
19 * is contributed by such licensors),
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
20 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
21 * without restriction, including without limitation the rights to copy, create
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
22 * derivative works of, display, perform, and distribute the Software and make,
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
23 * use, sell, offer for sale, import, export, have made, and have sold the
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
24 * Software and the Larger Work(s), and to sublicense the foregoing rights on
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
25 * either these or other terms.
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
26 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
27 * This license is subject to the following condition:
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
28 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
29 * The above copyright notice and either this complete permission notice or at a
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
30 * minimum a reference to the UPL must be included in all copies or substantial
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
31 * portions of the Software.
22065
503529c65456 Remove trailing whitespace from UPL license
Tom Rodriguez <tom.rodriguez@oracle.com>
parents: 21997
diff changeset
32 *
21997
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
c07e64ecb528 Update SL copyright headers to use UPL
Gilles Duboscq <gilles.m.duboscq@oracle.com>
parents: 21951
diff changeset
39 * SOFTWARE.
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
40 */
13761
7c418666c6c9 Refactoring and cleanup of Simple Language (more to come soon)
Christian Wimmer <christian.wimmer@oracle.com>
parents: 12752
diff changeset
41 package com.oracle.truffle.sl.nodes;
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
42
22157
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22065
diff changeset
43 import com.oracle.truffle.api.frame.VirtualFrame;
18990
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
44 import com.oracle.truffle.api.instrument.ProbeNode.WrapperNode;
22157
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22065
diff changeset
45 import com.oracle.truffle.api.nodes.Node;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22065
diff changeset
46 import com.oracle.truffle.api.nodes.NodeInfo;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22065
diff changeset
47 import com.oracle.truffle.api.source.SourceSection;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22065
diff changeset
48 import com.oracle.truffle.sl.nodes.instrument.SLStatementWrapperNode;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22065
diff changeset
49 import java.io.File;
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
50
13821
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
51 /**
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
52 * The base class of all Truffle nodes for SL. All nodes (even expressions) can be used as
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
53 * statements, i.e., without returning a value. The {@link VirtualFrame} provides access to the
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
54 * local variables.
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
55 */
15776
111bf82514ca SL: adding NodeInfo.descriptions to SL statements
Christian Wirth <christian.wirth@oracle.com>
parents: 13821
diff changeset
56 @NodeInfo(language = "Simple Language", description = "The abstract base node for all statements")
18990
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
57 public abstract class SLStatementNode extends Node {
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
58
16512
abe7128ca473 SL: upgrade source attribution
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15776
diff changeset
59 public SLStatementNode(SourceSection src) {
abe7128ca473 SL: upgrade source attribution
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15776
diff changeset
60 super(src);
abe7128ca473 SL: upgrade source attribution
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15776
diff changeset
61 }
abe7128ca473 SL: upgrade source attribution
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15776
diff changeset
62
13821
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
63 /**
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
64 * Execute this node as as statement, where no return value is necessary.
b16ec83edc73 Documentation and more refactoring of Simple Language
Christian Wimmer <christian.wimmer@oracle.com>
parents: 13761
diff changeset
65 */
13761
7c418666c6c9 Refactoring and cleanup of Simple Language (more to come soon)
Christian Wimmer <christian.wimmer@oracle.com>
parents: 12752
diff changeset
66 public abstract void executeVoid(VirtualFrame frame);
16595
618d92152d3c SL: Added support for instrumentation.
David Piorkowski <david.piorkowski@oracle.com>
parents: 16512
diff changeset
67
618d92152d3c SL: Added support for instrumentation.
David Piorkowski <david.piorkowski@oracle.com>
parents: 16512
diff changeset
68 public SLStatementNode getNonWrapperNode() {
618d92152d3c SL: Added support for instrumentation.
David Piorkowski <david.piorkowski@oracle.com>
parents: 16512
diff changeset
69 return this;
618d92152d3c SL: Added support for instrumentation.
David Piorkowski <david.piorkowski@oracle.com>
parents: 16512
diff changeset
70 }
16880
7661cc464239 Truffle/Instrumentation: Added Instrumentable interface and LineLocationToSourceSections map
David Piorkowski <david.piorkowski@oracle.com>
parents: 16595
diff changeset
71
7661cc464239 Truffle/Instrumentation: Added Instrumentable interface and LineLocationToSourceSections map
David Piorkowski <david.piorkowski@oracle.com>
parents: 16595
diff changeset
72 @Override
16913
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
73 public String toString() {
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
74 return formatSourceSection(this);
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
75 }
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
76
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
77 /**
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
78 * Formats a source section of a node in human readable form. If no source section could be
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
79 * found it looks up the parent hierarchy until it finds a source section. Nodes where this was
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
80 * required append a <code>'~'</code> at the end.
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
81 *
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
82 * @param node the node to format.
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
83 * @return a formatted source section string
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
84 */
20096
3844fb65016c SL: repeating node should implement SLStatementNode for a proper toString implementation.
Christian Humer <christian.humer@gmail.com>
parents: 18990
diff changeset
85 public static String formatSourceSection(Node node) {
16913
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
86 if (node == null) {
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
87 return "<unknown>";
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
88 }
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
89 SourceSection section = node.getSourceSection();
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
90 boolean estimated = false;
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
91 if (section == null) {
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
92 section = node.getEncapsulatingSourceSection();
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
93 estimated = true;
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
94 }
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
95
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
96 if (section == null || section.getSource() == null) {
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
97 return "<unknown source>";
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
98 } else {
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
99 String sourceName = new File(section.getSource().getName()).getName();
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
100 int startLine = section.getStartLine();
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
101 return String.format("%s:%d%s", sourceName, startLine, estimated ? "~" : "");
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
102 }
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
103 }
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
104
b879421229db SL: better toString for SL nodes.
Christian Humer <christian.humer@gmail.com>
parents: 16880
diff changeset
105 @Override
18990
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
106 public boolean isInstrumentable() {
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
107 return true;
16880
7661cc464239 Truffle/Instrumentation: Added Instrumentable interface and LineLocationToSourceSections map
David Piorkowski <david.piorkowski@oracle.com>
parents: 16595
diff changeset
108 }
16958
997899955e72 Instrumentation: removed ExecutionContext parameter from probe method in Instrumentable
David Piorkowski <david.piorkowski@oracle.com>
parents: 16914
diff changeset
109
18485
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests.
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18163
diff changeset
110 @Override
18990
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
111 public WrapperNode createWrapperNode() {
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
112 return new SLStatementWrapperNode(this);
d1c1cd2530d7 Truffle/Instrumentation: clean up and repair some old unit tests
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
113 }
16958
997899955e72 Instrumentation: removed ExecutionContext parameter from probe method in Instrumentable
David Piorkowski <david.piorkowski@oracle.com>
parents: 16914
diff changeset
114
7503
31da1716950f Updated truffle-sl for the changed operation code generation.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
115 }