Skip to content

Latest commit

 

History

History
115 lines (71 loc) · 5.58 KB

README.zh.md

File metadata and controls

115 lines (71 loc) · 5.58 KB

MoonBit 编译器

MoonBit | 文档 | 概览 | 标准库

这里是 MoonBit 的编译器。MoonBit 是一个用户友好，构建快，产出质量高的编程语言。

路线图

构建一个编程语言是一个漫长的旅程。Rust 和 Go 分别用了 9 年和 5 年到达 1.0 版本。MoonBit 由一个年轻而有干劲的团队开发，正在稳步前进。我们明白，社区的采用和扩展对编程语言来说十分关键，并且我们也致力于打造一个围绕 MoonBit 的积极参与、合作共赢的社区。到目前为止，我们已经开源了标准库和绝大多数工具，包括构建系统，词法分析，markdown 解析等，将来还会有更多项目。开放编译器源代码对于安全来说十分重要。开源 Wasm 后端是重要一步，并且我们计划在将来开源更多组件（ moonfmt、moondoc ）。

从源代码构建

开发环境

MoonBit 必须升级/降级到特定版本，因为语言的语法已经改变。

构建

使用下列脚本构建:

opam switch create 4.14.2
opam install -y dune
dune build -p moonbit-lang

使用

MoonBit 的核心库一般安装在 ~/.moon/lib/core 下。在下面的命令中，我们会用 $core 表示核心库的安装路径。你可以选择 riscv 或 wasm-gc 作为编译目标，我们用 $target 表示这两者之一。值得注意的是，目前 riscv 只会产生 SSA 文件，而不会产生汇编代码。

$src 表示源代码的路径；在这个文件夹下，除了源代码之外还必须包括一个 moon.pkg.json。如果你不清楚如何编写这个文件，可以考虑使用 moon 来初始化。

我们用 $obj 表示中间文件生成的地方。它们一般以 .core 或者 .mi 作为后缀。

我们用 $dest 表示目标文件生成的地方。它可以是 .wat 或 .wasm，但不允许其他后缀。

为了搭建运行环境，请执行如下命令（只需要执行一次）:

# 移除已经安装的核心库
rm -rf $core

# 安装指定的版本
git clone https://github.com/moonbitlang/core.git $core
git checkout 4660d8b

# 编译
moon bundle --source-dir $core

我们强烈建议使用上面的命令重新编译一次标准库。已经构建好的二进制文件可能和这个编译器不兼容。

执行完成后，你应当能在 $core/target/ 下发现文件夹 wasm-gc。

现在你可以使用这些命令来编译 .mbt 文件:

# 即使 $target 是 `riscv`，也依然可以使用这个路径。
# 这是因为 bundle 文件夹的内容是中间表示 (IR)，它和编译目标无关。
bundled=$core/target/wasm-gc/release/bundle

# 这里 main.mbt 是一个含有 `fn main` 的文件。
moonc build-package $src/main.mbt -is-main -std-path $core/target/$bundled -o $obj -target $target

# 如果有不止一个包，别忘了在 -pkg-sources 里指定所有包的路径。
moonc link-core $bundled/core.core $obj -o $dest -pkg-config-path $src/moon.pkg.json -pkg-sources $core:$src -target $target

执行后，$dest 就是编译好的目标代码了。

如果你仍有疑问，可以参考 moon run --dry-run 的输出。

贡献

这个项目正在快速演进，因此还没有准备好接受大量社区贡献。

如果你有兴趣贡献，首先，十分感谢！

请签署 CLA。 对于小的 Bug 修复，欢迎向我们的邮箱发送补丁。对于大的贡献，推荐先在我们的论坛进行讨论。

许可证

MoonBit 采用 MoonBit Public License，一个放宽的 SSPL (Server Side Public License)。有两个关键的区别：

  • 用户可以任意选择许可证来对 MoonBit 编译器构建的产物进行许可。用户可以自由使用他们的 MoonBit 源代码以及生成的产物。
  • 允许以非商业目的对编译器的修改。

虽然我们拥抱开放，出于下列两个原因，我们没有选择完全开放的许可证，而是选择了放宽后的 SSPL:

  • MoonBit 依然在 beta-preview 的阶段。在这个阶段引入分叉可能影响项目的稳定。我们希望达到一个更成熟、更稳定的状态后接受社区贡献。
  • 我们希望避免大型云服务商利用团队的成果进行商业化。

在过去两年中，我们的团队努力改进 MoonBit 和它的工具链，始终守护我们的愿景：开发一个快速、简单、高效的编程语言。通过开源 MoonBit，我们希望可以让我们的用户相信，我们致力于 MoonBit 的增长和创新。我们同时希望我们的用户可以放心，MoonBit 不会采用 open-core 的模式，所有的 MoonBit 用户都会获得最好的开发编译器和 IDE 支持。 MoonBit 团队的愿景是通过云平台服务以及硬件 SDK 等来获得持续增长。

致谢

我们十分感谢社区对我们的支持。
特别感谢 Jane Street 的优秀的 PPX 库，这个仓库使用了一些他们的 PPX 函数。