wintf 0.0.3

Windows Tategaki Framework - Rust UI library with Japanese vertical text support
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
//! 入口を通る再入のドラッグの決定論テスト(取り消し側)。
//!
//! 組み立ては `wndproc_bridge_drag_test_support.rs` の [`Rig`]。テストの番号は design.md の
//! Testing Strategy「入口を通る再入のテスト」の表の番号(1・3・4・7・7b・8・13)。
//! 起床の旗を読むテスト(7・7b)は共有の錠 `TICK_WAKE_TEST_LOCK` を毒化に耐える取り方で取る。

use std::cell::{Cell, RefCell};
use std::rc::Rc;
use std::time::Instant;

use bevy_ecs::message::Messages;
use windows::Win32::UI::WindowsAndMessaging::{
    WM_ACTIVATE, WM_KEYDOWN, WM_LBUTTONDOWN, WM_LBUTTONUP, WM_MOUSEMOVE,
};

use super::wndproc_bridge_drag_test_support::{
    CANCELMODE, CANCELS, CAPTURE_LOST, Cancel, DEACTIVATE, ESC, MOVED, PRESS, Rig, client_lparam,
    rests_cancelled,
};
use crate::ecs::drag::{DragEndEvent, DraggingState, WindowDragging, snapshot_drag_state};
use crate::ecs::pointer::PhysicalPoint;
use crate::ecs::window::{KeepDirectlyAbove, SinkObservationPending};
use crate::ecs::world::{FrameCount, UISetup, tick_wake};

// ============================================================================
// テスト 1: 閾値を越えた後の取り消し 4 種で、終了の知らせが取り消しの印つきで 1 件
// (要件 1.1・2.1・2.3)
// ============================================================================

fn cancel_after_threshold_ends_once(kind: Cancel) {
    let rig = Rig::new();
    rig.start_drag();

    let ret = rig.send_while_borrowed(kind.msg, kind.wparam, 0);
    assert!(ret.is_none(), "{}: 入口は既定の手続きへ委ねる", kind.what);
    assert!(
        rests_cancelled(),
        "{}: 再入で届いてもドラッグは取り消しの印つきで休む: {:?}",
        kind.what,
        snapshot_drag_state()
    );

    let ends = rig.dispatch_ends();
    assert_eq!(
        ends.len(),
        1,
        "{}: 再入の取り消しでも終了の知らせは 1 件: {ends:?}",
        kind.what
    );
    let end = &ends[0];
    assert_eq!(end.target, rig.target, "{}: 対象", kind.what);
    assert!(end.cancelled, "{}: 取り消しの印つき", kind.what);
    assert_eq!(end.position, PRESS, "{}: 位置は押した位置", kind.what);
}

#[test]
fn t01_reentrant_esc_after_threshold_ends_once_cancelled() {
    cancel_after_threshold_ends_once(ESC);
}

#[test]
fn t01_reentrant_cancelmode_after_threshold_ends_once_cancelled() {
    cancel_after_threshold_ends_once(CANCELMODE);
}

#[test]
fn t01_reentrant_deactivate_after_threshold_ends_once_cancelled() {
    cancel_after_threshold_ends_once(DEACTIVATE);
}

#[test]
fn t01_reentrant_capture_lost_after_threshold_ends_once_cancelled() {
    cancel_after_threshold_ends_once(CAPTURE_LOST);
}

// ============================================================================
// テスト 3: 取り消しの終了の知らせを配った後、ドラッグ中の印が外れている(要件 2.5)
// ============================================================================

fn cancel_after_threshold_clears_drag_markers(kind: Cancel) {
    let rig = Rig::new();
    rig.start_drag();
    assert!(
        rig.target_has::<DraggingState>() && rig.target_has::<WindowDragging>(),
        "開始を配った後はドラッグ中の印が付いている"
    );

    rig.send_while_borrowed(kind.msg, kind.wparam, 0);
    rig.dispatch_ends();

    assert!(
        !rig.target_has::<DraggingState>(),
        "{}: 配った後 DraggingState が外れている",
        kind.what
    );
    assert!(
        !rig.target_has::<WindowDragging>(),
        "{}: 配った後 WindowDragging が外れている",
        kind.what
    );
}

#[test]
fn t03_reentrant_esc_clears_drag_markers() {
    cancel_after_threshold_clears_drag_markers(ESC);
}

#[test]
fn t03_reentrant_cancelmode_clears_drag_markers() {
    cancel_after_threshold_clears_drag_markers(CANCELMODE);
}

#[test]
fn t03_reentrant_deactivate_clears_drag_markers() {
    cancel_after_threshold_clears_drag_markers(DEACTIVATE);
}

#[test]
fn t03_reentrant_capture_lost_clears_drag_markers() {
    cancel_after_threshold_clears_drag_markers(CAPTURE_LOST);
}

// ============================================================================
// テスト 4: 閾値前の取り消し 4 種で、状態が休み、終了の知らせ 0 件(要件 3.2)
// ============================================================================

fn cancel_before_threshold_rests_without_end(kind: Cancel) {
    let rig = Rig::new();
    rig.press();

    rig.send_while_borrowed(kind.msg, kind.wparam, 0);
    assert!(
        rests_cancelled(),
        "{}: 閾値前でも再入の取り消しで状態は休む: {:?}",
        kind.what,
        snapshot_drag_state()
    );

    let ends = rig.dispatch_ends();
    assert_eq!(
        ends.len(),
        0,
        "{}: 閾値前の取り消しで終了の知らせは 0 件: {ends:?}",
        kind.what
    );
}

#[test]
fn t04_reentrant_esc_before_threshold_rests_without_end() {
    cancel_before_threshold_rests_without_end(ESC);
}

#[test]
fn t04_reentrant_cancelmode_before_threshold_rests_without_end() {
    cancel_before_threshold_rests_without_end(CANCELMODE);
}

#[test]
fn t04_reentrant_deactivate_before_threshold_rests_without_end() {
    cancel_before_threshold_rests_without_end(DEACTIVATE);
}

#[test]
fn t04_reentrant_capture_lost_before_threshold_rests_without_end() {
    cancel_before_threshold_rests_without_end(CAPTURE_LOST);
}

// ============================================================================
// テスト 7: 再入の終了の知らせは、借用を返した後の 1 回目の配る段で 1 件・2 回目は 0 件。
// 借用なしで渡した場合も同じ 1 回目。再入の扱いの後、起床の旗が立つ(要件 2.4・8.3)
// ============================================================================

/// 閾値を越えたドラッグへ取り消しを渡し、配る段 2 回の件数を返す。
fn ends_per_dispatch(borrowed: bool) -> (usize, usize) {
    let rig = Rig::new();
    rig.start_drag();
    if borrowed {
        rig.send_while_borrowed(CANCELMODE.msg, CANCELMODE.wparam, 0);
    } else {
        rig.send(CANCELMODE.msg, CANCELMODE.wparam, 0);
    }
    (rig.dispatch_ends().len(), rig.dispatch_ends().len())
}

#[test]
fn t07_reentrant_end_is_dispatched_on_the_first_dispatch_like_the_ordinary_path() {
    let _lock = crate::ecs::world::TICK_WAKE_TEST_LOCK
        .lock()
        .unwrap_or_else(|p| p.into_inner());

    // 比べる相手: 借用なしで渡した場合は 1 回目で 1 件、2 回目は 0 件。
    assert_eq!(ends_per_dispatch(false), (1, 0), "借用なしの道");

    // 再入: 旗を掃いてから渡し、扱いの後に旗が立っていることを見る。
    let rig = Rig::new();
    rig.start_drag();
    let _ = tick_wake::take(Instant::now());
    rig.send_while_borrowed(CANCELMODE.msg, CANCELMODE.wparam, 0);
    let woke = tick_wake::take(Instant::now());

    let first = rig.dispatch_ends().len();
    let second = rig.dispatch_ends().len();
    assert_eq!(
        (first, second),
        (1, 0),
        "再入の終了の知らせは借用を返した後の 1 回目の配る段で 1 件・2 回目は 0 件"
    );
    let expected = tick_wake::wake_bits_for_message(CANCELMODE.msg);
    assert!(
        woke.bits & expected.bits() == expected.bits(),
        "再入の扱いの後、配送表の入口と同じ起床の旗が立っている: {:?}",
        woke.bits
    );
}

// ============================================================================
// テスト 7b: 本番の並び。本物の try_tick_world を 2 回回し、1 回目の途中(UISetup)から
// 非活性化を入口へ渡す(要件 2.4・2.5・8.3)
// ============================================================================

thread_local! {
    /// UISetup のテスト用システムが呼ぶ入口(組み立てごと預ける)。
    static STASHED: RefCell<Option<Rc<Rig>>> = const { RefCell::new(None) };
    /// 真のときだけ、次の UISetup で非活性化を 1 回渡す。
    static ARMED: Cell<bool> = const { Cell::new(false) };
    /// テスト用システムが実際に非活性化を渡した回数(空振りの見逃しを防ぐ)。
    static FIRED: Cell<u32> = const { Cell::new(0) };
}

/// UISetup(メインスレッド固定)に置くテスト用システム。画面更新の途中で入口を呼ぶ。
fn deactivate_through_the_entrance_mid_tick() {
    if !ARMED.with(|a| a.replace(false)) {
        return;
    }
    // 預け先の借用は複製を取る間だけ(入口を呼ぶ間は握らない)。
    let rig = STASHED.with(|s| s.borrow().clone());
    if let Some(rig) = rig {
        rig.send(DEACTIVATE.msg, DEACTIVATE.wparam, 0);
        FIRED.with(|f| f.set(f.get() + 1));
    }
}

/// 本番と同じく World を可変で借りたまま 1 回の画面更新を回し、届いた終了の知らせを読む。
fn tick(rig: &Rig) -> Vec<DragEndEvent> {
    let mut w = rig.world.borrow_mut();
    assert!(w.try_tick_world(), "画面更新が回る");
    w.world_mut()
        .resource_mut::<Messages<DragEndEvent>>()
        .drain()
        .collect()
}

/// テスト用システムを UISetup へ置いた組み立てを作り、ドラッグ中にして預ける。
fn stashed_dragging_rig() -> Rc<Rig> {
    let rig = Rc::new(Rig::new());
    rig.world
        .borrow_mut()
        .add_systems(UISetup, deactivate_through_the_entrance_mid_tick);
    rig.start_drag();
    STASHED.with(|s| *s.borrow_mut() = Some(rig.clone()));
    FIRED.with(|f| f.set(0));
    rig
}

#[test]
fn t07b_deactivate_inside_a_real_tick_ends_on_the_next_tick() {
    let _lock = crate::ecs::world::TICK_WAKE_TEST_LOCK
        .lock()
        .unwrap_or_else(|p| p.into_inner());

    // 比べる相手: 同じ非活性化を 1 回目と 2 回目の間に借用なしで渡すと、2 回目で 1 件。
    {
        let rig = stashed_dragging_rig();
        assert_eq!(tick(&rig).len(), 0, "借用なしの道: 1 回目は何も起きない");
        rig.send(DEACTIVATE.msg, DEACTIVATE.wparam, 0);
        assert_eq!(tick(&rig).len(), 1, "借用なしの道: 2 回目で 1 件");
        STASHED.with(|s| *s.borrow_mut() = None);
    }

    let rig = stashed_dragging_rig();
    let _ = tick_wake::take(Instant::now());
    ARMED.with(|a| a.set(true));

    // 1 回目: 途中の UISetup から非活性化が入口へ届く(World は借用中=再入)。
    let first = tick(&rig);
    assert_eq!(
        FIRED.with(|f| f.get()),
        1,
        "テスト用システムが 1 回目の途中で入口を呼んだ"
    );
    let woke = tick_wake::take(Instant::now());
    assert_eq!(
        first.len(),
        0,
        "1 回目の終わりでは終了の知らせ 0 件: {first:?}"
    );
    assert!(
        rests_cancelled(),
        "1 回目の終わりで状態は取り消しの印つきで休んでいる: {:?}",
        snapshot_drag_state()
    );
    let expected = tick_wake::wake_bits_for_message(DEACTIVATE.msg);
    assert!(
        woke.bits & expected.bits() == expected.bits(),
        "1 回目の終わりで再入の扱いの起床の旗が立っている: {:?}",
        woke.bits
    );

    // 2 回目: 終了の知らせ 1 件・ドラッグ中の印が外れる。
    let second = tick(&rig);
    assert_eq!(second.len(), 1, "2 回目で終了の知らせ 1 件: {second:?}");
    assert!(second[0].cancelled, "取り消しの印つき");
    assert_eq!(second[0].target, rig.target, "対象");
    assert!(
        !rig.target_has::<DraggingState>(),
        "2 回目の後 DraggingState が外れている"
    );
    assert!(
        !rig.target_has::<WindowDragging>(),
        "2 回目の後 WindowDragging が外れている"
    );

    STASHED.with(|s| *s.borrow_mut() = None);
}

// ============================================================================
// テスト 8: 5 種でないメッセージは、借用中は状態も累積器も変えず None・
// `drag_reentry_handled` の記録 0 件(要件 1.4・6.3)
// ============================================================================

/// 5 種に入らないメッセージ(押す・動かす・ESC でないキー・活性化)。
const NOT_DRAG_MESSAGES: [(&str, u32, usize); 4] = [
    ("WM_MOUSEMOVE", WM_MOUSEMOVE, 0),
    ("WM_LBUTTONDOWN", WM_LBUTTONDOWN, 0),
    ("ESC でない WM_KEYDOWN(A)", WM_KEYDOWN, 0x41),
    ("活性化の WM_ACTIVATE(WA_ACTIVE)", WM_ACTIVATE, 1),
];

/// 今の状態のまま 5 種でないメッセージを借用中に渡し、何も変わらないことを確かめる。
fn not_drag_messages_change_nothing(rig: &Rig, phase: &str) {
    let acc = rig.accumulator();
    // 前に積まれた分を掃き、以後に積まれたものだけを見る。
    let before_flush = acc.flush().expect("累積器の錠は毒化していない");
    let before_state = format!("{:?}", snapshot_drag_state());

    let ((), events) = log_capture_kit::capture(|| {
        for (what, msg, wparam) in NOT_DRAG_MESSAGES {
            // 閾値を越える位置を渡す(閾値と比べたなら開始してしまう形)。
            let ret = rig.send_while_borrowed(msg, wparam, client_lparam(MOVED));
            assert!(ret.is_none(), "{phase}: {what} は借用中は None");
        }
    });

    assert_eq!(
        format!("{:?}", snapshot_drag_state()),
        before_state,
        "{phase}: 5 種でないメッセージは状態を変えない"
    );
    let after = acc.flush().expect("累積器の錠は毒化していない");
    assert!(
        after.transitions.is_empty(),
        "{phase}: 遷移は積まれない: {:?}",
        after.transitions
    );
    assert_eq!(
        after.delta,
        PhysicalPoint::new(0, 0),
        "{phase}: 動きは積まれない"
    );
    assert_eq!(
        after.current_dragging_entity, before_flush.current_dragging_entity,
        "{phase}: ドラッグ中の対象は変わらない"
    );
    assert_eq!(
        after.current_position, before_flush.current_position,
        "{phase}: 位置は変わらない"
    );
    let handled = events
        .iter()
        .filter(|e| e.field_str("event") == Some("drag_reentry_handled"))
        .count();
    assert_eq!(handled, 0, "{phase}: drag_reentry_handled の記録は 0 件");
}

#[test]
fn t08_non_drag_messages_while_borrowed_change_nothing() {
    // 準備中(閾値と比べる前)。
    let rig = Rig::new();
    rig.press();
    not_drag_messages_change_nothing(&rig, "準備中");

    // ドラッグ中(動きを積む状態)。
    let rig = Rig::new();
    rig.start_drag();
    not_drag_messages_change_nothing(&rig, "ドラッグ中");
}

// ============================================================================
// テスト 13: 再入の扱いは None を返し、非活性化でも沈降の観測の目印が付かない。
// 借用は握られたまま。画面更新の回数は増えない(要件 1.2・1.3)
// ============================================================================

#[test]
fn t13_reentrant_handling_returns_none_keeps_the_borrow_and_skips_side_work() {
    let release = Cancel {
        what: "左ボタンを離す(WM_LBUTTONUP)",
        msg: WM_LBUTTONUP,
        wparam: 0,
    };
    for kind in CANCELS.into_iter().chain([release]) {
        let rig = Rig::new();
        // 対象の窓をペアの相手に持つ宣言側(非活性化の目印はここへ付く)。
        let balloon = rig
            .world
            .borrow_mut()
            .world_mut()
            .spawn(KeepDirectlyAbove { peer: rig.target })
            .id();
        rig.start_drag();
        let frames = rig.world.borrow().world().resource::<FrameCount>().0;

        {
            let _held = rig.world.borrow_mut();
            let ret = rig.send(kind.msg, kind.wparam, client_lparam(MOVED));
            assert!(ret.is_none(), "{}: 再入の扱いは None を返す", kind.what);
            assert!(
                rig.world.try_borrow().is_err(),
                "{}: 扱いの後も借用は握られたまま(横取りしない)",
                kind.what
            );
        }

        let w = rig.world.borrow();
        assert_eq!(
            w.world().resource::<FrameCount>().0,
            frames,
            "{}: 画面更新の回数は増えない",
            kind.what
        );
        assert!(
            !w.world()
                .entity(balloon)
                .contains::<SinkObservationPending>(),
            "{}: 再入では沈降の観測の目印が付かない",
            kind.what
        );
    }

    // 対照: 借用なしの非活性化では目印が付く(付かない側の主張が恒真でない)。
    let rig = Rig::new();
    let balloon = rig
        .world
        .borrow_mut()
        .world_mut()
        .spawn(KeepDirectlyAbove { peer: rig.target })
        .id();
    rig.send(DEACTIVATE.msg, DEACTIVATE.wparam, 0);
    assert!(
        rig.world
            .borrow()
            .world()
            .entity(balloon)
            .contains::<SinkObservationPending>(),
        "借用なしの非活性化では目印が付く"
    );
}