首页
/ Roy 项目技术文档

Roy 项目技术文档

2024-12-24 05:32:06作者:毕习沙Eudora

1. 安装指南

环境准备

在开始安装 Roy 之前,请确保您的系统已经安装了以下工具:

  • make
  • gccclang
  • node.js(建议使用最新版本)

安装步骤

  1. 克隆项目仓库到本地:
    git clone https://github.com/puffnfresh/roy.git
    
  2. 进入项目目录:
    cd roy
    
  3. 安装依赖:
    make deps
    
  4. 编译项目:
    make
    

2. 项目的使用说明

编译 .roy 文件

要编译一个 .roy 文件并生成对应的 .js 文件,可以使用以下命令:

./roy examples/helloworld.roy

编译完成后,生成的 JavaScript 文件将位于同一目录下,文件名为 helloworld.js

运行 .roy 文件

要编译并立即运行一个 .roy 文件,可以使用以下命令:

./roy -r examples/helloworld.roy

进入 REPL 模式

要进入 Roy 的交互式 REPL 模式,可以直接运行:

./roy

在 REPL 模式下,您可以输入 Roy 代码并立即查看结果。

3. 项目 API 使用文档

基本语法

Roy 是一种小型的函数式编程语言,具有以下主要特性:

  • Damas-Hindley-Milner 类型推导:自动推导变量类型。
  • 空格敏感语法:代码的缩进和空格会影响语法解析。
  • 简单标记联合:支持简单的联合类型。
  • 模式匹配:通过模式匹配处理不同的情况。
  • 结构化类型:支持结构化类型系统。
  • Monad 语法:支持 Monad 语法。
  • 非丑陋的 JS 输出:生成的 JavaScript 代码可读性较好。

示例代码

以下是一个简单的 Roy 代码示例:

let addTwo n =
    n + 2

console.log (addTwo 40)

编译后的 JavaScript 代码如下:

var addTwo = function(n) {
    return n + 2;
}
console.log(addTwo(40))

类型检查

Roy 在编译时会进行严格的类型检查。例如,如果您尝试调用 addTwo 函数时传入一个字符串,将会在编译时报错:

addTwo "test"

编译时错误信息:

Type error: Expected Number, got String

4. 项目安装方式

从源码安装

  1. 克隆项目仓库:
    git clone https://github.com/puffnfresh/roy.git
    
  2. 进入项目目录:
    cd roy
    
  3. 安装依赖并编译:
    make deps
    make
    

使用预编译二进制文件

如果您不想从源码编译,可以下载预编译的二进制文件。请访问项目 GitHub 仓库的发布页面,下载适合您操作系统的二进制文件,并将其放置在系统的 PATH 路径中。

使用包管理器安装

Roy 也可以通过一些包管理器进行安装,具体方法请参考项目官方文档。


通过以上文档,您应该能够顺利安装、使用 Roy 项目,并了解其基本 API 的使用方法。如有更多问题,请参考项目官方文档或社区资源。

登录后查看全文
热门项目推荐
相关项目推荐