craft-svg: a paths feature, and CSS colours with their alpha (#1848)

The geometry reader (craft_svg::paths) is the only part of the crate that
needs vectorcraft-geom and vectorcraft-pathops, and the tree is the only part
that needs craft-image-codecs. Both are now optional: paths is a default
feature and tree turns it on, so existing users build the same crate, while
an app that only needs SVG text, guards, path data, colours and the writer can
turn default features off and take no app crates or image codecs.

parse_color_alpha is parse_color keeping the alpha of #rgba, #rrggbbaa and
the fourth value of rgb()/hsl(). parse_color now calls it and still drops it.

Refs #778, #789
This commit is contained in:
FredApps authored and GitHub committed 2026-11-16 06:54:06 -05:00
1 parent e409e74333
commit b836a71856
4 files changed
+65 -30

No files matched your search

+11 -4
View File
@@ -13,14 +13,16 @@ workspace = true
[dependencies]
craft-xml = { workspace = true }
quick-xml = { version = "0.41", default-features = false }
craft-image-codecs = { workspace = true }
# Probing and bounding raster images embedded in a parsed tree (`tree`).
craft-image-codecs = { workspace = true, optional = true }
# SVGZ (gzip), pure-Rust backend.
flate2 = { version = "1", default-features = false, features = ["rust_backend"] }
kurbo = { workspace = true }
roxmltree = "0.21.2"
thiserror = { workspace = true }
vectorcraft-geom = { workspace = true }
vectorcraft-pathops = { workspace = true }
# The geometry reader (`paths`) builds and cleans its outlines with these.
vectorcraft-geom = { workspace = true, optional = true }
vectorcraft-pathops = { workspace = true, optional = true }
# The full SVG parser (Apache-2.0 OR MIT). The one version every Craft app uses: apps depend on
# craft-svg's `tree` feature and take usvg from its re-export, never directly.
usvg = { version = "=0.48.1", default-features = false, optional = true }
@@ -31,8 +33,13 @@ resvg = { version = "=0.48.1", default-features = false, features = ["text", "ra
data-url = { version = "0.3.2", optional = true }
[features]
default = ["paths"]
# `craft_svg::paths`: the geometry reader (Bézier paths in millimetres) for cutters, plotters and
# CAD import. Off, the crate is SVG text, guards, path data, colours and the writer only, with no
# app crates (vectorcraft) among its dependencies.
paths = ["dep:vectorcraft-geom", "dep:vectorcraft-pathops"]
# `craft_svg::tree`: usvg behind the bounded entry point.
tree = ["dep:usvg", "dep:data-url"]
tree = ["paths", "dep:usvg", "dep:data-url", "dep:craft-image-codecs"]
# Text converted to paths (needs a font database in the options).
tree-text = ["tree", "usvg/text"]
# The system's fonts in `usvg::fontdb`.
+50 -24
View File
@@ -65,12 +65,20 @@ pub struct ColorParseError {
/// and SVG 2 paint both defer to): the 148 named colours, `#rgb`, `#rgba`, `#rrggbb`,
/// `#rrggbbaa`, `rgb()`/`rgba()` with integer 0–255 or percentage channels, and
/// `hsl()`/`hsla()`, in comma or space syntax with an optional alpha (`/ a` or a fourth
/// comma value). Alpha is checked and then dropped.
/// comma value). Alpha is checked and then dropped; [`parse_color_alpha`] keeps it.
///
/// Anything else — `transparent`, `currentColor`, `color()`, out-of-range channels —
/// is an error, not a guess: silent color loss is worse than a reported failure.
/// Callers that understand `none`/`currentColor` (SVG paint) resolve them first.
pub fn parse_color(input: &str) -> Result<Color, ColorParseError> {
parse_color_alpha(input).map(|(color, _)| color)
}
/// [`parse_color`], with the colour's alpha in `[0, 1]`: from `#rgba` and `#rrggbbaa` (in
/// 255ths), from the fourth value of `rgb()`/`hsl()` (a number or a percentage), else 1. A
/// colour with an alpha of its own (a fill of `rgba(…)`) multiplies with `fill-opacity`; that
/// is the caller's to do.
pub fn parse_color_alpha(input: &str) -> Result<(Color, f32), ColorParseError> {
let err = || ColorParseError { input: input.to_string() };
// Cap input length before work: a caller feeding untrusted text cannot
// make this quadratic.
@@ -84,30 +92,27 @@ pub fn parse_color(input: &str) -> Result<Color, ColorParseError> {
if let Some((name, rest)) = lower.split_once('(') {
return parse_function(name.trim(), rest).ok_or_else(err);
}
NAMED.iter().find(|(name, _)| *name == lower).map(|(_, rgb)| Color::new((rgb >> 16) as u8, (rgb >> 8) as u8, *rgb as u8)).ok_or_else(err)
NAMED.iter().find(|(name, _)| *name == lower).map(|(_, rgb)| (Color::new((rgb >> 16) as u8, (rgb >> 8) as u8, *rgb as u8), 1.0)).ok_or_else(err)
}
/// Hex digits after `#`: 3 or 4 (each doubled), 6 or 8; the alpha digits are dropped.
fn parse_hex(digits: &str) -> Option<Color> {
/// Hex digits after `#`: 3 or 4 (each doubled), 6 or 8; the fourth (or fourth pair) is alpha.
fn parse_hex(digits: &str) -> Option<(Color, f32)> {
if !digits.bytes().all(|b| b.is_ascii_hexdigit()) {
return None;
}
let value = |s: &str| u8::from_str_radix(s, 16).ok();
match digits.len() {
3 | 4 => {
let d = |i: usize| value(digits.get(i..=i)?).map(|v| v * 17);
Some(Color::new(d(0)?, d(1)?, d(2)?))
}
6 | 8 => {
let d = |i: usize| value(digits.get(i..i + 2)?);
Some(Color::new(d(0)?, d(2)?, d(4)?))
}
_ => None,
}
let channels: Vec<u8> = match digits.len() {
3 | 4 => (0..digits.len()).map(|i| value(digits.get(i..=i)?).map(|v| v * 17)).collect::<Option<_>>()?,
6 | 8 => (0..digits.len() / 2).map(|i| value(digits.get(2 * i..2 * i + 2)?)).collect::<Option<_>>()?,
_ => return None,
};
let (&r, &g, &b) = (channels.first()?, channels.get(1)?, channels.get(2)?);
let alpha = channels.get(3).map_or(1.0, |a| f32::from(*a) / 255.0);
Some((Color::new(r, g, b), alpha))
}
/// `rgb(…)`, `rgba(…)`, `hsl(…)`, `hsla(…)` after the `(`, which must close with `)`.
fn parse_function(name: &str, rest: &str) -> Option<Color> {
fn parse_function(name: &str, rest: &str) -> Option<(Color, f32)> {
let body = rest.trim().strip_suffix(')')?;
// Legacy comma syntax, or modern space syntax with `/ alpha`.
let parts: Vec<&str> = if body.contains(',') {
@@ -127,26 +132,29 @@ fn parse_function(name: &str, rest: &str) -> Option<Color> {
if !(parts.len() == 3 || parts.len() == 4) {
return None;
}
if let Some(alpha) = parts.get(3) {
let a = match alpha.strip_suffix('%') {
let mut alpha = 1.0;
if let Some(text) = parts.get(3) {
let a = match text.strip_suffix('%') {
Some(p) => number(p)? / 100.0,
None => number(alpha)?,
None => number(text)?,
};
if !(0.0..=1.0).contains(&a) {
return None;
}
alpha = a as f32;
}
let (Some(a), Some(b), Some(c)) = (parts.first(), parts.get(1), parts.get(2)) else {
return None;
};
match name {
"rgb" | "rgba" => Some(Color::new(rgb_channel(a)?, rgb_channel(b)?, rgb_channel(c)?)),
let color = match name {
"rgb" | "rgba" => Color::new(rgb_channel(a)?, rgb_channel(b)?, rgb_channel(c)?),
"hsl" | "hsla" => {
let hue = number(a.strip_suffix("deg").unwrap_or(a))?;
Some(hsl_to_rgb(hue.rem_euclid(360.0), percent(b)?, percent(c)?))
hsl_to_rgb(hue.rem_euclid(360.0), percent(b)?, percent(c)?)
}
_ => None,
}
_ => return None,
};
Some((color, alpha))
}
/// A finite plain decimal number.
@@ -372,6 +380,24 @@ mod tests {
assert_eq!(c("#abc"), Color::new(0xaa, 0xbb, 0xcc));
}
#[test]
fn alpha_is_kept_by_parse_color_alpha() {
let a = |input: &str| parse_color_alpha(input).ok().expect("test input should parse");
assert_eq!(a("#ff000080"), (Color::new(255, 0, 0), 128.0 / 255.0));
assert_eq!(a("#f008"), (Color::new(255, 0, 0), 136.0 / 255.0));
assert_eq!(a("#f00"), (Color::new(255, 0, 0), 1.0));
assert_eq!(a("rgba(255, 0, 0, 0.25)"), (Color::new(255, 0, 0), 0.25));
assert_eq!(a("rgb(0 0 255 / 50%)"), (Color::new(0, 0, 255), 0.5));
assert_eq!(a("hsla(120, 100%, 50%, 0)"), (Color::new(0, 255, 0), 0.0));
assert_eq!(a("SteelBlue"), (Color::new(0x46, 0x82, 0xb4), 1.0));
// parse_color keeps dropping it, and both refuse the same input.
assert_eq!(c("#ff000080"), Color::new(255, 0, 0));
for bad in ["rgba(255, 0, 0, 1.5)", "#ff00000", "rgb(0 0 0 / -1)", "transparent", "#ggg"] {
assert!(parse_color_alpha(bad).is_err(), "{bad}");
assert!(parse_color(bad).is_err(), "{bad}");
}
}
#[test]
fn parses_css_keywords() {
assert_eq!(c("black"), Color::new(0, 0, 0));
+3 -2
View File
@@ -5,8 +5,8 @@
//! UTF-16 and ISO 8859-1 decoded; and SVGZ compression.
//! - [`guard`]: checks on the text before any XML reader or SVG converter sees it: how deep the
//! elements nest, and what the document type's entities expand to.
//! - [`paths`]: the geometry of a document as Bézier paths in millimetres, for cutters, plotters
//! and CAD import.
//! - `paths` (feature `paths`, on by default): the geometry of a document as Bézier paths in
//! millimetres, for cutters, plotters and CAD import.
//! - [`color`]: CSS colours.
//! - [`write`]: a writer for SVG documents, their path data and numbers.
//! - `tree` (feature `tree`): the full parser. usvg at the one version the Craft apps share,
@@ -22,6 +22,7 @@ pub mod drawing_write;
pub mod guard;
pub mod neutral_document;
pub mod path_data;
#[cfg(feature = "paths")]
pub mod paths;
pub mod preflight;
pub mod sniff;
+1
View File
@@ -362,6 +362,7 @@ mod tests {
}
#[test]
#[cfg(feature = "paths")]
fn writes_a_document_the_reader_reads() {
let mut w = SvgWriter::new();
assert!(!w.is_empty());