@pkmn/engine 0.1.0-dev.dd5b9081 → 0.1.0-dev.deda8593

package/src/lib/gen1/helpers.zig

@@ -1,4 +1,5 @@
 const std = @import("std");
+const builtin = @import("builtin");
 
 const common = @import("../common/data.zig");
 const optional = @import("../common/optional.zig");
@@ -35,6 +36,8 @@ const Status = data.Status;
 const Action = chance.Action;
 const Actions = chance.Actions;
 
+const endian = builtin.cpu.arch.endian();
+
 /// Configuration options controlling the domain of valid Pokémon that can be generated by the
 /// random generator helpers.
 pub const Options = struct {
@@ -43,6 +46,8 @@ pub const Options = struct {
     /// Whether to generate Pokémon with moves that contain bugs on Pokémon Showdown that are
     /// unimplementable in the engine.
     block: bool = showdown,
+    // FIXME: remove once durations work with -Dchance
+    durations: bool = false,
 };
 
 /// Helpers to simplify initialization of a Generation I battle.
@@ -86,18 +91,38 @@ pub const Battle = struct {
 };
 
 fn prng(rand: *PSRNG) data.PRNG {
-    // GLITCH: initial bytes in seed can only range from 0-252, not 0-255
-    const max: u8 = 253;
     return .{
         .src = .{
             .seed = if (showdown)
                 rand.newSeed()
-            else
-                .{
-                    rand.range(u8, 0, max), rand.range(u8, 0, max), rand.range(u8, 0, max),
-                    rand.range(u8, 0, max), rand.range(u8, 0, max), rand.range(u8, 0, max),
-                    rand.range(u8, 0, max), rand.range(u8, 0, max), rand.range(u8, 0, max),
-                },
+            else seed: {
+                // GLITCH: The initial RNG seed in Gen I link battles is heavily constrained
+                // https://www.smogon.com/forums/threads/rng-in-rby-link-battles.3746779
+                var seed = [_]u8{ 0, 0, 0, 0, 0, 0, 0, 0, 0 };
+
+                // Bytes in seed can only range from 0-252, not 0-255
+                const max: u8 = 253;
+                // Instructions take multiples of 4 cycles to execute
+                var timer: u16 = 4 * rand.range(u16, 0, 16384);
+                var add: u8 = rand.range(u8, 0, 256);
+                var carry: u8 = 0;
+
+                var i: u8 = 0;
+                while (i < seed.len) {
+                    const div: u8 = @intCast(timer >> 8);
+                    add +%= div +% carry;
+                    if (add < max) {
+                        seed[i] = add;
+                        i += 1;
+                        timer +%= 472;
+                        carry = 1;
+                    } else {
+                        timer +%= 452;
+                        carry = 0;
+                    }
+                }
+                break :seed seed;
+            },
         },
     };
 }
@@ -210,6 +235,7 @@ pub const Pokemon = struct {
             var m: Move = .None;
             sample: while (true) {
                 m = @enumFromInt(rand.range(u8, 1, Move.size - 1 + 1));
+                if (opt.durations and durations(m)) continue :sample;
                 if (opt.block and blocked(m)) continue :sample;
                 for (0..i) |j| if (ms[j].id == m) continue :sample;
                 break;
@@ -247,6 +273,23 @@ fn blocked(m: Move) bool {
     };
 }
 
+fn durations(m: Move) bool {
+    // Any moves that have effects that result in duration tracking with -Dchance
+    return switch (Move.get(m).effect) {
+        .Confusion,
+        .Bide,
+        .Sleep,
+        .Rage,
+        .Binding,
+        .Thrashing,
+        .ConfusionChance,
+        .Disable,
+        .Metronome,
+        => true,
+        else => false,
+    };
+}
+
 /// Convenience helper to create a move-type choice for the provided move slot.
 pub fn move(slot: u4) Choice {
     return .{ .type = .Move, .data = slot };
@@ -266,8 +309,8 @@ pub const Rolls = struct {
     const PLAYERS = [_]Optional(Player){ .P1, .P2 };
 
     /// Returns a slice with the correct range of values for speed ties given the `action` state.
-    pub inline fn speedTie(action: Action) []const Optional(Player) {
-        return if (@field(action, "speed_tie") == .None) &PLAYER_NONE else &PLAYERS;
+    pub fn speedTie(action: Action) []const Optional(Player) {
+        return if (action.speed_tie == .None) &PLAYER_NONE else &PLAYERS;
     }
 
     const BOOL_NONE = [_]Optional(bool){.None};
@@ -275,27 +318,21 @@ pub const Rolls = struct {
 
     /// Returns a slice with the correct range of values for hits given the `action` state
     /// and the state of the `parent` (whether the player's Pokémon was fully paralyzed).
-    pub inline fn hit(action: Action, parent: Optional(bool)) []const Optional(bool) {
+    pub fn hit(action: Action, parent: Optional(bool)) []const Optional(bool) {
         if (parent == .true) return &BOOL_NONE;
-        return if (@field(action, "hit") == .None) &BOOL_NONE else &BOOLS;
+        return if (action.hit == .None) &BOOL_NONE else &BOOLS;
     }
 
     /// Returns a slice with the correct range of values for critical hits given the `action` state
     /// and the state of the `parent` (whether the player's Pokémon's move hit).
-    pub inline fn criticalHit(
-        action: Action,
-        parent: Optional(bool),
-    ) []const Optional(bool) {
+    pub fn criticalHit(action: Action, parent: Optional(bool)) []const Optional(bool) {
         if (parent == .false) return &BOOL_NONE;
-        return if (@field(action, "critical_hit") == .None) &BOOL_NONE else &BOOLS;
+        return if (action.critical_hit == .None) &BOOL_NONE else &BOOLS;
     }
 
     /// Returns a slice with the correct range of values for secondary chances hits given the
     /// `action` state and the state of the `parent` (whether the player's Pokémon's move hit).
-    pub inline fn secondaryChance(
-        action: Action,
-        parent: Optional(bool),
-    ) []const Optional(bool) {
+    pub fn secondaryChance(action: Action, parent: Optional(bool)) []const Optional(bool) {
         if (parent == .false) return &BOOL_NONE;
         return if (@field(action, "secondary_chance") == .None) &BOOL_NONE else &BOOLS;
     }
@@ -305,8 +342,8 @@ pub const Rolls = struct {
 
     /// Returns the range bounding damage rolls given the `action` state and the state of
     /// the `parent` (whether the player's Pokémon's move hit).
-    pub inline fn damage(action: Action, parent: Optional(bool)) Range {
-        return if (parent == .false or @field(action, "damage") == 0)
+    pub fn damage(action: Action, parent: Optional(bool)) Range {
+        return if (parent == .false or action.damage == 0)
             .{ .min = 0, .max = 1 }
         else
             .{ .min = 217, .max = 256 };
@@ -314,7 +351,7 @@ pub const Rolls = struct {
 
     /// Returns the max damage roll which will produce the same damage as `roll`
     /// given the base damage in `summaries`.
-    pub inline fn coalesce(player: Player, roll: u8, summaries: *calc.Summaries, cap: bool) !u8 {
+    pub fn coalesce(player: Player, roll: u8, summaries: *calc.Summaries, cap: bool) !u8 {
         if (roll == 0) return roll;
 
         const dmg = summaries.get(player.foe()).damage;
@@ -326,15 +363,15 @@ pub const Rolls = struct {
 
     /// Returns a slice with the correct range of values for confused given the `action` state
     /// and the state of the `parent` (the player's Pokémon's remaining confusion turns).
-    pub inline fn confused(action: Action, parent: u4) []const Optional(bool) {
-        return if (parent == 0 or @field(action, "confused") == .None) &BOOL_NONE else &BOOLS;
+    pub fn confused(action: Action, parent: u4) []const Optional(bool) {
+        return if (parent == 0 or action.confused == .None) &BOOL_NONE else &BOOLS;
     }
 
     /// Returns a slice with the correct range of values for paralysis given the `action` state
     /// and the state of the `parent` (whether the player's Pokémon was confused).
-    pub inline fn paralyzed(action: Action, parent: Optional(bool)) []const Optional(bool) {
+    pub fn paralyzed(action: Action, parent: Optional(bool)) []const Optional(bool) {
         if (parent == .true) return &BOOL_NONE;
-        return if (@field(action, "paralyzed") == .None) &BOOL_NONE else &BOOLS;
+        return if (action.paralyzed == .None) &BOOL_NONE else &BOOLS;
     }
 
     const DURATION_NONE = [_]u1{0};
@@ -342,9 +379,9 @@ pub const Rolls = struct {
 
     /// Returns a slice with a range of values for duration given the `action` state
     /// and the state of the `parent` (whether the player's Pokémon's move hit).
-    pub inline fn duration(action: Action, parent: Optional(bool)) []const u1 {
+    pub fn duration(action: Action, parent: Optional(bool)) []const u1 {
         if (parent == .false) return &DURATION_NONE;
-        return if (@field(action, "duration") == 0) &DURATION_NONE else &DURATION;
+        return if (action.duration == 0) &DURATION_NONE else &DURATION;
     }
 
     const U3_NONE = [_]u3{0};
@@ -352,8 +389,8 @@ pub const Rolls = struct {
 
     /// Returns a slice with a range of values for sleep given the `action` and `origin` states.
     pub inline fn sleep(action: Action, origin: Action) []const u3 {
-        const a = @field(action.durations, "sleep");
-        const o = @field(origin.durations, "sleep");
+        const a = action.durations.sleep;
+        const o = origin.durations.sleep;
         if (o == a) return if (o == 0) &U3_NONE else &[_]u3{o};
         assert(a == 0 or a == o + 1);
         return if (o >= 7) &U3_NONE else &[_]u3{ 0, o + 1 };
@@ -365,8 +402,8 @@ pub const Rolls = struct {
     /// and the state of the `parent` (the player's Pokémon's remaining sleep turns).
     pub inline fn disable(action: Action, origin: Action, parent: u4) []const u4 {
         if (parent > 0) return &DISABLE_NONE;
-        const a = @field(action.durations, "disable");
-        const o = @field(origin.durations, "disable");
+        const a = action.durations.disable;
+        const o = origin.durations.disable;
         if (o == a) return if (o == 0) &DISABLE_NONE else &[_]u4{o};
         assert(a == 0 or a == o + 1);
         return if (o >= 8) &DISABLE_NONE else &[_]u4{ 0, o + 1 };
@@ -376,8 +413,8 @@ pub const Rolls = struct {
     /// and the state of the `parent` (the player's remaining sleep turns).
     pub inline fn confusion(action: Action, origin: Action, parent: u4) []const u3 {
         if (parent > 0) return &U3_NONE;
-        const a = @field(action.durations, "confusion");
-        const o = @field(origin.durations, "confusion");
+        const a = action.durations.confusion;
+        const o = origin.durations.confusion;
         if (o == a) return if (o == 0) &U3_NONE else &[_]u3{o};
         assert(a == 0 or a == o + 1);
         return if (o >= 5) &U3_NONE else if (o < 2)
@@ -390,8 +427,8 @@ pub const Rolls = struct {
     /// and the state of the `parent` (whether the player's Pokémon was fully paralyzed).
     pub inline fn attacking(action: Action, origin: Action, parent: Optional(bool)) []const u3 {
         if (parent == .true) return &U3_NONE;
-        const a = @field(action.durations, "attacking");
-        const o = @field(origin.durations, "attacking");
+        const a = action.durations.attacking;
+        const o = origin.durations.attacking;
         if (o == a) return if (o == 0) &U3_NONE else &[_]u3{o};
         assert(a == 0 or a == o + 1);
         return if (o >= 3) &U3_NONE else if (o < 2)
@@ -404,8 +441,8 @@ pub const Rolls = struct {
     /// and the state of the `parent` (whether the player's Pokémon was fully paralyzed).
     pub inline fn binding(action: Action, origin: Action, parent: Optional(bool)) []const u3 {
         if (parent == .true) return &U3_NONE;
-        const a = @field(action.durations, "binding");
-        const o = @field(origin.durations, "binding");
+        const a = action.durations.binding;
+        const o = origin.durations.binding;
         if (o == a) return if (o == 0) &U3_NONE else &[_]u3{o};
         assert(a == 0 or a == o + 1);
         return if (o >= 4) &U3_NONE else &[_]u3{ 0, o + 1 };
@@ -418,9 +455,9 @@ pub const Rolls = struct {
     /// and the state of the `parent` (whether the player's Pokémon's move hit).
     ///
     /// These slots may or **may not be valid** as slots may be unset / have 0 PP.
-    pub inline fn moveSlot(action: Action, parent: Optional(bool)) []const u4 {
+    pub fn moveSlot(action: Action, parent: Optional(bool)) []const u4 {
         if (parent == .false) return &SLOT_NONE;
-        return if (@field(action, "move_slot") == 0) &SLOT_NONE else &SLOT;
+        return if (action.move_slot == 0) &SLOT_NONE else &SLOT;
     }
 
     const MULTI_NONE = [_]u4{0};
@@ -428,9 +465,9 @@ pub const Rolls = struct {
 
     /// Returns a slice with the correct range of values for multi hit given the `action` state
     /// and the state of the `parent` (whether the player's Pokémon's move hit).
-    pub inline fn multiHit(action: Action, parent: Optional(bool)) []const u4 {
+    pub fn multiHit(action: Action, parent: Optional(bool)) []const u4 {
         if (parent == .false) return &MULTI_NONE;
-        return if (@field(action, "multi_hit") == 0) &MULTI_NONE else &MULTI;
+        return if (action.multi_hit == 0) &MULTI_NONE else &MULTI;
     }
 
     const PSYWAVE_NONE = [_]u8{0};
@@ -442,49 +479,34 @@ pub const Rolls = struct {
 
     /// Returns a slice with the correct range of values for psywave given the `action` state,
     /// the `side`, and the state of the `parent` (whether the player's Pokémon's move hit).
-    pub inline fn psywave(
+    pub fn psywave(
         action: Action,
         side: *data.Side,
         parent: Optional(bool),
     ) []const u8 {
         if (parent == .false) return &PSYWAVE_NONE;
-        return if (@field(action, "psywave") == 0)
+        return if (action.psywave == 0)
             &PSYWAVE_NONE
         else
             PSYWAVE[0 .. @as(u16, side.stored().level) * 3 / 2];
     }
 
     const MOVE_NONE = [_]Move{.None};
-    const MOVES = init: {
-        var moves: [Move.size - 2]Move = undefined;
-        var i: usize = 0;
-        for (@typeInfo(Move).Enum.fields) |f| {
-            if (!(std.mem.eql(u8, f.name, "None") or
-                std.mem.eql(u8, f.name, "Metronome") or
-                std.mem.eql(u8, f.name, "Struggle") or
-                std.mem.eql(u8, f.name, "SKIP_TURN")))
-            {
-                moves[i] = @field(Move, f.name);
-                i += 1;
-            }
-        }
-        break :init moves;
-    };
 
     /// Returns a slice with the correct range of values for metronome given the `action` state.
-    pub inline fn metronome(action: Action) []const Move {
-        return if (@field(action, "metronome") == .None) &MOVE_NONE else &MOVES;
+    pub fn metronome(action: Action) []const Move {
+        return if (action.metronome == .None) &MOVE_NONE else &Move.METRONOME;
     }
 };
 
 test "Rolls.speedTie" {
-    const actions = Actions{ .p1 = .{ .speed_tie = .P2 } };
+    const actions: Actions = .{ .p1 = .{ .speed_tie = .P2 } };
     try expectEqualSlices(Optional(Player), &.{ .P1, .P2 }, Rolls.speedTie(actions.p1));
     try expectEqualSlices(Optional(Player), &.{.None}, Rolls.speedTie(actions.p2));
 }
 
 test "Rolls.damage" {
-    const actions = Actions{ .p2 = .{ .damage = 221 } };
+    const actions: Actions = .{ .p2 = .{ .damage = 221 } };
     try expectEqual(Rolls.Range{ .min = 0, .max = 1 }, Rolls.damage(actions.p1, .None));
     try expectEqual(Rolls.Range{ .min = 217, .max = 256 }, Rolls.damage(actions.p2, .None));
     try expectEqual(Rolls.Range{ .min = 0, .max = 1 }, Rolls.damage(actions.p2, .false));
@@ -493,16 +515,16 @@ test "Rolls.damage" {
 test "Rolls.coalesce" {
     var summaries =
         calc.Summaries{ .p1 = .{ .damage = .{ .base = 74, .final = 69, .capped = true } } };
-    try expectEqual(@as(u8, 0), try Rolls.coalesce(.P2, 0, &summaries, false));
-    try expectEqual(@as(u8, 241), try Rolls.coalesce(.P2, 238, &summaries, false));
-    try expectEqual(@as(u8, 255), try Rolls.coalesce(.P2, 238, &summaries, true));
+    try expectEqual(0, try Rolls.coalesce(.P2, 0, &summaries, false));
+    try expectEqual(241, try Rolls.coalesce(.P2, 238, &summaries, false));
+    try expectEqual(255, try Rolls.coalesce(.P2, 238, &summaries, true));
     summaries.p1.damage.final = 74;
-    try expectEqual(@as(u8, 217), try Rolls.coalesce(.P2, 217, &summaries, false));
-    try expectEqual(@as(u8, 255), try Rolls.coalesce(.P2, 217, &summaries, true));
+    try expectEqual(217, try Rolls.coalesce(.P2, 217, &summaries, false));
+    try expectEqual(255, try Rolls.coalesce(.P2, 217, &summaries, true));
 }
 
 test "Rolls.hit" {
-    const actions = Actions{ .p2 = .{ .hit = .true } };
+    const actions: Actions = .{ .p2 = .{ .hit = .true } };
     try expectEqualSlices(Optional(bool), &.{.None}, Rolls.hit(actions.p1, .None));
     try expectEqualSlices(Optional(bool), &.{ .false, .true }, Rolls.hit(actions.p2, .None));
     try expectEqualSlices(Optional(bool), &.{.None}, Rolls.hit(actions.p2, .true));
@@ -510,7 +532,7 @@ test "Rolls.hit" {
 }
 
 test "Rolls.secondaryChance" {
-    const actions = Actions{ .p1 = .{ .secondary_chance = .true } };
+    const actions: Actions = .{ .p1 = .{ .secondary_chance = .true } };
     try expectEqualSlices(
         Optional(bool),
         &.{ .false, .true },
@@ -521,7 +543,7 @@ test "Rolls.secondaryChance" {
 }
 
 test "Rolls.criticalHit" {
-    const actions = Actions{ .p1 = .{ .critical_hit = .true } };
+    const actions: Actions = .{ .p1 = .{ .critical_hit = .true } };
     try expectEqualSlices(
         Optional(bool),
         &.{ .false, .true },
@@ -532,14 +554,14 @@ test "Rolls.criticalHit" {
 }
 
 test "Rolls.confused" {
-    const actions = Actions{ .p2 = .{ .confused = .true } };
+    const actions: Actions = .{ .p2 = .{ .confused = .true } };
     try expectEqualSlices(Optional(bool), &.{.None}, Rolls.confused(actions.p1, 1));
     try expectEqualSlices(Optional(bool), &.{ .false, .true }, Rolls.confused(actions.p2, 1));
     try expectEqualSlices(Optional(bool), &.{.None}, Rolls.confused(actions.p2, 0));
 }
 
 test "Rolls.paralyzed" {
-    const actions = Actions{ .p2 = .{ .paralyzed = .true } };
+    const actions: Actions = .{ .p2 = .{ .paralyzed = .true } };
     try expectEqualSlices(Optional(bool), &.{.None}, Rolls.paralyzed(actions.p1, .None));
     try expectEqualSlices(Optional(bool), &.{ .false, .true }, Rolls.paralyzed(actions.p2, .None));
     try expectEqualSlices(Optional(bool), &.{ .false, .true }, Rolls.paralyzed(actions.p2, .false));
@@ -547,7 +569,7 @@ test "Rolls.paralyzed" {
 }
 
 test "Rolls.duration" {
-    const actions = Actions{ .p2 = .{ .duration = 3 } };
+    const actions: Actions = .{ .p2 = .{ .duration = 3 } };
     try expectEqualSlices(u1, &.{0}, Rolls.duration(actions.p1, .None));
     try expectEqualSlices(u1, &.{1}, Rolls.duration(actions.p2, .None));
     try expectEqualSlices(u1, &.{0}, Rolls.duration(actions.p2, .false));
@@ -757,27 +779,27 @@ test "Rolls.binding" {
 }
 
 test "Rolls.moveSlot" {
-    const actions = Actions{ .p2 = .{ .move_slot = 3 } };
+    const actions: Actions = .{ .p2 = .{ .move_slot = 3 } };
     try expectEqualSlices(u4, &.{0}, Rolls.moveSlot(actions.p1, .None));
     try expectEqualSlices(u4, &.{ 1, 2, 3, 4 }, Rolls.moveSlot(actions.p2, .None));
     try expectEqualSlices(u4, &.{0}, Rolls.moveSlot(actions.p2, .false));
 }
 
 test "Rolls.multiHit" {
-    const actions = Actions{ .p2 = .{ .multi_hit = 3 } };
+    const actions: Actions = .{ .p2 = .{ .multi_hit = 3 } };
     try expectEqualSlices(u4, &.{0}, Rolls.multiHit(actions.p1, .None));
     try expectEqualSlices(u4, &.{ 2, 3, 4, 5 }, Rolls.multiHit(actions.p2, .None));
     try expectEqualSlices(u4, &.{0}, Rolls.multiHit(actions.p2, .false));
 }
 
 test "Rolls.metronome" {
-    const actions = Actions{ .p2 = .{ .metronome = .Surf } };
+    const actions: Actions = .{ .p2 = .{ .metronome = .Surf } };
     try expectEqualSlices(Move, &.{.None}, Rolls.metronome(actions.p1));
     try expectEqual(@as(Move, @enumFromInt(24)), Rolls.metronome(actions.p2)[23]);
 }
 
 test "Rolls.psywave" {
-    const actions = Actions{ .p2 = .{ .psywave = 79 } };
+    const actions: Actions = .{ .p2 = .{ .psywave = 79 } };
     var side = Side.init(&[_]Pokemon{.{
         .species = .Bulbasaur,
         .level = 100,
@@ -786,9 +808,53 @@ test "Rolls.psywave" {
 
     try expectEqualSlices(u8, &.{0}, Rolls.psywave(actions.p1, &side, .None));
     var rolls = Rolls.psywave(actions.p2, &side, .None);
-    try expectEqual(@as(u8, 150), rolls[rolls.len - 1]);
+    try expectEqual(150, rolls[rolls.len - 1]);
     side.stored().level = 81;
     rolls = Rolls.psywave(actions.p2, &side, .None);
-    try expectEqual(@as(u8, 121), rolls[rolls.len - 1]);
+    try expectEqual(121, rolls[rolls.len - 1]);
     try expectEqualSlices(u8, &.{0}, Rolls.psywave(actions.p2, &side, .false));
 }
+
+/// Empirically determined maximum number of bytes possibly required to store the diff between two
+/// Generation I battles.
+pub const MAX_DIFFS: usize = 117;
+
+/// The optimal size in bytes required to hold the diff between two Generation I battles.
+/// At least as large as MAX_DIFFS.
+pub const DIFFS_SIZE = if (builtin.mode == .ReleaseSmall)
+    MAX_DIFFS
+else
+    std.math.ceilPowerOfTwo(usize, MAX_DIFFS) catch unreachable;
+
+/// TODO
+pub fn diff(
+    a: *const data.Battle(data.PRNG),
+    b: *const data.Battle(data.PRNG),
+    w: protocol.ByteStream.Writer,
+) !usize {
+    const pos = w.stream.pos;
+    const size = @sizeOf(data.Battle(data.PRNG)) - @sizeOf(data.PRNG);
+    assert(size % 2 == 0);
+    assert(size / 2 < 255);
+
+    var i: usize = 0;
+    while (i < size) : (i += 2) {
+        const val = std.mem.bytesAsValue(u16, std.mem.asBytes(a)[i .. i + 2]).*;
+        if (val != std.mem.bytesAsValue(u16, std.mem.asBytes(b)[i .. i + 2]).*) {
+            try w.writeByte(@intCast(i / 2));
+            try w.writeInt(u16, val, endian);
+        }
+    }
+
+    return w.stream.pos - pos;
+}
+
+/// TODO
+pub fn patch(battle: *data.Battle(data.PRNG), buf: []u8) void {
+    var i: usize = 0;
+    while (i < buf.len) : (i += 3) {
+        const off = @as(u16, @intCast(buf[i])) * 2;
+        const val = std.mem.readInt(u16, @ptrCast(buf[i + 1 .. i + 3]), endian);
+        std.mem.writeInt(u16, @ptrCast(std.mem.asBytes(battle)[off .. off + 2]), val, endian);
+    }
+}