Merge main into feat/psd-export-writes-slices

This commit is contained in:
dotCooCoo committed 2026-11-15 18:12:07 -08:00
commit 66ce4de5db
200 files changed
+12631 -616

No files matched your search

+1 -1
View File
@@ -24,7 +24,7 @@ blocking it ([Alpha gate](docs/roadmap.md#alpha-gate)).
| | Value | Kind |
|---|---|---|
| **Feature breadth** (Illustrator's menu items, tools, effects, formats exist) | **~88%** | measured in part: menu items 348/375 wired (92.8%), tools 89/92, Illustrator effects 46/50, Photoshop effects 57/57, 3D 4/4 (initial types, no materials) |
| **Feature breadth** (Illustrator's menu items, tools, effects, formats exist) | **~88%** | measured in part: menu items 717/719 wired (99.7%), tools 89/92, Illustrator effects 46/50, Photoshop effects 57/57, 3D 4/4 (initial types, no materials) |
| **Feature depth** (weighted by use, scored by behaviour) | **~75%** | estimated |
| **To beta** | **~170–270 h** one agent · ~50–80 h with 4–6 agents | estimated |
| **To full parity** | **~360–590 h** one agent · ~95–165 h with 4–6 agents | estimated |
+2 -1
View File
@@ -238,10 +238,11 @@ fn main() -> ExitCode {
/// A headless session that remembers what the user keeps between runs: the PDF presets saved, the
/// ICC profiles loaded, the plug-ins installed (#2168, #2174, #2541), the custom dictionary's words (#4936) and the Color Settings (#6335), in the folders
/// and files next to the preferences that the desktop app uses too, and lists the scripts of the Scripts folder there
/// (`script.listInstalled`) and starts new documents from the New Document profiles there. `VECTORCRAFT_NO_PREFS` and
/// (`script.listInstalled`), keeps File Info's metadata templates there and starts new documents from the New Document profiles there. `VECTORCRAFT_NO_PREFS` and
/// `VECTORCRAFT_CONFIG_DIR` apply as they do there.
fn with_stores(mut h: Headless) -> Headless {
prefs_dir::attach_scripts_dir(&mut h.session);
prefs_dir::attach_metadata_templates_dir(&mut h.session);
prefs_dir::attach_new_doc_profiles(&mut h.session);
prefs_dir::attach_profile_store(&mut h.session);
prefs_dir::attach_color_settings(&mut h.session);
+241 -38
View File
@@ -163,6 +163,10 @@ fn takes_files(mimes: &[&'static str]) -> bool {
/// [`copied_file`] with a file of more than `limit` bytes skipped.
fn copied_file_within(paths: Vec<PathBuf>, mimes: &[&'static str], limit: usize) -> Option<Flavour> {
// A list of more than MAX_URIS files (untrusted data) names none, before any file is looked at.
if paths.len() > MAX_URIS {
return None;
}
paths.into_iter().find_map(|path| {
// text/uri-list lines end in CRLF (RFC 2483), but arboard splits them on LF only.
let path = match path.to_str() {
@@ -203,6 +207,53 @@ fn read_rest(file: impl Read, mut data: Vec<u8>, limit: usize) -> Option<Vec<u8>
(data.len() <= limit).then_some(data)
}
/// The data `copy` takes off the clipboard, called only when `size` (what the clipboard reports
/// before the copy) is known and from 1 to `limit` bytes. `None` without a call otherwise, and
/// when the copy comes to more than `limit` bytes.
#[cfg_attr(not(any(windows, target_os = "macos")), allow(dead_code))]
fn copy_within(size: Option<usize>, limit: usize, copy: impl FnOnce() -> Option<Vec<u8>>) -> Option<Vec<u8>> {
size.filter(|&n| n > 0 && n <= limit)?;
copy().filter(|data| data.len() <= limit)
}
/// The most bytes of UTF-8 that `utf16` bytes of UTF-16 text come to: a code unit (2 bytes) is at
/// most 3 bytes of UTF-8, and a surrogate pair (4 bytes) is 4.
#[cfg_attr(not(windows), allow(dead_code))]
fn utf8_most(utf16: usize) -> usize {
utf16.div_ceil(2).saturating_mul(3)
}
/// Whether a Windows file list (`CF_HDROP`: a `DROPFILES` header, then file names each ended by a
/// NUL and the list by one more, in UTF-16 when the header's `fWide` is set) names at most `limit`
/// files. Counting stops at the first name past `limit`. A block too short for its header, or
/// whose names would start past its end, is not within.
#[cfg_attr(not(windows), allow(dead_code))]
fn drop_files_within(block: &[u8], limit: usize) -> bool {
let field = |at: usize| Some(u32::from_le_bytes(block.get(at..at.checked_add(4)?)?.try_into().ok()?));
let (Some(start), Some(wide)) = (field(0), field(16)) else {
return false;
};
let Some(names) = usize::try_from(start).ok().and_then(|start| block.get(start..)) else {
return false;
};
let (mut count, mut in_name) = (0usize, false);
for unit in names.chunks_exact(if wide != 0 { 2 } else { 1 }) {
if unit.iter().all(|&b| b == 0) {
if !in_name {
break;
}
in_name = false;
} else if !in_name {
in_name = true;
count += 1;
if count > limit {
return false;
}
}
}
true
}
/// The most URIs a copied file list may hold, VectorCraft's own limit: a longer list (untrusted
/// data) names no files.
const MAX_URIS: usize = 1024;
@@ -284,12 +335,13 @@ fn file_uri_path(uri: &str) -> Option<PathBuf> {
#[cfg(windows)]
mod win {
use std::num::NonZeroU32;
use std::num::{NonZeroU32, NonZeroUsize};
use clipboard_win::{formats, options::NoClear, raw};
use super::{
BITMAP, ClipboardRead, Cursor, Flavour, PNG, SVG, SystemClipboard, TEXT, copied_file, decode_png, dib_image, png_flavour, windows_formats,
BITMAP, ClipboardRead, Cursor, Flavour, MAX_BYTES, MAX_URIS, PNG, SVG, SystemClipboard, TEXT, copied_file, copy_within, decode_png,
dib_image, drop_files_within, png_flavour, utf8_most, windows_formats,
};
/// The device-independent bitmaps, the one that carries alpha first. Each is there whenever the
@@ -376,8 +428,11 @@ mod win {
let mut files = vec![];
{
let _open = clipboard_win::Clipboard::new_attempts(10).ok()?;
// None copied when the clipboard holds no file list.
let _ = raw::get_file_list_path(&mut files);
// None copied when the clipboard holds no file list, or one of more than MAX_BYTES
// or MAX_URIS files: the list is counted before its names are copied.
if copy_registered(formats::CF_HDROP, MAX_BYTES).is_some_and(|block| drop_files_within(&block, MAX_URIS)) {
let _ = raw::get_file_list_path(&mut files);
}
}
// The files are read with the clipboard closed again, not keeping other apps waiting.
copied_file(files, mimes).map(ClipboardRead::Now).or_else(|| {
@@ -396,44 +451,64 @@ mod win {
}
}
/// Read the first registered format of `mime` the clipboard holds into `data`.
fn read_registered(mime: &str, data: &mut Vec<u8>) -> bool {
formats_of(mime).filter(|id| raw::is_format_avail(*id)).any(|id| {
data.clear();
raw::get_vec(id, data).is_ok() && !data.is_empty()
/// The size the clipboard reports for format `id`, while it is open.
fn size_of(id: u32) -> Option<usize> {
raw::size(id).map(NonZeroUsize::get)
}
/// The data of format `id`, while the clipboard is open, copied only when its size is at most
/// `limit` bytes ([`copy_within`]).
fn copy_registered(id: u32, limit: usize) -> Option<Vec<u8>> {
copy_within(size_of(id), limit, || {
let mut data = vec![];
raw::get_vec(id, &mut data).ok()?;
Some(data)
})
}
/// The first registered format of `mime` the clipboard holds that is not empty and at most
/// [`MAX_BYTES`]; a larger one is skipped and the next tried.
fn read_registered(mime: &str) -> Option<Vec<u8>> {
formats_of(mime).filter(|id| raw::is_format_avail(*id)).find_map(|id| copy_registered(id, MAX_BYTES).filter(|data| !data.is_empty()))
}
/// A device-independent bitmap as a PNG flavour.
fn dib_png(dib: &[u8]) -> Option<Flavour> {
png_flavour(&dib_image(dib)?)
}
/// Copy both bitmap formats while the clipboard is open, then decode them in preference order.
pub(super) fn read_dibs(mut get: impl FnMut(u32) -> Option<Vec<u8>>) -> Option<ClipboardRead> {
let dibs: Vec<_> = DIBS.into_iter().filter_map(&mut get).collect();
/// `size` gives each format's size before `get` copies it, and a format of more than
/// [`MAX_BYTES`] is not copied ([`copy_within`]) and the next one is tried.
pub(super) fn read_dibs(mut size: impl FnMut(u32) -> Option<usize>, mut get: impl FnMut(u32) -> Option<Vec<u8>>) -> Option<ClipboardRead> {
let dibs: Vec<_> = DIBS.into_iter().filter_map(|id| copy_within(size(id), MAX_BYTES, || get(id))).collect();
(!dibs.is_empty()).then_some(ClipboardRead::Later(Box::new(move || dibs.iter().find_map(|dib| dib_png(dib)))))
}
/// One flavour, while the clipboard is open. A device-independent bitmap is copied here, and
/// the work that comes back decodes each captured format in preference order.
/// the work that comes back decodes each captured format in preference order. Text whose
/// UTF-16 block could come to more than [`MAX_BYTES`] as UTF-8 ([`utf8_most`]) is not read.
fn read_one(mime: &'static str) -> Option<ClipboardRead> {
let mut data = vec![];
let mime = match mime {
BITMAP if read_registered(PNG, &mut data) => PNG,
BITMAP => {
return read_dibs(|id| {
let mut dib = vec![];
raw::get_vec(id, &mut dib).ok()?;
Some(dib)
});
}
let (mime, mut data) = match mime {
BITMAP => match read_registered(PNG) {
Some(png) => (PNG, png),
None => {
return read_dibs(size_of, |id| {
let mut dib = vec![];
raw::get_vec(id, &mut dib).ok()?;
Some(dib)
});
}
},
TEXT => {
raw::get_string(&mut data).ok()?;
TEXT
let text = copy_within(size_of(formats::CF_UNICODETEXT).map(utf8_most), MAX_BYTES, || {
let mut text = vec![];
raw::get_string(&mut text).ok()?;
Some(text)
})?;
(TEXT, text)
}
m if read_registered(m, &mut data) => m,
_ => return None,
m => (m, read_registered(m)?),
};
// Memory blocks can be longer than the data: SVG text ends at its first NUL.
if mime == SVG
@@ -3141,7 +3216,7 @@ mod mac {
use objc2_app_kit::NSPasteboard;
use objc2_foundation::{NSArray, NSString};
use super::{Flavour, pasteboard_types};
use super::{Flavour, MAX_BYTES, copy_within, pasteboard_types};
/// Does the pasteboard hold one of `mimes` ([`pasteboard_types`])? Asks for its types only.
pub fn has(mimes: &[&'static str]) -> bool {
@@ -3152,13 +3227,16 @@ mod mac {
})
}
/// The pasteboard's data for `mime`, the first of its types held ([`pasteboard_types`]).
/// The pasteboard's data for `mime`, the first of its types held ([`pasteboard_types`]) that is
/// not empty and at most [`MAX_BYTES`]: its length is checked before it is copied, and a larger
/// type is skipped and the next tried.
pub fn read(mime: &str) -> Option<Flavour> {
autoreleasepool(|_| {
let pasteboard = NSPasteboard::generalPasteboard();
pasteboard_types(mime).iter().find_map(|&(t, mime)| {
let data = pasteboard.dataForType(&NSString::from_str(t))?.to_vec();
(!data.is_empty()).then_some(Flavour { mime, data })
let held = pasteboard.dataForType(&NSString::from_str(t))?;
let data = copy_within(Some(held.len()), MAX_BYTES, || Some(held.to_vec()))?;
Some(Flavour { mime, data })
})
})
}
@@ -3345,6 +3423,102 @@ mod tests {
assert!(uri_list_paths(list(MAX_URIS + 1).as_bytes()).is_empty());
}
/// A copied file list of more than 1,024 files pastes none, before any file is looked at,
/// wherever the list came from; 1,024 files paste the first that is art.
#[test]
fn a_copied_file_list_longer_than_the_limit_pastes_no_file() {
let d = dir("many");
let art = d.path().join("art.svg");
std::fs::write(&art, "<svg xmlns=\"http://www.w3.org/2000/svg\"/>").unwrap();
let missing = |n: usize| (0..n).map(|i| d.path().join(format!("gone{i}.png"))).collect::<Vec<_>>();
let last = [missing(MAX_URIS - 1), vec![art.clone()]].concat();
assert_eq!(copied_file(last, &PASTE_ORDER).map(|f| f.mime), Some(SVG));
// The art first: no file is opened past the count.
let first = [vec![art.clone()], missing(MAX_URIS)].concat();
assert!(copied_file(first, &PASTE_ORDER).is_none());
assert!(copied_file([missing(MAX_URIS), vec![art]].concat(), &PASTE_ORDER).is_none());
}
/// Clipboard data is copied only when the size the clipboard gives is from 1 byte to the limit,
/// and the copy is not asked for otherwise.
#[test]
fn clipboard_data_is_copied_only_when_its_size_fits() {
let copy = |size: Option<usize>, got: usize| {
let mut asked = false;
let data = copy_within(size, 8, || {
asked = true;
Some(vec![1; got])
});
(data.map(|d| d.len()), asked)
};
assert_eq!(copy(Some(8), 8), (Some(8), true));
assert_eq!(copy(Some(1), 1), (Some(1), true));
for size in [None, Some(0), Some(9), Some(usize::MAX)] {
assert_eq!(copy(size, 1), (None, false), "{size:?}");
}
// Data that comes to more than the limit after all is refused.
assert_eq!(copy(Some(8), 9), (None, true));
assert_eq!(MAX_BYTES, 64 << 20);
}
/// The UTF-8 that UTF-16 text comes to is bounded from the UTF-16 block's size alone, before
/// the text is converted: a block that could pass the limit as UTF-8 is not read.
#[test]
fn text_is_bounded_by_what_its_utf8_could_come_to() {
for text in ["", "a", "\u{20ac}\u{20ac}\u{20ac}", "\u{1f600}", "a\u{20ac}\u{1f600}\u{ffff}"] {
let utf16 = text.encode_utf16().count() * 2;
assert!(utf8_most(utf16) >= text.len(), "{text:?}");
}
// Every code unit at 3 bytes of UTF-8: the bound is exact.
assert_eq!(utf8_most("\u{20ac}\u{20ac}".encode_utf16().count() * 2), "\u{20ac}\u{20ac}".len());
let copied = |utf16: usize| copy_within(Some(utf8_most(utf16)), MAX_BYTES, || Some(vec![])).is_some();
assert!(copied(MAX_BYTES / 3 * 2));
assert!(!copied(MAX_BYTES / 3 * 2 + 2));
assert!(!copied(MAX_BYTES));
assert_eq!(utf8_most(usize::MAX), usize::MAX);
}
/// A Windows file list (CF_HDROP) of `names`: a DROPFILES header, the names in UTF-16 or one
/// byte a character, each ended by a NUL, and one more NUL.
fn drop_files(names: &[&str], wide: bool) -> Vec<u8> {
let mut block = vec![];
block.extend(20u32.to_le_bytes());
block.extend([0u8; 12]);
block.extend(u32::from(wide).to_le_bytes());
for name in names.iter().copied().chain([""]) {
for unit in name.encode_utf16().chain([0]) {
if wide {
block.extend(unit.to_le_bytes());
} else {
block.push(unit as u8);
}
}
}
block
}
#[test]
fn a_windows_file_list_is_counted_before_its_names_are_read() {
let names = |n: usize| (0..n).map(|i| format!("C:\\art\\{i}.svg")).collect::<Vec<_>>();
for wide in [true, false] {
let list = |n: usize| drop_files(&names(n).iter().map(String::as_str).collect::<Vec<_>>(), wide);
assert!(drop_files_within(&list(MAX_URIS), MAX_URIS), "{wide}");
assert!(!drop_files_within(&list(MAX_URIS + 1), MAX_URIS), "{wide}");
assert!(drop_files_within(&list(0), MAX_URIS), "{wide}");
// Names past the list's closing NUL are not counted.
let mut ended = list(2);
ended.extend(list(MAX_URIS + 1).get(20..).unwrap());
assert!(drop_files_within(&ended, 2), "{wide}");
// A list cut short counts the names it holds.
assert!(!drop_files_within(&list(3)[..list(3).len() - 4], 2), "{wide}");
}
// A header cut short, or names that would start past the block's end.
assert!(!drop_files_within(&drop_files(&["a"], true)[..19], MAX_URIS));
let mut past = drop_files(&["a"], true);
past[0..4].copy_from_slice(&u32::MAX.to_le_bytes());
assert!(!drop_files_within(&past, MAX_URIS));
}
#[test]
fn gnome_files_list_names_its_files_after_copy_or_cut() {
let paths = |list: &[u8]| gnome_copied_paths(list).into_iter().map(|p| p.to_string_lossy().into_owned()).collect::<Vec<_>>();
@@ -3398,19 +3572,48 @@ mod tests {
let valid = dib(40, 1, 1, 32, 0, &[], &bgra(&[RED]));
let mut captured = Vec::new();
let read = win::read_dibs(|id| {
captured.push(id);
match id {
CF_DIBV5 => Some(vec![40, 0, 0]),
CF_DIB => Some(valid.clone()),
_ => None,
}
})
let get = |id: u32| match id {
CF_DIBV5 => Some(vec![40, 0, 0]),
CF_DIB => Some(valid.clone()),
_ => None,
};
let read = win::read_dibs(
|id| get(id).map(|d| d.len()),
|id| {
captured.push(id);
get(id)
},
)
.unwrap();
assert_eq!(captured, [CF_DIBV5, CF_DIB]);
let flavour = read.flavour().unwrap();
assert_eq!(flavour.mime, PNG);
assert_eq!(pixels(&decode_png(&flavour.data).unwrap()), [RED]);
// A bitmap larger than the limit is not copied, and the other one still pastes.
captured.clear();
let read = win::read_dibs(
|id| if id == CF_DIBV5 { Some(MAX_BYTES + 1) } else { get(id).map(|d| d.len()) },
|id| {
captured.push(id);
get(id)
},
)
.unwrap();
assert_eq!(captured, [CF_DIB]);
assert_eq!(read.flavour().map(|f| f.mime), Some(PNG));
// Each format has the limit to itself: a first one at the limit that doesn't decode
// leaves the second to paste.
captured.clear();
let read = win::read_dibs(
|id| if id == CF_DIBV5 { Some(MAX_BYTES) } else { get(id).map(|d| d.len()) },
|id| {
captured.push(id);
get(id)
},
)
.unwrap();
assert_eq!(captured, [CF_DIBV5, CF_DIB]);
assert_eq!(read.flavour().map(|f| f.mime), Some(PNG));
}
#[test]
+2
View File
@@ -535,6 +535,8 @@ fn main() -> std::process::ExitCode {
prefs_dir::attach_plugin_store(&mut session);
// File › Scripts lists the scripts of the Scripts folder next to the preferences.
prefs_dir::attach_scripts_dir(&mut session);
// File Info's metadata templates live in their own folder next to the preferences.
prefs_dir::attach_metadata_templates_dir(&mut session);
prefs_dir::attach_new_doc_profiles(&mut session);
let mut app = VectorcraftApp::new(session, services(cc.winit_window().cloned(), cc.egui_ctx.clone()));
app.set_startup_update_check(true);
+8
View File
@@ -65,6 +65,14 @@ pub fn attach_scripts_dir(session: &mut vectorcraft_engine::Session) {
}
}
/// Keep File Info's metadata templates in the `Metadata Templates` folder, which a saved template
/// makes.
pub fn attach_metadata_templates_dir(session: &mut vectorcraft_engine::Session) {
if let Some(dir) = store_dir("Metadata Templates") {
session.attach_metadata_templates_dir(dir);
}
}
/// Have File › New start each category's documents from its profile in the `New Document
/// Profiles` folder, which `file.newProfiles.edit` makes.
pub fn attach_new_doc_profiles(session: &mut vectorcraft_engine::Session) {
+2 -2
View File
@@ -444,8 +444,8 @@ pub fn export(doc: &Document, opts: &DxfOptions) -> Result<DxfOutput, String> {
return Err("the export region is not finite".into());
}
// Symbols' art is placed without clipping, as the scene places it.
let baked =
vectorcraft_effects::bake_document_placing_symbols(doc, false, vectorcraft_effects::WrittenLayers { hidden: true, non_printing: true });
let layers = vectorcraft_effects::WrittenLayers { hidden: true, non_printing: true, hidden_objects: false };
let baked = vectorcraft_effects::bake_document_placing_symbols(doc, false, layers);
let doc = baked.as_ref().unwrap_or(doc);
Ok(scene::Scene::new(doc, opts).run())
}
+2
View File
@@ -28,6 +28,7 @@ pub mod shared;
mod symbol_export_type;
mod symbol_nine_slice;
pub mod symbol_overrides;
mod symbol_pixel_aligned;
mod symbol_registration;
pub use inline::{SYMBOL_HALF, SYMBOL_SIZES};
pub use shared::Shared;
@@ -37,6 +38,7 @@ pub use symbol_nine_slice::{
SymbolNineSlice, charge_symbol_art,
};
pub use symbol_overrides::SymbolOverride;
pub use symbol_pixel_aligned::SYMBOL_PIXEL_ALIGNED;
pub use symbol_registration::{SYMBOL_REGISTRATION, SymbolRegistration};
pub mod links;
pub mod live;
+1
View File
@@ -316,6 +316,7 @@ fn content_hash(text: &crate::TextObject) -> Option<[u64; 2]> {
let inline_bounds = text.runs.iter().filter_map(|r| r.inline.as_ref()).map(|i| i.bounds.map(|b| [b.x0, b.y0, b.x1, b.y1].map(f64::to_bits)));
for h in &mut feed.0 {
h.write_u8(u8::from(text.first_para_continues));
h.write_u32(text.first_para_lead.map_or(u32::MAX, u32::from));
for b in inline_bounds.clone() {
match b {
None => h.write_u8(0),
+80
View File
@@ -0,0 +1,80 @@
//! Symbol Options › Align to Pixel Grid: a symbol whose instances stay on the pixel grid at their
//! actual size wherever they are placed
//! (<https://web.archive.org/web/20220911143322/https://helpx.adobe.com/pdf/cs6/illustrator_reference.pdf#page=28>).
//!
//! Stored under [`SYMBOL_PIXEL_ALIGNED`] keyed by symbol name; a symbol that is not pixel-aligned
//! (the default) is left out of the map.
use std::collections::HashSet;
use crate::Document;
/// Document unknown key: `{ symbolName: true }` for each pixel-aligned symbol.
pub const SYMBOL_PIXEL_ALIGNED: &str = "symbolPixelAligned";
impl Document {
/// Whether symbol `name` has Symbol Options › Align to Pixel Grid on (default: off).
pub fn symbol_pixel_aligned(&self, name: &str) -> bool {
self.unknown.get(SYMBOL_PIXEL_ALIGNED).and_then(|m| m.get(name)).and_then(serde_json::Value::as_bool).unwrap_or(false)
}
/// Turn Align to Pixel Grid on or off for symbol `name`. Off removes the symbol from the map,
/// and the map goes when it is empty.
pub fn set_symbol_pixel_aligned(&mut self, name: &str, on: bool) {
if on {
let m = self.unknown.entry(SYMBOL_PIXEL_ALIGNED.to_string()).or_insert_with(|| serde_json::json!({}));
if let Some(o) = m.as_object_mut() {
o.insert(name.into(), serde_json::json!(true));
}
return;
}
let Some(o) = self.unknown.get_mut(SYMBOL_PIXEL_ALIGNED).and_then(|m| m.as_object_mut()) else { return };
o.remove(name);
if o.is_empty() {
self.unknown.remove(SYMBOL_PIXEL_ALIGNED);
}
}
/// Move the stored setting when a symbol is renamed.
pub fn rename_symbol_pixel_aligned(&mut self, from: &str, to: &str) {
if from == to {
return;
}
let on = self.symbol_pixel_aligned(from);
self.set_symbol_pixel_aligned(from, false);
self.set_symbol_pixel_aligned(to, on);
}
/// The names of the pixel-aligned symbols the document holds (empty for most documents).
pub fn pixel_aligned_symbols(&self) -> HashSet<String> {
let Some(o) = self.unknown.get(SYMBOL_PIXEL_ALIGNED).and_then(|m| m.as_object()) else { return HashSet::new() };
o.iter()
.filter(|(name, v)| v.as_bool() == Some(true) && self.symbols.iter().any(|s| &s.name == *name))
.map(|(name, _)| name.clone())
.collect()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_setting_is_off_by_default_and_follows_a_rename() {
let mut d = Document::new(100.0, 100.0);
let art = std::sync::Arc::new(crate::Node::group(d.alloc_id(), vec![]));
d.symbols.push(crate::Symbol { dynamic: false, name: "A".into(), art });
assert!(!d.symbol_pixel_aligned("A"));
assert!(d.unknown.get(SYMBOL_PIXEL_ALIGNED).is_none());
d.set_symbol_pixel_aligned("A", true);
assert!(d.symbol_pixel_aligned("A"));
assert_eq!(d.pixel_aligned_symbols(), HashSet::from(["A".to_string()]));
d.symbols[0].name = "B".into();
d.rename_symbol_pixel_aligned("A", "B");
assert!(!d.symbol_pixel_aligned("A"));
assert!(d.symbol_pixel_aligned("B"));
d.set_symbol_pixel_aligned("B", false);
assert!(d.unknown.get(SYMBOL_PIXEL_ALIGNED).is_none());
assert!(d.pixel_aligned_symbols().is_empty());
}
}
+7 -1
View File
@@ -35,7 +35,7 @@ pub use tabs_lists::{
Bullet, DEFAULT_TAB_INTERVAL, LIST_HANGING_INDENT, LIST_LEVEL_INDENT, LIST_LEVELS, ListAlign, ListCounts, NumberStyle, ParaList, TabAlign,
TabStop,
};
pub use wrap::{resolve_wrap, wrap_work};
pub use wrap::{resolve_wrap, wrap_sources, wrap_work};
/// A text object. `runs` split into paragraphs at `\n`.
///
@@ -67,6 +67,12 @@ pub struct TextObject {
/// it on a frame that leaves its thread and on a copy. Not saved.
#[serde(skip)]
pub first_para_continues: bool,
/// Threaded text whose first paragraph continues ([`TextObject::first_para_continues`]): the
/// last character of that paragraph in the frames before that a repeat mark could stand for
/// (Kurikaeshi Moji Shori), or None. The engine sets it with `first_para_continues`; layout
/// reads it only while `first_para_continues` is on. Not saved.
#[serde(skip)]
pub first_para_lead: Option<char>,
/// Area Type Options (area type only).
#[serde(default, skip_serializing_if = "crate::skip::is_default")]
pub area: AreaOptions,
+1
View File
@@ -94,6 +94,7 @@ impl TextObject {
para: ParaStyle::default(),
paras: Vec::new(),
first_para_continues: false,
first_para_lead: None,
area: AreaOptions::default(),
path_effect: PathEffect::default(),
path_align: PathAlign::default(),
+9
View File
@@ -271,6 +271,9 @@ pub struct ParaStyle {
/// dashes, two ellipses, two two-dot leaders, a vertical kana repeat mark's two halves). Kept
/// with kinsoku None, where it has no effect. Off by default.
pub bunri_kinshi: bool,
/// Kurikaeshi Moji Shori (Paragraph panel menu): a repeat mark (々, ゝ, ゞ, ヽ or ヾ) that starts
/// a line is drawn as the character it repeats, and the text keeps the mark. Off by default.
pub kurikaeshi_moji_shori: bool,
/// Roman Hanging Punctuation (Paragraph panel menu): quotation marks, hyphens, full stops and
/// commas starting or ending a line hang outside the margin, and asterisks, tildes, ellipses,
/// dashes, colons and semicolons hang by half. East Asian punctuation hangs by burasagari.
@@ -375,6 +378,8 @@ struct ParaStyleFile {
#[serde(default, skip_serializing_if = "crate::skip::is_default")]
bunri_kinshi: bool,
#[serde(default, skip_serializing_if = "crate::skip::is_default")]
kurikaeshi_moji_shori: bool,
#[serde(default, skip_serializing_if = "crate::skip::is_default")]
roman_hanging: bool,
#[serde(default, skip_serializing_if = "crate::skip::is_default")]
kashida: Kashida,
@@ -412,6 +417,7 @@ impl From<ParaStyle> for ParaStyleFile {
kinsoku,
kinsoku_type,
bunri_kinshi,
kurikaeshi_moji_shori,
roman_hanging,
kashida,
korean_line_break_anywhere,
@@ -439,6 +445,7 @@ impl From<ParaStyle> for ParaStyleFile {
kinsoku,
kinsoku_type,
bunri_kinshi,
kurikaeshi_moji_shori,
roman_hanging,
kashida,
korean_line_break_anywhere,
@@ -470,6 +477,7 @@ impl From<ParaStyleFile> for ParaStyle {
kinsoku,
kinsoku_type,
bunri_kinshi,
kurikaeshi_moji_shori,
roman_hanging,
kashida,
korean_line_break_anywhere,
@@ -496,6 +504,7 @@ impl From<ParaStyleFile> for ParaStyle {
kinsoku,
kinsoku_type,
bunri_kinshi,
kurikaeshi_moji_shori,
roman_hanging,
kashida,
korean_line_break_anywhere,
+58 -34
View File
@@ -4,7 +4,7 @@ use std::sync::Arc;
use vectorcraft_geom::{PathData, shapes};
use super::{TextKind, WrapShape};
use super::{TextKind, TextObject, WrapShape};
use crate::{Document, Node, NodeId, NodeKind};
/// Outline of a wrap object in document coordinates: its paths, or its bounds for other art.
@@ -82,6 +82,57 @@ pub fn wrap_work(doc: &Document) -> usize {
total
}
/// Each area text object of `layer`, from the top down, with the wrap objects above it in the
/// layer whose outlines aren't empty, topmost first, each with the shape its outline makes in
/// document coordinates. Each wrap object's outline is made once.
fn each_text<'a>(layer: &'a Node, mut f: impl FnMut(&'a Node, &[(&'a Node, WrapShape)])) {
let mut items = vec![];
collect(layer, &mut items);
let mut above: Vec<(&Node, WrapShape)> = vec![];
for it in items.iter().rev() {
match it {
Item::Wrap(n) => {
let mut pd = PathData::default();
outline(n, &mut pd);
if !pd.is_empty() {
above.push((n, WrapShape { path: pd, wrap: n.extras().wrap.unwrap_or_default() }));
}
}
Item::Text(n) => f(n, &above),
}
}
}
/// The wrap shapes of text object `t` (text space) from `above`, the wrap objects above it as
/// [`each_text`] gives them: bottom first.
fn shapes_of(t: &TextObject, above: &[(&Node, WrapShape)]) -> Vec<WrapShape> {
let inv = t.xf.inverse();
above
.iter()
.rev()
.map(|(_, s)| {
let mut path = s.path.clone();
path.transform(inv);
WrapShape { path, wrap: s.wrap }
})
.collect()
}
/// Each area text object on `doc`'s layers that [`resolve_wrap`] gives wrap shapes, with the wrap
/// objects whose outlines make them, bottom first, and those shapes (text space), as
/// [`resolve_wrap`] works them out. The copying is [`wrap_work`].
pub fn wrap_sources<'a>(doc: &'a Document, mut f: impl FnMut(&'a Node, Vec<&'a Node>, Vec<WrapShape>)) {
for layer in &doc.layers {
each_text(layer, |n, above| {
if let NodeKind::Text(t) = &n.kind
&& !above.is_empty()
{
f(n, above.iter().rev().map(|(s, _)| *s).collect(), shapes_of(t, above));
}
});
}
}
/// Resolve the wrap shapes (`TextObject::wrap`, text space) of each area text object from the
/// outlines of the wrap objects above it in its layer. With `before`, the layers it holds unchanged
/// are skipped; without it, every layer is resolved. Returns the area text objects whose shapes
@@ -95,41 +146,14 @@ pub fn resolve_wrap(before: Option<&Document>, doc: &mut Document) -> Vec<NodeId
{
continue;
}
let mut items = vec![];
collect(layer, &mut items);
if items.is_empty() {
continue;
}
// From the top down, each wrap object's outline is made once; each area text object takes
// those above it, bottom first.
let mut above: Vec<WrapShape> = vec![];
for it in items.iter().rev() {
match it {
Item::Wrap(n) => {
let mut pd = PathData::default();
outline(n, &mut pd);
if !pd.is_empty() {
above.push(WrapShape { path: pd, wrap: n.extras().wrap.unwrap_or_default() });
}
}
Item::Text(n) => {
let NodeKind::Text(t) = &n.kind else { continue };
let inv = t.xf.inverse();
let shapes: Vec<WrapShape> = above
.iter()
.rev()
.map(|s| {
let mut path = s.path.clone();
path.transform(inv);
WrapShape { path, wrap: s.wrap }
})
.collect();
if shapes != t.wrap {
updates.push((n.id, shapes));
}
each_text(layer, |n, above| {
if let NodeKind::Text(t) = &n.kind {
let shapes = shapes_of(t, above);
if shapes != t.wrap {
updates.push((n.id, shapes));
}
}
}
});
}
let mut changed = Vec::with_capacity(updates.len());
for (id, shapes) in updates {
+14 -10
View File
@@ -167,7 +167,7 @@ struct Placing {
layers: WrittenLayers,
}
/// The layers an exporter writes besides the shown, printing ones
/// The layers and objects an exporter writes besides the shown, printing ones
/// ([`bake_document_placing_symbols`]). Template layers are never written.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct WrittenLayers {
@@ -175,16 +175,19 @@ pub struct WrittenLayers {
pub hidden: bool,
/// Layers that do not print.
pub non_printing: bool,
/// Hidden objects other than layers (written hidden, as SVG writes them when it keeps hidden
/// layers).
pub hidden_objects: bool,
}
/// Does the export leave `n` and everything in it out, while [`bake_document_placing_symbols`]
/// bakes? A hidden object other than a layer, a template layer, and a hidden layer or a layer
/// bakes? A template layer, and a hidden object other than a layer, a hidden layer or a layer
/// that does not print when the export leaves those out ([`WrittenLayers`]).
fn unwritten(n: &Node) -> bool {
PLACING.with(|p| {
p.borrow().as_ref().is_some_and(|p| match n.kind {
NodeKind::Layer { template, printable, .. } => template || !(printable || p.layers.non_printing) || !(n.visible || p.layers.hidden),
_ => !n.visible,
_ => !(n.visible || p.layers.hidden_objects),
})
})
}
@@ -1041,13 +1044,14 @@ pub fn bake_document(doc: &Document) -> Option<Document> {
/// (live geometry effects, color adjustments and the rest [`needs_bake`] counts, in its own art or
/// in the art of the symbols it places) replaced by that art as the instance places it, baked
/// ([`placed_symbol_art`]), so the art draws as on the canvas wherever the instance is. For
/// exporters that write each instance's art in its place (PDF, print, EPS, DXF), rather than
/// writing each symbol once. `clip_slices`: whether 9-slice cells are clipped
/// ([`Document::place_symbol_art`]) or not ([`Document::place_symbol_art_unclipped`]), as the
/// exporter places other instances. `layers`: the hidden layers and layers that do not print
/// that the exporter writes. Instances the export does not write (hidden ones, those in hidden
/// objects, on template layers, and on the layers `layers` leaves out) stay as they are. The
/// symbols' own art is left as it is.
/// exporters that write each instance's art in its place (PDF, print, EPS, DXF, EMF, WMF), and
/// for SVG, which writes the instances of other symbols as one shared definition. `clip_slices`:
/// whether 9-slice cells are clipped ([`Document::place_symbol_art`]) or not
/// ([`Document::place_symbol_art_unclipped`]), as the exporter places other instances. `layers`:
/// the hidden layers, layers that do not print and hidden objects that the exporter writes.
/// Instances the export does not write (template layers, and the hidden objects and layers
/// `layers` leaves out, with what is in them) stay as they are. The symbols' own art is left as
/// it is.
pub fn bake_document_placing_symbols(doc: &Document, clip_slices: bool, layers: WrittenLayers) -> Option<Document> {
bake(doc, Some((clip_slices, vectorcraft_doc::MAX_SYMBOL_NODES, layers)))
}
+12 -2
View File
@@ -1328,7 +1328,7 @@ fn placing_symbols_keeps_the_instances_stain() {
}
/// Every layer written, as DXF writes them (template layers are never written).
const ALL: WrittenLayers = WrittenLayers { hidden: true, non_printing: true };
const ALL: WrittenLayers = WrittenLayers { hidden: true, non_printing: true, hidden_objects: false };
fn is_instance(d: &Document, id: u64) -> bool {
d.node(NodeId(id)).is_some_and(|n| matches!(n.kind, NodeKind::SymbolInstance { .. }))
@@ -1455,10 +1455,20 @@ fn placing_symbols_skips_instances_the_export_leaves_out() {
}
// An export that writes the layers that do not print, or the hidden layers, places that
// layer's instance first; the template layer's instance is never placed.
for (layers, first) in [(WrittenLayers { non_printing: true, hidden: false }, 921), (WrittenLayers { non_printing: false, hidden: true }, 931)] {
for (layers, first) in
[(WrittenLayers { non_printing: true, ..WrittenLayers::default() }, 921), (WrittenLayers { hidden: true, ..WrittenLayers::default() }, 931)]
{
let out = bake(&d, Some((true, each, layers))).unwrap();
assert!(!is_instance(&out, first) && is_instance(&out, 900) && is_instance(&out, 911), "{layers:?}");
}
// An export that writes hidden objects (SVG keeping hidden layers) places the hidden instance
// first, and the instance in the hidden group would come next; the hidden layer's instance
// stays, since that layer is still left out.
let out = bake(&d, Some((true, each, WrittenLayers { hidden_objects: true, ..WrittenLayers::default() }))).unwrap();
assert!(!is_instance(&out, 901), "the hidden instance is placed");
for id in [900, 903, 911, 921, 931] {
assert!(is_instance(&out, id), "{id} stays as it is");
}
}
/// `leaf` in `levels` groups, with ids from `id` up.
+3 -3
View File
@@ -210,21 +210,21 @@ pub fn effect_catalog() -> Vec<EffectInfo> {
CLASSIC_EXTRUDE,
"Extrude & Bevel (Classic)…",
&["Effect", "3D and Materials", "3D (Classic)"],
"{depth: pt (0..2000, 50), cap: bool (true: solid; false: hollow), bevel: none|classic|rounded|cove|step|ogee (none), bevelHeight: pt (1..100, 4; the bevel is as wide as it is tall), bevelInside: bool (false: added around the shape; true: carved into it), rotationX: degrees (-180..180, -21.88), rotationY: degrees (-180..180, -23.4), rotationZ: degrees (-180..180, 9.06; the defaults are the Off-Axis Front position), perspectiveAngle: degrees (0..160, 0; 0 is none, wider brings the eye nearer), surface: wireframe|none|diffuse|plastic (plastic; wireframe draws the edges of every face, hidden ones included, and fills none; none keeps the paint unlit; diffuse lights the faces softly; plastic adds a glossy highlight), lights: null or array of 1..10 objects (intensity: % 0..100, rotation: degrees -180..180, height: degrees 0..90, behind: bool; overrides the single-light fields; the lights add up; color and softness are not used), lightRotation: degrees (-180..180, 125.26; round the object on the page, 0 on its right, counterclockwise), lightHeight: degrees (0..90, 30; 0 beside the object, 90 straight in front), lightBehind: bool (false; true lights it from behind), lightIntensity: % (0..100, 100), ambient: % (0..100, 50; Ambient Light, every face whichever way it faces), highlightIntensity: % (0..100, 60; plastic only), highlightSize: % (0..100, 90; 100 broad, 0 a small spot; plastic only), blendSteps: integer (1..256, 25; how many levels the shading and the highlight are rounded to), shadingColor: black|custom|none (black; the color the faces darken toward; none keeps the paint and adds only the highlight), shadingCustom: #rrggbb (#000000; the color shadingColor custom darkens toward), preserveSpotColors: bool (false; a color linked to a spot or global swatch stays a tint of that swatch, lighter where the highlight is, with black multiplied and overprinting where the faces darken, so a spot color keeps its plate; it does nothing while shadingColor is custom), drawHiddenFaces: bool (false; also draws the faces turned away, behind the others)}. The front face is the art, extruded backwards about the center of its bounds; a solid is built for the top fill and for each stroke, each in its own paint. The defaults are VectorCraft's own.",
"{depth: pt (0..2000, 50), cap: bool (true: solid; false: hollow), bevel: none|classic|rounded|cove|step|ogee (none), bevelHeight: pt (1..100, 4; the bevel is as wide as it is tall), bevelInside: bool (false: added around the shape; true: carved into it), rotationX: degrees (-180..180, -21.88), rotationY: degrees (-180..180, -23.4), rotationZ: degrees (-180..180, 9.06; the defaults are the Off-Axis Front position), perspectiveAngle: degrees (0..160, 0; 0 is none, wider brings the eye nearer), surface: wireframe|none|diffuse|plastic (plastic; wireframe draws the edges of every face, hidden ones included, and fills none; none keeps the paint unlit; diffuse lights the faces softly; plastic adds a glossy highlight), lights: null or array of 1..10 objects (intensity: % 0..100, rotation: degrees -180..180, height: degrees 0..90, behind: bool; overrides the single-light fields; the lights add up; color and softness are not used), lightRotation: degrees (-180..180, 125.26; round the object on the page, 0 on its right, counterclockwise), lightHeight: degrees (0..90, 30; 0 beside the object, 90 straight in front), lightBehind: bool (false; true lights it from behind), lightIntensity: % (0..100, 100), ambient: % (0..100, 50; Ambient Light, every face whichever way it faces), highlightIntensity: % (0..100, 60; plastic only), highlightSize: % (0..100, 90; 100 broad, 0 a small spot; plastic only), blendSteps: integer (1..256, 25; how many levels the shading and the highlight are rounded to), shadingColor: black|custom|none|blackOverprint (black; the color the faces darken toward; none keeps the paint and adds only the highlight; blackOverprint keeps the paint and draws the shading over it as overprinting black, on the black plate, with no highlight), shadingCustom: #rrggbb (#000000; the color shadingColor custom darkens toward), preserveSpotColors: bool (false; a color linked to a spot or global swatch stays a tint of that swatch, lighter where the highlight is, with black multiplied and overprinting where the faces darken, so a spot color keeps its plate; it does nothing while shadingColor is custom, and with blackOverprint every face keeps its paint and swatch link whether it is on or off), drawHiddenFaces: bool (false; also draws the faces turned away, behind the others)}. The front face is the art, extruded backwards about the center of its bounds; a solid is built for the top fill and for each stroke, each in its own paint. The defaults are VectorCraft's own.",
json!({"depth":50.0,"cap":true,"bevel":"none","bevelHeight":4.0,"bevelInside":false,"rotationX":-21.88,"rotationY":-23.4,"rotationZ":9.06,"perspectiveAngle":0.0,"surface":"plastic","lights":null,"lightRotation":125.26438968275465,"lightHeight":30.0,"lightBehind":false,"lightIntensity":100.0,"ambient":50.0,"highlightIntensity":60.0,"highlightSize":90.0,"blendSteps":25,"shadingColor":"black","shadingCustom":"#000000","preserveSpotColors":false,"drawHiddenFaces":false}),
),
g(
CLASSIC_REVOLVE,
"Revolve (Classic)…",
&["Effect", "3D and Materials", "3D (Classic)"],
"{angle: degrees (0..360, 360; how far the profile sweeps round the axis), cap: bool (true: solid, the open ends closed; false: hollow), offset: pt (0..1000, 0; the axis's distance from the profile, a ring past 0), edge: left|right (left; the axis is at the left or the right edge of the profile's bounds), rotationX: degrees (-180..180, -21.88), rotationY: degrees (-180..180, -23.4), rotationZ: degrees (-180..180, 9.06; the defaults are the Off-Axis Front position), perspectiveAngle: degrees (0..160, 0; 0 is none, wider brings the eye nearer), surface: wireframe|none|diffuse|plastic (plastic; wireframe draws the edges of every face and fills none; none keeps the paint unlit; diffuse lights the faces softly; plastic adds a glossy highlight), lights: null or array of 1..10 objects (intensity: % 0..100, rotation: degrees -180..180, height: degrees 0..90, behind: bool; overrides the single-light fields; the lights add up; color and softness are not used), lightRotation: degrees (-180..180, 125.26; round the object on the page, 0 on its right, counterclockwise), lightHeight: degrees (0..90, 30; 0 beside the object, 90 straight in front), lightBehind: bool (false; true lights it from behind), lightIntensity: % (0..100, 100), ambient: % (0..100, 50; Ambient Light, every face whichever way it faces), highlightIntensity: % (0..100, 60; plastic only), highlightSize: % (0..100, 90; 100 broad, 0 a small spot; plastic only), blendSteps: integer (1..256, 25; how many levels the shading and the highlight are rounded to), shadingColor: black|custom|none (black; the color the faces darken toward; none keeps the paint and adds only the highlight), shadingCustom: #rrggbb (#000000; the color shadingColor custom darkens toward), preserveSpotColors: bool (false; a color linked to a spot or global swatch stays a tint of that swatch, lighter where the highlight is, with black multiplied and overprinting where the faces darken, so a spot color keeps its plate; it does nothing while shadingColor is custom)}. The profile sweeps round a vertical axis, as Revolve's does, painted with the top fill (else the top stroke); every face is drawn, back to front. The defaults are VectorCraft's own.",
"{angle: degrees (0..360, 360; how far the profile sweeps round the axis), cap: bool (true: solid, the open ends closed; false: hollow), offset: pt (0..1000, 0; the axis's distance from the profile, a ring past 0), edge: left|right (left; the axis is at the left or the right edge of the profile's bounds), rotationX: degrees (-180..180, -21.88), rotationY: degrees (-180..180, -23.4), rotationZ: degrees (-180..180, 9.06; the defaults are the Off-Axis Front position), perspectiveAngle: degrees (0..160, 0; 0 is none, wider brings the eye nearer), surface: wireframe|none|diffuse|plastic (plastic; wireframe draws the edges of every face and fills none; none keeps the paint unlit; diffuse lights the faces softly; plastic adds a glossy highlight), lights: null or array of 1..10 objects (intensity: % 0..100, rotation: degrees -180..180, height: degrees 0..90, behind: bool; overrides the single-light fields; the lights add up; color and softness are not used), lightRotation: degrees (-180..180, 125.26; round the object on the page, 0 on its right, counterclockwise), lightHeight: degrees (0..90, 30; 0 beside the object, 90 straight in front), lightBehind: bool (false; true lights it from behind), lightIntensity: % (0..100, 100), ambient: % (0..100, 50; Ambient Light, every face whichever way it faces), highlightIntensity: % (0..100, 60; plastic only), highlightSize: % (0..100, 90; 100 broad, 0 a small spot; plastic only), blendSteps: integer (1..256, 25; how many levels the shading and the highlight are rounded to), shadingColor: black|custom|none|blackOverprint (black; the color the faces darken toward; none keeps the paint and adds only the highlight; blackOverprint keeps the paint and draws the shading over it as overprinting black, on the black plate, with no highlight), shadingCustom: #rrggbb (#000000; the color shadingColor custom darkens toward), preserveSpotColors: bool (false; a color linked to a spot or global swatch stays a tint of that swatch, lighter where the highlight is, with black multiplied and overprinting where the faces darken, so a spot color keeps its plate; it does nothing while shadingColor is custom, and with blackOverprint every face keeps its paint and swatch link whether it is on or off)}. The profile sweeps round a vertical axis, as Revolve's does, painted with the top fill (else the top stroke); every face is drawn, back to front. The defaults are VectorCraft's own.",
json!({"angle":360.0,"cap":true,"offset":0.0,"edge":"left","rotationX":-21.88,"rotationY":-23.4,"rotationZ":9.06,"perspectiveAngle":0.0,"surface":"plastic","lights":null,"lightRotation":125.26438968275465,"lightHeight":30.0,"lightBehind":false,"lightIntensity":100.0,"ambient":50.0,"highlightIntensity":60.0,"highlightSize":90.0,"blendSteps":25,"shadingColor":"black","shadingCustom":"#000000","preserveSpotColors":false}),
),
g(
CLASSIC_ROTATE,
"Rotate (Classic)…",
&["Effect", "3D and Materials", "3D (Classic)"],
"{rotationX: degrees (-180..180, -21.88), rotationY: degrees (-180..180, -23.4), rotationZ: degrees (-180..180, 9.06; the defaults are the Off-Axis Front position), perspectiveAngle: degrees (0..160, 0; 0 is none, wider brings the eye nearer), surface: none|diffuse (diffuse; none keeps the paint unlit; diffuse lights the art softly), lights: null or array of 1..10 objects (intensity: % 0..100, rotation: degrees -180..180, height: degrees 0..90, behind: bool; overrides the single-light fields; the lights add up; color and softness are not used), lightRotation: degrees (-180..180, 125.26; round the object on the page, 0 on its right, counterclockwise), lightHeight: degrees (0..90, 30; 0 beside the object, 90 straight in front), lightBehind: bool (false; true lights it from behind), lightIntensity: % (0..100, 100), ambient: % (0..100, 50; Ambient Light, the art whichever way it faces), blendSteps: integer (1..256, 25; how many levels the shading is rounded to), shadingColor: black|custom|none (black; the color the art darkens toward; none keeps the paint), shadingCustom: #rrggbb (#000000; the color shadingColor custom darkens toward), preserveSpotColors: bool (false; a color linked to a spot or global swatch stays a tint of that swatch, with black multiplied and overprinting where the art darkens, so a spot color keeps its plate; it does nothing while shadingColor is custom)}. Every fill and stroke turns as one flat plane about the center of the object's bounds, as Rotate's do, each in its own paint, and is seen from either side. The defaults are VectorCraft's own.",
"{rotationX: degrees (-180..180, -21.88), rotationY: degrees (-180..180, -23.4), rotationZ: degrees (-180..180, 9.06; the defaults are the Off-Axis Front position), perspectiveAngle: degrees (0..160, 0; 0 is none, wider brings the eye nearer), surface: none|diffuse (diffuse; none keeps the paint unlit; diffuse lights the art softly), lights: null or array of 1..10 objects (intensity: % 0..100, rotation: degrees -180..180, height: degrees 0..90, behind: bool; overrides the single-light fields; the lights add up; color and softness are not used), lightRotation: degrees (-180..180, 125.26; round the object on the page, 0 on its right, counterclockwise), lightHeight: degrees (0..90, 30; 0 beside the object, 90 straight in front), lightBehind: bool (false; true lights it from behind), lightIntensity: % (0..100, 100), ambient: % (0..100, 50; Ambient Light, the art whichever way it faces), blendSteps: integer (1..256, 25; how many levels the shading is rounded to), shadingColor: black|custom|none|blackOverprint (black; the color the art darkens toward; none keeps the paint; blackOverprint keeps the paint and draws the shading over it as overprinting black, on the black plate), shadingCustom: #rrggbb (#000000; the color shadingColor custom darkens toward), preserveSpotColors: bool (false; a color linked to a spot or global swatch stays a tint of that swatch, with black multiplied and overprinting where the art darkens, so a spot color keeps its plate; it does nothing while shadingColor is custom, and with blackOverprint the art keeps its paint and swatch link whether it is on or off)}. Every fill and stroke turns as one flat plane about the center of the object's bounds, as Rotate's do, each in its own paint, and is seen from either side. The defaults are VectorCraft's own.",
json!({"rotationX":-21.88,"rotationY":-23.4,"rotationZ":9.06,"perspectiveAngle":0.0,"surface":"diffuse","lights":null,"lightRotation":125.26438968275465,"lightHeight":30.0,"lightBehind":false,"lightIntensity":100.0,"ambient":50.0,"blendSteps":25,"shadingColor":"black","shadingCustom":"#000000","preserveSpotColors":false}),
),
g(
+17 -5
View File
@@ -367,9 +367,14 @@ fn compound_shape_art_in(doc: Option<&Document>, n: &Node, hook: Option<OutlineH
fn styled(src: &Node, path: PathData, outline: bool) -> Node {
let mut appearance = Appearance { items: src.appearance.items.clone(), ..Default::default() };
if outline {
let fill = src.appearance.fill_paint();
let paint = if fill.is_none() { src.appearance.stroke_paint() } else { fill };
appearance = Appearance { items: vec![AppearanceItem::Stroke(StrokeLayer::new(paint, 1.0))], ..Default::default() };
// The edges take the paint, opacity, blend mode and overprint of the top fill that paints,
// or of the top stroke that paints when no fill does.
let layer = top_painting_fill(&src.appearance).or_else(|| src.appearance.items.iter().rev().find(|i| paints(i)));
let mut stroke = StrokeLayer::new(layer.map_or(Paint::None, |i| i.paint().clone()), 1.0);
if let Some(i) = layer {
(stroke.opacity, stroke.blend, stroke.overprint) = (i.opacity(), i.blend(), i.overprint());
}
appearance = Appearance { items: vec![AppearanceItem::Stroke(stroke)], ..Default::default() };
}
let mut n = Node::path(src.id, path, appearance);
n.opacity = src.opacity;
@@ -504,7 +509,8 @@ pub fn pathfinder_children(doc: Option<&Document>, group: &Node, hook: Option<Ou
.iter()
.filter_map(|l| {
let (path, rule) = geometry(l)?;
Some((l.id, crate::trap::TrapSource { path, rule, fill: l.appearance.fill_paint() }))
let fill = top_painting_fill(&l.appearance).map_or(Paint::None, |i| i.paint().clone());
Some((l.id, crate::trap::TrapSource { path, rule, fill }))
})
.unzip();
let made = crate::trap::traps(&srcs, &crate::trap::TrapOptions::from_params(&e.params));
@@ -580,7 +586,8 @@ fn mixing_rate(params: &Value) -> f64 {
}
fn fill_cmyk(src: &Node) -> Option<[f32; 4]> {
let paint = src.appearance.fill_paint();
// The top fill that paints: a hidden fill adds no color.
let paint = top_painting_fill(&src.appearance)?.paint().clone();
let color = paint.color()?;
let tinted = match paint {
Paint::Solid { tint, .. } => color.tinted(tint),
@@ -637,6 +644,11 @@ fn is_container(n: &Node) -> bool {
matches!(n.kind, NodeKind::Group { .. } | NodeKind::Layer { .. })
}
/// The top fill of `a` that paints: hidden fills and fills of no paint are skipped.
fn top_painting_fill(a: &Appearance) -> Option<&AppearanceItem> {
a.items.iter().rev().find(|i| i.is_fill() && paints(i))
}
/// Does `item` paint anything?
pub fn paints(item: &AppearanceItem) -> bool {
item.visible()
+94 -1
View File
@@ -1,6 +1,6 @@
use super::*;
use vectorcraft_color::{BlendMode, Color, Paint};
use vectorcraft_doc::{CharStyle, Effect, NodeId, TextObject};
use vectorcraft_doc::{CharStyle, Effect, FillLayer, NodeId, TextObject};
use vectorcraft_geom::{Point, Rect, shapes};
/// Type tests need glyph outlines, which only the optional craft-fonts build input provides.
@@ -71,6 +71,33 @@ fn trap_effect_adds_an_overprinting_strip_above_the_members() {
assert_eq!(fill.paint.color(), Some(yellow));
}
/// Trap takes each member's top fill that paints: a hidden fill on top is skipped, and a member
/// whose only fill is hidden does not take part.
#[test]
fn trap_skips_a_hidden_fill() {
let yellow = Color::cmyk(0.0, 0.0, 1.0, 0.0);
let blue = Color::cmyk(1.0, 0.6, 0.0, 0.0);
let mut hidden = FillLayer::new(Paint::solid(Color::cmyk(0.0, 0.0, 0.0, 1.0)));
hidden.visible = false;
let trap = |members: Vec<Arc<Node>>| {
let mut g = Node::group(NodeId(10), members);
let params = serde_json::json!({"thickness": 1.0, "tintReduction": 100});
g.appearance.effects.push(Effect { id: crate::trap::TRAP.into(), params, visible: true });
pathfinder_children(None, &g, None).unwrap()
};
let mut covered = (*sq(1, 0.0, yellow)).clone();
covered.appearance.items.push(AppearanceItem::Fill(hidden.clone()));
let out = trap(vec![Arc::new(covered), sq(2, 10.0, blue)]);
assert_eq!(out.len(), 3, "both squares and one trap");
assert_eq!(out[2].appearance.fill().unwrap().paint.color(), Some(yellow));
let only_hidden = Node::path(
NodeId(1),
shapes::rectangle(Rect::new(0.0, 0.0, 10.0, 10.0)),
Appearance { items: vec![AppearanceItem::Fill(hidden)], ..Default::default() },
);
assert_eq!(trap(vec![Arc::new(only_hidden), sq(2, 10.0, blue)]).len(), 2, "no trap");
}
#[test]
fn hard_mix_takes_the_highest_of_each_cmyk_channel_and_drops_strokes() {
let mut g = two_overlapping_cmyk_squares();
@@ -87,6 +114,72 @@ fn soft_mix_blends_cmyk_bottom_to_top_and_drops_strokes() {
assert!((c - 0.3).abs() < 0.02 && (m - 0.43).abs() < 0.02 && (y - 0.35).abs() < 0.02 && (k - 0.05).abs() < 0.02, "{c} {m} {y} {k}");
}
/// Soft Mix and Hard Mix mix the top fill that paints: a hidden fill above it adds no color.
#[test]
fn mixes_skip_a_hidden_fill() {
for effect in ["pathfinder.softMix", "pathfinder.hardMix"] {
let mut plain = two_overlapping_cmyk_squares();
plain.appearance.effects.push(Effect { id: effect.into(), params: serde_json::json!({"mixingRate": 50.0}), visible: true });
let mut covered = plain.clone();
let NodeKind::Group { children, .. } = &mut covered.kind else { panic!("group") };
let mut hidden = FillLayer::new(Paint::solid(Color::cmyk(0.0, 0.0, 0.0, 1.0)));
hidden.visible = false;
for c in children.iter_mut() {
Arc::make_mut(c).appearance.items.push(AppearanceItem::Fill(hidden.clone()));
}
assert_eq!(overlap_cmyk(&covered), overlap_cmyk(&plain), "{effect}");
}
}
/// Outline strokes each edge with the top fill that paints, keeping that fill's opacity, blend
/// mode and overprint. A hidden fill or a fill of no paint gives the edges nothing; with no fill
/// that paints, the edges take the top stroke that paints, which skips hidden and 0 pt strokes.
#[test]
fn outline_edges_keep_the_fill_layers_opacity_blend_and_overprint() {
use vectorcraft_doc::StrokeLayer;
let red = Paint::solid(Color::rgb(1.0, 0.0, 0.0));
let blue = Paint::solid(Color::rgb(0.0, 0.0, 1.0));
let mut fill = FillLayer::new(red.clone());
(fill.opacity, fill.blend, fill.overprint) = (0.5, BlendMode::Multiply, true);
let mut hidden = FillLayer::new(Paint::solid(Color::rgb(0.0, 1.0, 0.0)));
hidden.visible = false;
let mut stroke = StrokeLayer::new(blue.clone(), 2.0);
(stroke.opacity, stroke.blend, stroke.overprint) = (0.5, BlendMode::Multiply, true);
let mut hidden_stroke = StrokeLayer::new(Paint::solid(Color::rgb(0.0, 1.0, 0.0)), 2.0);
hidden_stroke.visible = false;
let zero_stroke = StrokeLayer::new(Paint::solid(Color::rgb(0.0, 1.0, 0.0)), 0.0);
let look = |items: Vec<AppearanceItem>| Appearance { items, ..Default::default() };
let (f, s) = (AppearanceItem::Fill, AppearanceItem::Stroke);
let cases = [
(look(vec![f(fill.clone())]), Some(red.clone())),
(look(vec![f(fill.clone()), f(hidden.clone())]), Some(red.clone())),
(look(vec![f(fill.clone()), f(FillLayer::new(Paint::None))]), Some(red.clone())),
(look(vec![f(hidden.clone())]), None),
(look(vec![s(stroke.clone())]), Some(blue.clone())),
(look(vec![f(hidden.clone()), s(stroke.clone())]), Some(blue.clone())),
(look(vec![s(stroke.clone()), s(hidden_stroke), s(zero_stroke.clone())]), Some(blue.clone())),
(look(vec![s(zero_stroke)]), None),
];
for (appearance, want) in cases {
let member = Arc::new(Node::path(NodeId(1), shapes::rectangle(Rect::new(0.0, 0.0, 10.0, 10.0)), appearance));
let mut g = Node::group(NodeId(10), vec![member, sq(2, 5.0, Color::rgb(0.0, 0.0, 1.0))]);
g.appearance.effects.push(Effect { id: "pathfinder.outline".into(), params: serde_json::json!({}), visible: true });
let out = pathfinder_children(None, &g, None).unwrap();
let edges: Vec<_> = out.iter().filter(|n| n.id == NodeId(1)).collect();
assert!(!edges.is_empty(), "{out:#?}");
for n in edges {
let [AppearanceItem::Stroke(s)] = n.appearance.items.as_slice() else { panic!("one stroke: {n:#?}") };
match &want {
Some(paint) => {
assert_eq!(&s.paint, paint);
assert_eq!((s.opacity, s.blend, s.overprint), (0.5, BlendMode::Multiply, true), "{s:#?}");
}
None => assert!(s.paint.is_none() && s.opacity == 1.0, "{s:#?}"),
}
}
}
}
#[test]
fn shape_modes_follow_the_pathfinder_panel() {
let add = pathfinder_children(None, &group_with("pathfinder.add"), None).unwrap();
+2 -2
View File
@@ -103,8 +103,8 @@ pub use solids::{
with_graphic,
};
pub use solids::{
GRAPHIC_MAX_OFFSET, GRAPHIC_SCALE_RANGE, GRAPHICS_NOT_TAKEN, appearance_graphic_symbols, graphic_frame_at, graphics_reshaped_after,
rename_appearance_graphic_symbol,
GRAPHIC_MAX_OFFSET, GRAPHIC_SCALE_RANGE, GRAPHICS_NOT_TAKEN, appearance_graphic_symbols, exports_three_d, graphic_frame_at,
graphics_reshaped_after, rename_appearance_graphic_symbol,
};
pub use stylize::{ScribbleSetting, scribble_setting_id, scribble_settings};
pub use svg_filter::SVG_FILTER;
+15 -3
View File
@@ -175,6 +175,20 @@ pub(crate) fn footprint(path: &vectorcraft_geom::BezPath, seam: f64) -> vectorcr
/// every face is a facet a surface draws: a path filled and stroked by its seam, or a facet composed
/// in a clip of its footprint, neither with an opacity mask.
pub(crate) fn sealed(id: vectorcraft_doc::NodeId, faces: &[std::sync::Arc<vectorcraft_doc::Node>]) -> Option<vectorcraft_doc::Node> {
use std::sync::Arc;
use vectorcraft_doc::{Node, NodeKind};
let (clip, mut underlay) = underlay(id, faces)?;
underlay.extend(faces.iter().cloned());
Some(Node::new(id, NodeKind::Group { children: vec![Arc::new(clip), Arc::new(Node::group(id, underlay))], clip: true }))
}
/// The parts of [`sealed`] for `faces`: a path of the union of the facets' footprints, to clip to,
/// and the facets grown to seams [`UNDERLAY_SEAM`] wide, in the same order. `None` under the same
/// conditions as [`sealed`].
pub(crate) fn underlay(
id: vectorcraft_doc::NodeId,
faces: &[std::sync::Arc<vectorcraft_doc::Node>],
) -> Option<(vectorcraft_doc::Node, Vec<std::sync::Arc<vectorcraft_doc::Node>>)> {
use std::sync::Arc;
use vectorcraft_doc::{Appearance, Node, NodeKind};
let mut outline = vectorcraft_geom::BezPath::new();
@@ -207,9 +221,7 @@ pub(crate) fn sealed(id: vectorcraft_doc::NodeId, faces: &[std::sync::Arc<vector
_ => return None,
}
}
let clip = Node::path(id, vectorcraft_geom::PathData::from_bezpath(&outline), Appearance::default());
underlay.extend(faces.iter().cloned());
Some(Node::new(id, NodeKind::Group { children: vec![Arc::new(clip), Arc::new(Node::group(id, underlay))], clip: true }))
Some((Node::path(id, vectorcraft_geom::PathData::from_bezpath(&outline), Appearance::default()), underlay))
}
/// Composite smooth solid-fill facets with one clip and three channel groups per surface. In each
+285 -19
View File
@@ -296,11 +296,35 @@ fn paint_copies(faces: usize, paint: &Paint) -> usize {
faces.saturating_mul(4).saturating_mul(paint_bytes(paint))
}
/// Do Revolve's `options` light its surface with colored lights?
fn colored(options: &Revolve) -> bool {
options.light_color != [1.0; 3] || options.lights.is_some()
}
/// Do Revolve's `faces` in `paint` lie over an underlay of themselves ([`sealed_run`])? Under
/// colored lights (`colored`), in a solid color or a gradient, when a face takes a smooth light
/// ramp ([`crate::lighting::rgb_gradient_art`], [`crate::lighting::gradient_art`],
/// [`crate::lighting::smooth_paint`]). Not in a gradient with transparent stops: its composed faces
/// carry its opacity mask, which the underlay does not take ([`crate::lighting::underlay`]).
fn seals(faces: &[vectorcraft_three_d::Face], paint: &Paint, colored: bool) -> bool {
colored
&& (matches!(paint, Paint::Gradient(_)) || paint.color().is_some())
&& faces.iter().any(|f| f.rgb_gradient.is_some() || f.light_gradient.is_some())
&& crate::lighting::opaque_paint(paint).1.is_none()
}
/// The bytes the copies of `paint` take on Revolve's `faces` ([`paint_copies`]), twice that when the
/// faces lie over an underlay of themselves ([`seals`]).
fn surface_copies(faces: &[vectorcraft_three_d::Face], paint: &Paint, colored: bool) -> usize {
let copies = paint_copies(faces.len(), paint);
if seals(faces, paint, colored) { copies.saturating_mul(2) } else { copies }
}
/// An error when `path` does not revolve or when its surface in `item`'s paint takes `copies`, the
/// bytes of an object's paint copies so far, past [`MAX_PAINT_COPIES`].
fn check_surface(path: &PathData, b: Rect, options: Revolve, item: Option<&AppearanceItem>, copies: &mut usize) -> Result<(), String> {
let faces = vectorcraft_three_d::revolve(path, b, options)?;
*copies = copies.saturating_add(item.map_or(0, |i| paint_copies(faces.len(), &paint_of(i).0)));
*copies = copies.saturating_add(item.map_or(0, |i| surface_copies(&faces, &paint_of(i).0, colored(&options))));
if *copies > MAX_PAINT_COPIES {
return Err("Revolve paint is too complex for this surface; reduce Segments or simplify the gradient".into());
}
@@ -438,7 +462,9 @@ fn group_shadow(
/// with its classic surface, as Extrude & Bevel (Classic) does. Revolve's graphics, with the
/// symbols of `doc`, are drawn on the faces of the side ([`crate::solids::graphics::surface_parts`]):
/// a face with a part of a graphic is a group of the face and that part. With `cast`, the sweep
/// that draws the surface also keeps the faces its shadow is cast from ([`SolidFaces`]).
/// that draws the surface also keeps the faces its shadow is cast from ([`SolidFaces`]). The last
/// value is whether the faces go over an underlay of themselves ([`seals`]): the caller seals them
/// ([`sealed_surface`], [`sealed_runs`]) in the order it draws them.
#[allow(clippy::too_many_arguments)]
fn surface(
doc: Option<&Document>,
@@ -453,7 +479,7 @@ fn surface(
expand: bool,
copies: &mut Copies,
cast: bool,
) -> Option<(Vec<Drawn>, Node, Option<SolidFaces>)> {
) -> Option<(Vec<Drawn>, Node, Option<SolidFaces>, bool)> {
#[cfg(test)]
crate::solids::SOLIDS_BUILT.with(|n| n.set(n.get() + 1));
// A loaded file or a profile edited past the limits keeps drawing its source path instead
@@ -473,15 +499,16 @@ fn surface(
let drawn =
facets.iter().map(|f| Drawn { depth: f.depth, points: f.contours.first().cloned().unwrap_or_default(), plane: f.plane }).collect();
let p = merged_params(&fx.id, &fx.params);
return Some((drawn, crate::solids::classic::surface(n, facets, &paint, opacity, blend, &p), kept));
return Some((drawn, crate::solids::classic::surface(n, facets, &paint, opacity, blend, &p), kept, false));
}
let colored = options.light_color != [1.0; 3] || options.lights.is_some();
let colored = colored(&options);
let (faces, kept) = if cast {
vectorcraft_three_d::revolve_shadowed(path, b, options).ok().map(|(f, kept)| (f, Some(kept)))?
} else {
(vectorcraft_three_d::revolve(path, b, options).ok()?, None)
};
copies.surfaces = copies.surfaces.saturating_add(paint_copies(faces.len(), &paint));
let seal = seals(&faces, &paint, colored);
copies.surfaces = copies.surfaces.saturating_add(surface_copies(&faces, &paint, colored));
if copies.surfaces > MAX_PAINT_COPIES {
return None;
}
@@ -604,7 +631,62 @@ fn surface(
let mut group = Node::group(n.id, children);
group.opacity = opacity;
group.blend = blend;
Some((keys, group, kept))
Some((keys, group, kept, seal))
}
/// Plain `surface` ([`surface`]: a group of its faces) over an underlay of its faces when `seal`
/// ([`sealed_run`]), keeping the surface's opacity and blending mode.
fn sealed_surface(id: NodeId, surface: Node, seal: bool) -> Node {
let NodeKind::Group { children, clip: false } = &surface.kind else { return surface };
let Some(mut out) = seal.then(|| sealed_run(id, children)).flatten() else { return surface };
out.opacity = surface.opacity;
out.blend = surface.blend;
out
}
/// The faces `run` of one surface, in drawing order, over an underlay of themselves, all clipped
/// once to the faces' outline, as [`crate::lighting::sealed`] draws them. A face drawn with a part
/// of a graphic, a group of the face and that part, takes its face's underlay and stays in the
/// order with its part; the part is cut to its face's outline ([`crate::solids::graphics::surface_parts`]),
/// so the clip keeps it. `None` when [`crate::lighting::underlay`] does not take the faces.
fn sealed_run(id: NodeId, run: &[Arc<Node>]) -> Option<Node> {
let faces: Vec<Arc<Node>> = run
.iter()
.map(|face| match &face.kind {
NodeKind::Group { children, clip: false } => children.first().cloned(),
_ => Some(face.clone()),
})
.collect::<Option<_>>()?;
if faces.is_empty() {
return None;
}
let (clip, mut underlay) = crate::lighting::underlay(id, &faces)?;
underlay.extend(run.iter().cloned());
Some(Node::new(id, NodeKind::Group { children: vec![Arc::new(clip), Arc::new(Node::group(id, underlay))], clip: true }))
}
/// `faces` in their drawing order, each with the index of its surface. Each run of consecutive
/// faces of one surface that `seal` takes lies over an underlay of its own faces ([`sealed_run`]),
/// so no underlay reaches under another surface's faces, as Inflate's surfaces do
/// (`crate::solids::underlaid_runs`). A run the underlay does not take keeps its faces.
fn sealed_runs(id: NodeId, faces: Vec<(usize, Arc<Node>)>, seal: impl Fn(usize) -> bool) -> Vec<Arc<Node>> {
let mut out = Vec::with_capacity(faces.len());
let mut run: Vec<Arc<Node>> = vec![];
let mut faces = faces.into_iter().peekable();
while let Some((surface, face)) = faces.next() {
run.push(face);
if faces.peek().is_some_and(|(next, _)| *next == surface) {
continue;
}
match seal(surface).then(|| sealed_run(id, &run)).flatten() {
Some(sealed) => {
out.push(Arc::new(sealed));
run.clear();
}
None => out.append(&mut run),
}
}
out
}
/// A face [`surface`] draws: its depth and, for [`crate::solids::surface_order`], its polygon on the
@@ -636,7 +718,8 @@ fn object_surface(
let b = path.bounds()?;
let (paint, opacity, blend) = paint_of(item);
let cast = casts(fx, opacity);
surface(doc, n, path, b, fx_options(fx), fx, paint, opacity, blend, expand, copies, cast).map(|(_, art, kept)| (art, kept))
surface(doc, n, path, b, fx_options(fx), fx, paint, opacity, blend, expand, copies, cast)
.map(|(_, art, kept, seal)| (sealed_surface(n.id, art, seal), kept))
}
/// The paint of a graphic's solid color `c` on `face`, shaded as the face shades a solid fill of
@@ -1055,6 +1138,8 @@ fn group_art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
let mut surfaces = vec![];
// The faces each member's surface kept for the shadow, member by member.
let mut kept = vec![];
// Whether each member's faces lie over an underlay of themselves ([`surface`]).
let mut seals = vec![];
let mut opaque = true;
// The graphics go once, on the side of the member with the longest profile. Without graphics
// no member is measured for them.
@@ -1072,10 +1157,14 @@ fn group_art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
let expand = expand && s.scopes.is_empty();
let doc = doc.filter(|_| longest == Some(k));
let cast = casts(fx, opacity * s.opacity);
let (depths, art, faces) = surface(doc, n, &s.path, b, options, fx, paint, opacity, blend, expand, &mut copies, cast)?;
let (depths, art, faces, seal) = surface(doc, n, &s.path, b, options, fx, paint, opacity, blend, expand, &mut copies, cast)?;
surfaces.push((depths, art, s.scopes.as_slice()));
kept.push(faces);
seals.push(seal);
}
// The faces of a member whose surface takes an underlay lie over one, run by run in the one
// order of every member's faces ([`sealed_runs`]).
let seal = |member: usize| seals.get(member) == Some(&true);
if surfaces.is_empty() {
return None;
}
@@ -1101,7 +1190,7 @@ fn group_art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
let order = crate::solids::surface_order(faces.iter().map(|(d, ..)| (d.points.as_slice(), d.plane, d.depth)));
let faces = in_order(faces, &order);
if opaque {
vec![Arc::new(Node::group(n.id, faces.into_iter().map(|(.., face)| face).collect()))]
vec![Arc::new(Node::group(n.id, sealed_runs(n.id, faces.into_iter().map(|(_, member, .., face)| (member, face)).collect(), seal)))]
} else {
// An opaque member's face goes in the order on its own. The faces of a member with
// transparency share a run, one group with the opacity and blending mode of its fill or
@@ -1110,6 +1199,8 @@ fn group_art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
// where one group can't be both behind and in front of another face.
struct Run<'a> {
member: Option<usize>,
// The member the faces are of.
of: usize,
scopes: &'a [Scope],
bounds: Rect,
faces: Vec<Arc<Node>>,
@@ -1125,12 +1216,12 @@ fn group_art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
let paints = opacity > 0.0 && scopes.iter().all(|s| s.opacity > 0.0);
let Some(cover) = Coverage::of(&face).filter(|_| paints) else {
// A face that paints nothing goes in the order on its own and overlaps nothing.
runs.push(Run { member: None, scopes, bounds: Rect::ZERO, faces: vec![face], cover: vec![], opacity, blend });
runs.push(Run { member: None, of: member, scopes, bounds: Rect::ZERO, faces: vec![face], cover: vec![], opacity, blend });
continue;
};
let masked = masks.get(member).is_some_and(Option::is_some);
if opacity >= 1.0 && blend == Default::default() && scopes.is_empty() && !masked {
runs.push(Run { member: None, scopes, bounds: cover.bounds, faces: vec![face], cover: vec![cover], opacity, blend });
runs.push(Run { member: None, of: member, scopes, bounds: cover.bounds, faces: vec![face], cover: vec![cover], opacity, blend });
continue;
}
let mut clear = |r: &Run| {
@@ -1153,24 +1244,49 @@ fn group_art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
if let Some(last) = last_run.get_mut(member) {
*last = Some(runs.len());
}
runs.push(Run { member: Some(member), scopes, bounds: cover.bounds, faces: vec![face], cover: vec![cover], opacity, blend });
runs.push(Run {
member: Some(member),
of: member,
scopes,
bounds: cover.bounds,
faces: vec![face],
cover: vec![cover],
opacity,
blend,
});
}
}
}
let runs = runs.into_iter().filter_map(|mut r| {
// Consecutive faces of opaque members on their own wait in `solo` and go over an
// underlay of their member's faces, run by run ([`sealed_runs`]).
let mut out: Vec<(&[Scope], Arc<Node>)> = Vec::with_capacity(runs.len());
let mut solo: Vec<(usize, Arc<Node>)> = vec![];
for mut r in runs {
// A face on its own needs a group only for the opacity or blending mode of its fill or stroke.
if r.member.is_none() && r.opacity >= 1.0 && r.blend == Default::default() {
return r.faces.pop().map(|face| (r.scopes, face));
let Some(face) = r.faces.pop() else { continue };
if r.scopes.is_empty() && !r.cover.is_empty() {
solo.push((r.of, face));
} else {
out.extend(sealed_runs(n.id, std::mem::take(&mut solo), seal).into_iter().map(|face| (&[][..], face)));
out.push((r.scopes, face));
}
continue;
}
let mut group = Node::group(n.id, r.faces);
out.extend(sealed_runs(n.id, std::mem::take(&mut solo), seal).into_iter().map(|face| (&[][..], face)));
let mut group = match r.member.filter(|m| seal(*m)).and_then(|_| sealed_run(n.id, &r.faces)) {
Some(sealed) => sealed,
None => Node::group(n.id, r.faces),
};
group.opacity = r.opacity;
group.blend = r.blend;
if let Some(mask) = r.member.and_then(|m| masks.get(m)).cloned().flatten() {
group.extras_mut().mask = Some(mask);
}
Some((r.scopes, Arc::new(group)))
});
scoped(n.id, runs.collect(), 0)
out.push((r.scopes, Arc::new(group)));
}
out.extend(sealed_runs(n.id, solo, seal).into_iter().map(|face| (&[][..], face)));
scoped(n.id, out, 0)
}
};
// One shadow for every member's surface, behind them all.
@@ -1693,6 +1809,156 @@ mod tests {
assert_eq!(revolve_art(&two), None, "past the budget the source draws");
let object = painted(3, 0.0, stops * 2);
assert!(validate_revolve(&object, &json!({})).is_err(), "one object past the budget");
// Under a colored light the faces lie over an underlay of themselves, which copies their
// paints again: the gradient that fits in white light is past the budget.
let lit = json!({"lightColor": "#ff0000"});
let object = painted(4, 0.0, stops);
assert_eq!(validate_revolve(&object, &json!({})), Ok(()));
let refused = validate_revolve(&object, &lit).unwrap_err();
assert!(refused.contains("simplify the gradient"), "{refused}");
let mut drawn = (*object).clone();
drawn.appearance.effects.push(crate::new_effect(REVOLVE, &lit).unwrap());
assert_eq!(revolve_art(&drawn), None, "past the budget the source draws");
}
/// Is `u` the underlay [`crate::lighting::underlay`] draws for `face`, a face [`surface`] draws?
fn underlies(u: &Node, face: &Node) -> bool {
match (&u.kind, &face.kind) {
(NodeKind::Path { .. }, NodeKind::Path { .. }) => {
u.path_data() == face.path_data()
&& u.appearance.items.iter().all(|i| !matches!(i, AppearanceItem::Stroke(s) if s.width != crate::lighting::UNDERLAY_SEAM))
}
(NodeKind::Group { children: under, clip: true }, NodeKind::Group { children, clip: true }) => {
matches!((under.get(1), children.get(1)), (Some(a), Some(b)) if Arc::ptr_eq(a, b))
}
(_, NodeKind::Group { children, clip: false }) => children.first().is_some_and(|f| underlies(u, f)),
_ => false,
}
}
/// The runs of faces in `art` that lie over an underlay of themselves ([`sealed_run`]), each
/// run's faces in drawing order.
pub(super) fn sealed_faces(art: &Node) -> Vec<Vec<Arc<Node>>> {
let mut out = vec![];
art.walk(&mut |n| {
let NodeKind::Group { children, clip: true } = &n.kind else { return };
let [clip, inner] = &children[..] else { return };
let NodeKind::Group { children: drawn, clip: false } = &inner.kind else { return };
let (under, faces) = drawn.split_at(drawn.len() / 2);
if clip.path_data().is_some() && !inner.isolate && drawn.len() % 2 == 0 && under.iter().zip(faces).all(|(u, f)| underlies(u, f)) {
out.push(faces.to_vec());
}
});
out
}
/// `n`'s surface as [`surface`] draws it before its faces are sealed, and whether they are.
fn unsealed(n: &Node) -> (Node, bool) {
let path = n.path_data().unwrap();
let fx = n.appearance.effects.first().unwrap();
let (paint, opacity, blend) = paint_of(n.appearance.items.first().unwrap());
let (_, art, _, seal) =
surface(None, n, path, path.bounds().unwrap(), fx_options(fx), fx, paint, opacity, blend, false, &mut Copies::default(), false).unwrap();
(art, seal)
}
#[test]
fn colored_light_faces_lie_over_an_underlay_of_themselves_once_per_surface() {
use vectorcraft_doc::color::{BlendMode, Gradient, GradientKind, GradientPaint, GradientStop};
let lit = |params: Value, paint: Paint| {
let mut n = profile_node();
n.appearance = Appearance::basic(paint, Paint::None, 0.0).into();
n.appearance.effects.push(crate::new_effect(REVOLVE, &params).unwrap());
n
};
let red = Paint::solid(Color::rgb(0.8, 0.2, 0.1));
let ramp = |opacity: f32| {
let stops = [Color::WHITE, Color::rgb(0.5, 0.5, 0.5)].into_iter().enumerate();
let stops = stops.map(|(i, c)| GradientStop { opacity, ..GradientStop::new(i as f32, c) }).collect();
Paint::Gradient(Box::new(GradientPaint::new(Gradient::new(GradientKind::Linear, stops))))
};
let lights = json!([{"color": "#ff8080", "rotation": 120.0}, {"color": "#8080ff", "rotation": -30.0}]);
// In white light nothing is sealed.
let white = lit(json!({}), red.clone());
assert!(!unsealed(&white).1);
assert!(sealed_faces(&revolve_art(&white).unwrap()).is_empty());
for (name, n) in [
("solid", lit(json!({"lightColor": "#ff0000"}), red.clone())),
("gradient", lit(json!({"lightColor": "#ff0000"}), ramp(1.0))),
("two lights", lit(json!({"lights": lights}), ramp(1.0))),
("edge-on", lit(json!({"lightColor": "#ff0000", "rotationX": -80}), red.clone())),
] {
// Every face of the surface, in its order, lies over its underlay, once.
let (plain, seal) = unsealed(&n);
assert!(seal, "{name}");
let faces = plain.children().unwrap().to_vec();
assert_eq!(sealed_faces(&revolve_art(&n).unwrap()), vec![faces], "{name}");
}
// The surface's opacity and blending mode apply once, to the sealed surface.
let mut n = lit(json!({"lightColor": "#ff0000"}), ramp(1.0));
if let Some(AppearanceItem::Fill(f)) = n.appearance.items.first_mut() {
f.opacity = 0.5;
f.blend = BlendMode::Multiply;
}
let art = revolve_art(&n).unwrap();
assert_eq!(sealed_faces(&art).len(), 1);
// Inside the surface only a face's own lit art blends (its light multiplied over its paint).
let once = |chain: &Chain| chain.first() == Some(&(0.5, BlendMode::Multiply)) && chain.iter().skip(1).all(|(o, _)| *o == 1.0);
let faces = faces_in_order(&art);
assert!(faces.iter().all(|(_, chain)| once(chain)), "{:?}", faces.iter().map(|f| &f.1).find(|c| !once(c)));
// Faces in a gradient with transparent stops carry its opacity mask, which the underlay
// does not take: the surface keeps its faces as they are, and their paints are not
// counted twice.
let n = lit(json!({"lightColor": "#ff0000"}), ramp(0.6));
let (plain, seal) = unsealed(&n);
assert!(!seal);
assert_eq!(sealed_surface(n.id, plain.clone(), true), plain);
assert!(sealed_faces(&revolve_art(&n).unwrap()).is_empty());
let path = n.path_data().unwrap();
let faces = vectorcraft_three_d::revolve(path, path.bounds().unwrap(), fx_options(&n.appearance.effects[0])).unwrap();
assert_eq!(surface_copies(&faces, &ramp(0.6), true), paint_copies(faces.len(), &ramp(0.6)));
assert_eq!(surface_copies(&faces, &ramp(1.0), true), 2 * paint_copies(faces.len(), &ramp(1.0)));
// Revolve (Classic) takes no colored light, so none of its faces are sealed.
assert!(!colored(&classic::options(&json!({"lightColor": "#ff0000"}))));
}
#[test]
fn each_members_run_of_faces_lies_over_an_underlay_of_its_own() {
// Rings one above the other: their faces alternate in the one order, so each ring's
// faces go over underlays run by run, and no run holds faces of both.
let ring = |id, y: f64, opacity: f32| {
let mut n = (*member(id, 40.0)).clone();
if let Some(AppearanceItem::Fill(f)) = n.appearance.items.first_mut() {
f.opacity = opacity;
}
if let NodeKind::Path { path, .. } = &mut n.kind {
*path = PathData::from_bezpath(&(Affine::translate((0.0, y)) * path.to_bezpath()));
}
Arc::new(n)
};
let lit = json!({"segments": 16, "lightColor": "#ff0000"});
for opacity in [1.0, 0.5] {
let members = vec![ring(1, 0.0, 1.0), ring(2, 200.0, opacity)];
let art = revolve_art(&group_with(lit.clone(), members.clone())).unwrap();
let runs = sealed_faces(&art);
assert!(runs.len() >= 2, "{opacity}: {} runs", runs.len());
for run in &runs {
let ys: Vec<f64> = run.iter().filter_map(|f| f.visual_bounds()).map(|b| b.center().y).collect();
assert!(ys.iter().all(|y| *y < 100.0) || ys.iter().all(|y| *y > 100.0), "{opacity}: a run holds one ring's faces: {ys:?}");
}
// Each ring's opacity applies once, to its faces and their underlays; inside, only a
// face's own lit art blends.
let faded = |chain: &Chain| chain.iter().filter(|(o, _)| *o != 1.0).count();
let chains: Vec<Chain> = faces_in_order(&art).into_iter().map(|(_, c)| c).collect();
assert!(chains.iter().all(|c| faded(c) <= 1 && c.iter().all(|(o, _)| *o == 1.0 || *o == opacity)), "{opacity}");
assert_eq!(chains.iter().any(|c| faded(c) == 1), opacity < 1.0, "{opacity}");
if opacity == 1.0 {
// Opaque rings share one order, and every face in it lies over an underlay.
let white = revolve_art(&group_with(json!({"segments": 16}), members)).unwrap();
let count = white.children().unwrap()[0].children().unwrap().len();
assert_eq!(runs.iter().map(Vec::len).sum::<usize>(), count);
}
}
}
#[test]
+35
View File
@@ -164,6 +164,41 @@ mod tests {
}
}
/// With Black Overprint every face keeps the blue, and the faces that darken get black over it,
/// overprinting, as strong as the darkening of the shading color Black.
#[test]
fn black_overprint_keeps_the_blue_under_overprinting_black() {
let darkened = revolved(json!({"surface": "diffuse"}));
let art = revolved(json!({"surface": "diffuse", "shadingColor": "blackOverprint"}));
let (darkened, drawn) = (faces(&darkened), faces(&art));
assert_eq!(darkened.len(), drawn.len());
let mut shaded = 0;
for (face, black) in drawn.iter().zip(&darkened) {
let fills: Vec<&vectorcraft_doc::FillLayer> = face
.appearance
.items
.iter()
.filter_map(|i| match i {
AppearanceItem::Fill(f) => Some(f),
AppearanceItem::Stroke(_) => None,
})
.collect();
assert_eq!((fills[0].paint.color(), fills[0].overprint), (Some(BLUE), false));
let k = match fills.get(1) {
Some(shadow) => {
let Some(Color::Gray { k }) = shadow.paint.color() else { panic!("black shading: {:?}", shadow.paint) };
assert_eq!((shadow.blend, shadow.overprint), (vectorcraft_doc::color::BlendMode::Multiply, true));
shaded += 1;
k
}
None => 0.0,
};
let b = fill(black).unwrap().to_rgb()[2];
assert!((b - 0.8 * (1.0 - k)).abs() < 1e-3, "black at {k} matches the darkened blue {b}");
}
assert!(shaded > 0, "faces turned from the light get black");
}
#[test]
fn angle_offset_edge_and_cap_shape_the_surface() {
let full = revolved(json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0})).visual_bounds().unwrap();
@@ -279,6 +279,23 @@ fn under_several_lights_a_graphic_takes_each_faces_own_lit_art() {
assert!(translucent > base && opaque - base == 2 * (translucent - base), "{base} {opaque} {translucent}");
}
#[test]
fn under_a_colored_light_each_part_of_a_graphic_stays_right_after_its_face_over_the_underlay() {
let d = document();
let n = revolved(&CYLINDER, json!({"shade": true, "lightColor": "#ff8040", "graphics": [{"symbol": "Red"}]}));
let art = revolve_art_in(Some(&d), &n).unwrap();
// One run holds every face; a face with a part of the bar is a group of the face and that part.
let runs = super::tests::sealed_faces(&art);
assert_eq!(runs.len(), 1);
let carrying: Vec<&Arc<Node>> = runs[0].iter().filter(|f| matches!(f.kind, NodeKind::Group { clip: false, .. })).collect();
assert!(!carrying.is_empty());
assert!(carrying.iter().all(|f| f.children().is_some_and(|c| c.len() > 1 && parts(&c[0], false).is_empty())));
// Every part of the bar is drawn in the run, after its face, and none in the underlay.
let in_run: usize = carrying.iter().map(|f| parts(f, false).len()).sum();
assert!(in_run > 0);
assert_eq!(in_run, parts(&art, false).len());
}
#[test]
fn graphics_past_the_point_limit_are_refused() {
let mut d = document();
+15
View File
@@ -102,6 +102,21 @@ pub fn has_solid(n: &Node) -> bool {
solid(&n.appearance.effects).is_some() || n.appearance.items.iter().any(|i| i.visible() && solid(i.effects()).is_some())
}
/// Does `n` carry a 3D effect that [`three_d_meshes`] builds solids from: a visible Revolve, or
/// else a visible Extrude & Bevel, Inflate or Rotate effect, which on a group or layer must be on
/// the object itself (one on a group's fill or stroke draws nothing to export)? It does not build
/// the solids, so [`three_d_meshes`] can still refuse an object it passes.
pub fn exports_three_d(n: &Node) -> bool {
let container = is_container(n);
if crate::has_revolve(n) {
!container || n.appearance.effects.iter().any(|e| e.visible && crate::is_revolve(&e.id))
} else if container {
solid(&n.appearance.effects).is_some()
} else {
has_solid(n)
}
}
/// The Position presets: (id, [rotation X, Y, Z]). Front, Back, Left, Right, Top and Bottom face
/// the art that way; Off-Axis tilts each 20° down and 25° aside (showing the top and right);
/// Isometric lays the art on the left, right, top or bottom plane of an isometric view (the
+52 -19
View File
@@ -20,8 +20,8 @@ pub const ROTATE_SURFACES: [&str; 2] = ["none", "diffuse"];
/// The width of a Wireframe edge, in points.
const WIRE: f64 = 0.5;
/// The Shading Color choices: black, a custom color, or none.
pub const SHADING_COLORS: [&str; 3] = ["black", "custom", "none"];
/// The Shading Color choices: black, a custom color, none, or black overprinting the paint.
pub const SHADING_COLORS: [&str; 4] = ["black", "custom", "none", "blackOverprint"];
/// The surface settings of Extrude & Bevel (Classic)'s parameters.
pub fn classic_shading(p: &Value) -> ClassicShading {
@@ -55,8 +55,8 @@ pub fn classic_extrude_options(p: &Value) -> Extrude {
}
}
/// The color faces darken toward: black, the custom color, or none (faces keep their paint and only
/// the highlight lightens them).
/// The color faces darken toward: black (for Black Overprint too), the custom color, or none (faces
/// keep their paint and only the highlight lightens them).
fn shading_color(p: &Value) -> Option<Color> {
match text(p, "shadingColor", "black") {
"none" => None,
@@ -200,27 +200,54 @@ fn preserves_spot_colors(p: &Value) -> bool {
/// A face of `paint`, a color linked to a swatch, with Preserve Spot Colors: the swatch at a lower
/// tint for the highlight `spec`, its link kept so a spot color stays on its own plate, and, where
/// tone `tone` is below full light and the faces darken (`shade`), black over it at `1 - tone`,
/// multiplied and overprinting, so it prints on the black plate. `seam` is the width of the seam
/// tone `tone` is below full light and the faces darken (`shade`), black over it as
/// [`overprinting_black`] draws it, so it prints on the black plate. `seam` is the width of the seam
/// stroke each layer draws around the face.
fn linked_face(paint: &Paint, tone: f64, spec: f64, shade: Option<Color>, seam: f64) -> Vec<AppearanceItem> {
let Paint::Solid { color, swatch, tint } = paint else { return vec![] };
let keep = (1.0 - spec).clamp(0.0, 1.0) as f32;
let fill = Paint::Solid { color: color.tinted(keep), swatch: swatch.clone(), tint: tint * keep };
let mut items = vec![AppearanceItem::Fill(FillLayer::new(fill.clone())), AppearanceItem::Stroke(crate::lighting::seam_stroke(fill, seam))];
if shade.is_some() && tone < 1.0 {
let black = Paint::solid(Color::gray((1.0 - tone).clamp(0.0, 1.0) as f32));
let mut layer = FillLayer::new(black.clone());
layer.blend = BlendMode::Multiply;
layer.overprint = true;
let mut edge = crate::lighting::seam_stroke(black, seam);
edge.blend = BlendMode::Multiply;
edge.overprint = true;
items.extend([AppearanceItem::Fill(layer), AppearanceItem::Stroke(edge)]);
if shade.is_some() {
items.extend(overprinting_black(tone, seam));
}
items
}
/// The black that shades a face at tone `tone` on the black plate, when the tone is below full
/// light: a fill of black at `1 - tone`, multiplied and overprinting, and its seam stroke `seam`
/// wide, overprinting with Darken, so where the stroke lies over the face's own black, or over a
/// neighbor's, the face is not darkened twice.
fn overprinting_black(tone: f64, seam: f64) -> Vec<AppearanceItem> {
if tone >= 1.0 {
return vec![];
}
let black = Paint::solid(Color::gray((1.0 - tone).clamp(0.0, 1.0) as f32));
let mut layer = FillLayer::new(black.clone());
layer.blend = BlendMode::Multiply;
layer.overprint = true;
let mut edge = crate::lighting::seam_stroke(black, seam);
edge.blend = BlendMode::Darken;
edge.overprint = true;
vec![AppearanceItem::Fill(layer), AppearanceItem::Stroke(edge)]
}
/// Whether the shading color of parameters `p` is Black Overprint.
fn black_overprint(p: &Value) -> bool {
text(p, "shadingColor", "black") == "blackOverprint"
}
/// A face of `paint` with Black Overprint: the paint unchanged, and where tone `tone` is below full
/// light, black over it as [`overprinting_black`] draws it, so the paint's own inks print as they
/// are and the shading prints on the black plate. The highlight is not drawn. `seam` is the width of
/// the seam stroke each layer draws around the face.
fn overprinted_face(paint: &Paint, tone: f64, seam: f64) -> Vec<AppearanceItem> {
let mut items =
vec![AppearanceItem::Fill(FillLayer::new(paint.clone())), AppearanceItem::Stroke(crate::lighting::seam_stroke(paint.clone(), seam))];
items.extend(overprinting_black(tone, seam));
items
}
/// The width of the stroke [`surface`] draws around `face` with parameters `p`: a wire edge on
/// Wireframe, else the seam between faces.
pub(crate) fn stroke_width(face: &Facet, p: &Value) -> f64 {
@@ -229,15 +256,17 @@ pub(crate) fn stroke_width(face: &Facet, p: &Value) -> f64 {
/// One solid's faces in paint `paint`, as a group with the paint's opacity and blend mode, one child
/// for each facet: the edges of the faces on Wireframe, else each face filled in its paint shaded by
/// its tone and highlight (with Preserve Spot Colors, a color linked to a swatch as [`linked_face`]
/// draws it). A gradient with transparent stops is shaded opaque and then masked by
/// its own transparency, so the shading follows the gradient's coverage; without a placement of its
/// own, it is placed once on all the faces ([`crate::lighting::opaque_surface_paint`]).
/// its tone and highlight (with Black Overprint, as [`overprinted_face`] draws it; with Preserve Spot
/// Colors, a color linked to a swatch as [`linked_face`] draws it). A gradient with transparent stops
/// is shaded opaque and then masked by its own transparency, so the shading follows the gradient's
/// coverage; without a placement of its own, it is placed once on all the faces
/// ([`crate::lighting::opaque_surface_paint`]).
pub(crate) fn surface(n: &Node, facets: Vec<Facet>, source: &Paint, opacity: f32, blend: BlendMode, p: &Value) -> Node {
let shading = classic_shading(p);
let lights = lights(p);
let shade = shading_color(p);
let preserve = preserves_spot_colors(p);
let overprint = black_overprint(p);
let wire = shading.surface == ClassicSurface::Wireframe;
let (paint, mask) = if wire { (source.clone(), None) } else { crate::lighting::opaque_surface_paint(source, || super::facets_bounds(&facets)) };
let paint = &paint;
@@ -252,6 +281,10 @@ pub(crate) fn surface(n: &Node, facets: Vec<Facet>, source: &Paint, opacity: f32
let (tone, spec) = shading.tone(face.normal, &lights);
// A narrow stroke of the face's own paint closes the hairline seams between faces.
let seam = super::seam_width(&face);
if overprint {
let items = overprinted_face(paint, tone, seam);
return Arc::new(Node::path(n.id, face.path(), Appearance { items, ..Default::default() }));
}
let items = match paint.color() {
// Unshaded (No Shading, no shading color, or a face in full light) with no
// highlight: the paint itself, its color space and swatch kept.
+89 -2
View File
@@ -1908,6 +1908,89 @@ fn classic_shading_color_blend_steps_and_lights() {
assert_eq!(with(json!({"drawHiddenFaces": true})).len(), 6);
}
/// The fills, then the strokes, of face `face`.
fn layers_of(face: &Node) -> (Vec<&vectorcraft_doc::FillLayer>, Vec<&StrokeLayer>) {
let fills = face.appearance.items.iter().filter_map(|i| if let AppearanceItem::Fill(f) = i { Some(f) } else { None }).collect();
let strokes = face.appearance.items.iter().filter_map(|i| if let AppearanceItem::Stroke(s) = i { Some(s) } else { None }).collect();
(fills, strokes)
}
/// The black over face `face` with Black Overprint, checked to be opaque and overprinting in
/// both its fill (multiplied) and its seam stroke (Darken, so it does not darken the face twice);
/// `None` when the face has none.
fn overprinted_black(face: &Node) -> Option<f32> {
let (fills, strokes) = layers_of(face);
assert_eq!(fills.len(), strokes.len(), "each fill has its seam stroke");
let shadow = fills.get(1)?;
let Some(Color::Gray { k }) = shadow.paint.color() else { panic!("black shading: {:?}", shadow.paint) };
assert_eq!((shadow.blend, shadow.overprint, shadow.opacity), (BlendMode::Multiply, true, 1.0));
assert_eq!((strokes[1].paint.clone(), strokes[1].blend, strokes[1].overprint), (shadow.paint.clone(), BlendMode::Darken, true));
assert!(!fills[0].overprint && !strokes[0].overprint, "the paint itself knocks out");
Some(k)
}
/// Black Overprint keeps the paint on every face and draws the shading over it as black,
/// overprinting, as strong as the darkening of the shading color Black; the
/// highlight is not drawn, and No Shading adds no black.
#[test]
fn classic_black_overprint_keeps_the_paint_under_overprinting_black() {
let diffuse = json!({"surface": "diffuse", "ambient": 20});
let mut over = diffuse.clone();
over["shadingColor"] = json!("blackOverprint");
let darkened: Vec<[f32; 3]> = classic_faces(diffuse).iter().map(fill_rgb).collect();
let faces = classic_faces(over);
assert_eq!(faces.len(), darkened.len());
let mut shaded = 0;
for (face, rgb) in faces.iter().zip(&darkened) {
assert_eq!(layers_of(face).0[0].paint, Paint::solid(RED), "the paint is kept");
let k = overprinted_black(face).unwrap_or(0.0);
assert!((rgb[0] - 0.8 * (1.0 - k)).abs() < 1e-3, "black at {k} matches the darkened {rgb:?}");
shaded += usize::from(k > 0.0);
}
assert!(shaded > 0, "faces turned from the light get black");
// Plastic: no white layer for the highlight.
let shiny = json!({"shadingColor": "blackOverprint", "highlightIntensity": 100, "highlightSize": 100, "lightHeight": 60});
for face in classic_faces(shiny) {
let (fills, _) = layers_of(&face);
assert_eq!(fills[0].paint, Paint::solid(RED));
assert!(fills.len() <= 2 && overprinted_black(&face).is_none_or(|k| k > 0.0), "{fills:?}");
}
// No Shading: the paint alone.
for face in classic_faces(json!({"surface": "none", "shadingColor": "blackOverprint"})) {
assert_eq!(overprinted_black(&face), None);
assert_eq!(layers_of(&face).0[0].paint, Paint::solid(RED));
}
}
/// Black Overprint keeps a gradient fill on every face, with the black over it, and Rotate
/// (Classic) draws its plane the same way.
#[test]
fn classic_black_overprint_keeps_gradients_and_shades_rotate() {
use vectorcraft_doc::color::{Gradient, GradientKind, GradientPaint};
let gradient = Paint::Gradient(Box::new(GradientPaint::new(Gradient::new(
GradientKind::Linear,
vec![vectorcraft_doc::color::GradientStop::new(0.0, RED), vectorcraft_doc::color::GradientStop::new(1.0, BLUE)],
))));
let mut n = classic(json!({"shadingColor": "blackOverprint", "surface": "diffuse"}));
if let Some(AppearanceItem::Fill(f)) = n.appearance.items.first_mut() {
f.paint = gradient.clone();
}
let art = solid_art(&n).unwrap();
let mut shaded = 0;
for face in faces(&art) {
assert_eq!(layers_of(face).0[0].paint, gradient);
shaded += usize::from(overprinted_black(face).is_some());
}
assert!(shaded > 0);
// Rotate (Classic), turned from the light: red with black over it; facing it: red alone.
let turned = classic_rotate(json!({"rotationX": 0, "rotationY": 70, "rotationZ": 0, "lightHeight": 90, "shadingColor": "blackOverprint"}));
let face = &turned[0].children().unwrap()[0];
assert_eq!(layers_of(face).0[0].paint, Paint::solid(RED));
assert!(overprinted_black(face).is_some_and(|k| k > 0.05));
let lit = classic_rotate(json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0, "lightHeight": 90, "shadingColor": "blackOverprint"}));
assert_eq!(overprinted_black(&lit[0].children().unwrap()[0]), None);
}
#[test]
fn classic_bevel_height_extent_and_cap_shape_the_solid() {
let bounds = |p: Value| solid_art(&classic(p)).unwrap().visual_bounds().unwrap();
@@ -2134,9 +2217,12 @@ fn classic_parameters_are_checked() {
let check = |p: Value| validate_solid(&n, CLASSIC_EXTRUDE, &crate::merged_params(CLASSIC_EXTRUDE, &p));
assert!(check(json!({})).is_ok());
assert!(check(json!({"surface": "wireframe", "shadingColor": "custom", "shadingCustom": "#12aBcd", "blendSteps": 256, "bevel": "ogee"})).is_ok());
assert!(check(json!({"shadingColor": "blackOverprint"})).is_ok());
for (p, says) in [
(json!({"surface": "glossy"}), "`surface` must be one of wireframe, none, diffuse, plastic"),
(json!({"shadingColor": "red"}), "`shadingColor` must be one of black, custom, none"),
(json!({"shadingColor": "red"}), "`shadingColor` must be one of black, custom, none, blackOverprint"),
(json!({"shadingColor": "blackoverprint"}), "`shadingColor` must be one of"),
(json!({"shadingColor": true}), "`shadingColor` must be one of"),
(json!({"shadingCustom": "blue"}), "`shadingCustom` must be a #rrggbb color"),
(json!({"shadingCustom": "#fff"}), "`shadingCustom` must be a #rrggbb color"),
(json!({"depth": 2001}), "`depth` must be between 0 and 2000 (got 2001)"),
@@ -2213,11 +2299,12 @@ fn classic_rotate_parameters_are_checked() {
let check = |p: Value| validate_solid(&n, CLASSIC_ROTATE, &crate::merged_params(CLASSIC_ROTATE, &p));
assert!(check(json!({})).is_ok());
assert!(check(json!({"surface": "none", "shadingColor": "custom", "shadingCustom": "#12aBcd", "blendSteps": 1})).is_ok());
assert!(check(json!({"shadingColor": "blackOverprint"})).is_ok());
for (p, says) in [
(json!({"surface": "plastic"}), "`surface` must be one of none, diffuse"),
(json!({"surface": "wireframe"}), "`surface` must be one of none, diffuse"),
(json!({"surface": 2}), "`surface` must be one of"),
(json!({"shadingColor": "red"}), "`shadingColor` must be one of black, custom, none"),
(json!({"shadingColor": "red"}), "`shadingColor` must be one of black, custom, none, blackOverprint"),
(json!({"shadingCustom": "#fff"}), "`shadingCustom` must be a #rrggbb color"),
(json!({"rotationX": 181}), "`rotationX` must be between -180 and 180 (got 181)"),
(json!({"perspectiveAngle": 161}), "`perspectiveAngle` must be between 0 and 160 (got 161)"),
+29 -3
View File
@@ -8,7 +8,7 @@ use std::collections::HashSet;
use serde_json::{Map, Value, json};
use vectorcraft_doc::{ExportAsset, NodeId};
use super::edit::{roots_of, selected_roots};
use super::edit::{refuse_symbol_part, roots_of, selected_roots};
use super::fileio::{
DEFAULT_FORMAT_3D, FORMATS_3D, SCREEN_SETTINGS_KEYS, check_screen_settings, create_dir, export_crop, export_screens, mesh_file_names, mesh_files,
safe_file_name, store_screen_settings, with_screen_export_preset, write_file,
@@ -62,7 +62,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Export 3D Object",
[],
None,
"{ids?: [id…] (default: the selected objects), format?: usda|usdz|gltf|obj (default usda)} collect each object with an Extrude & Bevel, Revolve, Inflate or Rotate effect as a 3D asset of Window › Asset Export, named after the object (else Asset 1, Asset 2…): assets.export3D writes it as a mesh file. An object already collected as a 3D asset keeps it; an object without such an effect is refused → {assets: [asset id…] (in order), added: n}",
"{ids?: [id…] (default: the selected objects), format?: usda|usdz|gltf|obj (default usda)} collect each object with an Extrude & Bevel, Revolve, Inflate or Rotate effect as a 3D asset of Window › Asset Export, named after the object (else Asset 1, Asset 2…): assets.export3D writes it as a mesh file. An object already collected as a 3D asset keeps it; an object in ids without such an effect is refused. Without ids, the selected objects without one (on a group or layer, one on its fill or stroke draws nothing and does not count), and a selected object inside another selected object that has one, are left out; refused when none is left → {assets: [asset id…] (in order), added: n}",
has_doc,
add_3d
),
@@ -203,10 +203,36 @@ fn three_d_asset_ids(d: &vectorcraft_doc::Document, p: &Value, key: &str, cmd: &
Ok(ids)
}
/// The selected objects `assets.add3D` collects without `ids`: those with a 3D effect it exports
/// ([`vectorcraft_render::effects::exports_three_d`]; a path of a compound path counts as the
/// compound path), layers included, in tree order, dropping
/// each one inside another of them (that one's asset holds it). Refused while an object of a
/// dynamic symbol instance's art is selected, as [`selected_roots`] is.
fn selected_3d_roots(s: &Session) -> Result<Vec<NodeId>> {
refuse_symbol_part(s)?;
let st = s.doc()?;
// A path of a compound path stands for the compound path, which holds the paint and effects.
let found = st
.selection
.objects
.iter()
.map(|id| super::path::compound_or_self(&st.doc, *id))
.filter(|id| st.doc.node(*id).is_some_and(vectorcraft_render::effects::exports_three_d));
let mut paths: Vec<(Vec<usize>, NodeId)> = st.doc.index_paths(found).into_iter().map(|(id, path)| (path, id)).collect();
paths.sort_by(|a, b| a.0.cmp(&b.0));
let mut kept: Vec<(Vec<usize>, NodeId)> = Vec::with_capacity(paths.len());
for (path, id) in paths {
if !kept.last().is_some_and(|(outer, _)| path.starts_with(outer)) {
kept.push((path, id));
}
}
Ok(kept.into_iter().map(|(_, id)| id).collect())
}
fn add_3d(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "assets.add3D";
let format = format_3d_param(p, C, Some(DEFAULT_FORMAT_3D))?;
let ids = if p.get("ids").is_some_and(|v| !v.is_null()) { checked_ids_param(s, p, "ids", C)? } else { selected_roots(s)? };
let ids = if p.get("ids").is_some_and(|v| !v.is_null()) { checked_ids_param(s, p, "ids", C)? } else { selected_3d_roots(s)? };
if ids.is_empty() {
return Err(bad(C, "select an object with a 3D effect (or give its ids)"));
}
+3 -3
View File
@@ -190,7 +190,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Symbols",
[],
None,
"{} → {symbols: [{name, instances, size: [w,h], registration: 0..8, exportType: movieClip|graphic, nineSlice, type: static|dynamic}], current}",
"{} → {symbols: [{name, instances, size: [w,h], registration: 0..8, exportType: movieClip|graphic, nineSlice, type: static|dynamic, alignToPixelGrid: bool}], current}",
has_doc,
symbol_list
),
@@ -199,7 +199,7 @@ pub fn specs() -> Vec<CommandSpec> {
"New Symbol…",
[],
None,
"{name?, ids?|id?, registration?: 0..8 (9-point grid, 4 = centre; Symbol Options › Registration), exportType?: movieClip (default)|graphic, nineSlice?: bool, nineSliceGuides?: array, type?: static (default)|dynamic (Symbol Options › Symbol Type)} make a symbol from the selection and replace it with an instance; a frame of threaded text in the selection leaves its thread with the text it shows, which the symbol's art holds; nineSlice is Symbol Options › Enable Guides for 9-Slice Scaling, nineSliceGuides [left, top, right, bottom] as fractions of the natural size in from each edge, each -16..16 (below 0 or above 1 puts a guide outside the art), with left + right < 1 and top + bottom < 1 (default a quarter each); an instance of a symbol with guides keeps its corners' size when scaled, its edges stretch along their length and its center in both directions → {name, id, registration, exportType, nineSlice, type}",
"{name?, ids?|id?, registration?: 0..8 (9-point grid, 4 = centre; Symbol Options › Registration), exportType?: movieClip (default)|graphic, nineSlice?: bool, nineSliceGuides?: array, type?: static (default)|dynamic (Symbol Options › Symbol Type), alignToPixelGrid?: bool (default false; Symbol Options › Align to Pixel Grid)} make a symbol from the selection and replace it with an instance; a frame of threaded text in the selection leaves its thread with the text it shows, which the symbol's art holds; nineSlice is Symbol Options › Enable Guides for 9-Slice Scaling, nineSliceGuides [left, top, right, bottom] as fractions of the natural size in from each edge, each -16..16 (below 0 or above 1 puts a guide outside the art), with left + right < 1 and top + bottom < 1 (default a quarter each); an instance of a symbol with guides keeps its corners' size when scaled, its edges stretch along their length and its center in both directions; alignToPixelGrid keeps the symbol's instances on the pixel grid as symbol.options describes → {name, id, registration, exportType, nineSlice, type, alignToPixelGrid}",
has_selection,
symbol_new
),
@@ -208,7 +208,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Symbol Options…",
[],
None,
"{name?, newName?, registration?: 0..8, exportType?: movieClip|graphic, nineSlice?: bool, nineSliceGuides?: array, type?: static|dynamic} rename a symbol (its instances and the graphics mapped onto 3D objects follow the new name) and/or set Symbol Options › Registration, Export Type, 9-slice guides (nineSliceGuides [left, top, right, bottom] fractions in from each edge, each -16..16, with left + right < 1 and top + bottom < 1) and Symbol Type (a dynamic symbol's instances may change the appearance of objects in its art and stay linked; making it static drops those changes); default name: current → {name, registration, exportType, nineSlice, type}",
"{name?, newName?, registration?: 0..8, exportType?: movieClip|graphic, nineSlice?: bool, nineSliceGuides?: array, type?: static|dynamic, alignToPixelGrid?: bool} rename a symbol (its instances and the graphics mapped onto 3D objects follow the new name) and/or set Symbol Options › Registration, Export Type, 9-slice guides (nineSliceGuides [left, top, right, bottom] fractions in from each edge, each -16..16, with left + right < 1 and top + bottom < 1), Symbol Type (a dynamic symbol's instances may change the appearance of objects in its art and stay linked; making it static drops those changes) and Align to Pixel Grid (on: the horizontal and vertical straight segments of the paths in the symbol's art snap to whole points, or half points for an odd centered stroke, at the symbol's natural size, its stroke weights become whole points, and every instance placed at that size, reflected across one axis or not, moves to whole points and goes back to them after each move; a scaled, rotated (a half turn included) or sheared instance, and an instance in another symbol's art, is left where it is; the art snaps again after it is edited); alignToPixelGrid alone with the value the symbol already has changes nothing and adds no undo step; default name: current → {name, registration, exportType, nineSlice, type, alignToPixelGrid}",
has_doc,
symbol_options
),
+42 -9
View File
@@ -69,6 +69,15 @@ fn nine_slice_param(p: &Value, cmd: &str, current: Option<SymbolNineSlice>) -> R
})
}
/// `alignToPixelGrid` (Symbol Options › Align to Pixel Grid): `None` when it is not given; any
/// value other than true or false, null included, is an error.
fn pixel_grid_param(p: &Value, cmd: &str) -> Result<Option<bool>> {
match p.get("alignToPixelGrid") {
None => Ok(None),
Some(v) => v.as_bool().map(Some).ok_or_else(|| bad(cmd, "alignToPixelGrid must be true or false")),
}
}
fn nine_slice_json(d: &Document, name: &str) -> Value {
d.symbol_nine_slice(name).map_or(Value::Null, SymbolNineSlice::to_value)
}
@@ -187,6 +196,7 @@ pub(super) fn symbol_list(s: &mut Session, _: &Value) -> Result<Value> {
"exportType": d.symbol_export_type(&sym.name).id(),
"nineSlice": nine_slice_json(d, &sym.name),
"type": type_id(sym.dynamic),
"alignToPixelGrid": d.symbol_pixel_aligned(&sym.name),
})
})
.collect();
@@ -239,6 +249,7 @@ pub(super) fn symbol_new(s: &mut Session, p: &Value) -> Result<Value> {
let export = export_type_param(p, C)?.unwrap_or_default();
let nine = nine_slice_param(p, C, None)?.flatten();
let dynamic = type_param(p, C)?.unwrap_or(false);
let pixel = pixel_grid_param(p, C)?.unwrap_or(false);
// Keep the art where it was: the geometric centre stays at `c`, whatever the registration is.
let place = place_xf(c + reg.offset_from_center(size.0, size.1), size, reg);
let id = s.edit("New Symbol", |d, sel| {
@@ -249,6 +260,7 @@ pub(super) fn symbol_new(s: &mut Session, p: &Value) -> Result<Value> {
d.set_symbol_registration(&name, reg);
d.set_symbol_export_type(&name, export);
d.set_symbol_nine_slice(&name, nine);
d.set_symbol_pixel_aligned(&name, pixel);
let id = instance_in_place(d, &ids, &name, place)?;
sel.set([id]);
Ok(id)
@@ -260,6 +272,7 @@ pub(super) fn symbol_new(s: &mut Session, p: &Value) -> Result<Value> {
"exportType": export.id(),
"nineSlice": nine.map_or(Value::Null, SymbolNineSlice::to_value),
"type": type_id(dynamic),
"alignToPixelGrid": pixel,
}))
}
@@ -270,9 +283,15 @@ pub(super) fn symbol_options(s: &mut Session, p: &Value) -> Result<Value> {
let reg = registration_param(p, C)?;
let nine = nine_slice_param(p, C, s.doc()?.doc.symbol_nine_slice(&name))?;
let dynamic = type_param(p, C)?;
let pixel = pixel_grid_param(p, C)?;
let new_name = str_param(p, "newName").map(str::trim).filter(|n| !n.is_empty()).map(str::to_string);
if new_name.is_none() && export.is_none() && reg.is_none() && nine.is_none() && dynamic.is_none() {
return Err(bad(C, "pass newName, registration, exportType, nineSlice and/or type"));
match pixel {
None => return Err(bad(C, "pass newName, registration, exportType, nineSlice, type and/or alignToPixelGrid")),
// Align to Pixel Grid alone, already as asked: nothing changes and no undo step is added.
Some(on) if on == s.doc()?.doc.symbol_pixel_aligned(&name) => return Ok(options_json(&s.doc()?.doc, &name)),
Some(_) => {}
}
}
if let Some(ref n) = new_name
&& n != &name
@@ -324,6 +343,7 @@ pub(super) fn symbol_options(s: &mut Session, p: &Value) -> Result<Value> {
d.rename_symbol_registration(&name, n);
d.rename_symbol_export_type(&name, n);
d.rename_symbol_nine_slice(&name, n);
d.rename_symbol_pixel_aligned(&name, n);
if d.unknown.get(CURRENT_SYMBOL).and_then(Value::as_str) == Some(name.as_str()) {
d.unknown.insert(CURRENT_SYMBOL.into(), json!(n));
}
@@ -352,16 +372,26 @@ pub(super) fn symbol_options(s: &mut Session, p: &Value) -> Result<Value> {
sym.dynamic = dynamic;
fit_overrides(d, &instances_of(d, Some(&final_name)));
}
// Turning it on snaps the art and the instances at actual size when the edit ends
// (`object::refresh_pixel_aligned`).
if let Some(on) = pixel {
d.set_symbol_pixel_aligned(&final_name, on);
}
Ok(())
})?;
let d = &s.doc()?.doc;
Ok(json!({
"name": final_name,
"registration": d.symbol_registration(&final_name).0,
"exportType": d.symbol_export_type(&final_name).id(),
"nineSlice": nine_slice_json(d, &final_name),
"type": type_id(d.symbols.iter().any(|x| x.name == final_name && x.dynamic)),
}))
Ok(options_json(&s.doc()?.doc, &final_name))
}
/// What `symbol.options` answers for symbol `name`.
fn options_json(d: &Document, name: &str) -> Value {
json!({
"name": name,
"registration": d.symbol_registration(name).0,
"exportType": d.symbol_export_type(name).id(),
"nineSlice": nine_slice_json(d, name),
"type": type_id(d.symbols.iter().any(|x| x.name == name && x.dynamic)),
"alignToPixelGrid": d.symbol_pixel_aligned(name),
})
}
fn resolve_symbol(d: &Document, p: &Value, cmd: &str) -> Result<String> {
@@ -702,6 +732,7 @@ pub(super) fn symbol_delete(s: &mut Session, p: &Value) -> Result<Value> {
d.set_symbol_registration(name, SymbolRegistration::CENTER);
d.clear_symbol_export_type(name);
d.set_symbol_nine_slice(name, None);
d.set_symbol_pixel_aligned(name, false);
if d.unknown.get(CURRENT_SYMBOL).and_then(Value::as_str) == Some(name.as_str()) {
d.unknown.remove(CURRENT_SYMBOL);
}
@@ -725,6 +756,7 @@ pub(super) fn symbol_duplicate(s: &mut Session, p: &Value) -> Result<Value> {
let reg = d.symbol_registration(&name);
let export = d.symbol_export_type(&name);
let nine = d.symbol_nine_slice(&name);
let pixel = d.symbol_pixel_aligned(&name);
s.edit("Duplicate Symbol", |d, _| {
let art = d.reid(&sym.art);
d.symbols.push(Symbol { dynamic: sym.dynamic, name: new.clone(), art: Arc::new(art) });
@@ -732,6 +764,7 @@ pub(super) fn symbol_duplicate(s: &mut Session, p: &Value) -> Result<Value> {
d.set_symbol_registration(&new, reg);
d.set_symbol_export_type(&new, export);
d.set_symbol_nine_slice(&new, nine);
d.set_symbol_pixel_aligned(&new, pixel);
Ok(())
})?;
Ok(json!({ "name": new, "registration": reg.0, "exportType": export.id(), "nineSlice": nine.map_or(Value::Null, SymbolNineSlice::to_value) }))
+1 -1
View File
@@ -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), 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), through?: [id…] (scope connected only; at most 4096 edges counted as drawing with stroke paint match whatever they draw with, such as the edge a double-click's first click painted), tint?: 0..100, keepModel?: bool (both as paint.setFill)} paint the edge nearest point, skipping hidden edges: each edge reached has its strokes replaced by one stroke with the paint and width, shown, fully opaque and blending normally, in the place of its topmost stroke and with the dashes, caps and arrowheads of its topmost shown stroke (a new stroke above the fills when it has none; none leaves one stroke of none), and its fills stay as they are; when every edge it reaches already has only that one stroke (at any width for none), nothing changes (no undo step, and the recent colors stay as they are) → {group, edge, count (edges reached)}",
"{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), through?: [id…] (scope connected only; at most 4096 of the group's edges, each given once, counted as drawing with stroke paint match whatever they draw with, such as another edge a double-click's clicks painted; any other id is an error), tint?: 0..100, keepModel?: bool (both as paint.setFill)} paint the edge nearest point, skipping hidden edges: each edge reached has its strokes replaced by one stroke with the paint and width, shown, fully opaque and blending normally, in the place of its topmost stroke and with the dashes, caps and arrowheads of its topmost shown stroke (a new stroke above the fills when it has none; none leaves one stroke of none), and its fills stay as they are; when every edge it reaches already has only that one stroke (at any width for none), nothing changes (no undo step, and the recent colors stay as they are) → {group, edge, count (edges reached)}",
has_doc,
lp_stroke_edge
),
@@ -580,6 +580,12 @@ pub(super) fn lp_stroke_edge(s: &mut Session, p: &Value) -> Result<Value> {
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")))?;
// Each id in `through` is an edge of the group, given once.
let group_edges: std::collections::HashSet<NodeId> = b::edges(n).iter().map(|e| e.id).collect();
let mut seen = std::collections::HashSet::new();
if let Some(id) = through.iter().find(|id| !group_edges.contains(id) || !seen.insert(**id)) {
return Err(bad(C, format!("through: {id} is not an edge of {g}, or is given twice")));
}
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));
+11 -4
View File
@@ -173,7 +173,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Clipboard Formats",
[],
None,
"{} → {flavours: [mime…]} what Copy offers other apps for the current clipboard, best first, by the Clipboard Handling preferences: text/plain (a type-only copy's text, else the SVG markup with copyAsSvg when the images it embeds total at most 1 MiB), image/svg+xml (copyAsSvg), application/pdf (copyAsPdf), image/png (always; PDF and PNG only for objects with an area); the app publishes them on Copy and Cut",
"{} → {flavours: [mime…]} what Copy offers other apps for the current clipboard, best first, by the Clipboard Handling preferences: text/plain (a type-only copy's text, else the SVG markup with copyAsSvg when the images it embeds total at most 1 MiB), image/svg+xml (copyAsSvg), application/pdf (copyAsPdf), image/png (always; PDF and PNG only for objects with an area); under read roots, SVG and its markup as text are left out when clipboard.exportSvg would refuse; the app publishes them on Copy and Cut",
always,
flavours
),
@@ -369,13 +369,20 @@ impl Session {
/// The MIME types of [`Self::clipboard_flavours`], without making them.
pub fn clipboard_flavour_types(&self) -> Vec<&'static str> {
self.clipboard.flavour_types(self.prefs.copy_as_svg, self.prefs.copy_as_pdf)
self.clipboard.flavour_types(self.clipboard_svg_offered(), self.prefs.copy_as_pdf)
}
/// What Copy offers other apps, best first (see `clipboard.flavours`): [`Clipboard::flavours`]
/// by the Clipboard Handling preferences.
/// by the Clipboard Handling preferences, without the SVG (and the SVG markup as text) that
/// [`Self::clipboard_svg_refused`] withholds from the caller asking now.
pub fn clipboard_flavours(&self) -> Vec<Flavour> {
self.clipboard.flavours(self.prefs.copy_as_svg, self.prefs.copy_as_pdf)
self.clipboard.flavours(self.clipboard_svg_offered(), self.prefs.copy_as_pdf)
}
/// Does Copy offer the SVG: Include SVG Code is on and the SVG is not withheld from the caller
/// asking now.
fn clipboard_svg_offered(&self) -> bool {
self.prefs.copy_as_svg && !self.clipboard_svg_refused()
}
/// Replace the clipboard with `clip`, centred on `p`'s `center` (default: the first
@@ -766,6 +766,8 @@ pub struct SymbolOptions {
pub export_type: SymbolExportType,
/// 9-slice guides (`None`: 9-slice scaling off).
pub nine_slice: Option<SymbolNineSlice>,
/// Align to Pixel Grid.
pub pixel_aligned: bool,
}
impl SymbolOptions {
@@ -776,6 +778,7 @@ impl SymbolOptions {
registration: d.symbol_registration(name),
export_type: d.symbol_export_type(name),
nine_slice: d.symbol_nine_slice(name),
pixel_aligned: d.symbol_pixel_aligned(name),
}
}
@@ -785,6 +788,7 @@ impl SymbolOptions {
d.set_symbol_registration(name, self.registration);
d.set_symbol_export_type(name, self.export_type);
d.set_symbol_nine_slice(name, self.nine_slice);
d.set_symbol_pixel_aligned(name, self.pixel_aligned);
}
}
+21 -3
View File
@@ -26,7 +26,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Ellipse",
[],
None,
"{x, y, width, height, rotation?: deg clockwise about the centre (0: upright)} → {id}",
"{x, y, width, height, rotation?: deg clockwise about the centre (0: upright), anchors=4 (2–1000: smooth anchors spaced evenly by angle; any count but 4 draws a plain path, not a live ellipse)} → {id}",
has_doc,
ellipse
),
@@ -362,10 +362,28 @@ fn rectangle(s: &mut Session, p: &Value) -> Result<Value> {
add_art_turned(s, label, path_kind(live.to_path(), Some(live)), f64_or(p, "rotation", 0.0))
}
/// The most anchors `shape.ellipse` draws, as many as a polygon's sides.
const MAX_ELLIPSE_ANCHORS: u64 = 1000;
fn ellipse(s: &mut Session, p: &Value) -> Result<Value> {
let r = rect_of(p, "shape.ellipse")?;
let live = LiveShape::Ellipse { w: r.width(), h: r.height(), pie: (0.0, 360.0), xf: rect_transform(r, p, "shape.ellipse")? };
add_art_turned(s, "Ellipse", path_kind(live.to_path(), Some(live)), f64_or(p, "rotation", 0.0))
// One message for every number that is not a whole count in range (a fraction, a negative,
// 0, 1, too many); a value that is not a number gets `number_or`'s.
let (key, min, max) = ("anchors", 2, MAX_ELLIPSE_ANCHORS);
let n = number_or(p, key, 4.0, "shape.ellipse")?;
if n.fract() != 0.0 || !(min as f64..=max as f64).contains(&n) {
return Err(bad("shape.ellipse", format!("`{key}` must be a whole number between {min} and {max} (got {n})")));
}
let x = n as u64;
let xf = rect_transform(r, p, "shape.ellipse")?;
let rotation = f64_or(p, "rotation", 0.0);
if x != 4 {
// Another count is a plain path: a live ellipse always has 4 anchors.
let path = shapes::ellipse_with_anchors(Rect::new(0.0, 0.0, r.width(), r.height()), x as u32).transformed(xf);
return add_art_turned(s, "Ellipse", path_kind(path, None), rotation);
}
let live = LiveShape::Ellipse { w: r.width(), h: r.height(), pie: (0.0, 360.0), xf };
add_art_turned(s, "Ellipse", path_kind(live.to_path(), Some(live)), rotation)
}
/// The whole-number count `p` gives for `key` (`5` or `5.0`), or `default` when it is left out or
+6 -7
View File
@@ -631,13 +631,12 @@ impl LiquifyStroke {
}
let msg = (!ids.is_empty()).then(|| {
let n = ids.len();
format!(
"{} left {n} object{} under the brush as {} ({}): it reshapes paths only",
self.prm.kind.label(),
if n == 1 { "" } else { "s" },
if n == 1 { "it was" } else { "they were" },
kinds.join(", ")
)
let (tool, kinds) = (self.prm.kind.label(), kinds.join(", "));
if n == 1 {
format!("{tool} left {n} object under the brush as it was ({kinds}): it reshapes paths only")
} else {
format!("{tool} left {n} objects under the brush as they were ({kinds}): it reshapes paths only")
}
});
(ids, msg)
}
+27
View File
@@ -270,6 +270,33 @@ pub fn specs() -> Vec<CommandSpec> {
has_doc,
super::fileinfo::file_info
),
cmd!(
"file.info.saveTemplate",
"Save Metadata Template…",
[],
None,
"{name?: save into the metadata templates folder as <name>.xmp (a name with characters file systems reject, a dot at either end, or a device name is an error (spaces at either end are dropped); the same name replaces that template), path?: save to this file instead (not both), fields?: {File Info fields as file.info takes them} save these instead of the document's (default: the document's File Info)} write the File Info as an XMP metadata template: title (only one of its own, not Untitled-N), author, authorTitle, description, keywords, rating (1–5), copyrightStatus, copyrightNotice and copyrightUrl, each where it has a value; the dates are left out → {name, path} (with name), {path} (with path), or {data: the XMP text} with neither",
has_doc,
super::fileinfo::save_template
),
cmd!(
"file.info.applyTemplate",
"Import Metadata Template…",
[],
None,
"{path?: an XMP file, name?: a template of the metadata templates folder by the name or file file.info.templates lists, data?: XMP text (exactly one of the three; at most 8 MB), mode: \"replace\" (clear the author, authorTitle, description, keywords, rating, copyright status, notice and URL, then take the template's; the title stays unless the template has one) | \"keep\" (keep the File Info, and take each field the template has) | \"append\" (keep the File Info, add the template's keywords, and take its other fields only where the File Info has none: a title only over an Untitled-N one, a rating only over 0, a copyright status only over unknown), apply?: true (false: change nothing and return the merged File Info), base?: {File Info fields as file.info takes them} merged into instead of the document's} merge a metadata template into the File Info in one undo step, none when nothing changes; a template value file.info would refuse is left out; a missing file, a file larger than 8 MB or one that is not XMP is an error → the File Info as file.info reports it, with changed: true|false (with apply: false, the merged File Info without changed)",
has_doc,
super::fileinfo::apply_template
),
cmd!(
query "file.info.templates",
"Metadata Templates",
[],
None,
"{create?: false (true: make the folder when it is missing)} the metadata templates in the metadata templates folder next to the preferences, sorted by name, at most 1,000 → {templates: [{name, file: the file name, path}], folder?: the folder (left out for a request that may not read it, in runs without preferences and on the web, where the list is empty)}",
super::always,
super::fileinfo::templates
),
]
}
+1 -1
View File
@@ -92,7 +92,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Eraser",
[],
None,
"{points: [[x,y]…] or [[x,y,pressure]…] or [[x,y,pressure,tiltX,tiltY,rotation]…] (pen pressure 0..1, tilt −90..90°, barrel rotation ° clockwise, as path.freehand), size?: pt (10), angle?: ° (0: the tip's long axis counter-clockwise from level), roundness?: % (100, kept within 1–100), angleMode?, roundnessMode?, sizeMode?: \"fixed\" (default) | \"random\" | \"pressure\" | \"tilt\" | \"bearing\" | \"rotation\" (Eraser Tool Options' variation menus; a varied angle turns either way, clockwise or counter-clockwise), angleVariation?: ° (0–180, default 0, either way: clockwise or counter-clockwise), roundnessVariation?: % (0–100, default 0), sizeVariation?: pt (0 or more, default 0)} erase the stroke of an elliptical tip from paths (selected, or all) → {ids}. The tip is `size` across its long axis, which runs at `angle` counter-clockwise from horizontal; its short axis is `roundness` percent of the long one. A value whose mode is not fixed varies by up to its variation either way: random draws one value for the drag; pressure goes from the value less the variation where the pen presses lightest to the value plus it where it presses hardest (size on pressure as path.blob); tilt from less with the pen lying flat to more with it upright; bearing and rotation from less at −180° to more at 180° of the pen's lean direction or barrel turn. A drag without that pen reading (a mouse) erases at the value itself. An unknown mode, or a variation below 0 or past its range, is an error and erases nothing",
"{points: [[x,y]…] or [[x,y,pressure]…] or [[x,y,pressure,tiltX,tiltY,rotation]…] (pen pressure 0..1, tilt −90..90°, barrel rotation ° clockwise, as path.freehand), size?: pt (10), angle?: ° (0: the tip's long axis counter-clockwise from level), roundness?: % (100, kept within 1–100), angleMode?, roundnessMode?, sizeMode?: \"fixed\" (default) | \"random\" | \"pressure\" | \"tilt\" | \"bearing\" | \"rotation\" (Eraser Tool Options' variation menus; a varied angle turns either way, clockwise or counter-clockwise), angleVariation?: ° (0–180, default 0, either way: clockwise or counter-clockwise), roundnessVariation?: % (0–100, default 0), sizeVariation?: pt (0 or more, default 0)} or {rect: [x, y, width, height] (pt; the Eraser's Alt-drag marquee)} erase the stroke of an elliptical tip from paths (selected, or all) → {ids}. The tip is `size` across its long axis, which runs at `angle` counter-clockwise from horizontal; its short axis is `roundness` percent of the long one. A value whose mode is not fixed varies by up to its variation either way: random draws one value for the drag; pressure goes from the value less the variation where the pen presses lightest to the value plus it where it presses hardest (size on pressure as path.blob); tilt from less with the pen lying flat to more with it upright; bearing and rotation from less at −180° to more at 180° of the pen's lean direction or barrel turn. A drag without that pen reading (a mouse) erases at the value itself. An unknown mode, or a variation below 0 or past its range, is an error and erases nothing. `rect` in place of `points` erases everything inside the rectangle: closed paths lose its area, and open paths are cut where they cross its edges; the tip's size, angle, roundness and variations do not apply. A width or height of 0 or less, a value that is not a finite number, or `points` and `rect` together is an error. When nothing is erased, no undo step is added",
has_doc,
erase_region
),
+76 -6
View File
@@ -3,9 +3,10 @@ use super::common::{
samples_param, sibling_with, size_pressure, target_paths, usize_opt,
};
use super::{
Anchor, AnchorKind, Beside, BezPath, BoolOp, Cap, EngineError, FillRule, Join, NodeId, Paint, ParamCurve, PathData, Point, Result, Session,
Anchor, AnchorKind, Beside, BezPath, BoolOp, Cap, EngineError, FillRule, Join, NodeId, Paint, ParamCurve, PathData, Point, Rect, Result, Session,
SubPath, Value, Vec2, bad, eraser_area, eraser_tip, f64_or, fill_contains, json, number_or, object_param, po,
};
use kurbo::{CubicBez, Line, PathSeg};
use vectorcraft_brush::{Brush, BrushKind, Calligraphic, Variation};
use vectorcraft_doc::StrokeLayer;
use vectorcraft_tools::draw2::MIN_BRUSH_SIZE;
@@ -46,8 +47,8 @@ pub(in super::super) fn components(pd: &PathData) -> Vec<PathData> {
/// The pieces of `sp` where `remove(point)` is false. `None` when nothing is removed. Each segment
/// is sampled at least every `step` pt (and at least 24 times), so a removed stretch at least
/// `step` long is found.
fn cut_subpath(sp: &SubPath, step: f64, remove: &dyn Fn(Point) -> bool) -> Option<Vec<SubPath>> {
/// `step` long is found, and also at the parameters `extra` gives for it.
fn cut_subpath(sp: &SubPath, step: f64, remove: &dyn Fn(Point) -> bool, extra: &dyn Fn(CubicBez) -> Vec<f64>) -> Option<Vec<SubPath>> {
let nseg = sp.segment_count();
if nseg == 0 {
return sp.anchors.first().filter(|a| remove(a.p)).map(|_| vec![]);
@@ -64,6 +65,13 @@ fn cut_subpath(sp: &SubPath, step: f64, remove: &dyn Fn(Point) -> bool) -> Optio
let edge = (c.p1 - c.p0).hypot().max((c.p2 - c.p1).hypot()).max((c.p3 - c.p2).hypot());
let wanted = (3.0 * edge / step).ceil();
let samples = if wanted.is_finite() && wanted > K as f64 { (wanted as usize).min(MAX_SAMPLES) } else { K };
let mut ts: Vec<f64> = (1..=samples).map(|k| k as f64 / samples as f64).collect();
let more = extra(c);
if !more.is_empty() {
ts.extend(more.into_iter().filter(|t| t.is_finite() && *t > 0.0 && *t < 1.0));
ts.sort_by(f64::total_cmp);
ts.dedup();
}
let mut prev_t = 0.0;
let mut prev_rm = remove(c.eval(0.0));
let mut start = if prev_rm { None } else { Some(0.0) };
@@ -73,8 +81,7 @@ fn cut_subpath(sp: &SubPath, step: f64, remove: &dyn Fn(Point) -> bool) -> Optio
runs.push(std::mem::take(&mut cur));
}
}
for k in 1..=samples {
let t = k as f64 / samples as f64;
for t in ts {
let rm = remove(c.eval(t));
if rm != prev_rm {
let (mut lo, mut hi) = (prev_t, t);
@@ -146,10 +153,15 @@ fn cut_subpath(sp: &SubPath, step: f64, remove: &dyn Fn(Point) -> bool) -> Optio
/// every `step` pt (`f64::INFINITY` for the fixed sampling). Returns the new geometry per output
/// object (one object per piece when the path had a single subpath), or None if unchanged.
pub(in super::super) fn erase_outline(pd: &PathData, step: f64, remove: &dyn Fn(Point) -> bool) -> Option<Vec<PathData>> {
erase_outline_at(pd, step, remove, &|_| vec![])
}
/// [`erase_outline`], also sampling each segment at the parameters `extra` gives for it.
fn erase_outline_at(pd: &PathData, step: f64, remove: &dyn Fn(Point) -> bool, extra: &dyn Fn(CubicBez) -> Vec<f64>) -> Option<Vec<PathData>> {
let mut changed = false;
let mut subs = vec![];
for sp in &pd.subpaths {
match cut_subpath(sp, step, remove) {
match cut_subpath(sp, step, remove, extra) {
Some(pieces) => {
changed = true;
subs.extend(pieces);
@@ -274,6 +286,12 @@ pub(super) fn knife(s: &mut Session, p: &Value) -> Result<Value> {
pub(super) fn erase_region(s: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "path.eraseRegion";
if let Some(rect) = p.get("rect").filter(|v| !v.is_null()) {
if p.get("points").is_some_and(|v| !v.is_null()) {
return Err(bad(C, "give `points` or `rect`, not both"));
}
return erase_rect(s, marquee_param(rect, C)?);
}
let samples = samples_param(p, "points", C)?;
let size = number_or(p, "size", 10.0, C)?;
if !(size.is_finite() && size > 0.0) {
@@ -325,6 +343,58 @@ pub(super) fn erase_region(s: &mut Session, p: &Value) -> Result<Value> {
apply_plan(s, "Eraser", plan)
}
/// `path.eraseRegion`'s `rect: [x, y, width, height]`: four finite numbers, with a width and a
/// height above 0.
fn marquee_param(v: &Value, cmd: &str) -> Result<Rect> {
const SHAPE: &str = "rect is [x, y, width, height] in points, with a width and a height above 0";
let n: Vec<f64> = match v.as_array() {
Some(a) if a.len() == 4 => a.iter().map(Value::as_f64).collect::<Option<_>>().ok_or_else(|| bad(cmd, SHAPE))?,
_ => return Err(bad(cmd, SHAPE)),
};
let [x, y, w, h] = [n[0], n[1], n[2], n[3]];
if !(n.iter().all(|v| v.is_finite()) && w > 0.0 && h > 0.0 && (x + w).is_finite() && (y + h).is_finite()) {
return Err(bad(cmd, SHAPE));
}
Ok(Rect::new(x, y, x + w, y + h))
}
/// `path.eraseRegion` with a marquee: everything inside `r` is erased from the paths (selected, or
/// all). Closed paths lose the rectangle's area, and open paths are cut where they cross its edges.
fn erase_rect(s: &mut Session, r: Rect) -> Result<Value> {
let region =
PathData::single(SubPath::polyline(&[Point::new(r.x0, r.y0), Point::new(r.x1, r.y0), Point::new(r.x1, r.y1), Point::new(r.x0, r.y1)], true));
let inside = |q: Point| q.x >= r.x0 && q.x <= r.x1 && q.y >= r.y0 && q.y <= r.y1;
// An open path is sampled at least every half of the rectangle's shorter side, and also where
// each segment crosses the rectangle's edges and halfway between those crossings, so a stretch
// inside the rectangle is found however long the segment is.
let step = r.width().min(r.height()) / 2.0;
let corners = [Point::new(r.x0, r.y0), Point::new(r.x1, r.y0), Point::new(r.x1, r.y1), Point::new(r.x0, r.y1)];
let crossings = |c: CubicBez| {
let mut ts: Vec<f64> = (0..4)
.flat_map(|k| PathSeg::Cubic(c).intersect_line(Line::new(corners[k], corners[(k + 1) % 4])))
.map(|x| x.segment_t)
.filter(|t| t.is_finite() && *t > 0.0 && *t < 1.0)
.collect();
ts.sort_by(f64::total_cmp);
let mids: Vec<f64> = [0.0].iter().chain(&ts).zip(ts.iter().chain(&[1.0])).map(|(a, b)| 0.5 * (a + b)).collect();
ts.extend(mids);
ts
};
let st = s.doc()?;
let mut plan: Vec<(NodeId, Vec<PathData>)> = vec![];
for (id, pd, rule) in fill_targets(&st.doc, &st.selection, r)? {
if pd.is_closed() {
if po::area(&po::boolean(&pd, rule, &region, FillRule::NonZero, BoolOp::Intersect), FillRule::NonZero) <= 1e-6 {
continue;
}
plan.push((id, components(&po::boolean(&pd, rule, &region, FillRule::NonZero, BoolOp::Difference))));
} else if let Some(pieces) = erase_outline_at(&pd, step, &inside, &crossings) {
plan.push((id, pieces));
}
}
apply_plan(s, "Eraser", plan)
}
/// The variation modes `path.eraseRegion` takes for each of `angleMode`, `roundnessMode` and
/// `sizeMode`.
const ERASER_MODES: &str = "\"fixed\", \"random\", \"pressure\", \"tilt\", \"bearing\" or \"rotation\"";
+321 -13
View File
@@ -3,14 +3,28 @@
//! title is the one the file the document was opened from gave itself ([`DocMetadata::title`]),
//! else the document's name. The SVG (with `metadata`), PDF and PNG writers carry it, and a PDF or
//! `.ai` opens with the File Info it gives ([`read_pdf`]).
//!
//! Metadata templates: `file.info.saveTemplate` writes the File Info as an XMP file
//! ([`vectorcraft_pdf::metadata_template`]), `file.info.applyTemplate` merges one into the File
//! Info, and `file.info.templates` lists those in the metadata templates folder.
use serde_json::{Map, Value, json};
use vectorcraft_doc::metadata::{MAX_RATING, iso8601};
use vectorcraft_doc::{ColorMode, CopyrightStatus, DocMetadata, Document};
use super::{Result, Session, bad};
use super::{Result, Session, bad, switch_or, text_param};
const C: &str = "file.info";
const SAVE: &str = "file.info.saveTemplate";
const APPLY: &str = "file.info.applyTemplate";
const LIST: &str = "file.info.templates";
/// The extension of a metadata template file.
const TEMPLATE_EXT: &str = "xmp";
/// The most templates `file.info.templates` lists.
const MAX_LISTED: usize = 1000;
/// The largest metadata template `file.info.saveTemplate` writes and `file.info.applyTemplate`
/// reads, in bytes (8 MB). The largest template File Info's fields can give is under 4 MB.
const MAX_TEMPLATE_FILE: usize = vectorcraft_pdf::MAX_TEMPLATE_BYTES;
/// Longest text field, in characters.
const MAX_TEXT: usize = 65_536;
/// Longest keyword, in characters.
@@ -21,9 +35,13 @@ const READ_ONLY: [&str; 6] = ["created", "modified", "colorMode", "units", "artb
/// What `file.info` reports (and takes back).
pub(crate) fn info_json(d: &Document) -> Value {
let m = &d.metadata;
info_json_with(d, d.info_title(), &d.metadata)
}
/// [`info_json`] with the title `title` and the metadata `m` in place of the document's.
fn info_json_with(d: &Document, title: &str, m: &DocMetadata) -> Value {
json!({
"title": d.info_title(),
"title": title,
"author": m.author,
"authorTitle": m.author_title,
"description": m.description,
@@ -48,11 +66,25 @@ pub(crate) fn file_info(s: &mut Session, p: &Value) -> Result<Value> {
Value::Object(o) => o,
_ => return Err(bad(C, "params must be an object")),
};
let (title, m) = edited(s, Some(o))?;
commit(s, title, m)?;
Ok(info_json(&s.doc()?.doc))
}
/// The active document's File Info title and metadata with `fields` (as `file.info` takes them)
/// applied.
fn edited(s: &Session, fields: Option<&Map<String, Value>>) -> Result<(String, DocMetadata)> {
let d = &s.doc()?.doc;
let (mut title, mut m) = (d.info_title().to_string(), d.metadata.clone());
for (k, v) in o {
for (k, v) in fields.into_iter().flatten() {
apply(&mut title, &mut m, k, v)?;
}
Ok((title, m))
}
/// Make `title` and `m` the active document's File Info in one undo step; nothing is recorded when
/// they are what it has. Whether anything changed.
fn commit(s: &mut Session, title: String, mut m: DocMetadata) -> Result<bool> {
let d = &s.doc()?.doc;
// A title File Info changes becomes the document's own, as it always has (the tab and Save As
// offer it where the document has no file), and replaces the one its file gave.
@@ -60,16 +92,290 @@ pub(crate) fn file_info(s: &mut Session, p: &Value) -> Result<Value> {
if retitled {
m.title = None;
}
if retitled || m != d.metadata {
s.edit("File Info", |d, _| {
if retitled {
d.title = title;
}
d.metadata = m;
Ok(())
})?;
if !retitled && m == d.metadata {
return Ok(false);
}
Ok(info_json(&s.doc()?.doc))
s.edit("File Info", |d, _| {
if retitled {
d.title = title;
}
d.metadata = m;
Ok(())
})?;
Ok(true)
}
/// The optional object `p` gives for `key`.
fn fields_param<'a>(p: &'a Value, key: &str, c: &str) -> Result<Option<&'a Map<String, Value>>> {
match p.get(key) {
None | Some(Value::Null) => Ok(None),
Some(Value::Object(o)) => Ok(Some(o)),
Some(_) => Err(bad(c, format!("`{key}` must be an object"))),
}
}
impl Session {
/// Have `file.info.saveTemplate`, `file.info.applyTemplate` and `file.info.templates` keep the
/// metadata templates in the folder `dir`, which a save makes when it is missing.
pub fn attach_metadata_templates_dir(&mut self, dir: std::path::PathBuf) {
self.metadata_templates_dir = Some(dir);
}
/// The metadata templates folder ([`Session::attach_metadata_templates_dir`]); none on the web,
/// which has no folders.
pub fn metadata_templates_dir(&self) -> Option<&std::path::Path> {
self.metadata_templates_dir.as_deref().filter(|_| !cfg!(target_arch = "wasm32"))
}
}
/// The metadata template of the File Info `title` and `m`: each field that has a value, the title
/// only where it is one of its own ([`super::fileio::is_own_title`]), the rating only from 1 up.
fn template_of(title: &str, m: &DocMetadata) -> vectorcraft_pdf::FileInfo {
let text = |s: &str| (!s.trim().is_empty()).then(|| s.to_string());
vectorcraft_pdf::FileInfo {
title: super::fileio::is_own_title(title).then(|| title.to_string()),
author: text(&m.author),
author_title: text(&m.author_title),
description: text(&m.description),
keywords: (!m.keywords.is_empty()).then(|| m.keywords.clone()),
rating: (m.rating > 0).then_some(m.rating),
copyright_notice: text(&m.copyright_notice),
copyright_url: text(&m.copyright_url),
copyrighted: match m.copyright_status {
CopyrightStatus::Copyrighted => Some(true),
CopyrightStatus::PublicDomain => Some(false),
CopyrightStatus::Unknown => None,
},
..Default::default()
}
}
/// The path of the template `name` in the folder `dir`: `name` made a safe file name, with
/// [`TEMPLATE_EXT`].
fn template_path(dir: &std::path::Path, name: &str, c: &str) -> Result<String> {
let name = name.trim();
if name.is_empty() {
return Err(bad(c, "the template name can't be empty"));
}
Ok(dir.join(super::swatchlib::library_file_name(name, TEMPLATE_EXT)).to_string_lossy().into_owned())
}
/// The error for a template over [`MAX_TEMPLATE_FILE`].
fn too_big(c: &str) -> crate::EngineError {
bad(c, format!("the file is larger than {} MB", MAX_TEMPLATE_FILE >> 20))
}
/// File Info › Save Metadata Template: `file.info.saveTemplate {name?, path?, fields?}`.
pub(crate) fn save_template(s: &mut Session, p: &Value) -> Result<Value> {
let name = text_param(p, "name", SAVE)?;
let path = text_param(p, "path", SAVE)?;
let (title, m) = edited(s, fields_param(p, "fields", SAVE)?)?;
let xmp = vectorcraft_pdf::metadata_template(&template_of(&title, &m));
if xmp.len() > MAX_TEMPLATE_FILE {
return Err(too_big(SAVE));
}
match (name, path) {
(Some(_), Some(_)) => Err(bad(SAVE, "give `name` or `path`, not both")),
(Some(name), None) => {
let dir = s.metadata_templates_dir().ok_or_else(|| bad(SAVE, "no metadata templates folder here"))?.to_path_buf();
let path = template_path(&dir, name, SAVE)?;
// The name is the file name as it is, so two names never share a file.
let listed = std::path::Path::new(&path).file_stem().map(|s| s.to_string_lossy().into_owned());
if listed.as_deref() != Some(name.trim()) {
return Err(bad(SAVE, "the template name isn't usable as a file name"));
}
// Only a file in the folder itself is replaced: a link there is not followed.
if std::fs::symlink_metadata(&path).is_ok_and(|m| !m.is_file()) {
return Err(crate::EngineError::Other(format!("{path}: not a file")));
}
let dir = dir.to_string_lossy().into_owned();
// The app's own folder, under a name checked above: no root applies.
crate::file_access::unconfined(|| super::fileio::create_dir(&dir).and_then(|()| super::fileio::write_file(&path, xmp.as_bytes())))?;
Ok(json!({ "name": listed, "path": super::fileio::shown_path(&path) }))
}
(None, Some(path)) => {
super::fileio::write_file(path, xmp.as_bytes())?;
Ok(json!({ "path": path }))
}
(None, None) => Ok(json!({ "data": xmp })),
}
}
/// How `file.info.applyTemplate` merges a template's fields into the File Info.
#[derive(Clone, Copy, PartialEq, Eq)]
enum Merge {
/// Clear the fields a template can hold, then take the template's.
Replace,
/// Keep the fields, and take each one the template gives.
Keep,
/// Keep the fields: add the template's keywords, and take its other fields only where the File
/// Info has none.
Append,
}
/// File Info › Import: `file.info.applyTemplate {path?|name?|data?, mode, apply?, base?}`.
pub(crate) fn apply_template(s: &mut Session, p: &Value) -> Result<Value> {
let mode = match text_param(p, "mode", APPLY)? {
Some("replace") => Merge::Replace,
Some("keep") => Merge::Keep,
Some("append") => Merge::Append,
_ => return Err(bad(APPLY, "mode must be replace, keep or append")),
};
let apply = switch_or(p, "apply", true, APPLY)?;
let base = fields_param(p, "base", APPLY)?;
let bytes = template_bytes(s, p)?;
let t = vectorcraft_pdf::read_template(&bytes).ok_or_else(|| bad(APPLY, "the file is not an XMP metadata template"))?;
let (mut title, mut m) = edited(s, base)?;
merge(&mut title, &mut m, t, mode);
if !apply {
return Ok(info_json_with(&s.doc()?.doc, &title, &m));
}
let changed = commit(s, title, m)?;
let mut out = info_json(&s.doc()?.doc);
out["changed"] = json!(changed);
Ok(out)
}
/// The bytes of the template `p` names: `path`, `name` (in the metadata templates folder) or
/// `data`, exactly one, at most [`MAX_TEMPLATE_FILE`] long.
fn template_bytes(s: &Session, p: &Value) -> Result<Vec<u8>> {
let given = [text_param(p, "path", APPLY)?, text_param(p, "name", APPLY)?, text_param(p, "data", APPLY)?];
// At most one byte past the limit is read, so a huge file is never read whole.
let read = |path: &str| super::fileio::read_file_head(path, MAX_TEMPLATE_FILE + 1);
let bytes = match given {
[Some(path), None, None] => read(path)?,
[None, Some(name), None] => {
let dir = s.metadata_templates_dir().ok_or_else(|| bad(APPLY, "no metadata templates folder here"))?;
let mut path = template_path(dir, name, APPLY)?;
// A template `file.info.templates` lists: by its `file` first, then by its `name` with
// the extension in lowercase, then in other letter case. Only files in the folder itself
// are listed: a link there is not followed.
let name = name.trim();
let own = format!("{name}.{TEMPLATE_EXT}");
let listed = template_files(dir)
.filter(|f| f == name || f.rsplit_once('.').is_some_and(|(stem, _)| stem == name))
.min_by_key(|f| (f != name, *f != own));
if let Some(file) = listed {
path = dir.join(file).to_string_lossy().into_owned();
} else if std::path::Path::new(&path).file_stem().map(|s| s.to_string_lossy()).as_deref() != Some(name) {
// A name that is not a file name as it is never opens another template.
return Err(bad(APPLY, "the template name isn't usable as a file name"));
}
let plain_file = |path: &str| std::fs::symlink_metadata(path).is_ok_and(|m| m.is_file());
if std::fs::symlink_metadata(&path).is_ok() && !plain_file(&path) {
return Err(crate::EngineError::Other(format!("{path}: not a file")));
}
// The app's own folder: no root applies.
crate::file_access::unconfined(|| read(&path))?
}
[None, None, Some(data)] if data.len() > MAX_TEMPLATE_FILE => return Err(too_big(APPLY)),
[None, None, Some(data)] => data.as_bytes().to_vec(),
_ => return Err(bad(APPLY, "give one of `path`, `name` and `data`")),
};
if bytes.len() > MAX_TEMPLATE_FILE {
return Err(too_big(APPLY));
}
Ok(bytes)
}
/// Merge the template `t` into the File Info `title` and `m` as `mode` says. Each field goes in as
/// `file.info` would take it; a value it would refuse is left out.
fn merge(title: &mut String, m: &mut DocMetadata, t: vectorcraft_pdf::FileInfo, mode: Merge) {
if mode == Merge::Replace {
// The title is never cleared: a document always has one.
m.author.clear();
m.author_title.clear();
m.description.clear();
m.keywords.clear();
m.rating = 0;
m.copyright_status = CopyrightStatus::Unknown;
m.copyright_notice.clear();
m.copyright_url.clear();
}
let status = t.copyrighted.map(|c| if c { CopyrightStatus::Copyrighted } else { CopyrightStatus::PublicDomain });
let fields = [
("title", t.title.map(Value::from)),
("author", t.author.map(Value::from)),
("authorTitle", t.author_title.map(Value::from)),
("description", t.description.map(Value::from)),
("keywords", t.keywords.map(Value::from)),
("rating", t.rating.map(Value::from)),
("copyrightStatus", status.map(|s| Value::from(s.id()))),
("copyrightNotice", t.copyright_notice.map(Value::from)),
("copyrightUrl", t.copyright_url.map(Value::from)),
];
for (k, v) in fields {
let Some(mut v) = v else { continue };
if mode == Merge::Append {
let empty = match k {
"title" => !super::fileio::is_own_title(title),
"author" => m.author.is_empty(),
"authorTitle" => m.author_title.is_empty(),
"description" => m.description.is_empty(),
"rating" => m.rating == 0,
"copyrightStatus" => m.copyright_status == CopyrightStatus::Unknown,
"copyrightNotice" => m.copyright_notice.is_empty(),
"copyrightUrl" => m.copyright_url.is_empty(),
_ => true,
};
if !empty {
continue;
}
if k == "keywords" {
let mut all: Vec<Value> = m.keywords.iter().cloned().map(Value::from).collect();
all.extend(v.as_array().cloned().unwrap_or_default());
v = Value::from(all);
}
}
// `apply` changes the field only when it takes the value.
let _ = apply(title, m, k, &v);
}
}
/// The file names of the templates in the folder `dir`: its files with a name before the
/// [`TEMPLATE_EXT`] extension, in any case. The app's own folder, read directly; a folder not made
/// yet holds none.
fn template_files(dir: &std::path::Path) -> impl Iterator<Item = String> {
std::fs::read_dir(dir)
.into_iter()
.flatten()
.flatten()
.filter(|e| e.file_type().is_ok_and(|t| t.is_file()))
.map(|e| e.file_name().to_string_lossy().into_owned())
.filter(|file| file.rsplit_once('.').is_some_and(|(stem, ext)| ext.eq_ignore_ascii_case(TEMPLATE_EXT) && !stem.is_empty()))
}
/// `file.info.templates {create?}`: the metadata templates in the folder, by name.
pub(crate) fn templates(s: &mut Session, p: &Value) -> Result<Value> {
let create = switch_or(p, "create", false, LIST)?;
let Some(dir) = s.metadata_templates_dir().map(|d| d.to_string_lossy().into_owned()) else {
return Ok(json!({ "templates": [] }));
};
if create {
// The app's own folder: no root applies.
crate::file_access::unconfined(|| super::fileio::create_dir(&dir))?;
}
// The first [`MAX_LISTED`] by name, with no more than that many held at once.
let mut files = std::collections::BTreeSet::new();
for file in template_files(std::path::Path::new(&dir)) {
files.insert(file);
if files.len() > MAX_LISTED {
files.pop_last();
}
}
let list: Vec<Value> = files
.iter()
.filter_map(|file| {
let (stem, _) = file.rsplit_once('.')?;
let path = std::path::Path::new(&dir).join(file).to_string_lossy().into_owned();
Some(json!({ "name": stem, "file": file, "path": super::fileio::shown_path(&path) }))
})
.collect();
let mut out = json!({ "templates": list });
if super::fileio::shown_path(&dir) == dir.as_str() {
out["folder"] = json!(dir);
}
Ok(out)
}
/// The File Info a PDF or PDF-compatible `.ai` gives ([`vectorcraft_pdf::file_info`]) into `m`: each
@@ -79,8 +385,10 @@ pub(crate) fn read_pdf(m: &mut DocMetadata, f: vectorcraft_pdf::FileInfo) {
let status = f.copyrighted.map(|c| if c { CopyrightStatus::Copyrighted } else { CopyrightStatus::PublicDomain });
let fields = [
("author", f.author.map(Value::from)),
("authorTitle", f.author_title.map(Value::from)),
("description", f.description.map(Value::from)),
("keywords", f.keywords.map(Value::from)),
("rating", f.rating.map(Value::from)),
("copyrightStatus", status.map(|s| Value::from(s.id()))),
("copyrightNotice", f.copyright_notice.map(Value::from)),
("copyrightUrl", f.copyright_url.map(Value::from)),
+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, file_clipped, size_note};
pub(crate) use load::{MAX_RASTER_ALLOC, file_clipped, png_clip, size_note};
mod heifread;
mod hpgl;
mod jp2read;
+9 -3
View File
@@ -199,8 +199,12 @@ fn selected_part(n: &Arc<Node>, keep: &HashSet<NodeId>, holders: &HashSet<NodeId
/// out, at any depth of layers, sublayers and groups that don't clip, unless what the renderer
/// draws for them, their effects included ([`vectorcraft_render::effect_bounds`]), reaches it.
/// Objects that reach it stay whole (the file's bounds clip them), as DXF's crop leaves them.
/// Symbol instances are measured by their art, and the box of one whose art holds brushed strokes
/// grows by as far as their brush art can paint ([`SymbolBoxes::with_brush_art`]). An object that
/// Both boxes grow by the room brush art can paint past the brushed strokes of the object and of
/// the objects in it ([`vectorcraft_brush::reach_within`]: a clipping group or layer by its clipping
/// path's, a compound path by its own strokes'), so a brushed path just off `rect` stays when its
/// brush art reaches it. Symbol instances are measured by their art, and the box of one whose art
/// holds brushed strokes grows by as far as their brush art can paint
/// ([`SymbolBoxes::with_brush_art`]). An object that
/// holds a symbol instance also stays when what the canvas paints for it reaches `rect`
/// ([`vectorcraft_render::painted_bounds`]: the effects in the symbols' art and its own effects). A
/// clipping layer keeps every object, its clipping path among them. An artboard's file then holds
@@ -233,7 +237,9 @@ pub(super) fn art_over(doc: &Document, rect: vectorcraft_geom::Rect, renderer: &
let mut holds_instance = false;
n.walk(&mut |c| holds_instance |= matches!(c.kind, NodeKind::SymbolInstance { .. }));
let painted = || holds_instance && vectorcraft_render::painted_bounds(doc, n).is_some_and(over);
(n.visual_bounds_with(symbols).is_none_or(over) || renderer.effect_bounds(symbols, n).is_some_and(over) || painted()).then(|| n.clone())
let reach = vectorcraft_brush::reach_within(n);
let brushed = |b: vectorcraft_geom::Rect| over(if reach > 0.0 { b.inflate(reach, reach) } else { b });
(n.visual_bounds_with(symbols).is_none_or(brushed) || renderer.effect_bounds(symbols, n).is_some_and(brushed) || painted()).then(|| n.clone())
}
let symbols = doc.symbol_boxes().with_brush_art();
let mut d = doc.clone();
+48 -6
View File
@@ -73,8 +73,10 @@ pub struct RasterImage {
pub height: u32,
/// The resolution the file declares (see [`super::ppi::resolution`]).
pub ppi: Option<(f64, f64)>,
/// A DCS file's clipping path, in the image's pixel space ([`crate::cmd::place::dcs`]).
pub clip: Option<vectorcraft_geom::PathData>,
/// The clipping path its file draws it through, in the image's pixel space, with its fill rule:
/// a DCS file's (nonzero, [`crate::cmd::place::dcs`]), or a PSD or PSB file's (even-odd,
/// [`psdread::clipping_path`]).
pub clip: Option<(vectorcraft_geom::PathData, vectorcraft_geom::FillRule)>,
}
pub(super) fn err(e: impl std::fmt::Display) -> EngineError {
@@ -949,7 +951,8 @@ pub(crate) fn size_note(bytes: &[u8]) -> Option<String> {
/// or TIFF keeps its inks, at the 8 or 16 bits the file has, and its CMYK ICC profile as a CMYK
/// TIFF ([`vectorcraft_doc::cmyk::turned_cmyk`]). An image the decoder reads and that is stored as
/// PNG keeps its gray or RGB samples at 8 or 16 bits, and the gray or RGB ICC profile they are in;
/// other samples become 8-bit RGBA.
/// other samples become 8-bit RGBA. A Photoshop document's PNG keeps the clipping path the file
/// names ([`png_with_clip`]).
pub fn raster_image(bytes: &[u8]) -> Result<RasterImage> {
let ppi = super::ppi::resolution(bytes);
if let Some((w, h)) = vectorcraft_doc::cmyk::oversized_tiff(bytes) {
@@ -957,7 +960,8 @@ pub fn raster_image(bytes: &[u8]) -> Result<RasterImage> {
}
if psdread::is_psd(bytes) {
let cms = vectorcraft_color::cms::active();
return as_png(psdread::decode(bytes, MAX_RASTER_ALLOC, |c| cms.cmyk_to_srgb(c, false)).map_err(err)?, None, ppi);
let img = as_png(psdread::decode(bytes, MAX_RASTER_ALLOC, |c| cms.cmyk_to_srgb(c, false)).map_err(err)?, None, ppi)?;
return Ok(png_with_clip(img, psdread::clipping_path(bytes)));
}
if jxlread::is_jxl(bytes) {
let (img, icc, orientation) = jxlread::decode(bytes, MAX_RASTER_ALLOC).map_err(err)?;
@@ -1125,10 +1129,48 @@ fn stored(bytes: Vec<u8>, mime: &'static str, (width, height): (u32, u32), ppi:
Ok(RasterImage { key: blob.content_key(), blob, width, height, ppi, clip: None })
}
/// The keyword of the PNG text chunk holding the clipping path of the file a PNG was made from
/// ([`png_with_clip`]).
const CLIP_KEYWORD: &str = "VectorCraft clip";
/// Longest clipping path a PNG keeps (bytes of its JSON).
const MAX_PNG_CLIP: usize = 16 << 20;
/// `img`, a PNG made from a PSD or PSB file, with `clip`, the clipping path that file names in the
/// image's pixel space (even-odd): the image keeps it, and its PNG keeps it in a text chunk, so the
/// Links commands know a clip group of that path as the file's ([`png_clip`]). A path whose JSON is
/// longer than [`MAX_PNG_CLIP`] is left out, and the image comes in unclipped.
fn png_with_clip(mut img: RasterImage, clip: Option<vectorcraft_geom::PathData>) -> RasterImage {
let Some(clip) = clip else { return img };
let Some(json) = serde_json::to_string(&clip).ok().filter(|j| j.len() <= MAX_PNG_CLIP) else { return img };
let png = vectorcraft_render::encode::png::with_text(img.blob.bytes.to_vec(), &[(CLIP_KEYWORD, json.into())]);
img.blob = ImageBlob::new("image/png", png);
img.key = img.blob.content_key();
img.clip = Some((clip, vectorcraft_geom::FillRule::EvenOdd));
img
}
/// The clipping path a PNG made from a PSD or PSB file keeps ([`png_with_clip`]), in its pixel
/// space; `None` for other images, and for a text chunk longer than [`MAX_PNG_CLIP`] or a path
/// past [`vectorcraft_geom::path::MAX_READ_ANCHORS`]. Reads only the chunks before the image data.
pub(crate) fn png_clip(png: &[u8]) -> Option<vectorcraft_geom::PathData> {
if !png.starts_with(b"\x89PNG\r\n\x1a\n") {
return None;
}
let keyword = [CLIP_KEYWORD.as_bytes(), &[0]].concat();
let json = super::ppi::png_chunks(png)
.take_while(|(ty, _)| *ty != b"IDAT")
.find_map(|(ty, data)| data.strip_prefix(keyword.as_slice()).filter(|_| ty == b"tEXt"))?;
if json.len() > MAX_PNG_CLIP {
return None;
}
vectorcraft_geom::path::with_anchor_budget(vectorcraft_geom::path::MAX_READ_ANCHORS, || serde_json::from_slice(json).ok())
}
/// An image as a document of its physical size at the resolution it declares (as Place sizes it;
/// 72 ppi, 1 px = 1 pt, when it declares none), the image named after the file.
pub(super) fn raster_doc(name: &str, bytes: &[u8]) -> Result<Document> {
let RasterImage { key, blob, width, height, ppi, .. } = raster_image(bytes)?;
let RasterImage { key, blob, width, height, ppi, clip } = raster_image(bytes)?;
let (sx, sy) = crate::cmd::place::pt_per_px(ppi);
let mut d = Document::new(width as f64 * sx, height as f64 * sy);
let layer = d.layers[0].id;
@@ -1138,7 +1180,7 @@ pub(super) fn raster_doc(name: &str, bytes: &[u8]) -> Result<Document> {
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));
let mut n = file_clipped(&mut d, n, clip.map(|(path, _)| path));
n.name = Some(name.to_string());
d.images.insert(key, blob);
d.insert(Some(layer), 0, n).map_err(err)?;
+1 -1
View File
@@ -128,7 +128,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Export PDF",
[],
None,
"{path?, preset?: \"VectorCraft Default\" (built-in or saved: pdf.preset.list), artboard? | artboards?: [i…] | range?: \"1-3, 5\" (1-based; default all, one page each), useArtboards?: true (false: one page, the bounds of the visible art the page draws (non-printing layers left out unless includeNonPrinting or createLayers keeps them), as document.export writes it; artboard, artboards and range are then ignored, Preserve Editing is left out (with a warning when it is on), and a document with no visible art is refused), standard?: none|pdfA2b|pdfX1a (CMYK, grey and spot colours only: colours and images converted to output.destination or the CMYK output intent, untagged; transparency flattened with flattenerPreset; PDF 1.3)|pdfX3 (colours ICC-tagged; transparency flattened; PDF 1.3)|pdfX4 (transparency and layers kept; colours ICC-tagged; PDF 1.6 at most) (PDF/X: a /GTS_PDFX output intent, by default the CMYK profile in effect, embedded; TrimBox, Trapped, GTS_PDFXVersion, title and dates; fonts embedded or outlined), compatibility?: 1.3 (no transparency: it is flattened with flattenerPreset, without the layers the file leaves out; images keep no see-through pixels)|1.4|1.5|1.6|1.7 (default)|2.0 (choosing a standard sets its version: 1.7 for pdfA2b, 1.6 for pdfX4, 1.3 for pdfX1a and pdfX3, which write 1.4 as 1.3 too; pdfA2b refuses 1.3; in pdfA2b files, and with longPagesInPoints: false, a page with a side longer than 14,400 pt keeps its size with a UserUnit from 1.6 on: 1.5 is then written as 1.6, with 1.5's encryption, and so is 1.4 in pdfA2b files, with a warning; PDF/X files and other 1.3 and 1.4 files write it in points, and 1.3 and 1.4 (pdfX1a and pdfX3 too) refuse a page past 32,767 pt whose size or art needs a real number past 32,767; a page whose short side is 3 pt or longer but would be under 3 units at that UserUnit gets a smaller one that keeps the short side at 3 units; a warning gives each such page's size), longPagesInPoints?: true (such a page is written at its size in points, without a UserUnit, at every version, and 1.5 stays 1.5, in files without a standard (PDF/A files keep the UserUnit); apps that keep to the limit cut it to 200 in; false: the UserUnit as above, with a warning that names this option), preserveEditing? (on in VectorCraft Default: the native document as an embedded file, which document.open restores; choosing a standard turns it off, a standard refuses it), thumbnails? (each page drawn as a /Thumb image, 106 px on its long side), fastWebView? (a linearised file: the first page shows while the rest downloads; it stays linearised when encrypted), viewAfterSaving? (the app opens the written file), createLayers? (each layer and sublayer but template layers as a PDF layer, an optional content group listed under its layer's: hidden layers off, non-printing ones /PrintState /OFF, locked ones locked; needs 1.5 or later; they reopen as layers; choosing pdfX1a or pdfX3 turns it off; they refuse it), includeNonPrinting? (keep layers whose Print option is off; left out by default unless createLayers), flattenerPreset?: \"\" (High Resolution) | high | medium | low | a saved preset (flattener.presets.list): what PDF 1.3 files flatten transparency with, flattener?: {object.flattenTransparency options over it}, compression?: {color?, gray?: {downsample: none|average|subsample|bicubic, ppi: 300, abovePpi: 450, compression: none|zip|jpeg|jpeg2000|auto, quality: minimum|low|medium|high|maximum}, mono?: {downsample, ppi: 1200, abovePpi: 1800, compression: none|ccittG3|ccittG4|zip|runLength} (black-and-white images), compressText?: true} (images above abovePpi are resampled to ppi; auto keeps JPEGs JPEG, the others lossless; JPEG needs opaque images; none, jpeg2000, CCITT and runLength are written as ZIP with a warning), marks?: {trim, registration, colorBars, pageInfo, kind: roman|japanese, weight: 0.25 (trim marks and targets), offset: 6 (pt from the artboard, at least the bleed)} (printer's marks in [Registration], every plate: trim marks, registration targets mid-side, CMYK/spot/black-tint colour bars on top, page information (title, artboard, date UTC) below), bleed?: {useDocument (the document's bleed, document.setup), top, bottom, left, right} (pt; art in the bleed is kept; a PDF/X file with no bleed on a side where the document's bleed has one comes back with a warning). Each page: TrimBox = artboard, BleedBox = artboard + bleed, MediaBox = that + the marks' room (art clipped to the BleedBox), output?: {conversion: none (default)|destination (every colour into the destination profile's model, CMYK or RGB, also colours of that model in another profile)|preserveNumbers (only colours of the other model and Lab; those in the destination's model keep their numbers) (grey stays grey; images are converted too, and with destination and an sRGB destination a gray or RGB image tagged with an ICC profile is converted from it and written untagged; with destination and a CMYK destinatio Line truncated
"{path?, preset?: \"VectorCraft Default\" (built-in or saved: pdf.preset.list), artboard? | artboards?: [i…] | range?: \"1-3, 5\" (1-based; default all, one page each), useArtboards?: true (false: one page, the bounds of the visible art the page draws (non-printing layers left out unless includeNonPrinting or createLayers keeps them), as document.export writes it; artboard, artboards and range are then ignored, Preserve Editing is left out (with a warning when it is on), and a document with no visible art is refused), standard?: none|pdfA2b|pdfX1a (CMYK, grey and spot colours only: colours and images converted to output.destination or the CMYK output intent, untagged; transparency flattened with flattenerPreset; PDF 1.3)|pdfX3 (colours ICC-tagged; transparency flattened; PDF 1.3)|pdfX4 (transparency and layers kept; colours ICC-tagged; PDF 1.6 at most) (PDF/X: a /GTS_PDFX output intent, by default the CMYK profile in effect, embedded; TrimBox, Trapped, GTS_PDFXVersion, title and dates; fonts embedded or outlined), compatibility?: 1.3 (no transparency: it is flattened with flattenerPreset, without the layers the file leaves out; images keep no see-through pixels)|1.4|1.5|1.6|1.7 (default)|2.0 (choosing a standard sets its version: 1.7 for pdfA2b, 1.6 for pdfX4, 1.3 for pdfX1a and pdfX3, which write 1.4 as 1.3 too; pdfA2b refuses 1.3; in pdfA2b files, and with longPagesInPoints: false, a page with a side longer than 14,400 pt keeps its size with a UserUnit from 1.6 on: 1.5 is then written as 1.6, with 1.5's encryption, and so is 1.4 in pdfA2b files, with a warning; PDF/X files and other 1.3 and 1.4 files write it in points, and 1.3 and 1.4 (pdfX1a and pdfX3 too) refuse a page past 32,767 pt whose size or art needs a real number past 32,767; a page whose short side is 3 pt or longer but would be under 3 units at that UserUnit gets a smaller one that keeps the short side at 3 units; a warning gives each such page's size), longPagesInPoints?: true (such a page is written at its size in points, without a UserUnit, at every version, and 1.5 stays 1.5, in files without a standard (PDF/A files keep the UserUnit); apps that keep to the limit cut it to 200 in; false: the UserUnit as above, with a warning that names this option), preserveEditing? (on in VectorCraft Default: the native document as an embedded file, which document.open restores; choosing a standard turns it off, a standard refuses it), thumbnails? (each page drawn as a /Thumb image, 106 px on its long side), fastWebView? (a linearised file: the first page shows while the rest downloads; it stays linearised when encrypted), viewAfterSaving? (the app opens the written file), createLayers? (each layer and sublayer but template layers as a PDF layer, an optional content group listed under its layer's: hidden layers off, non-printing ones /PrintState /OFF, locked ones locked; needs 1.5 or later; they reopen as layers; choosing pdfX1a or pdfX3 turns it off; they refuse it), includeNonPrinting? (keep layers whose Print option is off; left out by default unless createLayers), flattenerPreset?: \"\" (High Resolution) | high | medium | low | a saved preset (flattener.presets.list): what PDF 1.3 files flatten transparency with, flattener?: {object.flattenTransparency options over it}, compression?: {color?, gray?: {downsample: none|average|subsample|bicubic, ppi: 300, abovePpi: 450, compression: none|zip|jpeg|jpeg2000|auto, quality: minimum|low|medium|high|maximum}, mono?: {downsample, ppi: 1200, abovePpi: 1800, compression: none|ccittG3|ccittG4|zip|runLength} (black-and-white images), compressText?: true} (images above abovePpi are resampled to ppi; auto keeps JPEGs JPEG, the others lossless; JPEG needs opaque images; none, jpeg2000, CCITT and runLength are written as ZIP with a warning), marks?: {trim, registration, colorBars, pageInfo, kind: roman|japanese, weight: 0.25 (trim marks and targets), offset: 6 (pt from the artboard, at least the bleed)} (printer's marks in [Registration], every plate: trim marks, registration targets mid-side, CMYK/spot/black-tint colour bars on top, page information (title, artboard, date UTC) below), bleed?: {useDocument (the document's bleed, document.setup), top, bottom, left, right} (pt; art in the bleed is kept; a PDF/X file with no bleed on a side where the document's bleed has one comes back with a warning). Each page: TrimBox = artboard, BleedBox = artboard + bleed, MediaBox = that + the marks' room (art clipped to the BleedBox), output?: {conversion: none (default)|destination (every colour into the destination profile's model, CMYK or RGB, also colours of that model in another profile)|preserveNumbers (only colours of the other model and Lab; those in the destination's model keep their numbers) (grey stays grey; images are converted too, and with destination and an sRGB destination a gray or RGB image tagged with an ICC profile is converted from it and written untagged; with destination and a CMYK destinatio Line truncated
has_doc,
export_pdf
),
@@ -414,6 +414,98 @@ fn a_plain_image_replacing_a_clipped_psd_keeps_its_rotation() {
assert!(after.iter().zip(before).all(|(a, b)| (a - b).abs() < 1e-9), "{after:?} != {before:?}");
}
/// A square saved as "Square" and the clipping path naming it.
fn square_resources() -> Vec<u8> {
let square = saved_path(false, &[(true, &[[0.25, 0.25], [0.75, 0.25], [0.75, 0.75], [0.25, 0.75]])]);
[resource(2000, b"Square", &square), clipping_name(b"Square")].concat()
}
/// `bytes` written as `name` in `dir`, by its path.
fn write_file(dir: &std::path::Path, name: &str, bytes: &[u8]) -> String {
let p = dir.join(name);
std::fs::write(&p, bytes).unwrap();
p.to_string_lossy().into_owned()
}
/// links.relink and links.update put a linked PSD file's image in the clip group of the clipping
/// path its new file names, take that clip group's clipping path away when the new file names
/// none, and give it back when a later file names one again.
#[test]
fn relink_and_update_follow_the_clipping_path_of_a_linked_psd() {
let dir = vectorcraft_testkit::TempDir::new("psd-relink-clip");
let cut = write_file(&dir, "cut.psd", &red_psd(&triangle_resources()));
let square = write_file(&dir, "square.psd", &red_psd(&square_resources()));
let plain = write_file(&dir, "plain.psd", &red_psd(&[]));
let triangle = vec![[50.0, 0.0], [100.0, 50.0], [0.0, 50.0]];
let squared = vec![[25.0, 12.5], [75.0, 12.5], [75.0, 37.5], [25.0, 37.5]];
let mut s = Session::new();
s.execute("file.new", &json!({"width": 100, "height": 50})).unwrap();
let r = s.execute("file.place", &json!({"path": cut, "at": [50, 25]})).unwrap();
let (group, image) = (NodeId(r["ids"][0].as_u64().unwrap()), r["image"].as_u64().unwrap());
assert_eq!(clip_group(&s.doc().unwrap().doc, group), (triangle.clone(), true, NodeId(image)));
s.execute("links.relink", &json!({"ids": [image], "path": square})).unwrap();
assert_eq!(clip_group(&s.doc().unwrap().doc, group), (squared.clone(), true, NodeId(image)), "the new file's clipping path");
s.execute("links.relink", &json!({"ids": [image], "path": plain})).unwrap();
let d = &s.doc().unwrap().doc;
match d.node(group).map(|n| &n.kind) {
Some(NodeKind::Group { children, clip: false }) => assert_eq!(children.iter().map(|c| c.id.0).collect::<Vec<_>>(), [image]),
other => panic!("a plain group of the image: {other:?}"),
}
s.execute("links.relink", &json!({"ids": [image], "path": cut})).unwrap();
assert_eq!(clip_group(&s.doc().unwrap().doc, group), (triangle.clone(), true, NodeId(image)), "clipped again");
// The file is saved again with another clipping path.
std::fs::write(&cut, red_psd(&square_resources())).unwrap();
s.execute("links.update", &json!({"ids": [image]})).unwrap();
assert_eq!(clip_group(&s.doc().unwrap().doc, group), (squared, true, NodeId(image)), "links.update reads the clipping path again");
}
/// The PNG a PSD file's merged image is kept as holds the clipping path the file names, and only a
/// text chunk within the size limit that reads as a path gives one back.
#[test]
fn the_kept_png_holds_the_clipping_path_within_bounds() {
let img = raster_image(&red_psd(&triangle_resources())).unwrap();
let (path, rule) = img.clip.clone().expect("the file's clipping path");
assert_eq!(rule, vectorcraft_geom::FillRule::EvenOdd);
assert_eq!(super::load::png_clip(&img.blob.bytes), Some(path));
let plain = raster_image(&red_psd(&[])).unwrap();
assert!(plain.clip.is_none() && super::load::png_clip(&plain.blob.bytes).is_none());
let with = |text: String| vectorcraft_render::encode::png::with_text(plain.blob.bytes.to_vec(), &[("VectorCraft clip", text.into())]);
assert_eq!(super::load::png_clip(&with("not a path".into())), None);
assert_eq!(super::load::png_clip(&with(" ".repeat((16 << 20) + 1))), None, "a chunk past the limit is not read");
}
/// A plain image relinked to a PSD file that names a clipping path goes into a clip group of that
/// path, under the even-odd rule; a clipping mask made in the document stays around it.
#[test]
fn a_plain_image_relinked_to_a_clipped_psd_is_clipped_by_its_path() {
let dir = vectorcraft_testkit::TempDir::new("psd-relink-plain");
let plain = write_file(&dir, "plain.psd", &red_psd(&[]));
let cut = write_file(&dir, "cut.psd", &red_psd(&triangle_resources()));
let mut s = Session::new();
s.execute("file.new", &json!({"width": 100, "height": 50})).unwrap();
let r = s.execute("file.place", &json!({"path": plain, "at": [50, 25]})).unwrap();
let image = NodeId(r["ids"][0].as_u64().unwrap());
s.execute("links.relink", &json!({"ids": [image.0], "path": cut})).unwrap();
let d = &s.doc().unwrap().doc;
let group = d.parent_of(image).expect("a clip group");
assert_eq!(clip_group(d, group), (vec![[50.0, 0.0], [100.0, 50.0], [0.0, 50.0]], true, image));
// The clipping path's fill rule changed in the document makes it the document's own mask: a
// relink keeps it and puts the file's clip group inside it.
let clip = match d.node(group).map(|n| &n.kind) {
Some(NodeKind::Group { children, .. }) => children[0].id,
other => panic!("{other:?}"),
};
let doc = std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc);
if let Some(vectorcraft_doc::Node { kind: NodeKind::Path { rule, .. }, .. }) = doc.node_mut(clip) {
*rule = vectorcraft_geom::FillRule::NonZero;
}
s.execute("links.relink", &json!({"ids": [image.0], "path": cut})).unwrap();
let d = &s.doc().unwrap().doc;
let inner = d.parent_of(image).unwrap();
assert_eq!(d.parent_of(inner), Some(group), "the document's mask holds the file's clip group");
assert!(clip_group(d, inner).1, "the file's clip group is even-odd");
}
#[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]])]);
@@ -501,8 +501,13 @@ fn damaged_slices_never_panic() {
let mut f = base.clone();
f[at] = v;
let mut s = Session::new();
let _ = s.execute("document.open", &json!({"name": "poster.psd", "dataBase64": b64(&f)}));
let _ = s.execute("document.psdInfo", &json!({"dataBase64": b64(&f)}));
// The engine's guard reports a panic as an internal error.
for r in [
s.execute("document.open", &json!({"name": "poster.psd", "dataBase64": b64(&f)})),
s.execute("document.psdInfo", &json!({"dataBase64": b64(&f)})),
] {
assert!(!matches!(r, Err(crate::EngineError::Internal { .. })), "byte {at} set to {v}: {r:?}");
}
}
}
}
@@ -1,7 +1,10 @@
//! SVG encodings, profiles and embedded fonts through the engine: the options reach the file,
//! files in each encoding open again, and `document.serialize` reads them as text.
use std::sync::Arc;
use serde_json::json;
use vectorcraft_doc::Document;
use super::*;
@@ -109,6 +112,106 @@ fn a_chosen_artboard_s_svg_keeps_an_object_whose_shadow_reaches_it() {
assert_eq!(paths(&mut s), 1, "its shadow reaches 10 pt onto the artboard");
}
/// A 100 × 100 document whose 3 pt. Round brush paints with a 20 pt nib, and the left edge of its
/// artboard.
fn nib_doc() -> (Document, f64) {
let mut d = Document::new(100.0, 100.0);
let mut lib = vectorcraft_brush::library(&d);
let Some(vectorcraft_brush::BrushKind::Calligraphic(c)) = lib.iter_mut().find(|b| b.name == "3 pt. Round").map(|b| &mut b.kind) else {
panic!("the 3 pt. Round brush")
};
c.size = 20.0;
vectorcraft_brush::store(&mut d, &lib);
let x0 = d.artboards[0].rect.x0;
(d, x0)
}
/// A line from (`x`, 40) to (`x`, 60) with a 1 pt stroke in `paint`, painted by the 20 pt nib of
/// [`nib_doc`] when `brushed`: the nib paints 10 pt either side of the line.
fn nib_line(d: &mut Document, x: f64, paint: vectorcraft_color::Paint, brushed: bool) -> vectorcraft_doc::Node {
let mut look = vectorcraft_doc::Appearance::basic(vectorcraft_color::Paint::None, paint, 1.0);
if brushed {
look.stroke_mut().unwrap().brush = Some("3 pt. Round".into());
}
let line = vectorcraft_geom::shapes::line((x, 40.0).into(), (x, 60.0).into());
vectorcraft_doc::Node::path(d.alloc_id(), line, look)
}
fn black() -> vectorcraft_color::Paint {
vectorcraft_color::Paint::solid(vectorcraft_color::Color::BLACK)
}
/// A brushed path just left of a chosen artboard, whose brush art paints onto it, is in that
/// artboard's SVG and SVGZ; a brushed path too far off for its brush art to reach it is not.
#[test]
fn a_chosen_artboard_s_svg_keeps_brush_art_reaching_in() {
let (mut d, x0) = nib_doc();
let layer = d.layers[0].id;
let near = nib_line(&mut d, x0 - 5.0, black(), true);
let far = nib_line(&mut d, x0 - 200.0, black(), true);
let (near, far) = (d.insert(Some(layer), 0, near).unwrap(), d.insert(Some(layer), 0, far).unwrap());
let kept = export::art_over(&d, d.artboards[0].rect, &mut vectorcraft_render::Renderer::new());
assert!(kept.node(near).is_some(), "the nib paints 5 pt onto the artboard");
assert!(kept.node(far).is_none(), "the nib paints 190 pt short of the artboard");
let mut s = Session::new();
s.add_document(d, None);
let svg = s.execute("document.serialize", &json!({"format": "svg", "artboard": 0})).unwrap();
let svg = svg["text"].as_str().unwrap().to_string();
assert!(vectorcraft_testkit::svg_shapes(&svg) > 0, "{svg}");
let svgz = s.execute("document.serialize", &json!({"format": "svgz", "artboard": 0})).unwrap();
let svgz = vectorcraft_format::base64_decode(svgz["dataBase64"].as_str().unwrap()).unwrap();
assert_eq!(vectorcraft_svg::text_of(&svgz).unwrap(), svg, "the SVGZ is the SVG gzipped");
}
/// The room for brush art also keeps a brushed path in a plain group on a sublayer. A brushed
/// stroke without a paint draws no brush art, a clipping group's clip keeps its members' brush art
/// inside it, and a compound path is painted with its own appearance, not its paths': those stay
/// out when only brush art could reach the artboard.
#[test]
fn a_chosen_artboard_s_svg_keeps_nested_brush_art_but_not_unpainted_or_clipped_art() {
use vectorcraft_doc::{LayerColor, Node, NodeKind};
let (mut d, x0) = nib_doc();
let layer = d.layers[0].id;
let x = x0 - 5.0;
// A brushed line in a plain group on a sublayer.
let line = nib_line(&mut d, x, black(), true);
let nested = line.id;
let group = Node::new(d.alloc_id(), NodeKind::Group { children: vec![Arc::new(line)], clip: false });
let mut sublayer = Node::layer(d.alloc_id(), "Sublayer", LayerColor::Preset(1));
sublayer.children_mut().unwrap().push(Arc::new(group));
d.insert(Some(layer), 0, sublayer).unwrap();
// A brushed stroke without a paint.
let unpainted = nib_line(&mut d, x, vectorcraft_color::Paint::None, true);
let unpainted = d.insert(Some(layer), 0, unpainted).unwrap();
// A clipping group whose clip, far left of the artboard, holds a brushed line just off it.
let mut clip = Node::path(
d.alloc_id(),
vectorcraft_geom::shapes::rectangle(vectorcraft_geom::Rect::new(x0 - 100.0, 40.0, x0 - 90.0, 60.0)),
vectorcraft_doc::Appearance::basic(vectorcraft_color::Paint::None, vectorcraft_color::Paint::None, 0.0),
);
if let NodeKind::Path { clipping, .. } = &mut clip.kind {
*clipping = true;
}
let member = nib_line(&mut d, x, black(), true);
let clipped = Node::new(d.alloc_id(), NodeKind::Group { children: vec![Arc::new(clip), Arc::new(member)], clip: true });
let clipped = d.insert(Some(layer), 0, clipped).unwrap();
// Compound paths of a brushed line: plain itself, then brushed itself.
let mut compounds = vec![];
for own in [false, true] {
let member = nib_line(&mut d, x, black(), true);
let mut compound =
Node::new(d.alloc_id(), NodeKind::Compound { children: vec![Arc::new(member)], rule: vectorcraft_geom::FillRule::NonZero });
compound.appearance = nib_line(&mut d, x, black(), own).appearance;
compounds.push(d.insert(Some(layer), 0, compound).unwrap());
}
let kept = export::art_over(&d, d.artboards[0].rect, &mut vectorcraft_render::Renderer::new());
assert!(kept.node(nested).is_some(), "the brushed line in the group on the sublayer");
assert!(kept.node(unpainted).is_none(), "a brushed stroke without a paint");
assert!(kept.node(clipped).is_none(), "a clipping group whose clip misses the artboard");
assert!(kept.node(compounds[0]).is_none(), "a compound path that is not brushed itself");
assert!(kept.node(compounds[1]).is_some(), "a compound path that is brushed itself");
}
/// #3544: an SVG of one artboard on its own (an `artboard` or `range`, Export for Screens, an asset)
/// has the artboard's (or asset's) name as `<title>`; Save's SVG and Export for Screens' Full
/// Document keep the document's.
+1 -1
View File
@@ -40,7 +40,7 @@ use vectorcraft_render::effects;
use super::edit::roots_of;
use super::menucmds::{MAX_PIXELS, isolated_doc, unique_key};
use super::pathops::{node_path, outline_strokes, outline_strokes_under, separate, shape_node};
use super::pathops::{leaves, node_path, outline_strokes, separate, shape_node};
use super::{CommandSpec, EngineError, Result, Session, always, bad, bool_or, cmd, has_doc, str_param, targets, unique_name};
mod analysis;
+390 -50
View File
@@ -1,9 +1,11 @@
use std::collections::HashSet;
use super::analysis::{Scratch, finite, flatten_groups, has_effects, masked, outlined_text, overlapping, painted, reach};
use super::compose::{Builder, CLEAR, Composer, Elem, Fill, Kind, Px, WHITE};
use super::options::FlattenOptions;
use super::{
Affine, Appearance, AppearanceItem, Arc, BlendMode, Color, ColorMode, Document, EngineError, FillLayer, FillRule, ImageBlob, ImageObject, Inks,
MAX_PIXELS, Node, NodeId, NodeKind, Paint, PathData, Rect, Result, composite, effects, isolated_doc, outline_strokes_under, planes_cmyk, po,
MAX_PIXELS, Node, NodeId, NodeKind, Paint, PathData, Rect, Result, composite, effects, isolated_doc, leaves, outline_strokes, planes_cmyk, po,
separate, shape_node, shapes, unique_key,
};
@@ -14,6 +16,8 @@ pub(super) struct Plan {
pub(super) flat: Vec<Flat>,
/// Objects without transparency (they stay, but for the outline options).
pub(super) kept: Vec<NodeId>,
/// What the outline and overprint options do to each of `kept`, in its order.
pub(super) work: Vec<Kept>,
/// The objects with transparency of their own.
pub(super) transparent: Vec<NodeId>,
}
@@ -112,7 +116,12 @@ pub(super) fn plan(src: &Document, roots: &[NodeId], o: &FlattenOptions, render:
let reaches: Vec<Option<Rect>> = plain.iter().zip(&clipped).map(|(n, c)| reach(n).zip(reach(c)).map(|(a, b)| a.intersect(b))).collect();
let see_through: Vec<bool> = plain.iter().map(|n| o.shows_transparency(&baked, n) || o.draws_see_through_image(n)).collect();
let cmyk = src.color_mode == ColorMode::Cmyk;
let mut out = Plan { flat: vec![], kept: vec![], transparent: roots.iter().zip(&see_through).filter(|(_, t)| **t).map(|(id, _)| *id).collect() };
let mut out = Plan {
flat: vec![],
kept: vec![],
work: vec![],
transparent: roots.iter().zip(&see_through).filter(|(_, t)| **t).map(|(id, _)| *id).collect(),
};
// Baking above stopped early when cancelled; each group is a place to stop (a plan changes nothing).
vectorcraft_doc::cancel::check()?;
let mut queue = groups(src, roots, &plain, &reaches, &see_through, o)?;
@@ -193,9 +202,101 @@ pub(super) fn plan(src: &Document, roots: &[NodeId], o: &FlattenOptions, render:
};
out.flat.push(Flat { roots: ids, regions, area, raster, lines });
}
out.work = out.kept.iter().map(|id| Kept::of(src, *id, o)).collect();
Ok(out)
}
/// What the outline and overprint options do to one object without transparency, found in one
/// walk of it.
pub(super) struct Kept {
pub(super) id: NodeId,
/// Whether the options change it.
pub(super) changes: bool,
/// The type the text option outlines and the stroked paths the stroke option outlines, those
/// that show and are not pieces of a compound path: what the Flattener Preview highlights.
pub(super) shown_text: Vec<NodeId>,
pub(super) shown_strokes: Vec<NodeId>,
/// In paint order: the type the text option outlines and the leaf shapes ([`leaves`]) other
/// than type that the stroke option outlines.
steps: Vec<Step>,
/// The objects with overprints, each with the type or leaf shape that holds it (itself
/// included) when a step replaces that.
overprinted: Vec<(NodeId, Option<NodeId>)>,
}
/// One object [`apply`] outlines.
enum Step {
/// Type; `leaf`: only groups and layers hold it, so its outlines are leaf shapes for the
/// stroke option.
Text { id: NodeId, leaf: bool },
/// A leaf shape other than type.
Leaf(NodeId),
}
/// Where [`Kept::visit`] is in the object it walks.
#[derive(Clone, Copy)]
struct At {
/// Neither the node nor what holds it is hidden, and it is not a piece of a compound path.
shown: bool,
/// Only groups and layers hold the node.
leaf: bool,
/// The type or leaf shape holding the node that a step replaces.
holder: Option<NodeId>,
}
impl Kept {
/// What the options `o` do to `root` of `d`: nothing when `d` doesn't hold it.
fn of(d: &Document, root: NodeId, o: &FlattenOptions) -> Kept {
let mut k = Kept { id: root, changes: false, shown_text: vec![], shown_strokes: vec![], steps: vec![], overprinted: vec![] };
if let Some(n) = d.node(root) {
k.visit(n, o, At { shown: true, leaf: true, holder: None });
}
k
}
/// Note what the options `o` do to `n` and to everything under it.
fn visit(&mut self, n: &Node, o: &FlattenOptions, at: At) {
kept_seen(n);
let shown = at.shown && n.visible;
let mut holder = at.holder;
if matches!(n.kind, NodeKind::Text(_)) {
if o.text_to_outlines {
self.changes = true;
if shown {
self.shown_text.push(n.id);
}
self.steps.push(Step::Text { id: n.id, leaf: at.leaf });
holder = Some(n.id);
}
} else {
if o.strokes_to_outlines && stroked(n) {
self.changes = true;
if shown {
self.shown_strokes.push(n.id);
}
}
if o.strokes_to_outlines && at.leaf && matches!(n.kind, NodeKind::Path { guide: false, clipping: false, .. } | NodeKind::Compound { .. })
{
self.steps.push(Step::Leaf(n.id));
holder = Some(n.id);
}
}
if !o.preserve_overprints && overprints(n) {
self.changes = true;
self.overprinted.push((n.id, holder));
}
let Some(children) = n.children() else { return };
let inside = At {
shown: shown && !matches!(n.kind, NodeKind::Compound { .. }),
leaf: at.leaf && matches!(n.kind, NodeKind::Group { .. } | NodeKind::Layer { .. }),
holder,
};
for c in children {
self.visit(c, o, inside);
}
}
}
/// `roots` of `src` (`plain`: as plain art; `reaches`: where each can paint, clipped) in the
/// groups that flatten together ([`flatten_groups`]), each in paint order, by their first object.
/// Objects that overlap (as [`overlapping`] groups them) stay in one group when one of them is
@@ -668,7 +769,7 @@ pub(crate) fn flatten_expanded(doc: &Document, o: &FlattenOptions) -> Result<Opt
roots.extend(children.iter().skip(usize::from(l.clips())).filter(|c| c.visible && !c.is_ruler_guide()).map(|c| c.id));
}
let plan = plan(doc, &roots, o, true)?;
if plan.flat.is_empty() && !plan.kept.iter().any(|id| doc.node(*id).is_some_and(|n| kept_work(n, o))) {
if plan.flat.is_empty() && !plan.work.iter().any(|k| k.changes) {
return Ok(None);
}
let mut d = doc.clone();
@@ -753,19 +854,8 @@ pub(super) fn apply(d: &mut Document, sel: &mut vectorcraft_doc::Selection, plan
d.insert(Some(layer), usize::MAX, guide)?;
}
let brushes = if o.strokes_to_outlines { vectorcraft_brush::library(d) } else { vec![] };
for mut id in plan.kept {
if o.text_to_outlines {
id = outline_texts_under(d, id)?;
}
if o.strokes_to_outlines {
id = outline_strokes_under(d, &brushes, id)?.0;
}
if !o.preserve_overprints
&& let Some(n) = d.node_mut(id)
{
drop_overprints(n);
}
ids.push(id);
for k in plan.work {
ids.push(outline_kept(d, &brushes, k, o)?);
}
ids.sort_by_key(|id| d.index_path(*id));
sel.set(ids.iter().copied());
@@ -838,6 +928,21 @@ fn guide_seen(n: &Node) {
#[cfg(not(test))]
fn guide_seen(_: &Node) {}
#[cfg(test)]
thread_local! {
/// The nodes that [`Kept::of`] has looked at on this thread, in order.
static KEPT_SEEN: std::cell::RefCell<Vec<NodeId>> = const { std::cell::RefCell::new(Vec::new()) };
}
/// Note that [`Kept::of`] looked at `n`.
#[cfg(test)]
fn kept_seen(n: &Node) {
KEPT_SEEN.with(|s| s.borrow_mut().push(n.id));
}
#[cfg(not(test))]
fn kept_seen(_: &Node) {}
/// An image of `r` (in a clip group when it is clipped).
fn raster_node(d: &mut Document, r: Raster) -> Node {
let key = unique_key(d, "flattened");
@@ -858,38 +963,65 @@ fn raster_node(d: &mut Document, r: Raster) -> Node {
crate::cmd::rasterfx::clip_group(d, path, FillRule::NonZero, image)
}
/// Replace the type under `root` by its outlines: → the id now standing for `root`.
fn outline_texts_under(d: &mut Document, root: NodeId) -> Result<NodeId> {
let mut texts = vec![];
if let Some(n) = d.node(root) {
n.walk(&mut |c| {
if matches!(c.kind, NodeKind::Text(_)) {
texts.push(c.clone());
/// Do what [`Kept`] `k` found to its object of `d` (`brushes`: the document's brushes, for the
/// stroke option): its type outlined, then the strokes of its leaf shapes, the outlines of its
/// type included, then its overprints dropped. → the id now standing for the object.
fn outline_kept(d: &mut Document, brushes: &[vectorcraft_brush::Brush], k: Kept, o: &FlattenOptions) -> Result<NodeId> {
let mut root = k.id;
let mut replaced = HashSet::new();
let dropping = !o.preserve_overprints;
// Each replacement loses its overprints before it goes in: no new object is looked up.
let mut put = |d: &mut Document, old: NodeId, mut new: Node, root: &mut NodeId| -> Result<()> {
if dropping {
drop_overprints(&mut new);
}
let nid = new.id;
*d.node_mut(old).ok_or(EngineError::NoNode(old))? = new;
replaced.insert(old);
if old == *root {
*root = nid;
}
Ok(())
};
// The leaf shapes of each outlined type that only groups and layers hold, by step.
let mut outlined: Vec<Vec<Node>> = Vec::with_capacity(k.steps.len());
for step in &k.steps {
let mut lv = vec![];
if let Step::Text { id, leaf } = *step
&& let Some(out) = d.node(id).and_then(outlined_text)
{
let out = d.reid(&out);
if leaf && o.strokes_to_outlines {
leaves(&out, &mut lv);
}
});
put(d, id, out, &mut root)?;
}
outlined.push(lv);
}
let mut out = root;
for t in texts {
let Some(o) = outlined_text(&t) else { continue };
let o = d.reid(&o);
let nid = o.id;
*d.node_mut(t.id).ok_or(EngineError::NoNode(t.id))? = o;
if t.id == root {
out = nid;
if o.strokes_to_outlines {
for (step, lv) in k.steps.iter().zip(outlined) {
let shapes = match *step {
Step::Leaf(id) => d.node(id).cloned().into_iter().collect(),
Step::Text { .. } => lv,
};
for l in shapes.iter().filter(|l| !matches!(l.kind, NodeKind::Text(_))) {
if let Some(new) = outline_strokes(d, brushes, l) {
put(d, l.id, new, &mut root)?;
}
}
}
}
Ok(out)
}
/// Whether the outline and overprint options change `n`, an object without transparency.
pub(super) fn kept_work(n: &Node, o: &FlattenOptions) -> bool {
let mut any = false;
n.walk(&mut |c| {
any |= (o.text_to_outlines && matches!(c.kind, NodeKind::Text(_)))
|| (o.strokes_to_outlines && stroked(c))
|| (!o.preserve_overprints && overprints(c));
});
any
if dropping {
for (id, holder) in k.overprinted {
if holder.is_some_and(|h| replaced.contains(&h)) {
continue;
}
if let Some(n) = d.node_mut(id) {
drop_own_overprints(n);
}
}
}
Ok(root)
}
/// Whether `n` is a path with a visible stroke (outlining turns it into a fill).
@@ -898,12 +1030,8 @@ pub(super) fn stroked(n: &Node) -> bool {
&& n.appearance.items.iter().any(|i| matches!(i, AppearanceItem::Stroke(s) if s.visible && !s.paint.is_none() && s.width > 0.0))
}
fn overprints(n: &Node) -> bool {
n.appearance.items.iter().any(AppearanceItem::overprint)
|| matches!(&n.kind, NodeKind::Text(t) if t.runs.iter().any(|r| r.style.overprint_fill || r.style.overprint_stroke))
}
fn drop_overprints(n: &mut Node) {
/// Drop the overprints of `n` itself.
fn drop_own_overprints(n: &mut Node) {
if overprints(n) {
for i in &mut n.appearance.items {
*i.overprint_mut() = false;
@@ -914,6 +1042,16 @@ fn drop_overprints(n: &mut Node) {
}
}
}
}
fn overprints(n: &Node) -> bool {
n.appearance.items.iter().any(AppearanceItem::overprint)
|| matches!(&n.kind, NodeKind::Text(t) if t.runs.iter().any(|r| r.style.overprint_fill || r.style.overprint_stroke))
}
/// Drop the overprints of `n` and of everything under it.
fn drop_overprints(n: &mut Node) {
drop_own_overprints(n);
if let Some(ch) = n.children_mut() {
for c in ch {
drop_overprints(Arc::make_mut(c));
@@ -994,6 +1132,208 @@ mod tests {
assert_eq!(run(&[deep, deep]).0, vec![(sub, g2), (sub, g2)]);
}
/// The objects [`kept_session`] makes.
struct KeptArt {
/// Each group with its stroked rectangle (its fill overprints) and its stroked type.
groups: Vec<(NodeId, NodeId, NodeId)>,
/// A stroked rectangle and stroked type with an overprint, on their own.
rect: NodeId,
text: NodeId,
/// A stroked compound path and its pieces.
compound: NodeId,
pieces: Vec<NodeId>,
/// A group holding an unstroked rectangle and a hidden stroked rectangle.
hidden_group: NodeId,
hidden: NodeId,
/// An unstroked rectangle.
plain: NodeId,
}
/// A document without transparency: `n` groups, then the other objects of [`KeptArt`].
fn kept_session(n: usize) -> (Session, KeptArt) {
let mut s = Session::new();
s.execute("file.new", &json!({"width": 400, "height": 300})).unwrap();
let id = |v: serde_json::Value| NodeId(v["id"].as_u64().unwrap());
let rect = |s: &mut Session, x: f64| id(s.execute("shape.rectangle", &json!({"x": x, "y": 10, "width": 20, "height": 20})).unwrap());
let text = |s: &mut Session, x: f64| {
let t = id(s.execute("text.create", &json!({"x": x, "y": 80, "text": "Hi", "size": 24})).unwrap());
s.execute("paint.setStroke", &json!({"color": "#000000", "ids": [t.0]})).unwrap();
t
};
let select = |s: &mut Session, ids: &[NodeId]| {
s.execute("select.set", &json!({"ids": ids.iter().map(|i| i.0).collect::<Vec<_>>()})).unwrap();
};
let overprint = |s: &mut Session, on: NodeId| {
s.execute("attributes.set", &json!({"ids": [on.0], "overprintFill": true})).unwrap();
};
let unstroked = |s: &mut Session, on: NodeId| {
s.execute("paint.setStroke", &json!({"none": true, "ids": [on.0]})).unwrap();
};
let mut groups = vec![];
for i in 0..n {
let x = (i % 10) as f64 * 30.0;
let (r, t) = (rect(&mut s, x), text(&mut s, x));
overprint(&mut s, r);
select(&mut s, &[r, t]);
groups.push((id(s.execute("object.group", &json!({})).unwrap()), r, t));
}
let (r, t) = (rect(&mut s, 0.0), text(&mut s, 100.0));
overprint(&mut s, t);
let (a, b) = (rect(&mut s, 200.0), rect(&mut s, 210.0));
select(&mut s, &[a, b]);
let compound = id(s.execute("object.compoundPath.make", &json!({})).unwrap());
s.execute("paint.setStroke", &json!({"color": "#000000", "ids": [compound.0]})).unwrap();
let pieces = s.doc().unwrap().doc.node(compound).unwrap().children().unwrap().iter().map(|c| c.id).collect();
let (shown, hidden) = (rect(&mut s, 300.0), rect(&mut s, 310.0));
unstroked(&mut s, shown);
select(&mut s, &[shown, hidden]);
let hidden_group = id(s.execute("object.group", &json!({})).unwrap());
s.execute("object.hide", &json!({"ids": [hidden.0]})).unwrap();
let plain = rect(&mut s, 350.0);
unstroked(&mut s, plain);
(s, KeptArt { groups, rect: r, text: t, compound, pieces, hidden_group, hidden, plain })
}
/// Every option on: type and strokes outlined, overprints dropped.
fn outlining() -> FlattenOptions {
FlattenOptions { text_to_outlines: true, strokes_to_outlines: true, preserve_overprints: false, ..FlattenOptions::default() }
}
/// The top-level objects of `d`'s first layer, in paint order.
fn top_level(d: &Document) -> Vec<NodeId> {
d.layers[0].children().unwrap().iter().map(|c| c.id).collect()
}
fn sorted(mut ids: Vec<NodeId>) -> Vec<NodeId> {
ids.sort();
ids
}
/// The nodes [`Kept::of`] looked at while `f` ran, sorted.
fn kept_seen_by(f: impl FnOnce()) -> Vec<NodeId> {
KEPT_SEEN.with(|v| v.borrow_mut().clear());
f();
sorted(KEPT_SEEN.with(|v| v.take()))
}
/// The Flattener Preview, `object.flattenTransparency` and flattening a whole document each look
/// at every node of the objects without transparency once, with type and strokes outlined and
/// overprints dropped, an object they leave as it is included.
#[test]
fn kept_objects_are_looked_at_once() {
let (mut s, _) = kept_session(100);
let o = outlining();
let doc = s.doc().unwrap().doc.clone();
let roots = top_level(&doc);
let mut nodes = vec![];
for r in &roots {
doc.node(*r).unwrap().walk(&mut |c| nodes.push(c.id));
}
nodes.sort();
assert_eq!(nodes.len(), 309);
let preview = kept_seen_by(|| drop(super::super::report::report(&doc, &roots, &o).unwrap()));
assert!(preview == nodes, "the preview looked at {} nodes of {}", preview.len(), nodes.len());
let whole = kept_seen_by(|| drop(flatten_document(&doc, &o).unwrap().unwrap()));
assert!(whole == nodes, "flattening the document looked at {} nodes of {}", whole.len(), nodes.len());
let ids: Vec<u64> = roots.iter().map(|r| r.0).collect();
let command = kept_seen_by(|| {
s.execute(
"object.flattenTransparency",
&json!({"ids": ids, "textToOutlines": true, "strokesToOutlines": true, "preserveOverprints": false}),
)
.unwrap();
});
assert!(command == nodes, "object.flattenTransparency looked at {} nodes of {}", command.len(), nodes.len());
}
/// [`apply`]'s outlining of `kept` (objects of `d` without transparency) with `o`, done as a
/// walk of each object for each option: → the ids standing for them, in paint order.
fn outlined_walk_by_walk(d: &mut Document, kept: &[NodeId], o: &FlattenOptions) -> Vec<NodeId> {
let brushes = if o.strokes_to_outlines { vectorcraft_brush::library(d) } else { vec![] };
let mut ids = vec![];
for &root in kept {
let mut id = root;
if o.text_to_outlines {
let mut texts = vec![];
d.node(id).unwrap().walk(&mut |c| {
if matches!(c.kind, NodeKind::Text(_)) {
texts.push(c.clone());
}
});
for t in texts {
let Some(out) = outlined_text(&t) else { continue };
let out = d.reid(&out);
if t.id == root {
id = out.id;
}
*d.node_mut(t.id).unwrap() = out;
}
}
if o.strokes_to_outlines {
id = crate::cmd::pathops::outline_strokes_under(d, &brushes, id).unwrap().0;
}
if !o.preserve_overprints {
drop_overprints(d.node_mut(id).unwrap());
}
ids.push(id);
}
ids.sort_by_key(|id| d.index_path(*id));
ids
}
/// With each mix of the text, stroke and overprint options, the objects without transparency
/// end as a walk of each of them for each option leaves them: the same art, ids and selection.
#[test]
fn kept_objects_change_as_a_walk_per_option_changes_them() {
let (s, _) = kept_session(3);
let doc = Document::clone(&s.doc().unwrap().doc);
let roots = top_level(&doc);
for bits in 0..8u8 {
let o = FlattenOptions {
text_to_outlines: bits & 1 != 0,
strokes_to_outlines: bits & 2 != 0,
preserve_overprints: bits & 4 != 0,
..FlattenOptions::default()
};
let p = plan(&doc, &roots, &o, true).unwrap();
assert!(p.flat.is_empty(), "{o:?}");
// In the order the plan's groups come in.
let kept = p.kept.clone();
assert_eq!(sorted(kept.clone()), sorted(roots.clone()), "{o:?}");
let mut once = doc.clone();
let mut sel = vectorcraft_doc::Selection::default();
let (ids, ..) = apply(&mut once, &mut sel, p, &o).unwrap();
let mut walked = doc.clone();
let want = outlined_walk_by_walk(&mut walked, &kept, &o);
assert_eq!(ids, want, "{o:?}");
assert!(once == walked, "{o:?}");
assert_eq!(once == doc, bits == 4, "{o:?}: only with every option off does nothing change");
}
}
/// The Flattener Preview lists the kept objects the options change, and of those the type and
/// the stroked paths that show and are not pieces of a compound path.
#[test]
fn the_preview_lists_what_the_options_change_in_kept_objects() {
let (s, a) = kept_session(2);
let doc = &s.doc().unwrap().doc;
let roots = top_level(doc);
let r = super::super::report::report(doc, &roots, &outlining()).unwrap();
let (g, rects, texts): (Vec<_>, Vec<_>, Vec<_>) =
(a.groups.iter().map(|g| g.0).collect(), a.groups.iter().map(|g| g.1).collect(), a.groups.iter().map(|g| g.2).collect());
assert_eq!(r.affected, [g.clone(), vec![a.rect, a.text, a.compound, a.hidden_group]].concat());
// Both lists come in the order the plan's groups do.
assert_eq!(sorted(r.text.clone()), sorted([texts, vec![a.text]].concat()));
assert_eq!(sorted(r.strokes.clone()), sorted([rects, vec![a.rect, a.compound]].concat()));
assert!(!r.strokes.contains(&a.hidden) && !r.strokes.iter().any(|id| a.pieces.contains(id)) && !r.affected.contains(&a.plain));
// Dropping overprints alone changes the objects that overprint.
let o = FlattenOptions { preserve_overprints: false, ..FlattenOptions::default() };
let r = super::super::report::report(doc, &roots, &o).unwrap();
assert_eq!((r.affected, r.text, r.strokes), ([g, vec![a.text]].concat(), vec![], vec![]));
// With every option off, nothing.
assert!(super::super::report::report(doc, &roots, &FlattenOptions::default()).unwrap().affected.is_empty());
}
/// In a file without transparency with Clip Complex Regions on, art under a group's opaque
/// image within one of its pixels joins the group, also where a long image is made at a lower
/// resolution and its pixels are wider than at the preset's.
+2 -2
View File
@@ -1,5 +1,5 @@
use super::analysis::draws_image;
use super::apply::{apply, kept_work, plan};
use super::apply::{apply, plan};
use super::presets::{FlattenerPreset, saved_preset};
use super::report::target_roots;
use super::{BTreeSet, Deserialize, Document, EngineError, Node, NodeKind, Paint, Result, Serialize, Session, Value, bad, json, str_param};
@@ -194,7 +194,7 @@ pub(super) fn flatten(s: &mut Session, p: &Value) -> Result<Value> {
let plan = plan(&src, &roots, &o, true)?;
let warning = crate::cmd::rasterfx::undecoded_warning(failed);
let options = serde_json::to_value(&o).unwrap_or_default();
if plan.flat.is_empty() && !plan.kept.iter().any(|id| src.node(*id).is_some_and(|n| kept_work(n, &o))) {
if plan.flat.is_empty() && !plan.work.iter().any(|k| k.changes) {
return Ok(json!({ "ids": roots.iter().map(|i| i.0).collect::<Vec<_>>(), "rasterized": 0, "vector": 0, "options": options }));
}
let (ids, vector, rasterized) = s.edit("Flatten Transparency", |d, sel| {
+5 -10
View File
@@ -1,4 +1,4 @@
use super::apply::{kept_work, opaque, plan, stroked};
use super::apply::{opaque, plan, stroked};
use super::options::FlattenOptions;
use super::{
Appearance, Color, Deserialize, Document, Node, NodeId, NodeKind, Paint, PathData, Rect, Result, Serialize, Session, Value, bad, isolated_doc,
@@ -263,15 +263,10 @@ pub fn report(doc: &Document, roots: &[NodeId], o: &FlattenOptions) -> Result<Fl
r.rasterized.push(a.outline());
}
}
for root in plan.kept.iter().filter_map(|id| doc.node(*id)).filter(|n| kept_work(n, o)) {
r.affected.push(root.id);
visit(root, &mut |n| {
if o.text_to_outlines && matches!(n.kind, NodeKind::Text(_)) {
r.text.push(n.id);
} else if o.strokes_to_outlines && stroked(n) {
r.strokes.push(n.id);
}
});
for k in plan.work.iter().filter(|k| k.changes) {
r.affected.push(k.id);
r.text.extend(&k.shown_text);
r.strokes.extend(&k.shown_strokes);
}
r.affected.sort_by_key(|id| doc.index_path(*id));
Ok(r)
+47
View File
@@ -53,6 +53,15 @@ pub fn specs() -> Vec<CommandSpec> {
always,
font_list
),
cmd!(
query "text.glyphCategories",
"Glyph Categories",
[],
None,
"{family, style?} the OpenType categories of the font's glyphs, what the Glyphs panel's Show menu lists after Alternates for Current Selection: from the font's GSUB table, the glyphs that the single, alternate, multiple and ligature substitutions of each kind's features give, each glyph once by id, in this order: `ligatures` (liga, dlig, hlig), `swashes` (swsh, cswh), `stylisticAlternates` (salt), `ss01` to `ss20`, `smallCaps` (smcp, c2sc), `ornaments` (ornm), `fractions` (frac, afrc, numr, dnom) and `figures` (lnum, onum, pnum, tnum); a kind without glyphs is left out; contextual lookups are not followed → {family, style, categories: [{id, name?: a stylistic set's name in the font, glyphs: [glyph id]}]} (style omitted: the family's first style; an error when the family or style isn't available)",
always,
glyph_categories
),
cmd!(
"text.rescanFonts",
"Refresh Font List",
@@ -1137,6 +1146,44 @@ fn font_list(_: &mut Session, p: &Value) -> Result<Value> {
}
}
/// `text.glyphCategories`: the OpenType categories of a font's glyphs
/// ([`vectorcraft_text::FontFace::glyph_categories`]).
fn glyph_categories(_: &mut Session, p: &Value) -> Result<Value> {
const C: &str = "text.glyphCategories";
let text = |key: &str| match p.get(key) {
None | Some(Value::Null) => Ok(None),
Some(Value::String(s)) => Ok(Some(s.as_str())),
Some(_) => Err(bad(C, format!("`{key}` must be a string"))),
};
let family = text("family")?.ok_or_else(|| bad(C, "missing `family`"))?;
let db = vectorcraft_text::FontDb::global();
if !db.has_family(family) {
return Err(bad(C, format!("font family `{family}` is not available")));
}
let styles = db.styles(family);
let style = match text("style")? {
Some(style) => styles
.iter()
.find(|s| s.eq_ignore_ascii_case(style))
.cloned()
.ok_or_else(|| bad(C, format!("style `{style}` of `{family}` is not available")))?,
None => styles.first().cloned().unwrap_or_else(|| "Regular".into()),
};
let face = db.face(family, &style).ok_or_else(|| bad(C, format!("style `{style}` of `{family}` is not available")))?;
let categories: Vec<Value> = face
.glyph_categories()
.iter()
.map(|c| {
let mut v = json!({"id": c.kind.id(), "glyphs": c.glyphs});
if let Some(name) = &c.name {
v["name"] = json!(name);
}
v
})
.collect();
Ok(json!({"family": face.family, "style": face.style, "categories": categories}))
}
pub(crate) fn rescan(s: &mut Session, _: &Value) -> Result<Value> {
let db = vectorcraft_text::FontDb::global();
#[cfg(not(target_arch = "wasm32"))]
+19 -5
View File
@@ -393,6 +393,16 @@ impl<'a> Plot<'a> {
series_marks(self.g, i, series_fill, stroke, width)
}
/// The stroke paint and width series `s`'s filled marks and its legend swatch get when the series keeps no stroke
/// of its own: a white line between stacked segments, area bands and pie wedges, none on other marks.
fn mark_stroke(&self, s: usize) -> (Paint, f64) {
match self.kind(s) {
GraphKind::StackedColumn | GraphKind::StackedBar | GraphKind::Area => (Paint::solid(Color::WHITE), 0.25),
GraphKind::Pie => (Paint::solid(Color::WHITE), 0.5),
_ => (Paint::None, 0.0),
}
}
fn series_label(&self, i: usize) -> String {
self.g.series.get(i).cloned().unwrap_or_default()
}
@@ -471,7 +481,8 @@ impl<'a> Plot<'a> {
}
let sweep = v / total * std::f64::consts::TAU;
let bp = wedge_path(ring, a0, sweep);
let (fill, stroke, sw) = self.mark(s, true, Paint::solid(Color::WHITE), 0.5);
let (stroke, width) = self.mark_stroke(s);
let (fill, stroke, sw) = self.mark(s, true, stroke, width);
let dark = is_dark(&fill);
let n = self.b.path(PathData::from_bezpath(&bp), fill, stroke, sw);
self.push_shadowed(s, n);
@@ -887,7 +898,8 @@ impl<'a> Plot<'a> {
let Some(base) = (if v >= 0.0 { pos.get_mut(ax) } else { neg.get_mut(ax) }) else { continue };
let (v0, v1) = (geo.vpos(ax, *base), geo.vpos(ax, *base + v));
*base += v;
let paint = self.mark(s, true, Paint::solid(Color::WHITE), 0.25);
let (stroke, width) = self.mark_stroke(s);
let paint = self.mark(s, true, stroke, width);
let rect = bar_rect(geo.horizontal, a, w, v0, v1);
// A segment of 0 has no area to shade.
let n = self.bar_node(Bar { s, rect, value: v, down: v1 < v0, per_unit: geo.per_unit(ax) }, paint, v != 0.0);
@@ -907,7 +919,8 @@ impl<'a> Plot<'a> {
let at = |c: usize, v: &[f64]| Point::new(geo.cat_mid(c), geo.vpos(a, v.get(c).copied().unwrap_or(0.0)));
let mut pts: Vec<Point> = (0..ncat).map(|c| at(c, &above)).collect();
pts.extend((0..ncat).rev().map(|c| at(c, below)));
let (fill, stroke, w) = self.mark(s, true, Paint::solid(Color::WHITE), 0.25);
let (stroke, width) = self.mark_stroke(s);
let (fill, stroke, w) = self.mark(s, true, stroke, width);
let n = self.b.path(polyline(&pts, true), fill, stroke, w);
self.push_series(s, n);
*below = above;
@@ -951,10 +964,11 @@ impl<'a> Plot<'a> {
}
/// The swatch of series `s` at `(x, y)`: series drawn with markers show their marker design in the legend, and
/// series drawn with a column design that design.
/// series drawn with a column design that design. A default swatch has the stroke of its series' marks.
fn legend_swatch(&mut self, s: usize, (x, y): (f64, f64)) {
let marked = matches!(self.g.kind, GraphKind::Scatter | GraphKind::Radar) || self.kind(s) == GraphKind::Line;
let paint = self.mark(s, true, Paint::None, 0.0);
let (stroke, width) = self.mark_stroke(s);
let paint = self.mark(s, true, stroke, width);
let column = nth(self.column_looks, s).filter(|_| self.columnar(s));
let swatch = self.b.swatch(column, nth(&self.designs, s).filter(|_| marked), Rect::new(x, y, x + 8.0, y + 8.0), paint);
self.push_series(s, swatch);
+96 -1
View File
@@ -8449,7 +8449,102 @@ fn a_drawn_graph_saved_as_ai_opens_as_a_graph_unless_the_save_warns() {
}
}
}
assert!(live.contains(&"column v7.ai".to_string()) && live.contains(&"column pdf.ai".to_string()), "{live:?}");
for ty in ["column", "stackedColumn", "area"] {
assert!(live.contains(&format!("{ty} v7.ai")) && live.contains(&format!("{ty} pdf.ai")), "{ty}: {live:?}");
}
}
/// A default legend swatch has the stroke paint and weight of its series' marks, beside the plot or across the top: the
/// thin white line of stacked columns and bars, areas and pie wedges, and none on columns and bars. A stroke color kept
/// on the series, with or without a weight of its own, is on the swatch too.
#[test]
fn a_legend_swatch_has_the_stroke_of_its_series_marks() {
let white = |w: f64| (Paint::solid(vectorcraft_color::Color::WHITE), w);
let cases = [
("stackedColumn", white(0.25)),
("stackedBar", white(0.25)),
("area", white(0.25)),
("pie", white(0.5)),
("column", (Paint::None, 0.0)),
("bar", (Paint::None, 0.0)),
];
for (ty, stroke) in cases {
for across_top in [false, true] {
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 = NodeId(
s.execute("graph.create", &json!({"type": ty, "x": 100, "y": 100, "width": 300, "height": 200, "csv": csv})).unwrap()["id"]
.as_u64()
.unwrap(),
);
s.execute("graph.setType", &json!({"id": id.0, "legendAcrossTop": across_top})).unwrap();
for i in 0..2 {
let marks = marks_of(&s, id, i);
assert!(marks.len() > 1, "{ty} {i}: marks and a swatch");
assert!(marks.iter().all(|m| (m.1.clone(), m.2) == stroke), "{ty} across top {across_top}, series {i}: {marks:?}");
}
// A stroke color kept on series 0 without a weight keeps the default weight, then with one.
let bar = series(s.doc().unwrap().doc.node(id).unwrap(), 0).children().unwrap()[0].clone();
let row = bar.appearance.items.iter().rposition(|it| !it.is_fill());
let Some(row) = row else { continue };
s.execute("appearance.setItem", &json!({"ids": [bar.id.0], "index": row, "color": "#ff0000"})).unwrap();
s.execute("graph.setData", &json!({"id": id.0, "csv": csv})).unwrap();
let marks = marks_of(&s, id, 0);
assert!(marks.iter().all(|m| *m == marks[0]) && marks[0].1 != stroke.0, "{ty} across top {across_top}, red: {marks:?}");
let bar = series(s.doc().unwrap().doc.node(id).unwrap(), 0).children().unwrap()[0].id;
s.execute("appearance.setItem", &json!({"ids": [bar.0], "index": row, "weight": 3})).unwrap();
s.execute("graph.setData", &json!({"id": id.0, "csv": csv})).unwrap();
let marks = marks_of(&s, id, 0);
assert!(marks.iter().all(|m| *m == marks[0]) && marks[0].2 == 3.0, "{ty} across top {across_top}, 3 pt: {marks:?}");
}
}
}
/// A stacked column graph the graph tools draw, saved as `.ai` in either form, opens again as the same graph without a
/// warning, and its data can be edited there.
#[test]
fn a_drawn_stacked_column_graph_saved_as_ai_opens_as_a_graph_that_takes_new_data() {
let dir = vectorcraft_testkit::temp_dir("graph-ai-stacked");
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": "stackedColumn", "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(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();
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": path})).unwrap();
let mut found = vec![];
again.doc().unwrap().doc.walk(|n| {
if n.extras().graph.is_some() {
found.push(n.id);
}
});
assert_eq!(found.len(), 1, "{name}");
let g = spec(&again, found[0]);
assert_eq!((g.kind, g.cells()), (written.kind, written.cells()), "{name}");
assert_eq!((g.series.as_slice(), g.categories.as_slice()), (&written.series[..], &written.categories[..]), "{name}");
again.execute("select.set", &json!({"ids": [found[0].0]})).unwrap();
again.execute("graph.setData", &json!({"id": found[0].0, "csv": ",2024,2025\nQ1,8,1\nQ2,2,7"})).unwrap();
let after = spec(&again, found[0]);
assert_eq!((after.kind, after.rows.as_slice()), (written.kind, &[vec![8.0, 1.0], vec![2.0, 7.0]][..]), "{name}");
// Each series keeps one fill and the thin white stroke on its marks and its swatch.
for i in 0..2 {
let marks = marks_of(&again, found[0], i);
let white = Paint::solid(vectorcraft_color::Color::WHITE);
assert!(marks.len() > 1 && marks.iter().all(|m| *m == marks[0] && (&m.1, m.2) == (&white, 0.25)), "{name} series {i}: {marks:?}");
}
}
}
/// A graph opened from a `.ai` keeps the bounds of its art without type, so moving one of its labels on its own
+94 -68
View File
@@ -698,6 +698,20 @@ fn clip_shape((frame, room): Clip) -> PathData {
shapes::rectangle(Rect::new(0.0, 0.0, room.0, room.1)).transformed(frame)
}
/// The clipping path an image's file draws it through, with the fill rule its clip group takes:
/// a DCS file's (nonzero) or a PSD or PSB file's (even-odd).
type FileClip = (PathData, FillRule);
/// The clipping path the file of image content `blob` draws it through, in its pixel space, as it
/// was kept when the file was read: a DCS file's ([`ImageBlob::separated_clip`]) or a PSD or PSB
/// file's ([`fileio::png_clip`]).
fn file_clip(blob: &ImageBlob) -> Option<FileClip> {
if let Some(path) = blob.separated_clip() {
return Some((path, FillRule::NonZero));
}
(blob.mime == "image/png").then(|| fileio::png_clip(&blob.bytes)).flatten().map(|path| (path, FillRule::EvenOdd))
}
/// What happens to the clip of an object a link update remakes.
enum ClipTo {
/// It stays as it is.
@@ -705,25 +719,25 @@ enum ClipTo {
/// It is clipped to this path (Placement Options' clip): the clipping path of the clip group
/// holding just it changes, else it goes into a new clip group.
Path(PathData),
/// It is clipped to this path, the clipping path its DCS file draws it through: as [`ClipTo::Path`],
/// except that a plain group holding just it (as [`ClipTo::Off`] leaves one) becomes a clip group
/// again.
File(PathData),
/// It is clipped to this path, the clipping path its file draws it through, under its fill
/// rule: as [`ClipTo::Path`], except that a plain group holding just it (as [`ClipTo::Off`]
/// leaves one) becomes a clip group again.
File(FileClip),
/// It goes into a new clip group of this path, inside the clip group that holds it.
Nest(PathData),
/// Placement Options clip it to `placement` while its DCS file draws it through `file`: it is
Nest(FileClip),
/// Placement Options clip it to `placement` while its file draws it through `file`: it is
/// clipped to `file` as [`ClipTo::File`] clips it, and the clip group holding it is clipped to
/// `placement` as [`ClipTo::Path`] clips an object. With no `file` (the new file lacks the
/// clipping path of the clip group holding it), that group stays as [`ClipTo::Off`] leaves it,
/// clipped to `placement`.
Both { file: Option<PathData>, placement: PathData },
/// Placement Options clip it to `placement` while its DCS file draws it through `file`, and the
Both { file: Option<FileClip>, placement: PathData },
/// Placement Options clip it to `placement` while its file draws it through `file`, and the
/// clip group holding just it is not its old file's: that clip group's clipping path becomes
/// `placement`, and it goes into a new clip group of `file` inside it.
BothInside { file: PathData, placement: PathData },
/// The clipping path of the clip group holding just it goes (a DCS file's clipping path that
/// its new file lacks): the group stays as a plain group of it, with its id, name, visibility
/// and transparency.
BothInside { file: FileClip, placement: PathData },
/// The clipping path of the clip group holding just it goes (its old file's clipping path,
/// which its new file lacks): the group stays as a plain group of it, with its id, name,
/// visibility and transparency.
Off,
}
@@ -756,25 +770,25 @@ fn same_path(a: &PathData, b: &PathData) -> bool {
}
/// The clip an image placed with `old_xf` takes when it shows `img`, read from a file, placed with
/// `new_xf`: Placement Options' clip `clip` when they clip it, and the clipping path a DCS file
/// draws `img` through, the file's clip group inside the placement's. When neither clips it, a clip
/// group holding just it whose clipping path `held` is its old DCS file's (`old_clip`, in the old
/// pixels, under the nonzero rule its clip groups get) goes.
/// `new_xf`: Placement Options' clip `clip` when they clip it, and the clipping path the file
/// (DCS, PSD or PSB) draws `img` through, the file's clip group inside the placement's. When
/// neither clips it, a clip group holding just it whose clipping path `held` is its old file's
/// (`old_clip`, in the old pixels, under the fill rule its clip groups get) goes.
fn clip_to(
old_xf: Affine,
old_clip: Option<&PathData>,
old_clip: Option<&FileClip>,
clip: Option<Clip>,
img: &RasterImage,
new_xf: Affine,
held: Option<(&PathData, FillRule)>,
) -> ClipTo {
// Whether the clip group holding just the image is the old DCS file's: a clipping path whose
// fill rule was changed in the document is not.
// Whether the clip group holding just the image is the old file's: a clipping path whose fill
// rule was changed in the document is not.
let file_held = match (old_clip, held) {
(Some(old), Some((held, rule))) => rule == FillRule::NonZero && same_path(&old.transformed(old_xf), held),
(Some((old, old_rule)), Some((held, rule))) => rule == *old_rule && same_path(&old.transformed(old_xf), held),
_ => false,
};
let file = img.clip.as_ref().map(|path| path.transformed(new_xf));
let file = img.clip.as_ref().map(|(path, rule)| (path.transformed(new_xf), *rule));
if let Some(clip) = clip {
let placement = clip_shape(clip);
return match file {
@@ -831,7 +845,7 @@ impl Nested<'_> {
fn root(&mut self, n: &mut Arc<Node>) {
if !(self.pick)(n) {
if let Some(placement) = self.update(n, true) {
*n = Arc::new(self.clip_group(Arc::clone(n), placement));
*n = Arc::new(self.clip_group(Arc::clone(n), (placement, FillRule::NonZero)));
}
return;
}
@@ -839,7 +853,8 @@ impl Nested<'_> {
let mut new = Arc::new(new);
let _ = self.update(&mut new, true);
*n = match clip {
ClipTo::Path(path) | ClipTo::File(path) | ClipTo::Nest(path) => Arc::new(self.clip_group(new, path)),
ClipTo::Path(path) => Arc::new(self.clip_group(new, (path, FillRule::NonZero))),
ClipTo::File(file) | ClipTo::Nest(file) => Arc::new(self.clip_group(new, file)),
ClipTo::Both { file, placement } => self.clip_both(new, file, placement),
ClipTo::BothInside { file, placement } => self.clip_both(new, Some(file), placement),
ClipTo::Keep | ClipTo::Off => new,
@@ -848,8 +863,8 @@ impl Nested<'_> {
/// `n` (outside the layer tree when `nested`) with the picked objects under it remade; it stays
/// the same node when none is there, and only the nodes on the way to one are copied. The
/// result is Placement Options' clip that `n` itself, now the clip group of a DCS file's
/// clipping path holding a picked object (or the plain group [`ClipTo::Off`] leaves), takes:
/// result is Placement Options' clip that `n` itself, now the clip group of a file's clipping
/// path holding a picked object (or the plain group [`ClipTo::Off`] leaves), takes:
/// the clipping path of the clip group holding just `n` becomes it, else `n` goes into a new
/// clip group of it.
#[must_use]
@@ -880,8 +895,8 @@ impl Nested<'_> {
match (self.update(&mut new, nested), clip_path) {
(None, _) if Arc::ptr_eq(&new, c) => {}
(None, _) => slots.push((i, new)),
(Some(placement), Some(path)) if i == 1 => slots.extend([(0, with_clip(path, placement)), (1, new)]),
(Some(placement), _) => slots.push((i, Arc::new(self.clip_group(new, placement)))),
(Some(placement), Some(path)) if i == 1 => slots.extend([(0, with_clip(path, placement, None)), (1, new)]),
(Some(placement), _) => slots.push((i, Arc::new(self.clip_group(new, (placement, FillRule::NonZero))))),
}
continue;
}
@@ -894,17 +909,22 @@ impl Nested<'_> {
let _ = self.update(&mut new, true);
match (clip, clip_path) {
(ClipTo::Keep, _) => slots.push((i, new)),
(ClipTo::Path(clip) | ClipTo::File(clip), Some(path)) if i == 1 => slots.extend([(0, with_clip(path, clip)), (1, new)]),
(ClipTo::Path(clip), Some(path)) if i == 1 => slots.extend([(0, with_clip(path, clip, None)), (1, new)]),
(ClipTo::File((clip, rule)), Some(path)) if i == 1 => slots.extend([(0, with_clip(path, clip, Some(rule))), (1, new)]),
(ClipTo::File(clip), None) if plain => reclipped = Some((clip, new)),
(ClipTo::Path(clip) | ClipTo::File(clip) | ClipTo::Nest(clip), _) => {
(ClipTo::Path(clip), _) => {
let group = self.clip_group(new, (clip, FillRule::NonZero));
slots.push((i, Arc::new(group)));
}
(ClipTo::File(clip) | ClipTo::Nest(clip), _) => {
let group = self.clip_group(new, clip);
slots.push((i, Arc::new(group)));
}
(ClipTo::Off, Some(_)) if i == 1 => declipped = Some(new),
(ClipTo::Off, _) => slots.push((i, new)),
// The file's clip group stays `n`, and the placement's clip goes around it.
(ClipTo::Both { file: Some(file), placement }, Some(path)) if i == 1 => {
slots.extend([(0, with_clip(path, file)), (1, new)]);
(ClipTo::Both { file: Some((file, rule)), placement }, Some(path)) if i == 1 => {
slots.extend([(0, with_clip(path, file, Some(rule))), (1, new)]);
around = Some(placement);
}
(ClipTo::Both { file: Some(file), placement }, None) if plain => {
@@ -917,7 +937,7 @@ impl Nested<'_> {
}
(ClipTo::BothInside { file, placement }, Some(path)) if i == 1 => {
let group = self.clip_group(new, file);
slots.extend([(0, with_clip(path, placement)), (1, Arc::new(group))]);
slots.extend([(0, with_clip(path, placement, None)), (1, Arc::new(group))]);
}
(ClipTo::Both { file, placement }, _) => slots.push((i, self.clip_both(new, file, placement))),
(ClipTo::BothInside { file, placement }, _) => slots.push((i, self.clip_both(new, Some(file), placement))),
@@ -958,27 +978,28 @@ impl Nested<'_> {
/// A clip group of `placement` holding `object`, inside a clip group of `file` when there is a
/// `file` ([`ClipTo::Both`] for an object no clip group holds yet).
fn clip_both(&mut self, object: Arc<Node>, file: Option<PathData>, placement: PathData) -> Arc<Node> {
fn clip_both(&mut self, object: Arc<Node>, file: Option<FileClip>, placement: PathData) -> Arc<Node> {
let object = match file {
Some(file) => Arc::new(self.clip_group(object, file)),
None => object,
};
Arc::new(self.clip_group(object, placement))
Arc::new(self.clip_group(object, (placement, FillRule::NonZero)))
}
/// A clip group of `object` clipped to `clip`, as [`clip_image_to`] makes one in the layers.
fn clip_group(&mut self, object: Arc<Node>, clip: PathData) -> Node {
/// A clip group of `object` clipped to `clip` under its fill rule, as [`new_clip_group`] makes
/// one in the layers.
fn clip_group(&mut self, object: Arc<Node>, clip: FileClip) -> Node {
let path = self.clipping_path(clip);
let group_id = NodeId(self.next);
self.next += 1;
Node::new(group_id, NodeKind::Group { children: vec![Arc::new(path), object], clip: true })
}
/// A clipping path of `clip`, with the next node id.
fn clipping_path(&mut self, clip: PathData) -> Node {
/// A clipping path of `clip` under its fill rule, with the next node id.
fn clipping_path(&mut self, (clip, rule): FileClip) -> Node {
let id = NodeId(self.next);
self.next += 1;
clipping_path(id, clip)
clipping_path(id, clip, rule)
}
}
@@ -1082,9 +1103,9 @@ fn placed_xf(xf: Affine, old: (f64, f64), old_pt: (f64, f64), new: (f64, f64), n
(frame * at * Affine::scale_non_uniform(size.0 / nw, size.1 / nh), (o.clip && over).then_some((frame, room)))
}
/// The clipping path of the clip group of `d` holding just object `id` becomes `path`; false when
/// no such clip group holds it.
fn set_clip_path(d: &mut Document, id: NodeId, path: PathData) -> bool {
/// The clipping path of the clip group of `d` holding just object `id` becomes `path`, under fill
/// rule `rule` when one is given; false when no such clip group holds it.
fn set_clip_path(d: &mut Document, id: NodeId, path: PathData, rule: Option<FillRule>) -> bool {
let clip_path = d.parent_of(id).and_then(|p| match &d.node(p)?.kind {
NodeKind::Group { children, clip: true } => match &children[..] {
[c, im] if im.id == id && matches!(c.kind, NodeKind::Path { clipping: true, .. }) => Some(c.id),
@@ -1093,8 +1114,9 @@ fn set_clip_path(d: &mut Document, id: NodeId, path: PathData) -> bool {
_ => None,
});
let Some(c) = clip_path else { return false };
if let Some(Node { kind: NodeKind::Path { path: p, .. }, .. }) = d.node_mut(c) {
if let Some(Node { kind: NodeKind::Path { path: p, rule: r, .. }, .. }) = d.node_mut(c) {
*p = path;
*r = rule.unwrap_or(*r);
}
true
}
@@ -1108,25 +1130,25 @@ fn clip_image(d: &mut Document, id: NodeId, clip: Clip) -> Result<()> {
/// Clip object `id` of `d` to `path`: the clipping path of the clip group holding just it changes,
/// else it goes into a new clip group.
fn clip_image_to(d: &mut Document, id: NodeId, path: PathData) -> Result<()> {
if set_clip_path(d, id, path.clone()) {
if set_clip_path(d, id, path.clone(), None) {
return Ok(());
}
new_clip_group(d, id, path)
new_clip_group(d, id, (path, FillRule::NonZero))
}
/// Clip object `id` of `d` to `path`, the clipping path its DCS file draws it through: the clipping
/// path of the clip group holding just it changes, a plain group holding just it (as [`unclip`]
/// leaves one) becomes a clip group again, else it goes into a new clip group.
fn clip_file_to(d: &mut Document, id: NodeId, path: PathData) -> Result<()> {
if set_clip_path(d, id, path.clone()) {
/// Clip object `id` of `d` to `path`, the clipping path its file draws it through, under its fill
/// rule: the clipping path of the clip group holding just it changes, a plain group holding just it
/// (as [`unclip`] leaves one) becomes a clip group again, else it goes into a new clip group.
fn clip_file_to(d: &mut Document, id: NodeId, (path, rule): FileClip) -> Result<()> {
if set_clip_path(d, id, path.clone(), Some(rule)) {
return Ok(());
}
let plain = d.parent_of(id).filter(|g| match d.node(*g).map(|n| &n.kind) {
Some(NodeKind::Group { children, clip: false }) => matches!(&children[..], [o] if o.id == id),
_ => false,
});
let Some(g) = plain else { return new_clip_group(d, id, path) };
let clip = clipping_path(d.alloc_id(), path);
let Some(g) = plain else { return new_clip_group(d, id, (path, rule)) };
let clip = clipping_path(d.alloc_id(), path, rule);
d.insert(Some(g), 0, clip)?;
if let Some(Node { kind: NodeKind::Group { clip, .. }, .. }) = d.node_mut(g) {
*clip = true;
@@ -1134,30 +1156,33 @@ fn clip_file_to(d: &mut Document, id: NodeId, path: PathData) -> Result<()> {
Ok(())
}
/// Clipping path `path` (a node) with its path changed to `clip`.
fn with_clip(path: &Node, clip: PathData) -> Arc<Node> {
/// Clipping path `path` (a node) with its path changed to `clip`, and its fill rule to `rule` when
/// one is given.
fn with_clip(path: &Node, clip: PathData, rule: Option<FillRule>) -> Arc<Node> {
let mut path = Node::clone(path);
if let NodeKind::Path { path: p, .. } = &mut path.kind {
if let NodeKind::Path { path: p, rule: r, .. } = &mut path.kind {
*p = clip;
*r = rule.unwrap_or(*r);
}
Arc::new(path)
}
/// A clipping path `id` of `path`, unpainted.
fn clipping_path(id: NodeId, path: PathData) -> Node {
/// A clipping path `id` of `path` under fill rule `rule`, unpainted.
fn clipping_path(id: NodeId, path: PathData, rule: FillRule) -> Node {
let none = vectorcraft_color::Paint::None;
let mut clip = Node::path(id, path, Appearance::basic(none.clone(), none, 0.0));
if let NodeKind::Path { clipping, .. } = &mut clip.kind {
if let NodeKind::Path { clipping, rule: r, .. } = &mut clip.kind {
*clipping = true;
*r = rule;
}
clip
}
/// Put object `id` of `d` into a new clip group of `path`, where it is.
fn new_clip_group(d: &mut Document, id: NodeId, path: PathData) -> Result<()> {
/// Put object `id` of `d` into a new clip group of `path`, under its fill rule, where it is.
fn new_clip_group(d: &mut Document, id: NodeId, (path, rule): FileClip) -> Result<()> {
let (par, index, _) = d.position(id).ok_or(EngineError::NoNode(id))?;
let image = d.remove(id)?;
let clip = clipping_path(d.alloc_id(), path);
let clip = clipping_path(d.alloc_id(), path, rule);
let group = Node::new(d.alloc_id(), NodeKind::Group { children: vec![std::sync::Arc::new(clip), image], clip: true });
d.insert(par, index, group)?;
Ok(())
@@ -1186,15 +1211,15 @@ fn install(d: &mut Document, ids: &[NodeId], (link, img): FileRead, force: Optio
let nested = nested_ids(d, ids);
if also.is_some() || !nested.is_empty() {
let pick = |n: &Node| matches!(n.kind, NodeKind::Image(_)) && (nested.contains(&n.id) || also.is_some_and(|also| shows(n, also, false)));
// The resolution of each content the images picked show, and the clipping path its DCS file
// The resolution of each content the images picked show, and the clipping path its file
// drew it through, looked up once each.
let mut old: BTreeMap<String, ((f64, f64), Option<PathData>)> = BTreeMap::new();
let mut old: BTreeMap<String, ((f64, f64), Option<FileClip>)> = BTreeMap::new();
d.visit_stored(|n, _| {
if let NodeKind::Image(im) = &n.kind
&& pick(n)
&& !old.contains_key(&im.key)
{
old.insert(im.key.clone(), (file_pt(d, &im.key), d.images.get(&im.key).and_then(ImageBlob::separated_clip)));
old.insert(im.key.clone(), (file_pt(d, &im.key), d.images.get(&im.key).and_then(file_clip)));
}
});
let mut make = |n: &Node, held: Option<(&PathData, FillRule)>| {
@@ -1220,8 +1245,9 @@ fn install(d: &mut Document, ids: &[NodeId], (link, img): FileRead, force: Optio
let o = PlacementOptions { preserve: force.unwrap_or(im.placement.preserve), ..im.placement };
let size = |w: u32, h: u32| (w as f64, h as f64);
let (xf, clip) = placed_xf(im.xf, size(im.width, im.height), file_pt(d, &im.key), size(img.width, img.height), new_pt, o);
// Placement Options' clip, else a DCS file's clipping path, read again with its plates.
let old_clip = d.images.get(&im.key).and_then(ImageBlob::separated_clip);
// Placement Options' clip, else the clipping path of a DCS file (read again with its
// plates) or of a PSD or PSB file.
let old_clip = d.images.get(&im.key).and_then(file_clip);
clips.push((*id, clip_to(im.xf, old_clip.as_ref(), clip, &img, xf, clip_path_of(d, *id))));
if let Some(n) = d.node_mut(*id)
&& let NodeKind::Image(im) = &mut n.kind
@@ -1235,8 +1261,8 @@ fn install(d: &mut Document, ids: &[NodeId], (link, img): FileRead, force: Optio
clips.into_iter().try_for_each(|(id, clip)| match clip {
ClipTo::Keep => Ok(()),
ClipTo::Path(path) => clip_image_to(d, id, path),
ClipTo::File(path) => clip_file_to(d, id, path),
ClipTo::Nest(path) => new_clip_group(d, id, path),
ClipTo::File(file) => clip_file_to(d, id, file),
ClipTo::Nest(file) => new_clip_group(d, id, file),
ClipTo::Off => unclip(d, id),
ClipTo::Both { file, placement } => {
match file {
+1 -1
View File
@@ -38,7 +38,7 @@ pub use commands::specs;
pub(super) use compound::{as_clipping_path, make_clipping_path, release_clip};
pub(crate) use pixelgrid::{
align_new_object, can_align, keep_aligned_in, keep_compound_aligned, keep_pixel_aligned, refresh as refresh_pixel_aligned, resnap,
snap_if_aligned,
snap_if_aligned, snap_symbol_art,
};
pub(super) use shape::recut;
pub(crate) use transform::{apply_transform, preview_copies, scaling, transform_node, transform_patterns, transforms_objects};
+241 -2
View File
@@ -1,6 +1,9 @@
//! Transform panel › Align to Pixel Grid: an object's pixel-aligned property, and the snapping that
//! keeps the horizontal and vertical segments of a pixel-aligned object on the pixel grid
//! (<https://helpx.adobe.com/illustrator/desktop/get-started/learn-the-basics/pixel-preview-mode-for-web-graphics.html>).
//! (<https://helpx.adobe.com/illustrator/desktop/get-started/learn-the-basics/pixel-preview-mode-for-web-graphics.html>),
//! and Symbol Options › Align to Pixel Grid, which keeps a symbol's instances on the pixel grid.
use std::collections::HashMap;
use vectorcraft_doc::{AppearanceItem, LiveShape, StrokeAlign};
@@ -150,10 +153,234 @@ pub(crate) fn refresh(before: &Document, doc: &mut Document) {
keep_pixel_aligned(n, Scaling::default());
}
}
refresh_symbols(before, doc);
}
/// How far the linear part of an instance's transform may be from its symbol's natural size, as a
/// fraction of that size, for the instance to count as placed at actual size.
const ACTUAL_SIZE_TOLERANCE: f64 = 1e-9;
/// After any edit: Symbol Options › Align to Pixel Grid. The art of a pixel-aligned symbol snaps to
/// the pixel grid at the symbol's natural size ([`snap_symbol_art`]) when the symbol becomes
/// pixel-aligned, when its art or natural size changes, and when symbol editing mode for it ends
/// (while it is edited, the art snaps as the editing layer is written back to it). Every instance
/// of such a symbol then goes to whole points ([`snap_instance`]), and so does each instance of a
/// pixel-aligned symbol in an object the edit changed or added, the art of opacity masks included.
/// An instance in another symbol's art is placed by that symbol's instances and is left as it is.
/// A document without pixel-aligned symbols is not walked.
fn refresh_symbols(before: &Document, doc: &mut Document) {
let aligned = doc.pixel_aligned_symbols();
if aligned.is_empty() {
return;
}
let was = before.pixel_aligned_symbols();
let edited_before = before.symbol_edit.as_ref().map(|e| e.symbol.as_str());
let mut every = false;
for name in &aligned {
let art_before = before.symbols.iter().find(|s| &s.name == name).map(|s| &s.art);
let art_now = doc.symbols.iter().find(|s| &s.name == name).map(|s| &s.art);
let art_changed = match (art_before, art_now) {
(Some(b), Some(a)) => !Arc::ptr_eq(b, a),
_ => true,
};
let size_changed = before.symbol_natural_xf(name) != doc.symbol_natural_xf(name);
if !was.contains(name) || edited_before == Some(name.as_str()) || art_changed || size_changed {
snap_symbol_art(doc, name);
every = true;
}
}
let natural: HashMap<String, Affine> = aligned.iter().map(|name| (name.clone(), doc.symbol_natural_xf(name))).collect();
if every {
for layer in doc.layers.iter_mut() {
if holds_instance(layer, &natural) {
snap_instances_in(Arc::make_mut(layer), &natural);
}
}
return;
}
let (mut ids, mut masked) = (vec![], vec![]);
changed_instances(&before.layers, &doc.layers, &natural, &mut ids, &mut masked);
for id in ids {
if let Some(n) = doc.node_mut(id) {
snap_instance(n, &natural);
}
}
for id in masked {
if let Some(m) = doc.node_mut(id).and_then(|n| n.extras_if_any()).and_then(|e| e.mask.as_mut()) {
snap_instances_in(Arc::make_mut(&mut m.art), &natural);
}
}
}
/// Among the objects of `after` that differ from their counterparts in `before` (or are new), in
/// groups too: the instances of the symbols in `natural` (`ids`), and the objects whose opacity
/// mask art holds such instances (`masked`).
fn changed_instances(before: &[Arc<Node>], after: &[Arc<Node>], natural: &HashMap<String, Affine>, ids: &mut Vec<NodeId>, masked: &mut Vec<NodeId>) {
let mut by_id: Option<HashMap<NodeId, &Arc<Node>>> = None;
for (i, a) in after.iter().enumerate() {
let b = match before.get(i) {
Some(b) if b.id == a.id => Some(b),
_ => by_id.get_or_insert_with(|| before.iter().map(|b| (b.id, b)).collect()).get(&a.id).copied(),
};
if b.is_some_and(|b| Arc::ptr_eq(b, a)) {
continue;
}
if a.extras().mask.as_ref().is_some_and(|m| holds_instance(&m.art, natural)) {
masked.push(a.id);
}
if let NodeKind::SymbolInstance { symbol, .. } = &a.kind {
if natural.contains_key(symbol) {
ids.push(a.id);
}
} else if let Some(children) = a.children() {
changed_instances(b.and_then(|b| b.children()).map_or(&[], Vec::as_slice), children, natural, ids, masked);
}
}
}
/// Whether `n`, an object in it or the art of an opacity mask in it is an instance of a symbol in
/// `natural`.
fn holds_instance(n: &Node, natural: &HashMap<String, Affine>) -> bool {
matches!(&n.kind, NodeKind::SymbolInstance { symbol, .. } if natural.contains_key(symbol))
|| n.extras().mask.as_ref().is_some_and(|m| holds_instance(&m.art, natural))
|| n.children().is_some_and(|ch| ch.iter().any(|c| holds_instance(c, natural)))
}
/// [`snap_instance`] on every instance of a symbol in `natural` in `n`, the art of its opacity
/// masks included. Only what holds such an instance is copied for editing.
fn snap_instances_in(n: &mut Node, natural: &HashMap<String, Affine>) {
snap_instance(n, natural);
if let Some(m) = n.extras_if_any().and_then(|e| e.mask.as_mut())
&& holds_instance(&m.art, natural)
{
snap_instances_in(Arc::make_mut(&mut m.art), natural);
}
if let Some(children) = n.children_mut() {
for c in children.iter_mut() {
if holds_instance(c, natural) {
snap_instances_in(Arc::make_mut(c), natural);
}
}
}
}
/// Snap the art of pixel-aligned symbol `name` to the pixel grid as it is drawn at the symbol's
/// natural size: each path and compound path in it snaps as a pixel-aligned object does
/// ([`snap_object`]), measured from the symbol's origin. The art is stored again only when
/// something in it moved, and the answer says whether it did.
pub(crate) fn snap_symbol_art(doc: &mut Document, name: &str) -> bool {
let natural = doc.symbol_natural_xf(name);
let det = natural.determinant();
if !det.is_finite() || det.abs() < 1e-18 {
return false;
}
let Some(sym) = doc.symbols.iter_mut().find(|s| s.name == name) else { return false };
// Instances draw the art's strokes at their stored width, and the art of unlinked opacity
// masks, which `Node::transform` leaves alone, at the natural size too.
let mut art = (*sym.art).clone();
art.transform(natural, false);
transform_unlinked_masks(&mut art, natural);
if !snap_art(&mut art) {
return false;
}
let inverse = natural.inverse();
art.transform(inverse, false);
transform_unlinked_masks(&mut art, inverse);
sym.art = Arc::new(art);
true
}
/// Transform the art of every unlinked opacity mask in `n` by `xf`, in the art of other masks
/// too. Only what holds such a mask is copied for editing.
fn transform_unlinked_masks(n: &mut Node, xf: Affine) {
if let Some(m) = n.extras_if_any().and_then(|e| e.mask.as_mut())
&& holds_unlinked_mask(&m.art, !m.linked)
{
let linked = m.linked;
let art = Arc::make_mut(&mut m.art);
if !linked {
art.transform(xf, false);
}
transform_unlinked_masks(art, xf);
}
if let Some(children) = n.children_mut() {
for c in children.iter_mut() {
if holds_unlinked_mask(c, false) {
transform_unlinked_masks(Arc::make_mut(c), xf);
}
}
}
}
/// Whether `n` is the art of an unlinked mask (`unlinked`), or it or an object in it, in the art of
/// its masks too, has an unlinked opacity mask.
fn holds_unlinked_mask(n: &Node, unlinked: bool) -> bool {
unlinked
|| n.extras().mask.as_ref().is_some_and(|m| holds_unlinked_mask(&m.art, !m.linked))
|| n.children().is_some_and(|ch| ch.iter().any(|c| holds_unlinked_mask(c, false)))
}
/// Snap every path and compound path in `n` ([`can_align`]) with [`snap_object`], the art of
/// opacity masks included (those of a compound path's paths too). Returns whether anything
/// changed.
fn snap_art(n: &mut Node) -> bool {
let mut moved = false;
if can_align(n) {
let was = n.clone();
snap_object(n, Scaling::default());
moved = *n != was;
if let Some(children) = n.children_mut() {
for c in children.iter_mut() {
if c.extras().mask.is_some() {
moved |= snap_mask(Arc::make_mut(c));
}
}
}
} else if let Some(children) = n.children_mut() {
for c in children.iter_mut() {
moved |= snap_art(Arc::make_mut(c));
}
}
// After the object itself, which a linked mask follows.
snap_mask(n) || moved
}
/// [`snap_art`] on the art of `n`'s opacity mask. Returns whether anything changed.
fn snap_mask(n: &mut Node) -> bool {
let Some(m) = n.extras_if_any().and_then(|e| e.mask.as_mut()) else { return false };
let mut art = (*m.art).clone();
if !snap_art(&mut art) {
return false;
}
m.art = Arc::new(art);
true
}
/// Move symbol instance `n` to whole points when its transform places its symbol's art at the
/// symbol's natural size (`natural`, by symbol name), reflected across one axis or not. A scaled,
/// rotated (a half turn included) or sheared instance stays where it is.
fn snap_instance(n: &mut Node, natural: &HashMap<String, Affine>) {
let NodeKind::SymbolInstance { symbol, xf } = &mut n.kind else { return };
let Some(nat) = natural.get(symbol.as_str()) else { return };
let [a, b, c, d, e, f] = xf.as_coeffs();
let [na, _, _, nd, _, _] = nat.as_coeffs();
let near = |v: f64, to: f64| (v.abs() - to.abs()).abs() <= ACTUAL_SIZE_TOLERANCE * to.abs().max(1.0);
let actual =
near(a, na) && near(d, nd) && b.abs() <= ACTUAL_SIZE_TOLERANCE * na.abs().max(1.0) && c.abs() <= ACTUAL_SIZE_TOLERANCE * nd.abs().max(1.0);
// Flipped along both axes is a half turn, which counts as rotated.
let half_turn = a * na < 0.0 && d * nd < 0.0;
if !actual || half_turn || !e.is_finite() || !f.is_finite() {
return;
}
let (x, y) = (e.round(), f.round());
if x != e || y != f {
*xf = Affine::new([a, b, c, d, x, y]);
}
}
/// After a pass that moved what objects `ids` hold (Objects on Path placing its members): snap the
/// pixel-aligned objects in them to the pixel grid again.
/// pixel-aligned objects and the instances of pixel-aligned symbols in them to the pixel grid
/// again.
pub(crate) fn keep_aligned_in(doc: &mut Document, ids: &[NodeId]) {
for id in ids {
if doc.node(*id).is_some_and(holds_aligned)
@@ -162,6 +389,18 @@ pub(crate) fn keep_aligned_in(doc: &mut Document, ids: &[NodeId]) {
keep_pixel_aligned(n, Scaling::default());
}
}
let aligned = doc.pixel_aligned_symbols();
if aligned.is_empty() {
return;
}
let natural: HashMap<String, Affine> = aligned.iter().map(|name| (name.clone(), doc.symbol_natural_xf(name))).collect();
for id in ids {
if doc.node(*id).is_some_and(|n| holds_instance(n, &natural))
&& let Some(n) = doc.node_mut(*id)
{
snap_instances_in(n, &natural);
}
}
}
/// The objects of `after` that differ from their counterparts in `before` (or are new) and are
+5 -1
View File
@@ -67,7 +67,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Character / Paragraph",
[],
None,
"{ids?|id?, kerning?: 1/1000 em|\"auto\"|\"optical\", baselineShift?: pt, hScale?: %, vScale?: %, rotation?: deg counter-clockwise (0: upright), underline?, strikethrough?, allCaps?, smallCaps?: bool, position?: \"normal\"|\"superscript\"|\"subscript\" (sizes from Document Setup), antiAlias?: \"none\"|\"sharp\"|\"crisp\"|\"strong\" (Character panel › Anti-aliasing Method, how the type's edges are drawn as pixels; it sets each targeted type object, with or without a range; each frame of a thread keeps its own method; graph labels keep it for every label of their kind when the graph is drawn again; new type: \"sharp\"), leftIndent?, rightIndent?, firstLineIndent?, spaceBefore?, spaceAfter?: pt (±1296), list?: \"none\"|\"bullet\"|\"number\", bullet?: \"none\"|\"dot\"|\"dash\"|\"circle\"|\"square\", number?: \"none\"|\"arabic\"|\"upperLetters\"|\"lowerLetters\"|\"upperRoman\"|\"lowerRoman\"|\"twoDigits\"|\"threeDigits\", listAlign?: \"left\"|\"right\", listLevel?: 1..9 (Paragraph panel › Bullets and Numbered List: each paragraph of a list starts with its marker, drawn in the font, size and color of the paragraph's first character, and its text starts at the next tab stop after the marker, the left indent counting as a stop; a bulleted list's marker is its bullet, and a numbered list's is the paragraph's number and a period: 1, 2, 3; A to Z, then AA, BB; a to z, then aa, bb; I, II, III; i, ii, iii; 01 to 99, then 100; 001 to 999, then 1000; letters and roman numerals past 3999 in Arabic digits; the numbers count the story's numbered paragraphs, its threaded frames included, from 1 after a paragraph in no list, and an empty or bulleted paragraph is not counted; list \"bullet\" keeps a list's bullet, else a dot, and list \"number\" keeps a numbered list's style, else arabic; without list, a number style makes a numbered list and a bullet makes a bulleted one; \"none\" in any of the three turns the list off; a paragraph that joins a list with left and first-line indents of 0 gets 18 and -18 unless the call sets an indent; a horizontal right-to-left list paragraph has its indents mirrored, measured from the right; listAlign \"right\" (Bullets and Numbering…'s Alignment) puts the marker against the text, and \"left\" (the default) puts it at the first line's start, the text starting at the same place with either; it sets the paragraphs that are in a list or that the call puts in one, and a list keeps it when it changes between bullets and numbers; listLevel (Tab and Shift+Tab at the start of a list paragraph, Bullets and Numbering…'s Level) is a whole number from 1 to 9 that sets the paragraphs in a list or that the call puts in one, a list keeping it when it changes between bullets and numbers, and a list turned on without listLevel starting at level 1; each level past the first sets the paragraph 18 pt further in than its left indent, and each level counts its own numbers: a list paragraph with text sets the counts of the levels deeper than its own back to 0, so a deeper numbered paragraph after it counts from 1, and a paragraph back at a shallower level goes on with that level's count), hyphenate?: bool, wordsLongerThan?: letters 1..25 (5), afterFirst?, beforeLast?: letters 1..15 (3), hyphenLimit?: lines 0..25 (0: no limit), hyphenationZone?: pt 0..1296 (0; Single-line Composer only), hyphenateCapitalized?: bool (true) (Paragraph panel menu › Hyphenation…: only words longer than wordsLongerThan break, keeping afterFirst letters before the hyphen and beforeLast after it; at most hyphenLimit lines in a row end with a hyphen; a line whose text already ends within hyphenationZone of its right edge breaks before the next word instead of hyphenating it; the counts are rounded, and every value is clamped to its range), wordSpacing?: % 0..1000 (80, 100, 133), letterSpacing?: % of a word space -100..500 (0, 0, 0), glyphScaling?: % 50..200 (100, 100, 100): each [min, desired, max] or {min?, desired?, max?} (Paragraph panel menu › Justification…: Desired applies to every line, Minimum and Maximum bound what justified lines may use; values are clamped to their range, and Minimum ≤ Desired ≤ Maximum must hold afterwards or nothing changes), autoLeading?: % of the size 0..500 (120; the leading of characters whose leading is Auto), singleWordJustification?: \"fullJustify\"|\"alignLeft\"|\"alignCenter\"|\"alignRight\" (a justified line holding one word), mojikumi?: \"none\"|\"yakumonoHankaku\"|\"gyomatsuYakumonoHankaku\"|\"gyomatsuYakumonoZenkaku\"|\"yakumonoZenkaku\"|\"lineEndHalf\" (Mojikumi Set: Japanese punctuation spacing), kinsoku?: \"none\"|\"hard\"|\"soft\" (Kinsoku Set: Soft lets 々, ー and small kana start a line), kinsokuType?: \"pushInFirst\"|\"pushOutFirst\"|\"pushOutOnly\" (Paragraph panel menu › Kinsoku Shori Type: how area type keeps those characters off a line's ends; pushInFirst sets them on the line when its gaps next to CJK characters can close up enough, by at most a tent Line truncated
"{ids?|id?, kerning?: 1/1000 em|\"auto\"|\"optical\", baselineShift?: pt, hScale?: %, vScale?: %, rotation?: deg counter-clockwise (0: upright), underline?, strikethrough?, allCaps?, smallCaps?: bool, position?: \"normal\"|\"superscript\"|\"subscript\" (sizes from Document Setup), antiAlias?: \"none\"|\"sharp\"|\"crisp\"|\"strong\" (Character panel › Anti-aliasing Method, how the type's edges are drawn as pixels; it sets each targeted type object, with or without a range; each frame of a thread keeps its own method; graph labels keep it for every label of their kind when the graph is drawn again; new type: \"sharp\"), leftIndent?, rightIndent?, firstLineIndent?, spaceBefore?, spaceAfter?: pt (±1296), list?: \"none\"|\"bullet\"|\"number\", bullet?: \"none\"|\"dot\"|\"dash\"|\"circle\"|\"square\", number?: \"none\"|\"arabic\"|\"upperLetters\"|\"lowerLetters\"|\"upperRoman\"|\"lowerRoman\"|\"twoDigits\"|\"threeDigits\", listAlign?: \"left\"|\"right\", listLevel?: 1..9 (Paragraph panel › Bullets and Numbered List: each paragraph of a list starts with its marker, drawn in the font, size and color of the paragraph's first character, and its text starts at the next tab stop after the marker, the left indent counting as a stop; a bulleted list's marker is its bullet, and a numbered list's is the paragraph's number and a period: 1, 2, 3; A to Z, then AA, BB; a to z, then aa, bb; I, II, III; i, ii, iii; 01 to 99, then 100; 001 to 999, then 1000; letters and roman numerals past 3999 in Arabic digits; the numbers count the story's numbered paragraphs, its threaded frames included, from 1 after a paragraph in no list, and an empty or bulleted paragraph is not counted; list \"bullet\" keeps a list's bullet, else a dot, and list \"number\" keeps a numbered list's style, else arabic; without list, a number style makes a numbered list and a bullet makes a bulleted one; \"none\" in any of the three turns the list off; a paragraph that joins a list with left and first-line indents of 0 gets 18 and -18 unless the call sets an indent; a horizontal right-to-left list paragraph has its indents mirrored, measured from the right; listAlign \"right\" (Bullets and Numbering…'s Alignment) puts the marker against the text, and \"left\" (the default) puts it at the first line's start, the text starting at the same place with either; it sets the paragraphs that are in a list or that the call puts in one, and a list keeps it when it changes between bullets and numbers; listLevel (Tab and Shift+Tab at the start of a list paragraph, Bullets and Numbering…'s Level) is a whole number from 1 to 9 that sets the paragraphs in a list or that the call puts in one, a list keeping it when it changes between bullets and numbers, and a list turned on without listLevel starting at level 1; each level past the first sets the paragraph 18 pt further in than its left indent, and each level counts its own numbers: a list paragraph with text sets the counts of the levels deeper than its own back to 0, so a deeper numbered paragraph after it counts from 1, and a paragraph back at a shallower level goes on with that level's count), hyphenate?: bool, wordsLongerThan?: letters 1..25 (5), afterFirst?, beforeLast?: letters 1..15 (3), hyphenLimit?: lines 0..25 (0: no limit), hyphenationZone?: pt 0..1296 (0; Single-line Composer only), hyphenateCapitalized?: bool (true) (Paragraph panel menu › Hyphenation…: only words longer than wordsLongerThan break, keeping afterFirst letters before the hyphen and beforeLast after it; at most hyphenLimit lines in a row end with a hyphen; a line whose text already ends within hyphenationZone of its right edge breaks before the next word instead of hyphenating it; the counts are rounded, and every value is clamped to its range), wordSpacing?: % 0..1000 (80, 100, 133), letterSpacing?: % of a word space -100..500 (0, 0, 0), glyphScaling?: % 50..200 (100, 100, 100): each [min, desired, max] or {min?, desired?, max?} (Paragraph panel menu › Justification…: Desired applies to every line, Minimum and Maximum bound what justified lines may use; values are clamped to their range, and Minimum ≤ Desired ≤ Maximum must hold afterwards or nothing changes), autoLeading?: % of the size 0..500 (120; the leading of characters whose leading is Auto), singleWordJustification?: \"fullJustify\"|\"alignLeft\"|\"alignCenter\"|\"alignRight\" (a justified line holding one word), mojikumi?: \"none\"|\"yakumonoHankaku\"|\"gyomatsuYakumonoHankaku\"|\"gyomatsuYakumonoZenkaku\"|\"yakumonoZenkaku\"|\"lineEndHalf\" (Mojikumi Set: Japanese punctuation spacing), kinsoku?: \"none\"|\"hard\"|\"soft\" (Kinsoku Set: Soft lets 々, ー and small kana start a line), kinsokuType?: \"pushInFirst\"|\"pushOutFirst\"|\"pushOutOnly\" (Paragraph panel menu › Kinsoku Shori Type: how area type keeps those characters off a line's ends; pushInFirst sets them on the line when its gaps next to CJK characters can close up enough, by at most a tent Line truncated
has_doc,
set_format
),
@@ -522,6 +522,7 @@ fn set_format(s: &mut Session, p: &Value) -> Result<Value> {
"romanHangingPunctuation",
"koreanLineBreakAnywhere",
"bunriKinshi",
"kurikaeshiMojiShori",
],
C,
)?;
@@ -597,6 +598,7 @@ fn set_format(s: &mut Session, p: &Value) -> Result<Value> {
"kinsoku",
"kinsokuType",
"bunriKinshi",
"kurikaeshiMojiShori",
"direction",
"leadingModel",
"charAlign",
@@ -995,6 +997,8 @@ fn set_format(s: &mut Session, p: &Value) -> Result<Value> {
if let Some(v) = flag("bunriKinshi") {
para.bunri_kinshi = v;
}
// An omitted or null value keeps the paragraph's own.
para.kurikaeshi_moji_shori = flag("kurikaeshiMojiShori").unwrap_or(para.kurikaeshi_moji_shori);
if let Some(v) = direction {
para.direction = v;
}
+1 -1
View File
@@ -318,7 +318,7 @@ pub(crate) fn style_of(n: &Node) -> Style {
/// Leaf shapes (paths, compound paths, text) of a subtree in paint order; guides and clipping
/// paths are skipped.
fn leaves(n: &Node, out: &mut Vec<Node>) {
pub(crate) fn leaves(n: &Node, out: &mut Vec<Node>) {
each_leaf(n, &mut |l| out.push(l.clone()));
}
+1 -1
View File
@@ -306,7 +306,7 @@ fn load_into(p: &Value, cmd: &str, board: Option<Rect>, link_pdf: bool, slices_o
let link = src.path.filter(|_| !embed).map(|path| super::links::link_info(path, &src.bytes));
let mut warnings: Vec<String> = unread.into_iter().chain(fileio::size_note(&img.blob.bytes)).collect();
*slices_out = psd_slices(slices_from, natural, &mut warnings);
let clip = fileio::psdread::clipping_path(&src.bytes);
let clip = img.clip.clone().map(|(path, _)| path);
return Ok(Loaded { name, format, art: Art::Image(img, clip), natural, warnings, link, board: None });
}
if pdf {
+1
View File
@@ -104,6 +104,7 @@ pub(crate) fn read(bytes: &[u8], path: Option<&str>) -> Result<DcsArt> {
};
let blob = ImageBlob::separated_tiff_clipped(&p.separated, p.ppi, &files, clip.as_ref())
.ok_or_else(|| EngineError::Other("the plates can't be kept".into()))?;
let clip = clip.map(|path| (path, vectorcraft_geom::FillRule::NonZero));
let img = RasterImage { key: blob.content_key(), blob, width: p.separated.width, height: p.separated.height, ppi: p.ppi, clip };
let spots = p.separated.spots().map(|s| (s.name.clone(), s.cmyk)).collect();
Ok(DcsArt { img, xf: p.xf, page: p.page, clip: p.clip, spots, warnings: p.warnings })
@@ -624,6 +624,7 @@ pub(super) const ALLOWED: &[&str] = &[
"text.fonts",
"text.getRange",
"text.glyphAlternates",
"text.glyphCategories",
"text.insertInline",
"text.missingFonts",
"text.replaceFont",
+7 -4
View File
@@ -52,7 +52,7 @@ pub fn specs() -> Vec<CommandSpec> {
"Randomize Colors",
[],
None,
"{map: rows as recolor.apply, order?: true (shuffle the new colours among the rows that aren't excluded), saturationBrightness?: false (random saturation and brightness, hue kept), seed?: 0} → {map: the rows with their new colours as keys}",
"{map: rows as recolor.apply (an excluded row, or a row whose from is empty, keeps its new color), order?: true (shuffle the new colours among the rows that aren't excluded and hold current colors), saturationBrightness?: false (random saturation and brightness, hue kept), seed?: 0} → {map: the rows with their new colours as keys}",
always,
randomize
),
@@ -1746,8 +1746,11 @@ fn randomize(_: &mut Session, p: &Value) -> Result<Value> {
let mut rng = Rng::new(super::menucmds::whole_or(p, "seed", 0, C)?);
let (order, saturation_brightness) = (switch_or(p, "order", true, C)?, switch_or(p, "saturationBrightness", false, C)?);
// Each new color with its row's tint and model: a tint moves with its color, and goes when
// the color changes; a model moves with its color.
let mut news: Vec<(Color, f32, Option<ModelRule>)> = rows.iter().filter_map(|r| r.new_color().map(|c| (c, r.tint, r.model))).collect();
// the color changes; a model moves with its color. A row with no current colors recolors
// nothing, so it keeps its new color and takes no other row's.
let takes = |r: &Row| !r.from.is_empty() && r.new_color().is_some();
let mut news: Vec<(Color, f32, Option<ModelRule>)> =
rows.iter().filter(|r| takes(r)).filter_map(|r| r.new_color().map(|c| (c, r.tint, r.model))).collect();
if order {
rng.shuffle(&mut news);
}
@@ -1765,7 +1768,7 @@ fn randomize(_: &mut Session, p: &Value) -> Result<Value> {
.iter()
.map(|r| {
let (to, tint, model) =
if r.new_color().is_some() { news.next().map_or((None, 1.0, None), |(c, t, m)| (Some(c), t, m)) } else { (r.to, r.tint, r.model) };
if takes(r) { news.next().map_or((None, 1.0, None), |(c, t, m)| (Some(c), t, m)) } else { (r.to, r.tint, r.model) };
let mut row = json!({"from": r.from.iter().map(Match::to_json).collect::<Vec<_>>(), "to": to.as_ref().map(key_str)});
if r.exclude {
row["exclude"] = json!(true);
+18
View File
@@ -529,6 +529,24 @@ pub(crate) fn sync(before: &Document, d: &mut Document) -> Result<()> {
};
d.symbols[index].art = Arc::new(new_art);
follow_objects(d, &se.symbol, (&old, old_group), (&art, group));
// A pixel-aligned symbol stores its art on the pixel grid while it is edited too, and the
// editing layer shows the snapped art.
if d.symbol_pixel_aligned(&se.symbol) && super::object::snap_symbol_art(d, &se.symbol) {
let stored = &d.symbols[index].art;
let snapped: Vec<Arc<Node>> = if group { stored.children().map(|c| c.to_vec()).unwrap_or_default() } else { vec![stored.clone()] };
let mut snapped = snapped.into_iter().map(|n| {
let mut n = (*n).clone();
n.transform(se.xf, false);
Arc::new(n)
});
if let Some(ch) = d.node_mut(se.layer).and_then(Node::children_mut) {
for c in ch.iter_mut().filter(|c| !c.is_ruler_guide()) {
if let Some(n) = snapped.next() {
*c = n;
}
}
}
}
if let Some(e) = d.symbol_edit.as_mut() {
e.changed = true;
e.group = group;
+2 -1
View File
@@ -499,12 +499,13 @@ fn instance(name: &str) -> Node {
}
/// Symbol `from`'s Symbol Options in `src` (natural size, registration, export type, 9-slice
/// guides) given to symbol `to` of `d`.
/// guides, Align to Pixel Grid) given to symbol `to` of `d`.
fn copy_options(src: &Document, from: &str, d: &mut Document, to: &str) {
set_natural_size(d, to, Some(natural_size(src, from)));
d.set_symbol_registration(to, src.symbol_registration(from));
d.set_symbol_export_type(to, src.symbol_export_type(from));
d.set_symbol_nine_slice(to, src.symbol_nine_slice(from));
d.set_symbol_pixel_aligned(to, src.symbol_pixel_aligned(from));
}
fn builtin_info(b: &BuiltinSymbolLibrary) -> LibraryInfo {
+2
View File
@@ -1830,6 +1830,7 @@ fn create_in_path(s: &mut Session, p: &Value) -> Result<Value> {
para: super::create::new_type_para(),
paras: Vec::new(),
first_para_continues: false,
first_para_lead: None,
area: Default::default(),
path_effect: Default::default(),
path_align: Default::default(),
@@ -2136,6 +2137,7 @@ fn headline_tracking(t: &TextObject, target: f64) -> Option<f64> {
para: Default::default(),
paras: Vec::new(),
first_para_continues: false,
first_para_lead: None,
area: Default::default(),
path_effect: Default::default(),
path_align: Default::default(),
+1
View File
@@ -255,6 +255,7 @@ pub fn para_attrs(v: &ParaStyle) -> Map<String, Value> {
("kinsoku", json!(v.kinsoku)),
("kinsoku_type", json!(v.kinsoku_type)),
("bunri_kinshi", json!(v.bunri_kinshi)),
("kurikaeshi_moji_shori", json!(v.kurikaeshi_moji_shori)),
("roman_hanging", json!(v.roman_hanging)),
("kashida", json!(v.kashida)),
("korean_line_break_anywhere", json!(v.korean_line_break_anywhere)),
+40 -3
View File
@@ -225,7 +225,9 @@ pub(crate) fn reflow(before: &Document, doc: &mut Document) {
.collect();
let refs: Vec<&TextObject> = frames.iter().collect();
let parts = vectorcraft_text::thread::distribute(vectorcraft_text::FontDb::global(), &refs, &story, &paras);
for (id, part) in live.iter().zip(parts) {
let texts: Vec<String> = parts.iter().map(|p| p.runs.iter().map(|r| r.text.as_str()).collect()).collect();
let leads = first_para_leads(&texts, &parts.iter().map(|p| p.continues).collect::<Vec<_>>());
for ((id, part), lead) in live.iter().zip(parts).zip(leads) {
if let Some(NodeKind::Text(t)) = doc.node_mut(*id).map(|n| &mut n.kind) {
let mut next = (**t).clone();
next.runs = part.runs;
@@ -241,6 +243,7 @@ pub(crate) fn reflow(before: &Document, doc: &mut Document) {
|| part.list_count != t.list_count
|| part.list_level_counts != t.list_level_counts
|| continues != t.first_para_continues
|| lead != t.first_para_lead
{
t.runs = next.runs;
t.para = next.para;
@@ -250,6 +253,7 @@ pub(crate) fn reflow(before: &Document, doc: &mut Document) {
t.list_count = part.list_count;
t.list_level_counts = part.list_level_counts;
t.first_para_continues = continues;
t.first_para_lead = lead;
refresh_bounds(t);
}
}
@@ -384,17 +388,42 @@ pub(crate) fn mark_continued(doc: &mut Document) {
let live: Vec<NodeId> = thread.into_iter().filter(|id| text_of(doc, *id).is_some()).collect();
let frames: Vec<&TextObject> = live.iter().filter_map(|id| text_of(doc, *id)).collect();
let marks = vectorcraft_text::thread::continued(&frames);
for (id, on) in live.iter().zip(marks) {
let texts: Vec<String> = frames.iter().map(|t| t.plain_text()).collect();
let leads = first_para_leads(&texts, &marks);
for ((id, on), lead) in live.iter().zip(marks).zip(leads) {
if let Some(NodeKind::Text(t)) = doc.node_mut(*id).map(|n| &mut n.kind)
&& t.first_para_continues != on
&& (t.first_para_continues != on || t.first_para_lead != lead)
{
t.first_para_continues = on;
t.first_para_lead = lead;
refresh_bounds(t);
}
}
}
}
/// [`TextObject::first_para_lead`] for each frame of a thread, from the frames' plain `texts` and
/// whether each one's first paragraph `continues` from the frame before: the last character of
/// that paragraph in the frames before that a repeat mark could stand for, or None. One pass over
/// the frames: each frame's lead is carried forward to the next.
fn first_para_leads(texts: &[String], continues: &[bool]) -> Vec<Option<char>> {
// The lead the next frame takes when its first paragraph continues from this one.
let mut carry = None;
texts
.iter()
.enumerate()
.map(|(k, text)| {
#[cfg(test)]
LEAD_SCANS.with(|c| c.set(c.get() + 1));
let lead = carry.filter(|_| continues.get(k) == Some(&true));
let tail = text.rsplit('\n').next().unwrap_or(text);
// A paragraph break in this frame ends the paragraph the lead came from.
carry = vectorcraft_text::repeat_base(tail).or(lead.filter(|_| tail.len() == text.len()));
lead
})
.collect()
}
#[cfg(test)]
thread_local! {
/// Tests: how many times [`story_of`] and [`ThreadIndex::of`] went through the document's
@@ -402,6 +431,8 @@ thread_local! {
static THREAD_SCANS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
/// Tests: how many times [`story_in`] went through a thread's frames on this thread.
static STORY_BUILDS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
/// Tests: how many frame texts [`first_para_leads`] went through on this thread.
static LEAD_SCANS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
}
/// Tests: how many times [`story_of`] and [`ThreadIndex::of`] have gone through the document's
@@ -417,6 +448,12 @@ pub(crate) fn story_builds() -> usize {
STORY_BUILDS.with(std::cell::Cell::get)
}
/// Tests: how many frame texts [`first_para_leads`] has gone through on this thread.
#[cfg(test)]
pub(crate) fn lead_scans() -> usize {
LEAD_SCANS.with(std::cell::Cell::get)
}
/// The frames of the thread that `id` is a frame of, in thread order, each area type or type on a
/// path; empty when `id` is in no thread or the thread has fewer than two such frames.
pub(crate) fn story_of(d: &Document, id: NodeId) -> Vec<NodeId> {
+54
View File
@@ -2226,3 +2226,57 @@ fn paragraph_indents_check_every_entry_and_skip_a_change_that_changes_nothing()
assert_eq!(s.doc().unwrap().history.undo.len(), undo + 1);
assert_eq!(text_of(&s.doc().unwrap().doc, NodeId(c)).unwrap().para_at(1).left_indent, 30.0);
}
/// Kurikaeshi Moji Shori: a frame whose first paragraph continues carries the last character of
/// that paragraph in the frames before that a repeat mark can stand for, looking past frames that
/// hold only repeat marks and stopping at the paragraph's start; a frame that starts a paragraph
/// carries none. Flowing the story and opening a file both set it.
#[test]
fn a_continued_frame_carries_the_character_a_repeat_mark_stands_for() {
let leads = |texts: &[&str], continues: &[bool]| first_para_leads(&texts.iter().map(|t| t.to_string()).collect::<Vec<_>>(), continues);
assert_eq!(leads(&["時", "々す"], &[false, true]), [None, Some('時')]);
assert_eq!(leads(&["時", "々", "々"], &[false, true, true]), [None, Some('時'), Some('時')]);
assert_eq!(leads(&["時\nか\u{3099}", "ゝ"], &[false, true]), [None, Some('か')]);
assert_eq!(leads(&["時\n々", "々"], &[false, true]), [None, None]);
assert_eq!(leads(&["時\n", "々"], &[false, false]), [None, None]);
assert_eq!(leads(&[], &[]), Vec::<Option<char>>::new());
// Opening a file marks the frames as they were saved.
let mut s = Session::new();
s.execute("file.new", &json!({"width": 600, "height": 300})).unwrap();
let mut ids = Vec::new();
for (x, text) in [(10, "日時"), (200, "々す")] {
let id =
s.execute("text.create", &json!({"x": x, "y": 10, "text": text, "area": {"width": 150, "height": 60}})).unwrap()["id"].as_u64().unwrap();
ids.push(NodeId(id));
}
let mut d = (*s.doc().unwrap().doc).clone();
d.text_threads = vec![ids.clone()];
mark_continued(&mut d);
let tb = text_of(&d, ids[1]).unwrap();
assert!(tb.first_para_continues);
assert_eq!(tb.first_para_lead, Some('時'));
// Flowing the story through the frames sets it from the text each frame now holds.
reflow(&d.clone(), &mut d);
let (ta, tb) = (text_of(&d, ids[0]).unwrap(), text_of(&d, ids[1]).unwrap());
assert_eq!([ta.plain_text(), tb.plain_text()].concat(), "日時々す");
assert!(tb.first_para_continues);
assert_eq!(tb.first_para_lead, vectorcraft_text::repeat_base(&ta.plain_text()));
}
/// Kurikaeshi Moji Shori: the leads of a thread whose frames hold only repeat marks come from one
/// pass over the frames, each frame's text gone through once, not once for every frame after it.
#[test]
fn continued_frame_leads_go_through_each_frame_once() {
let n = 2000;
let mut texts = vec!["時".to_string()];
texts.extend(std::iter::repeat_n("々\u{2028}".to_string(), n - 1));
let continues: Vec<bool> = (0..n).map(|k| k > 0).collect();
let before = lead_scans();
let leads = first_para_leads(&texts, &continues);
assert!(lead_scans() - before <= n, "{} frame texts gone through for {n} frames", lead_scans() - before);
assert_eq!(leads.first(), Some(&None));
assert!(leads.iter().skip(1).all(|l| *l == Some('時')));
// A paragraph break stops the carry, and a frame that starts a paragraph carries nothing.
let leads = first_para_leads(&["時".into(), "々\nす".into(), "々".into(), "日".into(), "々".into()], &[false, true, true, false, true]);
assert_eq!(leads, [None, Some('時'), Some('す'), None, Some('日')]);
}
@@ -504,6 +504,62 @@ fn bunri_kinshi_is_set_per_paragraph_and_saved_only_when_on() {
assert!(!text(&s).para_at(0).bunri_kinshi && !text(&s).para_at(1).bunri_kinshi);
}
/// Paragraph panel menu › Kurikaeshi Moji Shori: off for new type and for a paragraph saved before
/// it, and saved only when on; `text.setFormat {kurikaeshiMojiShori}` sets it per paragraph in one
/// undo step, records nothing when the paragraphs already have the value, refuses a value that is
/// not true or false, and paragraph styles carry it. The text keeps its repeat marks.
#[test]
fn kurikaeshi_moji_shori_is_set_per_paragraph_and_saved_only_when_on() {
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": 10, "size": 20, "text": "時々\nすゝ"})).unwrap()["id"].as_u64().unwrap();
let text = |s: &Session| match &s.doc().unwrap().doc.node(NodeId(id)).unwrap().kind {
NodeKind::Text(t) => (**t).clone(),
_ => panic!("text"),
};
assert!(!text(&s).para_at(0).kurikaeshi_moji_shori, "new type has it off");
assert!(serde_json::to_value(text(&s).para_at(0)).unwrap().get("kurikaeshi_moji_shori").is_none());
let old: vectorcraft_doc::ParaStyle = serde_json::from_value(json!({"justify": "Left"})).unwrap();
assert!(!old.kurikaeshi_moji_shori, "saved before the option: off");
s.execute("select.set", &json!({"ids": [id]})).unwrap();
let steps = s.doc().unwrap().history.undo.len();
// Only the second paragraph.
let second = "時々\n".len();
s.execute("text.setFormat", &json!({"kurikaeshiMojiShori": true, "start": second, "end": second})).unwrap();
assert!(!text(&s).para_at(0).kurikaeshi_moji_shori && text(&s).para_at(1).kurikaeshi_moji_shori);
assert_eq!(s.doc().unwrap().history.undo.len(), steps + 1);
assert_eq!(text(&s).plain_text(), "時々\nすゝ", "the text keeps its marks");
// The same value again records nothing.
s.execute("text.setFormat", &json!({"kurikaeshiMojiShori": true, "start": second, "end": second})).unwrap();
assert_eq!(s.doc().unwrap().history.undo.len(), steps + 1);
let saved = serde_json::to_value(text(&s).para_at(1)).unwrap();
assert_eq!(saved["kurikaeshi_moji_shori"], true);
let back: vectorcraft_doc::ParaStyle = serde_json::from_value(saved).unwrap();
assert!(back.kurikaeshi_moji_shori);
let reopened = vectorcraft_format::load(&vectorcraft_format::save(&s.doc().unwrap().doc, false)).unwrap();
let Some(NodeKind::Text(back)) = reopened.node(NodeId(id)).map(|n| &n.kind) else { panic!("text") };
assert!(!back.para_at(0).kurikaeshi_moji_shori && back.para_at(1).kurikaeshi_moji_shori, "the file keeps it per paragraph");
s.execute("edit.undo", &json!({})).unwrap();
assert!(!text(&s).para_at(1).kurikaeshi_moji_shori);
s.execute("edit.redo", &json!({})).unwrap();
assert!(text(&s).para_at(1).kurikaeshi_moji_shori);
for bad in [json!("yes"), json!(1)] {
assert!(s.execute("text.setFormat", &json!({"ids": [id], "kurikaeshiMojiShori": bad, "kinsoku": "none"})).is_err(), "{bad}");
}
assert!(s.execute("text.setRangeStyle", &json!({"id": id, "kurikaeshiMojiShori": false})).is_err());
assert!(
text(&s).para_at(1).kurikaeshi_moji_shori && text(&s).para_at(1).kinsoku != vectorcraft_doc::Kinsoku::None,
"a refused call changes nothing"
);
// A paragraph style carries it.
s.execute("paraStyle.new", &json!({"name": "Repeats", "attrs": {"kurikaeshi_moji_shori": true}})).unwrap();
s.execute("paraStyle.apply", &json!({"name": "Repeats", "id": id})).unwrap();
assert!(text(&s).para_at(0).kurikaeshi_moji_shori && text(&s).para_at(1).kurikaeshi_moji_shori);
s.execute("paraStyle.new", &json!({"name": "Marks", "attrs": {"kurikaeshi_moji_shori": false}})).unwrap();
s.execute("paraStyle.apply", &json!({"name": "Marks", "id": id})).unwrap();
assert!(!text(&s).para_at(0).kurikaeshi_moji_shori && !text(&s).para_at(1).kurikaeshi_moji_shori);
}
/// Paragraph panel › Insert Kashidas: `text.setFormat {kashida}` sets it per paragraph in one
/// undo step, the paragraph is saved with it only when it is not None and opens with it, an
/// unknown value changes nothing, and paragraph styles carry it.
+3
View File
@@ -179,6 +179,9 @@ pub struct Session {
/// The Scripts folder, whose scripts File › Scripts lists; `None`: no folder
/// ([`Session::attach_scripts_dir`]).
scripts_dir: Option<std::path::PathBuf>,
/// The folder of File Info's metadata templates; `None`: no folder
/// ([`Session::attach_metadata_templates_dir`]).
metadata_templates_dir: Option<std::path::PathBuf>,
/// The folder of the New Document profiles `file.new` starts documents from; `None`: none,
/// every document starts with the defaults ([`Session::attach_new_doc_profiles`]).
new_doc_profile_dir: Option<std::path::PathBuf>,
+5 -1
View File
@@ -2012,7 +2012,11 @@ impl Session {
Ok(Ok(Progress::Done(_))) if job.host.dialogs.unused() > 0 => {
let n = job.host.dialogs.unused();
let kind = LimitKind::Host;
let message = format!("`answers` has {n} answer{} the script did not use", if n == 1 { "" } else { "s" });
let message = if n == 1 {
format!("`answers` has {n} answer the script did not use")
} else {
format!("`answers` has {n} answers the script did not use")
};
Some(self.script_failed(job, &RunError { kind: RunErrorKind::Limit(kind), message, line: 0, column: 0 }))
}
Ok(Ok(Progress::Done(_))) => {
+1
View File
@@ -93,6 +93,7 @@ impl Session {
color_settings_file: None,
plugin_dir: None,
scripts_dir: None,
metadata_templates_dir: None,
new_doc_profile_dir: None,
plugin_output: None,
plugin_install_approval: None,
+79
View File
@@ -3310,6 +3310,85 @@ fn flare_ring_seed_moves_only_the_rings() {
assert_eq!(s.doc().unwrap().history.undo.len(), undo);
}
/// `shape.ellipse` without `anchors`, or with 4, draws the live ellipse it always drew.
#[test]
fn ellipse_with_four_anchors_is_the_live_ellipse() {
let mut s = session();
let draw = |s: &mut Session, extra: Option<u64>| {
let mut p = json!({"x": 40, "y": 30, "width": 120, "height": 80});
if let Some(n) = extra {
p["anchors"] = json!(n);
}
let id = NodeId(s.execute("shape.ellipse", &p).unwrap()["id"].as_u64().unwrap());
s.doc().unwrap().doc.node(id).unwrap().clone()
};
let (plain, four) = (draw(&mut s, None), draw(&mut s, Some(4)));
for n in [&plain, &four] {
assert!(matches!(n.live_shape(), Some(vectorcraft_doc::LiveShape::Ellipse { .. })), "{:?}", n.live_shape());
assert_eq!(n.path_data().unwrap().anchor_count(), 4);
}
assert_eq!(plain.path_data(), four.path_data());
assert_eq!(plain.live_shape(), four.live_shape());
}
/// Any other count draws a closed plain path of that many smooth anchors on the ellipse, its
/// bounds the typed size, as one undo step.
#[test]
fn ellipse_anchors_draw_that_many_anchors_on_the_ellipse() {
let mut s = session();
let (x, y, w, h) = (40.0, 30.0, 120.0, 80.0);
let (c, rx, ry) = (Point::new(x + w / 2.0, y + h / 2.0), w / 2.0, h / 2.0);
for n in [2u64, 3, 5, 6, 8] {
let undo = s.doc().unwrap().history.undo.len();
let id = NodeId(s.execute("shape.ellipse", &json!({"x": x, "y": y, "width": w, "height": h, "anchors": n})).unwrap()["id"].as_u64().unwrap());
assert_eq!(s.doc().unwrap().history.undo.len(), undo + 1, "{n}: one undo step");
let node = s.doc().unwrap().doc.node(id).unwrap();
assert!(node.live_shape().is_none(), "{n}: a plain path");
let path = node.path_data().unwrap();
assert_eq!(path.subpaths.len(), 1);
let sp = &path.subpaths[0];
assert!(sp.closed, "{n}");
assert_eq!(sp.anchors.len() as u64, n);
for a in &sp.anchors {
assert_eq!(a.kind, vectorcraft_geom::AnchorKind::Smooth, "{n}");
let on = ((a.p.x - c.x) / rx).powi(2) + ((a.p.y - c.y) / ry).powi(2);
assert!((on - 1.0).abs() < 0.01, "{n}: {:?} is off the ellipse ({on})", a.p);
}
let b = path.bounds().unwrap();
for (got, want) in [(b.x0, x), (b.y0, y), (b.x1, x + w), (b.y1, y + h)] {
assert!((got - want).abs() < 1e-6, "{n}: bounds {b:?}");
}
}
// The first anchor is the left one, and they run clockwise on screen, as the live ellipse's do.
let id = NodeId(s.execute("shape.ellipse", &json!({"x": x, "y": y, "width": w, "height": h, "anchors": 8})).unwrap()["id"].as_u64().unwrap());
let sp = s.doc().unwrap().doc.node(id).unwrap().path_data().unwrap().subpaths[0].clone();
assert!(sp.anchors[0].p.distance(Point::new(x, c.y)) < 1e-6, "{:?}", sp.anchors[0].p);
assert!(sp.anchors[2].p.distance(Point::new(c.x, y)) < 1e-6, "{:?}", sp.anchors[2].p);
}
/// An `anchors` that is not a whole number from 2 to 1000 is refused, and nothing is drawn.
#[test]
fn ellipse_refuses_a_bad_anchor_count() {
let mut s = session();
let undo = s.doc().unwrap().history.undo.len();
let range = |got: &str| format!("`anchors` must be a whole number between 2 and 1000 (got {got})");
for (bad, want) in [
(json!(0), range("0")),
(json!(1), range("1")),
(json!(2.5), range("2.5")),
(json!(-3), range("-3")),
(json!(1001), range("1001")),
(json!("x"), "`anchors` must be a number, not \"x\"".to_string()),
(json!("6"), "`anchors` must be a number, not \"6\"".to_string()),
(json!(true), "`anchors` must be a number, not true".to_string()),
] {
let e = s.execute("shape.ellipse", &json!({"x": 0, "y": 0, "width": 50, "height": 50, "anchors": bad})).unwrap_err().to_string();
assert!(e.contains(&want), "{bad}: {e}");
}
assert_eq!(s.doc().unwrap().history.undo.len(), undo);
assert!(s.doc().unwrap().doc.layers[0].children().unwrap().is_empty());
}
/// Through the session, Ctrl/Cmd in the Flare tool's center drag keeps the center's size while the
/// drag sizes the halo, and the flare drawn keeps both.
#[test]
+39
View File
@@ -89,6 +89,45 @@ fn export_3d_object_refuses_objects_without_a_3d_effect_and_bad_formats() {
assert_eq!(r["added"], 1);
}
/// Without `ids`, the selected objects without a 3D effect, a group whose 3D effect is on its fill
/// (it draws nothing to export) and a 3D object inside another selected one are left out; a
/// selection with none left is refused.
#[test]
fn export_3d_object_leaves_flat_objects_in_the_selection_out() {
let mut s = session();
let plain = run(&mut s, "shape.rectangle", json!({"x": 10.0, "y": 100.0, "width": 40.0, "height": 30.0}))["id"].as_u64().unwrap();
let filled = run(&mut s, "shape.rectangle", json!({"x": 10.0, "y": 200.0, "width": 40.0, "height": 30.0}))["id"].as_u64().unwrap();
run(&mut s, "select.set", json!({"ids": [filled]}));
let group = run(&mut s, "object.group", json!({}))["id"].as_u64().unwrap();
run(&mut s, "select.set", json!({"ids": [group]}));
run(&mut s, "appearance.addFill", json!({}));
run(&mut s, "effect.apply", json!({"effect": "threeD.extrude"}));
// `effect.apply` puts a group's 3D effect on the group itself; a file can hold one on its fill.
s.edit("fill", |d, _| {
let n = d.node_mut(vectorcraft_doc::NodeId(group)).unwrap();
let fx = n.appearance.effects.remove(0);
n.appearance.items[0].effects_mut().push(fx);
Ok(())
})
.unwrap();
run(&mut s, "select.set", json!({"ids": [plain, group]}));
let before = undo_len(&s);
assert!(s.execute("assets.add3D", &json!({})).is_err(), "no object with a 3D effect to export");
assert_eq!(undo_len(&s), before);
let inner = extruded(&mut s, 100.0, "Inner");
let other = run(&mut s, "shape.rectangle", json!({"x": 200.0, "y": 10.0, "width": 40.0, "height": 30.0}))["id"].as_u64().unwrap();
run(&mut s, "select.set", json!({"ids": [inner, other]}));
let outer = run(&mut s, "object.group", json!({}))["id"].as_u64().unwrap();
run(&mut s, "select.set", json!({"ids": [outer]}));
run(&mut s, "effect.apply", json!({"effect": "threeD.extrude"}));
run(&mut s, "select.set", json!({"ids": [plain, group, inner, outer]}));
let r = run(&mut s, "assets.add3D", json!({}));
assert_eq!(r["added"], 1, "{r}");
let nodes: Vec<Value> = run(&mut s, "assets.list", json!({}))["assets"].as_array().unwrap().iter().map(|a| a["nodes"].clone()).collect();
assert_eq!(nodes, [json!([outer])]);
assert!(s.execute("assets.add3D", &json!({"ids": [plain, outer]})).is_err(), "ids are still refused");
}
#[test]
fn the_format_is_set_per_asset_and_only_a_change_is_an_undo_step() {
let mut s = session();
+38 -1
View File
@@ -4272,15 +4272,26 @@ fn live_paint_bucket_double_click_across_a_junction_paints_the_joined_edges() {
s.pointer(&PointerEvent::new(kind, x, 50.0).with_mods(shift), v).unwrap();
}
assert_eq!(middle.iter().map(|e| node(&s, *e).appearance.stroke_paint()).collect::<Vec<_>>(), [green.clone(), green.clone(), green]);
// `through` takes edge ids, with scope "connected" only.
// `through` takes the group's edge ids, each once, with scope "connected" only; a face's id, an
// unknown id or an edge given twice is refused and changes nothing.
let face = vectorcraft_tools::builder::faces(&node(&s, g)).first().map(|f| f.id).unwrap();
let before = s.doc().unwrap().doc.clone();
let depth = s.doc().unwrap().history.undo.len();
for p in [
json!({"group": g.0, "point": [15, 50], "scope": "connected", "through": "x"}),
json!({"group": g.0, "point": [15, 50], "scope": "connected", "through": [-1]}),
json!({"group": g.0, "point": [15, 50], "scope": "samePaint", "through": []}),
json!({"group": g.0, "point": [15, 50], "through": []}),
json!({"group": g.0, "point": [15, 50], "scope": "connected", "through": [face.0]}),
json!({"group": g.0, "point": [15, 50], "scope": "connected", "through": [999_999_999]}),
json!({"group": g.0, "point": [15, 50], "scope": "connected", "through": [middle[1].0, middle[1].0]}),
] {
assert!(s.execute("livePaint.strokeEdge", &p).is_err(), "{p}");
}
assert_eq!(s.doc().unwrap().doc, before);
assert_eq!(s.doc().unwrap().history.undo.len(), depth);
let r = s.execute("livePaint.strokeEdge", &json!({"group": g.0, "point": [15, 50], "scope": "connected", "through": [middle[1].0]})).unwrap();
assert_eq!(r["count"], 3, "an edge of the group is taken");
}
/// A double-click whose second press lands on the next joined edge and is released back on the
@@ -4318,6 +4329,32 @@ fn live_paint_bucket_double_click_released_back_on_the_first_edge_paints_the_joi
assert_eq!(middle.iter().map(|e| node(&s, *e).appearance.stroke_paint()).collect::<Vec<_>>(), [green.clone(), green.clone(), green]);
}
/// With Paint Fills and Paint Strokes both on, a double-click on an edge after a click that filled
/// a face whose fill was the edge's stroke paint paints the joined edges: the face is not sent as
/// an edge to join through.
#[test]
fn live_paint_bucket_edge_double_click_after_filling_a_face_paints_the_joined_edges() {
let mut s = session();
let g = live_squares(&mut s, &[0.0, 50.0]);
let [a, b] = faces_at(&s, g, &[(25.0, 25.0), (75.0, 25.0)])[..] else { panic!("two faces") };
let black = Paint::solid(Color::rgb(0.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, &[(a, black.clone()), (b, black.clone())]);
let v = ViewInfo::default();
s.select_tool("livePaintBucket", v).unwrap();
s.set_tool_option("paintStrokes", &json!(true));
s.paint.fill = green.clone();
s.paint.stroke = green.clone();
for (kind, x) in [(PointerKind::Down, 25.0), (PointerKind::Up, 25.0), (PointerKind::Down, 50.0), (PointerKind::Up, 50.0)] {
s.pointer(&PointerEvent::new(kind, x, 25.0), v).unwrap();
}
assert_eq!(fill_of(&s, a), green, "the first click fills the face");
s.pointer(&PointerEvent::new(PointerKind::DoubleClick, 50.0, 25.0), v).unwrap();
assert!(all.iter().all(|e| node(&s, *e).appearance.stroke_paint() == green), "every joined edge is painted");
assert_eq!(fill_of(&s, b), black);
}
/// A triple-click whose second press holds Cmd (it goes to the selection tool Cmd lends) matches
/// the fill the face had before the first click: the lent press counts as one that paints nothing.
#[test]
+19
View File
@@ -253,6 +253,25 @@ fn constrain_angle_turns_shapes_made_by_a_click() {
}
}
/// An ellipse of another anchor count made by a click turns along the Constrain Angle like the
/// live ellipse: it keeps its anchors and its box runs along the turned axes from the click.
#[test]
fn constrain_angle_turns_an_ellipse_of_six_anchors_made_by_a_click() {
let mut s = new_doc();
set_angle(&mut s, 90.0);
let p = json!({"x": 10, "y": 200, "width": 100, "height": 50, "anchors": 6});
let p = constrain_click(&s, "shape.ellipse", p.clone(), corner(&p));
assert_eq!(p["anchors"], json!(6));
let id = NodeId(s.execute("shape.ellipse", &p).unwrap()["id"].as_u64().unwrap());
let n = s.doc().unwrap().doc.node(id).unwrap().clone();
assert!(n.live_shape().is_none());
assert_eq!(n.path_data().unwrap().anchor_count(), 6);
let b = bounds(&s, id);
for (got, want) in [(b.x0, 10.0), (b.y0, 100.0), (b.x1, 60.0), (b.y1, 200.0)] {
assert!(close(got, want), "{b:?}");
}
}
/// The Line Segment tool's Shift steps of 45° count from the Constrain Angle.
#[test]
fn constrain_angle_steps_the_line_segment_tool() {
+20
View File
@@ -265,6 +265,26 @@ fn liquify_without_selection_hits_paths_under_the_brush() {
assert!(path(&s, b).bounds().unwrap().width() < 100.0);
}
/// The warning about objects under the brush that Liquify leaves as they are names their count
/// with the matching noun and verb.
#[test]
fn liquify_warns_about_one_or_several_skipped_objects() {
let mut s = session();
let text =
|s: &mut Session, x: i32| s.execute("text.create", &json!({"x": x, "y": 460, "text": "Hi", "size": 24})).unwrap()["id"].as_u64().unwrap();
let pucker = json!({"tool": "pucker", "points": [[550, 450]], "diameter": 150, "intensity": 1});
let first = text(&mut s, 520);
s.execute("select.set", &json!({"ids": []})).unwrap();
let r = s.execute("object.liquify", &pucker).unwrap();
assert_eq!(r["skipped"], json!([first]));
assert_eq!(r["warning"], "Pucker left 1 object under the brush as it was (type): it reshapes paths only");
let second = text(&mut s, 560);
s.execute("select.set", &json!({"ids": []})).unwrap();
let r = s.execute("object.liquify", &pucker).unwrap();
assert_eq!(r["skipped"], json!([first, second]));
assert_eq!(r["warning"], "Pucker left 2 objects under the brush as they were (type): it reshapes paths only");
}
/// With nothing selected, a stroke leaves the art on a locked artboard as it is.
#[test]
fn liquify_without_selection_leaves_the_art_on_a_locked_artboard() {
+78
View File
@@ -1337,6 +1337,84 @@ fn eraser_removes_small_shape_entirely() {
assert!(paths(&s).is_empty());
}
/// `path.eraseRegion {rect}` (the Eraser's Alt-drag marquee) erases everything inside the
/// rectangle: a closed shape loses its area, an open path is cut where it crosses the edges, a
/// shape wholly inside goes, and only the selected paths take part when something is selected. One
/// undo step puts everything back, and a rectangle that touches nothing adds no undo step.
#[test]
fn erase_region_rect_erases_everything_inside_it() {
let filled = |s: &Session, x: f64, y: f64| {
paths(s).iter().any(|(_, pd)| pd.is_closed() && vectorcraft_geom::hit::fill_contains(&pd.to_bezpath(), FillRule::NonZero, Point::new(x, y)))
};
let mut s = session();
rect(&mut s, 100.0, 100.0, 200.0, 200.0);
rect(&mut s, 180.0, 140.0, 10.0, 10.0);
line(&mut s, 50.0, 150.0, 350.0, 150.0);
s.execute("select.none", &json!({})).unwrap();
let undo = undo_steps(&s);
let r = s.execute("path.eraseRegion", &json!({"rect": [150, 120, 100, 60]})).unwrap();
assert!(!r["ids"].as_array().unwrap().is_empty(), "{r}");
assert_eq!(undo_steps(&s), undo + 1);
assert!(!filled(&s, 200.0, 150.0) && !filled(&s, 185.0, 145.0), "the area inside is erased, the small square with it");
assert!(filled(&s, 120.0, 150.0) && filled(&s, 200.0, 250.0) && filled(&s, 200.0, 110.0), "the rest stays filled");
let ps = paths(&s);
assert_eq!(ps.iter().filter(|(_, pd)| pd.is_closed()).count(), 1, "the square keeps the rectangle as a hole: {ps:?}");
let open: Vec<f64> = ps.iter().filter(|(_, pd)| !pd.is_closed()).map(|(_, pd)| pd.length()).collect();
assert_eq!(open.len(), 2, "the line is cut in two: {open:?}");
assert!(open.iter().all(|l| (l - 100.0).abs() < 0.01), "{open:?}");
s.execute("edit.undo", &json!({})).unwrap();
assert_eq!(paths(&s).len(), 3);
assert!(filled(&s, 200.0, 160.0) && filled(&s, 185.0, 145.0));
// A rectangle away from the art erases nothing and adds no undo step.
let undo = undo_steps(&s);
assert_eq!(s.execute("path.eraseRegion", &json!({"rect": [500, 500, 10, 10]})).unwrap(), json!({"ids": []}));
assert_eq!(undo_steps(&s), undo);
// With the line selected, only the line is erased.
let ln = paths(&s).into_iter().find(|(_, pd)| !pd.is_closed()).unwrap().0;
s.execute("select.set", &json!({"ids": [ln.0]})).unwrap();
let closed: Vec<PathData> = paths(&s).into_iter().filter(|(_, pd)| pd.is_closed()).map(|(_, pd)| pd).collect();
s.execute("path.eraseRegion", &json!({"rect": [90, 100, 30, 100]})).unwrap();
let after: Vec<PathData> = paths(&s).into_iter().filter(|(_, pd)| pd.is_closed()).map(|(_, pd)| pd).collect();
assert_eq!(after, closed, "the unselected squares are unchanged");
let open: Vec<f64> = paths(&s).iter().filter(|(_, pd)| !pd.is_closed()).map(|(_, pd)| pd.length()).collect();
assert_eq!(open.len(), 2);
assert!((open.iter().sum::<f64>() - 270.0).abs() < 0.01, "{open:?}");
}
/// A narrow `path.eraseRegion {rect}` across a long open path cuts it, wherever the rectangle
/// falls between the samples the path's length would give.
#[test]
fn erase_region_rect_cuts_a_long_line_with_a_narrow_rectangle() {
let mut s = session();
line(&mut s, 0.0, 100.0, 10000.0, 100.0);
s.execute("select.none", &json!({})).unwrap();
s.execute("path.eraseRegion", &json!({"rect": [5000.3, 90, 1, 20]})).unwrap();
let mut open: Vec<f64> = paths(&s).iter().map(|(_, pd)| pd.length()).collect();
open.sort_by(f64::total_cmp);
assert_eq!(open.len(), 2, "{open:?}");
assert!((open[0] - 4998.7).abs() < 0.01 && (open[1] - 5000.3).abs() < 0.01, "{open:?}");
}
/// `path.eraseRegion` refuses a `rect` that is not four finite numbers with a width and a height
/// above 0, and `rect` given with `points`, and changes nothing.
#[test]
fn erase_region_rect_refuses_bad_values() {
let mut s = session();
rect(&mut s, 0.0, 0.0, 100.0, 100.0);
let shape = "rect is [x, y, width, height] in points, with a width and a height above 0";
for p in [
json!({"rect": [10, 10, 0, 20]}),
json!({"rect": [10, 10, 20, -5]}),
json!({"rect": [10, 10, 20]}),
json!({"rect": [10, "10", 20, 20]}),
json!({"rect": [1e308, 0, 1e308, 20]}),
json!({"rect": {"x": 10, "y": 10, "width": 20, "height": 20}}),
] {
refuses_with(&mut s, "path.eraseRegion", &p, shape);
}
refuses_with(&mut s, "path.eraseRegion", &json!({"rect": [10, 10, 20, 20], "points": [[0, 0]]}), "give `points` or `rect`, not both");
}
/// #4495: the Eraser cuts a compound path as one shape: its hole stays empty, the erased area is
/// empty, and the rest stays filled, with either fill rule. A notch inside the ring keeps one
/// compound path; a drag through the whole ring leaves compound paths whose holes stay holes.
+230
View File
@@ -582,3 +582,233 @@ fn an_untitled_document_saved_to_a_file_exports_titled_after_it() {
}
let _ = std::fs::remove_dir_all(dir);
}
/// A session whose metadata templates folder is `dir/Metadata Templates`, with a document titled
/// Poster.
fn template_session(dir: &std::path::Path) -> Session {
let mut s = session();
s.attach_metadata_templates_dir(dir.join("Metadata Templates"));
s
}
#[test]
fn a_saved_metadata_template_is_listed_and_applies_to_another_document() {
let dir = vectorcraft_testkit::TempDir::new("fileinfo-template");
let mut s = template_session(&dir);
assert_eq!(s.execute("file.info.templates", &json!({})).unwrap()["templates"], json!([]), "no folder yet");
s.execute("file.info", &info()).unwrap();
let r = s.execute("file.info.saveTemplate", &json!({"name": " Studio "})).unwrap();
assert_eq!(r["name"], "Studio");
let path = dir.join("Metadata Templates").join("Studio.xmp");
assert!(path.is_file(), "saved into the folder: {r}");
let listed = s.execute("file.info.templates", &json!({})).unwrap();
assert_eq!(listed["templates"][0]["name"], "Studio");
assert_eq!(listed["templates"].as_array().map(Vec::len), Some(1));
// A name that isn't a usable file name as it is is refused, so `a/b` and `a?b` never share a file.
for name in ["a/b", "a?b", "CON", "Studio.", "x\u{1}"] {
assert!(s.execute("file.info.saveTemplate", &json!({"name": name})).is_err(), "{name}");
}
assert_eq!(s.execute("file.info.templates", &json!({})).unwrap()["templates"].as_array().map(Vec::len), Some(1));
// Saving is not an edit of the document.
assert_eq!(s.doc().unwrap().history.undo.len(), 1);
// Into a new document, by name, in one undo step.
s.execute("file.new", &json!({"width": 100, "height": 80})).unwrap();
let r = s.execute("file.info.applyTemplate", &json!({"name": "Studio", "mode": "keep"})).unwrap();
assert_eq!(r["changed"], true);
let m = &s.doc().unwrap().doc.metadata;
assert_eq!((m.author.as_str(), m.author_title.as_str(), m.rating), ("Ada Lovelace", "Designer", 4));
assert_eq!(m.keywords, ["fair", "Poster", "print"]);
assert_eq!((m.copyright_status, m.copyright_notice.as_str()), (CopyrightStatus::Copyrighted, "(c) 2026 Ada"));
assert_eq!(m.description, "A poster\nfor the fair");
assert_eq!(r["title"], "Poster", "the template carries the title of its own");
assert_eq!(s.doc().unwrap().history.undo.len(), 1);
// Applied again, nothing changes and nothing is recorded.
let r = s.execute("file.info.applyTemplate", &json!({"path": path.to_str().unwrap(), "mode": "keep"})).unwrap();
assert_eq!(r["changed"], false);
assert_eq!(s.doc().unwrap().history.undo.len(), 1);
s.execute("edit.undo", &json!({})).unwrap();
assert_eq!(s.doc().unwrap().doc.metadata.author, "");
// The same name replaces the template.
s.execute("file.info.saveTemplate", &json!({"name": "Studio", "fields": {"author": "Grace"}})).unwrap();
let back = vectorcraft_pdf::read_template(&std::fs::read(&path).unwrap()).unwrap();
assert_eq!(back.author.as_deref(), Some("Grace"));
assert_eq!(back.title, None, "an Untitled-N title is not written");
}
#[test]
fn a_metadata_template_merges_in_three_modes() {
let mut s = session();
s.execute("file.info", &json!({"author": "Ada", "keywords": ["fair"], "rating": 2, "copyrightUrl": "https://example.com/a"})).unwrap();
let template = vectorcraft_pdf::metadata_template(&vectorcraft_pdf::FileInfo {
author: Some("Grace".into()),
description: Some("From the template".into()),
keywords: Some(vec!["print".into(), "Fair".into()]),
rating: Some(5),
copyrighted: Some(false),
..Default::default()
});
let merged =
|s: &mut Session, mode: &str| s.execute("file.info.applyTemplate", &json!({"data": template, "mode": mode, "apply": false})).unwrap();
// Clear and replace: the fields the template lacks are cleared; the title stays.
let r = merged(&mut s, "replace");
assert_eq!((r["author"].as_str(), r["description"].as_str(), r["rating"].as_u64()), (Some("Grace"), Some("From the template"), Some(5)));
assert_eq!(
(r["keywords"].clone(), r["copyrightUrl"].as_str(), r["copyrightStatus"].as_str()),
(json!(["print", "Fair"]), Some(""), Some("publicDomain"))
);
assert_eq!(r["title"], "Poster");
// Keep and replace: the template's fields replace those it has; the others stay.
let r = merged(&mut s, "keep");
assert_eq!((r["author"].as_str(), r["rating"].as_u64(), r["copyrightUrl"].as_str()), (Some("Grace"), Some(5), Some("https://example.com/a")));
assert_eq!(r["keywords"], json!(["print", "Fair"]));
// Keep and append: keywords are added (each once), and only empty fields are filled.
let r = merged(&mut s, "append");
assert_eq!((r["author"].as_str(), r["rating"].as_u64(), r["description"].as_str()), (Some("Ada"), Some(2), Some("From the template")));
assert_eq!((r["keywords"].clone(), r["copyrightStatus"].as_str()), (json!(["fair", "print"]), Some("publicDomain")));
// `apply: false` changed nothing; `base` merges into the given fields instead.
assert_eq!(s.doc().unwrap().history.undo.len(), 1);
assert_eq!(s.doc().unwrap().doc.metadata.author, "Ada");
let r = s.execute("file.info.applyTemplate", &json!({"data": template, "mode": "append", "apply": false, "base": {"author": ""}})).unwrap();
assert_eq!(r["author"], "Grace");
// Applied: one undo step.
s.execute("file.info.applyTemplate", &json!({"data": template, "mode": "replace"})).unwrap();
assert_eq!(s.doc().unwrap().history.undo.len(), 2);
assert_eq!(s.doc().unwrap().doc.metadata.copyright_url, "");
}
#[test]
fn metadata_template_errors() {
let dir = vectorcraft_testkit::TempDir::new("fileinfo-template-errors");
let mut s = template_session(&dir);
let xmp = vectorcraft_pdf::metadata_template(&vectorcraft_pdf::FileInfo { author: Some("Ada".into()), ..Default::default() });
let not_xmp = dir.join("note.xmp");
std::fs::write(&not_xmp, "<note>not metadata</note>").unwrap();
let big = dir.join("big.xmp");
std::fs::write(&big, vec![b' '; vectorcraft_pdf::MAX_TEMPLATE_BYTES + 1]).unwrap();
let e = s.execute("file.info.applyTemplate", &json!({"path": big.to_str().unwrap(), "mode": "keep"})).unwrap_err();
assert!(e.to_string().contains("larger than 8 MB"), "{e}");
let e = s.execute("file.info.applyTemplate", &json!({"data": " ".repeat(vectorcraft_pdf::MAX_TEMPLATE_BYTES + 1), "mode": "keep"})).unwrap_err();
assert!(e.to_string().contains("larger than 8 MB"), "{e}");
for bad in [
json!({"data": xmp, "mode": "merge"}),
json!({"data": xmp}),
json!({"data": xmp, "mode": 3}),
json!({"mode": "keep"}),
json!({"data": xmp, "path": not_xmp.to_str().unwrap(), "mode": "keep"}),
json!({"path": dir.join("missing.xmp").to_str().unwrap(), "mode": "keep"}),
json!({"path": not_xmp.to_str().unwrap(), "mode": "keep"}),
json!({"path": big.to_str().unwrap(), "mode": "keep"}),
json!({"name": "missing", "mode": "keep"}),
json!({"data": "Ada Lovelace", "mode": "keep"}),
json!({"data": xmp, "mode": "keep", "apply": "yes"}),
json!({"data": xmp, "mode": "keep", "base": [1]}),
json!({"data": xmp, "mode": "keep", "base": {"rating": 9}}),
] {
assert!(s.execute("file.info.applyTemplate", &bad).is_err(), "{bad}");
}
for bad in [json!({"name": "a", "path": "b.xmp"}), json!({"name": " "}), json!({"fields": {"rating": 9}}), json!({"fields": "x"})] {
assert!(s.execute("file.info.saveTemplate", &bad).is_err(), "{bad}");
}
assert_eq!(s.doc().unwrap().history.undo.len(), 0);
assert!(!dir.join("Metadata Templates").exists(), "no failed save made the folder");
// A link in the folder is not followed, by its name or its file name.
#[cfg(unix)]
{
let outside = dir.join("outside.xmp");
std::fs::write(&outside, &xmp).unwrap();
std::fs::create_dir_all(dir.join("Metadata Templates")).unwrap();
std::os::unix::fs::symlink(&outside, dir.join("Metadata Templates").join("Linked.xmp")).unwrap();
for name in ["Linked", "Linked.xmp"] {
assert!(s.execute("file.info.applyTemplate", &json!({"name": name, "mode": "keep"})).is_err(), "{name}");
}
let e = s.execute("file.info.applyTemplate", &json!({"name": "Linked", "mode": "keep"})).unwrap_err();
assert!(e.to_string().contains("not a file"), "{e}");
assert_eq!(s.execute("file.info.templates", &json!({})).unwrap()["templates"], json!([]));
// A save by that name leaves the linked file as it was.
let e = s.execute("file.info.saveTemplate", &json!({"name": "Linked", "fields": {"author": "Grace"}})).unwrap_err();
assert!(e.to_string().contains("not a file"), "{e}");
assert_eq!(std::fs::read_to_string(&outside).unwrap(), xmp);
std::fs::remove_dir_all(dir.join("Metadata Templates")).unwrap();
}
// Without a folder (runs without preferences), a name is an error, the data comes back, and
// the list is empty.
let mut s = session();
assert!(s.execute("file.info.saveTemplate", &json!({"name": "Studio"})).is_err());
let data = s.execute("file.info.saveTemplate", &json!({"fields": {"author": "Ada"}})).unwrap()["data"].as_str().unwrap().to_string();
assert_eq!(vectorcraft_pdf::read_template(data.as_bytes()).unwrap().author.as_deref(), Some("Ada"));
assert_eq!(s.execute("file.info.templates", &json!({"create": true})).unwrap(), json!({"templates": []}));
}
#[test]
fn the_templates_folder_lists_only_xmp_files_and_can_be_made() {
let dir = vectorcraft_testkit::TempDir::new("fileinfo-template-list");
let mut s = template_session(&dir);
let r = s.execute("file.info.templates", &json!({"create": true})).unwrap();
let folder = dir.join("Metadata Templates");
assert!(folder.is_dir());
assert_eq!(r["folder"], folder.to_str().unwrap());
for f in ["b.XMP", "a.xmp", "notes.txt", ".xmp"] {
std::fs::write(folder.join(f), "x").unwrap();
}
std::fs::create_dir(folder.join("c.xmp")).unwrap();
// Other files, however many, leave the templates listed.
for i in 0..1000 {
std::fs::write(folder.join(format!("{i:04}.txt")), "").unwrap();
}
let names: Vec<String> = s.execute("file.info.templates", &json!({})).unwrap()["templates"]
.as_array()
.unwrap()
.iter()
.map(|t| t["name"].as_str().unwrap().to_string())
.collect();
assert_eq!(names, ["a", "b"]);
// A listed name opens whatever the case of its extension.
let xmp = vectorcraft_pdf::metadata_template(&vectorcraft_pdf::FileInfo { author: Some("Grace".into()), ..Default::default() });
std::fs::write(folder.join("b.XMP"), xmp).unwrap();
let r = s.execute("file.info.applyTemplate", &json!({"name": "b", "mode": "keep"})).unwrap();
assert_eq!(r["author"], "Grace");
// Its listed file name opens it too.
let listed = s.execute("file.info.templates", &json!({})).unwrap();
assert_eq!(listed["templates"][1]["file"], "b.XMP");
let r = s.execute("file.info.applyTemplate", &json!({"name": "b.XMP", "mode": "replace", "apply": false})).unwrap();
assert_eq!(r["author"], "Grace");
// A listed file name is taken before the name with `.xmp` added.
let ada = vectorcraft_pdf::metadata_template(&vectorcraft_pdf::FileInfo { author: Some("Ada".into()), ..Default::default() });
std::fs::write(folder.join("b.XMP.xmp"), ada).unwrap();
let r = s.execute("file.info.applyTemplate", &json!({"name": "b.XMP", "mode": "replace", "apply": false})).unwrap();
assert_eq!(r["author"], "Grace");
let r = s.execute("file.info.applyTemplate", &json!({"name": "b.XMP.xmp", "mode": "replace", "apply": false})).unwrap();
assert_eq!(r["author"], "Ada");
// A name that is not a file name never opens the template its safe form names.
let grace = vectorcraft_pdf::metadata_template(&vectorcraft_pdf::FileInfo { author: Some("Grace".into()), ..Default::default() });
std::fs::write(folder.join("a-b.xmp"), grace).unwrap();
let r = s.execute("file.info.applyTemplate", &json!({"name": "a-b", "mode": "replace", "apply": false})).unwrap();
assert_eq!(r["author"], "Grace");
for name in ["a/b", "a\\b", "a:b"] {
let e = s.execute("file.info.applyTemplate", &json!({"name": name, "mode": "replace", "apply": false})).unwrap_err();
assert!(e.to_string().contains("isn't usable as a file name"), "{name}: {e}");
}
}
#[test]
fn the_largest_file_info_saves_a_template_that_imports() {
let mut s = session();
let text = "\"&".repeat(32_768);
let keywords: Vec<String> = (0..1000).map(|i| format!("{i:04}{}", "\"".repeat(252))).collect();
let fields = json!({
"author": text, "authorTitle": text, "description": text, "copyrightNotice": text,
"copyrightUrl": format!("https://example.com/{}", "&".repeat(2000)), "keywords": keywords, "rating": 5, "copyrightStatus": "copyrighted",
});
let data = s.execute("file.info.saveTemplate", &json!({"fields": fields})).unwrap()["data"].as_str().unwrap().to_string();
assert!(data.len() > 1 << 20, "{} bytes", data.len());
let r = s.execute("file.info.applyTemplate", &json!({"data": data, "mode": "replace"})).unwrap();
assert_eq!((r["author"].as_str(), r["keywords"].as_array().map(Vec::len)), (Some(text.as_str()), Some(1000)));
}
#[test]
fn a_pdf_opens_with_the_rating_and_author_title_its_packet_gives() {
let mut m = DocMetadata::default();
let f = vectorcraft_pdf::FileInfo { author_title: Some("Editor".into()), rating: Some(3), ..Default::default() };
crate::cmd::fileinfo::read_pdf(&mut m, f);
assert_eq!((m.author_title.as_str(), m.rating), ("Editor", 3));
}
+35
View File
@@ -49,6 +49,41 @@ fn refreshing_the_font_list_redraws_type_without_editing_the_document() {
assert!(!d.is_dirty(), "nothing to save");
}
/// `text.glyphCategories` lists the kinds of glyph a font's OpenType features give, with a
/// stylistic set's name, and refuses a font that isn't available and params that aren't strings.
#[test]
fn glyph_categories_list_the_glyphs_of_each_kind_of_feature() {
use vectorcraft_text::test_fonts::{CATEGORIES_FAMILY, categories_font, source_sans_gid};
FontDb::global().add_font(categories_font().expect("the test font builds"));
let mut s = Session::new();
let g = |c| u32::from(source_sans_gid(c).expect("a glyph"));
let mut figures = vec![g('7'), g('8')];
figures.sort_unstable();
let r = s.execute("text.glyphCategories", &json!({"family": CATEGORIES_FAMILY})).unwrap();
assert_eq!(r["family"], CATEGORIES_FAMILY);
assert_eq!(r["style"], "Regular");
assert_eq!(
r["categories"],
json!([
{"id": "ligatures", "glyphs": [g('L')]},
{"id": "ss02", "name": "Round Dots", "glyphs": [g('G')]},
{"id": "smallCaps", "glyphs": [g('B')]},
{"id": "figures", "glyphs": figures},
])
);
assert_eq!(s.execute("text.glyphCategories", &json!({"family": CATEGORIES_FAMILY, "style": "regular"})).unwrap(), r);
for (p, says) in [
(json!({}), "missing `family`"),
(json!({"family": 3}), "`family` must be a string"),
(json!({"family": "No Such Font"}), "is not available"),
(json!({"family": CATEGORIES_FAMILY, "style": "Black"}), "is not available"),
(json!({"family": CATEGORIES_FAMILY, "style": true}), "`style` must be a string"),
] {
let e = s.execute("text.glyphCategories", &p).unwrap_err().to_string();
assert!(e.contains(says), "{p}: {e}");
}
}
/// Refreshing the font list while a background save writes the file leaves the document saved
/// once the file is written.
#[test]
+29
View File
@@ -2117,6 +2117,35 @@ fn confined_clipboard_svg_refuses_a_linked_image_file_outside_the_read_roots() {
assert!(svg.contains(&format!("xlink:href=\"{photo}\"")), "{svg}");
}
/// `clipboard.flavours` and the session's flavors leave out the SVG, and its markup as text, that
/// `clipboard.exportSvg` withholds from a confined caller; the PNG is still listed. The SVG is listed
/// while its image's pixels are held, and for a caller with no read roots.
#[test]
fn confined_clipboard_flavours_leave_out_a_withheld_svg() {
use crate::file_access::{AutomationRoots, confine};
let away = Folder::new("clip-flavours-away");
let home = Folder::new("clip-flavours-home");
let photo = away.file("photo.png");
write(&photo, &png(60, 30, RED));
let mut s = session();
let a = place(&mut s, &photo);
s.execute("select.set", &json!({"ids": [a.0]})).unwrap();
s.execute("edit.copy", &json!({})).unwrap();
let roots = AutomationRoots::new(&[home.0.as_path()], &[home.0.as_path()]).unwrap();
let (text, svg, png) = ("text/plain", "image/svg+xml", "image/png");
let listed = |s: &mut Session| confine(roots.as_ref(), || s.execute("clipboard.flavours", &json!({}))).unwrap()["flavours"].clone();
assert_eq!(listed(&mut s), json!([text, svg, png]));
without_pixels(&mut s, a);
s.execute("edit.copy", &json!({})).unwrap();
assert_eq!(listed(&mut s), json!([png]));
let made = confine(roots.as_ref(), || s.clipboard_flavours());
assert!(made.iter().all(|f| f.mime != svg && f.mime != text), "{:?}", made.iter().map(|f| f.mime).collect::<Vec<_>>());
assert_eq!(confine(roots.as_ref(), || s.clipboard_flavour_types()), [png]);
assert_eq!(s.execute("clipboard.flavours", &json!({})).unwrap()["flavours"], json!([text, svg, png]));
}
/// A confined caller's SVG with Preserve Editing Capabilities is refused while the stored brush
/// library holds an entry that does not read as a brush, or is not a list: the native document
/// carries it as it is, and its links cannot be checked. Without Preserve Editing the SVG is written.
+58
View File
@@ -276,3 +276,61 @@ fn overprint_black_covers_type_gradients_spots_and_groups() {
s.execute("edit.colors.overprintBlack", &json!({"includeCmyBlacks": true, "includeSpotBlacks": true})).unwrap();
assert!(fill(&s, g) && fill(&s, spot));
}
/// The plate `plate` of `doc`, drawn as Separations Preview draws one plate, as one gray value per
/// pixel (0 full ink, 255 none).
fn plate(doc: &Document, plate: &str) -> Vec<u8> {
let mut r = Renderer::new();
r.threads = 0;
let seps = vectorcraft_render::proof::ProofSetup { separations: Some(vec![plate.into()]), ..Default::default() };
let opts = RenderOptions { background: Some([255, 255, 255, 255]), proof: Some(seps), ..Default::default() };
let image = r.render(doc, 100, 100, Affine::IDENTITY, &opts);
(0..100 * 100).map(|i| image.pixel(i % 100, i / 100)[0]).collect()
}
/// 3D (Classic) with the shading color Black Overprint puts the shading on the black plate, shows
/// it as the cyan darkened, and writes it to PDF as overprinting fills.
#[test]
fn classic_3d_black_overprint_shades_on_the_black_plate() {
let doc = |params: Value| {
let mut s = session();
rect(&mut s, [30.0, 30.0, 40.0, 40.0], cyan_ink(), None, 0.0);
s.execute("effect.apply", &json!({"effect": "threeD.classicExtrude", "item": null, "params": params})).unwrap();
s
};
let over = doc(json!({"surface": "diffuse", "depth": 20, "shadingColor": "blackOverprint"}));
let flat = doc(json!({"surface": "none", "depth": 20, "shadingColor": "blackOverprint"}));
let black = doc(json!({"surface": "diffuse", "depth": 20}));
let (over_doc, flat_doc) = (&over.doc().unwrap().doc, &flat.doc().unwrap().doc);
let inked = |p: &[u8]| p.iter().filter(|v| **v < 250).count();
assert!(inked(&plate(over_doc, "Cyan")) > 1000, "the solid is drawn");
assert!(inked(&plate(over_doc, "Black")) > 100, "the shading is on the black plate");
assert_eq!(inked(&plate(flat_doc, "Black")), 0, "No Shading adds no black");
// On screen a shaded face is the cyan darkened, not gray: the black multiplies the cyan.
let image = |d: &Document| {
let mut r = Renderer::new();
r.threads = 0;
let opts = RenderOptions { background: Some([255, 255, 255, 255]), ..Default::default() };
r.render(d, 100, 100, Affine::IDENTITY, &opts)
};
let (shaded, unshaded) = (image(over_doc), image(flat_doc));
let mut darker = 0;
for (x, y) in (0..100u32).flat_map(|y| (0..100u32).map(move |x| (x, y))) {
let (s, u) = (shaded.pixel(x, y), unshaded.pixel(x, y));
// Inside the solid (no white mixed in at an antialiased edge) where the shading darkens it.
if u[0] < 30 && (s[1] as i32) + 20 < u[1] as i32 {
darker += 1;
assert!(s[2] as i32 > s[0] as i32 + 20, "a shaded face keeps its cyan at ({x}, {y}): {s:?}");
}
}
assert!(darker > 100, "the faces turned from the light are darker");
let pdf_overprints = |s: &mut Session| {
let v = s.execute("document.exportPdf", &json!({"compression": {"compressText": false}, "preserveEditing": false})).unwrap();
let bytes = vectorcraft_format::base64_decode(v["dataBase64"].as_str().unwrap()).unwrap();
String::from_utf8_lossy(&bytes).matches("/OP true/op true/OPM 1").count()
};
let (mut over, mut black) = (over, black);
assert!(pdf_overprints(&mut over) > 0, "the black is written overprinting");
assert_eq!(pdf_overprints(&mut black), 0);
}
+16
View File
@@ -399,6 +399,22 @@ fn click_to_size_dialogs_draw_on_the_active_plane_in_plane_units() {
assert!(crate::perspective_click(&s, "shape.rectangle", &json!({}), at).is_none());
}
/// The Ellipse dialog's anchor count reaches the ellipse drawn on the active plane.
#[test]
fn an_ellipse_of_six_anchors_made_by_a_click_draws_on_the_active_plane() {
let (mut s, _) = persp_session();
s.execute("perspective.grid.show", &json!({"visible": true})).unwrap();
s.execute("perspective.plane.set", &json!({"plane": "right"})).unwrap();
let at = Point::new(470.0, 300.0);
let p = json!({"x": at.x, "y": at.y, "width": 50, "height": 30, "anchors": 6});
let (cmd, p) = crate::perspective_click(&s, "shape.ellipse", &p, at).unwrap();
let n = undo_len(&s);
let id = NodeId(s.execute(&cmd, &p).unwrap()["id"].as_u64().unwrap());
assert_eq!(undo_len(&s), n + 1);
assert_eq!(attached(&s, id).map(|a| a.0), Some(Plane::Right));
assert_eq!(node(&s, id).path_data().unwrap().anchor_count(), 6);
}
#[test]
fn the_canvas_draws_type_in_perspective_foreshortened() {
let (mut s, rect) = persp_session();
+301
View File
@@ -1158,3 +1158,304 @@ fn not_aligned_to_pixel_grid_takes_a_compound_path_by_its_own_property() {
assert!(!aligned(&s, off));
assert_eq!(not_aligned(&mut s, &[compound]), vec![other]);
}
/// The anchors of the paths in the art of symbol instance `inst`, where its transform places them.
fn placed_points(s: &Session, inst: u64) -> Vec<(f64, f64)> {
let d = &s.doc().unwrap().doc;
let NodeKind::SymbolInstance { symbol, xf } = &d.node(NodeId(inst)).unwrap().kind else { panic!("{inst} is not a symbol instance") };
let art = &d.symbols.iter().find(|x| &x.name == symbol).unwrap().art;
let mut out = vec![];
art.walk(&mut |n| {
if let Some(p) = n.path_data() {
out.extend(p.anchors().map(|(_, _, a)| {
let q = *xf * a.p;
(q.x, q.y)
}));
}
});
out
}
/// The transform of symbol instance `inst`.
fn instance_xf(s: &Session, inst: u64) -> vectorcraft_geom::Affine {
match &s.doc().unwrap().doc.node(NodeId(inst)).unwrap().kind {
NodeKind::SymbolInstance { xf, .. } => *xf,
_ => panic!("{inst} is not a symbol instance"),
}
}
/// Symbol Options › Align to Pixel Grid on a new symbol: the instance that replaces the selection
/// draws its art's edges on whole points, and goes back to them after a move by a fraction of a
/// point; a symbol made without it keeps the art where it was drawn.
#[test]
fn a_pixel_aligned_symbol_keeps_its_instance_on_whole_points() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let r = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap();
assert_eq!(r["alignToPixelGrid"], true);
let inst = r["id"].as_u64().unwrap();
let pts = placed_points(&s, inst);
assert_eq!(pts.len(), 4);
assert!(whole(&pts), "{pts:?}");
s.execute("object.move", &json!({"dx": 0.3, "dy": 0.45})).unwrap();
let pts = placed_points(&s, inst);
assert!(whole(&pts), "{pts:?}");
let list = s.execute("symbol.list", &json!({})).unwrap();
assert_eq!(list["symbols"][0]["alignToPixelGrid"], true);
path(&mut s, "M100.3 20.6 L140.7 20.6 L140.7 30.3 L100.3 30.3 Z", 2.0);
let plain = s.execute("symbol.new", &json!({"name": "Plain"})).unwrap();
assert_eq!(plain["alignToPixelGrid"], false);
let pts = placed_points(&s, plain["id"].as_u64().unwrap());
assert!(!whole(&pts), "{pts:?}");
}
/// A centered stroke of odd weight puts the art's edges on half points, so the stroke's own edges
/// fall on the grid.
#[test]
fn a_pixel_aligned_symbol_with_an_odd_stroke_goes_to_half_points() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 1.0);
let inst = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap()["id"].as_u64().unwrap();
let pts = placed_points(&s, inst);
assert!(halves(&pts), "{pts:?}");
}
/// Turning it on in Symbol Options snaps the instances placed at actual size and leaves a scaled
/// one where it is; instances placed later land on whole points; asking again for the value the
/// symbol has adds no undo step; a duplicate and a rename keep it, a delete clears it, and a value
/// that is not true or false is refused.
#[test]
fn symbol_options_align_to_pixel_grid_snaps_instances_at_actual_size() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let a = s.execute("symbol.new", &json!({"name": "Px"})).unwrap()["id"].as_u64().unwrap();
let b = s.execute("symbol.place", &json!({"name": "Px", "x": 100.3, "y": 200.7})).unwrap()["id"].as_u64().unwrap();
s.execute("select.set", &json!({"ids": [b]})).unwrap();
s.execute("object.scale", &json!({"sx": 150, "sy": 150})).unwrap();
let scaled = instance_xf(&s, b);
assert!(!whole(&placed_points(&s, a)));
let r = s.execute("symbol.options", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap();
assert_eq!(r["alignToPixelGrid"], true);
let pts = placed_points(&s, a);
assert!(whole(&pts), "{pts:?}");
assert_eq!(instance_xf(&s, b), scaled);
let c = s.execute("symbol.place", &json!({"name": "Px", "x": 50.3, "y": 60.6})).unwrap()["id"].as_u64().unwrap();
let pts = placed_points(&s, c);
assert!(whole(&pts), "{pts:?}");
let steps = undo_len(&s);
s.execute("symbol.options", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap();
assert_eq!(undo_len(&s), steps);
assert_eq!(s.execute("symbol.duplicate", &json!({"name": "Px"})).unwrap()["name"], "Px copy");
assert!(s.doc().unwrap().doc.symbol_pixel_aligned("Px copy"));
s.execute("symbol.options", &json!({"name": "Px", "newName": "Grid"})).unwrap();
assert!(s.doc().unwrap().doc.symbol_pixel_aligned("Grid"));
assert!(!s.doc().unwrap().doc.symbol_pixel_aligned("Px"));
s.execute("symbol.delete", &json!({"names": ["Grid", "Px copy"]})).unwrap();
assert!(s.doc().unwrap().doc.unknown.get(vectorcraft_doc::SYMBOL_PIXEL_ALIGNED).is_none());
path(&mut s, "M10 10 L20 10 L20 20 L10 20 Z", 1.0);
assert!(s.execute("symbol.new", &json!({"alignToPixelGrid": "yes"})).is_err());
assert!(s.execute("symbol.new", &json!({"alignToPixelGrid": null})).is_err());
s.execute("symbol.new", &json!({"name": "Q"})).unwrap();
assert!(s.execute("symbol.options", &json!({"name": "Q", "alignToPixelGrid": 1})).is_err());
assert!(s.execute("symbol.options", &json!({"name": "Q", "alignToPixelGrid": null})).is_err());
}
/// An instance reflected across one axis goes back to whole points after a move; one turned a half
/// turn counts as rotated and moves by exactly the amount asked.
#[test]
fn a_reflected_instance_snaps_and_a_half_turned_one_does_not() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let inst = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap()["id"].as_u64().unwrap();
s.execute("object.reflect", &json!({"axis": "vertical"})).unwrap();
s.execute("object.move", &json!({"dx": 0.3, "dy": 0.45})).unwrap();
let [.., e, f] = instance_xf(&s, inst).as_coeffs();
assert!(whole(&[(e, f)]), "{e} {f}");
s.execute("object.reflect", &json!({"axis": "vertical"})).unwrap();
s.execute("object.rotate", &json!({"angle": 180})).unwrap();
let [.., e0, f0] = instance_xf(&s, inst).as_coeffs();
s.execute("object.move", &json!({"dx": 0.3, "dy": 0.45})).unwrap();
let [.., e1, f1] = instance_xf(&s, inst).as_coeffs();
assert!((e1 - e0 - 0.3).abs() < 1e-9 && (f1 - f0 - 0.45).abs() < 1e-9, "{e0} {f0} -> {e1} {f1}");
}
/// An instance of a pixel-aligned symbol attached to a path goes back to whole points each time the
/// path places it.
#[test]
fn an_instance_on_a_path_stays_on_whole_points() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let inst = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap()["id"].as_u64().unwrap();
let spine = s.execute("path.create", &json!({"d": "M 0.3 100.4 L 300.3 100.4"})).unwrap()["id"].as_u64().unwrap();
s.execute("object.objectsOnPath.attach", &json!({"path": spine, "ids": [inst]})).unwrap();
let pts = placed_points(&s, inst);
assert!(whole(&pts), "attached: {pts:?}");
let anchors = json!([{"x": 0.6, "y": 120.7}, {"x": 300.6, "y": 120.7}]);
s.execute("path.setAnchors", &json!({"id": spine, "subpaths": [{"anchors": anchors, "closed": false}]})).unwrap();
let pts = placed_points(&s, inst);
assert!(whole(&pts), "path edited: {pts:?}");
}
/// A path in the art of an opacity mask in a pixel-aligned symbol's art snaps with the rest of
/// the art.
#[test]
fn mask_art_in_a_pixel_aligned_symbol_snaps() {
let mut s = new_doc();
let r = path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let m = path(&mut s, "M12.3 22.6 L30.7 22.6 L30.7 28.3 L12.3 28.3 Z", 2.0);
{
let d = std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc);
let art = d.remove(NodeId(m)).unwrap();
d.node_mut(NodeId(r)).unwrap().extras_mut().mask = Some(Box::new(vectorcraft_doc::OpacityMask::new((*art).clone(), true)));
}
s.execute("select.set", &json!({"ids": [r]})).unwrap();
let inst = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap()["id"].as_u64().unwrap();
let d = &s.doc().unwrap().doc;
let xf = instance_xf(&s, inst);
let art = &d.symbols.iter().find(|x| x.name == "Px").unwrap().art;
let mut pts = vec![];
art.walk(&mut |n| {
if let Some(mask) = n.extras().mask.as_ref() {
mask.art.walk(&mut |c| {
if let Some(p) = c.path_data() {
pts.extend(p.anchors().map(|(_, _, a)| {
let q = xf * a.p;
(q.x, q.y)
}));
}
});
}
});
assert_eq!(pts.len(), 4);
assert!(whole(&pts), "{pts:?}");
}
/// A path in the art of an unlinked opacity mask in a pixel-aligned symbol's art snaps as the mask
/// is drawn at the symbol's natural size.
#[test]
fn unlinked_mask_art_in_a_pixel_aligned_symbol_snaps_at_natural_size() {
let mut s = new_doc();
let r = path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let m = path(&mut s, "M12.3 22.6 L30.7 22.6 L30.7 28.3 L12.3 28.3 Z", 2.0);
{
let d = std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc);
let art = d.remove(NodeId(m)).unwrap();
d.node_mut(NodeId(r)).unwrap().extras_mut().mask = Some(Box::new(vectorcraft_doc::OpacityMask::new((*art).clone(), false)));
}
s.execute("select.set", &json!({"ids": [r]})).unwrap();
let inst = s.execute("symbol.new", &json!({"name": "Px"})).unwrap()["id"].as_u64().unwrap();
assert_ne!(s.doc().unwrap().doc.symbol_natural_xf("Px"), vectorcraft_geom::Affine::IDENTITY);
{
let d = std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc);
let sym = d.symbols.iter_mut().find(|x| x.name == "Px").unwrap();
std::sync::Arc::make_mut(&mut sym.art).extras_mut().mask.as_mut().unwrap().linked = false;
}
s.execute("symbol.options", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap();
let d = &s.doc().unwrap().doc;
let xf = instance_xf(&s, inst);
let art = &d.symbols.iter().find(|x| x.name == "Px").unwrap().art;
let mut pts = vec![];
art.walk(&mut |n| {
if let Some(mask) = n.extras().mask.as_ref() {
mask.art.walk(&mut |c| {
if let Some(p) = c.path_data() {
pts.extend(p.anchors().map(|(_, _, a)| {
let q = xf * a.p;
(q.x, q.y)
}));
}
});
}
});
assert_eq!(pts.len(), 4);
assert!(whole(&pts), "{pts:?}");
}
/// A path in the art of an opacity mask on a path of a compound path in a pixel-aligned symbol's
/// art snaps with the rest of the art.
#[test]
fn mask_art_on_a_compound_paths_path_in_a_pixel_aligned_symbol_snaps() {
let mut s = new_doc();
let a = path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let b = path(&mut s, "M50.3 20.6 L60.7 20.6 L60.7 30.3 L50.3 30.3 Z", 2.0);
s.execute("select.set", &json!({"ids": [a, b]})).unwrap();
let c = s.execute("object.compoundPath.make", &json!({})).unwrap()["id"].as_u64().unwrap();
let m = path(&mut s, "M12.3 22.6 L30.7 22.6 L30.7 28.3 L12.3 28.3 Z", 2.0);
{
let d = std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc);
let art = d.remove(NodeId(m)).unwrap();
let first = d.node(NodeId(c)).unwrap().children().unwrap()[0].id;
d.node_mut(first).unwrap().extras_mut().mask = Some(Box::new(vectorcraft_doc::OpacityMask::new((*art).clone(), true)));
}
s.execute("select.set", &json!({"ids": [c]})).unwrap();
let inst = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap()["id"].as_u64().unwrap();
let d = &s.doc().unwrap().doc;
let xf = instance_xf(&s, inst);
let art = &d.symbols.iter().find(|x| x.name == "Px").unwrap().art;
let mut pts = vec![];
art.walk(&mut |n| {
if let Some(mask) = n.extras().mask.as_ref() {
mask.art.walk(&mut |c| {
if let Some(p) = c.path_data() {
pts.extend(p.anchors().map(|(_, _, a)| {
let q = xf * a.p;
(q.x, q.y)
}));
}
});
}
});
assert_eq!(pts.len(), 4);
assert!(whole(&pts), "{pts:?}");
}
/// An instance in the art of an object's opacity mask goes to whole points when its symbol is made
/// pixel-aligned.
#[test]
fn an_instance_in_an_opacity_mask_snaps_with_its_symbol() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
s.execute("symbol.new", &json!({"name": "Px"})).unwrap();
let b = s.execute("symbol.place", &json!({"name": "Px", "x": 100.3, "y": 200.7})).unwrap()["id"].as_u64().unwrap();
let r = path(&mut s, "M80 180 L160 180 L160 240 L80 240 Z", 1.0);
{
let d = std::sync::Arc::make_mut(&mut s.doc_mut().unwrap().doc);
let inst = d.remove(NodeId(b)).unwrap();
d.node_mut(NodeId(r)).unwrap().extras_mut().mask = Some(Box::new(vectorcraft_doc::OpacityMask::new((*inst).clone(), true)));
}
s.execute("symbol.options", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap();
let d = &s.doc().unwrap().doc;
let mask = d.node(NodeId(r)).unwrap().extras().mask.clone().unwrap();
let NodeKind::SymbolInstance { xf, .. } = &mask.art.kind else { panic!("the mask art is not the instance") };
let [.., e, f] = xf.as_coeffs();
assert!(whole(&[(e, f)]), "{e} {f}");
}
/// While a pixel-aligned symbol is edited, the art written back from the editing layer is stored
/// on the pixel grid, so its instances stay on it.
#[test]
fn art_edited_in_symbol_editing_mode_stays_on_the_pixel_grid() {
let mut s = new_doc();
path(&mut s, "M10.3 20.6 L40.7 20.6 L40.7 30.3 L10.3 30.3 Z", 2.0);
let inst = s.execute("symbol.new", &json!({"name": "Px", "alignToPixelGrid": true})).unwrap()["id"].as_u64().unwrap();
s.execute("symbol.edit", &json!({"ids": [inst]})).unwrap();
let st = s.doc().unwrap();
let layer = st.doc.symbol_edit.as_ref().unwrap().layer;
let part = st.doc.node(layer).unwrap().children().unwrap()[0].id.0;
s.execute("select.set", &json!({"ids": [part]})).unwrap();
s.execute("object.move", &json!({"dx": 0.3, "dy": 0.45})).unwrap();
assert!(s.doc().unwrap().doc.symbol_edit.is_some());
let pts = placed_points(&s, inst);
assert!(whole(&pts), "{pts:?}");
// The editing layer shows the art as it is stored.
let shown = points(&s, part);
assert!(whole(&shown), "{shown:?}");
s.execute("symbol.exitEditing", &json!({})).unwrap();
let pts = placed_points(&s, inst);
assert!(whole(&pts), "{pts:?}");
}
+21
View File
@@ -380,6 +380,27 @@ fn randomize_shuffles_new_colours_and_skips_excluded_rows() {
assert!((hue(&sb["map"][0]["to"]) - 0.0).abs() < 1.0 && (hue(&sb["map"][1]["to"]) - 120.0).abs() < 1.0, "hue kept");
}
/// A row with no current colors (New Row) keeps its new color through Randomize, and its color
/// goes to no row that holds current colors: the other rows shuffle their own colors only.
#[test]
fn randomize_leaves_an_empty_row_out() {
let mut s = session();
let map = json!([
{"from": [], "to": "rgb 0 255 0"},
{"from": ["rgb 255 0 0"], "to": "rgb 255 0 0"},
{"from": ["rgb 0 0 255"], "to": "rgb 0 0 255"},
]);
for seed in 0..16 {
let r = run(&mut s, "recolor.randomize", json!({"map": map, "seed": seed}));
assert_eq!(r["map"][0], map[0], "seed {seed}: the empty row keeps its color");
let mut tos: Vec<String> = [1, 2].iter().map(|i| r["map"][*i]["to"].as_str().unwrap().to_string()).collect();
tos.sort();
assert_eq!(tos, ["rgb 0 0 255", "rgb 255 0 0"], "seed {seed}: a permutation of the filled rows' colors");
}
let sb = run(&mut s, "recolor.randomize", json!({"map": map, "order": false, "saturationBrightness": true, "seed": 3}));
assert_eq!(sb["map"][0], map[0], "the empty row keeps its saturation and brightness");
}
#[test]
fn edit_group_rewrites_in_order_as_one_undo_step() {
let mut s = session();
+12
View File
@@ -120,6 +120,18 @@ fn missing_or_mismatched_answer_rolls_back() {
assert_eq!(s.script_report().unwrap()["dialogs"][0]["answer"], "missing");
}
/// The error about answers left over names their count with the matching noun.
#[test]
fn unused_answers_are_counted_in_the_singular_and_the_plural() {
let mut s = one_doc();
let ok = json!({"kind": "alert", "value": "ok"});
for (extra, says) in [(1, "`answers` has 1 answer the script did not use"), (2, "`answers` has 2 answers the script did not use")] {
let given = Value::Array(vec![ok.clone(); extra + 1]);
let e = headless(&mut s, "alert('x');", given).unwrap_err().to_string();
assert!(e.contains(says), "{e}");
}
}
#[test]
fn invalid_answers_are_rejected_before_run() {
let mut s = one_doc();
+1 -1
View File
@@ -255,7 +255,7 @@ impl Session {
}
// The Selection and Group Selection tools act on the instance whole.
self.select_whole_instance(id);
// The tool lent to does not see the press: it counts as a press elsewhere for the clicks a
// The lending tool does not see the press: it counts as a press elsewhere for the clicks a
// double-click or triple-click compares.
self.tool.press_elsewhere();
let lent = self.make_tool(id);
+266 -1
View File
@@ -1,5 +1,5 @@
//! Untrusted files never crash the app: garbage, truncated, mutated and hostile SVG, PDF, DXF and HP-GL input,
//! mutated raster images (Photoshop documents and JPEG XL images among them) placed with File → Place, and swatch (`.vcswatches`, `.gpl`, `.ase`), graphic style (`.vcstyles`), flattener preset
//! mutated raster images (Photoshop documents and JPEG XL images among them) placed with File → Place, Photoshop documents' slices (damaged or cut short) opened and placed, and swatch (`.vcswatches`, `.gpl`, `.ase`), graphic style (`.vcstyles`), flattener preset
//! (`.vcflattener`) and export preset (`.vcexportpresets`) libraries, shortcut sets and action sets other apps save as text (`.kys`, `.aia`), and native files (compressed, damaged, saved for older versions),
//! must load as an error or as a document that then renders and exports, without a panic; nor may
//! bitmaps, PDF and text pasted from other apps, nor EMF and WMF pictures (damaged files, records
@@ -1939,6 +1939,271 @@ proptest! {
}
}
// ---------- PSD slices ----------
/// A Unicode string as a PSD file stores it: a count of UTF-16 units, then the units.
fn psd_unicode(s: &str) -> Vec<u8> {
let units: Vec<u16> = s.encode_utf16().collect();
let mut b = (units.len() as u32).to_be_bytes().to_vec();
b.extend(units.iter().flat_map(|u| u.to_be_bytes()));
b
}
/// A descriptor key or class ID: length 0 and its four characters, or its length and its characters.
fn psd_key(k: &str) -> Vec<u8> {
let mut b = if k.len() == 4 { 0u32 } else { k.len() as u32 }.to_be_bytes().to_vec();
b.extend(k.as_bytes());
b
}
/// A descriptor's class (an empty name and the ID `null`), then the count of its items.
fn psd_class(count: usize) -> Vec<u8> {
let mut b = psd_unicode("");
b.extend(psd_key("null"));
b.extend((count as u32).to_be_bytes());
b
}
/// A descriptor of `items`, each a key and a typed value.
fn psd_descriptor(items: &[(&str, Vec<u8>)]) -> Vec<u8> {
let mut b = psd_class(items.len());
for (k, v) in items {
b.extend(psd_key(k));
b.extend(v);
}
b
}
/// A typed descriptor value: its four-character type, then `body`.
fn psd_value(kind: &[u8; 4], body: &[u8]) -> Vec<u8> {
[kind.as_slice(), body].concat()
}
fn psd_long(v: i32) -> Vec<u8> {
psd_value(b"long", &v.to_be_bytes())
}
fn psd_text(t: &str) -> Vec<u8> {
psd_value(b"TEXT", &psd_unicode(t))
}
fn psd_enum(kind: &str, v: &str) -> Vec<u8> {
psd_value(b"enum", &[psd_key(kind), psd_key(v)].concat())
}
/// A bounds object: left, top, right and bottom (px), stored top, left, bottom, right.
fn psd_bounds([l, t, r, b]: [i32; 4]) -> Vec<u8> {
psd_value(b"Objc", &psd_descriptor(&[("Top ", psd_long(t)), ("Left", psd_long(l)), ("Btom", psd_long(b)), ("Rght", psd_long(r))]))
}
/// The slices of the samples: origin (0: generated automatically, 1: follows a layer, 2: made by
/// the user), name, and left, top, right and bottom on the 12 × 10 px canvas. Two come in; the
/// automatic one between them is left out.
const PSD_SLICES: [(u32, &str, [i32; 4]); 3] = [(2, "a", [1, 2, 5, 6]), (0, "auto", [0, 0, 12, 1]), (1, "b", [6, 3, 11, 9])];
/// The data of an image resource 1050 holding [`PSD_SLICES`].
struct SliceSample {
version: u32,
data: Vec<u8>,
/// Where the slice count starts in `data`.
count_at: usize,
}
/// Version 6: the bounds of all the slices, the group's name, the count and one record per slice.
/// The first record is followed by a Photoshop 7 descriptor (version 16) with a nested object, which
/// the reader reads past to the second record.
fn psd_slices_v6() -> SliceSample {
let mut b = 6u32.to_be_bytes().to_vec();
b.extend([0i32, 0, 10, 12].iter().flat_map(|v| v.to_be_bytes()));
b.extend(psd_unicode("group"));
let count_at = b.len();
b.extend((PSD_SLICES.len() as u32).to_be_bytes());
for (i, (origin, name, rect)) in PSD_SLICES.iter().enumerate() {
// The ID, the group ID and the origin; a slice that follows a layer gives the layer's ID.
b.extend((i as u32 + 1).to_be_bytes());
b.extend(0u32.to_be_bytes());
b.extend(origin.to_be_bytes());
if *origin == 1 {
b.extend(4u32.to_be_bytes());
}
b.extend(psd_unicode(name));
// An Image slice: its rectangle, link, target, message, alternative text, plain cell text,
// alignment and background color (alpha, red, green, blue).
b.extend(1u32.to_be_bytes());
b.extend(rect.iter().flat_map(|v| v.to_be_bytes()));
for t in ["https://example.com/", "_blank", "", "alt"] {
b.extend(psd_unicode(t));
}
b.push(0);
b.extend(psd_unicode(""));
b.extend([0u8; 8]);
b.extend([255, 10, 20, 30]);
if i == 0 {
b.extend(16u32.to_be_bytes());
let color = psd_value(b"Objc", &psd_descriptor(&[("Rd ", psd_value(b"doub", &128f64.to_be_bytes()))]));
b.extend(psd_descriptor(&[("topOutset", psd_long(0)), ("bgColor", color)]));
}
}
SliceSample { version: 6, data: b, count_at }
}
/// Versions 7 and 8: a version 16 descriptor with the slices' bounds, base name and `slices` list,
/// each slice an object with a nested bounds and background color object.
fn psd_slices_descriptor(version: u32) -> SliceSample {
let mut b = version.to_be_bytes().to_vec();
b.extend(16u32.to_be_bytes());
b.extend(psd_class(3));
b.extend(psd_key("bounds"));
b.extend(psd_bounds([0, 0, 12, 10]));
b.extend(psd_key("baseName"));
b.extend(psd_text("sheet"));
b.extend(psd_key("slices"));
b.extend(b"VlLs");
let count_at = b.len();
b.extend((PSD_SLICES.len() as u32).to_be_bytes());
for (i, (origin, name, rect)) in PSD_SLICES.iter().enumerate() {
let origin = match origin {
0 => "autoGenerated",
1 => "layerGenerated",
_ => "userGenerated",
};
let doub = |v: f64| psd_value(b"doub", &v.to_be_bytes());
let color = psd_value(b"Objc", &psd_descriptor(&[("Rd ", doub(10.0)), ("Grn ", doub(20.0)), ("Bl ", doub(30.0))]));
b.extend(psd_value(
b"Objc",
&psd_descriptor(&[
("sliceID", psd_long(i as i32 + 1)),
("groupID", psd_long(0)),
("origin", psd_enum("ESliceOrigin", origin)),
("Type", psd_enum("ESliceType", "Img ")),
("bounds", psd_bounds(*rect)),
("Nm ", psd_text(name)),
("url", psd_text("https://example.com/")),
("bgColorType", psd_enum("ESliceBGColorType", "Clr ")),
("bgColor", color),
]),
));
}
SliceSample { version, data: b, count_at }
}
/// Resource 1050 in versions 6, 7 and 8.
fn psd_slice_samples() -> Vec<SliceSample> {
vec![psd_slices_v6(), psd_slices_descriptor(7), psd_slices_descriptor(8)]
}
/// A flat 12 × 10 px RGB PSD file whose one image resource is 1050 holding `data`, and where
/// `data` lies in it.
fn sliced_psd(data: &[u8]) -> (Vec<u8>, std::ops::Range<usize>) {
// The signature, version 1, reserved bytes, 3 channels, 10 rows, 12 columns, 8 bits, RGB, and
// no color mode data.
let mut f = b"8BPS\0\x01\0\0\0\0\0\0\0\x03".to_vec();
f.extend(10u32.to_be_bytes());
f.extend(12u32.to_be_bytes());
f.extend([0, 8, 0, 3]);
f.extend([0; 4]);
let mut block = b"8BIM".to_vec();
block.extend(1050u16.to_be_bytes());
block.extend([0, 0]);
block.extend((data.len() as u32).to_be_bytes());
let start = f.len() + 4 + block.len();
block.extend(data);
block.resize(block.len().next_multiple_of(2), 0);
f.extend((block.len() as u32).to_be_bytes());
f.extend(block);
// No layer and mask information, then the merged image, raw.
f.extend([0; 4]);
f.extend([0, 0]);
f.extend((0..360u32).map(|v| (v * 7) as u8));
(f, start..start + data.len())
}
/// PSD file `f` opened (the names of the document's slices, and the open's warnings), counted by
/// `document.psdInfo`, and placed embedded in a new document (the count of the slices it brings in).
fn sliced_psd_imports(f: &[u8]) -> (Vec<String>, Value, Value, usize) {
let mut s = vectorcraft_engine::Session::new();
let p = json!({"name": "sheet.psd", "dataBase64": vectorcraft_format::base64_encode(f)});
let r = s.execute("document.open", &p).unwrap();
let names = s.doc().unwrap().doc.slices.iter().map(|x| x.options.name.clone()).collect();
let info = s.execute("document.psdInfo", &p).unwrap();
s.execute("file.new", &json!({})).unwrap();
let placed = s.execute("file.place", &json!({"name": "sheet.psd", "dataBase64": vectorcraft_format::base64_encode(f), "link": false})).unwrap();
(names, r["warnings"].clone(), info["slices"].clone(), placed["slices"].as_array().map_or(0, Vec::len))
}
/// Each sample reaches the slice reader: its two user slices open and place, without a warning,
/// and `document.psdInfo` counts them; the automatic one is left out.
#[test]
fn the_sliced_psd_samples_bring_in_their_user_slices() {
for sample in psd_slice_samples() {
let (names, warnings, info, placed) = sliced_psd_imports(&sliced_psd(&sample.data).0);
assert_eq!(names, ["a", "b"], "version {}: {warnings}", sample.version);
assert_eq!(warnings.as_array().map_or(0, Vec::len), 0, "version {}: {warnings}", sample.version);
assert_eq!((info, placed), (json!(2), 2), "version {}", sample.version);
}
}
/// A slice count past the 10,000 read, or one larger than the slices stored, and resource data cut
/// short, open and place the file without its slices, with a warning, and `document.psdInfo`
/// counts none.
#[test]
fn sliced_psd_samples_with_huge_counts_or_cut_short_come_in_without_their_slices() {
for sample in psd_slice_samples() {
let mut damaged = vec![];
for count in [10_001u32, 0x7fff_ffff, u32::MAX] {
let mut d = sample.data.clone();
d[sample.count_at..sample.count_at + 4].copy_from_slice(&count.to_be_bytes());
damaged.push((format!("count {count}"), d));
}
damaged.push(("one byte short".into(), sample.data[..sample.data.len() - 1].to_vec()));
damaged.push(("cut in the count".into(), sample.data[..sample.count_at + 2].to_vec()));
for (what, d) in damaged {
let (names, warnings, info, placed) = sliced_psd_imports(&sliced_psd(&d).0);
let warned = warnings.as_array().is_some_and(|w| w.iter().any(|w| w.as_str().is_some_and(|w| w.contains("the slices can't be read"))));
assert!(warned, "version {}, {what}: {warnings}", sample.version);
assert_eq!((names.len(), info, placed), (0, json!(0), 0), "version {}, {what}", sample.version);
}
}
}
proptest! {
#![proptest_config(config())]
/// Mutated copies of the slice samples never crash opening the file, `document.psdInfo` or
/// placing it embedded: the resource's data mutated, then kept whole, cut short with the
/// resource's length saying so, or with the file cut short in the resource's block.
#[test]
fn mutated_psd_slices_never_panic(which in 0usize..3, mode in 0u8..3, cut in any::<usize>(), edits in prop::collection::vec((any::<usize>(), any::<u8>()), 0..12)) {
let SliceSample { version, mut data, .. } = psd_slice_samples().swap_remove(which);
let len = data.len();
for (at, b) in edits {
data[at % len] = b;
}
let bytes = match mode {
0 => sliced_psd(&data).0,
1 => {
data.truncate(cut % (len + 1));
sliced_psd(&data).0
}
_ => {
let (mut f, at) = sliced_psd(&data);
f.truncate(at.start - 12 + cut % (len + 13));
f
}
};
let r = catch_quiet(|| {
let mut s = vectorcraft_engine::Session::new();
let p = json!({"name": "sheet.psd", "dataBase64": vectorcraft_format::base64_encode(&bytes)});
let _ = no_panic(s.execute("document.open", &p));
let _ = no_panic(s.execute("document.psdInfo", &p));
let _ = no_panic(s.execute("file.new", &json!({})));
let p = json!({"name": "sheet.psd", "dataBase64": vectorcraft_format::base64_encode(&bytes), "link": false});
let _ = no_panic(s.execute("file.place", &p));
});
prop_assert!(r.is_ok(), "version {version}, mode {mode}: 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.
@@ -648,6 +648,107 @@ fn batched_colored_inflate_preserves_compound_holes_and_surface_opacity() {
assert_eq!(image.pixels, render(doc(&s)).pixels);
}
/// The alpha of `d` drawn at 1:1 against a 3x render averaged down. Inside the art, on each pixel
/// whose 3x average and its eight neighbors' share one alpha, a pixel is off when it is below 255
/// where that alpha is 255, otherwise more than 3 levels away from it. Outside the art, a pixel is
/// painted past the outline when it has an alpha above 3 where it and its eight neighbors are empty
/// at 3x. Returns (pixels measured inside, pixels off, the largest alpha off, pixels painted past the
/// outline, the first few of either).
fn alpha_against_supersampled(d: &Document) -> (usize, usize, u8, usize, Vec<String>) {
let image = render(d);
let fine = vectorcraft_render::Renderer::new().render(
d,
1200,
1200,
kurbo::Affine::scale(3.0),
&vectorcraft_render::RenderOptions { background: None, artboards: false, ..Default::default() },
);
let average = fine.area_resized(400, 400).unwrap();
let (mut measured, mut off, mut worst, mut past) = (0, 0, 0, 0);
let mut first = vec![];
for y in 1..399 {
for x in 1..399 {
let q = average.pixel(x, y)[3];
if !(y - 1..=y + 1).all(|y| (x - 1..=x + 1).all(|x| average.pixel(x, y)[3] == q)) {
continue;
}
let p = image.pixel(x, y)[3];
let wrong = if q == 0 {
let painted = p > 3;
past += usize::from(painted);
painted
} else {
measured += 1;
let hole = if q == 255 { p < 255 } else { p.abs_diff(q) > 3 };
off += usize::from(hole);
worst = worst.max(p.abs_diff(q));
hole
};
if wrong && first.len() < 4 {
first.push(format!("({x},{y}) {p} vs {q}"));
}
}
}
(measured, off, worst, past, first)
}
/// Revolve under colored lights draws each face of a gradient-lit surface on its own, over an
/// underlay of its faces clipped to the surface's outline: at 1:1, no pixel inside the art lets the
/// background through where a 3x render averaged down is opaque, none paints past the outline, and
/// a surface's opacity, its gradient's transparent stops and its blending mode apply once. The same
/// holds for the art read back from SVG and PDF and for Expand Appearance.
#[test]
fn colored_revolve_faces_leave_no_alpha_holes_at_one_to_one() {
let gradient = |opacity: f64| {
json!({"gradient":{"kind":"linear","start":[100,150],"end":[200,150],"stops":[
{"offset":0,"color":"#ffffff","opacity":opacity},{"offset":1,"color":"#808080","opacity":opacity}
]}})
};
let lights = json!([
{"color":"#ff0000","rotation":135,"height":35,"intensity":70},
{"color":"#0000ff","rotation":-35,"height":25,"intensity":65}
]);
let cases = [
("red light, gradient", gradient(1.0), json!({}), None),
("red light, solid", json!({"color":"#ffcc66"}), json!({}), None),
("two lights, gradient", gradient(1.0), json!({"ambient":10,"lights":lights}), None),
("two lights, solid", json!({"color":"#ffcc66"}), json!({"ambient":10,"lights":lights}), None),
("red light, edge-on faces", gradient(1.0), json!({"rotationX":-80}), None),
("red light, gradient at 60%", gradient(0.6), json!({}), None),
("red light, fill at 60%", gradient(1.0), json!({}), Some(json!({"item":0,"opacity":60}))),
("red light, multiply", gradient(1.0), json!({}), Some(json!({"item":0,"blend":"Multiply"}))),
];
let mut failures = vec![];
for (name, fill, params, transparency) in cases {
let (mut s, _) = capped_profile();
s.execute("effect.setParams", &json!({"index":0,"item":null,"params":params})).unwrap();
s.execute("paint.setFill", &fill).unwrap();
if let Some(t) = transparency {
s.execute("transparency.set", &t).unwrap();
}
let svg = s.execute("document.serialize", &json!({"format":"svg"})).unwrap()["text"].as_str().unwrap().to_owned();
assert!(!svg.contains("<image"), "{name}");
let pdf = s.execute("document.serialize", &json!({"format":"pdf"})).unwrap();
let pdf = vectorcraft_format::base64_decode(pdf["dataBase64"].as_str().unwrap()).unwrap();
assert!(!pdf.windows(b"/Subtype /Image".len()).any(|w| w == b"/Subtype /Image"), "{name}");
let live = doc(&s).clone();
s.execute("effect.expandAppearance", &json!({})).unwrap();
for (of, d) in [
("live", live),
("SVG", vectorcraft_svg::import(&svg).unwrap()),
("PDF", vectorcraft_pdf::import(&pdf).unwrap()),
("expanded", doc(&s).clone()),
] {
let (measured, off, worst, past, first) = alpha_against_supersampled(&d);
assert!(measured > 10_000, "{name} {of}: {measured} pixels inside");
if off > 0 || past > 0 {
failures.push(format!("{name} {of}: of {measured} pixels, {off} off (at most {worst}), {past} past the outline: {first:?}"));
}
}
}
assert!(failures.is_empty(), "{failures:#?}");
}
/// Under colored lights, an Inflate fill and stroke in solid colors draw each face on its own, in
/// one depth order: zoomed in, the fill's faces show the colors the one composite of the surface
/// shows (drawn when the stroke is translucent), with no seam between faces; at 1x, where a pixel
+15
View File
@@ -265,6 +265,15 @@ pub fn export_ai_editing(doc: &Document, o: &AiEditingOptions) -> Result<AiEditi
/// [`export_ai_editing`] writing at most `max_objects` objects, counted as the reader counts them.
fn export_within(doc: &Document, o: &AiEditingOptions, max_objects: usize) -> Result<AiEditingOutput, String> {
export_held(doc, o, max_objects, true)
}
/// [`export_within`]; with `keep_wraps`, wrapped area type the reader wraps the same is written as
/// type ([`writer::wraps_held`]). When such type is written and art is left out at the object
/// limit, the wrap objects above it may be among what is left out, and the document is written
/// again with that type as its outlines.
fn export_held(source: &Document, o: &AiEditingOptions, max_objects: usize, keep_wraps: bool) -> Result<AiEditingOutput, String> {
let doc = source;
let board = doc.artboards.first().ok_or("the document has no artboard")?.rect;
if !(board.is_finite() && board.width() > 0.0 && board.height() > 0.0) {
return Err("the document has no artboard".into());
@@ -277,6 +286,8 @@ fn export_within(doc: &Document, o: &AiEditingOptions, max_objects: usize) -> Re
let (symbol_styled, pattern_styled) = writer::styled_definitions(doc);
let own_styles = doc.graphic_styles != Document::new(1.0, 1.0).graphic_styles;
let links = writer::style_links(doc);
// Before baking, which leaves the wrap objects that may be written as they are unchanged.
let wraps_held = if keep_wraps { writer::wraps_held(doc, &styled) } else { HashSet::new() };
// Live geometry effects as their result, as the PDF part draws them.
let baked = baked(doc);
let doc = baked.as_ref().unwrap_or(doc);
@@ -309,6 +320,7 @@ fn export_within(doc: &Document, o: &AiEditingOptions, max_objects: usize) -> Re
w.brushes_live = scale == 1.0;
w.symbol_doc = symbol_doc;
w.max_objects = max_objects;
w.wraps_held = wraps_held;
w.reserve_swatch_gradients();
if scale == 1.0 {
w.styled = styled;
@@ -320,6 +332,9 @@ fn export_within(doc: &Document, o: &AiEditingOptions, max_objects: usize) -> Re
for layer in &doc.layers {
w.layer(layer);
}
if w.wrapped_type_cut() {
return export_held(source, o, max_objects, false);
}
// The symbols no instance uses too; their art adds definitions.
w.symbols();
// The brushes, once the layers have said whether an object is written with one.
+343
View File
@@ -11634,6 +11634,349 @@ fn same_region(before: &[(Vec<[f64; 4]>, f64, bool)], after: &[(Vec<[f64; 4]>, f
before.len() == after.len() && before.iter().zip(after).all(|(b, a)| close(&b.0, &a.0) && (b.1 - a.1).abs() < 1e-6 && b.2 == a.2)
}
/// A `w` × `h` document of area type "Body" in the frame `frame`, with `over` above it (bottom
/// first), its wrap shapes resolved as the canvas resolves them.
fn wrapped_body(w: f64, h: f64, frame: Rect, over: impl FnOnce(&mut Document) -> Vec<Node>) -> Document {
use vectorcraft_doc::{TextKind, TextObject, TextRun};
let mut doc = Document::new(w, h);
let layer = doc.layers[0].id;
let size = frame.height() / 20.0;
let mut body = TextObject::point(vectorcraft_geom::Point::ZERO, "", style(size, Color::BLACK));
body.runs = vec![TextRun::new("one two three four five six seven eight nine ten eleven twelve", style(size, Color::BLACK))];
body.kind = TextKind::Area { frame: shapes::rectangle(frame) };
body.xf = Affine::IDENTITY;
let body = named(text_node(&mut doc, body), "Body");
let over = over(&mut doc);
for n in std::iter::once(body).chain(over) {
doc.insert(Some(layer), usize::MAX, n).unwrap();
}
vectorcraft_doc::text::resolve_wrap(None, &mut doc);
doc
}
/// The characters, frame and wrap shapes of the area type on `doc`'s first layer, as it is (its
/// shapes not resolved again).
fn area_type(doc: &Document) -> Option<(String, Option<Rect>, usize)> {
use vectorcraft_doc::TextKind;
doc.layers[0].children().unwrap().iter().find_map(|n| match &n.kind {
NodeKind::Text(t) if matches!(&t.kind, TextKind::Area { .. }) => {
let TextKind::Area { frame } = &t.kind else { return None };
Some((t.runs.iter().map(|r| r.text.as_str()).collect(), frame.transformed(t.xf).bounds(), t.wrap.len()))
}
_ => None,
})
}
/// Area type wrapped only by plain paths, compound paths and groups that don't clip is written as
/// type and reopens as area type with its characters, its frame and the same wrap shapes, which
/// the reader works out again from the objects above it ([`crate::import`]'s
/// `resolve_text_wrap`): a filled path with a negative offset and Invert Wrap, a locked path with
/// only a stroke, a compound path, a group of two squares with a hidden member, an offset of
/// -1000 pt, and an empty group and an open line with options, which wrap nothing.
#[test]
fn area_type_wrapped_by_plain_objects_stays_type() {
type Make = fn(&mut Document) -> Vec<Node>;
fn ring(doc: &mut Document, r: Rect) -> Node {
let outer = Node::path(doc.alloc_id(), shapes::rectangle(r), Appearance::default());
let inner = Node::path(doc.alloc_id(), shapes::rectangle(r.inset(-10.0)), Appearance::default());
let mut ring = Node::new(doc.alloc_id(), NodeKind::Compound { children: vec![Arc::new(outer), Arc::new(inner)], rule: FillRule::EvenOdd });
ring.appearance = Appearance::basic(solid(Color::gray(0.5)), Paint::None, 0.0).into();
ring
}
let cases: [(&str, Make); 6] = [
("a path, a negative offset, Invert Wrap", |doc| {
vec![wrapped(square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5)), -4.25, true)]
}),
("a locked stroked path", |doc| {
let mut n = Node::path(
doc.alloc_id(),
shapes::ellipse(Rect::new(80.0, 30.0, 180.0, 130.0)),
Appearance::basic(Paint::None, solid(Color::BLACK), 2.0),
);
n.locked = true;
vec![wrapped(n, 6.0, false)]
}),
("a compound path", |doc| vec![wrapped(ring(doc, Rect::new(80.0, 30.0, 200.0, 150.0)), 7.0, true)]),
("a group", |doc| {
let a = square(doc, Rect::new(40.0, 40.0, 80.0, 80.0), Color::gray(0.5));
let mut hidden = square(doc, Rect::new(120.0, 40.0, 160.0, 80.0), Color::gray(0.5));
hidden.visible = false;
let b = square(doc, Rect::new(200.0, 100.0, 240.0, 140.0), Color::gray(0.5));
vec![wrapped(group(doc, vec![a, hidden, b], false), -2.0, false)]
}),
("an offset of -1000 pt", |doc| vec![wrapped(square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5)), -1000.0, false)]),
("an empty group and an open line", |doc| {
let line = Node::path(
doc.alloc_id(),
shapes::line((20.0, 20.0).into(), (280.0, 180.0).into()),
Appearance::basic(Paint::None, solid(Color::BLACK), 1.0),
);
let empty = group(doc, vec![], false);
let n = square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5));
vec![wrapped(n, 3.0, false), wrapped(empty, 5.0, false), wrapped(line, 5.0, false)]
}),
];
for (name, make) in cases {
let doc = wrapped_body(300.0, 200.0, Rect::new(10.0, 10.0, 290.0, 190.0), make);
let before = area_type(&doc).unwrap();
assert_ne!(before.2, 0, "{name}: the type is wrapped");
let out = export_ai_editing(&doc, &opts()).unwrap();
let text_out = String::from_utf8_lossy(&out.program).replace("\r\n", "\n");
assert!(!out.warnings.iter().any(|w| w == writer::TYPE), "{name}: {:?}", out.warnings);
assert!(text_out.contains("/AI11Text"), "{name}");
let back = read_back(&doc);
let after = area_type(&back).unwrap_or_else(|| panic!("{name}: no area type\n{text_out}"));
assert_eq!(after.0, before.0, "{name}");
let (b, a) = (before.1.unwrap(), after.1.unwrap());
assert!([b.x0 - a.x0, b.y0 - a.y0, b.x1 - a.x1, b.y1 - a.y1].iter().all(|d| d.abs() < 1e-3), "{name}: {b:?} {a:?}");
assert_eq!(after.2, before.2, "{name}: the reader wrapped it");
assert!(same_region(&area_wrap_region(&doc), &area_wrap_region(&back)), "{name}\n{text_out}");
// The object that wraps it comes back as the same kind, lock and options.
let source = |d: &Document| {
let n = d.layers[0].children().unwrap()[1].clone();
(std::mem::discriminant(&n.kind), n.locked, n.visible, n.extras().wrap)
};
assert_eq!(source(&back), source(&doc), "{name}\n{text_out}");
}
}
/// Area type stays outlines when a wrap object above it is not written as itself, or its shapes
/// are not the ones the objects above it give it: an object with an effect, a blend, a symbol
/// instance, a path with a gradient, a compound path with a hidden member, a group holding type,
/// a compound path of one subpath (read back as a path), an offset past 1000 pt, a clipping group, and shapes of an object that has moved since.
#[test]
fn area_type_wrapped_by_other_objects_stays_outlines() {
type Make = fn(&mut Document) -> Vec<Node>;
let cases: [(&str, Make); 10] = [
("an effect", |doc| {
let n = styled_rect(doc, "Shadowed", Rect::new(100.0, 40.0, 160.0, 120.0), solid(Color::gray(0.5)), Paint::None, vec![drop_shadow()]);
vec![wrapped(n, 4.0, false)]
}),
("a blend", |doc| {
let keys = vec![
Arc::new(square(doc, Rect::new(60.0, 80.0, 70.0, 90.0), Color::gray(0.5))),
Arc::new(square(doc, Rect::new(220.0, 110.0, 230.0, 120.0), Color::gray(0.5))),
];
let spec = vectorcraft_doc::BlendSpec { spacing: vectorcraft_doc::BlendSpacing::Distance(60.0), ..Default::default() };
vec![wrapped(Node::new(doc.alloc_id(), NodeKind::Blend { children: keys, spec: Box::new(spec) }), 4.5, false)]
}),
("a symbol instance", |doc| {
two_leaves(doc);
vec![wrapped(instance(doc, "Leaf", Affine::new([3.0, 0.0, 0.0, 3.0, 150.0, 100.0])), 4.5, false)]
}),
("a gradient", |doc| {
let g = Gradient::new(GradientKind::Linear, vec![GradientStop::new(0.0, Color::BLACK), GradientStop::new(1.0, Color::WHITE)]);
let ap = Appearance::basic(Paint::Gradient(Box::new(GradientPaint::new(g))), Paint::None, 0.0);
vec![wrapped(Node::path(doc.alloc_id(), shapes::rectangle(Rect::new(100.0, 40.0, 160.0, 120.0)), ap), 4.0, false)]
}),
("a compound path with a hidden member", |doc| {
let outer = Node::path(doc.alloc_id(), shapes::rectangle(Rect::new(80.0, 30.0, 200.0, 150.0)), Appearance::default());
let mut inner = Node::path(doc.alloc_id(), shapes::rectangle(Rect::new(100.0, 50.0, 180.0, 130.0)), Appearance::default());
inner.visible = false;
let mut ring =
Node::new(doc.alloc_id(), NodeKind::Compound { children: vec![Arc::new(outer), Arc::new(inner)], rule: FillRule::EvenOdd });
ring.appearance = Appearance::basic(solid(Color::gray(0.5)), Paint::None, 0.0).into();
vec![wrapped(ring, 4.0, false)]
}),
("a group holding type", |doc| {
let label = vectorcraft_doc::TextObject::point(vectorcraft_geom::Point::new(100.0, 100.0), "Label", style(20.0, Color::BLACK));
let label = text_node(doc, label);
let n = square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5));
vec![wrapped(group(doc, vec![n, label], false), 4.0, false)]
}),
("a compound path of one subpath", |doc| {
let only = Node::path(doc.alloc_id(), shapes::rectangle(Rect::new(80.0, 30.0, 200.0, 150.0)), Appearance::default());
let mut one = Node::new(doc.alloc_id(), NodeKind::Compound { children: vec![Arc::new(only)], rule: FillRule::NonZero });
one.appearance = Appearance::basic(solid(Color::gray(0.5)), Paint::None, 0.0).into();
vec![wrapped(one, 4.0, false)]
}),
("an offset past 1000 pt", |doc| vec![wrapped(square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5)), 1000.5, false)]),
("a clipping group", |doc| {
let clip = clipping(doc, shapes::rectangle(Rect::new(80.0, 30.0, 200.0, 150.0)));
let n = square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5));
vec![wrapped(group(doc, vec![clip, n], true), 4.0, false)]
}),
("a path moved since", |doc| vec![wrapped(square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5)), 4.0, false)]),
];
let mut typed = vec![];
for (name, make) in cases {
let mut doc = wrapped_body(300.0, 200.0, Rect::new(10.0, 10.0, 290.0, 190.0), make);
assert_ne!(area_type(&doc).unwrap().2, 0, "{name}: the type is wrapped");
if name == "a path moved since" {
let id = doc.layers[0].children().unwrap()[1].id;
doc.node_mut(id).unwrap().transform(Affine::translate((30.0, 0.0)), false);
}
let out = export_ai_editing(&doc, &opts()).unwrap();
if !out.warnings.iter().any(|w| w == writer::TYPE) || area_type(&read_back(&doc)).is_some() {
typed.push(name);
}
}
assert!(typed.is_empty(), "written as type: {typed:?}");
}
/// Each frame of threaded area type is checked on its own: a thread whose first frame is wrapped
/// by a path and a group and whose second by the group alone is written as type and reopens as the
/// same thread with the same shapes in each frame; with a blend over the second frame, the whole
/// thread is written as outlines.
#[test]
fn threaded_area_type_wrapped_by_plain_objects_stays_type() {
use vectorcraft_doc::{TextKind, TextObject, TextRun};
for blend in [false, true] {
let mut doc = Document::new(400.0, 200.0);
let layer = doc.layers[0].id;
let st = style(10.0, Color::BLACK);
let mut first = TextObject::point(vectorcraft_geom::Point::ZERO, "", st.clone());
first.runs = vec![TextRun::new("one two three four five six seven eight nine ten eleven twelve thirteen fourteen ", st.clone())];
first.kind = TextKind::Area { frame: shapes::rectangle(Rect::new(10.0, 10.0, 190.0, 90.0)) };
first.xf = Affine::IDENTITY;
let mut second = first.clone();
second.runs = vec![TextRun::new("fifteen sixteen seventeen eighteen nineteen twenty", st.clone())];
second.kind = TextKind::Area { frame: shapes::rectangle(Rect::new(210.0, 10.0, 390.0, 90.0)) };
let (first, second) = (named(text_node(&mut doc, first), "First"), named(text_node(&mut doc, second), "Second"));
doc.text_threads.push(vec![first.id, second.id]);
let path = wrapped(square(&mut doc, Rect::new(60.0, 20.0, 100.0, 60.0), Color::gray(0.5)), -3.0, true);
let over_second = if blend {
let keys = vec![
Arc::new(square(&mut doc, Rect::new(250.0, 20.0, 260.0, 30.0), Color::gray(0.5))),
Arc::new(square(&mut doc, Rect::new(340.0, 60.0, 350.0, 70.0), Color::gray(0.5))),
];
let spec = vectorcraft_doc::BlendSpec { spacing: vectorcraft_doc::BlendSpacing::Distance(30.0), ..Default::default() };
wrapped(Node::new(doc.alloc_id(), NodeKind::Blend { children: keys, spec: Box::new(spec) }), 2.0, false)
} else {
let a = square(&mut doc, Rect::new(250.0, 20.0, 290.0, 60.0), Color::gray(0.5));
let b = square(&mut doc, Rect::new(120.0, 50.0, 300.0, 80.0), Color::gray(0.5));
wrapped(group(&mut doc, vec![a, b], false), 2.0, false)
};
// Bottom first: the first frame, the path, the second frame, the group or blend.
for n in [first, path, second, over_second] {
doc.insert(Some(layer), usize::MAX, n).unwrap();
}
vectorcraft_doc::text::resolve_wrap(None, &mut doc);
type Region = Vec<(Vec<[f64; 4]>, f64, bool)>;
let shapes = |d: &Document| -> Vec<Region> {
d.layers[0]
.children()
.unwrap()
.iter()
.filter_map(|n| match &n.kind {
NodeKind::Text(t) => Some(
t.wrap
.iter()
.map(|s| {
let parts = s
.path
.subpaths
.iter()
.map(|sp| {
let b = PathData::new(vec![sp.clone()]).bounds().unwrap_or_default();
[b.x0, b.y0, b.x1, b.y1]
})
.collect();
(parts, s.wrap.offset, s.wrap.invert)
})
.collect(),
),
_ => None,
})
.collect()
};
let before = shapes(&doc);
assert_eq!(before.iter().map(Vec::len).collect::<Vec<_>>(), [2, 1], "blend: {blend}");
let out = export_ai_editing(&doc, &opts()).unwrap();
let back = read_back(&doc);
if blend {
assert!(out.warnings.iter().any(|w| w == writer::TYPE), "{:?}", out.warnings);
assert!(back.text_threads.is_empty());
continue;
}
assert!(!out.warnings.iter().any(|w| w == writer::TYPE), "{:?}", out.warnings);
assert_eq!(back.text_threads.len(), 1);
let names: Vec<_> = back.text_threads[0].iter().map(|id| back.node(*id).and_then(|n| n.name.clone())).collect();
assert_eq!(names, [Some("First".to_string()), Some("Second".to_string())]);
let after = shapes(&back);
assert_eq!(after.len(), 2);
for (b, a) in before.iter().zip(&after) {
assert!(same_region(b, a), "{before:?}\n{after:?}");
}
}
}
/// Wrapped area type is written as type only while the wrap shapes of all the area type the reader
/// reads stay within what it copies: 150 frames under a wrap object of 10,000 anchors are, and
/// with 100 more frames under it, none are.
#[test]
fn area_type_wrapped_past_the_reader_limit_stays_outlines() {
use vectorcraft_doc::{TextKind, TextObject};
let area = |doc: &mut Document| {
let mut t = TextObject::point(vectorcraft_geom::Point::ZERO, "Wrapped", style(10.0, Color::BLACK));
t.kind = TextKind::Area { frame: shapes::rectangle(Rect::new(0.0, 0.0, 100.0, 100.0)) };
t.xf = Affine::IDENTITY;
let n = text_node(doc, t);
doc.insert(Some(doc.layers[0].id), 0, n).unwrap()
};
let mut doc = Document::new(100.0, 100.0);
let ids: Vec<_> = (0..150).map(|_| area(&mut doc)).collect();
let mut zigzag = vec![(40.0, 0.0).into()];
zigzag.extend((1..10_000).map(|i| vectorcraft_geom::Point::new(40.0 + 20.0 * f64::from(i) / 10_000.0, if i % 2 == 0 { 0.0 } else { 100.0 })));
let n = wrapped(
Node::path(doc.alloc_id(), PathData::new(vec![vectorcraft_geom::SubPath::polyline(&zigzag, true)]), Appearance::default()),
6.0,
false,
);
doc.insert(Some(doc.layers[0].id), usize::MAX, n).unwrap();
vectorcraft_doc::text::resolve_wrap(None, &mut doc);
let held = writer::wraps_held(&doc, &std::collections::HashMap::new());
assert!(ids.iter().all(|id| held.contains(id)), "{} of {}", held.len(), ids.len());
for _ in 0..100 {
area(&mut doc);
}
assert!(vectorcraft_doc::text::wrap_work(&doc) > crate::import::MAX_WRAP_WORK);
assert!(writer::wraps_held(&doc, &std::collections::HashMap::new()).is_empty());
}
/// Wrapped area type stays type with room for every object, and is written as outlines when art is
/// left out at the object limit: one object short, the wrap object above it would be left out and
/// the reader would not wrap the type.
#[test]
fn area_type_wrapped_past_the_object_limit_is_written_as_outlines() {
let doc = wrapped_body(300.0, 200.0, Rect::new(10.0, 10.0, 290.0, 190.0), |doc| {
vec![wrapped(square(doc, Rect::new(100.0, 40.0, 160.0, 120.0), Color::gray(0.5)), 4.0, false)]
});
let read = crate::import::objects_read(&export_ai_editing(&doc, &opts()).unwrap().program).unwrap();
let all = export_within(&doc, &opts(), read).unwrap();
assert!(!all.warnings.iter().any(|w| w == writer::OBJECT_LIMIT || w == writer::TYPE), "{:?}", all.warnings);
let short = export_within(&doc, &opts(), read - 1).unwrap();
assert!(short.warnings.iter().any(|w| w == writer::OBJECT_LIMIT), "{:?}", short.warnings);
assert!(short.warnings.iter().any(|w| w == writer::TYPE), "{:?}", short.warnings);
let (back, _) = crate::ai_alone(&short.program).unwrap();
assert!(area_type(&back).is_none(), "{}", String::from_utf8_lossy(&short.program));
}
/// On a large canvas, area type wrapped by a plain path is written as type and reopens with the
/// same wrap shapes, the offset at its size.
#[test]
fn area_type_wrapped_on_a_large_canvas_stays_type() {
let doc = wrapped_body(20_000.0, 20_000.0, Rect::new(1000.0, 1000.0, 9000.0, 9000.0), |doc| {
vec![wrapped(square(doc, Rect::new(3000.0, 3000.0, 5000.0, 6000.0), Color::gray(0.5)), -12.5, true)]
});
let before = area_type(&doc).unwrap();
assert_ne!(before.2, 0);
let out = export_ai_editing(&doc, &opts()).unwrap();
assert!(!out.warnings.iter().any(|w| w == writer::TYPE), "{:?}", out.warnings);
let back = read_back(&doc);
let after = area_type(&back).expect("area type");
assert_eq!((after.0.as_str(), after.2), (before.0.as_str(), before.2));
let (b, a) = (area_wrap_region(&doc), area_wrap_region(&back));
let close = b.len() == a.len()
&& b.iter().zip(&a).all(|(b, a)| {
b.0.len() == a.0.len()
&& b.0.iter().zip(&a.0).all(|(x, y)| x.iter().zip(y).all(|(x, y)| (x - y).abs() < 1e-2))
&& (b.1 - a.1).abs() < 1e-3
&& b.2 == a.2
});
assert!(close, "{b:?}\n{a:?}");
}
/// Type written as its outlines wraps area type below it by its bounds, as it did before saving,
/// not by its glyphs: its text wrap options go on an unpainted rectangle of its bounds, the last
/// member of the outlines' group, which keeps the type's name and has no options of its own.
+21 -3
View File
@@ -31,6 +31,7 @@ pub(super) use envelopes::ENVELOPES;
pub(super) use styles::{LARGE_CANVAS_STYLES, style_links, styled_definitions, styled_objects};
#[cfg(test)]
pub(super) use styles::{PANEL_EMPTY, PANEL_STYLES, STYLE_LINKS, WARPED_IMAGES, same_appearance};
pub(super) use texts::wraps_held;
pub(super) use images::PAYLOAD;
#[cfg(test)]
@@ -49,7 +50,7 @@ pub(super) use variables::{ACTIVE, BINDINGS, LIMITS, VALUES};
/// [`vectorcraft_doc::MAX_DEPTH`].
pub(super) const MAX_NEST: u32 = 8;
pub(super) const TYPE: &str = "type in opacity masks, pattern tiles, symbols and art cut to a clipping object, mirrored type, area type and type on a path that is turned or unevenly scaled or whose frame or path has several parts, area type in an open frame, type on an open path whose ends meet, area type that flows around a text wrap, type of only white space, threads of type on a path, threads whose frames differ in orientation or hold a frame written as outlines, type of sizes past what the reader reads, stories past what the reader reads (1,048,576 bytes a story, 16,777,216 bytes in all, and the size of text document it reads), and type with inline graphics, ruby, gradient or pattern paint, or fills, strokes, effects or an opacity mask of the object's own, is written as its outlines in the editing data for other apps";
pub(super) const TYPE: &str = "type in opacity masks, pattern tiles, symbols and art cut to a clipping object, mirrored type, area type and type on a path that is turned or unevenly scaled or whose frame or path has several parts, area type in an open frame, type on an open path whose ends meet, area type whose text wrap cannot be preserved from the saved objects, type of only white space, threads of type on a path, threads whose frames differ in orientation or hold a frame written as outlines, type of sizes past what the reader reads, stories past what the reader reads (1,048,576 bytes a story, 16,777,216 bytes in all, and the size of text document it reads), and type with inline graphics, ruby, gradient or pattern paint, or fills, strokes, effects or an opacity mask of the object's own, is written as its outlines in the editing data for other apps";
pub(super) const PATTERNS: &str = "pattern fills whose tiles aren't a grid or whose art reaches past the tile, pattern fills in another pattern's tile or in a symbol, and pattern fills nested more than 8 deep are written as their tiles cut to the shape in the editing data for other apps";
pub(super) const PATTERN_TILES: &str = "pattern fills with more tiles than a fill places are written filled gray in the editing data for other apps";
pub(super) const CLIPPING: &str = "clipping groups and clipping layers whose clipping object isn't a path, and the clipping groups inside them, are written as their art cut to that object in the editing data for other apps";
@@ -228,6 +229,10 @@ pub(super) struct Writer<'a> {
bound: Vec<(vectorcraft_doc::NodeId, String, Vec<String>)>,
/// The text document: the stories of the type written as text.
pub(super) texts: texts::TextDoc,
/// The area type with wrap shapes that may be written as type ([`texts::wraps_held`]).
pub(super) wraps_held: HashSet<NodeId>,
/// Area type with wrap shapes was written as type.
wrapped_typed: bool,
/// Symbol instances on the layers may be written as instances ([`Self::live_instance`]); false
/// on a large canvas, where they are written as their art.
pub(super) symbols_live: bool,
@@ -348,6 +353,8 @@ impl<'a> Writer<'a> {
typed: false,
bound: vec![],
texts: texts::TextDoc::default(),
wraps_held: HashSet::new(),
wrapped_typed: false,
cms: vectorcraft_color::cms::active(),
body: String::new(),
warnings: vec![],
@@ -404,6 +411,12 @@ impl<'a> Writer<'a> {
}
}
/// Was area type with wrap shapes written as type, and art left out at the object limit
/// ([`Self::take_objects`])? The reader may then wrap that type by fewer objects than it had.
pub(super) fn wrapped_type_cut(&self) -> bool {
self.wrapped_typed && self.left_out > 0
}
/// Whether `count` more objects may be written: the objects written so far, counted as the
/// reader counts them ([`object_count`]), stay within [`Self::max_objects`]. Past it the art is
/// left out, with a warning.
@@ -1482,7 +1495,11 @@ impl<'a> Writer<'a> {
let thread = doc.text_threads.iter().find(|th| th.contains(&n.id));
let contents = self.contents_level.filter(|(hidden, nest, _)| (*hidden, *nest) == (self.hidden, self.nest));
// Type that can't be a stub is written as its outlines, which count their own objects.
if (self.hidden > 0 && contents.is_none()) || self.clip.is_some() || self.in_symbol || (thread.is_none() && !texts::holds(n, t)) {
if (self.hidden > 0 && contents.is_none())
|| self.clip.is_some()
|| self.in_symbol
|| (thread.is_none() && !texts::holds(n, t, self.wraps_held.contains(&n.id)))
{
self.outlined += 1;
return self.outlined_text(n, xy);
}
@@ -1495,7 +1512,7 @@ impl<'a> Writer<'a> {
}
let placed = if let Some(thread) = thread {
// A thread is checked for what it loses, in every frame, when its story is written.
let placed = self.texts.thread(doc, thread, n.id, self.canvas, &|id| !cut_to_clipping_object(doc, id));
let placed = self.texts.thread(doc, thread, n.id, self.canvas, &|id| !cut_to_clipping_object(doc, id), &self.wraps_held);
placed.map(|p| (p, self.texts.take_lost()))
} else {
self.texts.add(t, self.canvas).map(|story| ((story, 0), texts::loses(t)))
@@ -1507,6 +1524,7 @@ impl<'a> Writer<'a> {
return self.outlined_text(n, xy);
};
self.typed = true;
self.wrapped_typed |= !t.wrap.is_empty();
if lost {
self.warn(texts::TYPE_ATTRIBUTES);
}
+115 -7
View File
@@ -17,6 +17,7 @@
use std::collections::{HashMap, HashSet};
use std::fmt::Write;
use std::sync::Arc;
use kurbo::{ParamCurveArclen, PathSeg};
use vectorcraft_color::{Color, Paint};
@@ -197,8 +198,8 @@ fn solid(p: &Paint) -> Option<Option<Color>> {
/// Can the text document hold type `t` of object `n` as it is: point type that isn't mirrored, or
/// area type or type on a path that is only moved ([`shape`]); characters other than inline graphics
/// and ruby; solid fills and strokes; no fills, strokes, effects or opacity mask of the object's
/// own; some text.
pub(in crate::ai_editing) fn holds(n: &Node, t: &TextObject) -> bool {
/// own; some text. Area type with wrap shapes only when `wrap_held` ([`wraps_held`]).
pub(in crate::ai_editing) fn holds(n: &Node, t: &TextObject, wrap_held: bool) -> bool {
let xf = t.xf.as_coeffs();
let shape_ok = match &t.kind {
TextKind::Point => xf.iter().all(|v| v.is_finite()) && t.xf.determinant() > 1e-12,
@@ -210,10 +211,9 @@ pub(in crate::ai_editing) fn holds(n: &Node, t: &TextObject) -> bool {
}
};
// Area type with wrap shapes: the text document doesn't hold them. The reader works them out
// again from the art above the type, which can wrap it differently (a live object written as
// its drawn pieces) or not at all.
// again from the art above the type, which wraps it the same only where `wraps_held` says so.
shape_ok
&& t.wrap.is_empty()
&& (t.wrap.is_empty() || wrap_held)
&& t.ruby.is_empty()
&& !t.stacks_warichu()
&& t.runs.iter().any(|r| r.text.chars().any(|c| !c.is_whitespace()))
@@ -324,6 +324,112 @@ fn plain(n: &Node) -> bool {
&& n.extras().mask.is_none()
}
/// The area type of `doc` whose wrap shapes the reader of the editing data works out again as they
/// are ([`vectorcraft_doc::text::resolve_wrap`], which the reader runs on what it reads): the
/// shapes are the ones the wrap objects above it give it now, and each of those objects is written
/// as itself and read back with the same outline and options ([`wrap_source_held`]), in layers
/// and groups written as they are ([`plain_containers`]). `styled`: the objects written with an
/// art style. Empty when the shapes of the document's area type would hold more anchors than the
/// reader copies into them ([`crate::import::MAX_WRAP_WORK`]).
pub(in crate::ai_editing) fn wraps_held(doc: &Document, styled: &HashMap<NodeId, Arc<Node>>) -> HashSet<NodeId> {
let mut held = HashSet::new();
if vectorcraft_doc::text::wrap_work(doc) > crate::import::MAX_WRAP_WORK {
return held;
}
let mut plain_in = HashSet::new();
for layer in &doc.layers {
plain_containers(layer, true, styled, &mut plain_in);
}
let mut checked: HashMap<NodeId, bool> = HashMap::new();
vectorcraft_doc::text::wrap_sources(doc, |n, sources, shapes| {
let NodeKind::Text(t) = &n.kind else { return };
if t.wrap.is_empty() || shapes != t.wrap || !plain_in.contains(&n.id) {
return;
}
let ok = sources.iter().all(|s| *checked.entry(s.id).or_insert_with(|| plain_in.contains(&s.id) && wrap_source_held(s, styled)));
if ok {
held.insert(n.id);
}
});
held
}
/// Adds to `out` the objects with text wrap options and the text objects in `n` (a top-level layer
/// when `top`) that sit only in layers and groups written as they are: layers and sublayers that
/// don't clip and have no effects, and groups that don't clip, have no fills, strokes, effects,
/// art style, opacity mask or graph and aren't written with an art style (`styled`).
fn plain_containers(n: &Node, top: bool, styled: &HashMap<NodeId, Arc<Node>>, out: &mut HashSet<NodeId>) {
let plain = match &n.kind {
NodeKind::Layer { clip, .. } => !clip && n.appearance.effects.is_empty(),
NodeKind::Group { clip, .. } => !top && !clip && n.appearance.items.is_empty() && own_plain(n, styled),
_ => false,
};
if !plain {
return;
}
for c in n.children().map(Vec::as_slice).unwrap_or_default() {
if c.extras().wrap.is_some() || matches!(c.kind, NodeKind::Text(_)) {
out.insert(c.id);
}
plain_containers(c, false, styled, out);
}
}
/// Has object `n` no effects, art style, opacity mask or graph, and isn't it a ruler guide or
/// written with an art style (`styled`)?
fn own_plain(n: &Node, styled: &HashMap<NodeId, Arc<Node>>) -> bool {
!styled.contains_key(&n.id)
&& n.appearance.effects.is_empty()
&& n.appearance.items.iter().all(|i| i.effects().is_empty())
&& n.extras().graphic_style.is_none()
&& n.extras().mask.is_none()
&& n.extras().graph.is_none()
&& !n.is_ruler_guide()
}
/// Is wrap object `n` written as itself and read back with the same outline and text wrap options:
/// an offset the writer and the reader keep as it is (-1000 to 1000 pt) and a plain object
/// ([`plain_wrap_art`])?
fn wrap_source_held(n: &Node, styled: &HashMap<NodeId, Arc<Node>>) -> bool {
n.extras().wrap.is_some_and(|w| w.offset.is_finite() && w.offset.abs() <= 1000.0) && plain_wrap_art(n, styled)
}
/// Is `n` written as one object of its own kind that the reader reads back with the same outline
/// ([`vectorcraft_doc::text::resolve_wrap`]): a path of one subpath, a compound path of visible
/// paths with two subpaths or more in all, each painted with no paint, a solid fill, a plain line of a solid color or both, or a
/// group that doesn't clip of such paths, compound paths and groups (hidden ones too) without text
/// wrap options of their own; each without effects, art style, opacity mask or graph
/// ([`own_plain`]). Each subpath has two anchors or more.
fn plain_wrap_art(n: &Node, styled: &HashMap<NodeId, Arc<Node>>) -> bool {
use vectorcraft_doc::AppearanceItem;
let solid = |p: &Paint| matches!(p, Paint::Solid { .. });
let painted = || match super::visible_items(n).as_slice() {
[] => true,
[AppearanceItem::Fill(f)] => solid(&f.paint),
[AppearanceItem::Stroke(s)] => solid(&s.paint) && vectorcraft_effects::stroke::is_plain(s),
[AppearanceItem::Fill(f), AppearanceItem::Stroke(s)] => solid(&f.paint) && solid(&s.paint) && vectorcraft_effects::stroke::is_plain(s),
_ => false,
};
let whole = |p: &PathData| p.subpaths.iter().all(|sp| sp.anchors.len() >= 2);
own_plain(n, styled)
&& match &n.kind {
NodeKind::Path { path, clipping: false, guide: false, .. } => path.subpaths.len() == 1 && whole(path) && painted(),
// One subpath in all would be written, and read back, as a path.
NodeKind::Compound { children, .. } => {
let subpaths: usize = children.iter().filter_map(|c| c.path_data()).map(|p| p.subpaths.len()).sum();
let members = children.iter().all(|c| {
c.visible
&& matches!(&c.kind, NodeKind::Path { path, clipping: false, guide: false, .. } if !path.subpaths.is_empty() && whole(path))
});
painted() && subpaths > 1 && members
}
NodeKind::Group { children, clip: false } => {
n.appearance.items.is_empty() && children.iter().all(|c| c.extras().wrap.is_none() && plain_wrap_art(c, styled))
}
_ => false,
}
}
/// Is the end bracket of type on an open path so near the path's end that the reader reads it as
/// no bracket (`Story::node`: within 0.02 of a segment)?
fn end_read_as_none(t: &TextObject) -> bool {
@@ -1000,7 +1106,8 @@ impl TextDoc {
/// `thread` (its frames in order, all area type the document holds, the first holding the
/// story) the first time one of its frames is written. `None` when the thread can't be written
/// as one story: `writable` says which frames are written where type can be text (every frame
/// of the thread must be).
/// of the thread must be), and `wraps_held` which frames with wrap shapes the reader wraps the
/// same ([`wraps_held`]; every frame with wrap shapes must be one).
pub(in crate::ai_editing) fn thread(
&mut self,
doc: &Document,
@@ -1008,6 +1115,7 @@ impl TextDoc {
id: NodeId,
canvas: Affine,
writable: &dyn Fn(NodeId) -> bool,
wraps_held: &HashSet<NodeId>,
) -> Option<(usize, usize)> {
let first = *thread.first()?;
if self.planned.insert(first) {
@@ -1026,7 +1134,7 @@ impl TextDoc {
&& t.vertical == vertical
&& writable(n.id)
// The text document doesn't hold wrap shapes (see `holds`).
&& t.wrap.is_empty()
&& (t.wrap.is_empty() || wraps_held.contains(&n.id))
&& plain(n)
&& t.ruby.is_empty()
&& !t.stacks_warichu()
+1 -1
View File
@@ -96,7 +96,7 @@ pub(crate) use ai::{
pub(crate) use ai::{ENVELOPE_DRAWN, ENVELOPE_TYPE_DRAWN};
pub(crate) use ate::{MAX_BYTES as MAX_TEXT_DOCUMENT, MAX_FRAMES, MAX_SEGMENTS, MAX_STORY, MAX_VALUES as MAX_TEXT_VALUES, record_version};
pub use native::{AiLayers, ai_alone, ai_alone_on_page, ai_alone_with, ai_layers_alone, ai_opened_artboard, is_loss, layered_ai, layered_ai_from};
pub(crate) use native::{MAX_TEXT, scale_document, scale_symbols};
pub(crate) use native::{MAX_TEXT, MAX_WRAP_WORK, scale_document, scale_symbols};
pub use text::family_style;
pub(crate) use text::{document_font, postscript_face};
+1 -1
View File
@@ -49,7 +49,7 @@ mod slots;
#[cfg(test)]
use build::{Frame, MADE, prune_unseen};
pub(crate) use build::{scale_document, scale_symbols};
pub(crate) use build::{MAX_WRAP_WORK, scale_document, scale_symbols};
#[cfg(test)]
use compare::{
MAX_DIFFERENCE, MAX_SOLID_DIFFERENCE, PageView, Shares, compare, compared, comparison_render, comparison_samples, differ, differ_in_colour,
+1 -1
View File
@@ -773,7 +773,7 @@ fn settle_warped_type(
}
/// Most anchors copied into the wrap shapes of a file's area type ([`vectorcraft_doc::text::wrap_work`]).
const MAX_WRAP_WORK: usize = 2_000_000;
pub(crate) const MAX_WRAP_WORK: usize = 2_000_000;
/// [`relayout_wrapped`], or an error when the wrap shapes would hold more than [`MAX_WRAP_WORK`]
/// anchors.
+2 -2
View File
@@ -232,8 +232,8 @@ pub fn export(doc: &Document, opts: &EpsOptions, preview: Option<&Raster>, thumb
}
// Type in the document's composite fonts is drawn in them, whether or not an app has the document open.
let _lent = vectorcraft_text::FontDb::global().lend_composite_fonts(&doc.composite_fonts);
let baked =
vectorcraft_effects::bake_document_placing_symbols(doc, true, vectorcraft_effects::WrittenLayers { hidden: false, non_printing: true });
let layers = vectorcraft_effects::WrittenLayers { hidden: false, non_printing: true, hidden_objects: false };
let baked = vectorcraft_effects::bake_document_placing_symbols(doc, true, layers);
let doc = baked.as_ref().unwrap_or(doc);
let page = scene::Scene::new(doc, opts).run();
let mut setting_notes = vec![];
+55
View File
@@ -103,6 +103,38 @@ pub fn ellipse(r: Rect) -> PathData {
PathData::single(SubPath::new(anchors, true))
}
/// Ellipse inscribed in `r` with `n` smooth anchors (at least 2) spaced evenly by angle, clockwise
/// on screen from the left one, as [`ellipse`] runs. Each segment is a cubic whose handles are
/// 4/3·tan(θ/4) of the tangent at its ends (θ = 360°/`n`), scaled along each axis; the path is then
/// fitted to `r`, so its bounds are `r` whatever the count. 4 anchors give [`ellipse`].
pub fn ellipse_with_anchors(r: Rect, n: u32) -> PathData {
let n = n.max(2);
let r = r.abs();
let c = r.center();
let (rx, ry) = (r.width() / 2.0, r.height() / 2.0);
let step = TAU / f64::from(n);
let k = 4.0 / 3.0 * (step / 4.0).tan();
let anchors = (0..n)
.map(|i| {
// From the left anchor (angle π). With y down, sin is negative just past π, so the next
// anchor is above the centre: left, then top, then right, as `ellipse` runs.
let a = PI + step * f64::from(i);
let p = Point::new(c.x + rx * a.cos(), c.y + ry * a.sin());
let d = Vec2::new(-rx * a.sin(), ry * a.cos()) * k;
Anchor { p, h_in: p - d, h_out: p + d, kind: AnchorKind::Smooth }
})
.collect();
let path = PathData::single(SubPath::new(anchors, true));
// Between anchors a curve can reach a little past the ellipse or stop short of it (0.15% of
// the height with 3 anchors): fit the bounds to `r` along each axis that has a size.
let Some(b) = path.bounds() else { return path };
let fit = |want: f64, got: f64| if want > 0.0 && got > 0.0 { want / got } else { 1.0 };
let (sx, sy) = (fit(r.width(), b.width()), fit(r.height(), b.height()));
path.transformed(
kurbo::Affine::translate(r.origin().to_vec2()) * kurbo::Affine::scale_non_uniform(sx, sy) * kurbo::Affine::translate(-b.origin().to_vec2()),
)
}
/// How an ellipse or shape arc is closed or left open when cut between start and end angles.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
@@ -693,6 +725,29 @@ mod tests {
assert!((area - PI * 50.0 * 30.0).abs() / area < 0.001);
}
#[test]
fn ellipse_with_four_anchors_is_the_ellipse_and_others_fit_the_box() {
let r = Rect::new(10.0, 20.0, 110.0, 80.0);
let (four, plain) = (ellipse_with_anchors(r, 4), ellipse(r));
for (a, b) in four.subpaths[0].anchors.iter().zip(&plain.subpaths[0].anchors) {
assert!(a.p.distance(b.p) < 1e-9 && a.h_in.distance(b.h_in) < 1e-9 && a.h_out.distance(b.h_out) < 1e-9, "{a:?} {b:?}");
}
for n in [2, 3, 5, 7, 9, 1000] {
let p = ellipse_with_anchors(r, n);
assert_eq!(p.anchor_count(), n as usize);
let b = p.bounds().unwrap();
assert!(
(b.x0 - r.x0).abs() < 1e-9 && (b.y0 - r.y0).abs() < 1e-9 && (b.x1 - r.x1).abs() < 1e-9 && (b.y1 - r.y1).abs() < 1e-9,
"{n}: {b:?}"
);
let area = p.subpaths[0].area().abs();
assert!((area - PI * 50.0 * 30.0).abs() / area < if n == 2 { 0.1 } else { 0.01 }, "{n}: {area}");
}
// A box with no height leaves the path flat rather than dividing by zero.
let flat = ellipse_with_anchors(Rect::new(0.0, 5.0, 40.0, 5.0), 6);
assert!(flat.subpaths[0].anchors.iter().all(|a| a.p.y == 5.0 && a.p.x.is_finite()));
}
#[test]
fn rounded_rect_clamps() {
let p = rounded_rectangle(Rect::new(0.0, 0.0, 20.0, 10.0), 100.0);
+2 -1
View File
@@ -244,7 +244,7 @@ pub fn tool_definitions() -> Vec<Value> {
tool(
"draw_shape",
"Draw shape",
"Create a live shape and apply optional paint. rectangle/ellipse: x, y, width, height (rectangle: radius = corner radius). polygon: cx, cy, radius, sides. star: cx, cy, radius1, radius2, points. line: x1, y1, x2, y2. Omitted paint fields inherit the current new-art appearance (initially white fill and 1 pt black stroke); lines start with no fill and a visible stroke. For a filled shape without an outline, pass an explicit fill and stroke:\"none\". Stroke dash/cap/join, opacity, name and live effects apply to the new shape as in draw_path. Returns the new object id.",
"Create a live shape and apply optional paint. rectangle/ellipse: x, y, width, height (rectangle: radius = corner radius; ellipse: anchors, default 4, where any other count from 2 to 1000 draws a plain path rather than a live shape). polygon: cx, cy, radius, sides. star: cx, cy, radius1, radius2, points. line: x1, y1, x2, y2. Omitted paint fields inherit the current new-art appearance (initially white fill and 1 pt black stroke); lines start with no fill and a visible stroke. For a filled shape without an outline, pass an explicit fill and stroke:\"none\". Stroke dash/cap/join, opacity, name and live effects apply to the new shape as in draw_path. Returns the new object id.",
obj(
with_draw_options(json!({
"shape": {"type": "string", "enum": ["rectangle", "ellipse", "polygon", "star", "line"]},
@@ -253,6 +253,7 @@ pub fn tool_definitions() -> Vec<Value> {
"width": num("Width (rectangle/ellipse)"),
"height": num("Height (rectangle/ellipse)"),
"radius": num("Corner radius (rectangle) or radius (polygon)"),
"anchors": {"type": "integer", "minimum": 2, "maximum": 1000, "description": "Ellipse anchors, spaced evenly by angle (default 4, a live ellipse; any other count draws a plain path)"},
"cx": num("Centre x (polygon/star)"),
"cy": num("Centre y (polygon/star)"),
"sides": {"type": "integer", "minimum": 3, "description": "Polygon sides (default 6)"},
+1 -1
View File
@@ -188,7 +188,7 @@ pub const UI_COMMANDS: &[(&str, &str, &str, &str)] = &[
"shortcuts.exportText",
"Export Keyboard Shortcuts as Text…",
"",
"{path?} save the current set's tools and menu commands with their shortcuts as a UTF-8 text file (Keyboard Shortcuts › Export Text…): the set's name, then a Tools and a Menu Commands section in the dialog's order, one `name<TAB>shortcut` line per row, empty after the tab when it has none; without `path`, pick a file",
"{path?, format?: \"text\"|\"sheet\"|\"csv\" (default text), pageSize?: \"letter\"|\"a4\" (sheet only; default A4 when the current document prints on A4, else letter)} save the current set's tools and menu commands with their shortcuts (Keyboard Shortcuts › Export Text…). text: a UTF-8 text file: the set's name, then a Tools and a Menu Commands section in the dialog's order, one `name<TAB>shortcut` line per row, empty after the tab when it has none. sheet: a printable PDF on landscape pages that lists the rows with a shortcut, Tools and then a group per top-level menu, under a colored band per group, shortcut then name, in four columns. csv: a UTF-8 CSV file (RFC 4180 quoting, CRLF) with a `Group,Command,Shortcut` header and one record per row in the sheet's groups, in the UI language; a field that starts with = + - @ and has more after it starts with '. A `path` is written as given. Without it, pick a file: the desktop save dialog offers the three formats (text first) unless `format` names one, and the file type picked decides and gives the name its extension; with no dialog, writer or download, returns {text} (text, csv) or {pdf: base64} (sheet); a bad `format` or `pageSize` is an error",
),
("shortcuts.import", "Import Keyboard Shortcuts…", "", "{path? | data?}"),
(
Loaded 100 of 200 files, more files were not shown because too many files have changed in this diff. Show more