Yacc 和 Bison

From ：http://www.ibm.com/developerworks/cn/linux/sdk/lex/index.html

Yacc

Yacc 代表 Yet Another Compiler Compiler。 Yacc 的 GNU 版叫做Bison。它是一种工具，将任何一种编程语言的所有语法翻译成针对此种语言的Yacc 语 法解析器。它用巴科斯范式(BNF, Backus NaurForm)来书写。按照惯例，Yacc 文件有 .y 后缀。编译行如下调用 Yacc编译器：

       $ yacc <options>

        <filename ending with .y>

在进一步阐述以前，让我们复习一下什么是语法。在上一节中，我们看到Lex 从输入序列中识别标记。如果你在查看标记序列，你可能想在这一序列出现时执行某一动作。这种情况下有效序列的规范称为语法。Yacc 语法文件包括这一语法规范。它还包含了序列匹配时你想要做的事。

为了更加说清这一概念，让我们以英语为例。 这一套标记可能是：名词,动词,形容词等等。为了使用这些标记造一个语法正确的句子，你的结构必须符合一定的规则。一个简单的句子可能是名词+动词或者名词+动词+名词。(如 I care. Seespot run.)

所以在我们这里，标记本身来自语言（Lex），并且标记序列允许用 Yacc来指定这些标记(标记序列也叫语法)。

用 Yacc 来创建一个编译器包括四个步骤：

1. 通过在语法文件上运行 Yacc 生成一个解析器。
2. 说明语法：         
   • 编写一个 .y 的语法文件（同时说明 C 在这里要进行的动作）。
   • 编写一个词法分析器来处理输入并将标记传递给解析器。 这可以使用Lex 来完成。
   • 编写一个函数，通过调用 yyparse() 来开始解析。
   • 编写错误处理例程（如 yyerror()）。
3. 编译 Yacc 生成的代码以及其他相关的源文件。
4. 将目标文件链接到适当的可执行解析器库。

用 Yacc 编写语法

如同 Lex 一样, 一个 Yacc 程序也用双百分号分为三段。它们是：声明、语法规则和 C 代码。 我们将解析一个格式为 姓名 = 年龄的文件作为例子，来说明语法规则。我们假设文件有多个姓名和年龄，它们以空格分隔。 在看 Yacc程序的每一段时，我们将为我们的例子编写一个语法文件。

C 与 Yacc 的声明

C 声明可能会定义动作中使用的类型和变量，以及宏。还可以包含头文件。每个 Yacc声明段声明了终端符号和非终端符号（标记）的名称，还可能描述操作符优先级和针对不同符号的数据类型。lexer (Lex) 一般返回这些标记。所有这些标记都必须在 Yacc声明中进行说明。

在文件解析的例子中我们感兴趣的是这些标记：name, equal sign, 和age。Name 是一个完全由字符组成的值。 Age是数字。于是声明段就会像这样：

   
文件解析例子的声明

       %

        #typedef char* string; /*

        to specify token types as char* */

        #define YYSTYPE string /*

        a Yacc variable which has the value of returned token */

        %}

        %token NAME EQ AGE

        %%

你可能会觉得 YYSTYPE 有点奇怪。但是类似 Lex, Yacc也有一套变量和函数可供用户来进行功能扩展。 YYSTYPE 定义了用来将值从lexer 拷贝到解析器或者 Yacc 的 yylval （另一个 Yacc 变量）的类型。默认的类型是 int。 由于字符串可以从 lexer 拷贝，类型被重定义为char*。 关于 Yacc 变量的详细讨论，请参考 Yacc 手册（见         资源）。     

Yacc 语法规则

Yacc 语法规则具有以下一般格式：

       result: components { /*

        action to be taken in C */ }

        ;

在这个例子中，result 是规则描述的非终端符号。Components是根据规则放在一起的不同的终端和非终端符号。 如果匹配特定序列的话Components 后面可以跟随要执行的动作。 考虑如下的例子：

       param : NAME EQ NAME {

        printf("/tName:%s/tValue(name):%s/n", $1,$3);}

            | NAME EQ VALUE{

            printf("/tName:%s/tValue(value):%s/n",$1,$3);}

        ;

如果上例中序列 NAME EQ NAME 被匹配，将执行相应的 { }括号中的动作。 这里另一个有用的就是 $1 和 $3 的使用, 它们引用了标记NAME 和 NAME（或者第二行的 VALUE）的值。 lexer 通过 Yacc 的变量yylval 返回这些值。标记 NAME 的 Lex 代码是这样的：

       char [A-Za-z]

        name {char}+

        %%

        {name} { yylval = strdup(yytext);

        return NAME; }

文件解析例子的规则段是这样的：

   
文件解析的语法

       file : record file

        | record

        ;

        record: NAME EQ AGE {

        printf("%s is now %s years old!!!", $1, $3);}

        ;

        %%

附加 C 代码

现在让我们看一下语法文件的最后一段，附加 C 代码。（这一段是可选的，如果有人想要略过它的话：）一个函数如 main() 调用yyparse() 函数（Yacc 中 Lex 的 yylex() 等效函数）。 一般来说，Yacc最好提供 yyerror(char msg) 函数的代码。 当解析器遇到错误时调用yyerror(char msg)。错误消息作为参数来传递。 一个简单的 yyerror(char* ) 可能是这样的：

       int yyerror(char* msg)

        {

        printf("Error: %s

        encountered at line number:%d/n", msg, yylineno);

        }

yylineno 提供了行数信息。

这一段还包括文件解析例子的主函数：

   
附加 C 代码

       void main()

        {

            yyparse();

        }

        int yyerror(char* msg)

        {

        printf("Error: %s

        encountered /n", msg);

要生成代码，可能用到以下命令：

       $ yacc _d <filename.y>

这生成了输出文件 y.tab.h 和 y.tab.c，它们可以用 UNIX上的任何标准 C 编译器来编译（如 gcc）。

命令行的其他常用选项

•      '-d' ,'--defines' :编写额外的输出文件，它们包含这些宏定义：语法中定义的标记类型名称，语义的取值类型          YYSTYPE, 以及一些外部变量声明。如果解析器输出文件名叫'name.c', 那么 '-d' 文件就叫做 'name.h'。 如果你想将           yylex定义放到独立的源文件中，你需要 'name.h', 因为           yylex必须能够引用标记类型代码和           yylval变量。       
•      '-b file-prefix' ,'--file-prefix=prefix' :指定一个所有Yacc输出文件名都可以使用的前缀。选择一个名字，就如输入文件名叫'prefix.c'.       
•      '-o outfile' ,'--output-file=outfile' :指定解析器文件的输出文件名。其他输出文件根据 '-d'选项描述的输出文件来命名。       

Yacc库通常在编译步骤中自动被包括。但是它也能被显式的包括，以便在编译步骤中指定        �ly选项。这种情况下的编译命令行是：     

       $ cc <source file

        names> -ly

将 Lex 与 Yacc 结合起来

到目前为止我们已经分别讨论了 Lex 和Yacc。现在让我们来看一下他们是怎样结合使用的。

一个程序通常在每次返回一个标记时都要调用        yylex()函数。只有在文件结束或者出现错误标记时才会终止。     

一个由 Yacc 生成的解析器调用        yylex()函数来获得标记。         yylex() 可以由 Lex来生成或完全由自己来编写。 对于由 Lex 生成的 lexer 来说，要和 Yacc结合使用，每当 Lex 中匹配一个模式时都必须返回一个标记。 因此 Lex中匹配模式时的动作一般格式为：     

       {pattern} { /* do smthg*/

        return TOKEN_NAME; }

于是 Yacc 就会获得返回的标记。当 Yacc 编译一个带有 _d 标记的        .y文件时，会生成一个头文件，它对每个标记都有        #define的定义。 如果 Lex 和 Yacc 一起使用的话，头文件必须在相应的 Lex 文件        .lex中的 C 声明段中包括。     

让我们回到名字和年龄的文件解析例子中，看一看 Lex 和 Yacc文件的代码。

   
Name.y - 语法文件

       %

        typedef char* string;

        #define YYSTYPE string

        %}

        %token NAME EQ AGE

        %%

        file : record file

        | record

        ;

        record : NAME EQ AGE {

        printf("%s is %s years old!!!/n", $1, $3); }

        ;

        %%

        int main()

        {

        yyparse();

        return 0;

        }

        int yyerror(char *msg)

        {

        printf("Error

        encountered: %s /n", msg);

        }

Name.lex - Lex 的解析器文件

       %{

        #include "y.tab.h"



        #include <stdio.h>

        #include <string.h>

        extern char* yylval;

        %}

        char [A-Za-z]

        num [0-9]

        eq [=]

        name {char}+

        age {num}+

        %%

        {name} { yylval = strdup(yytext);

        return NAME; }

        {eq} { return EQ; }

        {age} { yylval = strdup(yytext);

        return AGE; }

        %%

        int yywrap()

        {

        return 1;

        }

作为一个参考，我们列出了        y.tab.h, Yacc 生成的头文件。     

   
y.tab.h - Yacc 生成的头文件

       # define NAME 257

        # define EQ 258

        # define AGE 259

我们对于 Lex 和Yacc的讨论到此为止。今天你想要编译什么语言呢？

参考资料

• 您可以参阅本文在 developerWorks 全球站点上的          英文原文.       
•      Lex and Yacc, Levine, Mason 和 Branson, O�Reilly及其合作公司，2nd Ed。       
•      Program Development in UNIX, J. T. Shen, Prentice-HallIndia。       
•      Compilers: Principles, Techniques and Tools, Ahoo, Sethi 和Ullman, Addison-Wesley Pub. Co., 1985，11。       
•      Lex andYacc and compiler writing指导。       
• Java 版的 Lex 指导, 叫做          Jlex。       
• 使用 Lex 和 Yacc 的          formalizinga grammar实例。