java - 使用 ANTLR4 计算 token

Question

我需要使用 ANTLR4 编写一个 Java 程序，给定一个具有单一方法的源文件，它可以计算变量、运算符、标点符号和保留字的数量。

我如何使用 ANTLR4 根据 token 的类型对 token 进行计数？

Answer 1

在做了一些研究之后，基于 Özhan Düz，我意识到我需要的东西需要两种技术:

• 可以使用 ANTLR4 词法分析器 计算运算符、保留字和标点符号，因为这些可以在源代码中识别，而无需将它们放入上下文中。
• 可以使用 ANTLR4 解析器 对变量(以及常量、方法、类...)进行计数，因为识别它们需要解析和理解这些标识符出现的上下文。

为了所有将来需要做类似事情的人，我是这样做的:

1) 使用 ANTLR 命令行工具为您的语言生成 Lexer、Parser 和 BaseListener。可以在 ANTLR 官方网站上找到有关如何操作的说明。在这个例子中，我创建了这些用于分析 Java 语言的类。

2) 创建一个新的 Java 项目。将 JavaLexer.java、JavaListener.java、JavaParser.java 和 JavaBaseListener.java 添加到您的项目中，然后将 ANTLR 库添加到项目的构建路径。

3) 创建一个扩展JavaBaseListener 基类的新类。查看 JavaBaseListener.java 文件，了解您可以覆盖的所有方法。扫描源代码的 AST 时，将在相应事件发生时调用每个方法(例如 - enterMethodDeclaration() 将在每次解析器到达新方法声明时调用)。

例如，这个监听器会在每次发现新方法时将计数器加 1:

public static final AtomicInteger count = new AtomicInteger();

/**
 * Implementation of the abstract base listener
 */
public static class MyListener extends JavaBaseListener {
    /**
     * Overrides the default callback called whenever the walker has entered a method declaration.
     * This raises the count every time a new method is found
     */
    @Override
    public void enterMethodDeclaration(JavaParser.MethodDeclarationContext ctx) {
        count.incrementAndGet();
    }
}

4) 创建一个Lexer、一个Parser、一个ParseTree 和一个ParseTreeWalker:

• Lexer - 从头到尾遍历您的代码，并将其拆分为“标记”——标识符、文字、运算符等。每个标记都有一个名称和一个类型。类型列表可以在词法分析器文件的开头找到(在我们的例子中，JavaLexer.java)
• 解析器 - 使用词法分析器的输出来构建代表您的代码的 AST(抽象语法树)。除了对您的源代码进行标记之外，这还允许了解每个标记出现在哪个上下文中。
• ParseTree - 整个代码的 AST 或其子树
• ParseTreeWalker - 允许“遍历”树的对象，这基本上意味着分层扫描代码而不是从头到尾

最后，实例化您的监听器并遍历 ParseTree。

例如:

public static void main(String... args) throws IOException {
    JavaLexer lexer = new JavaLexer(new ANTLRFileStream(sourceFile, "UTF-8"));
    JavaParser parser = new JavaParser(new CommonTokenStream(lexer));
    ParseTree tree = parser.compilationUnit();

    ParseTreeWalker walker = new ParseTreeWalker();
    MyListener listener = new MyListener();
    walker.walk(listener, tree);
}

这是基础。接下来的步骤取决于您想要实现的目标，这让我回到使用Lexer 和Parser 之间的区别:

对于您的代码的基本词法分析，例如识别运算符和保留字，请使用词法分析器迭代您的标记并通过检查 Token.type 字段来确定它们的类型。使用此代码计算方法内保留字的数量:

private List<Token> tokenizeMethod(String method) {
    JavaLexer lex = new JavaLexer(new ANTLRInputStream(method));
    CommonTokenStream tokStream = new CommonTokenStream(lex);
    tokStream.fill();

    return tokStream.getTokens();
}


/**
 * Returns the number of reserved words inside the given method, using lexical analysis
 * @param method The method text
 */
private int countReservedWords(String method) {
    int count = 0;

    for(Token t : tokenizeMethod(method)) {
        if(t.getType() <= JavaLexer.WHILE) {
            count++;
        }
    }

    return count;
}

对于需要解析 AST 的任务，例如识别变量、方法、注释等，请使用解析器。使用此代码计算方法内变量声明的数量:

/**
 * Returns the number of variable declarations inside the given method, by parsing the method's AST
 * @param method The method text
 */
private int countVariableDeclarations(String method) {
    JavaLexer lex = new JavaLexer(new ANTLRInputStream(method));
    JavaParser parse = new JavaParser(new CommonTokenStream(lex));
    ParseTree tree = parse.methodDeclaration();

    ParseTreeWalker walker = new ParseTreeWalker();
    final AtomicInteger count = new AtomicInteger();
    walker.walk(new JavaBaseListener() {
        @Override public void enterLocalVariableDeclaration(JavaParser.LocalVariableDeclarationContext ctx) {
            count.incrementAndGet();
        }
    }, tree);

    return count.get();
}