parsing - 使用 ANTLR 捕获（并保留）所有评论

Question

我正在用 ANTLR 编写语法，将 Java 源文件解析为 AST 以供以后分析。与其他解析器（如 JavaDoc）不同，我试图保留所有注释。这是很难的注释，可以在代码中的任何地方使用。如果源代码中某处的注释与语法不匹配，则 ANTLR 无法完成对文件的解析。

有没有办法让 ANTLR 自动将它找到的任何评论添加到 AST 中？我知道词法分析器可以简单地使用其中一个{skip();}或通过将文本发送到隐藏通道来忽略所有评论。使用这些选项中的任何一个，ANTLR 都可以毫无问题地解析文件。

欢迎任何想法。

score 9 · Accepted Answer

“The Definitive Antlr 4 Reference”中的第 12.1 节展示了如何访问评论，而不必在整个语法中散布评论规则。简而言之，您将其添加到语法文件中：

grammar Java;

@lexer::members {
    public static final int WHITESPACE = 1;
    public static final int COMMENTS = 2;
}

然后为您的评论规则执行此操作：

COMMENT
    : '/*' .*? '*/' -> channel(COMMENTS)
    ;

LINE_COMMENT
    : '//' ~[\r\n]* -> channel(COMMENTS)
    ;

然后在您的代码中通过 getHiddenTokensToLeft/getHiddenTokensToRight 请求令牌并查看本书中的 12.1 部分，您将了解如何执行此操作。

score 8 · Accepted Answer

第一：将所有评论定向到某个频道（仅限评论）

COMMENT
    : '/*' .*? '*/' -> channel(2)
    ;

LINE_COMMENT
    : '//' ~[\r\n]* -> channel(2)
    ;

第二：打印所有评论

      CommonTokenStream tokens = new CommonTokenStream(lexer);
      tokens.fill();
      for (int index = 0; index < tokens.size(); index++)
      {
         Token token = tokens.get(index);
         // substitute whatever parser you have
         if (token.getType() != Parser.WS) 
         {
            String out = "";
            // Comments will be printed as channel 2 (configured in .g4 grammar file)
            out += "Channel: " + token.getChannel();
            out += " Type: " + token.getType();
            out += " Hidden: ";
            List<Token> hiddenTokensToLeft = tokens.getHiddenTokensToLeft(index);
            for (int i = 0; hiddenTokensToLeft != null && i < hiddenTokensToLeft.size(); i++)
            {
               if (hiddenTokensToLeft.get(i).getType() != IDLParser.WS)
               {
                  out += "\n\t" + i + ":";
                  out += "\n\tChannel: " + hiddenTokensToLeft.get(i).getChannel() + "  Type: " + hiddenTokensToLeft.get(i).getType();
                  out += hiddenTokensToLeft.get(i).getText().replaceAll("\\s", "");
               }
            }
            out += token.getText().replaceAll("\\s", "");
            System.out.println(out);
         }
      }

score 7 · Accepted Answer

有没有办法让 ANTLR 自动将它找到的任何评论添加到 AST 中？

不，您必须在整个语法中添加额外的comments规则，以说明可能出现注释的所有有效位置：

...

if_stat
 : 'if' comments '(' comments expr comments ')' comments ...
 ;

...

comments
 : (SingleLineComment | MultiLineComment)*
 ;

SingleLineComment
 : '//' ~('\r' | '\n')*
 ;

MultiLineComment
 : '/*' .* '*/'
 ;

score 1 · Accepted Answer

也可以使用“孤岛语法”功能。请参阅 ANTLR4 书中的以下部分：

Island Grammars：处理同一文件中的不同格式

score 0 · Accepted Answer

我在我的词法分析器部分做到了：

WS  :   ( [ \t\r\n] | COMMENT) -> skip
;

fragment
COMMENT
: '/*'.*'*/' /*single comment*/
| '//'~('\r' | '\n')* /* multiple comment*/
;

就像它会自动删除它们！

score 0 · Accepted Answer

对于 ANTLR v3：

空白标记通常不被解析器处理，但它们仍然在 HIDDEN 通道上捕获。

如果您使用BufferedTokenStream，您可以通过它获取所有令牌的列表并进行后处理，根据需要添加它们。

parsing - 使用 ANTLR 捕获（并保留）所有评论

6 回答 6

Related

Reference