Zig 语言圣经

Appearance

zig 版本：0.12.0

函数 ​

函数是编程语言中最为基本的语句。

基本使用 ​

zig 的函数明显，你可以一眼就看出来它的组成，我们来用一个简单的函数作为说明：

zig
pub fn add(a: u8, b: u8) u8 {
    return a + b;
}

如果你有 C 的使用经验，一眼就可以看出来各自的作用。

下面来进行说明：

  1. pub 是访问修饰符，有且只有一个选择，那就是 pub，这代表着函数是公共可访问的（其他的文件import该文件后，可以直接使用这个函数）。
  2. fn 是关键字，代表着我们接下来定义了一个函数。
  3. add 是标识符，作为函数的名字。
  4. a: u8 是参数的标识符和类型，这里有两个参数，分别是 a 和 b，它们的类型均是 u8。
  5. u8 是函数的返回类型，在 zig 中，一个函数只能返回一个值。

如果没有返回值，请使用 void，zig 原则上不允许忽略函数的返回值，如果需要忽略可将返回值分配给 _，编译器将自动忽略该返回值。

🅿️ 提示

你可能注意到了有的函数定义是这样子的：

zig
fn max(comptime T: type, a: T, b: T) T {
    return if (a > b) a else b;
}

其中的 comptime T: type 你可能很陌生，这是编译期参数，它是用来实现鸭子类型（泛型）的关键语法！

关于函数命名

这里命名规则没什么强制性的要求，你只需要保证符合变量声明的 标识符规范 即可。

如果你需要一个命名的推荐规则的话，可以参照 zig 源码的命名方式，它使用的是小驼峰命名法。

WARNING

函数体和函数指针之间是有区别的，函数体是仅限编译时的类型，而函数指针可能是运行时已知的。

关于函数指针，*const fn (a: i8, b: i8) i8 就是一个函数指针类型。

参数传递 ​

参数传递是一个非常古老的问题，在高级语言的角度来看，存在着“值传递”和“引用传递”这两种情况，这无疑大大增加了程序员在编程时的心智负担。

zig 在这方面的处理则是，原始类型（整型、布尔这种）传递完全使用值传递，针对原始类型的这种策略开销非常小，通常只需要设置对应的寄存器即可。

像复合类型（结构体、联合、数组等），这些传递均是由编译器来决定究竟是使用“值传递”还是“引用传递”。

但作为开发者，只需要记住，函数的参数是不可变的 就行了。

🅿️ 提示

对于外部函数(使用 extern 修饰)，Zig 遵循 C ABI 按值传递结构和联合类型。

内建函数 ​

内建函数由编译器提供，并以 @ 为前缀。参数上的 comptime 关键字意味着该参数必须在编译期已知。

介于内建函数的数目过多，故不进行系统讲解，仅在对应章节说明涉及到的内建函数。

更多的内建函数文档请看 这里。

高阶使用 ​

anytype ​

函数参数可以用 anytype 代替类型来声明。在这种情况下，调用函数时将推断参数类型。使用 @TypeOf 和 @typeInfo 获取有关推断类型的信息。

zig
fn addFortyTwo(x: anytype) @TypeOf(x) {
    return x + 42;
}

noreturn ​

noreturn 是一个特殊的类型，它代表以下内容：

  • break
  • continue
  • return
  • unreachable
  • while (true) {}

当一个函数不会返回时，你可以使用它来代替 void。

该类型一般用在内核开发中，因为内核本身应当是一个不会退出的程序，还有一种使用场景是 exit 函数。

zig
const WINAPI = @import("std").os.windows.WINAPI;
extern "kernel32" fn ExitProcess(exit_code: c_uint) callconv(WINAPI) noreturn;

extern ​

extern 关键字保证函数可以在生成的 object 文件中可见，并且使用 C ABI。

zig
export fn sub(a: i8, b: i8) i8 {
    return a - b;
}

🅿️ 提示

extern 关键字后面带引号的标识符指定具有该函数的库，例如 c -> libc.so，callconv 说明符更改函数的调用约定。

zig
extern "c" fn atan2(a: f64, b: f64) f64;

@setCold ​

@setCold(comptime is_cold: bool) void

告诉优化器当前函数很少被调用（或不被调用），该函数仅在函数作用域内有效。

zig
fn abort() noreturn {
    @setCold(true);
    while (true) {}
}

callconv ​

callconv 关键字告诉函数的调用约定，这在对外暴露函数或者裸汇编时会很有用。

zig
// 强制该函数在所有被调用位置内联，否则失败。
inline fn shiftLeftOne(a: u32) u32 {
    return a << 1;
}

关于可以使用的调用约定格式，可以参考这里std.builtin.CallingConvention。