@pkmn/engine 0.1.0-dev.d716e940 → 0.1.0-dev.da4a0515

package/src/lib/node.zig

@@ -0,0 +1,131 @@
+const std = @import("std");
+
+const pkmn = @import("pkmn.zig");
+
+const js = @import("common/js.zig");
+
+const assert = std.debug.assert;
+
+const c = @cImport({
+    @cDefine("NAPI_VERSION", "8");
+    @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 {
+    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) }),
+    };
+    assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
+    return object;
+}
+
+fn options(env: c.napi_env) c.napi_value {
+    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) }),
+        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 {
+    const 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);
+    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) }),
+        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;
+}
+
+fn update(gen: anytype) c.napi_callback {
+    return struct {
+        fn call(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_value {
+            var argc: usize = 4;
+            var argv: [4]c.napi_value = undefined;
+            assert(c.napi_get_cb_info(env, info, &argc, &argv, null, null) == c.napi_ok);
+            assert(argc == 4);
+
+            var data: ?*anyopaque = undefined;
+            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)));
+
+            var battle: *gen.Battle(gen.PRNG) = @alignCast(@ptrCast(data.?));
+            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, &gen.NULL),
+                else => result: {
+                    assert(c.napi_get_arraybuffer_info(env, argv[3], &data, &len) == c.napi_ok);
+                    assert(len == gen.LOGS_SIZE);
+
+                    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() },
+                        gen.chance.NULL,
+                        gen.calc.NULL,
+                    );
+                    break :result battle.update(c1, c2, &opts);
+                },
+            } catch unreachable;
+
+            return js.Number.init(env, @as(u8, @bitCast(result)));
+        }
+    }.call;
+}
+
+fn choices(gen: anytype) c.napi_callback {
+    return struct {
+        fn call(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_value {
+            var argc: usize = 4;
+            var argv: [4]c.napi_value = undefined;
+            assert(c.napi_get_cb_info(env, info, &argc, &argv, null, null) == c.napi_ok);
+            assert(argc == 4);
+
+            var data: ?*anyopaque = undefined;
+            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)));
+
+            var battle: *gen.Battle(gen.PRNG) = @alignCast(@ptrCast(data.?));
+            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);
+
+            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)));
+        }
+    }.call;
+}

package/src/lib/pkmn.zig

@@ -1,4 +1,4 @@
-/// Configurated Options for the pkmn package.
+/// Configured Options for the pkmn package.
 pub const options = @import("common/options.zig");
 /// Configures the behavior of the pkmn package.
 pub const Options = options.Options;
@@ -46,9 +46,91 @@ pub const protocol = if (options.internal) struct {
     pub const NULL = @import("common/protocol.zig").NULL;
 };
 
-/// Namespace for Generation I Pokémon
+pub usingnamespace @import("common/rational.zig");
+
+/// Namespace for cross-generation battle-related types.
+pub const battle = @import("common/battle.zig");
+
+/// Namespace for Generation I Pokémon.
 pub const gen1 = struct {
     pub usingnamespace @import("gen1/data.zig");
+    /// Tracks chance actions and their associated probability during a
+    /// Generation I battle update when `options.chance` is enabled.
+    pub const Chance = @import("gen1/chance.zig").Chance;
+    /// Namespace for types associated with tracking Generation I Pokémon chance outcomes.
+    pub const chance = struct {
+        /// Actions taken by a hypothetical "chance player" that convey
+        /// information about which RNG events were observed during a Generation
+        /// I battle `update`. This can additionally be provided as input to the
+        /// `update` call via the `Calc` when `options.calc` is enabled to
+        /// override the normal behavior of the RNG in order to force specific
+        /// outcomes.
+        pub const Actions = @import("gen1/chance.zig").Actions;
+        /// Information about the RNG that was observed during a Generation I
+        /// battle `update` for a single player.
+        pub const Action = @import("gen1/chance.zig").Action;
+        /// TODO
+        pub const Durations = @import("gen1/chance.zig").Durations;
+        /// TODO
+        pub const Duration = @import("gen1/chance.zig").Duration;
+        /// Null object pattern implementation of Generation I `Chance` which
+        /// does nothing, though chance tracking should additionally be turned
+        /// off entirely via `options.chance`.
+        pub const NULL = @import("gen1/chance.zig").NULL;
+    };
+    /// Allows for forcing the value of specific RNG events during a Generation I battle `update`
+    /// via `overrides` and tracks `summaries` of information relevant to damage calculation.
+    pub const Calc = @import("gen1/calc.zig").Calc;
+    /// Namespace for types associated with supported Generation I Pokémon damage calc features.
+    pub const calc = if (options.internal) struct {
+        pub usingnamespace @import("gen1/calc.zig");
+    } else struct {
+        /// TODO
+        pub const Overrides = @import("gen1/calc.zig").Overrides;
+        /// Information relevant to damage calculation that occured during a Generation I
+        /// battle `update`.
+        pub const Summaries = @import("gen1/calc.zig").Summaries;
+        /// Information relevant to damage calculation that occured during a Generation I
+        /// battle `update` for a single player.
+        pub const Summary = @import("gen1/calc.zig").Summary;
+        /// Null object pattern implementation of Generation I `Calc` which does nothing,
+        /// though damage calculator support should additionally be turned off
+        /// entirely via `options.calc`.
+        pub const NULL = @import("gen1/calc.zig").NULL;
+    };
     /// Provides helpers for initializing Generation I Pokémon battles.
     pub const helpers = @import("gen1/helpers.zig");
 };
+
+/// TODO
+pub const gen2 = struct {
+    pub usingnamespace @import("gen2/data.zig");
+    pub const Chance = @import("gen2/chance.zig").Chance;
+    pub const chance = struct {
+        pub const Actions = @import("gen2/chance.zig").Actions;
+        pub const Action = @import("gen2/chance.zig").Action;
+        pub const Durations = @import("gen2/chance.zig").Durations;
+        pub const Duration = @import("gen2/chance.zig").Duration;
+        pub const NULL = @import("gen2/chance.zig").NULL;
+    };
+    pub const Calc = @import("gen2/calc.zig").Calc;
+    pub const calc = if (options.internal) struct {
+        pub usingnamespace @import("gen2/calc.zig");
+    } else struct {
+        pub const Overrides = @import("gen2/calc.zig").Overrides;
+        pub const Summaries = @import("gen2/calc.zig").Summaries;
+        pub const Summary = @import("gen2/calc.zig").Summary;
+        pub const NULL = @import("gen2/calc.zig").NULL;
+    };
+    pub const helpers = @import("gen2/helpers.zig");
+};
+
+// Internal APIs used by other pkmn libraries, not actually part of the public API.
+// NOTE: `pub usingnamespace struct { ... }` here results in a (false?) dependency loop
+pub const js = if (options.internal) struct {
+    pub usingnamespace @import("common/js.zig");
+} else struct {};
+pub const bindings = if (options.internal) struct {
+    pub const node = @import("node.zig");
+    pub const wasm = @import("wasm.zig");
+} else struct {};

package/src/lib/wasm.zig

@@ -0,0 +1,13 @@
+const std = @import("std");
+
+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;
+export const GEN1_LOGS_SIZE =
+    std.math.ceilPowerOfTwo(u32, @as(u32, @intCast(pkmn.gen1.LOGS_SIZE))) catch unreachable;

package/src/lib/binding/node.zig

@@ -1,229 +0,0 @@
-const std = @import("std");
-const pkmn = @import("../pkmn.zig");
-
-const assert = std.debug.assert;
-
-const c = @cImport({
-    @cDefine("NAPI_VERSION", "8");
-    @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{
-        Property.init("options", .{ .value = options(env) }),
-        Property.init("bindings", .{ .value = bindings(env) }),
-    };
-    assert(c.napi_define_properties(env, exports, properties.len, &properties) == c.napi_ok);
-    return exports;
-}
-
-fn options(env: c.napi_env) c.napi_value {
-    var object = 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) }),
-    };
-    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));
-    return array;
-}
-
-fn bind(env: c.napi_env, gen: anytype) c.napi_value {
-    const choices_size = @intCast(u32, gen.CHOICES_SIZE);
-    const logs_size = @intCast(u32, gen.LOGS_SIZE);
-    var object = 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) }),
-    };
-    assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
-    return object;
-}
-
-fn update(gen: anytype) c.napi_callback {
-    return struct {
-        fn call(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_value {
-            var argc: usize = 4;
-            var argv: [4]c.napi_value = undefined;
-            assert(c.napi_get_cb_info(env, info, &argc, &argv, null, null) == c.napi_ok);
-            assert(argc == 4);
-
-            var data: ?*anyopaque = undefined;
-            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 aligned = @alignCast(@alignOf(*gen.Battle(gen.PRNG)), data.?);
-            var battle = @ptrCast(*gen.Battle(gen.PRNG), aligned);
-            const c1 = @bitCast(pkmn.Choice, Number.get(env, argv[1], u8));
-            const c2 = @bitCast(pkmn.Choice, 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),
-                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 = @ptrCast([*]u8, 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);
-                },
-            } catch unreachable;
-
-            return Number.init(env, @bitCast(u8, result));
-        }
-    }.call;
-}
-
-fn choices(gen: anytype) c.napi_callback {
-    return struct {
-        fn call(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_value {
-            var argc: usize = 4;
-            var argv: [4]c.napi_value = undefined;
-            assert(c.napi_get_cb_info(env, info, &argc, &argv, null, null) == c.napi_ok);
-            assert(argc == 4);
-
-            var data: ?*anyopaque = undefined;
-            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 aligned = @alignCast(@alignOf(*gen.Battle(gen.PRNG)), data.?);
-            var battle = @ptrCast(*gen.Battle(gen.PRNG), aligned);
-
-            const player = @intToEnum(pkmn.Player, Number.get(env, argv[1], u8));
-            const request = @intToEnum(pkmn.Choice.Type, 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);
-            assert(data != null);
-
-            var out = @ptrCast([*]pkmn.Choice, data.?)[0..gen.CHOICES_SIZE];
-            const n = battle.choices(player, request, out);
-            return Number.init(env, @bitCast(u8, 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(T, 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(T, result);
-                    },
-                },
-                33...63 => {
-                    var result: i64 = undefined;
-                    assert(c.napi_get_value_int64(env, value, &result) == c.napi_ok);
-                    return @intCast(T, result);
-                },
-                else => {
-                    var result: i64 = undefined;
-                    assert(c.napi_get_value_int64(env, value, &result) == c.napi_ok);
-                    return switch (info.signedness) {
-                        .signed => @as(T, value),
-                        .unsigned => if (0 <= value) @intCast(T, 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

@@ -1,10 +0,0 @@
-const std = @import("std");
-const pkmn = @import("../pkmn.zig");
-
-export const SHOWDOWN = pkmn.options.showdown;
-export const LOG = pkmn.options.log;
-
-export const GEN1_CHOICES_SIZE =
-    std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.CHOICES_SIZE)) catch unreachable;
-export const GEN1_LOGS_SIZE =
-    std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.LOGS_SIZE)) catch unreachable;