Merge main into fix/shadow-validation-builds-its-shadow-geometry

This commit is contained in:
dotCooCoo
2026-11-14 18:52:10 -08:00
191 changed files with 9727 additions and 954 deletions
+12 -8
View File
@@ -840,15 +840,19 @@ fn reorient_strokes(n: &mut Node, o: Orient) {
}
}
/// Turn the strokes of path `n` for Reverse Path Direction, before its subpaths flagged in
/// `reversed` are reversed with [`SubPath::reverse`] (a closed one then starts at its last
/// anchor): each stroke's width profile (sides swapped), pen pressure, tilt, bearing and rotation
/// then run the new way, so the stroke draws as it did. A stroke reads one profile along every
/// subpath, so it turns only when all of them turn alike. Arrowheads stay at the path's start and
/// end.
/// Turn the strokes of path or compound path `n` for Reverse Path Direction, before its subpaths
/// flagged in `reversed` are reversed with [`SubPath::reverse`] (a closed one then starts at its
/// last anchor): each stroke's width profile (sides swapped), pen pressure, tilt, bearing and
/// rotation then run the new way, so the stroke draws as it did. A compound path's subpaths are
/// its members' subpaths in order. A stroke reads one profile along every subpath, so it turns
/// only when all of them turn alike. Arrowheads stay at the path's start and end.
pub fn reverse_stroke_records(n: &mut Node, reversed: &[bool]) {
let NodeKind::Path { path, .. } = &n.kind else { return };
let mut turns = path.subpaths.iter().enumerate().map(|(i, sp)| {
let subpaths: Vec<&SubPath> = match &n.kind {
NodeKind::Path { path, .. } => path.subpaths.iter().collect(),
NodeKind::Compound { children, .. } => children.iter().filter_map(|c| c.path_data()).flat_map(|pd| &pd.subpaths).collect(),
_ => return,
};
let mut turns = subpaths.into_iter().enumerate().map(|(i, sp)| {
let mut o = Orient::of(sp);
if reversed.get(i).copied().unwrap_or(false) {
if sp.closed {
+630 -39
View File
@@ -332,20 +332,24 @@ pub fn oversized_tiff(bytes: &[u8]) -> Option<(u32, u32)> {
None
}
/// The color type of TIFF `bytes` and its decoder; `None` for [`oversized_tiff`] images too.
pub(crate) fn tiff(bytes: &[u8]) -> Option<(tiff::ColorType, tiff::decoder::Decoder<Cursor<&[u8]>>)> {
/// The decoder of TIFF `bytes`' first image; `None` for other bytes and [`oversized_tiff`] images.
fn tiff_decoder(bytes: &[u8]) -> Option<tiff::decoder::Decoder<Cursor<&[u8]>>> {
if !is_tiff(bytes) || oversized_tiff(bytes).is_some() {
return None;
}
let mut d = tiff::decoder::Decoder::new(Cursor::new(bytes)).ok()?;
tiff::decoder::Decoder::new(Cursor::new(bytes)).ok()
}
/// The color type of TIFF `bytes` and its decoder; `None` for [`oversized_tiff`] images too.
pub(crate) fn tiff(bytes: &[u8]) -> Option<(tiff::ColorType, tiff::decoder::Decoder<Cursor<&[u8]>>)> {
let mut d = tiff_decoder(bytes)?;
Some((d.colortype().ok()?, d))
}
/// The Orientation tag of TIFF `bytes`' first image, of any unsigned type; `None` for other images
/// and TIFFs without one. Reads only its header.
/// and TIFFs without one. Reads only its header, for any color type.
pub fn tiff_orientation(bytes: &[u8]) -> Option<u16> {
let (_, mut d) = tiff(bytes)?;
d.find_tag_unsigned::<u16>(tiff::tags::Tag::Orientation).ok().flatten()
tiff_decoder(bytes)?.find_tag_unsigned::<u16>(tiff::tags::Tag::Orientation).ok().flatten()
}
/// The EXIF orientation of encoded image `bytes` when it turns or flips the pixels; `None` when
@@ -363,8 +367,160 @@ pub fn exif_orientation(bytes: &[u8]) -> Option<image::metadata::Orientation> {
decoded().or_else(tagged).filter(|o| *o != Orientation::NoTransforms)
}
/// TIFF bytes as a reader sees them with some of them replaced: each patch is an offset and the
/// bytes read there instead, at most four, in order of offset without overlaps. The file is not
/// copied.
struct Patched<'a> {
bytes: Cursor<&'a [u8]>,
patches: Vec<(usize, &'static [u8])>,
}
impl std::io::Read for Patched<'_> {
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
let start = usize::try_from(self.bytes.position()).unwrap_or(usize::MAX);
let read = std::io::Read::read(&mut self.bytes, buf)?;
let got = buf.get_mut(..read).unwrap_or_default();
let end = start.saturating_add(read);
// The patches are in order and apart, and each is at most four bytes long.
let first = self.patches.partition_point(|&(at, _)| at.saturating_add(4) <= start);
for &(at, with) in self.patches.get(first..).unwrap_or_default().iter().take_while(|&&(at, _)| at < end) {
for (k, &b) in with.iter().enumerate() {
if let Some(slot) = at.checked_add(k).and_then(|i| i.checked_sub(start)).and_then(|i| got.get_mut(i)) {
*slot = b;
}
}
}
Ok(read)
}
}
impl std::io::Seek for Patched<'_> {
fn seek(&mut self, to: std::io::SeekFrom) -> std::io::Result<u64> {
std::io::Seek::seek(&mut self.bytes, to)
}
}
/// TIFF `bytes` read with the PhotometricInterpretation (tag 262) of their first image set to 1
/// (black is zero) in each of its entries that holds one SHORT or LONG value. The decoder gives
/// every sample of a grayscale image's pixels, in the order the file stores them, where it gives a
/// CMYK image's inks and at most the first extra sample, and doesn't read a white-is-zero image
/// with extra samples. `None` for bytes that aren't a TIFF and when the first image has no such
/// entry.
fn as_black_is_zero(bytes: &[u8]) -> Option<Patched<'_>> {
let le = bytes.starts_with(b"II*\0");
if !le && !bytes.starts_with(b"MM\0*") {
return None;
}
let u16_at = |at: usize| -> Option<u16> {
let b: [u8; 2] = bytes.get(at..at.checked_add(2)?)?.try_into().ok()?;
Some(if le { u16::from_le_bytes(b) } else { u16::from_be_bytes(b) })
};
let u32_at = |at: usize| -> Option<u32> {
let b: [u8; 4] = bytes.get(at..at.checked_add(4)?)?.try_into().ok()?;
Some(if le { u32::from_le_bytes(b) } else { u32::from_be_bytes(b) })
};
let ifd = usize::try_from(u32_at(4)?).ok()?;
let mut patches = Vec::new();
for i in 0..usize::from(u16_at(ifd)?) {
let e = ifd.checked_add(i.checked_mul(12)?.checked_add(2)?)?;
let (Some(tag), Some(ty), Some(count)) = (u16_at(e), u16_at(e.checked_add(2)?), u32_at(e.checked_add(4)?)) else { break };
if tag != 262 || count != 1 {
continue;
}
// The value sits in the entry, in the file's byte order.
let one: &'static [u8] = match (ty, le) {
(3, true) => &[1, 0],
(3, false) => &[0, 1],
(4, true) => &[1, 0, 0, 0],
(4, false) => &[0, 0, 0, 1],
_ => continue,
};
let at = e.checked_add(8)?;
bytes.get(at..at.checked_add(one.len())?)?;
patches.push((at, one));
}
(!patches.is_empty()).then(|| Patched { bytes: Cursor::new(bytes), patches })
}
/// The ExtraSamples values of the image `d` reads, one for each sample after its color, in order:
/// 0 not alpha, 1 associated alpha, 2 unassociated alpha. Empty without the tag.
fn extra_samples(d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>) -> Vec<u16> {
d.find_tag_unsigned_vec::<u16>(tiff::tags::Tag::ExtraSamples).ok().flatten().unwrap_or_default()
}
/// Does `kind`, the color type of the TIFF `d` reads, hold inks that Open and Place keep: CMYK of 8
/// or 16 bits, with no extra sample that the file names as alpha? The decoder gives a CMYK color
/// type to a file whose alpha follows another extra sample. [`ImageBlob::cmyk`] reads the inks of
/// such a file all the same: a document saved with one as a CMYK image keeps it.
fn cmyk_inks(kind: tiff::ColorType, d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>) -> bool {
matches!(kind, tiff::ColorType::CMYK(8 | 16)) && !extra_samples(d).iter().any(|e| matches!(e, 1 | 2))
}
/// Most samples a pixel of a TIFF is read with, its color and extra samples included, as the
/// file's SamplesPerPixel counts them: VectorCraft's own limit.
const MAX_EXTRA_SAMPLES_PIXEL: usize = 64;
/// The bytes of the row the decoder of the TIFF `d` reads takes before it reads each strip or tile
/// of a file that stores a pixel's samples together and has more of them (its SamplesPerPixel)
/// than the decoder gives: one row of the strip or tile, every sample of each pixel. 0 for other
/// files. `None` when the file has more than [`MAX_EXTRA_SAMPLES_PIXEL`] samples a pixel, when its
/// samples aren't unsigned integers (a SampleFormat other than 1, which the readers don't take, and
/// which the floating-point predictor needs) and when its color type isn't read. Reads only the
/// file's tags.
fn row_buffer<R: std::io::Read + std::io::Seek>(d: &mut tiff::decoder::Decoder<R>) -> Option<u64> {
use tiff::tags::Tag;
let kind = d.colortype().ok()?;
let all = d.find_tag_unsigned::<u16>(Tag::SamplesPerPixel).ok()?.unwrap_or(1);
if usize::from(all) > MAX_EXTRA_SAMPLES_PIXEL {
return None;
}
if d.find_tag_unsigned_vec::<u16>(Tag::SampleFormat).ok()?.is_some_and(|f| f.iter().any(|&f| f != 1)) {
return None;
}
if all <= kind.num_samples() || planar(d) {
return Some(0);
}
// A strip is as wide as the image, a tile as its TileWidth.
let width = match d.get_chunk_type() {
tiff::decoder::ChunkType::Tile => d.find_tag_unsigned::<u32>(Tag::TileWidth).ok()??,
tiff::decoder::ChunkType::Strip => d.dimensions().ok()?.0,
};
u64::from(width).checked_mul(u64::from(all))?.checked_mul(u64::from(kind.bit_depth().div_ceil(8)))
}
/// `d`, the decoder of a TIFF of `file` bytes, set to decode `n` pixels of `per` samples of `bits`
/// bits each into RGBA. `None` when the file has more than [`MAX_EXTRA_SAMPLES_PIXEL`] samples a
/// pixel, when its samples aren't unsigned integers (a SampleFormat other than 1), and when the
/// decoded samples, the copy that puts a planar file's samples pixel by pixel, the row the decoder
/// reads each strip or tile into ([`row_buffer`]) and the RGBA pixels together take more than
/// [`crate::MAX_RASTER_ALLOC`]. The decoder may then decode no more than those samples, and read no
/// strip or tile of more compressed bytes than the file holds (nor more than its own limit of
/// 128 MiB).
fn with_room<R: std::io::Read + std::io::Seek>(
mut d: tiff::decoder::Decoder<R>,
file: usize,
n: usize,
per: usize,
bits: u8,
) -> Option<tiff::decoder::Decoder<R>> {
if per > MAX_EXTRA_SAMPLES_PIXEL {
return None;
}
let row = row_buffer(&mut d)?;
let need = n.checked_mul(per)?.checked_mul(usize::from(bits.div_ceil(8)))?;
let copies = if per > 1 && planar(&mut d) { 2 } else { 1 };
let peak = u64::try_from(need).ok()?.checked_mul(copies)?.checked_add(u64::try_from(n).ok()?.checked_mul(4)?)?.checked_add(row)?;
if peak > crate::MAX_RASTER_ALLOC {
return None;
}
let mut limits = tiff::decoder::Limits::default();
limits.decoding_buffer_size = need;
limits.intermediate_buffer_size = limits.intermediate_buffer_size.min(file);
Some(d.with_limits(limits))
}
/// Does the TIFF `d` reads store one plane per channel (PlanarConfiguration 2)?
fn planar(d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>) -> bool {
fn planar<R: std::io::Read + std::io::Seek>(d: &mut tiff::decoder::Decoder<R>) -> bool {
d.find_tag_unsigned::<u16>(tiff::tags::Tag::PlanarConfiguration).ok().flatten().is_some_and(|p| p != 1)
}
@@ -372,7 +528,10 @@ fn planar(d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>) -> bool {
/// type has), pixel by pixel and 8 bits each (16-bit samples to their high byte), whether the file
/// stores each pixel's samples together or one plane per channel. `None` when they don't decode to
/// that many samples, which includes images whose planes together need more than the decoder's
/// limit (256 MB of samples).
/// limit (256 MiB of samples), and, before any decoding, files with more than
/// [`MAX_EXTRA_SAMPLES_PIXEL`] samples a pixel, files whose samples aren't unsigned integers (a
/// SampleFormat other than 1) and ones whose samples with the row the decoder reads each strip or
/// tile into ([`row_buffer`]) take more than [`crate::MAX_RASTER_ALLOC`].
pub(crate) fn read_samples(d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>, n: usize, per: usize) -> Option<Vec<u8>> {
Some(match read_samples_at_depth(d, n, per)? {
Samples::Eight(v) => v,
@@ -404,7 +563,20 @@ enum SampleSlice<'a> {
}
/// [`read_samples`], keeping 16-bit samples at 16 bits.
fn read_samples_at_depth(d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>, n: usize, per: usize) -> Option<Samples> {
fn read_samples_at_depth<R: std::io::Read + std::io::Seek>(d: &mut tiff::decoder::Decoder<R>, n: usize, per: usize) -> Option<Samples> {
// Checked from the tags, before anything is decoded.
let row = row_buffer(d)?;
let bytes = u64::from(d.colortype().ok()?.bit_depth().div_ceil(8));
let need = u64::try_from(n).ok()?.checked_mul(u64::try_from(per).ok()?)?.checked_mul(bytes)?;
if need.checked_add(row)? > crate::MAX_RASTER_ALLOC {
return None;
}
decode_samples(d, n, per)
}
/// [`read_samples_at_depth`] without its checks, for a decoder that [`with_room`] made. Its tags
/// can't be read once its limits are set: the decoder holds a tag's values to its decoding limit.
fn decode_samples<R: std::io::Read + std::io::Seek>(d: &mut tiff::decoder::Decoder<R>, n: usize, per: usize) -> Option<Samples> {
let mut buf = tiff::decoder::DecodingResult::U8(Vec::new());
let layout = d.read_image_to_buffer(&mut buf).ok()?;
match buf {
@@ -415,7 +587,8 @@ fn read_samples_at_depth(d: &mut tiff::decoder::Decoder<Cursor<&[u8]>>, n: usize
}
/// `data`, the samples of `n` pixels, `per` to a pixel, stored in `planes` planes, as the samples
/// pixel by pixel; `None` when it doesn't hold that many samples or a plane per sample.
/// pixel by pixel; `None` when it doesn't hold that many samples or a plane per sample. The copy
/// of a planar file's samples is allocated once, at its length.
fn chunky<T: Copy>(data: Vec<T>, planes: usize, n: usize, per: usize) -> Option<Vec<T>> {
if Some(data.len()) != n.checked_mul(per) {
return None;
@@ -427,7 +600,13 @@ fn chunky<T: Copy>(data: Vec<T>, planes: usize, n: usize, per: usize) -> Option<
return None;
}
let planes: Vec<&[T]> = data.chunks_exact(n).collect();
Some((0..n).flat_map(|i| planes.iter().filter_map(move |p| p.get(i).copied())).collect())
let mut out = Vec::with_capacity(data.len());
for i in 0..n {
for p in &planes {
out.push(*p.get(i)?);
}
}
Some(out)
}
/// The color space an ICC profile's header names (bytes 16 to 19, such as `RGB `, `GRAY` or
@@ -473,10 +652,14 @@ struct CmykSource {
}
/// The samples of CMYK TIFF `bytes` (8 or 16 bits), their inks together or one plane per ink, with
/// the TIFF's CMYK ICC profile; `None` for other images and ones larger than [`MAX_CMYK_PIXELS`].
/// the TIFF's CMYK ICC profile; `None` for other images, CMYK ones with alpha, ones larger than
/// [`MAX_CMYK_PIXELS`], and, before any decoding, ones with more than [`MAX_EXTRA_SAMPLES_PIXEL`]
/// samples a pixel (their SamplesPerPixel), ones whose samples aren't unsigned integers (a
/// SampleFormat other than 1) and ones whose samples with the row the decoder reads each strip or
/// tile into ([`row_buffer`]) take more than [`crate::MAX_RASTER_ALLOC`].
fn tiff_source(bytes: &[u8]) -> Option<CmykSource> {
let (kind, mut d) = tiff(bytes)?;
if !matches!(kind, tiff::ColorType::CMYK(8 | 16)) {
if !cmyk_inks(kind, &mut d) {
return None;
}
let (width, height) = d.dimensions().ok()?;
@@ -687,7 +870,10 @@ fn jpeg_inks(bytes: &[u8]) -> Option<Inks> {
}
/// The ink amounts of a CMYK TIFF (16-bit samples to 8 bits), its inks stored together or one plane
/// per ink.
/// per ink. `None` for other images, ones larger than [`MAX_CMYK_PIXELS`], and the files
/// [`read_samples`] refuses: more than [`MAX_EXTRA_SAMPLES_PIXEL`] samples a pixel, samples that
/// aren't unsigned integers, or samples that with the decoder's row take more than
/// [`crate::MAX_RASTER_ALLOC`].
fn tiff_inks(bytes: &[u8]) -> Option<Inks> {
let (kind, mut d) = tiff(bytes)?;
let (w, h) = d.dimensions().ok()?;
@@ -701,8 +887,8 @@ fn tiff_inks(bytes: &[u8]) -> Option<Inks> {
/// CMYK TIFF `bytes` that no orientation turns ([`turned_cmyk`] stores the others) as Open and
/// Place store them: as they are, or, when they store one plane per ink, which the image decoder
/// doesn't read, their inks together in a CMYK TIFF with the resolution `ppi`, at the 8 or 16 bits
/// the file has, carrying the file's CMYK ICC profile. `None` for other images and for CMYK TIFFs
/// whose inks [`ImageBlob::cmyk`] doesn't read.
/// the file has, carrying the file's CMYK ICC profile. `None` for other images, for CMYK TIFFs
/// with an extra sample named as alpha and for ones whose inks [`ImageBlob::cmyk`] doesn't read.
pub fn stored_cmyk_tiff(bytes: &[u8], ppi: Option<(f64, f64)>) -> Option<Vec<u8>> {
let source = tiff_source(bytes)?;
let (_, mut d) = tiff(bytes)?;
@@ -716,7 +902,8 @@ pub fn stored_cmyk_tiff(bytes: &[u8], ppi: Option<(f64, f64)>) -> Option<Vec<u8>
/// inks turned and written again as a CMYK TIFF with the resolution `ppi` of the turned pixels,
/// with the turned width and height. A TIFF keeps its 8 or 16 bits, a JPEG has 8, and both keep
/// their CMYK ICC profile (a JPEG's put together from all its APP2 segments). `None` for other
/// images and for CMYK images whose inks [`ImageBlob::cmyk`] doesn't read.
/// images, for CMYK TIFFs with an extra sample named as alpha and for CMYK images whose inks
/// [`ImageBlob::cmyk`] doesn't read.
pub fn turned_cmyk(bytes: &[u8], orientation: image::metadata::Orientation, ppi: Option<(f64, f64)>) -> Option<(Vec<u8>, (u32, u32))> {
let CmykSource { width, height, samples, icc } = if bytes.starts_with(&[0xFF, 0xD8]) { jpeg_source(bytes) } else { tiff_source(bytes) }?;
// Four inks to a pixel, turned as four channels of the same depth are.
@@ -735,31 +922,58 @@ pub fn turned_cmyk(bytes: &[u8], orientation: image::metadata::Orientation, ppi:
}
/// A TIFF whose pixels have samples after their colour, which the image decoder doesn't read at
/// all, as RGBA pixels: CMYK with an alpha channel (5 samples), each colour converted by `rgb` (ink
/// amounts 0..1 → sRGB 0..1; the inks can't be kept with the transparency, so they show as RGB),
/// and grayscale with extra samples, of which the first is the alpha when the file says so (other
/// channels are left out). Associated (premultiplied) alpha is divided back out, and a pixel with
/// no associated alpha has no color. 16-bit samples are converted at 16 bits, and only the result
/// is rounded to 8 bits. The samples may be stored together or one plane per channel. `None` for
/// other images and ones larger than [`MAX_CMYK_PIXELS`].
/// all, as RGBA pixels: CMYK with an alpha channel, each color converted by `rgb` (ink amounts
/// 0..1 → sRGB 0..1; the inks can't be kept with the transparency, so they show as RGB), and
/// grayscale with extra samples. The alpha is the first extra sample whose ExtraSamples value
/// names it (1 or 2), whatever extra samples come before it; the other extra samples are left out,
/// and without such a value the pixels are opaque. A CMYK file with a fifth sample and no
/// ExtraSamples tag has that sample as unassociated alpha. Associated (premultiplied) alpha is
/// divided back out, and a pixel with no associated alpha has no color. 16-bit samples are
/// converted at 16 bits, and only the result is rounded to 8 bits. The samples may be stored
/// together or one plane per channel. A CMYK file with two or more samples past its inks and its
/// ExtraSamples values (or with no ExtraSamples tag) is read too, opaque when none of those values
/// names an alpha. `None` for other images, CMYK ones without alpha (their inks are read by
/// [`ImageBlob::cmyk`]), ones larger than [`MAX_CMYK_PIXELS`], ones whose SamplesPerPixel is more
/// than [`MAX_EXTRA_SAMPLES_PIXEL`], ones whose samples aren't unsigned integers (a SampleFormat
/// other than 1) and ones whose samples, with the copy a planar file needs, the row the decoder
/// reads each strip or tile into and the RGBA pixels, take more than [`crate::MAX_RASTER_ALLOC`];
/// those are refused from the file's tags, before any decoding.
pub fn extra_samples_tiff_rgba(bytes: &[u8], rgb: impl Fn([f32; 4]) -> [f32; 3]) -> Option<image::RgbaImage> {
use tiff::tags::Tag;
let (kind, mut d) = tiff(bytes)?;
let mut d = tiff_decoder(bytes)?;
// The decoder gives no color type to a CMYK file that has six or more samples besides the
// ones its ExtraSamples values count.
let kind = d.colortype().ok();
let (w, h) = d.dimensions().ok()?;
// 0: white is zero, 1: black is zero (the two grayscales).
// 0: white is zero, 1: black is zero (the two grayscales), 5: CMYK.
let photometric = d.find_tag_unsigned::<u16>(Tag::PhotometricInterpretation).ok().flatten();
// ExtraSamples 1: associated alpha (premultiplied colour), 2: unassociated alpha, 0: not alpha.
let extra = d.find_tag_unsigned_vec::<u16>(Tag::ExtraSamples).ok().flatten().and_then(|v| v.first().copied());
// (samples in a pixel, how many of them are its colour, is the next one alpha?)
let (samples, colour, alpha) = match kind {
tiff::ColorType::CMYKA(8 | 16) => (5, 4, true),
tiff::ColorType::Multiband { bit_depth: 8 | 16, num_samples: n @ 2.. } if matches!(photometric, Some(0 | 1)) => {
(usize::from(n), 1, matches!(extra, Some(1 | 2)))
}
let extras = extra_samples(&mut d);
// The first extra sample named as alpha: (its place among the extra samples, is it associated?)
let named = extras.iter().position(|e| matches!(e, 1 | 2)).map(|i| (i, extras.get(i) == Some(&1)));
// The samples of a pixel that no ExtraSamples value counts.
let uncounted = d.find_tag_unsigned::<u16>(Tag::SamplesPerPixel).ok().flatten().and_then(|all| usize::from(all).checked_sub(extras.len()));
// (how many of a pixel's samples are its color, the alpha among the extra samples)
let (colour, alpha) = match kind {
Some(tiff::ColorType::CMYKA(8 | 16)) => (4, if extras.is_empty() { Some((0, false)) } else { named }),
Some(tiff::ColorType::CMYK(8 | 16)) if named.is_some() => (4, named),
Some(tiff::ColorType::Multiband { bit_depth: 8 | 16, num_samples: 2.. }) if matches!(photometric, Some(0 | 1)) => (1, named),
None if photometric == Some(5) && uncounted.is_some_and(|c| c > 5) => (4, named),
_ => return None,
};
let n = usize::try_from(pixels(w, h)?).ok()?;
let data = read_samples_at_depth(&mut d, n, samples)?;
// The decoder gives a CMYK pixel its inks and at most one extra sample, and doesn't read
// white-is-zero gray with extra samples: those are read as black-is-zero gray, every sample.
let given = kind.map_or(0, |k| usize::from(k.num_samples()));
let (data, samples) = if photometric == Some(0) || kind.is_none() || alpha.is_some_and(|(i, _)| colour + i >= given) {
let mut d = tiff::decoder::Decoder::new(as_black_is_zero(bytes)?).ok()?;
let tiff::ColorType::Multiband { bit_depth: bits @ (8 | 16), num_samples } = d.colortype().ok()? else { return None };
let samples = usize::from(num_samples);
(decode_samples(&mut with_room(d, bytes.len(), n, samples, bits)?, n, samples)?, samples)
} else {
(decode_samples(&mut with_room(d, bytes.len(), n, given, kind?.bit_depth())?, n, given)?, given)
};
// (the alpha's sample in a pixel, is it associated?), when the pixel has that sample.
let alpha = alpha.map(|(i, associated)| (colour + i, associated)).filter(|(at, _)| *at < samples);
// Sample `i` of the image, 0..1.
let level_at = |i: usize| match &data {
Samples::Eight(v) => v.get(i).map(|&s| f32::from(s) / 255.0),
@@ -772,13 +986,16 @@ pub fn extra_samples_tiff_rgba(bytes: &[u8], rgb: impl Fn([f32; 4]) -> [f32; 3])
};
let mut out = Vec::with_capacity(n.checked_mul(4)?);
for first in (0..n).map(|p| p * samples) {
let (opacity, a) = if alpha { (byte_at(first + colour).unwrap_or(u8::MAX), level_at(first + colour).unwrap_or(1.0)) } else { (u8::MAX, 1.0) };
let (opacity, a) = match alpha {
Some((at, _)) => (byte_at(first + at).unwrap_or(u8::MAX), level_at(first + at).unwrap_or(1.0)),
None => (u8::MAX, 1.0),
};
let level = |s: usize| {
let v = level_at(first + s).unwrap_or(0.0);
match extra {
Some(1) if a > 0.0 => (v / a).min(1.0),
match alpha {
Some((_, true)) if a > 0.0 => (v / a).min(1.0),
// No associated alpha: the color is zero (TIFF 6.0, Associated Alpha Handling).
Some(1) if alpha => 0.0,
Some((_, true)) => 0.0,
_ => v,
}
};
@@ -1083,6 +1300,380 @@ mod tests {
assert_eq!(gray.into_raw(), [0, 0, 0, 0], "a gray of zero");
}
/// A pixel type of `$n` samples of `$inner`, `$bits` bits each, in color space `$space`.
macro_rules! samples {
($name:ident, $inner:ty, $space:ident, $bits:literal, $n:literal) => {
struct $name;
impl tiff::encoder::colortype::ColorType for $name {
type Inner = $inner;
const TIFF_VALUE: tiff::tags::PhotometricInterpretation = tiff::tags::PhotometricInterpretation::$space;
const BITS_PER_SAMPLE: &'static [u16] = &[$bits; $n];
const SAMPLE_FORMAT: &'static [tiff::tags::SampleFormat] = &[tiff::tags::SampleFormat::Uint; $n];
fn horizontal_predict(row: &[$inner], result: &mut Vec<$inner>) {
result.extend_from_slice(row);
}
}
};
}
samples!(Cmyk6x8, u8, CMYK, 8, 6);
samples!(Cmyk6x16, u16, CMYK, 16, 6);
samples!(Cmyk7x8, u8, CMYK, 8, 7);
samples!(Cmyk8x8, u8, CMYK, 8, 8);
samples!(Gray3x8, u8, BlackIsZero, 8, 3);
samples!(WhiteGray2x8, u8, WhiteIsZero, 8, 2);
/// A one-row TIFF of `C`'s pixels `data`, with the ExtraSamples values `extra`.
fn extras_tiff<C: tiff::encoder::colortype::ColorType>(extra: &[u16], data: &[C::Inner]) -> Vec<u8>
where
[C::Inner]: tiff::encoder::TiffValue,
{
let samples = C::BITS_PER_SAMPLE.len();
let mut file = Cursor::new(Vec::new());
let mut enc = tiff::encoder::TiffEncoder::new(&mut file).unwrap();
let mut img = enc.new_image::<C>(u32::try_from(data.len() / samples).unwrap(), 1).unwrap();
img.encoder().write_tag(tiff::tags::Tag::ExtraSamples, extra).unwrap();
img.write_data(data).unwrap();
file.into_inner()
}
/// Two pixels of four inks with an alpha sample and another extra sample, the alpha first when
/// `alpha_first`: cyan at an alpha of 128 (or premultiplied, at 128 of cyan when `associated`)
/// with an extra sample of 9, then black, opaque, with an extra sample of 64.
fn inks_alpha_and_extra(alpha_first: bool, associated: bool) -> Vec<u16> {
let cyan = if associated { 128 } else { 255 };
let px = |inks: [u16; 4], alpha: u16, other: u16| {
let extras = if alpha_first { [alpha, other] } else { [other, alpha] };
[&inks[..], &extras[..]].concat()
};
[px([cyan, 0, 0, 0], 128, 9), px([0, 0, 0, 255], 255, 64)].concat()
}
/// A CMYK TIFF whose pixels have alpha and another extra sample reads the sample its
/// ExtraSamples names as alpha, first or second, at 8 and 16 bits, and leaves the other out.
/// Open and Place don't keep its inks. A blob that holds the file, as a document saved with it
/// as a CMYK image does, is a CMYK image with those inks when the alpha is the second extra
/// sample.
#[test]
fn a_cmyk_tiff_with_alpha_and_another_extra_sample_reads_its_alpha() {
let naive = |[c, m, y, k]: [f32; 4]| [(1.0 - c) * (1.0 - k), (1.0 - m) * (1.0 - k), (1.0 - y) * (1.0 - k)];
for extra in [[1, 0], [2, 0], [0, 1], [0, 2]] {
let data = inks_alpha_and_extra(extra[0] != 0, extra.contains(&1));
let eight: Vec<u8> = data.iter().map(|&v| u8::try_from(v).unwrap()).collect();
let sixteen: Vec<u16> = data.iter().map(|&v| v * 257).collect();
for (bits, bytes) in [(8, extras_tiff::<Cmyk6x8>(&extra, &eight)), (16, extras_tiff::<Cmyk6x16>(&extra, &sixteen))] {
let px = extra_samples_tiff_rgba(&bytes, naive).unwrap_or_else(|| panic!("{extra:?}, {bits} bits: reads"));
assert_eq!(px.into_raw(), [0, 255, 255, 128, 0, 0, 0, 255], "{extra:?}, {bits} bits: cyan at half alpha, then black");
assert!(stored_cmyk_tiff(&bytes, None).is_none(), "{extra:?}, {bits} bits: the inks can't be kept with the alpha");
let b = ImageBlob::new("image/tiff", bytes);
if extra[0] != 0 {
// The decoder gives these the color type of CMYK with alpha.
assert!(!b.is_cmyk() && b.cmyk().is_none(), "{extra:?}, {bits} bits: never stored as inks");
continue;
}
assert!(b.is_cmyk(), "{extra:?}, {bits} bits: a stored one stays a CMYK image");
assert_eq!(b.is_cmyk16(), bits == 16, "{extra:?}, {bits} bits");
let cyan = u8::try_from(data[0]).unwrap();
assert_eq!(b.cmyk().map(|i| i.data), Some(vec![cyan, 0, 0, 0, 0, 0, 0, 255]), "{extra:?}, {bits} bits: a stored one keeps its inks");
}
}
// Two extra samples, neither of them alpha: the inks are kept, as with one.
let bytes = extras_tiff::<Cmyk6x8>(&[0, 0], &[255, 0, 0, 0, 9, 128, 0, 0, 0, 255, 64, 255]);
assert!(extra_samples_tiff_rgba(&bytes, naive).is_none(), "not alpha: not this reader's");
assert!(stored_cmyk_tiff(&bytes, None).is_some());
let b = ImageBlob::new("image/tiff", bytes);
assert!(b.is_cmyk() && !b.is_cmyk16());
assert_eq!(b.cmyk().map(|i| i.data), Some(vec![255, 0, 0, 0, 0, 0, 0, 255]));
}
/// A CMYK TIFF of six samples a pixel whose ExtraSamples has only one value: the sample after
/// the inks is alpha only when that value says so, and the sample after it is never alpha. Files
/// with more samples than the decoder gives a color type read the same way, opaque when no
/// value names an alpha.
#[test]
fn a_cmyk_tiff_with_fewer_extra_sample_values_than_samples_reads_only_a_named_alpha() {
let naive = |[c, m, y, k]: [f32; 4]| [(1.0 - c) * (1.0 - k), (1.0 - m) * (1.0 - k), (1.0 - y) * (1.0 - k)];
let data = [255, 0, 0, 0, 128, 9, 0, 0, 0, 255, 255, 64];
let read = |extra: u16| extra_samples_tiff_rgba(&extras_tiff::<Cmyk6x8>(&[extra], &data), naive).expect("reads").into_raw();
assert_eq!(read(2), [0, 255, 255, 128, 0, 0, 0, 255], "the sample after the inks is the alpha");
assert_eq!(read(0), [0, 255, 255, 255, 0, 0, 0, 255], "not alpha: opaque");
// Eight samples with two values: the decoder gives the file no color type. The second
// value names the sixth sample as the alpha.
let wide = [255, 0, 0, 0, 9, 128, 17, 18];
let px = extra_samples_tiff_rgba(&extras_tiff::<Cmyk8x8>(&[0, 2], &wide), naive).expect("reads");
assert_eq!(px.into_raw(), [0, 255, 255, 128], "cyan at the alpha the second value names");
let px = extra_samples_tiff_rgba(&extras_tiff::<Cmyk8x8>(&[0, 0], &wide), naive).expect("no value names an alpha: reads");
assert_eq!(px.into_raw(), [0, 255, 255, 255], "no value names an alpha: opaque cyan");
// Six samples and no ExtraSamples tag: the decoder gives the file no color type either.
let mut file = Cursor::new(Vec::new());
let mut enc = tiff::encoder::TiffEncoder::new(&mut file).unwrap();
enc.write_image::<Cmyk6x8>(1, 1, &wide[..6]).unwrap();
let px = extra_samples_tiff_rgba(&file.into_inner(), naive).expect("no ExtraSamples tag: reads");
assert_eq!(px.into_raw(), [0, 255, 255, 255], "no ExtraSamples tag: opaque cyan");
// Seven samples with two values: the decoder reads it as CMYK with alpha.
let px = extra_samples_tiff_rgba(&extras_tiff::<Cmyk7x8>(&[0, 2], &wide[..7]), naive).expect("reads");
assert_eq!(px.into_raw(), [0, 255, 255, 128], "seven samples: cyan at the alpha the second value names");
// Its Orientation tag is read too.
let mut file = Cursor::new(Vec::new());
let mut enc = tiff::encoder::TiffEncoder::new(&mut file).unwrap();
let mut img = enc.new_image::<Cmyk8x8>(1, 1).unwrap();
img.encoder().write_tag(tiff::tags::Tag::ExtraSamples, &[0u16, 2][..]).unwrap();
img.encoder().write_tag(tiff::tags::Tag::Orientation, 6u16).unwrap();
img.write_data(&wide).unwrap();
let turned = file.into_inner();
assert_eq!(tiff_orientation(&turned), Some(6));
assert_eq!(exif_orientation(&turned), Some(image::metadata::Orientation::Rotate90));
}
/// A white-is-zero grayscale TIFF `width` pixels wide and `rows` tall (2 or more), each pixel
/// `samples` samples of 8 bits: a level of 0, an unassociated alpha of 128, then zeros. Each
/// row is a strip, and every strip is the same bytes of the file.
fn tall_gray_tiff(width: u32, rows: u32, samples: u16) -> Vec<u8> {
gray_tiff(width, rows, samples, false)
}
/// [`tall_gray_tiff`], or with `planar` one plane per sample, each row of each plane a strip
/// of zeros, every strip the same bytes of the file.
fn gray_tiff(width: u32, rows: u32, samples: u16, planar: bool) -> Vec<u8> {
let at = |f: &Vec<u8>| u32::try_from(f.len()).unwrap();
let mut f = b"II*\0\0\0\0\0".to_vec();
let row = at(&f);
if planar {
f.resize(f.len() + usize::try_from(width).unwrap(), 0);
} else {
for _ in 0..width {
f.extend([0, 128]);
f.resize(f.len() + usize::from(samples) - 2, 0);
}
}
let (strips, strip) = if planar { (rows * u32::from(samples), width) } else { (rows, width * u32::from(samples)) };
let offsets = at(&f);
f.extend((0..strips).flat_map(|_| row.to_le_bytes()));
let counts = at(&f);
f.extend((0..strips).flat_map(|_| strip.to_le_bytes()));
let ifd = at(&f);
f[4..8].copy_from_slice(&ifd.to_le_bytes());
// (tag, type (3 SHORT, 4 LONG), count, value or offset)
let entries = [
(256u16, 4u16, 1, width),
(257, 4, 1, rows),
(258, 3, 1, 8),
(259, 3, 1, 1),
(262, 3, 1, 0),
(273, 4, strips, offsets),
(277, 3, 1, u32::from(samples)),
(278, 4, 1, 1),
(279, 4, strips, counts),
(284, 3, 1, if planar { 2 } else { 1 }),
(338, 3, 1, 2),
];
f.extend(u16::try_from(entries.len()).unwrap().to_le_bytes());
for (tag, ty, count, value) in entries {
f.extend([tag.to_le_bytes(), ty.to_le_bytes()].concat());
f.extend([count.to_le_bytes(), value.to_le_bytes()].concat());
}
f.extend([0; 4]);
f
}
/// A TIFF with extra samples whose samples take more than the decoder's own limit of 256 MiB
/// reads: here 256 × 16,385 pixels of 64 samples, 16,384 bytes more than the limit.
#[test]
fn a_tiff_with_extra_samples_past_the_decoders_limit_reads() {
let (width, rows, samples) = (256, 16_385, 64);
assert!(u64::from(width * rows) * u64::from(samples) > 256 << 20);
let px = extra_samples_tiff_rgba(&tall_gray_tiff(width, rows, samples), |_| [0.0; 3]).expect("reads");
assert_eq!((px.width(), px.height()), (width, rows));
assert!(px.pixels().all(|p| p.0 == [255, 255, 255, 128]), "white at an alpha of 128");
}
/// A pixel of more than [`MAX_EXTRA_SAMPLES_PIXEL`] samples is not read.
#[test]
fn a_tiff_with_too_many_samples_a_pixel_is_not_read() {
let samples = u16::try_from(MAX_EXTRA_SAMPLES_PIXEL).unwrap();
assert!(extra_samples_tiff_rgba(&tall_gray_tiff(2, 2, samples), |_| [0.0; 3]).is_some(), "at the limit: reads");
assert!(extra_samples_tiff_rgba(&tall_gray_tiff(2, 2, samples + 1), |_| [0.0; 3]).is_none(), "past it: not read");
}
/// The header of a one-row CMYK TIFF `width` pixels wide, each pixel `samples` samples of
/// `bits` bits stored together, with the ExtraSamples values `extras` (more than two). Its one
/// strip claims every sample of the row, uncompressed, and holds four bytes of zeros.
fn cmyk_header(width: u32, samples: u16, bits: u16, extras: &[u16]) -> Vec<u8> {
assert!(extras.len() > 2, "the values sit outside the entry");
let mut f = b"II*\0\0\0\0\0".to_vec();
f.extend([0; 4]);
let at = u32::try_from(f.len()).unwrap();
f.extend(extras.iter().flat_map(|e| e.to_le_bytes()));
let ifd = u32::try_from(f.len()).unwrap();
f[4..8].copy_from_slice(&ifd.to_le_bytes());
let strip = u32::try_from(u64::from(width) * u64::from(samples) * u64::from(bits / 8)).unwrap();
// (tag, type (3 SHORT, 4 LONG), count, value or offset)
let entries = [
(256u16, 4u16, 1, width),
(257, 4, 1, 1),
(258, 3, 1, u32::from(bits)),
(259, 3, 1, 1),
(262, 3, 1, 5),
(273, 4, 1, 8),
(277, 3, 1, u32::from(samples)),
(278, 4, 1, 1),
(279, 4, 1, strip),
(284, 3, 1, 1),
(338, 3, u32::try_from(extras.len()).unwrap(), at),
];
f.extend(u16::try_from(entries.len()).unwrap().to_le_bytes());
for (tag, ty, count, value) in entries {
f.extend([tag.to_le_bytes(), ty.to_le_bytes()].concat());
f.extend([count.to_le_bytes(), value.to_le_bytes()].concat());
}
f.extend([0; 4]);
f
}
/// A CMYK TIFF whose first ExtraSamples value is alpha has the color type of CMYK with alpha,
/// five samples, however many samples its pixels have; one with more than
/// [`MAX_EXTRA_SAMPLES_PIXEL`] is refused from its tags, before the decoder takes a row of
/// every sample (here 8,192 × 65,535 × 2 bytes, 1 GiB). Neither is it read as inks.
#[test]
fn a_cmyk_tiff_with_more_samples_a_pixel_than_the_limit_is_refused_before_decoding() {
let (width, samples) = (8192u32, u16::MAX);
for first in [1u16, 0] {
let extras: Vec<u16> = std::iter::once(first).chain(std::iter::repeat_n(0, usize::from(samples) - 5)).collect();
let bytes = cmyk_header(width, samples, 16, &extras);
let mut d = tiff::decoder::Decoder::new(Cursor::new(&bytes[..])).unwrap();
let kind = d.colortype().unwrap();
assert_eq!(kind, if first == 1 { tiff::ColorType::CMYKA(16) } else { tiff::ColorType::CMYK(16) });
assert_eq!(row_buffer(&mut d), None, "{kind:?}: refused from the tags");
let given = usize::from(kind.num_samples());
assert!(with_room(d, bytes.len(), usize::try_from(width).unwrap(), given, 16).is_none(), "{kind:?}: refused before the decode");
assert!(extra_samples_tiff_rgba(&bytes, |_| [0.0; 3]).is_none(), "{kind:?}");
assert!(ImageBlob::new("image/tiff", bytes).cmyk().is_none(), "{kind:?}: no inks");
}
}
/// The row the decoder reads each strip of a CMYK TIFF with alpha into, every sample of the
/// row, counts in the allowance: 2²⁴ pixels of 64 16-bit samples, whose five decoded samples
/// and RGBA pixels fit but not with that row of 2 GiB.
#[test]
fn the_decoders_row_of_every_sample_counts_in_the_allowance() {
let width = 1u32 << 24;
let samples = u16::try_from(MAX_EXTRA_SAMPLES_PIXEL).unwrap();
let extras: Vec<u16> = std::iter::once(2).chain(std::iter::repeat_n(0, usize::from(samples) - 5)).collect();
let bytes = cmyk_header(width, samples, 16, &extras);
let n = usize::try_from(width).unwrap();
let (need, rgba, row) = (u64::from(width) * 5 * 2, u64::from(width) * 4, u64::from(width) * u64::from(samples) * 2);
assert!(need + rgba <= crate::MAX_RASTER_ALLOC && need + rgba + row > crate::MAX_RASTER_ALLOC);
let mut d = tiff::decoder::Decoder::new(Cursor::new(&bytes[..])).unwrap();
assert_eq!(d.colortype().unwrap(), tiff::ColorType::CMYKA(16));
assert_eq!(row_buffer(&mut d), Some(row));
assert!(with_room(d, bytes.len(), n, 5, 16).is_none(), "refused before the decode");
assert!(extra_samples_tiff_rgba(&bytes, |_| [0.0; 3]).is_none());
}
/// A TIFF whose samples aren't unsigned integers is refused from its tags.
#[test]
fn a_tiff_of_float_samples_is_refused_from_its_tags() {
use tiff::encoder::colortype::{Gray8, Gray32Float};
let mut file = Cursor::new(Vec::new());
tiff::encoder::TiffEncoder::new(&mut file).unwrap().write_image::<Gray32Float>(2, 1, &[0.25, 0.5]).unwrap();
let float = file.into_inner();
let mut d = tiff::decoder::Decoder::new(Cursor::new(&float[..])).unwrap();
assert_eq!(row_buffer(&mut d), None, "floats: refused");
assert!(read_samples_at_depth(&mut d, 2, 1).is_none());
let mut file = Cursor::new(Vec::new());
tiff::encoder::TiffEncoder::new(&mut file).unwrap().write_image::<Gray8>(2, 1, &[64, 128]).unwrap();
let bytes = file.into_inner();
let mut d = tiff::decoder::Decoder::new(Cursor::new(&bytes[..])).unwrap();
assert_eq!(row_buffer(&mut d), Some(0), "unsigned: no extra row");
assert_eq!(read_samples_at_depth(&mut d, 2, 1), Some(Samples::Eight(vec![64, 128])));
}
/// The copy that puts a planar file's samples pixel by pixel is allocated at its length, so
/// the reader holds no more than the allowance counts. 33 samples: a copy that grew as it
/// was filled would hold room for 64.
#[test]
fn the_planar_copy_is_allocated_at_its_length() {
let (n, per) = (11u8, 3u8);
let data: Vec<u8> = (0..n * per).collect();
let len = data.len();
let out = chunky(data, usize::from(per), usize::from(n), usize::from(per)).unwrap();
let pixel_by_pixel: Vec<u8> = (0..n).flat_map(|i| (0..per).map(move |p| p * n + i)).collect();
assert_eq!(out, pixel_by_pixel);
assert!(out.capacity() >= len && out.capacity() < len.next_power_of_two(), "capacity {} for {len} samples", out.capacity());
}
/// A TIFF whose decoded samples fit [`crate::MAX_RASTER_ALLOC`] but not with its RGBA pixels
/// beside them is refused before its samples are decoded; so is one whose samples fit with
/// the RGBA pixels but not with the copy a planar file needs. The file holds one row of pixels,
/// which every strip reuses.
#[test]
fn a_tiff_whose_decode_with_its_rgba_takes_more_than_the_allowance_is_refused() {
let side = 8192u32;
let n = usize::try_from(u64::from(side) * u64::from(side)).unwrap();
assert_eq!(u64::try_from(n).unwrap(), MAX_CMYK_PIXELS);
let max = usize::try_from(crate::MAX_RASTER_ALLOC).unwrap();
// One sample fewer than fills the allowance: the samples alone fit.
let per = max / n - 1;
assert!(n * per <= max && n * per + 4 * n > max);
let bytes = tall_gray_tiff(side, side, u16::try_from(per).unwrap());
let decoder = || tiff::decoder::Decoder::new(Cursor::new(&bytes[..])).unwrap();
assert!(with_room(decoder(), bytes.len(), n, per, 8).is_none(), "refused before the decode");
assert!(extra_samples_tiff_rgba(&bytes, |_| [0.0; 3]).is_none());
// Half the allowance in samples fits with the RGBA pixels, but not twice over.
let half = max / n / 2;
assert!(with_room(decoder(), bytes.len(), n, half, 8).is_some(), "stored together: fits");
let planar = gray_tiff(side, side, u16::try_from(half).unwrap(), true);
let decoder = tiff::decoder::Decoder::new(Cursor::new(&planar[..])).unwrap();
assert!(with_room(decoder, planar.len(), n, half, 8).is_none(), "one plane per sample: refused");
}
/// Patched bytes read the same whole, a byte at a time and after a seek into a patch.
#[test]
fn patched_bytes_read_with_their_patches() {
use std::io::{Read, Seek, SeekFrom};
let bytes: Vec<u8> = (10..30).collect();
let patched = || Patched { bytes: Cursor::new(&bytes[..]), patches: vec![(4, &[1, 0]), (19, &[7, 7])] };
let want = [10, 11, 12, 13, 1, 0, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 7];
let mut whole = Vec::new();
patched().read_to_end(&mut whole).unwrap();
assert_eq!(whole, want);
let mut one = patched();
let bytewise: Vec<u8> = (0..want.len())
.map(|_| {
let mut b = [0];
assert_eq!(one.read(&mut b).unwrap(), 1);
b[0]
})
.collect();
assert_eq!(bytewise, want);
let mut from = patched();
from.seek(SeekFrom::Start(5)).unwrap();
let mut b = [9; 3];
from.read_exact(&mut b).unwrap();
assert_eq!(b, [0, 16, 17], "the second byte of the first patch, then the file");
}
/// A grayscale TIFF whose alpha follows another extra sample reads that alpha.
#[test]
fn a_grayscale_tiff_with_alpha_after_another_extra_sample_reads_its_alpha() {
let read =
|extra: [u16; 2], data: &[u8]| extra_samples_tiff_rgba(&extras_tiff::<Gray3x8>(&extra, data), |_| [0.0; 3]).expect("reads").into_raw();
// A gray of 64 at an alpha of 204 (premultiplied: 51), with an extra sample of 9.
assert_eq!(read([0, 2], &[64, 9, 204]), [64, 64, 64, 204], "unassociated");
assert_eq!(read([0, 1], &[51, 9, 204]), [64, 64, 64, 204], "associated, divided back out");
assert_eq!(read([2, 0], &[64, 204, 9]), [64, 64, 64, 204], "the alpha first");
assert_eq!(read([0, 0], &[64, 9, 204]), [64, 64, 64, 255], "no alpha: opaque");
}
/// A grayscale TIFF whose white is zero (PhotometricInterpretation 0), with alpha, reads with
/// its levels turned around.
#[test]
fn a_white_is_zero_grayscale_tiff_with_alpha_reads_as_rgba() {
// White, opaque; black at an alpha of 128.
let bytes = extras_tiff::<WhiteGray2x8>(&[2], &[0, 255, 255, 128]);
let px = extra_samples_tiff_rgba(&bytes, |_| [0.0; 3]).expect("reads");
assert_eq!(px.into_raw(), [255, 255, 255, 255, 0, 0, 0, 128]);
}
/// A header claiming more tiles than can be counted: (2^32 − 1)² pixels in tiles of one pixel,
/// times 2 planes.
#[test]
+15
View File
@@ -79,6 +79,21 @@ fn odd_text_reads_as_nothing_without_panicking() {
}
}
/// Text from a command or a file can be any length: a sum of thousands of terms reads as nothing
/// instead of exhausting the stack. Up to 128 `+ - * /` signs read; 129 read as nothing.
#[test]
fn a_very_long_expression_reads_as_nothing() {
let sum = |terms: usize| format!("1{}", "+1".repeat(terms - 1));
assert_eq!(Unit::Points.parse(&sum(129)), Some(129.0));
assert_eq!(Unit::Points.parse(&format!("10{} mm", "*1".repeat(128))), Some(Unit::Millimeters.to_pt(10.0)));
// Long text with no signs still reads.
assert_eq!(Unit::Points.parse(&format!("{}5", " ".repeat(2_000))), Some(5.0));
for text in [sum(200_000), format!("1{}", "*1".repeat(200_000)), sum(130), format!("10{} mm", "*1".repeat(129))] {
assert_eq!(Unit::Points.parse(&text), None, "{} bytes", text.len());
assert_eq!(crate::parse_number(&text), None, "{} bytes", text.len());
}
}
proptest! {
/// Field text made of digits, operators, `%`, spaces and unit letters reads as a finite value
/// or as nothing and does not panic.
+8
View File
@@ -156,7 +156,12 @@ impl Unit {
/// before it (`3cm*50%` is 1.5 cm, `3cm/50%` is 6 cm). After `+` or `-`, it adds or takes away
/// that share of everything before it (`50pt+25%` is 62.5 pt, `100pt+20pt-50%` is 60 pt). A
/// percentage on its own (`50%`) reads as nothing.
///
/// Text with more than 128 `+ - * /` signs reads as nothing.
pub fn parse(self, s: &str) -> Option<f64> {
if s.chars().filter(|c| matches!(c, '+' | '-' | '*' | '/')).count() > MAX_MEASURE_OPERATORS {
return None;
}
parse_measure(s, self).filter(|v| v.is_finite())
}
/// The value naming this unit in the Units preferences (`points`, `millimeters`,
@@ -207,6 +212,9 @@ impl Unit {
}
}
/// The most `+ - * /` signs [`Unit::parse`] reads in one text.
const MAX_MEASURE_OPERATORS: usize = 128;
fn parse_measure(s: &str, default: Unit) -> Option<f64> {
let s = s.trim();
// Simple arithmetic on the right (Illustrator fields accept "10+5", "100/2", "3in*2").
+49 -12
View File
@@ -199,8 +199,19 @@ fn placed_fits(baked: &Node, spent: u64, dropped: u64) -> Option<u64> {
}
/// The names of the symbols of `d` whose art needs baking ([`needs_bake`]), and of those whose art
/// holds an instance of one of them at any depth.
/// holds an instance of one of them at any depth, in the art of enabled opacity masks too.
fn drawn_symbols(d: &Document) -> HashSet<String> {
fn used(n: &Node, names: &mut Vec<String>) {
if let NodeKind::SymbolInstance { symbol, .. } = &n.kind {
names.push(symbol.clone());
}
if let Some(m) = n.extras().mask.as_ref().filter(|m| !m.disabled) {
used(&m.art, names);
}
for c in n.children().into_iter().flatten() {
used(c, names);
}
}
let mut out: HashSet<String> = d.symbols.iter().filter(|s| needs_bake(&s.art)).map(|s| s.name.clone()).collect();
if out.is_empty() {
return out;
@@ -211,11 +222,7 @@ fn drawn_symbols(d: &Document) -> HashSet<String> {
.filter(|s| !out.contains(&s.name))
.map(|s| {
let mut names = vec![];
s.art.walk(&mut |c| {
if let NodeKind::SymbolInstance { symbol, .. } = &c.kind {
names.push(symbol.clone());
}
});
used(&s.art, &mut names);
(s.name.as_str(), names)
})
.collect();
@@ -233,14 +240,22 @@ fn drawn_symbols(d: &Document) -> HashSet<String> {
}
/// Does `n`'s subtree hold an instance of a symbol that [`bake_document_placing_symbols`] replaces
/// by its placed art? False outside it, and for objects the export does not write ([`unwritten`]).
/// by its placed art, in the art of its enabled opacity masks too? False outside it, and for
/// objects the export does not write ([`unwritten`]).
fn holds_placed_symbol(n: &Node) -> bool {
fn walk(n: &Node, symbols: &HashSet<String>) -> bool {
placed_symbol_in(n, true)
}
/// [`holds_placed_symbol`], with the art of `n`'s own opacity mask left out unless `own_mask`
/// (the art of the masks inside `n` is always looked into).
fn placed_symbol_in(n: &Node, own_mask: bool) -> bool {
fn walk(n: &Node, symbols: &HashSet<String>, own_mask: bool) -> bool {
!unwritten(n)
&& (matches!(&n.kind, NodeKind::SymbolInstance { symbol, .. } if symbols.contains(symbol))
|| n.children().is_some_and(|ch| ch.iter().any(|c| walk(c, symbols))))
|| (own_mask && !n.is_ruler_guide() && n.extras().mask.as_ref().is_some_and(|m| !m.disabled && walk(&m.art, symbols, true)))
|| n.children().is_some_and(|ch| ch.iter().any(|c| walk(c, symbols, true))))
}
!UNWRITTEN.with(|c| c.get()) && PLACING.with(|p| p.borrow().as_ref().is_some_and(|p| walk(n, &p.symbols)))
!UNWRITTEN.with(|c| c.get()) && PLACING.with(|p| p.borrow().as_ref().is_some_and(|p| walk(n, &p.symbols, own_mask)))
}
/// Symbol instance `n`, while [`bake_document_placing_symbols`] bakes and its symbol is one it
@@ -278,8 +293,29 @@ fn placed_symbol_art(d: &Document, n: &Node) -> Option<(Node, u64)> {
Some((g, most))
}
/// `n` with its geometry effects evaluated (`None` = unchanged).
/// `n` with its geometry effects evaluated (`None` = unchanged), and the art of its enabled opacity
/// mask baked one level deeper when it holds instances that [`bake_document_placing_symbols`]
/// places ([`holds_placed_symbol`]), so the mask masks with the art the instances draw. The art is
/// baked only while the object baked from `n` still carries `n`'s mask art; art already baked
/// with `n`'s recolored or placed form is not baked again. A ruler guide's mask stays as it is.
fn bake_node(d: &mut Document, n: &Node) -> Option<Node> {
let out = bake_object(d, n);
let Some(mask) = n.extras().mask.as_ref().filter(|m| !m.disabled && !n.is_ruler_guide() && !unwritten(n) && holds_placed_symbol(&m.art)) else {
return out;
};
let changed = out.is_some();
let mut out = out.unwrap_or_else(|| n.clone());
let Some(slot) = out.extras_if_any().and_then(|e| e.mask.as_mut()).filter(|s| Arc::ptr_eq(&s.art, &mask.art)) else {
return changed.then_some(out);
};
let Some(art) = one_deeper(|| bake_node(d, &mask.art)) else { return changed.then_some(out) };
slot.art = Arc::new(art);
Some(out)
}
/// `n` with its geometry effects evaluated (`None` = unchanged); its opacity mask is left to
/// [`bake_node`].
fn bake_object(d: &mut Document, n: &Node) -> Option<Node> {
// Inside an object the export leaves out, effects are baked but no instance is placed.
if !UNWRITTEN.with(|c| c.get()) && unwritten(n) {
UNWRITTEN.with(|c| c.set(true));
@@ -289,7 +325,8 @@ fn bake_node(d: &mut Document, n: &Node) -> Option<Node> {
}
// A cancelled export leaves the rest of the document as it is: the caller drops the result.
// A ruler guide draws nothing and stays as it is, last in its layer.
if n.is_ruler_guide() || !(needs_bake(n) || holds_placed_symbol(n)) || vectorcraft_doc::cancel::is_cancelled() {
// An object whose own mask's art alone holds placed instances stays as it is here.
if n.is_ruler_guide() || !(needs_bake(n) || placed_symbol_in(n, false)) || vectorcraft_doc::cancel::is_cancelled() {
return None;
}
// Colour adjustments: the object recoloured (inside it too), then baked as it is.
+68
View File
@@ -1169,6 +1169,74 @@ fn placing_symbols_reaches_the_art_of_nested_instances() {
assert!(near_rect(bounds(&out, 900), Rect::new(110.0, 140.0, 120.0, 150.0)), "{:?}", bounds(&out, 900));
}
/// A 10 pt square with id `id`, masked by `art` (the mask enabled unless `disabled`).
fn masked_square(id: u64, art: Node, disabled: bool) -> Node {
let mut n = Node::path(NodeId(id), shapes::rectangle(Rect::new(0.0, 0.0, 10.0, 10.0)), Appearance::default_art());
let mut mask = vectorcraft_doc::OpacityMask::new(art, false);
mask.disabled = disabled;
n.extras_mut().mask = Some(Box::new(mask));
n
}
/// Whether the art of `n`'s opacity mask is still a symbol instance, and its bounds when it is not.
fn mask_art(n: &Node) -> (bool, Option<Rect>) {
let art = &n.extras().mask.as_ref().unwrap_or_else(|| panic!("node {:?} has a mask", n.id)).art;
(matches!(art.kind, NodeKind::SymbolInstance { .. }), art.geometric_bounds())
}
/// An instance in the art of an enabled opacity mask is placed and baked like any other, so the
/// mask masks with the art the instance draws, and the masked object stays as it is (a clipping
/// path stays one); one in a disabled mask, in the mask of an object the export leaves out, or in
/// a ruler guide's mask, stays as it is.
#[test]
fn placing_symbols_reaches_instances_in_opacity_masks() {
use vectorcraft_geom::Affine;
let mut d = doc_with(masked_square(700, instance(900, "S", Affine::IDENTITY), false));
let layer = d.layers[0].id;
d.insert(Some(layer), 1, masked_square(701, instance(901, "S", Affine::IDENTITY), true)).unwrap();
let mut hidden = masked_square(702, instance(902, "S", Affine::IDENTITY), false);
hidden.visible = false;
d.insert(Some(layer), 2, hidden).unwrap();
let mut clipping = masked_square(703, instance(903, "S", Affine::IDENTITY), false);
if let NodeKind::Path { clipping: c, .. } = &mut clipping.kind {
*c = true;
}
d.insert(Some(layer), 3, Node::group(NodeId(704), vec![Arc::new(clipping)])).unwrap();
let mut guide = Node::new(NodeId(705), NodeKind::RulerGuide { vertical: false, pos: 5.0, artboard: None });
guide.extras_mut().mask = Some(Box::new(vectorcraft_doc::OpacityMask::new(instance(905, "S", Affine::IDENTITY), false)));
d.insert(Some(layer), 4, guide).unwrap();
add_symbol(&mut d, "S", moved_square(800));
let out = bake_document_placing_symbols(&d, true, ALL).unwrap();
for id in [700, 703] {
let (still, b) = mask_art(out.node(NodeId(id)).unwrap());
assert!(!still && b.is_some_and(|b| near_rect(b, Rect::new(110.0, 40.0, 120.0, 50.0))), "{id}: {b:?}");
}
assert!(matches!(out.node(NodeId(703)).unwrap().kind, NodeKind::Path { clipping: true, .. }), "the clipping path stays one");
assert!(mask_art(out.node(NodeId(701)).unwrap()).0, "a disabled mask's instance stays");
assert!(mask_art(out.node(NodeId(702)).unwrap()).0, "a hidden object's mask's instance stays");
assert!(mask_art(out.node(NodeId(705)).unwrap()).0, "a ruler guide's mask's instance stays");
}
/// A symbol whose art holds an instance only in an opacity mask's art is placed too, and the
/// instance in its mask is placed with it.
#[test]
fn placing_symbols_reaches_instances_in_the_masks_of_symbol_art() {
use vectorcraft_geom::Affine;
let mut d = doc_with(instance(900, "Outer", Affine::IDENTITY));
add_symbol(&mut d, "Inner", moved_square(800));
add_symbol(&mut d, "Outer", masked_square(803, instance(802, "Inner", Affine::IDENTITY), false));
let out = bake_document_placing_symbols(&d, true, ALL).unwrap();
assert!(!is_instance(&out, 900), "the outer instance is placed");
let mut found = None;
out.node(NodeId(900)).unwrap().walk(&mut |n| {
if n.id == NodeId(803) {
found = Some(mask_art(n));
}
});
let (still, b) = found.unwrap_or_else(|| panic!("the masked square is in the placed art"));
assert!(!still && b.is_some_and(|b| near_rect(b, Rect::new(110.0, 40.0, 120.0, 50.0))), "{b:?}");
}
/// A symbol whose art holds an instance of itself is placed until the depth limit, and the export
/// ends.
#[test]
+3 -3
View File
@@ -417,7 +417,7 @@ pub fn effect_catalog() -> Vec<EffectInfo> {
"artistic.roughPastels",
"Rough Pastels…",
ARTISTIC,
"{strokeLength: 0..40 (6; longer pastel strokes), strokeDetail: 1..20 (10; bristle texture along the strokes), texture: \"brick\"|\"burlap\"|\"canvas\"|\"sandstone\" (\"canvas\"), scaling: % 50..200 (100), relief: 0..50 (4), lightDirection: \"bottom\"|\"bottomLeft\"|\"left\"|\"topLeft\"|\"top\"|\"topRight\"|\"right\"|\"bottomRight\" (\"top\"), invert: bool (false)} repaints the object in soft diagonal pastel strokes over a textured surface, keeping its coverage. Slider ranges follow the documented controls; numeric defaults are chosen for VectorCraft and are not verified against proprietary defaults.",
"{strokeLength: 0..40 (6; longer pastel strokes), strokeDetail: 1..20 (10; bristle texture along the strokes), texture: \"brick\"|\"burlap\"|\"canvas\"|\"sandstone\"|\"loaded\" (\"canvas\"; \"loaded\" draws the image in textureImage and draws Canvas when there is none; the others are surfaces made in code), textureImage?: {path} | {name?, dataBase64} | string (Load Texture…: an image file that File › Place reads, within the renderer's pixel allowance, stored as its gray levels in a grayscale PNG in base64; a file sets texture to \"loaded\" unless texture is given, and the stored string, as effect.list gives it, is kept as it is), scaling: % 50..200 (100), relief: 0..50 (4), lightDirection: \"bottom\"|\"bottomLeft\"|\"left\"|\"topLeft\"|\"top\"|\"topRight\"|\"right\"|\"bottomRight\" (\"top\"), invert: bool (false)} repaints the object in soft diagonal pastel strokes over a textured surface, keeping its coverage. A loaded texture lies one image pixel per point at 100 %, centered on the object's center and repeated; each pixel's luma is the surface's height, from 0 for black to 1 pt for white, and a transparent pixel counts as middle gray. Slider ranges follow the documented controls; numeric defaults are chosen for VectorCraft and are not verified against proprietary defaults.",
json!({
"strokeLength": 6.0,
"strokeDetail": 10.0,
@@ -468,8 +468,8 @@ pub fn effect_catalog() -> Vec<EffectInfo> {
"blur.radial",
"Radial Blur…",
BLUR,
"{amount: 1..100 (10; spin: an arc of `amount`°, zoom: the content scaled by up to about ±amount/2 %), method: \"spin\"|\"zoom\" (\"spin\"), quality: \"draft\"|\"good\"|\"best\" (\"good\"; 16, 64 or 256 samples)} blurs around the object's centre",
json!({"amount": 10.0, "method": "spin", "quality": "good"}),
"{amount: 1..100 (10; spin: an arc of `amount`°, zoom: the content scaled by up to about ±amount/2 %), method: \"spin\"|\"zoom\" (\"spin\"), quality: \"draft\"|\"good\"|\"best\" (\"good\"; 16, 64 or 256 samples), centerX: 0..1 (0.5; the Blur Center across the object's bounds, 0 their left edge), centerY: 0..1 (0.5; the Blur Center down the object's bounds, 0 their top edge)} blurs around the Blur Center, which moves and scales with the object. A centerX or centerY outside 0..1 is refused",
json!({"amount": 10.0, "method": "spin", "quality": "good", "centerX": 0.5, "centerY": 0.5}),
),
r(
"blur.smart",
+22 -16
View File
@@ -30,7 +30,7 @@ mod texture;
mod video;
use serde_json::Value;
use vectorcraft_geom::{Affine, Point, Rect};
use vectorcraft_geom::{Affine, Point, Rect, Vec2};
use crate::util::{flag, num, text};
@@ -155,12 +155,14 @@ pub enum PixelFx {
/// `texture_coverage` (0..40) says.
Underpainting { brush_size: f64, texture_coverage: f64, texture: Texture, scaling: f64, relief: f64, light: Light, invert: bool },
/// Artistic › Rough Pastels: diagonal pastel strokes `length` (0..40) long, bristle detail
/// (1..20), then a [`Texture`] surface scaled by `scaling` (0.5..2), in relief as strong as
/// `relief` (0..50) and lit from `light`; `invert` turns the surface's heights over.
/// (1..20), then a [`Texture`] surface (a loaded one included) scaled by `scaling` (0.5..2), in
/// relief as strong as `relief` (0..50) and lit from `light`; `invert` turns the surface's
/// heights over.
RoughPastels { length: f64, detail: f64, texture: Texture, scaling: f64, relief: f64, light: Light, invert: bool },
/// Blur › Radial Blur around the object's centre: along arcs (spin, an arc of `amount`°) or
/// along rays (zoom, the content scaled by up to about ±`amount`/2 %), averaging 2^`passes` samples.
RadialBlur { amount: f64, zoom: bool, passes: u32 },
/// Blur › Radial Blur around its Blur Center, `center` (0..1 across and down the object's
/// bounds; (0.5, 0.5) the object's centre): along arcs (spin, an arc of `amount`°) or along
/// rays (zoom, the content scaled by up to about ±`amount`/2 %), averaging 2^`passes` samples.
RadialBlur { amount: f64, zoom: bool, passes: u32, center: [f64; 2] },
/// Blur › Smart Blur (Normal mode): each pixel averaged with the neighbours within `radius`
/// whose colour differs from its own by no more than `threshold` levels, over a grid of
/// `samples` × `samples` neighbours at most.
@@ -314,9 +316,12 @@ pub struct PixelSpace {
pub to_doc: Affine,
/// The size of a pixel in document units.
pub px: f64,
/// The object's centre (document coordinates): where Radial Blur blurs around, and where the
/// Pixelate filters' patterns are anchored (so they move with the object).
/// The object's centre (document coordinates): where Radial Blur blurs around by default, and
/// where the Pixelate filters' patterns are anchored (so they move with the object).
pub center: Point,
/// The width and height of the object's bounds (document units), centred on `center`: Radial
/// Blur's Blur Center lies at a share of them.
pub size: Vec2,
/// What the colour channels hold.
pub channels: Channels,
/// The height of a line of the document's raster grid (document units: 72 / Document Raster
@@ -381,7 +386,7 @@ pub(crate) fn parse(id: &str, p: &Value) -> Option<PixelFx> {
"artistic.roughPastels" => PixelFx::RoughPastels {
length: num(p, "strokeLength", 6.0).clamp(0.0, 40.0),
detail: num(p, "strokeDetail", 10.0).clamp(1.0, 20.0),
texture: Texture::parse(text(p, "texture", "canvas")),
texture: Texture::parse_with(text(p, "texture", "canvas"), p.get(TEXTURE_IMAGE).and_then(Value::as_str)),
scaling: num(p, "scaling", 100.0).clamp(50.0, 200.0) / 100.0,
relief: num(p, "relief", 4.0).clamp(0.0, 50.0),
light: Light::parse(text(p, "lightDirection", "top")),
@@ -421,6 +426,7 @@ pub(crate) fn parse(id: &str, p: &Value) -> Option<PixelFx> {
amount: num(p, "amount", 10.0).clamp(1.0, 100.0),
zoom: text(p, "method", "spin").eq_ignore_ascii_case("zoom"),
passes: quality([("draft", 4), ("good", 6), ("best", 8)], 6),
center: [num(p, "centerX", 0.5).clamp(0.0, 1.0), num(p, "centerY", 0.5).clamp(0.0, 1.0)],
},
"blur.smart" => PixelFx::SmartBlur {
radius: num(p, "radius", 3.0).clamp(0.1, 100.0),
@@ -608,13 +614,13 @@ pub(crate) fn parse(id: &str, p: &Value) -> Option<PixelFx> {
impl PixelFx {
/// How far beyond `bounds` (the content's, document units) the effect can paint.
pub fn outset(&self, bounds: Rect) -> f64 {
// From the centre to the farthest corner, and to the nearest side.
let far = 0.5 * bounds.width().hypot(bounds.height());
let near = 0.5 * bounds.width().min(bounds.height());
match *self {
// A rotated corner reaches the circle through the corners.
PixelFx::RadialBlur { zoom: false, .. } => (far - near).max(0.0),
PixelFx::RadialBlur { amount, zoom: true, .. } => far * (blur::zoom_extent(amount).exp() - 1.0),
// A rotated corner reaches the circle about the Blur Center through the farthest corner.
PixelFx::RadialBlur { zoom: false, center, .. } => {
let (far, near) = blur::center_reach(bounds, center);
(far - near).max(0.0)
}
PixelFx::RadialBlur { amount, zoom: true, center, .. } => blur::center_reach(bounds, center).0 * (blur::zoom_extent(amount).exp() - 1.0),
PixelFx::SmartBlur { radius, .. } => radius,
PixelFx::AccentedEdges { .. } => 0.0,
// Strokes reach out of the object as far as they reach into it.
@@ -786,7 +792,7 @@ impl PixelFx {
PixelFx::RoughPastels { length, detail, ref texture, scaling, relief, light, invert } => {
artistic::rough_pastels(px, w, h, space, length, detail, texture, scaling, relief, light, invert)
}
PixelFx::RadialBlur { amount, zoom, passes } => blur::radial(px, w, h, space, amount, zoom, passes),
PixelFx::RadialBlur { amount, zoom, passes, center } => blur::radial(px, w, h, space, amount, zoom, passes, center),
PixelFx::SmartBlur { radius, threshold, samples, mode: SmartBlurMode::Normal } => {
blur::smart(px, w, h, to_px(radius), threshold, samples)
}
+25 -7
View File
@@ -1,6 +1,6 @@
//! Blur › Radial Blur and Smart Blur (Normal, Edge Only and Overlay Edge).
use vectorcraft_geom::{Affine, Point, Vec2};
use vectorcraft_geom::{Affine, Point, Rect, Vec2};
use super::{PixelSpace, Px16, box_blur, pick, to8, to16};
@@ -29,13 +29,31 @@ fn bilinear(buf: &[Px16], w: usize, h: usize, x: f64, y: f64) -> [f32; 4] {
std::array::from_fn(|i| a[i] * wa + b[i] * wb + c[i] * wc + d[i] * wd)
}
/// Radial Blur: the average of the content turned (spin) or scaled (zoom) about the centre over
/// evenly spaced steps spanning `amount`. Each pass averages the previous result with itself
/// turned both ways by half the last step, so `passes` passes average 2^`passes` samples at two
/// lookups a pixel each.
pub(super) fn radial(px: &mut [[u8; 4]], w: usize, h: usize, space: &PixelSpace, amount: f64, zoom: bool, passes: u32) {
/// How far Radial Blur's Blur Center `center` (0..1 across and down `bounds`) lies from the
/// farthest corner of `bounds`, and from its nearest side.
pub(super) fn center_reach(bounds: Rect, center: [f64; 2]) -> (f64, f64) {
// The share of the width (height) on the far side of the center, doubled: 1 at the middle.
let far = |f: f64| 1.0 + (2.0 * f - 1.0).abs();
let (w, h) = (bounds.width(), bounds.height());
let near = ((2.0 - far(center[0])) * w).min((2.0 - far(center[1])) * h);
(0.5 * (far(center[0]) * w).hypot(far(center[1]) * h), 0.5 * near)
}
/// Where Radial Blur's Blur Center `center` (0..1 across and down the object's bounds) lies in the
/// document: the object's centre at (0.5, 0.5).
pub(super) fn blur_center(space: &PixelSpace, center: [f64; 2]) -> Point {
let shift = Vec2::new((center[0] - 0.5) * space.size.x, (center[1] - 0.5) * space.size.y);
if shift.x.is_finite() && shift.y.is_finite() { space.center + shift } else { space.center }
}
/// Radial Blur: the average of the content turned (spin) or scaled (zoom) about the Blur Center
/// (`center`, [`blur_center`]) over evenly spaced steps spanning `amount`. Each pass averages the
/// previous result with itself turned both ways by half the last step, so `passes` passes average
/// 2^`passes` samples at two lookups a pixel each.
#[allow(clippy::too_many_arguments)] // the effect's four options
pub(super) fn radial(px: &mut [[u8; 4]], w: usize, h: usize, space: &PixelSpace, amount: f64, zoom: bool, passes: u32, center: [f64; 2]) {
// The centre in pixel index coordinates (pixel centres at whole numbers).
let c = space.to_doc.inverse() * space.center - Vec2::new(0.5, 0.5);
let c = space.to_doc.inverse() * blur_center(space, center) - Vec2::new(0.5, 0.5);
if !(c.x.is_finite() && c.y.is_finite()) {
return;
}
+94 -5
View File
@@ -12,6 +12,7 @@ fn space(w: usize, h: usize) -> PixelSpace {
to_doc: Affine::IDENTITY,
px: 1.0,
center: Point::new(w / 2.0, h / 2.0),
size: vectorcraft_geom::Vec2::new(w, h),
channels: Channels::Rgb,
line: 1.0,
extent: 0.5 * w.hypot(h),
@@ -479,12 +480,16 @@ fn film_grain_leaves_invalid_coordinate_spaces_alone() {
#[test]
fn params_take_defaults_and_stay_in_range() {
assert_eq!(fx("blur.radial", json!({})), PixelFx::RadialBlur { amount: 10.0, zoom: false, passes: 6 });
assert_eq!(fx("blur.radial", json!({})), PixelFx::RadialBlur { amount: 10.0, zoom: false, passes: 6, center: [0.5, 0.5] });
assert_eq!(
fx("blur.radial", json!({"amount": 1e308, "method": "ZOOM", "quality": "best"})),
PixelFx::RadialBlur { amount: 100.0, zoom: true, passes: 8 }
fx("blur.radial", json!({"amount": 1e308, "method": "ZOOM", "quality": "best", "centerX": 0.25, "centerY": 1})),
PixelFx::RadialBlur { amount: 100.0, zoom: true, passes: 8, center: [0.25, 1.0] }
);
// A saved center outside the bounds (the commands refuse one) draws at the nearest edge.
assert_eq!(
fx("blur.radial", json!({"amount": -5, "quality": "nonsense", "centerX": -3, "centerY": 7})),
PixelFx::RadialBlur { amount: 1.0, zoom: false, passes: 6, center: [0.0, 1.0] }
);
assert_eq!(fx("blur.radial", json!({"amount": -5, "quality": "nonsense"})), PixelFx::RadialBlur { amount: 1.0, zoom: false, passes: 6 });
assert_eq!(fx("blur.smart", json!({})), PixelFx::SmartBlur { radius: 3.0, threshold: 25.0, samples: 7, mode: SmartBlurMode::Normal });
assert_eq!(
fx("blur.smart", json!({"radius": "1e999", "threshold": -1, "quality": "low", "blurMode": "EDGEONLY"})),
@@ -519,6 +524,11 @@ fn outsets_follow_the_object() {
let far = 0.5 * 100f64.hypot(50.0);
assert!((spin.outset(b) - (far - 25.0)).abs() < 1e-9);
assert!(fx("blur.radial", json!({"method": "zoom", "amount": 100})).outset(b) > 0.4 * far);
// About a corner the spin reaches the circle through the opposite corner, the whole diagonal out.
let corner = fx("blur.radial", json!({"centerX": 0, "centerY": 0}));
assert!((corner.outset(b) - 100f64.hypot(50.0)).abs() < 1e-9, "{}", corner.outset(b));
let zoom = |center: f64| fx("blur.radial", json!({"method": "zoom", "amount": 100, "centerX": center, "centerY": center})).outset(b);
assert!((zoom(1.0) - 2.0 * zoom(0.5)).abs() < 1e-9, "a zoom about a corner reaches twice as far");
assert_eq!(fx("blur.smart", json!({"radius": 4})).outset(b), 4.0);
assert_eq!(fx("blur.smart", json!({"radius": 4})).reach(1.0), Some(4.0));
// The edge modes also read the copy blurred over a wide radius's samples.
@@ -633,6 +643,40 @@ fn spin_blur_smears_along_arcs_and_keeps_the_centre() {
assert_eq!(at(&z, w, 32, 16)[3], 0, "not across it");
}
/// The Blur Center moves the point the blur turns about: a dot on it stays sharp, a dot on the
/// object's centre then spreads, and the center follows the object when it moves or is scaled.
#[test]
fn radial_blur_turns_about_its_blur_center() {
let (w, h) = (41, 41);
// A dot on pixel (10, 30), whose centre (10.5, 30.5) is the Blur Center below, and one on the
// object's centre.
let src = image(w, h, |x, y| if (x == 10 && y == 30) || (x == 20 && y == 20) { grey(255) } else { [0, 0, 0, 0] });
let blur = |p: serde_json::Value, s: &PixelSpace, src: &[u8]| {
let mut d = src.to_vec();
fx("blur.radial", p).apply(&mut d, w, h, s);
d
};
let off = json!({"amount": 60, "quality": "best", "centerX": 10.5 / 41.0, "centerY": 30.5 / 41.0});
let d = blur(off.clone(), &space(w, h), &src);
assert!(at(&d, w, 10, 30)[3] > 100, "the dot on the Blur Center barely moves: {:?}", at(&d, w, 10, 30));
assert!(at(&d, w, 20, 20)[3] < 100, "the dot on the object's centre spreads: {:?}", at(&d, w, 20, 20));
// The default center is the object's centre, the same as no center at all.
assert_eq!(blur(json!({"amount": 60, "centerX": 0.5, "centerY": 0.5}), &space(w, h), &src), blur(json!({"amount": 60}), &space(w, h), &src));
// Moved 7 pt right and 3 pt down, the object draws the same pixels.
let moved =
PixelSpace { to_doc: Affine::translate((7.0, 3.0)), center: space(w, h).center + vectorcraft_geom::Vec2::new(7.0, 3.0), ..space(w, h) };
assert_eq!(blur(off.clone(), &moved, &src), d, "the center moves with the object");
// Drawn at twice the size (two points a pixel), the center lies on the same pixels.
let big = PixelSpace {
to_doc: Affine::scale(2.0),
px: 2.0,
center: Point::new(41.0, 41.0),
size: vectorcraft_geom::Vec2::new(82.0, 82.0),
..space(w, h)
};
assert_eq!(blur(off, &big, &src), d, "the center scales with the object");
}
#[test]
fn smart_blur_smooths_noise_and_keeps_edges() {
let (w, h) = (40, 20);
@@ -862,6 +906,7 @@ fn lengths_are_document_units() {
to_doc: Affine::scale(1.0 / scale as f64),
px: 1.0 / scale as f64,
center: Point::ZERO,
size: vectorcraft_geom::Vec2::ZERO,
channels: Channels::Rgb,
line: 1.0,
extent: 0.0,
@@ -916,7 +961,15 @@ fn linear_light_blur_mixes_light_not_values() {
fn pixel_timings() {
let (w, h) = (2000, 2000);
let src = image(w, h, |x, y| [(x % 256) as u8, (y % 256) as u8, ((x ^ y) % 256) as u8, 255]);
let s = PixelSpace { to_doc: Affine::IDENTITY, px: 1.0, center: Point::new(1000.0, 1000.0), channels: Channels::Rgb, line: 1.0, extent: 0.0 };
let s = PixelSpace {
to_doc: Affine::IDENTITY,
px: 1.0,
center: Point::new(1000.0, 1000.0),
size: vectorcraft_geom::Vec2::new(2000.0, 2000.0),
channels: Channels::Rgb,
line: 1.0,
extent: 0.0,
};
let cases = [
("blur.radial", json!({"quality": "draft"})),
("blur.radial", json!({"quality": "good"})),
@@ -1494,6 +1547,42 @@ fn texturizer_draws_a_loaded_texture_as_relief() {
assert_eq!(fx("texture.texturizer", json!({"texture": "LOADED", "textureImage": "not a texture"})), fx("texture.texturizer", json!({})));
}
/// Rough Pastels draws a loaded texture as its surface, and Scaling, Relief, Light Direction and
/// Invert act on it as on the built-in ones.
#[test]
fn rough_pastels_draws_a_loaded_texture_as_its_surface() {
let w = 64;
let mid = grey(150);
let rings = stored(12, 10, |x, y| {
let v = ((x as f64 - 5.5).hypot(y as f64 - 4.5) * 0.9).sin().abs();
let g = (v * 255.0).round() as u8;
[g, g, g, 255]
});
let run = |mut p: serde_json::Value| {
p["strokeLength"] = json!(0);
let mut d = flat(w, mid);
fx("artistic.roughPastels", p).apply(&mut d, w, w, &space(w, w));
d
};
let relief = run(json!({"texture": "loaded", "textureImage": rings, "relief": 20}));
assert_ne!(relief, flat(w, mid));
for (_, builtin) in TEXTURES {
assert_ne!(relief, run(json!({"texture": builtin, "relief": 20})), "{builtin}");
}
for (key, value) in [("invert", json!(true)), ("scaling", json!(200)), ("lightDirection", json!("bottomRight")), ("relief", json!(5))] {
let mut p = json!({"texture": "loaded", "textureImage": rings, "relief": 20});
p[key] = value;
assert_ne!(run(p), relief, "{key}");
}
assert_eq!(run(json!({"texture": "loaded", "textureImage": rings, "relief": 0})), flat(w, mid));
let parsed = fx("artistic.roughPastels", json!({"texture": "Loaded", "textureImage": rings}));
assert!(matches!(parsed, PixelFx::RoughPastels { texture: Texture::Loaded(_), .. }), "{parsed:?}");
// Without a stored texture, or with one that isn't, Loaded draws Canvas.
for p in [json!({"texture": "loaded"}), json!({"texture": "loaded", "textureImage": "not a texture"})] {
assert_eq!(fx("artistic.roughPastels", p), fx("artistic.roughPastels", json!({})));
}
}
/// The Texture filters' patterns lie in document space around the object's centre: the same at
/// twice the resolution, and moving with the object.
#[test]
+1
View File
@@ -14,6 +14,7 @@ fn space(w: usize, h: usize) -> PixelSpace {
to_doc: Affine::IDENTITY,
px: 1.0,
center: Point::new(w / 2.0, h / 2.0),
size: vectorcraft_geom::Vec2::new(w, h),
channels: Channels::Rgb,
line: 1.0,
extent: 0.5 * w.hypot(h),
+1
View File
@@ -14,6 +14,7 @@ fn space(w: usize, h: usize) -> PixelSpace {
to_doc: Affine::IDENTITY,
px: 1.0,
center: Point::new(w / 2.0, h / 2.0),
size: vectorcraft_geom::Vec2::new(w, h),
channels: Channels::Rgb,
line: 1.0,
extent: 0.5 * w.hypot(h),
+38
View File
@@ -1121,6 +1121,44 @@ fn the_check_builds_the_profile_of_a_shape_with_no_fill() {
}
}
/// A filled shape is checked about the bounds the effect draws its solid about, which take in the
/// strokes beside it. A shape of many small curves is too complex for Extrude & Bevel about the
/// shapes' own bounds, where its curves are sampled more finely, and passes about the bounds of a
/// wide stroke in its group, as its solid draws there.
#[test]
fn the_check_builds_a_filled_shape_about_the_bounds_its_solid_draws_about() {
// 900 curves about (100, 100), each bulging 1 pt out from a side of a polygon 80 pt across.
let corners = 900;
let center = Point::new(100.0, 100.0);
let corner = |k: usize| {
let (s, c) = (k as f64 * std::f64::consts::TAU / corners as f64).sin_cos();
Point::new(center.x + 40.0 * c, center.y + 40.0 * s)
};
let mut b = BezPath::new();
b.move_to(corner(0));
for k in 0..corners {
let (p0, p3) = (corner(k), corner(k + 1));
let out = p0.midpoint(p3) - center;
let out = out / out.hypot();
b.curve_to(p0 + (p3 - p0) / 3.0 + out, p0 + (p3 - p0) * (2.0 / 3.0) + out, p3);
}
b.close_path();
let filled = Node::path(NodeId(1), PathData::from_bezpath(&b), Appearance::basic(Paint::solid(RED), Paint::None, 0.0));
let mut line = BezPath::new();
line.move_to((80.0, 100.0));
line.line_to((120.0, 100.0));
let mut wide = Node::path(NodeId(2), PathData::from_bezpath(&line), Appearance::basic(Paint::None, Paint::solid(Color::BLACK), 2000.0));
wide.appearance.items.retain(|i| matches!(i, AppearanceItem::Stroke(_)));
let p = json!({"bevel": "rounded", "bevelRepeat": 6});
let (path, rule) = profile(&filled).unwrap();
let own = path.bounds().unwrap().union(wide.path_data().unwrap().bounds().unwrap());
assert_eq!(facets(EXTRUDE, &path, rule, own, &p).map(|_| ()), Err(vectorcraft_three_d::TOO_COMPLEX_SOLID.to_string()), "about its own bounds");
let mut g = Node::group(NodeId(9999), vec![Arc::new(filled), Arc::new(wide)]);
assert_eq!(validate_solid(&g, EXTRUDE, &p), Ok(()));
g.appearance.effects.push(fx(EXTRUDE, p));
assert!(solid_art(&g).is_some(), "the solid draws");
}
/// A convex polygon of `corners` corners about (20,000, 20,000), filled red, with no stroke.
fn polygon_node(id: u64, corners: usize) -> Node {
let points: Vec<Point> = (0..corners)
@@ -128,6 +128,7 @@ mod tests {
to_doc: Affine::scale(1.0),
px: 1.0,
center: Point::new(wd / 2.0, wd / 2.0),
size: vectorcraft_geom::Vec2::new(wd, wd),
channels: Channels::Rgb,
line: 1.0,
extent: 0.5 * wd.hypot(wd),
+9 -1
View File
@@ -10,7 +10,15 @@ use crate::{PixelFx, RasterFx, raster_effects};
/// resolution whose pixels are `line` points wide.
fn space(w: usize, h: usize, px: f64, line: f64) -> PixelSpace {
let (wd, hd) = (w as f64 * px, h as f64 * px);
PixelSpace { to_doc: Affine::scale(px), px, center: Point::new(wd / 2.0, hd / 2.0), channels: Channels::Rgb, line, extent: 0.5 * wd.hypot(hd) }
PixelSpace {
to_doc: Affine::scale(px),
px,
center: Point::new(wd / 2.0, hd / 2.0),
size: vectorcraft_geom::Vec2::new(wd, hd),
channels: Channels::Rgb,
line,
extent: 0.5 * wd.hypot(hd),
}
}
/// `w` × `h` premultiplied pixels: `f(x, y)` each.
+1
View File
@@ -1850,6 +1850,7 @@ fn rasterize_compose_leaves_the_raster_alone_when_the_sizes_do_not_fit() {
to_doc: Affine::IDENTITY,
px: 1.0,
center: Point::new(1.0, 1.0),
size: vectorcraft_geom::Vec2::new(2.0, 2.0),
channels: pixel::Channels::Rgb,
line: 1.0,
extent: std::f64::consts::SQRT_2,
@@ -531,8 +531,13 @@ fn an_anchor_edit_makes_it_a_plain_path_and_transforms_keep_it_editable() {
s.execute("addon.pathtools.shape.set", &json!({"id": id.0, "count": 6})).unwrap();
assert_eq!((path(&s, id).anchor_count(), steps(&s)), (12, n + 1));
assert!((shape_of(&s, id).unwrap().rotation + 30.0).abs() < 1e-6, "the turn stays");
// Stretched across its own axes (it is turned): skewed, so no longer.
// Stretched along its turned bounding box: still the shape, wider along its own axis.
s.execute("object.scale", &json!({"sx": 150, "sy": 100, "origin": [220, 140]})).unwrap();
let r = shape_of(&s, id).unwrap();
assert!((r.width - 300.0).abs() < 1e-6 && (r.height - 200.0).abs() < 1e-6 && (r.rotation + 30.0).abs() < 1e-6, "{r:?}");
s.execute("edit.undo", &json!({})).unwrap();
// Stretched across the page's axes (it is turned): skewed, so no longer.
s.execute("object.scale", &json!({"sx": 150, "sy": 100, "origin": [220, 140], "basis": "page"})).unwrap();
assert_eq!(shape_of(&s, id), None);
s.execute("edit.undo", &json!({})).unwrap();
assert!(shape_of(&s, id).is_some(), "undo brings it back");
+309 -15
View File
@@ -14,7 +14,7 @@ use std::collections::{HashMap, HashSet};
use std::sync::Arc;
use serde_json::{Value, json};
use vectorcraft_color::{Color, Paint};
use vectorcraft_color::{BlendMode, Color, Paint};
use vectorcraft_doc::appearance::{AppearanceItem, FillLayer, LineCap, LineJoin, StrokeLayer};
use vectorcraft_doc::{Appearance, Document, GapOptions, GapSize, LiveShape, Node, NodeId, NodeKind, Selection, TraceView};
use vectorcraft_geom::{FillRule, PathData, Point, Rect, SubPath};
@@ -72,7 +72,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Make",
["Object", "Live Paint"],
Some("Cmd+Alt+X"),
"{ids?|id?} build a Live Paint group from the selected paths (paths, compound paths and groups of them; type, images and other objects are refused, nothing changes); each covered face starts with its front-most covering source's fill; with a Live Paint group among them, add the others to it as livePaint.merge does; a Live Paint group alone has nothing to add, so it is selected and nothing changes (no undo step) → {id, faces, edges}",
"{ids?|id?} build a Live Paint group from the selected paths (paths, compound paths and groups of them; type, images and other objects are refused, nothing changes); each covered face starts with the fill rows that draw (shown, with paint and an opacity above 0) of its front-most covering source that has one and an opacity above 0, and each edge with the stroke rows that draw (also a weight above 0) of its source, in order with their settings and with that source's opacity and blending mode (on a path cut into several edges, dashes go on along the path with the lengths set, without the fit of dashes aligned to corners and path ends, arrowheads stay at its own ends, and a width profile or brush stays only on an edge that runs the whole path); a face or edge given no such row has one unpainted row; with a Live Paint group among them, add the others to it as livePaint.merge does; a Live Paint group alone has nothing to add, so it is selected and nothing changes (no undo step) → {id, faces, edges}",
has_selection_or_ids,
lp_make
),
@@ -117,7 +117,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Live Paint Bucket",
[],
None,
"{group?: id | ids?|id?: [id…] (paths to make live first, as livePaint.make does), point: [x,y], points?: [[x,y]…] (a drag polyline starting at point; 1 to 4096 finite canvas points; fills every crossed face of the same group), continuation?: [[[x,y]…]…] (further path chunks of 1 to 4096 finite canvas points each; each starts at the preceding chunk's last point; requires points), color?|swatch?|gradient?|none? (default: current fill; a color in #rrggbbaa or #rgba is refused), tint?: 0..100, keepModel?: bool (both as paint.setFill)} fill the face containing point, skipping hidden faces; when every face it reaches already has the paint, nothing changes (no undo step, and the recent colors stay as they are) → {group, face}",
"{group?: id | ids?|id?: [id…] (paths to make live first, as livePaint.make does), point: [x,y], points?: [[x,y]…] (a drag polyline starting at point; 1 to 4096 finite canvas points; fills every crossed face of the same group), continuation?: [[[x,y]…]…] (further path chunks of 1 to 4096 finite canvas points each; each starts at the preceding chunk's last point; requires points), scope?: \"one\" (default: the face alone) | \"connected\" (a double-click: also each face reached across edges that are hidden or draw no stroke, as a flood from the face; a stroked edge, a hidden face or a Gap Detection gap stops it) | \"samePaint\" (a triple-click: also every face of the group whose fill is match; \"connected\" and \"samePaint\" are refused with points), match?: paint (as the document stores it, the `fill` of a face's appearance; scope samePaint only; default: the face's fill), color?|swatch?|gradient?|none? (default: current fill; a color in #rrggbbaa or #rgba is refused), tint?: 0..100, keepModel?: bool (both as paint.setFill)} fill the face containing point, skipping hidden faces; when every face it reaches already has the paint, nothing changes (no undo step, and the recent colors stay as they are) → {group, face, count (faces reached)}",
has_doc,
lp_fill
),
@@ -126,7 +126,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Live Paint Bucket (Stroke)",
[],
None,
"{group: id, point: [x,y], color?|swatch?|none? (default: current stroke), width?: pt (default: current weight), tolerance?: pt (4), tint?: 0..100, keepModel?: bool (both as paint.setFill)} paint the edge nearest point; when it already has the paint and the width, nothing changes (no undo step, and the recent colors stay as they are) → {group, edge}",
"{group: id, point: [x,y], color?|swatch?|none? (default: current stroke), width?: pt (default: current weight), tolerance?: pt (4), scope?: \"one\" (default: the edge alone) | \"connected\" (a double-click: also each edge joined to it, end to end, through edges that draw with stroke paint match) | \"samePaint\" (a triple-click: also every edge of the group that draws with stroke paint match), match?: paint (as the document stores it; scope connected or samePaint only; default: the stroke paint the edge draws with; an edge draws with the paint of its topmost stroke that is shown, with paint, above 0 pt and not fully transparent, and with none when the edge is fully transparent or has no such stroke), tint?: 0..100, keepModel?: bool (both as paint.setFill)} paint the edge nearest point, skipping hidden edges: each edge reached takes the paint and width in its topmost stroke that is shown, or in a new stroke above the others when it has none; when every edge it reaches already has the paint and the width there, nothing changes (no undo step, and the recent colors stay as they are) → {group, edge, count (edges reached)}",
has_doc,
lp_stroke_edge
),
@@ -414,22 +414,274 @@ fn source_nodes(n: &Node) -> Vec<Arc<Node>> {
if is_live_paint(n) { b::sources(n).and_then(|g| g.children().cloned()).unwrap_or_default() } else { vec![Arc::new(n.clone())] }
}
/// Does appearance row `i` draw: it is shown, has paint and an opacity above 0, and a stroke also
/// has a weight above 0?
fn row_draws(i: &AppearanceItem) -> bool {
match i {
AppearanceItem::Fill(f) => f.visible && !f.paint.is_none() && f.opacity > 0.0,
AppearanceItem::Stroke(s) => s.visible && !s.paint.is_none() && s.opacity > 0.0 && s.width > 0.0,
}
}
/// What a source path gives the faces and edges made from it.
struct SourceStyle {
/// The fill rows that draw, in paint order (none when the path's opacity is 0).
fills: Vec<AppearanceItem>,
/// The stroke rows that draw, in paint order (none when the path's opacity is 0).
strokes: Vec<AppearanceItem>,
/// The top stroke's weight, for an edge given no stroke that draws.
width: f64,
opacity: f32,
blend: BlendMode,
}
impl SourceStyle {
/// The style of source path `n`: its rows keep their order and settings, gradients fitted to
/// its bounds keep that fit, and the strokes' pen pressure, tilt, bearing and rotation stay
/// with the path.
fn of(n: &Node) -> Self {
let mut a = (*n.appearance).clone().without_pressure();
if a.has_unplaced_gradient()
&& let Some(bounds) = n.geometric_bounds()
{
a.pin_gradients(bounds);
}
let width = a.stroke().map_or(1.0, |s| s.width);
let (mut fills, mut strokes) = (vec![], vec![]);
if n.opacity > 0.0 {
for i in a.items.into_iter().filter(row_draws) {
if i.is_fill() { fills.push(i) } else { strokes.push(i) }
}
}
Self { fills, strokes, width, opacity: n.opacity, blend: n.blend }
}
/// Give part `n` the rows `rows` of this source with its opacity and blending mode; with no
/// rows, `n` keeps the unpainted row it has.
fn paint(&self, n: &mut Node, rows: &[AppearanceItem]) {
if rows.is_empty() {
return;
}
n.appearance = Appearance { items: rows.to_vec(), ..Default::default() }.into();
n.opacity = self.opacity;
n.blend = self.blend;
}
}
/// How far, in points, a place on an edge may be from its source path and still be on it.
const ON_SOURCE: f64 = 0.05;
/// Does stroke row `i` have settings that depend on where along its path a piece of it lies or
/// which way it runs: dashes, arrowheads, a width profile, a brush, or a gradient along or across
/// the stroke?
fn depends_on_place(i: &AppearanceItem) -> bool {
matches!(i, AppearanceItem::Stroke(s) if s.dash.is_some() || s.start_arrow.is_some() || s.end_arrow.is_some() || s.profile.is_some() || s.brush.is_some() || s.gradient_mode != vectorcraft_doc::StrokeGradientMode::Within)
}
/// One subpath's segments with the length along it where each starts, then its whole length, and
/// a grid of square cells listing the segments whose bounds, grown by [`ON_SOURCE`], reach into
/// each cell, so finding the segments near a point does not look at every segment.
struct Track {
segs: Vec<kurbo::PathSeg>,
at: Vec<f64>,
closed: bool,
cell: f64,
grid: HashMap<(i64, i64), Vec<usize>>,
/// Segments that reach into more than [`Track::MAX_CELLS`] cells, or that come after the grid
/// holds [`Track::CELLS_PER_SEGMENT`] entries per segment, looked at for every point.
wide: Vec<usize>,
}
impl Track {
const ACCURACY: f64 = 1e-4;
const MAX_CELLS: i64 = 4096;
const CELLS_PER_SEGMENT: usize = 16;
fn new(sp: &SubPath) -> Self {
use kurbo::{ParamCurveArclen, Shape as _};
let mut bp = kurbo::BezPath::new();
sp.to_bezpath_into(&mut bp);
let segs: Vec<kurbo::PathSeg> = bp.segments().collect();
let mut at = Vec::with_capacity(segs.len() + 1);
let mut len = 0.0;
for s in &segs {
at.push(len);
len += s.arclen(Self::ACCURACY);
}
at.push(len);
let boxes: Vec<kurbo::Rect> = segs.iter().map(|s| s.bounding_box().inflate(ON_SOURCE, ON_SOURCE)).collect();
// Cells about as wide as an average segment's bounds.
let mean = boxes.iter().map(|b| b.width().max(b.height())).sum::<f64>() / boxes.len().max(1) as f64;
let cell = if mean.is_finite() { mean.max(4.0 * ON_SOURCE) } else { 4.0 * ON_SOURCE };
let mut grid: HashMap<(i64, i64), Vec<usize>> = HashMap::new();
let mut wide = vec![];
// The grid holds at most this many entries in all.
let mut budget = boxes.len().saturating_mul(Self::CELLS_PER_SEGMENT);
for (k, b) in boxes.iter().enumerate() {
let (x0, y0) = Self::cell_of(Point::new(b.x0, b.y0), cell);
let (x1, y1) = Self::cell_of(Point::new(b.x1, b.y1), cell);
let cells = x1.saturating_sub(x0).saturating_add(1).saturating_mul(y1.saturating_sub(y0).saturating_add(1));
let Some(cells) = usize::try_from(cells).ok().filter(|&c| cells <= Self::MAX_CELLS && c <= budget) else {
wide.push(k);
continue;
};
budget -= cells;
for x in x0..=x1 {
for y in y0..=y1 {
grid.entry((x, y)).or_default().push(k);
}
}
}
Self { segs, at, closed: sp.closed, cell, grid, wide }
}
fn cell_of(p: Point, cell: f64) -> (i64, i64) {
((p.x / cell).floor() as i64, (p.y / cell).floor() as i64)
}
fn len(&self) -> f64 {
self.at.last().copied().unwrap_or(0.0)
}
/// The lengths along the subpath to each of its segments' places nearest `p` that are within
/// [`ON_SOURCE`] of it (more than one where the subpath passes `p` again).
fn places(&self, p: Point) -> Vec<f64> {
use kurbo::{ParamCurve, ParamCurveArclen, ParamCurveNearest};
let near = self.grid.get(&Self::cell_of(p, self.cell)).map(Vec::as_slice).unwrap_or_default();
let mut out = vec![];
for &k in near.iter().chain(&self.wide) {
let Some(s) = self.segs.get(k) else { continue };
let n = s.nearest(p, 1e-9);
if n.distance_sq <= ON_SOURCE * ON_SOURCE {
out.push(self.at.get(k).copied().unwrap_or(0.0) + s.subsegment(0.0..n.t).arclen(Self::ACCURACY));
}
}
out
}
/// The signed length from `a` to `b` along the subpath (the shorter way round a closed one).
fn step(&self, a: f64, b: f64) -> f64 {
let (d, len) = (b - a, self.len());
if self.closed && len > 0.0 { d - len * (d / len).round() } else { d }
}
/// Of `places`, the one nearest along the subpath to `target`.
fn nearest(&self, places: &[f64], target: f64) -> Option<f64> {
places.iter().copied().min_by(|x, y| self.step(*x, target).abs().total_cmp(&self.step(*y, target).abs()))
}
}
/// Where edge `edge` runs along its source path, whose subpaths' tracks are `tracks`: the length
/// along the source subpath to the edge's start, whether the edge starts at that subpath's start and
/// ends at its end (an open subpath), and whether it runs the whole subpath. The middle of the
/// edge's first segment places it, and its ends are taken where they lie that far along the source,
/// so a path that passes a point twice is told apart. An edge that runs against the direction of its
/// source is reversed first, and a closed edge as long as its closed source is started at the anchor
/// where its source starts (one with no anchor there, or a shorter loop cut from a source that
/// crosses itself, does not count as running the whole subpath). `None` when the edge is
/// not a single piece found on the source.
fn edge_run(tracks: &[Track], edge: &mut PathData) -> Option<(f64, bool, bool, bool)> {
use kurbo::{ParamCurve, ParamCurveArclen};
let [sp] = edge.subpaths.as_slice() else { return None };
if sp.segment_count() == 0 {
return None;
}
let (a, z) = (sp.anchors.first()?.p, if sp.closed { sp.anchors.first()?.p } else { sp.anchors.last()?.p });
let first = sp.segment(0);
let mid = first.eval(0.5);
let half = first.subsegment(0.0..0.5).arclen(Track::ACCURACY);
let length = sp.anchor_arc_positions().last().copied().unwrap_or(0.0);
let edge_closed = sp.closed;
// (how far off the fit is, track, start, end, runs forward) for the subpath that fits best.
let mut found: Option<(f64, &Track, f64, f64, bool)> = None;
for track in tracks {
// The start lies half the first segment before its middle along the source, or after it
// when the edge runs the other way: take the place and way that fit best.
let starts_at = track.places(a);
let mut best: Option<(f64, f64, bool)> = None;
for pm in track.places(mid) {
for forward in [true, false] {
let Some(pa) = track.nearest(&starts_at, if forward { pm - half } else { pm + half }) else { continue };
let miss = (if forward { track.step(pa, pm) } else { track.step(pm, pa) } - half).abs();
if best.is_none_or(|(m, _, _)| miss < m) {
best = Some((miss, pa, forward));
}
}
}
let Some((miss, pa, forward)) = best else { continue };
let target = if forward { pa + length } else { pa - length };
let Some(pz) = track.nearest(&track.places(z), target) else { continue };
let miss = miss + track.step(pz, target).abs();
if found.is_none_or(|(m, ..)| miss < m) {
found = Some((miss, track, pa, pz, forward));
}
}
let (_, track, pa, pz, forward) = found?;
let (from, to) = if forward { (pa, pz) } else { (pz, pa) };
if !forward {
edge.reverse();
}
let open = !track.closed;
let starts = open && from <= ON_SOURCE;
let ends = open && to >= track.len() - ON_SOURCE;
if open {
return Some((from, starts, ends, starts && ends));
}
// A closed edge runs the whole closed subpath, from the anchor the planar map starts it at.
// Start it at the anchor where the source starts, so settings that follow the path begin there.
let start = track.segs.first().map(|s| s.start())?;
let moved = edge_closed
&& (length - track.len()).abs() <= ON_SOURCE.max(track.len() * 1e-4)
&& edge.subpaths.first_mut().is_some_and(|sp| match sp.anchors.iter().position(|a| a.p.distance(start) <= ON_SOURCE) {
Some(k) => {
sp.anchors.rotate_left(k);
true
}
None => false,
});
Some((if moved { 0.0 } else { from }, false, false, moved))
}
/// Fit stroke row `row` of a source path to an edge cut from it, which runs as [`edge_run`] says
/// (`None`: not known): its dashes go on from where the edge starts along the source, with the
/// lengths set and without the fit of dashes aligned to corners and path ends, its arrowheads stay only at the source's own ends, and its width profile and brush, which spread
/// over the whole path, stay only on an edge that runs the whole path.
fn fit_to_edge(row: &mut AppearanceItem, run: Option<(f64, bool, bool, bool)>) {
let AppearanceItem::Stroke(s) = row else { return };
let (from, starts, ends, whole) = run.unwrap_or((0.0, false, false, false));
if !whole {
if let Some(d) = &mut s.dash
&& run.is_some()
{
d.offset += from;
d.align_corners = false;
}
s.profile = None;
s.brush = None;
}
if !starts {
s.start_arrow = None;
}
if !ends {
s.end_arrow = None;
}
}
/// The planar map's inputs from `sources` (paths and compound paths, back → front), with the
/// fill, stroke and stroke width of each.
fn source_shapes(sources: &[Arc<Node>]) -> (Vec<po::Shape>, Vec<(Paint, Paint, f64)>) {
/// style of each.
fn source_shapes(sources: &[Arc<Node>]) -> (Vec<po::Shape>, Vec<SourceStyle>) {
let mut lv = vec![];
for n in sources {
b::leaf_shapes(n, &mut lv);
}
let mut shapes = vec![];
let mut styles: Vec<(Paint, Paint, f64)> = vec![];
let mut styles: Vec<SourceStyle> = vec![];
for l in lv {
if let Some((path, rule)) = b::node_outline(l)
&& !path.is_empty()
{
shapes.push(po::Shape::new(path, rule, styles.len() as u64));
let a = &l.appearance;
styles.push((a.fill_paint(), a.stroke_paint(), a.stroke().map(|s| s.width).unwrap_or(1.0)));
styles.push(SourceStyle::of(l));
}
}
(shapes, styles)
@@ -462,17 +714,35 @@ fn build_children(d: &mut Document, sources: Vec<Arc<Node>>, max_gap: Option<f64
let nfaces = regs.len();
for r in regs {
let id = d.alloc_id();
let fill = r.top().and_then(|t| styles.get(t)).map_or(Paint::None, |s| s.0.clone());
let mut n = Node::path(id, r.path, fill_only(fill));
let mut n = Node::path(id, r.path, fill_only(Paint::None));
n.name = Some(FACE_NAME.into());
// The front-most covering source with a fill that draws gives the face its fill rows.
if let Some(s) = r.sources.iter().rev().filter_map(|&t| styles.get(t)).find(|s| !s.fills.is_empty()) {
s.paint(&mut n, &s.fills);
}
children.push(Arc::new(n));
}
let nedges = edges.len();
// The tracks of the sources whose edges need them, measured once each.
let mut tracks: HashMap<usize, Vec<Track>> = HashMap::new();
for e in edges {
let Some((_, stroke, w)) = styles.get(e.key as usize) else { continue };
let key = e.key as usize;
let Some(s) = styles.get(key) else { continue };
let mut path = e.path;
let mut rows = s.strokes.clone();
if rows.iter().any(depends_on_place) {
let source = tracks
.entry(key)
.or_insert_with(|| shapes.get(key).map(|src| src.path.subpaths.iter().map(Track::new).collect()).unwrap_or_default());
let run = edge_run(source, &mut path);
for r in &mut rows {
fit_to_edge(r, run);
}
}
let id = d.alloc_id();
let mut n = Node::path(id, e.path, stroke_only(stroke.clone(), *w));
let mut n = Node::path(id, path, stroke_only(Paint::None, s.width));
n.name = Some(EDGE_NAME.into());
s.paint(&mut n, &rows);
children.push(Arc::new(n));
}
Ok((children, nfaces, nedges))
@@ -481,8 +751,9 @@ fn build_children(d: &mut Document, sources: Vec<Arc<Node>>, max_gap: Option<f64
/// Give the faces and edges of `g`, a Live Paint group made again from the sources of `old`, the
/// look of `old`'s face or edge where they lie: each face takes everything but the outline (its
/// appearance, none included, its transparency and the rest) of the old face its inside point is
/// in, and each edge that of the old edge its middle lies on. Faces and edges where `old` had none
/// keep the paint of their sources.
/// in, and each edge that of the old edge its middle lies on, with the old edge's stroke rows fitted
/// to the part of it the new edge runs, as [`fit_to_edge`] fits a source's rows. Faces and edges
/// where `old` had none keep the paint of their sources.
fn repaint_from(g: &mut Node, old: &Node) {
/// How far an edge's middle may be from the old edge it lies on.
const ON_EDGE: f64 = 1e-3;
@@ -505,7 +776,30 @@ fn repaint_from(g: &mut Node, old: &Node) {
n.id = c.id;
n.kind = c.kind.clone();
n.bbox_angle = c.bbox_angle;
// An edge cut from the old one takes the old edge's dashes, arrowheads, width profile
// and brush as they fall on its part of the old edge.
if c.name.as_deref() == Some(EDGE_NAME)
&& let Some(old_path) = was.path_data()
{
fit_to_old_edge(&mut n, old_path);
}
*c = Arc::new(n);
}
}
}
/// Fit the stroke rows of edge `n`, which it took from an old edge whose outline is `old`, to the
/// part of the old edge that `n` runs, as [`fit_to_edge`] fits a source's rows to an edge cut from
/// it; `n` is reversed when it runs against the old edge.
fn fit_to_old_edge(n: &mut Node, old: &PathData) {
if !n.appearance.items.iter().any(depends_on_place) {
return;
}
let tracks: Vec<Track> = old.subpaths.iter().map(Track::new).collect();
let run = n.path_data_mut().and_then(|path| edge_run(&tracks, path));
let mut a = (*n.appearance).clone();
for r in &mut a.items {
fit_to_edge(r, run);
}
n.appearance = a.into();
}
+149 -42
View File
@@ -1,8 +1,8 @@
use super::{
Appearance, AppearanceItem, Arc, Beside, Document, EDGE_NAME, EngineError, FACE_NAME, GapOptions, GapSize, LIVE_PAINT_NAME, Node, NodeId,
PathData, Point, Rect, Result, SOURCES_NAME, Selection, Session, SubPath, Value, b, bad, build_children, edge_near, face_at, finite, ids_json,
is_live_paint, json, number_or, object_param, paint_from, po, point_param, repaint_from, replace_roots, root_ids, source_nodes, source_shapes,
switch_or,
PathData, Point, Rect, Result, SOURCES_NAME, Selection, Session, SubPath, Value, b, bad, build_children, edge_near, face_at, finite,
fit_to_old_edge, ids_json, is_live_paint, json, number_or, object_param, paint_from, po, point_param, repaint_from, replace_roots, root_ids,
source_nodes, source_shapes, switch_or,
};
/// `options` as stored on a Live Paint group: none for the defaults.
@@ -85,6 +85,9 @@ pub(super) fn lp_make(s: &mut Session, p: &Value) -> Result<Value> {
Ok(json!({ "id": id.0, "faces": faces, "edges": edges }))
}
/// How far, in points, the middle of an edge Merge makes may be from the old edge it lies on.
const ON_OLD_EDGE: f64 = 1e-3;
/// What Merge carries from a face or edge to the part it makes again in its place, another path:
/// the appearance, visibility, opacity and blending mode. Gradients fitted to the old outline keep
/// that fit, and the strokes' pen pressure, tilt, bearing and rotation stay behind.
@@ -125,18 +128,11 @@ fn merge_live(d: &mut Document, sel: &mut Selection, roots: &[NodeId]) -> Result
.ok_or_else(|| EngineError::Other("Live Paint Merge: select a Live Paint group and the paths to add".into()))?;
check_live_paint_takes(d, roots)?;
let old = d.node(target).cloned().ok_or(EngineError::NoNode(target))?;
// Paint to carry over: (point inside face, paint) for faces that draw, and (point on edge,
// paint) for every edge.
// Paint to carry over: (point inside face, paint) for faces that draw; edges are matched to the
// old edges below.
let keep_faces: Vec<(Point, Carried)> =
b::faces(&old).iter().filter(|f| draws(f)).filter_map(|f| Some((po::interior_point(f.path_data()?)?, Carried::of(f)))).collect();
let keep_edges: Vec<(Point, Carried)> = b::edges(&old)
.iter()
.filter_map(|e| {
let pd = e.path_data()?;
let sp = pd.subpaths.first().filter(|sp| sp.segment_count() > 0)?;
Some((kurbo::ParamCurve::eval(&sp.segment(0), 0.5), Carried::of(e)))
})
.collect();
let old_parts = old.clone();
let mut sources = source_nodes(&old);
for r in roots {
if *r != target {
@@ -162,12 +158,24 @@ fn merge_live(d: &mut Document, sel: &mut Selection, roots: &[NodeId]) -> Result
carried.onto(Arc::make_mut(f));
}
}
for (pt, carried) in keep_edges {
if let Some(eid) = edge_near(&g, pt, 0.5).map(|e| e.id)
&& let Some(ch) = g.children_mut()
&& let Some(e) = ch.iter_mut().find(|c| c.id == eid)
{
carried.onto(Arc::make_mut(e));
// Each edge whose middle lies on an old edge, every piece of an edge an added path cuts
// included, takes the old edge's paint, with its rows fitted to its part of the old edge.
if let Some(ch) = g.children_mut() {
for c in ch.iter_mut().filter(|c| c.name.as_deref() == Some(EDGE_NAME)) {
let Some(mid) = c
.path_data()
.and_then(|pd| pd.subpaths.first())
.filter(|sp| sp.segment_count() > 0)
.map(|sp| kurbo::ParamCurve::eval(&sp.segment(0), 0.5))
else {
continue;
};
let Some(was) = edge_near(&old_parts, mid, ON_OLD_EDGE) else { continue };
let e = Arc::make_mut(c);
Carried::of(was).onto(e);
if let Some(outline) = was.path_data() {
fit_to_old_edge(e, outline);
}
}
}
let mut merged = Beside::replacing(d, roots);
@@ -363,9 +371,52 @@ pub(super) fn lp_gap_options(s: &mut Session, p: &Value) -> Result<Value> {
Ok(json!({ "ids": ids_json(&targets), "faces": faces, "gaps": gaps_json(&gaps), "closed": closed }))
}
/// Which parts a Live Paint Bucket click paints besides the one under the pointer.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum LpScope {
/// The part under the pointer alone (a click).
One,
/// A face and the faces reached from it across edges that draw no stroke ([`b::flood_faces`]),
/// or an edge and the edges joined to it end to end that draw with the same stroke paint
/// ([`b::connected_edges`], [`b::lp_stroke_paint`]) (a double-click).
Connected,
/// Every face with the same fill, or every edge that draws with the same stroke paint, in the
/// group (a triple-click).
SamePaint,
}
/// The `scope` of `livePaint.fill` and `livePaint.strokeEdge`: `one` when left out or null.
fn scope_param(p: &Value, c: &str) -> Result<LpScope> {
match p.get("scope").filter(|v| !v.is_null()) {
None => Ok(LpScope::One),
Some(v) => match v.as_str() {
Some("one") => Ok(LpScope::One),
Some("connected") => Ok(LpScope::Connected),
Some("samePaint") => Ok(LpScope::SamePaint),
_ => Err(bad(c, "scope must be \"one\", \"connected\" or \"samePaint\"")),
},
}
}
/// The `match` of `livePaint.fill` and `livePaint.strokeEdge`: a paint as the document stores it,
/// None when left out or null. With `allowed` false (a scope that compares no paints) a `match` is
/// an error naming `scopes`, the scopes it applies to.
fn match_param(p: &Value, c: &str, allowed: bool, scopes: &str) -> Result<Option<super::Paint>> {
let Some(v) = p.get("match").filter(|v| !v.is_null()) else { return Ok(None) };
if !allowed {
return Err(bad(c, format!("match applies only with scope {scopes}")));
}
serde_json::from_value::<super::Paint>(v.clone()).map(Some).map_err(|_| bad(c, "match must be a paint as the document stores it"))
}
pub(super) fn lp_fill(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "livePaint.fill";
let pt = point_param(p, "point").filter(|q| finite(*q)).ok_or_else(|| bad(C, "missing point [x,y]"))?;
let scope = scope_param(p, C)?;
let like = match_param(p, C, scope == LpScope::SamePaint, "\"samePaint\"")?;
if scope != LpScope::One && p.get("points").is_some() {
return Err(bad(C, "scope applies to a click: leave out points"));
}
let parse_chunk = |input: &Value, start: Point| -> Result<Vec<Point>> {
let values = input
.as_array()
@@ -400,7 +451,8 @@ pub(super) fn lp_fill(s: &mut Session, p: &Value) -> Result<Value> {
let group = object_param(p, "group", C)?;
let roots = if group.is_none() { root_ids(s, p)? } else { vec![] };
// The faces the click or drag paints in Live Paint group `gid`: the visible face at the point,
// and every visible face the drag crosses; → (the face at the point, the faces).
// the faces its scope adds, and every visible face the drag crosses; → (the face at the point,
// the faces).
let targets_in = |d: &Document, gid: NodeId| -> Result<(NodeId, std::collections::BTreeSet<NodeId>)> {
let fid = d
.node(gid)
@@ -408,6 +460,18 @@ pub(super) fn lp_fill(s: &mut Session, p: &Value) -> Result<Value> {
.map(|f| f.id)
.ok_or_else(|| EngineError::Other("no Live Paint face at that point".into()))?;
let mut targets = std::collections::BTreeSet::from([fid]);
if scope != LpScope::One {
let n = d.node(gid).ok_or(EngineError::NoNode(gid))?;
if scope == LpScope::Connected {
targets.extend(b::flood_faces(n, fid));
} else {
let like = match &like {
Some(m) => m.clone(),
None => d.node(fid).ok_or(EngineError::NoNode(fid))?.appearance.fill_paint(),
};
targets.extend(b::faces(n).into_iter().filter(|f| f.visible && f.appearance.fill_paint() == like).map(|f| f.id));
}
}
if let Some(points) = points {
let n = d.node(gid).ok_or(EngineError::NoNode(gid))?;
// Use the existing region-crossing probes, so even a face narrower than the distance
@@ -457,34 +521,36 @@ pub(super) fn lp_fill(s: &mut Session, p: &Value) -> Result<Value> {
}
}
};
let (g, face) = match live {
let (g, face, count) = match live {
Some(gid) => {
let (fid, targets) = targets_in(&s.doc()?.doc, gid)?;
let count = targets.len();
// Faces that already have the paint stay as they are: when every face has it, nothing
// changes and no undo step is recorded.
let d = &s.doc()?.doc;
let unpainted: Vec<NodeId> = targets.into_iter().filter(|t| d.node(*t).is_none_or(|f| f.appearance.fill_paint() != paint)).collect();
if unpainted.is_empty() {
return Ok(json!({ "group": gid.0, "face": fid.0 }));
return Ok(json!({ "group": gid.0, "face": fid.0, "count": count }));
}
s.edit("Live Paint Bucket", |d, _| {
for target in unpainted {
d.node_mut(target).ok_or(EngineError::NoNode(target))?.appearance.set_fill(paint.clone());
}
Ok((gid, fid))
Ok((gid, fid, count))
})?
}
None => s.edit("Live Paint Bucket", |d, sel| {
let gid = make_live(d, sel, &roots)?.0;
let (fid, targets) = targets_in(d, gid)?;
let count = targets.len();
for target in targets {
d.node_mut(target).ok_or(EngineError::NoNode(target))?.appearance.set_fill(paint.clone());
}
Ok((gid, fid))
Ok((gid, fid, count))
})?,
};
s.remember_paint(&paint);
Ok(json!({ "group": g.0, "face": face.0 }))
Ok(json!({ "group": g.0, "face": face.0, "count": count }))
}
pub(super) fn lp_stroke_edge(s: &mut Session, p: &Value) -> Result<Value> {
@@ -498,31 +564,72 @@ pub(super) fn lp_stroke_edge(s: &mut Session, p: &Value) -> Result<Value> {
return Err(bad(C, "width out of range"));
}
let tol = number_or(p, "tolerance", 4.0, C)?.clamp(0.0, 1000.0);
let (eid, unchanged) = {
let scope = scope_param(p, C)?;
let like = match_param(p, C, scope != LpScope::One, "\"connected\" or \"samePaint\"")?;
let (eid, count, changed) = {
let d = &s.doc()?.doc;
let n = d.node(g).filter(|n| is_live_paint(n)).ok_or_else(|| bad(C, format!("{g} is not a Live Paint group")))?;
let e = b::visible_edge_near(n, pt, tol).ok_or_else(|| EngineError::Other("no Live Paint edge near that point".into()))?;
// An edge that already has the paint and the width (or has no stroke and gets none) stays as
// it is, and no undo step is recorded.
let unchanged = match e.appearance.stroke() {
Some(st) => st.paint == paint && st.width == width,
None => paint.is_none(),
let start = b::visible_edge_near(n, pt, tol).ok_or_else(|| EngineError::Other("no Live Paint edge near that point".into()))?;
let eid = start.id;
let like = like.unwrap_or_else(|| b::lp_stroke_paint(start));
let targets = match scope {
LpScope::One => vec![eid],
LpScope::Connected => b::connected_edges(n, eid, &like),
LpScope::SamePaint => std::iter::once(eid)
.chain(b::edges(n).into_iter().filter(|e| e.visible && e.id != eid && b::lp_stroke_paint(e) == like).map(|e| e.id))
.collect(),
};
(e.id, unchanged)
let count = targets.len();
// An edge whose shown stroke already has the paint and the width (or that has no shown stroke
// and gets none) stays as it is; when every edge does, nothing changes and no undo step is
// recorded.
let changed: Vec<NodeId> = targets
.into_iter()
.filter(|t| {
d.node(*t).is_none_or(|e| match shown_stroke(e) {
Some(st) => !(st.paint == paint && st.width == width),
None => !paint.is_none(),
})
})
.collect();
(eid, count, changed)
};
if unchanged {
return Ok(json!({ "group": g.0, "edge": eid.0 }));
if changed.is_empty() {
return Ok(json!({ "group": g.0, "edge": eid.0, "count": count }));
}
let edge = s.edit("Live Paint Bucket", |d, _| {
let e = d.node_mut(eid).ok_or(EngineError::NoNode(eid))?;
e.appearance.set_stroke(paint.clone());
if let Some(st) = e.appearance.stroke_mut() {
st.width = width;
s.edit("Live Paint Bucket", |d, _| {
for target in &changed {
let e = d.node_mut(*target).ok_or(EngineError::NoNode(*target))?;
match shown_stroke_mut(e) {
Some(st) => {
st.paint = paint.clone();
st.width = width;
}
None => e.appearance.items.push(super::AppearanceItem::Stroke(super::StrokeLayer::new(paint.clone(), width))),
}
}
Ok(eid)
Ok(())
})?;
s.remember_paint(&paint);
Ok(json!({ "group": g.0, "edge": edge.0 }))
Ok(json!({ "group": g.0, "edge": eid.0, "count": count }))
}
/// The stroke `livePaint.strokeEdge` paints on Live Paint edge `e`: its topmost stroke that is
/// shown. None when it has no stroke or every stroke is hidden; the command then adds a stroke
/// above the others.
fn shown_stroke(e: &Node) -> Option<&super::StrokeLayer> {
e.appearance.items.iter().rev().find_map(|i| match i {
super::AppearanceItem::Stroke(s) if s.visible => Some(s),
_ => None,
})
}
/// [`shown_stroke`], to change.
fn shown_stroke_mut(e: &mut Node) -> Option<&mut super::StrokeLayer> {
e.appearance.items.iter_mut().rev().find_map(|i| match i {
super::AppearanceItem::Stroke(s) if s.visible => Some(s),
_ => None,
})
}
/// Every fill and stroke row of face or edge `n`, bottom first, as `livePaint.info` lists them. A
@@ -104,9 +104,14 @@ fn plane_param(g: &PerspectiveGrid, p: &Value, cmd: &str) -> Result<Plane> {
Ok(plane)
}
/// The objects a perspective command acts on: the outermost of `ids` (each once, in the order first
/// given), else the selection's roots.
pub(super) fn roots(s: &Session, p: &Value) -> Result<Vec<NodeId>> {
match named_ids(p)? {
Some(v) => Ok(outermost(&s.doc()?.doc, v)),
Some(v) => {
let mut seen = std::collections::HashSet::new();
Ok(outermost(&s.doc()?.doc, v.into_iter().filter(|id| seen.insert(*id)).collect()))
}
None => selected_roots(s),
}
}
+6 -2
View File
@@ -427,6 +427,7 @@ pub(crate) fn apply(s: &mut Session, p: &Value) -> Result<Value> {
}
super::params::check_effect_color(C, id, &params)?;
super::params::check_effect_channel(C, id, &params)?;
super::params::check_effect_center(C, id, &params)?;
// Crop Marks take their style from the preferences when applied.
if id == effects::CROP_MARKS && params.get("style").is_none() {
params["style"] = json!(s.crop_mark_style().id());
@@ -740,6 +741,7 @@ pub(crate) fn set_params(s: &mut Session, p: &Value) -> Result<Value> {
for effect in &edited {
super::params::check_effect_color(C, effect, &params)?;
super::params::check_effect_channel(C, effect, &params)?;
super::params::check_effect_center(C, effect, &params)?;
}
if edited.iter().any(|e| texture_load_effect(e)) {
load_texture(&mut params, C)?;
@@ -833,11 +835,13 @@ pub(crate) fn set_params(s: &mut Session, p: &Value) -> Result<Value> {
const GLASS: &str = "distort.glass";
/// Effect › Texture › Texturizer.
const TEXTURIZER: &str = "texture.texturizer";
/// Effect › Artistic › Rough Pastels.
const ROUGH_PASTELS: &str = "artistic.roughPastels";
/// Does effect `id` have Load Texture: a `textureImage` that `effect.apply` reads from an image
/// file (Glass, Texturizer)?
/// file (Glass, Texturizer, Rough Pastels)?
pub(crate) fn texture_load_effect(id: &str) -> bool {
id == GLASS || id == TEXTURIZER
id == GLASS || id == TEXTURIZER || id == ROUGH_PASTELS
}
/// Glass's `textureImage` in `params` as Glass stores it: an image file (`{path}`, or `{name?,
+66
View File
@@ -1016,3 +1016,69 @@ fn a_3d_shadow_is_one_undo_step_saved_exported_and_expanded() {
});
assert_eq!(shadows, 1);
}
/// Radial Blur's Blur Center: stored as given, drawn about that point of the object's bounds, and
/// a value outside 0 to 1 (or not a number) is refused with nothing changed and no undo step.
#[test]
fn radial_blur_center_is_stored_drawn_and_checked() {
let (mut s, id) = session_with_rect();
let draw = |s: &Session| {
vectorcraft_render::Renderer::new().render(&s.doc().unwrap().doc, 300, 300, vectorcraft_geom::Affine::IDENTITY, &Default::default()).pixels
};
s.execute("effect.apply", &json!({"effect": "blur.radial", "params": {"amount": 40}})).unwrap();
assert_eq!(node(&s, id).appearance.effects[0].params["centerX"], json!(0.5), "the default center is stored");
let middle = draw(&s);
s.execute("effect.setParams", &json!({"index": 0, "params": {"centerX": 0.5, "centerY": 0.5}})).unwrap();
assert_eq!(draw(&s), middle, "the default center draws as before");
s.execute("effect.setParams", &json!({"index": 0, "params": {"centerX": 0, "centerY": 1}})).unwrap();
let params = node(&s, id).appearance.effects[0].params.clone();
assert_eq!((params["centerX"].clone(), params["centerY"].clone()), (json!(0), json!(1)));
let corner = draw(&s);
assert_ne!(corner, middle, "the blur turns about the bottom-left corner");
let undo = s.doc().unwrap().history.undo.len();
for (cmd, params) in [
("effect.setParams", json!({"index": 0, "params": {"centerX": 1.5}})),
("effect.setParams", json!({"index": 0, "params": {"centerY": -0.01}})),
("effect.setParams", json!({"index": 0, "params": {"centerX": "0.5"}})),
("effect.apply", json!({"effect": "blur.radial", "params": {"centerY": 2}})),
] {
let e = s.execute(cmd, &params).unwrap_err().to_string();
assert!(e.contains("must be a number"), "{cmd} {params}: {e}");
assert_eq!(s.doc().unwrap().history.undo.len(), undo, "{cmd} {params}");
assert_eq!(node(&s, id).appearance.effects.len(), 1, "{cmd} {params}");
assert_eq!(draw(&s), corner, "{cmd} {params}");
}
// A replayed journal is checked too: the refusal is the command's own.
let e = s.replay("effect.setParams", &json!({"index": 0, "params": {"centerX": 7}})).unwrap_err().to_string();
assert!(e.contains("`centerX` must be a number from 0 to 1"), "{e}");
// Moving the object moves the blur with it.
s.execute("object.move", &json!({"ids": [id.0], "dx": 40, "dy": 20})).unwrap();
let moved = draw(&s);
let at = |px: &[u8], x: usize, y: usize| px[(y * 300 + x) * 4..][..4].to_vec();
for (x, y) in [(95, 150), (150, 205), (205, 95), (120, 120)] {
assert_eq!(at(&moved, x + 40, y + 20), at(&corner, x, y), "({x}, {y})");
}
}
/// A Rasterize with transparent room around the art, before another Rasterize, splits the stack,
/// and the part after the split paints around content the room spreads. The Blur Center still
/// lies in the object's own bounds, so the blur draws as it does without the room.
#[test]
fn radial_blur_center_stays_in_the_object_when_the_stack_splits() {
let draw = |room: bool| {
let (mut s, _) = session_with_rect();
let mut stack = vec![("rasterize", json!({})), ("blur.radial", json!({"amount": 60, "centerX": 0, "centerY": 0}))];
if room {
stack.insert(0, ("rasterize", json!({"addAround": 40})));
}
for (effect, params) in stack {
s.execute("effect.apply", &json!({"effect": effect, "params": params})).unwrap();
}
vectorcraft_render::Renderer::new().render(&s.doc().unwrap().doc, 300, 300, vectorcraft_geom::Affine::IDENTITY, &Default::default()).pixels
};
let (plain, split) = (draw(false), draw(true));
let alpha = |px: &[u8]| px.iter().skip(3).step_by(4).map(|a| u64::from(*a)).sum::<u64>();
assert!(alpha(&plain) > 0, "the blurred art draws");
let differ = (0..300 * 300).filter(|i| plain[i * 4 + 3].abs_diff(split[i * 4 + 3]) > 8).count();
assert!(differ < 50, "{differ} pixels' coverage moved with the room around the art");
}
+1 -1
View File
@@ -39,7 +39,7 @@ pub mod jxlread;
mod legacy_ai;
mod load;
mod mesh3d;
pub(crate) use load::{MAX_RASTER_ALLOC, size_note};
pub(crate) use load::{MAX_RASTER_ALLOC, file_clipped, size_note};
mod heifread;
mod hpgl;
mod jp2read;
+20 -2
View File
@@ -864,7 +864,9 @@ pub(crate) fn size_note(bytes: &[u8]) -> Option<String> {
/// they are, with their ink amounts ([`ImageBlob::cmyk`]), except that ones storing one plane per
/// ink are written again with their inks together ([`vectorcraft_doc::cmyk::stored_cmyk_tiff`]);
/// CMYK TIFFs with an alpha channel, which the decoder can't read, become RGBA in the active color
/// settings' CMYK, as do CMYK Photoshop documents, whose merged image is read ([`psdread`]).
/// settings' CMYK, whichever of their extra channels is the alpha
/// ([`vectorcraft_doc::cmyk::extra_samples_tiff_rgba`]), as do CMYK Photoshop documents, whose
/// merged image is read ([`psdread`]).
/// 1-bit TIFFs compressed with CCITT Group 3, which the decoder can't read either, become RGBA
/// too ([`vectorcraft_doc::cmyk::group3_tiff_rgba`]).
/// Grayscale TIFFs with an alpha channel or other extra channels, which the decoder can't read
@@ -1072,16 +1074,32 @@ pub(super) fn raster_doc(name: &str, bytes: &[u8]) -> Result<Document> {
let layer = d.layers[0].id;
let id = d.alloc_id();
let xf = Affine::scale_non_uniform(sx, sy);
let mut n = Node::new(
let n = Node::new(
id,
NodeKind::Image(Box::new(ImageObject { key: key.clone(), width, height, xf, link: None, placement: Default::default(), pixels: None })),
);
let mut n = file_clipped(&mut d, n, psdread::clipping_path(bytes));
n.name = Some(name.to_string());
d.images.insert(key, blob);
d.insert(Some(layer), 0, n).map_err(err)?;
Ok(d)
}
/// Image `image` of `d` clipped by `clip`, the clipping path its file names in the image's pixel
/// space (a PSD or PSB file's, [`psdread::clipping_path`]): a clip group of that path (even-odd,
/// with no paint) and the image. Without one the image stays as it is.
pub(crate) fn file_clipped(d: &mut Document, image: Node, clip: Option<vectorcraft_geom::PathData>) -> Node {
let (Some(mut path), NodeKind::Image(im)) = (clip, &image.kind) else { return image };
path.transform(im.xf);
let none = vectorcraft_color::Paint::None;
let mut clip = Node::path(d.alloc_id(), path, vectorcraft_doc::Appearance::basic(none.clone(), none, 0.0));
if let NodeKind::Path { clipping, rule, .. } = &mut clip.kind {
*clipping = true;
*rule = vectorcraft_geom::FillRule::EvenOdd;
}
Node::new(d.alloc_id(), NodeKind::Group { children: vec![std::sync::Arc::new(clip), std::sync::Arc::new(image)], clip: true })
}
/// Does this import note say that the file has something the document doesn't?
fn is_loss(note: &str) -> bool {
note == vectorcraft_pdf::OFF_ARTBOARD_NOTE || vectorcraft_eps::is_loss(note)
+103 -18
View File
@@ -2,7 +2,8 @@
//! File › Place (#918): the merged image, the flattened picture every PSD carries after its layers,
//! as a linked PSD shows. Written from Adobe's public "Photoshop File Formats Specification"
//! (<https://www.adobe.com/devnet-apps/photoshop/fileformatashtml/>). File › Open reads the
//! layers with [`super::psdlayers`], which shares this reader.
//! layers with [`super::psdlayers`], which shares this reader. The clipping path a document names
//! ([`clipping_path`]) clips its merged image where it opens or is placed.
//!
//! Every mode Photoshop saves a merged image in is read: Bitmap, Grayscale, Duotone (as its
//! grayscale data), Indexed, RGB, CMYK and Lab, at 1, 8, 16 and 32 bits per channel, stored raw,
@@ -14,6 +15,7 @@
use std::io::Read;
use vectorcraft_color::cms::{Lab, lab::lab_to_srgb};
use vectorcraft_geom::{Anchor, AnchorKind, PathData, Point, SubPath};
/// Photoshop's colour modes (the header's numbers), as far as the merged image is concerned.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
@@ -154,30 +156,113 @@ pub(super) fn header<'a>(r: &mut Reader<'a>) -> Result<Header<'a>, String> {
pub fn resolution(bytes: &[u8]) -> Option<(f64, f64)> {
let mut r = Reader::new(bytes);
let h = header(&mut r).ok()?;
let mut r = Reader::new(h.resources);
while !r.rest().is_empty() {
r.take(4).ok()?;
let (_, _, data) = resources(h.resources, false).find(|(id, _, _)| *id == 0x03ed)?;
let mut d = Reader::new(data);
// Fixed 16.16 values, each with its unit (1: per inch, 2: per centimetre) and the unit the
// size is shown in.
let mut axis = || -> Option<f64> {
let v = f64::from(d.u32().ok()?) / 65536.0;
let unit = d.u16().ok()?;
d.u16().ok()?;
Some(if unit == 2 { v * 2.54 } else { v })
};
Some((axis()?, axis()?))
}
/// The image resource blocks of `resources`, in file order: each one's id, name (the bytes of its
/// Pascal string) and data. Stops at the first block that is cut short. With `signed`, only the
/// blocks whose signature is `8BIM` are given.
fn resources(resources: &[u8], signed: bool) -> impl Iterator<Item = (u16, &[u8], &[u8])> {
let mut r = Reader::new(resources);
std::iter::from_fn(move || {
if r.rest().is_empty() {
return None;
}
let ours = r.take(4).ok()? == b"8BIM";
let id = r.u16().ok()?;
// A Pascal string padded to an even size, length byte included.
let name = usize::from(r.u8().ok()?);
r.take(name + (name + 1) % 2).ok()?;
let len = usize::from(r.u8().ok()?);
let name = r.take(len).ok()?;
r.take((len + 1) % 2).ok()?;
let size = usize::try_from(r.u32().ok()?).ok()?;
let data = r.take(size).ok()?;
r.take(size % 2).ok()?;
if id == 0x03ed {
let mut d = Reader::new(data);
// Fixed 16.16 values, each with its unit (1: per inch, 2: per centimetre) and the
// unit the size is shown in.
let mut axis = || -> Option<f64> {
let v = f64::from(d.u32().ok()?) / 65536.0;
let unit = d.u16().ok()?;
d.u16().ok()?;
Some(if unit == 2 { v * 2.54 } else { v })
};
return Some((axis()?, axis()?));
Some((ours, id, name, data))
})
.filter(move |(ours, ..)| *ours || !signed)
.map(|(_, id, name, data)| (id, name, data))
}
/// The resource naming the document's clipping path.
const CLIPPING_PATH_NAME: u16 = 2999;
/// The saved paths' resource ids.
const SAVED_PATHS: std::ops::RangeInclusive<u16> = 2000..=2997;
/// The clipping path a PSD or PSB file names, in its pixel space (x across its width, y down
/// its height): the saved path (resources 2000 to 2997) whose name the clipping path resource
/// (2999) gives, both `8BIM` resources. `None` when the document names none, names a path it doesn't have, or that path
/// has no anchors or more records than [`vectorcraft_geom::path::MAX_READ_ANCHORS`]. Saved paths
/// use the even-odd rule. A path whose initial fill record says the fill starts with all pixels
/// begins with a subpath around the whole image, so its subpaths cut holes in it.
pub fn clipping_path(bytes: &[u8]) -> Option<PathData> {
let mut r = Reader::new(bytes);
let h = header(&mut r).ok()?;
let (_, _, named) = resources(h.resources, true).find(|(id, _, _)| *id == CLIPPING_PATH_NAME)?;
// A Pascal string, then the flatness and a fill rule, which the specification says is ignored.
let len = usize::from(*named.first()?);
let name = named.get(1..1 + len)?;
let (_, _, data) = resources(h.resources, true).find(|(id, n, _)| SAVED_PATHS.contains(id) && *n == name)?;
// A path of more records than a document may hold anchors is left out before it is built.
if data.len() / PATH_RECORD > vectorcraft_geom::path::MAX_READ_ANCHORS {
return None;
}
let path = saved_path(data, f64::from(h.width), f64::from(h.height));
(!path.is_empty()).then_some(path)
}
/// One record of a saved path: a selector, then 24 bytes.
const PATH_RECORD: usize = 26;
/// The saved path of path records `data`, scaled to an image `width` × `height` pixels. Knot
/// records come after their subpath's length record; one that comes before any, or past the knots
/// a length record counts, is left out, as is a last record cut short.
fn saved_path(data: &[u8], width: f64, height: f64) -> PathData {
// A path point: a vertical, then a horizontal signed 8.24 fixed-point fraction of the image's
// height and width.
let fixed = |b: [u8; 4]| f64::from(i32::from_be_bytes(b)) / f64::from(1 << 24);
let point = |[v0, v1, v2, v3, h0, h1, h2, h3]: [u8; 8]| Point::new(fixed([h0, h1, h2, h3]) * width, fixed([v0, v1, v2, v3]) * height);
let mut subpaths: Vec<SubPath> = vec![];
let mut all_pixels = false;
// The knots the current subpath still takes.
let mut left = 0usize;
let (records, _) = data.as_chunks::<PATH_RECORD>();
for &[s0, s1, ref body @ ..] in records {
let [c0, c1, ..] = *body;
let (points, _) = body.as_chunks::<8>();
let [a, b, c] = [0, 1, 2].map(|i| points.get(i).copied().map_or(Point::ZERO, point));
match u16::from_be_bytes([s0, s1]) {
sel @ (0 | 3) => {
left = usize::from(u16::from_be_bytes([c0, c1]));
// Anchors are added as knots come: a count can claim more than follow.
subpaths.push(SubPath::new(vec![], sel == 0));
}
sel @ (1 | 2 | 4 | 5) if left > 0 => {
let Some(sp) = subpaths.last_mut() else { continue };
left -= 1;
let kind = if matches!(sel, 1 | 4) { AnchorKind::Smooth } else { AnchorKind::Corner };
sp.anchors.push(Anchor { h_in: a, p: b, h_out: c, kind });
}
8 => all_pixels = [c0, c1] == [0, 1],
_ => {}
}
}
None
subpaths.retain(|s| !s.anchors.is_empty());
if all_pixels && !subpaths.is_empty() {
let all = vectorcraft_geom::shapes::rectangle(vectorcraft_geom::Rect::new(0.0, 0.0, width, height));
subpaths.splice(0..0, all.subpaths);
}
PathData::new(subpaths)
}
/// Does the merged image keep its transparency in the first extra channel? Yes when the layer
+35
View File
@@ -202,6 +202,41 @@ fn a_16_bit_cmyk_tiff_with_alpha_places_at_16_bits() {
}
}
/// A CMYK or grayscale TIFF whose alpha follows another extra sample opens and places with that
/// alpha, at 8 and 16 bits, chunky and planar; a CMYK one is not kept as inks. A CMYK one with two
/// more samples than its ExtraSamples values count does too.
#[test]
fn a_tiff_with_alpha_after_another_extra_sample_places_with_its_alpha() {
let none = vec![0u16; 6];
let full = vec![255u16; 6];
let other = vec![9u16, 8, 7, 6, 5, 4];
let alpha = vec![255u16, 128, 0, 255, 64, 1];
let inks = [full.clone(), none.clone(), none.clone(), none.clone()];
let cases = [
("CMYK", 5, vec![full.clone(), none.clone(), none.clone(), none.clone(), other.clone(), alpha.clone()]),
("CMYK, two more samples", 5, [&inks[..], &[other.clone(), alpha.clone(), other.clone(), full.clone()]].concat()),
("gray", 1, vec![full.clone(), other.clone(), alpha.clone()]),
];
for (what, photometric, channels) in cases {
for bits in [8, 16] {
let wide: Vec<Vec<u16>> = channels.iter().map(|ch| ch.iter().map(|v| if bits == 16 { v * 257 } else { *v }).collect()).collect();
for planar in [false, true] {
let what = format!("{what}, {bits} bits, planar {planar}");
let file = hand_tiff(photometric, bits, &[0, 2], planar, &wide);
let (inks, rgba) = kept(&what, &file);
assert_eq!(inks, None, "{what}: shown as RGB with its alpha");
let alphas: Vec<u8> = rgba.iter().skip(3).step_by(4).copied().collect();
assert_eq!(alphas, [255, 128, 0, 255, 64, 1], "{what}: the alpha is the second extra sample");
let mut s = session(100.0, 100.0, 1);
s.execute("file.place", &json!({"name": "a.tif", "dataBase64": vectorcraft_format::base64_encode(&file)})).unwrap();
let blob = &s.doc().unwrap().doc.images[&image_of(&s).key];
let placed = image::load_from_memory(&blob.bytes).unwrap().to_rgba8().into_raw();
assert_eq!(placed, rgba, "{what}: Place reads it as Open does");
}
}
}
}
/// A planar TIFF whose header claims more strips than the decoder can count (here 2^31 + 1 rows
/// a strip each, times 5 planes) is refused as too large to draw, without a panic.
#[test]
+197 -2
View File
@@ -1,9 +1,11 @@
//! Reading Photoshop documents (#918): the merged image of every colour mode, depth and
//! compression, PSB files, transparency, the resolution, and damaged files refused without a panic.
//! compression, PSB files, transparency, the resolution, the clipping path, and damaged files
//! refused without a panic.
use serde_json::{Value, json};
use vectorcraft_doc::{Document, NodeId, NodeKind};
use super::psdread::{decode, is_psd, resolution};
use super::psdread::{clipping_path, decode, is_psd, resolution};
use super::*;
/// A Photoshop document built from its parts: `version` 1 (PSD) or 2 (PSB), the header's fields,
@@ -260,6 +262,199 @@ fn pdd_files_open_and_place() {
assert!(format_for_name("x.pdd").is_none() && writable_format(None, Some("x.pdd")).is_err(), "an export to .pdd is refused as before");
}
/// An image resource block: `8BIM`, `id`, `name` as a Pascal string padded to an even size, then
/// `data` padded to an even size.
fn resource(id: u16, name: &[u8], data: &[u8]) -> Vec<u8> {
let mut r = b"8BIM".to_vec();
r.extend(id.to_be_bytes());
r.push(name.len() as u8);
r.extend(name);
if name.len().is_multiple_of(2) {
r.push(0);
}
r.extend((data.len() as u32).to_be_bytes());
r.extend(data);
if !data.len().is_multiple_of(2) {
r.push(0);
}
r
}
/// A path point record's 8 bytes: `[x, y]` as fractions of the image's width and height, stored
/// vertical first as signed 8.24 fixed-point numbers.
fn point([x, y]: [f64; 2]) -> Vec<u8> {
[y, x].iter().flat_map(|v| ((v * f64::from(1 << 24)).round() as i32).to_be_bytes()).collect()
}
/// A saved path's records: the fill rule record, an initial fill record saying whether the fill
/// starts with all pixels, then each subpath (closed or not) of corner knots without handles.
fn saved_path(all_pixels: bool, subpaths: &[(bool, &[[f64; 2]])]) -> Vec<u8> {
let record = |selector: u16, body: Vec<u8>| {
let mut r = selector.to_be_bytes().to_vec();
r.extend(body);
r.resize(26, 0);
r
};
let mut d = record(6, vec![]);
d.extend(record(8, vec![0, u8::from(all_pixels)]));
for (closed, knots) in subpaths {
d.extend(record(if *closed { 0 } else { 3 }, (knots.len() as u16).to_be_bytes().to_vec()));
for k in *knots {
d.extend(record(if *closed { 2 } else { 5 }, [point(*k), point(*k), point(*k)].concat()));
}
}
d
}
/// The clipping path resource (2999) naming the saved path `name`, with a flatness of 0 and the
/// fill rule left as it is.
fn clipping_name(name: &[u8]) -> Vec<u8> {
let mut d = vec![name.len() as u8];
d.extend(name);
d.extend([0; 6]);
resource(2999, b"", &d)
}
/// A 100 × 50 pixel red RGB document with `resources`, flat or with a layer count of 0.
fn red_psd(resources: &[u8]) -> Vec<u8> {
psd(1, 3, (100, 50), 8, 3, &[], resources, &[], &raw(&[&[255; 5000], &[0; 5000], &[0; 5000]]))
}
/// The triangle saved as "Outline", another path saved as "Other", and the clipping path naming
/// "Outline".
fn triangle_resources() -> Vec<u8> {
let other = saved_path(false, &[(true, &[[0.0, 0.0], [0.1, 0.0], [0.1, 0.1]])]);
let outline = saved_path(false, &[(true, &[[0.5, 0.0], [1.0, 1.0], [0.0, 1.0]])]);
[resource(2000, b"Other", &other), resource(2001, b"Outline", &outline), clipping_name(b"Outline")].concat()
}
/// The clip group a PSD file comes in as: its clipping path's anchors (pt), whether that path
/// uses the even-odd rule, and the image it clips.
fn clip_group(d: &Document, id: NodeId) -> (Vec<[f64; 2]>, bool, NodeId) {
let Some(NodeKind::Group { children, clip: true }) = d.node(id).map(|n| &n.kind) else { panic!("not a clip group: {:?}", d.node(id)) };
let [path, image] = &children[..] else { panic!("{} children", children.len()) };
let NodeKind::Path { path: p, rule, clipping: true, .. } = &path.kind else { panic!("not a clipping path") };
assert!(matches!(image.kind, NodeKind::Image(_)));
let anchors = p.anchors().map(|(_, _, a)| [a.p.x, a.p.y]).collect();
(anchors, *rule == vectorcraft_geom::FillRule::EvenOdd, image.id)
}
#[test]
fn the_clipping_path_clips_the_merged_image_on_place_and_open() {
let f = red_psd(&triangle_resources());
let triangle = vec![[50.0, 0.0], [100.0, 50.0], [0.0, 50.0]];
let data = vectorcraft_format::base64_encode(&f);
// Place: one clip group of the named path, not the other, at 100 % (72 ppi: a pixel a point).
let mut s = Session::new();
s.execute("file.new", &json!({"width": 100, "height": 50})).unwrap();
let r = s.execute("file.place", &json!({"name": "cut.psd", "dataBase64": data, "at": [50, 25]})).unwrap();
let id = NodeId(r["ids"][0].as_u64().unwrap());
let (anchors, even_odd, image) = clip_group(&s.doc().unwrap().doc, id);
assert_eq!((anchors, even_odd), (triangle.clone(), true));
assert_eq!(r["image"], image.0, "{r}");
assert_eq!((r["width"].as_f64(), r["height"].as_f64()), (Some(100.0), Some(50.0)));
// Open with layers off, and a flat file opened with layers on, as its merged image.
for params in [json!({"layers": false}), json!({})] {
s.execute("document.open", &merge(json!({"name": "cut.psd", "dataBase64": data}), params.clone())).unwrap();
let d = &s.doc().unwrap().doc;
let top = d.layers[0].children().unwrap();
assert_eq!(top.len(), 1, "{params}");
assert_eq!(top[0].name.as_deref(), Some("cut.psd"), "{params}");
let group = top[0].id;
let (anchors, even_odd, _) = clip_group(d, group);
assert_eq!((anchors, even_odd), (triangle.clone(), true), "{params}");
// The corner outside the triangle draws nothing; its middle draws red.
let png = image::load_from_memory(&exported(&mut s, json!({"format": "png"}))).unwrap().to_rgba8();
assert_eq!((png.get_pixel(2, 2).0[3], png.get_pixel(50, 40).0), (0, [255, 0, 0, 255]), "{params}");
// The clipping path is an ordinary path: releasing the clipping mask leaves the image whole.
s.execute("select.set", &json!({"ids": [group.0]})).unwrap();
s.execute("object.clippingMask.release", &json!({})).unwrap();
let png = image::load_from_memory(&exported(&mut s, json!({"format": "png"}))).unwrap().to_rgba8();
assert_eq!(png.get_pixel(2, 2).0, [255, 0, 0, 255], "{params}");
}
}
/// Replace keeps a clipped PSD file's scale, as it keeps an image's.
#[test]
fn replacing_a_clipped_psd_keeps_its_scale() {
let data = vectorcraft_format::base64_encode(&red_psd(&triangle_resources()));
let mut s = Session::new();
s.execute("file.new", &json!({"width": 400, "height": 400})).unwrap();
s.execute("file.place", &json!({"name": "cut.psd", "dataBase64": data, "at": [200, 200]})).unwrap();
s.execute("object.scale", &json!({"sx": 200, "sy": 200})).unwrap();
let r = s.execute("file.place", &json!({"name": "cut.psd", "dataBase64": data, "replace": true})).unwrap();
assert_eq!((r["width"].as_f64(), r["height"].as_f64()), (Some(200.0), Some(100.0)), "{r}");
let (anchors, _, _) = clip_group(&s.doc().unwrap().doc, NodeId(r["ids"][0].as_u64().unwrap()));
assert_eq!(anchors, [[200.0, 150.0], [300.0, 250.0], [100.0, 250.0]]);
// Other art replacing the clip group takes its centre only, as before.
let plain = vectorcraft_format::base64_encode(&red_psd(&[]));
let r = s.execute("file.place", &json!({"name": "plain.psd", "dataBase64": plain, "replace": true})).unwrap();
assert_eq!((r["width"].as_f64(), r["height"].as_f64()), (Some(100.0), Some(50.0)), "{r}");
}
#[test]
fn a_fill_that_starts_with_all_pixels_puts_the_image_around_the_path() {
let hole = saved_path(true, &[(true, &[[0.25, 0.25], [0.75, 0.25], [0.75, 0.75], [0.25, 0.75]])]);
let f = red_psd(&[resource(2000, b"Hole", &hole), clipping_name(b"Hole")].concat());
let path = clipping_path(&f).unwrap();
let starts: Vec<_> = path.subpaths.iter().map(|s| (s.anchors[0].p.x, s.anchors[0].p.y, s.closed)).collect();
assert_eq!(starts, [(0.0, 0.0, true), (25.0, 12.5, true)], "the image's edges, then the hole");
let mut s = Session::new();
s.execute("document.open", &json!({"name": "hole.psd", "dataBase64": vectorcraft_format::base64_encode(&f), "layers": false})).unwrap();
let png = image::load_from_memory(&exported(&mut s, json!({"format": "png"}))).unwrap().to_rgba8();
assert_eq!((png.get_pixel(2, 2).0, png.get_pixel(50, 25).0[3]), ([255, 0, 0, 255], 0));
}
#[test]
fn files_naming_no_clipping_path_or_a_missing_one_place_a_plain_image() {
let other = saved_path(false, &[(true, &[[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]])]);
let empty = saved_path(false, &[]);
for (resources, what) in [
(resource(2000, b"Other", &other), "saved paths, none named"),
([resource(2000, b"Other", &other), clipping_name(b"Gone")].concat(), "a name no path has"),
([resource(2000, b"Empty", &empty), clipping_name(b"Empty")].concat(), "a path with no knots"),
([resource(3000, b"Other", &other), clipping_name(b"Other")].concat(), "a resource outside the saved paths"),
([resource(2000, b"Other", &other), [&b"MeSa"[..], &clipping_name(b"Other")[4..]].concat()].concat(), "a block not signed 8BIM"),
(vec![], "no resources"),
] {
let f = red_psd(&resources);
assert!(clipping_path(&f).is_none(), "{what}");
let mut s = Session::new();
s.execute("file.new", &json!({})).unwrap();
let r = s.execute("file.place", &json!({"name": "a.psd", "dataBase64": vectorcraft_format::base64_encode(&f)})).unwrap();
let id = NodeId(r["ids"][0].as_u64().unwrap());
assert!(matches!(s.doc().unwrap().doc.node(id).map(|n| &n.kind), Some(NodeKind::Image(_))), "{what}");
assert!(r.get("image").is_none(), "{what}: {r}");
}
}
#[test]
fn damaged_clipping_paths_are_read_without_a_panic() {
let good = red_psd(&triangle_resources());
assert!(clipping_path(&good).is_some());
// The header, the empty colour mode data, then the resources' length and the resources.
let start = 26 + 4;
let end = start + 4 + triangle_resources().len();
for n in 0..end + 2 {
let _ = clipping_path(&good[..n]);
}
for i in start..end {
for v in [0, 1, 0x7f, 0x80, 0xff] {
let mut f = good.clone();
f[i] = v;
let _ = clipping_path(&f);
}
}
// Knots before any length record, and more knots than a length record counts, are left out.
let mut extra = saved_path(false, &[(true, &[[0.0, 0.0], [1.0, 0.0], [1.0, 1.0]])]);
extra[26 * 2 + 3] = 2;
let mut stray = 2u16.to_be_bytes().to_vec();
stray.resize(26, 0);
extra.splice(26..26, stray);
let path = clipping_path(&red_psd(&[resource(2000, b"P", &extra), clipping_name(b"P")].concat())).unwrap();
assert_eq!(path.subpaths.iter().map(|s| s.anchors.len()).collect::<Vec<_>>(), [2]);
}
#[test]
fn damaged_and_unsupported_files_are_refused_without_a_panic() {
let good = psd(2, 4, (3, 2), 8, 3, &[], &[], &layer_count(-1, true), &raw(&[&[1; 6], &[2; 6], &[3; 6], &[4; 6]]));
+2 -2
View File
@@ -37,9 +37,9 @@ use axis::{nice_axis, tick_values};
#[cfg(test)]
use columns::{fill_totals, total_text};
pub use commands::specs;
pub(crate) use data::apply_csv;
pub(crate) use data::{apply_csv, parse_csv};
#[cfg(test)]
use data::{fmt_value, parse_csv, to_csv};
use data::{fmt_value, to_csv};
pub(crate) use edit::{graphs_holding, keep_placed};
#[cfg(test)]
use generate::generate;
+1 -1
View File
@@ -42,7 +42,7 @@ fn cell(c: &str) -> Cell {
}
}
pub(super) fn parse_csv(csv: &str) -> (Vec<String>, Vec<String>, Vec<Vec<Option<f64>>>) {
pub(crate) fn parse_csv(csv: &str) -> (Vec<String>, Vec<String>, Vec<Vec<Option<f64>>>) {
let csv = csv.strip_prefix('\u{feff}').unwrap_or(csv);
// Records end at line breaks outside quotes; a record is tab-separated if it has a tab outside quotes.
let rows: Vec<Vec<Cell>> = split_unquoted(csv, '\n')
+8 -6
View File
@@ -149,20 +149,22 @@ impl Gen<'_> {
refresh_bounds(&mut t);
t
}
/// A category or series label: a `|` in it starts a new line (Add graph labels). `middle`: the lines are centred
/// on `at` (labels beside an axis or in a wedge) instead of running down from it.
/// A category or series label: a `|` in it starts a new line (Add graph labels), as does a line break a quoted CSV
/// cell keeps. `middle`: the lines are centred on `at` (labels beside an axis or in a wedge) instead of running down
/// from it.
pub(super) fn label(&mut self, role: Role, at: Point, s: &str, justify: Justify, middle: bool) -> Arc<Node> {
let lines = s.split('|').count();
let text = s.replace('|', "\n");
let lines = text.split('\n').count();
// Default leading puts the first and last baselines this far above and below `at`.
let half = (lines - 1) as f64 * label_size(self.styles, role) * 1.2 / 2.0;
let start = if middle { Point::new(at.x, at.y - half) } else { at };
let mut t = self.text_object(role, start, &s.replace('|', "\n"), justify);
let mut t = self.text_object(role, start, &text, justify);
// Kept leading or paragraph spacing moves the lines: put the middle of the first and last baselines on `at`. An
// empty line has no baseline: an empty first or last line leaves the label where the default leading puts it.
if middle && kept_para(self.styles, role).is_some() {
let ys: Vec<f64> = t.baselines().map(|(a, _)| a.y).collect();
let ends_set = s.split('|').next().is_some_and(|l| !l.is_empty()) && s.split('|').next_back().is_some_and(|l| !l.is_empty());
let set = s.split('|').filter(|l| !l.is_empty()).count();
let ends_set = text.split('\n').next().is_some_and(|l| !l.is_empty()) && text.split('\n').next_back().is_some_and(|l| !l.is_empty());
let set = text.split('\n').filter(|l| !l.is_empty()).count();
if let (Some(first), Some(last), true) = (ys.first(), ys.last(), ends_set && ys.len() == set) {
t.xf = Affine::translate((0.0, half - (first + last) / 2.0)) * t.xf;
}
+90 -3
View File
@@ -7142,6 +7142,43 @@ fn a_centered_label_with_an_empty_middle_line_and_kept_leading_stays_centered()
assert!((after - before).abs() < 0.01, "the three-line category label keeps its middle: {before} {after}");
}
#[test]
fn a_centered_label_with_a_line_break_in_its_text_is_set_as_with_a_bar() {
// A quoted CSV cell keeps its line breaks, so they reach the label as well as the `|` it is written with.
for (bar, quoted, text) in [("Q|1", "\"Q\n1\"", "Q\n1"), ("Q|||1", "\"Q\n||1\"", "Q\n\n\n1")] {
let label_middle = |s: &Session, id: NodeId| {
let n = s.doc().unwrap().doc.node(id).unwrap().clone();
let label =
group(&n, "Axes").children().unwrap().iter().find(|c| matches!(&c.kind, NodeKind::Text(t) if t.plain_text() == text)).unwrap();
let b = label.geometric_bounds().unwrap();
(b.y0 + b.y1) / 2.0
};
let drawn = |cat: &str, leading: bool| {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 800, "height": 800})).unwrap();
let csv = format!(",2024,2025\n{cat},3,2\nQ2,5,4\nQ3,-1,6");
let id = NodeId(
s.execute("graph.create", &json!({"type": "bar", "x": 100, "y": 100, "width": 300, "height": 200, "csv": csv})).unwrap()["id"]
.as_u64()
.unwrap(),
);
if leading {
let l = text_id(&s, id, "Axes", text);
s.execute("select.set", &json!({"ids": [l.0]})).unwrap();
s.execute("text.setFormat", &json!({"autoLeading": 400})).unwrap();
s.execute("select.set", &json!({"ids": [id.0]})).unwrap();
s.execute("graph.setData", &json!({"id": id.0, "csv": csv})).unwrap();
}
label_middle(&s, id)
};
for leading in [false, true] {
let (by_bar, by_break) = (drawn(bar, leading), drawn(quoted, leading));
assert!((by_bar - by_break).abs() < 0.01, "{text:?} sits where {bar:?} does (kept leading: {leading}): {by_bar} {by_break}");
}
assert!((drawn(quoted, true) - drawn(quoted, false)).abs() < 0.01, "{text:?} keeps its middle with kept leading");
}
}
#[test]
fn a_legend_across_top_measures_its_labels_with_system_layout() {
let mut s = Session::new();
@@ -7335,8 +7372,8 @@ fn graph_commands_refuse_params_of_the_wrong_type() {
}
/// A `.ai` in PostScript form whose graph's records read whole (version 7 specification, appendix A)
/// opens as a graph whose data can be edited: Graph Data redraws it on its plot. Saving it as `.ai`
/// says its data and settings aren't written, in either form.
/// opens as a graph whose data can be edited: Graph Data redraws it on its plot. Saving it as `.ai`,
/// in either form, writes its records, and the file opens again with the graph's new data.
#[test]
fn a_graph_opened_from_ai_keeps_its_data_for_editing() {
let graph = "%_Gs\n%_100 200 300 100 Gb\n%_5 0 0 14 0 1 0 0 6 44 Gy\n%_10 2 0 0 90 80 0 Gd\n\
@@ -7393,10 +7430,60 @@ fn a_graph_opened_from_ai_keeps_its_data_for_editing() {
}
let r = s.execute("file.saveAs", &p).unwrap();
let notes = r["warnings"].as_array().cloned().unwrap_or_default();
assert!(notes.iter().any(|w| w.as_str().is_some_and(|w| w.starts_with("graphs are written as their art"))), "{name}: {r}");
assert!(!notes.iter().any(|w| w.as_str().is_some_and(|w| w.starts_with("graphs are written as their art"))), "{name}: {r}");
let mut again = Session::new();
again.execute("document.open", &json!({"path": dir.join(name)})).unwrap();
let mut graphs = vec![];
again.doc().unwrap().doc.walk(|n| graphs.extend(n.extras().graph.as_deref().cloned()));
assert_eq!(graphs.len(), 1, "{name}");
let g = &graphs[0];
assert_eq!(
(g.series.as_slice(), g.categories.as_slice(), g.rows.as_slice()),
(&after.series[..], &after.categories[..], &after.rows[..]),
"{name}"
);
assert_eq!(g.kind, after.kind, "{name}");
}
}
/// A graph the graph tools draw, of each type, saved as `.ai` in either form, opens again as the same
/// graph exactly when the save gives no warning about graphs; a column graph does.
#[test]
fn a_drawn_graph_saved_as_ai_opens_as_a_graph_unless_the_save_warns() {
let dir = vectorcraft_testkit::temp_dir("graph-ai-save");
let mut live = vec![];
for ty in ["column", "stackedColumn", "bar", "stackedBar", "line", "area", "scatter", "pie", "radar"] {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 800, "height": 800})).unwrap();
let csv = ",2024,2025\nQ1,3,2\nQ2,5,4\nQ3,1,6";
let id = s.execute("graph.create", &json!({"type": ty, "x": 100, "y": 100, "width": 300, "height": 200, "csv": csv})).unwrap()["id"]
.as_u64()
.unwrap();
let written = spec(&s, NodeId(id));
for (name, version) in [("v7.ai", Some("7")), ("pdf.ai", None)] {
let path = dir.join(format!("{ty}-{name}"));
let mut p = json!({"path": path, "format": "ai"});
if let Some(v) = version {
p["aiVersion"] = json!(v);
}
let r = s.execute("file.saveAs", &p).unwrap();
let notes = r["warnings"].as_array().cloned().unwrap_or_default();
let warned = notes.iter().any(|w| w.as_str().is_some_and(|w| w.starts_with("graphs are written as their art")));
let mut again = Session::new();
again.execute("document.open", &json!({"path": path})).unwrap();
let mut graphs = vec![];
again.doc().unwrap().doc.walk(|n| graphs.extend(n.extras().graph.as_deref().cloned()));
assert_eq!(graphs.len(), usize::from(!warned), "{ty} {name}: {r}");
if let Some(g) = graphs.first() {
assert_eq!((g.kind, g.cells()), (written.kind, written.cells()), "{ty} {name}");
assert_eq!((g.series.as_slice(), g.categories.as_slice()), (&written.series[..], &written.categories[..]), "{ty} {name}");
live.push(format!("{ty} {name}"));
}
}
}
assert!(live.contains(&"column v7.ai".to_string()) && live.contains(&"column pdf.ai".to_string()), "{live:?}");
}
/// A graph opened from a `.ai` keeps the bounds of its art without type, so moving one of its labels on its own
/// leaves the plot where it is at the first redraw.
#[test]
+2 -2
View File
@@ -43,7 +43,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Scale…",
["Object", "Transform"],
None,
"{ids?: [id…] (selected first; default: the selection), sx: %, sy?: %, origin?: [x,y], copy?, strokes?: bool (Scale Strokes & Effects: stroke weights, dashes and effect distances scale; off keeps them, type strokes included), corners?: bool (Scale Corners: live corner radii scale), objects?: bool (Transform Objects, default true; false: the art stays and, with patterns, only its pattern tiles transform), patterns?: bool (Transform Patterns: pattern fills and strokes transform with the art; default: prefs transformPatternTiles), typeAreas?: bool (area type: the frame is reshaped and the text reflows at its size)} (strokes/corners default to the preferences). With anchors selected with Direct Selection (and no copy), only those anchors and their handles transform, about the centre of their own box.",
"{ids?: [id…] (selected first; default: the selection), sx: % (along the bounding box's width), sy?: % (along its height), origin?: [x,y] (a page point), basis?: \"box\"|\"page\" (box, the default: sx and sy follow the bounding box, turned with rotated objects until Reset Bounding Box; page: the page's axes; a saved step without basis, recorded before it, plays along the page's axes), copy?, strokes?: bool (Scale Strokes & Effects: stroke weights, dashes and effect distances scale; off keeps them, type strokes included), corners?: bool (Scale Corners: live corner radii scale), objects?: bool (Transform Objects, default true; false: the art stays and, with patterns, only its pattern tiles transform), patterns?: bool (Transform Patterns: pattern fills and strokes transform with the art; default: prefs transformPatternTiles), typeAreas?: bool (area type: the frame is reshaped and the text reflows at its size)} (strokes/corners default to the preferences). With anchors selected with Direct Selection (and no copy), only those anchors and their handles transform, about the centre of their own box.",
has_selection,
scale
),
@@ -52,7 +52,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Reflect…",
["Object", "Transform"],
None,
"{ids?: [id…] (selected first; default: the selection), axis: \"vertical\"|\"horizontal\"|deg (the mirror line, counter-clockwise from horizontal; 0: horizontal; omitted: vertical), origin?, copy?, objects?: bool (Transform Objects, default true; false: the art stays and, with patterns, only its pattern tiles transform), patterns?: bool (Transform Patterns: pattern fills and strokes transform with the art; default: prefs transformPatternTiles), typeAreas?: bool (area type: the frame is reshaped and the text reflows at its size)}. With anchors selected with Direct Selection (and no copy), only those anchors and their handles transform, about the centre of their own box.",
"{ids?: [id…] (selected first; default: the selection), axis: \"vertical\"|\"horizontal\"|deg (the mirror line, counter-clockwise from horizontal; 0: horizontal; omitted: vertical; vertical and horizontal are the bounding box's own axes, deg a line on the page), origin?, basis?: \"box\"|\"page\" (for a named axis; box, the default: the bounding box's axes, turned with rotated objects until Reset Bounding Box; page: the page's axes; a saved step without basis, recorded before it, plays along the page's axes), copy?, objects?: bool (Transform Objects, default true; false: the art stays and, with patterns, only its pattern tiles transform), patterns?: bool (Transform Patterns: pattern fills and strokes transform with the art; default: prefs transformPatternTiles), typeAreas?: bool (area type: the frame is reshaped and the text reflows at its size)}. With anchors selected with Direct Selection (and no copy), only those anchors and their handles transform, about the centre of their own box.",
has_selection,
reflect
),
+37 -11
View File
@@ -1,7 +1,7 @@
use super::align::choice;
use super::{
Affine, Arc, Document, EngineError, LastTransform, Node, NodeId, NodeKind, Point, Result, Scaling, Session, Value, Vec2, bad, bool_or,
check_numbers, check_switches, duplicate_in, effects, f64_or, f64_req, ids_param, json, matrix_param, ok, outermost, point_param,
Affine, Arc, Document, EngineError, LastTransform, Node, NodeId, NodeKind, OrientedBox, Point, Rect, Result, Scaling, Session, Value, Vec2, bad,
bool_or, check_numbers, check_switches, duplicate_in, effects, f64_or, f64_req, ids_param, json, matrix_param, ok, outermost, point_param,
selected_roots_to_transform,
};
@@ -358,26 +358,52 @@ pub(super) fn scale(s: &mut Session, p: &Value) -> Result<Value> {
if sx == 0.0 || sy == 0.0 {
return Err(bad("object.scale", "scale must be non-zero"));
}
apply_transform(s, "Scale", ids, about(o, Affine::scale_non_uniform(sx, sy)), p, true)
let frame = basis_frame(s, p, "object.scale", &ids)?;
apply_transform(s, "Scale", ids, about(o, frame.conjugate(Affine::scale_non_uniform(sx, sy))), p, true)
}
/// The frame that `object.scale` and a named `object.reflect` act in, from the `basis` param:
/// `"box"` (the default) is the bounding box of `ids`, turned with rotated objects until Reset
/// Bounding Box ([`Document::bbox_angle`]); `"page"` is the page's axes. Anchors selected with
/// Direct Selection (with no copy and Transform Objects on) transform along the page's axes, as
/// their own box does. The basis joins the journal entry, so a replay acts in the same frame. A
/// saved step without `basis` ([`Session::replay`]) was recorded before Scale and Reflect followed
/// the box, so it acts along the page's axes, as it did when it was recorded.
fn basis_frame(s: &mut Session, p: &Value, cmd: &str, ids: &[NodeId]) -> Result<OrientedBox> {
let basis = choice(p, cmd, "basis", &["box", "page"])?;
let page = basis == Some("page") || (basis.is_none() && s.replaying());
let st = s.doc()?;
let anchors = !bool_or(p, "copy", false)
&& transforms_objects(p)
&& effects::preview::anchor_bounds_with(&st.selection, &st.doc, s.bounds_measure()).is_some();
let angle = if page || anchors { 0.0 } else { st.doc.bbox_angle(ids) };
s.note_journal("basis", json!(if page { "page" } else { "box" }));
Ok(OrientedBox { angle, rect: Rect::ZERO })
}
pub(super) fn reflect(s: &mut Session, p: &Value) -> Result<Value> {
check_switches(p, &TRANSFORM_SWITCHES, "object.reflect")?;
let ids = selected_roots_to_transform(s)?;
let o = origin_of(s, p, &ids)?;
let m = match p.get("axis") {
Some(Value::String(a)) if a == "horizontal" => Affine::scale_non_uniform(1.0, -1.0),
Some(Value::Number(n)) => {
let t = -n.as_f64().unwrap_or(90.0).to_radians();
Affine::rotate(t) * Affine::scale_non_uniform(1.0, -1.0) * Affine::rotate(-t)
}
None | Some(Value::Null) => Affine::scale_non_uniform(-1.0, 1.0),
Some(Value::String(a)) if a == "vertical" => Affine::scale_non_uniform(-1.0, 1.0),
// A named axis is the bounding box's own (see [`basis_frame`]); an angle is a line on the page.
let named = match p.get("axis") {
Some(Value::String(a)) if a == "horizontal" => Some(Affine::scale_non_uniform(1.0, -1.0)),
Some(Value::Number(_)) => None,
None | Some(Value::Null) => Some(Affine::scale_non_uniform(-1.0, 1.0)),
Some(Value::String(a)) if a == "vertical" => Some(Affine::scale_non_uniform(-1.0, 1.0)),
Some(v) => {
let given = v.as_str().map_or_else(|| v.to_string(), str::to_string);
return Err(bad("object.reflect", format!("axis must be \"vertical\", \"horizontal\" or an angle in degrees, not `{given}`")));
}
};
let m = match named {
Some(m) => basis_frame(s, p, "object.reflect", &ids)?.conjugate(m),
None => {
choice(p, "object.reflect", "basis", &["box", "page"])?;
let t = -p.get("axis").and_then(Value::as_f64).unwrap_or(90.0).to_radians();
Affine::rotate(t) * Affine::scale_non_uniform(1.0, -1.0) * Affine::rotate(-t)
}
};
apply_transform(s, "Reflect", ids, about(o, m), p, true)
}
+21 -4
View File
@@ -382,7 +382,8 @@ pub fn check_effect_params(id: &str, effect: &str, params: &Value) -> Result<()>
return Err(bad(id, format!("`version` must be 0 or {newest}")));
}
check_effect_color(id, effect, params)?;
check_effect_channel(id, effect, params)
check_effect_channel(id, effect, params)?;
check_effect_center(id, effect, params)
}
/// The type of the values in `params` of effect `effect`, as command `id` was given them: a key
@@ -423,9 +424,9 @@ fn check_effect_types(id: &str, effect: &str, params: &Value) -> Result<()> {
/// A value of the type effect `effect` reads for `key`, a parameter its params description names
/// without a dialog default: the earlier 3D Perspective and light (`perspective`, `lightAzimuth`,
/// `lightElevation`) and Scribble `variation` are numbers, an Outline Stroke's `width` is a number
/// and a Gaussian Blur's `linear` is true or false. A Glass or Texturizer `textureImage`, an SVG
/// filter's `name` and `xml`, a Warp's `version` and the `style` of Crop Marks have checks of their
/// own; they aren't listed.
/// and a Gaussian Blur's `linear` is true or false. A Glass, Texturizer or Rough Pastels
/// `textureImage`, an SVG filter's `name` and `xml`, a Warp's `version` and the `style` of Crop
/// Marks have checks of their own; they aren't listed.
pub(crate) fn undefaulted_type(effect: &str, key: &str) -> Option<Value> {
use vectorcraft_render::effects;
let number = || Some(Value::from(0.0));
@@ -500,6 +501,22 @@ pub(crate) fn check_effect_channel(id: &str, effect: &str, params: &Value) -> Re
Err(bad(id, format!("`{key}` must be one of {}", vectorcraft_render::effects::CHANNELS.join(", "))))
}
/// The Blur Center (`centerX`, `centerY`) in `params` of Radial Blur (`effect`), as command `id`
/// was given it: a parameter error unless each is a number from 0 to 1 (a share of the object's
/// bounds). `effect.apply` and `effect.setParams` run this themselves before they edit, as they
/// run [`check_effect_channel`].
pub(crate) fn check_effect_center(id: &str, effect: &str, params: &Value) -> Result<()> {
if effect != "blur.radial" {
return Ok(());
}
for key in ["centerX", "centerY"] {
if params.get(key).is_some_and(|v| !v.as_f64().is_some_and(|x| (0.0..=1.0).contains(&x))) {
return Err(bad(id, format!("`{key}` must be a number from 0 to 1")));
}
}
Ok(())
}
/// Commands whose params aren't checked yet (#1442): they read keys in ways the audit of the
/// descriptions couldn't follow (a list of keys in a loop, a whole object read as settings), so
/// their descriptions aren't proven to name every key they take. Sorted; take a command out once
+24 -5
View File
@@ -77,7 +77,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Reverse Path Direction",
["Object", "Path"],
None,
"{ids?|id?, subpath?: usize (reverse only this subpath of each path, 0 included; default: every subpath), reversed?: bool (true: every subpath runs counter-clockwise on screen, false: clockwise, the Attributes panel's Reverse Path Direction On / Off; omitted: flip each path; with subpath, the direction is not read: that subpath is flipped)} the paths in ids or the selection (groups and compound paths: the paths inside), as one undo step; when every subpath of a path turns alike, its strokes' width profiles (sides swapped) and pen pressure, tilt, bearing and rotation turn with it, so they draw as before → {changed: paths}",
"{ids?|id?, subpath?: usize (reverse only this subpath of each path, 0 included; default: every subpath), reversed?: bool (true: every subpath runs counter-clockwise on screen, false: clockwise, the Attributes panel's Reverse Path Direction On / Off; omitted: flip each path; with subpath, the direction is not read: that subpath is flipped)} the paths in ids or the selection (groups and compound paths: the paths inside), as one undo step; when every subpath of a path or compound path turns alike, its strokes' width profiles (sides swapped) and pen pressure, tilt, bearing and rotation turn with it, so they draw as before → {changed: paths}",
has_selected_path,
reverse
),
@@ -458,14 +458,33 @@ fn reverse(s: &mut Session, p: &Value) -> Result<Value> {
if ids.is_empty() {
return Err(bad(C, "select paths"));
}
let flip_of = |path: &PathData| -> Vec<bool> {
match subpath {
Some(si) => (0..path.subpaths.len()).map(|i| i == si).collect(),
None => path.subpaths.iter().map(|sp| want.is_none_or(|ccw| (sp.signed_area() < 0.0) != ccw)).collect(),
}
};
let changed = super::overprint::edit_counted(s, "Reverse Path Direction", |d| {
// A compound path's own strokes run along its members' subpaths in order, so they turn
// with them, read before any member turns.
let compounds: BTreeSet<NodeId> = ids.iter().map(|id| compound_or_self(d, *id)).filter(|c| ids.binary_search(c).is_err()).collect();
for c in compounds {
let Some(NodeKind::Compound { children, .. }) = d.node(c).map(|n| &n.kind) else { continue };
let flip: Vec<bool> = children
.iter()
.filter_map(|m| m.path_data().map(|pd| if ids.binary_search(&m.id).is_ok() { flip_of(pd) } else { vec![false; pd.subpaths.len()] }))
.flatten()
.collect();
if flip.contains(&true)
&& let Some(n) = d.node_mut(c)
{
vectorcraft_doc::blend::reverse_stroke_records(n, &flip);
}
}
let mut changed = 0;
for id in &ids {
let path = path_mut(d, *id)?;
let flip: Vec<bool> = match subpath {
Some(si) => (0..path.subpaths.len()).map(|i| i == si).collect(),
None => path.subpaths.iter().map(|sp| want.is_none_or(|ccw| (sp.signed_area() < 0.0) != ccw)).collect(),
};
let flip = flip_of(path);
if !flip.contains(&true) {
continue;
}
+34 -15
View File
@@ -75,7 +75,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Place…",
["File"],
Some("Cmd+Shift+P"),
"{path | name | dataBase64 (a file's path, or its name with its bytes), link?: true (a raster image keeps its file's path; a VectorCraft document at path becomes one locked placed document showing artboard `page`, linked to the file and read again when it changes (links.update; saving it in this app updates it at once), drawn as vectors in every output; so does a PDF/.ai page at path, showing its `crop` box, unless password or textAs: \"outlines\" is given; false: an editable copy of its art, as from dataBase64; other files are embedded), text?: {characterSet?: \"unicode\" (UTF-8, or UTF-16 with a byte-order mark, or without one by dataset.import's rule: an even length, at least half of its two-byte units holding a NUL byte, the byte order that reads a line break, valid UTF-16 with no NUL character; other bytes as the platform's 8-bit set) | \"ansi\" (the platform's 8-bit set), platform?: \"windows\" (Windows-1252) | \"mac\" (Mac Roman), removeLineReturns?: false (each block of lines becomes one paragraph; blank lines end paragraphs), removeParagraphReturns?: false (drop blank lines), replaceSpaces?: n (runs of n ≥ 2 spaces become a tab)} (a .txt file, placed as area type filling rect, the replaced object's bounds, or else the artboard less a 36 pt margin), template?: false (onto a new locked template layer below the current layer), replace?: false (swap the one selected object, keeping its stacking place and transform; no at/rect; refused while an object of a symbol instance's art is selected), at?: [x, y] centre (default: the first artboard's centre), rect?: [x, y, width, height] fit inside; aspect kept (wins over at), page?: 1 (PDF/.ai page, or a native document's artboard), crop?: \"crop\" (clipped to that page or artboard, default; an SVG, only when given: framed and clipped by its viewBox, else by its art's bounds) | \"bounding\" (the bounds of the art that shows, with its strokes and effects, as an export measures them: hidden objects and guides left out) | \"art\" | \"trim\" | \"bleed\" | \"media\" (a PDF page's boxes), password? (an encrypted PDF), dxf?: {…the DXF options of document.open} (a .dxf drawing: fit fills the artboard under at, else the first; fitted or uncentred art lands with its drawing's artboard on that artboard, else it is centred on at)} → {ids, name, format, linked, width, height, warnings, image?: the id of the image of a DCS file placed in a clip group, which the Links commands take}. Raster images come in at 100% of their physical size (the file's ppi, else 72); SVG, DXF, HP-GL (.plt, .hpgl, .hgl, .hpg), PDF/.ai, EMF/WMF and PICT (.pct, .pic, .pict; clipped to the picture's frame), EPS (clipped to its bounding box; as document.open reads it), a .ai saved without PDF compatibility (from its editing data, as document.open reads it: the art of the layers that show on artboard `page`, clipped to that artboard unless crop is \"bounding\") and native documents as one group, with the images, symbols, patterns, swatches and brushes they use. A DCS file (an EPS file with one program per printing plate, DCS 1.0 or 2.0) is placed only from its path with link (else an error, as are document.open and links.embed): one linked image of its plates mixed into CMYK, clipped by the clipping path its composite is drawn through, its spot plates added as spot swatches in the process equivalents the file gives (a swatch of the same name is kept, with a warning); print separations and Separations Preview show each plate on its own ink, and plate files of their own are read from its folder. One undo step; selects what it placed (unless on a template layer); never touches the clipboard. A PNG, JPEG, GIF or WebP image whose pixels can't be read (a file cut short) is an error, and nothing is placed",
"{path | name | dataBase64 (a file's path, or its name with its bytes), link?: true (a raster image keeps its file's path; a VectorCraft document at path becomes one locked placed document showing artboard `page`, linked to the file and read again when it changes (links.update; saving it in this app updates it at once), drawn as vectors in every output; so does a PDF/.ai page at path, showing its `crop` box, unless password or textAs: \"outlines\" is given; false: an editable copy of its art, as from dataBase64; other files are embedded), text?: {characterSet?: \"unicode\" (UTF-8, or UTF-16 with a byte-order mark, or without one by dataset.import's rule: an even length, at least half of its two-byte units holding a NUL byte, the byte order that reads a line break, valid UTF-16 with no NUL character; other bytes as the platform's 8-bit set) | \"ansi\" (the platform's 8-bit set), platform?: \"windows\" (Windows-1252) | \"mac\" (Mac Roman), removeLineReturns?: false (each block of lines becomes one paragraph; blank lines end paragraphs), removeParagraphReturns?: false (drop blank lines), replaceSpaces?: n (runs of n ≥ 2 spaces become a tab)} (a .txt file, placed as area type filling rect, the replaced object's bounds, or else the artboard less a 36 pt margin), template?: false (onto a new locked template layer below the current layer), replace?: false (swap the one selected object, keeping its stacking place and transform; no at/rect; refused while an object of a symbol instance's art is selected), at?: [x, y] centre (default: the first artboard's centre), rect?: [x, y, width, height] fit inside; aspect kept (wins over at), page?: 1 (PDF/.ai page, or a native document's artboard), crop?: \"crop\" (clipped to that page or artboard, default; an SVG, only when given: framed and clipped by its viewBox, else by its art's bounds) | \"bounding\" (the bounds of the art that shows, with its strokes and effects, as an export measures them: hidden objects and guides left out) | \"art\" | \"trim\" | \"bleed\" | \"media\" (a PDF page's boxes), password? (an encrypted PDF), dxf?: {…the DXF options of document.open} (a .dxf drawing: fit fills the artboard under at, else the first; fitted or uncentred art lands with its drawing's artboard on that artboard, else it is centred on at)} → {ids, name, format, linked, width, height, warnings, image?: the id of the image of a DCS file or PSD/PSB file placed in a clip group, which the Links commands take}. A PSD or PSB file that names a clipping path places in a clip group of that path (even-odd), as does its merged image in document.open. Raster images come in at 100% of their physical size (the file's ppi, else 72); SVG, DXF, HP-GL (.plt, .hpgl, .hgl, .hpg), PDF/.ai, EMF/WMF and PICT (.pct, .pic, .pict; clipped to the picture's frame), EPS (clipped to its bounding box; as document.open reads it), a .ai saved without PDF compatibility (from its editing data, as document.open reads it: the art of the layers that show on artboard `page`, clipped to that artboard unless crop is \"bounding\") and native documents as one group, with the images, symbols, patterns, swatches and brushes they use. A DCS file (an EPS file with one program per printing plate, DCS 1.0 or 2.0) is placed only from its path with link (else an error, as are document.open and links.embed): one linked image of its plates mixed into CMYK, clipped by the clipping path its composite is drawn through, its spot plates added as spot swatches in the process equivalents the file gives (a swatch of the same name is kept, with a warning); print separations and Separations Preview show each plate on its own ink, and plate files of their own are read from its folder. One undo step; selects what it placed (unless on a template layer); never touches the clipboard. A PNG, JPEG, GIF or WebP image whose pixels can't be read (a file cut short) is an error, and nothing is placed",
has_doc,
place
),
@@ -113,7 +113,9 @@ pub fn specs() -> Vec<CommandSpec> {
/// A file's art at its natural size, before it joins a document.
enum Art {
Image(RasterImage),
/// An image, with the clipping path its file names, in its pixel space (a PSD or PSB file's,
/// [`fileio::psdread::clipping_path`]).
Image(RasterImage, Option<vectorcraft_geom::PathData>),
/// A text file's, an RTF file's or a Word document's text, placed as area type filling the
/// natural box.
Text(text::Story),
@@ -241,7 +243,8 @@ fn load(p: &Value, cmd: &str, board: Option<Rect>, link_pdf: bool) -> Result<Loa
let natural = Rect::new(0.0, 0.0, img.width as f64 * sx, img.height as f64 * sy);
let link = src.path.map(|path| super::links::link_info(path, &src.bytes));
let warnings = fileio::size_note(&img.blob.bytes).into_iter().collect();
return Ok(Loaded { name, format, art: Art::Image(img), natural, warnings, link, board: None });
let clip = fileio::psdread::clipping_path(&src.bytes);
return Ok(Loaded { name, format, art: Art::Image(img, clip), natural, warnings, link, board: None });
}
if pdf {
// Linked: placed like a VectorCraft document, read again with the page's box only. A page
@@ -411,7 +414,7 @@ fn art_of<'a>(nodes: impl Iterator<Item = &'a Arc<Node>>) -> Vec<Node> {
/// The art as one object of `d` (its resources added), at its natural size and position.
fn build(d: &mut Document, l: Loaded, link: Option<LinkInfo>) -> Node {
let mut node = match l.art {
Art::Image(img) => {
Art::Image(img, clip) => {
let (sx, sy) = pt_per_px(img.ppi);
super::links::store_image(d, &img.key, img.blob, link.is_some());
let im = ImageObject {
@@ -423,7 +426,8 @@ fn build(d: &mut Document, l: Loaded, link: Option<LinkInfo>) -> Node {
placement: Default::default(),
pixels: None,
};
Node::new(d.alloc_id(), NodeKind::Image(Box::new(im)))
let image = Node::new(d.alloc_id(), NodeKind::Image(Box::new(im)));
fileio::file_clipped(d, image, clip)
}
Art::Dcs(a) => {
let a = *a;
@@ -485,9 +489,23 @@ fn at_param(p: &Value) -> Result<Option<Point>> {
/// The transform that puts new art with the natural box `natural` where `old` is: an image's scale
/// and rotation relative to its 100% size (its resolution's) and its centre are kept (with
/// `image_xf`); other objects keep their centre.
fn replace_xf(d: &Document, old: &Node, natural: Rect, image_xf: bool) -> Affine {
if image_xf && let NodeKind::Image(im) = &old.kind {
/// `image_xf`), also for an image alone in a clip group when the new art is an image clipped by
/// its file's clipping path (`clipped`); other objects keep their centre.
fn replace_xf(d: &Document, old: &Node, natural: Rect, image_xf: bool, clipped: bool) -> Affine {
// An image alone in a clip group (as a PSD or PSB file's clipping path places it,
// [`fileio::file_clipped`]) is measured as the image when the new art brings its own clip
// group; a DCS file's plates are not.
let image = match &old.kind {
NodeKind::Group { children, clip: true } if clipped => match &children[..] {
[path, image] if matches!(path.kind, NodeKind::Path { clipping: true, .. }) => match &image.kind {
NodeKind::Image(im) if d.images.get(&im.key).is_none_or(|b| b.separated().is_none()) => image,
_ => old,
},
_ => old,
},
_ => old,
};
if image_xf && let NodeKind::Image(im) = &image.kind {
let (sx, sy) = pt_per_px(d.images.get(&im.key).and_then(|b| fileio::ppi::resolution(&b.bytes)));
let full = Affine::scale_non_uniform(sx, sy);
let centre = full * Point::new(im.width as f64 / 2.0, im.height as f64 / 2.0);
@@ -541,7 +559,7 @@ impl PlaceJob {
let mut loaded = load(&self.params, PLACE, self.target, true)?;
let linked = loaded.link.is_some() && bool_or(&self.params, "link", true);
match &mut loaded.art {
Art::Image(img) => {
Art::Image(img, _) => {
let unread = super::links::kept_unread(&img.blob.bytes);
img.blob = super::links::readable_and_kept(img.blob.clone(), unread, linked)?;
}
@@ -657,7 +675,7 @@ fn apply(s: &mut Session, read: PlaceRead) -> Result<Value> {
}
let natural = loaded.natural;
let m = match (old_node, rect) {
(Some(o), _) => replace_xf(&st.doc, o, natural, !is_text),
(Some(o), _) => replace_xf(&st.doc, o, natural, !is_text, matches!(loaded.art, Art::Image(_, Some(_)))),
(None, Some(r)) => fit(natural, r),
// Its artboard's bottom-left corner on the target's.
(None, None) if let (Some(src), Some(to)) = (loaded.board, target) => Affine::translate((to.x0 - src.x0, to.y1 - src.y1)),
@@ -671,7 +689,7 @@ fn apply(s: &mut Session, read: PlaceRead) -> Result<Value> {
let link = loaded.link.take().filter(|_| bool_or(p, "link", true));
let linked = link.is_some();
let (name, format, mut warnings) = (loaded.name.clone(), loaded.format.id, std::mem::take(&mut loaded.warnings));
let dcs_clipped = matches!(&loaded.art, Art::Dcs(a) if a.clip.is_some());
let file_clipped = matches!(&loaded.art, Art::Dcs(a) if a.clip.is_some()) || matches!(&loaded.art, Art::Image(_, Some(_)));
if let Art::Dcs(a) = &loaded.art {
warnings.extend(dcs::swatch_notes(&st.doc, &a.spots));
}
@@ -697,8 +715,9 @@ fn apply(s: &mut Session, read: PlaceRead) -> Result<Value> {
Ok((id, size))
})?;
let mut out = json!({ "ids": [id.0], "name": name, "format": format, "linked": linked, "width": size.width(), "height": size.height(), "warnings": warnings });
// A DCS file clipped by its clipping path: its image, which the Links commands take.
if dcs_clipped {
// A DCS, PSD or PSB file clipped by its clipping path: its image, which the Links commands
// take.
if file_clipped {
let image = s.doc()?.doc.node(id).and_then(|n| match &n.kind {
NodeKind::Group { children, clip: true } => children.get(1).filter(|c| matches!(c.kind, NodeKind::Image(_))).map(|c| c.id),
_ => None,
@@ -810,7 +829,7 @@ fn read_queue(doc: u64, p: Value, queued: Vec<Value>) -> Result<QueueRead> {
let checked = load(&q, QUEUE, None, false).and_then(|mut l| {
let linked = l.link.is_some() && bool_or(&q, "link", true);
match &mut l.art {
Art::Image(img) => {
Art::Image(img, _) => {
let unread = super::links::kept_unread(&img.blob.bytes);
let check = if thumbnail.is_some() { super::links::readable_and_kept } else { super::links::readable };
img.blob = check(img.blob.clone(), unread, linked)?;
@@ -932,7 +951,7 @@ pub fn read_info(p: &Value) -> Result<Value> {
"height": natural.height(),
"warnings": std::mem::take(&mut l.warnings),
});
if let Art::Image(img) = &l.art {
if let Art::Image(img, _) = &l.art {
let (x, y) = img.ppi.unwrap_or((72.0, 72.0));
out["pixelWidth"] = json!(img.width);
out["pixelHeight"] = json!(img.height);
+2 -2
View File
@@ -538,8 +538,8 @@ pub(crate) fn run_command(s: &mut Session, id: &str, p: &Value) -> Result<Value>
/// live-effect plug-in) with parameters it takes, filled in to their defaults. A record the object
/// already had stays as it was. An object takes one 3D effect (its fills' and strokes' own
/// counted), which must fit it, and the `textureImage` of an effect with Load Texture (Glass,
/// Texturizer) comes as the effect stores it, never as a file to read: a plug-in can't have the
/// host read one.
/// Texturizer, Rough Pastels) comes as the effect stores it, never as a file to read: a plug-in
/// can't have the host read one.
fn admit_effects(fx: &[Effect], n: &Node) -> std::result::Result<Vec<Effect>, String> {
admit_effects_for("plugin.run", fx, n)
}
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -140,7 +140,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Character",
[],
None,
"{ids?|id?, font?, style? (font alone: the style is kept when the new family has it, else its closest), size?: pt 0.1..1296 (outside it: an error), leading?: pt|\"auto\", tracking?: 1/1000 em, justify?: \"auto\" (the start of each paragraph's direction)|\"left\"|\"center\"|\"right\"|\"justifyAll\", fill?: colour|\"none\", stroke?: colour|\"none\" (characters without a stroke weight get 1 pt; #rrggbbaa and #rgba are refused in both), keepModel?: bool (fill and stroke, as paint.setFill), strokeWidth?: pt (the character stroke's weight, in document points as stroke.set), features?: [\"dlig\", \"-liga\", \"salt=2\", …] OpenType (swsh, ss01–ss20, salt, titl, pnum, lnum, sups, subs, numr, dnom and aalt take the font's alternate number as `tag=N`, N 0–65535: \"salt=2\" draws the second alternate of each glyph that has one, \"salt\" is \"salt=1\", \"-salt\" and \"salt=0\" are off), featureChanges?: [\"tnum\", \"-onum\", \"salt=2\", …] (OpenType features turned on, or with - off, on top of each character's own, a value replacing the feature's last one; its other features are kept), start?: byte, end?: byte} (size/leading are document points after object scaling; with a range: the character attributes style that range and justify the paragraphs it touches; without: all the text; no undo step when no character, paragraph or graph label style changes) → {ids, overflow?: [id…] (area type and type on a path whose text no longer fits; left out when all fits), warning?: text (the font or style set isn't available: its type is drawn in the fallback font or the family's closest style)}",
"{ids?|id?, font?, style? (font alone: the style is kept when the new family has it, else its closest), size?: pt 0.1..1296 (outside it: an error), leading?: pt|\"auto\", tracking?: 1/1000 em, justify?: \"auto\" (the start of each paragraph's direction)|\"left\"|\"center\"|\"right\"|\"justifyAll\", fill?: colour|\"none\", stroke?: colour|\"none\" (characters without a stroke weight get 1 pt; #rrggbbaa and #rgba are refused in both), keepModel?: bool (fill and stroke, as paint.setFill), strokeWidth?: pt (the character stroke's weight, in document points as stroke.set), features?: [\"dlig\", \"-liga\", \"salt=2\", …] OpenType (swsh, ss01–ss20, salt, titl, pnum, lnum, sups, subs, numr, dnom and aalt take the font's alternate number as `tag=N`, N 0–65535: \"salt=2\" draws the second alternate of each glyph that has one, \"salt\" is \"salt=1\", \"-salt\" and \"salt=0\" are off; \"hkna\" is H or V Style, kana in the font's forms for the writing direction, shaped as `vkna` in vertical type, and \"ital\" is Roman Italics, half-width alphanumerics in the font's italic forms, both on or off only), featureChanges?: [\"tnum\", \"-onum\", \"salt=2\", …] (OpenType features turned on, or with - off, on top of each character's own, a value replacing the feature's last one; its other features are kept), start?: byte, end?: byte} (size/leading are document points after object scaling; with a range: the character attributes style that range and justify the paragraphs it touches; without: all the text; no undo step when no character, paragraph or graph label style changes) → {ids, overflow?: [id…] (area type and type on a path whose text no longer fits; left out when all fits), warning?: text (the font or style set isn't available: its type is drawn in the fallback font or the family's closest style)}",
has_doc,
set_style
),
@@ -1589,6 +1589,40 @@ fn proportional_metrics_is_a_character_attribute_saved_only_when_on() {
assert!(!serde_json::from_value::<vectorcraft_doc::CharStyle>(old).unwrap().proportional_metrics);
}
/// H or V Style (`hkna`) and Roman Italics (`ital`, OpenType panel menu, East Asian options) are
/// feature tags of the characters: set on a range and turned off again, kept by a character style
/// and in a saved document, on or off only (`hkna=2` is refused and changes nothing).
#[test]
fn kana_style_and_roman_italics_are_character_features() {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 400, "height": 400})).unwrap();
let id = s.execute("text.create", &json!({"x": 10, "y": 50, "text": "かなAB"})).unwrap()["id"].as_u64().unwrap();
let runs = |s: &Session| match &s.doc().unwrap().doc.node(NodeId(id)).unwrap().kind {
NodeKind::Text(t) => t.runs.iter().map(|r| (r.text.clone(), r.style.features.clone())).collect::<Vec<_>>(),
_ => panic!("text"),
};
// か and な are 3 bytes each.
s.execute("text.setRangeStyle", &json!({"id": id, "start": 0, "end": 6, "features": ["hkna"]})).unwrap();
s.execute("text.setRangeStyle", &json!({"id": id, "start": 6, "end": 8, "featureChanges": ["ital"]})).unwrap();
assert_eq!(runs(&s), [("かな".to_string(), vec!["hkna".to_string()]), ("AB".to_string(), vec!["ital".to_string()])]);
let saved = vectorcraft_format::load(&vectorcraft_format::save(&s.doc().unwrap().doc, false)).unwrap();
let NodeKind::Text(t) = &saved.node(NodeId(id)).unwrap().kind else { panic!("text") };
assert_eq!(t.runs.iter().map(|r| r.style.features.clone()).collect::<Vec<_>>(), [vec!["hkna".to_string()], vec!["ital".to_string()]]);
let before = runs(&s);
for bad in [json!({"id": id, "features": ["hkna=2"]}), json!({"id": id, "featureChanges": ["ital=1"]})] {
let e = s.execute("text.setRangeStyle", &bad).unwrap_err().to_string();
assert!(e.contains("unknown OpenType feature"), "{e}");
}
assert_eq!(runs(&s), before);
s.execute("text.setRangeStyle", &json!({"id": id, "featureChanges": ["-hkna", "-ital"]})).unwrap();
assert!(runs(&s).iter().all(|(_, f)| f.is_empty()), "{:?}", runs(&s));
s.execute("charStyle.new", &json!({"name": "Kana", "attrs": {"features": ["hkna", "ital"]}})).unwrap();
s.execute("charStyle.apply", &json!({"name": "Kana", "id": id})).unwrap();
assert!(runs(&s).iter().all(|(_, f)| *f == ["hkna", "ital"]), "{:?}", runs(&s));
let e = s.execute("charStyle.new", &json!({"name": "Bad", "attrs": {"features": ["ital=2"]}})).unwrap_err().to_string();
assert!(e.contains("unknown OpenType feature `ital=2`"), "{e}");
}
/// Tate-chu-yoko (Character panel menu, East Asian options): a character attribute, saved only
/// when on. Documents written before it read as off.
#[test]
+4 -4
View File
@@ -9,8 +9,8 @@
//! before an image variable); import replaces the datasets, names the rows Data Set 1, 2…,
//! also reads tab-separated files, and reads header cells that define new variables (`#` for
//! visibility, `@` for image, no prefix for text). `variable.loadLibrary` replaces the variables and data sets with the
//! text variables and data sets of a variable library, the XML file of the reference app's Save
//! Variable Library, and `variable.saveLibrary` writes the text variables and data sets as one.
//! variables and data sets of a variable library, the XML file of the reference app's Save
//! Variable Library, and `variable.saveLibrary` writes the variables and data sets as one.
//! Agents reach every command through `run_command`, like all engine commands.
use std::collections::{BTreeMap, BTreeSet};
@@ -886,7 +886,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Load Variable Library…",
["Window", "Variables"],
None,
"{path? | xml? | dataBase64?} replace the document's variables and data sets with a variable library's (XML: `variableSets` › `variableSet` › `variables` of `variable` elements with `varName` and `trait`, and `sampleDataSets` of `sampleDataSet` elements with `dataSetName`) in one undo step (none when the document already holds what the library gives). Every data set is deleted, and every variable of the document is deleted with its bindings and values except a text variable the library also declares, which keeps its bindings; then the library's other variables whose `trait` is `textcontent` are defined as text variables, unbound, and each data set takes a value for a variable from the `p` elements of the element named after it, one paragraph each. Variables of other kinds are left out and named in `skipped` and `warning`. Refused while the variables are locked when it would delete or define a variable → {variables, deleted, deletedDataSets, names, skipped, warning?}",
"{path? | xml? | dataBase64?} replace the document's variables and data sets with a variable library's (XML: `variableSets` › `variableSet` › `variables` of `variable` elements with `varName` and `trait`, and `sampleDataSets` of `sampleDataSet` elements with `dataSetName`) in one undo step (none when the document already holds what the library gives). Every data set is deleted, and every variable of the document is deleted with its bindings and values except a variable the library also declares with the same kind, which keeps its bindings; then the library's other variables are defined, unbound, with the kind of their `trait`: `textcontent` text, `visibility` visibility, `fileref` image, `graphdata` graph, and any other or none unknown (no values). Each data set takes a variable's value from the element named after it: a text value from its `p` elements, one paragraph each; a visibility value from `true` or `false`; an image value from a file's absolute path or a `file:` URL (the file isn't read); a graph value from a `data` element (`propertyRow` series names, `values` › `row` with a first `value` key=\"name\" category), read as the CSV graph.setData takes. A value that doesn't fit its kind is refused. Refused while the variables are locked when it would delete or define a variable → {variables, deleted, deletedDataSets, names}",
has_doc,
load_library
),
@@ -895,7 +895,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Save Variable Library…",
["Window", "Variables"],
None,
"{path?} write the document's text variables and every data set as a variable library, the XML that variable.loadLibrary reads: a `variable` element with `varName` and `trait=\"textcontent\"` per text variable, and a `sampleDataSet` element with `dataSetName` per data set, holding an element named after each text variable it has a value for, with one `p` element per line of the value. Variables of other kinds are left out with their values and named in `skipped` and `warning`. Refused without a text variable, for a text variable whose name isn't an XML name (letters, digits, `-`, `_` and `.`, starting with a letter or `_`), for a data set name or value that holds a control character, for a data set name with white space at either end, for a name longer than 255 characters or used twice, and past variable.loadLibrary's caps (256 variables, 1,000 data sets, 8 MiB). Without path → {xml, variables, datasets, skipped, warning?}; with it → {path, variables, datasets, skipped, warning?}",
"{path?} write the document's variables and every data set as a variable library, the XML that variable.loadLibrary reads: a `variable` element with `varName` per variable, with the `trait` of its kind (`textcontent`, `visibility`, `fileref` for image, `graphdata` for graph; none for an unknown kind), and a `sampleDataSet` element with `dataSetName` per data set, holding an element named after each variable it has a value for: one `p` element per line of a text value, `true` or `false`, an image's path (a `file:///` URL for a path from a Unix root), or graph data as a `data` element. Refused without a variable, for a variable whose name isn't an XML name (letters, digits, `-`, `_` and `.`, starting with a letter or `_`; not asked of an unknown kind), for a name or value that holds a control character, for a name with white space at either end, for a name longer than 255 characters or used twice, for an image value that isn't a file's absolute path, and past variable.loadLibrary's caps (256 variables, 1,000 data sets, 8 MiB). Without path → {xml, variables, datasets}; with it → {path, variables, datasets}",
has_doc,
save_library
),
+437 -116
View File
@@ -1,18 +1,29 @@
use std::collections::HashMap;
use std::fmt::Write as _;
use vectorcraft_doc::{GraphSpec, MAX_GRAPH_CATEGORIES, MAX_GRAPH_SERIES};
use super::{
BTreeMap, BTreeSet, DataSet, DataValue, Document, EngineError, MAX_NAME, NodeId, NodeKind, Result, Session, Value, Variable, VariableKind,
Variables, absolute_path, bad, json, named, read_file_head, str_param, variables_unlocked, write_file,
BTreeMap, BTreeSet, DataSet, DataValue, Document, EngineError, MAX_GRAPH_CSV, MAX_NAME, NodeId, NodeKind, Result, Session, Value, Variable,
VariableKind, Variables, absolute_path, bad, json, named, read_file_head, str_param, variables_unlocked, write_file,
};
/// The namespace of a variable library's elements, the default namespace of its data sets' values,
/// and the `category` of its text variables.
/// and the `category` of its visibility and image variables.
const NS_VARIABLES: &str = "http://ns.adobe.com/Variables/1.0/"; // brand-ok: the namespace variable libraries use
const NS_CUSTOM: &str = "http://ns.adobe.com/GenericCustomNamespace/1.0/"; // brand-ok: the namespace variable libraries use
/// The `category` of a library's text variables.
const NS_FLOWS: &str = "http://ns.adobe.com/Flows/1.0/"; // brand-ok: the namespace variable libraries use
/// The `category` of a library's graph variables.
const NS_GRAPHS: &str = "http://ns.adobe.com/Graphs/1.0/"; // brand-ok: the namespace variable libraries use
/// The white space XML puts round a value: a value's text is read without it at either end.
const XML_SPACE: [char; 4] = [' ', '\t', '\n', '\r'];
/// Caps on a variable library (paths and MCP payloads are untrusted): its size, its XML nodes, how
/// deep its elements nest, and the entities, variables and data sets it declares.
const MAX_LIBRARY_BYTES: usize = 8 << 20;
@@ -170,16 +181,47 @@ fn without_doctype(xml: &str, cmd: &str) -> Result<String> {
Ok(out)
}
/// A variable library as Load Variable Library reads it: the names of its text variables in the
/// order it declares them, the name and `trait` of each variable of another kind, its data sets
/// with their text values, and the element id each text variable's `docRef` names.
/// One variable a library declares: its name, its kind, and its `trait` as the library spells it
/// (`None` when it has none).
struct LibraryVariable {
name: String,
kind: VariableKind,
trait_name: Option<String>,
}
/// A variable library as Load Variable Library reads it: its variables in the order it declares
/// them, its data sets with their values, and the element id each text variable's `docRef` names.
pub(crate) struct Library {
text: Vec<String>,
other: Vec<(String, String)>,
variables: Vec<LibraryVariable>,
datasets: Vec<DataSet>,
refs: Vec<(String, String)>,
}
/// The kind of a library variable whose `trait` is `t`: `textcontent` is text, `visibility` is
/// visibility, `fileref` (a linked file) is image and `graphdata` is graph. A variable without a
/// `trait`, or with one VectorCraft doesn't know, is of unknown kind.
fn trait_kind(t: Option<&str>) -> VariableKind {
match t {
Some("textcontent") => VariableKind::Text,
Some("visibility") => VariableKind::Visibility,
Some("fileref") => VariableKind::Image,
Some("graphdata") => VariableKind::Graph,
_ => VariableKind::Unknown,
}
}
/// The `trait` and the `category` reference a library declares a variable of `kind` with, or `None`
/// for a variable of unknown kind, which is declared with neither.
fn kind_trait(kind: VariableKind) -> Option<(&'static str, &'static str)> {
match kind {
VariableKind::Text => Some(("textcontent", "&ns_flows;")),
VariableKind::Visibility => Some(("visibility", "&ns_vars;")),
VariableKind::Image => Some(("fileref", "&ns_vars;")),
VariableKind::Graph => Some(("graphdata", "&ns_graphs;")),
VariableKind::Unknown => None,
}
}
impl Library {
/// The element ids the text variables' `docRef`s name.
pub(crate) fn elements(&self) -> std::collections::HashSet<String> {
@@ -190,13 +232,13 @@ impl Library {
/// Read a variable library: XML whose `variableSets` element holds `variableSet` elements, each
/// with a `variables` element of `variable` elements (`varName`, `trait`) and a `sampleDataSets`
/// element of `sampleDataSet` elements (`dataSetName`). Elements are matched by their local names.
/// A variable whose `trait` is `textcontent` is a text variable. In a data set, an element named
/// after a text variable gives its value: the text of its `p` elements, one paragraph each, and
/// none when it has no `p` element. Values for variables of other kinds are left out. A variable
/// or data set declared twice, a value for a variable the library doesn't declare, and a library
/// past the caps are refused. Entities that its document type declaration defines are read as
/// [`without_doctype`] says.
fn parse_library(xml: &str, cmd: &str) -> Result<Library> {
/// A variable's kind comes from its `trait` ([`trait_kind`]). In a data set, an element named after
/// a variable gives its value, as [`library_value`] reads it. A variable or data set declared
/// twice, a value for a variable the library doesn't declare, a value that doesn't fit its
/// variable's kind, and a library past the caps are refused. With `text_only`, only text values
/// are read, and the values of the other kinds are passed over unread. Entities that its document
/// type declaration defines are read as [`without_doctype`] says.
fn parse_library(xml: &str, cmd: &str, text_only: bool) -> Result<Library> {
let xml = without_doctype(xml, cmd)?;
// roxmltree parses nested elements recursively.
if crate::cmd::place::docx::nesting(&xml) > MAX_LIBRARY_NESTING {
@@ -210,32 +252,29 @@ fn parse_library(xml: &str, cmd: &str) -> Result<Library> {
return Err(bad(cmd, "the file holds no `variableSets` element"));
};
let sets: Vec<roxmltree::Node> = root.children().filter(|n| is(n, "variableSet")).collect();
let (mut text, mut other, mut declared, mut refs) = (Vec::new(), Vec::new(), BTreeSet::new(), Vec::new());
let (mut variables, mut kinds, mut refs) = (Vec::new(), BTreeMap::new(), Vec::new());
for var in sets.iter().flat_map(|s| s.children()).filter(|n| is(n, "variables")).flat_map(|v| v.children()).filter(|n| is(n, "variable")) {
let name = named(var.attribute("varName"), "varName", cmd)?;
if !declared.insert(name.clone()) {
let trait_name = var.attribute("trait").map(|t| t.chars().take(MAX_NAME).collect::<String>());
let kind = trait_kind(trait_name.as_deref());
if kinds.insert(name.clone(), kind).is_some() {
return Err(bad(cmd, format!("variable `{name}` is declared twice")));
}
if declared.len() > MAX_LIBRARY_VARIABLES {
if kinds.len() > MAX_LIBRARY_VARIABLES {
return Err(bad(cmd, format!("the variable library declares more than {MAX_LIBRARY_VARIABLES} variables")));
}
match var.attribute("trait") {
Some("textcontent") => {
// `docRef="id('…')"` names the element of the variable's bound object.
let element = var.attribute("docRef").and_then(|r| r.trim().strip_prefix("id('")?.strip_suffix("')")).filter(|e| !e.is_empty());
if let Some(element) = element {
refs.push((name.clone(), element.to_string()));
}
text.push(name);
if kind == VariableKind::Text {
// `docRef="id('…')"` names the element of the variable's bound object.
let element = var.attribute("docRef").and_then(|r| r.trim().strip_prefix("id('")?.strip_suffix("')")).filter(|e| !e.is_empty());
if let Some(element) = element {
refs.push((name.clone(), element.to_string()));
}
Some(t) => other.push((name, t.chars().take(MAX_NAME).collect())),
None => return Err(bad(cmd, format!("variable `{name}` has no `trait`"))),
}
variables.push(LibraryVariable { name, kind, trait_name });
}
if declared.is_empty() {
if variables.is_empty() {
return Err(bad(cmd, "the variable library declares no variables"));
}
let text_names: BTreeSet<&str> = text.iter().map(String::as_str).collect();
let (mut datasets, mut seen) = (Vec::new(), BTreeSet::new());
for row in
sets.iter().flat_map(|s| s.children()).filter(|n| is(n, "sampleDataSets")).flat_map(|d| d.children()).filter(|n| is(n, "sampleDataSet"))
@@ -250,27 +289,197 @@ fn parse_library(xml: &str, cmd: &str) -> Result<Library> {
let (mut values, mut held) = (BTreeMap::new(), BTreeSet::new());
for el in row.children().filter(roxmltree::Node::is_element) {
let var = el.tag_name().name();
if !declared.contains(var) {
let Some(kind) = kinds.get(var) else {
return Err(bad(cmd, format!("data set `{name}` holds a value for `{var}`, which the library doesn't declare")));
}
};
if !held.insert(var) {
return Err(bad(cmd, format!("data set `{name}` holds two values for `{var}`")));
}
if !text_names.contains(var) {
if text_only && *kind != VariableKind::Text {
continue;
}
let paras: Vec<String> = el
.children()
.filter(|n| is(n, "p"))
.map(|p| p.descendants().filter(roxmltree::Node::is_text).filter_map(|t| t.text()).collect())
.collect();
if !paras.is_empty() {
values.insert(var.to_string(), DataValue::Text(paras.join("\n")));
if let Some(value) = library_value(el, *kind, &name, cmd)? {
values.insert(var.to_string(), value);
}
}
datasets.push(DataSet { name, values });
}
Ok(Library { text, other, datasets, refs })
Ok(Library { variables, datasets, refs })
}
/// The value a data set's element `el` gives a variable of `kind`, or `None` when it gives none.
/// A text value is the text of its `p` elements, one paragraph each, and none without a `p`
/// element. A visibility value is `true` or `false`, in any case. An image value is the absolute
/// path of a file, or a `file:` URL of one ([`library_path`]); the file isn't read. A graph value is
/// a `data` element ([`graph_value`]). Visibility, image and graph values are read without the
/// white space round them, and an element holding only white space gives none. A variable of
/// unknown kind takes no value, so what its element holds is passed over. `set` names the data set
/// in the errors.
fn library_value(el: roxmltree::Node, kind: VariableKind, set: &str, cmd: &str) -> Result<Option<DataValue>> {
let refused = |what: &str| bad(cmd, format!("data set `{set}` holds a value for `{}` that isn't {what}", el.tag_name().name()));
let text = || if elements(el).next().is_some() { None } else { Some(deep_text(el)) };
match kind {
VariableKind::Text => {
let paras: Vec<String> = elements(el).filter(|n| n.tag_name().name() == "p").map(deep_text).collect();
Ok((!paras.is_empty()).then(|| DataValue::Text(paras.join("\n"))))
}
VariableKind::Visibility => {
let what = "`true` or `false`";
let text = text().ok_or_else(|| refused(what))?;
match text.trim_matches(XML_SPACE) {
"" => Ok(None),
t if t.eq_ignore_ascii_case("true") => Ok(Some(DataValue::Visible(true))),
t if t.eq_ignore_ascii_case("false") => Ok(Some(DataValue::Visible(false))),
_ => Err(refused(what)),
}
}
VariableKind::Image => {
let what = "a file's absolute path or `file:` URL";
let text = text().ok_or_else(|| refused(what))?;
match text.trim_matches(XML_SPACE) {
"" => Ok(None),
t => library_path(t).map(|p| Some(DataValue::Image(p))).ok_or_else(|| refused(what)),
}
}
VariableKind::Graph => graph_value(el, set, cmd),
VariableKind::Unknown => Ok(None),
}
}
/// The elements among `n`'s children.
fn elements<'a, 'i>(n: roxmltree::Node<'a, 'i>) -> impl Iterator<Item = roxmltree::Node<'a, 'i>> {
n.children().filter(roxmltree::Node::is_element)
}
/// The text of every text node inside `n`, in order.
fn deep_text(n: roxmltree::Node) -> String {
n.descendants().filter(roxmltree::Node::is_text).filter_map(|t| t.text()).collect()
}
/// The absolute path a library's image value `text` names: a `file:` URL's path (`file:///…`,
/// `file://localhost/…` or `file:/…`), its `%XX` escapes decoded (a URL with a host names a share,
/// `//host/…`), or `text` itself. `None` unless that is an absolute path: one starting with `/` or
/// `\\`, or a drive's path from its root (`C:\…`, `C:/…`).
fn library_path(text: &str) -> Option<String> {
let drive = |p: &str| matches!(p.as_bytes(), [l, b':', b'\\' | b'/', ..] if l.is_ascii_alphabetic());
let url = match (text.strip_prefix("file://"), text.strip_prefix("file:")) {
(Some(rest), _) => Some(rest.strip_prefix("localhost").filter(|r| r.starts_with('/')).unwrap_or(rest)),
// `file:/…` names a path without a host.
(None, Some(rest)) if rest.starts_with('/') => Some(rest),
_ => None,
};
let path = match url {
Some(rest) => {
if rest.starts_with('/') {
let p = percent_decoded(rest.trim_start_matches('/'));
if drive(&p) { p } else { format!("/{p}") }
} else {
format!("//{}", percent_decoded(rest))
}
}
None => text.to_string(),
};
(path.len() > 1 && (path.starts_with('/') || path.starts_with("\\\\") || drive(&path))).then_some(path)
}
/// `s` with its `%XX` escapes decoded, or as it is when the decoded bytes aren't UTF-8.
fn percent_decoded(s: &str) -> String {
let hex = |b: u8| char::from(b).to_digit(16);
let (mut out, mut rest) = (Vec::with_capacity(s.len()), s.as_bytes());
while let Some((&b, tail)) = rest.split_first() {
match tail {
[h, l, more @ ..] if b == b'%' && hex(*h).is_some() && hex(*l).is_some() => {
out.push(((hex(*h).unwrap_or(0) << 4) | hex(*l).unwrap_or(0)) as u8);
rest = more;
}
_ => {
out.push(b);
rest = tail;
}
}
}
String::from_utf8(out).unwrap_or_else(|_| s.to_string())
}
/// How a library writes the image value `path`: an absolute path from the root of a Unix file
/// system as a `file:` URL (`file:///` and the path, with `%`, `#`, `?`, spaces, controls and
/// bytes past ASCII escaped), any other path as it is. [`library_path`] reads it back.
fn library_file(path: &str) -> String {
if !path.starts_with('/') || path.starts_with("//") {
return path.to_string();
}
let mut url = String::from("file:///");
for &b in path.as_bytes() {
if matches!(b, b'%' | b'#' | b'?') || !(0x21..=0x7e).contains(&b) {
let _ = write!(url, "%{b:02X}");
} else {
url.push(char::from(b));
}
}
url
}
/// A library's graph value: the `data` element that `el` holds, read as CSV of the kind Graph
/// Data takes. Its `propertyRow` holds a corner cell and then the names of the series, and each
/// `row` of its `values` holds the row's category in a first `value` whose `key` is `name`, then
/// the row's values. The graph has categories when a row's name isn't blank or is marked
/// `type="string"`. Labels are read as they are; a value is read without the white space round it,
/// and one that is empty, marked `type="string"` or not a finite number is a blank. Without rows or
/// series, or when `el` holds only white space, there is no value. Anything else in `el`, more than
/// [`MAX_GRAPH_CATEGORIES`] rows or [`MAX_GRAPH_SERIES`] series (what a graph holds), and CSV longer
/// than graph values hold, are refused.
fn graph_value(el: roxmltree::Node, set: &str, cmd: &str) -> Result<Option<DataValue>> {
let var = el.tag_name().name();
let refused = || bad(cmd, format!("data set `{set}` holds a value for `{var}` that isn't a graph's `data` element"));
let named = |name: &'static str| move |n: &roxmltree::Node| n.tag_name().name() == name;
let mut children = elements(el);
let data = match (children.next(), children.next()) {
(None, _) if deep_text(el).trim_matches(XML_SPACE).is_empty() => return Ok(None),
(Some(data), None) if data.tag_name().name() == "data" => data,
_ => return Err(refused()),
};
// Labels keep their white space; numbers are read without it.
let series: Vec<String> =
elements(data).find(named("propertyRow")).map(|r| elements(r).filter(named("value")).skip(1).map(deep_text).collect()).unwrap_or_default();
let rows: Vec<roxmltree::Node> =
elements(data).filter(named("values")).flat_map(elements).filter(named("row")).take(MAX_GRAPH_CATEGORIES + 1).collect();
if rows.is_empty() && series.is_empty() {
return Ok(None);
}
let too_many = || bad(cmd, format!("data set `{set}` holds a graph value for `{var}` with {}", graph_limits()));
// A row's values after its name.
let wide = |row: &roxmltree::Node| {
let mut values = elements(*row).filter(named("value")).peekable();
let _name = values.next_if(|v| v.attribute("key") == Some("name"));
values.count() > MAX_GRAPH_SERIES
};
if rows.len() > MAX_GRAPH_CATEGORIES || series.len() > MAX_GRAPH_SERIES || rows.iter().any(wide) {
return Err(too_many());
}
// Each row's name and the values after it. A blank name marked `type="string"` is a blank
// category, so a graph whose categories are all blank keeps them.
let mut labelled = false;
let read: Vec<(Option<String>, Vec<Option<f64>>)> = rows
.iter()
.map(|row| {
let mut values = elements(*row).filter(named("value")).peekable();
let name = values.next_if(|v| v.attribute("key") == Some("name"));
labelled |= name.is_some_and(|v| v.attribute("type") == Some("string") || !deep_text(v).is_empty());
let name = name.map(deep_text);
let number = |v: roxmltree::Node| deep_text(v).trim_matches(XML_SPACE).parse::<f64>().ok().filter(|n| n.is_finite());
let numbers = values.map(|v| if v.attribute("type") == Some("string") { None } else { number(v) });
(name, numbers.collect())
})
.collect();
let categories = if labelled { read.iter().map(|(name, _)| name.clone().unwrap_or_default()).collect() } else { vec![] };
let mut spec = GraphSpec { series, categories, ..GraphSpec::default() };
spec.set_cells(read.into_iter().map(|(_, numbers)| numbers).collect());
// Data set values hold graph data without the line break at its end.
let csv = spec.to_csv().trim_end().to_string();
if csv.len() > MAX_GRAPH_CSV {
return Err(bad(cmd, format!("data set `{set}` holds a graph value for `{var}` longer than {MAX_GRAPH_CSV} bytes")));
}
Ok(Some(DataValue::Graph(csv)))
}
/// The variable library an SVG carries (SVG Options › Include Variable Data), read as
@@ -317,7 +526,8 @@ pub(crate) fn svg_library(svg: &str) -> Option<Result<Library>> {
for (name, value) in &entities {
element = element.replace(name.as_str(), value);
}
parse_library(&format!("<svg>{element}</svg>"), C)
// The SVG keeps only the text variables, so the values of the other kinds aren't read.
parse_library(&format!("<svg>{element}</svg>"), C, true)
};
Some(read())
}
@@ -389,12 +599,16 @@ fn variable_sets_range(svg: &str) -> Option<(usize, Option<usize>)> {
/// the type object made of the element its `docRef` names, or the one type object among the
/// objects a group made of it holds (`found`: the object made of each element, by id). A `docRef`
/// that names no type object, or one another variable is bound to already, binds nothing. The art
/// stays as the file draws it. The warning about the variables of other kinds that were left out,
/// if any.
/// stays as the file draws it. Variables of other kinds are left out with their values. The
/// warning about those variables, if any.
pub(crate) fn give_svg_library(doc: &mut Document, lib: Library, found: &HashMap<String, NodeId>) -> Option<String> {
let (text, other): (Vec<LibraryVariable>, Vec<LibraryVariable>) = lib.variables.into_iter().partition(|v| v.kind == VariableKind::Text);
let mut vars =
Variables { variables: lib.text.iter().map(|n| Variable { name: n.clone(), kind: VariableKind::Text }).collect(), ..Variables::default() };
Variables { variables: text.iter().map(|v| Variable { name: v.name.clone(), kind: VariableKind::Text }).collect(), ..Variables::default() };
vars.datasets = lib.datasets;
for ds in &mut vars.datasets {
ds.values.retain(|_, v| matches!(v, DataValue::Text(_)));
}
// A type object written with a paint of its own, or with fills and strokes of its appearance,
// is a group around its text (and the appearance's paths).
let text_of = |id: NodeId| match doc.node(id).map(|n| &n.kind) {
@@ -415,32 +629,32 @@ pub(crate) fn give_svg_library(doc: &mut Document, lib: Library, found: &HashMap
}
}
doc.variables = vars.into();
left_out_warning(lib.other.iter().map(|(_, t)| t.as_str()))
left_out_warning(other.iter().map(|v| v.trait_name.as_deref().unwrap_or_else(|| v.kind.label())))
}
/// Load Variable Library: replace the document's variables and data sets with a variable library's
/// ([`parse_library`]) in one undo step, or none when the document already holds what the library
/// gives. Every data set is deleted, and every variable of the document is deleted with its
/// bindings and values, except a text variable the library also declares: it stays bound to its
/// objects, so the library's data sets change them (#4136; a template's bound variables take a
/// library of the same names:
/// bindings and values, except a variable the library also declares with the same kind: it stays
/// bound to its objects, so the library's data sets change them (#4136; a template's bound
/// variables take a library of the same names:
/// <https://community.adobe.com/questions-652/illustrator-error-with-csv-files-812184>). The
/// library's other text variables are then defined, unbound, and its data sets are added. The
/// library's variables of other kinds are left out, named in `skipped` and in a warning.
/// library's other variables are then defined with their kinds, unbound, and its data sets are
/// added.
pub(super) fn load_library(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "variable.loadLibrary";
let bytes = library_bytes(p, C)?;
let xml = std::str::from_utf8(bytes.strip_prefix(b"\xEF\xBB\xBF").unwrap_or(&bytes)).map_err(|_| bad(C, "the variable library is not UTF-8"))?;
let lib = parse_library(xml, C)?;
let lib = parse_library(xml, C, false)?;
let vars = &s.doc()?.doc.variables;
let kept = |v: &Variable| v.kind == VariableKind::Text && lib.text.contains(&v.name);
let kept = |v: &Variable| lib.variables.iter().any(|l| l.name == v.name && l.kind == v.kind);
let deleted: Vec<String> = vars.variables.iter().filter(|v| !kept(v)).map(|v| v.name.clone()).collect();
let deleted_sets: Vec<String> = vars.datasets.iter().map(|d| d.name.clone()).collect();
let added: Vec<Variable> = lib
.text
.variables
.iter()
.filter(|n| !vars.variables.iter().any(|v| kept(v) && &v.name == *n))
.map(|n| Variable { name: n.clone(), kind: VariableKind::Text })
.filter(|l| !vars.variables.iter().any(|v| kept(v) && v.name == l.name))
.map(|l| Variable { name: l.name.clone(), kind: l.kind })
.collect();
// Lock Variables refuses New Variable and Delete Variable, so the load is refused when it would
// delete or define a variable.
@@ -460,14 +674,8 @@ pub(super) fn load_library(s: &mut Session, p: &Value) -> Result<Value> {
let st = s.doc_mut()?;
st.drop_stale_variables_highlight();
st.revision += 1;
let skipped: Vec<Value> = lib.other.iter().map(|(name, t)| json!({"name": name, "trait": t})).collect();
let mut out = json!({
"variables": lib.text, "deleted": deleted, "deletedDataSets": deleted_sets, "names": names, "skipped": skipped,
});
if let Some(warning) = left_out_warning(lib.other.iter().map(|(_, t)| t.as_str())) {
out["warning"] = json!(warning);
}
Ok(out)
let declared: Vec<&str> = lib.variables.iter().map(|l| l.name.as_str()).collect();
Ok(json!({"variables": declared, "deleted": deleted, "deletedDataSets": deleted_sets, "names": names}))
}
/// The warning about variables that aren't text and were left out, given the kind of each: every
@@ -533,26 +741,95 @@ fn push_escaped(out: &mut String, c: char, attribute: bool) {
}
}
/// Save Variable Library: the document's text variables and its data sets as a variable library in
/// the layout [`parse_library`] reads, so Load Variable Library reads back the same text variables,
/// data set names and text values. A text value is written as one `p` element per line. Variables
/// of other kinds are left out with their values, named in `skipped` and in a warning. A text
/// variable whose name can't name an element ([`element_name`]), a data set name or text value that
/// holds a character XML can't hold, a name that Load Variable Library would read differently or
/// refuse (white space at either end of a data set name, a name longer than `MAX_NAME` characters,
/// a name used twice), and a library past the caps Load Variable Library reads are refused. With `path` the library is written to the file; without it the reply carries it as
/// `xml`.
/// Add the graph value `csv` of the variable `var` to `xml` as the `data` element [`graph_value`]
/// reads: the CSV read as Graph Data reads it, a `propertyRow` with a blank corner cell and the
/// series names when it names series, and a `row` per category, its name in a first `value` with
/// `key="name"` (blank without categories) and then a `value` per series, blank where the row has
/// none. A label that isn't a number is marked `type="string"`, and so is a blank category. CSV
/// that names series and has no rows is written as the `propertyRow` alone. Refused for CSV with
/// neither rows nor series, which reads back as no value, for more than [`MAX_GRAPH_CATEGORIES`]
/// rows or [`MAX_GRAPH_SERIES`] series (what a graph holds), when a label holds a character XML
/// can't hold, and when `xml` grows past `room` bytes.
fn push_graph(xml: &mut String, var: &str, csv: &str, room: usize) -> std::result::Result<(), GraphRefusal> {
let (series, categories, rows) = super::super::graph::parse_csv(csv);
if rows.is_empty() && series.is_empty() {
return Err(GraphRefusal::Empty);
}
let width = rows.iter().map(Vec::len).max().unwrap_or(0).max(series.len());
if rows.len() > MAX_GRAPH_CATEGORIES || width > MAX_GRAPH_SERIES {
return Err(GraphRefusal::TooMany);
}
if !series.iter().chain(&categories).all(|l| l.chars().all(xml_char)) {
return Err(GraphRefusal::Control);
}
let labelled = !categories.is_empty();
let label = |l: &str, category: bool| {
let text = !l.is_empty() && l.trim().parse::<f64>().is_err();
let blank_category = category && labelled && l.is_empty();
let key = if category { " key=\"name\"" } else { "" };
let string = if text || blank_category { " type=\"string\"" } else { "" };
format!("<value{key}{string}>{}</value>", escaped(l, false))
};
let _ = writeln!(xml, "\t\t\t\t<{var}>\n\t\t\t\t\t<data numDataColumns=\"{}\">", width + usize::from(labelled));
if !series.is_empty() {
let names: String = (0..width).map(|s| label(series.get(s).map(String::as_str).unwrap_or_default(), false)).collect();
let _ = writeln!(xml, "\t\t\t\t\t\t<propertyRow key=\"name\"><value></value>{names}</propertyRow>");
}
xml.push_str("\t\t\t\t\t\t<values>\n");
for (i, row) in rows.iter().enumerate() {
let name = label(categories.get(i).map(String::as_str).unwrap_or_default(), true);
let values: String = (0..width)
.map(|s| match row.get(s).copied().flatten() {
Some(v) => format!("<value>{v}</value>"),
None => "<value></value>".to_string(),
})
.collect();
let _ = writeln!(xml, "\t\t\t\t\t\t\t<row>{name}{values}</row>");
if xml.len() > room {
return Err(GraphRefusal::TooLarge);
}
}
let _ = writeln!(xml, "\t\t\t\t\t\t</values>\n\t\t\t\t\t</data>\n\t\t\t\t</{var}>");
Ok(())
}
/// What a graph holds at most, for the errors about graph data past it.
fn graph_limits() -> String {
format!("more than {MAX_GRAPH_CATEGORIES} rows or {MAX_GRAPH_SERIES} series, which a graph doesn't hold")
}
/// Why [`push_graph`] refused a graph value.
enum GraphRefusal {
/// A label holds a character XML can't hold.
Control,
/// The data has more rows or series than a graph holds.
TooMany,
/// The data has neither rows nor series.
Empty,
/// The library grew past the room it has.
TooLarge,
}
/// Save Variable Library: the document's variables and its data sets as a variable library in the
/// layout [`parse_library`] reads, so Load Variable Library reads back the same variables with their
/// kinds, data set names and values. Each variable is declared with the `trait` and `category` of
/// its kind ([`kind_trait`]), and a variable of unknown kind with neither. A text value is written
/// as one `p` element per line, a visibility value as `true` or `false`, an image value as
/// [`library_file`] writes its path, and a graph value as a `data` element ([`push_graph`]). A
/// variable whose name can't name an element ([`element_name`]; a variable of unknown kind has no
/// values, so no element is named after it), a name or value that holds a character XML can't
/// hold, a name that Load Variable Library would read differently or refuse (white space at either
/// end, a name longer than `MAX_NAME` characters, a name used twice), an image value that isn't a
/// file's absolute path, and a library past the caps Load Variable Library reads are refused. With
/// `path` the library is written to the file; without it the reply carries it as `xml`.
pub(super) fn save_library(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "variable.saveLibrary";
let vars = &s.doc()?.doc.variables;
if vars.variables.is_empty() {
return Err(bad(C, "define a variable first"));
}
let (text, other): (Vec<&Variable>, Vec<&Variable>) = vars.variables.iter().partition(|v| v.kind == VariableKind::Text);
if text.is_empty() {
return Err(bad(C, "a variable library holds text variables, and the document has none"));
}
if let Some(name) = text.iter().map(|v| &v.name).find(|n| !element_name(n)) {
let all: Vec<&Variable> = vars.variables.iter().collect();
if let Some(name) = all.iter().filter(|v| v.kind != VariableKind::Unknown).map(|v| &v.name).find(|n| !element_name(n)) {
return Err(bad(
C,
format!(
@@ -560,48 +837,62 @@ pub(super) fn save_library(s: &mut Session, p: &Value) -> Result<Value> {
),
));
}
// Load Variable Library refuses a name longer than `MAX_NAME` characters and a name declared
// twice.
// Load Variable Library reads a name trimmed and refuses one longer than `MAX_NAME` characters
// or declared twice.
let mut declared = BTreeSet::new();
for v in &text {
named(Some(&v.name), "varName", C)?;
for v in &all {
if named(Some(&v.name), "varName", C)? != v.name || !v.name.chars().all(xml_char) {
return Err(bad(
C,
format!("variable `{}` starts or ends with white space or holds a control character, which a variable library can't hold", v.name),
));
}
if !declared.insert(v.name.as_str()) {
return Err(bad(C, format!("variable `{}` is already defined", v.name)));
}
}
if text.len() > MAX_LIBRARY_VARIABLES {
if all.len() > MAX_LIBRARY_VARIABLES {
return Err(bad(C, format!("the variable library declares more than {MAX_LIBRARY_VARIABLES} variables")));
}
if vars.datasets.len() > MAX_LIBRARY_DATASETS {
return Err(bad(C, format!("the variable library declares more than {MAX_LIBRARY_DATASETS} data sets")));
}
fn text_value<'a>(ds: &'a DataSet, var: &str) -> Option<&'a str> {
match ds.values.get(var) {
Some(DataValue::Text(t)) => Some(t.as_str()),
_ => None,
}
}
let mut xml = format!(
"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n\
<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\" [\n\
\t<!ENTITY ns_vars \"{NS_VARIABLES}\">\n\
\t<!ENTITY ns_custom \"{NS_CUSTOM}\">\n\
\t<!ENTITY ns_flows \"{NS_FLOWS}\">\n\
\t<!ENTITY ns_graphs \"{NS_GRAPHS}\">\n\
]>\n\
<svg>\n\
<variableSets xmlns=\"&ns_vars;\">\n\
\t<variableSet varSetName=\"binding1\" locked=\"none\">\n\
\t\t<variables>\n"
);
for v in &text {
xml += &format!("\t\t\t<variable varName=\"{}\" trait=\"textcontent\" category=\"&ns_flows;\"></variable>\n", v.name);
for v in &all {
let name = escaped(&v.name, true);
match kind_trait(v.kind) {
Some((t, category)) => xml += &format!("\t\t\t<variable varName=\"{name}\" trait=\"{t}\" category=\"{category}\"></variable>\n"),
None => xml += &format!("\t\t\t<variable varName=\"{name}\"></variable>\n"),
}
}
xml += "\t\t</variables>\n\t\t<v:sampleDataSets xmlns:v=\"&ns_vars;\" xmlns=\"&ns_custom;\">\n";
// Load Variable Library caps the file and the text its entity references expand to: one
// `&ns_flows;` per variable, two `&ns_vars;` and one `&ns_custom;`. The library stays within
// the cap less what the references add.
// Load Variable Library caps the file and the text its entity references expand to: each
// variable's `category`, two `&ns_vars;` and one `&ns_custom;`. The library stays within the
// cap less what the references add.
let grows = |value: &str, reference: &str| value.len().saturating_sub(reference.len());
let growth = text.len() * grows(NS_FLOWS, "&ns_flows;") + 2 * grows(NS_VARIABLES, "&ns_vars;") + grows(NS_CUSTOM, "&ns_custom;");
let growth = all
.iter()
.filter_map(|v| kind_trait(v.kind))
.map(|(_, category)| match category {
"&ns_flows;" => grows(NS_FLOWS, category),
"&ns_graphs;" => grows(NS_GRAPHS, category),
_ => grows(NS_VARIABLES, category),
})
.sum::<usize>()
+ 2 * grows(NS_VARIABLES, "&ns_vars;")
+ grows(NS_CUSTOM, "&ns_custom;");
let room = MAX_LIBRARY_BYTES.saturating_sub(growth);
let too_large = || bad(C, format!("the variable library is larger than {MAX_LIBRARY_BYTES} bytes"));
let mut seen = BTreeSet::new();
@@ -615,25 +906,61 @@ pub(super) fn save_library(s: &mut Session, p: &Value) -> Result<Value> {
if !seen.insert(name.as_str()) {
return Err(bad(C, format!("dataset `{name}` already exists")));
}
if !name.chars().all(xml_char) || text.iter().filter_map(|v| text_value(ds, &v.name)).any(|t| !t.chars().all(xml_char)) {
return Err(bad(C, format!("data set `{name}` holds a control character, which a variable library can't hold")));
let control = || bad(C, format!("data set `{name}` holds a control character, which a variable library can't hold"));
let mut text_values = all.iter().filter_map(|v| match ds.values.get(&v.name) {
Some(DataValue::Text(t)) if v.kind == VariableKind::Text => Some(t),
_ => None,
});
if !name.chars().all(xml_char) || text_values.any(|t| !t.chars().all(xml_char)) {
return Err(control());
}
xml += &format!("\t\t\t<v:sampleDataSet dataSetName=\"{}\">\n", escaped(name, true));
for v in &text {
let Some(t) = text_value(ds, &v.name) else { continue };
xml += &format!("\t\t\t\t<{}>\n", v.name);
for line in t.split('\n') {
xml += "\t\t\t\t\t<p>";
// A value can be larger than the cap, so the text stops growing once it passes it.
for c in line.chars() {
push_escaped(&mut xml, c, false);
if xml.len() > room {
return Err(too_large());
for v in &all {
let Some(value) = ds.values.get(&v.name).filter(|value| value.fits(v.kind)) else { continue };
let var = &v.name;
match value {
DataValue::Text(t) => {
xml += &format!("\t\t\t\t<{var}>\n");
for line in t.split('\n') {
xml += "\t\t\t\t\t<p>";
// A value can be larger than the cap, so the text stops growing once it passes it.
for c in line.chars() {
push_escaped(&mut xml, c, false);
if xml.len() > room {
return Err(too_large());
}
}
xml += "</p>\n";
}
xml += &format!("\t\t\t\t</{var}>\n");
}
xml += "</p>\n";
DataValue::Visible(shown) => xml += &format!("\t\t\t\t<{var}>{shown}</{var}>\n"),
DataValue::Image(path) => {
// Load Variable Library reads back only a file's absolute path.
let file = library_file(path);
if library_path(file.trim_matches(XML_SPACE)).as_deref() != Some(path.as_str()) {
return Err(bad(C, format!("data set `{name}` holds an image value for `{var}` that isn't a file's absolute path")));
}
if !file.chars().all(xml_char) {
return Err(control());
}
xml += &format!("\t\t\t\t<{var}>{}</{var}>\n", escaped(&file, false));
}
DataValue::Graph(csv) => match push_graph(&mut xml, var, csv, room) {
Ok(()) => {}
Err(GraphRefusal::Control) => return Err(control()),
Err(GraphRefusal::TooMany) => {
return Err(bad(C, format!("data set `{name}` holds a graph value for `{var}` with {}", graph_limits())));
}
Err(GraphRefusal::Empty) => {
return Err(bad(C, format!("data set `{name}` holds a graph value for `{var}` without rows or series")));
}
Err(GraphRefusal::TooLarge) => return Err(too_large()),
},
}
if xml.len() > room {
return Err(too_large());
}
xml += &format!("\t\t\t\t</{}>\n", v.name);
}
xml += "\t\t\t</v:sampleDataSet>\n";
if xml.len() > room {
@@ -644,13 +971,7 @@ pub(super) fn save_library(s: &mut Session, p: &Value) -> Result<Value> {
if xml.len() > room {
return Err(too_large());
}
let skipped: Vec<Value> = other.iter().map(|v| json!({"name": v.name, "kind": v.kind.label()})).collect();
let mut out = json!({
"variables": text.iter().map(|v| v.name.as_str()).collect::<Vec<_>>(), "datasets": vars.datasets.len(), "skipped": skipped,
});
if let Some(warning) = left_out_warning(other.iter().map(|v| v.kind.label())) {
out["warning"] = json!(warning);
}
let mut out = json!({"variables": all.iter().map(|v| v.name.as_str()).collect::<Vec<_>>(), "datasets": vars.datasets.len()});
match str_param(p, "path") {
Some(path) => {
let path = absolute_path(path);
+6 -1
View File
@@ -1293,7 +1293,12 @@ fn a_transform_that_moves_nothing_records_no_undo_step() {
for (id, p) in calls {
assert_eq!(s.execute(id, &p).unwrap(), json!({"ids": [a.0]}), "{id} {p}");
assert_eq!(history(&s), before, "{id} {p}");
assert_eq!(s.journal.last().unwrap(), &(id.to_string(), p));
// The journal adds the frame a scale acted in, so a replay acts in the same one.
let mut recorded = p;
if id == "object.scale" {
recorded["basis"] = json!("box");
}
assert_eq!(s.journal.last().unwrap(), &(id.to_string(), recorded));
}
assert_eq!(
s.doc().unwrap().last_transform,
+33
View File
@@ -218,6 +218,39 @@ fn reverse_path_direction_turns_the_width_profile_and_pen_records_with_the_path(
}
}
#[test]
fn reverse_path_direction_turns_a_compound_paths_own_width_profile_and_pen_records() {
use vectorcraft_doc::{AngleProfile, PressureProfile, WidthProfile};
let mut s = session();
let (a, b) = (rect(&mut s, 0.0), rect(&mut s, 50.0));
run(&mut s, "select.set", json!({"ids": [a.0, b.0]}));
run(&mut s, "object.compoundPath.make", json!({}));
let compound = s.doc().unwrap().selection.objects[0];
// A lone rectangle of the same shape, whose strokes Reverse Path Direction already turns.
let lone = rect(&mut s, 0.0);
let profile = WidthProfile { points: vec![(0.0, 0.2, 0.6), (0.3, 1.0, 0.4), (1.0, 0.5, 0.9)] };
let pressure = PressureProfile { points: vec![(0.0, 0.1), (0.25, 0.9), (1.0, 0.4)] };
let bearing = AngleProfile { points: vec![(0.0, 10.0), (0.6, 80.0), (1.0, 170.0)] };
s.edit("set", |d, _| {
for id in [compound, lone] {
let st = d.node_mut(id).unwrap().appearance.stroke_mut().unwrap();
st.profile = Some(profile.clone());
st.pressure = Some(pressure.clone());
st.bearing = Some(bearing.clone());
}
Ok(())
})
.unwrap();
run(&mut s, "select.set", json!({"ids": [compound.0, lone.0]}));
assert_eq!(run(&mut s, "path.reverse", json!({}))["changed"], 3);
let stroke = |id: NodeId| s.doc().unwrap().doc.node(id).unwrap().appearance.stroke().unwrap().clone();
let (got, want) = (stroke(compound), stroke(lone));
assert_ne!(want.profile.as_ref(), Some(&profile), "the lone rectangle's profile turned");
assert_eq!(got.profile, want.profile, "both members turned alike, so the compound path's profile turns as the rectangle's does");
assert_eq!(got.pressure, want.pressure);
assert_eq!(got.bearing, want.bearing);
}
#[test]
fn attributes_survive_a_native_round_trip() {
let mut s = session();
+155 -1
View File
@@ -666,7 +666,7 @@ fn expanding_a_reflected_symbol_instance_keeps_its_box() {
for reset in [false, true] {
let (mut s, inst) = turned_instance(0.0);
s.execute("object.rotate", &json!({"angle": 150})).unwrap();
s.execute("object.reflect", &json!({"axis": "horizontal"})).unwrap();
s.execute("object.reflect", &json!({"axis": "horizontal", "basis": "page"})).unwrap();
assert!(near(angle(&s, inst), -170.0), "{}", angle(&s, inst));
if reset {
s.execute("object.resetBoundingBox", &json!({})).unwrap();
@@ -719,10 +719,164 @@ fn page_flips_keep_an_upright_box_upright() {
s.execute("object.reflect", &json!({"axis": "horizontal"})).unwrap();
assert_eq!(angle(&s, a), 0.0);
s.execute("object.rotate", &json!({"angle": 30})).unwrap();
// A named axis is the turned box's own: the box keeps its angle.
s.execute("object.reflect", &json!({"axis": "vertical"})).unwrap();
assert!(near(angle(&s, a), 30.0));
s.execute("object.reflect", &json!({"axis": "vertical", "basis": "page"})).unwrap();
assert!(near(angle(&s, a), -30.0));
}
fn same_matrix(a: Affine, b: Affine) -> bool {
a.as_coeffs().iter().zip(b.as_coeffs()).all(|(x, y)| near(*x, y))
}
/// After a rotation, Scale and a named Reflect act along the turned bounding box until Reset
/// Bounding Box; `basis: "page"` keeps the page's axes, and Transform Again repeats the matrix the
/// transform applied on the page.
#[test]
fn scale_and_reflect_follow_the_turned_box() {
let mut s = session();
let a = turned_rect(&mut s);
let page = |s: &Session, ids: &[NodeId]| s.doc().unwrap().doc.bounds_of(ids, false).unwrap();
let c = Point::new(200.0, 200.0);
let frame = OrientedBox { angle: 45.0, rect: Rect::ZERO };
s.execute("object.scale", &json!({"sx": 200, "sy": 100})).unwrap();
let b = selection_box(&s);
assert!(near(b.angle, 45.0) && near(angle(&s, a), 45.0), "{b:?}");
assert!(near(b.rect.width(), 200.0) && near(b.rect.height(), 50.0), "{b:?}");
assert!(b.center().distance(c) < 1e-6, "{b:?}");
let want = Affine::translate(c.to_vec2()) * frame.conjugate(Affine::scale_non_uniform(2.0, 1.0)) * Affine::translate(-c.to_vec2());
let Some(LastTransform::Matrix(m, _)) = s.doc().unwrap().last_transform.clone() else { panic!("no transform to repeat") };
assert!(same_matrix(m, want), "{m:?}");
// The recorded step names its basis, so a replay acts in the same frame.
let steps = s.journal_for_action(0);
assert!(steps.iter().any(|(id, p)| id == "object.scale" && p["basis"] == "box"), "{steps:?}");
// Reflected across the box's vertical axis through its left side: the box keeps its angle and
// size, and its centre moves a width to the left along the box.
let left = b.reference_point(3);
s.execute("object.reflect", &json!({"axis": "vertical", "origin": [left.x, left.y]})).unwrap();
let r = selection_box(&s);
let moved = c + (frame.to_doc() * Point::new(-200.0, 0.0)).to_vec2();
assert!(near(r.angle, 45.0) && near(r.rect.width(), 200.0) && near(r.rect.height(), 50.0), "{r:?}");
assert!(r.center().distance(moved) < 1e-6, "{r:?}");
// Across its horizontal axis through its centre: the box stays where it is.
s.execute("object.reflect", &json!({"axis": "horizontal"})).unwrap();
assert!(selection_box(&s).center().distance(moved) < 1e-6 && near(angle(&s, a), 45.0));
// Unknown bases are errors and change nothing.
let n = undo_len(&s);
assert!(s.execute("object.scale", &json!({"sx": 50, "basis": "turned"})).is_err());
assert!(s.execute("object.reflect", &json!({"axis": "vertical", "basis": 1})).is_err());
assert!(s.execute("object.reflect", &json!({"axis": 30, "basis": "turned"})).is_err());
assert_eq!(undo_len(&s), n);
// On the page's axes, the box no longer stands at 45°.
s.execute("object.scale", &json!({"sx": 50, "sy": 100, "basis": "page"})).unwrap();
assert!(!near(angle(&s, a), 45.0));
// Transform Again repeats the page matrix after Reset Bounding Box too.
s.execute("object.scale", &json!({"sx": 200, "sy": 100})).unwrap();
let Some(LastTransform::Matrix(m, _)) = s.doc().unwrap().last_transform.clone() else { panic!("no transform to repeat") };
s.execute("object.resetBoundingBox", &json!({})).unwrap();
let before = s.doc().unwrap().doc.node(a).unwrap().clone();
s.execute("object.transformAgain", &json!({})).unwrap();
let mut want = before;
want.transform(m, false);
let (got, want) = (page(&s, &[a]), want.geometric_bounds_with(&s.doc().unwrap().doc.symbol_boxes()).unwrap());
assert!([got.x0 - want.x0, got.y0 - want.y0, got.x1 - want.x1, got.y1 - want.y1].iter().all(|d| d.abs() < 1e-6), "{got:?} {want:?}");
}
/// A saved step without `basis` was recorded before Scale and Reflect followed the turned box, so a
/// replay of it acts along the page's axes, as it did then, and its new journal entry says so. A
/// step recorded now names its basis and replays along the box. A call without `basis` that is not
/// a replay acts along the box.
#[test]
fn saved_steps_without_a_basis_replay_on_the_page() {
// The turned rectangle after `run` runs on it: its page bounds and its box's angle.
let after = |run: &dyn Fn(&mut Session)| {
let mut s = session();
let a = turned_rect(&mut s);
run(&mut s);
let st = (s.doc().unwrap().doc.bounds_of(&[a], false).unwrap(), angle(&s, a));
(st, s.journal.last().unwrap().clone())
};
let same = |(r, a): (Rect, f64), (q, b): (Rect, f64)| [r.x0 - q.x0, r.y0 - q.y0, r.x1 - q.x1, r.y1 - q.y1, a - b].iter().all(|d| d.abs() < 1e-6);
for (id, p) in [("object.scale", json!({"sx": 200, "sy": 100})), ("object.reflect", json!({"axis": "vertical"}))] {
let mut on_page = p.clone();
on_page["basis"] = json!("page");
let (page, _) = after(&|s| {
s.execute(id, &on_page).unwrap();
});
let (old, (_, noted)) = after(&|s| {
s.replay(id, &p).unwrap();
});
assert!(same(old, page), "{id}: {old:?} {page:?}");
assert_eq!(noted["basis"], "page", "{id}");
let (boxed, (recorded_id, recorded)) = after(&|s| {
s.execute(id, &p).unwrap();
});
assert!(!same(boxed, page) && near(boxed.1, 45.0), "{id}: {boxed:?}");
assert_eq!(recorded["basis"], "box", "{id}");
let (replayed, _) = after(&|s| {
s.replay(&recorded_id, &recorded).unwrap();
});
assert!(same(replayed, boxed), "{id}: {replayed:?} {boxed:?}");
}
}
/// Once Reset Bounding Box squares the box, and for objects standing at different angles, Scale
/// acts along the page's axes.
#[test]
fn scale_follows_the_page_after_a_reset_and_for_mixed_angles() {
let mut s = session();
let a = turned_rect(&mut s);
s.execute("object.resetBoundingBox", &json!({})).unwrap();
let page = |s: &Session, ids: &[NodeId]| s.doc().unwrap().doc.bounds_of(ids, false).unwrap();
let w = page(&s, &[a]);
s.execute("object.scale", &json!({"sx": 200, "sy": 100})).unwrap();
let r = page(&s, &[a]);
assert!(near(r.width(), 2.0 * w.width()) && near(r.height(), w.height()), "{w:?} {r:?}");
assert_eq!(angle(&s, a), 0.0);
// A turned rectangle with an upright one: the box is square to the page.
let b = turned_rect(&mut s);
let u = rect(&mut s, 400.0, 100.0, 50.0, 50.0);
sel(&mut s, &[b, u]);
let w = page(&s, &[b, u]);
s.execute("object.scale", &json!({"sx": 100, "sy": 200})).unwrap();
let r = page(&s, &[b, u]);
assert!(near(r.width(), w.width()) && near(r.height(), 2.0 * w.height()), "{w:?} {r:?}");
}
/// With anchors selected, Scale and a named Reflect move the anchors along the page's axes, but
/// with Transform Objects off they move the whole objects' pattern tiles, along the turned box.
#[test]
fn pattern_only_transforms_of_selected_anchors_follow_the_turned_box() {
let c = Point::new(200.0, 200.0);
let frame = OrientedBox { angle: 45.0, rect: Rect::ZERO };
let about = |m: Affine| Affine::translate(c.to_vec2()) * m * Affine::translate(-c.to_vec2());
let last = |s: &Session| match s.doc().unwrap().last_transform.clone() {
Some(LastTransform::Matrix(m, _)) => m,
other => panic!("no matrix to repeat: {other:?}"),
};
let scale = Affine::scale_non_uniform(2.0, 1.0);
let flip = Affine::scale_non_uniform(-1.0, 1.0);
for (cmd, p, m) in [("object.scale", json!({"sx": 200, "sy": 100}), scale), ("object.reflect", json!({"axis": "vertical"}), flip)] {
for objects in [false, true] {
let mut s = session();
let a = turned_rect(&mut s);
s.execute("select.anchors", &json!({"id": a.0, "anchors": [[0, 0]], "mode": "set"})).unwrap();
let mut p = p.clone();
p["origin"] = json!([c.x, c.y]);
p["objects"] = json!(objects);
p["patterns"] = json!(true);
s.execute(cmd, &p).unwrap();
let want = if objects { about(m) } else { about(frame.conjugate(m)) };
assert!(same_matrix(last(&s), want), "{cmd} objects {objects}: {:?}", last(&s));
}
}
}
#[test]
fn groups_type_and_multiple_selections_keep_their_angle() {
let mut s = session();
+900 -2
View File
@@ -3,7 +3,8 @@
use std::sync::Arc;
use serde_json::{Value, json};
use vectorcraft_color::{Color, Paint};
use vectorcraft_color::{BlendMode, Color, Paint};
use vectorcraft_doc::appearance::{Effect, FillLayer, StrokeLayer};
use vectorcraft_doc::{AppearanceItem, ImageBlob, ImageObject, LineCap, LineJoin, Node, NodeKind};
use vectorcraft_geom::{Affine, FillRule, PathData, Point, Rect};
use vectorcraft_testkit::pdf::{PdfPage, pdf};
@@ -2684,6 +2685,401 @@ fn live_paint_make_and_expand_keep_abutting_compound_colors() {
check_colors(&node(&s, group));
}
/// Gives `id` the appearance rows `items` (paint order) and returns them.
fn set_rows(s: &mut Session, id: NodeId, items: Vec<AppearanceItem>) -> Vec<AppearanceItem> {
s.edit("t", |d, _| {
d.node_mut(id).unwrap().appearance = vectorcraft_doc::Appearance { items: items.clone(), ..Default::default() }.into();
Ok(())
})
.unwrap();
items
}
/// A fill row of `p`, changed by `f`.
fn fill_row(p: Paint, f: impl FnOnce(&mut FillLayer)) -> AppearanceItem {
let mut l = FillLayer::new(p);
f(&mut l);
AppearanceItem::Fill(l)
}
/// A stroke row of `p` `width` wide, changed by `f`.
fn stroke_row(p: Paint, width: f64, f: impl FnOnce(&mut StrokeLayer)) -> AppearanceItem {
let mut l = StrokeLayer::new(p, width);
f(&mut l);
AppearanceItem::Stroke(l)
}
/// The faces and edges of Live Paint group `g` whose bounds lie within x `x0`..`x1`.
fn parts_within(s: &Session, g: NodeId, x0: f64, x1: f64) -> (Vec<Node>, Vec<Node>) {
let n = node(s, g);
let within = |c: &&Arc<Node>| c.geometric_bounds().is_some_and(|b| b.x0 >= x0 - 1e-6 && b.x1 <= x1 + 1e-6);
let faces = vectorcraft_tools::builder::faces(&n).into_iter().filter(within).map(|c| (**c).clone()).collect();
let edges = vectorcraft_tools::builder::edges(&n).into_iter().filter(within).map(|c| (**c).clone()).collect();
(faces, edges)
}
/// Make gives each edge every stroke row of its source that draws, a lower one under an
/// unpainted or hidden top row included, with the rows' settings and the source's opacity and
/// blending mode; rows that draw nothing stay only with the stored source, which Release returns.
#[test]
fn live_paint_make_keeps_lower_drawn_stroke_rows() {
let mut s = session();
let (a, b) = two_at(&mut s, 200.0);
let black = Paint::solid(Color::BLACK);
let green = Paint::solid(Color::rgb(0.0, 1.0, 0.0));
let thick = stroke_row(black.clone(), 3.0, |l| {
l.opacity = 0.5;
l.blend = BlendMode::Multiply;
l.cap = LineCap::Round;
});
// A: the top stroke has no paint.
let a_rows =
set_rows(&mut s, a, vec![fill_row(Paint::solid(Color::rgb(1.0, 0.0, 0.0)), |_| {}), thick.clone(), stroke_row(Paint::None, 1.0, |_| {})]);
// B: the top stroke is hidden; a zero-weight and a transparent stroke draw nothing either.
set_rows(
&mut s,
b,
vec![
stroke_row(green.clone(), 2.0, |_| {}),
stroke_row(black.clone(), 0.0, |_| {}),
stroke_row(black, 2.0, |l| l.opacity = 0.0),
stroke_row(Paint::solid(Color::rgb(0.0, 0.0, 1.0)), 5.0, |l| l.visible = false),
],
);
s.edit("t", |d, _| {
let n = d.node_mut(a).unwrap();
n.opacity = 0.75;
n.blend = BlendMode::Screen;
Ok(())
})
.unwrap();
s.execute("select.set", &json!({"ids": [a.0, b.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let (_, a_edges) = parts_within(&s, g, 0.0, 100.0);
let (_, b_edges) = parts_within(&s, g, 200.0, 300.0);
assert!(!a_edges.is_empty() && !b_edges.is_empty());
for e in &a_edges {
assert_eq!(e.appearance.items, vec![thick.clone()], "A's edge takes the stroke that draws");
assert_eq!((e.opacity, e.blend), (0.75, BlendMode::Screen));
}
for e in &b_edges {
assert_eq!(e.appearance.items, vec![stroke_row(green.clone(), 2.0, |_| {})], "B's edge takes only its green stroke");
assert_eq!((e.opacity, e.blend), (1.0, BlendMode::Normal));
}
// Release returns the sources with every row they had.
let released = ids(&s.execute("livePaint.release", &json!({})).unwrap());
assert!(released.contains(&a));
assert_eq!(node(&s, a).appearance.items, a_rows);
}
/// When Make cuts a dashed stroke with arrowheads, a width profile and a brush into edges, each
/// edge's dashes go on from where it starts along the path, the arrowheads stay at the path's own
/// ends, and the profile and brush, which spread over the whole path, are left off the pieces.
#[test]
fn live_paint_make_fits_dashes_and_arrowheads_to_each_edge() {
use vectorcraft_doc::{Arrowhead, Dash};
let mut s = session();
let a = rect(&mut s, 0.0, 0.0, 100.0, 100.0);
let l = line(&mut s, (-20.0, 50.0), (120.0, 50.0));
let dash = Dash { pattern: vec![10.0, 5.0], offset: 2.0, align_corners: true };
let row = stroke_row(Paint::solid(Color::BLACK), 2.0, |st| {
st.dash = Some(dash.clone());
st.start_arrow = Some(Arrowhead::Triangle);
st.end_arrow = Some(Arrowhead::Circle);
st.brush = Some("Charcoal".into());
});
let rows = set_rows(&mut s, l, vec![row]);
s.execute("select.set", &json!({"ids": [a.0, l.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let gn = node(&s, g);
let mut pieces: Vec<(f64, f64, vectorcraft_doc::StrokeLayer)> = vectorcraft_tools::builder::edges(&gn)
.iter()
.filter_map(|e| {
let st = e.appearance.stroke().filter(|st| st.dash.is_some())?.clone();
let sp = e.path_data()?.subpaths.first()?;
Some((sp.anchors.first()?.p.x, sp.anchors.last()?.p.x, st))
})
.collect();
pieces.sort_by(|p, q| p.0.total_cmp(&q.0));
let ends: Vec<(f64, f64)> = pieces.iter().map(|p| ((p.0 * 1e3).round() / 1e3, (p.1 * 1e3).round() / 1e3)).collect();
assert_eq!(ends, vec![(-20.0, 0.0), (0.0, 100.0), (100.0, 120.0)], "each piece runs the way the line does");
let offsets: Vec<f64> = pieces.iter().map(|p| (p.2.dash.as_ref().unwrap().offset * 1e3).round() / 1e3).collect();
assert_eq!(offsets, vec![2.0, 22.0, 122.0], "the dashes go on along the line");
assert!(pieces.iter().all(|p| !p.2.dash.as_ref().unwrap().align_corners && p.2.brush.is_none()));
let arrows: Vec<_> = pieces.iter().map(|p| (p.2.start_arrow.clone(), p.2.end_arrow.clone())).collect();
assert_eq!(arrows, vec![(Some(Arrowhead::Triangle), None), (None, None), (None, Some(Arrowhead::Circle))]);
// A path that crosses itself: the pieces that start at the crossing take their place on the
// path from where they run, not from the first time the path passes that point.
let mut s3 = session();
let anchors = [(0.0, 0.0), (100.0, 100.0), (100.0, 0.0), (0.0, 100.0)].map(|(x, y)| json!({"x": x, "y": y}));
let z = NodeId(s3.execute("path.create", &json!({"anchors": anchors, "closed": false})).unwrap()["id"].as_u64().unwrap());
set_rows(&mut s3, z, rows.clone());
s3.execute("select.set", &json!({"ids": [z.0]})).unwrap();
let g3 = NodeId(s3.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let mut cut: Vec<(f64, Option<Arrowhead>, Option<Arrowhead>)> = vectorcraft_tools::builder::edges(&node(&s3, g3))
.iter()
.filter_map(|e| {
let st = e.appearance.stroke()?;
Some(((st.dash.as_ref()?.offset * 1e3).round() / 1e3, st.start_arrow.clone(), st.end_arrow.clone()))
})
.collect();
cut.sort_by(|p, q| p.0.total_cmp(&q.0));
let d = 2.0 + 50.0 * 2f64.sqrt();
let r = |v: f64| (v * 1e3).round() / 1e3;
assert_eq!(
cut,
vec![(2.0, Some(Arrowhead::Triangle), None), (r(d), None, None), (r(d + 100.0 + 100.0 * 2f64.sqrt()), None, Some(Arrowhead::Circle))]
);
// An uncut path keeps all of it.
let mut s2 = session();
let l2 = line(&mut s2, (0.0, 0.0), (50.0, 0.0));
set_rows(&mut s2, l2, rows.clone());
s2.execute("select.set", &json!({"ids": [l2.0]})).unwrap();
let g2 = NodeId(s2.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let edges: Vec<_> = vectorcraft_tools::builder::edges(&node(&s2, g2)).iter().map(|e| e.appearance.items.clone()).collect();
assert_eq!(edges, vec![rows]);
}
/// When Gap Options or Merge cuts an edge in two, each piece keeps the edge's dashes going on from
/// where it starts along the edge, an arrowhead only at the end of the edge it ends at, and no brush.
#[test]
fn live_paint_gap_options_and_merge_fit_an_edge_look_to_each_piece() {
use vectorcraft_doc::{Arrowhead, Dash};
let mut s = session();
let l = line(&mut s, (0.0, 50.0), (100.0, 50.0));
let stub = line(&mut s, (50.0, 0.0), (50.0, 48.0));
let row = stroke_row(Paint::solid(Color::BLACK), 2.0, |st| {
st.dash = Some(Dash { pattern: vec![10.0, 5.0], offset: 2.0, align_corners: false });
st.start_arrow = Some(Arrowhead::Triangle);
st.end_arrow = Some(Arrowhead::Circle);
st.brush = Some("Charcoal".into());
});
let rows = set_rows(&mut s, l, vec![row]);
s.execute("select.set", &json!({"ids": [l.0, stub.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let dashed = |s: &Session, g: NodeId| {
let mut out: Vec<(f64, f64, vectorcraft_doc::StrokeLayer)> = vectorcraft_tools::builder::edges(&node(s, g))
.iter()
.filter_map(|e| {
let st = e.appearance.stroke().filter(|st| st.dash.is_some())?.clone();
let sp = e.path_data()?.subpaths.first()?;
Some(((sp.anchors.first()?.p.x * 1e3).round() / 1e3, (sp.anchors.last()?.p.x * 1e3).round() / 1e3, st))
})
.collect();
out.sort_by(|p, q| p.0.total_cmp(&q.0));
out
};
let before = dashed(&s, g);
assert_eq!(before.len(), 1, "nothing cuts the line yet");
assert_eq!(vec![AppearanceItem::Stroke(before[0].2.clone())], rows);
let r = s.execute("livePaint.gapOptions", &json!({"id": g.0, "closeGaps": true})).unwrap();
assert_eq!(r["closed"], json!(1));
let pieces = dashed(&s, g);
let ends: Vec<(f64, f64)> = pieces.iter().map(|p| (p.0, p.1)).collect();
assert_eq!(ends, vec![(0.0, 50.0), (50.0, 100.0)], "the line is cut where the gap closes");
let offsets: Vec<f64> = pieces.iter().map(|p| (p.2.dash.as_ref().unwrap().offset * 1e3).round() / 1e3).collect();
assert_eq!(offsets, vec![2.0, 52.0], "the dashes go on along the line");
let arrows: Vec<_> = pieces.iter().map(|p| (p.2.start_arrow.clone(), p.2.end_arrow.clone())).collect();
assert_eq!(arrows, vec![(Some(Arrowhead::Triangle), None), (None, Some(Arrowhead::Circle))]);
assert!(pieces.iter().all(|p| p.2.brush.is_none()), "a brush spreads over the whole line");
// Merge: the piece of the edge that an added path cuts off, which takes the edge's look, gets
// it fitted to where it lies along the edge in the same way.
let mut s = session();
let l = line(&mut s, (0.0, 50.0), (100.0, 50.0));
set_rows(&mut s, l, rows.clone());
s.execute("select.set", &json!({"ids": [l.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let cut = line(&mut s, (25.0, 0.0), (25.0, 100.0));
s.execute("livePaint.merge", &json!({"ids": [g.0, cut.0]})).unwrap();
let pieces = dashed(&s, g);
let ends: Vec<(f64, f64)> = pieces.iter().map(|p| (p.0, p.1)).collect();
assert_eq!(ends, vec![(0.0, 25.0), (25.0, 100.0)], "the added line cuts the edge");
let offsets: Vec<f64> = pieces.iter().map(|p| (p.2.dash.as_ref().unwrap().offset * 1e3).round() / 1e3).collect();
assert_eq!(offsets, vec![2.0, 27.0], "the dashes go on along the line");
let arrows: Vec<_> = pieces.iter().map(|p| (p.2.start_arrow.clone(), p.2.end_arrow.clone())).collect();
assert_eq!(arrows, vec![(Some(Arrowhead::Triangle), None), (None, Some(Arrowhead::Circle))]);
assert!(pieces.iter().all(|p| p.2.brush.is_none()), "a brush spreads over the whole line");
// A repainted edge that Merge cuts keeps its paint on every piece.
let mut s = session();
let l = line(&mut s, (0.0, 50.0), (100.0, 50.0));
s.execute("select.set", &json!({"ids": [l.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [50, 50], "color": "#ff0000", "width": 3})).unwrap();
let cut = line(&mut s, (50.0, 0.0), (50.0, 100.0));
s.execute("livePaint.merge", &json!({"ids": [g.0, cut.0]})).unwrap();
let gn = node(&s, g);
let red = Paint::solid(Color::from_hex("#ff0000").unwrap());
let mut on_line: Vec<(f64, bool)> = vectorcraft_tools::builder::edges(&gn)
.iter()
.filter_map(|e| {
let sp = e.path_data()?.subpaths.first()?;
let (a, z) = (sp.anchors.first()?.p, sp.anchors.last()?.p);
((a.y - 50.0).abs() < 1e-6 && (z.y - 50.0).abs() < 1e-6)
.then(|| ((a.x.min(z.x) * 1e3).round() / 1e3, e.appearance.stroke().is_some_and(|st| st.paint == red)))
})
.collect();
on_line.sort_by(|p, q| p.0.total_cmp(&q.0));
assert_eq!(on_line, vec![(0.0, true), (50.0, true)], "both pieces keep the edge's paint");
}
/// The edge Make builds from a closed path that nothing cuts starts at the anchor the path starts
/// at and runs the way the path does, whichever anchor that is, so its dashes and brush lie where
/// they do on the path, and it keeps the path's stroke row as it is.
#[test]
fn live_paint_make_starts_a_closed_edge_where_its_path_starts() {
use vectorcraft_doc::Dash;
let corners = [(50.0, 0.0), (100.0, 50.0), (50.0, 100.0), (0.0, 50.0)];
for clockwise in [true, false] {
for start in 0..4 {
let mut s = session();
let mut pts: Vec<(f64, f64)> = (0..4).map(|k| corners[(k + start) % 4]).collect();
if !clockwise {
pts.reverse();
}
let anchors: Vec<_> = pts.iter().map(|(x, y)| json!({"x": x, "y": y})).collect();
let z = NodeId(s.execute("path.create", &json!({"anchors": anchors, "closed": true})).unwrap()["id"].as_u64().unwrap());
let row = stroke_row(Paint::solid(Color::BLACK), 2.0, |st| {
st.dash = Some(Dash { pattern: vec![10.0, 5.0], offset: 2.0, align_corners: false });
st.brush = Some("Charcoal".into());
});
let rows = set_rows(&mut s, z, vec![row]);
s.execute("select.set", &json!({"ids": [z.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let gn = node(&s, g);
let edges = vectorcraft_tools::builder::edges(&gn);
let [e] = edges.as_slice() else { panic!("one edge, got {}", edges.len()) };
let sp = e.path_data().unwrap().subpaths.first().unwrap().clone();
let at: Vec<(f64, f64)> = sp.anchors.iter().map(|a| ((a.p.x * 1e3).round() / 1e3, (a.p.y * 1e3).round() / 1e3)).collect();
assert!(sp.closed);
assert_eq!(at, pts, "clockwise {clockwise}, start {start}");
assert_eq!(e.appearance.items, rows, "clockwise {clockwise}, start {start}");
}
}
// A closed path that crosses itself is cut into loops, and the loop that holds the path's
// first anchor is still only part of the path: it keeps no brush.
let mut s = session();
let anchors = [(0.0, 0.0), (100.0, 100.0), (100.0, 0.0), (0.0, 100.0)].map(|(x, y)| json!({"x": x, "y": y}));
let z = NodeId(s.execute("path.create", &json!({"anchors": anchors, "closed": true})).unwrap()["id"].as_u64().unwrap());
let row = stroke_row(Paint::solid(Color::BLACK), 2.0, |st| {
st.dash = Some(Dash { pattern: vec![10.0, 5.0], offset: 2.0, align_corners: false });
st.brush = Some("Charcoal".into());
});
set_rows(&mut s, z, vec![row]);
s.execute("select.set", &json!({"ids": [z.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let gn = node(&s, g);
let edges = vectorcraft_tools::builder::edges(&gn);
assert!(edges.len() > 1, "the crossing cuts the path, got {} edge", edges.len());
assert!(edges.iter().all(|e| e.appearance.stroke().is_some_and(|st| st.brush.is_none())), "no loop is the whole path");
}
/// When Make cuts a stroke whose only setting that depends on direction is a gradient along or
/// across it, each edge runs the way its source path does, so the gradient keeps its direction.
#[test]
fn live_paint_make_keeps_the_direction_of_gradient_strokes() {
use vectorcraft_doc::StrokeGradientMode;
for mode in [StrokeGradientMode::Along, StrokeGradientMode::Across] {
for (x0, x1) in [(-20.0, 120.0), (120.0, -20.0)] {
let mut s = session();
let a = rect(&mut s, 0.0, 0.0, 100.0, 100.0);
let l = line(&mut s, (x0, 50.0), (x1, 50.0));
let gradient = Paint::Gradient(Box::new(vectorcraft_color::GradientPaint::new(vectorcraft_color::Gradient::default())));
set_rows(&mut s, l, vec![stroke_row(gradient, 2.0, |st| st.gradient_mode = mode)]);
s.execute("select.set", &json!({"ids": [a.0, l.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let pieces: Vec<(f64, f64)> = vectorcraft_tools::builder::edges(&node(&s, g))
.iter()
.filter_map(|e| {
e.appearance.stroke().filter(|st| st.gradient_mode == mode)?;
let sp = e.path_data()?.subpaths.first()?;
Some((sp.anchors.first()?.p.x, sp.anchors.last()?.p.x))
})
.collect();
assert_eq!(pieces.len(), 3, "{mode:?}, from {x0}");
assert!(
pieces.iter().all(|&(p, q)| (q - p).signum() == (x1 - x0).signum()),
"{mode:?}, from {x0}: each piece runs the way the line does: {pieces:?}"
);
}
}
}
/// Make gives each face every fill row of its source that draws, in order and with their
/// opacity, blending mode, overprint and effects, and the source's gradients keep their fit on
/// the source; Expand keeps the rows, and Undo and Redo bring the group back with them.
#[test]
fn live_paint_make_keeps_all_drawn_fill_rows_and_attributes() {
let mut s = session();
let (a, b) = two(&mut s);
let lower = fill_row(Paint::solid(Color::rgb(1.0, 0.0, 0.0)), |l| {
l.opacity = 0.4;
l.blend = BlendMode::Multiply;
l.overprint = true;
l.effects.push(Effect { id: "distort.roughen".into(), params: Value::Null, visible: true });
});
// A: two fills that draw, with a hidden one between them and an unpainted one above them.
set_rows(
&mut s,
a,
vec![
lower.clone(),
fill_row(Paint::solid(Color::rgb(0.0, 1.0, 0.0)), |l| l.visible = false),
fill_row(Paint::None, |_| {}),
stroke_row(Paint::None, 1.0, |_| {}),
],
);
// The top fill (and the stroke) become a gradient fitted to A's bounds.
let (want_fill, _) = paint_with_gradients(&mut s, a);
s.execute("select.set", &json!({"ids": [a.0, b.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let want = vec![lower, fill_row(want_fill, |_| {})];
let rows_within = |s: &Session, x0: f64, x1: f64| parts_within(s, g, x0, x1).0.iter().map(|f| f.appearance.items.clone()).collect::<Vec<_>>();
assert_eq!(rows_within(&s, 0.0, 50.0), vec![want.clone()], "A's face takes both fills that draw, the gradient at its fit on A");
let blue = vec![fill_row(Paint::solid(Color::rgb(0.0, 0.0, 1.0)), |_| {})];
assert_eq!(rows_within(&s, 50.0, 100.0), vec![blue], "B is in front");
s.execute("livePaint.expand", &json!({})).unwrap();
let expanded = node(&s, g);
assert!(!vectorcraft_tools::builder::is_live_paint(&expanded));
let kept =
expanded.children().unwrap().iter().filter(|c| c.geometric_bounds().is_some_and(|b| b.x1 <= 50.0 + 1e-6)).any(|c| c.appearance.items == want);
assert!(kept, "Expand keeps both fills");
s.execute("edit.undo", &json!({})).unwrap();
assert_eq!(rows_within(&s, 0.0, 50.0), vec![want.clone()]);
s.execute("edit.undo", &json!({})).unwrap();
s.execute("edit.redo", &json!({})).unwrap();
assert_eq!(rows_within(&s, 0.0, 50.0), vec![want]);
}
/// A face takes the fill rows of the front-most covering source whose fill draws: a source in
/// front whose fill is hidden or transparent, or whose opacity is 0, does not hide the paint of the
/// source behind it, and a face that no such source covers has no paint.
#[test]
fn live_paint_make_uses_frontmost_source_with_drawn_fill() {
for front in ["hidden", "clear", "transparent object"] {
let mut s = session();
let (a, b) = two(&mut s);
s.edit("t", |d, _| {
let n = d.node_mut(b).unwrap();
let mut app = (*n.appearance).clone();
match front {
"hidden" => app.fill_mut().unwrap().visible = false,
"clear" => app.fill_mut().unwrap().opacity = 0.0,
_ => n.opacity = 0.0,
}
n.appearance = app.into();
Ok(())
})
.unwrap();
s.execute("select.set", &json!({"ids": [a.0, b.0]})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let rows_within = |x0: f64, x1: f64| parts_within(&s, g, x0, x1).0.iter().map(|f| f.appearance.items.clone()).collect::<Vec<_>>();
let red = vec![fill_row(Paint::solid(Color::rgb(1.0, 0.0, 0.0)), |_| {})];
assert_eq!(rows_within(50.0, 100.0), vec![red], "{front}: the overlap shows A");
assert_eq!(rows_within(100.0, 150.0), vec![vec![fill_row(Paint::None, |_| {})]], "{front}: B alone paints nothing");
assert_eq!(parts_within(&s, g, 100.0, 150.0).0[0].opacity, 1.0, "{front}");
}
}
#[test]
fn live_paint_fill_assigns_the_face_under_the_point() {
let mut s = session();
@@ -2781,7 +3177,7 @@ fn live_paint_fill_same_paint_is_no_op() {
let mut before = snapshot(&s);
let click = s.execute("livePaint.fill", &json!({"group": g.0, "point": [75, 50], "color": "#00ff00"})).unwrap();
let face = vectorcraft_tools::builder::face_at(&node(&s, g), Point::new(75.0, 50.0)).unwrap().id;
assert_eq!(click, json!({"group": g.0, "face": face.0}), "the usual reply");
assert_eq!(click, json!({"group": g.0, "face": face.0, "count": 1}), "the usual reply");
assert_unchanged(&mut s, &mut before, "a click on a face with the paint");
s.execute("livePaint.fill", &drag).unwrap();
assert_unchanged(&mut s, &mut before, "a drag over faces with the paint");
@@ -2850,6 +3246,42 @@ fn live_paint_stroke_edge_same_paint_and_width_is_no_op() {
assert_eq!(history_state(&s).0, before.1.0 + 1);
}
/// With `scope`, faces and edges that already have the paint (and the width) are skipped: when
/// every face or edge the call reaches has it, nothing changes, and when some do, only the others
/// are painted, in one undo step. `count` is every face or edge reached.
#[test]
fn live_paint_scoped_fill_and_stroke_skip_parts_with_the_paint() {
let mut s = session();
let g = live(&mut s);
s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 50], "points": [[25, 50], [125, 50]], "color": "#00ff00"})).unwrap();
let edges =
s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [100, 50], "scope": "samePaint", "color": "#ff0000", "width": 3})).unwrap();
redo_waiting_and_saved(&mut s, g);
let mut before = snapshot(&s);
let same = json!({"group": g.0, "point": [75, 50], "scope": "samePaint", "color": "#00ff00"});
assert_eq!(s.execute("livePaint.fill", &same).unwrap()["count"], 3);
assert_unchanged(&mut s, &mut before, "a samePaint fill where every face has the paint");
let again = json!({"group": g.0, "point": [100, 50], "scope": "samePaint", "color": "#ff0000", "width": 3});
assert_eq!(s.execute("livePaint.strokeEdge", &again).unwrap()["count"], edges["count"]);
assert_unchanged(&mut s, &mut before, "a samePaint stroke where every edge has the paint and the width");
// One face of the three without the paint: only it is filled, in one undo step.
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let red = Paint::solid(Color::from_hex("#ff0000").unwrap());
s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 50], "color": "#ff0000"})).unwrap();
let depth = history_state(&s).0;
let like = serde_json::to_value(&green).unwrap();
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 50], "scope": "samePaint", "match": like, "color": "#00ff00"})).unwrap();
assert_eq!(r["count"], 3);
assert_eq!(history_state(&s).0, depth + 1);
let fill_at = |s: &Session, x: f64| vectorcraft_tools::builder::face_at(&node(s, g), Point::new(x, 50.0)).unwrap().appearance.fill_paint();
for x in [25.0, 75.0, 125.0] {
assert_eq!(fill_at(&s, x), green, "{x}");
}
s.execute("edit.undo", &json!({})).unwrap();
assert_eq!(fill_at(&s, 25.0), red);
assert_eq!((fill_at(&s, 75.0), fill_at(&s, 125.0)), (green.clone(), green));
}
#[test]
fn live_paint_gap_options_same_values_are_no_op() {
let mut s = session();
@@ -3012,6 +3444,472 @@ fn live_paint_fill_skips_hidden_faces() {
assert!(!node(&s, hidden).visible);
}
/// A Live Paint group of 50 pt squares side by side, 50 pt tall, with their left sides at each of
/// `xs`.
fn live_squares(s: &mut Session, xs: &[f64]) -> NodeId {
let ids: Vec<u64> = xs.iter().map(|&x| rect(s, x, 0.0, 50.0, 50.0).0).collect();
s.execute("select.set", &json!({"ids": ids})).unwrap();
NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap())
}
/// The ids of the faces of `g` that hold `p`, in the order given.
fn faces_at(s: &Session, g: NodeId, ps: &[(f64, f64)]) -> Vec<NodeId> {
ps.iter().map(|&(x, y)| vectorcraft_tools::builder::face_at(&node(s, g), Point::new(x, y)).unwrap().id).collect()
}
/// The edges of `g` whose bounds lie within `r`.
fn edges_in(s: &Session, g: NodeId, r: Rect) -> Vec<NodeId> {
let r = r.inflate(1e-6, 1e-6);
vectorcraft_tools::builder::edges(&node(s, g))
.iter()
.filter(|e| e.geometric_bounds().is_some_and(|bb| r.contains(Point::new(bb.x0, bb.y0)) && r.contains(Point::new(bb.x1, bb.y1))))
.map(|e| e.id)
.collect()
}
/// Give `ids` stroke paint `paint` at weight 1 (none: no stroke), and `fill` to the faces in `faces`.
fn paint_parts(s: &mut Session, ids: &[NodeId], paint: &Paint, faces: &[(NodeId, Paint)]) {
s.edit("t", |d, _| {
for id in ids {
let n = d.node_mut(*id).unwrap();
n.appearance.set_stroke(paint.clone());
if let Some(st) = n.appearance.stroke_mut() {
st.width = 1.0;
}
}
for (id, fill) in faces {
d.node_mut(*id).unwrap().appearance.set_fill(fill.clone());
}
Ok(())
})
.unwrap();
}
fn fill_of(s: &Session, id: NodeId) -> Paint {
node(s, id).appearance.fill_paint()
}
/// A double-click on a face fills it and the faces reached across edges that draw no stroke; a
/// stroked edge and a hidden face stop the flood.
#[test]
fn live_paint_bucket_double_click_floods_across_unstroked_edges() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0, 100.0, 150.0]);
let [a, b, c, d] = faces_at(&s, g, &[(25.0, 25.0), (75.0, 25.0), (125.0, 25.0), (175.0, 25.0)])[..] else { panic!("four faces") };
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 201.0, 51.0));
paint_parts(&mut s, &all, &Paint::None, &[]);
let stroked = edges_in(&s, g, Rect::new(150.0, 0.0, 150.0, 50.0));
assert!(!stroked.is_empty());
paint_parts(&mut s, &stroked, &Paint::solid(Color::rgb(0.0, 0.0, 0.0)), &[]);
let white = fill_of(&s, d);
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
assert_ne!(white, green);
let depth = s.doc().unwrap().history.undo.len();
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 25], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!((&r["face"], &r["count"]), (&json!(a.0), &json!(3)));
assert_eq!([a, b, c, d].map(|f| fill_of(&s, f)), [green.clone(), green.clone(), green.clone(), white.clone()]);
assert_eq!(s.doc().unwrap().history.undo.len(), depth + 1, "one undo step");
s.execute("edit.undo", &json!({})).unwrap();
assert!([a, b, c].iter().all(|f| fill_of(&s, *f) != green));
// A hidden face is not filled and does not pass the flood on.
s.execute("object.setProps", &json!({"ids": [b.0], "visible": false})).unwrap();
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 25], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!(r["count"], 1);
assert_eq!([a, b, c].map(|f| fill_of(&s, f) == green), [true, false, false]);
while s.doc().unwrap().history.undo.len() > depth {
s.execute("edit.undo", &json!({})).unwrap();
}
// The tool: two clicks and the double-click that follows them.
let v = ViewInfo::default();
s.select_tool("livePaintBucket", v).unwrap();
s.paint.fill = green.clone();
for kind in [PointerKind::Down, PointerKind::Up, PointerKind::Down, PointerKind::Up, PointerKind::DoubleClick] {
s.pointer(&PointerEvent::new(kind, 125.0, 25.0), v).unwrap();
}
assert_eq!([a, b, c, d].map(|f| fill_of(&s, f)), [green.clone(), green.clone(), green, white]);
}
/// An edge that draws no stroke (fully transparent, or with its stroke hidden) lets a flood across
/// although it stores a stroke paint, and an edge scope compares the stroke paint each edge draws
/// with.
#[test]
fn live_paint_bucket_scopes_follow_the_stroke_an_edge_draws() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0, 100.0]);
let black = Paint::solid(Color::rgb(0.0, 0.0, 0.0));
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 151.0, 51.0));
paint_parts(&mut s, &all, &black, &[]);
let clear = edges_in(&s, g, Rect::new(50.0, 0.0, 50.0, 50.0));
let hidden = edges_in(&s, g, Rect::new(100.0, 0.0, 100.0, 50.0));
assert!(!clear.is_empty() && !hidden.is_empty());
s.edit("t", |d, _| {
for id in &clear {
d.node_mut(*id).unwrap().opacity = 0.0;
}
for id in &hidden {
d.node_mut(*id).unwrap().appearance.stroke_mut().unwrap().visible = false;
}
Ok(())
})
.unwrap();
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 25], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!(r["count"], 3, "the flood crosses both middle edges");
s.execute("edit.undo", &json!({})).unwrap();
let stroke = |s: &mut Session, at: [f64; 2]| {
let r = s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": at, "color": "#00ff00", "width": 3, "scope": "samePaint"})).unwrap();
s.execute("edit.undo", &json!({})).unwrap();
r["count"].clone()
};
assert_eq!(stroke(&mut s, [25.0, 0.0]), json!(all.len() - clear.len() - hidden.len()), "the edges that draw black");
assert_eq!(stroke(&mut s, [50.0, 25.0]), json!(clear.len() + hidden.len()), "the edges that draw no stroke");
// With the top edge between them fully transparent too, the connected scope walks from the edge
// at x = 50 through it to the edge at x = 100, and reaches no edge that draws black.
let top = edges_in(&s, g, Rect::new(50.0, 0.0, 100.0, 0.0));
assert_eq!(top.len(), 1);
s.edit("t", |d, _| {
d.node_mut(top[0]).unwrap().opacity = 0.0;
Ok(())
})
.unwrap();
let r =
s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [50, 25], "color": "#00ff00", "width": 3, "scope": "connected"})).unwrap();
assert_eq!(r["count"], json!(clear.len() + top.len() + hidden.len()));
}
/// `livePaint.strokeEdge` paints an edge's topmost stroke that is shown, so the edge then draws
/// with the paint; an edge whose strokes are all hidden takes a new stroke above them. Painting
/// again changes nothing.
#[test]
fn live_paint_stroke_edge_paints_the_shown_stroke() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0]);
let black = Paint::solid(Color::rgb(0.0, 0.0, 0.0));
let red = Paint::solid(Color::rgb(1.0, 0.0, 0.0));
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 101.0, 51.0));
paint_parts(&mut s, &all, &black, &[]);
let middle = edges_in(&s, g, Rect::new(50.0, 0.0, 50.0, 50.0));
let left: Vec<NodeId> = edges_in(&s, g, Rect::new(0.0, 0.0, 50.0, 50.0)).into_iter().filter(|e| !middle.contains(e)).collect();
let (&[m], &[l]) = (&middle[..], &left[..]) else { panic!("one middle edge and one other edge round the left face") };
// The middle edge draws red under a hidden black stroke; every stroke of the left face's other
// edge is hidden.
s.edit("t", |d, _| {
let n = d.node_mut(m).unwrap();
n.appearance.items.insert(0, AppearanceItem::Stroke(vectorcraft_doc::appearance::StrokeLayer::new(red.clone(), 1.0)));
n.appearance.stroke_mut().unwrap().visible = false;
d.node_mut(l).unwrap().appearance.stroke_mut().unwrap().visible = false;
Ok(())
})
.unwrap();
let drawn = |s: &Session, id: NodeId| vectorcraft_tools::builder::lp_stroke_paint(&node(s, id));
assert_eq!(drawn(&s, m), red);
let paint = |s: &mut Session, at: [f64; 2]| {
s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": at, "color": "#00ff00", "width": 2})).unwrap();
};
for (id, at) in [(m, [50.0, 25.0]), (l, [0.0, 25.0])] {
paint(&mut s, at);
assert_eq!(drawn(&s, id), green, "{id}");
let depth = history_state(&s).0;
paint(&mut s, at);
assert_eq!(history_state(&s).0, depth, "painting {id} again");
}
assert_eq!(node(&s, m).appearance.items.len(), 2, "the hidden stroke stays as it was");
assert_eq!(node(&s, l).appearance.items.len(), 2, "a new stroke above the hidden one");
}
/// With Cmd held, the Live Paint Bucket's presses go to the selection tool Cmd lends, and the
/// double-click and triple-click that follow them paint nothing.
#[test]
fn live_paint_bucket_cmd_double_and_triple_click_paint_nothing() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0, 100.0]);
let faces = faces_at(&s, g, &[(25.0, 25.0), (75.0, 25.0), (125.0, 25.0)]);
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 151.0, 51.0));
paint_parts(&mut s, &all, &Paint::None, &[]);
let before: Vec<Paint> = faces.iter().map(|f| fill_of(&s, *f)).collect();
let v = ViewInfo::default();
s.select_tool("livePaintBucket", v).unwrap();
s.paint.fill = Paint::solid(Color::from_hex("#00ff00").unwrap());
let cmd = Mods { cmd: true, ..Default::default() };
let (down, up) = (PointerKind::Down, PointerKind::Up);
for kind in [down, up, down, up, PointerKind::DoubleClick, down, up, PointerKind::TripleClick] {
s.pointer(&PointerEvent::new(kind, 75.0, 25.0).with_mods(cmd), v).unwrap();
}
assert_eq!(faces.iter().map(|f| fill_of(&s, *f)).collect::<Vec<_>>(), before);
assert_eq!(s.tool_id(), "livePaintBucket");
}
/// The flood crosses curved edges, and reaches a face 0.012 pt wide.
#[test]
fn live_paint_bucket_double_click_floods_curved_and_narrow_faces() {
let mut s = session();
let ids: Vec<u64> = [0.0, 60.0]
.iter()
.map(|&x| s.execute("shape.ellipse", &json!({"x": x, "y": 0, "width": 100, "height": 100})).unwrap()["id"].as_u64().unwrap())
.collect();
s.execute("select.set", &json!({"ids": ids})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 161.0, 101.0));
paint_parts(&mut s, &all, &Paint::None, &[]);
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [20, 50], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!(r["count"], 3, "both lunes and the lens between them");
let mut s = session();
let ids = [rect(&mut s, 0.0, 0.0, 50.0, 50.0).0, rect(&mut s, 49.988, 0.0, 50.0, 50.0).0];
s.execute("select.set", &json!({"ids": ids})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let [a, sliver, c] = faces_at(&s, g, &[(25.0, 25.0), (49.994, 25.0), (75.0, 25.0)])[..] else { panic!("three faces") };
assert!(a != sliver && sliver != c);
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 101.0, 51.0));
paint_parts(&mut s, &all, &Paint::None, &[]);
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 25], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!(r["count"], 3);
assert_eq!([a, sliver, c].map(|f| fill_of(&s, f)), [green.clone(), green.clone(), green]);
}
/// The flood crosses a hidden edge, and an edge that a Gap Detection gap meets partway along, but
/// not the gap.
#[test]
fn live_paint_bucket_double_click_floods_across_hidden_edges_and_past_gaps() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0]);
let black = Paint::solid(Color::rgb(0.0, 0.0, 0.0));
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 101.0, 51.0));
paint_parts(&mut s, &all, &black, &[]);
let fill = |s: &mut Session, g: NodeId, at: [f64; 2]| {
s.execute("livePaint.fill", &json!({"group": g.0, "point": at, "color": "#00ff00", "scope": "connected"})).unwrap()["count"].clone()
};
assert_eq!(fill(&mut s, g, [25.0, 25.0]), 1, "a stroked edge stops the flood");
s.execute("edit.undo", &json!({})).unwrap();
let middle = edges_in(&s, g, Rect::new(50.0, 0.0, 50.0, 50.0));
s.execute("object.setProps", &json!({"ids": middle.iter().map(|e| e.0).collect::<Vec<_>>(), "visible": false})).unwrap();
assert_eq!(fill(&mut s, g, [25.0, 25.0]), 2, "a hidden edge does not");
// Square B (100..200 by 0..100) over square C (100..200 by 100..200), and a line down the middle
// of B that stops 2 pt short of their shared edge: Gap Detection closes it, so B is two faces
// that each run along part of the shared edge, which is one edge segment.
let mut s = session();
let mut ids = vec![rect(&mut s, 100.0, 0.0, 100.0, 100.0).0, rect(&mut s, 100.0, 100.0, 100.0, 100.0).0];
let line = s.execute("path.create", &json!({"anchors": [{"x": 150, "y": 0}, {"x": 150, "y": 98}]})).unwrap();
ids.push(line["id"].as_u64().unwrap());
s.execute("select.set", &json!({"ids": ids})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
s.execute("livePaint.gapOptions", &json!({"id": g.0, "detect": true, "size": "small"})).unwrap();
let [b1, b2, c] = faces_at(&s, g, &[(125.0, 50.0), (175.0, 50.0), (150.0, 150.0)])[..] else { panic!("three faces") };
assert!(b1 != b2 && b2 != c && b1 != c);
let all = edges_in(&s, g, Rect::new(99.0, -1.0, 201.0, 201.0));
paint_parts(&mut s, &all, &black, &[]);
let shared = edges_in(&s, g, Rect::new(100.0, 100.0, 200.0, 100.0));
assert!(!shared.is_empty());
paint_parts(&mut s, &shared, &Paint::None, &[]);
assert_eq!(fill(&mut s, g, [150.0, 150.0]), 3, "from C across the shared edge to both faces of B");
s.execute("edit.undo", &json!({})).unwrap();
// With the line and the shared edge stroked, only the gap lies between the two faces of B.
paint_parts(&mut s, &shared, &black, &[]);
assert_eq!(fill(&mut s, g, [125.0, 50.0]), 1, "the flood does not pass the gap");
// B alone, its outline drawing no stroke and the line stroked: the two faces of B run along
// different parts of the outline's bottom segment, on the same side, and the flood does not
// join them there.
let mut s = session();
let mut ids = vec![rect(&mut s, 100.0, 0.0, 100.0, 100.0).0];
let line = s.execute("path.create", &json!({"anchors": [{"x": 150, "y": 0}, {"x": 150, "y": 98}]})).unwrap();
ids.push(line["id"].as_u64().unwrap());
s.execute("select.set", &json!({"ids": ids})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
s.execute("livePaint.gapOptions", &json!({"id": g.0, "detect": true, "size": "small"})).unwrap();
assert_eq!(vectorcraft_tools::builder::faces(&node(&s, g)).len(), 2);
let all = edges_in(&s, g, Rect::new(99.0, -1.0, 201.0, 101.0));
paint_parts(&mut s, &all, &Paint::None, &[]);
let line = edges_in(&s, g, Rect::new(150.0, 0.0, 150.0, 98.0));
assert!(!line.is_empty() && line.len() < all.len());
paint_parts(&mut s, &line, &black, &[]);
assert_eq!(fill(&mut s, g, [125.0, 50.0]), 1, "the gap parts the two faces along the bottom");
}
/// The flood crosses an edge into each face along it when a face's outline runs along the edge in
/// one segment and the edge is split where another line meets it.
#[test]
fn live_paint_bucket_double_click_floods_along_edges_split_at_a_junction() {
// A square with a line across its middle, and a line from the top at x = 30 that crosses it and
// stops 20 pt below. The bottom face's outline runs along the middle line in one segment, from
// x = 0 to 100; the middle line's edges are split at x = 30.
let mut s = session();
let mut ids = vec![rect(&mut s, 0.0, 0.0, 100.0, 100.0).0];
for anchors in [json!([{"x": 0, "y": 50}, {"x": 100, "y": 50}]), json!([{"x": 30, "y": 0}, {"x": 30, "y": 70}])] {
ids.push(s.execute("path.create", &json!({ "anchors": anchors })).unwrap()["id"].as_u64().unwrap());
}
s.execute("select.set", &json!({"ids": ids})).unwrap();
let g = NodeId(s.execute("livePaint.make", &json!({})).unwrap()["id"].as_u64().unwrap());
let [left, right, bottom] = faces_at(&s, g, &[(15.0, 25.0), (65.0, 25.0), (65.0, 75.0)])[..] else { panic!("three faces") };
assert!(left != right && right != bottom && left != bottom);
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 101.0, 101.0));
paint_parts(&mut s, &all, &Paint::None, &[]);
let down = edges_in(&s, g, Rect::new(30.0, 0.0, 30.0, 70.0));
assert!(!down.is_empty() && down.len() < all.len());
paint_parts(&mut s, &down, &Paint::solid(Color::rgb(0.0, 0.0, 0.0)), &[]);
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [65, 75], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!(r["count"], 3, "from the bottom face to both faces above the line");
assert_eq!([left, right, bottom].map(|f| fill_of(&s, f)), [green.clone(), green.clone(), green.clone()]);
s.execute("edit.undo", &json!({})).unwrap();
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [15, 25], "color": "#00ff00", "scope": "connected"})).unwrap();
assert_eq!(r["count"], 3, "from the upper left face down to the bottom face and up again");
}
/// A triple-click on a face fills every face of the group with that face's fill, joined to it or
/// not. Through the tool, the fill compared is the face's fill before the first click.
#[test]
fn live_paint_bucket_triple_click_fills_every_face_of_the_same_fill() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0, 100.0, 150.0]);
let [a, b, c, d] = faces_at(&s, g, &[(25.0, 25.0), (75.0, 25.0), (125.0, 25.0), (175.0, 25.0)])[..] else { panic!("four faces") };
let (red, blue) = (Paint::solid(Color::rgb(1.0, 0.0, 0.0)), Paint::solid(Color::rgb(0.0, 0.0, 1.0)));
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let all = edges_in(&s, g, Rect::new(-1.0, -1.0, 201.0, 51.0));
paint_parts(&mut s, &all, &Paint::None, &[(a, red.clone()), (b, blue.clone()), (c, red.clone()), (d, red.clone())]);
let stroked = edges_in(&s, g, Rect::new(100.0, 0.0, 100.0, 50.0));
paint_parts(&mut s, &stroked, &Paint::solid(Color::rgb(0.0, 0.0, 0.0)), &[]);
let depth = s.doc().unwrap().history.undo.len();
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [25, 25], "color": "#00ff00", "scope": "samePaint"})).unwrap();
assert_eq!(r["count"], 3);
assert_eq!([a, b, c, d].map(|f| fill_of(&s, f)), [green.clone(), blue.clone(), green.clone(), green.clone()]);
s.execute("edit.undo", &json!({})).unwrap();
// The tool: the first click fills the face, the double-click floods across x = 50 into B, and
// the triple-click fills the faces that were red.
let v = ViewInfo::default();
s.select_tool("livePaintBucket", v).unwrap();
s.paint.fill = green.clone();
for kind in [
PointerKind::Down,
PointerKind::Up,
PointerKind::Down,
PointerKind::Up,
PointerKind::DoubleClick,
PointerKind::Down,
PointerKind::Up,
PointerKind::TripleClick,
] {
s.pointer(&PointerEvent::new(kind, 25.0, 25.0), v).unwrap();
}
assert_eq!([a, b, c, d].map(|f| fill_of(&s, f)), [green.clone(), green.clone(), green.clone(), green.clone()]);
// A match given by the caller is the fill compared.
while s.doc().unwrap().history.undo.len() > depth {
s.execute("edit.undo", &json!({})).unwrap();
}
assert_eq!([a, b, c, d].map(|f| fill_of(&s, f)), [red.clone(), blue.clone(), red.clone(), red.clone()]);
let r = s
.execute(
"livePaint.fill",
&json!({"group": g.0, "point": [25, 25], "color": "#00ff00", "scope": "samePaint", "match": serde_json::to_value(&blue).unwrap()}),
)
.unwrap();
assert_eq!(r["count"], 2);
assert_eq!([a, b, c, d].map(|f| fill_of(&s, f)), [green.clone(), green, red.clone(), red]);
}
/// A triple-click whose first click makes the Live Paint group from the selected paths matches the
/// fill the face was made with.
#[test]
fn live_paint_bucket_triple_click_after_making_the_group_matches_the_made_fill() {
let mut s = session();
let ids: Vec<NodeId> = [0.0, 100.0, 200.0].iter().map(|&x| rect(&mut s, x, 0.0, 50.0, 50.0)).collect();
let (red, blue) = (Color::rgb(1.0, 0.0, 0.0), Color::rgb(0.0, 0.0, 1.0));
for (id, c) in ids.iter().zip([red, red, blue]) {
set_fill(&mut s, *id, c);
}
s.execute("select.set", &json!({"ids": ids.iter().map(|i| i.0).collect::<Vec<_>>()})).unwrap();
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let v = ViewInfo::default();
s.select_tool("livePaintBucket", v).unwrap();
s.paint.fill = green.clone();
for kind in [
PointerKind::Down,
PointerKind::Up,
PointerKind::Down,
PointerKind::Up,
PointerKind::DoubleClick,
PointerKind::Down,
PointerKind::Up,
PointerKind::TripleClick,
] {
s.pointer(&PointerEvent::new(kind, 25.0, 25.0), v).unwrap();
}
let g = vectorcraft_tools::builder::live_paint_at(&s.doc().unwrap().doc, Point::new(25.0, 25.0)).expect("the clicks made a group");
let faces = faces_at(&s, g, &[(25.0, 25.0), (125.0, 25.0), (225.0, 25.0)]);
assert_eq!(faces.iter().map(|f| fill_of(&s, *f)).collect::<Vec<_>>(), [green.clone(), green, Paint::solid(blue)]);
}
/// A double-click on an edge paints the edges joined to it that have its stroke, and a
/// triple-click every edge of the group with that stroke; an edge with another stroke is left.
#[test]
fn live_paint_bucket_double_and_triple_click_paint_joined_and_same_stroke_edges() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0, 200.0]);
let black = Paint::solid(Color::rgb(0.0, 0.0, 0.0));
let red = Paint::solid(Color::rgb(1.0, 0.0, 0.0));
let green = Paint::solid(Color::from_hex("#00ff00").unwrap());
let joined = edges_in(&s, g, Rect::new(0.0, 0.0, 100.0, 50.0));
let apart = edges_in(&s, g, Rect::new(200.0, 0.0, 250.0, 50.0));
let middle = edges_in(&s, g, Rect::new(50.0, 0.0, 50.0, 50.0));
assert!(!apart.is_empty() && !middle.is_empty());
paint_parts(&mut s, &joined, &black, &[]);
paint_parts(&mut s, &apart, &black, &[]);
paint_parts(&mut s, &middle, &red, &[]);
let stroke = |s: &Session, ids: &[NodeId]| ids.iter().map(|id| node(s, *id).appearance.stroke_paint()).collect::<Vec<_>>();
let outer: Vec<NodeId> = joined.iter().copied().filter(|e| !middle.contains(e)).collect();
let r =
s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [25, 0], "color": "#00ff00", "width": 3, "scope": "connected"})).unwrap();
assert_eq!(r["count"], outer.len());
assert!(stroke(&s, &outer).iter().all(|p| *p == green));
assert!(outer.iter().all(|e| node(&s, *e).appearance.stroke_width() == 3.0));
assert!(stroke(&s, &middle).iter().all(|p| *p == red), "another stroke is left");
assert!(stroke(&s, &apart).iter().all(|p| *p == black), "edges not joined are left");
s.execute("edit.undo", &json!({})).unwrap();
let r = s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [25, 0], "color": "#00ff00", "scope": "samePaint"})).unwrap();
assert_eq!(r["count"], outer.len() + apart.len());
assert!(stroke(&s, &outer).iter().chain(&stroke(&s, &apart)).all(|p| *p == green));
assert!(stroke(&s, &middle).iter().all(|p| *p == red));
// A hidden edge is not painted.
s.execute("edit.undo", &json!({})).unwrap();
s.execute("object.setProps", &json!({"ids": [apart[0].0], "visible": false})).unwrap();
let r = s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [25, 0], "color": "#00ff00", "scope": "samePaint"})).unwrap();
assert_eq!(r["count"], outer.len() + apart.len() - 1);
assert_eq!(node(&s, apart[0]).appearance.stroke_paint(), black);
}
/// A `scope` that is not one of the three, a `match` that is not a paint or is given with a scope
/// that compares none, and a scope with a drag's points are refused; nothing changes.
#[test]
fn live_paint_scope_and_match_are_checked() {
let mut s = session();
let g = live(&mut s);
let none = serde_json::to_value(Paint::None).unwrap();
let before = s.doc().unwrap().doc.clone();
let depth = s.doc().unwrap().history.undo.len();
for (cmd, p) in [
("livePaint.fill", json!({"group": g.0, "point": [75, 50], "scope": "all"})),
("livePaint.fill", json!({"group": g.0, "point": [75, 50], "scope": 2})),
("livePaint.fill", json!({"group": g.0, "point": [75, 50], "match": none})),
("livePaint.fill", json!({"group": g.0, "point": [75, 50], "scope": "connected", "match": none})),
("livePaint.fill", json!({"group": g.0, "point": [75, 50], "scope": "samePaint", "match": "red"})),
("livePaint.fill", json!({"group": g.0, "point": [75, 50], "scope": "connected", "points": [[75, 50], [125, 50]]})),
("livePaint.strokeEdge", json!({"group": g.0, "point": [100, 50], "scope": "Connected"})),
("livePaint.strokeEdge", json!({"group": g.0, "point": [100, 50], "scope": "one", "match": none})),
("livePaint.strokeEdge", json!({"group": g.0, "point": [100, 50], "scope": "samePaint", "match": {"type": "plaid"}})),
] {
assert!(s.execute(cmd, &p).is_err(), "{cmd} {p}");
}
assert_eq!(s.doc().unwrap().doc, before);
assert_eq!(s.doc().unwrap().history.undo.len(), depth);
// "one" and null are a click's scope.
for scope in [json!("one"), Value::Null] {
let r = s.execute("livePaint.fill", &json!({"group": g.0, "point": [75, 50], "scope": scope})).unwrap();
assert_eq!(r["count"], 1);
}
}
#[test]
fn live_paint_release_and_expand() {
let mut s = session();
+20 -1
View File
@@ -1,6 +1,6 @@
//! Width points, Liquify, Puppet Warp and Perspective Grid commands and tools.
use serde_json::json;
use serde_json::{Value, json};
use vectorcraft_geom::{PathData, Point, Rect, Shape};
use vectorcraft_tools::distort::perspective::{PerspectiveGrid, Plane};
use vectorcraft_tools::{Mods, PointerEvent, PointerKind, ToolKey};
@@ -625,6 +625,25 @@ fn attach_projects_onto_the_plane_and_releases() {
assert_eq!(path(&s, a).bounds().unwrap(), Rect::new(450.0, 300.0, 550.0, 400.0));
}
#[test]
fn a_repeated_id_attaches_moves_and_transforms_an_object_once() {
let edited = |cmd: &str, ids: &[u64], extra: Value| {
let mut s = session();
s.execute("perspective.grid.preset", &json!({"kind": 2})).unwrap();
let a = rect(&mut s, 450.0, 300.0, 100.0, 100.0);
let ids: Vec<u64> = ids.iter().map(|_| a.0).collect();
let mut p = json!({"ids": ids, "plane": "right"});
p.as_object_mut().unwrap().extend(extra.as_object().unwrap().clone());
s.execute(cmd, &p).unwrap();
path(&s, a)
};
let moved = json!({"from": [480.0, 330.0], "to": [500.0, 350.0], "constrain": true});
let scaled = json!({"matrix": [1.5, 0.0, 0.0, 1.5, 10.0, 0.0]});
for (cmd, extra) in [("perspective.attach", json!({})), ("perspective.move", moved), ("perspective.transform", scaled)] {
assert_eq!(edited(cmd, &[0, 0], extra.clone()), edited(cmd, &[0], extra), "{cmd}");
}
}
#[test]
fn rectangle_tool_draws_in_perspective_on_the_active_plane() {
let mut s = session();
+3 -2
View File
@@ -219,9 +219,10 @@ fn rotate_reflect_and_scale_carry_unplaced_gradients() {
s.execute("object.rotate", &json!({"angle": 90})).unwrap();
let g = fill_geom(&s, id);
assert!((g.end.x - g.start.x).abs() < 1e-9 && (g.length() - 100.0).abs() < 1e-9, "vertical after a 90° turn: {g:?}");
s.execute("object.reflect", &json!({"axis": "horizontal"})).unwrap();
s.execute("object.reflect", &json!({"axis": "horizontal", "basis": "page"})).unwrap();
let r = fill_geom(&s, id);
// The vertical vector is centred on the object, so the reflection swaps its ends.
// The vertical vector is centred on the object, so the reflection across the page's
// horizontal axis swaps its ends.
assert!(r.start.distance(g.end) < 1e-9 && r.end.distance(g.start) < 1e-9, "{g:?} → {r:?}");
// A circle's radial gradient becomes an ellipse under a non-uniform scale.
+1 -1
View File
@@ -406,7 +406,7 @@ fn a_batch_step_records_what_it_took_from_the_preferences() {
]);
s.execute("command.batch", &json!({ "commands": steps })).unwrap();
let p = &s.journal.last().unwrap().1;
assert_eq!(p["commands"][2]["params"], json!({"sx": 300, "strokes": true, "corners": false}));
assert_eq!(p["commands"][2]["params"], json!({"sx": 300, "strokes": true, "corners": false, "basis": "box"}));
// Replayed with other preferences, the scale still scales the stroke.
let r = replayed(&s);
assert!(!r.prefs.scale_strokes);
+1
View File
@@ -1700,6 +1700,7 @@ fn filters_set_effects_and_stroke_styles() {
("test.engine.badn", json!([{"id": "plugin.test.engine.fx", "params": {"n": "two"}}]), "`n`"),
("test.engine.file", json!([{"id": "distort.glass", "params": {"textureImage": {"path": "/etc/hosts"}}}]), "textureImage"),
("test.engine.file2", json!([{"id": "texture.texturizer", "params": {"textureImage": {"path": "/etc/hosts"}}}]), "textureImage"),
("test.engine.file3", json!([{"id": "artistic.roughPastels", "params": {"textureImage": {"path": "/etc/hosts"}}}]), "textureImage"),
("test.engine.two3d", json!([{"id": "threeD.extrude"}, {"id": "threeD.extrude"}]), "one 3D effect"),
] {
let e = filter(&mut s, name, fx).unwrap_err().to_string();
+53 -4
View File
@@ -143,19 +143,22 @@ fn listed_applied_edited_and_undone() {
}
}
// Numbers far out of range are stored as given and read clamped; the canvas still draws.
// Radial Blur's Blur Center is refused outside 0 to 1 instead.
let center = |id: &str, k: &str| id == "blur.radial" && matches!(k, "centerX" | "centerY");
for (id, _) in EFFECTS {
let defaults = vectorcraft_render::effects::default_params(id).unwrap();
let junk: serde_json::Map<String, Value> = defaults
.as_object()
.unwrap()
.iter()
.filter(|(_, v)| v.is_number())
.filter(|(k, v)| v.is_number() && !center(id, k))
.enumerate()
.map(|(i, (k, _))| (k.clone(), json!(if i % 2 == 0 { 1e308 } else { -1e308 })))
.collect();
assert!(!junk.is_empty(), "{id}");
s.execute("effect.apply", &json!({"effect": id, "ids": [g], "params": junk})).unwrap();
}
assert!(s.execute("effect.apply", &json!({"effect": "blur.radial", "ids": [g], "params": {"centerX": 1e308}})).is_err());
let _ = render(&s);
let n = s.doc().unwrap().doc.node(NodeId(g)).unwrap().clone();
assert_eq!(n.appearance.effects.len(), 3);
@@ -320,8 +323,7 @@ fn glass_loads_a_texture_saves_it_and_draws_it() {
assert_eq!(doc.node(NodeId(g)).unwrap().appearance.effects[0].params, glass_params(&s, g));
assert_eq!(Renderer::new().render_region(&doc, Rect::new(0.0, 0.0, 200.0, 200.0), 1.0, true).pixels, loaded.pixels);
// The same file by path, through Effect Options, stores the same texture.
let dir = std::env::temp_dir().join(format!("vc-glass-texture-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let dir = vectorcraft_testkit::TempDir::new("glass-texture");
let path = dir.join("rings.png");
std::fs::write(&path, &png).unwrap();
let (mut t, h) = striped();
@@ -331,7 +333,7 @@ fn glass_loads_a_texture_saves_it_and_draws_it() {
assert_eq!(glass_params(&t, h)["textureImage"], json!(stored));
assert_eq!(glass_params(&t, h)["texture"], json!("loaded"));
assert_eq!(render(&t).pixels, loaded.pixels);
let _ = std::fs::remove_dir_all(&dir);
drop(dir);
// The stored string is taken as it is (as effect.list gives it, and a graphic style copies it).
t.execute("effect.apply", &json!({"effect": "distort.glass", "ids": [h], "params": {"textureImage": stored, "texture": "frosted"}})).unwrap();
let second = t.doc().unwrap().doc.node(NodeId(h)).unwrap().appearance.effects[1].params.clone();
@@ -388,6 +390,53 @@ fn texturizer_loads_a_texture_and_draws_it() {
assert_eq!(Renderer::new().render_region(&doc, Rect::new(0.0, 0.0, 200.0, 200.0), 1.0, true).pixels, loaded.pixels);
}
/// Effect › Artistic › Rough Pastels › Load Texture: an image file, given as bytes or by path, is
/// stored with the effect and picked; it draws as the surface, a save and open keeps it, a file
/// that isn't an image is refused without a change, and undo takes it away.
#[test]
fn rough_pastels_loads_a_texture_saves_it_and_draws_it() {
let png = rings_png();
let data = vectorcraft_format::base64_encode(&png);
let (mut s, g) = striped();
let file = json!({"name": "rings.png", "dataBase64": data});
s.execute("effect.apply", &json!({"effect": "artistic.roughPastels", "ids": [g], "params": {"relief": 20, "textureImage": file}})).unwrap();
let p = glass_params(&s, g);
assert_eq!(p["texture"], json!("loaded"), "loading a texture picks it");
let stored = p["textureImage"].as_str().unwrap().to_string();
assert_eq!(vectorcraft_render::effects::pixel::texture(&stored).unwrap().size(), (12, 10));
let loaded = render(&s);
for (_, builtin) in vectorcraft_render::effects::pixel::TEXTURES {
s.execute("effect.setParams", &json!({"index": 0, "ids": [g], "params": {"texture": builtin}})).unwrap();
assert!(mean_diff(&loaded, &render(&s)) > 0.001, "{builtin}");
}
s.execute("effect.setParams", &json!({"index": 0, "ids": [g], "params": {"texture": "loaded"}})).unwrap();
assert_eq!(render(&s).pixels, loaded.pixels, "the texture stayed with the effect");
let doc = vectorcraft_format::load(&vectorcraft_format::save(&s.doc().unwrap().doc, false)).unwrap();
assert_eq!(doc.node(NodeId(g)).unwrap().appearance.effects[0].params, glass_params(&s, g));
assert_eq!(Renderer::new().render_region(&doc, Rect::new(0.0, 0.0, 200.0, 200.0), 1.0, true).pixels, loaded.pixels);
// A file that isn't an image changes nothing.
let junk = vectorcraft_format::base64_encode(b"not an image");
let before = glass_params(&s, g);
let e = s.execute("effect.setParams", &json!({"index": 0, "ids": [g], "params": {"textureImage": {"dataBase64": junk}}})).unwrap_err();
assert!(e.to_string().contains("textureImage"), "{e}");
let e = s.execute("effect.setParams", &json!({"index": 0, "ids": [g], "params": {"textureImage": 5}})).unwrap_err();
assert!(e.to_string().contains("textureImage"), "{e}");
assert_eq!(glass_params(&s, g), before);
// The same file by path, through Effect Options, stores the same texture; undo takes it away.
let dir = vectorcraft_testkit::TempDir::new("rough-pastels-texture");
let path = dir.join("rings.png");
std::fs::write(&path, &png).unwrap();
let (mut t, h) = striped();
t.execute("effect.apply", &json!({"effect": "artistic.roughPastels", "ids": [h], "params": {"relief": 20}})).unwrap();
assert!(glass_params(&t, h).get("textureImage").is_none());
t.execute("effect.setParams", &json!({"index": 0, "ids": [h], "params": {"textureImage": {"path": path.to_string_lossy()}}})).unwrap();
drop(dir);
assert_eq!((&glass_params(&t, h)["textureImage"], &glass_params(&t, h)["texture"]), (&json!(stored), &json!("loaded")));
assert_eq!(render(&t).pixels, loaded.pixels);
t.execute("edit.undo", &json!({})).unwrap();
assert!(glass_params(&t, h).get("textureImage").is_none(), "undone");
}
#[test]
fn spin_blur_reaches_past_the_corners() {
let (mut s, g) = striped();
+1 -1
View File
@@ -216,7 +216,7 @@ fn the_journal_records_the_scale_options_used() {
run(&mut s, "object.scale", json!({"sx": 150}));
let (cmd, p) = s.journal.last().unwrap().clone();
assert_eq!(cmd, "object.scale");
assert_eq!(p, json!({"sx": 150, "strokes": false, "corners": true}));
assert_eq!(p, json!({"sx": 150, "strokes": false, "corners": true, "basis": "box"}));
// An explicit value stays; moves don't scale, so they record nothing.
run(&mut s, "object.scale", json!({"sx": 150, "strokes": true}));
assert_eq!(s.journal.last().unwrap().1["strokes"], json!(true));
+290 -80
View File
@@ -2284,7 +2284,7 @@ fn a_variable_library_defines_text_variables_and_data_sets() {
assert_eq!(r["variables"], json!(["Name", "Note"]));
assert_eq!((r["deleted"].clone(), r["deletedDataSets"].clone()), (json!([]), json!([])));
assert_eq!(r["names"], json!(["Row 1", "Row 2"]));
assert_eq!((r["skipped"].clone(), r.get("warning")), (json!([]), None));
assert_eq!((r.get("skipped"), r.get("warning")), (None, None));
let listed = s.execute("variable.list", &json!({})).unwrap();
assert_eq!(listed["variables"], json!([{"name": "Name", "kind": "text", "bindings": 0}, {"name": "Note", "kind": "text", "bindings": 0}]));
let sets = s.execute("dataset.list", &json!({})).unwrap();
@@ -2405,13 +2405,14 @@ fn an_import_or_library_load_that_changes_nothing_records_no_undo_step() {
s.execute("variable.loadLibrary", &json!({"xml": other})).unwrap();
assert_eq!(super::history(&s), (undo + 1, 0, true));
// While the variables are locked, a library without text variables still loads its data sets,
// and loading it again changes nothing.
// While the variables are locked, a library of the variables the document has, with their
// kinds, still loads its data sets, and loading it again changes nothing.
let mut s = session();
let t = text(&mut s, "Alice");
s.execute("variable.lock", &json!({"locked": true})).unwrap();
let xml = library(&[("Shown", "other")], &[("B", &[])]);
s.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
s.execute("variable.lock", &json!({"locked": true})).unwrap();
s.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
super::select_with_a_step_to_redo(&mut s, &[t]);
let before = super::history(&s);
s.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
@@ -2432,22 +2433,89 @@ fn a_refused_variable_library_deletes_nothing() {
assert_eq!(s.doc().unwrap().doc.variables, before);
}
/// A library's variables of other kinds are left out with their values, named in `skipped` and
/// in a warning that gives each kind once with its count; its text variables load.
/// A library of every kind, in the layout the public grammar gives: visibility (`visibility`),
/// image (`fileref`) and graph (`graphdata`) variables beside a text variable, a variable without a
/// `trait` and one whose `trait` VectorCraft doesn't know, with values in the forms
/// [`a_variable_library_defines_every_kind_with_its_values`] reads.
fn every_kind_library() -> String {
"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n\
<!DOCTYPE svg [<!ENTITY ns_vars \"http://ns.adobe.com/Variables/1.0/\"><!ENTITY ns_custom \"http://ns.adobe.com/GenericCustomNamespace/1.0/\">]>\n\
<svg><variableSets xmlns=\"&ns_vars;\"><variableSet varSetName=\"binding1\" locked=\"none\"><variables>\
<variable varName=\"Name\" trait=\"textcontent\"/><variable varName=\"Shown\" trait=\"visibility\"/>\
<variable varName=\"Photo\" trait=\"fileref\"/><variable varName=\"Chart\" trait=\"graphdata\"/>\
<variable varName=\"Loose\"/><variable varName=\"Odd\" trait=\"somethingelse\"/></variables>\
<v:sampleDataSets xmlns:v=\"&ns_vars;\" xmlns=\"&ns_custom;\">\
<v:sampleDataSet dataSetName=\"A\"><Name><p>Bravo</p></Name><Shown>true</Shown>\
<Photo>\n\t\tfile:////Users/me/Art%20Work/logo%23one.png\n\t\t</Photo>\
<Chart><data numDataColumns=\"3\"><propertyRow key=\"name\"><value></value><value type=\"string\">North</value><value type=\"string\">South</value></propertyRow>\
<values><row><value key=\"name\" type=\"string\">Q1</value><value>10</value><value>2.5</value></row>\
<row><value key=\"name\">2024</value><value></value><value>-4</value></row></values></data></Chart>\
<Loose></Loose><Odd>ignored</Odd></v:sampleDataSet>\
<v:sampleDataSet dataSetName=\"B\"><Shown> FALSE </Shown><Photo>C:\\Art\\logo.png</Photo>\
<Chart><data numDataColumns=\"2\"><values><row><value key=\"name\"></value><value>7</value><value>8</value></row></values></data></Chart></v:sampleDataSet>\
<v:sampleDataSet dataSetName=\"C\"><Shown/><Photo> </Photo><Chart>\n</Chart></v:sampleDataSet>\
</v:sampleDataSets></variableSet></variableSets></svg>\n"
.to_string()
}
/// Load Variable Library defines a library's variables of every kind, unbound, with their values:
/// a visibility value from `true` or `false` in any case, an image value from a file's absolute
/// path or a `file:` URL (escapes decoded, the white space round it left out, the file not read),
/// and a graph value from a `data` element, as the CSV Graph Data takes (series from its
/// `propertyRow`, a category from each row's `key="name"` value, blanks where a row has no
/// number). A variable without a `trait`, or with one VectorCraft doesn't know, is defined of
/// unknown kind, without values. An element holding only white space gives no value.
#[test]
fn a_variable_library_leaves_out_variables_that_are_not_text() {
fn a_variable_library_defines_every_kind_with_its_values() {
let mut s = session();
let xml = library(
&[("Shown", "kindB"), ("Name", "textcontent"), ("Photo", "kindC"), ("Other", "kindB")],
&[("A", &[("Shown", &["true"]), ("Name", &["Bravo"]), ("Photo", &["a.png"])])],
);
let r = s.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
assert_eq!(r["variables"], json!(["Name"]));
assert_eq!(r["skipped"], json!([{"name": "Shown", "trait": "kindB"}, {"name": "Photo", "trait": "kindC"}, {"name": "Other", "trait": "kindB"}]));
assert_eq!(r["warning"], "variables that aren't text were left out: kindB (2), kindC (1)");
let r = s.execute("variable.loadLibrary", &json!({"xml": every_kind_library()})).unwrap();
assert_eq!(r["variables"], json!(["Name", "Shown", "Photo", "Chart", "Loose", "Odd"]));
let vars = &s.doc().unwrap().doc.variables;
assert_eq!(vars.variables.len(), 1);
assert_eq!(vars.dataset("A").map(|d| d.values.len()), Some(1));
let kinds: Vec<(&str, &str)> = vars.variables.iter().map(|v| (v.name.as_str(), v.kind.label())).collect();
assert_eq!(kinds, [("Name", "text"), ("Shown", "visibility"), ("Photo", "image"), ("Chart", "graph"), ("Loose", "unknown"), ("Odd", "unknown")]);
assert!(vars.bindings.is_empty());
use vectorcraft_doc::DataValue::{Graph, Image, Text, Visible};
let a = &vars.dataset("A").unwrap().values;
assert_eq!(a.get("Name"), Some(&Text("Bravo".into())));
assert_eq!(a.get("Shown"), Some(&Visible(true)));
assert_eq!(a.get("Photo"), Some(&Image("/Users/me/Art Work/logo#one.png".into())));
assert_eq!(a.get("Chart"), Some(&Graph(",North,South\nQ1,10,2.5\n\"2024\",,-4".into())));
assert_eq!((a.get("Loose"), a.get("Odd")), (None, None));
let b = &vars.dataset("B").unwrap().values;
assert_eq!((b.get("Shown"), b.get("Photo")), (Some(&Visible(false)), Some(&Image("C:\\Art\\logo.png".into()))));
assert_eq!(b.get("Chart"), Some(&Graph(",,\n7,8".into())));
assert!(vars.dataset("C").unwrap().values.is_empty(), "{:?}", vars.dataset("C"));
}
/// A library's visibility, image and graph variables drive the art they are bound to: a variable
/// the document already has with the same name and kind stays bound (#4136), so selecting a
/// library's data set shows or hides the object, swaps the linked image's path and replaces the
/// graph's data. A variable of the same name and another kind is replaced, and its bindings go.
#[test]
fn a_variable_library_keeps_bound_variables_of_every_kind() {
let mut s = session();
let r = rect(&mut s);
let graph = s.execute("graph.create", &json!({"type": "column", "x": 10, "y": 10, "width": 120, "height": 80, "csv": ",a\nX,1"})).unwrap()["id"]
.as_u64()
.unwrap();
for (name, kind, id) in [("Shown", "visibility", r.0), ("Chart", "graph", graph), ("Photo", "text", r.0)] {
s.execute("variable.define", &json!({"name": name, "kind": kind})).unwrap();
if kind != "text" {
s.execute("variable.bind", &json!({"variable": name, "ids": [id]})).unwrap();
}
}
let loaded = s.execute("variable.loadLibrary", &json!({"xml": every_kind_library()})).unwrap();
assert_eq!(loaded["deleted"], json!(["Photo"]), "Photo is an image variable in the library");
let listed = s.execute("variable.list", &json!({})).unwrap();
let bindings: Vec<(String, u64)> =
listed["variables"].as_array().unwrap().iter().map(|v| (v["name"].as_str().unwrap().to_string(), v["bindings"].as_u64().unwrap())).collect();
assert_eq!(bindings.iter().find(|(n, _)| n == "Shown").map(|b| b.1), Some(1));
assert_eq!(bindings.iter().find(|(n, _)| n == "Chart").map(|b| b.1), Some(1));
s.execute("dataset.select", &json!({"name": "B"})).unwrap();
let doc = &s.doc().unwrap().doc;
assert!(!doc.node(r).unwrap().visible, "Shown is false in B");
let csv = doc.node(NodeId(graph)).and_then(|n| n.extras().graph.as_ref()).map(|g| g.to_csv());
assert_eq!(csv.as_deref(), Some(",,\n7,8\n"), "B's graph data");
}
/// A library that isn't one, or that breaks its grammar or the caps, is refused, and the document
@@ -2477,12 +2545,36 @@ fn malformed_variable_libraries_are_refused() {
"&big;".repeat(8000),
" ".repeat(300_000)
);
// A library of one variable `Shown` of the trait given, and a data set holding `value`.
let kind_value = |t: &str, value: &str| {
format!(
"<variableSets><variableSet><variables><variable varName=\"Shown\" trait=\"{t}\"/></variables>\
<sampleDataSets><sampleDataSet dataSetName=\"A\">{value}</sampleDataSet></sampleDataSets></variableSet></variableSets>"
)
};
// A library graph value of more rows or series than a graph holds.
let rows_past = format!("<Shown><data><values>{}</values></data></Shown>", "<row><value>1</value></row>".repeat(10_001));
let series_past =
format!("<Shown><data><values><row><value key=\"name\">Q</value>{}</row></values></data></Shown>", "<value>1</value>".repeat(257));
// 2,000 rows of 20 values of eight digits are more CSV than a graph value holds.
let row = format!("<row>{}</row>", "<value>12345678</value>".repeat(20));
let long_graph = format!("<Shown><data><values>{}</values></data></Shown>", row.repeat(2_000));
let cases = [
("not well-formed XML", "<variableSets><variableSet>".to_string()),
("no `variableSets` element", "<svg><variables/></svg>".to_string()),
("declares no variables", "<variableSets><variableSet><variables/></variableSet></variableSets>".to_string()),
("is declared twice", library(&[("Name", "textcontent"), ("Name", "textcontent")], &[])),
("has no `trait`", ok.replace(" trait=\"textcontent\"", "")),
("for `Shown` that isn't `true` or `false`", kind_value("visibility", "<Shown>maybe</Shown>")),
("for `Shown` that isn't `true` or `false`", kind_value("visibility", "<Shown><p>true</p></Shown>")),
("for `Shown` that isn't a file's absolute path or `file:` URL", kind_value("fileref", "<Shown>logo.png</Shown>")),
("for `Shown` that isn't a file's absolute path or `file:` URL", kind_value("fileref", "<Shown>C:logo.png</Shown>")),
("for `Shown` that isn't a file's absolute path or `file:` URL", kind_value("fileref", "<Shown>file:logo.png</Shown>")),
("for `Shown` that isn't a graph's `data` element", kind_value("graphdata", "<Shown>1,2</Shown>")),
("for `Shown` that isn't a graph's `data` element", kind_value("graphdata", "<Shown><values/></Shown>")),
("for `Shown` that isn't a graph's `data` element", kind_value("graphdata", "<Shown><data/><data/></Shown>")),
("graph value for `Shown` longer than 262144 bytes", kind_value("graphdata", &long_graph)),
("graph value for `Shown` with more than 10000 rows or 256 series", kind_value("graphdata", &rows_past)),
("graph value for `Shown` with more than 10000 rows or 256 series", kind_value("graphdata", &series_past)),
("missing `varName`", ok.replace("varName=\"Name\"", "varName=\" \"")),
("missing `dataSetName`", ok.replace(" dataSetName=\"A\"", "")),
("data set `A` is declared twice", library(&[("Name", "textcontent")], &[("A", &[]), ("A", &[])])),
@@ -2531,51 +2623,50 @@ fn a_variable_library_expands_entities_of_plain_text() {
assert_eq!(value, Some(vectorcraft_doc::DataValue::Text("x-y \"z\"-x&a;".into())));
}
/// Save Variable Library writes what Load Variable Library reads back: the text variables in their
/// order, every data set by name and in order, and each text value as it was, with several lines,
/// markup characters, quotes, a carriage return and an empty value. Variables of other kinds are
/// left out with their values, named in `skipped` and in the warning. The library is written while
/// the variables are locked too, to a file with `path`.
/// Save Variable Library writes what Load Variable Library reads back: the variables of every kind
/// in their order, every data set by name and in order, and each value as it was: text with several
/// lines, markup characters, quotes, a carriage return and an empty value; visibility values;
/// image paths with spaces, markup characters, `%`, `#` and letters past ASCII, from a Unix root,
/// a drive and a share; and graph data with series, categories, a numeric category and blanks. A
/// variable of unknown kind is declared without a `trait` and loads back as one. The library is
/// written while the variables are locked too, to a file with `path`.
#[test]
fn a_saved_variable_library_loads_back_the_text_variables_and_data_sets() {
fn a_saved_variable_library_loads_back_every_variable_and_data_set() {
let mut s = session();
let t = text(&mut s, "Alice");
for (name, kind) in [("Name", "text"), ("Shown", "visibility"), ("Note", "text"), ("Photo", "image"), ("Badge", "visibility")] {
for (name, kind) in [("Name", "text"), ("Shown", "visibility"), ("Note", "text"), ("Photo", "image"), ("Chart", "graph"), ("Badge", "visibility")]
{
s.execute("variable.define", &json!({"name": name, "kind": kind})).unwrap();
}
s.execute("variable.bind", &json!({"variable": "Name", "ids": [t.0]})).unwrap();
s.execute("dataset.new", &json!({"name": "First", "values": {"Name": "Bravo", "Note": "One\nTwo & <three>\r\n'four' \"five\"", "Shown": true}}))
.unwrap();
s.execute("dataset.new", &json!({"name": "Say \"hi\" & <go>\tnow", "values": {"Name": "", "Photo": "a.png"}})).unwrap();
let chart = ",North,\"S, \"\"q\"\"\"\nQ1,10,2.5\n\"2024\",,-4";
let first = json!({"Name": "Bravo", "Note": "One\nTwo & <three>\r\n'four' \"five\"", "Shown": true, "Photo": "/Users/me/Art & <Work> 100%/#1 ü.png", "Chart": chart});
s.execute("dataset.new", &json!({"name": "First", "values": first})).unwrap();
let second = json!({"Name": "", "Photo": "C:\\Art\\logo.png", "Badge": false, "Chart": ",,\n7,8"});
s.execute("dataset.new", &json!({"name": "Say \"hi\" & <go>\tnow", "values": second})).unwrap();
s.execute("dataset.new", &json!({"name": "Share", "values": {"Photo": "\\\\server\\share\\a.png"}})).unwrap();
s.execute("dataset.new", &json!({"name": "Empty"})).unwrap();
// A file can declare a variable of unknown kind, which no command defines.
std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc)
.variables
.variables
.push(vectorcraft_doc::Variable { name: "Loose name".into(), kind: vectorcraft_doc::VariableKind::Unknown });
s.execute("variable.lock", &json!({"locked": true})).unwrap();
let before = s.doc().unwrap().doc.variables.clone();
let saved = s.execute("variable.saveLibrary", &json!({})).unwrap();
assert_eq!(saved["variables"], json!(["Name", "Note"]));
assert_eq!(saved["datasets"], json!(3));
assert_eq!(
saved["skipped"],
json!([{"name": "Shown", "kind": "visibility"}, {"name": "Photo", "kind": "image"}, {"name": "Badge", "kind": "visibility"}])
);
assert_eq!(saved["warning"], "variables that aren't text were left out: visibility (2), image (1)");
assert_eq!(saved["variables"], json!(["Name", "Shown", "Note", "Photo", "Chart", "Badge", "Loose name"]));
assert_eq!(saved["datasets"], json!(4));
assert_eq!((saved.get("skipped"), saved.get("warning")), (None, None));
assert_eq!(s.doc().unwrap().doc.variables, before, "saving changes nothing");
let mut other = session();
let loaded = other.execute("variable.loadLibrary", &json!({"xml": saved["xml"]})).unwrap();
assert_eq!((loaded["skipped"].clone(), loaded.get("warning")), (json!([]), None));
other.execute("variable.loadLibrary", &json!({"xml": saved["xml"]})).unwrap();
let vars = &other.doc().unwrap().doc.variables;
assert_eq!(vars.variables.iter().map(|v| (v.name.as_str(), v.kind.label())).collect::<Vec<_>>(), [("Name", "text"), ("Note", "text")]);
let text_only: Vec<vectorcraft_doc::DataSet> = before
.datasets
.iter()
.map(|d| {
let mut d = d.clone();
d.values.retain(|k, _| k == "Name" || k == "Note");
d
})
.collect();
assert_eq!(vars.datasets, text_only);
assert_eq!(vars.variables, before.variables);
assert_eq!(vars.datasets, before.datasets);
// Saving the loaded library again writes the same file.
assert_eq!(other.execute("variable.saveLibrary", &json!({})).unwrap()["xml"], saved["xml"]);
let dir = Folder::new("vars-save-library");
let path = dir.file("library.xml");
@@ -2585,19 +2676,78 @@ fn a_saved_variable_library_loads_back_the_text_variables_and_data_sets() {
assert_eq!(std::fs::read_to_string(&path).unwrap(), saved["xml"].as_str().unwrap());
let mut from_file = session();
from_file.execute("variable.loadLibrary", &json!({"path": path})).unwrap();
assert_eq!(from_file.doc().unwrap().doc.variables.datasets, text_only);
assert_eq!(from_file.doc().unwrap().doc.variables.datasets, before.datasets);
}
/// Graph data whose categories are all blank keeps them through a save and a load, and so does
/// graph data of series names without rows; graph data with neither is refused. An image value
/// written as a `file:/…` URL without a host loads as its path, graph data with more series than a
/// graph holds is refused, and wide graph data is checked against the size cap as it is written.
#[test]
fn saved_graph_values_and_file_urls_load_back_at_their_edges() {
let mut s = session();
s.execute("variable.define", &json!({"name": "Chart", "kind": "graph"})).unwrap();
s.execute("dataset.new", &json!({"name": "A", "values": {"Chart": ",S\n\"\",1\n\"\",2"}})).unwrap();
let xml = s.execute("variable.saveLibrary", &json!({})).unwrap()["xml"].as_str().unwrap().to_string();
assert!(xml.contains("<row><value key=\"name\" type=\"string\"></value><value>1</value></row>"), "{xml}");
let mut other = session();
other.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
assert_eq!(other.doc().unwrap().doc.variables.datasets, s.doc().unwrap().doc.variables.datasets);
// Series names without rows load back, and graph data with neither is refused.
s.execute("dataset.set", &json!({"name": "A", "values": {"Chart": ",North,South"}})).unwrap();
let xml = s.execute("variable.saveLibrary", &json!({})).unwrap()["xml"].clone();
let mut other = session();
other.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
assert_eq!(other.doc().unwrap().doc.variables.datasets, s.doc().unwrap().doc.variables.datasets);
s.execute("dataset.set", &json!({"name": "A", "values": {"Chart": ","}})).unwrap();
let e = s.execute("variable.saveLibrary", &json!({})).unwrap_err().to_string();
assert!(e.contains("graph value for `Chart` without rows or series"), "{e}");
let url = "<variableSets><variableSet><variables><variable varName=\"Photo\" trait=\"fileref\"/></variables><sampleDataSets>\
<sampleDataSet dataSetName=\"A\"><Photo>file:/tmp/logo%20one.png</Photo></sampleDataSet>\
<sampleDataSet dataSetName=\"B\"><Photo>file:/C:/Art/logo.png</Photo></sampleDataSet></sampleDataSets></variableSet></variableSets>";
let mut s = session();
s.execute("variable.loadLibrary", &json!({"xml": url})).unwrap();
let image = |set: &str| s.doc().unwrap().doc.variables.dataset(set).and_then(|d| d.values.get("Photo")).cloned();
assert_eq!(image("A"), Some(vectorcraft_doc::DataValue::Image("/tmp/logo one.png".into())));
assert_eq!(image("B"), Some(vectorcraft_doc::DataValue::Image("C:/Art/logo.png".into())));
// More series than a graph holds are refused.
let mut s = session();
s.execute("variable.define", &json!({"name": "Chart", "kind": "graph"})).unwrap();
let wide = (0..257).map(|i| i.to_string()).collect::<Vec<_>>().join(",");
s.execute("dataset.new", &json!({"name": "A", "values": {"Chart": wide}})).unwrap();
let e = s.execute("variable.saveLibrary", &json!({})).unwrap_err().to_string();
assert!(e.contains("graph value for `Chart` with more than 10000 rows or 256 series"), "{e}");
// One row of 256 values and 1,000 rows of one: every row is written 256 values wide.
let mut csv = (0..256).map(|i| i.to_string()).collect::<Vec<_>>().join(",");
for i in 0..1_000 {
csv += &format!("\n{i}");
}
s.execute("dataset.set", &json!({"name": "A", "values": {"Chart": csv.clone()}})).unwrap();
let xml = s.execute("variable.saveLibrary", &json!({})).unwrap()["xml"].as_str().unwrap().to_string();
assert_eq!(xml.matches("<row>").count(), 1_001);
assert!(xml.contains("<data numDataColumns=\"256\">"));
// Rows that make the library larger than 8 MiB are refused as each is written.
for i in 1_000..9_000 {
csv += &format!("\n{i}");
}
s.execute("dataset.set", &json!({"name": "A", "values": {"Chart": csv}})).unwrap();
let e = s.execute("variable.saveLibrary", &json!({})).unwrap_err().to_string();
assert!(e.contains("larger than 8388608 bytes"), "{e}");
}
/// The library is the XML of the public grammar: a document type declaration with the namespace
/// entities, `variableSets` › `variableSet` › `variables` with a `textcontent` variable per text
/// variable, and `sampleDataSets` with a `sampleDataSet` per data set, holding an element per text
/// variable it has a value for, with a `p` element per line. Markup characters, a carriage return,
/// and a tab or quote in a data set name are escaped. A document with text variables and no data
/// sets writes an empty `sampleDataSets`.
/// entities, `variableSets` › `variableSet` › `variables` with a variable per variable, its `trait`
/// and `category` those of its kind, and `sampleDataSets` with a `sampleDataSet` per data set,
/// holding an element per variable it has a value for: a `p` element per line of a text value,
/// `true` or `false`, a `file:` URL for an image's path from a Unix root, and a `data` element for
/// graph data. Markup characters, a carriage return, and a tab or quote in a data set name are
/// escaped. A document with variables and no data sets writes an empty `sampleDataSets`.
#[test]
fn a_saved_variable_library_has_the_library_layout() {
let mut s = session();
for (name, kind) in [("Name", "text"), ("Shown", "visibility"), ("Note", "text")] {
for (name, kind) in [("Name", "text"), ("Shown", "visibility"), ("Note", "text"), ("Photo", "image"), ("Chart", "graph")] {
s.execute("variable.define", &json!({"name": name, "kind": kind})).unwrap();
}
let head = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n\
@@ -2605,13 +2755,17 @@ fn a_saved_variable_library_has_the_library_layout() {
\t<!ENTITY ns_vars \"http://ns.adobe.com/Variables/1.0/\">\n\
\t<!ENTITY ns_custom \"http://ns.adobe.com/GenericCustomNamespace/1.0/\">\n\
\t<!ENTITY ns_flows \"http://ns.adobe.com/Flows/1.0/\">\n\
\t<!ENTITY ns_graphs \"http://ns.adobe.com/Graphs/1.0/\">\n\
]>\n\
<svg>\n\
<variableSets xmlns=\"&ns_vars;\">\n\
\t<variableSet varSetName=\"binding1\" locked=\"none\">\n\
\t\t<variables>\n\
\t\t\t<variable varName=\"Name\" trait=\"textcontent\" category=\"&ns_flows;\"></variable>\n\
\t\t\t<variable varName=\"Shown\" trait=\"visibility\" category=\"&ns_vars;\"></variable>\n\
\t\t\t<variable varName=\"Note\" trait=\"textcontent\" category=\"&ns_flows;\"></variable>\n\
\t\t\t<variable varName=\"Photo\" trait=\"fileref\" category=\"&ns_vars;\"></variable>\n\
\t\t\t<variable varName=\"Chart\" trait=\"graphdata\" category=\"&ns_graphs;\"></variable>\n\
\t\t</variables>\n\
\t\t<v:sampleDataSets xmlns:v=\"&ns_vars;\" xmlns=\"&ns_custom;\">\n";
let tail = "\t\t</v:sampleDataSets>\n\t</variableSet>\n</variableSets>\n</svg>\n";
@@ -2619,7 +2773,8 @@ fn a_saved_variable_library_has_the_library_layout() {
assert_eq!(empty["xml"].as_str().unwrap(), format!("{head}{tail}"));
assert_eq!(empty["datasets"], json!(0));
s.execute("dataset.new", &json!({"name": "A &\t\"B\"", "values": {"Name": "x\r\ny < z", "Shown": false}})).unwrap();
let values = json!({"Name": "x\r\ny < z", "Shown": false, "Photo": "/art/a b.png", "Chart": ",S\nQ1,1\n2,"});
s.execute("dataset.new", &json!({"name": "A &\t\"B\"", "values": values})).unwrap();
s.execute("dataset.new", &json!({"name": "C", "values": {"Note": ""}})).unwrap();
let xml = s.execute("variable.saveLibrary", &json!({})).unwrap()["xml"].as_str().unwrap().to_string();
let sets = "\t\t\t<v:sampleDataSet dataSetName=\"A &amp;&#9;&quot;B&quot;\">\n\
@@ -2627,6 +2782,17 @@ fn a_saved_variable_library_has_the_library_layout() {
\t\t\t\t\t<p>x&#13;</p>\n\
\t\t\t\t\t<p>y &lt; z</p>\n\
\t\t\t\t</Name>\n\
\t\t\t\t<Shown>false</Shown>\n\
\t\t\t\t<Photo>file:////art/a%20b.png</Photo>\n\
\t\t\t\t<Chart>\n\
\t\t\t\t\t<data numDataColumns=\"2\">\n\
\t\t\t\t\t\t<propertyRow key=\"name\"><value></value><value type=\"string\">S</value></propertyRow>\n\
\t\t\t\t\t\t<values>\n\
\t\t\t\t\t\t\t<row><value key=\"name\" type=\"string\">Q1</value><value>1</value></row>\n\
\t\t\t\t\t\t\t<row><value key=\"name\">2</value><value></value></row>\n\
\t\t\t\t\t\t</values>\n\
\t\t\t\t\t</data>\n\
\t\t\t\t</Chart>\n\
\t\t\t</v:sampleDataSet>\n\
\t\t\t<v:sampleDataSet dataSetName=\"C\">\n\
\t\t\t\t<Note>\n\
@@ -2636,10 +2802,11 @@ fn a_saved_variable_library_has_the_library_layout() {
assert_eq!(xml, format!("{head}{sets}{tail}"));
}
/// Save Variable Library refuses a document without variables or without text variables, a text
/// variable whose name can't name an element, a data set name or text value with a character XML
/// can't hold, a name that Load Variable Library would read differently or refuse, and a library
/// past the caps that Load Variable Library reads. A refused save writes no file.
/// Save Variable Library refuses a document without variables, a variable whose name can't name an
/// element (but for a variable of unknown kind), a data set name, text value or graph label with a
/// character XML can't hold, an image value that isn't a file's absolute path, a name that Load
/// Variable Library would read differently or refuse, and a library past the caps that Load
/// Variable Library reads. A refused save writes no file.
#[test]
fn save_variable_library_refuses_what_a_library_cant_hold() {
let dir = Folder::new("vars-save-refused");
@@ -2652,14 +2819,41 @@ fn save_variable_library_refuses_what_a_library_cant_hold() {
let mut s = session();
refused(&mut s, "define a variable first");
// A library without text variables is saved.
s.execute("variable.define", &json!({"name": "Shown", "kind": "visibility"})).unwrap();
refused(&mut s, "holds text variables, and the document has none");
assert_eq!(s.execute("variable.saveLibrary", &json!({})).unwrap()["variables"], json!(["Shown"]));
for name in ["First Name", "1st", "a:b", "x/y", "-dash"] {
for (name, kind) in [("First Name", "text"), ("1st", "visibility"), ("a:b", "image"), ("x/y", "graph"), ("-dash", "text")] {
let mut s = session();
s.execute("variable.define", &json!({"name": name, "kind": "text"})).unwrap();
s.execute("variable.define", &json!({"name": name, "kind": kind})).unwrap();
refused(&mut s, &format!("variable `{name}` can't be saved in a variable library"));
}
// No element is named after a variable of unknown kind, so its name can be any name.
let mut s = session();
std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc)
.variables
.variables
.push(vectorcraft_doc::Variable { name: "First \"Name\" & <x>".into(), kind: vectorcraft_doc::VariableKind::Unknown });
let xml = s.execute("variable.saveLibrary", &json!({})).unwrap()["xml"].clone();
let mut other = session();
other.execute("variable.loadLibrary", &json!({"xml": xml})).unwrap();
assert_eq!(other.doc().unwrap().doc.variables.variables, s.doc().unwrap().doc.variables.variables);
// An image value that isn't a file's absolute path, which Load Variable Library refuses.
for path in ["a.png", "C:a.png", "C:\\a.png ", "/"] {
let mut s = session();
s.execute("variable.define", &json!({"name": "Photo", "kind": "image"})).unwrap();
std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc).variables.datasets.push(vectorcraft_doc::DataSet {
name: "A".into(),
values: [("Photo".to_string(), vectorcraft_doc::DataValue::Image(path.into()))].into(),
});
refused(&mut s, "data set `A` holds an image value for `Photo` that isn't a file's absolute path");
}
// A graph label with a character XML can't hold.
let mut s = session();
s.execute("variable.define", &json!({"name": "Chart", "kind": "graph"})).unwrap();
s.execute("dataset.new", &json!({"name": "A", "values": {"Chart": ",S\u{1}\nQ1,1"}})).unwrap();
refused(&mut s, "data set `A` holds a control character");
for name in ["Ünïcode", "_x", "a.b-c_d", "名前"] {
let mut s = session();
s.execute("variable.define", &json!({"name": name, "kind": "text"})).unwrap();
@@ -2757,10 +2951,10 @@ fn a_saved_variable_library_near_the_size_cap_loads_back() {
/// While the variables are locked, a library that would delete or define a variable is refused, as
/// Delete Variable and New Variable are, and the document keeps its variables and data sets. That
/// covers a library without text variables loaded into a document with variables, and one that
/// adds a text variable to the document's. A library of the document's own text variables, and
/// one without text variables loaded into a document without variables, delete and define none:
/// they load, replacing the data sets.
/// covers a library of other variables loaded into a document with variables, one that adds a
/// variable to the document's, one that declares a document variable's name with another kind, and
/// any library loaded into a document without variables. A library of the document's own variables
/// with their kinds deletes and defines none: it loads, replacing the data sets.
#[test]
fn locked_variables_refuse_a_library_that_deletes_or_defines_variables() {
let mut s = session();
@@ -2768,7 +2962,7 @@ fn locked_variables_refuse_a_library_that_deletes_or_defines_variables() {
s.execute("dataset.new", &json!({"name": "A", "values": {"Name": "Old"}})).unwrap();
s.execute("variable.lock", &json!({"locked": true})).unwrap();
let before = s.doc().unwrap().doc.variables.clone();
for vars in [&[("Shown", "other")][..], &[("Name", "textcontent"), ("Note", "textcontent")][..]] {
for vars in [&[("Shown", "other")][..], &[("Name", "textcontent"), ("Note", "textcontent")][..], &[("Name", "visibility")][..]] {
let e = s.execute("variable.loadLibrary", &json!({"xml": library(vars, &[("B", &[])])})).unwrap_err();
assert!(matches!(&e, EngineError::Disabled(cmd, why) if cmd == "variable.loadLibrary" && why == "variables are locked"), "{e}");
assert_eq!(s.doc().unwrap().doc.variables, before);
@@ -2780,13 +2974,13 @@ fn locked_variables_refuse_a_library_that_deletes_or_defines_variables() {
let mut s = session();
s.execute("dataset.new", &json!({"name": "A"})).unwrap();
s.execute("variable.lock", &json!({"locked": true})).unwrap();
let e = s.execute("variable.loadLibrary", &json!({"xml": library(&[("Name", "textcontent")], &[])})).unwrap_err();
assert!(matches!(&e, EngineError::Disabled(_, why) if why == "variables are locked"), "{e}");
let r = s.execute("variable.loadLibrary", &json!({"xml": library(&[("Shown", "other")], &[("B", &[])])})).unwrap();
assert_eq!((r["deletedDataSets"].clone(), r["names"].clone()), (json!(["A"]), json!(["B"])));
for vars in [&[("Name", "textcontent")][..], &[("Shown", "other")][..]] {
let e = s.execute("variable.loadLibrary", &json!({"xml": library(vars, &[("B", &[])])})).unwrap_err();
assert!(matches!(&e, EngineError::Disabled(_, why) if why == "variables are locked"), "{e}");
}
let vars = &s.doc().unwrap().doc.variables;
assert!(vars.variables.is_empty() && vars.locked);
assert_eq!(vars.datasets.iter().map(|d| d.name.as_str()).collect::<Vec<_>>(), ["B"]);
assert_eq!(vars.datasets.iter().map(|d| d.name.as_str()).collect::<Vec<_>>(), ["A"]);
}
/// A graph variable's data set applies its CSV as `graph.setData` does: a right-axis series the row's data no longer
@@ -3109,6 +3303,10 @@ fn an_svg_without_readable_variable_data_opens_its_art() {
let head = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\">";
let art = "<rect x=\"1\" y=\"1\" width=\"5\" height=\"5\"/></svg>";
let untraited = format!("{head}<variableSets><variableSet><variables><variable varName=\"A\"/></variables></variableSet></variableSets>{art}");
let relative = format!(
"{head}<variableSets><variableSet><variables><variable varName=\"T\" trait=\"textcontent\"/><variable varName=\"A\" trait=\"fileref\"/></variables>\
<sampleDataSets><sampleDataSet dataSetName=\"D\"><T><p>kept</p></T><A>a.png</A></sampleDataSet></sampleDataSets></variableSet></variableSets>{art}"
);
let refs = "&ns_big;".repeat(40_000);
let big = "x".repeat(250);
let growing = format!(
@@ -3164,11 +3362,23 @@ fn an_svg_without_readable_variable_data_opens_its_art() {
assert!(warnings.is_empty(), "{warnings:?}");
assert_eq!(o.doc().unwrap().doc.variables.variables.len(), 1);
for (svg, why) in [(untraited, "variable `A` has no `trait`"), (growing, "entities expand to more than")] {
let (o, warnings) = svg_opened(&svg, "broken.svg");
assert!(warnings.iter().any(|w| w.as_str().is_some_and(|w| w.contains("variable data wasn't read") && w.contains(why))), "{warnings:?}");
let d = &o.doc().unwrap().doc;
assert!(d.variables.variables.is_empty());
assert_eq!(vectorcraft_testkit::svg_shapes(&vectorcraft_svg::export(d, &Default::default())), 1, "the art opens");
}
// A variable without a `trait` is of unknown kind: the SVG leaves it out like the other kinds
// that aren't text.
let (o, warnings) = svg_opened(&untraited, "untraited.svg");
assert!(warnings.contains(&json!("variables that aren't text were left out: unknown (1)")), "{warnings:?}");
assert!(o.doc().unwrap().doc.variables.variables.is_empty());
// The values of the other kinds aren't read, so one that Load Variable Library would refuse
// leaves the text variables and their values as they open.
let (o, warnings) = svg_opened(&relative, "relative.svg");
assert!(warnings.contains(&json!("variables that aren't text were left out: fileref (1)")), "{warnings:?}");
let vars = &o.doc().unwrap().doc.variables;
assert_eq!(vars.variables.iter().map(|v| v.name.as_str()).collect::<Vec<_>>(), ["T"]);
assert_eq!(vars.dataset("D").map(|d| d.values.clone()), Some([("T".to_string(), vectorcraft_doc::DataValue::Text("kept".into()))].into()));
let (o, warnings) = svg_opened(&growing, "broken.svg");
let why = "entities expand to more than";
assert!(warnings.iter().any(|w| w.as_str().is_some_and(|w| w.contains("variable data wasn't read") && w.contains(why))), "{warnings:?}");
let d = &o.doc().unwrap().doc;
assert!(d.variables.variables.is_empty());
assert_eq!(vectorcraft_testkit::svg_shapes(&vectorcraft_svg::export(d, &Default::default())), 1, "the art opens");
}
+1 -1
View File
@@ -651,7 +651,7 @@ impl Session {
match ev.kind {
PointerKind::Down | PointerKind::Drag => self.pointer_held = true,
PointerKind::Up | PointerKind::Move => self.pointer_held = false,
PointerKind::DoubleClick => {}
PointerKind::DoubleClick | PointerKind::TripleClick => {}
}
match ev.kind {
PointerKind::Down => {
+97
View File
@@ -664,6 +664,29 @@ proptest! {
survive(&svg, || vectorcraft_svg::import(&svg).ok())?;
}
/// Style sheets of descendant, child, sibling and `:not()` selectors over nested groups and the
/// `<use>` copies of a rectangle inside them, in an SVG and in an SVG image it shows: the import
/// measures their matching before its own cascade and the SVG reader run.
#[test]
fn svg_hostile_selectors_over_copies_never_panic(
sheet in r#"([a-z.#:()>+* ]{1,24}\{fill:red\} ?){1,6}"#,
depth in 1usize..12,
copies in 0usize..4,
) {
let groups = format!("{}<rect id=\"r\" class=\"a\" width=\"1\" height=\"1\"/>{}", "<g class=\"a\">".repeat(depth), "</g>".repeat(depth));
let inner = format!(
"<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"4\" height=\"4\"><style>{sheet}</style>{groups}{}</svg>",
"<use href=\"#r\"/>".repeat(copies)
);
let image = format!(
"<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"4\" height=\"4\"><image href=\"data:image/svg+xml;base64,{}\" width=\"4\" height=\"4\"/></svg>",
vectorcraft_svg::base64_encode(inner.as_bytes())
);
for svg in [inner, image] {
survive(&svg, || vectorcraft_svg::import(&svg).ok())?;
}
}
/// Clip paths made of text, of `<use>` elements showing text, and of both with shapes, each with
/// hostile attributes, clipping art that may clip by them in turn.
#[test]
@@ -1831,6 +1854,80 @@ proptest! {
}
}
/// A 4 × 2 pixel RGB PSD file whose clipping path resource (2999) names its saved path "P"
/// (resource 2000): a closed subpath of a linked and two unlinked knots, an open subpath, and the
/// initial fill record saying the fill starts with all pixels.
fn clipped_psd() -> Vec<u8> {
let record = |selector: u16, body: &[i32]| {
let mut r = selector.to_be_bytes().to_vec();
r.extend(body.iter().flat_map(|v| v.to_be_bytes()));
r.resize(26, 0);
r
};
let one = 1 << 24;
let mut path = record(6, &[]);
path.extend(record(8, &[1 << 16]));
path.extend(record(0, &[3 << 16]));
path.extend(record(1, &[0, 0, 0, one / 2, 0, one]));
path.extend(record(2, &[one, one, one, one, one, one]));
path.extend(record(2, &[one, 0, one, 0, one, 0]));
path.extend(record(3, &[2 << 16]));
path.extend(record(5, &[-one, -one, 0, 0, 2 * one, 2 * one]));
path.extend(record(4, &[one / 4, one / 4, one / 4, one / 4, one / 4, one / 4]));
let mut res = b"8BIM\x07\xd0\x01P".to_vec();
res.extend((path.len() as u32).to_be_bytes());
res.extend(path);
res.extend(b"8BIM\x0b\xb7\0\0");
res.extend(8u32.to_be_bytes());
res.extend([1, b'P', 0, 0, 0, 0, 0, 0]);
let mut f = b"8BPS\0\x01\0\0\0\0\0\0\0\x03\0\0\0\x02\0\0\0\x04\0\x08\0\x03".to_vec();
f.extend([0; 4]);
f.extend((res.len() as u32).to_be_bytes());
f.extend(res);
f.extend([0; 4]);
f.extend([0, 0]);
f.extend((0..24u8).map(|v| v * 10));
f
}
#[test]
fn the_clipped_psd_sample_places_in_a_clip_group() {
let path = vectorcraft_engine::cmd::fileio::psdread::clipping_path(&clipped_psd()).unwrap();
assert_eq!(path.subpaths.iter().map(|s| (s.anchors.len(), s.closed)).collect::<Vec<_>>(), [(4, true), (3, true), (2, false)]);
let mut s = vectorcraft_engine::Session::new();
s.execute("file.new", &json!({"width": 100, "height": 100})).unwrap();
let r = s.execute("file.place", &json!({"name": "c.psd", "dataBase64": vectorcraft_format::base64_encode(&clipped_psd())})).unwrap();
assert!(r["image"].is_u64(), "{r}");
}
proptest! {
#![proptest_config(config())]
/// Mutated copies of a PSD file with a clipping path (its resources: the path records, their
/// selectors, counts and points, and the names) never crash reading the path, placing the file
/// or opening its merged image.
#[test]
fn mutated_psd_clipping_paths_never_panic(cut in 0usize..1000, edits in prop::collection::vec((0usize..300, any::<u8>()), 0..12)) {
let mut bytes = clipped_psd();
let len = bytes.len();
for (at, b) in edits {
if let Some(x) = bytes.get_mut(at % len) {
*x = b;
}
}
bytes.truncate((cut % (len + 1)).max(8));
let r = catch_quiet(|| {
let _ = vectorcraft_engine::cmd::fileio::psdread::clipping_path(&bytes);
let mut s = vectorcraft_engine::Session::new();
s.execute("file.new", &json!({"width": 100, "height": 100})).unwrap();
let p = json!({"name": "c.psd", "dataBase64": vectorcraft_format::base64_encode(&bytes), "thumbnail": 8});
let _ = no_panic(s.execute("file.place", &p));
let _ = no_panic(s.execute("document.open", &json!({"name": "c.psd", "dataBase64": vectorcraft_format::base64_encode(&bytes), "layers": false})));
});
prop_assert!(r.is_ok(), "panicked: {:?}", r.err());
}
}
/// 1-bit TIFFs compressed with CCITT Group 3: modified Huffman (Compression 2) in three strips, T.4
/// (Compression 3) with two-dimensional rows, fill bits, six EOLs at the end and each byte's lowest
/// bit first, and T.4 two-dimensional rows in 16 × 16 tiles.
+4
View File
@@ -143,6 +143,10 @@
//! A path or compound path with a brush the reader reads live is written with an art style whose
//! stroke is the brush's filter (`writer::brushes`). A brush is written only when the reader reads
//! it back with its settings.
//! - Graphs, as the reader reads them (`read/graph.rs`): a graph on the layers whose records the
//! reader reads back as the same graph ([`crate::ai_graph`]) is written as its group between
//! `%_Gs`, its functional records and `%_GS`, each series' group tagged `Go` right after its end;
//! any other graph, and a graph with art left out, as its art, with a warning.
//!
//! Lines end in CR LF. Strings are written in UTF-8. Art space is ruler space: y up, its origin at
//! the first artboard's top-left corner. On the canvas ([`CANVAS_SIZE`] points square, y down) the
+70
View File
@@ -10907,3 +10907,73 @@ fn a_clipping_path_written_as_its_paint_keeps_one_text_wrap() {
same_wraps(&wraps(read_back(&doc).layers[0].children().unwrap()), &[(None, 5.0, true)]);
}
}
/// A graph whose records read back whole is written with them, each series' group tagged before
/// its name, and opens again as the same live graph, also from a PDF-compatible file's first page.
#[test]
fn graphs_are_written_with_their_records_and_open_live() {
use crate::ai_graph::sample;
for (what, doc) in sample::kept() {
let out = export_ai_editing(&doc, &opts()).unwrap();
assert!(!out.warnings.iter().any(|w| w == writer::GRAPHS), "{what}: {:?}", out.warnings);
let text = program(&doc);
assert_eq!((text.matches("%_Gs\n").count(), text.matches("%_GS\n").count()), (1, 1), "{what}: {text}");
assert!(text.contains("U\n%_2 ") && text.contains(" 0 0 Go\n%_/ArtDictionary :\n"), "{what}: the tag comes before the series' name: {text}");
let written = sample::graphs(&doc);
let graphs = sample::graphs(&read_back(&doc));
assert_eq!(graphs.len(), 1, "{what}");
assert!(sample::same(&written[0].0, &graphs[0].0), "{what}: {:#?}\n{:#?}", written[0].0, graphs[0].0);
assert_eq!(graphs[0].1, written[0].1, "{what}: the members and their series");
}
let doc = sample::document(sample::spec(vectorcraft_doc::GraphKind::Column));
let (p, _) = private_data(&doc, &opts()).unwrap();
let pdf =
vectorcraft_pdf::export(&doc, &vectorcraft_pdf::PdfOptions { private_data: Some(p), ..vectorcraft_pdf::PdfOptions::uncompressed() }).unwrap();
let (read, _) = crate::ai_alone(&vectorcraft_pdf::illustrator_data(&pdf, None).unwrap()).unwrap();
let graphs = sample::graphs(&read);
assert_eq!(graphs.len(), 1);
assert!(sample::same(&sample::graphs(&doc)[0].0, &graphs[0].0));
}
/// A graph whose records wouldn't read back as it is is written as its art, without records, with
/// the warning.
#[test]
fn graphs_the_records_cant_keep_are_written_as_their_art() {
use crate::ai_graph::sample;
for (what, doc) in sample::unkept() {
let out = export_ai_editing(&doc, &opts()).unwrap();
assert!(out.warnings.iter().any(|w| w == writer::GRAPHS), "{what}: {:?}", out.warnings);
let text = program(&doc);
assert!(!text.contains("%_Gs") && !text.contains(" Go\n") && !text.contains("%_GS"), "{what}: {text}");
let read = read_back(&doc);
assert!(sample::graphs(&read).is_empty(), "{what}");
let paths = |d: &Document| {
let mut count = 0;
d.walk(|n| count += usize::from(matches!(n.kind, NodeKind::Path { .. })));
count
};
assert_eq!(paths(&read), paths(&doc), "{what}: the graph's art is kept");
}
}
/// A graph with art left out for the object limit is written as the art there is room for, without
/// records or tags, with the warning; with room for all of it, it is written with its records.
#[test]
fn a_graph_with_art_left_out_is_written_without_records() {
use crate::ai_graph::sample;
let doc = sample::document(sample::spec(vectorcraft_doc::GraphKind::Column));
let all = export_ai_editing(&doc, &opts()).unwrap();
let read = crate::import::objects_read(&all.program).unwrap();
let room = export_within(&doc, &opts(), read).unwrap();
assert_eq!(room.program, all.program);
for max in [0, 1, read / 2, read - 1] {
let out = export_within(&doc, &opts(), max).unwrap();
let text = String::from_utf8_lossy(&out.program).replace("\r\n", "\n");
assert!(
out.warnings.iter().any(|w| w == writer::OBJECT_LIMIT) && out.warnings.iter().any(|w| w == writer::GRAPHS),
"{max}: {:?}",
out.warnings
);
assert!(!text.contains("%_Gs") && !text.contains(" Go\n") && !text.contains("%_GS"), "{max}: {text}");
}
}
+57 -1
View File
@@ -295,6 +295,13 @@ pub(super) struct Writer<'a> {
shown: Vec<vectorcraft_geom::BezPath>,
/// The copy of an image that the last [`Self::image`] wrote as a window, when it did.
windowed: Option<images::Windowed>,
/// Writing a graph's art with its records ([`Self::graph_records`]): a graph inside it is written
/// as its art.
in_graph: bool,
/// The `Go` line the next object, a graph's series group, is followed by.
series_tag: Option<String>,
/// Where the `Go` lines of the graph being written start in [`Self::body`].
graph_tags: Vec<usize>,
}
impl<'a> Writer<'a> {
@@ -367,6 +374,9 @@ impl<'a> Writer<'a> {
whole_images: HashMap::new(),
shown: vec![],
windowed: None,
in_graph: false,
series_tag: None,
graph_tags: vec![],
}
}
@@ -642,6 +652,7 @@ impl<'a> Writer<'a> {
/// One object: its state before it, its transparency, and its name and opacity mask after it.
fn node(&mut self, n: &Node) {
let tag = self.series_tag.take();
if let NodeKind::Layer { .. } = n.kind {
return self.write_layer(n, &[]);
}
@@ -652,7 +663,8 @@ impl<'a> Writer<'a> {
if self.in_symbol {
self.wrote_fixed |= symbols::redrawn(n);
}
if n.extras().graph.is_some() && !self.in_look {
let graph = if n.extras().graph.is_some() && !self.in_look { self.graph_records(n) } else { None };
if n.extras().graph.is_some() && !self.in_look && graph.is_none() {
self.warn(GRAPHS);
}
// On the layers or in an opacity mask's art, outside art cut to a clipping object: with its
@@ -680,14 +692,18 @@ impl<'a> Writer<'a> {
let start = self.body.len();
// An image's copy written as the part that its opacity mask, among other regions, shows.
let mut mask_window = None;
let charged = self.charges();
match &n.kind {
NodeKind::Layer { .. } => {}
NodeKind::Group { children, clip: true } => self.clip_group(children, xy),
NodeKind::Group { children, clip: false } => {
if self.open_group("u") {
self.in_graph |= graph.is_some();
for c in children {
self.series_tag = graph.as_ref().and_then(|g| g.tags.get(&c.id).cloned());
self.node(c);
}
self.in_graph &= graph.is_none();
self.end_group("U", xy);
}
}
@@ -790,6 +806,11 @@ impl<'a> Writer<'a> {
// A group's dictionary goes between its end and its state block.
let block = (self.block_end == self.body.len() && self.block_start >= start).then(|| self.body.split_off(self.block_start));
self.block_end = usize::MAX;
// A graph's series group is tagged right after its end, before its dictionary.
if let Some(t) = tag {
self.graph_tags.push(self.body.len());
self.line(&t);
}
let mask_written = self.dictionary(n);
if let Some(b) = block {
self.body.push_str(&b);
@@ -803,6 +824,41 @@ impl<'a> Writer<'a> {
if deform {
self.line(&envelopes::plugin_line());
}
if let Some(g) = graph {
self.graph_end(g, start, charged);
}
}
/// The records of graph `n` ([`crate::ai_graph::records`]) when it is written as a graph: on the
/// layers, outside art cut to a clipping object, symbols' art, live objects' art and another
/// graph, and without an art style anywhere in it. `None` when it is written as its art.
fn graph_records(&self, n: &Node) -> Option<crate::ai_graph::Records> {
fn has_style(n: &Node, styled: &HashMap<NodeId, Arc<Node>>) -> bool {
styled.contains_key(&n.id) || n.children().is_some_and(|c| c.iter().any(|c| has_style(c, styled)))
}
let placed = self.hidden == 0 && self.nest == 0 && self.drawn == 0 && self.clip.is_none() && !self.in_symbol && !self.in_graph;
if !placed || has_style(n, &self.styled) {
return None;
}
crate::ai_graph::records(n, self.to_art)
}
/// The graph whose art was written from `start` on, charged from `charged`, ends: its records go
/// before the art and `%_GS` after it, or, when art in it was left out ([`Self::take_objects`]),
/// its `Go` lines are taken out and it stays its art, with a warning.
fn graph_end(&mut self, records: crate::ai_graph::Records, start: usize, charged: Charges) {
let tags = std::mem::take(&mut self.graph_tags);
if self.body.len() > start && !self.left_out_since(charged) {
self.body.insert_str(start, &records.head);
self.line(crate::ai_graph::END);
return;
}
for at in tags.into_iter().rev() {
if let Some(len) = self.body.get(at..).and_then(|rest| rest.find('\n')) {
self.body.replace_range(at..=at + len, "");
}
}
self.warn(GRAPHS);
}
/// Live object `n`, of transparency `xy`, as a group of its art, with `warning` when it is given.
+661
View File
@@ -0,0 +1,661 @@
//! A live graph's records, which the legacy `.ai` writer ([`crate::legacy_ai`]) and the editing data
//! writer ([`crate::ai_editing`]) both write around a graph's group (Adobe Illustrator File Format
//! Specification, version 7.0, §17 and appendix A): `%_Gs`, the functional records on `%_` lines
//! (`Gb`, `Gy`, `Gd`, three `Ga` … `GA` axes, `Gz`, `Gc` cells and `GC`), the drawn art in one group
//! with each series' group followed by `%_2 column 0 0 Go`, then `%_GS`.
//!
//! A graph is written so only when the `.ai` reader (`import::ai::read::graph`) reads every record
//! back as the same graph: one of the four graph types it reads (grouped and stacked column, line,
//! area), the settings it keeps, a table it holds, and drawn art it attaches the graph to (each
//! series' group a direct member of the graph's, of paths painted with one solid fill and one plain
//! line, and the plot's left and bottom edges drawn as stroked lines). Any other graph is written as
//! its art, with a warning.
use std::collections::HashMap;
use std::fmt::Write;
use kurbo::{PathSeg, Point};
use vectorcraft_color::{BlendMode, Paint};
use vectorcraft_doc::{
Appearance, AppearanceItem, GraphKind, GraphSpec, LabelStyles, MAX_GRAPH_CATEGORIES, MAX_GRAPH_SERIES, Node, NodeId, NodeKind, PiePosition,
PieSort, TickLength, ValueAxisSide,
};
use vectorcraft_effects::stroke;
use vectorcraft_geom::{Affine, Rect};
use crate::ps;
/// Most cells of a graph's table, its label row and column included.
const MAX_CELLS: usize = 2_600_000;
/// Longest cell string, in bytes (appendix A, `Gc`).
const MAX_CELL_TEXT: usize = 255;
/// Most characters of the text before or after a value axis' numbers (appendix A, `Ga`, `GA`).
const MAX_AFFIX: usize = 9;
/// Most tick marks per division the reader keeps.
const MAX_TICK_MARKS: usize = 20;
/// Most divisions of a value axis with set values the reader keeps.
const MAX_DIVISIONS: usize = 100;
/// How far an axis line may be from the plot's edge, in points.
const EDGE: f64 = 0.01;
/// Most values one `Gc` takes.
const CELLS_PER_RECORD: usize = 15;
/// A graph's records: what goes before its group (`%_Gs` to `%_GC`), and the `Go` line that follows
/// each series' group, by the group's id. `%_GS` follows the group.
pub(crate) struct Records {
pub(crate) head: String,
pub(crate) tags: HashMap<NodeId, String>,
}
/// The line that ends a graph's records, after its group.
pub(crate) const END: &str = "%_GS";
/// The records of graph `n` (a group holding [`vectorcraft_doc::NodeExtras::graph`]), its art written
/// through `to_art`; `None` when the reader would not read them back as the same graph.
pub(crate) fn records(n: &Node, to_art: Affine) -> Option<Records> {
let g = n.extras().graph.as_deref()?;
let NodeKind::Group { children, clip: false } = &n.kind else { return None };
(n.visible && n.extras().mask.is_none() && all_shown(n)).then_some(())?;
let ty = kind_code(g.kind)?;
settings_kept(g).then_some(())?;
let (left_manual, left_min, left_max, left_step) = axis(g.ticks, g.axis_min, g.axis_max)?;
let (right_manual, right_min, right_max, right_step) = axis(g.right_ticks, g.right_axis_min, g.right_axis_max)?;
// The table as the graph draws it: `cells` leaves out rows and series past the model's limits.
let rows = g.rows.len();
let width = g.rows.iter().map(Vec::len).max().unwrap_or(0);
((1..=MAX_GRAPH_CATEGORIES).contains(&rows) && (1..=MAX_GRAPH_SERIES).contains(&width)).then_some(())?;
let cells = g.cells();
cells.iter().flatten().all(|v| v.is_none_or(f64::is_finite)).then_some(())?;
cells.iter().flatten().any(Option::is_some).then_some(())?;
let first_row = usize::from(!g.series.is_empty());
let first_col = usize::from(!g.categories.is_empty());
(g.series.is_empty() || g.series.len() == width).then_some(())?;
(g.categories.is_empty() || g.categories.len() == rows).then_some(())?;
let (total_rows, total_cols) = (rows + first_row, width + first_col);
total_rows.checked_mul(total_cols).filter(|c| *c <= MAX_CELLS)?;
g.series.iter().chain(&g.categories).all(|l| l.len() <= MAX_CELL_TEXT && !l.chars().any(char::is_control)).then_some(())?;
[&g.prefix, &g.suffix, &g.right_prefix, &g.right_suffix]
.iter()
.all(|a| a.chars().count() <= MAX_AFFIX && !a.chars().any(char::is_control))
.then_some(())?;
// The plot, and the art the reader attaches the graph to.
let r = g.rect;
(r.is_finite() && r.width() > 0.0 && r.height() > 0.0).then_some(())?;
let plot = to_art.transform_rect_bbox(r);
(plot.is_finite() && plot.width() > 0.0 && plot.height() > 0.0).then_some(())?;
let tags = series_groups(children, width, first_col, g.kind == GraphKind::Line)?;
draws_axes(n, r).then_some(())?;
let placed = n.geometric_bounds()?;
(r.x0 >= placed.x0 - EDGE && r.y0 >= placed.y0 - EDGE && r.x1 <= placed.x1 + EDGE && r.y1 <= placed.y1 + EDGE).then_some(())?;
let mut head = String::from("%_Gs\n");
let _ = writeln!(head, "%_{} {} {} {} Gb", real(plot.x0), real(plot.y1), real(plot.x1), real(plot.y0));
let flag = |b: bool| u8::from(b);
let _ = writeln!(
head,
"%_{ty} {} {} 14 {} {} 0 {} 6 44 Gy",
flag(g.drop_shadow),
flag(g.first_row_in_front),
flag(g.mark_points),
flag(g.connect_points),
flag(g.legend_across_top)
);
let _ =
writeln!(head, "%_10 2 {} 0 {} {} {} Gd", flag(g.first_column_in_front), real(g.column_width), real(g.cluster_width), flag(g.edge_to_edge));
// Tick marks per division: 0 and 1 both mean one, at the labels, and the reader reads 0 as 1.
let (category_marks, left_marks, right_marks) = (g.category_tick_marks.max(1), g.tick_marks.max(1), g.right_tick_marks.max(1));
let _ = writeln!(head, "%_1 () Ga\n%_0 {} 0 0 0 {category_marks} {} () GA", tick(g.category_tick_length), flag(g.ticks_between_labels));
let _ = writeln!(head, "%_2 {} Ga", ps::bytes(g.prefix.as_bytes()));
let _ = writeln!(
head,
"%_{} {} {} {} {} {} 0 {} GA",
flag(left_manual),
tick(g.tick_length),
real(left_min),
real(left_max),
real(left_step),
left_marks,
ps::bytes(g.suffix.as_bytes())
);
let _ = writeln!(head, "%_4 {} Ga", ps::bytes(g.right_prefix.as_bytes()));
let _ = writeln!(
head,
"%_{} {} {} {} {} {} 0 {} GA",
flag(right_manual),
tick(g.right_tick_length),
real(right_min),
real(right_max),
real(right_step),
right_marks,
ps::bytes(g.right_suffix.as_bytes())
);
let _ = writeln!(head, "%_{total_rows} {total_cols} {first_row} {first_col} Gz");
let mut table = Table::new(&mut head);
if first_row == 1 {
if first_col == 1 {
table.text("");
}
for s in &g.series {
table.text(s);
}
}
for (i, row) in cells.iter().enumerate() {
if let Some(c) = g.categories.get(i) {
table.text(c);
}
for v in row {
match v {
Some(v) => table.num(*v),
None => table.text(""),
}
}
}
table.finish();
head.push_str("%_GC\n");
Some(Records { head, tags })
}
/// The `Gc` records of a table, its cells in rows: at most [`CELLS_PER_RECORD`] values each, one
/// string at most.
struct Table<'a> {
out: &'a mut String,
values: usize,
string: bool,
}
impl<'a> Table<'a> {
fn new(out: &'a mut String) -> Self {
Self { out, values: 0, string: false }
}
fn start(&mut self, string: bool) {
if self.values == CELLS_PER_RECORD || (string && self.string) {
self.finish();
}
self.out.push_str(if self.values == 0 { "%_" } else { " " });
self.values += 1;
self.string |= string;
}
fn text(&mut self, t: &str) {
self.start(true);
self.out.push_str(&ps::bytes(t.as_bytes()));
}
fn num(&mut self, v: f64) {
self.start(false);
self.out.push_str(&real(v));
}
fn finish(&mut self) {
if self.values > 0 {
self.out.push_str(" Gc\n");
}
(self.values, self.string) = (0, false);
}
}
/// `v` as a PostScript number that reads back as the same value.
fn real(v: f64) -> String {
if v == 0.0 {
"0".into()
} else if (1e-4..1e15).contains(&v.abs()) {
format!("{v}")
} else {
format!("{v:e}")
}
}
/// `graphType`: 5 grouped column, 6 stacked column, 7 line, 10 area; the reader reads no other type.
fn kind_code(k: GraphKind) -> Option<u8> {
match k {
GraphKind::Column => Some(5),
GraphKind::StackedColumn => Some(6),
GraphKind::Line => Some(7),
GraphKind::Area => Some(10),
_ => None,
}
}
/// `tickMarkType`: 13 none, 14 short, 15 the length of the plot.
fn tick(t: TickLength) -> u8 {
match t {
TickLength::None => 13,
TickLength::Short => 14,
TickLength::Full => 15,
}
}
/// Whether `g`'s settings are ones the records give and the reader keeps: a legend beside or across
/// the top, every series of the graph's type, one value axis on the left, lines not filled, no graph
/// designs, label formatting or pie settings, column and cluster widths of 1% to 1000%, and at most
/// [`MAX_TICK_MARKS`] tick marks a division.
fn settings_kept(g: &GraphSpec) -> bool {
let percent = |p: f64| (1.0..=1000.0).contains(&p);
g.legend
&& g.series_kinds.iter().all(|k| k.is_none_or(|k| k == g.kind))
&& g.value_axis == ValueAxisSide::Left
&& !g.separate_scales
&& g.right_series.is_empty()
&& !g.filled_lines
&& g.series_markers.iter().all(Option::is_none)
&& g.series_columns.iter().all(Option::is_none)
&& g.label_styles == LabelStyles::default()
&& !g.pie_legend_in_wedges
&& g.pie_position == PiePosition::Even
&& g.pie_sort == PieSort::None
&& percent(g.column_width)
&& percent(g.cluster_width)
&& [g.tick_marks, g.right_tick_marks, g.category_tick_marks].iter().all(|m| *m <= MAX_TICK_MARKS)
}
/// A value axis' `useManualValues`, lowest and highest value and `betweenValue`: automatic (no tick
/// count and no values), or a whole number of divisions (1 to [`MAX_DIVISIONS`]) between a lowest
/// and a higher highest value, which the reader reads back as the same count.
fn axis(ticks: usize, min: Option<f64>, max: Option<f64>) -> Option<(bool, f64, f64, f64)> {
match (ticks, min, max) {
(0, None, None) => Some((false, 0.0, 0.0, 0.0)),
(1..=MAX_DIVISIONS, Some(lo), Some(hi)) if lo.is_finite() && hi.is_finite() && hi > lo => {
let step = (hi - lo) / ticks as f64;
let n = (hi - lo) / step;
let exact = step > 0.0 && step.is_finite() && (n - n.round()).abs() <= 1e-6 * n.round().max(1.0) && n.round() == ticks as f64;
exact.then_some((true, lo, hi, step))
}
_ => None,
}
}
/// Whether `n` and everything in it is shown.
fn all_shown(n: &Node) -> bool {
n.visible && n.children().is_none_or(|c| c.iter().all(|c| all_shown(c)))
}
/// Whether `n` is shown, fully opaque, in Normal mode, not isolated and without an opacity mask or
/// effects: the reader keeps a series' paint only from groups and paths drawn so.
fn as_drawn(n: &Node) -> bool {
n.visible
&& n.opacity == 1.0
&& n.blend == BlendMode::Normal
&& !n.isolate
&& n.extras().mask.is_none()
&& !n.appearance.effects.iter().any(|e| e.visible)
}
/// The visible fill and line `p` is written with as one path object: a solid fill, and a solid
/// plain line with its weight, each opaque, in Normal mode and without effects of its own. `None`
/// when it has other paint, more than one of either, or isn't one path of one subpath.
#[allow(clippy::type_complexity)]
fn plain_paint(p: &Node) -> Option<(Option<Paint>, Option<(Paint, f64)>)> {
let NodeKind::Path { path, guide: false, clipping: false, .. } = &p.kind else { return None };
(path.subpaths.iter().filter(|sp| !sp.anchors.is_empty()).count() == 1).then_some(())?;
let (mut fill, mut line) = (None, None);
for item in &p.appearance.items {
let drawn = match item {
AppearanceItem::Fill(f) => f.visible && !f.paint.is_none(),
AppearanceItem::Stroke(s) => s.visible && !s.paint.is_none() && s.width > 0.0 && s.width.is_finite(),
};
if !drawn {
// The writers leave out what draws nothing; the reader reads nothing in its place.
continue;
}
let plain =
item.opacity() == 1.0 && item.blend() == BlendMode::Normal && item.effects().is_empty() && matches!(item.paint(), Paint::Solid { .. });
plain.then_some(())?;
match item {
AppearanceItem::Fill(f) if fill.is_none() && line.is_none() => fill = Some(f.paint.clone()),
AppearanceItem::Stroke(s) if line.is_none() && stroke::is_plain(s) => line = Some((s.paint.clone(), s.width)),
_ => return None,
}
}
Some((fill, line))
}
/// The `Go` line of each series' group among `children`: a group whose series index is one of the
/// `series` the table has, each once, of paths [`as_drawn`] with one fill and one line alike
/// ([`plain_paint`]), every path filled unless the graph draws lines (`line`). Its column is the
/// table's: after the label column when there is one (`first_col`). `None` when a series has no
/// such group.
fn series_groups(children: &[std::sync::Arc<Node>], series: usize, first_col: usize, line: bool) -> Option<HashMap<NodeId, String>> {
let mut tags = HashMap::new();
let mut seen = vec![false; series];
for c in children {
let Some(s) = c.extras().series_index else { continue };
let s = usize::try_from(s).ok().filter(|s| *s < series)?;
let slot = seen.get_mut(s)?;
(!*slot).then_some(())?;
*slot = true;
let NodeKind::Group { children: paths, clip: false } = &c.kind else { return None };
(as_drawn(c) && *c.appearance == Appearance::default() && !paths.is_empty()).then_some(())?;
let mut paints = vec![];
for p in paths {
as_drawn(p).then_some(())?;
paints.push(plain_paint(p)?);
}
let fill = paints.iter().find_map(|(f, _)| f.clone());
paints.iter().all(|(f, _)| f.is_none() || *f == fill).then_some(())?;
(line || paints.iter().all(|(f, _)| f.is_some())).then_some(())?;
let stroke = paints.first().and_then(|(_, s)| s.clone());
paints.iter().all(|(_, s)| *s == stroke).then_some(())?;
tags.insert(c.id, format!("%_2 {} 0 0 Go", s + first_col));
}
seen.iter().all(|s| *s).then_some(tags)
}
/// Whether `art` draws plot `plot`'s left edge and its bottom edge (the document's y runs down) as
/// straight lines, each a shown path of one subpath with a plain line ([`plain_paint`]) in a shown
/// group, as the reader finds the axes.
fn draws_axes(art: &Node, plot: Rect) -> bool {
let near = |a: Point, b: Point| (a - b).hypot() <= EDGE;
let on = |s: &PathSeg, a: Point, b: Point| match s {
PathSeg::Line(l) => (near(l.p0, a) && near(l.p1, b)) || (near(l.p0, b) && near(l.p1, a)),
_ => false,
};
let (top_left, bottom_left, bottom_right) = (Point::new(plot.x0, plot.y0), Point::new(plot.x0, plot.y1), Point::new(plot.x1, plot.y1));
let (mut left, mut bottom) = (false, false);
let mut stack = vec![art];
while let Some(n) = stack.pop() {
if !n.visible || n.opacity <= 0.0 || (left && bottom) {
continue;
}
match &n.kind {
NodeKind::Group { children, clip: false } => stack.extend(children.iter().map(|c| &**c)),
NodeKind::Path { path, .. } if plain_paint(n).is_some_and(|(_, line)| line.is_some()) => {
for s in path.to_bezpath().segments() {
left |= on(&s, top_left, bottom_left);
bottom |= on(&s, bottom_left, bottom_right);
}
}
_ => {}
}
}
left && bottom
}
/// Graphs built as the graph tools draw them, for the writers' tests.
#[cfg(test)]
pub(crate) mod sample {
use std::sync::Arc;
use vectorcraft_color::{Color, Paint};
use vectorcraft_doc::{Document, GraphKind, GraphSpec, Node, PieSort, TickLength, ValueAxisSide};
use vectorcraft_geom::{PathData, Point, Rect, shapes};
use super::Appearance;
/// A graph of kind `kind`: series East and West, categories Q1 to Q3, West blank in Q2, on the
/// plot 100 100 300 250.
pub(crate) fn spec(kind: GraphKind) -> GraphSpec {
let mut g = GraphSpec {
kind,
rect: Rect::new(100.0, 100.0, 300.0, 250.0),
series: vec!["East".into(), "West".into()],
categories: vec!["Q1".into(), "Q2".into(), "Q3".into()],
..GraphSpec::default()
};
g.set_cells(vec![vec![Some(5.0), Some(3.0)], vec![Some(7.0), None], vec![Some(4.0), Some(6.0)]]);
g
}
fn path(doc: &mut Document, p: PathData, fill: Paint, stroke: Paint) -> Arc<Node> {
Arc::new(Node::path(doc.alloc_id(), p, Appearance::basic(fill, stroke, 1.0)))
}
/// Graph `g` drawn as a group: a group of each series' marks (a line graph's series as an unfilled
/// line, the others' as filled columns), its axes on the plot's left and bottom edges, and a
/// legend of a swatch for each series; its series groups named after the series.
pub(crate) fn graph(doc: &mut Document, g: GraphSpec) -> Node {
let r = g.rect;
let cells = g.cells();
let width = cells.first().map_or(0, Vec::len);
let mut members = vec![];
let axes = vec![
path(doc, shapes::line(Point::new(r.x0, r.y0), Point::new(r.x0, r.y1)), Paint::None, Paint::solid(Color::BLACK)),
path(doc, shapes::line(Point::new(r.x0, r.y1), Point::new(r.x1, r.y1)), Paint::None, Paint::solid(Color::BLACK)),
];
members.push(Arc::new(Node::group(doc.alloc_id(), axes)));
for s in 0..width {
let gray = Paint::solid(Color::gray(0.2 + 0.3 * s as f32));
let points: Vec<Point> = cells
.iter()
.enumerate()
.filter_map(|(c, row)| {
row.get(s).copied().flatten().map(|v| Point::new(r.x0 + 20.0 + 60.0 * c as f64 + 15.0 * s as f64, r.y1 - v * 10.0))
})
.collect();
let marks: Vec<Arc<Node>> = if g.kind == GraphKind::Line {
let mut bp = kurbo::BezPath::new();
for (i, p) in points.iter().enumerate() {
if i == 0 { bp.move_to(*p) } else { bp.line_to(*p) }
}
vec![path(doc, PathData::from_bezpath(&bp), Paint::None, gray)]
} else {
points.iter().map(|p| path(doc, shapes::rectangle(Rect::new(p.x, p.y, p.x + 10.0, r.y1)), gray.clone(), Paint::None)).collect()
};
let mut series = Node::group(doc.alloc_id(), marks);
series.name = Some(g.series.get(s).cloned().unwrap_or_else(|| format!("Series {}", s + 1)));
series.extras_mut().series_index = Some(s as u32);
members.push(Arc::new(series));
}
let swatches: Vec<Arc<Node>> = (0..width)
.map(|s| {
let y = r.y0 + 12.0 * s as f64;
path(
doc,
shapes::rectangle(Rect::new(r.x1 + 10.0, y, r.x1 + 18.0, y + 8.0)),
Paint::solid(Color::gray(0.2 + 0.3 * s as f32)),
Paint::None,
)
})
.collect();
members.push(Arc::new(Node::group(doc.alloc_id(), swatches)));
let mut n = Node::group(doc.alloc_id(), members);
n.extras_mut().graph = Some(Box::new(g));
n
}
/// A 400 × 300 document holding `g` drawn by [`graph`] on its layer.
pub(crate) fn document(g: GraphSpec) -> Document {
let mut doc = Document::new(400.0, 300.0);
let layer = doc.layers[0].id;
let n = graph(&mut doc, g);
doc.insert(Some(layer), usize::MAX, n).unwrap();
doc
}
/// Graphs whose records read back whole: each type the records give, every setting they keep
/// changed, labels with parentheses, backslashes and non-ASCII characters, a label of 255 bytes,
/// and a table without labels.
pub(crate) fn kept() -> Vec<(&'static str, Document)> {
let mut cases = vec![
("column", document(spec(GraphKind::Column))),
("stacked column", document(spec(GraphKind::StackedColumn))),
("line", document(spec(GraphKind::Line))),
("area", document(spec(GraphKind::Area))),
];
let mut g = spec(GraphKind::Column);
(g.drop_shadow, g.first_row_in_front, g.first_column_in_front, g.legend_across_top) = (true, true, true, true);
(g.mark_points, g.connect_points, g.edge_to_edge) = (false, false, true);
(g.column_width, g.cluster_width) = (120.0, 50.0);
(g.tick_length, g.tick_marks, g.ticks, g.axis_min, g.axis_max) = (TickLength::Full, 3, 4, Some(0.0), Some(20.0));
(g.right_tick_length, g.right_tick_marks, g.right_ticks, g.right_axis_min, g.right_axis_max) = (TickLength::None, 2, 5, Some(1.0), Some(6.0));
(g.category_tick_length, g.category_tick_marks, g.ticks_between_labels) = (TickLength::Short, 2, true);
(g.prefix, g.suffix, g.right_prefix, g.right_suffix) = ("($".into(), "\\)".into(), "é".into(), " u".into());
cases.push(("settings", document(g)));
let mut g = spec(GraphKind::Column);
g.series = vec!["A (1)".into(), "B\\2".into()];
g.categories = vec![String::new(), "naïve".into(), "a".repeat(255)];
g.set_cells(vec![vec![Some(1.0 / 3.0), Some(1e-7)], vec![None, Some(2.5)], vec![Some(12.0), None]]);
cases.push(("labels", document(g)));
let mut g = spec(GraphKind::Column);
(g.series, g.categories) = (vec![], vec![]);
cases.push(("no labels", document(g)));
cases
}
/// Graphs the records can't give as they are, which are written as their art: the five other
/// types, settings the reader doesn't keep, a table it can't hold, and art it can't attach the
/// graph to.
pub(crate) fn unkept() -> Vec<(&'static str, Document)> {
let with = |f: &dyn Fn(&mut GraphSpec)| {
let mut g = spec(GraphKind::Column);
f(&mut g);
document(g)
};
let mut cases: Vec<(&'static str, Document)> = [GraphKind::Bar, GraphKind::StackedBar, GraphKind::Scatter, GraphKind::Pie, GraphKind::Radar]
.into_iter()
.map(|k| (k.id(), document(spec(k))))
.collect();
cases.extend([
("no legend", with(&|g| g.legend = false)),
("filled lines", with(&|g| (g.kind, g.filled_lines) = (GraphKind::Line, true))),
("a series of another type", with(&|g| g.series_kinds = vec![None, Some(GraphKind::Line)])),
("a marker design", with(&|g| g.series_markers = vec![Some("Star".into())])),
("a column design", with(&|g| g.series_columns = vec![Some(Default::default())])),
("label formatting", with(&|g| g.label_styles.values = Some(Default::default()))),
("a value axis on both sides", with(&|g| g.value_axis = ValueAxisSide::Both)),
("a series on the right axis", with(&|g| g.right_series = vec![1])),
("pie settings", with(&|g| g.pie_sort = PieSort::All)),
("a manual axis without its values", with(&|g| g.ticks = 4)),
("values without a tick count", with(&|g| (g.axis_min, g.axis_max) = (Some(0.0), Some(10.0)))),
("101 divisions", with(&|g| (g.ticks, g.axis_min, g.axis_max) = (101, Some(0.0), Some(101.0)))),
("too many tick marks", with(&|g| g.tick_marks = 21)),
("a column width past 1000%", with(&|g| g.column_width = 1001.0)),
("a long prefix", with(&|g| g.prefix = "0123456789".into())),
("a line break in a label", with(&|g| g.series[0] = "East\nside".into())),
("a label of 256 bytes", with(&|g| g.categories[0] = "a".repeat(256))),
("a value that isn't finite", with(&|g| g.rows[0][0] = f64::NAN)),
("only blank cells", with(&|g| g.set_cells(vec![vec![None, None]; 3]))),
("fewer labels than series", with(&|g| g.series.truncate(1))),
]);
let drawn = |what: &'static str, f: &dyn Fn(&mut Vec<Arc<Node>>)| {
let mut doc = Document::new(400.0, 300.0);
let mut n = graph(&mut doc, spec(GraphKind::Column));
if let Some(c) = n.children_mut() {
f(c);
}
let layer = doc.layers[0].id;
doc.insert(Some(layer), usize::MAX, n).unwrap();
(what, doc)
};
cases.extend([
drawn("a series without its group", &|c| {
c.remove(2);
}),
drawn("no axes", &|c| {
c.remove(0);
}),
drawn("a hidden legend", &|c| {
if let Some(l) = c.last_mut() {
Arc::make_mut(l).visible = false;
}
}),
drawn("a series drawn half opaque", &|c| Arc::make_mut(&mut c[1]).opacity = 0.5),
drawn("a series mark with a gradient", &|c| {
let g = vectorcraft_color::Gradient::new(
vectorcraft_color::GradientKind::Linear,
vec![vectorcraft_color::GradientStop::new(0.0, Color::BLACK), vectorcraft_color::GradientStop::new(1.0, Color::WHITE)],
);
let series = Arc::make_mut(&mut c[1]);
if let Some(marks) = series.children_mut() {
let mark = Arc::make_mut(&mut marks[0]);
mark.appearance = Appearance::basic(Paint::Gradient(Box::new(vectorcraft_color::GradientPaint::new(g))), Paint::None, 0.0).into();
}
}),
]);
cases
}
/// The graphs in `doc`, each with the series index of its members.
pub(crate) fn graphs(doc: &Document) -> Vec<(GraphSpec, Vec<Option<u32>>)> {
let mut out = vec![];
doc.walk(|n| {
if let Some(g) = n.extras().graph.as_deref() {
out.push((g.clone(), n.children().map(|c| c.iter().map(|c| c.extras().series_index).collect()).unwrap_or_default()));
}
});
out
}
/// Whether `read` is the graph `written` was: the same data and settings, the plot in the same
/// place; its series' paint is the art's and its bounds are the art's as read.
pub(crate) fn same(written: &GraphSpec, read: &GraphSpec) -> bool {
let near = |a: Rect, b: Rect| (a.x0 - b.x0).abs() + (a.y0 - b.y0).abs() + (a.x1 - b.x1).abs() + (a.y1 - b.y1).abs() < 1e-6;
let plain = |g: &GraphSpec| GraphSpec {
rect: Rect::ZERO,
rows: vec![],
blanks: vec![],
series_paints: vec![],
placed: None,
placed_art: None,
series_kinds: vec![],
..g.clone()
};
near(written.rect, read.rect) && written.cells() == read.cells() && plain(written) == plain(read)
}
}
#[cfg(test)]
mod tests {
use super::*;
/// Numbers are written so they read back the same, small and large ones included.
#[test]
fn numbers_read_back_as_written() {
for v in [0.0, 1.0, -2.5, 1.0 / 3.0, 1e-7, 123_456_789_012_345_678.0, f64::MAX, f64::MIN_POSITIVE] {
assert_eq!(real(v).parse::<f64>().ok(), Some(v), "{v}");
}
}
/// A graph of `categories` rows of `series` values, drawn by [`sample::graph`].
fn sized(categories: usize, series: usize) -> Node {
let mut g = sample::spec(GraphKind::Column);
(g.series, g.categories) = (vec![], vec![]);
g.set_cells(vec![vec![Some(1.0); series]; categories]);
sample::graph(&mut vectorcraft_doc::Document::new(400.0, 300.0), g)
}
/// The table the reader holds: up to 10,000 categories and 256 series; past them, the graph is
/// its art.
#[test]
fn tables_up_to_the_readers_limits_are_written() {
assert!(records(&sized(MAX_GRAPH_CATEGORIES, 1), Affine::IDENTITY).is_some_and(|r| r.head.contains("%_10000 1 0 0 Gz\n")));
assert!(records(&sized(MAX_GRAPH_CATEGORIES + 1, 1), Affine::IDENTITY).is_none());
assert!(records(&sized(1, MAX_GRAPH_SERIES), Affine::IDENTITY).is_some_and(|r| r.tags.len() == MAX_GRAPH_SERIES));
assert!(records(&sized(1, MAX_GRAPH_SERIES + 1), Affine::IDENTITY).is_none());
}
/// Tick-mark counts of 0, which mean one tick mark as 1 does, are written as 1, the count the
/// reader reads back.
#[test]
fn tick_mark_counts_of_0_are_written_as_1() {
let mut g = sample::spec(GraphKind::Column);
(g.tick_marks, g.right_tick_marks, g.category_tick_marks) = (0, 0, 0);
let n = sample::graph(&mut vectorcraft_doc::Document::new(400.0, 300.0), g);
let head = records(&n, Affine::IDENTITY).map(|r| r.head).unwrap_or_default();
let marks: Vec<&str> = head.lines().filter(|l| l.ends_with(" GA")).map(|l| l.split(' ').nth(5).unwrap_or("")).collect();
assert_eq!(marks, ["1", "1", "1"], "{head}");
}
/// A table's cells go fifteen to a record, with one string at most in each.
#[test]
fn cells_go_fifteen_to_a_record_with_one_string_each() {
let mut out = String::new();
let mut t = Table::new(&mut out);
t.text("a");
t.text("b");
for v in 0..16 {
t.num(f64::from(v));
}
t.finish();
let records: Vec<&str> = out.lines().collect();
assert_eq!(records[0], "%_(a) Gc");
assert_eq!(records[1], "%_(b) 0 1 2 3 4 5 6 7 8 9 10 11 12 13 Gc");
assert_eq!(records[2], "%_14 15 Gc");
}
}
+31 -6
View File
@@ -10329,23 +10329,48 @@ fn a_brushed_path_with_samples_of_the_pen_keeps_its_drawn_look() {
assert_eq!(a.len(), 1, "{a:#?}");
assert!(matches!(a[0].kind, NodeKind::Group { .. }), "the drawn look: {a:#?}");
assert!(r.warnings.iter().any(|w| w.contains("drawn look")), "{:?}", r.warnings);
// The samples belong to the path before them: a path after them is read as it was.
let after = format!("{path}{RED}{}f\n", rect_path(0.0, 0.0, 10.0, 10.0));
// The samples belong to the path before them: a path after them with the same brush and no
// samples of its own comes in brushed.
let after = format!("{path}{}", brushed_path());
let a = art(&read_ok(&format!("{def}{style}{}", layer(&after))).doc);
assert_eq!(a.len(), 2, "{a:#?}");
assert!(matches!(a[1].kind, NodeKind::Path { .. }) && a[1].appearance.fill().is_some(), "{a:#?}");
assert!(matches!(a[0].kind, NodeKind::Group { .. }), "the sampled path's drawn look: {a:#?}");
assert!(matches!(a[1].kind, NodeKind::Path { .. }), "the path after the samples, brushed: {a:#?}");
assert_eq!(a[1].appearance.stroke().and_then(|s| s.brush.as_deref()), Some("Six D"), "{a:#?}");
// Samples with no object before them in the layer mark nothing: the path after them is read.
let first = format!("{PEN_SAMPLES}{}", brushed_path());
let a = art(&read_ok(&format!("{def}{style}{}", layer(&first))).doc);
assert_eq!(a.len(), 1, "{a:#?}");
assert!(matches!(a[0].kind, NodeKind::Path { .. }), "the path, brushed: {a:#?}");
// A brush whose modes are Fixed and Random, one whose pen modes vary by 0, and an Art brush
// don't follow the pen: the path comes in brushed.
// Each setting that follows the pen keeps the drawn look on its own, with the other two fixed:
// the diameter with the pressure or the tilt, the roundness with the bearing and the angle with
// the barrel's rotation.
let one_setting = [
("the diameter with the pressure", "1 4 8 40 40 30 30 2 0 0 0", [(6.0, 2.0), (40.0, 0.0), (30.0, 0.0)], [2, 0, 0]),
("the diameter with the tilt", "1 4 8 40 40 30 30 4 0 0 0", [(6.0, 2.0), (40.0, 0.0), (30.0, 0.0)], [4, 0, 0]),
("the roundness with the bearing", "1 6 6 30 50 30 30 0 5 0 0", [(6.0, 0.0), (40.0, 10.0), (30.0, 0.0)], [0, 5, 0]),
("the angle with the rotation", "1 6 6 40 40 -150 210 0 0 6 0", [(6.0, 0.0), (40.0, 0.0), (30.0, 180.0)], [0, 0, 6]),
];
for (why, params, settings, codes) in one_setting {
let def = plugin_object(CALLIGRAPHIC, "Six D", params);
let style = brushed_style("Six D", 0.5, settings, codes, 0);
let r = read_ok(&format!("{def}{style}{}", layer(&path)));
let a = art(&r.doc);
assert_eq!(a.len(), 1, "{why}: {a:#?}");
assert!(matches!(a[0].kind, NodeKind::Group { .. }), "{why}: the drawn look, {a:#?}");
assert!(r.warnings.iter().any(|w| w.contains("drawn look")), "{why}: {:?}", r.warnings);
}
// A brush whose modes are Fixed and Random, one whose pen modes vary by 0, one whose only
// varying setting is Random beside a pen setting that varies by 0, and an Art brush don't
// follow the pen: the path comes in brushed.
let fixed_def = plugin_object(CALLIGRAPHIC, "Six D", &SIX_D.replace(" 2 5 6 0", " 0 1 0 0"));
let fixed = brushed_style("Six D", 0.5, SIX_D_SETTINGS, [0, 1, 0], 0);
let even_def = plugin_object(CALLIGRAPHIC, "Six D", "1 6 6 40 40 30 30 2 5 6 0");
let even = brushed_style("Six D", 0.5, [(6.0, 0.0), (40.0, 0.0), (30.0, 0.0)], [2, 5, 6], 0);
for (why, def, style) in [("Fixed and Random", fixed_def, fixed), ("no variation", even_def, even)] {
let random_def = plugin_object(CALLIGRAPHIC, "Six D", "1 4 8 40 40 30 30 1 2 0 0");
let random = brushed_style("Six D", 0.5, [(6.0, 2.0), (40.0, 0.0), (30.0, 0.0)], [1, 2, 0], 0);
let cases = [("Fixed and Random", fixed_def, fixed), ("no variation", even_def, even), ("Random beside an even pen setting", random_def, random)];
for (why, def, style) in cases {
let r = read_ok(&format!("{def}{style}{}", layer(&path)));
let a = art(&r.doc);
assert_eq!(a.len(), 1, "{why}: {a:#?}");
+6 -2
View File
@@ -43,13 +43,17 @@
//! PostScript names in `%%DocumentFonts` and `%%IncludeFont` (§3.1) and re-encoded to
//! Windows-1252 (`TE`, then `%AI3_BeginEncoding: _name name`, `TZ`, §3.3), the 8-bit encoding
//! strings are in.
//! - Graphs (§17): a graph whose records VectorCraft's reader reads back as the same graph
//! (`crate::ai_graph`) as `%_Gs`, its functional records, its group with each series' group
//! followed by `%_2 column 0 0 Go`, and `%_GS`.
//!
//! The format has one artboard, no transparency, sublayers, object names, hidden objects (only
//! layers hide), live effects, symbols or appearances with several fills and strokes. Callers write
//! one file per artboard and expand appearances first; what is left is written as the format can
//! hold it, each loss a warning: transparent objects are written opaque, sublayers become groups,
//! live objects and symbols their art, strokes a plain line can't draw their outlines, pattern
//! fills their tiles clipped to the shape, freeform gradients their average colour, elliptical
//! live objects and symbols their art, other graphs their art, strokes a plain line can't draw
//! their outlines, pattern fills their tiles clipped to the shape, freeform gradients their average
//! colour, elliptical
//! radial gradients circular (the gradient matrix is relative to a canvas the specification
//! doesn't size), transparent image pixels over white. Hidden objects go to a hidden layer of
//! their own above their layer, are left out or show, as [`HiddenObjects`] says (in a hidden
+61
View File
@@ -2157,3 +2157,64 @@ fn a_stained_instance_is_written_in_its_stained_color() {
let text = String::from_utf8(write(&doc).bytes).unwrap();
assert!(text.contains("0 0 1 Xa") && !text.contains("1 0 0 Xa"), "{text}");
}
/// A graph whose records read back whole is written with them (§17), and opens again as the same
/// live graph: its table, type and settings, its series' groups tagged in order, without a warning
/// about graphs.
#[test]
fn graphs_are_written_with_their_records_and_open_live() {
use crate::ai_graph::sample;
for (what, doc) in sample::kept() {
let out = write(&doc);
assert!(!out.warnings.iter().any(|w| w == GRAPHS), "{what}: {:?}", out.warnings);
let text = String::from_utf8(out.bytes.clone()).unwrap();
assert_eq!((text.matches("%_Gs\n").count(), text.matches("%_GS\n").count()), (1, 1), "{what}: {text}");
let read = crate::import(&out.bytes).unwrap();
let written = sample::graphs(&doc);
let graphs = sample::graphs(&read.document);
assert_eq!(graphs.len(), 1, "{what}: {:?}", read.warnings);
assert!(sample::same(&written[0].0, &graphs[0].0), "{what}: {:#?}\n{:#?}", written[0].0, graphs[0].0);
assert_eq!(graphs[0].1, written[0].1, "{what}: the members and their series");
}
}
/// A graph inside a group is written with its records too, and opens on its own group.
#[test]
fn a_graph_in_a_group_is_written_with_its_records() {
use crate::ai_graph::sample;
let mut doc = Document::new(400.0, 300.0);
let graph = sample::graph(&mut doc, sample::spec(vectorcraft_doc::GraphKind::Column));
let frame = shape(&mut doc, shapes::rectangle(Rect::new(10.0, 10.0, 20.0, 20.0)), red(), Paint::None);
let outer = Node::group(doc.alloc_id(), vec![Arc::new(frame), Arc::new(graph)]);
let l = doc.layers[0].id;
doc.insert(Some(l), 0, outer).unwrap();
let out = write(&doc);
assert!(!out.warnings.iter().any(|w| w == GRAPHS), "{:?}", out.warnings);
let read = crate::import(&out.bytes).unwrap();
let graphs = sample::graphs(&read.document);
assert_eq!(graphs.len(), 1, "{:?}", read.warnings);
assert!(sample::same(&sample::graphs(&doc)[0].0, &graphs[0].0));
let layer = children(&read.document.layers[0]);
assert!(layer[0].extras().graph.is_none() && layer[0].children().is_some_and(|c| c.len() == 2), "{layer:#?}");
}
/// A graph whose records wouldn't read back as it is is written as its art, without records, with
/// the warning, and opens as that art.
#[test]
fn graphs_the_records_cant_keep_are_written_as_their_art() {
use crate::ai_graph::sample;
for (what, doc) in sample::unkept() {
let out = export_legacy_ai(&doc, &LegacyAiOptions::default()).unwrap();
assert!(out.warnings.iter().any(|w| w == GRAPHS), "{what}: {:?}", out.warnings);
let text = String::from_utf8_lossy(&out.bytes).into_owned();
assert!(!text.contains("%_Gs") && !text.contains(" Go\n") && !text.contains("%_GS"), "{what}: {text}");
let read = crate::import(&out.bytes).unwrap();
assert!(sample::graphs(&read.document).is_empty(), "{what}");
let paths = |d: &Document| {
let mut count = 0;
d.walk(|n| count += usize::from(matches!(n.kind, NodeKind::Path { .. })));
count
};
assert_eq!(paths(&read.document), paths(&doc), "{what}: the graph's art is kept");
}
}
+32 -2
View File
@@ -52,6 +52,8 @@ pub(super) struct Writer<'a> {
last_image: Option<(ImageBlob, Option<Arc<image::DynamicImage>>)>,
/// The images written whole so far, by the address of their data (which each entry keeps).
whole_images: std::collections::HashMap<usize, Arc<Vec<u8>>>,
/// Writing a graph's art with its records: a graph inside it is written as its art.
in_graph: bool,
}
impl<'a> Writer<'a> {
@@ -78,6 +80,7 @@ impl<'a> Writer<'a> {
clips: vec![],
last_image: None,
whole_images: std::collections::HashMap::new(),
in_graph: false,
}
}
@@ -264,7 +267,12 @@ impl<'a> Writer<'a> {
if n.name.as_deref().is_some_and(|s| !s.is_empty()) && !n.is_layer() {
self.warn(NAMES);
}
if n.extras().graph.is_some() {
// A graph on the layers keeps its data and settings when its records read back whole.
let graph = match n.extras().graph.is_some() {
true if self.nest == 0 && !self.in_graph => crate::ai_graph::records(n, self.to_art),
_ => None,
};
if n.extras().graph.is_some() && graph.is_none() {
self.warn(GRAPHS);
}
let locked = locked || n.locked;
@@ -273,7 +281,10 @@ impl<'a> Writer<'a> {
self.warn(SUBLAYERS);
self.group(children, *clip, locked);
}
NodeKind::Group { children, clip } => self.group(children, *clip, locked),
NodeKind::Group { children, clip } => match &graph {
Some(records) => self.graph(children, locked, records),
None => self.group(children, *clip, locked),
},
NodeKind::Path { path, rule, guide, .. } => {
self.lock(locked);
if *guide {
@@ -352,6 +363,25 @@ impl<'a> Writer<'a> {
}
}
/// A graph's group (`u` … `U`) between its records (§17): `%_Gs` and its functional records
/// before it, `%_GS` after it, and each series' group followed by its `Go` tag.
fn graph(&mut self, children: &[Arc<Node>], locked: bool, records: &crate::ai_graph::Records) {
self.lock(locked);
self.body.push_str(&records.head);
self.line("u");
self.in_graph = true;
for c in children {
self.node(c, locked);
if let Some(tag) = records.tags.get(&c.id) {
self.line(tag);
}
}
self.in_graph = false;
self.lock(locked);
self.line("U");
self.line(crate::ai_graph::END);
}
/// A clipping group: its first member's outline clips the others (`h W n`). That member's fills
/// paint behind the art, inside the clip, and its strokes over it, outside.
fn clip_group(&mut self, children: &[Arc<Node>], locked: bool) {
+2
View File
@@ -31,9 +31,11 @@
//! - `ai_editing`: the editing copy of the art a PDF-compatible `.ai` file carries
//! ([`export_ai_editing`], [`ai_private_data`]).
//! - `ai_ops`: the path and line style operators those two write.
//! - `ai_graph`: the records of a live graph those two write around its group.
//! - [`dcs`]: DCS files, an EPS file with one program per printing plate, read for placing.
mod ai_editing;
mod ai_graph;
mod ai_ops;
pub mod dcs;
mod import;
+2 -1
View File
@@ -81,6 +81,7 @@ pub(crate) fn pointer_kind(k: &str) -> Option<PointerKind> {
"up" => PointerKind::Up,
"move" => PointerKind::Move,
"doubleclick" | "dblclick" => PointerKind::DoubleClick,
"tripleclick" => PointerKind::TripleClick,
_ => return None,
})
}
@@ -238,7 +239,7 @@ impl Headless {
.map(|(e, backquote)| {
let mods = packet_mods(e)?.unwrap_or(base);
let kind = s(e, "kind").unwrap_or("");
let kind = pointer_kind(kind).ok_or_else(|| format!("unknown pointer kind `{kind}` (down|drag|up|move|doubleclick)"))?;
let kind = pointer_kind(kind).ok_or_else(|| format!("unknown pointer kind `{kind}` (down|drag|up|move|doubleclick|tripleclick)"))?;
PointerEvent::json_check(e)?;
if s(e, "space") == Some("screen") {
return Err("screen-space pointer events need the desktop app; use document coordinates".to_string());
+1
View File
@@ -16,6 +16,7 @@ mod gradient;
mod limits;
mod links;
mod liquify;
mod livepaint;
mod pen;
mod persp;
mod place;
+73
View File
@@ -0,0 +1,73 @@
//! The Live Paint Bucket through MCP: `pointer_gesture` sends a triple-click as `tripleclick`.
use serde_json::{Value, json};
use crate::{Backend, Headless, call_tool};
fn ok(h: &mut Headless, name: &str, args: Value) -> Value {
let r = call_tool(h, name, &args);
assert!(!r.is_error, "{name} {args}: {r:?}");
serde_json::from_str(r.content[0]["text"].as_str().unwrap()).unwrap_or(Value::Null)
}
fn run(h: &mut Headless, command: &str, params: Value) -> Value {
ok(h, "run_command", json!({"command": command, "params": params}))
}
/// The fill of each face of Live Paint group `g`, left to right.
fn fills(h: &mut Headless, g: &Value) -> Vec<Value> {
let info = run(h, "livePaint.info", json!({"group": g}));
let mut faces = info["faces"].as_array().unwrap().clone();
faces.sort_by(|a, b| a["bounds"][0].as_f64().unwrap().total_cmp(&b["bounds"][0].as_f64().unwrap()));
faces.iter().map(|f| f["fill"].clone()).collect()
}
#[test]
fn a_triple_click_fills_every_face_of_the_same_fill() {
let mut h = Headless::new();
h.call("engine.execute", json!({"command": "file.new", "params": {"width": 300, "height": 300}})).unwrap();
let a = run(&mut h, "shape.rectangle", json!({"x": 0, "y": 0, "width": 50, "height": 50}))["id"].clone();
let b = run(&mut h, "shape.rectangle", json!({"x": 100, "y": 0, "width": 50, "height": 50}))["id"].clone();
let g = run(&mut h, "livePaint.make", json!({"ids": [a, b]}))["id"].clone();
for x in [25, 125] {
run(&mut h, "livePaint.fill", json!({"group": g, "point": [x, 25], "color": "#ff0000"}));
}
let red = fills(&mut h, &g);
assert_eq!(red[0], red[1]);
// With nothing selected, the current fill changes and the group keeps its faces' fills.
run(&mut h, "select.none", json!({}));
run(&mut h, "paint.setFill", json!({"color": "#00ff00"}));
assert_eq!(fills(&mut h, &g), red);
let ev = |kind: &str| json!({"kind": kind, "x": 25, "y": 25});
let clicks = [ev("down"), ev("up"), ev("down"), ev("up"), ev("doubleclick"), ev("down"), ev("up")];
ok(&mut h, "pointer_gesture", json!({"tool": "livePaintBucket", "events": clicks}));
let after_two = fills(&mut h, &g);
assert_eq!(after_two[1], red[1], "the face apart is left by the clicks and the double-click");
assert_ne!(after_two[0], red[0]);
ok(&mut h, "pointer_gesture", json!({"events": [ev("tripleclick")]}));
assert_eq!(fills(&mut h, &g), [after_two[0].clone(), after_two[0].clone()], "both faces were red");
}
/// With Space held (`mods.space`), the Live Paint Bucket's clicks, double-click and triple-click
/// paint nothing.
#[test]
fn clicks_with_space_held_paint_nothing() {
let mut h = Headless::new();
h.call("engine.execute", json!({"command": "file.new", "params": {"width": 300, "height": 300}})).unwrap();
let a = run(&mut h, "shape.rectangle", json!({"x": 0, "y": 0, "width": 50, "height": 50}))["id"].clone();
let b = run(&mut h, "shape.rectangle", json!({"x": 100, "y": 0, "width": 50, "height": 50}))["id"].clone();
let g = run(&mut h, "livePaint.make", json!({"ids": [a, b]}))["id"].clone();
for x in [25, 125] {
run(&mut h, "livePaint.fill", json!({"group": g, "point": [x, 25], "color": "#ff0000"}));
}
run(&mut h, "select.none", json!({}));
run(&mut h, "paint.setFill", json!({"color": "#00ff00"}));
let red = fills(&mut h, &g);
let ev = |kind: &str| json!({"kind": kind, "x": 25, "y": 25});
let clicks = [ev("down"), ev("up"), ev("down"), ev("up"), ev("doubleclick"), ev("down"), ev("up"), ev("tripleclick")];
ok(&mut h, "pointer_gesture", json!({"tool": "livePaintBucket", "mods": {"space": true}, "events": clicks}));
assert_eq!(fills(&mut h, &g), red);
// Without Space, the same clicks paint.
ok(&mut h, "pointer_gesture", json!({"events": [ev("down"), ev("up")]}));
assert_ne!(fills(&mut h, &g)[0], red[0]);
}
+2 -2
View File
@@ -205,7 +205,7 @@ pub fn tool_definitions() -> Vec<Value> {
"type": "array",
"minItems": 1,
"items": obj(json!({
"kind": {"type": "string", "enum": ["down", "drag", "up", "move", "doubleclick"]},
"kind": {"type": "string", "enum": ["down", "drag", "up", "move", "doubleclick", "tripleclick"]},
"x": num("Document x (pt)"),
"y": num("Document y (pt)"),
"mods": mods_schema(),
@@ -465,7 +465,7 @@ pub fn tool_definitions() -> Vec<Value> {
tool(
"transform",
"Transform",
"Move, rotate, scale, reflect or shear the selection (or `ids`); several may be combined and run in that order. Angles in degrees (counter-clockwise), scale in %. `origin` [x,y] defaults to the selection centre; `copy` transforms a copy.",
"Move, rotate, scale, reflect or shear the selection (or `ids`); several may be combined and run in that order. Angles in degrees (counter-clockwise), scale in %. Scale and reflect act along the selection's bounding box, turned with rotated objects until Reset Bounding Box. `origin` [x,y] defaults to the selection centre; `copy` transforms a copy.",
obj(
json!({
"ids": {"type": "array", "items": {"type": "integer"}},
+1 -1
View File
@@ -145,7 +145,7 @@ fn dispatch(b: &mut dyn Backend, name: &str, a: &Args) -> Result<ToolResult, Str
for (i, e) in events.iter().enumerate() {
let kind = e.get("kind").and_then(Value::as_str).unwrap_or("");
if crate::headless::pointer_kind(kind).is_none() {
return Err(format!("event {i}: unknown kind `{kind}` (down, drag, up, move, doubleclick)"));
return Err(format!("event {i}: unknown kind `{kind}` (down, drag, up, move, doubleclick, tripleclick)"));
}
if !e.get("x").is_some_and(Value::is_number) || !e.get("y").is_some_and(Value::is_number) {
return Err(format!("event {i}: numeric `x` and `y` required"));
+12
View File
@@ -1087,6 +1087,12 @@ pub const UI_COMMANDS: &[(&str, &str, &str, &str)] = &[
"",
"{objects?: [paths|shapes|text|images|effects|groups|linkedFiles|guides], layers?: [locked|hidden]} set the Layers panel's Filter (By Object, By Layer): a row stays when it is of a kind in `objects` and in a state in `layers` (its own lock or eye; an empty list takes every row), or when a row inside it stays; Search All narrows the rows further. A key left out keeps its list. The filter lasts the session and does not change the document, its open rows or the selection → {objects, layers}",
),
(
"ui.panelView",
"Set Panel View",
"",
"{panel: swatches|graphicStyles|symbols, view?} set a panel's view, as the view items of its panel menu do: for swatches smallThumb|mediumThumb (the default)|largeThumb|smallList|largeList, for graphicStyles and symbols thumbnail (the default)|smallList|largeList; without `view`, answer the current one. The view lasts the session and does not change the document; an unknown panel or view is an error and changes nothing → {panel, view}",
),
(
"ui.tileEdgeColor",
"Tile Edge Color…",
@@ -1455,6 +1461,12 @@ pub const UI_COMMANDS: &[(&str, &str, &str, &str)] = &[
"",
"{id?} show the file of linked image `id` (default: the selected linked image) in the system's file manager → {path}",
),
(
"links.copyInfo",
"Copy Info",
"",
"{ids?} copy the file names of images and placed documents `ids` (default: the selected ones and the rows picked in the Links panel, in links.list order) to the clipboard, one per line in that order; an embedded image gives the name its Links panel row shows (Links panel menu) → {text, names}",
),
(
"ui.placementOptionsDialog",
"Placement Options…",
+3
View File
@@ -14,6 +14,9 @@ pub(super) struct Content<'a> {
pub(super) cache: Option<usize>,
/// Document-space bounds of the painted content.
pub(super) reach: Rect,
/// `reach` before the effects of an earlier part of a split stack spread it: the bounds Radial
/// Blur's Blur Center is placed in, so the center stays put wherever the stack splits.
pub(super) object: Rect,
/// Its silhouette: Feather and Inner Glow clip to it (without one, Feather only blurs and
/// Inner Glow is skipped).
pub(super) outline: Option<(&'a BezPath, FillRule)>,
+5 -1
View File
@@ -241,7 +241,10 @@ impl Renderer {
outline: feather_outline(&chain, content, content.reach.origin()),
});
let (center, extent) = (content.reach.center(), 0.5 * content.reach.width().hypot(content.reach.height()));
let space = effects::PixelSpace { to_doc, px, center, channels, line, extent };
// The Blur Center lies in the object's bounds; a split stack's later part spreads `reach`
// evenly, so the centre stays the same.
let size = content.object.size().to_vec2();
let space = effects::PixelSpace { to_doc, px, center, size, channels, line, extent };
let (wz, hz) = (wu as usize, hu as usize);
// What the content covers after the effects run so far: Rasterize makes its image over it.
let mut bounds = content.bounds.unwrap_or(content.reach);
@@ -708,6 +711,7 @@ impl Renderer {
owner: None,
cache: Some((j + 1) << 8),
reach: ib.inflate(outset, outset),
object: ib.inflate(outset, outset),
outline: Some((&outline, orule)),
bounds,
kept: None,
+13 -2
View File
@@ -389,7 +389,7 @@ impl Renderer {
let bounds = rasterize_bounds(f.symbols, n, &rfx);
// Under Rasterize the content reaches as far as its fills' and strokes' raster effects paint.
let reach = bounds.map_or(reach, |b| reach.union(b));
let content = Content { node: n, owner: None, cache: Some(0), reach, outline: Some((g, rule)), bounds, kept: None };
let content = Content { node: n, owner: None, cache: Some(0), reach, object: reach, outline: Some((g, rule)), bounds, kept: None };
let mut items = items;
self.raster_fx(ctx, f, &content, &rfx, &mut |r, c, fr| r.paint_items(c, fr, paints, g, rule, &gctx, items.as_deref_mut()));
ctx.set_transform(Affine::IDENTITY);
@@ -447,7 +447,16 @@ impl Renderer {
None => rasterize_bounds(f.symbols, a, &rfx),
};
let reach = bounds.map_or(reach, |b| reach.union(b));
let content = Content { node: a, owner: Some(a), cache, reach, outline: region.as_deref().map(|r| (&r.0, r.1)), bounds, kept: None };
let content = Content {
node: a,
owner: Some(a),
cache,
reach,
object: reach,
outline: region.as_deref().map(|r| (&r.0, r.1)),
bounds,
kept: None,
};
self.raster_fx(ctx, f, &content, &rfx, &mut |r, c, fr| r.draw_fx_art(c, fr, a, &art));
ctx.set_transform(Affine::IDENTITY);
}
@@ -771,6 +780,7 @@ impl Renderer {
owner: content.owner,
cache: None,
reach: content.reach,
object: content.object,
outline: content.outline,
bounds: content.bounds,
kept: kept.as_ref(),
@@ -783,6 +793,7 @@ impl Renderer {
owner: content.owner,
cache: content.cache.filter(|_| !over),
reach,
object: content.object,
outline,
bounds: spread,
kept: content.kept.filter(|_| split == at),
+8 -6
View File
@@ -110,6 +110,8 @@ pub(crate) fn svg_filters(svg: &str, room: usize, taken: impl Fn(&str) -> bool)
return Err(too_deep());
}
let xml = parse(svg)?;
// Before the style cascade of `depth::height`, as `import` measures it.
budget::check(&xml, budget::Cost::LIMITS, depth::MAX_ELEMENT_DEPTH)?;
if depth::height(&xml, depth::MAX_ELEMENT_DEPTH).is_none() {
return Err(too_deep());
}
@@ -139,7 +141,7 @@ pub(crate) fn import_finding(
let xml = parse(svg)?;
// Before the style cascade of `depth::height` and the prepass, which keeps the declarations of
// each element it reads; measured again below on the text usvg reads when that differs.
let styles = budget::check(&xml, budget::MAX_COPIED_STYLES, depth::MAX_ELEMENT_DEPTH)?;
let spent = budget::check(&xml, budget::Cost::LIMITS, depth::MAX_ELEMENT_DEPTH)?;
let Some(height) = depth::height(&xml, depth::MAX_ELEMENT_DEPTH) else {
return Err(too_deep());
};
@@ -160,13 +162,13 @@ pub(crate) fn import_finding(
let text_xml = found.text_source.as_deref().map(parse).transpose()?;
let (src, slots) = text::prepare(svg, &xml, text_xml.as_ref(), units.dpi, &mut warnings);
// Before usvg copies what `<use>`s show and the style values of each copy: the text usvg reads.
let styles = match &src {
Cow::Borrowed(_) if !rewritten => styles,
Cow::Borrowed(_) => budget::check(&xml, budget::MAX_COPIED_STYLES, usize::MAX)?,
Cow::Owned(prepared) => budget::check(&parse(prepared)?, budget::MAX_COPIED_STYLES, usize::MAX)?,
let spent = match &src {
Cow::Borrowed(_) if !rewritten => spent,
Cow::Borrowed(_) => budget::check(&xml, budget::Cost::LIMITS, usize::MAX)?,
Cow::Owned(prepared) => budget::check(&parse(prepared)?, budget::Cost::LIMITS, usize::MAX)?,
};
let files = found.files;
files.copied_styles(styles);
files.spent_by_svg(spent);
let tree = {
let opt = usvg::Options {
dpi: units.dpi as f32,
+295 -51
View File
@@ -20,13 +20,23 @@
//! would leave it out.
//!
//! The style sheets' rules are matched against each element once, as usvg matches them against
//! each copy.
//! each copy. usvg tests a selector against an element without keeping what it found, so a
//! selector whose leftmost part matches nothing can test every set of ancestors in turn: the tests
//! usvg makes for each copy are counted, and an SVG past [`MAX_SELECTOR_TESTS`] of them is refused.
//! A look at an attribute counts one test for every 16 attributes of the element it scans, and one
//! for every 16 bytes of the value it compares. Matching stops once the tests pass what is left of
//! the limit.
//!
//! The import's own style cascade (`css::Styles`) keeps the declarations of the rules that match
//! each element, once per element, and reads selectors usvg drops (`:not()`). What it keeps and the
//! tests it makes count toward the same limits, measured before it runs.
use std::cell::Cell;
use std::collections::{HashMap, HashSet};
use usvg::roxmltree;
use super::{MAX_NODES, SVG_NS, XNode};
use super::{MAX_NODES, SVG_NS, XNode, css};
use crate::{MAX_ELEMENT_DEPTH, SvgError};
/// Most elements usvg may make of an SVG: [`MAX_NODES`], and below the 1,000,000 elements past
@@ -37,6 +47,10 @@ pub(crate) const MAX_SVG_ELEMENTS: usize = if MAX_NODES < 999_999 { MAX_NODES }
/// shows, all together: VectorCraft's own limit.
pub(crate) const MAX_COPIED_STYLES: u64 = 64 << 20;
/// Most tests of a style sheet selector's parts against elements an SVG and the SVG images it
/// shows may take, all together: VectorCraft's own limit.
pub(crate) const MAX_SELECTOR_TESTS: u64 = 50_000_000;
/// What usvg keeps for each value it copies besides its bytes (the count and length of a shared
/// string).
const COPY: u64 = 16;
@@ -116,28 +130,59 @@ fn svg_name<'a>(n: XNode<'a, '_>) -> Option<&'a str> {
(n.is_element() && matches!(name.namespace(), None | Some(SVG_NS)) && ELEMENTS.contains(&name.name())).then(|| name.name())
}
/// An element as the style sheets' selectors see it, as usvg matches them.
struct Element<'a, 'i>(XNode<'a, 'i>);
#[cfg(test)]
thread_local! {
/// The selector tests the last measurement on this thread made as usvg matches the style
/// sheets, as far as it got.
static USVG_TESTS: Cell<u64> = const { Cell::new(0) };
}
impl simplecss::Element for Element<'_, '_> {
/// An element as the style sheets' selectors see it, as usvg matches them. Each look at it counts
/// as tests in `tests`; past `most` it has no parent or sibling and matches nothing, so the
/// matching ends.
struct Element<'a, 'i, 't> {
node: XNode<'a, 'i>,
tests: &'t Cell<u64>,
most: u64,
}
impl<'a, 'i, 't> Element<'a, 'i, 't> {
/// Counts `n` tests: false past `most`.
fn test(&self, n: u64) -> bool {
let tests = self.tests.get().saturating_add(n);
self.tests.set(tests);
#[cfg(test)]
USVG_TESTS.set(tests);
tests <= self.most
}
fn of(&self, node: Option<XNode<'a, 'i>>) -> Option<Self> {
node.filter(|_| self.test(1)).map(|node| Element { node, tests: self.tests, most: self.most })
}
}
impl simplecss::Element for Element<'_, '_, '_> {
fn parent_element(&self) -> Option<Self> {
self.0.parent_element().map(Self)
self.of(self.node.parent_element())
}
fn prev_sibling_element(&self) -> Option<Self> {
self.0.prev_sibling_element().map(Self)
self.of(self.node.prev_sibling_element())
}
fn has_local_name(&self, name: &str) -> bool {
self.0.tag_name().name() == name
self.test(1) && self.node.tag_name().name() == name
}
fn attribute_matches(&self, name: &str, operator: simplecss::AttributeOperator<'_>) -> bool {
self.0.attribute(name).is_some_and(|value| operator.matches(value))
// The lookup scans the element's attributes, and the match the value.
let value = self.node.attribute(name);
let scanned = css::scan_tests(self.node.attributes().len()).saturating_add(value.map_or(0, |v| css::scan_tests(v.len())));
self.test(scanned) && value.is_some_and(|value| operator.matches(value))
}
fn pseudo_class_matches(&self, class: simplecss::PseudoClass<'_>) -> bool {
matches!(class, simplecss::PseudoClass::FirstChild) && self.0.prev_sibling_element().is_none()
self.test(1) && matches!(class, simplecss::PseudoClass::FirstChild) && self.node.prev_sibling_element().is_none()
}
}
@@ -153,16 +198,34 @@ fn copied(declaration: &simplecss::Declaration) -> u64 {
}
}
/// What usvg makes of one element: elements (text nodes included) and bytes of copied styles.
#[derive(Clone, Copy, Default)]
struct Cost {
elements: u64,
bytes: u64,
/// What usvg makes of an element or an SVG: elements (text nodes included), bytes of copied
/// styles and selector tests.
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub(crate) struct Cost {
pub(crate) elements: u64,
pub(crate) bytes: u64,
pub(crate) tests: u64,
}
impl Cost {
fn add(self, other: Cost) -> Cost {
Cost { elements: self.elements.saturating_add(other.elements), bytes: self.bytes.saturating_add(other.bytes) }
/// The most an SVG and the SVG images it shows may cost together.
pub(crate) const LIMITS: Cost = Cost { elements: MAX_SVG_ELEMENTS as u64, bytes: MAX_COPIED_STYLES, tests: MAX_SELECTOR_TESTS };
pub(crate) fn add(self, other: Cost) -> Cost {
Cost {
elements: self.elements.saturating_add(other.elements),
bytes: self.bytes.saturating_add(other.bytes),
tests: self.tests.saturating_add(other.tests),
}
}
/// What is left of `self` after `spent`.
pub(crate) fn less(self, spent: Cost) -> Cost {
Cost {
elements: self.elements.saturating_sub(spent.elements),
bytes: self.bytes.saturating_sub(spent.bytes),
tests: self.tests.saturating_sub(spent.tests),
}
}
}
@@ -178,6 +241,14 @@ struct Measure<'a, 'i> {
/// The first element of each id.
ids: HashMap<&'a str, XNode<'a, 'i>>,
sheet: simplecss::StyleSheet<'a>,
/// The selector tests made of `sheet` so far, each element once.
tests: Cell<u64>,
/// The most selector tests of `sheet` that are left: matching stops past them.
most_tests: u64,
/// The selector tests the import's own cascade made ([`Measure::cascade`]).
cascade_tests: Cell<u64>,
/// The import's own style cascade of the same style sheets.
cascade: css::Styles,
/// The elements that hold a `<use>` of themselves.
holds_use_of_itself: HashSet<roxmltree::NodeId>,
/// The `<use>`s of each element, by the element.
@@ -204,7 +275,17 @@ impl<'a, 'i> Measure<'a, 'i> {
sheet.parse_more(text);
}
}
let mut m = Measure { ids, sheet, holds_use_of_itself: HashSet::new(), used_by: HashMap::new(), tref_text: HashMap::new() };
let mut m = Measure {
ids,
sheet,
tests: Cell::new(0),
most_tests: MAX_SELECTOR_TESTS,
cascade_tests: Cell::new(0),
cascade: css::Styles::new(xml),
holds_use_of_itself: HashSet::new(),
used_by: HashMap::new(),
tref_text: HashMap::new(),
};
for u in xml.descendants().filter(|n| n.has_tag_name((SVG_NS, "use"))) {
let Some(target) = m.target(u) else { continue };
if u.ancestors().skip(1).any(|a| a == target) {
@@ -241,21 +322,51 @@ impl<'a, 'i> Measure<'a, 'i> {
Shows::All(link)
}
/// The bytes of style values usvg copies into one copy of element `n`.
fn styles(&self, n: XNode) -> u64 {
/// Element `n` alone, as usvg makes one copy of it: the bytes of style values it copies into
/// it, and the selector tests usvg makes to find them (each rule tested counts as one too).
fn own(&self, n: XNode) -> Cost {
let before = self.tests.get();
let mut bytes = 0u64;
for rule in self.sheet.rules.iter().filter(|r| r.selector.matches(&Element(n))) {
bytes = rule.declarations.iter().map(copied).fold(bytes, u64::saturating_add);
for rule in &self.sheet.rules {
self.tests.set(self.tests.get().saturating_add(1));
if rule.selector.matches(&Element { node: n, tests: &self.tests, most: self.most_tests }) {
bytes = rule.declarations.iter().map(copied).fold(bytes, u64::saturating_add);
}
}
if let Some(style) = n.attribute("style") {
bytes = simplecss::DeclarationTokenizer::from(style).map(|d| copied(&d)).fold(bytes, u64::saturating_add);
}
bytes
Cost { elements: 1, bytes, tests: self.tests.get().saturating_sub(before) }
}
/// Element `n` alone.
fn own(&self, n: XNode) -> Cost {
Cost { elements: 1, bytes: self.styles(n) }
/// Have the selector tests made so far passed what is left of them?
fn tests_past(&self) -> bool {
self.tests.get() > self.most_tests
}
/// What the import's own style cascade keeps for the elements of `xml`, each once, up to
/// `left`: the bytes of the declarations of the rules that match it, and the tests it makes to
/// find them.
/// The tests it makes are kept in `cascade_tests`, as far as it gets.
fn cascade(&self, xml: &roxmltree::Document, left: Cost) -> Result<Cost, Past> {
let mut cost = Cost::default();
if !self.cascade.has_rules() {
return Ok(cost);
}
let mut result = Ok(());
for n in xml.descendants().filter(XNode::is_element) {
let Some(bytes) = self.cascade.matched_bytes(n, COPY, &mut cost.tests, left.tests) else {
result = Err(Past::Tests);
break;
};
cost.bytes = cost.bytes.saturating_add(bytes);
if cost.bytes > left.bytes {
result = Err(Past::Bytes);
break;
}
}
self.cascade_tests.set(cost.tests);
result.map(|()| cost)
}
/// `<text>` `t` and what usvg makes of what it holds: at most an element of each element, and
@@ -265,11 +376,11 @@ impl<'a, 'i> Measure<'a, 'i> {
for d in t.descendants().skip(1) {
if d.is_text() {
let len = d.text().map_or(0, str::len) as u64;
cost = cost.add(Cost { elements: 1, bytes: COPY + len });
cost = cost.add(Cost { elements: 1, bytes: COPY + len, tests: 0 });
} else if svg_name(d).is_some() {
cost = cost.add(self.own(d));
if svg_name(d) == Some("tref") {
cost = cost.add(Cost { elements: 1, bytes: COPY + self.tref(d) });
cost = cost.add(Cost { elements: 1, bytes: COPY + self.tref(d), tests: 0 });
}
}
}
@@ -286,16 +397,23 @@ impl<'a, 'i> Measure<'a, 'i> {
}
}
/// The bytes of style values usvg would copy into the elements of `xml`, when that is no more
/// than `bytes_left` and it makes no more than [`MAX_SVG_ELEMENTS`] elements of it, nested no
/// deeper than `depth` (counted as `depth::height` counts, which finds at least as much).
pub(super) fn check(xml: &roxmltree::Document, bytes_left: u64, depth: usize) -> Result<u64, SvgError> {
match measure(xml, MAX_SVG_ELEMENTS as u64, bytes_left, depth) {
Ok(cost) => Ok(cost.bytes),
Err(Past::Elements) => Err(SvgError::TooLarge(MAX_SVG_ELEMENTS)),
Err(Past::Bytes) => Err(SvgError::StylesTooLarge((MAX_COPIED_STYLES >> 20) as usize)),
Err(Past::Depth) => Err(SvgError::TooDeep(MAX_ELEMENT_DEPTH)),
}
/// What usvg would make of `xml`, with what the import's own style cascade keeps of it and the
/// selector tests it makes, when that is no more than `left` and nested no deeper than `depth`
/// (counted as `depth::height` counts, which finds at least as much).
pub(super) fn check(xml: &roxmltree::Document, left: Cost, depth: usize) -> Result<Cost, SvgError> {
check_spending(xml, left, depth).0
}
/// [`check`], with the selector tests it made, as far as it got.
pub(super) fn check_spending(xml: &roxmltree::Document, left: Cost, depth: usize) -> (Result<Cost, SvgError>, u64) {
let (result, tests) = measure_spending(xml, left, depth);
let result = result.map_err(|past| match past {
Past::Elements => SvgError::TooLarge(MAX_SVG_ELEMENTS),
Past::Bytes => SvgError::StylesTooLarge((MAX_COPIED_STYLES >> 20) as usize),
Past::Tests => SvgError::StylesTooComplex,
Past::Depth => SvgError::TooDeep(MAX_ELEMENT_DEPTH),
});
(result, tests)
}
/// The limit [`measure`] stopped at.
@@ -303,14 +421,32 @@ pub(super) fn check(xml: &roxmltree::Document, bytes_left: u64, depth: usize) ->
enum Past {
Elements,
Bytes,
Tests,
Depth,
}
/// What usvg makes of `xml`, up to `elements` elements and `bytes` bytes of copied styles, its
/// elements and the copies `<use>`s show nested up to `depth` deep. Without recursion; each
/// element is measured once.
fn measure(xml: &roxmltree::Document, elements: u64, bytes: u64, depth: usize) -> Result<Cost, Past> {
/// What usvg makes of `xml` with what the import's own style cascade keeps of it and its tests,
/// up to `left`, its elements and the copies `<use>`s show nested up to `depth` deep. Without
/// recursion; each element is measured once.
#[cfg(test)]
fn measure(xml: &roxmltree::Document, left: Cost, depth: usize) -> Result<Cost, Past> {
measure_spending(xml, left, depth).0
}
/// [`measure`], with the selector tests it made, as far as it got.
fn measure_spending(xml: &roxmltree::Document, left: Cost, depth: usize) -> (Result<Cost, Past>, u64) {
let mut m = Measure::new(xml);
let result = walk(&mut m, xml, left, depth);
(result, m.cascade_tests.get().saturating_add(m.tests.get()))
}
/// [`measure`] with `m`, made of `xml`.
fn walk<'a, 'i>(m: &mut Measure<'a, 'i>, xml: &'a roxmltree::Document<'i>, left: Cost, depth: usize) -> Result<Cost, Past> {
// First: its tests are bounded by what it finds, usvg's are not.
let cascade = m.cascade(xml, left)?;
let left = left.less(cascade);
m.most_tests = left.tests;
let (elements, bytes) = (left.elements, left.bytes);
let mut costs: HashMap<roxmltree::NodeId, Cost> = HashMap::new();
// The elements entered and not yet left: one entered again is a loop.
let mut open: HashSet<roxmltree::NodeId> = HashSet::new();
@@ -366,11 +502,15 @@ fn measure(xml: &roxmltree::Document, elements: u64, bytes: u64, depth: usize) -
if cost.bytes > bytes {
return Err(Past::Bytes);
}
if m.tests_past() || cost.tests > left.tests {
return Err(Past::Tests);
}
costs.insert(n.id(), cost);
}
}
}
Ok(costs.get(&root.id()).copied().unwrap_or_default())
let usvg = costs.get(&root.id()).copied().unwrap_or_default();
Ok(usvg.add(cascade))
}
#[cfg(test)]
@@ -381,15 +521,17 @@ mod tests {
format!(r#"<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="10" height="10">{body}</svg>"#)
}
const NO_LIMITS: Cost = Cost { elements: u64::MAX, bytes: u64::MAX, tests: u64::MAX };
/// What [`measure`] makes of `text` with no limits, as (elements, bytes).
fn cost(text: &str) -> (u64, u64) {
let xml = roxmltree::Document::parse(text).unwrap();
let c = measure(&xml, u64::MAX, u64::MAX, usize::MAX).unwrap_or_else(|p| panic!("{p:?}"));
let c = measure(&xml, NO_LIMITS, usize::MAX).unwrap_or_else(|p| panic!("{p:?}"));
(c.elements, c.bytes)
}
fn past(text: &str, elements: u64, bytes: u64) -> Option<Past> {
measure(&roxmltree::Document::parse(text).unwrap(), elements, bytes, usize::MAX).err()
measure(&roxmltree::Document::parse(text).unwrap(), Cost { elements, bytes, tests: u64::MAX }, usize::MAX).err()
}
/// Groups `g0` to `g{levels}`: `g0` a rectangle styled `style`, each other two `<use>`s of the
@@ -423,9 +565,12 @@ mod tests {
#[test]
fn style_sheet_rules_count_where_they_match() {
let groups = "<g class='a'/>".repeat(4);
// `g` matches the four groups (16 + 3 each), `.b` none, `svg` the root (16 + 4).
// `g` matches the four groups (16 + 3 each), `.b` none, `svg` the root (16 + 4); the
// import's own cascade keeps the same, names included (16 + 4 + 3 and 16 + 4 + 4).
let (_, bytes) = cost(&svg(&format!("<style>g{{fill:red}} .b{{fill:blue}} svg{{fill:none}}</style>{groups}")));
assert_eq!(bytes, 4 * 19 + 20);
assert_eq!(bytes, 4 * 19 + 20 + 4 * 23 + 24);
// usvg drops a `:not()` rule; the cascade keeps it for each group it matches.
assert_eq!(cost(&svg(&format!("<style>g:not(.x){{fill:red}}</style>{groups}"))).1, 4 * 23);
// A style sheet of another type is not read; the style element itself makes nothing.
assert_eq!(cost(&svg(&format!("<style type='text/x'>g{{fill:red}}</style>{groups}"))), (5, 0));
// `marker` sets three properties; `font` resets twelve and sets six from its text.
@@ -467,13 +612,13 @@ mod tests {
let links: String = (0..3000).map(|i| format!("<g id='u{i}'><use href='#u{}'/></g>", i + 1)).collect();
let deep = svg(&format!("<defs>{links}<rect id='u3000' width='1' height='1'/></defs><use href='#u0'/>"));
let xml = roxmltree::Document::parse(&deep).unwrap();
assert_eq!(measure(&xml, u64::MAX, u64::MAX, MAX_ELEMENT_DEPTH).err(), Some(Past::Depth));
assert_eq!(measure(&xml, NO_LIMITS, MAX_ELEMENT_DEPTH).err(), Some(Past::Depth));
assert!(super::super::depth::height(&xml, MAX_ELEMENT_DEPTH).is_none());
assert!(matches!(check(&xml, MAX_COPIED_STYLES, MAX_ELEMENT_DEPTH), Err(SvgError::TooDeep(_))));
assert!(matches!(check(&xml, Cost::LIMITS, MAX_ELEMENT_DEPTH), Err(SvgError::TooDeep(_))));
for text in [chain(5, ""), svg("<g><g><use href='#r'/></g></g><rect id='r'/>")] {
let xml = roxmltree::Document::parse(&text).unwrap();
let height = super::super::depth::height(&xml, usize::MAX).unwrap_or(0);
assert!(measure(&xml, u64::MAX, u64::MAX, height).is_ok(), "{height} {text}");
assert!(measure(&xml, NO_LIMITS, height).is_ok(), "{height} {text}");
}
}
@@ -492,11 +637,110 @@ mod tests {
fn a_long_rule_on_many_elements_is_refused_before_the_cascade_reads_it() {
let groups = svg(&format!("<style>g{{font-family:{}}}</style>{}", "a".repeat(100_000), "<g/>".repeat(1000)));
let image = svg(&format!(r#"<image href="data:image/svg+xml;base64,{}" width="10" height="10"/>"#, crate::base64_encode(groups.as_bytes())));
for text in [groups, image] {
// usvg drops a `:not()` rule, which the import's own cascade reads.
let not = svg(&format!("<style>g:not(.x){{font-family:{}}}</style>{}", "a".repeat(100_000), "<g/>".repeat(1000)));
for text in [groups, image, not] {
let before = super::super::css::selector_tests();
let err = super::super::import(&text, &crate::ImportOptions::default(), MAX_NODES).err();
assert!(matches!(err, Some(SvgError::StylesTooLarge(64))), "{err:?}");
assert_eq!(super::super::css::selector_tests(), before);
}
}
/// A linked SVG file with such a rule, and an `<image>` of its own whose link the import reads,
/// is refused before the cascade reads it too.
#[test]
fn a_linked_svg_with_a_long_rule_is_refused_before_the_cascade_reads_it() {
let linked =
svg(&format!("<style>g{{font-family:{}}}</style>{}<image href='b.png' width='1' height='1'/>", "a".repeat(100_000), "<g/>".repeat(1000)));
let read = |path: &str| path.ends_with("a.svg").then(|| (linked.clone().into_bytes(), vectorcraft_doc::LinkInfo::new(path)));
let folder = std::env::temp_dir().join("vectorcraft-svg-budget");
let folder = folder.to_string_lossy();
let opts = crate::ImportOptions { folder: Some(&folder), read: Some(&read) };
let before = super::super::css::selector_tests();
let err = super::super::import(&svg("<image href='a.svg' width='10' height='10'/>"), &opts, MAX_NODES).err();
assert!(matches!(err, Some(SvgError::StylesTooLarge(64))), "{err:?}");
assert_eq!(super::super::css::selector_tests(), before);
}
/// `depth` groups in one another, each of class `a`, around a rectangle, with `sheet`.
fn nested(depth: usize, sheet: &str) -> String {
svg(&format!("<style>{sheet}</style>{}<rect width='1' height='1'/>{}", "<g class='a'>".repeat(depth), "</g>".repeat(depth)))
}
/// A selector whose leftmost part matches nothing makes usvg test every set of ancestors in
/// turn: the tests stop at the limit and the SVG is refused, before usvg or the cascade runs.
#[test]
fn a_selector_that_never_matches_stops_at_the_test_limit() {
let never = nested(60, &format!(".missing{} {{fill:red}}", " g".repeat(20)));
let xml = roxmltree::Document::parse(&never).unwrap();
assert_eq!(measure(&xml, Cost::LIMITS, usize::MAX).err(), Some(Past::Tests));
let before = super::super::css::selector_tests();
let err = super::super::import(&never, &crate::ImportOptions::default(), MAX_NODES).err();
assert!(matches!(err, Some(SvgError::StylesTooComplex)), "{err:?}");
assert_eq!(super::super::css::selector_tests(), before);
// The same selector without its leftmost part matches at once, and imports.
let matching = nested(60, &format!("g{} {{fill:red}}", " g".repeat(19)));
assert!(super::super::import(&matching, &crate::ImportOptions::default(), MAX_NODES).is_ok());
}
/// usvg tests the rules against each copy a `<use>` shows: the tests add up as the copies do,
/// and the cascade's tests count once for each element.
#[test]
fn selector_tests_count_for_each_copy() {
let tests = |levels: usize| {
let text = chain(levels, "").replacen("<defs>", "<style>.b rect{fill:red}</style><defs>", 1);
let xml = roxmltree::Document::parse(&text).unwrap();
measure(&xml, NO_LIMITS, usize::MAX).unwrap_or_else(|p| panic!("{p:?}")).tests
};
let (ten, eleven) = (tests(10), tests(11));
assert!(eleven > 2 * ten - 100, "{ten} {eleven}");
let text = chain(11, "").replacen("<defs>", "<style>.b rect{fill:red}</style><defs>", 1);
let xml = roxmltree::Document::parse(&text).unwrap();
assert_eq!(measure(&xml, Cost { tests: eleven - 1, ..NO_LIMITS }, usize::MAX).err(), Some(Past::Tests));
assert!(measure(&xml, Cost { tests: eleven, ..NO_LIMITS }, usize::MAX).is_ok());
}
/// Each alternative of a `:not()` counts as a test of the cascade, for each element.
#[test]
fn not_alternatives_count_as_tests() {
let alternatives: Vec<String> = (0..1000).map(|i| format!(".m{i}")).collect();
let text = svg(&format!("<style>g:not({}){{fill:red}}</style>{}", alternatives.join(","), "<g/>".repeat(1000)));
let xml = roxmltree::Document::parse(&text).unwrap();
let tests = measure(&xml, NO_LIMITS, usize::MAX).unwrap_or_else(|p| panic!("{p:?}")).tests;
assert!(tests > 1000 * 1000, "{tests}");
assert_eq!(measure(&xml, Cost { tests: 1000 * 1000, ..NO_LIMITS }, usize::MAX).err(), Some(Past::Tests));
}
/// Matching as usvg matches stops once its tests pass what the limits have left, as when an
/// SVG image gets what the SVG showing it left.
#[test]
fn usvg_matching_stops_at_what_is_left() {
let never = nested(60, &format!(".missing{} {{fill:red}}", " g".repeat(20)));
let xml = roxmltree::Document::parse(&never).unwrap();
let cascade = Measure::new(&xml).cascade(&xml, NO_LIMITS).unwrap_or_else(|p| panic!("{p:?}")).tests;
assert_eq!(measure(&xml, Cost { tests: cascade + 1000, ..NO_LIMITS }, usize::MAX).err(), Some(Past::Tests));
let made = USVG_TESTS.get();
assert!((1000..1100).contains(&made), "{made}");
}
/// Each class of a compound is looked for in the element's class list, so the tests grow with
/// the list's length: in the import's own cascade (a `:not()` rule, which usvg drops) and as
/// usvg matches.
#[test]
fn class_tests_grow_with_the_class_list() {
let list = (0..1000).map(|i| format!("c{i}")).collect::<Vec<_>>().join(" ");
let classes: String = (0..100).map(|i| format!(".c{i}")).collect();
let scans = 100 * css::scan_tests(list.len());
let tests = |rule: &str| {
let text = svg(&format!("<style>{rule}{{fill:red}}</style><g class='{list}'/>"));
let xml = roxmltree::Document::parse(&text).unwrap();
measure(&xml, NO_LIMITS, usize::MAX).unwrap_or_else(|p| panic!("{p:?}")).tests
};
let cascade = tests(&format!("g:not(.x{classes})"));
assert!(cascade >= scans, "{cascade} {scans}");
tests(&format!("g{classes}"));
let usvg = USVG_TESTS.get();
assert!(usvg >= scans, "{usvg} {scans}");
}
}
+61 -6
View File
@@ -103,6 +103,24 @@ impl Compound {
&& self.attrs.iter().all(|(a, v)| n.attribute(a.as_str()).is_some_and(|x| v.as_deref().is_none_or(|v| x == v)))
&& !self.nots.iter().any(|c| c.matches(n))
}
/// The tests [`Compound::matches`] makes of `n` at most, its `:not()`s' included: one for the
/// compound, [`scan_tests`] of `n`'s attributes for each attribute it looks up, and for each
/// of its classes, [`scan_tests`] of `n`'s class list.
fn tests(&self, n: XNode) -> u64 {
let lookups = u64::from(self.id.is_some()) + u64::from(!self.classes.is_empty()) + self.attrs.len() as u64;
let mut tests = lookups.saturating_mul(scan_tests(n.attributes().len())).saturating_add(1);
if !self.classes.is_empty() {
let list = scan_tests(n.attribute("class").map_or(0, str::len));
tests = tests.saturating_add((self.classes.len() as u64).saturating_mul(list));
}
self.nots.iter().map(|c| c.tests(n)).fold(tests, u64::saturating_add)
}
}
/// The tests a scan of `len` attributes or bytes counts as: one, and one more for every 16.
pub(super) fn scan_tests(len: usize) -> u64 {
1 + len as u64 / 16
}
/// A complex selector, rightmost compound first; each compound's flag says whether it must be the
@@ -260,14 +278,35 @@ impl Selector {
}
fn matches(&self, n: XNode) -> bool {
#[cfg(test)]
SELECTOR_TESTS.set(SELECTOR_TESTS.get().saturating_add(1));
self.matches_counting(n, &mut 0, None)
}
/// [`Self::matches`], counting the tests of each compound tested against an element in
/// `steps` ([`Compound::tests`]), those of its `:not()`s included. Once `steps` passes `most`,
/// no compound matches any more.
fn matches_within(&self, n: XNode, steps: &mut u64, most: u64) -> bool {
self.matches_counting(n, steps, Some(most))
}
/// [`Self::matches_within`] when `most` is given; [`Self::matches`], counting nothing, when not.
fn matches_counting(&self, n: XNode, steps: &mut u64, most: Option<u64>) -> bool {
// The result of matching a selector suffix from a node depends only on the suffix and
// the node, so memoize it: without this, every descendant step retries every matching
// ancestor and a selector whose leftmost compound never matches makes the search
// enumerate ancestor combinations (#1703). A suffix of `parts` is identified by its
// length, so (suffix length, node id) is a complete key and the visited states are
// bounded by parts × ancestors.
fn go(parts: &[(Compound, bool)], n: XNode, memo: &mut HashMap<(usize, roxmltree::NodeId), bool>) -> bool {
type Memo = HashMap<(usize, roxmltree::NodeId), bool>;
fn go(parts: &[(Compound, bool)], n: XNode, memo: &mut Memo, steps: &mut u64, most: Option<u64>) -> bool {
let Some(((c, child), rest)) = parts.split_first() else { return true };
if let Some(most) = most {
*steps = steps.saturating_add(c.tests(n));
if *steps > most {
return false;
}
}
if !c.matches(n) {
return false;
}
@@ -279,16 +318,14 @@ impl Selector {
return hit;
}
let hit = if *child {
n.parent_element().is_some_and(|p| go(rest, p, memo))
n.parent_element().is_some_and(|p| go(rest, p, memo, steps, most))
} else {
n.ancestors().skip(1).filter(|a| a.is_element()).any(|a| go(rest, a, memo))
n.ancestors().skip(1).filter(|a| a.is_element()).any(|a| go(rest, a, memo, steps, most))
};
memo.insert(key, hit);
hit
}
#[cfg(test)]
SELECTOR_TESTS.set(SELECTOR_TESTS.get().saturating_add(1));
go(&self.parts, n, &mut HashMap::new())
go(&self.parts, n, &mut HashMap::new(), steps, most)
}
}
@@ -495,6 +532,24 @@ impl Styles {
m
}
/// The bytes the declarations of the rules that match `n` take, names and values, each with
/// `per_declaration` more: at least what [`Styles::declared`] keeps of them for `n`. Nothing
/// is kept. `steps` counts the rules and compounds tested; `None` once it passes `most`.
pub(super) fn matched_bytes(&self, n: XNode, per_declaration: u64, steps: &mut u64, most: u64) -> Option<u64> {
let mut bytes = 0u64;
for r in self.index.candidates(n).into_iter().filter_map(|i| self.rules.get(i)) {
*steps = steps.saturating_add(1);
if r.selector.matches_within(n, steps, most) {
let size = |(k, v, _): &(String, String, bool)| per_declaration.saturating_add((k.len() + v.len()) as u64);
bytes = r.decls.iter().map(size).fold(bytes, u64::saturating_add);
}
if *steps > most {
return None;
}
}
Some(bytes)
}
/// Are there rules with a `:not()` (which usvg's style sheets drop)?
pub(super) fn has_not_rules(&self) -> bool {
self.rules.iter().any(|r| r.selector.has_not())
+84 -17
View File
@@ -74,9 +74,9 @@ pub(in crate::import) struct Files {
/// The CMYK TIFF stored in place of a turned CMYK image, by the address of the PNG usvg got
/// (kept here too, so the address stays its own).
cmyk: Mutex<HashMap<usize, (Bytes, Bytes)>>,
/// The bytes of style values usvg copies into the elements of the SVG and of the SVG images
/// read so far ([`budget`]).
styles: AtomicU64,
/// What usvg makes of the SVG and of the SVG images read so far, all together ([`budget`]):
/// elements, bytes of copied style values and selector tests.
spent: Mutex<budget::Cost>,
/// Why an SVG image refused the whole SVG: what usvg would make of it is past [`budget`]'s
/// limits. The first one.
refused: Mutex<Option<SvgError>>,
@@ -134,6 +134,9 @@ struct Reading<'a, 'w> {
/// SVG links to aren't counted.
svg_reads: usize,
svg_text: u64,
/// What the linked SVG files measured for their links make, all together ([`budget`]); of one
/// past what is left, the selector tests it made.
measured: budget::Cost,
}
impl Reading<'_, '_> {
@@ -254,8 +257,17 @@ impl Files {
/// relinked.
pub(in crate::import) fn read(svg: &str, xml: &roxmltree::Document, opts: &ImportOptions, edits: &mut Edits, warnings: &mut Vec<String>) -> Self {
let mut files = Files::default();
let mut reading =
Reading { opts, warnings, placeholder: None, by_file: HashMap::new(), active: vec![], placed: false, svg_reads: 0, svg_text: 0 };
let mut reading = Reading {
opts,
warnings,
placeholder: None,
by_file: HashMap::new(),
active: vec![],
placed: false,
svg_reads: 0,
svg_text: 0,
measured: budget::Cost::default(),
};
files.sources = files.links_of(svg, xml, opts.folder, None, edits, &mut reading);
files
}
@@ -383,6 +395,19 @@ impl Files {
// Read from its own handle: the text stays borrowed while `svg` may be given back.
let text = svg.text.clone();
let Ok(xml) = super::parse(&text) else { return Outcome::shown(Source::Svg(svg)) };
// Measured before the style cascade of `depth::height`, as an SVG image is when usvg
// reads it ([`Files::svg_tree`]), which then refuses one past the limits, within what the
// linked SVG files measured before it left: past it, its links aren't read, and the
// selector tests it made still count.
let (result, tests) = budget::check_spending(&xml, budget::Cost::LIMITS.less(reading.measured), left);
match result {
Ok(cost) => reading.measured = reading.measured.add(cost),
Err(e) => {
reading.measured.tests = reading.measured.tests.saturating_add(tests);
reading.placed |= matches!(e, SvgError::TooDeep(_));
return Outcome::shown(Source::Svg(svg));
}
}
let Some(height) = depth::height(&xml, left) else {
reading.placed = true;
return Outcome::shown(Source::Svg(svg));
@@ -485,10 +510,20 @@ impl Files {
notes
}
/// The SVG holding the images copies `bytes` of style values ([`budget::check`]): its images
/// copy at most what is left.
pub(in crate::import) fn copied_styles(&self, bytes: u64) {
self.styles.store(bytes, Ordering::Relaxed);
/// What usvg makes of the SVG holding the images ([`budget::check`]): its images make at most
/// what is left of [`budget::Cost::LIMITS`].
pub(in crate::import) fn spent_by_svg(&self, spent: budget::Cost) {
self.set_spent(spent);
}
fn spent(&self) -> budget::Cost {
self.spent.lock().map(|s| *s).unwrap_or(budget::Cost::LIMITS)
}
fn set_spent(&self, spent: budget::Cost) {
if let Ok(mut s) = self.spent.lock() {
*s = spent;
}
}
/// The error of the first SVG image past [`budget`]'s limits, which refuses the SVG holding it.
@@ -588,12 +623,12 @@ impl Files {
}
let xml = super::parse(text).ok()?;
// What usvg would make of it, measured as the SVG holding it is (`import`), before the
// style cascade of `depth::height`; its copied styles count with theirs while usvg reads
// it, and only when it decodes. Too deep, it is left out; past the other limits, the whole
// SVG is refused.
let spent = self.styles.load(Ordering::Relaxed);
let bytes = match budget::check(&xml, budget::MAX_COPIED_STYLES.saturating_sub(spent), left) {
Ok(bytes) => bytes,
// style cascade of `depth::height`; its elements, copied styles and selector tests count
// with theirs while usvg reads it, and only when it decodes. Too deep, it is left out;
// past the other limits, the whole SVG is refused.
let spent = self.spent();
let cost = match budget::check(&xml, budget::Cost::LIMITS.less(spent), left) {
Ok(cost) => cost,
Err(SvgError::TooDeep(_)) => return leave_out(&self.too_deep, true),
Err(e) => {
if let Ok(mut refused) = self.refused.lock() {
@@ -605,7 +640,7 @@ impl Files {
let Some(height) = depth::height(&xml, left) else { return leave_out(&self.too_deep, true) };
// usvg's parser would overflow on it, as on the SVG holding it (`import`).
super::convolve_matrices_ok(&xml).ok()?;
self.styles.store(spent.saturating_add(bytes), Ordering::Relaxed);
self.set_spent(spent.add(cost));
self.depth.store(used + height, Ordering::Relaxed);
let within = self.within.lock().ok().map(|mut w| w.push(file)).is_some();
// usvg's `Tree::from_data_nested`, except that hrefs to files go to the resolver.
@@ -631,7 +666,7 @@ impl Files {
self.depth.store(used, Ordering::Relaxed);
let Ok(tree) = tree else {
// Left out: neither it nor the images inside it count.
self.styles.store(spent, Ordering::Relaxed);
self.set_spent(spent);
return None;
};
self.note_text(text);
@@ -935,12 +970,44 @@ mod tests {
placed: false,
svg_reads: reads,
svg_text: text,
measured: budget::Cost::default(),
};
let mut files = Files::default();
files.sources = files.links_of(&svg, &xml, opts.folder, None, &mut Edits::default(), &mut reading);
(log.into_inner().unwrap(), files)
}
/// The linked SVG files measured for their links share the limits: each of these keeps about
/// 40 MB of declarations in the import's own cascade (its `:not()` rule), so the second one is
/// shown without its links, and neither it nor the cascade reads them.
#[test]
fn linked_svg_files_share_the_limits_for_their_links() {
let file = |png: &str| {
let groups = "<g/>".repeat(400);
let rule = format!("g:not(.x){{font-family:{}}}", "a".repeat(100_000));
format!(r#"<svg xmlns="http://www.w3.org/2000/svg" width="2" height="2"><style>{rule}</style>{groups}<image href="{png}" width="1" height="1"/></svg>"#)
.into_bytes()
};
let served = [("a.svg", file("a.png")), ("b.svg", file("b.png")), ("a.png", png()), ("b.png", png())];
let (log, _) = read_links(&["a.svg"], &served, 0, 0);
assert_eq!(log, ["a.svg", "a.png"]);
let (log, _) = read_links(&["a.svg", "b.svg"], &served, 0, 0);
assert_eq!(log, ["a.svg", "a.png", "b.svg"]);
}
/// A linked SVG file past the limits alone (a `<use>` chain past the element limit) is shown
/// without its links, and the linked SVG files after it still get what it left.
#[test]
fn a_linked_svg_file_past_the_limits_leaves_the_others_their_links() {
let links: String = (1..=20).map(|i| format!(r##"<g id="g{i}"><use href="#g{0}"/><use href="#g{0}"/></g>"##, i - 1)).collect();
let chain = format!(
r##"<svg xmlns="http://www.w3.org/2000/svg" width="2" height="2"><defs><rect id="g0" width="1" height="1"/>{links}</defs><use href="#g20"/><image href="a.png" width="1" height="1"/></svg>"##
);
let served = [("a.svg", chain.into_bytes()), ("b.svg", linking(&["b.png"])), ("a.png", png()), ("b.png", png())];
let (log, _) = read_links(&["a.svg", "b.svg"], &served, 0, 0);
assert_eq!(log, ["a.svg", "b.svg", "b.png"]);
}
fn png() -> Vec<u8> {
let mut out = vec![];
image::RgbaImage::new(1, 1).write_to(&mut std::io::Cursor::new(&mut out), image::ImageFormat::Png).unwrap();
+56 -15
View File
@@ -378,24 +378,29 @@ fn clip_uses(
Some(s) => own_transform(&cx.css, s),
None => t.attribute("transform").unwrap_or("").to_string(),
};
// One element can carry one clip path. The text's own clip path is in the text's user space
// and wins; a clip path of the `<use>` is in the `<use>`'s, so the text's transform moves
// to the importer instead.
let clipped = |n: XNode| cx.css.own(n, "clip-path").is_some_and(|v| v.trim() != "none");
// One element can carry one clip path. The text's own clip path is in the text's user space;
// a clip path of the `<use>` is in the `<use>`'s. With only the `<use>`'s, the text's
// transform moves to the importer. With both, the placeholder's clip path is one that
// holds both ([`both_clips`]).
let clipped = |n: XNode| cx.css.own(n, "clip-path").filter(|v| v.trim() != "none");
let id = format!("{}{i}-{k}", slots.prefix);
let transform = if style_t.is_some_and(clipped) {
if clipped(style_u) {
let label = u.attribute("id").map_or_else(|| "a use of a text".to_string(), |id| format!("'{id}'"));
warnings.push(format!("clip path of {label} in a clip path ignored: the text's own applies"));
}
format!("{placed} {text_xf}")
} else {
slots.inner.insert(id.clone(), parse_transform(Some(&text_xf)));
placed
};
let props = clip_props(&cx.css, style_t, Some(style_u));
let mut out = String::new();
clip_placeholder(&mut out, q, &id, &transform, &props, u, marker);
match (style_t.and_then(clipped), clipped(style_u)) {
(Some(text_clip), Some(use_clip)) => {
let both = both_clips(&mut out, q, &id, &text_clip, &use_clip, parse_transform(Some(&text_xf)), marker);
let props = match (both, props.split_once(';')) {
(Some(both), Some((_, rest))) => format!("clip-path:url(#{both});{rest}"),
_ => props,
};
clip_placeholder(&mut out, q, &id, &format!("{placed} {text_xf}"), &props, u, marker);
}
(Some(_), None) => clip_placeholder(&mut out, q, &id, &format!("{placed} {text_xf}"), &props, u, marker),
(None, _) => {
slots.inner.insert(id.clone(), parse_transform(Some(&text_xf)));
clip_placeholder(&mut out, q, &id, &placed, &props, u, marker);
}
}
// Another `<use>` can still show this one by its id: a copy of it stays in a `<defs>`, which
// the clip path leaves out, with the properties style rules gave it written out.
if u.attribute("id").is_some() {
@@ -654,6 +659,42 @@ fn clip_placeholder(out: &mut String, q: &str, id: &str, transform: &str, props:
let _ = write!(out, " d=\"M{} {}H{}V{}H{}Z\"/>", b.x0, b.y0, b.x1, b.y1, b.x0);
}
/// Write, in a `<defs>` (which a clip path leaves out), a clip path for the placeholder `id` of a
/// text with bounds `b` and transform `text_xf` shown by a `<use>`, when both have a clip path:
/// it clips by the text's clip path `text_clip` in the text's user space and by the `<use>`'s
/// `use_clip` in the `<use>`'s, each on a rectangle over the text's bounds there, so a clip path in
/// bounding box units measures the text. Its id, or `None` when `text_xf` can't be inverted (the
/// text then draws nothing).
fn both_clips(out: &mut String, q: &str, id: &str, text_clip: &str, use_clip: &str, text_xf: Affine, b: Rect) -> Option<String> {
let det = text_xf.determinant();
if !det.is_finite() || det == 0.0 {
return None;
}
let [a, b2, c, d, e, f] = text_xf.inverse().as_coeffs();
let ub = text_xf.transform_rect_bbox(b);
let (id_u, id_t) = (format!("{id}-u"), format!("{id}-t"));
let rect = |out: &mut String, clip: &str, r: Rect| {
let _ = write!(
out,
"<{q}path style=\"transform:{IDENTITY};clip-path:{};display:inline\" d=\"M{} {}H{}V{}H{}Z\"/>",
xml_escape(clip),
r.x0,
r.y0,
r.x1,
r.y1,
r.x0
);
};
// The `<use>`'s clip path, moved back by the inverse of the text's transform from the
// placeholder's user space to the `<use>`'s.
let _ = write!(out, "<{q}defs><{q}clipPath id=\"{}\" style=\"transform:matrix({a} {b2} {c} {d} {e} {f})\">", xml_escape(&id_u));
rect(out, use_clip, ub);
let _ = write!(out, "</{q}clipPath><{q}clipPath id=\"{}\" style=\"clip-path:url(#{})\">", xml_escape(&id_t), xml_escape(&id_u));
rect(out, text_clip, b);
let _ = write!(out, "</{q}clipPath></{q}defs>");
Some(id_t)
}
/// Write the placeholder group for text `t` (namespace prefix `q`), slot `index`, with the text's
/// id when `with_id`.
#[allow(clippy::too_many_arguments)]
+4
View File
@@ -370,6 +370,10 @@ pub enum SvgError {
/// copies and SVG images included, add up to more than this many megabytes.
#[error("the SVG's styles expand to more than {0} MB")]
StylesTooLarge(usize),
/// Matching the style sheets' selectors against the elements the SVG expands to, `<use>`
/// copies and SVG images included, takes more tests than the reader allows.
#[error("the SVG's style sheets take too long to match")]
StylesTooComplex,
}
/// Export a document as an SVG string (linked images are not returned: see [`export_full`]).
+21
View File
@@ -221,6 +221,27 @@ fn a_clip_path_on_a_use_of_a_text_is_in_the_use_s_user_space() {
assert!(t.xf.translation().to_point().distance(Point::new(200.0, 160.0)) < 1e-9, "{:?}", t.xf);
}
#[test]
fn a_use_and_the_text_it_shows_in_a_clip_path_both_clip() {
// The text's own clip keeps y < 120 of its user space; the `<use>`'s keeps x < 250 of the
// `<use>`'s, which the text's transform doesn't move. The glyphs keep only what both keep.
let body = r##"<defs><clipPath id="k"><rect width="250" height="300"/></clipPath>
<clipPath id="half"><rect width="400" height="120"/></clipPath>
<text id="t" transform="translate(200 0)" x="0" y="150" font-size="100" clip-path="url(#half)">HI</text></defs>
<clipPath id="c"><use href="#t" transform="translate(0 10)" clip-path="url(#k)"/></clipPath>
<rect width="400" height="300" clip-path="url(#c)"/>"##;
let (d, warnings) = import_with_report(&svg(body)).unwrap();
let (clip, _) = clip_group(&top(&d)[0]);
let b = clip_bounds(clip);
assert!(b.x0 >= 200.0 - 1e-6 && near(b.x1, 250.0, 1e-6), "{b:?}");
assert!(near(b.y1, 130.0, 1e-6) && b.y0 > 50.0, "{b:?}");
// It clips by the glyphs, not their box: nothing between the stems of the H.
let (bp, _) = vectorcraft_effects::clip_outline(clip).unwrap();
assert!(bp.contains(Point::new(b.x0 + 2.0, 110.0)), "on a stem");
assert!(!bp.contains(Point::new(225.0, 100.0)), "between the stems");
assert!(!warnings.iter().any(|w| w.contains("ignored")), "{warnings:?}");
}
#[test]
fn a_css_transform_places_a_text_in_a_clip_path() {
let d = open(
+27
View File
@@ -911,6 +911,33 @@ fn svg_images_whose_styles_expand_past_the_limit_refuse_the_svg() {
assert!(!art(&d).is_empty());
}
/// The SVG images share the element limit with the SVG showing them: each image's `<use>` chain
/// makes 655,356 elements, so one imports and two together are refused before usvg makes the
/// second.
#[test]
fn svg_images_share_the_element_limit() {
let chain = use_chain(16, "");
let unshown = chain.replacen(r##"<use href="#g16"/>"##, "", 1);
assert_ne!(chain, unshown);
let image = image_of("image/svg+xml", &unshown);
let rect = r#"<rect width="1" height="1"/>"#;
assert!(import_with(&svg(&format!("{rect}{image}")), &ImportOptions::default()).is_ok());
let err = import_with(&svg(&format!("{rect}{}", image.repeat(2))), &ImportOptions::default()).unwrap_err();
assert!(matches!(err, SvgError::TooLarge(n) if n == vectorcraft_svg::MAX_NODES.min(999_999)), "{err:?}");
}
/// A `:not()` rule, which only the import's own style cascade reads, counts toward the style limit
/// the SVG images share: each image's rule gives 400 groups the long style (about 40 MB), so one
/// imports and two together are refused.
#[test]
fn svg_images_share_the_style_limit_with_not_rules() {
let groups = svg(&format!(r#"<style>g:not(.x){{{}}}</style>{}<rect width="1" height="1"/>"#, long_style(), "<g/>".repeat(400)));
let image = image_of("image/svg+xml", &groups);
assert!(import_with(&svg(&image), &ImportOptions::default()).is_ok());
let err = import_with(&svg(&image.repeat(2)), &ImportOptions::default()).unwrap_err();
assert!(matches!(err, SvgError::StylesTooLarge(64)), "{err:?}");
}
/// Nested SVG images exceeding `MAX_NESTED_SVG_IMAGES` are left out with a warning note (#3564).
#[test]
fn nested_svg_images_past_count_cap_are_left_out() {
+42 -7
View File
@@ -43,7 +43,7 @@ pub struct OtFeatures {
pub swash: bool,
/// The features of [`EXTRA_FEATURES`] turned on, one bit each (off by default): stylistic
/// sets, alternates, titling, proportional and lining figures, superscript, subscript,
/// numerators and denominators, `aalt`.
/// numerators and denominators, `aalt`, H or V Style (`hkna`) and Roman Italics (`ital`).
pub extra: u32,
/// The value of each feature of [`EXTRA_FEATURES`] that is on, as a tag `salt=2` gives it: for
/// a feature with alternates, which of them the font draws (the HarfBuzz feature value, 1 for
@@ -64,13 +64,20 @@ pub const MAX_STYLE_FEATURES: usize = 256;
/// Features beyond the named fields, off unless asked for, each bit `i` of [`OtFeatures::extra`]:
/// stylistic sets `ss01`–`ss20`, stylistic alternates `salt`, titling `titl`, proportional `pnum`
/// and lining `lnum` figures, superscript `sups`, subscript `subs`, numerators `numr`,
/// denominators `dnom` and access all alternates `aalt`.
/// denominators `dnom`, access all alternates `aalt`, and the OpenType panel menu's H or V Style
/// `hkna` (shaped as `vkna` in vertical type) and Roman Italics `ital`.
/// <https://learn.microsoft.com/en-us/typography/opentype/spec/features_ae#tag-aalt>
pub const EXTRA_FEATURES: [&str; 29] = [
/// <https://learn.microsoft.com/en-us/typography/opentype/spec/features_fj#tag-hkna>
/// <https://learn.microsoft.com/en-us/typography/opentype/spec/features_fj#tag-ital>
pub const EXTRA_FEATURES: [&str; 31] = [
"ss01", "ss02", "ss03", "ss04", "ss05", "ss06", "ss07", "ss08", "ss09", "ss10", "ss11", "ss12", "ss13", "ss14", "ss15", "ss16", "ss17", "ss18",
"ss19", "ss20", "salt", "titl", "pnum", "lnum", "sups", "subs", "numr", "dnom", "aalt",
"ss19", "ss20", "salt", "titl", "pnum", "lnum", "sups", "subs", "numr", "dnom", "aalt", "hkna", "ital",
];
/// The features of [`EXTRA_FEATURES`] that are only on or off: they substitute one form for each
/// glyph, so they take no alternate's number (`hkna=2` is refused).
const SWITCH_FEATURES: [&str; 2] = ["hkna", "ital"];
impl Default for OtFeatures {
fn default() -> Self {
Self {
@@ -107,10 +114,11 @@ struct ParsedTag<'a> {
value: u16,
}
/// Can feature `name` take a value (`salt=2`)? The features of [`EXTRA_FEATURES`] and `swsh` can:
/// each substitutes glyphs, and the value says which alternate.
/// Can feature `name` take a value (`salt=2`)? The features of [`EXTRA_FEATURES`] but
/// [`SWITCH_FEATURES`], and `swsh`, can: each substitutes glyphs, and the value says which
/// alternate.
fn takes_value(name: &str) -> bool {
name == "swsh" || EXTRA_FEATURES.contains(&name)
name == "swsh" || (EXTRA_FEATURES.contains(&name) && !SWITCH_FEATURES.contains(&name))
}
/// Read a feature tag: `tag`, `+tag`, `-tag` or, for a feature that takes a value, `tag=N` (`N`
@@ -316,6 +324,8 @@ impl OtFeatures {
}
for (i, tag) in EXTRA_FEATURES.iter().enumerate() {
if let (true, Ok(t)) = (s.extra & (1 << i) != 0, <[u8; 4]>::try_from(tag.as_bytes())) {
// H or V Style: the kana forms made for the writing direction, `vkna` in vertical type.
let t = if self.vertical && &t == b"hkna" { *b"vkna" } else { t };
v.push(f(&t, u32::from(s.extra_values.get(i).copied().unwrap_or(0).max(1))));
}
}
@@ -434,6 +444,31 @@ mod tests {
}
}
/// H or V Style (`hkna`) and Roman Italics (`ital`) are known, round-trip through the stored
/// tags and reach the shaper: `hkna` as itself in horizontal type and as `vkna` in vertical
/// type, `ital` in both. Neither takes an alternate's number.
#[test]
fn kana_style_and_roman_italics_are_kept_and_shaped() {
for t in ["hkna", "-hkna", "+ital", "ital"] {
assert!(OtFeatures::known_tag(t), "{t}");
}
for t in ["hkna=2", "ital=0", "vkna"] {
assert!(!OtFeatures::known_tag(t), "{t}");
}
assert_eq!(OtFeatures::from_tags(["ital", "hkna", "smcp"]).to_tags(), ["smcp", "hkna", "ital"]);
assert_eq!(OtFeatures::from_tags(["hkna", "ital", "-hkna"]).to_tags(), ["ital"]);
let st = CharStyle { features: vec!["hkna".into(), "ital".into()], ..CharStyle::default() };
let on = |vertical: bool| -> Vec<String> {
OtFeatures { vertical, ..OtFeatures::default() }.resolve(&st).iter().filter(|f| f.value == 1).map(|f| f.tag.to_string()).collect()
};
assert_eq!(on(false), ["hkna", "ital"]);
assert_eq!(on(true), ["vkna", "ital", "vert"]);
let plain = |vertical: bool| OtFeatures { vertical, ..OtFeatures::default() }.resolve(&CharStyle::default());
for vertical in [false, true] {
assert!(!plain(vertical).iter().any(|f| [b"hkna", b"vkna", b"ital"].iter().any(|t| f.tag == Tag::new(t))), "off by default");
}
}
/// `changes` lists the features a change turns on and off and leaves out the ones it keeps,
/// and applying them to any set makes the same change.
#[test]
+8
View File
@@ -336,6 +336,8 @@ impl Ctx<'_> {
tab.kern_shift = 0.0;
tab.aki_shift = 0.0;
tab.aki = 0.0;
tab.tsume_shift = 0.0;
tab.tsume = 0.0;
tab.tcy = None;
tab.wari = None;
tab.vpal = None;
@@ -653,6 +655,8 @@ impl Ctx<'_> {
k.kern_shift = 0.0;
k.aki_shift = 0.0;
k.aki = 0.0;
k.tsume_shift = 0.0;
k.tsume = 0.0;
k.len = 0;
k.lead = 0.0;
k.ch = kashida::TATWEEL;
@@ -713,6 +717,8 @@ mod emit_kashida_mark_last {
kern_shift: 0.0,
aki_shift: 0.0,
aki: 0.0,
tsume_shift: 0.0,
tsume: 0.0,
sx: face.upem.recip() * 48.0,
sy: face.upem.recip() * 48.0,
bshift: 0.0,
@@ -779,6 +785,8 @@ mod emit_kashida_mark_last {
kern_shift: 0.0,
aki_shift: 0.0,
aki: 0.0,
tsume_shift: 0.0,
tsume: 0.0,
sx: face.upem.recip() * 48.0,
sy: face.upem.recip() * 48.0,
bshift: 0.0,
+2
View File
@@ -22,6 +22,8 @@ fn synthetic_glyphs(specs: &[(usize, usize, f64, char)]) -> Vec<SGlyph> {
kern_shift: 0.0,
aki_shift: 0.0,
aki: 0.0,
tsume_shift: 0.0,
tsume: 0.0,
sx: 1.0,
sy: 1.0,
bshift: 0.0,
+24 -9
View File
@@ -49,6 +49,12 @@ pub(crate) struct SGlyph {
/// The Insert Aki Left and Right `adv` holds, in points: on the last glyph of its cluster, 0
/// on the others. Justification does not stretch or narrow it.
pub aki: f64,
/// The space Tsume ([`tighten`]) took before the cluster's ink, in points, on every glyph of
/// its cluster: `dx` is that much smaller.
pub tsume_shift: f64,
/// The space Tsume took out of `adv`, in points: on the last glyph of its cluster, 0 on the
/// others.
pub tsume: f64,
/// Outline scale (font units -> points).
pub sx: f64,
pub sy: f64,
@@ -232,6 +238,8 @@ pub(crate) fn hyphen_glyph(g: &SGlyph) -> SGlyph {
h.kern_shift = 0.0;
h.aki_shift = 0.0;
h.aki = 0.0;
h.tsume_shift = 0.0;
h.tsume = 0.0;
h.byte = g.byte + g.len;
h.len = 0;
h.ch = '-';
@@ -838,8 +846,8 @@ fn optical_pairs(db: &FontDb, text: &str, glyphs: &mut [SGlyph], runs: &[(Range<
let mut cache = HashMap::new();
let mut corrections: HashMap<[u64; 15], Option<f64>> = HashMap::new();
let mut references: HashMap<u32, Option<f64>> = HashMap::new();
// The Insert Aki a cluster's last glyph holds does not make a mark its base.
let shaped_advances: Vec<f64> = glyphs.iter().map(|g| g.adv - g.aki).collect();
// The Insert Aki and Tsume a cluster's last glyph holds do not make a mark its base.
let shaped_advances: Vec<f64> = glyphs.iter().map(|g| g.adv - g.aki + g.tsume).collect();
for i in 0..glyphs.len().saturating_sub(1) {
let Some((a, b)) = glyphs.get(i).zip(glyphs.get(i + 1)) else { continue };
if a.level != b.level {
@@ -897,10 +905,10 @@ fn optical_pairs(db: &FontDb, text: &str, glyphs: &mut [SGlyph], runs: &[(Range<
continue;
}
// Neither glyph is rotated, so a right-to-left manual kerning shift adds to the offset.
// Insert Aki is measured as no space: the pair is spaced as it would be without it, and
// the Aki stays on top of that.
let left_x = left.dx + left.kern_shift - left.aki_shift;
let right_x = right.dx + right.kern_shift - right.aki_shift;
// Insert Aki is measured as no space, and Tsume as taking none: the pair is spaced as it
// would be without them, and they stay on top of that.
let left_x = left.dx + left.kern_shift - left.aki_shift + left.tsume_shift;
let right_x = right.dx + right.kern_shift - right.aki_shift + right.tsume_shift;
let left_y = left.dy - left.bshift;
let right_y = right.dy - right.bshift;
let Some(left_style) = runs.get(left.run).map(|(_, s)| *s) else { continue };
@@ -909,7 +917,7 @@ fn optical_pairs(db: &FontDb, text: &str, glyphs: &mut [SGlyph], runs: &[(Range<
let tracking = left_style.tracking / 1000.0 * em * spacing_scale(left_style, false);
// A manual kerning value on the left glyph is part of its advance and, right to left, of
// its offset too (it spaces the left glyph from its left neighbor): it is not taken off.
let advance = glyphs[cluster_start..=cluster_end].iter().map(|g| g.adv - g.aki).sum::<f64>() - tracking;
let advance = glyphs[cluster_start..=cluster_end].iter().map(|g| g.adv - g.aki + g.tsume).sum::<f64>() - tracking;
let key = [
u64::from(left.face.id()),
u64::from(left.gid),
@@ -1280,6 +1288,8 @@ fn inline_glyph(
kern_shift: if level.is_rtl() && !vertical { manual_kern } else { before } + aki_shift,
aki_shift,
aki: if adv.is_finite() { aki_left + aki_right } else { 0.0 },
tsume_shift: 0.0,
tsume: 0.0,
// Not used to draw (the art has its own transform), but they make the glyph's em box
// its run's em: Character Alignment and Top-to-Top leading treat an inline graphic as a
// character of its run's size, whatever its scale (see `layout::glyph_em`).
@@ -1788,6 +1798,8 @@ fn shape_segment(text: &str, context: &Range<usize>, seg: &Segment, feats: &OtFe
kern_shift,
aki_shift,
aki: aki_in_adv,
tsume_shift: 0.0,
tsume: 0.0,
sx: k * hs,
sy: k * vs,
bshift: gst.baseline_shift + pos_shift,
@@ -1826,8 +1838,9 @@ fn shape_segment(text: &str, context: &Range<usize>, seg: &Segment, feats: &OtFe
/// drawn along the line, the last one with `own` as its width before the tracking, kerning and
/// Insert Aki its advance holds. `tsume` percent of the blank space between the cluster's own width
/// and its ink, on each side, comes out of the cluster's advance, and its glyphs are drawn the
/// left side's share earlier. A cluster without ink, such as a space, or with a width that is not
/// positive, keeps its place and width.
/// left side's share earlier ([`SGlyph::tsume`] and [`SGlyph::tsume_shift`] hold both, for Optical
/// kerning to measure the pair without them). A cluster without ink, such as a space, or with a
/// width that is not positive, keeps its place and width.
fn tighten(glyphs: &mut [SGlyph], own: f64, tsume: f64) {
let Some(last) = glyphs.len().checked_sub(1) else { return };
let share = if tsume.is_nan() { 0.0 } else { tsume.clamp(0.0, MAX_TSUME) / 100.0 };
@@ -1848,9 +1861,11 @@ fn tighten(glyphs: &mut [SGlyph], own: f64, tsume: f64) {
let right = (pen - hi).clamp(0.0, pen) * share;
for g in glyphs.iter_mut() {
g.dx -= left;
g.tsume_shift = left;
}
if let Some(g) = glyphs.get_mut(last) {
g.adv -= left + right;
g.tsume = left + right;
}
}
+38
View File
@@ -381,6 +381,44 @@ fn check_spaced_harakat(db: &FontDb, family: &str) {
assert!((length(&b) - length(&a) - 12.0).abs() < 1e-6, "{family}: {} → {}", length(&a), length(&b));
}
/// Right to left, with harakat coloured apart, Optical kerning keeps the Tsume of each letter's
/// cluster as it does in "HOH": the glyphs move as far with Optical kerning as without it.
#[test]
fn optical_kerning_keeps_the_tsume_of_a_letter_with_coloured_harakat() {
let db = FontDb::with_font_dirs(vec![]);
assert_eq!(db.add_font(crate::test_fonts::lam_alef_font(b"rlig").unwrap()), 1);
check_optical_tsume(&db, crate::test_fonts::lam_alef_family(b"rlig"));
if let Some(face) = arabic_face("optical_kerning_keeps_the_tsume_of_a_letter_with_coloured_harakat") {
check_optical_tsume(FontDb::global(), &face.family);
}
}
fn check_optical_tsume(db: &FontDb, family: &str) {
const WORD: &str = "بَبَ"; // ب 0, fatha 2, ب 4, fatha 6
let set = |optical: bool, letter: Option<usize>| {
let mut t = text_with_harakat(WORD, family, Some(red()));
crate::edit::style_range(&mut t.runs, 0, WORD.len(), |st| st.optical_kerning = optical);
if let Some(at) = letter {
crate::edit::style_range(&mut t.runs, at, at + 2, |st| st.tsume = 100.0);
}
t
};
// Each glyph's place and advance: where a mark's ink leaves no blank space on the left, the
// Tsume of the line's first cluster only narrows its advance and moves no glyph.
let xs = |t: &TextObject| layout(db, t).glyphs.iter().flat_map(|g| [g.xf.as_coeffs()[4], g.advance]).collect::<Vec<_>>();
assert!(xs(&set(true, None)).iter().zip(xs(&set(false, None))).any(|(a, b)| (a - b).abs() > 1e-6), "{family}: Optical moves the pair");
// Each letter in turn: the first one's cluster ends the pair, the second one's starts it.
for letter in [0, 4] {
let moved = |optical: bool| xs(&set(optical, Some(letter))).iter().zip(xs(&set(optical, None))).map(|(a, b)| a - b).collect::<Vec<_>>();
let (without, with_optical) = (moved(false), moved(true));
assert!(without.iter().any(|m| m.abs() > 1e-3), "{family} {letter}: Tsume moves or narrows the glyphs: {without:?}");
assert!(
without.len() == with_optical.len() && without.iter().zip(&with_optical).all(|(a, b)| (a - b).abs() < 1e-6),
"{family} {letter}: {without:?} {with_optical:?}"
);
}
}
#[test]
fn own_chars_need_the_same_setting_and_each_character_in_its_cluster() {
// بَبَب right to left: final beh (cluster 8), fatha and medial beh (cluster 4), fatha and
+19
View File
@@ -112,6 +112,25 @@ fn the_font_kerning_is_added_after_the_tsume() {
assert!(near(&before_kerned, &before_h) && before_h[0] < -10.0, "{before_kerned:?} {before_h:?}");
}
#[test]
fn optical_kerning_keeps_the_tsume() {
// Optical kerning spaces each pair as without the Tsume, and the Tsume stays on top: the
// characters move back as far with Optical kerning as without it.
let plain = point("HOH", style(100.0));
let optical = point("HOH", CharStyle { optical_kerning: true, ..style(100.0) });
let xs = |t: &TextObject| {
let l = layout(db(), t);
[0, 1, 2].map(|i| drawn_x(&l, i))
};
// The test font's Optical spacing differs from its own for these pairs.
assert!(!near(&xs(&optical), &xs(&plain)), "{:?} {:?}", xs(&optical), xs(&plain));
for at in [0, 1, 2] {
let without = moves(&plain, &with(&plain, at, |s| s.tsume = 100.0), &[0, 1, 2]);
let with_optical = moves(&optical, &with(&optical, at, |s| s.tsume = 100.0), &[0, 1, 2]);
assert!(without.iter().any(|m| *m < -1.0) && near(&with_optical, &without), "{at}: {without:?} {with_optical:?}");
}
}
#[test]
fn a_letter_with_its_mark_takes_the_tsume_of_the_letter() {
let plain = point("H\u{301}O", style(100.0));
+1
View File
@@ -311,6 +311,7 @@ impl Tool for CornerTool {
None => vec![],
}
}
PointerKind::TripleClick => vec![],
}
}
+1 -1
View File
@@ -131,7 +131,7 @@ impl Tool for ExtendPathTool {
// Back where it started: nothing to keep.
if length == 0.0 { vec![Action::Cancel] } else { vec![preview, Action::Commit] }
}
PointerKind::DoubleClick => vec![],
PointerKind::DoubleClick | PointerKind::TripleClick => vec![],
}
}
+1 -1
View File
@@ -326,7 +326,7 @@ impl Tool for ParametricShapeTool {
self.hover(cx, ev.pos);
}
match ev.kind {
PointerKind::Move => vec![],
PointerKind::Move | PointerKind::TripleClick => vec![],
PointerKind::Down => {
let tol = cx.point_tol();
let grip = selected(cx).and_then(|(id, s)| {
+1 -1
View File
@@ -96,7 +96,7 @@ impl Tool for SlideAnchorTool {
// Back where it started: nothing to keep.
if t == 0.0 { vec![Action::Cancel] } else { vec![preview, Action::Commit] }
}
PointerKind::DoubleClick => vec![],
PointerKind::DoubleClick | PointerKind::TripleClick => vec![],
}
}
+1
View File
@@ -527,6 +527,7 @@ impl Tool for SmartPenTool {
}
_ => vec![],
},
PointerKind::TripleClick => vec![],
}
}
+2 -2
View File
@@ -42,8 +42,8 @@ pub use live_paint::{
use live_paint::{check_live_paint_options, lp_color, lp_rgb_color};
pub use lookup::{
EDGE_NAME, FACE_NAME, Face, LIVE_PAINT_NAME, LIVE_PAINT_PREFIX, LP_JOIN_TOL, SOURCES_NAME, builder_members, connected_edges, drawn_outlines,
edge_near, edges, face_at, faces, flood_faces, is_live_paint, leaf_shapes, live_paint_at, live_paint_takes, node_outline, outline_snap,
path_contains, shape_builder_shapes, shapes_for, sources, visible_edge_near, visible_face_at,
edge_near, edges, face_at, faces, flood_faces, is_live_paint, leaf_shapes, live_paint_at, live_paint_takes, lp_stroke_paint, node_outline,
outline_snap, path_contains, shape_builder_shapes, shapes_for, sources, visible_edge_near, visible_face_at,
};
pub use map::{
BuilderMap, HATCH, HIGHLIGHT_RED, Hit, MergeGeometry, MergeInput, PreparedMerge, Rest, Touched, hatch, maps_built, merge_geometry, merge_inputs,
+187 -17
View File
@@ -1,12 +1,14 @@
use super::cache::RegionCache;
use super::lookup::{
connected_edges, flood_faces, is_live_paint, live_paint_at, live_paint_at_where, lp_stroke_paint, visible_edge_near, visible_face_at,
connected_edges, flood_faces, is_live_paint, leaf_shapes, live_paint_at, live_paint_at_where, lp_stroke_paint, node_outline, visible_edge_near,
visible_face_at,
};
use super::map::{HIGHLIGHT_RED, sorted_roots};
use super::{
Action, Arc, BezPath, CLICK_TOL_PX, Cursor, Document, EDGE_NAME, FACE_NAME, FillRule, Mods, Node, NodeId, Overlay, Point, PointerEvent,
PointerKind, Rect, Tool, ToolContext, ToolKey, Value, color_swatches, json, json_ids, path_contains, pick_swatch, plain, swatch_chips,
};
use vectorcraft_color::Paint;
// ---------- Live Paint Bucket ----------
@@ -174,6 +176,17 @@ enum LpPaint {
/// highlighted. The cursor is a filled bucket where a click fills a face, a brush where it paints
/// an edge and an empty bucket where it paints nothing; with Alt it is the Eyedropper.
///
/// A double-click on a face fills it and the faces reached from it across edges that draw no
/// stroke (`scope: "connected"`); on an edge it paints the edges joined to it that have its stroke.
/// A triple-click on a face fills every face of the group with the face's fill, and on an edge it
/// paints every edge of the group with the edge's stroke (`scope: "samePaint"`). Each click of a
/// double-click or triple-click paints as it arrives, as its own undo step, and the paint compared
/// is the one the face or edge had before the first of its clicks that painted it. A first click
/// that made the Live Paint group counts when the face it filled is the clicked face. Shift and the
/// options choose a face or an edge as for a click; with Alt or Cmd/Ctrl held a double-click or
/// triple-click paints nothing. With Space held for the view tools, a click, double-click or triple-click paints
/// nothing and no face or edge is highlighted.
///
/// The Left and Right arrow keys without Shift, Alt or Cmd/Ctrl set the active paint (the fill,
/// or the stroke when the Stroke proxy is in front) to the color swatch before or after it in the
/// Swatches panel, wrapping around; from a color that is no swatch, Right picks the first swatch
@@ -184,10 +197,13 @@ enum LpPaint {
pub struct LivePaintBucketTool {
pub(super) cache: RegionCache,
pub(super) hover: LpHover,
/// Where the pointer last moved, and whether Shift and Alt were held.
at: Option<(Point, bool, bool)>,
/// Where the pointer last moved, and the modifiers held there.
at: Option<(Point, Mods)>,
/// The fill command and polyline previewed from the press's snapshot.
fill_drag: Option<(Value, Vec<Vec<Point>>)>,
/// The last [`LP_PRESSES`] presses, oldest first: the face or edge each one painted, with its
/// paint before that press, or None for a press that painted no face or edge.
presses: Vec<Option<LpPress>>,
fills: bool,
strokes: bool,
highlight: bool,
@@ -200,6 +216,40 @@ pub struct LivePaintBucketTool {
picked: [Option<usize>; 2],
}
/// The face or edge a Live Paint Bucket press paints.
#[derive(Clone, Debug, PartialEq)]
struct LpPress {
/// The face or edge; None for the face of the Live Paint group the press makes.
part: Option<NodeId>,
/// Where the press was.
at: Point,
/// Its fill (a face), or the stroke paint it draws with ([`lp_stroke_paint`], an edge), before
/// the press.
before: Paint,
/// The other faces or edges the double-click that followed the press reached, each with its
/// fill or drawn stroke paint before the double-click.
also: Vec<(NodeId, Paint)>,
}
/// The fill of the face under `p` in the Live Paint group that `roots` make: the fill of the
/// front-most of their paths whose closed subpaths hold `p`, else none. Open subpaths bound no face.
fn made_face_fill(doc: &Document, roots: &[NodeId], p: Point) -> Paint {
let mut leaves = vec![];
for n in roots.iter().filter_map(|id| doc.node(*id)) {
leaf_shapes(n, &mut leaves);
}
let holds = |l: &Node| {
node_outline(l).is_some_and(|(path, rule)| {
let closed = vectorcraft_geom::PathData::new(path.subpaths.into_iter().filter(|sp| sp.closed && sp.anchors.len() >= 2).collect());
!closed.is_empty() && path_contains(&closed, rule, p)
})
};
leaves.iter().rev().find(|l| holds(l)).map_or(Paint::None, |l| l.appearance.fill_paint())
}
/// How many presses the Live Paint Bucket keeps: the three of a triple-click.
const LP_PRESSES: usize = 3;
/// Maximum points in one Live Paint fill path chunk.
pub const LP_FILL_CHUNK_POINTS: usize = 4096;
@@ -210,6 +260,7 @@ impl Default for LivePaintBucketTool {
hover: LpHover::None,
at: None,
fill_drag: None,
presses: Vec::new(),
fills: true,
strokes: false,
highlight: true,
@@ -274,14 +325,109 @@ impl LivePaintBucketTool {
}
}
/// The highlight at `p` for a pointer with Shift and Alt held as given: none with Alt or with
/// Highlight off, else the face or edge a click there paints. With Highlight off the selection's
/// map is still made, for the cursor ([`Self::paints_at`]).
fn hover_at(&mut self, cx: &ToolContext, p: Point, shift: bool, alt: bool) -> LpHover {
if alt {
/// Note a press: what it paints, None when it paints no face or edge.
fn note_press(&mut self, press: Option<LpPress>) {
if self.presses.len() == LP_PRESSES {
self.presses.remove(0);
}
self.presses.push(press);
}
/// Note a press at `at` that paints face or edge (`edge`) `n`.
fn note_part(&mut self, n: &Node, edge: bool, at: Point) {
let before = if edge { lp_stroke_paint(n) } else { n.appearance.fill_paint() };
self.note_press(Some(LpPress { part: Some(n.id), at, before, also: vec![] }));
}
/// Note that the double-click after the last press also reaches `parts` of group `group`, with
/// the paint each has now (a face's fill, or an edge's drawn stroke paint with `edge`).
fn note_reached(&mut self, group: &Node, parts: Vec<NodeId>, edge: bool) {
let Some(Some(last)) = self.presses.last_mut() else { return };
let reached: std::collections::HashSet<NodeId> = parts.into_iter().filter(|id| last.part != Some(*id)).collect();
last.also = group
.children()
.into_iter()
.flatten()
.filter(|c| reached.contains(&c.id))
.map(|n| (n.id, if edge { lp_stroke_paint(n) } else { n.appearance.fill_paint() }))
.collect();
}
/// The paint `part` had before the first press of a click sequence of `clicks` presses that
/// painted `part`, or before the double-click after a press when that double-click reached it
/// (the sequence's first press counts when it made the group `part` is in and the face it
/// filled there is `part`); `now` when the last press did not paint it.
fn before(&self, cx: &ToolContext, part: NodeId, clicks: usize, now: Paint) -> Paint {
let Some(run) = self.presses.len().checked_sub(clicks).and_then(|from| self.presses.get(from..)) else { return now };
let made_part = |q: &LpPress| live_paint_at(cx.doc, q.at).and_then(|g| visible_face_at(cx.doc.node(g)?, q.at)).is_some_and(|f| f.id == part);
let on_part = |i: usize, q: &LpPress| q.part == Some(part) || (i == 0 && q.part.is_none() && made_part(q));
if !run.last().and_then(Option::as_ref).is_some_and(|q| on_part(run.len() - 1, q)) {
return now;
}
for (i, q) in run.iter().enumerate() {
let Some(q) = q else { continue };
if on_part(i, q) {
return q.before.clone();
}
if let Some((_, paint)) = q.also.iter().find(|(id, _)| *id == part) {
return paint.clone();
}
}
now
}
/// What a double-click (`scope` "connected", 2 `clicks`) or a triple-click ("samePaint", 3) at
/// `p` runs: the command a click there runs, with `scope`, and the paint it compares as `match`.
/// A double-click notes the other faces or edges it reaches, for the triple-click's `match`.
fn multi_click(&mut self, cx: &ToolContext, p: Point, mods: Mods, scope: &str, clicks: usize) -> Vec<Action> {
// With Alt held, with Space held for the view tools, or with Cmd/Ctrl held (its presses went
// to the selection tool Cmd lends), a double-click or triple-click paints nothing.
if mods.alt || mods.space || mods.cmd {
return vec![];
}
let point = json!([p.x, p.y]);
let paint = self.paints(mods.shift);
if matches!(paint, LpPaint::Strokes | LpPaint::Both)
&& let Some((g, Some(e))) = lp_part_at(cx.doc, p, cx.tol(4.0), true, &|id| lp_visible(cx, id))
{
let mut v = json!({ "group": g.0, "point": point, "tolerance": cx.tol(4.0), "scope": scope });
let like = self.before(cx, e.id, clicks, lp_stroke_paint(e));
if clicks == 2
&& let Some(group) = cx.doc.node(g)
{
self.note_reached(group, connected_edges(group, e.id, &like), true);
}
if let Ok(like) = serde_json::to_value(like) {
v["match"] = like;
}
return vec![Action::Exec("livePaint.strokeEdge".into(), v)];
}
if !matches!(paint, LpPaint::Fills | LpPaint::Both) {
return vec![];
}
let Some((g, f)) = live_paint_at(cx.doc, p).and_then(|g| Some((g, visible_face_at(cx.doc.node(g)?, p)?))) else { return vec![] };
let mut v = json!({ "group": g.0, "point": point, "scope": scope });
if clicks == 2
&& let Some(group) = cx.doc.node(g)
{
self.note_reached(group, flood_faces(group, f.id), false);
}
if scope == "samePaint"
&& let Ok(like) = serde_json::to_value(self.before(cx, f.id, clicks, f.appearance.fill_paint()))
{
v["match"] = like;
}
vec![Action::Exec("livePaint.fill".into(), v)]
}
/// The highlight at `p` for a pointer with the modifiers `mods`: none with Alt, with Space held
/// for the view tools or with Highlight off, else the face or edge a click there paints. With
/// Highlight off the selection's map is still made, for the cursor ([`Self::paints_at`]).
fn hover_at(&mut self, cx: &ToolContext, p: Point, mods: Mods) -> LpHover {
if mods.alt || mods.space {
return LpHover::None;
}
let target = self.target_at(cx, p, shift);
let target = self.target_at(cx, p, mods.shift);
if self.highlight { target } else { LpHover::None }
}
@@ -356,13 +502,19 @@ impl Tool for LivePaintBucketTool {
}
match ev.kind {
PointerKind::Move => {
self.at = Some((p, ev.mods.shift, ev.mods.alt));
self.hover = self.hover_at(cx, p, ev.mods.shift, ev.mods.alt);
self.at = Some((p, ev.mods));
self.hover = self.hover_at(cx, p, ev.mods);
vec![]
}
PointerKind::Down => {
self.hover = LpHover::None;
// With Space held for the view tools, a press paints nothing.
if ev.mods.space {
self.note_press(None);
return vec![];
}
if ev.mods.alt {
self.note_press(None);
if ev.mods.shift {
return crate::xform::eyedropper::sample_color_at(cx, p).map_or_else(Vec::new, |color| {
vec![Action::Exec("paint.sampleColor".into(), json!({ "color": crate::params::color_json(&color), "ids": [] }))]
@@ -387,36 +539,49 @@ impl Tool for LivePaintBucketTool {
let point = json!([p.x, p.y]);
let paint = self.paints(ev.mods.shift);
if matches!(paint, LpPaint::Strokes | LpPaint::Both)
&& let Some((g, Some(_))) = lp_part_at(cx.doc, p, cx.tol(4.0), true, &|id| lp_visible(cx, id))
&& let Some((g, Some(e))) = lp_part_at(cx.doc, p, cx.tol(4.0), true, &|id| lp_visible(cx, id))
{
self.note_part(e, true, p);
return vec![Action::Exec("livePaint.strokeEdge".into(), json!({ "group": g.0, "point": point, "tolerance": cx.tol(4.0) }))];
}
if !matches!(paint, LpPaint::Fills | LpPaint::Both) {
self.note_press(None);
return vec![];
}
if let Some(g) = live_paint_at(cx.doc, p) {
match cx.doc.node(g).and_then(|n| visible_face_at(n, p)) {
Some(f) => self.note_part(f, false, p),
None => self.note_press(None),
}
return self.begin_fill(json!({ "group": g.0, "point": point }), p);
}
if self.cache.at(cx, p).is_some() {
let roots = sorted_roots(cx.doc, &cx.selection.objects);
self.note_press(Some(LpPress { part: None, at: p, before: made_face_fill(cx.doc, &roots, p), also: vec![] }));
return self.begin_fill(json!({ "ids": json_ids(&roots), "point": point }), p);
}
self.note_press(None);
vec![]
}
PointerKind::Drag => self.drag_fill(p),
PointerKind::Up => {
// The swatch preview shows again at the release point.
self.at = Some((p, ev.mods.shift, ev.mods.alt));
self.at = Some((p, ev.mods));
let mut acts = self.drag_fill(p);
if self.fill_drag.take().is_some() {
acts.push(Action::Commit);
}
acts
}
_ => vec![],
PointerKind::DoubleClick => self.multi_click(cx, p, ev.mods, "connected", 2),
PointerKind::TripleClick => self.multi_click(cx, p, ev.mods, "samePaint", 3),
}
}
fn history_moved(&mut self) {
self.presses.clear();
}
/// Escape during a fill drag cancels it. Left and Right pick the color swatch before or after
/// the active paint, while no drag is on.
fn key(&mut self, cx: &ToolContext, key: ToolKey, mods: Mods) -> Vec<Action> {
@@ -455,6 +620,7 @@ impl Tool for LivePaintBucketTool {
}
fn deactivate(&mut self, _cx: &ToolContext) -> Vec<Action> {
self.presses.clear();
if self.fill_drag.take().is_some() { vec![Action::Commit] } else { vec![] }
}
@@ -469,7 +635,8 @@ impl Tool for LivePaintBucketTool {
// No chips during a fill drag, or while Alt makes the tool sample with the eyedropper.
if self.preview
&& !self.busy()
&& let Some((at, _, false)) = self.at
&& let Some((at, mods)) = self.at
&& !mods.alt
{
out.extend(swatch_chips(cx, at, Self::active_paint(cx), self.picked[Self::picked_slot(cx)], true));
}
@@ -520,8 +687,8 @@ impl Tool for LivePaintBucketTool {
// of a Live Paint group the hover takes no map.
loop {
self.cache.settle(wait);
if let Some((p, shift, alt)) = self.at {
self.hover = self.hover_at(cx, p, shift, alt);
if let Some((p, mods)) = self.at {
self.hover = self.hover_at(cx, p, mods);
}
if !wait || !self.cache.waiting() {
break;
@@ -776,6 +943,9 @@ impl Tool for LivePaintSelectionTool {
(false, false) => vec![Action::Exec("select.set".into(), json!({ "ids": json_ids(&ids) }))],
}
}
// The tool takes no action on a triple-click; its third press and release select as a
// click does.
PointerKind::TripleClick => vec![],
}
}
+1 -1
View File
@@ -130,7 +130,7 @@ fn lp_cells_around(p: Point) -> impl Iterator<Item = (i64, i64)> {
/// The stroke paint Live Paint edge `edge` draws with: the paint of its topmost stroke that is shown
/// with a paint, a weight above 0 and an opacity above 0, or [`Paint::None`] when the edge is fully
/// transparent or has no such stroke.
pub(super) fn lp_stroke_paint(edge: &Node) -> Paint {
pub fn lp_stroke_paint(edge: &Node) -> Paint {
if edge.opacity <= 0.0 {
return Paint::None;
}
+297
View File
@@ -1124,6 +1124,287 @@ fn bucket_click_fills_face_and_shift_click_strokes_edge() {
assert_eq!(id, "livePaint.strokeEdge");
}
/// A double-click runs a click's command with `scope: "connected"` and a triple-click with
/// `"samePaint"`, matching the paint the face or edge had before the first click there.
#[test]
fn bucket_double_and_triple_click_widen_what_a_click_paints() {
let (d, gid, f2, e) = live_group_doc();
let red = vectorcraft_color::Paint::solid(vectorcraft_color::Color::rgb(1.0, 0.0, 0.0));
let mut painted = d.clone();
painted.node_mut(f2).unwrap().appearance.set_fill(red.clone());
painted.node_mut(e).unwrap().appearance.set_stroke(red.clone());
let s = Selection::default();
let p = paint();
let (cx, later) = (cx(&d, &s, &p), cx(&painted, &s, &p));
let face_before = serde_json::to_value(d.node(f2).unwrap().appearance.fill_paint()).unwrap();
let edge_before = serde_json::to_value(d.node(e).unwrap().appearance.stroke_paint()).unwrap();
let red_json = serde_json::to_value(&red).unwrap();
assert_ne!(face_before, red_json);
assert_ne!(edge_before, red_json);
let fill = |scope: &str, like: Option<&Value>| {
let mut v = json!({ "group": gid.0, "point": [75.0, 25.0], "scope": scope });
if let Some(like) = like {
v["match"] = like.clone();
}
vec![Action::Exec("livePaint.fill".into(), v)]
};
let click = |t: &mut LivePaintBucketTool, cx: &ToolContext, x: f64, m: Mods| {
t.pointer(cx, &ev(PointerKind::Down, x, 25.0).with_mods(m));
t.pointer(cx, &ev(PointerKind::Up, x, 25.0).with_mods(m));
};
let mut t = LivePaintBucketTool::default();
// The clicks paint the face as they arrive; the triple-click matches the fill from before them.
click(&mut t, &cx, 75.0, Mods::default());
click(&mut t, &later, 75.0, Mods::default());
assert_eq!(t.pointer(&later, &ev(PointerKind::DoubleClick, 75.0, 25.0)), fill("connected", None));
click(&mut t, &later, 75.0, Mods::default());
assert_eq!(t.pointer(&later, &ev(PointerKind::TripleClick, 75.0, 25.0)), fill("samePaint", Some(&face_before)));
// A new click there starts again from the fill it finds.
click(&mut t, &later, 75.0, Mods::default());
assert_eq!(t.pointer(&later, &ev(PointerKind::TripleClick, 75.0, 25.0)), fill("samePaint", Some(&red_json)));
// A click before the triple-click's own three is not part of it.
let mut t = LivePaintBucketTool::default();
click(&mut t, &cx, 75.0, Mods::default());
for _ in 0..3 {
click(&mut t, &later, 75.0, Mods::default());
}
assert_eq!(t.pointer(&later, &ev(PointerKind::TripleClick, 75.0, 25.0)), fill("samePaint", Some(&red_json)));
// Shift: the edge, matching its stroke from before the first click.
let shift = Mods { shift: true, ..Default::default() };
let stroke = |scope: &str, like: &Value| {
vec![Action::Exec(
"livePaint.strokeEdge".into(),
json!({ "group": gid.0, "point": [51.0, 25.0], "tolerance": 4.0, "scope": scope, "match": like }),
)]
};
click(&mut t, &cx, 51.0, shift);
click(&mut t, &later, 51.0, shift);
assert_eq!(t.pointer(&later, &ev(PointerKind::DoubleClick, 51.0, 25.0).with_mods(shift)), stroke("connected", &edge_before));
click(&mut t, &later, 51.0, shift);
assert_eq!(t.pointer(&later, &ev(PointerKind::TripleClick, 51.0, 25.0).with_mods(shift)), stroke("samePaint", &edge_before));
// With Alt or Space held, or with both options off, a double-click or triple-click paints nothing.
let alt = Mods { alt: true, ..Default::default() };
let space = Mods { space: true, ..Default::default() };
for k in [PointerKind::DoubleClick, PointerKind::TripleClick] {
assert!(t.pointer(&cx, &ev(k, 75.0, 25.0).with_mods(alt)).is_empty(), "{k:?}");
assert!(t.pointer(&cx, &ev(k, 75.0, 25.0).with_mods(Mods { cmd: true, ..Default::default() })).is_empty(), "{k:?} with Cmd");
assert!(t.pointer(&cx, &ev(k, 75.0, 25.0).with_mods(space)).is_empty(), "{k:?} with Space");
assert!(t.pointer(&cx, &ev(k, 51.0, 25.0).with_mods(Mods { shift: true, ..space })).is_empty(), "{k:?} with Shift and Space");
}
// A press with Space held paints nothing either.
for m in [space, Mods { shift: true, ..space }] {
for (k, x) in [(PointerKind::Down, 75.0), (PointerKind::Up, 75.0), (PointerKind::Down, 51.0), (PointerKind::Up, 51.0)] {
assert!(t.pointer(&cx, &ev(k, x, 25.0).with_mods(m)).is_empty(), "{k:?} at {x} with {m:?}");
}
}
t.set_option("paintFills", &json!(false));
for k in [PointerKind::DoubleClick, PointerKind::TripleClick] {
assert!(t.pointer(&cx, &ev(k, 75.0, 25.0)).is_empty(), "{k:?}");
}
// Outside every face, nothing is painted.
t.set_option("paintFills", &json!(true));
assert!(t.pointer(&cx, &ev(PointerKind::DoubleClick, 400.0, 400.0)).is_empty());
}
/// A triple-click whose third click lands on a face the double-click's flood filled matches that
/// face's fill from before the double-click.
#[test]
fn bucket_triple_click_on_a_face_the_double_click_flooded_matches_its_earlier_fill() {
let (mut d, gid, f2, _) = live_group_doc();
let red = vectorcraft_color::Paint::solid(vectorcraft_color::Color::rgb(1.0, 0.0, 0.0));
let blue = vectorcraft_color::Paint::solid(vectorcraft_color::Color::rgb(0.0, 0.0, 1.0));
let f1 = crate::builder::face_at(d.node(gid).unwrap(), Point::new(25.0, 25.0)).unwrap().id;
for f in [f1, f2] {
d.node_mut(f).unwrap().appearance.set_fill(red.clone());
}
let mut first = d.clone();
first.node_mut(f1).unwrap().appearance.set_fill(blue.clone());
let mut flooded = first.clone();
flooded.node_mut(f2).unwrap().appearance.set_fill(blue.clone());
let s = Selection::default();
let p = paint();
let (start, first, flooded) = (cx(&d, &s, &p), cx(&first, &s, &p), cx(&flooded, &s, &p));
let mut t = LivePaintBucketTool::default();
let click = |t: &mut LivePaintBucketTool, cx: &ToolContext, x: f64| {
t.pointer(cx, &ev(PointerKind::Down, x, 25.0));
t.pointer(cx, &ev(PointerKind::Up, x, 25.0));
};
click(&mut t, &start, 25.0);
click(&mut t, &first, 25.0);
t.pointer(&first, &ev(PointerKind::DoubleClick, 25.0, 25.0));
click(&mut t, &flooded, 75.0);
let like = serde_json::to_value(&red).unwrap();
assert_eq!(
t.pointer(&flooded, &ev(PointerKind::TripleClick, 75.0, 25.0)),
vec![Action::Exec("livePaint.fill".into(), json!({ "group": gid.0, "point": [75.0, 25.0], "scope": "samePaint", "match": like }))]
);
}
/// On an edge that stores a stroke paint but draws none (its stroke hidden, or the edge fully
/// transparent), a double-click or triple-click matches no paint, with or without the clicks
/// before it.
#[test]
fn bucket_multi_click_on_an_edge_matches_the_paint_it_draws() {
let (mut d, gid, _, e) = live_group_doc();
d.node_mut(e).unwrap().appearance.set_stroke(vectorcraft_color::Paint::solid(vectorcraft_color::Color::rgb(0.0, 0.0, 0.0)));
let mut hidden = d.clone();
hidden.node_mut(e).unwrap().appearance.stroke_mut().unwrap().visible = false;
let mut clear = d.clone();
clear.node_mut(e).unwrap().opacity = 0.0;
let none = serde_json::to_value(vectorcraft_color::Paint::None).unwrap();
let s = Selection::default();
let p = paint();
let shift = Mods { shift: true, ..Default::default() };
let stroke = |scope: &str| {
vec![Action::Exec(
"livePaint.strokeEdge".into(),
json!({ "group": gid.0, "point": [51.0, 25.0], "tolerance": 4.0, "scope": scope, "match": none }),
)]
};
for doc in [&hidden, &clear] {
let cx = cx(doc, &s, &p);
let mut t = LivePaintBucketTool::default();
assert_eq!(t.pointer(&cx, &ev(PointerKind::DoubleClick, 51.0, 25.0).with_mods(shift)), stroke("connected"));
for _ in 0..3 {
t.pointer(&cx, &ev(PointerKind::Down, 51.0, 25.0).with_mods(shift));
t.pointer(&cx, &ev(PointerKind::Up, 51.0, 25.0).with_mods(shift));
}
assert_eq!(t.pointer(&cx, &ev(PointerKind::TripleClick, 51.0, 25.0).with_mods(shift)), stroke("samePaint"));
}
}
/// A triple-click whose first click makes the Live Paint group matches the fill of the face the
/// group makes there: an open path in front, whose outline bounds no face, does not give it.
#[test]
fn bucket_triple_click_on_a_made_group_skips_open_paths() {
use vectorcraft_color::{Color, Paint};
use vectorcraft_geom::{PathData, SubPath};
let (red, blue) = (Paint::solid(Color::rgb(1.0, 0.0, 0.0)), Paint::solid(Color::rgb(0.0, 0.0, 1.0)));
let mut d = Document::new(500.0, 500.0);
let l = d.layers[0].id;
let back = d.alloc_id();
let mut look = Appearance::default_art();
look.set_fill(red.clone());
d.insert(Some(l), 0, Node::path(back, shapes::rectangle(Rect::new(0.0, 0.0, 100.0, 100.0)), look)).unwrap();
// An open U around (75, 25), filled blue.
let u = [Point::new(60.0, 5.0), Point::new(60.0, 45.0), Point::new(90.0, 45.0), Point::new(90.0, 5.0)];
let front = d.alloc_id();
let mut look = Appearance::default_art();
look.set_fill(blue);
d.insert(Some(l), 1, Node::path(front, PathData::single(SubPath::polyline(&u, false)), look)).unwrap();
// The face the planar map makes there takes its fill from the square, as the group's would.
let shapes: Vec<vectorcraft_pathops::Shape> = [back, front]
.iter()
.enumerate()
.filter_map(|(k, id)| node_outline(d.node(*id)?).map(|(path, rule)| vectorcraft_pathops::Shape::new(path, rule, k as u64)))
.collect();
let (regions, _) = vectorcraft_pathops::live_paint(&shapes);
let face = regions.iter().find(|r| r.contains(Point::new(75.0, 25.0))).expect("a face at (75, 25)");
assert_eq!(face.top(), Some(0), "the square is the face's top shape");
let mut s = Selection::default();
s.set([back, front]);
let p = paint();
let (made, ..) = live_group_doc();
let none = Selection::default();
let (cx, later) = (cx(&d, &s, &p), cx(&made, &none, &p));
let mut t = LivePaintBucketTool::default();
t.pointer(&cx, &ev(PointerKind::Down, 75.0, 25.0));
t.pointer(&cx, &ev(PointerKind::Up, 75.0, 25.0));
for _ in 0..2 {
t.pointer(&later, &ev(PointerKind::Down, 75.0, 25.0));
t.pointer(&later, &ev(PointerKind::Up, 75.0, 25.0));
}
let acts = t.pointer(&later, &ev(PointerKind::TripleClick, 75.0, 25.0));
let [Action::Exec(id, v)] = acts.as_slice() else { panic!("{acts:?}") };
assert_eq!(id, "livePaint.fill");
assert_eq!(v["match"], serde_json::to_value(&red).unwrap());
}
/// A triple-click whose first click makes the Live Paint group on one face and whose other two
/// clicks fill another face matches the fill the second face had before the first click on it,
/// not the fill under the first click or the fill the clicks gave it.
#[test]
fn bucket_triple_click_after_making_the_group_on_another_face_matches_its_own_face() {
use vectorcraft_color::{Color, Paint};
let (red, blue) = (Paint::solid(Color::rgb(1.0, 0.0, 0.0)), Paint::solid(Color::rgb(0.0, 0.0, 1.0)));
let mut d = Document::new(500.0, 500.0);
let l = d.layers[0].id;
let square = d.alloc_id();
let mut look = Appearance::default_art();
look.set_fill(red.clone());
d.insert(Some(l), 0, Node::path(square, shapes::rectangle(Rect::new(0.0, 0.0, 100.0, 50.0)), look)).unwrap();
let mut s = Selection::default();
s.set([square]);
let p = paint();
let (made, _, f2, _) = live_group_doc();
let mut painted = made.clone();
painted.node_mut(f2).unwrap().appearance.set_fill(blue.clone());
let none = Selection::default();
let (cx, later, after) = (cx(&d, &s, &p), cx(&made, &none, &p), cx(&painted, &none, &p));
let mut t = LivePaintBucketTool::default();
// The first click makes the group and fills the face at (25, 25); the next two fill (75, 25),
// the first of them painting it blue.
t.pointer(&cx, &ev(PointerKind::Down, 25.0, 25.0));
t.pointer(&cx, &ev(PointerKind::Up, 25.0, 25.0));
for ctx in [&later, &after] {
t.pointer(ctx, &ev(PointerKind::Down, 75.0, 25.0));
t.pointer(ctx, &ev(PointerKind::Up, 75.0, 25.0));
}
let acts = t.pointer(&after, &ev(PointerKind::TripleClick, 75.0, 25.0));
let [Action::Exec(id, v)] = acts.as_slice() else { panic!("{acts:?}") };
assert_eq!(id, "livePaint.fill");
let own = serde_json::to_value(made.node(f2).unwrap().appearance.fill_paint()).unwrap();
assert_ne!(own, serde_json::to_value(&red).unwrap());
assert_ne!(own, serde_json::to_value(&blue).unwrap());
assert_eq!(v["match"], own);
}
/// A triple-click whose clicks land on one face, another face, then the first face again matches
/// the fill the first face had before the first click on it, not the fill that click gave it.
#[test]
fn bucket_triple_click_with_a_click_on_another_face_between_matches_the_first_fill() {
use vectorcraft_color::{Color, Paint};
let red = Paint::solid(Color::rgb(1.0, 0.0, 0.0));
let (d, gid, f2, _) = live_group_doc();
let mut painted = d.clone();
painted.node_mut(f2).unwrap().appearance.set_fill(red.clone());
let s = Selection::default();
let p = paint();
let (cx, later) = (cx(&d, &s, &p), cx(&painted, &s, &p));
let mut t = LivePaintBucketTool::default();
// The first click paints the face at (75, 25) red; the second fills the face at (25, 25).
for (ctx, x) in [(&cx, 75.0), (&later, 25.0), (&later, 75.0)] {
t.pointer(ctx, &ev(PointerKind::Down, x, 25.0));
t.pointer(ctx, &ev(PointerKind::Up, x, 25.0));
}
let acts = t.pointer(&later, &ev(PointerKind::TripleClick, 75.0, 25.0));
let own = serde_json::to_value(d.node(f2).unwrap().appearance.fill_paint()).unwrap();
assert_ne!(own, serde_json::to_value(&red).unwrap());
assert_eq!(
acts,
vec![Action::Exec("livePaint.fill".into(), json!({ "group": gid.0, "point": [75.0, 25.0], "scope": "samePaint", "match": own }))]
);
}
/// With Space held for the view tools, the pointer outlines no face or edge, as a press there
/// paints nothing.
#[test]
fn bucket_highlights_nothing_with_space_held() {
let (d, ..) = live_group_doc();
let s = Selection::default();
let p = paint();
let cx = cx(&d, &s, &p);
let mut t = LivePaintBucketTool::default();
let outlined = |t: &LivePaintBucketTool| t.overlays(&cx).iter().any(|o| matches!(o, Overlay::Path { .. }));
let space = Mods { space: true, ..Default::default() };
for (x, m) in [(75.0, space), (51.0, Mods { shift: true, ..space })] {
t.pointer(&cx, &ev(PointerKind::Move, x, 25.0).with_mods(m));
assert!(!outlined(&t), "at {x} with {m:?}");
}
t.pointer(&cx, &ev(PointerKind::Move, 75.0, 25.0));
assert!(outlined(&t));
}
/// After a fill drag, the cursor swatch preview shows at the release point, not where the pointer
/// last moved before the press.
#[test]
@@ -2292,6 +2573,22 @@ fn live_paint_selection_double_click_selects_connected_faces_or_edges() {
assert!(dbl(&mut t, 25.0, 1.0, alt).is_empty());
}
#[test]
fn live_paint_selection_triple_click_adds_nothing_to_its_clicks() {
let mut d = Document::new(500.0, 500.0);
let (_, [a, ..], _) = live_strip(&mut d);
let s = Selection::default();
let p = paint();
let cx = cx(&d, &s, &p);
let mut t = LivePaintSelectionTool::default();
// The third click's press and release select the face under the pointer, as a click does.
assert_eq!(lp_click(&mut t, &cx, ev(PointerKind::Down, 25.0, 25.0)), vec![Action::Exec("select.set".into(), json!({ "ids": [a.0] }))]);
for m in [Mods::default(), Mods { alt: true, ..Default::default() }, Mods { shift: true, ..Default::default() }] {
assert!(t.pointer(&cx, &ev(PointerKind::TripleClick, 25.0, 25.0).with_mods(m)).is_empty());
assert!(t.pointer(&cx, &ev(PointerKind::TripleClick, 25.0, 1.0).with_mods(m)).is_empty());
}
}
#[test]
fn live_paint_selection_double_click_skips_locked_groups_and_art_outside_isolation() {
let mut d = Document::new(500.0, 500.0);
+1
View File
@@ -169,6 +169,7 @@ impl Tool for CropImageTool {
PointerKind::Up => self.drag = None,
PointerKind::DoubleClick => return self.apply(cx),
PointerKind::Move => self.last = ev.pos,
PointerKind::TripleClick => {}
}
vec![]
}
+1 -1
View File
@@ -422,7 +422,7 @@ impl Tool for PuppetWarpTool {
}
None => vec![],
},
PointerKind::DoubleClick => vec![],
PointerKind::DoubleClick | PointerKind::TripleClick => vec![],
}
}
/// Delete/Backspace remove the selected pins; with none selected they are the shortcut's
+1
View File
@@ -300,6 +300,7 @@ impl Tool for WidthTool {
self.hover = Self::spot_at(cx, p);
vec![]
}
PointerKind::TripleClick => vec![],
PointerKind::DoubleClick => {
let Some(spot) = Self::spot_at(cx, p) else { return vec![] };
let Some((w, _)) = Self::hit(cx, &spot, p) else {
+1
View File
@@ -653,6 +653,7 @@ impl Tool for CurvatureTool {
self.pts[i].1 = !self.pts[i].1;
vec![Action::Exec("path.curvature".into(), self.params())]
}
PointerKind::TripleClick => vec![],
}
}
fn notify(&mut self, cx: &ToolContext, what: &str) {

Some files were not shown because too many files have changed in this diff Show More