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
// Copyright 2018 Evgeniy Reizner
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use {
ElementId,
Node,
};
/// This trait contains methods that check element's type according to the
/// [SVG spec](https://www.w3.org/TR/SVG/intro.html#Definitions).
///
/// Note that all methods works with `Node` type and will return `false`
/// if node's type is not equal to `NodeType::Element`.
///
/// # Panics
///
/// All methods panics if the node is currently mutability borrowed.
pub trait ElementType {
/// Returns true if the current node is referenced.
///
/// Referenced elements are elements that do not render by itself,
/// rather defines rendering properties for other.
///
/// List: `altGlyphDef`, `clipPath`, `cursor`, `filter`, `linearGradient`, `marker`,
/// `mask`, `pattern`, `radialGradient` and `symbol`.
///
/// Details: <https://www.w3.org/TR/SVG/struct.html#Head>
///
/// # Examples
///
/// ```
/// use svgdom::{Document, ElementType};
///
/// let doc = Document::from_str(
/// "<svg xmlns='http://www.w3.org/2000/svg'><linearGradient/></svg>").unwrap();
/// let mut iter = doc.root().descendants();
/// assert_eq!(iter.next().unwrap().is_referenced(), false); // root
/// assert_eq!(iter.next().unwrap().is_referenced(), false); // svg
/// assert_eq!(iter.next().unwrap().is_referenced(), true); // linearGradient
/// ```
fn is_referenced(&self) -> bool;
/// Returns true if the current node is a basic shape element.
///
/// List: `rect`, `circle`, `ellipse`, `line`, `polyline`, `polygon`.
///
/// Details: <https://www.w3.org/TR/SVG/shapes.html>
fn is_basic_shape(&self) -> bool;
/// Returns true if the current node is a shape element.
///
/// List: `path`, `rect`, `circle`, `ellipse`, `line`, `polyline` and `polygon`.
///
/// Details: <https://www.w3.org/TR/SVG/intro.html#TermShape>
fn is_shape(&self) -> bool;
/// Returns true if the current node is a container element.
///
/// List: `a`, `defs`, `glyph`, `g`, `marker`, `mask`, `missing-glyph`, `pattern`, `svg`,
/// `switch` and `symbol`.
///
/// Details: <https://www.w3.org/TR/SVG/intro.html#TermContainerElement>
fn is_container(&self) -> bool;
/// Returns true if the current node is a text content element.
///
/// List: `altGlyph`, `textPath`, `text`, `tref` and `tspan`.
///
/// Details: <https://www.w3.org/TR/SVG/intro.html#TermTextContentElement>
fn is_text_content(&self) -> bool;
/// Returns true if the current node is a text content child element.
///
/// List: `altGlyph`, `textPath`, `tref` and `tspan`.
///
/// Details: <https://www.w3.org/TR/SVG/intro.html#TermTextContentChildElement>
fn is_text_content_child(&self) -> bool;
/// Returns true if the current node is a graphic element.
///
/// List: `circle`, `ellipse`, `image`, `line`, `path`, `polygon`, `polyline`, `rect`,
/// `text` and `use`.
///
/// Details: <https://www.w3.org/TR/SVG/intro.html#TermGraphicsElement>
fn is_graphic(&self) -> bool;
/// Returns true if the current node is a gradient element.
///
/// List: `linearGradient`, `radialGradient`.
fn is_gradient(&self) -> bool;
/// Returns true if the current node is a [paint server].
///
/// List: `linearGradient`, `radialGradient` and `pattern`.
///
/// [paint server]: <https://www.w3.org/TR/SVG11/pservers.html#Introduction>
fn is_paint_server(&self) -> bool;
/// Returns true if the current node is a [filter primitive].
///
/// List: `feBlend`, `feColorMatrix`, `feComponentTransfer`, `feComposite`,
/// `feConvolveMatrix`, `feDiffuseLighting`, `feDisplacementMap`, `feFlood`, `feGaussianBlur`,
/// `feImage`, `feMerge`, `feMorphology`, `feOffset`, `feSpecularLighting`,
/// `feTile` and `feTurbulence`.
///
/// [filter primitive]: <https://www.w3.org/TR/SVG11/intro.html#TermFilterPrimitiveElement>
fn is_filter_primitive(&self) -> bool;
}
macro_rules! is_func {
($name:ident, $($pattern:tt)+) => (
fn $name(&self) -> bool {
if let Some(id) = self.tag_id() {
match id {
$($pattern)+ => true,
_ => false
}
} else {
false
}
}
)
}
impl ElementType for Node {
is_func!(is_referenced,
ElementId::AltGlyphDef
| ElementId::ClipPath
| ElementId::Cursor
| ElementId::Filter
| ElementId::LinearGradient
| ElementId::Marker
| ElementId::Mask
| ElementId::Pattern
| ElementId::RadialGradient
| ElementId::Symbol);
is_func!(is_basic_shape,
ElementId::Rect
| ElementId::Circle
| ElementId::Ellipse
| ElementId::Line
| ElementId::Polyline
| ElementId::Polygon);
is_func!(is_shape,
ElementId::Circle
| ElementId::Ellipse
| ElementId::Line
| ElementId::Path
| ElementId::Polygon
| ElementId::Polyline
| ElementId::Rect);
is_func!(is_container,
ElementId::A
| ElementId::Defs
| ElementId::Glyph
| ElementId::G
| ElementId::Marker
| ElementId::Mask
| ElementId::MissingGlyph
| ElementId::Pattern
| ElementId::Svg
| ElementId::Switch
| ElementId::Symbol);
is_func!(is_text_content,
ElementId::AltGlyph
| ElementId::TextPath
| ElementId::Text
| ElementId::Tref
| ElementId::Tspan);
is_func!(is_text_content_child,
ElementId::AltGlyph
| ElementId::TextPath
| ElementId::Tref
| ElementId::Tspan);
is_func!(is_graphic,
ElementId::Circle
| ElementId::Ellipse
| ElementId::Image
| ElementId::Line
| ElementId::Path
| ElementId::Polygon
| ElementId::Polyline
| ElementId::Rect
| ElementId::Text
| ElementId::Use);
is_func!(is_gradient,
ElementId::LinearGradient
| ElementId::RadialGradient);
is_func!(is_paint_server,
ElementId::LinearGradient
| ElementId::RadialGradient
| ElementId::Pattern);
is_func!(is_filter_primitive,
ElementId::FeBlend
| ElementId::FeColorMatrix
| ElementId::FeComponentTransfer
| ElementId::FeComposite
| ElementId::FeConvolveMatrix
| ElementId::FeDiffuseLighting
| ElementId::FeDisplacementMap
| ElementId::FeFlood
| ElementId::FeGaussianBlur
| ElementId::FeImage
| ElementId::FeMerge
| ElementId::FeMorphology
| ElementId::FeOffset
| ElementId::FeSpecularLighting
| ElementId::FeTile
| ElementId::FeTurbulence);
}