@pkmn/engine 0.1.0-dev.3a62fd35 → 0.1.0-dev.3d09f03a

package/build.zig

@@ -1,5 +1,9 @@
-const std = @import("std");
 const builtin = @import("builtin");
+const std = @import("std");
+
+fn ArrayList(comptime T: type) type {
+    return std.array_list.Aligned(T, null);
+}
 
 pub const Options = struct {
     showdown: ?bool = null,
@@ -9,16 +13,16 @@ pub const Options = struct {
 };
 
 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();
     build_options.addOption(?bool, "showdown", options.showdown);
     build_options.addOption(?bool, "log", options.log);
     build_options.addOption(?bool, "chance", options.chance);
     build_options.addOption(?bool, "calc", options.calc);
-    return b.createModule(.{
-        .root_source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
-        .imports = &.{.{ .name = "build_options", .module = build_options.createModule() }},
-    });
+
+    const root_source_file = b.path("src/lib/pkmn.zig");
+    const imports: []const std.Build.Module.Import =
+        &.{.{ .name = "build_options", .module = build_options.createModule() }};
+    return b.createModule(.{ .root_source_file = root_source_file, .imports = imports });
 }
 
 pub fn build(b: *std.Build) !void {
@@ -28,6 +32,10 @@ pub fn build(b: *std.Build) !void {
     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)");
+    const demo = if (try exists(b, "src/tools/demo.zig"))
+        b.option(bool, "demo", "Build the demo library") orelse false
+    else
+        false;
     const wasm = b.option(bool, "wasm", "Build a WASM library") orelse false;
     const wasm_stack_size =
         b.option(u64, "wasm-stack-size", "The size of WASM stack") orelse std.wasm.page_size;
@@ -44,7 +52,7 @@ 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.splitScalar(u8, parsed.value.object.get("repository").?.string, ':');
     std.debug.assert(std.mem.eql(u8, repository.first(), "github"));
 
     const showdown =
@@ -52,6 +60,7 @@ pub fn build(b: *std.Build) !void {
     const log = b.option(bool, "log", "Enable protocol message logging") orelse false;
     const chance = b.option(bool, "chance", "Enable update probability tracking") orelse false;
     const calc = b.option(bool, "calc", "Enable damage calculator support") orelse false;
+    const extra = b.option([]const []const u8, "option", "Enable extra option");
 
     const options = b.addOptions();
     options.addOption(?bool, "showdown", showdown);
@@ -59,32 +68,67 @@ pub fn build(b: *std.Build) !void {
     options.addOption(?bool, "chance", chance);
     options.addOption(?bool, "calc", calc);
 
+    if (extra) |opts| {
+        for (opts) |opt| {
+            if (std.mem.indexOfScalar(u8, opt, '=')) |i| {
+                options.addOption(?bool, opt[0..i], if (std.mem.eql(u8, opt[i + 1 ..], "true"))
+                    true
+                else if (std.mem.eql(u8, opt[i + 1 ..], "false"))
+                    false
+                else {
+                    std.log.err("Invalid option: {s}\n", .{opt});
+                    return error.InvalidOption;
+                });
+            } else {
+                options.addOption(?bool, opt, true);
+            }
+        }
+    }
+
     const name = if (showdown) "pkmn-showdown" else "pkmn";
 
+    const pkmn: *std.Build.Module = b.addModule("pkmn", .{
+        .root_source_file = 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 translate_c = b.addTranslateC(.{
+            .root_source_file = b.path("src/lib/napi.h"),
+            .target = target,
+            .optimize = optimize,
+        });
+        translate_c.addSystemIncludePath(b.path(headers));
         const addon = b.fmt("{s}.node", .{name});
-        const lib = b.addSharedLibrary(.{
+        const path = b.path("src/lib/node.zig");
+        const lib = b.addLibrary(.{
+            .linkage = .dynamic,
             .name = addon,
-            .root_source_file = .{ .path = "src/lib/node.zig" },
-            .optimize = optimize,
-            .target = target,
-            .strip = strip,
-            .pic = pic,
+            .root_module = b.createModule(.{
+                .root_source_file = path,
+                .optimize = optimize,
+                .target = target,
+                .strip = strip,
+                .pic = pic,
+            }),
         });
         lib.root_module.addOptions("build_options", options);
-        lib.addSystemIncludePath(.{ .path = headers });
-        lib.linkLibC();
+        lib.root_module.addImport("napi", translate_c.createModule());
+        lib.root_module.link_libc = true;
         if (node_import_lib) |il| {
-            lib.addObjectFile(.{ .path = il });
+            lib.root_module.addObjectFile(b.path(il));
         } else if (target.result.os.tag == .windows) {
-            try std.io.getStdErr().writeAll("Must provide --node-import-library path on Windows\n");
+            var err = std.Io.File.stderr().writer(b.graph.io, &.{});
+            try err.interface.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);
         // 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,67 +137,46 @@ pub fn build(b: *std.Build) !void {
         // rename the file ourself in install-pkmn-engine
         b.installArtifact(lib);
     } else if (wasm) {
-        const exe = b.addExecutable(.{
-            .name = name,
-            .root_source_file = .{ .path = "src/lib/wasm.zig" },
-            .optimize = switch (optimize) {
-                .ReleaseFast, .ReleaseSafe => .ReleaseSmall,
-                else => optimize,
-            },
-            .target = b.resolveTargetQuery(.{ .cpu_arch = .wasm32, .os_tag = .freestanding }),
-            .strip = strip,
-            .pic = pic,
-        });
-        exe.root_module.addOptions("build_options", options);
-        exe.root_module.export_symbol_names = &[_][]const u8{
-            "SHOWDOWN",
-            "LOG",
-            "CHANCE",
-            "CALC",
-            "GEN1_CHOICES_SIZE",
-            "GEN1_LOGS_SIZE",
-        };
-        exe.entry = .disabled;
-        exe.stack_size = wasm_stack_size;
-        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(exe);
-            sh.addArg("-o");
-            sh.addFileArg(.{ .path = out });
-            b.getInstallStep().dependOn(&sh.step);
-        } else {
-            b.getInstallStep().dependOn(&b.addInstallArtifact(exe, .{
-                .dest_dir = .{ .override = std.Build.InstallDir{ .lib = {} } },
-            }).step);
-        }
+        const path = "src/lib/wasm.zig";
+        try buildWasm(b, name, path, optimize, strip, pic, wasm_stack_size, null, options);
+    } else if (demo) {
+        const path = "src/tools/demo.zig";
+        const n = if (showdown) "demo-showdown" else "demo";
+        const mod = pkmn;
+        try buildWasm(b, n, path, optimize, strip, pic, wasm_stack_size, mod, options);
     } else if (dynamic) {
-        const lib = b.addSharedLibrary(.{
+        const path = b.path("src/lib/c.zig");
+        const lib = b.addLibrary(.{
+            .linkage = .dynamic,
             .name = name,
-            .root_source_file = .{ .path = "src/lib/c.zig" },
-            .version = try std.SemanticVersion.parse(version),
-            .optimize = optimize,
-            .target = target,
-            .strip = strip,
-            .pic = pic,
+            .root_module = b.createModule(.{
+                .root_source_file = path,
+                .optimize = optimize,
+                .target = target,
+                .strip = strip,
+                .pic = pic,
+            }),
         });
         lib.root_module.addOptions("build_options", options);
-        lib.addIncludePath(.{ .path = "src/include" });
+        lib.root_module.addIncludePath(b.path("src/include"));
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         b.installArtifact(lib);
         c = true;
     } else {
-        const lib = b.addStaticLibrary(.{
+        const path = b.path("src/lib/c.zig");
+        const lib = b.addLibrary(.{
+            .linkage = .static,
             .name = name,
-            .root_source_file = .{ .path = "src/lib/c.zig" },
-            .optimize = optimize,
-            .target = target,
-            .strip = strip,
-            .pic = pic,
+            .root_module = b.createModule(.{
+                .root_source_file = path,
+                .optimize = optimize,
+                .target = target,
+                .strip = strip,
+                .pic = pic,
+            }),
         });
         lib.root_module.addOptions("build_options", options);
-        lib.addIncludePath(.{ .path = "src/include" });
+        lib.root_module.addIncludePath(b.path("src/include"));
         lib.bundle_compiler_rt = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (emit_asm) {
@@ -175,20 +198,25 @@ pub fn build(b: *std.Build) !void {
     }
 
     if (c) {
-        const header = b.addInstallFileWithDir(
-            .{ .path = "src/include/pkmn.h" },
-            .header,
-            "pkmn.h",
-        );
+        const path = 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 pkgconfig_file = try std.fs.cwd().createFile(file, .{});
+        const cwd = try std.process.currentPathAlloc(b.graph.io, b.allocator);
+        const file = try std.Io.Dir.path.relative(
+            b.allocator,
+            cwd,
+            &b.graph.environ_map,
+            cwd,
+            try b.cache_root.join(b.allocator, &.{pc}),
+        );
+        const pkgconfig_file = try std.Io.Dir.cwd().createFile(b.graph.io, file, .{});
+        defer pkgconfig_file.close(b.graph.io);
 
         const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
-        const writer = pkgconfig_file.writer();
-        try writer.print(
+        var writer = pkgconfig_file.writer(b.graph.io, &.{});
+        try writer.interface.print(
             \\prefix={0s}/{1s}
             \\includedir=${{prefix}}/include
             \\libdir=${{prefix}}/lib
@@ -200,12 +228,11 @@ pub fn build(b: *std.Build) !void {
             \\Cflags: -I${{includedir}}
             \\Libs: -L${{libdir}} -l{2s}
         , .{ dirname, b.install_path, name, repository.next().?, description, version });
-        defer pkgconfig_file.close();
 
         b.installFile(file, b.fmt("share/pkgconfig/{s}", .{pc}));
     }
 
-    const config = .{
+    const config: Config = .{
         .target = target,
         .optimize = optimize,
         .pic = pic,
@@ -216,7 +243,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.Step.Compile).init(b.allocator);
+    var exes: ArrayList(*std.Build.Step.Compile) = .empty;
     const tools: ToolConfig = .{
         .options = .{
             .showdown = showdown,
@@ -224,6 +251,7 @@ pub fn build(b: *std.Build) !void {
             .chance = chance,
             .calc = calc,
         },
+        .module = pkmn,
         .general = config,
         .tool = .{
             .tests = if (tests.build) tests else null,
@@ -262,6 +290,85 @@ pub fn build(b: *std.Build) !void {
     }
 }
 
+fn buildWasm(
+    b: *std.Build,
+    name: []const u8,
+    root_src_file: []const u8,
+    optimize: std.builtin.OptimizeMode,
+    strip: ?bool,
+    pic: ?bool,
+    wasm_stack_size: u64,
+    import: ?*std.Build.Module,
+    options: anytype,
+) !void {
+    const mode = switch (optimize) {
+        .ReleaseFast, .ReleaseSafe => .ReleaseSmall,
+        else => optimize,
+    };
+    // https://webassembly.org/features/
+    var features = std.Target.wasm.featureSet(&.{
+        .atomics,
+        .bulk_memory,
+        // .exception_handling,
+        .extended_const,
+        // .half_precision,
+        // .multimemory,
+        .mutable_globals,
+        .nontrapping_fptoint,
+        .reference_types,
+        // .relaxed_simd,
+        .sign_ext,
+        .simd128,
+        // .tail_call,
+    });
+    if (builtin.zig_version.order(try std.SemanticVersion.parse("0.12.0")) != .lt) {
+        features.addFeature(@intFromEnum(std.Target.wasm.Feature.multivalue));
+    }
+    const freestanding = b.resolveTargetQuery(.{
+        .cpu_arch = .wasm32,
+        .os_tag = .freestanding,
+        .cpu_features_add = features,
+    });
+    const path = b.path(root_src_file);
+    const exe = b.addExecutable(.{
+        .name = name,
+        .root_module = b.createModule(.{
+            .root_source_file = path,
+            .optimize = mode,
+            .target = freestanding,
+            .strip = strip,
+            .pic = pic,
+        }),
+    });
+
+    var file = try std.Io.Dir.cwd().openFile(b.graph.io, root_src_file, .{});
+    defer file.close(b.graph.io);
+    var reader = file.reader(b.graph.io, &.{});
+    const bytes = try reader.interface.allocRemaining(b.allocator, .unlimited);
+    exe.root_module.export_symbol_names = try exports(b, bytes);
+    exe.entry = .disabled;
+
+    if (import) |i| {
+        exe.root_module.addImport("pkmn", i);
+    }
+    exe.stack_size = wasm_stack_size;
+    exe.root_module.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.?, "--enable-bulk-memory", "--enable-simd", "-O4" });
+        sh.addArtifactArg(exe);
+        sh.addArg("-o");
+        sh.addFileArg(b.path(out));
+        b.getInstallStep().dependOn(&sh.step);
+    } else {
+        b.getInstallStep().dependOn(&b.addInstallArtifact(exe, .{
+            .dest_dir = .{ .override = std.Build.InstallDir{ .lib = {} } },
+        }).step);
+    }
+}
+
 fn maybeStrip(
     b: *std.Build,
     artifact: *std.Build.Step.Compile,
@@ -294,7 +401,6 @@ const TestStep = struct {
 
     pub fn create(b: *std.Build, options: *std.Build.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");
 
@@ -302,21 +408,20 @@ const TestStep = struct {
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Run all tests", .owner = b });
         self.* = .{ .step = step, .build = test_filter == null };
 
-        const path = test_file orelse "src/lib/test.zig";
+        const path = b.path("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)),
+            .root_module = b.createModule(.{
+                .root_source_file = path,
+                .optimize = config.optimize,
+                .target = config.target,
+                .single_threaded = true,
+                .strip = config.strip,
+                .pic = config.pic,
             }),
-            .root_source_file = .{ .path = path },
-            .optimize = config.optimize,
-            .target = config.target,
-            .filter = test_filter,
-            .single_threaded = true,
-            .strip = config.strip,
-            .pic = config.pic,
+            .filters = if (test_filter) |filter| &.{filter} else &.{},
         });
         tests.root_module.addOptions("build_options", options);
+
         maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
         if (coverage) |c| {
             tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
@@ -329,19 +434,17 @@ 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.Step.Compile),
+        exes: *ArrayList(*std.Build.Step.Compile),
     },
 };
 
 fn tool(b: *std.Build, path: []const u8, config: ToolConfig) !?*std.Build.Step.Run {
-    std.fs.cwd().access(path, .{}) catch |err| switch (err) {
-        error.FileNotFound => return null,
-        else => |e| return e,
-    };
+    if (!try exists(b, path)) return null;
     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];
@@ -349,17 +452,23 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) !?*std.Build.Step.R
 
     const exe = b.addExecutable(.{
         .name = name,
-        .root_source_file = .{ .path = path },
-        .target = config.general.target,
-        .optimize = config.general.optimize,
-        .single_threaded = true,
-        .strip = config.general.strip,
-        .pic = config.general.pic,
+        .root_module = b.createModule(.{
+            .root_source_file = b.path(path),
+            .target = config.general.target,
+            .optimize = config.general.optimize,
+            .strip = config.general.strip,
+            .pic = config.general.pic,
+        }),
     });
-    exe.root_module.addImport("pkmn", module(b, config.options));
+
+    const import = if (config.module) |m| m else module(b, config.options);
+    exe.root_module.addImport("pkmn", import);
+    if (config.general.target.result.os.tag == .windows) {
+        exe.root_module.linkSystemLibrary("advapi32", .{});
+    }
 
     if (config.tool.tests) |ts| ts.step.dependOn(&exe.step);
-    config.tool.exes.append(exe) catch @panic("OOM");
+    config.tool.exes.append(b.allocator, exe) catch @panic("OOM");
 
     const run = b.addRunArtifact(exe);
     maybeStrip(b, exe, &run.step, config.general.strip, config.general.cmd);
@@ -368,10 +477,18 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) !?*std.Build.Step.R
     return run;
 }
 
+fn exists(b: *std.Build, path: []const u8) !bool {
+    std.Io.Dir.cwd().access(b.graph.io, path, .{}) catch |err| switch (err) {
+        error.FileNotFound => return false,
+        else => |e| return e,
+    };
+    return true;
+}
+
 const ToolsStep = struct {
     step: std.Build.Step,
 
-    pub fn create(b: *std.Build, exes: *std.ArrayList(*std.Build.Step.Compile)) *ToolsStep {
+    pub fn create(b: *std.Build, exes: *ArrayList(*std.Build.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.* = .{ .step = step };
@@ -379,3 +496,21 @@ const ToolsStep = struct {
         return self;
     }
 };
+
+pub fn exports(b: *std.Build, bytes: []const u8) ![][]const u8 {
+    var symbols: ArrayList([]const u8) = .empty;
+
+    var it = std.mem.splitSequence(u8, bytes, "export ");
+    _ = it.next();
+    while (it.next()) |s| {
+        if (std.mem.startsWith(u8, s, "const ")) {
+            const i = std.mem.indexOf(u8, s[6..], " ").?;
+            try symbols.append(b.allocator, s[6 .. 6 + i]);
+        } else { // "fn "
+            const i = std.mem.indexOf(u8, s[3..], "(").?;
+            try symbols.append(b.allocator, s[3 .. 3 + i]);
+        }
+    }
+
+    return symbols.items;
+}