@pkmn/engine 0.1.0-dev.44a51703 → 0.1.0-dev.46307385

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/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,60 @@
+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 + 1),
+            .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);
+}

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 {

package/src/lib/common/protocol.zig

@@ -102,6 +102,9 @@ pub const ArgType = enum(u8) {
     // Gen 8
     CanDynamax,
     SwapSideConditions,
+
+    // Gen 9
+    Terastallize,
 };
 
 pub const Move = enum(u8) {
@@ -219,8 +222,12 @@ pub const Immune = enum(u8) {
     OHKO,
 };
 
+/// Null object pattern implementation of `Log` backed by a `std.io.null_writer`.
+/// Ignores anything sent to it, though protocol logging should additionally be turned off
+/// entirely with `options.log`.
 pub const NULL = Log(@TypeOf(std.io.null_writer)){ .writer = std.io.null_writer };
 
+/// Logs protocol information to its `Writer` during a battle update when `options.log` is enabled.
 pub fn Log(comptime Writer: type) type {
     return struct {
         const Self = @This();
@@ -231,6 +238,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn move(self: Self, source: ID, m: anytype, target: ID, from: anytype) Error!void {
             if (!enabled) return;
+
             assert(m != .None);
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Move),
@@ -254,6 +262,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn switched(self: Self, ident: ID, pokemon: anytype) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Switch), @as(u8, @bitCast(ident)) });
             try self.writer.writeAll(&.{ @intFromEnum(pokemon.species), pokemon.level });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -263,6 +272,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn cant(self: Self, ident: ID, reason: Cant) Error!void {
             if (!enabled) return;
+
             assert(reason != .Disable);
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Cant),
@@ -273,6 +283,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn disabled(self: Self, ident: ID, m: anytype) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Cant),
                 @as(u8, @bitCast(ident)),
@@ -283,12 +294,14 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn faint(self: Self, ident: ID, done: bool) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Faint), @as(u8, @bitCast(ident)) });
             if (done) try self.writer.writeByte(@intFromEnum(ArgType.None));
         }
 
         pub fn turn(self: Self, num: u16) Error!void {
             if (!enabled) return;
+
             try self.writer.writeByte(@intFromEnum(ArgType.Turn));
             try self.writer.writeIntNative(u16, num);
             try self.writer.writeByte(@intFromEnum(ArgType.None));
@@ -296,6 +309,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn win(self: Self, player: Player) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Win),
                 @intFromEnum(player),
@@ -305,11 +319,13 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn tie(self: Self) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Tie), @intFromEnum(ArgType.None) });
         }
 
         pub fn damage(self: Self, ident: ID, pokemon: anytype, reason: Damage) Error!void {
             if (!enabled) return;
+
             assert(@intFromEnum(reason) <= @intFromEnum(Damage.LeechSeed));
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Damage), @as(u8, @bitCast(ident)) });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -325,6 +341,7 @@ pub fn Log(comptime Writer: type) type {
             source: ID,
         ) Error!void {
             if (!enabled) return;
+
             assert(@intFromEnum(reason) == @intFromEnum(Damage.RecoilOf));
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Damage), @as(u8, @bitCast(ident)) });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -338,6 +355,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn heal(self: Self, ident: ID, pokemon: anytype, reason: Heal) Error!void {
             if (!enabled) return;
+
             assert(reason != .Drain);
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Heal), @as(u8, @bitCast(ident)) });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -347,6 +365,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn drain(self: Self, source: ID, pokemon: anytype, target: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Heal), @as(u8, @bitCast(source)) });
             try self.writer.writeIntNative(u16, pokemon.hp);
             try self.writer.writeIntNative(u16, pokemon.stats.hp);
@@ -359,6 +378,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn status(self: Self, ident: ID, value: u8, reason: Status) Error!void {
             if (!enabled) return;
+
             assert(reason != .From);
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Status),
@@ -370,6 +390,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn statusFrom(self: Self, ident: ID, value: u8, m: anytype) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Status),
                 @as(u8, @bitCast(ident)),
@@ -381,6 +402,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn curestatus(self: Self, ident: ID, value: u8, reason: CureStatus) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.CureStatus),
                 @as(u8, @bitCast(ident)),
@@ -391,6 +413,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn boost(self: Self, ident: ID, reason: Boost, num: i8) Error!void {
             if (!enabled) return;
+
             assert(num != 0 and (reason != .Rage or num > 0));
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Boost),
@@ -402,11 +425,13 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn clearallboost(self: Self) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{@intFromEnum(ArgType.ClearAllBoost)});
         }
 
         pub fn fail(self: Self, ident: ID, reason: Fail) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Fail),
                 @as(u8, @bitCast(ident)),
@@ -416,11 +441,13 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn miss(self: Self, source: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Miss), @as(u8, @bitCast(source)) });
         }
 
         pub fn hitcount(self: Self, ident: ID, num: u8) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.HitCount),
                 @as(u8, @bitCast(ident)),
@@ -430,6 +457,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn prepare(self: Self, source: ID, m: anytype) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Prepare),
                 @as(u8, @bitCast(source)),
@@ -439,6 +467,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn mustrecharge(self: Self, ident: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.MustRecharge),
                 @as(u8, @bitCast(ident)),
@@ -447,6 +476,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn activate(self: Self, ident: ID, reason: Activate) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Activate),
                 @as(u8, @bitCast(ident)),
@@ -456,11 +486,13 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn fieldactivate(self: Self) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{@intFromEnum(ArgType.FieldActivate)});
         }
 
         pub fn start(self: Self, ident: ID, reason: Start) Error!void {
             if (!enabled) return;
+
             assert(@intFromEnum(reason) < @intFromEnum(Start.TypeChange));
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Start),
@@ -471,6 +503,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn typechange(self: Self, source: ID, types: anytype, target: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Start),
                 @as(u8, @bitCast(source)),
@@ -482,6 +515,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn startEffect(self: Self, ident: ID, reason: Start, m: anytype) Error!void {
             if (!enabled) return;
+
             assert(@intFromEnum(reason) > @intFromEnum(Start.TypeChange));
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Start),
@@ -493,6 +527,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn end(self: Self, ident: ID, reason: End) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.End),
                 @as(u8, @bitCast(ident)),
@@ -502,16 +537,19 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn ohko(self: Self) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{@intFromEnum(ArgType.OHKO)});
         }
 
         pub fn crit(self: Self, ident: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{ @intFromEnum(ArgType.Crit), @as(u8, @bitCast(ident)) });
         }
 
         pub fn supereffective(self: Self, ident: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.SuperEffective),
                 @as(u8, @bitCast(ident)),
@@ -520,6 +558,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn resisted(self: Self, ident: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Resisted),
                 @as(u8, @bitCast(ident)),
@@ -528,6 +567,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn immune(self: Self, ident: ID, reason: Immune) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Immune),
                 @as(u8, @bitCast(ident)),
@@ -537,6 +577,7 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn transform(self: Self, source: ID, target: ID) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{
                 @intFromEnum(ArgType.Transform),
                 @as(u8, @bitCast(source)),
@@ -546,18 +587,24 @@ pub fn Log(comptime Writer: type) type {
 
         pub fn laststill(self: Self) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{@intFromEnum(ArgType.LastStill)});
         }
 
         pub fn lastmiss(self: Self) Error!void {
             if (!enabled) return;
+
             try self.writer.writeAll(&.{@intFromEnum(ArgType.LastMiss)});
         }
     };
 }
 
+/// `Log` type backed by the optimized `ByteStream.Writer`.
 pub const FixedLog = Log(ByteStream.Writer);
 
+/// Stripped down version of `std.io.FixedBufferStream` optimized for efficiently writing the
+/// individual protocol bytes. Note that the `ByteStream.Writer` is **not** a `std.io.Writer` and
+/// should not be used for general purpose writing.
 pub const ByteStream = struct {
     buffer: []u8,
     pos: usize = 0,
@@ -855,6 +902,7 @@ pub fn expectLog(
     offset: usize,
 ) !void {
     if (!enabled) return;
+
     const color = color: {
         if (std.process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
             break :color true;