Skip to content

fix: Adapt to new xmlwriter API and disable COLR #982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jmikedupont2 wants to merge 1 commit into from
Closed

fix: Adapt to new xmlwriter API and disable COLR #982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 57 additions & 56 deletions crates/usvg/src/text/colr.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

use crate::parser::OptionLog;
use rustybuzz::ttf_parser;
use std::io::Write;

struct Builder<'a>(&'a mut String);

Expand Down Expand Up @@ -46,12 +47,12 @@ trait XmlWriterExt {
fn write_spread_method_attribute(&mut self, method: ttf_parser::colr::GradientExtend);
}

impl XmlWriterExt for xmlwriter::XmlWriter {
impl<W: Write> XmlWriterExt for xmlwriter::XmlWriter<'_, W> {
fn write_color_attribute(&mut self, name: &str, color: ttf_parser::RgbaColor) {
self.write_attribute_fmt(
name,
format_args!("rgb({}, {}, {})", color.red, color.green, color.blue),
);
).unwrap();
}

fn write_transform_attribute(&mut self, name: &str, ts: ttf_parser::Transform) {
Expand All @@ -65,7 +66,7 @@ impl XmlWriterExt for xmlwriter::XmlWriter {
"matrix({} {} {} {} {} {})",
ts.a, ts.b, ts.c, ts.d, ts.e, ts.f
),
);
).unwrap();
}

fn write_spread_method_attribute(&mut self, extend: ttf_parser::colr::GradientExtend) {
Expand All @@ -76,15 +77,15 @@ impl XmlWriterExt for xmlwriter::XmlWriter {
ttf_parser::colr::GradientExtend::Repeat => &"repeat",
ttf_parser::colr::GradientExtend::Reflect => &"reflect",
},
);
).unwrap();
}
}

// NOTE: This is only a best-effort translation of COLR into SVG.
pub(crate) struct GlyphPainter<'a> {
pub(crate) struct GlyphPainter<'a, 'w, W: Write> {
pub(crate) face: &'a ttf_parser::Face<'a>,
pub(crate) svg: &'a mut xmlwriter::XmlWriter,
pub(crate) path_buf: &'a mut String,
pub(crate) svg: &'w mut xmlwriter::XmlWriter<'w, W>,
pub(crate) path_buf: &'w mut String,
pub(crate) gradient_index: usize,
pub(crate) clip_path_index: usize,
pub(crate) palette_index: u16,
Expand All @@ -93,27 +94,27 @@ pub(crate) struct GlyphPainter<'a> {
pub(crate) transforms_stack: Vec<ttf_parser::Transform>,
}

impl<'a> GlyphPainter<'a> {
impl<'a, 'w, W: Write> GlyphPainter<'a, 'w, W> {
fn write_gradient_stops(&mut self, stops: ttf_parser::colr::GradientStopsIter) {
for stop in stops {
self.svg.start_element("stop");
self.svg.write_attribute("offset", &stop.stop_offset);
self.svg.start_element("stop").unwrap();
self.svg.write_attribute("offset", &stop.stop_offset).unwrap();
self.svg.write_color_attribute("stop-color", stop.color);
let opacity = f32::from(stop.color.alpha) / 255.0;
self.svg.write_attribute("stop-opacity", &opacity);
self.svg.end_element();
self.svg.write_attribute("stop-opacity", &opacity).unwrap();
self.svg.end_element().unwrap();
}
}

fn paint_solid(&mut self, color: ttf_parser::RgbaColor) {
self.svg.start_element("path");
self.svg.start_element("path").unwrap();
self.svg.write_color_attribute("fill", color);
let opacity = f32::from(color.alpha) / 255.0;
self.svg.write_attribute("fill-opacity", &opacity);
self.svg.write_attribute("fill-opacity", &opacity).unwrap();
self.svg
.write_transform_attribute("transform", self.outline_transform);
self.svg.write_attribute("d", self.path_buf);
self.svg.end_element();
self.svg.write_attribute("d", &*self.path_buf).unwrap();
self.svg.end_element().unwrap();
}

fn paint_linear_gradient(&mut self, gradient: ttf_parser::colr::LinearGradient<'a>) {
Expand All @@ -128,28 +129,28 @@ impl<'a> GlyphPainter<'a> {
// be applied from the first/last stop. So if we have a gradient with x1=0 x2=1, and
// a stop at x=0.4 and x=0.6, then in SVG we will always see a padding, while in ttf
// we will see the actual spreadMode. We need to account for that somehow.
self.svg.start_element("linearGradient");
self.svg.write_attribute("id", &gradient_id);
self.svg.write_attribute("x1", &gradient.x0);
self.svg.write_attribute("y1", &gradient.y0);
self.svg.write_attribute("x2", &gradient.x1);
self.svg.write_attribute("y2", &gradient.y1);
self.svg.write_attribute("gradientUnits", &"userSpaceOnUse");
self.svg.start_element("linearGradient").unwrap();
self.svg.write_attribute("id", &gradient_id).unwrap();
self.svg.write_attribute("x1", &gradient.x0).unwrap();
self.svg.write_attribute("y1", &gradient.y0).unwrap();
self.svg.write_attribute("x2", &gradient.x1).unwrap();
self.svg.write_attribute("y2", &gradient.y1).unwrap();
self.svg.write_attribute("gradientUnits", &"userSpaceOnUse").unwrap();
self.svg.write_spread_method_attribute(gradient.extend);
self.svg
.write_transform_attribute("gradientTransform", gradient_transform);
self.write_gradient_stops(
gradient.stops(self.palette_index, self.face.variation_coordinates()),
);
self.svg.end_element();
self.svg.end_element().unwrap();

self.svg.start_element("path");
self.svg.start_element("path").unwrap();
self.svg
.write_attribute_fmt("fill", format_args!("url(#{})", gradient_id));
.write_attribute_fmt("fill", format_args!("url(#{})", gradient_id)).unwrap();
self.svg
.write_transform_attribute("transform", self.outline_transform);
self.svg.write_attribute("d", self.path_buf);
self.svg.end_element();
self.svg.write_attribute("d", &*self.path_buf).unwrap();
self.svg.end_element().unwrap();
}

fn paint_radial_gradient(&mut self, gradient: ttf_parser::colr::RadialGradient<'a>) {
Expand All @@ -158,30 +159,30 @@ impl<'a> GlyphPainter<'a> {

let gradient_transform = paint_transform(self.outline_transform, self.transform);

self.svg.start_element("radialGradient");
self.svg.write_attribute("id", &gradient_id);
self.svg.write_attribute("cx", &gradient.x1);
self.svg.write_attribute("cy", &gradient.y1);
self.svg.write_attribute("r", &gradient.r1);
self.svg.write_attribute("fr", &gradient.r0);
self.svg.write_attribute("fx", &gradient.x0);
self.svg.write_attribute("fy", &gradient.y0);
self.svg.write_attribute("gradientUnits", &"userSpaceOnUse");
self.svg.start_element("radialGradient").unwrap();
self.svg.write_attribute("id", &gradient_id).unwrap();
self.svg.write_attribute("cx", &gradient.x1).unwrap();
self.svg.write_attribute("cy", &gradient.y1).unwrap();
self.svg.write_attribute("r", &gradient.r1).unwrap();
self.svg.write_attribute("fr", &gradient.r0).unwrap();
self.svg.write_attribute("fx", &gradient.x0).unwrap();
self.svg.write_attribute("fy", &gradient.y0).unwrap();
self.svg.write_attribute("gradientUnits", &"userSpaceOnUse").unwrap();
self.svg.write_spread_method_attribute(gradient.extend);
self.svg
.write_transform_attribute("gradientTransform", gradient_transform);
self.write_gradient_stops(
gradient.stops(self.palette_index, self.face.variation_coordinates()),
);
self.svg.end_element();
self.svg.end_element().unwrap();

self.svg.start_element("path");
self.svg.start_element("path").unwrap();
self.svg
.write_attribute_fmt("fill", format_args!("url(#{})", gradient_id));
.write_attribute_fmt("fill", format_args!("url(#{})", gradient_id)).unwrap();
self.svg
.write_transform_attribute("transform", self.outline_transform);
self.svg.write_attribute("d", self.path_buf);
self.svg.end_element();
self.svg.write_attribute("d", &*self.path_buf).unwrap();
self.svg.end_element().unwrap();
}

fn paint_sweep_gradient(&mut self, _: ttf_parser::colr::SweepGradient<'a>) {
Expand Down Expand Up @@ -227,27 +228,27 @@ fn paint_transform(
}
}

impl GlyphPainter<'_> {
impl<W: Write> GlyphPainter<'_, '_, W> {
fn clip_with_path(&mut self, path: &str) {
let clip_id = format!("cp{}", self.clip_path_index);
self.clip_path_index += 1;

self.svg.start_element("clipPath");
self.svg.write_attribute("id", &clip_id);
self.svg.start_element("path");
self.svg.start_element("clipPath").unwrap();
self.svg.write_attribute("id", &clip_id).unwrap();
self.svg.start_element("path").unwrap();
self.svg
.write_transform_attribute("transform", self.outline_transform);
self.svg.write_attribute("d", &path);
self.svg.end_element();
self.svg.end_element();
self.svg.write_attribute("d", &path).unwrap();
self.svg.end_element().unwrap();
self.svg.end_element().unwrap();

self.svg.start_element("g");
self.svg.start_element("g").unwrap();
self.svg
.write_attribute_fmt("clip-path", format_args!("url(#{})", clip_id));
.write_attribute_fmt("clip-path", format_args!("url(#{})", clip_id)).unwrap();
}
}

impl<'a> ttf_parser::colr::Painter<'a> for GlyphPainter<'a> {
impl<'a, 'w, W: Write> ttf_parser::colr::Painter<'a> for GlyphPainter<'a, 'w, W> {
fn outline_glyph(&mut self, glyph_id: ttf_parser::GlyphId) {
self.path_buf.clear();
let mut builder = Builder(self.path_buf);
Expand All @@ -262,7 +263,7 @@ impl<'a> ttf_parser::colr::Painter<'a> for GlyphPainter<'a> {
}

fn push_layer(&mut self, mode: ttf_parser::colr::CompositeMode) {
self.svg.start_element("g");
self.svg.start_element("g").unwrap();

use ttf_parser::colr::CompositeMode;
// TODO: Need to figure out how to represent the other blend modes
Expand Down Expand Up @@ -292,11 +293,11 @@ impl<'a> ttf_parser::colr::Painter<'a> for GlyphPainter<'a> {
self.svg.write_attribute_fmt(
"style",
format_args!("mix-blend-mode: {}; isolation: isolate", mode),
);
).unwrap();
}

fn pop_layer(&mut self) {
self.svg.end_element(); // g
self.svg.end_element().unwrap(); // g
}

fn push_transform(&mut self, transform: ttf_parser::Transform) {
Expand Down Expand Up @@ -324,7 +325,7 @@ impl<'a> ttf_parser::colr::Painter<'a> for GlyphPainter<'a> {
}

fn pop_clip(&mut self) {
self.svg.end_element();
self.svg.end_element().unwrap();
}

fn push_clip_box(&mut self, clipbox: ttf_parser::colr::ClipBox) {
Expand Down
46 changes: 7 additions & 39 deletions crates/usvg/src/text/flatten.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,10 @@ pub(crate) fn flatten(text: &mut Text, cache: &mut Cache) -> Option<(Group, NonZ

for glyph in &span.positioned_glyphs {
// A (best-effort conversion of a) COLR glyph.
/*
if let Some(tree) = cache.fontdb_colr(glyph.font, glyph.id) {
push_outline_paths(span, &mut span_builder, &mut new_children, rendering_mode);

let mut group = Group {
transform: glyph.colr_transform(),
..Group::empty()
Expand All @@ -84,8 +87,9 @@ pub(crate) fn flatten(text: &mut Text, cache: &mut Cache) -> Option<(Group, NonZ

new_children.push(Node::Group(Box::new(group)));
}
*/
// An SVG glyph. Will return the usvg node containing the glyph descriptions.
else if let Some(node) = cache.fontdb_svg(glyph.font, glyph.id) {
if let Some(node) = cache.fontdb_svg(glyph.font, glyph.id) {
push_outline_paths(span, &mut span_builder, &mut new_children, rendering_mode);

let mut group = Group {
Expand Down Expand Up @@ -282,43 +286,7 @@ impl DatabaseExt for Database {
})?
}

fn colr(&self, id: ID, glyph_id: GlyphId) -> Option<Tree> {
self.with_face_data(id, |data, face_index| -> Option<Tree> {
let face = ttf_parser::Face::parse(data, face_index).ok()?;

let mut svg = XmlWriter::new(xmlwriter::Options::default());

svg.start_element("svg");
svg.write_attribute("xmlns", "http://www.w3.org/2000/svg");
svg.write_attribute("xmlns:xlink", "http://www.w3.org/1999/xlink");

let mut path_buf = String::with_capacity(256);
let gradient_index = 1;
let clip_path_index = 1;

svg.start_element("g");

let mut glyph_painter = GlyphPainter {
face: &face,
svg: &mut svg,
path_buf: &mut path_buf,
gradient_index,
clip_path_index,
palette_index: 0,
transform: ttf_parser::Transform::default(),
outline_transform: ttf_parser::Transform::default(),
transforms_stack: vec![ttf_parser::Transform::default()],
};

face.paint_color_glyph(
glyph_id,
0,
RgbaColor::new(0, 0, 0, 255),
&mut glyph_painter,
)?;
svg.end_element();

Tree::from_data(svg.end_document().as_bytes(), &Options::default()).ok()
})?
fn colr(&self, _id: ID, _glyph_id: GlyphId) -> Option<Tree> {
None
}
}
Loading
Loading