Zig Cinterop

mohitmishra786/low-level-dev-skills/skills/zig/zig-cinterop

作者 mohitmishra786bdc58472fa9f無授權條款253 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫3 個月前更新

Zig C interoperability skill. Use when calling C from Zig, calling Zig from C, using @cImport and @cInclude, running translate-c on C headers, defining extern structs and packed structs, matching C ABI types, or building mixed C/Zig projects. Activates on queries about @cImport, @cInclude, translate-c, extern struct, packed struct, Zig C ABI, calling C from Zig, exporting Zig to C, or bindgen equivalents.

僅含說明Software Development

AI 產生的概覽

指導 Zig 與 C 互通：@cImport、translate-c、extern 與 packed 結構，以及 C/Zig 混合建置。

功能: 此技能提供從 Zig 呼叫 C，以及將 Zig 匯出給 C 使用的操作說明。內容涵蓋 @cImport 與 @cInclude 的用法、以 translate-c 檢視標頭檔轉譯結果、C 與 Zig 的型別對應、extern struct 與 packed struct 的記憶體配置、不透明型別、可變參數函式，以及混合 C/Zig 專案的 build.zig 設定。它也會指向一份關於 translate-c 輸出與 C ABI 型別的參考檔案。
適用情境: 適用於撰寫呼叫 C 函式庫的 Zig 程式碼，或將 Zig 函式開放給 C 使用的情況。適合處理關於 @cImport、@cInclude、translate-c、extern struct、packed struct、C ABI 型別對應，或建置 C 與 Zig 混合專案的問題。
執行需求: 需要 Zig 工具鏈來編譯與執行 translate-c，連結 C 程式碼時還需要 C 編譯器與 libc。此技能未附帶指令碼，僅為說明文件，另含一份參考 Markdown 檔案。

Zig C Interop

Purpose

Guide agents through Zig's C interoperability: @cImport/@cInclude for calling C, translate-c for header inspection, extern struct and packed struct for ABI-compatible types, exporting Zig for C consumption, and zig cc for mixed C/Zig builds.

Triggers

"How do I call a C function from Zig?"
"How do I use @cImport and @cInclude?"
"How do I export Zig functions to be called from C?"
"How do I define a struct that matches a C struct?"
"What does translate-c do?"
"How do I build a mixed C and Zig project?"

Workflow

1. Calling C from Zig with @cImport

zig

const c = @cImport({    @cInclude("stdio.h");    @cInclude("string.h");    @cInclude("mylib.h");    @cDefine("MY_FEATURE", "1");  // Equivalent to -DMY_FEATURE=1    @cUndef("SOME_MACRO");});
pub fn main() void {    _ = c.printf("Hello from C: %d\n", @as(c_int, 42));
    var buf: [256]u8 = undefined;    _ = c.snprintf(&buf, buf.len, "formatted: %d", @as(c_int, 100));}

const c = @cImport({    @cInclude("stdio.h");    @cInclude("string.h");    @cInclude("mylib.h");    @cDefine("MY_FEATURE", "1");  // Equivalent to -DMY_FEATURE=1    @cUndef("SOME_MACRO");});
pub fn main() void {    _ = c.printf("Hello from C: %d\n", @as(c_int, 42));
    var buf: [256]u8 = undefined;    _ = c.snprintf(&buf, buf.len, "formatted: %d", @as(c_int, 100));}

In build.zig:

2. translate-c — inspect C header translation

translate-c converts C headers to Zig declarations, letting you see exactly how Zig sees a C API:

bash

# Translate a header filezig translate-c /usr/include/stdio.h > stdio.zig
# Translate with defines/includeszig translate-c -I include/ -DFEATURE=1 mylib.h > mylib.zig
# Translate and inspect specific typeszig translate-c mylib.h | grep -A5 "struct MyStruct"

# Translate a header filezig translate-c /usr/include/stdio.h > stdio.zig
# Translate with defines/includeszig translate-c -I include/ -DFEATURE=1 mylib.h > mylib.zig
# Translate and inspect specific typeszig translate-c mylib.h | grep -A5 "struct MyStruct"

This is Zig's equivalent of bindgen — you use it to understand what Zig generates, then use @cImport directly in code.

3. C type mapping

C type	Zig type
`int`	`c_int`
`unsigned int`	`c_uint`
`long`	`c_long`
`unsigned long`	`c_ulong`
`long long`	`c_longlong`
`size_t`	`usize`
`ssize_t`	`isize`
`char *`	`[*:0]u8` (null-terminated)
`const char *`	`[*:0]const u8`
`void *`	`*anyopaque`
`NULL`	`null`
`bool`	`bool` (C99) or `c_int` (older)
`float`	`f32`
`double`	`f64`

zig

// Passing strings to Cconst str = "hello";_ = c.puts(str);  // Zig string literals are [*:0]const u8
// Dynamic strings — need null terminatorvar buf: [64:0]u8 = undefined;const len = std.fmt.bufPrint(buf[0..63], "hello {d}", .{42}) catch unreachable;buf[len] = 0;_ = c.puts(&buf);

// Passing strings to Cconst str = "hello";_ = c.puts(str);  // Zig string literals are [*:0]const u8
// Dynamic strings — need null terminatorvar buf: [64:0]u8 = undefined;const len = std.fmt.bufPrint(buf[0..63], "hello {d}", .{42}) catch unreachable;buf[len] = 0;_ = c.puts(&buf);

4. extern struct — ABI-compatible structs

Use extern struct to match a C struct's memory layout exactly:

zig

// Matches: struct Point { int x; int y; };const Point = extern struct {    x: c_int,    y: c_int,};
// Matches: struct Header { uint32_t magic; uint16_t version; uint16_t flags; };const Header = extern struct {    magic: u32,    version: u16,    flags: u16,};
// Use with C APIvar p = Point{ .x = 10, .y = 20 };_ = c.draw_point(&p);

// Matches: struct Point { int x; int y; };const Point = extern struct {    x: c_int,    y: c_int,};
// Matches: struct Header { uint32_t magic; uint16_t version; uint16_t flags; };const Header = extern struct {    magic: u32,    version: u16,    flags: u16,};
// Use with C APIvar p = Point{ .x = 10, .y = 20 };_ = c.draw_point(&p);

5. packed struct — bit-level layout

zig

// Matches C bitfield: struct { uint8_t flags : 4; uint8_t type : 4; };const Flags = packed struct(u8) {    mode: u4,    kind: u4,};
// Packed struct for wire protocolsconst IpHeader = packed struct(u32) {    ihl: u4,    version: u4,    tos: u8,    total_length: u16,};
var h: IpHeader = @bitCast(@as(u32, raw_bytes));

// Matches C bitfield: struct { uint8_t flags : 4; uint8_t type : 4; };const Flags = packed struct(u8) {    mode: u4,    kind: u4,};
// Packed struct for wire protocolsconst IpHeader = packed struct(u32) {    ihl: u4,    version: u4,    tos: u8,    total_length: u16,};
var h: IpHeader = @bitCast(@as(u32, raw_bytes));

6. Exporting Zig to C

zig

// Export a function callable from Cexport fn zig_add(a: c_int, b: c_int) c_int {    return a + b;}
// Export with specific calling conventionpub fn my_func(x: u32) callconv(.C) u32 {    return x * 2;}
// Export a struct (use extern struct for C layout)export const VERSION: c_int = 42;

// Export a function callable from Cexport fn zig_add(a: c_int, b: c_int) c_int {    return a + b;}
// Export with specific calling conventionpub fn my_func(x: u32) callconv(.C) u32 {    return x * 2;}
// Export a struct (use extern struct for C layout)export const VERSION: c_int = 42;

Generate a C header (manual or with tools):

/* mylib.h */#ifndef MYLIB_H#define MYLIB_H#include <stdint.h>
int zig_add(int a, int b);uint32_t my_func(uint32_t x);extern int VERSION;
#endif

/* mylib.h */#ifndef MYLIB_H#define MYLIB_H#include <stdint.h>
int zig_add(int a, int b);uint32_t my_func(uint32_t x);extern int VERSION;
#endif

7. Calling Zig from C in build.zig

zig

// Build Zig as a C-compatible static libraryconst lib = b.addStaticLibrary(.{    .name = "myzig",    .root_source_file = b.path("src/lib.zig"),    .target = target,    .optimize = optimize,});
// The C code that uses the Zig libraryconst c_exe = b.addExecutable(.{    .name = "c_consumer",    .target = target,    .optimize = optimize,});c_exe.addCSourceFile(.{    .file = b.path("src/main.c"),    .flags = &.{"-std=c11"},});c_exe.linkLibrary(lib);c_exe.linkLibC();b.installArtifact(c_exe);

// Build Zig as a C-compatible static libraryconst lib = b.addStaticLibrary(.{    .name = "myzig",    .root_source_file = b.path("src/lib.zig"),    .target = target,    .optimize = optimize,});
// The C code that uses the Zig libraryconst c_exe = b.addExecutable(.{    .name = "c_consumer",    .target = target,    .optimize = optimize,});c_exe.addCSourceFile(.{    .file = b.path("src/main.c"),    .flags = &.{"-std=c11"},});c_exe.linkLibrary(lib);c_exe.linkLibC();b.installArtifact(c_exe);

8. Opaque types and forward declarations

zig

// Forward-declared C struct (opaque)const FILE = opaque {};extern fn fopen(path: [*:0]const u8, mode: [*:0]const u8) ?*FILE;extern fn fclose(file: *FILE) c_int;extern fn fprintf(file: *FILE, fmt: [*:0]const u8, ...) c_int;
// Opaque handle patternconst MyHandle = opaque {};extern fn lib_create() ?*MyHandle;extern fn lib_destroy(h: *MyHandle) void;

// Forward-declared C struct (opaque)const FILE = opaque {};extern fn fopen(path: [*:0]const u8, mode: [*:0]const u8) ?*FILE;extern fn fclose(file: *FILE) c_int;extern fn fprintf(file: *FILE, fmt: [*:0]const u8, ...) c_int;
// Opaque handle patternconst MyHandle = opaque {};extern fn lib_create() ?*MyHandle;extern fn lib_destroy(h: *MyHandle) void;

9. Variadic functions

zig

// Call variadic C functions using @call with variadic argsconst c = @cImport(@cInclude("stdio.h"));
// printf works directly through @cImport_ = c.printf("value: %d\n", @as(c_int, 42));
// For custom variadic C functions, use extern with ...extern fn my_log(level: c_int, fmt: [*:0]const u8, ...) void;

// Call variadic C functions using @call with variadic argsconst c = @cImport(@cInclude("stdio.h"));
// printf works directly through @cImport_ = c.printf("value: %d\n", @as(c_int, 42));
// For custom variadic C functions, use extern with ...extern fn my_log(level: c_int, fmt: [*:0]const u8, ...) void;

For translate-c output guide and C ABI types reference, see references/translate-c-guide.md [blocked].

Related skills

Use skills/zig/zig-compiler for zig cc C compilation and basic Zig builds
Use skills/zig/zig-build-system for build.zig with mixed C/Zig projects
Use skills/binaries/elf-inspection to verify symbol exports and ABI
Use skills/rust/rust-ffi for comparison with Rust's C FFI approach

來源與署名

來源：mohitmishra786/low-level-dev-skills位於skills/zig/zig-cinterop提交bdc5847

授權條款：無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

Zig Cinterop

Zig C Interop

Purpose

Triggers

Workflow

1. Calling C from Zig with @cImport

2. translate-c — inspect C header translation

3. C type mapping

4. extern struct — ABI-compatible structs

5. packed struct — bit-level layout

6. Exporting Zig to C

7. Calling Zig from C in build.zig

8. Opaque types and forward declarations

9. Variadic functions

Related skills

來源與署名

更多來自 mohitmishra786/low-level-dev-skills 的技能

Zig Debugging

Simd Intrinsics

Zig Cross

Rustc Basics

Zig Build System

Memory Model

更多Software Development技能

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices