fop-types 0.1.1

Core types for Apache FOP Rust implementation
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
//! Gradient types for backgrounds

use crate::{Color, Point};
use std::fmt;

/// Color stop in a gradient
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ColorStop {
    /// Offset along the gradient (0.0-1.0)
    pub offset: f64,
    /// Color at this offset
    pub color: Color,
}

impl ColorStop {
    /// Create a new color stop
    #[must_use = "this returns a new value without modifying anything"]
    pub fn new(offset: f64, color: Color) -> Self {
        Self {
            offset: offset.clamp(0.0, 1.0),
            color,
        }
    }
}

/// Gradient type
#[derive(Debug, Clone, PartialEq)]
pub enum Gradient {
    /// Linear gradient from start point to end point
    Linear {
        /// Starting point of the gradient (normalized coordinates 0.0-1.0)
        start_point: Point,
        /// Ending point of the gradient (normalized coordinates 0.0-1.0)
        end_point: Point,
        /// Color stops along the gradient
        color_stops: Vec<ColorStop>,
    },
    /// Radial gradient from center with radius
    Radial {
        /// Center point of the gradient (normalized coordinates 0.0-1.0)
        center: Point,
        /// Radius of the gradient (normalized coordinate 0.0-1.0)
        radius: f64,
        /// Color stops along the gradient
        color_stops: Vec<ColorStop>,
    },
}

impl Gradient {
    /// Create a linear gradient
    #[must_use = "this returns a new value without modifying anything"]
    pub fn linear(start_point: Point, end_point: Point, color_stops: Vec<ColorStop>) -> Self {
        Self::Linear {
            start_point,
            end_point,
            color_stops,
        }
    }

    /// Create a radial gradient
    #[must_use = "this returns a new value without modifying anything"]
    pub fn radial(center: Point, radius: f64, color_stops: Vec<ColorStop>) -> Self {
        Self::Radial {
            center,
            radius: radius.max(0.0),
            color_stops,
        }
    }

    /// Create a linear gradient from an angle in degrees
    ///
    /// Angle is measured clockwise from top (0° = to top, 90° = to right, etc.)
    #[must_use = "this returns a new value without modifying anything"]
    pub fn linear_from_angle(angle_deg: f64, color_stops: Vec<ColorStop>) -> Self {
        use std::f64::consts::PI;

        // Convert angle to radians and adjust for coordinate system
        // CSS angles: 0° = to top, 90° = to right
        // We need to convert to start/end points
        let angle_rad = (angle_deg - 90.0) * PI / 180.0;

        // Calculate start and end points on a unit square
        let cos_a = angle_rad.cos();
        let sin_a = angle_rad.sin();

        // Calculate the gradient line endpoints
        let start_x = 0.5 - cos_a * 0.5;
        let start_y = 0.5 - sin_a * 0.5;
        let end_x = 0.5 + cos_a * 0.5;
        let end_y = 0.5 + sin_a * 0.5;

        use crate::Length;
        Self::Linear {
            start_point: Point::new(
                Length::from_pt(start_x * 100.0),
                Length::from_pt(start_y * 100.0),
            ),
            end_point: Point::new(
                Length::from_pt(end_x * 100.0),
                Length::from_pt(end_y * 100.0),
            ),
            color_stops,
        }
    }
}

impl fmt::Display for ColorStop {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} {}%", self.color, self.offset * 100.0)
    }
}

impl fmt::Display for Gradient {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Gradient::Linear {
                start_point,
                end_point,
                color_stops,
            } => {
                write!(f, "linear-gradient({} to {}", start_point, end_point)?;
                for stop in color_stops {
                    write!(f, ", {}", stop)?;
                }
                write!(f, ")")
            }
            Gradient::Radial {
                center,
                radius,
                color_stops,
            } => {
                write!(f, "radial-gradient(circle at {}, radius {}", center, radius)?;
                for stop in color_stops {
                    write!(f, ", {}", stop)?;
                }
                write!(f, ")")
            }
        }
    }
}

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

    #[test]
    fn test_color_stop() {
        let stop = ColorStop::new(0.5, Color::RED);
        assert_eq!(stop.offset, 0.5);
        assert_eq!(stop.color, Color::RED);

        // Test clamping
        let stop_clamped = ColorStop::new(1.5, Color::BLUE);
        assert_eq!(stop_clamped.offset, 1.0);
    }

    #[test]
    fn test_linear_gradient() {
        let stops = vec![
            ColorStop::new(0.0, Color::RED),
            ColorStop::new(1.0, Color::BLUE),
        ];

        let gradient = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(100.0), Length::from_pt(100.0)),
            stops,
        );

        match gradient {
            Gradient::Linear { color_stops, .. } => {
                assert_eq!(color_stops.len(), 2);
            }
            _ => panic!("Expected linear gradient"),
        }
    }

    #[test]
    fn test_radial_gradient() {
        let stops = vec![
            ColorStop::new(0.0, Color::WHITE),
            ColorStop::new(1.0, Color::BLACK),
        ];

        let gradient = Gradient::radial(
            Point::new(Length::from_pt(50.0), Length::from_pt(50.0)),
            0.5,
            stops,
        );

        match gradient {
            Gradient::Radial {
                radius,
                color_stops,
                ..
            } => {
                assert_eq!(radius, 0.5);
                assert_eq!(color_stops.len(), 2);
            }
            _ => panic!("Expected radial gradient"),
        }
    }

    #[test]
    fn test_linear_from_angle() {
        let stops = vec![
            ColorStop::new(0.0, Color::RED),
            ColorStop::new(1.0, Color::BLUE),
        ];

        // 0 degrees = to top
        let gradient = Gradient::linear_from_angle(0.0, stops.clone());
        assert!(matches!(gradient, Gradient::Linear { .. }));

        // 90 degrees = to right
        let gradient = Gradient::linear_from_angle(90.0, stops);
        assert!(matches!(gradient, Gradient::Linear { .. }));
    }

    #[test]
    fn test_color_stop_display() {
        let stop = ColorStop::new(0.5, Color::RED);
        assert_eq!(format!("{}", stop), "#FF0000 50%");

        let stop_zero = ColorStop::new(0.0, Color::BLACK);
        assert_eq!(format!("{}", stop_zero), "#000000 0%");

        let stop_full = ColorStop::new(1.0, Color::WHITE);
        assert_eq!(format!("{}", stop_full), "#FFFFFF 100%");
    }

    #[test]
    fn test_linear_gradient_display() {
        let stops = vec![
            ColorStop::new(0.0, Color::RED),
            ColorStop::new(1.0, Color::BLUE),
        ];

        let gradient = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(100.0), Length::from_pt(100.0)),
            stops,
        );

        let display = format!("{}", gradient);
        assert!(display.starts_with("linear-gradient("));
        assert!(display.contains("#FF0000 0%"));
        assert!(display.contains("#0000FF 100%"));
    }

    #[test]
    fn test_radial_gradient_display() {
        let stops = vec![
            ColorStop::new(0.0, Color::WHITE),
            ColorStop::new(1.0, Color::BLACK),
        ];

        let gradient = Gradient::radial(
            Point::new(Length::from_pt(50.0), Length::from_pt(50.0)),
            0.5,
            stops,
        );

        let display = format!("{}", gradient);
        assert!(display.starts_with("radial-gradient("));
        assert!(display.contains("#FFFFFF 0%"));
        assert!(display.contains("#000000 100%"));
    }
}

#[cfg(test)]
mod gradient_extra_tests {
    use super::*;
    use crate::Length;

    // --- ColorStop ---

    #[test]
    fn test_color_stop_at_zero() {
        let s = ColorStop::new(0.0, Color::BLACK);
        assert_eq!(s.offset, 0.0);
    }

    #[test]
    fn test_color_stop_at_one() {
        let s = ColorStop::new(1.0, Color::WHITE);
        assert_eq!(s.offset, 1.0);
    }

    #[test]
    fn test_color_stop_clamp_above_one() {
        let s = ColorStop::new(1.5, Color::RED);
        assert_eq!(s.offset, 1.0);
    }

    #[test]
    fn test_color_stop_clamp_below_zero() {
        let s = ColorStop::new(-0.5, Color::BLUE);
        assert_eq!(s.offset, 0.0);
    }

    #[test]
    fn test_color_stop_preserves_color() {
        let s = ColorStop::new(0.5, Color::GREEN);
        assert_eq!(s.color, Color::GREEN);
    }

    #[test]
    fn test_color_stop_display_50_pct() {
        let s = ColorStop::new(0.5, Color::RED);
        let display = format!("{}", s);
        assert!(display.contains("50%"));
        assert!(display.contains("#FF0000"));
    }

    #[test]
    fn test_color_stop_display_0_pct() {
        let s = ColorStop::new(0.0, Color::BLACK);
        assert!(format!("{}", s).contains("0%"));
    }

    #[test]
    fn test_color_stop_display_100_pct() {
        let s = ColorStop::new(1.0, Color::WHITE);
        assert!(format!("{}", s).contains("100%"));
    }

    // --- Linear gradient ---

    #[test]
    fn test_linear_gradient_has_correct_stops() {
        let stops = vec![
            ColorStop::new(0.0, Color::RED),
            ColorStop::new(0.5, Color::GREEN),
            ColorStop::new(1.0, Color::BLUE),
        ];
        let g = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(100.0), Length::ZERO),
            stops,
        );
        match g {
            Gradient::Linear { color_stops, .. } => {
                assert_eq!(color_stops.len(), 3);
                assert_eq!(color_stops[1].color, Color::GREEN);
            }
            _ => panic!("Expected linear"),
        }
    }

    #[test]
    fn test_linear_gradient_single_stop() {
        let stops = vec![ColorStop::new(0.0, Color::RED)];
        let g = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(10.0), Length::ZERO),
            stops,
        );
        match g {
            Gradient::Linear { color_stops, .. } => {
                assert_eq!(color_stops.len(), 1);
            }
            _ => panic!("Expected linear"),
        }
    }

    #[test]
    fn test_linear_gradient_empty_stops() {
        let g = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(10.0), Length::ZERO),
            vec![],
        );
        match g {
            Gradient::Linear { color_stops, .. } => {
                assert!(color_stops.is_empty());
            }
            _ => panic!("Expected linear"),
        }
    }

    // --- Radial gradient ---

    #[test]
    fn test_radial_gradient_radius_clamped_non_negative() {
        let g = Gradient::radial(
            Point::new(Length::from_pt(50.0), Length::from_pt(50.0)),
            -1.0, // negative radius should be clamped to 0
            vec![],
        );
        match g {
            Gradient::Radial { radius, .. } => {
                assert!(radius >= 0.0);
            }
            _ => panic!("Expected radial"),
        }
    }

    #[test]
    fn test_radial_gradient_center() {
        let center = Point::new(Length::from_pt(30.0), Length::from_pt(40.0));
        let g = Gradient::radial(center, 0.7, vec![]);
        match g {
            Gradient::Radial { center: c, .. } => {
                assert_eq!(c, center);
            }
            _ => panic!("Expected radial"),
        }
    }

    #[test]
    fn test_radial_gradient_stops_count() {
        let stops = vec![
            ColorStop::new(0.0, Color::WHITE),
            ColorStop::new(0.5, Color::rgb(128, 128, 128)),
            ColorStop::new(1.0, Color::BLACK),
        ];
        let g = Gradient::radial(
            Point::new(Length::from_pt(50.0), Length::from_pt(50.0)),
            0.5,
            stops,
        );
        match g {
            Gradient::Radial { color_stops, .. } => {
                assert_eq!(color_stops.len(), 3);
            }
            _ => panic!("Expected radial"),
        }
    }

    // --- linear_from_angle ---

    #[test]
    fn test_linear_from_angle_0_is_linear() {
        let g = Gradient::linear_from_angle(
            0.0,
            vec![
                ColorStop::new(0.0, Color::RED),
                ColorStop::new(1.0, Color::BLUE),
            ],
        );
        assert!(matches!(g, Gradient::Linear { .. }));
    }

    #[test]
    fn test_linear_from_angle_90_is_linear() {
        let g = Gradient::linear_from_angle(
            90.0,
            vec![
                ColorStop::new(0.0, Color::RED),
                ColorStop::new(1.0, Color::BLUE),
            ],
        );
        assert!(matches!(g, Gradient::Linear { .. }));
    }

    #[test]
    fn test_linear_from_angle_180_is_linear() {
        let g = Gradient::linear_from_angle(180.0, vec![]);
        assert!(matches!(g, Gradient::Linear { .. }));
    }

    #[test]
    fn test_linear_from_angle_360_is_linear() {
        let g = Gradient::linear_from_angle(360.0, vec![]);
        assert!(matches!(g, Gradient::Linear { .. }));
    }

    // --- Display ---

    #[test]
    fn test_linear_gradient_display_contains_linear() {
        let g = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(100.0), Length::ZERO),
            vec![
                ColorStop::new(0.0, Color::RED),
                ColorStop::new(1.0, Color::BLUE),
            ],
        );
        let s = format!("{}", g);
        assert!(s.starts_with("linear-gradient("));
    }

    #[test]
    fn test_radial_gradient_display_contains_radial() {
        let g = Gradient::radial(
            Point::new(Length::from_pt(50.0), Length::from_pt(50.0)),
            0.5,
            vec![
                ColorStop::new(0.0, Color::WHITE),
                ColorStop::new(1.0, Color::BLACK),
            ],
        );
        let s = format!("{}", g);
        assert!(s.starts_with("radial-gradient("));
    }

    #[test]
    fn test_gradient_display_contains_stop_colors() {
        let g = Gradient::linear(
            Point::new(Length::ZERO, Length::ZERO),
            Point::new(Length::from_pt(10.0), Length::ZERO),
            vec![
                ColorStop::new(0.0, Color::RED),
                ColorStop::new(1.0, Color::BLUE),
            ],
        );
        let s = format!("{}", g);
        assert!(s.contains("#FF0000"));
        assert!(s.contains("#0000FF"));
    }
}