如何使用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

可以使用ParseTreeListener实现Trees.toStringTree方法。以下侦听器生成与 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(')');
        }
    }
}