manabrew-engine 0.4.1

Magic: The Gathering rules engine — a Rust port of Forge
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
//! Hidden-origin zone change resolution.
//!
//! Handles library/hand searches with peek, choose, shuffle flow.
//! Mirrors Java's `changeHiddenOriginResolve`.

use forge_foundation::ZoneType;

use super::super::EffectContext;
use super::helpers::{
    can_search_library, find_opposition_agent, find_search_limit, matches_with_context,
    resolve_destination,
};
use super::move_cards::move_cards;
use super::search::{
    resolve_defined_players_for_hidden_origin, resolve_each_search, resolve_multi_search,
    resolve_random_selection, resolve_single_search,
};
use crate::ability::ability_ir::DefinedRef;
use crate::agent::GameEntity;
use crate::ids::PlayerId;
use crate::spellability::SpellAbility;

/// Resolve zone changes from hidden zones (Library, Hand).
pub(super) fn resolve_hidden_origin(
    ctx: &mut EffectContext,
    sa: &SpellAbility,
    origin_zone: ZoneType,
    dest_zone: ZoneType,
) {
    let (dest_zone, lib_position) = resolve_destination(ctx, sa, dest_zone);
    let defined = sa.defined().unwrap_or("").to_string();
    let defined_ref = sa.defined_ref();
    let change_type = sa.change_type().unwrap_or("").to_string();
    let controller = sa.activating_player;
    // ChangeNum$ resolved late — may be a Count$ expression, not a literal.
    let change_num =
        crate::svar::resolve_numeric_svar(ctx.game, sa, crate::parsing::keys::CHANGE_NUM, 1).max(0)
            as usize;
    let origin_zones = {
        let origins = sa.origin_zones();
        if origins.is_empty() {
            vec![origin_zone]
        } else {
            origins
        }
    };
    // Mirror Java `ChangeZoneEffect.changeZonePlayerInvariant` (line 914 / 970 / 1208).
    //   `optional_confirm` — Java line 970 `hasParam("Optional")`: gates the
    //     "Search?" confirm prompt that precedes the chooser.
    //   `chooser_optional` — Java line 1208 `!hasParam("Mandatory")`: passed to
    //     `chooseSingleCardForZoneChange` so the chooser may decline by returning
    //     null (CR 701.18b lets the controller find no cards even on a non-
    //     mandatory search). The chooser callback is still emitted in that case.
    let optional_confirm = sa.is_optional();
    let chooser_optional = !sa.is_mandatory();

    // ── Defined$ handling (mirrors Java lines 999-1011) ──────────────────
    // When Defined$ is set to a known card reference (Remembered, Imprinted,
    // Self, etc.), we bypass the search flow and directly fetch those cards.
    // Java's changeHiddenOriginResolve checks `defined = sa.hasParam("Defined")`
    // and uses AbilityUtils.getDefinedCards() to get the specific cards.
    let is_defined = !defined.is_empty()
        && !defined.eq_ignore_ascii_case("You")
        && !defined.eq_ignore_ascii_case("Opponent");

    if is_defined && sa.defined_player().is_none() {
        // Resolve defined cards (Remembered, Imprinted, Self, etc.)
        let cards: Vec<crate::ids::CardId> = if matches!(defined_ref, Some(DefinedRef::Remembered))
        {
            sa.source
                .map(|sid| ctx.game.card(sid).remembered_cards.clone())
                .unwrap_or_default()
        } else if matches!(defined_ref, Some(DefinedRef::Imprinted)) {
            sa.source
                .map(|sid| ctx.game.card(sid).imprinted_cards.clone())
                .unwrap_or_default()
        } else if matches!(defined_ref, Some(DefinedRef::SelfCard)) {
            sa.source.into_iter().collect()
        } else if matches!(defined_ref, Some(DefinedRef::ParentTarget)) {
            sa.target_chosen.target_card.into_iter().collect()
        } else if defined.starts_with("TopOfLibrary") {
            // TopOfLibrary, TopOfLibrary2, etc.
            let n = defined
                .strip_prefix("TopOfLibrary")
                .and_then(|s| {
                    if s.is_empty() {
                        Some(1)
                    } else {
                        s.parse::<usize>().ok()
                    }
                })
                .unwrap_or(1);
            let lib = ctx.game.cards_in_zone(origin_zone, controller);
            lib.iter().rev().take(n).copied().collect()
        } else if defined.starts_with("BottomOfLibrary") {
            let n = defined
                .strip_prefix("BottomOfLibrary")
                .and_then(|s| {
                    if s.is_empty() {
                        Some(1)
                    } else {
                        s.parse::<usize>().ok()
                    }
                })
                .unwrap_or(1);
            let lib = ctx.game.cards_in_zone(origin_zone, controller);
            lib.iter().take(n).copied().collect()
        } else if matches!(
            defined_ref,
            Some(DefinedRef::DelayTriggerRememberedLki | DefinedRef::RememberedLki)
        ) {
            sa.trigger_objects
                .get(&crate::ability::AbilityKey::RememberedLKI)
                .into_iter()
                .flat_map(|value| value.split(','))
                .filter_map(|part| part.trim().parse::<u32>().ok())
                .map(crate::ids::CardId)
                .collect()
        } else {
            // Unknown defined type — fall through to search
            Vec::new()
        };

        // Filter to only cards still in the expected origin zone
        let valid: Vec<crate::ids::CardId> = cards
            .into_iter()
            .filter(|&cid| ctx.game.card(cid).zone == origin_zone)
            .collect();
        if !valid.is_empty() {
            let mut ordered = valid;
            if sa.ir.reorder && ordered.len() > 1 {
                ctx.agents[controller.index()].snapshot_state(ctx.game, ctx.mana_pools);
                let reordered = ctx.agents[controller.index()]
                    .choose_reorder_library(ctx.game, controller, &ordered);
                if reordered.len() == ordered.len()
                    && ordered.iter().all(|id| reordered.contains(id))
                {
                    ordered = reordered;
                }
            }
            // Optional$ True — Java mirrors per-card confirm at
            // `ChangeZoneEffect.java:558-561`. Mirrors the same hook in
            // `known.rs`. Required for Risen Reef / similar peek-and-move
            // optional moves originating from a hidden zone (Library).
            if sa.ir.optional {
                let chooser = controller;
                let _source_name = sa.source.map(|cid| ctx.game.card(cid).card_name.clone());
                ordered.retain(|&cid| {
                    let card_name = ctx.game.card(cid).card_name.clone();
                    let prompt = format!(
                        "Do you want to move {} from {} to {}?",
                        card_name, origin_zone, dest_zone,
                    );
                    ctx.agents[chooser.index()].confirm_action(
                        chooser,
                        None,
                        &prompt,
                        &[],
                        sa.source,
                        Some(crate::ability::api_type::ApiType::ChangeZone),
                    )
                });
            }
            // For Defined card moves, suppress the post-move library shuffle.
            // Java's changeHiddenOriginResolve checks `!defined` before shuffling
            // (line 1509), so Defined moves never trigger a search shuffle.
            // The shuffle is handled separately by a SubAbility$ DBShuffle if needed.
            let mut sa_no_shuffle = sa.clone();
            sa_no_shuffle.ir.no_shuffle = true;
            move_cards(
                ctx,
                &sa_no_shuffle,
                &ordered,
                origin_zone,
                dest_zone,
                &lib_position,
                controller,
                controller,
            );
        }
        // For known defined types (Remembered, Imprinted, etc.), always return
        // even if empty — do NOT fall through to a full zone search.
        // In Java, getDefinedCards("Remembered") returns an empty list and
        // the search simply does nothing.
        return;
    }

    let explicit_chooser: Option<PlayerId> = if let Some(chooser_def) = sa.chooser() {
        let chooser_players = crate::ability::ability_utils::resolve_defined_players_with_sa(
            chooser_def,
            sa,
            controller,
            ctx.game,
        );
        if chooser_players.is_empty() {
            None
        } else {
            let chooser_entities: Vec<_> = chooser_players
                .iter()
                .copied()
                .map(GameEntity::Player)
                .collect();
            ctx.agents[controller.index()].snapshot_state(ctx.game, ctx.mana_pools);
            Some(
                match ctx.agents[controller.index()].choose_single_entity_for_effect(
                    controller,
                    &chooser_entities,
                    false,
                ) {
                    Some(GameEntity::Player(pid)) => pid,
                    _ => chooser_players[0],
                },
            )
        }
    } else {
        None
    };
    // Java `changeZonePlayerInvariant` (ChangeZoneEffect.java:917-921):
    //   `decider = chooser; if (decider == null) decider = player;`
    // Without an explicit `Chooser$`, the per-iteration affected fetcher decides
    // (e.g. Assassin's Trophy: the destroyed permanent's controller searches).
    let chooser = explicit_chooser.unwrap_or(controller);

    // DefinedPlayer$ for hidden-origin
    if sa.defined_player().is_some()
        && !defined.eq_ignore_ascii_case("You")
        && !defined.eq_ignore_ascii_case("Opponent")
    {
        for affected_player in resolve_defined_players_for_hidden_origin(ctx, sa) {
            let decider = explicit_chooser.unwrap_or(affected_player);
            let effective_chooser = if origin_zone == ZoneType::Library {
                find_opposition_agent(ctx, controller).unwrap_or(decider)
            } else {
                decider
            };

            if optional_confirm {
                let origin_label = origin_zone.to_string().to_lowercase();
                let message = format!(
                    "Search {}'s {}?",
                    ctx.game.player(affected_player).name,
                    origin_label
                );
                ctx.agents[effective_chooser.index()].snapshot_state(ctx.game, ctx.mana_pools);
                let accepted = ctx.agents[effective_chooser.index()].confirm_action(
                    effective_chooser,
                    Some("ChangeZoneGeneral"),
                    &message,
                    &[],
                    sa.source,
                    Some(crate::ability::api_type::ApiType::ChangeZone),
                );
                if !accepted {
                    continue;
                }
            }

            // RememberSearched$ — Java ChangeZoneEffect.java:1081.
            if sa.ir.remember_searched {
                if let Some(sid) = sa.source {
                    ctx.game
                        .card_mut(sid)
                        .add_remembered_player(affected_player);
                }
            }

            let mut zone_cards = ctx
                .game
                .cards_in_zone(origin_zone, affected_player)
                .to_vec();
            if origin_zone == ZoneType::Library {
                if let Some(max) = find_search_limit(ctx, affected_player, controller) {
                    zone_cards.truncate(max);
                }
            }

            let mut cards_to_move = if let Some(each_spec) = change_type.strip_prefix("EACH ") {
                resolve_each_search(
                    ctx,
                    sa,
                    each_spec,
                    &mut zone_cards,
                    effective_chooser,
                    chooser_optional,
                )
            } else {
                let candidates: Vec<_> = zone_cards
                    .iter()
                    .copied()
                    .filter(|&cid| matches_with_context(ctx, sa, cid, sa.change_type_selector()))
                    .collect();
                if sa.is_at_random() {
                    if candidates.is_empty() {
                        Vec::new()
                    } else {
                        resolve_random_selection(ctx, &candidates, change_num)
                    }
                } else if change_num == 1 {
                    // Mirrors Java line 1208 — call the chooser even with an
                    // empty fetchList so the parity callback is emitted.
                    resolve_single_search(ctx, sa, &candidates, effective_chooser, chooser_optional)
                } else {
                    resolve_multi_search(
                        ctx,
                        sa,
                        &candidates,
                        effective_chooser,
                        change_num,
                        chooser_optional,
                    )
                }
            };

            if sa.ir.reorder && cards_to_move.len() > 1 {
                ctx.agents[effective_chooser.index()].snapshot_state(ctx.game, ctx.mana_pools);
                let reordered = ctx.agents[effective_chooser.index()].choose_reorder_library(
                    ctx.game,
                    effective_chooser,
                    &cards_to_move,
                );
                if reordered.len() == cards_to_move.len()
                    && cards_to_move.iter().all(|id| reordered.contains(id))
                {
                    cards_to_move = reordered;
                }
            }

            move_cards(
                ctx,
                sa,
                &cards_to_move,
                origin_zone,
                dest_zone,
                &lib_position,
                affected_player,
                affected_player,
            );
        }
        return;
    }

    let search_player = if sa.defined_player().is_none() {
        sa.target_chosen.target_player.unwrap_or_else(|| {
            if defined.eq_ignore_ascii_case("Opponent") {
                ctx.game.opponent_of(controller)
            } else {
                controller
            }
        })
    } else if defined.eq_ignore_ascii_case("Opponent") {
        ctx.game.opponent_of(controller)
    } else {
        controller
    };

    // Leonin Arbiter check
    if origin_zone == ZoneType::Library && !can_search_library(ctx, controller) {
        ctx.game
            .shuffle_zone_cards(ZoneType::Library, search_player, ctx.rng);
        return;
    }

    // Opposition Agent — opponent controls the search
    let effective_chooser = if origin_zone == ZoneType::Library {
        find_opposition_agent(ctx, controller).unwrap_or(chooser)
    } else {
        chooser
    };

    if optional_confirm {
        let _source_name = sa.source.map(|cid| ctx.game.card(cid).card_name.as_str());
        let origin_label = origin_zone.to_string().to_lowercase();
        let message = if is_defined {
            format!(
                "Put that card from {}'s {} to {}?",
                ctx.game.player(search_player).name,
                origin_label,
                dest_zone.to_string().to_lowercase()
            )
        } else {
            format!(
                "Search {}'s {}?",
                ctx.game.player(search_player).name,
                origin_label
            )
        };
        ctx.agents[effective_chooser.index()].snapshot_state(ctx.game, ctx.mana_pools);
        let accepted = ctx.agents[effective_chooser.index()].confirm_action(
            effective_chooser,
            Some("ChangeZoneGeneral"),
            &message,
            &[],
            sa.source,
            Some(crate::ability::api_type::ApiType::ChangeZone),
        );
        if !accepted {
            return;
        }
    }

    let mut zone_cards = collect_search_zone_cards(ctx, &origin_zones, search_player);

    // Aven Mindcensor restriction
    if origin_zones.contains(&ZoneType::Library) {
        apply_library_search_limit(ctx, search_player, controller, &mut zone_cards);
    }

    // RememberSearched$
    if sa.ir.remember_searched {
        if let Some(sid) = sa.source {
            ctx.game.card_mut(sid).add_remembered_player(search_player);
        }
    }

    // Panglacial Wurm — offer to cast while searching
    if origin_zone == ZoneType::Library {
        offer_panglacial_cast(ctx, sa, controller, &mut zone_cards);
    }

    let mut cards_to_move = if let Some(each_spec) = change_type.strip_prefix("EACH ") {
        resolve_each_search(
            ctx,
            sa,
            each_spec,
            &mut zone_cards,
            effective_chooser,
            chooser_optional,
        )
    } else {
        let candidates: Vec<_> = zone_cards
            .iter()
            .copied()
            .filter(|&cid| matches_with_context(ctx, sa, cid, sa.change_type_selector()))
            .collect();
        if sa.is_at_random() {
            if candidates.is_empty() {
                Vec::new()
            } else {
                resolve_random_selection(ctx, &candidates, change_num)
            }
        } else if sa.ir.reorder
            && !chooser_optional
            && origin_zone == ZoneType::Library
            && dest_zone == ZoneType::Library
            && candidates.len() == change_num
        {
            // When the full candidate set must be moved and then reordered,
            // there is no meaningful hidden-zone selection step. Go straight
            // to the reorder callback for the final ordered set.
            candidates
        } else if change_num == 1 {
            // Mirrors Java line 1208: chooseSingleCardForZoneChange is called
            // unconditionally, even when fetchList is empty, so the callback
            // is emitted (returning null). Java line 1215 then breaks without
            // a cancel prompt when the list is empty.
            resolve_single_search(ctx, sa, &candidates, effective_chooser, chooser_optional)
        } else {
            resolve_multi_search(
                ctx,
                sa,
                &candidates,
                effective_chooser,
                change_num,
                chooser_optional,
            )
        }
    };

    if sa.ir.reorder && cards_to_move.len() > 1 {
        ctx.agents[effective_chooser.index()].snapshot_state(ctx.game, ctx.mana_pools);
        let reordered = ctx.agents[effective_chooser.index()].choose_reorder_library(
            ctx.game,
            effective_chooser,
            &cards_to_move,
        );
        if reordered.len() == cards_to_move.len()
            && cards_to_move.iter().all(|id| reordered.contains(id))
        {
            cards_to_move = reordered;
        }
    }

    // Exactly$ — must find exactly ChangeNum or fail
    if sa.ir.exactly && cards_to_move.len() != change_num {
        if origin_zone == ZoneType::Library {
            ctx.game
                .shuffle_zone_cards(ZoneType::Library, search_player, ctx.rng);
        }
        return;
    }

    // RememberLKI$
    if sa.ir.remember_lki_flag {
        if let Some(sid) = sa.source {
            for &cid in &cards_to_move {
                ctx.game.card_mut(sid).add_remembered_card(cid);
            }
        }
    }

    move_cards(
        ctx,
        sa,
        &cards_to_move,
        origin_zone,
        dest_zone,
        &lib_position,
        controller,
        search_player,
    );
}

fn collect_search_zone_cards(
    ctx: &EffectContext,
    origin_zones: &[ZoneType],
    search_player: PlayerId,
) -> Vec<crate::ids::CardId> {
    origin_zones
        .iter()
        .flat_map(|&zone| ctx.game.cards_in_zone(zone, search_player).to_vec())
        .collect()
}

fn apply_library_search_limit(
    ctx: &EffectContext,
    search_player: PlayerId,
    controller: PlayerId,
    zone_cards: &mut Vec<crate::ids::CardId>,
) {
    let Some(max) = find_search_limit(ctx, search_player, controller) else {
        return;
    };
    let mut seen_library = 0usize;
    zone_cards.retain(|&cid| {
        if ctx.game.card(cid).zone != ZoneType::Library {
            return true;
        }
        seen_library += 1;
        seen_library <= max
    });
}

/// Offer Panglacial Wurm cast during library search (CR 702.113).
fn offer_panglacial_cast(
    ctx: &mut EffectContext,
    _sa: &SpellAbility,
    controller: PlayerId,
    zone_cards: &mut Vec<crate::ids::CardId>,
) {
    let panglacial: Vec<_> = zone_cards
        .iter()
        .copied()
        .filter(|&cid| {
            ctx.game
                .card(cid)
                .keywords
                .contains_string_ignore_case("Panglacial")
        })
        .collect();
    for pg_id in panglacial {
        let name = ctx.game.card(pg_id).card_name.clone();
        let cast = ctx.agents[controller.index()].confirm_action(
            controller,
            Some("PanglacialCast"),
            &format!("Cast {} from library while searching?", name),
            &[],
            Some(pg_id),
            None,
        );
        if cast {
            zone_cards.retain(|&cid| cid != pg_id);
            ctx.move_card(pg_id, ZoneType::Stack, controller);
        }
    }
}