前言
在前一篇博客已经介绍了如何在eclipse中安装antlr插件,这篇博客中就来用它做一个计算器小程序。
为了使程序简单一点,这里只涉及基本的加减乘除以及括号运算。
定义词法
ID : [a-zA-Z]+ ; // 变量可以为大写小写字母的任意组合
INT : [0-9]+ ; // 运算数为整数的任意组合
NEWLINE:'\r'? '\n' ;//匹配换行
WS : [ \t]+ -> skip ;//跳过空格和 \t
定义运算符
MUL : '*' ; //乘法
DIV : '/' ; //除法
ADD : '+' ; //加法
SUB : '-' ; //减法
定义语法
首先我们定义表达式 :expr
表达式可以是数字(INT),变量(ID),可以是加减乘除运算表达式,也可以是括号表达式。
所以 expr 的定义如下:
expr:expr op=('*'|'/') expr # MulDiv
| expr op=('+'|'-') expr # AddSub
| INT # int
| ID # id
| '(' expr ')' # parens
;
然后定义语句: stat
语句可以使 表达式 + 换行,可以是 变量声明,也可以是 空行
stat: expr NEWLINE # printExpr
| ID '=' expr NEWLINE # assign
| NEWLINE # blank
;
最后定义我们的 prog
我们的 prog 可以有多个的语句,即:
prog:stat+;
到这里我们的所有的语法以及词法规则就已经定义好了!
然后我们要注意一下几点:
grammar CalExpr;
stat :expr NEWLINE #printExpr |ID '=' expr NEWLINE #assign |NEWLINE #blank ;
expr : expr op=('+'|'-') expr # AddSub | expr op=('*'|'/') expr # MulDiv | ID # id | INT # int | '(' expr ')' # parens ;
ID : [a-zA-Z]+ ;
INT : [0-9]+ ;
NEWLINE : '\r' ? '\n';
WS : [ \t]+ -> skip;
ADD : '+' ;
SUB : '-' ;
MUL : '*' ;
DIV : '/' ;
运行程序
上面的规则定义好了,我们来运行一下吧!
如上图:右击点击run as -> External tools configurations
将 Arguments里面内容改为:
-no-listener -visitor -encoding UTF-8
点击右下角的 run 来运行程序。
CalExprVisitor.java
这时候我们上面加 标签 的作用就体现出来了,打开 CalExprVisitor.java,里面的内容如下:
// Generated from CalExpr.g4 by ANTLR 4.4
import org.antlr.v4.runtime.misc.NotNull;
import org.antlr.v4.runtime.tree.ParseTreeVisitor;
public interface CalExprVisitor<T> extends ParseTreeVisitor<T> {
T visitParens(@NotNull CalExprParser.ParensContext ctx);
T visitBlank(@NotNull CalExprParser.BlankContext ctx);
T visitAddSub(@NotNull CalExprParser.AddSubContext ctx);
T visitMulDiv(@NotNull CalExprParser.MulDivContext ctx);
T visitId(@NotNull CalExprParser.IdContext ctx);
T visitInt(@NotNull CalExprParser.IntContext ctx);
T visitPrintExpr(@NotNull CalExprParser.PrintExprContext ctx);
T visitAssign(@NotNull CalExprParser.AssignContext ctx);
}
CalExprBaseVisitor.java
源码就不贴出来了,这个就是对上面那个接口的一个简单的实现。
开始制作计算器
新建一个Java 项目,就叫 Calculator 吧。
第一步
将上面生成的四个.java
文件复制到项目中,并引antlr-4.6-complete.jar
这个jar包。然后创建MyVisitor.java
这个类。
jar包下载地址:http://download.csdn.net/detail/zjq_1314520/9793480
第二步
MyVisitor继承 CalExprBaseVisitor ,并重写他的方法:
定义一个Map来存储变量以及它的值,最后初始化的代码如下:
import java.util.HashMap;
import java.util.Map;
public class MyVisitor extends CalExprBaseVisitor<Integer>{
Map<String,Integer> map=new HashMap<String,Integer>();
@Override
public Integer visitParens(CalExprParser.ParensContext ctx) {
return super.visitParens(ctx);
}
@Override
public Integer visitBlank(CalExprParser.BlankContext ctx) {
return super.visitBlank(ctx);
}
@Override
public Integer visitAddSub(CalExprParser.AddSubContext ctx) {
return super.visitAddSub(ctx);
}
@Override
public Integer visitMulDiv(CalExprParser.MulDivContext ctx) {
return super.visitMulDiv(ctx);
}
@Override
public Integer visitId(CalExprParser.IdContext ctx) {
return super.visitId(ctx);
}
@Override
public Integer visitInt(CalExprParser.IntContext ctx) {
return super.visitInt(ctx);
}
@Override
public Integer visitPrintExpr(CalExprParser.PrintExprContext ctx) {
return super.visitPrintExpr(ctx);
}
@Override
public Integer visitAssign(CalExprParser.AssignContext ctx) {
return super.visitAssign(ctx);
}
}
当然这样并没有什么用,我们还得重写每个方法!
第三步
我们来重写每个方法:
visitParens()
‘(’ expr ‘)’ # parens
说明:碰到括号直接返回括号里面的值
@Override
public Integer visitParens(CalExprParser.ParensContext ctx) {
return super.visit(ctx.expr());
}
visitBlank()
NEWLINE # blank
@Override
public Integer visitBlank(CalExprParser.BlankContext ctx) {
return super.visitBlank(ctx);
}
visitAddSub()
expr op=(‘+’|’-‘) expr # AddSub
上图中的 a 和 b 可以是一个表达式。
碰到加减直接将表达式相加减即可!
@Override
public Integer visitAddSub(CalExprParser.AddSubContext ctx) {
Integer left=visit(ctx.expr(0)); //获取左边表达式最终值
Integer right=visit(ctx.expr(1)); //获取右边表达式最终值
if(ctx.op.getType()==CalExprLexer.ADD) return left+right; //如果是加法
else return left-right; //如果是减法
}
visitMulDiv()
说明,与上面道理相同,其实可以合并称为一个函数
// expr op=('*'|'/') expr # MulDiv
@Override
public Integer visitMulDiv(CalExprParser.MulDivContext ctx) {
Integer left=visit(ctx.expr(0)); //获取左边表达式最终值
Integer right=visit(ctx.expr(1)); //获取右边表达式最终值
if(ctx.op.getType()==CalExprLexer.DIV) return left/right; //如果是除法
else return left*right; //如果是乘法
}
visitAssign()
ID ‘=’ expr NEWLINE # assign
说明:碰到赋值则将其作为键值对存到 map 中去。
其中 3 可以是一个表达式。
@Override
public Integer visitAssign(CalExprParser.AssignContext ctx) {
String key=ctx.ID().getText();
Integer value=visit(ctx.expr());
map.put(key,value);
return value; // 返回 value :a=b=6 则 a==6
}
visitId()
ID # id
图略
说明:如这个变量有值,则返回。否则返回 0
@Override
public Integer visitId(CalExprParser.IdContext ctx) {
String key=ctx.ID().getText();
if(map.containsKey(key)){ //如果变量被赋值
return map.get(key);
}
return 0;
}
visitInt()
INT # int
图略
说明:如果是直接一个数字,则直接返回该数字
@Override
public Integer visitInt(CalExprParser.IntContext ctx) {
return Integer.parseInt(ctx.INT().getText());
}
visitPrintExpr()
expr NEWLINE # printExpr
图略
说明:打印表达式对应的值
@Override
public Integer visitPrintExpr(CalExprParser.PrintExprContext ctx) {
Integer value=visit(ctx.expr());
System.out.println(value);
return 0;
}
import java.util.HashMap;
import java.util.Map;
import org.stringtemplate.v4.compiler.STParser.expr_return;
/** * 作者:白芷 * 时间:2017/03/25 * */
public class MyVisitor extends CalExprBaseVisitor<Integer>{
Map<String,Integer> map=new HashMap<String,Integer>();
@Override
public Integer visitParens(CalExprParser.ParensContext ctx) {
return super.visit(ctx.expr());
}
@Override
public Integer visitBlank(CalExprParser.BlankContext ctx) {
return super.visitBlank(ctx);
}
@Override
public Integer visitAddSub(CalExprParser.AddSubContext ctx) {
Integer left=visit(ctx.expr(0)); //获取左边表达式最终值
Integer right=visit(ctx.expr(1)); //获取右边表达式最终值
if(ctx.op.getType()==CalExprLexer.ADD) return left+right; //如果是加法
else return left-right; //如果是减法
}
@Override
public Integer visitMulDiv(CalExprParser.MulDivContext ctx) {
Integer left=visit(ctx.expr(0)); //获取左边表达式最终值
Integer right=visit(ctx.expr(1)); //获取右边表达式最终值
if(ctx.op.getType()==CalExprLexer.DIV) return left/right; //如果是除法
else return left*right; //如果是乘法
}
@Override
public Integer visitId(CalExprParser.IdContext ctx) {
String key=ctx.ID().getText();
if(map.containsKey(key)){ //如果变量被赋值
return map.get(key);
}
return 0;
}
@Override
public Integer visitInt(CalExprParser.IntContext ctx) {
return Integer.parseInt(ctx.INT().getText());
}
@Override
public Integer visitPrintExpr(CalExprParser.PrintExprContext ctx) {
Integer value=visit(ctx.expr());
System.out.println(value);
return 0;
}
@Override
public Integer visitAssign(CalExprParser.AssignContext ctx) {
String key=ctx.ID().getText();
Integer value=visit(ctx.expr());
map.put(key,value);
return value; // 返回 value :a=b=6 则 a==6
}
}
第四步
在这里我们来写一个主函数来使用这个类吧!
import java.io.FileInputStream;
import java.io.InputStream;
import org.antlr.v4.runtime.*;
import org.antlr.v4.runtime.tree.*;
public class Main {
public static void main(String[] args) throws Exception {
String inputFile = "E:\\EclipseProject\\Calculator\\src\\data.ini"; //文件读取数据
InputStream is = System.in;
if ( inputFile!=null ) is = new FileInputStream(inputFile);
ANTLRInputStream input = new ANTLRInputStream(is);
CalExprLexer lexer = new CalExprLexer(input);
CommonTokenStream tokens = new CommonTokenStream(lexer);
CalExprParser parser = new CalExprParser(tokens);
ParseTree tree = parser.prog(); // 生成语法树
MyVisitor visitor = new MyVisitor();
visitor.visit(tree);
}
}
在 文件中加入表达式 然后愉快的计算吧!