@pkmn/engine 0.1.0-dev.04c4d944 → 0.1.0-dev.0cabf16e

package/build.zig

@@ -8,6 +8,17 @@ pub const Options = struct {
     calc: ?bool = null,
 };
 
+const Step = if (@hasDecl(std.Build, "Step")) std.Build.Step else .{
+    .Compile = std.Build.CompileStep,
+    .Options = std.Build.OptionsStep,
+    .Run = std.Build.RunStep,
+};
+const has_path = @hasField(std.Build.LazyPath, "path");
+const root_module = @hasField(Step.Compile, "root_module");
+const force_pic = !@hasField(std.Build.SharedLibraryOptions, "pic");
+const ResolvedTarget =
+    if (@hasDecl(std.Build, "ResolvedTarget")) std.Build.ResolvedTarget else std.zig.CrossTarget;
+
 pub fn module(b: *std.Build, options: Options) *std.Build.Module {
     const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
     const build_options = b.addOptions();
@@ -15,16 +26,20 @@ pub fn module(b: *std.Build, options: Options) *std.Build.Module {
     build_options.addOption(?bool, "log", options.log);
     build_options.addOption(?bool, "chance", options.chance);
     build_options.addOption(?bool, "calc", options.calc);
-    return b.createModule(.{
-        .source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
-        .dependencies = &.{.{ .name = "build_options", .module = build_options.createModule() }},
-    });
+
+    const root_source_file = .{ .cwd_relative = dirname ++ "/src/lib/pkmn.zig" };
+    const imports = &.{.{ .name = "build_options", .module = build_options.createModule() }};
+    return b.createModule(if (@hasDecl(std.Build, "CreateModuleOptions"))
+        .{ .source_file = root_source_file, .dependencies = imports }
+    else
+        .{ .root_source_file = root_source_file, .imports = imports });
 }
 
 pub fn build(b: *std.Build) !void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
 
+    const default: ?bool = if (force_pic) false else null;
     const node_headers = b.option([]const u8, "node-headers", "Path to node-headers");
     const node_import_lib =
         b.option([]const u8, "node-import-library", "Path to node import library (Windows)");
@@ -32,8 +47,8 @@ pub fn build(b: *std.Build) !void {
     const wasm_stack_size =
         b.option(u64, "wasm-stack-size", "The size of WASM stack") orelse std.wasm.page_size;
     const dynamic = b.option(bool, "dynamic", "Build a dynamic library") orelse false;
-    const strip = b.option(bool, "strip", "Strip debugging symbols from binary") orelse false;
-    const pic = b.option(bool, "pic", "Force position independent code") orelse false;
+    const strip = b.option(bool, "strip", "Strip debugging symbols from binary") orelse default;
+    const pic = b.option(bool, "pic", "Force position independent code") orelse default;
     const emit_asm = b.option(bool, "emit-asm", "Output .s (assembly code)") orelse false;
     const emit_ll = b.option(bool, "emit-ll", "Output .ll (LLVM IR)") orelse false;
 
@@ -44,9 +59,15 @@ pub fn build(b: *std.Build) !void {
     defer parsed.deinit();
     const version = parsed.value.object.get("version").?.string;
     const description = parsed.value.object.get("description").?.string;
-    var repository = std.mem.split(u8, parsed.value.object.get("repository").?.string, ":");
+    var repository = std.mem.splitSequence(u8, parsed.value.object.get("repository").?.string, ":");
     std.debug.assert(std.mem.eql(u8, repository.first(), "github"));
 
+    const fast = try std.SemanticVersion.parse("0.12.0-dev.866+3a47bc715");
+    if (optimize != .Debug and fast.order(builtin.zig_version) == .lt) {
+        std.log.warn("Release builds are ~10-20% slower than before Zig " ++
+            "v0.12.0-dev.866+3a47bc715 due to ziglang/zig#17768", .{});
+    }
+
     const showdown =
         b.option(bool, "showdown", "Enable Pokémon Showdown compatibility mode") orelse false;
     const log = b.option(bool, "log", "Enable protocol message logging") orelse false;
@@ -61,30 +82,47 @@ pub fn build(b: *std.Build) !void {
 
     const name = if (showdown) "pkmn-showdown" else "pkmn";
 
+    const pkmn = if (@hasDecl(std.Build, "CreateModuleOptions")) null else b.addModule("pkmn", .{
+        .root_source_file = if (has_path)
+            .{ .path = "src/lib/pkmn.zig" }
+        else
+            b.path("src/lib/pkmn.zig"),
+        .optimize = optimize,
+        .target = target,
+        .imports = &.{.{ .name = "build_options", .module = options.createModule() }},
+    });
+
     var c = false;
     if (node_headers) |headers| {
         const addon = b.fmt("{s}.node", .{name});
-        const lib = b.addSharedLibrary(.{
+        const path = if (has_path) .{ .path = "src/lib/node.zig" } else b.path("src/lib/node.zig");
+        const lib = b.addSharedLibrary(if (force_pic) .{
+            .name = addon,
+            .root_source_file = path,
+            .optimize = optimize,
+            .target = target,
+        } else .{
             .name = addon,
-            .main_pkg_path = .{ .path = "." },
-            .root_source_file = .{ .path = "src/lib/binding/node.zig" },
+            .root_source_file = path,
             .optimize = optimize,
             .target = target,
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.addSystemIncludePath(.{ .path = headers });
+        (if (root_module) lib.root_module else lib).addOptions("build_options", options);
+        lib.addSystemIncludePath(if (has_path) .{ .path = headers } else b.path(headers));
         lib.linkLibC();
         if (node_import_lib) |il| {
-            lib.addObjectFile(.{ .path = il });
-        } else if ((try std.zig.system.NativeTargetInfo.detect(target)).target.os.tag == .windows) {
+            lib.addObjectFile(if (has_path) .{ .path = il } else b.path(il));
+        } else if (detect(target).os.tag == .windows) {
             try std.io.getStdErr().writeAll("Must provide --node-import-library path on Windows\n");
             std.process.exit(1);
         }
         lib.linker_allow_shlib_undefined = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
-        if (pic) lib.force_pic = pic;
+        if (force_pic and pic orelse false) lib.force_pic = pic;
         // Always emit to build/lib because this is where the driver code expects to find it
-        // TODO(ziglang/zig#2231): using the following used to work (though was hacky):
+        // TODO: ziglang/zig#2231 - using the following used to work (though was hacky):
         //
         //    lib.emit_bin = .{ .emit_to = b.fmt("build/lib/{s}", .{addon}) };
         //    b.getInstallStep().dependOn(&lib.step);
@@ -93,59 +131,116 @@ pub fn build(b: *std.Build) !void {
         // rename the file ourself in install-pkmn-engine
         b.installArtifact(lib);
     } else if (wasm) {
-        const lib = b.addSharedLibrary(.{
-            .name = name,
-            .main_pkg_path = .{ .path = "." },
-            .root_source_file = .{ .path = "src/lib/binding/wasm.zig" },
-            .optimize = switch (optimize) {
-                .ReleaseFast, .ReleaseSafe => .ReleaseSmall,
-                else => optimize,
-            },
-            .target = .{ .cpu_arch = .wasm32, .os_tag = .freestanding },
-        });
-        lib.addOptions("build_options", options);
-        lib.stack_size = wasm_stack_size;
-        lib.rdynamic = true;
-        lib.strip = strip;
-        if (pic) lib.force_pic = pic;
+        const entry = @hasDecl(Step.Compile, "Entry");
+        const mode = switch (optimize) {
+            .ReleaseFast, .ReleaseSafe => .ReleaseSmall,
+            else => optimize,
+        };
+        const freestanding = if (@hasDecl(std.Build, "resolveTargetQuery"))
+            b.resolveTargetQuery(.{ .cpu_arch = .wasm32, .os_tag = .freestanding })
+        else
+            ResolvedTarget{ .cpu_arch = .wasm32, .os_tag = .freestanding };
+        const path = if (has_path) .{ .path = "src/lib/wasm.zig" } else b.path("src/lib/wasm.zig");
+        const bin = if (entry) bin: {
+            const exe = b.addExecutable(if (force_pic) .{
+                .name = name,
+                .root_source_file = path,
+                .optimize = mode,
+                .target = freestanding,
+            } else .{
+                .name = name,
+                .root_source_file = path,
+                .optimize = mode,
+                .target = freestanding,
+                .strip = strip,
+                .pic = pic,
+            });
+            (if (root_module) exe.root_module else exe).export_symbol_names = &[_][]const u8{
+                "SHOWDOWN",
+                "LOG",
+                "CHANCE",
+                "CALC",
+                "GEN1_CHOICES_SIZE",
+                "GEN1_LOGS_SIZE",
+            };
+            exe.entry = .disabled;
+            break :bin exe;
+        } else bin: {
+            const lib = b.addSharedLibrary(.{
+                .name = name,
+                .root_source_file = path,
+                .optimize = mode,
+                .target = freestanding,
+            });
+            lib.rdynamic = true;
+            break :bin lib;
+        };
+        bin.stack_size = wasm_stack_size;
+        if (@hasDecl(@TypeOf(bin.*), "strip")) bin.strip = strip orelse false;
+        if (force_pic and pic orelse false) bin.force_pic = pic;
+        (if (root_module) bin.root_module else bin).addOptions("build_options", options);
+
         const opt = b.findProgram(&.{"wasm-opt"}, &.{"./node_modules/.bin"}) catch null;
         if (optimize != .Debug and opt != null) {
             const out = b.fmt("build/lib/{s}.wasm", .{name});
             const sh = b.addSystemCommand(&.{ opt.?, "-O4" });
-            sh.addArtifactArg(lib);
+            sh.addArtifactArg(bin);
             sh.addArg("-o");
-            sh.addFileSourceArg(.{ .path = out });
+            if (@hasDecl(@TypeOf(sh.*), "addFileSourceArg")) {
+                sh.addFileSourceArg(if (has_path) .{ .path = out } else b.path(out));
+            } else {
+                sh.addFileArg(if (has_path) .{ .path = out } else b.path(out));
+            }
             b.getInstallStep().dependOn(&sh.step);
+            if (!entry) b.installArtifact(bin);
+        } else if (entry) {
+            b.getInstallStep().dependOn(&b.addInstallArtifact(bin, .{
+                .dest_dir = .{ .override = std.Build.InstallDir{ .lib = {} } },
+            }).step);
         }
-        b.installArtifact(lib);
     } else if (dynamic) {
-        const lib = b.addSharedLibrary(.{
+        const path = if (has_path) .{ .path = "src/lib/c.zig" } else b.path("src/lib/c.zig");
+        const lib = b.addSharedLibrary(if (force_pic) .{
             .name = name,
-            .main_pkg_path = .{ .path = "." },
-            .root_source_file = .{ .path = "src/lib/binding/c.zig" },
+            .root_source_file = path,
             .version = try std.SemanticVersion.parse(version),
             .optimize = optimize,
             .target = target,
+        } else .{
+            .name = name,
+            .root_source_file = path,
+            .version = try std.SemanticVersion.parse(version),
+            .optimize = optimize,
+            .target = target,
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.addIncludePath(.{ .path = "src/include" });
+        (if (root_module) lib.root_module else lib).addOptions("build_options", options);
+        lib.addIncludePath(if (has_path) .{ .path = "src/include" } else b.path("src/include"));
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
-        if (pic) lib.force_pic = pic;
+        if (force_pic and pic orelse false) lib.force_pic = pic;
         b.installArtifact(lib);
         c = true;
     } else {
-        const lib = b.addStaticLibrary(.{
+        const path = if (has_path) .{ .path = "src/lib/c.zig" } else b.path("src/lib/c.zig");
+        const lib = b.addStaticLibrary(if (force_pic) .{
             .name = name,
-            .main_pkg_path = .{ .path = "." },
-            .root_source_file = .{ .path = "src/lib/binding/c.zig" },
+            .root_source_file = path,
             .optimize = optimize,
             .target = target,
+        } else .{
+            .name = name,
+            .root_source_file = path,
+            .optimize = optimize,
+            .target = target,
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.addIncludePath(.{ .path = "src/include" });
+        (if (root_module) lib.root_module else lib).addOptions("build_options", options);
+        lib.addIncludePath(if (has_path) .{ .path = "src/include" } else b.path("src/include"));
         lib.bundle_compiler_rt = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
-        if (pic) lib.force_pic = pic;
+        if (force_pic and pic orelse false) lib.force_pic = pic;
         if (emit_asm) {
             b.getInstallStep().dependOn(&b.addInstallFileWithDir(
                 lib.getEmittedAsm(),
@@ -165,15 +260,17 @@ pub fn build(b: *std.Build) !void {
     }
 
     if (c) {
-        const header = b.addInstallFileWithDir(
-            .{ .path = "src/include/pkmn.h" },
-            .header,
-            "pkmn.h",
-        );
+        const path =
+            if (has_path) .{ .path = "src/include/pkmn.h" } else b.path("src/include/pkmn.h");
+        const header = b.addInstallFileWithDir(path, .header, "pkmn.h");
         b.getInstallStep().dependOn(&header.step);
 
         const pc = b.fmt("lib{s}.pc", .{name});
-        const file = try b.cache_root.join(b.allocator, &.{pc});
+        const file = try std.fs.path.relative(
+            b.allocator,
+            try std.process.getCwdAlloc(b.allocator),
+            try b.cache_root.join(b.allocator, &.{pc}),
+        );
         const pkgconfig_file = try std.fs.cwd().createFile(file, .{});
 
         const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
@@ -206,7 +303,7 @@ pub fn build(b: *std.Build) !void {
     // TODO: tests can be run multiple times due to @imports
     const tests = TestStep.create(b, options, config);
 
-    var exes = std.ArrayList(*std.Build.CompileStep).init(b.allocator);
+    var exes = std.ArrayList(*Step.Compile).init(b.allocator);
     const tools: ToolConfig = .{
         .options = .{
             .showdown = showdown,
@@ -214,6 +311,7 @@ pub fn build(b: *std.Build) !void {
             .chance = chance,
             .calc = calc,
         },
+        .module = pkmn,
         .general = config,
         .tool = .{
             .tests = if (tests.build) tests else null,
@@ -224,37 +322,43 @@ pub fn build(b: *std.Build) !void {
     var benchmark_config = tools;
     benchmark_config.general.optimize = .ReleaseFast;
     benchmark_config.general.strip = true;
-    const benchmark = tool(b, "src/test/benchmark.zig", benchmark_config);
+    const benchmark = try tool(b, "src/test/benchmark.zig", benchmark_config);
 
     var fuzz_config = tools;
     fuzz_config.general.strip = false;
     fuzz_config.tool.name = "fuzz";
-    const fuzz = tool(b, "src/test/fuzz.zig", fuzz_config);
-
-    const analyze = tool(b, "src/tools/analyze.zig", tools);
-    const dump = tool(b, "src/tools/dump.zig", tools);
-    const serde = tool(b, "src/tools/serde.zig", tools);
-    const transitions = tool(b, "src/tools/transitions.zig", tools);
-
-    b.step("analyze", "Run LLVM analysis tool").dependOn(&analyze.step);
-    b.step("benchmark", "Run benchmark code").dependOn(&benchmark.step);
-    b.step("dump", "Run protocol dump tool").dependOn(&dump.step);
-    b.step("fuzz", "Run fuzz tester").dependOn(&fuzz.step);
-    b.step("serde", "Run serialization/deserialization tool").dependOn(&serde.step);
+    const fuzz = try tool(b, "src/test/fuzz.zig", fuzz_config);
+
+    const analyze = try tool(b, "src/tools/analyze.zig", tools);
+    const dump = try tool(b, "src/tools/dump.zig", tools);
+    const transitions = try tool(b, "src/tools/transitions.zig", tools);
+
+    // FIXME: serde randomly fails to build in some release configurations
+    var hack = tools;
+    if (optimize != .Debug) hack.tool.tests = null;
+    const serde = try tool(b, "src/tools/serde.zig", hack);
+
+    if (analyze) |t| b.step("analyze", "Run LLVM analysis tool").dependOn(&t.step);
+    if (benchmark) |t| b.step("benchmark", "Run benchmark code").dependOn(&t.step);
+    if (dump) |t| b.step("dump", "Run protocol dump tool").dependOn(&t.step);
+    if (fuzz) |t| b.step("fuzz", "Run fuzz tester").dependOn(&t.step);
+    if (serde) |t| b.step("serde", "Run serialization/deserialization tool").dependOn(&t.step);
     b.step("test", "Run all tests").dependOn(&tests.step);
     b.step("tools", "Install tools").dependOn(&ToolsStep.create(b, &exes).step);
-    b.step("transitions", "Visualize transitions algorithm search").dependOn(&transitions.step);
+    if (transitions) |t| {
+        b.step("transitions", "Visualize transitions algorithm search").dependOn(&t.step);
+    }
 }
 
 fn maybeStrip(
     b: *std.Build,
-    artifact: *std.Build.CompileStep,
+    artifact: *Step.Compile,
     step: *std.Build.Step,
-    strip: bool,
+    strip: ?bool,
     cmd: ?[]const u8,
 ) void {
-    artifact.strip = strip;
-    if (!strip or cmd == null) return;
+    if (@hasDecl(@TypeOf(artifact.*), "strip")) artifact.strip = strip orelse false;
+    if (!(strip orelse false) or cmd == null) return;
     // Using `strip -r -u` for dynamic libraries is supposed to work on macOS but doesn't...
     const mac = builtin.os.tag == .macos;
     if (mac and artifact.isDynamicLibrary()) return;
@@ -266,10 +370,10 @@ fn maybeStrip(
 }
 
 const Config = struct {
-    target: std.zig.CrossTarget,
+    target: ResolvedTarget,
     optimize: std.builtin.OptimizeMode,
-    pic: bool,
-    strip: bool,
+    pic: ?bool,
+    strip: ?bool,
     cmd: ?[]const u8,
 };
 
@@ -277,32 +381,37 @@ const TestStep = struct {
     step: std.Build.Step,
     build: bool,
 
-    pub fn create(b: *std.Build, options: *std.Build.OptionsStep, config: Config) *TestStep {
+    pub fn create(b: *std.Build, options: *Step.Options, config: Config) *TestStep {
         const coverage = b.option([]const u8, "test-coverage", "Generate test coverage");
-        const test_file = b.option([]const u8, "test-file", "Input file for test");
         const test_filter =
             b.option([]const u8, "test-filter", "Skip tests that do not match filter");
 
         const self = b.allocator.create(TestStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Run all tests", .owner = b });
-        self.* = TestStep{ .step = step, .build = test_filter == null };
-
-        const path = test_file orelse "src/lib/test.zig";
-        const tests = b.addTest(.{
-            .name = b.fmt("{s}-{s}", .{
-                std.fs.path.basename(std.fs.path.dirname(path).?),
-                std.fs.path.stem(std.fs.path.basename(path)),
-            }),
-            .main_pkg_path = .{ .path = "." },
-            .root_source_file = .{ .path = path },
+        self.* = .{ .step = step, .build = test_filter == null };
+
+        const path = if (has_path) .{ .path = "src/lib/test.zig" } else b.path("src/lib/test.zig");
+        const tests = b.addTest(if (force_pic) .{
+            .root_source_file = path,
             .optimize = config.optimize,
             .target = config.target,
             .filter = test_filter,
+        } else .{
+            .root_source_file = path,
+            .optimize = config.optimize,
+            .target = config.target,
+            .filter = test_filter,
+            .single_threaded = true,
+            .strip = config.strip,
+            .pic = config.pic,
         });
-        tests.addOptions("build_options", options);
-        tests.single_threaded = true;
+        (if (root_module) tests.root_module else tests).addOptions("build_options", options);
+
         maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
-        if (config.pic) tests.force_pic = config.pic;
+        if (force_pic) {
+            tests.single_threaded = true;
+            if (config.pic orelse false) tests.force_pic = config.pic;
+        }
         if (coverage) |c| {
             tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
         }
@@ -314,30 +423,51 @@ const TestStep = struct {
 
 const ToolConfig = struct {
     options: Options,
+    module: ?*std.Build.Module,
     general: Config,
     tool: struct {
         tests: ?*TestStep,
         name: ?[]const u8 = null,
-        exes: *std.ArrayList(*std.Build.CompileStep),
+        exes: *std.ArrayList(*Step.Compile),
     },
 };
 
-fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep {
+fn tool(b: *std.Build, path: []const u8, config: ToolConfig) !?*Step.Run {
+    std.fs.cwd().access(path, .{}) catch |err| switch (err) {
+        error.FileNotFound => return null,
+        else => |e| return e,
+    };
     var name = config.tool.name orelse std.fs.path.basename(path);
     const index = std.mem.lastIndexOfScalar(u8, name, '.');
     if (index) |i| name = name[0..i];
     if (config.options.showdown orelse false) name = b.fmt("{s}-showdown", .{name});
 
-    const exe = b.addExecutable(.{
+    const exe = b.addExecutable(if (force_pic) .{
         .name = name,
-        .root_source_file = .{ .path = path },
+        .root_source_file = if (has_path) .{ .path = path } else b.path(path),
         .target = config.general.target,
         .optimize = config.general.optimize,
+    } else .{
+        .name = name,
+        .root_source_file = if (has_path) .{ .path = path } else b.path(path),
+        .target = config.general.target,
+        .optimize = config.general.optimize,
+        .single_threaded = true,
+        .strip = config.general.strip,
+        .pic = config.general.pic,
     });
-    exe.addModule("pkmn", module(b, config.options));
 
-    exe.single_threaded = true;
-    if (config.general.pic) exe.force_pic = config.general.pic;
+    if (root_module) {
+        const import = if (config.module) |m| m else module(b, config.options);
+        exe.root_module.addImport("pkmn", import);
+    } else {
+        exe.addModule("pkmn", module(b, config.options));
+    }
+
+    if (force_pic) {
+        exe.single_threaded = true;
+        if (config.general.pic orelse false) exe.force_pic = config.general.pic;
+    }
     if (config.tool.tests) |ts| ts.step.dependOn(&exe.step);
     config.tool.exes.append(exe) catch @panic("OOM");
 
@@ -351,11 +481,16 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
 const ToolsStep = struct {
     step: std.Build.Step,
 
-    pub fn create(b: *std.Build, exes: *std.ArrayList(*std.Build.CompileStep)) *ToolsStep {
+    pub fn create(b: *std.Build, exes: *std.ArrayList(*Step.Compile)) *ToolsStep {
         const self = b.allocator.create(ToolsStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Install tools", .owner = b });
-        self.* = ToolsStep{ .step = step };
+        self.* = .{ .step = step };
         for (exes.items) |t| self.step.dependOn(&b.addInstallArtifact(t, .{}).step);
         return self;
     }
 };
+
+fn detect(target: anytype) std.Target {
+    if (@hasField(@TypeOf(target), "result")) return target.result;
+    return (std.zig.system.NativeTargetInfo.detect(target) catch unreachable).target;
+}