light-fw-core 0.17.2

Ядро Light: виртуальный DOM, реактивность, раскладка, отрисовка и окно
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
//! Опциональная поддержка асинхронного обновления UI (фича `async-runtime`).
//!
//! Тип [`UserEvent`] является единым типом пользовательских событий цикла
//! событий окна: помимо [`UserEvent::UpdateUI`] (закрытие, выполняемое
//! в UI-потоке с последующей перерисовкой всех открытых окон), он несёт
//! [`UserEvent::Command`] и (при фиче `a11y-winit`) [`UserEvent::Access`],
//! которыми обменивается [`crate::window`].
//!
//! [`spawn`] запускает заданное замыкание в отдельном потоке, [`post_to_ui`]
//! возвращает замыкание в цикл событий UI-потока, где оно выполняется,
//! и после выполнения на всех окнах запрашивается перерисовка.
//!
//! Прокси устанавливается один раз в [`crate::window::run`] через
//! [`install_proxy`] и живёт в статике [`UI_PROXY`].
//!
//! ```rust
//! # #[cfg(feature = "window")]
//! # fn example() {
//! use light_fw_core::async_runtime::{post_to_ui, spawn};
//!
//! spawn(|ctx| {
//!     std::thread::sleep(std::time::Duration::from_secs(1));
//!     if !ctx.is_cancelled() {
//!         post_to_ui(|| { /* обновить состояние UI */ }).ok();
//!     }
//! });
//! # }
//! ```

use std::any::{Any, TypeId};
#[cfg(feature = "async-await")]
use std::future::Future;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, OnceLock};
use std::thread::{JoinHandle, Result as ThreadResult};

use thiserror::Error;
use winit::event_loop::EventLoopProxy;
use winit::window::WindowId;

#[cfg(feature = "devtools")]
use crate::devtools::DevToolsCommand;
use crate::{WindowCommand, component::Component, control::WindowToken};
#[cfg(feature = "a11y-winit")]
use accesskit_winit;

/// Типизированное действие над состоянием компонента в UI-потоке.
///
/// Принимает `&mut dyn Any` и делает downcast к целевому типу сам;
/// тип проверяется внутри [`post_update`], а не в [`UserEvent::Action`].
pub type UpdateFn = Box<dyn FnOnce(&mut dyn Any) + Send + 'static>;

/// События цикла событий окна.
///
/// Единственный тип пользовательских событий, который использует
/// [`crate::window`]: [`UserEvent::Command`] адресует команду конкретному
/// окну по [`WindowToken`], [`UserEvent::Access`] — событие
/// assistive-technology-клиента (только при фиче `a11y-winit`), а
/// [`UserEvent::UpdateUI`] — замыкание, выполняемое в UI-потоке с
/// последующей перерисовкой всех открытых окон.
pub enum UserEvent {
    /// Команда управления окном, адресованная по [`WindowToken`].
    Command {
        /// Токен окна-получателя.
        token: WindowToken,
        /// Команда, которую нужно применить к окну.
        command: WindowCommand,
    },
    /// Событие assistive-technology-клиента (только при фиче `a11y-winit`).
    #[cfg(feature = "a11y-winit")]
    Access(accesskit_winit::Event),
    /// Замыкание, поставленное в очередь через [`post_to_ui`].
    UpdateUI(Box<dyn FnOnce() + Send + 'static>),
    /// Команда инспектора DevTools (клик по элементу, изменение состояния).
    /// Применяется в UI-потоке к активному окну; результат клика возвращается
    /// по каналу внутри [`DevToolsCommand`] TCP-серверу.
    #[cfg(feature = "devtools")]
    DevTools(DevToolsCommand),
    /// Типизированное обновление компонента через [`post_update`]
    /// или [`post_update_to`].
    ///
    /// `f` — замыкание, которое выполняется в UI-потоке над
    /// `&mut dyn Any` и делает downcast к целевому типу `C` сам.
    ///
    /// Поле `target` хранит `TypeId` компонента, на который выполняется
    /// downcast в UI-потоке. Поле `token` задаёт точную адресацию окна:
    /// `None` — первое совпадение по `TypeId` (поведение [`post_update`]),
    /// `Some(t)` — только окно с этим токеном (поведение [`post_update_to`]);
    /// если целевое окно закрыто, действие отбрасывается с лог-сообщением.
    Action {
        /// Замыкание для обновления состояния компонента.
        f: UpdateFn,
        /// `TypeId` целевого типа компонента (задаётся в [`post_update`]).
        target: std::any::TypeId,
        /// Токен окна-цели для точной адресации (см. описание выше).
        token: Option<WindowToken>,
    },
    /// ТЗ 0.14.3-fix9: отложенный minimize — спавним окно видимым,
    /// чтобы первый frame отрисовался (taskbar-thumbnail), затем сворачиваем.
    DeferredMinimize {
        /// Идентификатор окна, которое нужно минимизировать.
        window_id: WindowId,
    },
}

impl std::fmt::Debug for UserEvent {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Command { token, command } => f
                .debug_struct("Command")
                .field("token", token)
                .field("command", command)
                .finish(),
            #[cfg(feature = "a11y-winit")]
            Self::Access(event) => f.debug_tuple("Access").field(event).finish(),
            Self::UpdateUI(_) => f.debug_struct("UpdateUI").field("f", &"<closure>").finish(),
            #[cfg(feature = "devtools")]
            Self::DevTools(cmd) => f.debug_tuple("DevTools").field(cmd).finish(),
            Self::Action {
                f: _,
                target,
                token,
            } => f
                .debug_struct("Action")
                .field("f", &"<closure>")
                .field("target", target)
                .field("token", token)
                .finish(),
            Self::DeferredMinimize { window_id } => f
                .debug_struct("DeferredMinimize")
                .field("window_id", window_id)
                .finish(),
        }
    }
}

#[cfg(feature = "a11y-winit")]
impl From<accesskit_winit::Event> for UserEvent {
    fn from(event: accesskit_winit::Event) -> Self {
        Self::Access(event)
    }
}

/// Ошибка асинхронного обновления UI.
#[derive(Debug, Error)]
pub enum TaskError {
    /// UI-цикл ещё не запущен (`install_proxy` не был вызван).
    #[error("the event loop is not running")]
    NotRunning,

    /// UI-цикл уже завершён или прокси был удалён, событие не доставить.
    #[error("the event loop is closed")]
    Closed,

    /// Прокси уже установлен — `install_proxy` вызывается только один раз.
    #[error("the event loop proxy is already installed")]
    AlreadyInstalled,
}

/// Контекст, переданный замыканию [`spawn`] при запуске.
///
/// Позволяет задаче видеть запрос отмены: поток сам решает, где прерваться.
#[derive(Debug, Clone)]
pub struct TaskContext {
    cancel_flag: Arc<AtomicBool>,
}

impl TaskContext {
    /// Возвращает `true`, если на ручку [`TaskHandle::abort`] было вызвано
    /// (или планируется) отмена.
    pub fn is_cancelled(&self) -> bool {
        self.cancel_flag.load(Ordering::SeqCst)
    }
}

/// Ручка на поток, запущенный через [`spawn`].
///
/// Храни, если нужно дождаться завершения; просто сбрось, если задача
/// должна работать независимо от вызывающего кода.
#[must_use]
pub struct TaskHandle {
    inner: JoinHandle<()>,
    cancel_flag: Arc<AtomicBool>,
}

impl TaskHandle {
    /// Просит задачу остановиться: выставляет флаг, который задача читает
    /// через [`TaskContext::is_cancelled`]. Отмена кооперативная — поток
    /// сам решает, где прерваться.
    pub fn abort(&self) {
        self.cancel_flag.store(true, Ordering::SeqCst);
    }

    /// Ждёт завершения потока.
    ///
    /// Завёрнутый в поток замыкание не возвращает значений, поэтому
    /// результат — [`std::thread::Result`], который `Ok(())` при нормальном
    /// завершении и `Err` с паник-пейлоадем при падении.
    pub fn join(self) -> ThreadResult<()> {
        self.inner.join()
    }

    /// Возвращает флаг отмены, которым делится запущенный поток.
    ///
    /// Позволяет хранить сигнал отмены отдельно от ручки (например, в
    /// состоянии UI, где сама ручка с её [`JoinHandle`] не помещается),
    /// сохраняя возможность запросить отмену в любой момент.
    pub fn cancel_flag(&self) -> Arc<AtomicBool> {
        self.cancel_flag.clone()
    }
}

/// Прокси UI-цикла, установленный один раз в [`crate::window::run`].
pub(crate) static UI_PROXY: OnceLock<EventLoopProxy<UserEvent>> = OnceLock::new();

/// Устанавливает прокси UI-цикла (однократно).
///
/// Вызывается в [`crate::window::run`] сразу после создания `EventLoop`.
/// Повторный вызов возвращает [`TaskError::AlreadyInstalled`].
pub(crate) fn install_proxy(proxy: EventLoopProxy<UserEvent>) -> Result<(), TaskError> {
    UI_PROXY.set(proxy).map_err(|_| TaskError::AlreadyInstalled)
}

/// Запускает замыкание в отдельном потоке.
///
/// Замыкание получает [`TaskContext`], через который замечает запрос отмены
/// (кооперативно — поток сам решает, где прерваться). Поток живёт
/// независимо от вызывающего кода: [`TaskHandle`] можно отбросить, и задача
/// продолжит выполнение.
pub fn spawn<F>(f: F) -> TaskHandle
where
    F: FnOnce(TaskContext) + Send + 'static,
{
    let cancel_flag = Arc::new(AtomicBool::new(false));
    let ctx = TaskContext {
        cancel_flag: cancel_flag.clone(),
    };
    let inner = std::thread::Builder::new()
        .name("light-async".into())
        .spawn(move || f(ctx))
        .expect("thread spawn should not fail");
    TaskHandle { inner, cancel_flag }
}

/// Запускает асинхронный замыкание в отдельном потоке ОС, блокируя его
/// до завершения через [`futures::executor::block_on`].
///
/// Замыкание принимает [`TaskContext`] и возвращает `Future`, что даёт
/// доступ к кооперативному флагу отмены внутри асинхронного кода — ровно
/// как в [`spawn`], но для `async`-фьюч. Возвращает [`TaskHandle`].
///
/// Важно: [`futures::executor::block_on`] не поддерживает принудительную
/// отмену извне — если фьюча висит на I/O, [`TaskHandle::abort`] её не
/// прервёт. Отмена проверяется вручную через `ctx.is_cancelled()`.
/// Это ожидаемое поведение для 0.12.0.
///
/// # Пример
///
/// ```rust
/// # #[cfg(feature = "async-await")]
/// # fn example() {
/// use light_fw_core::async_runtime::spawn_async;
///
/// spawn_async(|ctx| async move {
///     // асинхронная работа с доступом к флагу отмены
///     if ctx.is_cancelled() { return; }
///     # std::future::ready(()).await;
/// });
/// # }
/// ```
#[cfg(feature = "async-await")]
pub fn spawn_async<F, Fut>(f: F) -> TaskHandle
where
    F: FnOnce(TaskContext) -> Fut + Send + 'static,
    Fut: Future<Output = ()> + Send + 'static,
{
    let cancel_flag = Arc::new(AtomicBool::new(false));
    let ctx = TaskContext {
        cancel_flag: cancel_flag.clone(),
    };

    let inner = std::thread::Builder::new()
        .name("light-async-await".into())
        .spawn(move || {
            futures::executor::block_on(f(ctx));
        })
        .expect("thread spawn should not fail");
    TaskHandle { inner, cancel_flag }
}

/// Ставит замыкание в очередь UI-цикла.
///
/// Замыкание выполнится в UI-потоке, после выполнения на всех открытых
/// окнах запрашивается перерисовка.
///
/// # Ошибки
///
/// * [`TaskError::NotRunning`] — если `install_proxy` ещё не был вызван
///   (UI-цикл не запущен).
/// * [`TaskError::Closed`] — если UI-цикл уже завершён.
pub fn post_to_ui<F>(f: F) -> Result<(), TaskError>
where
    F: FnOnce() + Send + 'static,
{
    let proxy = match UI_PROXY.get() {
        Some(proxy) => proxy,
        None => return Err(TaskError::NotRunning),
    };
    proxy
        .send_event(UserEvent::UpdateUI(Box::new(f)))
        .map_err(|_| TaskError::Closed)
}

/// Ставит типизированное обновление компонента в очередь UI-цикла.
///
/// Замыкание выполнится в UI-потоке, где компонент будет обновлён,
/// и на всех открытых окнах запрашивается перерисовка.
///
/// В отличие от [`post_to_ui`], замыкание получает ссылку на конкретный
/// тип компонента, что позволяет обновлять `!Send`-состояние компонента,
/// не нарушая границы `Send` при пересылке в UI-поток.
///
/// # Ошибки
///
/// * [`TaskError::NotRunning`] — если `install_proxy` ещё не был вызван
///   (UI-цикл не запущен).
/// * [`TaskError::Closed`] — если UI-цикл уже завершён.
pub fn post_update<C: Component + 'static>(
    f: impl FnOnce(&mut C) + Send + 'static,
) -> Result<(), TaskError> {
    post_update_impl(None, f)
}

/// Общий путь для [`post_update`] и [`post_update_to`]: упаковывает
/// замыкание в [`UserEvent::Action`] и отправляет его в очередь UI-цикла.
///
/// * `token == None` — адресация по `TypeId` (первое окно с компонентом `C`);
/// * `token == Some(t)` — адресация к окну с токеном `t`.
fn post_update_impl<C: Component + 'static>(
    token: Option<WindowToken>,
    f: impl FnOnce(&mut C) + Send + 'static,
) -> Result<(), TaskError> {
    let proxy = match UI_PROXY.get() {
        Some(proxy) => proxy,
        None => return Err(TaskError::NotRunning),
    };
    let action = UserEvent::Action {
        f: Box::new(move |any: &mut dyn Any| {
            if let Some(component) = any.downcast_mut::<C>() {
                f(component);
            }
        }),
        target: std::any::TypeId::of::<C>(),
        token,
    };
    proxy.send_event(action).map_err(|_| TaskError::Closed)
}

/// Применяет действие [`UserEvent::Action`] к одному из открытых окон.
///
/// Логика доставки, вынесенная из обработчика событий окна
/// ([`crate::window::App::user_event`]) в отдельную функцию, чтобы её можно
/// было проверить без запуска цикла событий winit. Окна передаются
/// итератором пар `(токен, компонент)` — именно эти два поля использует
/// доставка; остальное состояние окна (поверхность, раскладка) тут не
/// трогается.
///
/// * `token = Some(t)` — точная адресация: действие применяется только к
///   окну с токеном `t`; если такого окна нет (в том числе уже закрыто),
///   возвращается `None`, и действие отбрасывается;
/// * `token = None` — действие применяется к первому окну, чей компонент
///   имеет `TypeId` `target`; если таких окон нет, возвращается `None`.
///
/// Возвращает `Some(токен)` того окна, к которому действие было применено —
/// обработчик использует его для `request_redraw()` целевого окна. Перерисовка
/// не запрашивается внутри функции, что устраняет конфликт заёмов между
/// итератором компонентов и доступом к `Arc<Window>`.
/// Публичный API для тестирования логики доставки [`UserEvent::Action`]
/// без запуска цикла событий winit. См. внутреннюю документацию выше.
#[cfg(feature = "async-runtime")]
pub fn apply_action<'a>(
    windows: impl Iterator<Item = (WindowToken, TypeId, &'a mut dyn Component)>,
    token: Option<WindowToken>,
    target: TypeId,
    f: UpdateFn,
) -> Option<WindowToken> {
    // Для точной адресации (Some(token)) ищем по токену — TypeId не нужен.
    // Для broadcast (None) ищем по TypeId; он передаётся вместе с парой,
    // чтобы не вызывать as_any_mut() дважды (одна mutable borrow не может
    // служить и для type_id(), и для f).
    for (window_token, type_id, component) in windows {
        let matched = match token {
            Some(t) => window_token == t,
            None => type_id == target,
        };
        if matched {
            f(component.as_any_mut());
            return Some(window_token);
        }
    }
    None
}

/// Ставит типизированное обновление компонента в очередь UI-цикла
/// с адресацией к конкретному окну по его [`WindowToken`].
///
/// Замыкание выполнится в UI-потоке и применится **только** к окну,
/// чей токен совпадает с `token`. Если окно с этим токеном уже закрыто,
/// обновление тихо отбрасывается (в UI-потоке логируется
/// `async-runtime: target window closed`).
///
/// Токен окна получается через [`crate::control::current_window_token`]
/// (из UI-потока, например из `on_click`) или хранится в состоянии
/// компонента (поле типа `WindowToken` в `#[proxy]`-структуре).
///
/// # Ошибки
///
/// * [`TaskError::NotRunning`] — если `install_proxy` ещё не был вызван
///   (UI-цикл не запущен).
/// * [`TaskError::Closed`] — если UI-цикл уже завершён.
pub fn post_update_to<C: Component + 'static>(
    token: WindowToken,
    f: impl FnOnce(&mut C) + Send + 'static,
) -> Result<(), TaskError> {
    post_update_impl(Some(token), f)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::atomic::{AtomicBool, Ordering};
    use std::time::Duration;

    #[test]
    fn post_to_ui_without_install_errors() {
        let result = post_to_ui(|| {});
        match result {
            Err(TaskError::NotRunning) => {}
            other => panic!("expected NotRunning, got {other:?}"),
        }
    }

    #[test]
    fn spawn_runs_closure() {
        static RAN: AtomicBool = AtomicBool::new(false);
        let handle = spawn(|_ctx| RAN.store(true, Ordering::SeqCst));
        handle.join().expect("spawned thread must not panic");
        assert!(RAN.load(Ordering::SeqCst), "closure should have run");
    }

    #[test]
    fn spawn_returns_joinable_handle() {
        let handle = spawn(|_ctx| {});
        handle.join().expect("empty closure must not panic");
    }

    #[test]
    fn abort_stops_task() {
        static CANCELLED: AtomicBool = AtomicBool::new(false);
        let handle = spawn(|ctx| {
            while !ctx.is_cancelled() {
                std::thread::sleep(Duration::from_millis(1));
            }
            CANCELLED.store(true, Ordering::SeqCst);
        });
        handle.abort();
        handle.join().expect("aborted thread must finish");
        assert!(
            CANCELLED.load(Ordering::SeqCst),
            "task should observe cancellation"
        );
    }

    #[test]
    fn post_update_without_install_errors() {
        struct S;
        impl crate::Component for S {
            fn as_any_mut(&mut self) -> &mut dyn std::any::Any {
                self
            }
            fn render(&self) -> crate::VElement {
                crate::VElement::leaf(
                    "",
                    crate::NodeKind::Text {
                        content: "noop".into(),
                    },
                )
            }
        }
        let result = post_update::<S>(|_| {});
        match result {
            Err(TaskError::NotRunning) => {}
            other => panic!("expected NotRunning, got {other:?}"),
        }
    }

    /// Тест 4.2: Debug-представление `Action` содержит `"Action"`
    /// и `"target"` (TypeId не паникует при форматировании).
    #[test]
    fn action_debug_contains_action_and_target() {
        let action = UserEvent::Action {
            f: Box::new(|_any: &mut dyn Any| {}),
            target: std::any::TypeId::of::<u8>(),
            token: None,
        };
        let s = format!("{action:?}");
        assert!(s.contains("Action"), "Debug must name the variant: {s}");
        assert!(
            s.contains("target"),
            "Debug must include the `target` field: {s}"
        );
        assert!(
            s.contains("<closure>"),
            "Debug must render the closure placeholder: {s}"
        );
    }

    #[test]
    fn task_error_enum_unchanged() {
        // TaskError должен сохранять исходный набор вариантов:
        // NotRunning, Closed, AlreadyInstalled.
        let not_running = TaskError::NotRunning;
        let closed = TaskError::Closed;
        let already = TaskError::AlreadyInstalled;

        assert_eq!(not_running.to_string(), "the event loop is not running");
        assert_eq!(closed.to_string(), "the event loop is closed");
        assert_eq!(
            already.to_string(),
            "the event loop proxy is already installed"
        );
    }
}