语言类程序

在之前的学习中，我们已经知道了如何使用ANTLR来定义一种语言，现在进行一些深入的研究。通常单独的语法并没实际作用，应该有一个语法分析器才能帮助我们实现一些具体功能，才能开发一个语言类的程序。

语法分析器除了能够解析语法外，应该还能在遇到特定的语句，词组，或者语法符号时触发一些特定的行为。这样的语法和特殊行为的集合就构成了语言类程序。

ANTLR中为了实现这种功能，引入了访问器和监听器。

• 访问器可以通过显式触发的方式访问特定的节点。
• 监听器能够对特定规则的进入和退出事件作出响应。

下面详细介绍一些访问器和监听器能做什么，还是以之前学习的简单赋值语法做例子

grammar Hello;  //定义一个名为 Hello 的语法
 statement: ID '=' NUM; //匹配类似 a=1 age=100 这样的语句
 ID: [a-z]+;   // 定义了一个词法 ID，由小写字母组成
 NUM:[0-9]+; // 定义了一个词法 NUM，由数字组成
 WS: [ \t\r\n]+ -> skip;  //在进行解析的过程中，忽略掉空格，换行

ParseTreeVisitor（访问器）

根据语法生成的访问器接口

public interface HelloVisitor<T> extends ParseTreeVisitor<T> {
	/**
	 * Visit a parse tree produced by {@link HelloParser#statement}.
	 * @param ctx the parse tree
	 * @return the visitor result
	 */
	T visitStatement(HelloParser.StatementContext ctx);
}

从这个接口可以看到

1. ANTLR的访问器的*接口是ParseTreeVisitor
2. 访问器中会生成每个规则的visit方法,Hello里面只有statement这个规则，所以只有一个方法

接下来我们可以实现一个访问器的实现类，进行相关逻辑处理

public class HelloBaseVisitor<T> extends AbstractParseTreeVisitor<T> implements HelloVisitor<T> {
	/**
	 * {@inheritDoc}
	 *
	 * <p>The default implementation returns the result of calling
	 * {@link #visitChildren} on {@code ctx}.</p>
	 */
	@Override public T visitStatement(HelloParser.StatementContext ctx) {
        System.out.println(ctx.ID().getText());
        System.out.println(ctx.NUM().getText());
	    return visitChildren(ctx);
	}
}

1. visit方法的参数是一个**Context的类,每个规则会有一个**Context的类，这个类里面包含了规则里面的词组。
2. 可以提前规则里面的词组进行处理，这里就有了实现逻辑代码的空间。

ParseTreeListener（监听器）

public interface HelloListener extends ParseTreeListener {
	/**
	 * Enter a parse tree produced by {@link HelloParser#statement}.
	 * @param ctx the parse tree
	 */
	void enterStatement(HelloParser.StatementContext ctx);
	/**
	 * Exit a parse tree produced by {@link HelloParser#statement}.
	 * @param ctx the parse tree
	 */
	void exitStatement(HelloParser.StatementContext ctx);
}

1. ANTLR的监听器的*接口是ParseTreeListener
2. 访问器中会每个规则的一组方法。enterStatement和exitStatement，分别在分析树在进入规则和退出规则时触发。

public class HelloBaseListener implements HelloListener {
	/**
	 * {@inheritDoc}
	 *
	 * <p>The default implementation does nothing.</p>
	 */
	@Override public void enterStatement(HelloParser.StatementContext ctx) { }
	/**
	 * {@inheritDoc}
	 *
	 * <p>The default implementation does nothing.</p>
	 */
	@Override public void exitStatement(HelloParser.StatementContext ctx) { }
}

和访问器类似，我们也可以通过实现接口来添加代码逻辑。
这里有一点需要注意，在enterStatement方法时， 因为时刚进入该规则触发，所以这时还获取不到Statement里面的ID和NUM。如果需要用到这两个，只能在exitStatement方法类处理。

使用方式

在写好了访问器和监听器后，如何在ANTLR解析中使用？
这两个的使用方法有一定区别。

public static void main(String[] args) {
        HelloLexer lexer = new HelloLexer(CharStreams.fromString("a = 1"));
        CommonTokenStream tokenStream = new CommonTokenStream(lexer);
        HelloParser parser = new HelloParser(tokenStream);
        parser.addParseListener(new HelloBaseListener());//监听器
        StatementContext context = parser.statement();
        context.accept(new HelloBaseVisitor<>());//访问器
    }

监听器是在解析前通过addParseListener方法添加到Parser里面。
访问器是通过Context调用accept方法来指定访问规则。

思考

介绍了访问器和监听器使用后，大家可以思考一下分别使用这个两个来做一个简单的计算器。