facet-svg 0.43.0

SVG (Scalable Vector Graphics) serialization for Facet types using facet-xml
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
//! Facet-derived types for SVG parsing and serialization.
//!
//! This crate provides strongly-typed SVG elements that can be deserialized
//! from XML using `facet-xml`.
//!
//! # Example
//!
//! ```rust
//! use facet_svg::Svg;
//!
//! let svg_str = r#"<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100">
//!     <rect x="10" y="10" width="80" height="80" fill="blue"/>
//! </svg>"#;
//!
//! let svg: Svg = facet_svg::from_str(svg_str).unwrap();
//! ```

mod tracing_macros;

use facet::Facet;
use facet_xml as xml;
use facet_xml::to_vec;

mod path;
mod points;

pub use path::{PathCommand, PathData, PathDataProxy};
pub use points::{Point, Points, PointsProxy};

/// SVG namespace URI
pub const SVG_NS: &str = "http://www.w3.org/2000/svg";

/// Error type for SVG parsing
pub type Error = facet_xml::DeserializeError<facet_xml::XmlError>;

/// Error type for SVG serialization
pub type SerializeError = facet_xml::SerializeError<facet_xml::XmlSerializeError>;

/// Deserialize an SVG from a string.
pub fn from_str<T>(s: &str) -> Result<T, Error>
where
    T: for<'a> Facet<'a>,
{
    facet_xml::from_str(s)
}

/// Serialize an SVG value to a string.
pub fn to_string<'facet, T>(value: &T) -> Result<String, SerializeError>
where
    T: Facet<'facet> + ?Sized,
{
    let bytes = to_vec(value)?;
    // SAFETY: XmlSerializer produces valid UTF-8
    Ok(String::from_utf8(bytes).expect("XmlSerializer produces valid UTF-8"))
}

/// Root SVG element
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename = "svg",
    rename_all = "camelCase",
    skip_all_unless_truthy
)]
pub struct Svg {
    // Note: xmlns is handled by ns_all, not as a separate field
    #[facet(xml::attribute)]
    pub width: Option<String>,
    #[facet(xml::attribute)]
    pub height: Option<String>,
    #[facet(xml::attribute)]
    pub view_box: Option<String>,
    #[facet(flatten)]
    pub children: Vec<SvgNode>,
}

/// Any SVG node we care about
#[derive(Facet, Debug, Clone)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg")]
#[repr(u8)]
pub enum SvgNode {
    G(Group),
    Defs(Defs),
    Style(Style),
    Rect(Rect),
    Circle(Circle),
    Ellipse(Ellipse),
    Line(Line),
    Path(Path),
    Polygon(Polygon),
    Polyline(Polyline),
    Text(Text),
    Use(Use),
    Image(Image),
    Title(Title),
    Desc(Desc),
    Symbol(Symbol),
    Filter(Filter),
    Marker(Marker),
    LinearGradient(LinearGradient),
}

/// SVG group element (`<g>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct Group {
    #[facet(xml::attribute)]
    pub id: Option<String>,
    #[facet(xml::attribute)]
    pub class: Option<String>,
    #[facet(xml::attribute)]
    pub transform: Option<String>,
    #[facet(flatten)]
    pub children: Vec<SvgNode>,
}

/// SVG defs element (`<defs>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg")]
pub struct Defs {
    #[facet(flatten)]
    pub children: Vec<SvgNode>,
}

/// SVG style element (`<style>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(skip_all_unless_truthy)]
pub struct Style {
    #[facet(xml::attribute, rename = "type")]
    pub type_: Option<String>,
    #[facet(xml::text)]
    pub content: Option<String>,
}

/// SVG rect element (`<rect>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Rect {
    #[facet(xml::attribute)]
    pub x: Option<f64>,
    #[facet(xml::attribute)]
    pub y: Option<f64>,
    #[facet(xml::attribute)]
    pub width: Option<f64>,
    #[facet(xml::attribute)]
    pub height: Option<f64>,
    #[facet(xml::attribute)]
    pub rx: Option<f64>,
    #[facet(xml::attribute)]
    pub ry: Option<f64>,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG circle element (`<circle>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Circle {
    #[facet(xml::attribute)]
    pub cx: Option<f64>,
    #[facet(xml::attribute)]
    pub cy: Option<f64>,
    #[facet(xml::attribute)]
    pub r: Option<f64>,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG ellipse element (`<ellipse>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Ellipse {
    #[facet(xml::attribute)]
    pub cx: Option<f64>,
    #[facet(xml::attribute)]
    pub cy: Option<f64>,
    #[facet(xml::attribute)]
    pub rx: Option<f64>,
    #[facet(xml::attribute)]
    pub ry: Option<f64>,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG line element (`<line>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Line {
    #[facet(xml::attribute)]
    pub x1: Option<f64>,
    #[facet(xml::attribute)]
    pub y1: Option<f64>,
    #[facet(xml::attribute)]
    pub x2: Option<f64>,
    #[facet(xml::attribute)]
    pub y2: Option<f64>,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG path element (`<path>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Path {
    #[facet(xml::attribute, proxy = PathDataProxy)]
    pub d: Option<PathData>,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG polygon element (`<polygon>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Polygon {
    #[facet(xml::attribute, proxy = PointsProxy)]
    pub points: Points,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG polyline element (`<polyline>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Polyline {
    #[facet(xml::attribute, proxy = PointsProxy)]
    pub points: Points,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_dasharray: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG text element (`<text>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "kebab-case",
    skip_all_unless_truthy
)]
pub struct Text {
    #[facet(xml::attribute)]
    pub x: Option<f64>,
    #[facet(xml::attribute)]
    pub y: Option<f64>,
    #[facet(xml::attribute)]
    pub transform: Option<String>,
    #[facet(xml::attribute)]
    pub fill: Option<String>,
    #[facet(xml::attribute)]
    pub stroke: Option<String>,
    #[facet(xml::attribute)]
    pub stroke_width: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
    #[facet(xml::attribute)]
    pub font_family: Option<String>,
    #[facet(xml::attribute)]
    pub font_style: Option<String>,
    #[facet(xml::attribute)]
    pub font_weight: Option<String>,
    #[facet(xml::attribute)]
    pub font_size: Option<String>,
    #[facet(xml::attribute)]
    pub text_anchor: Option<String>,
    #[facet(xml::attribute)]
    pub dominant_baseline: Option<String>,
    #[facet(xml::text)]
    pub content: Option<String>,
}

/// SVG use element (`<use>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct Use {
    #[facet(xml::attribute)]
    pub x: Option<f64>,
    #[facet(xml::attribute)]
    pub y: Option<f64>,
    #[facet(xml::attribute)]
    pub width: Option<f64>,
    #[facet(xml::attribute)]
    pub height: Option<f64>,
    #[facet(xml::attribute, rename = "xlink:href")]
    pub href: Option<String>,
}

/// SVG image element (`<image>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct Image {
    #[facet(xml::attribute)]
    pub x: Option<f64>,
    #[facet(xml::attribute)]
    pub y: Option<f64>,
    #[facet(xml::attribute)]
    pub width: Option<f64>,
    #[facet(xml::attribute)]
    pub height: Option<f64>,
    #[facet(xml::attribute)]
    pub href: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
}

/// SVG title element (`<title>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg")]
pub struct Title {
    #[facet(xml::text)]
    pub content: Option<String>,
}

/// SVG description element (`<desc>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg")]
pub struct Desc {
    #[facet(xml::text)]
    pub content: Option<String>,
}

/// SVG symbol element (`<symbol>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "camelCase",
    skip_all_unless_truthy
)]
pub struct Symbol {
    #[facet(xml::attribute)]
    pub id: Option<String>,
    #[facet(xml::attribute)]
    pub view_box: Option<String>,
    #[facet(xml::attribute)]
    pub width: Option<String>,
    #[facet(xml::attribute)]
    pub height: Option<String>,
    #[facet(flatten)]
    pub children: Vec<SvgNode>,
}

/// SVG filter element (`<filter>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct Filter {
    #[facet(xml::attribute)]
    pub id: Option<String>,
    #[facet(flatten)]
    pub children: Vec<FilterPrimitive>,
}

/// Filter primitive elements
#[derive(Facet, Debug, Clone)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg")]
#[repr(u8)]
pub enum FilterPrimitive {
    #[facet(rename = "feGaussianBlur")]
    FeGaussianBlur(FeGaussianBlur),
}

/// feGaussianBlur filter primitive
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct FeGaussianBlur {
    #[facet(xml::attribute)]
    pub r#in: Option<String>,
    #[facet(xml::attribute, rename = "stdDeviation")]
    pub std_deviation: Option<String>,
}

/// SVG marker element (`<marker>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(
    xml::ns_all = "http://www.w3.org/2000/svg",
    rename_all = "camelCase",
    skip_all_unless_truthy
)]
pub struct Marker {
    #[facet(xml::attribute)]
    pub id: Option<String>,
    #[facet(xml::attribute)]
    pub marker_width: Option<String>,
    #[facet(xml::attribute)]
    pub marker_height: Option<String>,
    #[facet(xml::attribute, rename = "refX")]
    pub ref_x: Option<String>,
    #[facet(xml::attribute, rename = "refY")]
    pub ref_y: Option<String>,
    #[facet(xml::attribute)]
    pub orient: Option<String>,
    #[facet(flatten)]
    pub children: Vec<SvgNode>,
}

/// SVG linearGradient element (`<linearGradient>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct LinearGradient {
    #[facet(xml::attribute)]
    pub id: Option<String>,
    #[facet(xml::attribute)]
    pub x1: Option<String>,
    #[facet(xml::attribute)]
    pub y1: Option<String>,
    #[facet(xml::attribute)]
    pub x2: Option<String>,
    #[facet(xml::attribute)]
    pub y2: Option<String>,
    #[facet(xml::elements, rename = "stop")]
    pub stops: Vec<GradientStop>,
}

/// Gradient stop element (`<stop>`)
#[derive(Facet, Debug, Clone, Default)]
#[facet(xml::ns_all = "http://www.w3.org/2000/svg", skip_all_unless_truthy)]
pub struct GradientStop {
    #[facet(xml::attribute)]
    pub offset: Option<String>,
    #[facet(xml::attribute)]
    pub style: Option<String>,
    #[facet(xml::attribute, rename = "stop-color")]
    pub stop_color: Option<String>,
    #[facet(xml::attribute, rename = "stop-opacity")]
    pub stop_opacity: Option<String>,
}

// Re-export XML utilities for convenience
pub use facet_xml;

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

    #[test]
    fn test_attributes_are_parsed() {
        let xml = r#"<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
            <path d="M10,10L50,50" stroke="black"/>
        </svg>"#;

        let svg: Svg = from_str(xml).unwrap();

        println!("Parsed SVG: {:?}", svg);

        // These should NOT be None!
        assert!(svg.view_box.is_some(), "viewBox should be parsed");

        if let Some(SvgNode::Path(path)) = svg.children.first() {
            println!("Parsed Path: {:?}", path);
            assert!(path.d.is_some(), "path d attribute should be parsed");
            assert!(
                path.stroke.is_some(),
                "path stroke attribute should be parsed"
            );
        } else {
            panic!("Expected a Path element");
        }
    }

    #[test]
    fn test_svg_float_tolerance() {
        use facet_assert::{SameOptions, SameReport, check_same_with_report};

        // Simulate C vs Rust precision - C has 3 decimals, Rust has 10
        // (Without style difference to isolate float tolerance test)
        let c_svg = r#"<svg xmlns="http://www.w3.org/2000/svg">
            <path d="M118.239,208.239L226.239,208.239Z"/>
        </svg>"#;

        let rust_svg = r#"<svg xmlns="http://www.w3.org/2000/svg">
            <path d="M118.2387401575,208.2387401575L226.2387401575,208.2387401575Z"/>
        </svg>"#;

        let c: Svg = from_str(c_svg).unwrap();
        let rust: Svg = from_str(rust_svg).unwrap();

        eprintln!("C SVG: {:?}", c);
        eprintln!("Rust SVG: {:?}", rust);

        let tolerance = 0.002;
        let options = SameOptions::new().float_tolerance(tolerance);

        let result = check_same_with_report(&c, &rust, options);

        match &result {
            SameReport::Same => eprintln!("Result: Same"),
            SameReport::Different(report) => {
                eprintln!("Result: Different");
                eprintln!("XML diff:\n{}", report.render_ansi_xml());
            }
            SameReport::Opaque { type_name } => eprintln!("Result: Opaque({})", type_name),
        }

        assert!(
            matches!(result, SameReport::Same),
            "SVG values within float tolerance should be considered Same"
        );
    }

    #[test]
    fn test_polygon_points_serialization() {
        let polygon = Polygon {
            points: crate::points::Points::parse("50,10 90,90 10,90").unwrap(),
            fill: Some("lime".to_string()),
            stroke: None,
            stroke_width: None,
            stroke_dasharray: None,
            style: None,
        };

        let xml = to_string(&polygon).unwrap();

        // The points attribute should be present
        assert!(
            xml.contains("points="),
            "Serialized polygon should contain points attribute, got: {}",
            xml
        );
        // Check the actual value
        assert!(
            xml.contains(r#"points="50,10 90,90 10,90""#),
            "Points attribute should have correct value, got: {}",
            xml
        );
    }
}