for 2025: remove contest, add parser stage, rename 2024->2025

Author: RenZihou

README.md

@@ -22,13 +22,11 @@ int qsort(int a[], int l, int r) {
 }
 ```
 
-2024 年秋季学期基本沿用了 2023 年秋季学期《编译原理》课程的语法规范。为了贴合课程教学内容，提升训练效果，课程组设计了比较完善的编译器框架，包括词法分析、语法分析、语义分析、中间代码生成、数据流分析、寄存器分配、目标平台汇编代码生成等步骤。每个 step 同学们都会面对一个完整的编译器流程，但不必担心，实验开始的几个 step 涉及的编译器框架知识都比较初级，随着课程实验的深入，将会循序渐进地引入各个编译器功能模块，并通过文档对相关技术进行分析介绍，便于同学们实现相关编译功能模块。
-
-从2023年起，课程组增加了大实验环节，大实验是一个**可选**环节。可以参考[大实验参考文档](docs/contest/intro.md)获取更多信息。
+2025 年秋季学期基本沿用了往年《编译原理》课程的语法规范。为了贴合课程教学内容，提升训练效果，课程组设计了比较完善的编译器框架，包括词法分析、语法分析、语义分析、中间代码生成、数据流分析、寄存器分配、目标平台汇编代码生成等步骤。每个 step 同学们都会面对一个完整的编译器流程，但不必担心，实验开始的几个 step 涉及的编译器框架知识都比较初级，随着课程实验的深入，将会循序渐进地引入各个编译器功能模块，并通过文档对相关技术进行分析介绍，便于同学们实现相关编译功能模块。
 
 ## 实验起点和基本要求
 
-本次实验一共设置 13 个步骤（其中 step 0 和 step 1 为实验框架熟悉，不需要修改框架代码）。后续的 step 2-13 我们将由易到难完成 MiniDecaf 语言的所有特性，由于编译器的边界情况很多，你**只需通过我们提供的正例与负例即可**。
+本次实验一共设置 14 个步骤（其中 step 0 和 step 1 为实验框架熟悉，不需要修改框架代码）。后续的 step 2-13 我们将由易到难完成 MiniDecaf 语言的所有特性，由于编译器的边界情况很多，你**只需通过我们提供的正例与负例即可**。此外，parser step 为同学们提供了一个上手语法分析器的机会。
 
 我们以 stage 组织实验，各个 stage 组织如下：
 
@@ -41,9 +39,11 @@ int qsort(int a[], int l, int r) {
   </li>
   <li>
     变量和赋值（step5）。在这个 stage 中你将第一次支持变量声明与赋值。
+    作用域和块语句（step6）。在这个 stage 中你的编译器将支持作用域，以便支持后续的条件和循环。
   </li>
   <li>
-    作用域和块语句（step6）。在这个 stage 中你的编译器将支持作用域，以便支持后续的条件和循环。
+    手工自顶向下语法分析器（parser step）。在这个 step 中你将实现一个手工的自顶向下语法分析器，来替代当前框架中使用的 ANTLR 生成的语法分析器。
+    这个语法分析器只需要支持前面的几个 step，在随后的各个 step 中我们仍然使用 ANTLR 生成的语法分析器。
   </li>
   <li>
     条件和循环（step7-step8）。在这个 stage 中你将支持条件判断和循环语句，此时，你的编译器可以编译的程序就从线性结构程序到了有分支结构的程序。
@@ -61,9 +61,9 @@ int qsort(int a[], int l, int r) {
 
 
 其中，stage0 为环境配置和框架学习，无需进行编程，不计入成绩。
-stage1 - stage5 为 5 个基础关卡，你需要通过它们以拿到一定的分数（35%）。
-stage6 为升级关卡，如果你学有余力，完成它们可以减少期末考试在总评中所占的比重（完整完成可以获得占总评 7% 的成绩并替代期末考试对应权重）。
-stage7 为进阶关卡，如果你依然学有余力，你可以在这里实现一些编译优化（完整完成可以获得占总评 8% 的成绩并替代期末考试对应权重）。注意，你需要在完成 stage6 后才能尝试 stage7，否则无法获得对应分数。
+stage1 - stage4 与 parser-stage 为 5 个基础关卡，你需要通过它们以拿到一定的分数（35%）。
+stage5 为升级关卡，如果你学有余力，完成它们可以减少期末考试在总评中所占的比重（完整完成可以获得占总评 7% 的成绩并替代期末考试对应权重）。
+stage6 为进阶关卡，如果你依然学有余力，你可以在这里实现一些编译优化（完整完成可以获得占总评 8% 的成绩并替代期末考试对应权重）。注意，你需要在完成 stage5 后才能尝试 stage6，否则无法获得对应分数。
 
 我们以 step 组织文档，每个 step 的文档都将以如下形式组织：首先我们会介绍当前 step 需要用到的知识点，其次我们会以一个当前 step 具有代表性的例子介绍它的整个编译流程。在之前 step 中已经介绍的知识点，我们会略过，新的知识点和技术会被详细介绍。
 
@@ -75,7 +75,7 @@ stage7 为进阶关卡，如果你依然学有余力，你可以在这里实现
 
 ## 实验提交
 
-大家在网络学堂提交 **git.tsinghua.edu.cn** 的帐号名后，助教会给每个人建立一个私有的仓库，URL 为 https://git.tsinghua.edu.cn/compiler24/stu24/minidecaf-你的学号 ，将作业提交到那个仓库即可。
+大家在网络学堂提交 **git.tsinghua.edu.cn** 的帐号名后，助教会给每个人建立一个私有的仓库，URL 为 https://git.tsinghua.edu.cn/compiler25/stu25/minidecaf-你的学号 ，将作业提交到那个仓库即可。
 每个 stage 会对应于一个 branch，当切换到一个新的 branch 上实现时，你可以用 `git checkout -b` 来创建一个新的分支。
 
 本学期我们使用清华大学代码托管服务（git.tsinghua）的 CI（持续集成）来**测试**大家的代码实现及**提交实验报告**。

SUMMARY.md

@@ -41,22 +41,27 @@
   * [通过例子学习](docs/step4/example.md)
   * [规范](docs/step4/spec.md)
 
-## Stage2：变量
+## Stage2：变量和作用域
 
 * step5：局部变量和赋值
   * [实验要求](docs/step5/intro.md)
   * [通过例子学习](docs/step5/example.md)
   * [规范](docs/step5/spec.md)
 
-## Stage3：作用域
-
 * step6：作用域和块语句
   * [实验要求](docs/step6/intro.md)
   * [通过例子学习](docs/step6/example.md)
   * [数据流分析](docs/step6/dataflow.md)
   * [规范](docs/step6/spec.md)
 
-## Stage4：条件和循环
+## Parser Stage：手工自顶向下语法分析器
+
+* parser step
+  * [实验要求](docs/step-parser/intro.md)
+  * [通过例子学习](docs/step-parser/example.md)
+  * [规范](docs/step-parser/spec.md)
+
+## Stage3：条件和循环
 
 * step7：条件语句
   * [实验要求](docs/step7/intro.md)
@@ -68,14 +73,14 @@
   * [通过例子学习](docs/step8/example.md)
   * [规范](docs/step8/spec.md)
 
-## Stage5：函数
+## Stage4：函数
 
 * step9：函数
   * [实验要求](docs/step9/intro.md)
   * [通过例子学习](docs/step9/example.md)
   * [规范](docs/step9/spec.md)
 
-## Stage6（升级）：全局变量和数组
+## Stage5（升级）：全局变量和数组
 
 * step10：全局变量
   * [实验要求](docs/step10/intro.md)
@@ -92,26 +97,14 @@
   * [通过例子学习](docs/step12/example.md)
   * [规范](docs/step12/spec.md)
 
-## Stage7（升级）：寄存器分配与代码优化
+## Stage6（升级）：寄存器分配与代码优化
 
 * [选做二说明](docs/step13/readme.md)
 
 * step13：寄存器分配算法改进
   * [实验要求](docs/step13/intro.md)
   * [实验指导](docs/step13/example.md)
 
-## 大实验参考文档
-
-* [大实验简介](docs/contest/intro.md)
-* [前端设计](docs/contest/frontend.md)
-* [中端设计](docs/contest/midend/midend.md)
-  * [中间表示设计](docs/contest/midend/ir.md)
-  * [中间代码生成](docs/contest/midend/irgen.md)
-  * [静态单赋值](docs/contest/midend/ssa.md)
-  * [常量传播](docs/contest/midend/cp.md)
-  * [死代码消除](docs/contest/midend/dce.md)
-* [后端设计](docs/contest/backend.md)
-
 ## 参考资料
 
 * [参考资料](REFERENCE.md)

docs/step-parser/spec.md

@@ -1,55 +1,69 @@
 # parser-stage 语法规范（同 step6）
 
-
 <pre id='vimCodeElement'>
 <code></code>
 <span class="SpecRuleStart">program</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">function</span>
+
 <span class="SpecRuleStart">function</span>
-<span class="SpecRuleIndicator">    :</span> <span class="SpecRule">type</span> <span class="SpecToken">Identifier</span> <span class="SpecToken">'('</span> <span class="SpecToken">')'</span> <span class="SpecToken">'{'</span> <span class="SpecRule">block_item</span><span class="SpecOperator">*</span> <span class="SpecToken">'}'</span>
+<span class="SpecRuleIndicator">    :</span> <span class="SpecRule">type</span> <span class="SpecToken">Identifier</span> <span class="SpecToken">'('</span> <span class="SpecToken">')'</span> <span class="SpecRule">compound_statement</span>
 <span class="SpecRuleStart">type</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecToken">'int'</span>
+
+<span class="SpecRuleStart">compound_statement</span>
+<span class="SpecRuleIndicator">    :</span> <span class="SpecToken">'{'</span> <span class="SpecRule">block_item</span><span class="SpecOperator">*</span> <span class="SpecToken">'}'</span>
+
 <span class="SpecRuleStart">block_item</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">statement</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">declaration</span>
+
 <span class="SpecRuleStart">statement</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecToken">'return'</span> <span class="SpecRule">expression</span> <span class="SpecToken">';'</span>
-<span class="SpecRuleIndicator">    |</span> <span class="SpecRule">expression</span><span class="SpecOperator">?</span> <span class="SpecToken">';'</span>
-<span class="SpecRuleIndicator">    |</span> <span class="SpecToken">'if'</span> <span class="SpecToken">'('</span> <span class="SpecRule">expression</span> <span class="SpecToken">')'</span> <span class="SpecRule">statement</span> <span class="SpecOperator">(</span><span class="SpecToken">'else'</span> <span class="SpecRule">statement</span><span class="SpecOperator">)?</span>
+<span class="SpecRuleIndicator">    |</span> <span class="SpecRule">compound_statement</span>
 <span class="SpecRuleStart">declaration</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">type</span> <span class="SpecToken">Identifier</span> <span class="SpecOperator">(</span><span class="SpecToken">'='</span> <span class="SpecRule">expression</span><span class="SpecOperator">)?</span> <span class="SpecToken">';'</span>
+
 <span class="SpecRuleStart">expression</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">assignment</span>
+
 <span class="SpecRuleStart">assignment</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">conditional</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecToken">Identifier</span> <span class="SpecToken">'='</span> <span class="SpecRule">expression</span>
+
 <span class="SpecRuleStart">conditional</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">logical_or</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">logical_or</span> <span class="SpecToken">'?'</span> <span class="SpecRule">expression</span> <span class="SpecToken">':'</span> <span class="SpecRule">conditional</span>
+
 <span class="SpecRuleStart">logical_or</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">logical_and</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">logical_or</span> <span class="SpecToken">'||'</span> <span class="SpecRule">logical_and</span>
+
 <span class="SpecRuleStart">logical_and</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">equality</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">logical_and</span> <span class="SpecToken">'&amp;&amp;'</span> <span class="SpecRule">equality</span>
+
 <span class="SpecRuleStart">equality</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">relational</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">equality</span> <span class="SpecOperator">(</span><span class="SpecToken">'=='</span><span class="SpecOperator">|</span><span class="SpecToken">'!='</span><span class="SpecOperator">)</span> <span class="SpecRule">relational</span>
+
 <span class="SpecRuleStart">relational</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">additive</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">relational</span> <span class="SpecOperator">(</span><span class="SpecToken">'&lt;'</span><span class="SpecOperator">|</span><span class="SpecToken">'&gt;'</span><span class="SpecOperator">|</span><span class="SpecToken">'&lt;='</span><span class="SpecOperator">|</span><span class="SpecToken">'&gt;='</span><span class="SpecOperator">)</span> <span class="SpecRule">additive</span>
+
 <span class="SpecRuleStart">additive</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">multiplicative</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">additive</span> <span class="SpecOperator">(</span><span class="SpecToken">'+'</span><span class="SpecOperator">|</span><span class="SpecToken">'-'</span><span class="SpecOperator">)</span> <span class="SpecRule">multiplicative</span>
+
 <span class="SpecRuleStart">multiplicative</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">unary</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecRule">multiplicative</span> <span class="SpecOperator">(</span><span class="SpecToken">'*'</span><span class="SpecOperator">|</span><span class="SpecToken">'/'</span><span class="SpecOperator">|</span><span class="SpecToken">'%'</span><span class="SpecOperator">)</span> <span class="SpecRule">unary</span>
+
 <span class="SpecRuleStart">unary</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecRule">primary</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecOperator">(</span><span class="SpecToken">'-'</span><span class="SpecOperator">|</span><span class="SpecToken">'~'</span><span class="SpecOperator">|</span><span class="SpecToken">'!'</span><span class="SpecOperator">)</span> <span class="SpecRule">unary</span>
+
 <span class="SpecRuleStart">primary</span>
 <span class="SpecRuleIndicator">    :</span> <span class="SpecToken">Integer</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecToken">'('</span> <span class="SpecRule">expression</span> <span class="SpecToken">')'</span>
 <span class="SpecRuleIndicator">    |</span> <span class="SpecToken">Identifier</span>
 </pre>
-

docs/step0/intro.md

@@ -1,6 +1,6 @@
 # 实验环境简介
 
-2024年秋季学期，助教给大家提供了服务器。同学们可以选择使用我们已经配置好的机器，节省一定的时间花费。
+2025 年秋季学期，助教给大家提供了服务器。同学们可以选择使用我们已经配置好的机器，节省一定的时间花费。
 
 服务器环境如下：
 - Ubuntu 23.04
@@ -15,8 +15,8 @@
 1. 如何使用 ssh 登陆服务器？
     ```bash
     ssh username@ip -p port
-    # 假如你的账号为 2024000001，服务器 ip 地址为 192.168.1.1，端口为 223，则命令为：
-    ssh 2024000001@192.168.1.1 -p 223
+    # 假如你的账号为 2023000001，服务器 ip 地址为 192.168.1.1，端口为 223，则命令为：
+    ssh 2023000001@192.168.1.1 -p 223
     ```
 2. 建议配置 ssh 免密登录，方便大家使用服务器，然后在服务器上运行。你可以参考[这里](https://blog.csdn.net/qq_51447496/article/details/132089964)。
 

docs/step0/testing.md

@@ -1,16 +1,17 @@
 ## 运行实验框架
+
 配好环境以后，我们强烈推荐你构建运行我们提供的实验框架初始代码。
 > 接下来我们会用到 git。
 > git 的安装和使用会在软件工程课上讲述，同学们也自行查阅相关资料，也可以参考[这里](https://www.liaoxuefeng.com/wiki/896043488029600) 。
 
 1. 按照本文档的前几节（[RISCV 环境配置](./riscv_env.md)和[实验框架环境配置](./env.md)）配置好实验环境。
 
-2. 助教已经为每位同学在 git.tsinghua.edu.cn 创建了一个仓库，其中 minidecaf 的[测例仓库](https://git.tsinghua.edu.cn/compiler/2024/minidecaf-tests)为其中的一个子模块，你可以通过以下指令来在克隆主仓库的同时克隆子模块 `git clone --recursive <repository>`。
+2. 助教已经为每位同学在 git.tsinghua.edu.cn 创建了一个仓库，其中 minidecaf 的[测例仓库](https://git.tsinghua.edu.cn/compiler/2025/minidecaf-tests)为其中的一个子模块，你可以通过以下指令来在克隆主仓库的同时克隆子模块 `git clone --recursive <repository>`。
 由于测例仓库会有所更新，在克隆之后你需要在主仓库目录下使用 `git submodule update --remote --merge` 来手动更新。
 
 > 注意：由于子模块使用 ssh 链接，你需要将你的 ssh 公钥添加到你的 git.tsinghua 账号上，才能将其克隆下来。
 
-3. 按照[测例](https://git.tsinghua.edu.cn/compiler/2024/minidecaf-tests)的 README 运行测试 step1，实验框架给出的初始代码可以通过 step1 的所有测例。
+3. 按照[测例](https://git.tsinghua.edu.cn/compiler/2025/minidecaf-tests)的 README 运行测试 step1，实验框架给出的初始代码可以通过 step1 的所有测例。
 
 测试运行的 **输出结果** 大致如下。