Upgrade from Zig 0.12 to 0.14

Author: kristapsk

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
         - name: Set up Zig
           uses: goto-bus-stop/setup-zig@v2
           with:
-            version: '0.12.1'
+            version: '0.14.0'
         - name: Lint
           run: ./tools/fmt-check.sh
         - name: Test

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
 .ccls-cache
+.zig-cache
 zig-cache
 zig-out

README.md

@@ -11,7 +11,7 @@ with `zig build`. otherwise, for macOS or non-X11 platforms use SDL2:
 
 ## local development
 
-you'll need [zig v0.12.x](https://ziglang.org/download/).
+you'll need [zig v0.14.x](https://ziglang.org/download/).
 if working on the gui using sdl2 driver, also [SDL2](https://www.libsdl.org/).
 
 note that compiling the daemon on macOS is currently unsupported since

build.zig

@@ -71,16 +71,16 @@ pub fn build(b: *std.Build) void {
 
     ngui.root_module.addCMacro("NM_DISP_HOR", b.fmt("{d}", .{disp_horiz}));
     ngui.root_module.addCMacro("NM_DISP_VER", b.fmt("{d}", .{disp_vert}));
-    ngui.defineCMacro("LV_CONF_INCLUDE_SIMPLE", "1");
-    ngui.defineCMacro("LV_LOG_LEVEL", lvgl_loglevel.text());
-    ngui.defineCMacro("LV_TICK_CUSTOM", "1");
-    ngui.defineCMacro("LV_TICK_CUSTOM_INCLUDE", "\"lv_custom_tick.h\"");
-    ngui.defineCMacro("LV_TICK_CUSTOM_SYS_TIME_EXPR", "(nm_get_curr_tick())");
+    ngui.root_module.addCMacro("LV_CONF_INCLUDE_SIMPLE", "1");
+    ngui.root_module.addCMacro("LV_LOG_LEVEL", lvgl_loglevel.text());
+    ngui.root_module.addCMacro("LV_TICK_CUSTOM", "1");
+    ngui.root_module.addCMacro("LV_TICK_CUSTOM_INCLUDE", "\"lv_custom_tick.h\"");
+    ngui.root_module.addCMacro("LV_TICK_CUSTOM_SYS_TIME_EXPR", "(nm_get_curr_tick())");
     switch (drv) {
         .sdl2 => {
             ngui.addCSourceFiles(.{ .files = lvgl_sdl2_src, .flags = &lvgl_flags });
             ngui.addCSourceFile(.{ .file = b.path("src/ui/c/drv_sdl2.c"), .flags = &ngui_cflags });
-            ngui.defineCMacro("USE_SDL", "1");
+            ngui.root_module.addCMacro("USE_SDL", "1");
             ngui.linkSystemLibrary("SDL2");
         },
         .x11 => {
@@ -92,14 +92,14 @@ pub fn build(b: *std.Build) void {
                 },
                 .flags = &ngui_cflags,
             });
-            ngui.defineCMacro("USE_X11", "1");
+            ngui.root_module.addCMacro("USE_X11", "1");
             ngui.linkSystemLibrary("X11");
         },
         .fbev => {
             ngui.addCSourceFiles(.{ .files = lvgl_fbev_src, .flags = &lvgl_flags });
             ngui.addCSourceFile(.{ .file = b.path("src/ui/c/drv_fbev.c"), .flags = &ngui_cflags });
-            ngui.defineCMacro("USE_FBDEV", "1");
-            ngui.defineCMacro("USE_EVDEV", "1");
+            ngui.root_module.addCMacro("USE_FBDEV", "1");
+            ngui.root_module.addCMacro("USE_EVDEV", "1");
         },
     }
 
@@ -427,7 +427,7 @@ const VersionStep = struct {
         return &vstep.step;
     }
 
-    fn make(step: *std.Build.Step, _: *std.Progress.Node) anyerror!void {
+    fn make(step: *std.Build.Step, _: std.Build.Step.MakeOptions) anyerror!void {
         const self: *@This() = @fieldParentPtr("step", step);
         const semver = try self.eval();
         std.log.info("build version: {any}", .{semver});

build.zig.zon

@@ -1,14 +1,86 @@
 .{
-    .name = "ndg",
-    .version = "0.8.1",
+    // This is the default name used by packages depending on this one. For
+    // example, when a user runs `zig fetch --save <url>`, this field is used
+    // as the key in the `dependencies` table. Although the user can choose a
+    // different name, most users will stick with this provided value.
+    //
+    // It is redundant to include "zig" in this name because it is already
+    // within the Zig package namespace.
+    .name = .ndg,
+
+    // This is a [Semantic Version](https://semver.org/).
+    // In a future version of Zig it will be used for package deduplication.
+    .version = "0.9.0-alpha",
+
+    // Together with name, this represents a globally unique package
+    // identifier. This field is generated by the Zig toolchain when the
+    // package is first created, and then *never changes*. This allows
+    // unambiguous detection of one package being an updated version of
+    // another.
+    //
+    // When forking a Zig project, this id should be regenerated (delete the
+    // field and run `zig build`) if the upstream project is still maintained.
+    // Otherwise, the fork is *hostile*, attempting to take control over the
+    // original project's identity. Thus it is recommended to leave the comment
+    // on the following line intact, so that it shows up in code reviews that
+    // modify the field.
+    .fingerprint = 0x6f4f6560e5c632bf, // Changing this has security and trust implications.
+
+    // Tracks the earliest Zig version that the package considers to be a
+    // supported use case.
+    .minimum_zig_version = "0.14.0",
+
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // internet connectivity.
     .dependencies = .{
         .nif = .{
             .path = "lib/nif",
         },
         .ini = .{
             .path = "lib/ini",
         },
+        // See `zig fetch --save <url>` for a command-line interface for adding dependencies.
+        //.example = .{
+        //    // When updating this field to a new URL, be sure to delete the corresponding
+        //    // `hash`, otherwise you are communicating that you expect to find the old hash at
+        //    // the new URL. If the contents of a URL change this will result in a hash mismatch
+        //    // which will prevent zig from using it.
+        //    .url = "https://example.com/foo.tar.gz",
+        //
+        //    // This is computed from the file contents of the directory of files that is
+        //    // obtained after fetching `url` and applying the inclusion rules given by
+        //    // `paths`.
+        //    //
+        //    // This field is the source of truth; packages do not come from a `url`; they
+        //    // come from a `hash`. `url` is just one of many possible mirrors for how to
+        //    // obtain a package matching this `hash`.
+        //    //
+        //    // Uses the [multihash](https://multiformats.io/multihash/) format.
+        //    .hash = "...",
+        //
+        //    // When this is provided, the package is found in a directory relative to the
+        //    // build root. In this case the package's hash is irrelevant and therefore not
+        //    // computed. This field and `url` are mutually exclusive.
+        //    .path = "foo",
+        //
+        //    // When this is set to `true`, a package is declared to be lazily
+        //    // fetched. This makes the dependency only get fetched if it is
+        //    // actually used.
+        //    .lazy = false,
+        //},
     },
+
+    // Specifies the set of files and directories that are included in this package.
+    // Only files and directories listed here are included in the `hash` that
+    // is computed for this package. Only files listed here will remain on disk
+    // when using the zig package manager. As a rule of thumb, one should list
+    // files required for compilation plus any license(s).
+    // Paths are relative to the build root. Use the empty string (`""`) to refer to
+    // the build root itself.
+    // A directory listed here means that all files within, recursively, are included.
     .paths = .{
         "build.zig",
         "build.zig.zon",

lib/ini/README.md

@@ -3,7 +3,7 @@
 This is a very simple ini-parser library that provides:
 - Raw record reading
 - Leading/trailing whitespace removal
-- comments based on `;` and `#`
+- Comments
 - Zig API
 - C API
 
@@ -19,7 +19,9 @@ pub fn main() !void {
     const file = try std.fs.cwd().openFile("example.ini", .{});
     defer file.close();
 
-    var parser = ini.parse(std.testing.allocator, file.reader());
+    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    defer if (gpa.deinit() != .ok) @panic("memory leaked");
+    var parser = ini.parse(gpa.allocator(), file.reader(), ";#");
     defer parser.deinit();
 
     var writer = std.io.getStdOut().writer();
@@ -46,17 +48,17 @@ int main() {
   FILE * f = fopen("example.ini", "rb");
   if(!f)
     return 1;
-  
+
   struct ini_Parser parser;
-  ini_create_file(&parser, f);
+  ini_create_file(&parser, f, ";#", 2);
 
   struct ini_Record record;
   while(true)
   {
     enum ini_Error error = ini_next(&parser, &record);
     if(error != INI_SUCCESS)
       goto cleanup;
-    
+
     switch(record.type) {
       case INI_RECORD_NUL: goto done;
       case INI_RECORD_SECTION:
@@ -78,4 +80,4 @@ cleanup:
   fclose(f);
   return 0;
 }
-```
+```

lib/ini/build.zig

@@ -5,69 +5,62 @@ pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
 
     _ = b.addModule("ini", .{
-        .root_source_file = .{
-            .path = "src/ini.zig",
-        },
+        .root_source_file = b.path("src/ini.zig"),
     });
 
     const lib = b.addStaticLibrary(.{
         .name = "ini",
-        .root_source_file = .{ .path = "src/lib.zig" },
+        .root_source_file = b.path("src/lib.zig"),
         .target = target,
         .optimize = optimize,
     });
-
     lib.bundle_compiler_rt = true;
-    lib.addIncludePath(.{ .path = "src" });
+    lib.addIncludePath(b.path("src"));
     lib.linkLibC();
-
+    lib.installHeader(b.path("src/ini.h"), "ini.h");
     b.installArtifact(lib);
 
+    const example_step = b.step("example", "Build examples");
     const example_c = b.addExecutable(.{
         .name = "example-c",
         .optimize = optimize,
         .target = target,
     });
     example_c.addCSourceFile(.{
-        .file = .{
-            .path = "example/example.c",
-        },
+        .file = b.path("example/example.c"),
         .flags = &.{
             "-Wall",
             "-Wextra",
             "-pedantic",
         },
     });
-    example_c.addIncludePath(.{ .path = "src" });
+    example_c.addIncludePath(b.path("src"));
     example_c.linkLibrary(lib);
     example_c.linkLibC();
-
-    b.installArtifact(example_c);
+    example_step.dependOn(&b.addInstallArtifact(example_c, .{}).step);
 
     const example_zig = b.addExecutable(.{
         .name = "example-zig",
-        .root_source_file = .{ .path = "example/example.zig" },
+        .root_source_file = b.path("example/example.zig"),
         .optimize = optimize,
         .target = target,
     });
     example_zig.root_module.addImport("ini", b.modules.get("ini").?);
+    example_step.dependOn(&b.addInstallArtifact(example_zig, .{}).step);
 
-    b.installArtifact(example_zig);
-
-    var main_tests = b.addTest(.{
-        .root_source_file = .{ .path = "src/test.zig" },
+    const test_step = b.step("test", "Run library tests");
+    const main_tests = b.addTest(.{
+        .root_source_file = b.path("src/test.zig"),
         .optimize = optimize,
     });
+    test_step.dependOn(&b.addRunArtifact(main_tests).step);
 
-    var binding_tests = b.addTest(.{
-        .root_source_file = .{ .path = "src/lib-test.zig" },
+    const binding_tests = b.addTest(.{
+        .root_source_file = b.path("src/lib-test.zig"),
         .optimize = optimize,
     });
-    binding_tests.addIncludePath(.{ .path = "src" });
+    binding_tests.addIncludePath(b.path("src"));
     binding_tests.linkLibrary(lib);
     binding_tests.linkLibC();
-
-    const test_step = b.step("test", "Run library tests");
-    test_step.dependOn(&main_tests.step);
-    test_step.dependOn(&binding_tests.step);
+    test_step.dependOn(&b.addRunArtifact(binding_tests).step);
 }

lib/ini/build.zig.zon

@@ -1,10 +1,13 @@
 .{
-    .name = "libini",
-    .version = "0.0.0",
-    .dependencies = .{},
+    .name = .ini,
+    .fingerprint = 0x7757b668623d2460,
+    .version = "0.1.0",
+    .minimum_zig_version = "0.14.0",
     .paths = .{
+        "LICENCE",
+        "README.md",
         "build.zig",
         "build.zig.zon",
-        "src",
+        "src/ini.zig",
     },
 }

lib/ini/example/example.c

@@ -7,17 +7,17 @@ int main() {
   FILE * f = fopen("example.ini", "rb");
   if(!f)
     return 1;
-  
+
   struct ini_Parser parser;
-  ini_create_file(&parser, f);
+  ini_create_file(&parser, f, ";#", 2);
 
   struct ini_Record record;
   while(true)
   {
     enum ini_Error error = ini_next(&parser, &record);
     if(error != INI_SUCCESS)
       goto cleanup;
-    
+
     switch(record.type) {
       case INI_RECORD_NUL: goto done;
       case INI_RECORD_SECTION:
@@ -38,4 +38,4 @@ int main() {
   ini_destroy(&parser);
   fclose(f);
   return 0;
-}
+}

lib/ini/example/example.zig

@@ -7,7 +7,7 @@ pub fn main() !void {
 
     var gpa = std.heap.GeneralPurposeAllocator(.{}){};
     defer if (gpa.deinit() != .ok) @panic("memory leaked");
-    var parser = ini.parse(gpa.allocator(), file.reader());
+    var parser = ini.parse(gpa.allocator(), file.reader(), ";#");
     defer parser.deinit();
 
     var writer = std.io.getStdOut().writer();