@pkmn/engine 0.1.0-dev.f3aaee39 → 0.1.0-dev.f6545544

package/src/lib/{binding → bindings}/node.zig

@@ -1,7 +1,6 @@
-const std = @import("std");
-const pkmn = @import("../pkmn.zig");
-
 const js = @import("../common/js.zig");
+const pkmn = @import("../pkmn.zig");
+const std = @import("std");
 
 const assert = std.debug.assert;
 
@@ -10,16 +9,8 @@ const c = @cImport({
     @cInclude("node_api.h");
 });
 
-export fn napi_register_module_v1(env: c.napi_env, exports: c.napi_value) c.napi_value {
-    const properties = [_]c.napi_property_descriptor{
-        js.Property.init("engine", .{ .value = register(env) }),
-    };
-    assert(c.napi_define_properties(env, exports, properties.len, &properties) == c.napi_ok);
-    return exports;
-}
-
 pub fn register(env: c.napi_env) c.napi_value {
-    var object = js.Object.init(env);
+    const object = js.Object.init(env);
     const properties = [_]c.napi_property_descriptor{
         js.Property.init("options", .{ .value = options(env) }),
         js.Property.init("bindings", .{ .value = bindings(env) }),
@@ -29,7 +20,7 @@ pub fn register(env: c.napi_env) c.napi_value {
 }
 
 fn options(env: c.napi_env) c.napi_value {
-    var object = js.Object.init(env);
+    const object = js.Object.init(env);
     const properties = [_]c.napi_property_descriptor{
         js.Property.init("showdown", .{ .value = js.Boolean.init(env, pkmn.options.showdown) }),
         js.Property.init("log", .{ .value = js.Boolean.init(env, pkmn.options.log) }),
@@ -41,7 +32,7 @@ fn options(env: c.napi_env) c.napi_value {
 }
 
 fn bindings(env: c.napi_env) c.napi_value {
-    var array = js.Array.init(env, .{ .length = 1 });
+    const array = js.Array.init(env, .{ .length = 1 });
     js.Array.set(env, array, 0, bind(env, pkmn.gen1));
     return array;
 }
@@ -49,7 +40,7 @@ fn bindings(env: c.napi_env) c.napi_value {
 fn bind(env: c.napi_env, gen: anytype) c.napi_value {
     const choices_size: u32 = @intCast(gen.CHOICES_SIZE);
     const logs_size: u32 = @intCast(gen.LOGS_SIZE);
-    var object = js.Object.init(env);
+    const object = js.Object.init(env);
     const properties = [_]c.napi_property_descriptor{
         js.Property.init("CHOICES_SIZE", .{ .value = js.Number.init(env, choices_size) }),
         js.Property.init("LOGS_SIZE", .{ .value = js.Number.init(env, logs_size) }),
@@ -72,7 +63,6 @@ fn update(gen: anytype) c.napi_callback {
             var len: usize = 0;
             assert(c.napi_get_arraybuffer_info(env, argv[0], &data, &len) == c.napi_ok);
             assert(len == @sizeOf(gen.Battle(gen.PRNG)));
-            assert(data != null);
 
             var battle: *gen.Battle(gen.PRNG) = @alignCast(@ptrCast(data.?));
             const c1: pkmn.Choice = @bitCast(js.Number.get(env, argv[1], u8));
@@ -85,10 +75,9 @@ fn update(gen: anytype) c.napi_callback {
                 else => result: {
                     assert(c.napi_get_arraybuffer_info(env, argv[3], &data, &len) == c.napi_ok);
                     assert(len == gen.LOGS_SIZE);
-                    assert(data != null);
 
-                    var buf = @as([*]u8, @ptrCast(data.?))[0..gen.LOGS_SIZE];
-                    var stream = pkmn.protocol.ByteStream{ .buffer = buf };
+                    const buf = @as([*]u8, @ptrCast(data.?))[0..gen.LOGS_SIZE];
+                    var stream: pkmn.protocol.ByteStream = .{ .buffer = buf };
                     // TODO: extract out
                     var opts = pkmn.battle.options(
                         pkmn.protocol.FixedLog{ .writer = stream.writer() },
@@ -116,7 +105,6 @@ fn choices(gen: anytype) c.napi_callback {
             var len: usize = 0;
             assert(c.napi_get_arraybuffer_info(env, argv[0], &data, &len) == c.napi_ok);
             assert(len == @sizeOf(gen.Battle(gen.PRNG)));
-            assert(data != null);
 
             var battle: *gen.Battle(gen.PRNG) = @alignCast(@ptrCast(data.?));
             const player: pkmn.Player = @enumFromInt(js.Number.get(env, argv[1], u8));
@@ -124,9 +112,8 @@ fn choices(gen: anytype) c.napi_callback {
 
             assert(c.napi_get_arraybuffer_info(env, argv[3], &data, &len) == c.napi_ok);
             assert(len == gen.CHOICES_SIZE);
-            assert(data != null);
 
-            var out = @as([*]pkmn.Choice, @ptrCast(data.?))[0..gen.CHOICES_SIZE];
+            const out = @as([*]pkmn.Choice, @ptrCast(data.?))[0..gen.CHOICES_SIZE];
             const n = battle.choices(player, request, out);
             return js.Number.init(env, @as(u8, @bitCast(n)));
         }

package/src/lib/bindings/wasm.zig

@@ -0,0 +1,59 @@
+const pkmn = @import("../pkmn.zig");
+const std = @import("std");
+
+const assert = std.debug.assert;
+
+const Enum = if (@hasField(std.builtin.Type, "enum")) .@"enum" else .Enum;
+const Strong = if (@hasField(std.builtin.GlobalLinkage, "strong")) .strong else .Strong;
+
+pub const options = pkmn.options;
+
+pub fn gen(comptime num: comptime_int) type {
+    const g = @field(pkmn, "gen" ++ std.fmt.comptimePrint("{d}", .{num}));
+    return struct {
+        pub const CHOICES_SIZE = size(g.CHOICES_SIZE);
+        pub const LOGS_SIZE = size(g.LOGS_SIZE);
+
+        pub fn update(
+            battle: *g.Battle(g.PRNG),
+            c1: pkmn.Choice,
+            c2: pkmn.Choice,
+            options_: ?[*]u8,
+        ) callconv(.C) pkmn.Result {
+            return (if (options_) |o| result: {
+                const buf = @as([*]u8, @ptrCast(o))[0..g.LOGS_SIZE];
+                var stream: pkmn.protocol.ByteStream = .{ .buffer = buf };
+                // TODO: extract out
+                var opts = pkmn.battle.options(
+                    pkmn.protocol.FixedLog{ .writer = stream.writer() },
+                    g.chance.NULL,
+                    g.calc.NULL,
+                );
+                break :result battle.update(c1, c2, &opts);
+            } else battle.update(c1, c2, &g.NULL)) catch unreachable;
+        }
+
+        pub fn choices(
+            battle: *g.Battle(g.PRNG),
+            player: u8,
+            request: u8,
+            buf: [*]u8,
+        ) callconv(.C) u8 {
+            assert(player <= @field(@typeInfo(pkmn.Player), @tagName(Enum)).fields.len);
+            assert(request <= @field(@typeInfo(pkmn.Choice.Type), @tagName(Enum)).fields.len);
+
+            const n = CHOICES_SIZE;
+            return battle.choices(@enumFromInt(player), @enumFromInt(request), @ptrCast(buf[0..n]));
+        }
+    };
+}
+
+pub fn exports() type {
+    @export(gen(1).update, .{ .name = "GEN1_update", .linkage = Strong });
+    @export(gen(1).choices, .{ .name = "GEN1_choices", .linkage = Strong });
+    return struct {};
+}
+
+fn size(n: usize) u32 {
+    return std.math.ceilPowerOfTwo(u32, @as(u32, @intCast(n))) catch unreachable;
+}

package/src/lib/common/array.zig

@@ -0,0 +1,77 @@
+const std = @import("std");
+
+const expectEqual = std.testing.expectEqual;
+const assert = std.debug.assert;
+
+const Int = if (@hasField(std.builtin.Type, "int")) .int else .Int;
+const Enum = if (@hasField(std.builtin.Type, "enum")) .@"enum" else .Enum;
+
+/// Helpers for working with bit-packed arrays of non-powers-of-2 types.
+/// NOTE: ziglang/zig#12547
+pub fn Array(comptime n: comptime_int, comptime U: type) type {
+    return struct {
+        const size = @bitSizeOf(U);
+        const options: std.builtin.Type.Int = .{ .signedness = .unsigned, .bits = size * n };
+        pub const T = @Type(if (@hasField(std.builtin.Type, "int"))
+            .{ .int = options }
+        else
+            .{ .Int = options });
+
+        /// Returns the value stored at index `i` in the array `a`.
+        pub fn get(a: T, i: usize) U {
+            assert(i < n);
+            const shift = i * size;
+            const mask: T = (1 << size) - 1;
+            const result = (a >> @intCast(shift)) & mask;
+            return switch (@typeInfo(U)) {
+                Enum => @enumFromInt(result),
+                Int => @intCast(result),
+                else => unreachable,
+            };
+        }
+
+        /// Sets the value at index `i` to `val` in the array `a`.
+        pub fn set(a: T, i: usize, val: U) T {
+            assert(i < n);
+            const v: T = switch (@typeInfo(U)) {
+                Enum => @intFromEnum(val),
+                Int => @intCast(val),
+                else => unreachable,
+            };
+            const shift = i * size;
+            const mask: T = @as(T, @intCast((1 << size) - 1)) << @intCast(shift);
+            const result: T = a & ~mask;
+            return result | (v << @intCast(shift));
+        }
+    };
+}
+
+test Array {
+    const A = Array(5, u8);
+    var a: A.T = 0;
+    try expectEqual(u40, @TypeOf(a));
+
+    a = A.set(a, 4, 241);
+    try expectEqual(@as(u8, 241), A.get(a, 4));
+    a = A.set(a, 4, 1);
+    try expectEqual(@as(u8, 1), A.get(a, 4));
+
+    for (0..5) |i| a = A.set(a, i, @intCast(i));
+    for (0..5) |i| try expectEqual(@as(u8, @intCast(i)), A.get(a, i));
+
+    const Optional = @import("optional.zig").Optional;
+
+    const B = Array(4, Optional(bool));
+    var b: B.T = 0;
+    try expectEqual(u8, @TypeOf(b));
+
+    b = B.set(b, 2, .true);
+    try expectEqual(Optional(bool).None, B.get(b, 1));
+    try expectEqual(Optional(bool).true, B.get(b, 2));
+    try expectEqual(@as(u8, 0b00100000), b);
+    b = B.set(b, 2, .None);
+    b = B.set(b, 0, .false);
+    try expectEqual(Optional(bool).None, B.get(b, 2));
+    try expectEqual(Optional(bool).false, B.get(b, 0));
+    try expectEqual(@as(u8, 0b0000001), b);
+}

package/src/lib/common/data.zig

@@ -9,12 +9,12 @@ pub const Player = enum(u1) {
     P2,
 
     /// Returns a player's opponent.
-    pub inline fn foe(self: Player) Player {
+    pub fn foe(self: Player) Player {
         return @enumFromInt(~@intFromEnum(self));
     }
 
     /// Return's an identifier for the player's Pokémon at the one-indexed `id`.
-    pub inline fn ident(self: Player, id: u3) ID {
+    pub fn ident(self: Player, id: u3) ID {
         assert(id > 0 and id <= 6);
         return .{ .id = id, .player = self };
     }
@@ -27,24 +27,20 @@ test Player {
 }
 
 /// An identifier for a specific Pokémon in battle.
-pub const ID = packed struct {
+pub const ID = packed struct(u8) {
     /// The one-indexed team slot of the Pokémon
     id: u3 = 0,
     /// The Pokémon's trainer.
     player: Player = .P1,
     _: u4 = 0,
 
-    comptime {
-        assert(@sizeOf(ID) == 1);
-    }
-
     /// Converts the identifier into a number.
-    pub inline fn int(self: ID) u4 {
+    pub fn int(self: ID) u4 {
         return @intCast(@as(u8, @bitCast(self)));
     }
 
     /// Decodes the identifier from a number.
-    pub inline fn from(id: u4) ID {
+    pub fn from(id: u4) ID {
         return @bitCast(@as(u8, id));
     }
 };
@@ -52,12 +48,12 @@ pub const ID = packed struct {
 test ID {
     try expectEqual(@as(u8, 0b0001), @as(u8, @bitCast(ID{ .player = .P1, .id = 1 })));
     try expectEqual(@as(u8, 0b1101), @as(u8, @bitCast(ID{ .player = .P2, .id = 5 })));
-    const id = ID{ .player = .P2, .id = 4 };
+    const id: ID = .{ .player = .P2, .id = 4 };
     try expectEqual(id, ID.from(id.int()));
 }
 
 /// A choice made by a player during battle.
-pub const Choice = packed struct {
+pub const Choice = packed struct(u8) {
     /// The choice type.
     type: Choice.Type = .Pass,
     /// The choice data:
@@ -73,10 +69,6 @@ pub const Choice = packed struct {
         Move,
         Switch,
     };
-
-    comptime {
-        assert(@sizeOf(Choice) == 1);
-    }
 };
 
 test Choice {
@@ -84,12 +76,12 @@ test Choice {
     const p2: Choice = .{ .type = .Switch, .data = 5 };
     try expectEqual(5, p2.data);
     try expectEqual(Choice.Type.Move, p1.type);
-    try expectEqual(0b0001_0001, @as(u8, @bitCast(p1)));
-    try expectEqual(0b0001_0110, @as(u8, @bitCast(p2)));
+    try expectEqual(@as(u8, 0b0001_0001), @as(u8, @bitCast(p1)));
+    try expectEqual(@as(u8, 0b0001_0110), @as(u8, @bitCast(p2)));
 }
 
 /// The result of the battle - all results other than 'None' should be considered terminal.
-pub const Result = packed struct {
+pub const Result = packed struct(u8) {
     /// The type of result from the perspective of Player 1.
     /// `Error` is not possible when in Pokémon Showdown compatibility mode.
     type: Result.Type = .None,
@@ -117,13 +109,9 @@ pub const Result = packed struct {
     pub const Error: Result = .{ .type = .Error };
     /// The default result.
     pub const Default: Result = .{ .p1 = .Move, .p2 = .Move };
-
-    comptime {
-        assert(@sizeOf(Result) == 1);
-    }
 };
 
 test Result {
-    try expectEqual(0b0101_0000, @as(u8, @bitCast(Result.Default)));
-    try expectEqual(0b1000_0000, @as(u8, @bitCast(Result{ .p2 = .Switch })));
+    try expectEqual(@as(u8, 0b0101_0000), @as(u8, @bitCast(Result.Default)));
+    try expectEqual(@as(u8, 0b1000_0000), @as(u8, @bitCast(Result{ .p2 = .Switch })));
 }

package/src/lib/common/debug.zig

@@ -3,9 +3,19 @@ const std = @import("std");
 const debug = std.debug;
 const io = std.io;
 
+const Array = if (@hasField(std.builtin.Type, "array")) .array else .Array;
+const Enum = if (@hasField(std.builtin.Type, "enum")) .@"enum" else .Enum;
+const Optional = if (@hasField(std.builtin.Type, "optional")) .optional else .Optional;
+const Pointer = if (@hasField(std.builtin.Type, "pointer")) .pointer else .Pointer;
+const Struct = if (@hasField(std.builtin.Type, "struct")) .@"struct" else .Struct;
+const Union = if (@hasField(std.builtin.Type, "union")) .@"union" else .Union;
+
 pub fn print(value: anytype) void {
-    debug.getStderrMutex().lock();
-    defer debug.getStderrMutex().unlock();
+    if (@hasDecl(debug, "lockStdErr")) debug.lockStdErr() else debug.getStderrMutex().lock();
+    defer if (@hasDecl(debug, "unlockStdErr"))
+        debug.unlockStdErr()
+    else
+        debug.getStderrMutex().unlock();
     const stderr = io.getStdErr().writer();
 
     nosuspend {
@@ -19,7 +29,7 @@ pub fn print(value: anytype) void {
             }) catch return;
         } else {
             switch (@typeInfo(@TypeOf(value))) {
-                .Struct => |info| {
+                Struct => |info| {
                     if (info.is_tuple) {
                         inline for (info.fields, 0..) |f, i| {
                             inspect(@field(value, f.name));
@@ -42,17 +52,17 @@ fn inspect(value: anytype) void {
     nosuspend {
         const err = "Unable to format type '" ++ @typeName(@TypeOf(value)) ++ "'";
         switch (@typeInfo(@TypeOf(value))) {
-            .Array => |info| {
+            Array => |info| {
                 if (info.child == u8) return stderr.print("{s}", .{value}) catch return;
                 @compileError(err);
             },
-            .Pointer => |ptr_info| switch (ptr_info.size) {
+            Pointer => |ptr_info| switch (ptr_info.size) {
                 .One => switch (@typeInfo(ptr_info.child)) {
-                    .Array => |info| {
+                    Array => |info| {
                         if (info.child == u8) return stderr.print("{s}", .{value}) catch return;
                         @compileError(err);
                     },
-                    .Enum, .Union, .Struct => return inspect(value.*),
+                    Enum, Union, Struct => return inspect(value.*),
                     else => @compileError(err),
                 },
                 .Many, .C => {
@@ -67,8 +77,29 @@ fn inspect(value: anytype) void {
                     @compileError(err);
                 },
             },
-            .Optional => stderr.print("{?}", .{value}) catch return,
+            Optional => stderr.print("{?}", .{value}) catch return,
             else => stderr.print("{}", .{value}) catch return,
         }
     }
 }
+
+const showdown = @import("./options.zig").showdown;
+const Result = @import("./data.zig").Result;
+const Choice = @import("./data.zig").Choice;
+
+pub fn dump(gen: u8, battle: anytype, frame: ?struct { Result, Choice, Choice }) void {
+    const file = std.fs.cwd().createFile("logs/dump.bin", .{}) catch return;
+    defer file.close();
+    var w = file.writer();
+    w.writeByte(@intFromBool(showdown)) catch return;
+    w.writeByte(gen) catch return;
+    w.writeInt(i16, 0, .little) catch return;
+    w.writeInt(i32, 0, .little) catch return;
+    w.writeStruct(battle) catch return;
+    w.writeStruct(battle) catch return;
+    if (frame) |f| {
+        w.writeStruct(f[0]) catch return;
+        w.writeStruct(f[1]) catch return;
+        w.writeStruct(f[2]) catch return;
+    }
+}

package/src/lib/common/js.zig

@@ -2,6 +2,8 @@ const std = @import("std");
 
 const assert = std.debug.assert;
 
+const Int = if (@hasField(std.builtin.Type, "int")) .int else .Int;
+
 const c = @cImport({
     @cDefine("NAPI_VERSION", "8");
     @cInclude("node_api.h");
@@ -35,7 +37,7 @@ pub const Number = struct {
         const T = @TypeOf(value);
         var result: c.napi_value = undefined;
         assert(c.napi_ok == switch (@typeInfo(T)) {
-            .Int => |info| switch (info.bits) {
+            Int => |info| switch (info.bits) {
                 0...32 => switch (info.signedness) {
                     .signed => c.napi_create_int32(env, @as(i32, value), &result),
                     .unsigned => c.napi_create_uint32(env, @as(u32, value), &result),
@@ -50,7 +52,7 @@ pub const Number = struct {
 
     pub fn get(env: c.napi_env, value: c.napi_value, comptime T: type) T {
         switch (@typeInfo(T)) {
-            .Int => |info| switch (info.bits) {
+            Int => |info| switch (info.bits) {
                 0...32 => switch (info.signedness) {
                     .signed => {
                         var result: i32 = undefined;

package/src/lib/common/optional.zig

@@ -3,10 +3,12 @@ const std = @import("std");
 const expect = std.testing.expect;
 const assert = std.debug.assert;
 
+const Bool = if (@hasField(std.builtin.Type, "bool")) .bool else .Bool;
+
 // TODO: ziglang/zig#104
 pub fn Optional(comptime T: type) type {
     const fields = std.meta.fields(switch (@typeInfo(T)) {
-        .Bool => enum { false, true },
+        Bool => enum { false, true },
         else => T,
     });
 
@@ -14,6 +16,7 @@ pub fn Optional(comptime T: type) type {
     var decls = [_]std.builtin.Type.Declaration{};
 
     enumFields[0] = .{ .name = "None", .value = 0 };
+
     inline for (fields, 1..) |field, i| {
         assert(!std.mem.eql(u8, field.name, "None"));
         enumFields[i] = .{
@@ -22,14 +25,16 @@ pub fn Optional(comptime T: type) type {
         };
     }
 
-    return @Type(.{
-        .Enum = .{
-            .tag_type = std.math.IntFittingRange(0, fields.len + 1),
-            .fields = &enumFields,
-            .decls = &decls,
-            .is_exhaustive = true,
-        },
-    });
+    const options: std.builtin.Type.Enum = .{
+        .tag_type = std.math.IntFittingRange(0, fields.len),
+        .fields = &enumFields,
+        .decls = &decls,
+        .is_exhaustive = true,
+    };
+    return @Type(if (@hasField(std.builtin.Type, "enum"))
+        .{ .@"enum" = options }
+    else
+        .{ .Enum = options });
 }
 
 test Optional {
@@ -45,7 +50,7 @@ test Optional {
     try expect(b != .true);
     try expect(b != .false);
 
-    const Player = @import("./data.zig").Player;
+    const Player = @import("data.zig").Player;
     try expect(@bitSizeOf(Optional(Player)) == 2);
 
     const p: Optional(Player) = .P2;
@@ -57,4 +62,10 @@ test Optional {
     try expect(q == .None);
     try expect(q != .P1);
     try expect(q != .P2);
+
+    const Three = enum(u2) { A, B, C };
+    try expect(@bitSizeOf(Optional(Three)) == 2);
+
+    const Four = enum(u2) { A, B, C, D };
+    try expect(@bitSizeOf(Optional(Four)) == 3);
 }

package/src/lib/common/options.zig

@@ -7,9 +7,12 @@ pub const Options = struct {
     log: ?bool = null,
     chance: ?bool = null,
     calc: ?bool = null,
+    mod: ?bool = null,
     advance: ?bool = null,
     ebc: ?bool = null,
     key: ?bool = null,
+    miss: ?bool = null,
+    overwrite: ?bool = null,
     internal: ?bool = null,
 };
 
@@ -22,9 +25,12 @@ pub const chance = get("chance", false);
 /// Whether or not damage calculator support is enabled.
 pub const calc = get("calc", false);
 
+pub const mod = showdown or get("mod", false);
 pub const advance = get("advance", true);
 pub const ebc = get("ebc", true);
 pub const key = get("key", false);
+pub const miss = get("miss", true);
+pub const overwrite = get("overwrite", true);
 pub const internal = get("internal", false);
 
 fn get(comptime name: []const u8, default: bool) bool {