Antlr4 入门

Antlr是什么

ANTLR (ANother Tool for Language Recognition ) 是一种语言工具，它提供了一个框架，可以根据语法文件（语法描述语言编写的文件）生成该语法所对应的语言识别器、编译器和解释器。 例如，给定一个识别JSON的语法，ANTLR将会根据该语法生成一个程序，此程序可以通过ANTLR来识别输入的json字符串。

环境搭建

这里使用Antlr4（version 4.7.2）

下载

从ANTLR官网下载 ANTLR工具-4.7.2

配置

假设将上面下载的jar放到路径/usr/local/lib下（当然随便你放到哪，只是举例）
在系统中加入调用ANTLR命令（可以不配，不过配了会更方便使用）：

• 编辑文件vi ~/.bash_profile
• 输入并保存

export ANTLR4_HOME=/usr/local/lib/antlr-4.7.2-complete.jar
export CLASSPATH=$CLASSPATH:$ANTLR4_HOME
# 设置启动antlr4的别名
alias antlr4='java -jar /usr/local/lib/antlr-4.7.2-complete.jar'
alias grun='java org.antlr.v4.gui.TestRig'

• 执行命令source ~/.antlr_profile

Example

这个例子是将例如"hello abc"的字符串解析为抽象语法树。
假设工作目录是 /tmp/test，在目录下新建语法文件Hello.g4：

// Define a grammar called Hello
grammar Hello;
r  : 'hello' ID ;         // match keyword hello followed by an identifier
ID : [a-z]+ ;             // match lower-case identifiers
WS : [ \t\r\n]+ -> skip ; // skip spaces, tabs, newlines

接着运行ANTLR，根据语法文件Hello.g4生成对应的词法分析和语法分析程序：

$ cd /tmp/test
$ antlr4 Hello.g4

这时候文件夹下会多出几个文件（只选择典型的2个文件说明）

HelloLexer.java 词法分析
HelloParser.java 语法分析

然后利用javac对Java文件进行编译：

$ javac Hello*.java

测试

首先是词法分析测试。启动grun，测试之前的语法：

$ grun Hello r -tokens
hello parrt      # 输入要被识别的语句
EOF              # 在UNIX系统上输入 Ctrl+D 来输入文件结束符

下面就会显示词法分析结果：

[@0,0:4='hello',<'hello'>,1:0]
[@1,6:10='parrt',<ID>,1:6]
[@2,12:11='<EOF>',<EOF>,2:0]

然后进行语法分析测试。

$ grun Hello r -tree
hello parrt
EOF

显示

(r hello parrt)

还可以将语法树可视化：

$ grun Hello r -gui
hello parrt
EOF

接着会弹出一个对话框。

hello-parrt.png

Ref

《ANTLR4 权威指南》

Getting Started with ANTLR v4