sdformat 0.1.0

Parsing library for sdformat in Rust
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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
use std::collections::{BTreeSet, HashMap};
use std::fmt::Debug;
use std::io::{Read, Write};
use std::ops::{Deref, DerefMut};
use std::sync::Arc;

use nalgebra::*;
use xml::attribute::OwnedAttribute;
use xml::namespace::Namespace;

pub use yaserde;

use yaserde::{YaDeserialize, YaSerialize};

// Most of the structs are generated automatically from the
include!(concat!(env!("OUT_DIR"), "/sdf.rs"));

pub struct Boxed<T> {
    inner: Box<T>,
}

impl<T> From<T> for Boxed<T> {
    fn from(t: T) -> Self {
        Self { inner: Box::new(t) }
    }
}

impl<T: PartialEq> PartialEq for Boxed<T> {
    fn eq(&self, rhs: &Self) -> bool {
        self.inner == rhs.inner
    }
}

impl<T: YaDeserialize> YaDeserialize for Boxed<T> {
    fn deserialize<R: Read>(reader: &mut yaserde::de::Deserializer<R>) -> Result<Self, String> {
        Ok(Self {
            inner: Box::new(T::deserialize(reader)?),
        })
    }
}

impl<T: YaSerialize> YaSerialize for Boxed<T> {
    fn serialize<W: Write>(&self, writer: &mut yaserde::ser::Serializer<W>) -> Result<(), String> {
        self.inner.as_ref().serialize(writer)
    }

    fn serialize_attributes(
        &self,
        attributes: Vec<OwnedAttribute>,
        namespace: Namespace,
    ) -> Result<(Vec<OwnedAttribute>, Namespace), String> {
        self.inner
            .as_ref()
            .serialize_attributes(attributes, namespace)
    }
}

impl<T: Default> Default for Boxed<T> {
    fn default() -> Self {
        Self {
            inner: Default::default(),
        }
    }
}

impl<T: Clone> Clone for Boxed<T> {
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
        }
    }
}

impl<T: Debug> Debug for Boxed<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.inner.as_ref().fmt(f)
    }
}

impl<T> Deref for Boxed<T> {
    type Target = T;
    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<T> DerefMut for Boxed<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}

#[derive(PartialEq, Clone, Debug)]
pub enum ElementData {
    String(String),
    Nested(ElementMap),
}

impl Default for ElementData {
    fn default() -> Self {
        ElementData::String("".into())
    }
}

impl TryFrom<ElementData> for f64 {
    type Error = String;

    fn try_from(e: ElementData) -> Result<Self, Self::Error> {
        match e {
            ElementData::String(s) => s
                .parse::<f64>()
                .map_err(|_| "Unable to parse into f64".to_string()),
            ElementData::Nested(_) => Err("Nested element found".into()),
        }
    }
}

impl TryFrom<ElementData> for i64 {
    type Error = String;

    fn try_from(e: ElementData) -> Result<Self, Self::Error> {
        match e {
            ElementData::String(s) => s
                .parse::<i64>()
                .map_err(|_| "Unable to parse into i64".to_string()),
            ElementData::Nested(_) => Err("Nested element found".into()),
        }
    }
}

#[derive(PartialEq, Clone, Debug)]
pub struct XmlElement {
    pub attributes: HashMap<String, String>,
    pub name: Arc<str>,
    pub data: ElementData,
}

impl Default for XmlElement {
    fn default() -> Self {
        Self {
            attributes: Default::default(),
            name: "".into(),
            data: Default::default(),
        }
    }
}

#[derive(Default, PartialEq, Clone, Debug)]
pub struct ElementMap {
    indexes: HashMap<Arc<str>, BTreeSet<usize>>,
    elements: Vec<XmlElement>,
}

#[derive(Default, PartialEq, Clone, Debug)]
pub struct SdfParams(pub ElementMap);

// Manually declare plugin
#[derive(Default, PartialEq, Clone, Debug)]
pub struct SdfPlugin {
    pub name: String,
    pub filename: String,
    pub elements: ElementMap,
}

impl ElementMap {
    /// Returns a reference to the first element with the specified name
    pub fn get(&self, name: &str) -> Option<&XmlElement> {
        self.indexes
            .get(name)
            .and_then(|idxs| self.elements.get(*idxs.iter().next()?))
    }

    /// Returns a mutable reference to the first element with the specified name
    pub fn get_mut(&mut self, name: &str) -> Option<&mut XmlElement> {
        self.indexes
            .get(name)
            .and_then(|idxs| self.elements.get_mut(*idxs.iter().next()?))
    }

    /// Runs the provided closure for each element with the requested name.
    pub fn for_each<F: Fn(&XmlElement)>(&mut self, name: &str, f: F) {
        let Some(idxs) = self.indexes.get(name) else {
            return;
        };
        for idx in idxs.iter() {
            if let Some(element) = self.elements.get(*idx) {
                f(element);
            }
        }
    }

    /// Runs the provided closure for each element with the requested name. Allows mutating the
    /// element.
    pub fn for_each_mut<F: FnMut(&mut XmlElement)>(&mut self, name: &str, mut f: F) {
        let Some(idxs) = self.indexes.get(name) else {
            return;
        };
        for idx in idxs.iter() {
            if let Some(ref mut element) = self.elements.get_mut(*idx) {
                f(element);
            }
        }
    }

    /// Adds a new element.
    pub fn push(&mut self, elem: XmlElement) {
        let idx = self.elements.len();
        let name = elem.name.clone();
        self.elements.push(elem);
        self.indexes.entry(name).or_default().insert(idx);
    }

    /// Returns a slice containing all the elements in this map.
    pub fn all(&self) -> &[XmlElement] {
        &self.elements
    }
}

fn deserialize_element<R: Read>(
    reader: &mut yaserde::de::Deserializer<R>,
) -> Result<XmlElement, String> {
    let (name, attributes) = match reader.next_event()? {
        xml::reader::XmlEvent::StartElement {
            name, attributes, ..
        } => (name.local_name, attributes),
        _ => return Err("Unexpected event found when deserializing plugin element".to_string()),
    };
    let mut element = XmlElement {
        name: name.into(),
        ..Default::default()
    };
    for attr in attributes.iter() {
        element
            .attributes
            .insert(attr.name.local_name.clone(), attr.value.to_owned());
    }
    match reader.peek()? {
        xml::reader::XmlEvent::Characters(value) => {
            element.data = ElementData::String(value.clone());
            reader.next_event()?;
            // Discard the next element, it should be an end event
            reader.next_event()?;
        }
        xml::reader::XmlEvent::StartElement { .. } => {
            let mut elements = ElementMap::default();
            // TODO(luca) make sure we are ending this element
            while !matches!(reader.peek(), Ok(xml::reader::XmlEvent::EndElement { .. })) {
                let elem = deserialize_element(reader)?;
                elements.push(elem);
            }
            element.data = ElementData::Nested(elements);
            // Discard the next element, it is an end event
            reader.next_event()?;
        }
        xml::reader::XmlEvent::EndElement { .. } => {
            reader.next_event()?;
            element.data = ElementData::default();
        }
        _ => return Err("Unexpected event found when deserializing plugin data".to_string()),
    };
    Ok(element)
}

impl YaDeserialize for SdfPlugin {
    fn deserialize<R: Read>(reader: &mut yaserde::de::Deserializer<R>) -> Result<Self, String> {
        let mut plugin = SdfPlugin::default();
        let read_attribute = |attributes: &Vec<OwnedAttribute>, name: &str| {
            attributes
                .iter()
                .find(|attr| attr.name.local_name == name)
                .map(|attr| attr.value.clone())
                .unwrap_or_default()
        };
        // deserializer code
        if let Ok(xml::reader::XmlEvent::StartElement { attributes, .. }) = reader.next_event() {
            plugin.name = read_attribute(&attributes, "name");
            plugin.filename = read_attribute(&attributes, "filename");
            while !matches!(reader.peek()?, xml::reader::XmlEvent::EndElement { .. }) {
                let elem = deserialize_element(reader)?;
                plugin.elements.push(elem);
            }
            Ok(plugin)
        } else {
            Err("Element not found when parsing plugin".to_string())
        }
    }
}

impl YaDeserialize for SdfParams {
    fn deserialize<R: Read>(reader: &mut yaserde::de::Deserializer<R>) -> Result<Self, String> {
        let mut params = SdfParams::default();
        // deserializer code
        if let Ok(xml::reader::XmlEvent::StartElement { .. }) = reader.next_event() {
            while !matches!(reader.peek()?, xml::reader::XmlEvent::EndElement { .. }) {
                let elem = deserialize_element(reader)?;
                params.0.push(elem);
            }
            Ok(params)
        } else {
            Err("Element not found when parsing plugin".to_string())
        }
    }
}

fn serialize_element<W: Write>(
    elem: &XmlElement,
    serializer: &mut yaserde::ser::Serializer<W>,
) -> Result<(), String> {
    let mut builder = xml::writer::XmlEvent::start_element(&*elem.name);
    for (name, data) in elem.attributes.iter() {
        builder = builder.attr(xml::name::Name::local(name), data);
    }
    serializer.write(builder).map_err(|e| e.to_string())?;
    match &elem.data {
        ElementData::String(s) => {
            serializer
                .write(xml::writer::XmlEvent::Characters(s))
                .map_err(|e| e.to_string())?;
        }
        ElementData::Nested(elements) => {
            for element in elements.all().iter() {
                serialize_element(element, serializer)?;
            }
        }
    }
    serializer
        .write(xml::writer::XmlEvent::end_element())
        .map_err(|e| e.to_string())?;
    Ok(())
}

impl YaSerialize for SdfPlugin {
    fn serialize<W: Write>(
        &self,
        serializer: &mut yaserde::ser::Serializer<W>,
    ) -> Result<(), String> {
        serializer
            .write(
                xml::writer::XmlEvent::start_element("plugin")
                    .attr("name", &self.name)
                    .attr("filename", &self.filename),
            )
            .map_err(|e| e.to_string())?;
        for element in self.elements.elements.iter() {
            serialize_element(element, serializer)?;
        }
        serializer
            .write(xml::writer::XmlEvent::end_element())
            .map_err(|e| e.to_string())?;
        Ok(())
    }

    fn serialize_attributes(
        &self,
        attributes: Vec<OwnedAttribute>,
        namespace: Namespace,
    ) -> Result<(Vec<OwnedAttribute>, Namespace), String> {
        Ok((attributes, namespace))
    }
}

impl YaSerialize for SdfParams {
    fn serialize<W: Write>(
        &self,
        serializer: &mut yaserde::ser::Serializer<W>,
    ) -> Result<(), String> {
        serializer
            .write(xml::writer::XmlEvent::start_element("experimental:params"))
            .map_err(|e| e.to_string())?;
        for element in self.0.elements.iter() {
            serialize_element(element, serializer)?;
        }
        serializer
            .write(xml::writer::XmlEvent::end_element())
            .map_err(|e| e.to_string())?;
        Ok(())
    }

    fn serialize_attributes(
        &self,
        attributes: Vec<OwnedAttribute>,
        namespace: Namespace,
    ) -> Result<(Vec<OwnedAttribute>, Namespace), String> {
        Ok((attributes, namespace))
    }
}

// Frame is another wierdo. For some reason it refuses to serialize/deserialize automatically
// Hence the manual definition
// Todo(arjo): Actually implement Frame.
#[derive(Default, PartialEq, Clone, Debug, YaSerialize, YaDeserialize)]
#[yaserde(rename = "frame")]
pub struct SdfFrame {}

// Geometry should really be an enum rather than a list of Options, redefine it here
/// The shape of the visual or collision object.
#[derive(Default, PartialEq, Clone, Debug, YaSerialize, YaDeserialize)]
#[yaserde(rename = "geometry")]
pub enum SdfGeometry {
    #[yaserde(rename = "empty")]
    #[default]
    Empty,
    #[yaserde(rename = "box")]
    r#Box(SdfBoxShape),
    #[yaserde(rename = "capsule")]
    Capsule(SdfCapsuleShape),
    #[yaserde(rename = "cylinder")]
    Cylinder(SdfCylinderShape),
    #[yaserde(rename = "ellipsoid")]
    Ellipsoid(SdfEllipsoidShape),
    #[yaserde(rename = "heightmap")]
    Heightmap(SdfHeightmapShape),
    #[yaserde(rename = "image")]
    Image(SdfImageShape),
    #[yaserde(rename = "mesh")]
    Mesh(SdfMeshShape),
    #[yaserde(rename = "plane")]
    Plane(SdfPlaneShape),
    #[yaserde(rename = "polyline")]
    Polyline(SdfPolylineShape),
    #[yaserde(rename = "sphere")]
    Sphere(SdfSphereShape),
}

/// Simple implementation of pose
pub struct Pose {
    /// Translation vector
    pub translation: Vector3<f64>,
    /// Rotation
    pub rotation: Rotation3<f64>,
    /// Relative pose
    pub relative_to: String,
}

impl SdfPose {
    /// Lazily retrieve the pose as an Isometry
    /// In the event the pose is not parseable it returns a String based error.
    pub fn get_pose(&self) -> Result<Pose, String> {
        let digits = self
            .data
            .split_whitespace()
            .map(|dig| dig.parse::<f64>())
            .collect::<Result<Vec<_>, _>>()
            .map_err(|_| format!("Failed to parse pose values from {:?}", self.data))?;

        let relative_to = self.relative_to.clone().unwrap_or_default();

        if digits.len() == 6 {
            let translation = Vector3::new(digits[0], digits[1], digits[2]);
            if let Some(degrees) = self.degrees {
                let rotation = if degrees {
                    // TODO(arjo): Pose parsing code
                    use std::f64::consts::PI;
                    Rotation3::from_euler_angles(
                        digits[3] / PI * 180.0,
                        digits[4] / PI * 180.0,
                        digits[5] / PI * 180.0,
                    )
                } else {
                    Rotation3::from_euler_angles(digits[3], digits[4], digits[5])
                };
                return Ok(Pose {
                    translation,
                    rotation,
                    relative_to,
                });
            } else {
                let rotation = Rotation3::from_euler_angles(digits[3], digits[4], digits[5]);

                return Ok(Pose {
                    translation,
                    rotation,
                    relative_to,
                });
            }
        } else if digits.len() == 7 {
            let translation = Vector3::new(digits[0], digits[1], digits[2]);
            let (_norm, half_angle, axis) =
                Quaternion::new(digits[3], digits[4], digits[5], digits[6]).polar_decomposition();
            let rotation = if let Some(axis) = axis {
                Rotation3::from_axis_angle(&axis, half_angle * 2.0)
            } else {
                Rotation3::from_axis_angle(&Vector3::y_axis(), half_angle * 2.0)
            };
            return Ok(Pose {
                translation,
                rotation,
                relative_to,
            });
        }
        Err("Failed to parse pose".to_string())
    }
}

pub use yaserde::de::from_str;

#[derive(Clone, Debug, Default, PartialEq)]
pub struct Vector3d(pub Vector3<f64>);

impl TryFrom<String> for Vector3d {
    type Error = String;

    fn try_from(s: String) -> Result<Self, Self::Error> {
        let sz = s
            .split_whitespace()
            .map(|x| x.parse::<f64>())
            .collect::<Result<Vec<_>, _>>()
            .map_err(|_| "Unable to parse Vector3 into floats".to_string())?;

        if sz.len() != 3 {
            return Err("Expected 3 items in Vec3 field".to_string());
        }

        Ok(Vector3d::new(sz[0], sz[1], sz[2]))
    }
}

impl Vector3d {
    pub fn new(x: f64, y: f64, z: f64) -> Self {
        Vector3d(Vector3::new(x, y, z))
    }
}

impl YaDeserialize for Vector3d {
    fn deserialize<R: Read>(reader: &mut yaserde::de::Deserializer<R>) -> Result<Self, String> {
        // deserializer code
        reader.next_event()?;
        if let Ok(xml::reader::XmlEvent::Characters(v)) = reader.peek() {
            v.clone().try_into()
        } else {
            Err("String of elements not found while parsing Vec3".to_string())
        }
    }
}

impl YaSerialize for Vector3d {
    fn serialize<W: Write>(
        &self,
        serializer: &mut yaserde::ser::Serializer<W>,
    ) -> Result<(), String> {
        // serializer code
        let Some(yaserde_label) = serializer.get_start_event_name() else {
            return Err("vector3d is a primitive".to_string());
        };
        let struct_start_event = xml::writer::XmlEvent::start_element(yaserde_label.as_ref());

        serializer
            .write(struct_start_event)
            .map_err(|e| e.to_string())?;
        serializer
            .write(xml::writer::XmlEvent::Characters(&format!(
                "{} {} {}",
                self.0.x, self.0.y, self.0.z
            )))
            .map_err(|e| e.to_string())?;
        serializer
            .write(xml::writer::XmlEvent::end_element())
            .map_err(|e| e.to_string())?;
        Ok(())
    }

    fn serialize_attributes(
        &self,
        attributes: Vec<OwnedAttribute>,
        namespace: Namespace,
    ) -> Result<(Vec<OwnedAttribute>, Namespace), String> {
        println!("{:?}", namespace);
        Ok((attributes, namespace))
    }
}

#[derive(Clone, Debug, Default, PartialEq)]
pub struct Vector3i(pub Vector3<i64>);

impl TryFrom<String> for Vector3i {
    type Error = String;

    fn try_from(s: String) -> Result<Self, Self::Error> {
        let sz = s
            .split_whitespace()
            .map(|x| x.parse::<i64>())
            .collect::<Result<Vec<_>, _>>()
            .map_err(|_| "Unable to parse Vector3 into ints".to_string())?;

        if sz.len() != 3 {
            return Err("Expected 3 items in Vec3 field".to_string());
        }

        Ok(Vector3i::new(sz[0], sz[1], sz[2]))
    }
}

impl Vector3i {
    pub fn new(x: i64, y: i64, z: i64) -> Self {
        Self(Vector3::new(x, y, z))
    }
}

impl YaDeserialize for Vector3i {
    fn deserialize<R: Read>(reader: &mut yaserde::de::Deserializer<R>) -> Result<Self, String> {
        // deserializer code
        reader.next_event()?;
        if let Ok(xml::reader::XmlEvent::Characters(v)) = reader.peek() {
            v.clone().try_into()
        } else {
            Err("String of elements not found while parsing Vec3".to_string())
        }
    }
}

impl YaSerialize for Vector3i {
    fn serialize<W: Write>(
        &self,
        serializer: &mut yaserde::ser::Serializer<W>,
    ) -> Result<(), String> {
        // serializer code
        let Some(yaserde_label) = serializer.get_start_event_name() else {
            return Err("vector3d is a primitive".to_string());
        };
        let struct_start_event = xml::writer::XmlEvent::start_element(yaserde_label.as_ref());

        serializer
            .write(struct_start_event)
            .map_err(|e| e.to_string())?;
        serializer
            .write(xml::writer::XmlEvent::Characters(&format!(
                "{} {} {}",
                self.0.x, self.0.y, self.0.z
            )))
            .map_err(|e| e.to_string())?;
        serializer
            .write(xml::writer::XmlEvent::end_element())
            .map_err(|e| e.to_string())?;
        Ok(())
    }

    fn serialize_attributes(
        &self,
        attributes: Vec<OwnedAttribute>,
        namespace: Namespace,
    ) -> Result<(Vec<OwnedAttribute>, Namespace), String> {
        Ok((attributes, namespace))
    }
}