ANTLR4学习笔记

发表于   |   分类于

ANTLR4文法文档的基本书写语法,参考ANTLR官方文档,版本V4

参考:

  1. 快速入门-使用 Antlr 开发领域语言
  2. 快速入门-使用 Antlr 开发领域语言 - 开发一个完整的应用
  3. ANTLR官方文档

ANTLR是什么

ANTLR是一个解析器生成工具,可以根据你书写的文法文件,自动生成可以解析该文法的解析器(Parser).其强大的功能远不止这些.

文法文档(Grammar Lexicon)

Lexicon是按ANTLR规范书写的文件,在这个文件中指定你要解析的文法,ANTLR再根据这个文件生成对应的解析器.

语法

lexicon类似于一门小型的语言

注释(Comments)

支持单行注释,多行注释,和javadoc风格的注释

1
2
3
4
5
6
7
8
9
10
11
/**
* this is javadoc-style comment
*/

grammar T;

/* a multi-linexuanxiang
  comment
*/

decl : ID; //this is single-line comment

标识符(Identifiers)

词法单元和词法规则通常以大写字母命名
解析规则(parser rule) 以小写字母开头命名(驼峰命名法)

例如:

1
2
ID, LPAREN, RIGHT_CURLY //token names/rule
expr, simpleDclarator, d2, header_file //rule names

ANTLR还支持unicode编码的字符命名

文字(Literals)

ANTLR不区分字符和字符串.所有的字符串(这里是指出现在源文件中的需要被识别的字符串)都是由单引号引用起来的字符,但是像这样的字符串中不包括正则表达式.支持unicode和转义符号例如

1
2
3
4
',' , 'if', '>=', 
' \''//转义的单引号
'\u00E8' //法语中的字符è
'\n', '\r' //换行 回车

动作(Actions)

动作是用目标语言书写的代码块.嵌入的代码可以出现在:

  1. @header @members这样的命名动作中
  2. 解析规则和词法规则中
  3. 异常捕获中
  4. 解析规则的属性部分(返回值,参数等)
  5. 一些规则可选元素中

关键字(Keywords)

ANTLR中有一些保留关键字,例如:

1
import, fragment, lexer, parser, grammar, returns, locals, throws, catch, finally, mode, options, tokens

语法结构(Grammar Structure)

语法结构如下
|Grammar |
| ————- |
| /Optional javadoc style comment*/|
| grammer Name; |
| options {…}; |
| import …; |
| tokens {…}; |
| channels {…}; |
| @actionName** {…}; |
| |
| rule1 //parser and lexer rules |
| … |
| ruleN |

文件命名必须和grammar命名相同,如 grammar T,文件名必须命名为T.g4.
options,imports,token,action的声明顺序没有要求,但一个文件中options,imports,token最多只能声明一次.grammar是必须声明的,同时必须至少声明一条规则(rule),其余的部分都是可选的.

规则(rules)

规则的声明遵循以下格式:

1
2
3
4
ruleName : alternative1 | ... | alternativeN ;

//定义类型
type : 'int' | 'unsigned' | 'long'

引入(imports)

ANTLR中的引入机制类似于OO中的继承.它会从引入的文件继承所有的规则,词法单元,动作.然后主文件中的元素会”覆盖”引入文件中的重名元素.

嵌套引用的合并规则比较复杂,详见官方文档

词法单元(Tokens Section)

1
tokens {Token1 ... TokenN}

例如为向量表示定义虚词法单元:

1
2
3
4
5
6
7
8
9
grammar VecMathAST
options{output=AST;}
tokens{VEC;}
statlist : stat+ ;
stat : ID '=' expr -> ^('=' ID expr)
     | 'print' expr -> ^('print' expr);
expr : multExpr ('+' ^ multExpr)*;
multExpr : primary (('*'^|'.'^) primary)*;
primary : INT | ID | '[' expr (',' expr)* ']' -> ^(VEC expr+);

动作(Actions at the Grammar Level)

针对java,有两个已经定义好的action:header和members

@header在生成的目标代码中的类定义之前注入代码
@members在生成的目标代码中的类定义里注入代码(例如类的属性和方法)

1
2
3
4
5
6
7
8
9
10
11
12
13
grammar Count;

@header {
pacakage foo;
}

@members{
int count = 0;
}
list @after{System.out.println(count+"ints");} : INT {count++;} (',' INT {count++})*
;

INT: [0-9]+;

解析器规则(Parser Rules)

解析器由一组解析器规则组成.java应用通过调用生成的规则函数(每个规则会生成一个函数)来启动解析.

基本形式如下,用 | 操作符分割多个选项

1
stat : restat | 'break' ';' | 'continue' ';' ;

可选标签(Alternative Labels)

可以在规则中添加标签,ANTLR会根据标签生成与规则相关的解析树的事件监听函数,使我们更加精准的控制解析过程.用 # 操作符定义一个标签
用法如下:

1
2
3
grammar T;
stat: 'return' e ';' # Return
    | 'break' ';' # Break

ANTLR会为每个标签生成一个rule-context类.

1
2
3
4
5
6
public interface AListener extends ParseTreeListener {
 	void enterReturn(AParser.ReturnContext ctx);
 	void exitReturn(AParser.ReturnContext ctx);
 	void enterBreak(AParser.BreakContext ctx);
 	void exitBreak(AParser.BreakContext ctx);
 	}

同一个标签可以加在多个规则选项上(multiple alternatives),但是标签命名不可以和规则名冲突

规则上下文对象(Rule Context Objects)

ANTLR为每个规则生成一个上下文对象,通过这个对象可以访问规则定义中的其他规则的引用.根据规则定义中的其他规则的引用数量不同,生成对象中包含的方法也不同.例如:

1
2
3
4
5
6
7
inc : e '++';

//generates this context class
public static class IncContext extends ParserRuleContext {
 	public EContext e() { ... } // return context object associated with e
 	...
 	}
1
2
3
4
5
6
7
8
field : e '.' e;

//generates this context class
public static class FieldContext extends ParserRuleContext {
 	public EContext e(int i) { ... } // get ith e context
 	public List<EContext> e() { ... } // return ALL e contexts
 	...
 	}

规则元素标签(Rule Element Labels)

可以用 = 操作符为规则中的元素添加标签,这样会在规则的上下文对象中添加元素的字段.

例如:

1
2
3
4
5
6
7
8
9
stat: 'return' value=e ';' # Return //将e的context作为一个字段添加到 ReturnContext中
 	| 'break' ';' # Break
 	;
 	
 //generates context class
 public static class ReturnContext extends StatContext {
 	public EContext value;
 	...
 	}

+= 操作符可以很方便的记录大量的token或者规则的引用

1
2
3
4
5
6
array : '{' el+=INT (',' el+=INT)* '}' ;
//ANTLR generates a List field in the appropriate rule context class:
 public static class ArrayContext extends ParserRuleContext {
 	public List<Token> el = new ArrayList<Token>();
 	...
 	}

规则元素(Rule ELements)

规则元素指定了解析器在具体时刻应该执行什么任务.元素可以是规则(rule), 词法单元(token), 字符串文字(string literal)等

  1. T token
  2. ‘literal’ 字符串文字
  3. r 规则
  4. r[args] 向规则函数中传递参数,参数的书写规则是目标语言,用逗号分隔
  5. . 通配符
  6. {action} 动作,在元素的间隔中执行
  7. {p} 谓词

支持逻辑非操作符:~

子规则

规则中包含的可选块称为子规则(被封闭在括号中).子规则也可以看做规则(rule),但是没有显式的命名.子规则不能定义局部变量,也没有返回值.如果子规则只有一个元素,括号可以省略.
子规则有四种
例如:

  1. (x|y|z) 只匹配一个选项
  2. (x|y|z)? 匹配一个或者不匹配
  3. (x|y|z)* 匹配零次或多次
  4. (x|y|z)+ 匹配一次或多次

捕获异常(Catching Exception)

当规则中出现语法错误,ANTLR可以捕获异常,报告错误和尝试恢复(possibly by consuming more tokens),然后从规则中返回.ANLTR通过策略模式来处理所有的异常,也可以为某个规则通过指定特定的异常处理:在规则末尾添加catch语句.

1
2
3
r : ...
 	;
 	catch[RecognitionException e] { throw e; }

规则属性定义(Rule Attribute Definition)

可以像编程语言中的函数那样,在规则中定义参数,返回值,局部变量,定义的这些属性会保存在规则上下文对象中(rule context object).
例如:

1
2
3
rulename [args] returns [retvals] locals [localvars]: ...;
//[..]中定义的变量可以在定义之后使用
add [int x] returns [int result] : '+=' INT {$result = $x + $INT.int;};

和语法层面的动作(action)一样,可以定义规则层面的动作.合法的动作名是:init,after.像这些动作的命名一样,解析器会在匹配相应的规则之前执行init动作,在规则匹配完成之后执行after动作.

1
2
3
4
5
6
7
8
9
10
11
/** Derived from rule "row : field (',' field)* '\r'? '\n' ;" */
 	row[String[] columns] returns [Map<String,String> values]
 	locals [int col=0]
 	@init {
 	$values = new HashMap<String,String>();
 	}
 	@after {
 	if ($values!=null && $values.size()>0) {
 	System.out.println("values = "+$values);
 	}
 	}