wasserxr 0.2.1

A **dynamic XR Engine** to help you stay in the **flow**
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
use std::ffi::c_void;

use crate::{
    error::ComponentError,
    scene::component::{field_type::FieldType, serialized_bytes::SerializedBytes},
};

/// C ABI function that returns a raw pointer to a component field.
///
/// # Safety
///
/// The caller must pass a pointer to the component type the getter was
/// generated for. Returning a pointer to the wrong type or to invalid storage
/// makes later field reads undefined behavior.
pub type Getter = unsafe extern "C" fn(*mut c_void) -> *mut c_void;

/// C ABI function that serializes one component field into owned bytes.
///
/// # Safety
///
/// The caller must pass a pointer to the component type the serializer was
/// generated for.
pub type Serializer = unsafe extern "C" fn(*const c_void) -> SerializedBytes;

/// C ABI function that writes serialized bytes back into one component field.
///
/// # Safety
///
/// The caller must pass a pointer to the component type the deserializer was
/// generated for, and the bytes must have the format that deserializer expects.
pub type Deserializer = unsafe extern "C" fn(*mut c_void, SerializedBytes);

#[derive(Clone, Copy)]
/// Runtime metadata for one component field.
pub struct Field {
    type_hint: FieldType,
    getter: Option<Getter>,
    mutable: bool,
    serializer: Option<Serializer>,
    deserializer: Option<Deserializer>,
}

impl Field {
    /// Creates field metadata from a type hint and optional field binding functions.
    pub fn new(
        type_hint: FieldType,
        getter: Option<Getter>,
        mutable: bool,
        serializer: Option<Serializer>,
        deserializer: Option<Deserializer>,
    ) -> Self {
        Self {
            type_hint,
            getter,
            mutable,
            serializer,
            deserializer,
        }
    }

    /// Returns the runtime type hint registered for this field.
    pub fn get_type(&self) -> FieldType {
        self.type_hint
    }

    /// Returns the getter function, or `FieldNoGetter` if the schema has none.
    pub fn get_getter(&self) -> Result<Getter, ComponentError> {
        match self.getter {
            Some(getter) => Ok(getter),
            None => Err(ComponentError::FieldNoGetter),
        }
    }

    /// Returns whether this field may be borrowed mutably through `Scene::query_mut`.
    pub fn is_mutable(&self) -> bool {
        self.mutable
    }

    /// Returns whether this field can be parsed from text with `parse`.
    pub fn is_string_parsable(&self) -> bool {
        !matches!(self.type_hint, FieldType::Blob)
    }

    /// Returns the serializer function, or `FieldNoSerializer` if the schema has none.
    pub fn get_serializer(&self) -> Result<Serializer, ComponentError> {
        match self.serializer {
            Some(serializer) => Ok(serializer),
            None => Err(ComponentError::FieldNoSerializer),
        }
    }

    /// Returns the deserializer function, or `FieldNoDeserializer` if the schema has none.
    pub fn get_deserializer(&self) -> Result<Deserializer, ComponentError> {
        match self.deserializer {
            Some(deserializer) => Ok(deserializer),
            None => Err(ComponentError::FieldNoDeserializer),
        }
    }

    /// Renders the raw field value as a string according to this field's type hint.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a value matching this field's type hint.
    pub unsafe fn render(&self, ptr: *mut c_void) -> Result<String, ComponentError> {
        if ptr.is_null() {
            return Err(ComponentError::FieldValueParsing);
        }

        Ok(match self.type_hint {
            FieldType::I8 => unsafe { (*(ptr as *const i8)).to_string() },
            FieldType::I16 => unsafe { (*(ptr as *const i16)).to_string() },
            FieldType::I32 => unsafe { (*(ptr as *const i32)).to_string() },
            FieldType::I64 => unsafe { (*(ptr as *const i64)).to_string() },
            FieldType::I128 => unsafe { (*(ptr as *const i128)).to_string() },
            FieldType::Isize => unsafe { (*(ptr as *const isize)).to_string() },
            FieldType::U8 => unsafe { (*(ptr as *const u8)).to_string() },
            FieldType::U16 => unsafe { (*(ptr as *const u16)).to_string() },
            FieldType::U32 => unsafe { (*(ptr as *const u32)).to_string() },
            FieldType::U64 => unsafe { (*(ptr as *const u64)).to_string() },
            FieldType::U128 => unsafe { (*(ptr as *const u128)).to_string() },
            FieldType::Usize => unsafe { (*(ptr as *const usize)).to_string() },
            FieldType::F32 => unsafe { (*(ptr as *const f32)).to_string() },
            FieldType::F64 => unsafe { (*(ptr as *const f64)).to_string() },
            FieldType::F32Vec2 => unsafe { render_vector(&*(ptr as *const [f32; 2])) },
            FieldType::F32Vec3 => unsafe { render_vector(&*(ptr as *const [f32; 3])) },
            FieldType::F64Vec2 => unsafe { render_vector(&*(ptr as *const [f64; 2])) },
            FieldType::F64Vec3 => unsafe { render_vector(&*(ptr as *const [f64; 3])) },
            FieldType::Char => unsafe { (*(ptr as *const char)).to_string() },
            FieldType::String => unsafe { (*(ptr as *const String)).clone() },
            FieldType::Blob => format!("{ptr:p}"),
        })
    }

    /// Parses `input` and writes it into the raw field value.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a value matching this field's type hint.
    pub unsafe fn parse(&self, ptr: *mut c_void, input: &str) -> Result<(), ComponentError> {
        if ptr.is_null() {
            return Err(ComponentError::FieldValueParsing);
        }

        match self.type_hint {
            FieldType::I8 => unsafe { *(ptr as *mut i8) = parse_value(input)? },
            FieldType::I16 => unsafe { *(ptr as *mut i16) = parse_value(input)? },
            FieldType::I32 => unsafe { *(ptr as *mut i32) = parse_value(input)? },
            FieldType::I64 => unsafe { *(ptr as *mut i64) = parse_value(input)? },
            FieldType::I128 => unsafe { *(ptr as *mut i128) = parse_value(input)? },
            FieldType::Isize => unsafe { *(ptr as *mut isize) = parse_value(input)? },
            FieldType::U8 => unsafe { *(ptr as *mut u8) = parse_value(input)? },
            FieldType::U16 => unsafe { *(ptr as *mut u16) = parse_value(input)? },
            FieldType::U32 => unsafe { *(ptr as *mut u32) = parse_value(input)? },
            FieldType::U64 => unsafe { *(ptr as *mut u64) = parse_value(input)? },
            FieldType::U128 => unsafe { *(ptr as *mut u128) = parse_value(input)? },
            FieldType::Usize => unsafe { *(ptr as *mut usize) = parse_value(input)? },
            FieldType::F32 => unsafe { *(ptr as *mut f32) = parse_value(input)? },
            FieldType::F64 => unsafe { *(ptr as *mut f64) = parse_value(input)? },
            FieldType::F32Vec2 => unsafe { *(ptr as *mut [f32; 2]) = parse_vector(input)? },
            FieldType::F32Vec3 => unsafe { *(ptr as *mut [f32; 3]) = parse_vector(input)? },
            FieldType::F64Vec2 => unsafe { *(ptr as *mut [f64; 2]) = parse_vector(input)? },
            FieldType::F64Vec3 => unsafe { *(ptr as *mut [f64; 3]) = parse_vector(input)? },
            FieldType::Char => unsafe { *(ptr as *mut char) = parse_char(input)? },
            FieldType::String => unsafe { *(ptr as *mut String) = input.to_owned() },
            FieldType::Blob => return Err(ComponentError::FieldValueParsing),
        }

        Ok(())
    }
}

fn parse_value<T: std::str::FromStr>(input: &str) -> Result<T, ComponentError> {
    input.parse().map_err(|_| ComponentError::FieldValueParsing)
}

fn render_vector<T: ToString, const N: usize>(value: &[T; N]) -> String {
    value
        .iter()
        .map(ToString::to_string)
        .collect::<Vec<_>>()
        .join(", ")
}

fn parse_vector<T: std::str::FromStr, const N: usize>(
    input: &str,
) -> Result<[T; N], ComponentError> {
    let values = input
        .split(',')
        .map(|part| parse_value(part.trim()))
        .collect::<Result<Vec<_>, _>>()?;

    values
        .try_into()
        .map_err(|_| ComponentError::FieldValueParsing)
}

fn parse_char(input: &str) -> Result<char, ComponentError> {
    let mut chars = input.chars();
    let Some(value) = chars.next() else {
        return Err(ComponentError::FieldValueParsing);
    };

    if chars.next().is_some() {
        return Err(ComponentError::FieldValueParsing);
    }

    Ok(value)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::ffi::c_void;

    unsafe extern "C" fn test_getter(_data: *mut c_void) -> *mut c_void {
        std::ptr::null_mut()
    }

    unsafe extern "C" fn test_serializer(_data: *const c_void) -> SerializedBytes {
        SerializedBytes::from_vec(vec![1, 2, 3])
    }

    unsafe extern "C" fn test_deserializer(_data: *mut c_void, _value: SerializedBytes) {}

    #[test]
    fn field_new() {
        let field = Field::new(
            FieldType::I64,
            Some(test_getter),
            true,
            Some(test_serializer),
            Some(test_deserializer),
        );

        assert_eq!(field.get_type(), FieldType::I64);
        assert!(field.is_mutable());
    }

    #[test]
    fn field_get_getter_when_present() {
        let field = Field::new(FieldType::Blob, Some(test_getter), false, None, None);

        assert_eq!(
            field.get_getter().unwrap() as usize,
            test_getter as *const () as usize
        );
    }

    #[test]
    fn field_get_getter_when_missing() {
        let field = Field::new(FieldType::Blob, None, false, None, None);

        assert_eq!(field.get_getter(), Err(ComponentError::FieldNoGetter));
    }

    #[test]
    fn field_is_mutable_when_enabled() {
        let field = Field::new(FieldType::Blob, Some(test_getter), true, None, None);

        assert!(field.is_mutable());
    }

    #[test]
    fn field_is_not_mutable_by_default() {
        let field = Field::new(FieldType::Blob, Some(test_getter), false, None, None);

        assert!(!field.is_mutable());
    }

    #[test]
    fn field_get_serializer_when_present() {
        let field = Field::new(FieldType::Blob, None, false, Some(test_serializer), None);

        assert_eq!(
            field.get_serializer().unwrap() as usize,
            test_serializer as *const () as usize
        );
    }

    #[test]
    fn field_get_serializer_when_missing() {
        let field = Field::new(FieldType::Blob, None, false, None, Some(test_deserializer));

        assert_eq!(
            field.get_serializer(),
            Err(ComponentError::FieldNoSerializer)
        );
    }

    #[test]
    fn field_get_deserializer_when_present() {
        let field = Field::new(FieldType::Blob, None, false, None, Some(test_deserializer));

        assert_eq!(
            field.get_deserializer().unwrap() as usize,
            test_deserializer as *const () as usize
        );
    }

    #[test]
    fn field_get_deserializer_when_missing() {
        let field = Field::new(FieldType::Blob, None, false, Some(test_serializer), None);

        assert_eq!(
            field.get_deserializer(),
            Err(ComponentError::FieldNoDeserializer)
        );
    }

    #[test]
    fn field_render_and_parse_signed_integer() {
        let field = Field::new(FieldType::I32, None, true, None, None);
        let mut value = -4i32;
        let ptr = &mut value as *mut i32 as *mut c_void;

        assert_eq!(unsafe { field.render(ptr) }.unwrap(), "-4");
        unsafe { field.parse(ptr, "42") }.unwrap();

        assert_eq!(value, 42);
        assert_eq!(
            unsafe { field.parse(ptr, "not a number") },
            Err(ComponentError::FieldValueParsing)
        );
    }

    #[test]
    fn field_parse_unsigned_integer_rejects_negative_input() {
        let field = Field::new(FieldType::U8, None, true, None, None);
        let mut value = 1u8;
        let ptr = &mut value as *mut u8 as *mut c_void;

        assert_eq!(
            unsafe { field.parse(ptr, "-1") },
            Err(ComponentError::FieldValueParsing)
        );
        assert_eq!(value, 1);
    }

    #[test]
    fn field_render_and_parse_float() {
        let field = Field::new(FieldType::F32, None, true, None, None);
        let mut value = 1.5f32;
        let ptr = &mut value as *mut f32 as *mut c_void;

        assert_eq!(unsafe { field.render(ptr) }.unwrap(), "1.5");
        unsafe { field.parse(ptr, "2.25") }.unwrap();

        assert_eq!(value, 2.25);
    }

    #[test]
    fn field_render_and_parse_f32_vector() {
        let field = Field::new(FieldType::F32Vec3, None, true, None, None);
        let mut value = [1.5f32, 2.5, 3.5];
        let ptr = &mut value as *mut [f32; 3] as *mut c_void;

        assert_eq!(unsafe { field.render(ptr) }.unwrap(), "1.5, 2.5, 3.5");
        unsafe { field.parse(ptr, "4.0, 5.0, 6.0") }.unwrap();
        assert_eq!(value, [4.0, 5.0, 6.0]);

        unsafe { field.parse(ptr, "7.0,8.0,9.0") }.unwrap();
        assert_eq!(value, [7.0, 8.0, 9.0]);
    }

    #[test]
    fn field_render_and_parse_f64_vector() {
        let field = Field::new(FieldType::F64Vec2, None, true, None, None);
        let mut value = [1.5f64, 2.5];
        let ptr = &mut value as *mut [f64; 2] as *mut c_void;

        assert_eq!(unsafe { field.render(ptr) }.unwrap(), "1.5, 2.5");
        unsafe { field.parse(ptr, "3.0,4.0") }.unwrap();

        assert_eq!(value, [3.0, 4.0]);
    }

    #[test]
    fn field_parse_vector_rejects_invalid_input() {
        let field = Field::new(FieldType::F32Vec2, None, true, None, None);
        let mut value = [1.0f32, 2.0];
        let ptr = &mut value as *mut [f32; 2] as *mut c_void;

        assert_eq!(
            unsafe { field.parse(ptr, "3.0") },
            Err(ComponentError::FieldValueParsing)
        );
        assert_eq!(
            unsafe { field.parse(ptr, "3.0, invalid") },
            Err(ComponentError::FieldValueParsing)
        );
        assert_eq!(value, [1.0, 2.0]);
    }

    #[test]
    fn field_render_and_parse_char() {
        let field = Field::new(FieldType::Char, None, true, None, None);
        let mut value = 'a';
        let ptr = &mut value as *mut char as *mut c_void;

        assert_eq!(unsafe { field.render(ptr) }.unwrap(), "a");
        unsafe { field.parse(ptr, "z") }.unwrap();

        assert_eq!(value, 'z');
        assert_eq!(
            unsafe { field.parse(ptr, "ab") },
            Err(ComponentError::FieldValueParsing)
        );
    }

    #[test]
    fn field_render_and_parse_string() {
        let field = Field::new(FieldType::String, None, true, None, None);
        let mut value = "old".to_owned();
        let ptr = &mut value as *mut String as *mut c_void;

        assert_eq!(unsafe { field.render(ptr) }.unwrap(), "old");
        unsafe { field.parse(ptr, "new") }.unwrap();

        assert_eq!(value, "new");
    }

    #[test]
    fn field_renders_blob_pointer_and_rejects_parse() {
        let field = Field::new(FieldType::Blob, None, true, None, None);
        let mut value = 1u8;
        let ptr = &mut value as *mut u8 as *mut c_void;

        assert!(unsafe { field.render(ptr) }.unwrap().starts_with("0x"));
        assert_eq!(
            unsafe { field.parse(ptr, "0x0") },
            Err(ComponentError::FieldValueParsing)
        );
    }
}