@pkmn/engine 0.1.0-dev.8b83af6b → 0.1.0-dev.900756a9

package/src/lib/binding/node.zig

@@ -1,6 +1,8 @@
 const std = @import("std");
 const pkmn = @import("../pkmn.zig");
 
+const js = @import("../common/js.zig");
+
 const assert = std.debug.assert;
 
 const c = @cImport({
@@ -10,38 +12,49 @@ const c = @cImport({
 
 export fn napi_register_module_v1(env: c.napi_env, exports: c.napi_value) c.napi_value {
     const properties = [_]c.napi_property_descriptor{
-        Property.init("options", .{ .value = options(env) }),
-        Property.init("bindings", .{ .value = bindings(env) }),
+        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 properties = [_]c.napi_property_descriptor{
+        js.Property.init("options", .{ .value = options(env) }),
+        js.Property.init("bindings", .{ .value = bindings(env) }),
+    };
+    assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
+    return object;
+}
+
 fn options(env: c.napi_env) c.napi_value {
-    var object = Object.init(env);
+    var object = js.Object.init(env);
     const properties = [_]c.napi_property_descriptor{
-        Property.init("showdown", .{ .value = Boolean.init(env, pkmn.options.showdown) }),
-        Property.init("log", .{ .value = Boolean.init(env, pkmn.options.log) }),
+        js.Property.init("showdown", .{ .value = js.Boolean.init(env, pkmn.options.showdown) }),
+        js.Property.init("log", .{ .value = js.Boolean.init(env, pkmn.options.log) }),
+        js.Property.init("chance", .{ .value = js.Boolean.init(env, pkmn.options.chance) }),
+        js.Property.init("calc", .{ .value = js.Boolean.init(env, pkmn.options.calc) }),
     };
     assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
     return object;
 }
 
 fn bindings(env: c.napi_env) c.napi_value {
-    var array = Array.init(env, .{ .length = 1 });
-    Array.set(env, array, 0, bind(env, pkmn.gen1));
+    var array = js.Array.init(env, .{ .length = 1 });
+    js.Array.set(env, array, 0, bind(env, pkmn.gen1));
     return array;
 }
 
 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 = Object.init(env);
+    var object = js.Object.init(env);
     const properties = [_]c.napi_property_descriptor{
-        Property.init("CHOICES_SIZE", .{ .value = Number.init(env, choices_size) }),
-        Property.init("LOGS_SIZE", .{ .value = Number.init(env, logs_size) }),
-        Property.init("update", .{ .method = update(gen) }),
-        Property.init("choices", .{ .method = choices(gen) }),
+        js.Property.init("CHOICES_SIZE", .{ .value = js.Number.init(env, choices_size) }),
+        js.Property.init("LOGS_SIZE", .{ .value = js.Number.init(env, logs_size) }),
+        js.Property.init("update", .{ .method = update(gen) }),
+        js.Property.init("choices", .{ .method = choices(gen) }),
     };
     assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
     return object;
@@ -62,26 +75,31 @@ fn update(gen: anytype) c.napi_callback {
             assert(data != null);
 
             var battle: *gen.Battle(gen.PRNG) = @alignCast(@ptrCast(data.?));
-            const c1: pkmn.Choice = @bitCast(Number.get(env, argv[1], u8));
-            const c2: pkmn.Choice = @bitCast(Number.get(env, argv[2], u8));
+            const c1: pkmn.Choice = @bitCast(js.Number.get(env, argv[1], u8));
+            const c2: pkmn.Choice = @bitCast(js.Number.get(env, argv[2], u8));
 
             var vtype: c.napi_valuetype = undefined;
             assert(c.napi_typeof(env, argv[3], &vtype) == c.napi_ok);
             const result = switch (vtype) {
-                c.napi_undefined, c.napi_null => battle.update(c1, c2, pkmn.protocol.NULL),
+                c.napi_undefined, c.napi_null => battle.update(c1, c2, &gen.NULL),
                 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 };
-                    var log = pkmn.protocol.FixedLog{ .writer = stream.writer() };
-                    break :result battle.update(c1, c2, log);
+                    var stream: pkmn.protocol.ByteStream = .{ .buffer = buf };
+                    // TODO: extract out
+                    var opts = pkmn.battle.options(
+                        pkmn.protocol.FixedLog{ .writer = stream.writer() },
+                        gen.chance.NULL,
+                        gen.calc.NULL,
+                    );
+                    break :result battle.update(c1, c2, &opts);
                 },
             } catch unreachable;
 
-            return Number.init(env, @as(u8, @bitCast(result)));
+            return js.Number.init(env, @as(u8, @bitCast(result)));
         }
     }.call;
 }
@@ -101,8 +119,8 @@ fn choices(gen: anytype) c.napi_callback {
             assert(data != null);
 
             var battle: *gen.Battle(gen.PRNG) = @alignCast(@ptrCast(data.?));
-            const player: pkmn.Player = @enumFromInt(Number.get(env, argv[1], u8));
-            const request: pkmn.Choice.Type = @enumFromInt(Number.get(env, argv[2], u8));
+            const player: pkmn.Player = @enumFromInt(js.Number.get(env, argv[1], u8));
+            const request: pkmn.Choice.Type = @enumFromInt(js.Number.get(env, argv[2], u8));
 
             assert(c.napi_get_arraybuffer_info(env, argv[3], &data, &len) == c.napi_ok);
             assert(len == gen.CHOICES_SIZE);
@@ -110,117 +128,7 @@ fn choices(gen: anytype) c.napi_callback {
 
             var out = @as([*]pkmn.Choice, @ptrCast(data.?))[0..gen.CHOICES_SIZE];
             const n = battle.choices(player, request, out);
-            return Number.init(env, @as(u8, @bitCast(n)));
+            return js.Number.init(env, @as(u8, @bitCast(n)));
         }
     }.call;
 }
-
-const Array = struct {
-    fn init(env: c.napi_env, o: struct { length: ?usize }) c.napi_value {
-        var result: c.napi_value = undefined;
-        assert(c.napi_ok == if (o.length) |n|
-            c.napi_create_array_with_length(env, n, &result)
-        else
-            c.napi_create_array(env, &result));
-        return result;
-    }
-
-    fn set(env: c.napi_env, array: c.napi_value, index: u32, value: c.napi_value) void {
-        assert(c.napi_set_element(env, array, index, value) == c.napi_ok);
-    }
-};
-
-const Boolean = struct {
-    fn init(env: c.napi_env, value: bool) c.napi_value {
-        var result: c.napi_value = undefined;
-        assert(c.napi_get_boolean(env, value, &result) == c.napi_ok);
-        return result;
-    }
-};
-
-const Number = struct {
-    fn init(env: c.napi_env, value: anytype) c.napi_value {
-        const T = @TypeOf(value);
-        var result: c.napi_value = undefined;
-        assert(c.napi_ok == switch (@typeInfo(T)) {
-            .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),
-                },
-                33...52 => c.napi_create_int64(env, @as(i64, value), &result),
-                else => @compileError("int can't be represented as JS number"),
-            },
-            else => @compileError("expected number, got: " ++ @typeName(T)),
-        });
-        return result;
-    }
-
-    fn get(env: c.napi_env, value: c.napi_value, comptime T: type) T {
-        switch (@typeInfo(T)) {
-            .Int => |info| switch (info.bits) {
-                0...32 => switch (info.signedness) {
-                    .signed => {
-                        var result: i32 = undefined;
-                        assert(c.napi_get_value_int32(env, value, &result) == c.napi_ok);
-                        return if (info.bits == 32) result else @intCast(result);
-                    },
-                    .unsigned => {
-                        var result: u32 = undefined;
-                        assert(c.napi_get_value_uint32(env, value, &result) == c.napi_ok);
-                        return if (info.bits == 32) result else @intCast(result);
-                    },
-                },
-                33...63 => {
-                    var result: i64 = undefined;
-                    assert(c.napi_get_value_int64(env, value, &result) == c.napi_ok);
-                    return @intCast(result);
-                },
-                else => {
-                    var result: i64 = undefined;
-                    assert(c.napi_get_value_int64(env, value, &result) == c.napi_ok);
-                    return switch (info.signedness) {
-                        .signed => value,
-                        .unsigned => if (0 <= value) @intCast(value) else unreachable,
-                    };
-                },
-            },
-            else => @compileError("expected number, got: " ++ @typeName(T)),
-        }
-    }
-};
-
-const Object = struct {
-    fn init(env: c.napi_env) c.napi_value {
-        var result: c.napi_value = undefined;
-        assert(c.napi_create_object(env, &result) == c.napi_ok);
-        return result;
-    }
-};
-
-const Property = union(enum) {
-    method: c.napi_callback,
-    value: c.napi_value,
-
-    fn init(comptime name: [:0]const u8, property: Property) c.napi_property_descriptor {
-        return .{
-            .utf8name = name,
-            .name = null,
-            .method = switch (property) {
-                .method => |m| m,
-                .value => null,
-            },
-            .getter = null,
-            .setter = null,
-            .value = switch (property) {
-                .method => null,
-                .value => |v| v,
-            },
-            .attributes = switch (property) {
-                .method => c.napi_default,
-                .value => c.napi_enumerable,
-            },
-            .data = null,
-        };
-    }
-};

package/src/lib/binding/wasm.zig

@@ -3,6 +3,8 @@ const pkmn = @import("../pkmn.zig");
 
 export const SHOWDOWN = pkmn.options.showdown;
 export const LOG = pkmn.options.log;
+export const CHANCE = pkmn.options.chance;
+export const CALC = pkmn.options.calc;
 
 export const GEN1_CHOICES_SIZE =
     std.math.ceilPowerOfTwo(u32, @as(u32, @intCast(pkmn.gen1.CHOICES_SIZE))) catch unreachable;

package/src/lib/common/battle.zig

@@ -0,0 +1,17 @@
+/// Stores state required by optional features to the engine that can be passed to a generation's
+/// `Battle.update` function. All generations generically support protocol logging (enabled via
+/// `-Dlog`), chance actions and probability tracking (enabled via `-Dchance`), and damage
+/// computation and chance overrides (`-Dcalc`), though the concrete types for these features are
+/// generation dependent.
+pub fn Options(comptime Log: type, comptime Chance: type, comptime Calc: type) type {
+    return struct { log: Log, chance: Chance, calc: Calc };
+}
+
+/// Helper to create a battle `Options` object with the provided `log`, `chance`, and `calc`.
+pub fn options(
+    log: anytype,
+    chance: anytype,
+    calc: anytype,
+) Options(@TypeOf(log), @TypeOf(chance), @TypeOf(calc)) {
+    return .{ .log = log, .chance = chance, .calc = calc };
+}

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 {
@@ -89,7 +81,7 @@ test Choice {
 }
 
 /// 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,10 +109,6 @@ 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 {

package/src/lib/common/debug.zig

@@ -10,18 +10,27 @@ pub fn print(value: anytype) void {
 
     nosuspend {
         stderr.writeAll("\x1b[41m") catch return;
-        switch (@typeInfo(@TypeOf(value))) {
-            .Struct => |info| {
-                if (info.is_tuple) {
-                    inline for (info.fields, 0..) |f, i| {
-                        inspect(@field(value, f.name));
-                        if (i < info.fields.len - 1) stderr.writeAll(" ") catch return;
+        if (@TypeOf(@src()) == @TypeOf(value)) {
+            stderr.print("{s} ({s}:{d}:{d})", .{
+                value.fn_name,
+                value.file,
+                value.line,
+                value.column,
+            }) catch return;
+        } else {
+            switch (@typeInfo(@TypeOf(value))) {
+                .Struct => |info| {
+                    if (info.is_tuple) {
+                        inline for (info.fields, 0..) |f, i| {
+                            inspect(@field(value, f.name));
+                            if (i < info.fields.len - 1) stderr.writeAll(" ") catch return;
+                        }
+                    } else {
+                        inspect(value);
                     }
-                } else {
-                    inspect(value);
-                }
-            },
-            else => inspect(value),
+                },
+                else => inspect(value),
+            }
         }
         stderr.writeAll("\x1b[K\x1b[0m\n") catch return;
     }

package/src/lib/common/js.zig

@@ -0,0 +1,118 @@
+const std = @import("std");
+
+const assert = std.debug.assert;
+
+const c = @cImport({
+    @cDefine("NAPI_VERSION", "8");
+    @cInclude("node_api.h");
+});
+
+pub const Array = struct {
+    pub fn init(env: c.napi_env, o: struct { length: ?usize }) c.napi_value {
+        var result: c.napi_value = undefined;
+        assert(c.napi_ok == if (o.length) |n|
+            c.napi_create_array_with_length(env, n, &result)
+        else
+            c.napi_create_array(env, &result));
+        return result;
+    }
+
+    pub fn set(env: c.napi_env, array: c.napi_value, index: u32, value: c.napi_value) void {
+        assert(c.napi_set_element(env, array, index, value) == c.napi_ok);
+    }
+};
+
+pub const Boolean = struct {
+    pub fn init(env: c.napi_env, value: bool) c.napi_value {
+        var result: c.napi_value = undefined;
+        assert(c.napi_get_boolean(env, value, &result) == c.napi_ok);
+        return result;
+    }
+};
+
+pub const Number = struct {
+    pub fn init(env: c.napi_env, value: anytype) c.napi_value {
+        const T = @TypeOf(value);
+        var result: c.napi_value = undefined;
+        assert(c.napi_ok == switch (@typeInfo(T)) {
+            .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),
+                },
+                33...52 => c.napi_create_int64(env, @as(i64, value), &result),
+                else => @compileError("int can't be represented as JS number"),
+            },
+            else => @compileError("expected number, got: " ++ @typeName(T)),
+        });
+        return result;
+    }
+
+    pub fn get(env: c.napi_env, value: c.napi_value, comptime T: type) T {
+        switch (@typeInfo(T)) {
+            .Int => |info| switch (info.bits) {
+                0...32 => switch (info.signedness) {
+                    .signed => {
+                        var result: i32 = undefined;
+                        assert(c.napi_get_value_int32(env, value, &result) == c.napi_ok);
+                        return if (info.bits == 32) result else @intCast(result);
+                    },
+                    .unsigned => {
+                        var result: u32 = undefined;
+                        assert(c.napi_get_value_uint32(env, value, &result) == c.napi_ok);
+                        return if (info.bits == 32) result else @intCast(result);
+                    },
+                },
+                33...63 => {
+                    var result: i64 = undefined;
+                    assert(c.napi_get_value_int64(env, value, &result) == c.napi_ok);
+                    return @intCast(result);
+                },
+                else => {
+                    var result: i64 = undefined;
+                    assert(c.napi_get_value_int64(env, value, &result) == c.napi_ok);
+                    return switch (info.signedness) {
+                        .signed => value,
+                        .unsigned => if (0 <= value) @intCast(value) else unreachable,
+                    };
+                },
+            },
+            else => @compileError("expected number, got: " ++ @typeName(T)),
+        }
+    }
+};
+
+pub const Object = struct {
+    pub fn init(env: c.napi_env) c.napi_value {
+        var result: c.napi_value = undefined;
+        assert(c.napi_create_object(env, &result) == c.napi_ok);
+        return result;
+    }
+};
+
+pub const Property = union(enum) {
+    method: c.napi_callback,
+    value: c.napi_value,
+
+    pub fn init(comptime name: [:0]const u8, property: Property) c.napi_property_descriptor {
+        return .{
+            .utf8name = name,
+            .name = null,
+            .method = switch (property) {
+                .method => |m| m,
+                .value => null,
+            },
+            .getter = null,
+            .setter = null,
+            .value = switch (property) {
+                .method => null,
+                .value => |v| v,
+            },
+            .attributes = switch (property) {
+                .method => c.napi_default,
+                .value => c.napi_enumerable,
+            },
+            .data = null,
+        };
+    }
+};

package/src/lib/common/optional.zig

@@ -0,0 +1,67 @@
+const std = @import("std");
+
+const expect = std.testing.expect;
+const assert = std.debug.assert;
+
+// TODO: ziglang/zig#104
+pub fn Optional(comptime T: type) type {
+    const fields = std.meta.fields(switch (@typeInfo(T)) {
+        .Bool => enum { false, true },
+        else => T,
+    });
+
+    var enumFields: [fields.len + 1]std.builtin.Type.EnumField = undefined;
+    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] = .{
+            .name = field.name,
+            .value = i,
+        };
+    }
+
+    return @Type(.{
+        .Enum = .{
+            .tag_type = std.math.IntFittingRange(0, fields.len),
+            .fields = &enumFields,
+            .decls = &decls,
+            .is_exhaustive = true,
+        },
+    });
+}
+
+test Optional {
+    try expect(@bitSizeOf(Optional(bool)) == 2);
+
+    const a: Optional(bool) = .true;
+    try expect(a != .None);
+    try expect(a == .true);
+    try expect(a != .false);
+
+    const b: Optional(bool) = .None;
+    try expect(b == .None);
+    try expect(b != .true);
+    try expect(b != .false);
+
+    const Player = @import("./data.zig").Player;
+    try expect(@bitSizeOf(Optional(Player)) == 2);
+
+    const p: Optional(Player) = .P2;
+    try expect(p != .None);
+    try expect(p != .P1);
+    try expect(p == .P2);
+
+    const q: Optional(Player) = .None;
+    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

@@ -1,11 +1,15 @@
 const build_options = @import("build_options");
 const root = @import("root");
 
+/// Configures the behavior of the pkmn package.
 pub const Options = struct {
     showdown: ?bool = null,
     log: ?bool = null,
+    chance: ?bool = null,
+    calc: ?bool = null,
     advance: ?bool = null,
     ebc: ?bool = null,
+    key: ?bool = null,
     internal: ?bool = null,
 };
 
@@ -13,9 +17,14 @@ pub const Options = struct {
 pub const showdown = get("showdown", false);
 /// Whether or not protocol message logging is enabled.
 pub const log = get("log", false);
+/// Whether or not update probability tracking is enabled.
+pub const chance = get("chance", false);
+/// Whether or not damage calculator support is enabled.
+pub const calc = get("calc", false);
 
 pub const advance = get("advance", true);
 pub const ebc = get("ebc", true);
+pub const key = get("key", false);
 pub const internal = get("internal", false);
 
 fn get(comptime name: []const u8, default: bool) bool {