ps-blitz-html 0.3.0-beta.3

Blitz HTML parser
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

//! Touch events (touchstart, touchmove, touchend) are generated from finger
//! pointer input and dispatched to application code alongside the corresponding
//! pointer events. Mouse input must NOT generate touch events (and vice-versa),
//! and default actions remain driven by the pointer events.

use blitz_dom::{Document, DocumentConfig, EventDriver, EventHandler};
use blitz_html::{HtmlDocument, HtmlProvider};
use blitz_traits::{
    events::{
        BlitzPointerEvent, BlitzPointerId, DomEvent, EventState, MouseEventButton,
        MouseEventButtons, Point, PointerCoords, PointerDetails, UiEvent,
    },
    shell::{ColorScheme, Viewport},
};
use std::cell::RefCell;
use std::rc::Rc;
use std::sync::Arc;

fn doc(html: &str) -> HtmlDocument {
    let mut doc = HtmlDocument::from_html(
        html,
        DocumentConfig {
            viewport: Some(Viewport::new(200, 200, 1.0, ColorScheme::Light)),
            html_parser_provider: Some(Arc::new(HtmlProvider) as _),
            ..Default::default()
        },
    );
    doc.resolve(0.0);
    doc
}

fn pointer_event(id: BlitzPointerId, x: f32, y: f32) -> BlitzPointerEvent {
    BlitzPointerEvent {
        id,
        is_primary: true,
        coords: PointerCoords {
            page_x: x,
            page_y: y,
            screen_x: x,
            screen_y: y,
            client_x: x,
            client_y: y,
        },
        button: MouseEventButton::Main,
        buttons: MouseEventButtons::from(MouseEventButton::Main),
        mods: Default::default(),
        details: PointerDetails::default(),
        element: Point::default(),
        active_pointers: Default::default(),
    }
}

/// An [`EventHandler`] that records the name of every [`DomEvent`] it sees.
#[derive(Clone, Default)]
struct RecordingHandler {
    events: Rc<RefCell<Vec<String>>>,
}

impl EventHandler for RecordingHandler {
    fn handle_event(
        &mut self,
        _chain: &[usize],
        event: &mut DomEvent,
        _doc: &mut dyn Document,
        _event_state: &mut EventState,
    ) {
        self.events.borrow_mut().push(event.name().to_string());
    }
}

fn drive(doc: &mut HtmlDocument, events: impl IntoIterator<Item = UiEvent>) -> Vec<String> {
    let handler = RecordingHandler::default();
    let recorded = handler.events.clone();
    let mut driver = EventDriver::new(doc, handler);
    for event in events {
        driver.handle_ui_event(event);
    }
    let recorded = recorded.borrow().clone();
    recorded
}

fn target_doc() -> HtmlDocument {
    doc(r#"<html><body style="margin:0">
        <div id="target" style="width:200px; height:200px;"></div>
    </body></html>"#)
}

#[test]
fn finger_input_generates_touch_events() {
    let mut doc = target_doc();
    let finger = BlitzPointerId::Finger(0);
    let names = drive(
        &mut doc,
        [
            UiEvent::PointerDown(pointer_event(finger, 50.0, 50.0)),
            UiEvent::PointerMove(pointer_event(finger, 60.0, 60.0)),
            UiEvent::PointerUp(pointer_event(finger, 60.0, 60.0)),
        ],
    );

    assert!(
        names.contains(&"touchstart".to_string()),
        "expected a touchstart event, got {names:?}"
    );
    assert!(
        names.contains(&"touchmove".to_string()),
        "expected a touchmove event, got {names:?}"
    );
    assert!(
        names.contains(&"touchend".to_string()),
        "expected a touchend event, got {names:?}"
    );

    // The pointer events must still be dispatched.
    assert!(names.contains(&"pointerdown".to_string()));
    assert!(names.contains(&"pointermove".to_string()));
    assert!(names.contains(&"pointerup".to_string()));

    // Finger input must not generate mouse compatibility events.
    assert!(
        !names.iter().any(|n| n.starts_with("mouse")),
        "finger input should not generate mouse events, got {names:?}"
    );
}

#[test]
fn pen_input_generates_touch_events() {
    let mut doc = target_doc();
    let pen = BlitzPointerId::Pen;
    let names = drive(
        &mut doc,
        [
            UiEvent::PointerDown(pointer_event(pen, 50.0, 50.0)),
            UiEvent::PointerMove(pointer_event(pen, 60.0, 60.0)),
            UiEvent::PointerUp(pointer_event(pen, 60.0, 60.0)),
        ],
    );

    assert!(
        names.contains(&"touchstart".to_string()),
        "expected a touchstart event, got {names:?}"
    );
    assert!(
        names.contains(&"touchmove".to_string()),
        "expected a touchmove event, got {names:?}"
    );
    assert!(
        names.contains(&"touchend".to_string()),
        "expected a touchend event, got {names:?}"
    );

    // The pointer events must still be dispatched.
    assert!(names.contains(&"pointerdown".to_string()));

    // Pen input must not generate mouse compatibility events.
    assert!(
        !names.iter().any(|n| n.starts_with("mouse")),
        "pen input should not generate mouse events, got {names:?}"
    );
}

#[test]
fn finger_cancel_generates_pointercancel_and_touchcancel() {
    let mut doc = target_doc();
    let finger = BlitzPointerId::Finger(0);
    let names = drive(
        &mut doc,
        [
            UiEvent::PointerDown(pointer_event(finger, 50.0, 50.0)),
            UiEvent::PointerCancel(pointer_event(finger, 50.0, 50.0)),
        ],
    );

    assert!(
        names.contains(&"pointercancel".to_string()),
        "expected a pointercancel event, got {names:?}"
    );
    assert!(
        names.contains(&"touchcancel".to_string()),
        "expected a touchcancel event, got {names:?}"
    );

    // A cancelled interaction must not produce up/end events.
    assert!(
        !names.contains(&"pointerup".to_string()),
        "cancel should not produce pointerup, got {names:?}"
    );
    assert!(
        !names.contains(&"touchend".to_string()),
        "cancel should not produce touchend, got {names:?}"
    );

    // Finger input must not generate mouse compatibility events.
    assert!(
        !names.iter().any(|n| n.starts_with("mouse")),
        "finger input should not generate mouse events, got {names:?}"
    );
}

#[test]
fn pen_cancel_generates_pointercancel_and_touchcancel() {
    let mut doc = target_doc();
    let pen = BlitzPointerId::Pen;
    let names = drive(
        &mut doc,
        [
            UiEvent::PointerDown(pointer_event(pen, 50.0, 50.0)),
            UiEvent::PointerCancel(pointer_event(pen, 50.0, 50.0)),
        ],
    );

    assert!(
        names.contains(&"pointercancel".to_string()),
        "expected a pointercancel event, got {names:?}"
    );
    assert!(
        names.contains(&"touchcancel".to_string()),
        "expected a touchcancel event, got {names:?}"
    );
}

#[test]
fn mouse_cancel_generates_pointercancel_without_touch_or_mouse() {
    let mut doc = target_doc();
    let mouse = BlitzPointerId::Mouse;
    let names = drive(
        &mut doc,
        [
            UiEvent::PointerDown(pointer_event(mouse, 50.0, 50.0)),
            UiEvent::PointerCancel(pointer_event(mouse, 50.0, 50.0)),
        ],
    );

    assert!(
        names.contains(&"pointercancel".to_string()),
        "expected a pointercancel event, got {names:?}"
    );
    // Mouse input has no touchcancel and no mouse-cancel compatibility event.
    assert!(
        !names.iter().any(|n| n.starts_with("touch")),
        "mouse input should not generate touch events, got {names:?}"
    );
    assert!(
        !names.contains(&"mousecancel".to_string()),
        "there is no mousecancel event, got {names:?}"
    );
}

#[test]
fn mouse_input_does_not_generate_touch_events() {
    let mut doc = target_doc();
    let mouse = BlitzPointerId::Mouse;
    let names = drive(
        &mut doc,
        [
            UiEvent::PointerDown(pointer_event(mouse, 50.0, 50.0)),
            UiEvent::PointerMove(pointer_event(mouse, 60.0, 60.0)),
            UiEvent::PointerUp(pointer_event(mouse, 60.0, 60.0)),
        ],
    );

    assert!(
        !names.iter().any(|n| n.starts_with("touch")),
        "mouse input should not generate touch events, got {names:?}"
    );
    // Mouse compatibility events are still generated.
    assert!(names.contains(&"mousedown".to_string()));
}