-
Notifications
You must be signed in to change notification settings - Fork 198
/
SLStatementNode.java
217 lines (195 loc) · 8 KB
/
SLStatementNode.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
* Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.truffle.sl.nodes;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.dsl.ReportPolymorphism;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.instrumentation.GenerateWrapper;
import com.oracle.truffle.api.instrumentation.InstrumentableNode;
import com.oracle.truffle.api.instrumentation.ProbeNode;
import com.oracle.truffle.api.instrumentation.StandardTags;
import com.oracle.truffle.api.instrumentation.Tag;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.nodes.NodeInfo;
import com.oracle.truffle.api.nodes.RootNode;
import com.oracle.truffle.api.source.Source;
import com.oracle.truffle.api.source.SourceSection;
/**
* The base class of all Truffle nodes for SL. All nodes (even expressions) can be used as
* statements, i.e., without returning a value. The {@link VirtualFrame} provides access to the
* local variables.
*/
@NodeInfo(language = "SL", description = "The abstract base node for all SL statements")
@GenerateWrapper
@ReportPolymorphism
public abstract class SLStatementNode extends Node implements InstrumentableNode {
private static final int NO_SOURCE = -1;
private static final int UNAVAILABLE_SOURCE = -2;
private int sourceCharIndex = NO_SOURCE;
private int sourceLength;
private boolean hasStatementTag;
private boolean hasRootTag;
/*
* The creation of source section can be implemented lazily by looking up the root node source
* and then creating the source section object using the indices stored in the node. This avoids
* the eager creation of source section objects during parsing and creates them only when they
* are needed. Alternatively, if the language uses source sections to implement language
* semantics, then it might be more efficient to eagerly create source sections and store it in
* the AST.
*
* For more details see {@link InstrumentableNode}.
*/
@Override
@TruffleBoundary
public final SourceSection getSourceSection() {
if (sourceCharIndex == NO_SOURCE) {
// AST node without source
return null;
}
RootNode rootNode = getRootNode();
if (rootNode == null) {
// not yet adopted yet
return null;
}
SourceSection rootSourceSection = rootNode.getSourceSection();
if (rootSourceSection == null) {
return null;
}
Source source = rootSourceSection.getSource();
if (sourceCharIndex == UNAVAILABLE_SOURCE) {
if (hasRootTag && !rootSourceSection.isAvailable()) {
return rootSourceSection;
} else {
return source.createUnavailableSection();
}
} else {
return source.createSection(sourceCharIndex, sourceLength);
}
}
public final boolean hasSource() {
return sourceCharIndex != NO_SOURCE;
}
public final boolean isInstrumentable() {
return hasSource();
}
public final int getSourceCharIndex() {
return sourceCharIndex;
}
public final int getSourceEndIndex() {
return sourceCharIndex + sourceLength;
}
public final int getSourceLength() {
return sourceLength;
}
// invoked by the parser to set the source
public final void setSourceSection(int charIndex, int length) {
assert sourceCharIndex == NO_SOURCE : "source must only be set once";
if (charIndex < 0) {
throw new IllegalArgumentException("charIndex < 0");
} else if (length < 0) {
throw new IllegalArgumentException("length < 0");
}
this.sourceCharIndex = charIndex;
this.sourceLength = length;
}
public final void setUnavailableSourceSection() {
assert sourceCharIndex == NO_SOURCE : "source must only be set once";
this.sourceCharIndex = UNAVAILABLE_SOURCE;
}
public boolean hasTag(Class<? extends Tag> tag) {
if (tag == StandardTags.StatementTag.class) {
return hasStatementTag;
} else if (tag == StandardTags.RootTag.class || tag == StandardTags.RootBodyTag.class) {
return hasRootTag;
}
return false;
}
public WrapperNode createWrapper(ProbeNode probe) {
return new SLStatementNodeWrapper(this, probe);
}
/**
* Execute this node as as statement, where no return value is necessary.
*/
public abstract void executeVoid(VirtualFrame frame);
/**
* Marks this node as being a {@link StandardTags.StatementTag} for instrumentation purposes.
*/
public final void addStatementTag() {
hasStatementTag = true;
}
/**
* Marks this node as being a {@link StandardTags.RootTag} and {@link StandardTags.RootBodyTag}
* for instrumentation purposes.
*/
public final void addRootTag() {
hasRootTag = true;
}
@Override
public String toString() {
return formatSourceSection(this);
}
/**
* Formats a source section of a node in human readable form. If no source section could be
* found it looks up the parent hierarchy until it finds a source section. Nodes where this was
* required append a <code>'~'</code> at the end.
*
* @param node the node to format.
* @return a formatted source section string
*/
public static String formatSourceSection(Node node) {
if (node == null) {
return "<unknown>";
}
SourceSection section = node.getSourceSection();
boolean estimated = false;
if (section == null) {
section = node.getEncapsulatingSourceSection();
estimated = true;
}
if (section == null || section.getSource() == null) {
return "<unknown source>";
} else {
String sourceName = section.getSource().getName();
int startLine = section.getStartLine();
return String.format("%s:%d%s", sourceName, startLine, estimated ? "~" : "");
}
}
}