关于Antlr中遍历语法树的注意事项

根据官网显示，antlr提供listener和vistor两种遍历语法树的机制，其中listener可以理解为自动遍历语法树，用户可以重写enter和exit函数从而实现自己的逻辑。而visitor机制不会自动遍历语法树，当用户重写visitXXX()函数后，需要实现XXX节点以及其子树的所有逻辑（如果不实现则是什么都不做）。如果没有完全理解visit方法的含义，使用者可能会犯一些错误（笔者就是）。这里将自己遇到的错误做一个简单的归纳。

首先，这里省略了文法，直接跳到语法树生成环节，假设生成了这样一个语法树（着重关注B节点既是A的子节点，也是C的子节点）:

语法树生成后，我重写了visitC()函数，也重写了visitB()函数，两者的内容均为简单地打印所有内容，具体代码如下所示

@Override
public Object visitC(CContext ctx) {
    System.out.printf("I am visiting C: %s\n",ctx.getText());
    return 1;
}

@Override
public Object visitB(BContext ctx) {
 System.out.printf("I am visiting B: %s\n",ctx.getText());
    return 1;
}

可是我发现C节点下的B节点的内容无法在visitB()函数中被打印出来，而当我注释掉visitC()函数时，所有B节点的内容（包括C节点下的B节点的内容）都能被打印出来。

究其根本，使用visit机制遍历语法树不会从头开始自动遍历所有节点，而是就只会深度遍历所有的XXX节点（实现了visitXXX()函数）。因为上述例子的B节点可以是C节点的子树，而visitC()函数并没有特意对B节点进行处理。因此，尽管重写了visitB()函数，但还是无法打印出代码中所有B节点的详情。

解决方法：理解基于visitor的遍历机制，完整地定义一个节点下出现的所有节点的访问顺序。