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 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
use std::path::PathBuf;
use std::ops::Deref;
// self
use geom::*;
use super::attributes::*;
/// Node's kind.
#[allow(missing_docs)]
#[derive(Clone, Debug)]
pub enum NodeKind {
Svg(Svg),
Defs,
LinearGradient(LinearGradient),
RadialGradient(RadialGradient),
ClipPath(ClipPath),
Mask(Mask),
Pattern(Pattern),
Filter(Filter),
Path(Path),
Text(Text),
Image(Image),
Group(Group),
}
impl NodeKind {
/// Returns node's ID.
///
/// If a current node doesn't support ID - an empty string
/// will be returned.
pub fn id(&self) -> &str {
match *self {
NodeKind::Svg(_) => "",
NodeKind::Defs => "",
NodeKind::LinearGradient(ref e) => e.id.as_str(),
NodeKind::RadialGradient(ref e) => e.id.as_str(),
NodeKind::ClipPath(ref e) => e.id.as_str(),
NodeKind::Mask(ref e) => e.id.as_str(),
NodeKind::Pattern(ref e) => e.id.as_str(),
NodeKind::Filter(ref e) => e.id.as_str(),
NodeKind::Path(ref e) => e.id.as_str(),
NodeKind::Text(ref e) => e.id.as_str(),
NodeKind::Image(ref e) => e.id.as_str(),
NodeKind::Group(ref e) => e.id.as_str(),
}
}
/// Returns node's transform.
///
/// If a current node doesn't support transformation - a default
/// transform will be returned.
pub fn transform(&self) -> Transform {
match *self {
NodeKind::Svg(_) => Transform::default(),
NodeKind::Defs => Transform::default(),
NodeKind::LinearGradient(ref e) => e.transform,
NodeKind::RadialGradient(ref e) => e.transform,
NodeKind::ClipPath(ref e) => e.transform,
NodeKind::Mask(_) => Transform::default(),
NodeKind::Pattern(ref e) => e.transform,
NodeKind::Filter(_) => Transform::default(),
NodeKind::Path(ref e) => e.transform,
NodeKind::Text(ref e) => e.transform,
NodeKind::Image(ref e) => e.transform,
NodeKind::Group(ref e) => e.transform,
}
}
}
/// An SVG root element.
#[derive(Clone, Copy, Debug)]
pub struct Svg {
/// Image size.
///
/// Size of an image that should be created to fit the SVG.
///
/// `width` and `height` in SVG.
pub size: Size,
/// SVG viewbox.
///
/// Specifies which part of the SVG image should be rendered.
///
/// `viewBox` and `preserveAspectRatio` in SVG.
pub view_box: ViewBox,
}
/// A path element.
#[derive(Clone, Debug)]
pub struct Path {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Isn't automatically generated.
/// Can be empty.
pub id: String,
/// Element transform.
pub transform: Transform,
/// Element visibility.
pub visibility: Visibility,
/// Fill style.
pub fill: Option<Fill>,
/// Stroke style.
pub stroke: Option<Stroke>,
/// Segments list.
///
/// All segments are in absolute coordinates.
pub segments: Vec<PathSegment>,
}
/// A text element.
///
/// `text` element in SVG.
#[derive(Clone, Debug)]
pub struct Text {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Isn't automatically generated.
/// Can be empty.
pub id: String,
/// Element transform.
pub transform: Transform,
/// Rotate list.
pub rotate: Option<NumberList>,
/// A list of text chunks.
pub chunks: Vec<TextChunk>,
}
/// A text chunk.
///
/// Contains position and anchor of the next
/// [text chunk](https://www.w3.org/TR/SVG11/text.html#TextChunk).
///
/// Doesn't represented in SVG directly. Usually, it's a first `tspan` or text node
/// and any `tspan` that defines either `x` or `y` coordinates.
#[derive(Clone, Debug)]
pub struct TextChunk {
/// A list of absolute positions along the X-axis.
pub x: Option<NumberList>,
/// A list of absolute positions along the Y-axis.
pub y: Option<NumberList>,
/// A list of relative positions along the X-axis.
pub dx: Option<NumberList>,
/// A list of relative positions along the Y-axis.
pub dy: Option<NumberList>,
/// A text anchor/align.
pub anchor: TextAnchor,
/// A list of text spans.
pub spans: Vec<TextSpan>,
}
/// A text span.
///
/// `tspan` element in SVG.
#[derive(Clone, Debug)]
pub struct TextSpan {
/// Element visibility.
pub visibility: Visibility,
/// Fill style.
pub fill: Option<Fill>,
/// Stroke style.
pub stroke: Option<Stroke>,
/// Font description.
pub font: Font,
/// Text decoration.
///
/// Unlike `text-decoration` attribute from the SVG, this one has all styles resolved.
/// Basically, by the SVG `text-decoration` attribute can be defined on `tspan` element
/// and on any parent element. And all definitions should be combined.
/// The one that was defined by `tspan` uses the `tspan` style itself.
/// The one that was defined by any parent node uses the `text` element style.
/// So it's pretty hard to resolve.
///
/// This property has all this stuff resolved.
pub decoration: TextDecoration,
/// An actual text line.
///
/// SVG doesn't support multiline text, so this property doesn't have a new line inside of it.
/// All the spaces are already trimmed or preserved, depending on the `xml:space` attribute.
/// All characters references are already resolved, so there is no `>` or `P`.
/// So this text should be rendered as is, without any postprocessing.
pub text: String,
}
/// A raster image element.
///
/// `image` element in SVG.
#[derive(Clone, Debug)]
pub struct Image {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Isn't automatically generated.
/// Can be empty.
pub id: String,
/// Element transform.
pub transform: Transform,
/// Element visibility.
pub visibility: Visibility,
/// An image rectangle in which it should be fit.
///
/// Combination of the `x`, `y`, `width`, `height` and `preserveAspectRatio`
/// attributes.
pub view_box: ViewBox,
/// Image data.
pub data: ImageData,
/// Image data kind.
pub format: ImageFormat,
}
/// A raster image container.
#[derive(Clone, Debug)]
pub enum ImageData {
/// Path to a PNG, JPEG or SVG(Z) image.
///
/// Preprocessor will check that the file exist, but because it can be removed later,
/// so there is no guarantee that this path is valid.
///
/// The path may be relative.
Path(PathBuf),
/// Image raw data.
///
/// It's not a decoded image data, but the data that was decoded from base64.
/// So you still need a PNG, JPEG and SVG(Z) decoding libraries.
Raw(Vec<u8>),
}
/// An image codec.
#[allow(missing_docs)]
#[derive(Clone, Copy, PartialEq, Debug)]
pub enum ImageFormat {
PNG,
JPEG,
SVG,
}
/// A group container.
///
/// The preprocessor will remove all groups that don't impact rendering.
/// Those that left is just an indicator that a new canvas should be created.
///
/// `g` element in SVG.
#[derive(Clone, Debug)]
pub struct Group {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Isn't automatically generated.
/// Can be empty.
pub id: String,
/// Element transform.
pub transform: Transform,
/// Group opacity.
///
/// After the group is rendered we should combine
/// it with a parent group using the specified opacity.
pub opacity: Option<Opacity>,
/// Element clip path.
pub clip_path: Option<String>,
/// Element mask.
pub mask: Option<String>,
/// Element filter.
pub filter: Option<String>,
}
/// A generic gradient.
#[derive(Clone, Debug)]
pub struct BaseGradient {
/// Coordinate system units.
///
/// `gradientUnits` in SVG.
pub units: Units,
/// Gradient transform.
///
/// `gradientTransform` in SVG.
pub transform: Transform,
/// Gradient spreading method.
///
/// `spreadMethod` in SVG.
pub spread_method: SpreadMethod,
/// A list of `stop` elements.
pub stops: Vec<Stop>,
}
/// A linear gradient.
///
/// `linearGradient` element in SVG.
#[allow(missing_docs)]
#[derive(Clone, Debug)]
pub struct LinearGradient {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Can't be empty.
pub id: String,
pub x1: f64,
pub y1: f64,
pub x2: f64,
pub y2: f64,
/// Base gradient data.
pub base: BaseGradient,
}
impl Deref for LinearGradient {
type Target = BaseGradient;
fn deref(&self) -> &Self::Target {
&self.base
}
}
/// A radial gradient.
///
/// `radialGradient` element in SVG.
#[allow(missing_docs)]
#[derive(Clone, Debug)]
pub struct RadialGradient {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Can't be empty.
pub id: String,
pub cx: f64,
pub cy: f64,
pub r: f64,
pub fx: f64,
pub fy: f64,
/// Base gradient data.
pub base: BaseGradient,
}
impl Deref for RadialGradient {
type Target = BaseGradient;
fn deref(&self) -> &Self::Target {
&self.base
}
}
/// Gradient's stop element.
///
/// `stop` element in SVG.
#[derive(Clone, Copy, Debug)]
pub struct Stop {
/// Gradient stop offset.
///
/// `offset` in SVG.
pub offset: StopOffset,
/// Gradient stop color.
///
/// `stop-color` in SVG.
pub color: Color,
/// Gradient stop opacity.
///
/// `stop-opacity` in SVG.
pub opacity: Opacity,
}
/// A clip-path element.
///
/// `clipPath` element in SVG.
#[derive(Clone, Debug)]
pub struct ClipPath {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Can't be empty.
pub id: String,
/// Coordinate system units.
///
/// `clipPathUnits` in SVG.
pub units: Units,
/// Clip path transform.
///
/// `transform` in SVG.
pub transform: Transform,
/// Additional clip path.
///
/// `clip-path` in SVG.
pub clip_path: Option<String>,
}
/// A mask element.
///
/// `mask` element in SVG.
#[derive(Clone, Debug)]
pub struct Mask {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Can't be empty.
pub id: String,
/// Coordinate system units.
///
/// `maskUnits` in SVG.
pub units: Units,
/// Content coordinate system units.
///
/// `maskContentUnits` in SVG.
pub content_units: Units,
/// Mask rectangle.
///
/// `x`, `y`, `width` and `height` in SVG.
pub rect: Rect,
/// Additional mask.
///
/// `mask` in SVG.
pub mask: Option<String>,
}
/// A pattern element.
///
/// `pattern` element in SVG.
#[derive(Clone, Debug)]
pub struct Pattern {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Can't be empty.
pub id: String,
/// Coordinate system units.
///
/// `patternUnits` in SVG.
pub units: Units,
// TODO: should not be accessible when `viewBox` is present.
/// Content coordinate system units.
///
/// `patternContentUnits` in SVG.
pub content_units: Units,
/// Pattern transform.
///
/// `patternTransform` in SVG.
pub transform: Transform,
/// Pattern rectangle.
///
/// `x`, `y`, `width` and `height` in SVG.
pub rect: Rect,
/// Pattern viewbox.
pub view_box: Option<ViewBox>,
}
/// A filter element.
///
/// `filter` element in the SVG.
#[derive(Clone, Debug)]
pub struct Filter {
/// Element's ID.
///
/// Taken from the SVG itself.
/// Can't be empty.
pub id: String,
/// Region coordinate system units.
///
/// `filterUnits` in the SVG.
pub units: Units,
/// Content coordinate system units.
///
/// `primitiveUnits` in the SVG.
pub primitive_units: Units,
/// Filter region.
///
/// `x`, `y`, `width` and `height` in the SVG.
pub rect: Rect,
/// A list of filter primitives.
pub children: Vec<FilterPrimitive>,
}
/// A filter primitive element.
#[derive(Clone, Debug)]
pub struct FilterPrimitive {
/// `x` coordinate of the filter subregion.
pub x: Option<f64>,
/// `y` coordinate of the filter subregion.
pub y: Option<f64>,
/// The filter subregion width.
pub width: Option<f64>, // TODO: PositiveNumber
/// The filter subregion height.
pub height: Option<f64>, // TODO: PositiveNumber
/// Color interpolation mode.
///
/// `color-interpolation-filters` in the SVG.
pub color_interpolation: ColorInterpolation,
/// Identifies input for the given filter primitive.
///
/// `in` in the SVG.
pub filter_input: Option<FilterInput>,
/// Assigned name for this filter primitive.
///
/// `result` in the SVG.
pub filter_result: Option<String>,
/// Filter primitive kind.
pub kind: FilterKind,
}
/// A filter kind.
#[allow(missing_docs)]
#[derive(Clone, Debug)]
pub enum FilterKind {
FeBlend(FeBlend),
FeComposite(FeComposite),
FeFlood(FeFlood),
FeGaussianBlur(FeGaussianBlur),
FeImage(FeImage),
FeMerge(FeMerge),
FeOffset(FeOffset),
FeTile,
}
/// A Gaussian blur filter primitive.
///
/// `feGaussianBlur` element in the SVG.
#[derive(Clone, Copy, Debug)]
pub struct FeGaussianBlur {
/// A standard deviation along the X-axis.
///
/// `stdDeviation` in the SVG.
pub std_dev_x: PositiveNumber,
/// A standard deviation along the Y-axis.
///
/// `stdDeviation` in the SVG.
pub std_dev_y: PositiveNumber,
}
/// An offset filter primitive.
///
/// `feOffset` element in the SVG.
#[derive(Clone, Copy, Debug)]
pub struct FeOffset {
/// The amount to offset the input graphic along the X-axis.
pub dx: f64,
/// The amount to offset the input graphic along the Y-axis.
pub dy: f64,
}
/// An images blending mode.
#[allow(missing_docs)]
#[derive(Clone, Copy, PartialEq, Debug)]
pub enum FeBlendMode {
Normal,
Multiply,
Screen,
Darken,
Lighten,
}
impl ToString for FeBlendMode {
fn to_string(&self) -> String {
match self {
FeBlendMode::Normal => "normal",
FeBlendMode::Multiply => "multiply",
FeBlendMode::Screen => "screen",
FeBlendMode::Darken => "darken",
FeBlendMode::Lighten => "lighten",
}.to_string()
}
}
/// A blend filter primitive.
///
/// `feBlend` element in the SVG.
#[derive(Clone, Debug)]
pub struct FeBlend {
/// A blending mode.
///
/// `mode` in the SVG.
pub mode: FeBlendMode,
/// Identifies input for the given filter primitive.
///
/// `in2` in the SVG.
pub filter_input2: Option<FilterInput>,
}
// TODO: can't have an `in` attribute
/// A flood filter primitive.
///
/// `feFlood` element in the SVG.
#[derive(Clone, Copy, Debug)]
pub struct FeFlood {
/// A flood color.
///
/// `flood-color` in the SVG.
pub color: Color,
/// A flood opacity.
///
/// `flood-opacity` in the SVG.
pub opacity: Opacity,
}
/// An images compositing operation.
#[allow(missing_docs)]
#[derive(Clone, Copy, PartialEq, Debug)]
pub enum FeCompositeOperator {
Over,
In,
Out,
Atop,
Xor,
Arithmetic,
}
impl ToString for FeCompositeOperator {
fn to_string(&self) -> String {
match self {
FeCompositeOperator::Over => "over",
FeCompositeOperator::In => "in",
FeCompositeOperator::Out => "out",
FeCompositeOperator::Atop => "atop",
FeCompositeOperator::Xor => "xor",
FeCompositeOperator::Arithmetic => "arithmetic",
}.to_string()
}
}
/// A composite filter primitive.
///
/// `feComposite` element in the SVG.
#[derive(Clone, Debug)]
pub struct FeComposite {
/// A compositing operation.
///
/// `operator` in the SVG.
pub operator: FeCompositeOperator,
/// Identifies input for the given filter primitive.
///
/// `in2` in the SVG.
pub filter_input2: Option<FilterInput>,
}
// TODO: can't have an `in` attribute
/// A merge filter primitive.
///
/// `feMerge` element in the SVG.
#[derive(Clone, Debug)]
pub struct FeMerge {
/// List of input layers that should be merged.
///
/// List of `feMergeNode`'s in the SVG.
pub inputs: Vec<Option<FilterInput>>,
}
/// Kind of the `feImage` data.
#[derive(Clone, Debug)]
pub enum FeImageKind {
/// Empty image.
///
/// Unlike the `image` element, `feImage` can be without the `href` attribute.
/// In this case the filter primitive is an empty canvas.
/// And we can't remove it, because its `result` can be used.
None,
/// An image data.
Image(ImageData, ImageFormat),
/// A reference to an SVG object.
///
/// `feImage` can reference any SVG object, just like `use` element.
/// But we can't resolve `use` in this case.
///
/// Not supported yet.
Use(String),
}
// TODO: can't have an `in` attribute
/// An image filter primitive.
///
/// `feImage` element in the SVG.
#[derive(Clone, Debug)]
pub struct FeImage {
/// Value of the `preserveAspectRatio` attribute.
pub aspect: AspectRatio,
/// Image data.
pub data: FeImageKind,
}