Verilization

Verilization 是一种用于定义二进制文件格式的序列化描述语言。与其他序列化工具（如 Protocol Buffers）不同，序列化的 Verilization 数据不具有向前或向后兼容性。相反，从旧版本格式转换变得容易，允许数据更加紧凑，并且可以更好地控制数据的底层形状。

目标

Verilization 具有以下主要目标。

• 给用户最大的文件格式控制权
• 以语言无关的方式定义格式
• 支持从旧版本格式轻松转换

其他较低层次的目标。

• 支持大整型类型
• 可以在其他语言中嵌入而不使用本地二进制文件

类型

以下类型受支持。

结构体

使用多个 版本 定义 struct 类型。每个版本定义一个字段列表。

struct Rectangle {
    version 1 {
        width: u32;
        height: u32;
    }
}

枚举

使用多个 版本 定义 enum 类型。每个版本定义一个用作情况的字段列表。枚举值由这些字段中的 exactly one 个组成。

struct StringOrInt {
    version 1 {
        str: string;
        num: int;
    }
}

外部类型

在用户代码中定义 extern 类型。类型定义、转换和编解码器必须在目标语言中实现。

extern 类型可以声明可用于该类型的文字。

extern MyString {
    literal {
        string;
    }
}

支持以下文字规范。

运行时库类型

运行时库提供了一些extern类型。

int和nat的编码定义了一个小端顺序的位序列。每个字节的最高位如果该数字有更多字节则被设置。

此编码是一个字节序列[B₀, ..., B_n]，其中当i < n时，B_i,7 = 1，并且B_n,7 = 0。这个字节序列等同于一个位序列[B_0,0, ... B_0,6, ..., B_n-1,0, ..., B_n-1,6] = [b₀, ..., b_m-1]，其中m = 6n。本质上，位序列移除了用于确定序列何时结束的标志位，并将每个字节中的剩余位从最低到最高排序。位序列映射如下

• 对于int类型，如果b_m-1 = 0，则k = b₀ * 2⁰ + ... + b_{m - 2} * 2^m-2
• 对于int类型，如果b_m-1 = 1，则k = -(b₀ * 2⁰ + ... + b_{m - 2} * 2^m-2) - 1
• 对于nat类型，k = b₀ * 2⁰ + ... + b_{m - 1} * 2^m-1

版本控制

在下面的示例中，用户有一个用户名和出生日期。

struct Person {
    version 1 {
        name: Name;
        dob: Date;
    }
}

struct Name {
    version 1 {
        firstName: string;
        middleName: option string;
        lastName: string;
    }
}

但是，并非每个人都有2个或3个名字。为了适应这种情况，我们可以创建一个新的版本，允许任意数量的名字。

struct Name {
    version 1 {
        ...
    }
    version 2 {
        names: list string;
    }
}

对Name的这种改变意味着在格式的版本2中，Person的name字段现在将使用Name的版本2。然而，由于没有对Person的直接更改，版本2是自动创建的。在生成的代码中，预期用户将提供代码以将Name从版本1升级到版本2。但是，没有必要为升级Person提供此类代码。Person可以通过其字段的升级代码自动升级。

最终

可以通过将版本化类型声明为final来表示不会添加该类型的任何新版本。这限制了类型到最后显式声明的版本，防止自动生成新版本。最终类型只能包含最终或非版本化类型的字段。

final struct FormatVersion {
    version 1 {
        major: nat;
    }
}

泛型

泛型类型允许类型参数化。

final struct Pair(A, B) {
    version 1 {
        left: A;
        right: B;
    }
}

常量

常量允许定义在生成语言之间共享的值。

命令行

Verilization 具有命令行界面。以下选项受到支持。

语言生成器

以下语言受到支持。

• TypeScript
• Java
• Scala

编译器绑定

Verilization 编译器是用 Rust 编写的。它可以编译成 WebAssembly 以在其他语言中使用。这具有优势，即工具可以分发（例如，作为 NPM 软件包、独立 JAR 等），而不需要任何本地二进制文件。这些绑定公开了可以直接从运行时使用的界面，以及仅依赖于相关运行时的命令行界面。

目前，以下运行时存在绑定。

• Node