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
use std::{
collections::HashMap,
fmt::{self, Write},
};
/// A shorthand to draw rounded corners, see `PathData::arc`.
#[derive(Debug, Clone, Copy)]
pub enum Arc {
EastToNorth,
EastToSouth,
NorthToEast,
NorthToWest,
SouthToEast,
SouthToWest,
WestToNorth,
WestToSouth,
}
/// Selects the direction in which arrows on positive direction horizontal
/// lines point.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum HDir {
LTR,
RTL,
}
impl HDir {
/// Invert the direction.
#[must_use]
pub fn invert(self) -> Self {
match self {
HDir::LTR => HDir::RTL,
HDir::RTL => HDir::LTR,
}
}
}
impl Default for HDir {
fn default() -> Self {
Self::LTR
}
}
/// A builder-struct for SVG-Paths
pub struct PathData {
text: String,
h_dir: HDir,
}
impl PathData {
/// Construct a empty `PathData`
#[must_use]
pub fn new(h_dir: HDir) -> Self {
Self {
text: String::new(),
h_dir,
}
}
/// Convert to a `Element` of type `path` and fill it's data-attribute
#[must_use]
pub fn into_path(self) -> Element {
Element::new("path").set("d", &self.text)
}
/// Move the cursor to this absolute position without drawing anything
#[must_use]
pub fn move_to(mut self, x: i64, y: i64) -> Self {
write!(self.text, " M {x} {y}").unwrap();
self
}
/// Move the cursor relative to the current position without drawing anything
#[must_use]
pub fn move_rel(mut self, x: i64, y: i64) -> Self {
write!(self.text, " m {x} {y}").unwrap();
self
}
/// Draw a line from the cursor's current location to the given relative position
#[must_use]
pub fn line_rel(mut self, x: i64, y: i64) -> Self {
write!(self.text, " l {x} {y}").unwrap();
self
}
/// Draw a horizontal section from the cursor's current position
#[must_use]
pub fn horizontal(mut self, h: i64) -> Self {
write!(self.text, " h {h}").unwrap();
// Add an arrow for long stretches
match (h > 50, h < -50, self.h_dir) {
(true, _, HDir::LTR) => self
.move_rel(-(h / 2 - 3), 0)
.line_rel(-5, -5)
.move_rel(0, 10)
.line_rel(5, -5)
.move_rel(h / 2 - 3, 0),
(true, _, HDir::RTL) => self
.move_rel(-(h / 2 + 3), 0)
.line_rel(5, -5)
.move_rel(0, 10)
.line_rel(-5, -5)
.move_rel(h / 2 + 3, 0),
(_, true, HDir::LTR) => self
.move_rel(-(h / 2 - 3), 0)
.line_rel(5, -5)
.move_rel(0, 10)
.line_rel(-5, -5)
.move_rel(h / 2 - 3, 0),
(_, true, HDir::RTL) => self
.move_rel(-(h / 2 + 3), 0)
.line_rel(-5, -5)
.move_rel(0, 10)
.line_rel(5, -5)
.move_rel(h / 2 + 3, 0),
(false, false, _) => self,
}
}
/// Draw a vertical section from the cursor's current position
#[must_use]
pub fn vertical(mut self, h: i64) -> Self {
write!(self.text, " v {h}").unwrap();
// Add an arrow for long stretches
if h > 50 {
self.move_rel(0, -(h / 2 - 3))
.line_rel(-5, -5)
.move_rel(10, 0)
.line_rel(-5, 5)
.move_rel(0, h / 2 - 3)
} else if h < -50 {
self.move_rel(0, -(h / 2 - 3))
.line_rel(-5, 5)
.move_rel(10, 0)
.line_rel(-5, -5)
.move_rel(0, h / 2 - 3)
} else {
self
}
}
/// Draw a rounded corner using the given radius and direction
#[must_use]
pub fn arc(mut self, radius: i64, kind: Arc) -> Self {
let (sweep, x, y) = match kind {
Arc::EastToNorth => (1, -radius, -radius),
Arc::EastToSouth => (0, -radius, radius),
Arc::NorthToEast => (0, radius, radius),
Arc::NorthToWest => (1, -radius, radius),
Arc::SouthToEast => (1, radius, -radius),
Arc::SouthToWest => (0, -radius, -radius),
Arc::WestToNorth => (0, radius, -radius),
Arc::WestToSouth => (1, radius, radius),
};
write!(self.text, " a {radius} {radius} 0 0 {sweep} {x} {y}").unwrap();
self
}
}
impl fmt::Display for PathData {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
write!(f, "{}", self.text)
}
}
/// A pseudo-SVG Element
///
/// ```
/// use railroad::notactuallysvg as svg;
///
/// let e = svg::Element::new("g")
/// .add(svg::Element::new("rect")
/// .set("class", "important")
/// .set("x", &15))
/// .add(svg::PathData::new(svg::HDir::LTR)
/// .move_to(5, 5)
/// .line_rel(10, 20)
/// .into_path());
/// let serialized = e.to_string();
/// assert_eq!(serialized, "<g>\n<rect class=\"important\" x=\"15\"/>\n<path d=\" M 5 5 l 10 20\"/>\n</g>\n");
/// ```
#[derive(Debug, Clone)]
pub struct Element {
name: String,
attributes: HashMap<String, String>,
text: Option<String>,
children: Vec<Element>,
siblings: Vec<Element>,
}
impl Element {
/// Construct a new `Element` of type `name`.
pub fn new<T>(name: &T) -> Self
where T: ToString + ?Sized
{
Self {
name: name.to_string(),
attributes: HashMap::default(),
text: None,
children: Vec::default(),
siblings: Vec::default(),
}
}
/// Set this Element's attribute `key` to `value`
#[must_use]
pub fn set<K, V>(mut self, key: &K, value: &V) -> Self
where K: ToString + ?Sized,
V: ToString + ?Sized,
{
self.attributes.insert(key.to_string(), value.to_string());
self
}
/// Set all attributes via these `key`:`value`-pairs
#[must_use]
pub fn set_all(
mut self,
iter: impl IntoIterator<Item = (impl ToString, impl ToString)>,
) -> Self {
self.attributes.extend(
iter.into_iter()
.map(|(k, v)| (k.to_string(), v.to_string())),
);
self
}
/// Set the text within the opening and closing tag of this Element.
///
/// The text is automatically HTML-escaped. It is written before any children.
#[must_use]
pub fn text(mut self, text: &str) -> Self {
self.text = Some(htmlescape::encode_minimal(text));
self
}
/// Set the text within the opening and closing tag of this Element.
///
/// The text is NOT automatically HTML-escaped.
#[must_use]
pub fn raw_text<T>(mut self, text: &T) -> Self
where
T: ToString + ?Sized,
{
self.text = Some(text.to_string());
self
}
/// Add a child to this Element
///
/// Children is written within the opening and closing tag of this Element.
#[allow(clippy::should_implement_trait)]
#[must_use]
pub fn add(mut self, e: Self) -> Self {
self.children.push(e);
self
}
/// Add a child to this Element
///
/// Children is written within the opening and closing tag of this Element.
pub fn push(&mut self, e: Self) -> &mut Self {
self.children.push(e);
self
}
/// Add a sibling to this Element
///
/// Siblings is written after the closing tag of this Element.
#[must_use]
pub fn append(mut self, e: Self) -> Self {
self.siblings.push(e);
self
}
#[cfg(not(feature = "visual-debug"))]
#[allow(unused_variables)]
#[doc(hidden)]
#[must_use]
pub fn debug(self, name: &str, x: i64, y: i64, n: &dyn super::Node) -> Self {
self
}
/// Adds some basic textual and visual debugging information to this Element
#[cfg(feature = "visual-debug")]
pub fn debug(self, name: &str, x: i64, y: i64, n: &dyn super::Node) -> Self {
self.set("railroad:type", &name)
.set("railroad:x", &x)
.set("railroad:y", &y)
.set("railroad:entry_height", &n.entry_height())
.set("railroad:height", &n.height())
.set("railroad:width", &n.width())
.add(Element::new("title").text(name))
.append(
Element::new("path")
.set(
"d",
&PathData::new(HDir::LTR)
.move_to(x, y)
.horizontal(n.width())
.vertical(5)
.move_rel(-n.width(), -5)
.vertical(n.height())
.horizontal(5)
.move_rel(-5, -n.height())
.move_rel(0, n.entry_height())
.horizontal(10),
)
.set("class", "debug"),
)
}
}
impl ::std::fmt::Display for Element {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
write!(f, "<{}", self.name)?;
let mut attrs = self.attributes.iter().collect::<Vec<_>>();
attrs.sort_by_key(|(k, _)| *k);
for (k, v) in attrs {
write!(f, " {k}=\"{v}\"")?;
}
if self.text.is_none() && self.children.is_empty() {
f.write_str("/>\n")?;
} else {
f.write_str(">\n")?;
}
if let Some(t) = &self.text {
f.write_str(t)?;
}
for child in &self.children {
write!(f, "{child}")?;
}
if self.text.is_some() || !self.children.is_empty() {
writeln!(f, "</{}>", self.name)?;
}
for sibling in &self.siblings {
write!(f, "{sibling}")?;
}
Ok(())
}
}