Upgrade from 0.15.2 to Zig 0.16.0 (#21)

thsackos · web-flow · commit 11887ffa5b03 · 2026-05-08T05:46:43.000-07:00
* This is more annoying than I thought it would be. Will pick this up again tomorrow

* These are breaking changes, unfortunately. 2 tests still failing, working on fixing those. Writergate wasn't too bad it seems.

* Removed undefined memory from hook mask. Seems the compiler's behavior changed and exposed that undefined behavior

* Adding change log, updating build agents to zig 0.16, getting started upgrading examples

* Finalize upgrade
diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml
@@ -20,7 +20,7 @@ jobs:
     - name: (Z) Install Zig
       uses: mlugg/setup-zig@v2
       with:
-        version: 0.15.1
+        version: 0.16.0
 
     - name: Run tests
       shell: bash
diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml
@@ -20,7 +20,7 @@ jobs:
     - name: (Z) Install Zig
       uses: mlugg/setup-zig@v2
       with:
-        version: 0.15.1
+        version: 0.16.0
 
     - name: ▶️ Run tests
       shell: pwsh
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 zig-out/
 .zig-cache/
+zig-pkg/
 
 __pycache__/
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,12 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.0.0] - 2025-05-21
+
+## [v3.0.0] - 2026-05-08
+
+Upgrade from Zig 0.15.2 to Zig 0.16.0 across library and examples.
+
+### Changed
+
+- Upgraded `zig-luajit-build` dependency from 1.1.6 to 1.1.8 to adopt Zig 0.16.0 changes.
+- Changed API for `Lua.dump()`, `Lua.load()` and all `prettyPrint()` functions to adopt new `std.Io.Reader` and
+  `std.Io.Writer` interfaces. All references to the now deleted  `std.io.AnyReader` and `std.io.AnyWriter` are removed.
+- Changed API for `HookMask` struct, it is now zeroed by default instead of containing uninitialized memory.
+- Updated all example programs to 0.16.0 and removed unnecessary README.md files in the examples directory.
+
+
+## [v2.0.0] - 2025-05-21
 
 ### Fixed
 
 - Corrected a logic error causing the `Lua.checkArgument()` function to incorrectly error on a passing condition.
     - Refer to [bug: checkArgument has inverse logic #17](https://github.com/sackosoft/zig-luajit/issues/17)
 
-[2.0.0]: https://github.com/sackosoft/zig-luajit/compare/v1.5.4...v2.0.0
-[1.5.4]: https://github.com/sackosoft/zig-luajit/releases/tag/v1.5.4
+[v2.0.0]: https://github.com/sackosoft/zig-luajit/compare/v2.0.1...v3.0.0
+[v2.0.0]: https://github.com/sackosoft/zig-luajit/compare/v1.5.4...v2.0.0
+[v1.5.4]: https://github.com/sackosoft/zig-luajit/releases/tag/v1.5.4
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ checks in `Debug` and `ReleaseSafe` builds and provides full test coverage of th
 
 ## Zig Version
 
-The `main` branch targets the latest stable Zig version. Currently `0.15.1`.
+The `main` branch targets the latest stable Zig version. Currently `0.16.0`.
 
 For other Zig versions look for branches with the named version.
 
@@ -353,3 +353,4 @@ can be found in the [COPYRIGHT](./COPYRIGHT.md) file.
 
 This project was inspired by [natecraddock/ziglua](https://github.com/natecraddock/ziglua) which provides great
 functionality if you're looking to use Lua runtimes other than LuaJIT!
+
diff --git a/build.zig.zon b/build.zig.zon
@@ -1,11 +1,11 @@
 .{
     .name = .luajit,
     .fingerprint = 0xda4bba66d285c19c,
-    .version = "2.1.0",
+    .version = "3.0.0",
     .dependencies = .{
         .luajit_build = .{
-            .url = "git+https://github.com/sackosoft/zig-luajit-build#1664f2be707feccf4191fb8c6c6dff9ac2bd6edb",
-            .hash = "luajit_build-1.1.6-HFjoU9xAAAANlxEGfin2P8D_sVc-AHtqKC6Fg8WWztZN",
+            .url = "git+https://github.com/sackosoft/zig-luajit-build#83801ee5c76938eb8704de6ae667437e63744588",
+            .hash = "luajit_build-1.1.8-HFjoU8lBAABZOIYvsm0OATsjlN0Fye4QYA86RuTy6uzl",
         },
     },
     .paths = .{
diff --git a/examples/README.md b/examples/README.md
@@ -1,24 +1,14 @@
 # Examples
 
-Unless otherwise noted, the `build.zig` files are functionally the same between them.
-
-## Basic Examples
-
 Inspired by this [Lua C API "Cheat Sheet"](https://www.codingwiththomas.com/blog/a-lua-c-api-cheat-sheet).
 
+0. [A simple Read-Evaluate-Print-Loop (REPL)](./simple-repl)
 1. [Run Lua code from Zig](./example-01_run-lua)
 2. [Lua variables in Zig, and vice versa](./example-02_variables)
 3. [Lua functions in Zig](./example-03_lua-functions)
 4. [Zig functions in Lua](./example-04_zig-functions)
 5. [Zig structs (userdata) in Lua](./example-05_userdata)
 6. [Lua tables in Zig](./example-06_lua-tables)
 
-## Miscellaneous
-
-- [Simple REPL](./simple-repl)
-
-## Userdata, in-depth
 
-Based on [Programming in Lua, chapter 28](https://www.lua.org/pil/28.html).
 
-(To-do)
diff --git a/examples/example-01_run-lua/README.md b/examples/example-01_run-lua/README.md
diff --git a/examples/example-01_run-lua/src/main.zig b/examples/example-01_run-lua/src/main.zig
@@ -5,15 +5,9 @@ const std = @import("std");
 const print = std.debug.print;
 const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    // Boilerplate
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
-
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
-    // End boilerplate
 
     lua.openBaseLib();
 
diff --git a/examples/example-02_variables/README.md b/examples/example-02_variables/README.md
diff --git a/examples/example-02_variables/src/main.zig b/examples/example-02_variables/src/main.zig
@@ -3,31 +3,27 @@
 
 const std = @import("std");
 const print = std.debug.print;
-const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    // Boilerplate
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+const Lua = @import("luajit").Lua;
 
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
-    // End boilerplate
 
     lua.openBaseLib();
 
     // Push a number to the top of the stack
     const foo = 123;
     lua.pushNumber(foo);
+
     // Pop the value at the top of the stack, and set it as the value of the global "foo"
     lua.setGlobal("foo");
 
     print("[Zig] Set foo to: {d}\n", .{foo});
 
     lua.doFile("src/script.lua") catch |err| switch (err) {
         error.Runtime => print("[Zig] Runtime error: {s}\n", .{lua.toString(-1) catch "unknown"}),
-        else => print("[Zig] Unknown error: {!}\n", .{err}),
+        else => print("[Zig] Unknown error: {t}\n", .{err}),
     };
 
     // getGlobal gets the value of the named global and puts it on the top of the stack, and then returns the type of the global
diff --git a/examples/example-03_lua-functions/README.md b/examples/example-03_lua-functions/README.md
diff --git a/examples/example-03_lua-functions/src/main.zig b/examples/example-03_lua-functions/src/main.zig
@@ -3,17 +3,12 @@
 
 const std = @import("std");
 const print = std.debug.print;
-const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    // Boilerplate
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+const Lua = @import("luajit").Lua;
 
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
-    // End boilerplate
 
     lua.openBaseLib();
 
@@ -27,7 +22,7 @@ pub fn main() !void {
             return;
         },
         else => {
-            print("[Zig] Unknown error: {!}\n", .{err});
+            print("[Zig] Unknown error: {t}\n", .{err});
             return;
         },
     };
@@ -58,7 +53,7 @@ pub fn main() !void {
             return;
         },
         else => {
-            print("[Zig] Unknown error: {!}\n", .{err});
+            print("[Zig] Unknown error: {t}\n", .{err});
             return;
         },
     };
diff --git a/examples/example-04_zig-functions/README.md b/examples/example-04_zig-functions/README.md
diff --git a/examples/example-04_zig-functions/src/main.zig b/examples/example-04_zig-functions/src/main.zig
@@ -3,17 +3,12 @@
 
 const std = @import("std");
 const print = std.debug.print;
-const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    // Boilerplate
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+const Lua = @import("luajit").Lua;
 
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
-    // End boilerplate
 
     lua.openBaseLib();
 
@@ -30,7 +25,7 @@ pub fn main() !void {
             return;
         },
         else => {
-            print("[Zig] Unknown error: {!}\n", .{err});
+            print("[Zig] Unknown error: {t}\n", .{err});
             return;
         },
     };
diff --git a/examples/example-05_userdata/README.md b/examples/example-05_userdata/README.md
diff --git a/examples/example-05_userdata/src/main.zig b/examples/example-05_userdata/src/main.zig
@@ -5,15 +5,9 @@ const std = @import("std");
 const print = std.debug.print;
 const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    // Boilerplate
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
-
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
-    // End boilerplate
 
     lua.openBaseLib();
 
@@ -37,7 +31,7 @@ pub fn main() !void {
             return;
         },
         else => {
-            print("[Zig] Unknown error: {!}\n", .{err});
+            print("[Zig] Unknown error: {t}\n", .{err});
             return;
         },
     };
diff --git a/examples/example-06_lua-tables/README.md b/examples/example-06_lua-tables/README.md
diff --git a/examples/example-06_lua-tables/src/main.zig b/examples/example-06_lua-tables/src/main.zig
@@ -3,17 +3,12 @@
 
 const std = @import("std");
 const print = std.debug.print;
-const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    // Boilerplate
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+const Lua = @import("luajit").Lua;
 
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
-    // End boilerplate
 
     lua.openBaseLib();
 
@@ -29,7 +24,7 @@ pub fn main() !void {
             return;
         },
         else => {
-            print("[Zig] Unknown error: {!}\n", .{err});
+            print("[Zig] Unknown error: {t}\n", .{err});
             return;
         },
     };
diff --git a/examples/simple-repl/README.md b/examples/simple-repl/README.md
@@ -6,7 +6,7 @@ evaluates the expression and prints the result to the output.
 
 ## Version
 
-Last tested with Zig version `0.15.1`.
+Last tested with Zig version `0.16.0`.
 
 ## Usage
 
diff --git a/examples/simple-repl/main.zig b/examples/simple-repl/main.zig
@@ -2,25 +2,22 @@
 //! SPDX-License-Identifier: MIT
 
 const std = @import("std");
-const Lua = @import("luajit").Lua;
 
-pub fn main() !void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+const Lua = @import("luajit").Lua;
 
-    const allocator = gpa.allocator();
-    const lua = try Lua.init(allocator);
+pub fn main(init: std.process.Init) !void {
+    const lua = try Lua.init(init.gpa);
     defer lua.deinit();
 
     lua.openBaseLib();
 
     var stdin_buffer: [1024]u8 = undefined;
-    var stdin_reader = std.fs.File.stdin().reader(&stdin_buffer);
-    const stdin = &stdin_reader.interface;
+    var stdin_reader = std.Io.File.stdin().reader(init.io, &stdin_buffer);
+    var stdin = &stdin_reader.interface;
 
     var stdout_buffer: [1024]u8 = undefined;
-    var stdout_writer = std.fs.File.stdout().writer(&stdout_buffer);
-    const stdout = &stdout_writer.interface;
+    var stdout_writer = std.Io.File.stdout().writer(init.io, &stdout_buffer);
+    var stdout = &stdout_writer.interface;
 
     var line_buffer: [1025]u8 = undefined;
 
diff --git a/src/root.zig b/src/root.zig
