Compiler Explorer 技术文档

1. 安装指南

环境要求

• Node.js: 需要安装 node 20 版本。可以通过环境变量 NODE_DIR 指定 node 的路径。
• 操作系统: 支持 Linux 系统。

安装步骤

1. 克隆项目:

   git clone https://github.com/compiler-explorer/compiler-explorer.git
   cd compiler-explorer
   

2. 安装依赖:

   make
   

   或者使用 npm 安装依赖：

   npm install
   

3. 运行项目:

   make dev
   

   或者使用 npm 运行：

   npm run dev
   

4. 访问本地实例: 打开浏览器，访问 http://localhost:10240/。

2. 项目的使用说明

基本功能

Compiler Explorer 是一个交互式编译器探索网站，支持多种编程语言（如 C, C++, C#, F#, Rust, Go, D, Haskell, Swift, Pascal, ispc, Python, Java 等）。用户可以在网站上编写代码，并实时查看编译后的汇编代码。

高级功能

• 多编译器支持: 每个语言支持多个编译器。
• 工具和可视化: 提供多种工具和可视化功能。
• UI 布局配置: 使用 GoldenLayout 实现 UI 布局的可配置性。

常见问题

项目提供了 FAQ 部分，用户可以在 FAQ 中查找常见问题的解答。

视频教程

项目提供了多个视频教程，详细介绍了 Compiler Explorer 的使用和安装方法。

3. 项目API使用文档

RESTful API

Compiler Explorer 提供了一个简单的 RESTful API，用于编译代码和列出编译器。

编译代码

• URL: /api/compiler/{compilerId}/compile
• 方法: POST
• 请求参数:
  • source: 源代码
  • options: 编译选项
• 响应:
  • 返回编译后的汇编代码

列出编译器

• URL: /api/compilers
• 方法: GET
• 响应:
  • 返回支持的编译器列表

API 文档

完整的 API 文档可以在 API.md 中找到。

4. 项目安装方式

本地安装

1. 克隆项目:

   git clone https://github.com/compiler-explorer/compiler-explorer.git
   cd compiler-explorer
   

2. 安装依赖:

   make
   

   或者使用 npm 安装依赖：

   npm install
   

3. 运行项目:

   make dev
   

   或者使用 npm 运行：

   npm run dev
   

自定义编译器

如果需要使用自定义的 GCC 或其他编译器，可以编辑 etc/config/LANG.defaults.properties 文件，或者创建一个新的 LANG.local.properties 文件。

离线环境部署

在完全离线环境中部署时，可能需要移除从 www.godbolt.ms@443 拉取的部分配置。

替换 URL 缩短服务

在企业环境中，可以通过添加新的模块来替换默认的 URL 缩短服务。具体方法是在 lib/shortener/myservice.js 中添加新模块，并在配置中设置 urlShortenService 变量。

---

通过以上文档，用户可以详细了解 Compiler Explorer 的安装、使用和 API 调用方法。