zig-comptime

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Zig comptime

Zig comptime

Purpose

用途

Guide agents through Zig's
comptime
system: compile-time function evaluation, comptime type parameters, generics via
anytype
, type reflection with
@typeInfo
, and metaprogramming patterns that replace C++ templates and macros.
指导开发者掌握Zig的
comptime
系统:编译时函数求值、comptime类型参数、基于
anytype
的泛型、借助
@typeInfo
的类型反射,以及可替代C++模板和宏的元编程模式。

Triggers

触发场景

  • "How does comptime work in Zig?"
  • "How do I write a generic function in Zig?"
  • "How do I use @typeInfo for reflection?"
  • "How do I generate code at compile time in Zig?"
  • "How does anytype work in Zig?"
  • "How do Zig generics compare to C++ templates?"
  • "Zig中的comptime是如何工作的?"
  • "我该如何在Zig中编写泛型函数?"
  • "我该如何使用@typeInfo进行反射?"
  • "我该如何在Zig中生成编译时代码?"
  • "Zig中的anytype是如何工作的?"
  • "Zig泛型与C++模板相比有何不同?"

Workflow

操作流程

1. comptime basics

1. comptime基础

zig
// comptime keyword forces compile-time evaluation
const x: comptime_int = 42;         // comptime integer (arbitrary precision)
const y: comptime_float = 3.14159;  // comptime float (arbitrary precision)

// comptime block — runs at compile time
comptime {
    const val = fibonacci(20);       // computed at compile time
    std.debug.assert(val == 6765);   // compile-time assertion
}

// comptime parameter — caller must provide a comptime-known value
fn makeArray(comptime T: type, comptime n: usize) [n]T {
    return [_]T{0} ** n;             // array of n zeros of type T
}

const arr = makeArray(f32, 8);      // [8]f32 computed at compile time
zig
// comptime关键字强制进行编译时求值
const x: comptime_int = 42;         // comptime整数(任意精度)
const y: comptime_float = 3.14159;  // comptime浮点数(任意精度)

// comptime代码块 — 在编译时运行
comptime {
    const val = fibonacci(20);       // 编译时计算结果
    std.debug.assert(val == 6765);   // 编译时断言
}

// comptime参数 — 调用者必须提供编译时已知的值
fn makeArray(comptime T: type, comptime n: usize) [n]T {
    return [_]T{0} ** n;             // 生成包含n个T类型零值的数组
}

const arr = makeArray(f32, 8);      // [8]f32在编译时生成

2. Generic functions with comptime type parameters

2. 基于comptime类型参数的泛型函数

zig
const std = @import("std");

// Generic max function — T must be comptime-known
fn max(comptime T: type, a: T, b: T) T {
    return if (a > b) a else b;
}

// Usage: T is inferred from arguments or specified explicitly
const r1 = max(i32, 3, 7);          // 7
const r2 = max(f64, 2.5, 1.8);     // 2.5

// Generic Stack data structure
fn Stack(comptime T: type) type {
    return struct {
        items: []T,
        top: usize,
        allocator: std.mem.Allocator,

        const Self = @This();

        pub fn init(allocator: std.mem.Allocator) !Self {
            return Self{
                .items = try allocator.alloc(T, 64),
                .top = 0,
                .allocator = allocator,
            };
        }

        pub fn push(self: *Self, value: T) void {
            self.items[self.top] = value;
            self.top += 1;
        }

        pub fn pop(self: *Self) ?T {
            if (self.top == 0) return null;
            self.top -= 1;
            return self.items[self.top];
        }

        pub fn deinit(self: *Self) void {
            self.allocator.free(self.items);
        }
    };
}

// Usage: Stack(i32) and Stack(f64) are distinct types
var int_stack = try Stack(i32).init(allocator);
defer int_stack.deinit();
int_stack.push(42);
zig
const std = @import("std");

// 泛型max函数 — T必须是编译时已知类型
fn max(comptime T: type, a: T, b: T) T {
    return if (a > b) a else b;
}

// 使用方式:T可从参数推断或显式指定
const r1 = max(i32, 3, 7);          // 7
const r2 = max(f64, 2.5, 1.8);     // 2.5

// 泛型Stack数据结构
fn Stack(comptime T: type) type {
    return struct {
        items: []T,
        top: usize,
        allocator: std.mem.Allocator,

        const Self = @This();

        pub fn init(allocator: std.mem.Allocator) !Self {
            return Self{
                .items = try allocator.alloc(T, 64),
                .top = 0,
                .allocator = allocator,
            };
        }

        pub fn push(self: *Self, value: T) void {
            self.items[self.top] = value;
            self.top += 1;
        }

        pub fn pop(self: *Self) ?T {
            if (self.top == 0) return null;
            self.top -= 1;
            return self.items[self.top];
        }

        pub fn deinit(self: *Self) void {
            self.allocator.free(self.items);
        }
    };
}

// 使用方式:Stack(i32)和Stack(f64)是不同的类型
var int_stack = try Stack(i32).init(allocator);
defer int_stack.deinit();
int_stack.push(42);

3. anytype — duck-typed comptime parameters

3. anytype — 鸭子类型的comptime参数

anytype
accepts any type and the compiler infers it at the call site:
zig
// anytype: function works for any type with .len field
fn printLength(thing: anytype) void {
    std.debug.print("Length: {}\n", .{thing.len});
}

printLength("hello");                // string literal — works
printLength([_]u8{1, 2, 3});        // array — works
printLength(std.ArrayList(u32){});   // ArrayList — works

// anytype with comptime checks for better errors
fn serialize(writer: anytype, value: anytype) !void {
    // Verify writer has write method at comptime
    if (!@hasDecl(@TypeOf(writer), "write")) {
        @compileError("writer must have a write method");
    }
    try writer.write(std.mem.asBytes(&value));
}

// anytype in struct methods (used throughout std library)
pub fn format(
    self: MyType,
    comptime fmt: []const u8,
    options: std.fmt.FormatOptions,
    writer: anytype,    // any writer: file, buffer, etc.
) !void {
    try writer.print("{} {}", .{self.x, self.y});
}
anytype
接受任意类型,编译器会在调用点自动推断类型:
zig
// anytype:函数适用于所有带有.len字段的类型
fn printLength(thing: anytype) void {
    std.debug.print("长度:{}\n", .{thing.len});
}

printLength("hello");                // 字符串字面量 — 可正常运行
printLength([_]u8{1, 2, 3});        // 数组 — 可正常运行
printLength(std.ArrayList(u32){});   // ArrayList — 可正常运行

// 带有编译时检查的anytype,以提供更友好的错误提示
fn serialize(writer: anytype, value: anytype) !void {
    // 在编译时验证writer是否有write方法
    if (!@hasDecl(@TypeOf(writer), "write")) {
        @compileError("writer必须包含write方法");
    }
    try writer.write(std.mem.asBytes(&value));
}

// 结构体方法中的anytype(标准库中广泛使用)
pub fn format(
    self: MyType,
    comptime fmt: []const u8,
    options: std.fmt.FormatOptions,
    writer: anytype,    // 任意writer:文件、缓冲区等
) !void {
    try writer.print("{} {}", .{self.x, self.y});
}

4. Type reflection with @typeInfo

4. 借助@typeInfo的类型反射

@typeInfo
returns a tagged union describing a type's structure at comptime:
zig
const std = @import("std");
const TypeInfo = std.builtin.Type;

fn printTypeInfo(comptime T: type) void {
    const info = @typeInfo(T);
    switch (info) {
        .Int => |i| std.debug.print("Int: {} bits, {s}\n",
            .{i.bits, @tagName(i.signedness)}),
        .Float => |f| std.debug.print("Float: {} bits\n", .{f.bits}),
        .Struct => |s| {
            std.debug.print("Struct with {} fields:\n", .{s.fields.len});
            inline for (s.fields) |field| {
                std.debug.print("  {s}: {}\n", .{field.name, field.type});
            }
        },
        .Enum => |e| {
            std.debug.print("Enum with {} values:\n", .{e.fields.len});
            inline for (e.fields) |field| {
                std.debug.print("  {s} = {}\n", .{field.name, field.value});
            }
        },
        .Optional => |o| std.debug.print("Optional({s})\n", .{@typeName(o.child)}),
        .Array => |a| std.debug.print("[{}]{s}\n", .{a.len, @typeName(a.child)}),
        else => std.debug.print("Other type: {s}\n", .{@typeName(T)}),
    }
}

// Usage at comptime
comptime { printTypeInfo(u32); }   // Int: 32 bits, unsigned
comptime { printTypeInfo(f64); }   // Float: 64 bits
@typeInfo
会在编译时返回一个标记联合,描述类型的结构:
zig
const std = @import("std");
const TypeInfo = std.builtin.Type;

fn printTypeInfo(comptime T: type) void {
    const info = @typeInfo(T);
    switch (info) {
        .Int => |i| std.debug.print("整数:{}位,{s}\n",
            .{i.bits, @tagName(i.signedness)}),
        .Float => |f| std.debug.print("浮点数:{}位\n", .{f.bits}),
        .Struct => |s| {
            std.debug.print("结构体,包含{}个字段:\n", .{s.fields.len});
            inline for (s.fields) |field| {
                std.debug.print("  {s}:{}\n", .{field.name, field.type});
            }
        },
        .Enum => |e| {
            std.debug.print("枚举,包含{}个值:\n", .{e.fields.len});
            inline for (e.fields) |field| {
                std.debug.print("  {s} = {}\n", .{field.name, field.value});
            }
        },
        .Optional => |o| std.debug.print("可选类型({s})\n", .{@typeName(o.child)}),
        .Array => |a| std.debug.print("[{}]{s}\n", .{a.len, @typeName(a.child)}),
        else => std.debug.print("其他类型:{s}\n", .{@typeName(T)}),
    }
}

// 在编译时使用
comptime { printTypeInfo(u32); }   // 整数:32位,unsigned
comptime { printTypeInfo(f64); }   // 浮点数:64位

5. Comptime-generated code patterns

5. 编译时代码生成模式

zig
// Generate a lookup table at comptime
const sin_table = blk: {
    const N = 256;
    var table: [N]f32 = undefined;
    @setEvalBranchQuota(10000);     // increase for expensive comptime eval
    for (0..N) |i| {
        const angle = @as(f32, @floatFromInt(i)) * (2.0 * std.math.pi / N);
        table[i] = @sin(angle);
    }
    break :blk table;
};

// Comptime string processing
fn upperCase(comptime s: []const u8) [s.len]u8 {
    var result: [s.len]u8 = undefined;
    for (s, 0..) |c, i| {
        result[i] = std.ascii.toUpper(c);
    }
    return result;
}
const HELLO = upperCase("hello");  // computed at compile time

// Structural typing: accept any struct with specific fields
fn area(shape: anytype) f64 {
    const T = @TypeOf(shape);
    if (@hasField(T, "width") and @hasField(T, "height")) {
        return @as(f64, shape.width) * @as(f64, shape.height);
    } else if (@hasField(T, "radius")) {
        return std.math.pi * @as(f64, shape.radius) * @as(f64, shape.radius);
    } else {
        @compileError("shape must have width+height or radius fields");
    }
}
zig
// 在编译时生成查找表
const sin_table = blk: {
    const N = 256;
    var table: [N]f32 = undefined;
    @setEvalBranchQuota(10000);     // 增加配额以支持复杂的编译时求值
    for (0..N) |i| {
        const angle = @as(f32, @floatFromInt(i)) * (2.0 * std.math.pi / N);
        table[i] = @sin(angle);
    }
    break :blk table;
};

// 编译时字符串处理
fn upperCase(comptime s: []const u8) [s.len]u8 {
    var result: [s.len]u8 = undefined;
    for (s, 0..) |c, i| {
        result[i] = std.ascii.toUpper(c);
    }
    return result;
}
const HELLO = upperCase("hello");  // 编译时计算结果

// 结构类型:接受包含特定字段的任意结构体
fn area(shape: anytype) f64 {
    const T = @TypeOf(shape);
    if (@hasField(T, "width") and @hasField(T, "height")) {
        return @as(f64, shape.width) * @as(f64, shape.height);
    } else if (@hasField(T, "radius")) {
        return std.math.pi * @as(f64, shape.radius) * @as(f64, shape.radius);
    } else {
        @compileError("shape必须包含width+height字段或radius字段");
    }
}

6. comptime vs C++ templates comparison

6. comptime与C++模板的对比

FeatureC++ templatesZig comptime
Syntax
template<typename T>
fn foo(comptime T: type)
Error messagesCryptic instantiation stacksClear, at definition point
Specialization
template<> class Foo<int>
if (T == i32) { ... }
with
inline if
SFINAEComplex enable_if
@hasDecl
,
@hasField
,
@compileError
Variadic
template<typename... Ts>
anytype
, tuples,
inline for
Compile timeCan be very slowExplicit, bounded by
@setEvalBranchQuota
ValuesRequires
constexpr
Any expression can be
comptime
MacrosSeparate
#define
system
Comptime functions replace most macros
特性C++模板Zig comptime
语法
template<typename T>
fn foo(comptime T: type)
错误提示晦涩的实例化栈信息清晰的定义点错误提示
特化
template<> class Foo<int>
结合
inline if
使用
if (T == i32) { ... }
SFINAE复杂的enable_if
@hasDecl
@hasField
@compileError
可变参数
template<typename... Ts>
anytype
、元组、
inline for
编译速度可能非常慢显式可控,受
@setEvalBranchQuota
限制
值处理需要
constexpr
任意表达式都可标记为
comptime
独立的
#define
系统
comptime函数可替代大多数宏

7. Common comptime patterns

7. 常见comptime模式

zig
// Pattern: compile error for unsupported types
fn serializeInt(comptime T: type, value: T) []const u8 {
    if (@typeInfo(T) != .Int) {
        @compileError("serializeInt requires an integer type, got: " ++ @typeName(T));
    }
    // ...
}

// Pattern: conditional compilation
const is_debug = @import("builtin").mode == .Debug;
if (comptime is_debug) {
    // included only in debug builds
    validateInvariant(self);
}

// Pattern: inline for over comptime-known slice
const fields = std.meta.fields(MyStruct);
inline for (fields) |field| {
    // field.name, field.type available at comptime
    std.debug.print("{s}\n", .{field.name});
}
zig
// 模式:为不支持的类型抛出编译错误
fn serializeInt(comptime T: type, value: T) []const u8 {
    if (@typeInfo(T) != .Int) {
        @compileError("serializeInt需要整数类型,当前类型:" ++ @typeName(T));
    }
    // ...
}

// 模式:条件编译
const is_debug = @import("builtin").mode == .Debug;
if (comptime is_debug) {
    // 仅在Debug构建中包含
    validateInvariant(self);
}

// 模式:遍历编译时已知的切片
const fields = std.meta.fields(MyStruct);
inline for (fields) |field| {
    // field.name和field.type在编译时可用
    std.debug.print("{s}\n", .{field.name});
}

Related skills

相关技能

  • Use
    skills/zig/zig-testing
    for comptime assertions and testing comptime code
  • Use
    skills/zig/zig-build-system
    for comptime-based build.zig configuration
  • Use
    skills/compilers/cpp-templates
    for C++ template equivalent patterns
  • 若需comptime断言或测试comptime代码,可使用
    skills/zig/zig-testing
  • 若需基于comptime的build.zig配置,可使用
    skills/zig/zig-build-system
  • 若需C++模板的等效模式,可使用
    skills/compilers/cpp-templates