C2Compiler 项目教程

1. 项目的目录结构及介绍

C2Compiler 项目的目录结构如下：

c2compiler/
├── analyser/
├── analyser_utils/
├── ast/
├── ast_utils/
├── bootstrap/
├── common/
├── compiler/
├── generator/
├── parser/
├── plugins/
├── test/
├── tools/
├── .clang-format
├── .gitignore
├── INSTALL.md
├── LICENSE
├── README.md
├── c2c
├── c2recipe.yaml
├── env.sh
├── install_plugins.sh
└── recipe.txt

目录介绍

• analyser/: 包含代码分析相关的文件。
• analyser_utils/: 包含代码分析工具的辅助文件。
• ast/: 包含抽象语法树（AST）相关的文件。
• ast_utils/: 包含 AST 工具的辅助文件。
• bootstrap/: 包含引导编译器所需的文件。
• common/: 包含通用工具和辅助文件。
• compiler/: 包含编译器核心代码。
• generator/: 包含代码生成相关的文件。
• parser/: 包含解析器相关的文件。
• plugins/: 包含编译器插件相关的文件。
• test/: 包含测试相关的文件。
• tools/: 包含编译器工具和辅助脚本。
• .clang-format: 代码格式化配置文件。
• .gitignore: Git 忽略文件配置。
• INSTALL.md: 安装指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• c2c: 编译器可执行文件。
• c2recipe.yaml: 编译器配置文件。
• env.sh: 环境配置脚本。
• install_plugins.sh: 插件安装脚本。
• recipe.txt: 编译器构建配置文件。

2. 项目的启动文件介绍

启动文件

• c2c: 这是 C2 编译器的主可执行文件。通过运行 ./c2c 可以启动编译器。

启动步骤

1. 引导编译器: 首先需要引导编译器。运行以下命令：

   make -C bootstrap
   

   这将生成一个引导版本的 c2c 编译器，并将其输出到 output/ 目录。

2. 运行编译器: 引导完成后，可以通过以下命令运行编译器：

   ./output/c2c
   

3. 项目的配置文件介绍

配置文件

• c2recipe.yaml: 这是编译器的主要配置文件，用于定义编译器的各种配置选项。
• env.sh: 环境配置脚本，用于设置编译器运行所需的环境变量。
• install_plugins.sh: 插件安装脚本，用于安装编译器插件。
• recipe.txt: 编译器构建配置文件，用于定义编译器的构建选项。

配置文件使用

1. c2recipe.yaml: 该文件包含了编译器的各种配置选项，如插件路径、编译选项等。可以通过编辑该文件来定制编译器的行为。

2. env.sh: 运行该脚本可以设置编译器运行所需的环境变量，如插件路径等。运行命令如下：

   source env.sh
   

3. install_plugins.sh: 运行该脚本可以安装编译器插件。运行命令如下：

   ./install_plugins.sh
   

4. recipe.txt: 该文件用于定义编译器的构建选项。可以通过编辑该文件来定制编译器的构建过程。

通过以上步骤，您可以成功安装和配置 C2Compiler 项目，并开始使用它进行 C2 语言的编译工作。