如何使用 ANTLR4 漂亮地打印产品和行号？

Question

我正在尝试编写一段代码，它将采用 ANTLR4 解析器并使用它为类似于 grun (misc.TestRig) 上的 -tree 选项给出的输入生成 AST。但是，我还希望输出包含所有行号/偏移信息。

例如，代替打印

(add (int 5) '+' (int 6))

我想要

(add (int 5 [line 3, offset 6:7]) '+' (int 6 [line 3, offset 8:9]) [line 3, offset 5:10])

或类似的东西。

目前还没有大量针对 ANTLR4 的访问者示例，但我很确定我可以通过复制 toStringTree（由 grun 使用）的默认实现来完成大部分工作。但是，我没有看到有关行号或偏移量的任何信息。

我希望能写出这样超级简单的代码：

String visit(ParseTree t) {
    return "(" + t.productionName + t.visitChildren() + t.lineNumber + ")";
}

但似乎没有这么简单。我猜我应该能够从解析器中获取行号信息，但我还没有弄清楚如何去做。如何在遍历中获取此行号/偏移量信息？

---

为了填补以下解决方案中的几个空白，我使用了：

List<String> ruleNames = Arrays.asList(parser.getRuleNames());
parser.setBuildParseTree(true);
ParserRuleContext prc = parser.program();
ParseTree tree = prc;

获取tree 和ruleNames。 program 是我语法中最高产生式的名称。

Answer 1

Trees.toStringTree 方法可以使用ParseTreeListener 来实现。以下侦听器产生与Trees.toStringTree 完全相同的输出。

public class TreePrinterListener implements ParseTreeListener {
    private final List<String> ruleNames;
    private final StringBuilder builder = new StringBuilder();

    public TreePrinterListener(Parser parser) {
        this.ruleNames = Arrays.asList(parser.getRuleNames());
    }

    public TreePrinterListener(List<String> ruleNames) {
        this.ruleNames = ruleNames;
    }

    @Override
    public void visitTerminal(TerminalNode node) {
        if (builder.length() > 0) {
            builder.append(' ');
        }

        builder.append(Utils.escapeWhitespace(Trees.getNodeText(node, ruleNames), false));
    }

    @Override
    public void visitErrorNode(ErrorNode node) {
        if (builder.length() > 0) {
            builder.append(' ');
        }

        builder.append(Utils.escapeWhitespace(Trees.getNodeText(node, ruleNames), false));
    }

    @Override
    public void enterEveryRule(ParserRuleContext ctx) {
        if (builder.length() > 0) {
            builder.append(' ');
        }

        if (ctx.getChildCount() > 0) {
            builder.append('(');
        }

        int ruleIndex = ctx.getRuleIndex();
        String ruleName;
        if (ruleIndex >= 0 && ruleIndex < ruleNames.size()) {
            ruleName = ruleNames.get(ruleIndex);
        }
        else {
            ruleName = Integer.toString(ruleIndex);
        }

        builder.append(ruleName);
    }

    @Override
    public void exitEveryRule(ParserRuleContext ctx) {
        if (ctx.getChildCount() > 0) {
            builder.append(')');
        }
    }

    @Override
    public String toString() {
        return builder.toString();
    }
}

类可以如下使用：

List<String> ruleNames = ...;
ParseTree tree = ...;

TreePrinterListener listener = new TreePrinterListener(ruleNames);
ParseTreeWalker.DEFAULT.walk(listener, tree);
String formatted = listener.toString();

可以通过更新exitEveryRule 方法修改该类以在您的输出中生成信息：

@Override
public void exitEveryRule(ParserRuleContext ctx) {
    if (ctx.getChildCount() > 0) {
        Token positionToken = ctx.getStart();
        if (positionToken != null) {
            builder.append(" [line ");
            builder.append(positionToken.getLine());
            builder.append(", offset ");
            builder.append(positionToken.getStartIndex());
            builder.append(':');
            builder.append(positionToken.getStopIndex());
            builder.append("])");
        }
        else {
            builder.append(')');
        }
    }
}