Parallel lock free testing, remove potential deadlocks, cache static data, go to descriptor via test

runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/RuntimeTestLexer.java

@@ -0,0 +1,10 @@
+import org.antlr.v4.runtime.CharStream;
+import org.antlr.v4.runtime.Lexer;
+
+public abstract class RuntimeTestLexer extends Lexer {
+	protected java.io.PrintStream outStream = System.out;
+
+	public RuntimeTestLexer(CharStream input) { super(input); }
+
+	public void setOutStream(java.io.PrintStream outStream) { this.outStream = outStream; }
+}

runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/RuntimeTestParser.java

@@ -0,0 +1,14 @@
+import org.antlr.v4.runtime.Parser;
+import org.antlr.v4.runtime.TokenStream;
+
+public abstract class RuntimeTestParser extends Parser {
+	protected java.io.PrintStream outStream = System.out;
+
+	public RuntimeTestParser(TokenStream input) {
+		super(input);
+	}
+
+	public void setOutStream(java.io.PrintStream outStream) {
+		this.outStream = outStream;
+	}
+}

runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/Test.java.stg

@@ -1,20 +1,34 @@
 import org.antlr.v4.runtime.*;
 import org.antlr.v4.runtime.tree.*;
 import org.antlr.v4.runtime.atn.*;
+
+import java.io.IOException;
+import java.io.PrintStream;
 import java.nio.file.Paths;
 import java.util.Arrays;
 
 public class Test {
 	public static void main(String[] args) throws Exception {
+		recognize(args[0], System.out, System.err);
+	}
+
+	public static void recognize(String inputFile, PrintStream outStream, PrintStream errorStream) throws IOException {
+		CustomStreamErrorListener errorListener = new CustomStreamErrorListener(errorStream);
 <if(lexerName)>
-		CharStream input = CharStreams.fromPath(Paths.get(args[0]));
+		CharStream input = CharStreams.fromPath(Paths.get(inputFile));
 		<lexerName> lexer = new <lexerName>(input);
+		lexer.setOutStream(outStream);
+		lexer.removeErrorListeners();
+		lexer.addErrorListener(errorListener);
 		CommonTokenStream tokens = new CommonTokenStream(lexer);
 <else>
 		CommonTokenStream tokens = null; // It's required for compilation
 <endif>
 <if(parserName)>
 		<parserName> parser = new <parserName>(tokens);
+		parser.setOutStream(outStream);
+		parser.removeErrorListeners();
+		parser.addErrorListener(errorListener);
 <if(debug)>
 		parser.addErrorListener(new DiagnosticErrorListener());
 <endif>
@@ -25,18 +39,36 @@ public class Test {
 <endif>
 		ParserRuleContext tree = parser.<parserStartRuleName>();
 <if(profile)>
-		System.out.println(Arrays.toString(profiler.getDecisionInfo()));
+		outStream.println(Arrays.toString(profiler.getDecisionInfo()));
 <endif>
 		ParseTreeWalker.DEFAULT.walk(new TreeShapeListener(), tree);
 <else>
 		tokens.fill();
-		for (Object t : tokens.getTokens()) System.out.println(t);
+		for (Object t : tokens.getTokens()) outStream.println(t);
 <if(showDFA)>
-		System.out.print(lexer.getInterpreter().getDFA(Lexer.DEFAULT_MODE).toLexerString());
+		outStream.print(lexer.getInterpreter().getDFA(Lexer.DEFAULT_MODE).toLexerString());
 <endif>
 <endif>
 	}
 
+	static class CustomStreamErrorListener extends BaseErrorListener {
+		private final PrintStream printStream;
+
+		public CustomStreamErrorListener(PrintStream printStream){
+			this.printStream = printStream;
+		}
+
+		@Override
+		public void syntaxError(Recognizer\<?, ?> recognizer,
+								Object offendingSymbol,
+								int line,
+								int charPositionInLine,
+								String msg,
+								RecognitionException e) {
+			printStream.println("line " + line + ":" + charPositionInLine + " " + msg);
+		}
+	}
+
 <if(parserName)>
 	static class TreeShapeListener implements ParseTreeListener {
 		@Override public void visitTerminal(TerminalNode node) { }

runtime-testsuite/resources/org/antlr/v4/test/runtime/templates/Java.test.stg

@@ -1,6 +1,6 @@
-writeln(s) ::= <<System.out.println(<s>);>>
-write(s) ::= <<System.out.print(<s>);>>
-writeList(s) ::= <<System.out.println(<s; separator="+">);>>
+writeln(s) ::= <<outStream.println(<s>);>>
+write(s) ::= <<outStream.print(<s>);>>
+writeList(s) ::= <<outStream.println(<s; separator="+">);>>
 
 False() ::= "false"
 
@@ -44,7 +44,7 @@ ModMemberEquals(n,m,v) ::= <%this.<n> % <m> == <v>%>
 
 ModMemberNotEquals(n,m,v) ::= <%this.<n> % <m> != <v>%>
 
-DumpDFA() ::= "this.dumpDFA();"
+DumpDFA() ::= "this.dumpDFA(outStream);"
 
 Pass() ::= ""
 
@@ -186,9 +186,9 @@ protected static class PositionAdjustingLexerATNSimulator extends LexerATNSimula
 
 BasicListener(X) ::= <<
 @parser::members {
-public static class LeafListener extends TBaseListener {
+public class LeafListener extends TBaseListener {
 	public void visitTerminal(TerminalNode node) {
-		System.out.println(node.getSymbol().getText());
+		outStream.println(node.getSymbol().getText());
 	}
 }
 }
@@ -214,27 +214,27 @@ public static class MyRuleNode extends ParserRuleContext {
 
 TokenGetterListener(X) ::= <<
 @parser::members {
-public static class LeafListener extends TBaseListener {
+public class LeafListener extends TBaseListener {
 	public void exitA(TParser.AContext ctx) {
 		if (ctx.getChildCount()==2)
-			System.out.printf("%s %s %s\n",ctx.INT(0).getSymbol().getText(),
+			outStream.printf("%s %s %s\n",ctx.INT(0).getSymbol().getText(),
 				ctx.INT(1).getSymbol().getText(),ctx.INT());
 		else
-			System.out.println(ctx.ID().getSymbol());
+			outStream.println(ctx.ID().getSymbol());
 	}
 }
 }
 >>
 
 RuleGetterListener(X) ::= <<
 @parser::members {
-public static class LeafListener extends TBaseListener {
+public class LeafListener extends TBaseListener {
 	public void exitA(TParser.AContext ctx) {
 		if (ctx.getChildCount()==2) {
-			System.out.printf("%s %s %s\n",ctx.b(0).start.getText(),
+			outStream.printf("%s %s %s\n",ctx.b(0).start.getText(),
 				ctx.b(1).start.getText(),ctx.b().get(0).start.getText());
 		} else
-			System.out.println(ctx.b(0).start.getText());
+			outStream.println(ctx.b(0).start.getText());
 	}
 }
 }
@@ -243,26 +243,26 @@ public static class LeafListener extends TBaseListener {
 
 LRListener(X) ::= <<
 @parser::members {
-public static class LeafListener extends TBaseListener {
+public class LeafListener extends TBaseListener {
 	public void exitE(TParser.EContext ctx) {
 		if (ctx.getChildCount()==3) {
-			System.out.printf("%s %s %s\n",ctx.e(0).start.getText(),
+			outStream.printf("%s %s %s\n",ctx.e(0).start.getText(),
 				ctx.e(1).start.getText(), ctx.e().get(0).start.getText());
 		} else
-			System.out.println(ctx.INT().getSymbol().getText());
+			outStream.println(ctx.INT().getSymbol().getText());
 	}
 }
 }
 >>
 
 LRWithLabelsListener(X) ::= <<
 @parser::members {
-public static class LeafListener extends TBaseListener {
+public class LeafListener extends TBaseListener {
 	public void exitCall(TParser.CallContext ctx) {
-		System.out.printf("%s %s\n",ctx.e().start.getText(),ctx.eList());
+		outStream.printf("%s %s\n",ctx.e().start.getText(),ctx.eList());
 	}
 	public void exitInt(TParser.IntContext ctx) {
-		System.out.println(ctx.INT().getSymbol().getText());
+		outStream.println(ctx.INT().getSymbol().getText());
 	}
 }
 }
@@ -277,13 +277,13 @@ void foo() {
 >>
 
 Declare_foo() ::= <<
-	public void foo() {System.out.println("foo");}
+	public void foo() {outStream.println("foo");}
 >>
 
 Invoke_foo() ::= "foo();"
 
 Declare_pred() ::= <<boolean pred(boolean v) {
-	System.out.println("eval="+v);
+	outStream.println("eval="+v);
 	return v;
 }
 >>

runtime-testsuite/test/org/antlr/v4/test/runtime/CustomDescriptors.java

@@ -9,7 +9,7 @@
 import java.util.*;
 
 public class CustomDescriptors {
-	public static HashMap<String, RuntimeTestDescriptor[]> descriptors;
+	public final static HashMap<String, RuntimeTestDescriptor[]> descriptors;
 
 	static {
 		descriptors = new HashMap<>();

runtime-testsuite/test/org/antlr/v4/test/runtime/FileUtils.java

@@ -9,6 +9,7 @@
 import org.antlr.v4.runtime.misc.Utils;
 
 import java.io.*;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.*;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.EnumSet;
@@ -60,6 +61,18 @@ public static boolean moveFile(File sourceFir, String destDir, String fileName)
 		return file.renameTo(newFile);
 	}
 
+	public static void replaceInFile(Path sourcePath, String target, String replacement) throws IOException {
+		replaceInFile(sourcePath, sourcePath, target, replacement);
+	}
+
+	public static void replaceInFile(Path sourcePath, Path destPath, String target, String replacement) throws IOException {
+		String content = new String(Files.readAllBytes(sourcePath), StandardCharsets.UTF_8);
+		String newContent = content.replace(target, replacement);
+		try (PrintWriter out = new PrintWriter(destPath.toString())) {
+			out.println(newContent);
+		}
+	}
+
 	public static void mkdir(String dir) {
 		File f = new File(dir);
 		f.mkdirs();

runtime-testsuite/test/org/antlr/v4/test/runtime/GeneratedFile.java

@@ -0,0 +1,16 @@
+package org.antlr.v4.test.runtime;
+
+public class GeneratedFile {
+	public final String name;
+	public final boolean isParser;
+
+	public GeneratedFile(String name, boolean isParser) {
+		this.name = name;
+		this.isParser = isParser;
+	}
+
+	@Override
+	public String toString() {
+		return name + "; isParser:" + isParser;
+	}
+}

runtime-testsuite/test/org/antlr/v4/test/runtime/Generator.java

@@ -19,9 +19,6 @@
 import static org.antlr.v4.test.runtime.FileUtils.writeFile;
 
 public class Generator {
-	/** ANTLR isn't thread-safe to process grammars so we use a global lock for testing */
-	public static final Object antlrLock = new Object();
-
 	/** Write a grammar to tmpdir and run antlr */
 	public static ErrorQueue antlrOnString(String workdir,
 										   String targetName,
@@ -69,9 +66,7 @@ public static ErrorQueue antlrOnString(String workdir,
 		if (defaultListener) {
 			antlr.addListener(new DefaultToolListener(antlr));
 		}
-		synchronized (antlrLock) {
-			antlr.processGrammarsOnCommandLine();
-		}
+		antlr.processGrammarsOnCommandLine();
 
 		List<String> errors = new ArrayList<>();
 

runtime-testsuite/test/org/antlr/v4/test/runtime/RunOptions.java

@@ -21,12 +21,13 @@ public class RunOptions {
 	public final boolean showDFA;
 	public final Stage endStage;
 	public final boolean returnObject;
+	public final String superClass;
 
 	public RunOptions(String grammarFileName, String grammarStr, String parserName, String lexerName,
 					  boolean useListener, boolean useVisitor, String startRuleName,
 					  String input, boolean profile, boolean showDiagnosticErrors,
 					  boolean showDFA, Stage endStage, boolean returnObject,
-					  String language) {
+					  String language, String superClass) {
 		this.grammarFileName = grammarFileName;
 		this.grammarStr = grammarStr;
 		this.parserName = parserName;
@@ -63,5 +64,6 @@ else if (lexerName != null) {
 		this.showDFA = showDFA;
 		this.endStage = endStage;
 		this.returnObject = returnObject;
+		this.superClass = superClass;
 	}
 }

runtime-testsuite/test/org/antlr/v4/test/runtime/RuntimeRunner.java

@@ -121,11 +121,17 @@ public static String getRuntimePath(String language) {
 	}
 
 	public State run(RunOptions runOptions) {
-		String[] options = runOptions.useVisitor ? new String[]{"-visitor"} : new String[0];
+		List<String> options = new ArrayList<>();
+		if (runOptions.useVisitor) {
+			options.add("-visitor");
+		}
+		if (runOptions.superClass != null && runOptions.superClass.length() > 0) {
+			options.add("-DsuperClass=" + runOptions.superClass);
+		}
 		ErrorQueue errorQueue = Generator.antlrOnString(getTempDirPath(), getLanguage(),
-				runOptions.grammarFileName, runOptions.grammarStr, false, options);
+				runOptions.grammarFileName, runOptions.grammarStr, false, options.toArray(new String[0]));
 
-		List<String> generatedFiles = getGeneratedFiles(runOptions);
+		List<GeneratedFile> generatedFiles = getGeneratedFiles(runOptions);
 		GeneratedState generatedState = new GeneratedState(errorQueue, generatedFiles, null);
 
 		if (generatedState.containsErrors() || runOptions.endStage == Stage.Generate) {
@@ -152,28 +158,28 @@ public State run(RunOptions runOptions) {
 		return executedState;
 	}
 
-	protected List<String> getGeneratedFiles(RunOptions runOptions) {
-		List<String> files = new ArrayList<>();
+	protected List<GeneratedFile> getGeneratedFiles(RunOptions runOptions) {
+		List<GeneratedFile> files = new ArrayList<>();
 		String extensionWithDot = "." + getExtension();
 		String fileGrammarName = grammarNameToFileName(runOptions.grammarName);
 		boolean isCombinedGrammarOrGo = runOptions.lexerName != null && runOptions.parserName != null || getLanguage().equals("Go");
 		if (runOptions.lexerName != null) {
-			files.add(fileGrammarName + (isCombinedGrammarOrGo ? getLexerSuffix() : "") + extensionWithDot);
+			files.add(new GeneratedFile(fileGrammarName + (isCombinedGrammarOrGo ? getLexerSuffix() : "") + extensionWithDot, false));
 		}
 		if (runOptions.parserName != null) {
-			files.add(fileGrammarName + (isCombinedGrammarOrGo ? getParserSuffix() : "") + extensionWithDot);
+			files.add(new GeneratedFile(fileGrammarName + (isCombinedGrammarOrGo ? getParserSuffix() : "") + extensionWithDot, true));
 			if (runOptions.useListener) {
-				files.add(fileGrammarName + getListenerSuffix() + extensionWithDot);
+				files.add(new GeneratedFile(fileGrammarName + getListenerSuffix() + extensionWithDot, true));
 				String baseListenerSuffix = getBaseListenerSuffix();
 				if (baseListenerSuffix != null) {
-					files.add(fileGrammarName + baseListenerSuffix + extensionWithDot);
+					files.add(new GeneratedFile(fileGrammarName + baseListenerSuffix + extensionWithDot, true));
 				}
 			}
 			if (runOptions.useVisitor) {
-				files.add(fileGrammarName + getVisitorSuffix() + extensionWithDot);
+				files.add(new GeneratedFile(fileGrammarName + getVisitorSuffix() + extensionWithDot, true));
 				String baseVisitorSuffix = getBaseVisitorSuffix();
 				if (baseVisitorSuffix != null) {
-					files.add(fileGrammarName + baseVisitorSuffix + extensionWithDot);
+					files.add(new GeneratedFile(fileGrammarName + baseVisitorSuffix + extensionWithDot, true));
 				}
 			}
 		}