# cangjie_compiler **Repository Path**: Joeyscat/cangjie_compiler ## Basic Information - **Project Name**: cangjie_compiler - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: dev - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-08-16 - **Last Updated**: 2025-08-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 仓颉编程语言 ## 简介 仓颉编程语言是一种面向全场景应用开发的通用编程语言，可以兼顾开发效率和运行性能，并提供良好的编程体验。仓颉语言具有语法简明高效、多范式编程、类型安全等特点，了解更多仓颉语言的介绍，请参阅 [仓颉语言开发指南](https://cangjie-lang.cn/docs?url=%2F1.0.0%2Fuser_manual%2Fsource_zh_cn%2Ffirst_understanding%2Fbasic.html) 以及 [仓颉编程语言白皮书](https://cangjie-lang.cn/docs?url=%2F0.53.18%2Fwhite_paper%2Fsource_zh_cn%2Fcj-wp-abstract.html)。 本仓提供了仓颉编译器源码及 cjdb 调试工具源码，仓颉编译器的整体框架及编译流程如下图展示： ![架构图](figures/Compiler_Architecture_Diagram_zh.png) ## 目录结构 ```text cangjie_compiler/ ├── build.py # 编译器源码构建脚本 ├── cmake # cmake文件夹，用于保存构建辅助脚本 ├── include # 头文件文件夹 ├── integration_build # 仓颉SDK集成构建脚本 ├── schema # 用于保存 FlatBuffers Schema 序列化数据结构文件 ├── src # 编译器源码文件夹 │ ├── AST # 抽象语法树相关内容 │ ├── Basic # 编译器基础组件 │ ├── CHIR # 编译器中间层，该阶段对代码进行优化分析 │ ├── CodeGen # 代码生成，将 CHIR 翻译为 LLVMIR │ ├── ConditionalCompilation # 条件编译 │ ├── Demangle # 符号还原 │ ├── Driver # 编译器流程驱动，用于启动前端以及调用后端命令 │ ├── Frontend # 编译器实例类，组织编译器流程 │ ├── FrontendTool # 提供给周边工具的编译器实例类 │ ├── IncrementalCompilation # 增量编译 │ ├── Lex # 词法分析 │ ├── Macro # 宏展开 │ ├── main.cpp # 编译器入口 │ ├── Mangle # 符号改名 │ ├── MetaTransformation # 元编程编译器插件 │ ├── Modules # 包管理模块 │ ├── Option # 编译器选项控制 │ ├── Parse # 语法分析 │ ├── Sema # 语义分析 │ └── Utils # 公共组件 ├── third_party # 依赖的三方库构建脚本及依赖库 patch 文件 │ ├── cmake # 三方库 cmake 构建辅助脚本 │ ├── llvmPatch.diff # llvm 后端 patch 文件，包含 llvm 及 cjdb 相关源码 │ └── flatbufferPatch.diff # flatbuffer 源码 patch 文件 ├── unittests # 单元测试用例 └── utils # 编译器周边组件 ``` ## 约束 支持在 Ubuntu/MacOS(x86_64, aarch64) 环境中对仓颉编译器进行构建。更详细的环境及工具依赖请参阅 [构建依赖工具](https://gitcode.com/Cangjie/cangjie_build/blob/dev/docs/env_zh.md)。 ## 编译构建 > **注意：** > > 此章节描述了如何从源码对仓颉编译器进行构建。如果您期望使用仓颉编译器编译仓颉源代码或项目，请忽略此章节并移步 [仓颉官方网站下载页](https://cangjie-lang.cn/download) 下载发布包或参阅 [集成构建指导](#集成构建指导) 章节进行集成构建。 ### 构建准备 在各个平台构建编译器所需的环境要求及软件依赖请参阅 [独立构建指导书](doc/Standalone_Build_Guide.md)。 下载源码： ```shell git clone https://gitcode.com/Cangjie/cangjie_compiler.git -b main; ``` ### 构建步骤 ```shell cd cangjie_compiler python3 build.py clean python3 build.py build -t release python3 build.py install ``` 1. `clean` 命令用于清空工作区临时文件； 2. `build` 命令开始执行编译，选项 `-t` 即 `--build-type`，指定编译产物类型，可以是 `release`、 `debug` 或 `relwithdebinfo`； 3. `install` 命令将编译产物安装到 `output` 目录下。 `output` 目录结构如下： ```text ./output ├── bin │   ├── cjc # 仓颉编译器可执行文件 │   └── cjc-frontend -> cjc # 仓颉编译器前端可执行文件 ├── envsetup.sh # 一键环境变量配置脚本 ├── include # 编译前端对外头文件 ├── lib # 仓颉编译产物依赖库，子文件夹按照目标平台拆分 ├── modules # 仓颉标准库 cjo 文件预留文件夹，子文件夹按照目标平台拆分 ├── runtime # 仓颉编译产物依赖运行时库 ├── third_party # llvm 等第三方依赖二进制及库 └── tools # 仓颉工具文件夹 ``` Linux 环境下可通过 `source ./output/envsetup.sh` 命令应用 cjc 环境，执行 `cjc -v` 查看当前编译器版本信息及 cjc 的平台信息： ```shell source ./output/envsetup.sh cjc -v ``` 输出如下： ```text Cangjie Compiler: x.xx.xx (cjnative) Target: xxxx-xxxx-xxxx ``` ### 执行 unittest 单元测试用例 单元测试用例在编译构建时默认构建，构建成功后通过以下指令进行验证： ```shell python3 build.py test ``` ### 更多构建选项 如需了解更多构建选项，请参阅 [build.py 构建脚本](./build.py) 或通过 `--help` 选项查看。 ```shell python3 build.py --help ``` 如需了解更多平台编译，请参阅 [独立构建指导书](doc/Standalone_Build_Guide.md)。 ### 集成构建指导 集成构建请参阅 [仓颉 SDK 集成构建指导书](https://gitcode.com/Cangjie/cangjie_build/blob/dev/README_zh.md)。 ## 相关仓 本仓为仓颉编译器源码，完整的编译器组件还包含： - [仓颉语言开发指南](https://gitcode.com/Cangjie/cangjie_docs/tree/main/docs/dev-guide)：提供仓颉语言开发使用指南； - [仓颉语言标准库](https://gitcode.com/Cangjie/cangjie_runtime/tree/main/std)：提供仓颉标准库源码； - [仓颉运行时](https://gitcode.com/Cangjie/cangjie_runtime/tree/main/runtime)：提供仓颉语言所必需的标准库代码； - [仓颉工具](https://gitcode.com/Cangjie/cangjie_tools/tree/main)：提供仓颉工具套，包含代码格式化、包管理等工具。 ## 使用的开源软件声明 | 开源软件名称 | 开源许可协议 | 使用说明 | 使用主体 | 使用方式 | |---------------------|---------------------------------------------|-------------------------------------------------------------------------------------------|-----------------------|----------------------| | mingw-w64 | Zope Public License V2.1 | 仓颉 Windows 版本 SDK 携带 Mingw 中的部分静态库文件，与仓颉代码生成的目标文件链接在一起，为用户生成最终的可以调用 Windows API 的可执行二进制文件 | 编译器 | 集成到仓颉二进制发布包中 | | LLVM | Apache 2.0 with LLVM Exception | 仓颉编译器后端基于 llvm 开发实现 | 编译器 | 集成到仓颉二进制发布包中 | | libxml2 | MIT License | 仓颉调试器基于 lldb 实现，本软件是 lldb 的依赖软件 | 调试器 | 集成到仓颉二进制发布包中 | | libedit | BSD 3-Clause License | 仓颉调试器基于 lldb 实现，本软件是 lldb 的依赖软件 | 调试器 | 集成到仓颉二进制发布包中 | | ncurses | MIT License | 仓颉调试器基于 lldb 实现，lldb 依赖 libedit，libedit 依赖本软件 | 调试器 | 集成到仓颉二进制发布包中 | | flatbuffers | Apache License V2.0 | 仓颉的 cjo 文件和宏实现依赖该软件进行序列化和反序列化 | 编译器和标准库(std.ast) | 集成到仓颉二进制发布包中 | | PCRE2 | BSD 3-Clause License | 标准库中的正则库基于该软件封装实现 | 标准库(std.regex) | 集成到仓颉二进制发布包中 | | zlib | zlib/libpng License | 扩展库中的压缩库基于该软件封装实现 | 扩展库(compress.zlib) | 集成到仓颉二进制发布包中 | | libboundscheck | Mulan Permissive Software License Version 2 | 编译器等相关代码基于该软件实现 | 编译器、标准库、扩展库 | 集成到仓颉二进制发布包中 | | JSON for Modern C++ | MIT License | 语言服务中用于报文解析和封装 | 语言服务 | 集成到仓颉二进制发布包中 | | OpenSSL | Apache License V2.0 | 扩展库中的 HTTP 和 TLS 封装该软件的接口 | 扩展库(net.http、net.tls) | 作为构建工具使用，不会集成到仓颉二进制包 |