Browse Source

Update to latest zig 0.12.0dev while keeping 0.11.0 compatibility (#3715)

* update build.zig for latest zig 0.12.0dev while still allowing 0.11.0

* update examples/build.zig and add nicer message for type mismatch
freakmangd 1 year ago
parent
commit
482722d881
3 changed files with 57 additions and 11 deletions
  1. 1 1
      build.zig
  2. 35 7
      examples/build.zig
  3. 21 3
      src/build.zig

+ 1 - 1
build.zig

@@ -1,7 +1,7 @@
 const std = @import("std");
 const raylib = @import("src/build.zig");
 
-// This has been tested to work with zig 0.11.0
+// This has been tested to work with zig 0.11.0 and zig 0.12.0-dev.2075+f5978181e
 pub fn build(b: *std.Build) void {
     raylib.build(b);
 }

+ 35 - 7
examples/build.zig

@@ -1,14 +1,26 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-// This has been tested to work with zig 0.11.0 (67709b6, Aug 4 2023)
-fn add_module(comptime module: []const u8, b: *std.Build, target: std.zig.CrossTarget, optimize: std.builtin.OptimizeMode) !*std.Build.Step {
-    if (target.getOsTag() == .emscripten) {
+// This has been tested to work with zig 0.11.0 (67709b6, Aug 4 2023) and zig 0.12.0-dev.2075+f5978181e (Jan 8 2024)
+//
+// anytype is used here to preserve compatibility, in 0.12.0dev the std.zig.CrossTarget type
+// was reworked into std.Target.Query and std.Build.ResolvedTarget. Using anytype allows
+// us to accept both CrossTarget and ResolvedTarget and act accordingly in getOsTagVersioned.
+fn add_module(comptime module: []const u8, b: *std.Build, target: anytype, optimize: std.builtin.OptimizeMode) !*std.Build.Step {
+    if (comptime builtin.zig_version.minor >= 12 and @TypeOf(target) != std.Build.ResolvedTarget) {
+        @compileError("Expected 'std.Build.ResolvedTarget' for argument 2 'target' in 'add_module', found '" ++ @typeName(@TypeOf(target)) ++ "'");
+    } else if (comptime builtin.zig_version.minor == 11 and @TypeOf(target) != std.zig.CrossTarget) {
+        @compileError("Expected 'std.zig.CrossTarget' for argument 2 'target' in 'add_module', found '" ++ @typeName(@TypeOf(target)) ++ "'");
+    }
+
+    if (getOsTagVersioned(target) == .emscripten) {
         @panic("Emscripten building via Zig unsupported");
     }
 
     const all = b.step(module, "All " ++ module ++ " examples");
-    const dir = try std.fs.cwd().openIterableDir(module, .{});
+    var dir = try openIterableDirVersioned(std.fs.cwd(), module);
+    defer if (comptime builtin.zig_version.minor >= 12) dir.close();
+
     var iter = dir.iterate();
     while (try iter.next()) |entry| {
         if (entry.kind != .file) continue;
@@ -17,7 +29,7 @@ fn add_module(comptime module: []const u8, b: *std.Build, target: std.zig.CrossT
         const path = try std.fs.path.join(b.allocator, &.{ module, entry.name });
 
         // zig's mingw headers do not include pthread.h
-        if (std.mem.eql(u8, "core_loading_thread", name) and target.getOsTag() == .windows) continue;
+        if (std.mem.eql(u8, "core_loading_thread", name) and getOsTagVersioned(target) == .windows) continue;
 
         const exe = b.addExecutable(.{
             .name = name,
@@ -26,7 +38,7 @@ fn add_module(comptime module: []const u8, b: *std.Build, target: std.zig.CrossT
         });
         exe.addCSourceFile(.{ .file = .{ .path = path }, .flags = &.{} });
         exe.linkLibC();
-        exe.addObjectFile(switch (target.getOsTag()) {
+        exe.addObjectFile(switch (getOsTagVersioned(target)) {
             .windows => .{ .path = "../zig-out/lib/raylib.lib" },
             .linux => .{ .path = "../zig-out/lib/libraylib.a" },
             .macos => .{ .path = "../zig-out/lib/libraylib.a" },
@@ -38,7 +50,7 @@ fn add_module(comptime module: []const u8, b: *std.Build, target: std.zig.CrossT
         exe.addIncludePath(.{ .path = "../src/external" });
         exe.addIncludePath(.{ .path = "../src/external/glfw/include" });
 
-        switch (target.getOsTag()) {
+        switch (getOsTagVersioned(target)) {
             .windows => {
                 exe.linkSystemLibrary("winmm");
                 exe.linkSystemLibrary("gdi32");
@@ -106,3 +118,19 @@ pub fn build(b: *std.Build) !void {
     all.dependOn(try add_module("text", b, target, optimize));
     all.dependOn(try add_module("textures", b, target, optimize));
 }
+
+fn getOsTagVersioned(target: anytype) std.Target.Os.Tag {
+    if (comptime builtin.zig_version.minor >= 12) {
+        return target.result.os.tag;
+    } else {
+        return target.getOsTag();
+    }
+}
+
+fn openIterableDirVersioned(dir: std.fs.Dir, path: []const u8) !(if (builtin.zig_version.minor >= 12) std.fs.Dir else std.fs.IterableDir) {
+    if (comptime builtin.zig_version.minor >= 12) {
+        return dir.openDir(path, .{ .iterate = true });
+    } else {
+        return dir.openIterableDir(path, .{});
+    }
+}

+ 21 - 3
src/build.zig

@@ -1,8 +1,18 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-// This has been tested to work with zig 0.11.0 and zig 0.12.0-dev.1390+94cee4fb2
-pub fn addRaylib(b: *std.Build, target: std.zig.CrossTarget, optimize: std.builtin.OptimizeMode, options: Options) *std.Build.CompileStep {
+// This has been tested to work with zig 0.11.0 and zig 0.12.0-dev.2075+f5978181e
+//
+// anytype is used here to preserve compatibility, in 0.12.0dev the std.zig.CrossTarget type
+// was reworked into std.Target.Query and std.Build.ResolvedTarget. Using anytype allows
+// us to accept both CrossTarget and ResolvedTarget and act accordingly in getOsTagVersioned.
+pub fn addRaylib(b: *std.Build, target: anytype, optimize: std.builtin.OptimizeMode, options: Options) *std.Build.Step.Compile {
+    if (comptime builtin.zig_version.minor >= 12 and @TypeOf(target) != std.Build.ResolvedTarget) {
+        @compileError("Expected 'std.Build.ResolvedTarget' for argument 2 'target' in 'addRaylib', found '" ++ @typeName(@TypeOf(target)) ++ "'");
+    } else if (comptime builtin.zig_version.minor == 11 and @TypeOf(target) != std.zig.CrossTarget) {
+        @compileError("Expected 'std.zig.CrossTarget' for argument 2 'target' in 'addRaylib', found '" ++ @typeName(@TypeOf(target)) ++ "'");
+    }
+
     const raylib_flags = &[_][]const u8{
         "-std=gnu99",
         "-D_GNU_SOURCE",
@@ -68,7 +78,7 @@ pub fn addRaylib(b: *std.Build, target: std.zig.CrossTarget, optimize: std.built
         raylib.addIncludePath(.{ .path = srcdir ++ "/../../raygui/src" });
     }
 
-    switch (target.getOsTag()) {
+    switch (getOsTagVersioned(target)) {
         .windows => {
             addCSourceFilesVersioned(raylib, &.{
                 srcdir ++ "/rglfw.c",
@@ -219,6 +229,14 @@ const srcdir = struct {
     }
 }.getSrcDir();
 
+fn getOsTagVersioned(target: anytype) std.Target.Os.Tag {
+    if (comptime builtin.zig_version.minor >= 12) {
+        return target.result.os.tag;
+    } else {
+        return target.getOsTag();
+    }
+}
+
 fn addCSourceFilesVersioned(exe: *std.Build.Step.Compile, files: []const []const u8, flags: []const []const u8) void {
     if (comptime builtin.zig_version.minor >= 12) {
         exe.addCSourceFiles(.{