@pkmn/engine 0.1.0-dev.8b83af6b → 0.1.0-dev.8cf7e679

package/src/lib/node.zig

@@ -0,0 +1,129 @@
+const js = @import("common/js.zig");
+const pkmn = @import("pkmn.zig");
+const std = @import("std");
+
+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;
@@ -22,13 +22,16 @@ pub const Choice = @import("common/data.zig").Choice;
 /// considered terminal.
 pub const Result = @import("common/data.zig").Result;
 
+// TODO
+pub const Array = @import("common/array.zig").Array;
+// TODO
+pub const Optional = @import("common/optional.zig").Optional;
+
 /// Pokémon Showdown's RNG (backed by a Generation V & VI RNG).
 pub const PSRNG = @import("common/rng.zig").PSRNG;
 
 /// Namespace for helpers related to protocol message logging.
-pub const protocol = if (options.internal) struct {
-    pub usingnamespace @import("common/protocol.zig");
-} else struct {
+pub const protocol = if (options.internal) @import("common/protocol.zig") else struct {
     /// Logs protocol information to its `Writer` during a battle update when
     /// `options.log` is enabled.
     pub const Log = @import("common/protocol.zig").Log;
@@ -46,9 +49,86 @@ 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) @import("gen1/calc.zig") else struct {
+        /// 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;
+        /// TODO
+        pub const MAX_FRONTIER = @import("gen1/calc.zig").MAX_FRONTIER;
+        /// TODO
+        pub const Rolls = @import("gen1/calc.zig").Rolls;
+    };
     /// 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) @import("gen2/calc.zig") else struct {
+        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) @import("common/js.zig") else {};
+pub const bindings = if (options.internal) struct {
+    pub const node = @import("node.zig");
+    pub const wasm = @import("wasm.zig");
+} else {};

package/src/lib/wasm.zig

@@ -0,0 +1,48 @@
+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;
+
+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;
+
+export fn GEN1_update(
+    battle: *pkmn.gen1.Battle(pkmn.gen1.PRNG),
+    c1: pkmn.Choice,
+    c2: pkmn.Choice,
+    options: ?[*]u8,
+) pkmn.Result {
+    return (if (options) |o| result: {
+        const buf = @as([*]u8, @ptrCast(o))[0..pkmn.gen1.LOGS_SIZE];
+        var stream: pkmn.protocol.ByteStream = .{ .buffer = buf };
+        // TODO: extract out
+        var opts = pkmn.battle.options(
+            pkmn.protocol.FixedLog{ .writer = stream.writer() },
+            pkmn.gen1.chance.NULL,
+            pkmn.gen1.calc.NULL,
+        );
+        break :result battle.update(c1, c2, &opts);
+    } else battle.update(c1, c2, &pkmn.gen1.NULL)) catch unreachable;
+}
+
+export fn GEN1_choices(
+    battle: *pkmn.gen1.Battle(pkmn.gen1.PRNG),
+    player: u8,
+    request: u8,
+    buf: [*]u8,
+) u8 {
+    assert(player <= @field(@typeInfo(pkmn.Player), @tagName(Enum)).fields.len);
+    assert(request <= @field(@typeInfo(pkmn.Choice.Type), @tagName(Enum)).fields.len);
+
+    const len = GEN1_CHOICES_SIZE;
+    return battle.choices(@enumFromInt(player), @enumFromInt(request), @ptrCast(buf[0..len]));
+}

package/src/tools/display/dom.ts

@@ -0,0 +1,96 @@
+/** @license MIT modified from Vadim Demedes's https://github.com/vadimdemedes/dom-chef */
+type Attributes = JSX.IntrinsicElements['div'];
+type DocumentFragmentConstructor = typeof DocumentFragment;
+type ElementFunction = (props?: any) => HTMLElement;
+
+declare global {
+  namespace JSX {
+    interface Element extends HTMLElement, DocumentFragment {
+      addEventListener: HTMLElement['addEventListener'];
+      removeEventListener: HTMLElement['removeEventListener'];
+      className: HTMLElement['className'];
+    }
+  }
+}
+
+interface JSXElementClassDocumentFragment extends DocumentFragment, JSX.ElementClass { }
+interface Fragment {
+  prototype: JSXElementClassDocumentFragment;
+  new(): JSXElementClassDocumentFragment;
+}
+
+// https://github.com/preactjs/preact/blob/1bbd687c/src/constants.js#L3
+const IS_NON_DIMENSIONAL = /acit|ex(?:s|g|n|p|$)|rph|grid|ows|mnc|ntw|ine[ch]|zoo|^ord|itera/i;
+
+const isFragment = (type: DocumentFragmentConstructor | ElementFunction):
+  type is DocumentFragmentConstructor => type === DocumentFragment;
+
+const setCSSProps = (element: HTMLElement, style: CSSStyleDeclaration) => {
+  for (const [name, value] of Object.entries(style)) {
+    if (name.startsWith('-')) {
+      element.style.setProperty(name, value);
+    } else if (typeof value === 'number' && !IS_NON_DIMENSIONAL.test(name)) {
+      element.style[name as any] = `${value as string}px`;
+    } else {
+      element.style[name as any] = value;
+    }
+  }
+};
+
+const setAttribute = (element: HTMLElement, name: string, value: string) => {
+  if (value !== undefined && value !== null) element.setAttribute(name, value);
+};
+
+const addChildren = (parent: Element | DocumentFragment, children: Node[]) => {
+  for (const child of children) {
+    if (child instanceof Node) {
+      parent.appendChild(child);
+    } else if (Array.isArray(child)) {
+      addChildren(parent, child);
+    } else if (typeof child !== 'boolean' && typeof child !== 'undefined' && child !== null) {
+      parent.appendChild(document.createTextNode(child));
+    }
+  }
+};
+
+// https://github.com/facebook/react/blob/3f899089/packages/react-dom/src/shared/DOMProperty.js#L288-L322
+const FALSIFIABLE_ATTRIBUTES = ['contentEditable', 'draggable', 'spellCheck', 'value'];
+
+export const h = (
+  type: DocumentFragmentConstructor | ElementFunction | string,
+  attributes?: Attributes,
+  ...children: Node[]
+) => {
+  if (typeof type !== 'string') {
+    const element = isFragment(type) ? document.createDocumentFragment() : type(attributes);
+    addChildren(element, children);
+    return element;
+  }
+
+  const element = document.createElement(type);
+  addChildren(element, children);
+  if (!attributes) return element;
+
+  for (let [name, value] of Object.entries(attributes)) {
+    if (name === 'htmlFor') name = 'for';
+
+    if (name === 'class' || name === 'className') {
+      const existingClassname = element.getAttribute('class') ?? '';
+      setAttribute(element, 'class', (existingClassname + ' ' + String(value)).trim());
+    } else if (name === 'style') {
+      setCSSProps(element, value);
+    } else if (name.startsWith('on')) {
+      const eventName = name.slice(2).toLowerCase().replace(/^-/, '');
+      element.addEventListener(eventName, value);
+    } else if (name === 'dangerouslySetInnerHTML' && '__html' in value) {
+      element.innerHTML = value.__html;
+    } else if (name !== 'key' && (FALSIFIABLE_ATTRIBUTES.includes(name) || value !== false)) {
+      setAttribute(element, name, value === true ? '' : value);
+    }
+  }
+
+  return element;
+};
+
+export const Fragment =
+  (typeof DocumentFragment === 'function' ? DocumentFragment : () => {}) as Fragment;