Example #1
0
 @Before
 public void setUp() throws Exception {
   lastTestFailed = false; // hope for the best, but set to true in asserts that fail
   // new output dir for each test
   tmpdir =
       new File(
               System.getProperty("java.io.tmpdir"),
               getClass().getSimpleName() + "-" + System.currentTimeMillis())
           .getAbsolutePath();
   //		tmpdir = "/tmp";
 }
Example #2
0
public abstract class BaseTest {
  public static final String newline = System.getProperty("line.separator");
  public static final String pathSep = System.getProperty("path.separator");

  /** Build up the full classpath we need, including the surefire path (if present) */
  public static final String CLASSPATH = System.getProperty("java.class.path");

  public String tmpdir = null;

  /** reset during setUp and set to true if we find a problem */
  protected boolean lastTestFailed = false;

  /**
   * If error during parser execution, store stderr here; can't return stdout and stderr. This
   * doesn't trap errors from running antlr.
   */
  protected String stderrDuringParse;

  @Before
  public void setUp() throws Exception {
    lastTestFailed = false; // hope for the best, but set to true in asserts that fail
    // new output dir for each test
    tmpdir =
        new File(
                System.getProperty("java.io.tmpdir"),
                getClass().getSimpleName() + "-" + System.currentTimeMillis())
            .getAbsolutePath();
    //		tmpdir = "/tmp";
  }

  @After
  public void tearDown() throws Exception {
    // remove tmpdir if no error.
    if (!lastTestFailed) eraseTempDir();
  }

  protected org.antlr.v4.Tool newTool(String[] args) {
    Tool tool = new Tool(args);
    return tool;
  }

  protected Tool newTool() {
    org.antlr.v4.Tool tool = new Tool(new String[] {"-o", tmpdir});
    return tool;
  }

  ATN createATN(Grammar g) {
    if (g.atn != null) return g.atn;
    semanticProcess(g);

    ParserATNFactory f = new ParserATNFactory(g);
    if (g.isLexer()) f = new LexerATNFactory((LexerGrammar) g);
    g.atn = f.createATN();

    return g.atn;
  }

  protected void semanticProcess(Grammar g) {
    if (g.ast != null && !g.ast.hasErrors) {
      System.out.println(g.ast.toStringTree());
      Tool antlr = new Tool();
      SemanticPipeline sem = new SemanticPipeline(g);
      sem.process();
      if (g.getImportedGrammars() != null) { // process imported grammars (if any)
        for (Grammar imp : g.getImportedGrammars()) {
          antlr.processNonCombinedGrammar(imp, false);
        }
      }
    }
  }

  public DFA createDFA(Grammar g, DecisionState s) {
    //		PredictionDFAFactory conv = new PredictionDFAFactory(g, s);
    //		DFA dfa = conv.createDFA();
    //		conv.issueAmbiguityWarnings();
    //		System.out.print("DFA="+dfa);
    //		return dfa;
    return null;
  }

  //	public void minimizeDFA(DFA dfa) {
  //		DFAMinimizer dmin = new DFAMinimizer(dfa);
  //		dfa.minimized = dmin.minimize();
  //	}

  List<Integer> getTypesFromString(Grammar g, String expecting) {
    List<Integer> expectingTokenTypes = new ArrayList<Integer>();
    if (expecting != null && !expecting.trim().equals("")) {
      for (String tname : expecting.replace(" ", "").split(",")) {
        int ttype = g.getTokenType(tname);
        expectingTokenTypes.add(ttype);
      }
    }
    return expectingTokenTypes;
  }

  public List<Integer> getTokenTypes(String input, LexerATNSimulator lexerATN) {
    ANTLRStringStream in = new ANTLRStringStream(input);
    List<Integer> tokenTypes = new ArrayList<Integer>();
    int ttype = 0;
    do {
      ttype = lexerATN.matchATN(in);
      tokenTypes.add(ttype);
    } while (ttype != Token.EOF);
    return tokenTypes;
  }

  public List<String> getTokenTypes(LexerGrammar lg, ATN atn, CharStream input, boolean adaptive) {
    LexerATNSimulator interp = new LexerATNSimulator(atn);
    List<String> tokenTypes = new ArrayList<String>();
    int ttype;
    do {
      if (adaptive) ttype = interp.match(input, Lexer.DEFAULT_MODE);
      else ttype = interp.matchATN(input);
      if (ttype == Token.EOF) tokenTypes.add("EOF");
      else {
        tokenTypes.add(lg.typeToTokenList.get(ttype));
      }
    } while (ttype != Token.EOF);
    return tokenTypes;
  }

  List<ANTLRMessage> checkRuleDFA(String gtext, String ruleName, String expecting)
      throws Exception {
    ErrorQueue equeue = new ErrorQueue();
    Grammar g = new Grammar(gtext, equeue);
    ATN atn = createATN(g);
    ATNState s = atn.ruleToStartState[g.getRule(ruleName).index];
    if (s == null) {
      System.err.println("no such rule: " + ruleName);
      return null;
    }
    ATNState t = s.transition(0).target;
    if (!(t instanceof DecisionState)) {
      System.out.println(ruleName + " has no decision");
      return null;
    }
    DecisionState blk = (DecisionState) t;
    checkRuleDFA(g, blk, expecting);
    return equeue.all;
  }

  List<ANTLRMessage> checkRuleDFA(String gtext, int decision, String expecting) throws Exception {
    ErrorQueue equeue = new ErrorQueue();
    Grammar g = new Grammar(gtext, equeue);
    ATN atn = createATN(g);
    DecisionState blk = atn.decisionToState.get(decision);
    checkRuleDFA(g, blk, expecting);
    return equeue.all;
  }

  void checkRuleDFA(Grammar g, DecisionState blk, String expecting) throws Exception {
    DFA dfa = createDFA(g, blk);
    String result = null;
    if (dfa != null) result = dfa.toString();
    assertEquals(expecting, result);
  }

  List<ANTLRMessage> checkLexerDFA(String gtext, String expecting) throws Exception {
    return checkLexerDFA(gtext, LexerGrammar.DEFAULT_MODE_NAME, expecting);
  }

  List<ANTLRMessage> checkLexerDFA(String gtext, String modeName, String expecting)
      throws Exception {
    ErrorQueue equeue = new ErrorQueue();
    LexerGrammar g = new LexerGrammar(gtext, equeue);
    g.atn = createATN(g);
    //		LexerATNToDFAConverter conv = new LexerATNToDFAConverter(g);
    //		DFA dfa = conv.createDFA(modeName);
    //		g.setLookaheadDFA(0, dfa); // only one decision to worry about
    //
    //		String result = null;
    //		if ( dfa!=null ) result = dfa.toString();
    //		assertEquals(expecting, result);
    //
    //		return equeue.all;
    return null;
  }

  /**
   * Wow! much faster than compiling outside of VM. Finicky though. Had rules called r and modulo.
   * Wouldn't compile til I changed to 'a'.
   */
  protected boolean compile(String fileName) {
    String classpathOption = "-classpath";

    String[] args =
        new String[] {
          "javac",
          "-d",
          tmpdir,
          classpathOption,
          tmpdir + pathSep + CLASSPATH,
          tmpdir + "/" + fileName
        };
    String cmdLine =
        "javac"
            + " -d "
            + tmpdir
            + " "
            + classpathOption
            + " "
            + tmpdir
            + pathSep
            + CLASSPATH
            + " "
            + fileName;
    // System.out.println("compile: "+cmdLine);

    File f = new File(tmpdir, fileName);
    JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
    //		DiagnosticCollector<JavaFileObject> diagnostics =
    //			new DiagnosticCollector<JavaFileObject>();

    StandardJavaFileManager fileManager = compiler.getStandardFileManager(null, null, null);

    Iterable<? extends JavaFileObject> compilationUnits =
        fileManager.getJavaFileObjectsFromFiles(Arrays.asList(f));

    Iterable<String> compileOptions =
        Arrays.asList(new String[] {"-d", tmpdir, "-cp", tmpdir + pathSep + CLASSPATH});

    JavaCompiler.CompilationTask task =
        compiler.getTask(null, fileManager, null, compileOptions, null, compilationUnits);
    boolean ok = task.call();

    try {
      fileManager.close();
    } catch (IOException ioe) {
      ioe.printStackTrace(System.err);
    }

    //		List<String> errors = new ArrayList<String>();
    //		for (Diagnostic diagnostic : diagnostics.getDiagnostics()) {
    //			errors.add(
    //				String.valueOf(diagnostic.getLineNumber())+
    //				": " + diagnostic.getMessage(null));
    //		}
    //		if ( errors.size()>0 ) {
    //			System.err.println("compile stderr from: "+cmdLine);
    //			System.err.println(errors);
    //			return false;
    //		}
    return ok;

    /*
    File outputDir = new File(tmpdir);
    try {
    	Process process =
    		Runtime.getRuntime().exec(args, null, outputDir);
    	StreamVacuum stdout = new StreamVacuum(process.getInputStream());
    	StreamVacuum stderr = new StreamVacuum(process.getErrorStream());
    	stdout.start();
    	stderr.start();
    	process.waitFor();
              stdout.join();
              stderr.join();
    	if ( stdout.toString().length()>0 ) {
    		System.err.println("compile stdout from: "+cmdLine);
    		System.err.println(stdout);
    	}
    	if ( stderr.toString().length()>0 ) {
    		System.err.println("compile stderr from: "+cmdLine);
    		System.err.println(stderr);
    	}
    	int ret = process.exitValue();
    	return ret==0;
    }
    catch (Exception e) {
    	System.err.println("can't exec compilation");
    	e.printStackTrace(System.err);
    	return false;
    }
    */
  }

  /** Return true if all is ok, no errors */
  protected boolean antlr(
      String fileName, String grammarFileName, String grammarStr, boolean debug) {
    boolean allIsWell = true;
    mkdir(tmpdir);
    writeFile(tmpdir, fileName, grammarStr);
    try {
      final List options = new ArrayList();
      if (debug) {
        options.add("-debug");
      }
      options.add("-o");
      options.add(tmpdir);
      options.add("-lib");
      options.add(tmpdir);
      options.add(new File(tmpdir, grammarFileName).toString());
      final String[] optionsA = new String[options.size()];
      options.toArray(optionsA);
      ErrorQueue equeue = new ErrorQueue();
      Tool antlr = newTool(optionsA);
      antlr.addListener(equeue);
      antlr.processGrammarsOnCommandLine();
      if (equeue.errors.size() > 0) {
        allIsWell = false;
        System.err.println("antlr reports errors from " + options);
        for (int i = 0; i < equeue.errors.size(); i++) {
          ANTLRMessage msg = (ANTLRMessage) equeue.errors.get(i);
          System.err.println(msg);
        }
        System.out.println("!!!\ngrammar:");
        System.out.println(grammarStr);
        System.out.println("###");
      }
    } catch (Exception e) {
      allIsWell = false;
      System.err.println("problems building grammar: " + e);
      e.printStackTrace(System.err);
    }
    return allIsWell;
  }

  protected String execLexer(
      String grammarFileName, String grammarStr, String lexerName, String input) {
    return execLexer(grammarFileName, grammarStr, lexerName, input, false);
  }

  protected String execLexer(
      String grammarFileName, String grammarStr, String lexerName, String input, boolean showDFA) {
    rawGenerateAndBuildRecognizer(grammarFileName, grammarStr, null, lexerName, false);
    writeFile(tmpdir, "input", input);
    writeLexerTestFile(lexerName, showDFA);
    compile("Test.java");
    String output = execClass("Test");
    if (stderrDuringParse != null && stderrDuringParse.length() > 0) {
      System.err.println(stderrDuringParse);
    }
    return output;
  }

  protected String execParser(
      String grammarFileName,
      String grammarStr,
      String parserName,
      String lexerName,
      String startRuleName,
      String input,
      boolean debug) {
    rawGenerateAndBuildRecognizer(grammarFileName, grammarStr, parserName, lexerName, debug);
    writeFile(tmpdir, "input", input);
    boolean parserBuildsTrees =
        grammarStr.indexOf("output=AST") >= 0 || grammarStr.indexOf("output = AST") >= 0;
    boolean parserBuildsTemplate =
        grammarStr.indexOf("output=template") >= 0 || grammarStr.indexOf("output = template") >= 0;
    return rawExecRecognizer(
        parserName,
        null,
        lexerName,
        startRuleName,
        null,
        parserBuildsTrees,
        parserBuildsTemplate,
        false,
        debug);
  }

  protected String execTreeParser(
      String parserGrammarFileName,
      String parserGrammarStr,
      String parserName,
      String treeParserGrammarFileName,
      String treeParserGrammarStr,
      String treeParserName,
      String lexerName,
      String parserStartRuleName,
      String treeParserStartRuleName,
      String input) {
    return execTreeParser(
        parserGrammarFileName,
        parserGrammarStr,
        parserName,
        treeParserGrammarFileName,
        treeParserGrammarStr,
        treeParserName,
        lexerName,
        parserStartRuleName,
        treeParserStartRuleName,
        input,
        false);
  }

  protected String execTreeParser(
      String parserGrammarFileName,
      String parserGrammarStr,
      String parserName,
      String treeParserGrammarFileName,
      String treeParserGrammarStr,
      String treeParserName,
      String lexerName,
      String parserStartRuleName,
      String treeParserStartRuleName,
      String input,
      boolean debug) {
    // build the parser
    rawGenerateAndBuildRecognizer(
        parserGrammarFileName, parserGrammarStr, parserName, lexerName, debug);

    // build the tree parser
    rawGenerateAndBuildRecognizer(
        treeParserGrammarFileName, treeParserGrammarStr, treeParserName, lexerName, debug);

    writeFile(tmpdir, "input", input);

    boolean parserBuildsTrees =
        parserGrammarStr.indexOf("output=AST") >= 0
            || parserGrammarStr.indexOf("output = AST") >= 0;
    boolean treeParserBuildsTrees =
        treeParserGrammarStr.indexOf("output=AST") >= 0
            || treeParserGrammarStr.indexOf("output = AST") >= 0;
    boolean parserBuildsTemplate =
        parserGrammarStr.indexOf("output=template") >= 0
            || parserGrammarStr.indexOf("output = template") >= 0;

    return rawExecRecognizer(
        parserName,
        treeParserName,
        lexerName,
        parserStartRuleName,
        treeParserStartRuleName,
        parserBuildsTrees,
        parserBuildsTemplate,
        treeParserBuildsTrees,
        debug);
  }

  /** Return true if all is well */
  protected boolean rawGenerateAndBuildRecognizer(
      String grammarFileName,
      String grammarStr,
      String parserName,
      String lexerName,
      boolean debug) {
    boolean allIsWell = antlr(grammarFileName, grammarFileName, grammarStr, debug);
    boolean ok;
    if (lexerName != null) {
      ok = compile(lexerName + ".java");
      if (!ok) {
        allIsWell = false;
      }
    }
    if (parserName != null) {
      ok = compile(parserName + ".java");
      if (!ok) {
        allIsWell = false;
      }
    }
    return allIsWell;
  }

  protected String rawExecRecognizer(
      String parserName,
      String treeParserName,
      String lexerName,
      String parserStartRuleName,
      String treeParserStartRuleName,
      boolean parserBuildsTrees,
      boolean parserBuildsTemplate,
      boolean treeParserBuildsTrees,
      boolean debug) {
    this.stderrDuringParse = null;
    if (treeParserBuildsTrees && parserBuildsTrees) {
      writeTreeAndTreeTestFile(
          parserName,
          treeParserName,
          lexerName,
          parserStartRuleName,
          treeParserStartRuleName,
          debug);
    } else if (parserBuildsTrees) {
      writeTreeTestFile(
          parserName,
          treeParserName,
          lexerName,
          parserStartRuleName,
          treeParserStartRuleName,
          debug);
    } else if (parserBuildsTemplate) {
      writeTemplateTestFile(parserName, lexerName, parserStartRuleName, debug);
    } else if (parserName == null) {
      writeLexerTestFile(lexerName, false);
    } else {
      writeTestFile(parserName, lexerName, parserStartRuleName, debug);
    }

    compile("Test.java");
    return execClass("Test");
  }

  public String execRecognizer() {
    try {
      String inputFile = new File(tmpdir, "input").getAbsolutePath();
      String[] args =
          new String[] {"java", "-classpath", tmpdir + pathSep + CLASSPATH, "Test", inputFile};
      // String cmdLine = "java -classpath "+CLASSPATH+pathSep+tmpdir+" Test " + new File(tmpdir,
      // "input").getAbsolutePath();
      // System.out.println("execParser: "+cmdLine);
      Process process = Runtime.getRuntime().exec(args, null, new File(tmpdir));
      StreamVacuum stdoutVacuum = new StreamVacuum(process.getInputStream());
      StreamVacuum stderrVacuum = new StreamVacuum(process.getErrorStream());
      stdoutVacuum.start();
      stderrVacuum.start();
      process.waitFor();
      stdoutVacuum.join();
      stderrVacuum.join();
      String output = null;
      output = stdoutVacuum.toString();
      if (stderrVacuum.toString().length() > 0) {
        this.stderrDuringParse = stderrVacuum.toString();
        System.err.println("exec stderrVacuum: " + stderrVacuum);
      }
      return output;
    } catch (Exception e) {
      System.err.println("can't exec recognizer");
      e.printStackTrace(System.err);
    }
    return null;
  }

  public String execClass(String className) {
    /* HOW TO GET STDOUT?
    try {
    	ClassLoader cl_new = new DirectoryLoader(new File(tmpdir));
    	Class compiledClass = cl_new.loadClass(className);
    	Method m = compiledClass.getMethod("main");
    	m.invoke(null);
    } catch (Exception ex) {
    	ex.printStackTrace(System.err);
    }
    */

    try {
      String[] args =
          new String[] {
            "java",
            "-classpath",
            tmpdir + pathSep + CLASSPATH,
            className,
            new File(tmpdir, "input").getAbsolutePath()
          };
      // String cmdLine = "java -classpath "+CLASSPATH+pathSep+tmpdir+" Test " + new File(tmpdir,
      // "input").getAbsolutePath();
      // System.out.println("execParser: "+cmdLine);
      Process process = Runtime.getRuntime().exec(args, null, new File(tmpdir));
      StreamVacuum stdoutVacuum = new StreamVacuum(process.getInputStream());
      StreamVacuum stderrVacuum = new StreamVacuum(process.getErrorStream());
      stdoutVacuum.start();
      stderrVacuum.start();
      process.waitFor();
      stdoutVacuum.join();
      stderrVacuum.join();
      String output = null;
      output = stdoutVacuum.toString();
      if (stderrVacuum.toString().length() > 0) {
        this.stderrDuringParse = stderrVacuum.toString();
        System.err.println("exec stderrVacuum: " + stderrVacuum);
      }
      return output;
    } catch (Exception e) {
      System.err.println("can't exec recognizer");
      e.printStackTrace(System.err);
    }
    return null;
  }

  public void testErrors(String[] pairs, boolean printTree) {
    for (int i = 0; i < pairs.length; i += 2) {
      String input = pairs[i];
      String expect = pairs[i + 1];
      ErrorQueue equeue = new ErrorQueue();
      Grammar g = null;
      try {
        String[] lines = input.split("\n");
        String fileName = getFilenameFromFirstLineOfGrammar(lines[0]);
        g = new Grammar(fileName, input, equeue);
      } catch (org.antlr.runtime.RecognitionException re) {
        re.printStackTrace(System.err);
      }
      String actual = equeue.toString(g.tool);
      System.err.println(actual);
      String msg = input;
      msg = msg.replaceAll("\n", "\\\\n");
      msg = msg.replaceAll("\r", "\\\\r");
      msg = msg.replaceAll("\t", "\\\\t");

      // ignore error number
      expect = stripErrorNum(expect);
      actual = stripErrorNum(actual);
      assertEquals("error in: " + msg, expect, actual);
    }
  }

  // can be multi-line
  // error(29): A.g:2:11: unknown attribute reference a in $a
  // error(29): A.g:2:11: unknown attribute reference a in $a
  String stripErrorNum(String errs) {
    String[] lines = errs.split("\n");
    for (int i = 0; i < lines.length; i++) {
      String s = lines[i];
      int lp = s.indexOf("error(");
      int rp = s.indexOf(')', lp);
      if (lp >= 0 && rp >= 0) {
        lines[i] = s.substring(0, lp) + s.substring(rp + 1, s.length());
      }
    }
    return Utils.join(lines, "\n");
  }

  public String getFilenameFromFirstLineOfGrammar(String line) {
    String fileName = "<string>";
    int grIndex = line.lastIndexOf("grammar");
    int semi = line.lastIndexOf(';');
    if (grIndex >= 0 && semi >= 0) {
      int space = line.indexOf(' ', grIndex);
      fileName = line.substring(space + 1, semi) + ".g";
    }
    if (fileName.length() == ".g".length()) fileName = "<string>";
    return fileName;
  }

  //	void ambig(List<Message> msgs, int[] expectedAmbigAlts, String expectedAmbigInput)
  //		throws Exception
  //	{
  //		ambig(msgs, 0, expectedAmbigAlts, expectedAmbigInput);
  //	}

  //	void ambig(List<Message> msgs, int i, int[] expectedAmbigAlts, String expectedAmbigInput)
  //		throws Exception
  //	{
  //		List<Message> amsgs = getMessagesOfType(msgs, AmbiguityMessage.class);
  //		AmbiguityMessage a = (AmbiguityMessage)amsgs.get(i);
  //		if ( a==null ) assertNull(expectedAmbigAlts);
  //		else {
  //			assertEquals(a.conflictingAlts.toString(), Arrays.toString(expectedAmbigAlts));
  //		}
  //		assertEquals(expectedAmbigInput, a.input);
  //	}

  //	void unreachable(List<Message> msgs, int[] expectedUnreachableAlts)
  //		throws Exception
  //	{
  //		unreachable(msgs, 0, expectedUnreachableAlts);
  //	}

  //	void unreachable(List<Message> msgs, int i, int[] expectedUnreachableAlts)
  //		throws Exception
  //	{
  //		List<Message> amsgs = getMessagesOfType(msgs, UnreachableAltsMessage.class);
  //		UnreachableAltsMessage u = (UnreachableAltsMessage)amsgs.get(i);
  //		if ( u==null ) assertNull(expectedUnreachableAlts);
  //		else {
  //			assertEquals(u.conflictingAlts.toString(), Arrays.toString(expectedUnreachableAlts));
  //		}
  //	}

  List<ANTLRMessage> getMessagesOfType(List<ANTLRMessage> msgs, Class c) {
    List<ANTLRMessage> filtered = new ArrayList<ANTLRMessage>();
    for (ANTLRMessage m : msgs) {
      if (m.getClass() == c) filtered.add(m);
    }
    return filtered;
  }

  public static class StreamVacuum implements Runnable {
    StringBuffer buf = new StringBuffer();
    BufferedReader in;
    Thread sucker;

    public StreamVacuum(InputStream in) {
      this.in = new BufferedReader(new InputStreamReader(in));
    }

    public void start() {
      sucker = new Thread(this);
      sucker.start();
    }

    public void run() {
      try {
        String line = in.readLine();
        while (line != null) {
          buf.append(line);
          buf.append('\n');
          line = in.readLine();
        }
      } catch (IOException ioe) {
        System.err.println("can't read output from process");
      }
    }
    /** wait for the thread to finish */
    public void join() throws InterruptedException {
      sucker.join();
    }

    public String toString() {
      return buf.toString();
    }
  }

  protected void checkGrammarSemanticsError(
      ErrorQueue equeue, GrammarSemanticsMessage expectedMessage) throws Exception {
    ANTLRMessage foundMsg = null;
    for (int i = 0; i < equeue.errors.size(); i++) {
      ANTLRMessage m = (ANTLRMessage) equeue.errors.get(i);
      if (m.errorType == expectedMessage.errorType) {
        foundMsg = m;
      }
    }
    assertNotNull("no error; " + expectedMessage.errorType + " expected", foundMsg);
    assertTrue(
        "error is not a GrammarSemanticsMessage", foundMsg instanceof GrammarSemanticsMessage);
    assertEquals(Arrays.toString(expectedMessage.args), Arrays.toString(foundMsg.args));
    if (equeue.size() != 1) {
      System.err.println(equeue);
    }
  }

  protected void checkGrammarSemanticsWarning(
      ErrorQueue equeue, GrammarSemanticsMessage expectedMessage) throws Exception {
    ANTLRMessage foundMsg = null;
    for (int i = 0; i < equeue.warnings.size(); i++) {
      ANTLRMessage m = equeue.warnings.get(i);
      if (m.errorType == expectedMessage.errorType) {
        foundMsg = m;
      }
    }
    assertNotNull("no error; " + expectedMessage.errorType + " expected", foundMsg);
    assertTrue(
        "error is not a GrammarSemanticsMessage", foundMsg instanceof GrammarSemanticsMessage);
    assertEquals(Arrays.toString(expectedMessage.args), Arrays.toString(foundMsg.args));
    if (equeue.size() != 1) {
      System.err.println(equeue);
    }
  }

  protected void checkError(ErrorQueue equeue, ANTLRMessage expectedMessage) throws Exception {
    // System.out.println("errors="+equeue);
    ANTLRMessage foundMsg = null;
    for (int i = 0; i < equeue.errors.size(); i++) {
      ANTLRMessage m = (ANTLRMessage) equeue.errors.get(i);
      if (m.errorType == expectedMessage.errorType) {
        foundMsg = m;
      }
    }
    assertTrue("no error; " + expectedMessage.errorType + " expected", equeue.errors.size() > 0);
    assertTrue("too many errors; " + equeue.errors, equeue.errors.size() <= 1);
    assertNotNull("couldn't find expected error: " + expectedMessage.errorType, foundMsg);
    /*
    assertTrue("error is not a GrammarSemanticsMessage",
    		   foundMsg instanceof GrammarSemanticsMessage);
     */
    assertTrue(Arrays.equals(expectedMessage.args, foundMsg.args));
  }

  public static class FilteringTokenStream extends CommonTokenStream {
    public FilteringTokenStream(TokenSource src) {
      super(src);
    }

    Set<Integer> hide = new HashSet<Integer>();

    protected void sync(int i) {
      super.sync(i);
      if (hide.contains(get(i).getType())) get(i).setChannel(Token.HIDDEN_CHANNEL);
    }

    public void setTokenTypeChannel(int ttype, int channel) {
      hide.add(ttype);
    }
  }

  public static void writeFile(String dir, String fileName, String content) {
    try {
      File f = new File(dir, fileName);
      FileWriter w = new FileWriter(f);
      BufferedWriter bw = new BufferedWriter(w);
      bw.write(content);
      bw.close();
      w.close();
    } catch (IOException ioe) {
      System.err.println("can't write file");
      ioe.printStackTrace(System.err);
    }
  }

  protected void mkdir(String dir) {
    File f = new File(dir);
    f.mkdirs();
  }

  protected void writeTestFile(
      String parserName, String lexerName, String parserStartRuleName, boolean debug) {
    ST outputFileST =
        new ST(
            "import org.antlr.v4.runtime.*;\n"
                + "import org.antlr.v4.runtime.tree.*;\n"
                +
                // "import org.antlr.v4.runtime.debug.*;\n" +
                "\n"
                + "public class Test {\n"
                + "    public static void main(String[] args) throws Exception {\n"
                + "        CharStream input = new ANTLRFileStream(args[0]);\n"
                + "        <lexerName> lex = new <lexerName>(input);\n"
                + "        CommonTokenStream tokens = new CommonTokenStream(lex);\n"
                + "        <createParser>\n"
                + "        parser.<parserStartRuleName>();\n"
                + "    }\n"
                + "}");
    ST createParserST =
        new ST(
            "class Profiler2 extends Profiler {\n"
                + "    public void terminate() { ; }\n"
                + "}\n"
                + "        Profiler2 profiler = new Profiler2();\n"
                + "        <parserName> parser = new <parserName>(tokens,profiler);\n"
                + "        profiler.setParser(parser);\n");
    if (!debug) {
      createParserST = new ST("        <parserName> parser = new <parserName>(tokens);\n");
    }
    outputFileST.add("createParser", createParserST);
    outputFileST.add("parserName", parserName);
    outputFileST.add("lexerName", lexerName);
    outputFileST.add("parserStartRuleName", parserStartRuleName);
    writeFile(tmpdir, "Test.java", outputFileST.render());
  }

  protected void writeLexerTestFile(String lexerName, boolean showDFA) {
    ST outputFileST =
        new ST(
            "import org.antlr.v4.runtime.*;\n"
                + "\n"
                + "public class Test {\n"
                + "    public static void main(String[] args) throws Exception {\n"
                + "        CharStream input = new ANTLRFileStream(args[0]);\n"
                + "        <lexerName> lex = new <lexerName>(input);\n"
                + "        CommonTokenStream tokens = new CommonTokenStream(lex);\n"
                + "        tokens.fill();\n"
                + "        for (Object t : tokens.getTokens()) System.out.println(t);\n"
                + (showDFA
                    ? "System.out.print(lex.getInterpreter().getDFA(Lexer.DEFAULT_MODE).toLexerString());\n"
                    : "")
                + "    }\n"
                + "}");

    outputFileST.add("lexerName", lexerName);
    writeFile(tmpdir, "Test.java", outputFileST.render());
  }

  protected void writeTreeTestFile(
      String parserName,
      String treeParserName,
      String lexerName,
      String parserStartRuleName,
      String treeParserStartRuleName,
      boolean debug) {
    ST outputFileST =
        new ST(
            "import org.antlr.v4.runtime.*;\n"
                + "import org.antlr.v4.runtime.tree.*;\n"
                +
                //			"import org.antlr.v4.runtime.debug.*;\n" +
                "\n"
                + "public class Test {\n"
                + "    public static void main(String[] args) throws Exception {\n"
                + "        CharStream input = new ANTLRFileStream(args[0]);\n"
                + "        <lexerName> lex = new <lexerName>(input);\n"
                + "        TokenRewriteStream tokens = new TokenRewriteStream(lex);\n"
                + "        <createParser>\n"
                + "        ParserRuleContext r = parser.<parserStartRuleName>();\n"
                + "        <if(!treeParserStartRuleName)>\n"
                + "        if ( r.tree!=null ) {\n"
                + "            System.out.println(((Tree)r.tree).toStringTree());\n"
                + "            ((CommonTree)r.tree).sanityCheckParentAndChildIndexes();\n"
                + "		 }\n"
                + "        <else>\n"
                + "        CommonTreeNodeStream nodes = new CommonTreeNodeStream((Tree)r.tree);\n"
                + "        nodes.setTokenStream(tokens);\n"
                + "        <treeParserName> walker = new <treeParserName>(nodes);\n"
                + "        walker.<treeParserStartRuleName>();\n"
                + "        <endif>\n"
                + "    }\n"
                + "}");
    ST createParserST =
        new ST(
            "class Profiler2 extends Profiler {\n"
                + "    public void terminate() { ; }\n"
                + "}\n"
                + "        Profiler2 profiler = new Profiler2();\n"
                + "        <parserName> parser = new <parserName>(tokens,profiler);\n"
                + "        profiler.setParser(parser);\n");
    if (!debug) {
      createParserST = new ST("        <parserName> parser = new <parserName>(tokens);\n");
    }
    outputFileST.add("createParser", createParserST);
    outputFileST.add("parserName", parserName);
    outputFileST.add("treeParserName", treeParserName);
    outputFileST.add("lexerName", lexerName);
    outputFileST.add("parserStartRuleName", parserStartRuleName);
    outputFileST.add("treeParserStartRuleName", treeParserStartRuleName);
    writeFile(tmpdir, "Test.java", outputFileST.render());
  }

  /** Parser creates trees and so does the tree parser */
  protected void writeTreeAndTreeTestFile(
      String parserName,
      String treeParserName,
      String lexerName,
      String parserStartRuleName,
      String treeParserStartRuleName,
      boolean debug) {
    ST outputFileST =
        new ST(
            "import org.antlr.v4.runtime.*;\n"
                + "import org.antlr.v4.runtime.tree.*;\n"
                +
                //			"import org.antlr.v4.runtime.debug.*;\n" +
                "\n"
                + "public class Test {\n"
                + "    public static void main(String[] args) throws Exception {\n"
                + "        CharStream input = new ANTLRFileStream(args[0]);\n"
                + "        <lexerName> lex = new <lexerName>(input);\n"
                + "        TokenRewriteStream tokens = new TokenRewriteStream(lex);\n"
                + "        <createParser>\n"
                + "        ParserRuleContext r = parser.<parserStartRuleName>();\n"
                + "        ((CommonTree)r.tree).sanityCheckParentAndChildIndexes();\n"
                + "        CommonTreeNodeStream nodes = new CommonTreeNodeStream((Tree)r.tree);\n"
                + "        nodes.setTokenStream(tokens);\n"
                + "        <treeParserName> walker = new <treeParserName>(nodes);\n"
                + "        ParserRuleContext r2 = walker.<treeParserStartRuleName>();\n"
                + "		 CommonTree rt = ((CommonTree)r2.tree);\n"
                + "		 if ( rt!=null ) System.out.println(((CommonTree)r2.tree).toStringTree());\n"
                + "    }\n"
                + "}");
    ST createParserST =
        new ST(
            "class Profiler2 extends Profiler {\n"
                + "    public void terminate() { ; }\n"
                + "}\n"
                + "        Profiler2 profiler = new Profiler2();\n"
                + "        <parserName> parser = new <parserName>(tokens,profiler);\n"
                + "        profiler.setParser(parser);\n");
    if (!debug) {
      createParserST = new ST("        <parserName> parser = new <parserName>(tokens);\n");
    }
    outputFileST.add("createParser", createParserST);
    outputFileST.add("parserName", parserName);
    outputFileST.add("treeParserName", treeParserName);
    outputFileST.add("lexerName", lexerName);
    outputFileST.add("parserStartRuleName", parserStartRuleName);
    outputFileST.add("treeParserStartRuleName", treeParserStartRuleName);
    writeFile(tmpdir, "Test.java", outputFileST.render());
  }

  protected void writeTemplateTestFile(
      String parserName, String lexerName, String parserStartRuleName, boolean debug) {
    ST outputFileST =
        new ST(
            "import org.antlr.v4.runtime.*;\n"
                + "import org.antlr.v4.stringtemplate.*;\n"
                + "import org.antlr.v4.stringtemplate.language.*;\n"
                +
                //			"import org.antlr.v4.runtime.debug.*;\n" +
                "import java.io.*;\n"
                + "\n"
                + "public class Test {\n"
                + "    static String templates =\n"
                + "    		\"group test;\"+"
                + "    		\"foo(x,y) ::= \\\"<x> <y>\\\"\";\n"
                + "    static STGroup group ="
                + "    		new STGroup(new StringReader(templates),"
                + "					AngleBracketTemplateLexer.class);"
                + "    public static void main(String[] args) throws Exception {\n"
                + "        CharStream input = new ANTLRFileStream(args[0]);\n"
                + "        <lexerName> lex = new <lexerName>(input);\n"
                + "        CommonTokenStream tokens = new CommonTokenStream(lex);\n"
                + "        <createParser>\n"
                + "		 parser.setTemplateLib(group);\n"
                + "        ParserRuleContext r = parser.<parserStartRuleName>();\n"
                + "        if ( r.st!=null )\n"
                + "            System.out.print(r.st.toString());\n"
                + "	 	 else\n"
                + "            System.out.print(\"\");\n"
                + "    }\n"
                + "}");
    ST createParserST =
        new ST(
            "class Profiler2 extends Profiler {\n"
                + "    public void terminate() { ; }\n"
                + "}\n"
                + "        Profiler2 profiler = new Profiler2();\n"
                + "        <parserName> parser = new <parserName>(tokens,profiler);\n"
                + "        profiler.setParser(parser);\n");
    if (!debug) {
      createParserST = new ST("        <parserName> parser = new <parserName>(tokens);\n");
    }
    outputFileST.add("createParser", createParserST);
    outputFileST.add("parserName", parserName);
    outputFileST.add("lexerName", lexerName);
    outputFileST.add("parserStartRuleName", parserStartRuleName);
    writeFile(tmpdir, "Test.java", outputFileST.render());
  }

  public void writeRecognizerAndCompile(
      String parserName,
      String treeParserName,
      String lexerName,
      String parserStartRuleName,
      String treeParserStartRuleName,
      boolean parserBuildsTrees,
      boolean parserBuildsTemplate,
      boolean treeParserBuildsTrees,
      boolean debug) {
    if (treeParserBuildsTrees && parserBuildsTrees) {
      writeTreeAndTreeTestFile(
          parserName,
          treeParserName,
          lexerName,
          parserStartRuleName,
          treeParserStartRuleName,
          debug);
    } else if (parserBuildsTrees) {
      writeTreeTestFile(
          parserName,
          treeParserName,
          lexerName,
          parserStartRuleName,
          treeParserStartRuleName,
          debug);
    } else if (parserBuildsTemplate) {
      writeTemplateTestFile(parserName, lexerName, parserStartRuleName, debug);
    } else if (parserName == null) {
      writeLexerTestFile(lexerName, debug);
    } else {
      writeTestFile(parserName, lexerName, parserStartRuleName, debug);
    }

    compile("Test.java");
  }

  protected void eraseFiles(final String filesEndingWith) {
    File tmpdirF = new File(tmpdir);
    String[] files = tmpdirF.list();
    for (int i = 0; files != null && i < files.length; i++) {
      if (files[i].endsWith(filesEndingWith)) {
        new File(tmpdir + "/" + files[i]).delete();
      }
    }
  }

  protected void eraseFiles() {
    File tmpdirF = new File(tmpdir);
    String[] files = tmpdirF.list();
    for (int i = 0; files != null && i < files.length; i++) {
      new File(tmpdir + "/" + files[i]).delete();
    }
  }

  protected void eraseTempDir() {
    File tmpdirF = new File(tmpdir);
    if (tmpdirF.exists()) {
      eraseFiles();
      tmpdirF.delete();
    }
  }

  public String getFirstLineOfException() {
    if (this.stderrDuringParse == null) {
      return null;
    }
    String[] lines = this.stderrDuringParse.split("\n");
    String prefix = "Exception in thread \"main\" ";
    return lines[0].substring(prefix.length(), lines[0].length());
  }

  /**
   * When looking at a result set that consists of a Map/HashTable we cannot rely on the output
   * order, as the hashing algorithm or other aspects of the implementation may be different on
   * differnt JDKs or platforms. Hence we take the Map, convert the keys to a List, sort them and
   * Stringify the Map, which is a bit of a hack, but guarantees that we get the same order on all
   * systems. We assume that the keys are strings.
   *
   * @param m The Map that contains keys we wish to return in sorted order
   * @return A string that represents all the keys in sorted order.
   */
  public String sortMapToString(Map m) {

    System.out.println("Map toString looks like: " + m.toString());
    // Pass in crap, and get nothing back
    //
    if (m == null) {
      return null;
    }

    // Sort the keys in the Map
    //
    TreeMap nset = new TreeMap(m);

    System.out.println("Tree map looks like: " + nset.toString());
    return nset.toString();
  }

  public List<String> realElements(Vector elements) {
    return elements.subList(Token.MIN_USER_TOKEN_TYPE, elements.size());
  }

  // override to track errors

  public void assertEquals(String msg, Object a, Object b) {
    try {
      Assert.assertEquals(msg, a, b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertEquals(Object a, Object b) {
    try {
      Assert.assertEquals(a, b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertEquals(String msg, long a, long b) {
    try {
      Assert.assertEquals(msg, a, b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertEquals(long a, long b) {
    try {
      Assert.assertEquals(a, b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertTrue(String msg, boolean b) {
    try {
      Assert.assertTrue(msg, b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertTrue(boolean b) {
    try {
      Assert.assertTrue(b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertFalse(String msg, boolean b) {
    try {
      Assert.assertFalse(msg, b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertFalse(boolean b) {
    try {
      Assert.assertFalse(b);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertNotNull(String msg, Object p) {
    try {
      Assert.assertNotNull(msg, p);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertNotNull(Object p) {
    try {
      Assert.assertNotNull(p);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertNull(String msg, Object p) {
    try {
      Assert.assertNull(msg, p);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public void assertNull(Object p) {
    try {
      Assert.assertNull(p);
    } catch (Error e) {
      lastTestFailed = true;
      throw e;
    }
  }

  public static class IntTokenStream implements TokenStream {
    List<Integer> types;
    int p = 0;

    public IntTokenStream(List<Integer> types) {
      this.types = types;
    }

    public void consume() {
      p++;
    }

    public int LA(int i) {
      return LT(i).getType();
    }

    public int mark() {
      return index();
    }

    public int index() {
      return p;
    }

    public void rewind(int marker) {
      seek(marker);
    }

    public void rewind() {}

    public void release(int marker) {
      seek(marker);
    }

    public void seek(int index) {
      p = index;
    }

    public int size() {
      return types.size();
    }

    public String getSourceName() {
      return null;
    }

    public Token LT(int i) {
      if ((p + i - 1) >= types.size()) return new CommonToken(-1);
      return new CommonToken(types.get(p + i - 1));
    }

    public int range() {
      return 0;
    }

    public Token get(int i) {
      return new org.antlr.v4.runtime.CommonToken(types.get(i));
    }

    public TokenSource getTokenSource() {
      return null;
    }

    public String toString(int start, int stop) {
      return null;
    }

    public String toString(Token start, Token stop) {
      return null;
    }
  }
}