ANTLR 4的C#实例

网上大多ANTLR的资源都是Java的，很少C#的示例，此文的目的就是以一个C#实现的表达式计算实例来说明如何在Visual Studio中编写ANTLR程序。大家可以把它看成一个简单的Hello World，后续我会陆续介绍ANTLR的一些高阶使用。

 

ANTLR是一款强大的语法分析生成器，可以用来读取，处理，执行和转换结构化文本或二进制文件。最著名的应用应该是Hibernate，用ANTLR搭建了HQL。除了大牌项目，你也可以建立各种有用的工具，如配置文件的读取，遗留代码转换器，Wiki标记的渲染器以及JSON解析器。通过语法的语言描述，ANTLR可以生成这种语言解析器并自动生成语法分析树（一种代表语法如何去匹配输入的的数据结构）。ANTLR也可自动生成树的遍历器，你可以用Visitor访问那些树的节点来执行应用程序特定的代码。

同类的工具

早期有很多优秀的语言识别工具，比如Lex/Yacc和Flex/Bison，但是年代久远，不支持C#。

1. Flex/Bison  PostgreSQL用的是这个

2. Yacc  MySQL用的是这个

4. Lemon  一个小巧的词法语法解析器，SQLite用的是这个

下面是一张主流的Parser的比较图：

在Visial Studio 2010中安装ANTLR插件

打开Tools中的Extension Manager...

选择Online Gallery，搜索NuGet，下载NuGet Package Manager并安装

搜索ANTLR，下载ANTLR Language Support并安装

创建项目

新建一个控制台应用程序，右击Solution，点击Manage NuGet Packagers for Solution...，搜索ANTLR4(注意选择Include Prerelease，这样列表中的才是最新版本哦），选择ANTLR 4下载并安装，ANTLR 4 Runtime会一并安装。

1.添加ANTLR 4模板的语法文件至项目，取名MyGrammar.g4

在MyGrammar.g4里面编写语法

grammar MyGrammar;

/*
 * Parser Rules
 */

program
	: expression
;

expression 
	: '(' expression ')'	#Parenthesis
	| expression operate = ('*' | '/') expression	#MultiplyDivide
	| expression operate = ('+' | '-') expression	#AddSubtraction		
	| INT	#Number
;


/*
 * Lexer Rules
 */

ADD : '+' ;
SUB : '-' ;
MUL : '*' ;
DIV : '/' ;

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

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

这是一个简单的表达式语法规则，括号优先级最高，其次乘除，加减在最后面，编译后在 \obj\x86\Debug 文件夹自动生成相应程序。

2.添加一个MyGrammarVisitor.cs文件 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Antlr4.Runtime;

namespace ConsoleApplication1
{
    public class MyGrammarVisitor : MyGrammarBaseVisitor<object>
    {
        Dictionary<string, object> memory = new Dictionary<string, object>();

        public override object VisitParenthesis(MyGrammarParser.ParenthesisContext context)
        {
            object obj = Visit(context.expression());
            return obj;
        }

        public override object VisitMultiplyDivide(MyGrammarParser.MultiplyDivideContext context)
        {
            double left = Convert.ToDouble(Visit(context.expression(0)));
            double right = Convert.ToDouble(Visit(context.expression(1)));

            object obj = new object(); 
            if (context.operate.Type == MyGrammarParser.MUL) {
                obj = left * right;
            } else if (context.operate.Type == MyGrammarParser.DIV) {
                if (right == 0) {
                    throw new Exception("Cannot divide by zero.");
                }
                obj = left / right;
            }

            return obj;
        }

        public override object VisitAddSubtraction(MyGrammarParser.AddSubtractionContext context)
        {
            double left = Convert.ToDouble(Visit(context.expression(0)));
            double right = Convert.ToDouble(Visit(context.expression(1)));

            object obj = new object(); 
            if (context.operate.Type == MyGrammarParser.ADD) {
                obj = left + right;
            }
            else if (context.operate.Type == MyGrammarParser.SUB) {
                obj = left - right;
            }

            return obj;
        }

        public override object VisitNumber(MyGrammarParser.NumberContext context)
        {
            object obj = context.GetText();
            return obj;
        }
    }
}

MyGrammarVisitor类继承自MyGrammarBaseVisitor，重载具体实现了四则运算。

3.最后Main来调用这些方法

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Antlr4.Runtime;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            string input = @"1 + (2 - 3) * 4";

            var stream = new AntlrInputStream(input);
            var lexer = new MyGrammarLexer(stream);
            var tokens = new CommonTokenStream(lexer);
            var parser = new MyGrammarParser(tokens);
            var tree = parser.program();

            var visitor = new MyGrammarVisitor();
            var result = visitor.Visit(tree);

            Console.WriteLine(tree.ToStringTree(parser));
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}

该程序读入一个四则运算的表达式，由ANTLR来做词法分析语法分析，生成表达式树，然后按重载的Visitor方法自动walk，最后返回结果。

示例代码