ANTLR的运行库提供了两种遍历树的机制:语法分析树监听器与访问器。通过它们,我们可以在遍历树的时候实现相应逻辑。
监听器:
使用监听器时,需要继承Listener类,类的方法会被antlr提供的遍历器对象(比如ParseTreeWalker)自动调用。
ANTLR为每个语法文件生成一个ParserTreeListener的子类,在该类中,语法中的每条规则都有对应的enter和exit方法,例如:
ORACLEListener.py
# This class defines a complete listener for a parse tree produced by ORACLEParser.
class ORACLEListener(ParseTreeListener):
# Enter a parse tree produced by ORACLEParser#sqlStmt.
def enterSqlStmt(self, ctx:ORACLEParser.SqlStmtContext):
pass
# Exit a parse tree produced by ORACLEParser#sqlStmt.
def exitSqlStmt(self, ctx:ORACLEParser.SqlStmtContext):
pass
如下图,当遍历器访问到规则assign对应的节点时,就会调用enterAssign()方法,并将其对应的语法分析树节点——AssignContext的实例——当作参数传递给它。在访问了assign节点的全部子节点之后,它会调用exitAssign()。虚线标识了ParseTreeWalker对语法分析树进行深度优先遍历的过程。
访问器:
使用访问器时,需要继承Visitor类,类的方法中,必须显示调用visit方法来访问子节点,如果没有调用visit方法就会导致对应的子树不被访问。
ANTLR为每个语法文件生成一个ParseTreeVisitor的子类,在该类中,每条规则都有对应的visit方法,例如:
# This class defines a complete generic visitor for a parse tree produced by ORACLEParser.
class ORACLEVisitor(ParseTreeVisitor):
# Visit a parse tree produced by ORACLEParser#sqlStmt.
def visitSqlStmt(self, ctx:ORACLEParser.SqlStmtContext):
return self.visitChildren(ctx)
# Visit a parse tree produced by ORACLEParser#createStmt.
def visitCreateStmt(self, ctx:ORACLEParser.CreateStmtContext):
return self.visitChildren(ctx)
如下图,ANTLR内部为访问者模式提供的支持代码会在根节点处调用visitStat()方法,接下来visitStat()方法的实现将会调用visit()方法,并将所有子节点当作参数传递给它,从而继续遍历过程。