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，最后返回結果。

示例代碼