Skip to content

Commit ef38e33

Browse files
wojciszekwojciszek
committed
Calculate absolute position for action offending token
Signed-off-by: Wojtek K <5840392+wojciszek@users.noreply.github.com>
1 parent 45ee4ec commit ef38e33

4 files changed

Lines changed: 172 additions & 24 deletions

File tree

‎tool-testsuite/test/org/antlr/v4/test/tool/TestAttributeChecks.java‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@
66

77
package org.antlr.v4.test.tool;
88

9+
import org.antlr.runtime.CommonToken;
910
import org.antlr.runtime.RecognitionException;
11+
import org.antlr.v4.test.runtime.ErrorQueue;
12+
import org.antlr.v4.tool.ANTLRMessage;
1013
import org.antlr.v4.tool.ErrorType;
14+
import org.junit.jupiter.api.Assertions;
1115
import org.junit.jupiter.api.Test;
1216
import org.junit.jupiter.params.ParameterizedTest;
1317
import org.junit.jupiter.params.provider.Arguments;
@@ -18,6 +22,7 @@
1822

1923
import java.util.ArrayList;
2024
import java.util.List;
25+
import java.util.function.Consumer;
2126
import java.util.stream.Stream;
2227

2328
import static org.antlr.v4.test.tool.ToolTestUtils.testErrors;
@@ -235,6 +240,18 @@ public void testDynamicInlineActions(String input, String expected) {
235240
testAction("inline", attributeTemplate, input, expected);
236241
}
237242

243+
@Test
244+
public void shouldDetectOffendingTokenAbsolutePosition(){
245+
String expectedError = "error(" + ErrorType.ISOLATED_RULE_REF.code + "): A.g4:7:4: missing attribute access on rule reference lab in $lab\n";
246+
testAction("inline", attributeTemplate, "$lab", expectedError, q -> {
247+
Assertions.assertEquals(1, q.errors.size());
248+
ANTLRMessage antlrMessage = q.errors.get(0);
249+
CommonToken token = (CommonToken) antlrMessage.offendingToken;
250+
Assertions.assertEquals(131, token.getStartIndex(), "Offending Token start index assertion");
251+
Assertions.assertEquals(133, token.getStopIndex(), "Offending Token stop index assertion");
252+
});
253+
}
254+
238255
@Test public void testBadInlineActions() throws RecognitionException {
239256
testActions("inline", bad_inlineChecks, attributeTemplate);
240257
}
@@ -266,11 +283,16 @@ private static void testActions(String location, String[] pairs, String template
266283
}
267284

268285
private static void testAction(String location, String template, String action, String expected) {
286+
testAction(location, template, action, expected, $ -> {});
287+
}
288+
289+
private static void testAction(String location, String template, String action, String expected, Consumer<ErrorQueue> errorQueueConsumer) {
269290
STGroup g = new STGroup('<', '>');
270-
g.setListener(new ErrorBuffer()); // hush warnings
291+
ErrorBuffer listener = new ErrorBuffer();
292+
g.setListener(listener); // hush warnings
271293
ST st = new ST(g, template);
272294
st.add(location, action);
273295
String grammar = st.render();
274-
testErrors(new String[]{grammar, expected}, false);
296+
testErrors(new String[]{grammar, expected}, errorQueueConsumer);
275297
}
276298
}

‎tool-testsuite/test/org/antlr/v4/test/tool/ToolTestUtils.java‎

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import java.nio.file.Path;
3030
import java.nio.file.Paths;
3131
import java.util.List;
32+
import java.util.function.Consumer;
3233

3334
import static org.antlr.v4.test.runtime.FileUtils.deleteDirectory;
3435
import static org.antlr.v4.test.runtime.Generator.antlrOnString;
@@ -91,33 +92,40 @@ public static RunOptions createOptionsForJavaToolTests(
9192
}
9293

9394
public static void testErrors(String[] pairs, boolean printTree) {
95+
testErrors(pairs, $ -> {});
96+
}
97+
98+
public static void testErrors(String[] pairs, Consumer<ErrorQueue> errorQueueAssertionsConsumer) {
9499
for (int i = 0; i < pairs.length; i += 2) {
95100
String grammarStr = pairs[i];
96101
String expect = pairs[i + 1];
102+
testErrors(grammarStr, expect, errorQueueAssertionsConsumer);
103+
}
104+
}
97105

98-
String[] lines = grammarStr.split("\n");
99-
String fileName = getFilenameFromFirstLineOfGrammar(lines[0]);
100-
101-
String tempDirName = "AntlrTestErrors-" + Thread.currentThread().getName() + "-" + System.currentTimeMillis();
102-
String tempTestDir = Paths.get(TempDirectory, tempDirName).toString();
106+
private static void testErrors(String grammarStr, String expect, Consumer<ErrorQueue> additionalAssertions) {
107+
String[] lines = grammarStr.split("\n");
108+
String fileName = getFilenameFromFirstLineOfGrammar(lines[0]);
103109

104-
try {
105-
ErrorQueue equeue = antlrOnString(tempTestDir, null, fileName, grammarStr, false);
110+
String tempDirName = "AntlrTestErrors-" + Thread.currentThread().getName() + "-" + System.currentTimeMillis();
111+
String tempTestDir = Paths.get(TempDirectory, tempDirName).toString();
106112

107-
String actual = equeue.toString(true);
108-
actual = actual.replace(tempTestDir + File.separator, "");
109-
String msg = grammarStr;
110-
msg = msg.replace("\n", "\\n");
111-
msg = msg.replace("\r", "\\r");
112-
msg = msg.replace("\t", "\\t");
113+
try {
114+
ErrorQueue equeue = antlrOnString(tempTestDir, null, fileName, grammarStr, false);
115+
String actual = equeue.toString(true);
116+
actual = actual.replace(tempTestDir + File.separator, "");
117+
String msg = grammarStr;
118+
msg = msg.replace("\n", "\\n");
119+
msg = msg.replace("\r", "\\r");
120+
msg = msg.replace("\t", "\\t");
113121

114-
assertEquals(expect, actual, "error in: " + msg);
115-
}
116-
finally {
117-
try {
118-
deleteDirectory(new File(tempTestDir));
119-
} catch (IOException ignored) {
120-
}
122+
assertEquals(expect, actual, "error in: " + msg);
123+
additionalAssertions.accept(equeue);
124+
}
125+
finally {
126+
try {
127+
deleteDirectory(new File(tempTestDir));
128+
} catch (IOException ignored) {
121129
}
122130
}
123131
}

‎tool/src/org/antlr/v4/semantics/ActionErrorManager.java‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
package org.antlr.v4.semantics;
2+
3+
import org.antlr.runtime.CommonToken;
4+
import org.antlr.runtime.RecognitionException;
5+
import org.antlr.runtime.Token;
6+
import org.antlr.v4.tool.*;
7+
import org.stringtemplate.v4.ST;
8+
9+
import java.util.Collection;
10+
import java.util.Objects;
11+
12+
public class ActionErrorManager extends ErrorManager {
13+
private final Token actionToken;
14+
private final ErrorManager delegate;
15+
16+
public ActionErrorManager(Token actionToken, ErrorManager delegate) {
17+
super(delegate.tool);
18+
this.delegate = Objects.requireNonNull(delegate, "ErrorManager delegate cannot be null");
19+
this.actionToken = Objects.requireNonNull(actionToken, "Token actionToken cannot be null");
20+
}
21+
22+
@Override
23+
public void grammarError(ErrorType etype, String fileName, Token token, Object... args) {
24+
delegate.grammarError(etype, fileName, resolveTokenWithGrammarAbsolutePosition(token), args);
25+
}
26+
27+
private Token resolveTokenWithGrammarAbsolutePosition(Token token) {
28+
if (token instanceof CommonToken && actionToken instanceof CommonToken) {
29+
CommonToken absolutePositionToken = new CommonToken(token);
30+
CommonToken ruleToken = (CommonToken) actionToken;
31+
absolutePositionToken.setStartIndex(ruleToken.getStartIndex() + absolutePositionToken.getStartIndex());
32+
absolutePositionToken.setStopIndex(ruleToken.getStartIndex() + absolutePositionToken.getStopIndex());
33+
return absolutePositionToken;
34+
}
35+
return token;
36+
}
37+
38+
@Override
39+
public void resetErrorState() {
40+
delegate.resetErrorState();
41+
}
42+
43+
@Override
44+
public ST getMessageTemplate(ANTLRMessage msg) {
45+
return delegate.getMessageTemplate(msg);
46+
}
47+
48+
@Override
49+
public ST getLocationFormat() {
50+
return delegate.getLocationFormat();
51+
}
52+
53+
@Override
54+
public ST getReportFormat(ErrorSeverity severity) {
55+
return delegate.getReportFormat(severity);
56+
}
57+
58+
@Override
59+
public ST getMessageFormat() {
60+
return delegate.getMessageFormat();
61+
}
62+
63+
@Override
64+
public boolean formatWantsSingleLineMessage() {
65+
return delegate.formatWantsSingleLineMessage();
66+
}
67+
68+
@Override
69+
public void info(String msg) {
70+
delegate.info(msg);
71+
}
72+
73+
@Override
74+
public void syntaxError(ErrorType etype, String fileName, Token token, RecognitionException antlrException, Object... args) {
75+
delegate.syntaxError(etype, fileName, token, antlrException, args);
76+
}
77+
78+
@Override
79+
public void toolError(ErrorType errorType, Object... args) {
80+
delegate.toolError(errorType, args);
81+
}
82+
83+
@Override
84+
public void toolError(ErrorType errorType, Throwable e, Object... args) {
85+
delegate.toolError(errorType, e, args);
86+
}
87+
88+
@Override
89+
public void leftRecursionCycles(String fileName, Collection<? extends Collection<Rule>> cycles) {
90+
delegate.leftRecursionCycles(fileName, cycles);
91+
}
92+
93+
@Override
94+
public int getNumErrors() {
95+
return delegate.getNumErrors();
96+
}
97+
98+
@Override
99+
public void emit(ErrorType etype, ANTLRMessage msg) {
100+
delegate.emit(etype, msg);
101+
}
102+
103+
@Override
104+
public void setFormat(String formatName) {
105+
delegate.setFormat(formatName);
106+
}
107+
108+
@Override
109+
protected boolean verifyFormat() {
110+
return super.verifyFormat();
111+
}
112+
113+
@Override
114+
public void panic(ErrorType errorType, Object... args) {
115+
delegate.panic(errorType, args);
116+
}
117+
}

‎tool/src/org/antlr/v4/semantics/AttributeChecks.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
package org.antlr.v4.semantics;
88

99
import org.antlr.runtime.ANTLRStringStream;
10+
import org.antlr.runtime.CommonToken;
1011
import org.antlr.runtime.Token;
1112
import org.antlr.v4.parse.ActionSplitter;
1213
import org.antlr.v4.parse.ActionSplitterListener;
@@ -39,8 +40,8 @@ public AttributeChecks(Grammar g, Rule r, Alternative alt, ActionAST node, Token
3940
this.alt = alt;
4041
this.node = node;
4142
this.actionToken = actionToken;
42-
this.errMgr = g.tool.errMgr;
43-
}
43+
this.errMgr = new ActionErrorManager(actionToken, g.tool.errMgr);
44+
}
4445

4546
public static void checkAllAttributeExpressions(Grammar g) {
4647
for (ActionAST act : g.namedActions.values()) {

0 commit comments

Comments
 (0)