如何使用 ANTLRv4 仅解析一些评论

Question

我使用 ANTLRv4 开发分析 Java 源代码的应用程序。我声称将所有单行 cmets 与第一个令牌 TODO（例如 // TODO <some-comment>）以及直接以下语句匹配。

示例代码：

class Simple {
    public static void main(String[] args) {
        // TODO develop cycle
        for (int i = 0; i < 5; i++) {
            // unmatched comment
            System.out.println("hello");
        }
        // TODO atomic
        int a;

        // TODO revision required
        {
            int b = a+4;
            System.out.println(b);
        }
    }
}

结果 = 地图像这样：

"develop cycle" -> for(...){...}
"atomic" -> int a
"revision required" -> {...}

关注 official book (1) 和 stackoverflow 上的类似主题（(2)、(3)、(4)、(5)、(6)）我尝试了几种方法。

起初我希望有 (1) 和 (2) 中描述的特殊 COMMENTS 频道，但出现错误 rule 'LINE_COMMENT' contains a lexer command with an unrecognized constant value; lexer interpreters may produce incorrect output。

我想以忽略所有单行 cmets 但以 TODO 开头的方式解析源代码会更好。我希望可以将 todo-cmets 直接添加到 AST 中以使用侦听器/步行器。比我只需要为 TODO 注释注册监听器/walker 并提取以下语句，将两者都添加到所需的 ma​​p。

我已经修改官方Java8 gammar 两天了，但没有任何成功。编译器抱怨或 AST 被错误混合。

这是我所做的更新：

// ...
COMMENT
    :   '/*' .*? '*/' -> skip
    ;

TODO_COMMENT
    :   '// TODO' ~[\r\n]*
    ;

LINE_COMMENT
    :   '//' ~[\r\n]* -> skip
    ;

谁能帮帮我？语法不是我的一杯茶。提前致谢

EDIT1：

上面贴的语法修改没有错误，但是生成了下面的树（请注意红色标记的节点包括int）

EDIT2：

假设上面的代码示例，在调用parser.compilationUnit();时会产生以下错误

line 3:2 extraneous input '// TODO develop cycle;' expecting {'abstract', 'assert', 'boolean', 'break', 'byte', 'char', 'class', 'continue', 'do', 'double', 'enum', 'final', 'float', 'for', 'if', 'int', 'interface', 'long', 'new', 'private', 'protected', 'public', 'return', 'short', 'static', 'strictfp', 'super', 'switch', 'synchronized', 'this', 'throw', 'try', 'void', 'while', IntegerLiteral, FloatingPointLiteral, BooleanLiteral, CharacterLiteral, StringLiteral, 'null', '(', '{', '}', ';', '<', '!', '~', '++', '--', '+', '-', Identifier, '@'}
line 8:2 extraneous input '// TODO atomic;' expecting {'abstract', 'assert', 'boolean', 'break', 'byte', 'char', 'class', 'continue', 'do', 'double', 'enum', 'final', 'float', 'for', 'if', 'int', 'interface', 'long', 'new', 'private', 'protected', 'public', 'return', 'short', 'static', 'strictfp', 'super', 'switch', 'synchronized', 'this', 'throw', 'try', 'void', 'while', IntegerLiteral, FloatingPointLiteral, BooleanLiteral, CharacterLiteral, StringLiteral, 'null', '(', '{', '}', ';', '<', '!', '~', '++', '--', '+', '-', Identifier, '@'}
line 11:2 extraneous input '// TODO revision required;' expecting {'abstract', 'assert', 'boolean', 'break', 'byte', 'char', 'class', 'continue', 'do', 'double', 'enum', 'final', 'float', 'for', 'if', 'int', 'interface', 'long', 'new', 'private', 'protected', 'public', 'return', 'short', 'static', 'strictfp', 'super', 'switch', 'synchronized', 'this', 'throw', 'try', 'void', 'while', IntegerLiteral, FloatingPointLiteral, BooleanLiteral, CharacterLiteral, StringLiteral, 'null', '(', '{', '}', ';', '<', '!', '~', '++', '--', '+', '-', Identifier, '@'}

显然语法是不正确的，因为它与简单的例子很矛盾

Answer 1

原因是您不希望在任何解析器规则中出现您的特殊注释，即没有解析器会匹配它。

您可以（至少）执行以下操作：

1. 添加一个可选的TODO_COMMENT?在每个解析器规则之前。
2. 将TODO_COMMENT 令牌添加到单独的频道，例如ToDoCommentChannel（不要忘记为该通道定义常量！）并在 tree-walking 中选择注释后面的每个构造。

我将要做什么的大致轮廓：

• 为TODO_COMMENTs 使用单独的频道。
• 像往常一样使用 lex 和解析
• 从令牌流中获取所有令牌并找到所需通道的令牌，并在默认通道上获取以下令牌并将它们存储在列表中。
• 如果起始标记在列表中，则遍历解析并检查每个输入的规则。如果是，则将规则文本复制到结果列表中，否则递归（如果 TODO_COMMENT 可以嵌套，甚至在起始标记在列表中时递归）。

更新：

关于rule 'LINE_COMMENT' contains a lexer command with an unrecognized constant value; lexer interpreters may produce incorrect output 错误：

这可以忽略，因为它只影响 Antlrworks2 或插件使用的解释器。你也可以这样做：

//Instead of
TODO_COMMENT
    :   '// TODO' ~[\r\n]*  -> channel(ToDoCommentChannel)
    ;    

// do this (assuming the channel value is indeed 42):
TODO_COMMENT
    :   '// TODO' ~[\r\n]*  -> channel(42 /*ToDoCommentChannel*/)
    ;    

这将在 Antlrworks2 和代码中都有效（您仍然可以在您的 java 运行时代码中为通道使用常量值）。