编译技术教程：前言

本系列是北航《编译技术》实验教程的前端教程部分，介绍了编译器前端的实现过程。此系列内容由本人编写或参与修改，在此也感谢所有参与教程编写工作的本届和往届助教。对于完整的实验教程，可见 wokron/tolangc。

系列导航：
《编译技术教程：前言》
《编译技术教程：词法分析》
《编译技术教程：抽象语法树》
《编译技术教程：语法分析》
《编译技术教程：符号表与类型系统》
《编译技术教程：语义分析》
《编译技术教程：附录 - 项目测试》

一、本教程的背景

编译技术实验是计算机科学与技术专业核心专业必修课编译技术的实践环节，旨在帮助学生深入理解编译原理和技术，并掌握实际编译器的设计和实现方法。在本实验中，各位同学需要自行设计、实现一个完整的编译器，该编译器能够实现 SysY 语言（C 语言子集）到中间代码 LLVM、Pcode 或目标代码 MIPS 的编译过程。

亲自实现一个编译器对各位同学理解编译技术有着极大的帮助。然而，作为这门课的初学者，同学们往往难以在一开始就对编译器产生完整全面的认识。在实验中，这一点体现为一些同学在编译器的设计上存在不足，难以运用理论课上的知识实现一个架构清晰、可随实验进度不断扩展的编译器。这导致这种情况的出现：早期的设计隐患在之后的实验中爆发，不得不重构之前的程序逻辑。在浪费时间的同时，无法学到编译器设计的更好方法。

当然，这并不意味着理论课的内容毫无必要，而是理论与实际之间本就有着难以轻易逾越的鸿沟。将理论与实践融会贯通，本就需要付出极大的努力。在往届的实验中，我们也曾提供或推荐一些已有的编译器代码供同学们学习，然而这些代码或过于老旧、或过于复杂，常常难以满足同学们的学习和借鉴需要。

为了能稍稍帮助同学们更好的完成编译实验，实验课教程组决定做出一点自己的贡献。以往的编译实验教程主要关注于讲述实验中可能会用到的相关知识，尽管也有一些辅助理解的例子，但也常常局限于单一章节的内容，不同章节间内容互不相通。这一定程度上妨碍了同学们从中学习编译器的设计方法，并容易造成了理解上的混乱。

因此，我们决定修改原有的编译实验教程，通过示例驱动的方式给同学们提供更有参考价值的教程内容。具体来说，我们会设计一个十分简单的编程语言：tolang。在本教程中，我们将以 tolang 编译器 tolangc 的编写为主线，介绍基本的编译器设计和实现方法，从而为同学们提供一个相对较好的实践样例。

二、tolang 介绍

tolang 这个名字很奇怪，最初起名时的含义是 toy lang，但是也有 too long 的谐音。不过这个语言确实是一个玩具语言，根本没有复杂冗长的语法语义。

（1）文法定义

我们的 tolang 可以由如下的 EBNF 范式确定：

CompUnit: {FuncDef} {VarDecl} {Stmt}

FuncDef: 'fn' Ident '(' [FuncFParams] ')' '=>' Exp ';'

FuncFParams: Ident { ',' Ident }

VarDecl: 'var' Ident ';'

Stmt:
    'get' Ident ';'
    | 'put' Exp ';'
    | 'tag' Ident ';'
    | 'let' Ident '=' Exp ';'
    | 'if' Cond 'to' Ident ';'
    | 'to' Ident ';'

Exp: AddExp

AddExp:
    MulExp
    | AddExp ('+' | '-') MulExp

MulExp:
    UnaryExp
    | MulExp ('*' | '/' | '%') UnaryExp

UnaryExp:
    PrimaryExp
    | Ident '(' [FuncRParams] ')'
    | ('+' | '-') UnaryExp

PrimaryExp:
    '(' Exp ')'
    | Ident
    | Number

FuncRParams: Exp { ',' Exp }

Cond:
    Exp ('<' | '>' | '<=' | '>=' | '==' | '!=') Exp

其中标识符（Ident）和数字（Number）可以由如下正则表达式确定：

Ident: [a-zA-Z_][0-9a-zA-Z_]*
Number: (0|[1-9][0-9]*)(\.[0-9]+)?

当然，只是列出文法不太负责。接下来我们以一般教程的方式介绍该语言：

tolang 的内容只能写在单个文件中。
tolang 的代码包含三个部分：函数定义、变量定义和语句。三个部分的顺序不能颠倒。
tolang 的函数定义如下。函数中只能包含单一表达式。
```
fn func_name(a1, a2, a3) => a1 + a2 + a3 + 1.23;
```
tolang 的变量定义如下所示。变量只有（单精度）浮点数类型
```
var a; var b;
var c;
```
tolang 的输入输出如下所示。
```
get a; # input
put a; # output
```
tolang 的计算和赋值如下所示。
```
let a = a + b - c * d / 1;
```

tolang 不具有结构化控制流，而是使用标签 tag、无条件跳转 to 和有条件跳转 if... to 实现控制流。if 的条件只能是两个表达式值比较。

# if-else
if a + 1 < b to else;
    put a;
    to fi;
tag else;
    put b;
tag fi;

# while
let i = 1;
tag while; if i >= 10 to done;
    put a;
    let i = i + 1;
to while; tag done;

tolang 中，从 # 开始直到本行末尾为注释内容。

（2）tolangc 编译器

tolangc 是 tolang 语言的编译器，目前代码托管在此处。tolangc 使用 C++ 编写，采用 C++17 标准，并使用 CMake 作为构建系统。

tolangc 的使用方法如下：

Usage: ./build/tolangc [options] [file]
Options:
  -h, --help: Show this help message
  --emit-ast: Emit AST
  --emit-ir: Emit IR
  -S, --emit-asm: Emit assembly
  -o, --output: Output file

tolangc 提供两种版本。一种版本以 LLVM 作为中间代码，以 MIPS 作为目标代码。而另一种版本以 Pcode 作为中间代码，并提供了虚拟机运行时进行解释执行。

由于时间仓促，tolangc 的代码并未经过详尽的测试，因此必然存在一些 bug 亟待发现或修复。如果有感兴趣的同学，也欢迎为其编写测试样例或进行 bug 修复。

一、本教程的背景#

二、tolang 介绍#

（1）文法定义#

（2）tolangc 编译器#

一、本教程的背景

二、tolang 介绍

（1）文法定义

（2）tolangc 编译器