ANTLR4访问者模式在简单算术示例中的应用

Question

我完全不懂ANTLR4，所以请原谅我的无知。我遇到了这个演示文稿，其中定义了一个非常简单的算术表达式语法。它看起来像是：

grammar Expressions;

start : expr ;

expr  : left=expr op=('*'|'/') right=expr #opExpr
      | left=expr op=('+'|'-') right=expr #opExpr
      | atom=INT #atomExpr
      ;

INT   : ('0'..'9')+ ;

WS    : [ \t\r\n]+ -> skip ;

这很棒，因为它将生成一个非常简单的二叉树，可以使用访问者模式遍历该树，如幻灯片中所解释的那样，例如，这是访问expr的函数：

public Integer visitOpExpr(OpExprContext ctx) {
  int left = visit(ctx.left);
  int right = visit(ctx.right);
  String op = ctx.op.getText();
  switch (op.charAt(0)) {
    case '*': return left * right;
    case '/': return left / right;
    case '+': return left + right;
    case '-': return left - right;
    default: throw new IllegalArgumentException("Unkown opeator " + op);
  }
}

接下来我想要添加的是对括号的支持。因此，我修改了expr如下：

expr  : '(' expr ')'                      #opExpr
      | left=expr op=('*'|'/') right=expr #opExpr
      | left=expr op=('+'|'-') right=expr #opExpr
      | atom=INT #atomExpr
      ;

很不幸，上面的代码在遇到括号时会失败，因为三个属性op、left和right都为空（NPE失败）。

我认为可以通过定义一个新属性来解决这个问题，例如parenthesized='(' expr ')'，然后在访问者代码中处理它。但是，对我来说，使用一个完整的额外节点类型来表示带括号的表达式似乎过于复杂。一个更简单但更丑陋的解决方案是在visitOpExpr方法的开头添加以下代码行：

if (ctx.op == null) return visit(ctx.getChild(1)); // 0 and 2 are the parentheses!

我完全不喜欢上面的内容，因为它非常脆弱，且高度依赖语法结构。

我在想是否有一种方法可以告诉ANTLR只是“吃掉”括号，并将表达式视为子级。有吗？有更好的方法吗？

注意：我的最终目标是扩展示例以包括布尔表达式，这些表达式本身可以包含算术表达式，例如：(2+4*3)/10 >= 11，即，算术表达式之间的关系（<，>，==，~=等）可以定义一个原子布尔表达式。这很简单，我已经勾勒出了语法，但我遇到了同样的括号问题，即，我需要能够编写以下内容（我还将添加对变量的支持）：

((2+4*x)/10 >= 11) | ( x>1 & x<3 )

编辑：修正了括号表达式的优先级，括号始终具有更高的优先级。

- Giovanni Botta

Answer 1

当然，只需要将其标记为不同的名称即可。毕竟，替代方案'(' expr ')' 并不是一个#opExpr：

expr  : left=expr op=('*'|'/') right=expr #opExpr
      | left=expr op=('+'|'-') right=expr #opExpr
      | '(' expr ')'                      #parenExpr
      | atom=INT                          #atomExpr
      ;

在你的访问者中，你可以这样做：

public class EvalVisitor extends ExpressionsBaseVisitor<Integer> {

    @Override
    public Integer visitOpExpr(@NotNull ExpressionsParser.OpExprContext ctx) {
        int left = visit(ctx.left);
        int right = visit(ctx.right);
        String op = ctx.op.getText();
        switch (op.charAt(0)) {
            case '*': return left * right;
            case '/': return left / right;
            case '+': return left + right;
            case '-': return left - right;
            default: throw new IllegalArgumentException("Unknown operator " + op);
        }
    }

    @Override
    public Integer visitStart(@NotNull ExpressionsParser.StartContext ctx) {
        return this.visit(ctx.expr());
    }

    @Override
    public Integer visitAtomExpr(@NotNull ExpressionsParser.AtomExprContext ctx) {
        return Integer.valueOf(ctx.getText());
    }

    @Override
    public Integer visitParenExpr(@NotNull ExpressionsParser.ParenExprContext ctx) {
        return this.visit(ctx.expr());
    }

    public static void main(String[] args) {
        String expression = "2 * (3 + 4)";
        ExpressionsLexer lexer = new ExpressionsLexer(CharStreams.fromString(expression));
        ExpressionsParser parser = new ExpressionsParser(new CommonTokenStream(lexer));
        ParseTree tree = parser.start();
        Integer answer = new EvalVisitor().visit(tree);
        System.out.printf("%s = %s\n", expression, answer);
    }
}

如果您运行上面的代码，您会看到以下输出：

2 * (3 + 4) = 14

2 * (3 + 4) = 14

- Bart Kiers

---

我明白了。所以我猜没有办法让ANTLR直接去掉中间节点？原则上，这里也涉及到空间效率的问题，不是吗？ - Giovanni Botta

我不完全确定我是否理解你的意思，但是处理括号替代方案是不可避免的：ANTLR仅用于解析，所有其他逻辑/评估必须由您自己显式处理[在访问者/监听器类中]。 - Bart Kiers

我的意思是，如果你写成这样：((((((((((2+3))))))))))，而不是2+3，语法显然是有效的，但由于所有括号节点的存在，树所占用的空间要大得多。我只是惊讶地发现没有一种方法来定义一个短路，以便将前面的表达式转换为后者。 - Giovanni Botta

啊，我明白了。是的，据我所知，没有重写解析树的功能。另请参阅：http://stackoverflow.com/questions/18768905/antlr-4-should-all-of-these-tokens-be-showing-up-in-the-ast - Bart Kiers

明白了，你提出的更改并不那么糟糕。谢谢！ - Giovanni Botta

Answer 2

我已将以上内容移植到Python Visitor，甚至是Python Listener。

Python监听器。

from antlr4 import *
from arithmeticLexer import arithmeticLexer
from arithmeticListener import arithmeticListener
from arithmeticParser import arithmeticParser
import sys

##  grammar arithmetic;
##  
##  start : expr ;
##  
##  expr  : left=expr op=('*'|'/') right=expr #opExpr
##        | left=expr op=('+'|'-') right=expr #opExpr
##        | '(' expr ')'                      #parenExpr
##        | atom=INT                          #atomExpr
##        ;
##  
##  INT   : ('0'..'9')+ ;
##  
##  WS    : [ \t\r\n]+ -> skip ;

import codecs
import sys

def dump(obj):
  for attr in dir(obj):
    print("obj.%s = %r" % (attr, getattr(obj, attr)))

def is_number(s):
    try:
        float(s)
        return True
    except ValueError:
        return False


class arithmeticPrintListener(arithmeticListener):

    def __init__(self):
        self.stack = []

    # Exit a parse tree produced by arithmeticParser#opExpr.
    def exitOpExpr(self, ctx:arithmeticParser.OpExprContext):

        print('exitOpExpr INP',ctx.op.text,ctx.left.getText(),ctx.right.getText())

        op = ctx.op.text

        opchar1=op[0]
        right= self.stack.pop()
        left= self.stack.pop()

        if opchar1 == '*':
           val = left * right 
        elif opchar1 == '/':
           val = left / right 
        elif opchar1 == '+':
           val = left + right 
        elif opchar1 == '-':
           val = left - right
        else:
           raise ValueError("Unknown operator " + op) 

        print("exitOpExpr OUT",opchar1,left,right,val)

        self.stack.append(val)


    # Exit a parse tree produced by arithmeticParser#atomExpr.
    def exitAtomExpr(self, ctx:arithmeticParser.AtomExprContext):
         val=int(ctx.getText())
         print('exitAtomExpr',val)
         self.stack.append(val)

def main():
    #lexer = arithmeticLexer(StdinStream())
    expression = "(( 4 - 10 ) * ( 3 + 4 )) / (( 2 - 5 ) * ( 3 + 4 ))"
    lexer = arithmeticLexer(InputStream(expression))
    stream = CommonTokenStream(lexer)
    parser = arithmeticParser(stream)
    tree = parser.start()
    printer = arithmeticPrintListener()
    walker = ParseTreeWalker()
    walker.walk(printer, tree)

if __name__ == '__main__':
    main()

Python访问者

from antlr4 import *
from arithmeticLexer import arithmeticLexer
from arithmeticVisitor import arithmeticVisitor
from arithmeticParser import arithmeticParser
import sys
from pprint import pprint


##  grammar arithmetic;
##  
##  start : expr ;
##  
##  expr  : left=expr op=('*'|'/') right=expr #opExpr
##        | left=expr op=('+'|'-') right=expr #opExpr
##        | '(' expr ')'                      #parenExpr
##        | atom=INT                          #atomExpr
##        ;
##  
##  INT   : ('0'..'9')+ ;
##  
##  WS    : [ \t\r\n]+ -> skip ;

import codecs
import sys

class EvalVisitor(arithmeticVisitor):
    def visitOpExpr(self, ctx):

        #print("visitOpExpr",ctx.getText())

        left = self.visit(ctx.left)
        right = self.visit(ctx.right)
        op = ctx.op.text;

        # for attr in dir(ctx.op): ########### BEST 
        #   print("ctx.op.%s = %r" % (attr, getattr(ctx.op, attr)))
        #print("visitOpExpr",dir(ctx.op),left,right)

        opchar1=op[0]
        if opchar1 == '*':
           val = left * right 
        elif opchar1 == '/':
           val = left / right 
        elif opchar1 == '+':
           val = left + right 
        elif opchar1 == '-':
           val = left - right
        else:
           raise ValueError("Unknown operator " + op) 
        print("visitOpExpr",opchar1,left,right,val)
        return val 

    def visitStart(self, ctx):
        print("visitStart",ctx.getText())
        return self.visit(ctx.expr())

    def visitAtomExpr(self, ctx):
        print("visitAtomExpr",int(ctx.getText()))
        return int(ctx.getText())

    def visitParenExpr(self, ctx):
        print("visitParenExpr",ctx.getText())
        return self.visit(ctx.expr())

def main():
    #lexer = arithmeticLexer(StdinStream())
    expression = "(( 4 - 10 ) * ( 3 + 4 )) / (( 2 - 5 ) * ( 3 + 4 ))"
    lexer = arithmeticLexer(InputStream(expression))
    stream = CommonTokenStream(lexer)
    parser = arithmeticParser(stream)
    tree = parser.start()
    answer = EvalVisitor().visit(tree) 
    print(answer)

if __name__ == '__main__':
    main()

- Jayanta