Getting Started with ANTLR v4

翻译：原文
欢迎来到ANTLR发布的第4个版本。它的名字以Crazy Nasty-Ass Honey Badger的一位无所畏惧的英雄命名,因为ANTLR v4随心所欲-简直就是垃圾！请参阅为什么我们需要ANTLR v4？以及ANTLR v4书籍的序言。

Installation

ANTLR实际上是两件事：用于翻译你的语法做语法解析/词法分析通过java（或其他目标语言），以及生成词法/语法分析器所需要的运行时。即使你使用ANTLR Intellij plug-in 或 ANTLRWorks 运行ANTLR工具，生成代码也将需要运行时库。

首先，你需要下载安装一个开发工具插件。即使你只是使用一些工具编辑，它们很强大。然后根据以下的操作说明，使你的程序可以以运行时的环境运行语法/词法分析器。在之后的内容，我会讨论关于 antlr-4.7.1-complete.jar, 该文件具有工具，运行时以及其他任何支持库（例如，ANTLR v4是在v3中编写的）。

如果你将要整合ANTLR到你已经存在的构建系统使用mvn,或想要通过你的IDE获取ANTLR，比如 eclipse 或 intellij，查看整合ANTLR到开发系统。

UNIX

• 安装java
• 下载

$ cd /usr/local/lib
$ curl -O https://www.antlr.org/download/antlr-4.7.1-complete.jar

或者仅仅从浏览器下载 https://www.antlr.org/download.html,把它放置到合理的位置，如: /usr/local/lib

• 把 antlr-4.7.1-complete.jar 加入到你的 CLASSPATH:

$ export CLASSPATH=".:/usr/local/lib/antlr-4.7.1-complete.jar:$CLASSPATH"

把它加入到你的.bash_profile也是个不错的注意，或者加入到你的任何启动脚本处。

• 为ANTLR工具创建别名和TestRig

$ alias antlr4='java -Xmx500M -cp "/usr/local/lib/antlr-4.7.1-complete.jar:$CLASSPATH" org.antlr.v4.Tool'
$ alias grun='java -Xmx500M -cp "/usr/local/lib/antlr-4.7.1-complete.jar:$CLASSPATH" org.antlr.v4.gui.TestRig'

WINDOWS

// TODO

Testing the installation

直接启动每一个 org.antlr.v14.Tool

$ java org.antlr.v4.Tool
ANTLR Parser Generator Version 4.7.1
-o ___ specify output directory where all output is generated
-lib ___ specify location of .tokens files
...

或使用java 的 -jar命令

$ java -jar /usr/local/lib/antlr-4.7.1-complete.jar
ANTLR Parser Generator Version 4.7.1
-o ___ specify output directory where all output is generated
-lib ___ specify location of .tokens files
...

A First Example

在一个临时的文件夹，加入下列语法到 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工具

$ cd /tmp
$ antlr4 Hello.g4
$ javac Hello*.java

然后测试它:

$ grun Hello r -tree
(Now enter something like the string below)
hello parrt
(now,do:)
^D
(The output:)
(r hello parrt)
(That ^D means EOF on unix; it's ^Z in Windows.) The -tree option prints the parse tree in LISP notation.
It's nicer to look at parse trees visually.
$ grun Hello r -gui
hello parrt
^D

弹出的对话框盒子展示了规则r匹配关键字hello，跟着关键字parrt.

Book source code

本书有一些很有用的例子。可以在这里下载:
http://pragprog.com/titles/tpantlr2/source_code

这里同时手机了大量的v4的语法:
https://github.com/antlr/grammars-v4