Compiler for the Sub C Programing Language defined by CG.
针对希冀平台定义的 Sub C 程序设计语言的编译器。
- Build & Installation & Test | 构建、安装、自动测试方法
- Project Structure | 项目结构
- Language Definition | 语言定义
- License | 许可
- Author | 作者
本项目使用Makefile管理，若要编译本项目的代码，首先确保您已安装make，然后在终端中输入如下命令：
make release将在release目录中生成可执行文件scc和默认的动态词法定义文件sc.lang。
运行时请确保上述两个文件被放置在同一个目录下。
若要安装到操作系统的程序目录下，可以输入如下命令：
sudo make install或
su -c make install在上述安装命令中，默认安装路径为/usr/local/bin，可用环境变量DESTDIR指定安装的目标路径，
可将install替换为uninstall来卸载。
若要生成强制固定输入输出文件名为希冀平台要求的文件名（而不是根据命令行参数）、且不支持读取动态词法定义的可执行程序，
可用环境变量CG指定希冀平台的题号（范围为1～5）。例如：
make release CG=1将生成只进行词法分析的、输入输出文件固定的、词法类型名和正则表达式固定的可执行程序。
若不指定CG变量，则默认生成正常的、功能完整的可执行程序。
若要生成能够提交到希冀平台的压缩包，首先确保您已安装zip，然后可输入如下命令：
make zip CG=?其中?的范围为1～5。该命令将生成一个能够提交到希冀平台的zip压缩包。
建议使用上述命令打包，而不要自行打包。
若一定要自行打包代码提交，请先使用make release CG=?命令（?的范围为1～5）编译一次， 然后再打包，并请注意不要将*.pyc文件打包进压缩包。
若要执行本程序自带的自动测试脚本，首先确保您已安装python3，然后使用如下命令安装pytest（如已安装可以跳过）：
python -m pip install --upgrade pip
python -m pip install -r requirements.txt在某些操作系统中，您可能需要将python替换为python3。安装pytest后，可输入如下命令执行自动测试脚本：
make test若命令执行成功，则说明测试成功。
上述自测命令仅用于使用自带测试用例自测，若要使用其它测试用例请使用make release命令或make release CG=?命令构建后测试。
本项目使用Makefile管理，若要编译本项目的代码，首先确保您已安装MinGW，
并已将MinGW的bin目录添加至环境变量Path中，然后在 Git Bash （或其它 Linux Shell 中）输入如下命令：
mingw32-make release将在release目录中生成可执行文件scc.exe和默认的动态词法定义文件sc.lang。
运行时请确保上述两个文件被放置在同一个目录下。
如果您在使用 Windows 系统并使用 Visual Studio Code ，强烈建议您将它的默认 Shell 改为 Git Bash 。
修改方法可参考：https://code.visualstudio.com/docs/editor/integrated-terminal#_windows
若要生成强制固定输入输出文件名为希冀平台要求的文件名（而不是根据命令行参数）、且不支持读取动态词法定义的可执行程序，
可用环境变量CG指定希冀平台的题号（范围为1～5）。例如：
mingw32-make release CG=1将生成只进行词法分析的、输入输出文件固定的、词法类型名和正则表达式固定的可执行程序。
若不指定CG变量，则默认生成正常的、功能完整的可执行程序。
若要打包代码提交，请先使用
mingw32-make release CG=?命令（?的范围为1～5）编译一次， 然后再打包，并请注意不要将*.pyc文件打包进压缩包。
若要执行本程序自带的自动测试脚本，首先确保您已安装python3，然后使用如下命令安装pytest（如已安装可以跳过）：
python -m pip install --upgrade pip
python -m pip install -r requirements.txt安装pytest后，可输入如下命令执行自动测试脚本：
mingw32-make test若命令执行成功，则说明测试成功。
上述自测命令仅用于使用自带测试用例自测，若要使用其它测试用例请使用make release命令或make release CG=?命令构建后测试。
目前本项目分为5个模块，其中在每个模块中src为模块源码目录，build为模块构建生成的目标文件目录，
test为模块的自动测试目录，Makefile为模块的编译脚本。
另外，在本项目根目录中除了5个模块目录外还有release目录（构建生成的最终发布版本的可执行程序目录）、
build目录（构建生成的目标文件目录）、test目录 （整体自动测试目录）、Makefile（总编译脚本）。
代码的编译由Makefile管理。
各个模块如下：
是 Sub C 程序设计语言的编译器部分。各源文件的功能如下：
| 源文件 | 主要功能 |
|---|---|
| main | 程序入口 |
| lexer | 包含各个词法分析类，包含字典树(Trie)方法的词法分析与普通DFA方法的词法分析 |
| parser | 包含语法分析类，包含递归子程序法的语法分析、语义分析、中间代码优化、PCODE生成 |
| regexp | 包含对正则表达式的词法、语法、语义分析和字典树的生成，为范型类 |
| trie | 包含字典树数据结构，为范型类 |
| sc.lang | 包含各词法类型的类型码和正则表达式，支持自定义 |
| config | 包含对一些预定义参数与命令行参数的处理 |
| define | 包含一些编译选项的宏定义 |
| cg | 包含对希冀系统不支持 Makefile 的问题的处理 |
是目标代码的解释器部分。各源文件的功能如下：
| 源文件 | 主要功能 |
|---|---|
| imain | 程序入口，包含对各种命令行参数的处理 |
| interpreter | 包含各个解释器类，包含文本形式的PCODE的解释器和二进制形式的PCODE的解释器 |
| define | 包含一些编译选项的宏定义 |
是公共代码部分。各源文件的功能如下：
| 源文件 | 主要功能 |
|---|---|
| pcode | 包含二进制形式的PCODE的定义和文本形式的PCODE的定义 |
| exception | 包含各种异常类 |
| define | 包含一些编译选项的宏定义 |
是配套的集成开发环境（IDE）部分。
是相关的工具部分。
本项目中使用的正则表达式的EBNF定义如下：
<regexp> -> <expr>{'|'<expr>}
<expr> -> <item>{<item>}
<item> -> <itemChar>|'['<opt>']'['*']
<opt> -> <optItem>{<optItem>}
<optItem> -> <optChar>['-'<optChar>]
<itemChar> -> 除'[', ']', '*', '|', '\'外的ASCII在32~126之间的字符|'\'任意ASCII在32~126之间的字符
<optChar> -> 除']', '-', '\'外的ASCII在32~126之间的字符|'\'任意ASCII在32~126之间的字符
利用上述正则表达式文法，将 Sub C 程序设计语言的词法定义如下：
| 类型码 | 正则表达式 | 类型码 | 正则表达式 |
|---|---|---|---|
| INTCON | 0|[1-9][0-9]* | CHARCON | '[+\-*/_a-zA-Z0-9]' |
| STRCON | "[ !#-~]*" | CONSTTK | const |
| INTTK | int | CHARTK | char |
| VOIDTK | void | MAINTK | main |
| IFTK | if | ELSETK | else |
| DOTK | do | WHILETK | while |
| FORTK | for | SCANFTK | scanf |
| PRINTFTK | printf | RETURNTK | return |
| PLUS | + | MINU | - |
| MULT | \* | DIV | / |
| LSS | < | LEQ | <= |
| GRE | > | GEQ | >= |
| EQL | == | NEQ | != |
| SEMICN | ; | COMMA | , |
| LPARENT | ( | RPARENT | ) |
| LBRACK | \[ | RBRACK | \] |
| LBRACE | { | RBRACE | } |
| ASSIGN | = | IDENFR | [_a-zA-Z][_a-zA-Z0-9]* |
Sub C 程序设计语言的EBNF语法定义如下：
<str> -> STRCON
<program> -> [<constBlock>] [<varBlock>] {<funDef> | <voidFunDef>} <mainFun>
<constBlock> -> CONSTTK <constDef> SEMICN {CONSTTK <constDef> SEMICN}
<constDef> -> INTTK IDENFR ASSIGN <integer> {COMMA IDENFR ASSIGN <integer>} | CHARTK IDENFR ASSIGN CHARCON {COMMA IDENFR ASSIGN CHARCON}
<uinteger> -> INTCON
<integer> -> [PLUS | MINU] <uinteger>
<declareHead> -> INTTK IDENFR | CHARTK IDENFR
<varBlock> -> <varDef> SEMICN {<varDef> SEMICN}
<varDef> -> (INTTK | CHARTK) (IDENFR | IDENFR LBRACK <uinteger> RBRACK) {COMMA (IDENFR | IDENFR LBRACK <uinteger> RBRACK)}
<funDef> -> <declareHead> LPARENT <param> RPARENT LBRACE <compoundSt> RBRACE
<voidFunDef> -> VOIDTK IDENFR LPARENT <param> RPARENT LBRACE <compoundSt> RBRACE
<compoundSt> -> [<constBlock>] [<varBlock>] <statementBlock>
<param> -> (INTTK | CHARTK) IDENFR {COMMA (INTTK | CHARTK) IDENFR} | ɛ
<mainFun> -> VOIDTK MAINTK LPARENT RPARENT LBRACE <compoundSt> RBRACE
<expression> -> [PLUS | MINU] <item> {(PLUS | MINU) <item>}
<item> -> <factor> {(MULT | DIV) <factor>}
<factor> -> IDENFR | IDENFR LBRACK <expression> RBRACK | LPARENT <expression> RPARENT | <integer> | CHARCON | <funCall>
<statement> -> <conditionSt> | <loopSt> | LBRACE <statementBlock> RBRACE | <funCall> SEMICN | <voidFunCall> SEMICN | <assignSt> SEMICN | <readSt> SEMICN | <writeSt> SEMICN | SEMICN | <returnSt> SEMICN
<assignSt> -> IDENFR ASSIGN <expression> | IDENFR LBRACK <expression> RBRACK ASSIGN <expression>
<conditionSt> -> IFTK LPARENT <condition> RPARENT <statement> [ELSETK <statement>]
<condition> -> <expression> (LSS | LEQ | GRE | GEQ | EQL | NEQ) <expression> | <expression>
<loopSt> -> WHILETK LPARENT <condition> RPARENT <statement> | DOTK <statement> WHILETK LPARENT <condition> RPARENT | FORTK LPARENT IDENFY ASSIGN <expression> SEMICN <condition> SEMICN IDENFY ASSIGN IDENFY (PLUS | MINU) <step> RPARENT <statement>
<step> -> <uinteger>
<funCall> -> IDENFR LPARENT <paramVal> RPARENT
<voidFunCall> -> IDENFR LPARENT <paramVal> RPARENT
<paramVal> -> <expression> {COMMA <expression>} | ɛ
<statementBlock> -> {<statement>}
<readSt> -> SCANFTK LPARENT IDENFR {COMMA IDENFR} RPARENT
<writeSt> -> PRINTFTK LPARENT <str> COMMA <expression> RPARENT | PRINTFTK LPARENT <str> RPARENT | PRINTFTK LPARENT <expression> RPARENT
<returnSt> -> RETURNTK [LPARENT <expression> RPARENT]
PCODE 目标代码的定义如下：
| 功能码 | 选项 | OCT功能码 | 功能 |
|---|---|---|---|
| POP | 0 | 0000 | 弹出a个空间 |
| LIT | 0 | 0010 | 将常数放到栈顶 |
| LOD | 0 | 0020 | 将偏移地址为a的局部变量放到栈顶 |
| LOD | 1 | 0021 | 将偏移地址为a的全局变量放到栈顶 |
| STO | 0 | 0030 | 将栈顶弹出并保存到偏移地址为a的局部变量中 |
| STO | 1 | 0031 | 将栈顶弹出并保存到偏移地址为a的全局变量中 |
| STO | 2 | 0032 | 将栈顶保存到偏移地址为a的局部变量中 |
| STO | 3 | 0033 | 将栈顶保存到偏移地址为a的全局变量中 |
| CAL | 0 | 0040 | 调用地址为a的函数，不给返回值预留空间 |
| CAL | 2 | 0042 | 调用地址为a的函数，给返回值预留空间 |
| INT | 0 | 0050 | 分配大小为a的空间给变量 |
| JMP | 0 | 0060 | 无条件跳转至地址为a的地方 |
| JPC | 0 | 0070 | 栈顶为0则跳转至地址为a的地方 |
| OPR | 0 | 0100 | 多种无操作数的操作，见下表 |
| LDA | 0 | 0110 | 将偏移地址为(a+栈顶)的局部变量放到栈顶 |
| LDA | 1 | 0111 | 将偏移地址为(a+栈顶)的全局变量放到栈顶 |
| STO | 0 | 0120 | 将栈顶弹出并保存到偏移地址为(a+次栈顶)的局部变量中 |
| STO | 1 | 0121 | 将栈顶弹出并保存到偏移地址为(a+次栈顶)的全局变量中 |
OPR指令功能表：
| a | 功能 |
|---|---|
| 0 | 函数返回，若为最外层函数则结束运行 |
| 1 | 栈顶取反 |
| 2 | 将次栈顶加栈顶保存到次栈顶中 |
| 3 | 将次栈顶减栈顶保存到次栈顶中 |
| 4 | 将次栈顶乘栈顶保存到次栈顶中 |
| 5 | 将次栈顶除以栈顶保存到次栈顶中 |
| 6 | 判断栈顶奇偶，若为奇数栈顶置1，否则置0 |
| 7 | 栈顶取非 |
| 8 | 将次栈顶是否小于栈顶保存到次栈顶中 |
| 9 | 将次栈顶是否小于等于栈顶保存到次栈顶中 |
| 10 | 将次栈顶是否大于栈顶保存到次栈顶中 |
| 11 | 将次栈顶是否大于等于栈顶保存到次栈顶中 |
| 12 | 将次栈顶是否等于栈顶保存到次栈顶中 |
| 13 | 将次栈顶是否不等于栈顶保存到次栈顶中 |
| 14 | 输出栈顶的整数 |
| 15 | 输出换行符 |
| 16 | 输入整数到栈顶 |
| 17 | 输入字符到栈顶 |
| 18 | 输出栈顶指向的字符串常量 |
| 19 | 输出栈顶的字符 |