shecc 开源项目教程

shecc 开源项目教程

sheccA self-hosting and educational C compiler项目地址:https://gitcode.com/gh_mirrors/sh/shecc

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

shecc 项目的目录结构如下：

shecc/
├── LICENSE
├── Makefile
├── README.md
├── include/
│   ├── shecc.h
│   └── types.h
├── src/
│   ├── codegen.c
│   ├── lexer.c
│   ├── main.c
│   ├── parser.c
│   ├── symbol.c
│   └── utils.c
└── test/
    ├── test1.c
    ├── test2.c
    └── test3.c

目录介绍

• LICENSE: 项目许可证文件。
• Makefile: 用于编译项目的 Makefile 文件。
• README.md: 项目说明文档。
• include/: 包含项目头文件的目录。
  • shecc.h: 主要头文件，包含编译器的主要接口。
  • types.h: 定义项目中使用的数据类型。
• src/: 包含项目源代码的目录。
  • codegen.c: 代码生成模块。
  • lexer.c: 词法分析模块。
  • main.c: 主程序文件。
  • parser.c: 语法分析模块。
  • symbol.c: 符号表管理模块。
  • utils.c: 工具函数模块。
• test/: 包含测试文件的目录。
  • test1.c: 测试文件1。
  • test2.c: 测试文件2。
  • test3.c: 测试文件3。

2. 项目的启动文件介绍

项目的启动文件是 src/main.c。这个文件包含了编译器的主函数 main()，负责初始化编译器并启动编译过程。

// src/main.c
#include <stdio.h>
#include "../include/shecc.h"

int main(int argc, char **argv) {
    if (argc < 2) {
        fprintf(stderr, "Usage: %s <source file>\n", argv[0]);
        return 1;
    }

    // 初始化编译器
    init_compiler();

    // 编译源文件
    compile_file(argv[1]);

    // 清理资源
    cleanup_compiler();

    return 0;
}

启动文件功能

• 初始化编译器: 调用 init_compiler() 函数初始化编译器环境。
• 编译源文件: 调用 compile_file() 函数编译指定的源文件。
• 清理资源: 调用 cleanup_compiler() 函数清理编译过程中使用的资源。

3. 项目的配置文件介绍

shecc 项目没有显式的配置文件，其配置主要通过命令行参数和代码中的硬编码设置来完成。例如，编译器的输入文件通过命令行参数传递给 main() 函数。

配置方式

• 命令行参数: 通过命令行传递源文件路径，如 ./shecc test/test1.c。
• 代码硬编码: 部分配置如编译器选项可能在代码中硬编码，例如在 init_compiler() 函数中设置默认编译选项。

通过以上方式，shecc 项目实现了灵活的配置和使用。

sheccA self-hosting and educational C compiler项目地址:https://gitcode.com/gh_mirrors/sh/shecc