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
//! Компонент: виртуальное дерево интерфейса, обработка событий и описание
//! системного окна.

use std::any::Any;

use crate::vdom::{Event, VElement};

/// Фон окна по умолчанию (`#F7F8FA`, полностью непрозрачный).
pub const DEFAULT_BACKGROUND: u32 = 0xF7_F8_FA_FF;

/// Разбирает цвет `0xRRGGBBAA` на компоненты `(r, g, b, a)`.
pub const fn background_rgba(color: u32) -> (u8, u8, u8, u8) {
    (
        (color >> 24) as u8,
        (color >> 16) as u8,
        (color >> 8) as u8,
        color as u8,
    )
}

/// Настройки системного окна — из корневого элемента `<window>` шаблона.
///
/// Окно создаётся **без системной рамки** (`borderless`): заголовок и кнопки
/// управления задаются элементами интерфейса (`<titlebar>`, `<button>`).
/// Если шаблон не содержит `<window>`, [`Component::window_config`] возвращает
/// `None` и окно не создаётся.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WindowConfig {
    /// Заголовок окна для панели задач. Обычно переопределяется текстом
    /// элемента `<titlebar>`.
    pub title: String,
    /// Ширина окна в логических пикселях.
    pub width: u32,
    /// Высота окна в логических пикселях.
    pub height: u32,
    /// Цвет фона клиентской области в формате `0xRRGGBBAA` (альфа включена).
    pub background: u32,
    /// Можно ли менять размер окна.
    pub resizable: bool,
    /// Поддерживает ли окно прозрачность (композиция с рабочим столом).
    pub transparent: bool,
    /// Минимальная ширина окна (`min-width`), в логических пикселях.
    pub min_width: Option<u32>,
    /// Минимальная высота окна (`min-height`), в логических пикселях.
    pub min_height: Option<u32>,
    /// Максимальная ширина окна (`max-width`), в логических пикселях.
    pub max_width: Option<u32>,
    /// Максимальная высота окна (`max-height`), в логических пикселях.
    pub max_height: Option<u32>,
    /// Открывается ли окно как модальное (блокирует родительское окно).
    pub modal: bool,
    /// Видимо ли окно при создании (`visible`), по умолчанию `true`.
    pub visible: bool,
    /// Уникальный идентификатор окна из атрибута `<window id="...">`.
    ///
    /// Служит ключом для команд [`crate::control::WindowCommand::Open`],
    /// [`crate::control::WindowCommand::CloseWindow`],
    /// [`crate::control::WindowCommand::ShowWindow`] и
    /// [`crate::control::WindowCommand::HideWindow`].
    pub id: Option<String>,
    /// Идентификатор родительского окна из атрибута `<window parent="...">`.
    ///
    /// Дочернее окно закрывается вместе с родителем, а модальный потомок
    /// блокирует ввод родителю.
    pub parent: Option<String>,
    /// PNG-содержимое иконки окна из атрибута `<window icon="...">`.
    ///
    /// Файл встраивается в бинарник на этапе компиляции. Если иконка не
    /// задана, используется встроенная иконка Light.
    pub icon: Option<&'static [u8]>,
}

impl WindowConfig {
    /// Компоненты фона `(r, g, b, a)`.
    pub const fn background_rgba(&self) -> (u8, u8, u8, u8) {
        background_rgba(self.background)
    }
}

impl Default for WindowConfig {
    fn default() -> Self {
        Self {
            title: String::from("Light"),
            width: 640,
            height: 480,
            background: DEFAULT_BACKGROUND,
            resizable: true,
            transparent: false,
            min_width: None,
            min_height: None,
            max_width: None,
            max_height: None,
            modal: false,
            visible: true,
            id: None,
            parent: None,
            icon: None,
        }
    }
}

/// UI-компонент: структура, описывающая свойства и интерфейс.
///
/// Реализация обычно генерируется атрибутом
/// `#[template("...")]` из HTML-шаблона — шаблон полностью замещает
/// форму компонента: [`Component::render`] возвращает именно дерево из
/// шаблона, без какого-либо стандартного оформления сверх него.
pub trait Component: Any {
    /// Строит виртуальное дерево интерфейса компонента.
    fn render(&self) -> VElement;

    /// Обрабатывает событие `event`, адресованное узлу `key`.
    ///
    /// Возвращает `true`, если событие было обработано (тогда оконный бэкенд
    /// прекращает всплытие к родительским узлам). Реализация генерируется
    /// макросом `#[template]` из директив `@click`, `@mousedown`, `@keydown`,
    /// `v-model` и т. п.
    fn dispatch(&self, key: &str, event: Event) -> bool {
        let _ = (key, event);
        false
    }

    /// Читает значение поля по имени для шаблонов во время выполнения.
    ///
    /// Используется макросом `#[template]` с фичей `runtime-templates`: шаблон
    /// `{{ поле }}` обращается к этому методу вместо встроенного на этапе
    /// сборки значения. По умолчанию — `None` (поле неизвестно), и генерируемый
    /// макросом код переопределяет его для каждого поля структуры через
    /// геттер (`self.count()`).
    fn eval_field(&self, _name: &str) -> Option<String> {
        None
    }

    /// Диспетчирует событие по имени обработчика для шаблонов в runtime.
    ///
    /// Имя — уже без скобок вызова (runtime-парсер срезает их). Сопоставляются
    /// встроенные методы окна (`"close"`, `"minimize"`, `"toggle_maximize"`,
    /// `"open_modal"`); остальные имена пробуются через
    /// [`Component::invoke_handler`], что позволяет сгенерированному макросом
    /// коду донести имена пользовательских методов до этой точки.
    fn dispatch_by_name(&self, handler: &str, event: Event) -> bool {
        // Не-Click события (Mousemove, Mouseenter и т. д.) не должны
        // запускать @click-обработчики по имени.
        if !matches!(event, Event::Click) {
            return false;
        }
        match handler {
            "close" => {
                self.close();
                true
            }
            "minimize" => {
                self.minimize();
                true
            }
            "toggle_maximize" => {
                self.toggle_maximize();
                true
            }
            "open_modal" => {
                self.open_modal();
                true
            }
            _ => self.invoke_handler(handler, event),
        }
    }

    /// Вызывает пользовательский обработчик `@click` по имени.
    ///
    /// По умолчанию — `false` (имя неизвестно). Генерируемый макросом код
    /// переопределяет его `match`-цепочкой на имена методов компонента,
    /// найденных в статическом шаблоне. Имя сопоставляется как точный
    /// литерал (`"increment"`) и как ключ узла (`key="inc_btn"`): runtime-
    /// дерево использует имя обработчика в качестве ключа, а DevTools может
    /// отправлять `CLICK <ключ>` для произвольного ключа. Вызывается только
    /// после промаха встроенных методов.
    fn invoke_handler(&self, _handler: &str, _event: Event) -> bool {
        false
    }

    /// Снимок реактивных свойств компонента для инструментов разработки.
    ///
    /// По умолчанию — `null`: компонент без реактивных свойств ничего не
    /// сообщает. Реализацию генерирует макрос `#[template]`: каждое поле
    /// появляется под своим именем со значением геттера, неподдерживаемые
    /// типы — как `null`/`"<unsupported>"`. Метод доступен всегда: с фичей
    /// `devtools` его используют инспектор и сохранение состояния, без неё —
    /// только при явном вызове.
    fn inspect_state(&self) -> serde_json::Value {
        serde_json::Value::Null
    }

    /// Вставляет состояние, снятое через [`inspect_state`](Self::inspect_state),
    /// обратно в реактивные поля компонента.
    ///
    /// По умолчанию — операция без действия: компонент без реактивных свойств
    /// не принимает значения. Реализация генерируется макросом `#[template]`
    /// (фича `devtools`): каждое поле перезаписывается значением из объекта
    /// `state`, если оно там присутствует и успешно десериализуется в тип
    /// поля. Поддерживаются те же типы, что и в `inspect_state`. Метод
    /// доступен всегда: с фичей `devtools` его применяют при запуске
    /// (восстановление `.light/state.json`) и по команде `SET_STATE` из
    /// DevTools; без фичи — только при явном вызове. Он не уведомляет
    /// обозревателей — перерисовку организует вызывающая сторона (см.
    /// `window/mod.rs`).
    fn inject_state(&mut self, state: &serde_json::Value) {
        let _ = state;
    }

    /// Доступ к конкретному типу компонента через `Any`.
    ///
    /// Используется `post_update` для downcast-а к целевому типу компонента
    /// в UI-потоке: `UserEvent::Action` хранит `TypeId` цели, а обработчик
    /// находит первое совпадение по `type_id()` среди всех окон. Прямое
    /// приведение `&mut dyn Component` → `&mut dyn Any` невозможно:
    /// `dyn Component` не `Sized`, а `Any: Sized`. Реализация генерируется
    /// макросом `#[template]`.
    fn as_any_mut(&mut self) -> &mut dyn Any;

    /// Проверяет отдельное поле (директива `:validator`).
    ///
    /// Реализация генерируется макросом `#[template]`; метод вызывается для
    /// полей, у которых задан `:validator="имя"`, с текущим значением поля.
    /// По умолчанию поле считается валидным.
    fn validate_field(&self, field: &str, value: &str) -> Result<(), String> {
        let _ = (field, value);
        Ok(())
    }

    /// Проверяет всю форму (директива `@validate`).
    ///
    /// Возвращает `None`, если своя проверка формы не задана (тогда выполняется
    /// только стандартная проверка `required`), либо `Some(errors)` со списком
    /// пар «ключ поля — сообщение». Реализация генерируется макросом
    /// `#[template]`.
    fn validate_form(&self, form: &str) -> Option<Vec<(String, String)>> {
        let _ = form;
        None
    }

    /// Развёрнуто ли окно в данный момент.
    ///
    /// Доступно в шаблонах как свойство: `v-if="is_maximized"`,
    /// `v-if="!is_maximized"`.
    fn is_maximized(&self) -> bool {
        crate::control::is_maximized()
    }

    /// Закрывает активное окно.
    ///
    /// Доступно в шаблонах как обработчик: `@click="close()"`.
    fn close(&self) {
        crate::control::request(crate::control::WindowCommand::Close);
    }

    /// Сворачивает активное окно.
    ///
    /// Доступно в шаблонах как обработчик: `@click="minimize()"`.
    fn minimize(&self) {
        crate::control::request(crate::control::WindowCommand::Minimize);
    }

    /// Переключает развёрнутое состояние активного окна.
    ///
    /// Доступно в шаблонах как обработчик: `@click="toggle_maximize()"`.
    fn toggle_maximize(&self) {
        crate::control::request(crate::control::WindowCommand::ToggleMaximize);
    }

    /// Открывает модальное окно, описанное [`Component::modal`].
    ///
    /// Доступно в шаблонах как обработчик: `@click="open_modal()"`.
    fn open_modal(&self) {
        crate::control::request(crate::control::WindowCommand::OpenModal);
    }

    /// Описание системного окна компонента.
    ///
    /// По умолчанию берётся из корневого элемента дерева, возвращённого
    /// [`Component::render`] (узел `<window>`). Если корень не описывает окно,
    /// возвращается `None` и системное окно не создаётся.
    fn window_config(&self) -> Option<WindowConfig> {
        self.render().window_config().cloned()
    }

    /// Компонент дочернего модального окна, открываемого по команде
    /// [`crate::control::WindowCommand::OpenModal`].
    ///
    /// Макрос `#[template("…", modal = Компонент)]` генерирует эту реализацию
    /// автоматически. По умолчанию модальное окно не предусмотрено.
    fn modal(&self) -> Option<Box<dyn Component>> {
        None
    }

    /// Компонент ещё одного **главного** окна, открываемого по команде
    /// [`crate::control::WindowCommand::OpenWindow`].
    ///
    /// Макрос `#[template("…", window = Компонент)]` генерирует эту реализацию
    /// автоматически. По умолчанию дополнительное главное окно не предусмотрено.
    fn window_factory(&self) -> Option<Box<dyn Component>> {
        None
    }

    /// Фабрики окон, открываемых по идентификатору.
    ///
    /// Макрос `#[template("...", windows = [A, B])]` генерирует эту реализацию.
    /// Каждая фабрика создаёт компонент окна, чей `id` (из `<window id="...">`)
    /// служит ключом для [`crate::control::WindowCommand::Open`]. По умолчанию
    /// список пуст.
    fn windows(&self) -> Vec<fn() -> Box<dyn Component>> {
        Vec::new()
    }
}

#[cfg(test)]
mod tests {
    use std::any::Any;
    use std::cell::Cell;

    use super::Component;
    use crate::vdom::{Event, VElement};

    /// Тестовый компонент: не переопределяет `dispatch_by_name` (тестируем
    /// базовую реализацию с Click-фильтром), перехватывает только
    /// `invoke_handler` для пользовательских имён.
    struct FakeComp {
        handler_called: Cell<bool>,
    }

    impl FakeComp {
        fn new() -> Self {
            Self {
                handler_called: Cell::new(false),
            }
        }
    }

    impl Default for FakeComp {
        fn default() -> Self {
            Self::new()
        }
    }

    impl Component for FakeComp {
        fn render(&self) -> VElement {
            VElement::container("", crate::vdom::NodeKind::Column, Vec::new())
        }

        fn invoke_handler(&self, handler: &str, event: Event) -> bool {
            if handler == "increment" && matches!(event, Event::Click) {
                self.handler_called.set(true);
                return true;
            }
            false
        }

        fn as_any_mut(&mut self) -> &mut dyn Any {
            self
        }
    }

    /// `dispatch_by_name("close", Mousemove)` → `false`.
    #[test]
    fn mousemove_does_not_trigger_builtin_close() {
        let c = FakeComp::default();
        // close() шлёт WindowCommand через глобальный канал; в unit-тесте
        // главное — что базовая реализация НЕ доходит до self.close().
        let result = c.dispatch_by_name("close", Event::Mousemove { x: 1.0, y: 1.0 });
        assert!(
            !result,
            "non-Click events must not trigger builtin handlers"
        );
    }

    /// `dispatch_by_name("minimize", Mouseenter)` → `false`.
    #[test]
    fn mouseenter_does_not_trigger_builtin_minimize() {
        let c = FakeComp::default();
        let result = c.dispatch_by_name("minimize", Event::Mouseenter);
        assert!(
            !result,
            "non-Click events must not trigger builtin handlers"
        );
    }

    /// `dispatch_by_name("increment", Mousemove)` → `false`, обработчик не вызван.
    #[test]
    fn mousemove_does_not_trigger_user_handler() {
        let c = FakeComp::default();
        let result = c.dispatch_by_name("increment", Event::Mousemove { x: 2.0, y: 3.0 });
        assert!(!result, "user handler must not fire on Mousemove");
        assert!(
            !c.handler_called.get(),
            "invoke_handler must not be called on Mousemove"
        );
    }

    /// `dispatch_by_name("increment", Click)` → `true`, обработчик вызван.
    #[test]
    fn click_triggers_user_handler() {
        let c = FakeComp::default();
        let result = c.dispatch_by_name("increment", Event::Click);
        assert!(result, "user handler must fire on Click");
        assert!(
            c.handler_called.get(),
            "invoke_handler must be called on Click"
        );
    }
}