freya-html 0.5.0

HTML + CSS rendering for Freya using Blitz
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
use std::{
    str::FromStr,
    sync::{
        Arc,
        atomic::{
            AtomicBool,
            Ordering,
        },
    },
    time::Instant,
};

use atomic_refcell::AtomicRefCell;
use blitz_dom::{
    Document,
    DocumentConfig,
};
use blitz_html::HtmlDocument;
use blitz_paint::paint_scene;
use blitz_traits::{
    events::{
        BlitzKeyEvent,
        BlitzPointerEvent,
        BlitzPointerId,
        BlitzWheelDelta,
        BlitzWheelEvent,
        KeyState,
        MouseEventButton,
        MouseEventButtons,
        Point,
        PointerCoords,
        PointerDetails,
        UiEvent,
    },
    navigation::NavigationProvider,
    net::NetProvider,
    shell::{
        ColorScheme,
        ShellProvider,
        Viewport,
    },
};
use freya_core::prelude::{
    Bytes,
    Code as FreyaCode,
    Force,
    Key as FreyaKey,
    Modifiers as FreyaModifiers,
    MouseButton as FreyaMouseButton,
    TouchEventData,
    TouchPhase,
};
use freya_engine::prelude::{
    Canvas,
    Matrix,
    Picture,
    PictureRecorder,
    Rect,
};
use futures_channel::mpsc::UnboundedSender;
use keyboard_types::{
    Code as BlitzCode,
    Key as BlitzKey,
    Location as BlitzLocation,
    Modifiers as BlitzModifiers,
};
use smol_str::SmolStr;

use crate::{
    anyrender::{
        SkiaSceneCache,
        SkiaScenePainter,
    },
    cache::ResourceCache,
    fonts::font_context,
    handle::ElementHit,
    net::{
        FetchRequest,
        FreyaNavigationProvider,
        FreyaShellProvider,
        HttpNetProvider,
    },
};

/// Owns a parsed Blitz document and paints it directly into Freya's Skia canvas.
pub(crate) struct BlitzState {
    document: Option<HtmlDocument>,
    font_context: blitz_dom::FontContext,
    net_provider: Arc<dyn NetProvider>,
    shell_provider: Arc<dyn ShellProvider>,
    navigation_provider: Arc<dyn NavigationProvider>,
    cache: SkiaSceneCache,
    /// Draw commands replayed on unchanged frames.
    picture: Option<Picture>,
    paint_key: Option<(u32, u32, u32)>,
    /// Set when the document changes visually.
    redraw: Arc<AtomicBool>,
    buttons: MouseEventButtons,
    active_pointers: Arc<AtomicRefCell<Vec<BlitzPointerEvent>>>,
    created: Instant,
}

impl BlitzState {
    pub fn new(
        wake: UnboundedSender<()>,
        navigate: UnboundedSender<String>,
        fetch: UnboundedSender<FetchRequest>,
        resource_cache: ResourceCache,
        fonts: Vec<Bytes>,
    ) -> Self {
        let redraw = Arc::new(AtomicBool::new(true));
        Self {
            document: None,
            font_context: font_context(&fonts),
            net_provider: Arc::new(HttpNetProvider {
                fetch,
                cache: resource_cache,
            }),
            shell_provider: Arc::new(FreyaShellProvider {
                redraw: redraw.clone(),
                wake,
            }),
            navigation_provider: Arc::new(FreyaNavigationProvider { navigate }),
            cache: SkiaSceneCache::new(),
            picture: None,
            paint_key: None,
            redraw,
            buttons: MouseEventButtons::empty(),
            active_pointers: Arc::new(AtomicRefCell::new(Vec::new())),
            created: Instant::now(),
        }
    }

    pub fn load(&mut self, html: &str, base_url: Option<String>) {
        let config = DocumentConfig {
            base_url,
            net_provider: Some(self.net_provider.clone()),
            shell_provider: Some(self.shell_provider.clone()),
            navigation_provider: Some(self.navigation_provider.clone()),
            font_ctx: Some(self.font_context.clone()),
            ..Default::default()
        };
        self.document = Some(HtmlDocument::from_html(html, config));
        self.active_pointers.borrow_mut().clear();
        self.paint_key = None;
        self.shell_provider.request_redraw();
    }

    /// Paint the document into `canvas`, `x`/`y` and `width`/`height` are physical pixels.
    pub fn paint(&mut self, canvas: &Canvas, x: f32, y: f32, width: u32, height: u32, scale: f32) {
        let Some(document) = self.document.as_mut() else {
            return;
        };
        if width == 0 || height == 0 {
            return;
        }

        let key = (width, height, scale.to_bits());

        if self.redraw.swap(false, Ordering::Relaxed)
            || self.picture.is_none()
            || self.paint_key != Some(key)
        {
            if self.paint_key != Some(key) {
                document.set_viewport(Viewport::new(width, height, scale, ColorScheme::Light));
            }
            document.resolve(self.created.elapsed().as_secs_f64());

            if document.is_animating() {
                self.shell_provider.request_redraw();
            }

            let bounds = Rect::new(0.0, 0.0, width as f32, height as f32);
            let mut recorder = PictureRecorder::new();
            {
                let recording = recorder.begin_recording(bounds, false);
                let mut painter = SkiaScenePainter::new(recording, &mut self.cache);
                paint_scene(&mut painter, document, scale as f64, width, height, 0, 0);
            }
            self.cache.next_gen();

            self.picture = recorder.finish_recording_as_picture(None);
            self.paint_key = Some(key);
        }

        if let Some(picture) = &self.picture {
            canvas.draw_picture(picture, Some(&Matrix::translate((x, y))), None);
        }
    }

    pub fn mouse_move(&mut self, x: f32, y: f32) {
        let event = self.pointer_event(x, y, MouseEventButton::Main);
        self.dispatch(UiEvent::PointerMove(event));
    }

    pub fn elements_at(&mut self, x: f32, y: f32) -> Vec<ElementHit> {
        let Some(document) = self.document.as_mut() else {
            return Vec::new();
        };
        document.resolve(self.created.elapsed().as_secs_f64());
        document
            .elements_from_point(x, y)
            .iter()
            .filter_map(|node_id| {
                let node = document.get_node(*node_id)?;
                let element = node.data.downcast_element()?;
                Some(ElementHit {
                    tag: element.name.local.to_string(),
                    attributes: element
                        .attrs
                        .iter()
                        .map(|attr| (attr.name.local.to_string(), attr.value.clone()))
                        .collect(),
                })
            })
            .collect()
    }

    pub fn mouse_button(
        &mut self,
        x: f32,
        y: f32,
        button: Option<FreyaMouseButton>,
        pressed: bool,
    ) {
        let button = map_button(button);
        if pressed {
            self.buttons |= MouseEventButtons::from(button);
        } else {
            self.buttons -= MouseEventButtons::from(button);
        }
        let event = self.pointer_event(x, y, button);
        self.dispatch(if pressed {
            UiEvent::PointerDown(event)
        } else {
            UiEvent::PointerUp(event)
        });
        self.shell_provider.request_redraw();
    }

    pub fn touch(&mut self, data: &TouchEventData, phase: TouchPhase) {
        let id = BlitzPointerId::Finger(data.finger_id);
        let pressed = matches!(phase, TouchPhase::Started | TouchPhase::Moved);
        let mut event = self.pointer_event(
            data.element_location.x as f32,
            data.element_location.y as f32,
            MouseEventButton::Main,
        );
        event.id = id;
        event.coords.screen_x = data.global_location.x as f32;
        event.coords.screen_y = data.global_location.y as f32;
        event.buttons = if pressed {
            MouseEventButtons::from(MouseEventButton::Main)
        } else {
            MouseEventButtons::empty()
        };
        event.details.pressure = if pressed {
            match data.force {
                Some(Force::Normalized(force)) => force,
                Some(Force::Calibrated {
                    force,
                    max_possible_force,
                    ..
                }) if max_possible_force > 0.0 => force / max_possible_force,
                _ => 0.5,
            }
            .clamp(0.0, 1.0)
        } else {
            0.0
        };
        {
            let mut pointers = self.active_pointers.borrow_mut();
            let position = pointers.iter().position(|pointer| pointer.id == id);
            event.is_primary = position
                .map(|position| pointers[position].is_primary)
                .unwrap_or(pointers.is_empty() && phase == TouchPhase::Started);
            if pressed {
                let mut snapshot = event.clone();
                snapshot.active_pointers = Arc::new(AtomicRefCell::new(Vec::new()));
                if let Some(position) = position {
                    pointers[position] = snapshot;
                } else {
                    pointers.push(snapshot);
                }
            } else if let Some(position) = position {
                pointers.remove(position);
            }
        }
        self.dispatch(match phase {
            TouchPhase::Started => UiEvent::PointerDown(event),
            TouchPhase::Moved => UiEvent::PointerMove(event),
            TouchPhase::Ended => UiEvent::PointerUp(event),
            TouchPhase::Cancelled => UiEvent::PointerCancel(event),
        });
        self.shell_provider.request_redraw();
    }

    pub fn wheel(&mut self, x: f32, y: f32, delta_x: f64, delta_y: f64) {
        let coords = self.coords(x, y);
        self.dispatch(UiEvent::Wheel(BlitzWheelEvent {
            delta: BlitzWheelDelta::Pixels(delta_x, delta_y),
            element: Point {
                x: coords.client_x,
                y: coords.client_y,
            },
            coords,
            buttons: self.buttons,
            mods: BlitzModifiers::empty(),
        }));
    }

    pub fn key(
        &mut self,
        key: &FreyaKey,
        code: &FreyaCode,
        modifiers: FreyaModifiers,
        pressed: bool,
    ) {
        let event = BlitzKeyEvent {
            key: convert_key(key),
            code: convert_code(code),
            modifiers: convert_modifiers(modifiers),
            location: BlitzLocation::Standard,
            is_auto_repeating: false,
            is_composing: false,
            state: if pressed {
                KeyState::Pressed
            } else {
                KeyState::Released
            },
            text: key_text(key),
        };
        self.dispatch(if pressed {
            UiEvent::KeyDown(event)
        } else {
            UiEvent::KeyUp(event)
        });
        self.shell_provider.request_redraw();
    }

    fn coords(&self, x: f32, y: f32) -> PointerCoords {
        let (scroll_x, scroll_y) = self
            .document
            .as_ref()
            .map(|document| {
                let scroll = document.viewport_scroll();
                (scroll.x as f32, scroll.y as f32)
            })
            .unwrap_or((0.0, 0.0));
        PointerCoords {
            screen_x: x,
            screen_y: y,
            client_x: x,
            client_y: y,
            page_x: x + scroll_x,
            page_y: y + scroll_y,
        }
    }

    fn pointer_event(&self, x: f32, y: f32, button: MouseEventButton) -> BlitzPointerEvent {
        let coords = self.coords(x, y);
        BlitzPointerEvent {
            id: BlitzPointerId::Mouse,
            is_primary: true,
            element: Point {
                x: coords.client_x,
                y: coords.client_y,
            },
            coords,
            button,
            buttons: self.buttons,
            mods: BlitzModifiers::empty(),
            details: PointerDetails::default(),
            active_pointers: self.active_pointers.clone(),
        }
    }

    fn dispatch(&mut self, event: UiEvent) {
        if let Some(document) = &mut self.document {
            document.handle_ui_event(event);
        }
    }
}

fn map_button(button: Option<FreyaMouseButton>) -> MouseEventButton {
    match button {
        Some(FreyaMouseButton::Right) => MouseEventButton::Secondary,
        Some(FreyaMouseButton::Middle) => MouseEventButton::Auxiliary,
        Some(FreyaMouseButton::Back) => MouseEventButton::Fourth,
        Some(FreyaMouseButton::Forward) => MouseEventButton::Fifth,
        _ => MouseEventButton::Main,
    }
}

fn convert_modifiers(modifiers: FreyaModifiers) -> BlitzModifiers {
    let mut out = BlitzModifiers::empty();
    if modifiers.contains(FreyaModifiers::CONTROL) {
        out |= BlitzModifiers::CONTROL;
    }
    if modifiers.contains(FreyaModifiers::SHIFT) {
        out |= BlitzModifiers::SHIFT;
    }
    if modifiers.contains(FreyaModifiers::ALT) {
        out |= BlitzModifiers::ALT;
    }
    if modifiers.contains(FreyaModifiers::META) {
        out |= BlitzModifiers::META;
    }
    out
}

fn convert_key(key: &FreyaKey) -> BlitzKey {
    BlitzKey::from_str(&key.to_string()).unwrap_or(BlitzKey::Unidentified)
}

fn convert_code(code: &FreyaCode) -> BlitzCode {
    BlitzCode::from_str(&code.to_string()).unwrap_or(BlitzCode::Unidentified)
}

fn key_text(key: &FreyaKey) -> Option<SmolStr> {
    match key {
        FreyaKey::Character(text) => Some(SmolStr::new(text)),
        _ => None,
    }
}