mirror of
https://github.com/storytold/vectorcraft.git
synced 2026-11-20 09:23:10 +01:00
Merge main into feat/brushes-dry-media-library
This commit is contained in:
commit
6e9ffa92cc
224 files changed
+14760
-564
No files matched your search
@@ -267,6 +267,7 @@ Generated-in-code art is original and has no file to list. This covers the defau
|
||||
| `assets/icons/flip-vertical-2.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | |
|
||||
| `assets/icons/folder-open.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | |
|
||||
| `assets/icons/frame.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | |
|
||||
| `assets/icons/graduation-cap.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | Learn panel, Explore tutorials button |
|
||||
| `assets/icons/grid-3x3.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | |
|
||||
| `assets/icons/group.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | |
|
||||
| `assets/icons/hand.svg` | Lucide Icons and Contributors | https://lucide.dev (lucide-static v1.49.0; header kept in file) | ISC (`assets/icons/LICENSE-lucide.txt`) | |
|
||||
|
||||
@@ -122,6 +122,7 @@ Ranked; detail in [docs/roadmap.md](docs/roadmap.md) and [docs/gaps.md](docs/gap
|
||||
## Progress log
|
||||
|
||||
- 2026-11-05: Window › Toolbars › Keep Tools Beside the Canvas, off by default, docks the Tools panel between left-side panels and the canvas instead of at the window's left edge, and the canvas's left edge then also docks a floating Tools panel (`window.toolsBesideCanvas`, #5395). Workspaces keep the setting; workspaces saved without it keep Tools at the window's edge. An optional VectorCraft layout choice; headline numbers unchanged.
|
||||
- 2026-11-12: Stencil Bridges in the Cutting Tools add-on (Object › Plug-ins › Cutting Tools): strips of a set width are cut out of the selected art so that every island of a stencil cut from it (the inside of an O, a hole in a shape) stays attached to the sheet, by the shortest crossings first, vertical, horizontal or the shortest among 12 directions 15° apart, with up to 16 bridges per island; type is measured by its glyph outlines and stays type, and the original goes to a hidden layer or is replaced. One undo step (`addon.cutting.bridges`). A VectorCraft addition: headline numbers unchanged.
|
||||
- 2026-11-05: Release Type on a Path joins the Type Tools add-on (Object › Plug-ins › Type Tools): each selected type on a path splits into point type with the same text and attributes, on one straight line starting where its first character sat, and the plain path it was set on, with its exact shape and place in the stacking order and no paint; or keeps only the path or only the text, optionally leaving the original. A dialog with Preview, one undo step (`addon.type.releasePath`, #5532). A VectorCraft addition: headline numbers unchanged.
|
||||
- 2026-11-04: New Document: the units chosen in Preset Details now belong to the chosen document, as the pane's options are listed for the selected preset; the chosen card shows them, every other Recent and Saved card keeps the units its document or preset was made in, and the built-in tabs still follow the chosen units, so switching between inches and millimetres no longer restyles every recent template. Scores and estimates unchanged.
|
||||
- 2026-11-02: Mouse wheel over a closed font-family field in Character, Properties or Control changes selected text through the family list using saved font filters (excluding search text), one undo step per notch, stopping at the ends (#5253). Scores and estimates unchanged.
|
||||
@@ -139,6 +140,7 @@ Ranked; detail in [docs/roadmap.md](docs/roadmap.md) and [docs/gaps.md](docs/gap
|
||||
- 2026-10-31: Export for Screens works as the reference app's dialog: Artboards and Assets tabs with a grid or list of thumbnails, Clear Selection and Prefix, Create Sub-folders by Scale or Format (on by default), Export PDFs As Single File (the chosen artboards as one PDF's pages, `pdfs: "single"`) or Multiple Files, iOS and Android rows, format presets in a ☰ menu, and a count of the files the export writes (#4895). About 55 community PRs and fixes landed the same day: Find Font, Replace Font, Outline Stroke and Expand leave hidden and locked art alone (with a warning); DXF export writes LINE and ELLIPSE entities and outlines only the strokes a CAD line can't draw; Blob Brush Angle and Roundness; Shift-constrained Perspective Selection; Grid Repeat Options Preview; a gradient mesh from a file budgeted at about a million quads; width-profile strokes keep their shape zoomed out; `.ai`/EPS import fidelity (area type, envelopes, transparency in dictionaries, character styles); PDF import finds hyphenated and CMap-suffixed font names; Windows renders follow the process's core affinity; Enter or Escape in a floating panel's field no longer reaches the canvas (#4803); Properties shows Blend Options for any selected blend (#4817); Artwork Cleanup finds doubled type (#4835) and joins stacked lines into one object (Join Point Text, #4826). Headline numbers unchanged.
|
||||
- 2026-10-31: Arrange Tools, a built-in add-on (Object › Plug-ins › Arrange Tools): Arrange in Grid lays the selected objects out in rows and columns, a row or a column with gaps, from the selection's top-left or centred on the artboard; Swap Objects swaps two objects' places (and, with Swap Objects and Sizes, their sizes); Replace with Top Object puts a copy of the topmost selected object in place of each of the others, kept, stretched or fitted in proportion; Set Size of Each gives every selected object an exact width and/or height about a reference point; Zoom to Selection fits the view to the selection. Each is one undo step with a previewed dialog where it has options. A VectorCraft addition: headline numbers unchanged.
|
||||
- 2026-11-11: Window › Swatch Libraries › Gradients › Organic Fades: fifteen soft fades (ten linear, five radial) through three to five unevenly spaced stops with off-center midpoints, mixed with the Perceptual method, that thin out to transparent at the end of a linear one and at the edge of a radial one; they also list in the Swatches panel's library menu, `swatch.library.list` and the Gradient panel's Presets.
|
||||
- 2026-11-11: Window › Swatch Libraries › Gradients › Holographic: seven foils (opaque linear gradients of six narrow pastel and pearl bands with off-center midpoints) and seven glows (radial gradients from a bright center out to a clear edge), mixed with the Perceptual method; they also list in the Swatches panel's library menu, `swatch.library.list` and the Gradient panel's Presets.
|
||||
- 2026-10-30: Gradient panel presets: a Presets menu applies one of the built-in gradient libraries' presets (grouped by theme) or a saved one to the gradient behind the active proxy, keeping its placement, as one undo step; the panel menu saves the current gradient as a preset, kept with the preferences, and deletes saved ones (`gradient.presets.list/apply/save/delete`).
|
||||
- 2026-10-23: Pathfinder › Trap: the Pathfinder panel's Trap… and Effect › Pathfinder › Trap… add a thin overprinting strip of the lighter colour inside the darker one where two solid colours meet, so misregistered plates leave no gap ([trapping](https://helpx.adobe.com/illustrator/using/trapping.html)), with Thickness, Height/Width, Tint Reduction, Traps with Process Color and Reverse Traps. Illustrator effects 49/50 (SVG Filters remains); Live vector effects hours 6–10 → 4–8; headline numbers unchanged.
|
||||
- 2026-10-23: OpenType SVG colour fonts draw as vector art: each glyph's SVG document is read by the SVG importer, in the text's colours where it asks for them, and draws, exports and outlines as COLR glyphs do; all colour font formats are now drawn.
|
||||
|
||||
@@ -378,7 +378,7 @@ pub(crate) fn services(parent: Parent, ui: egui::Context) -> Services {
|
||||
// Load Actions… refuses a file over its size limit without reading all of it.
|
||||
read_head: Some(Box::new(read_file_head)),
|
||||
write: Some(Box::new(write_file)),
|
||||
exists: Some(Box::new(|p: &str| std::path::Path::new(p).exists())),
|
||||
exists: Some(std::sync::Arc::new(|p: &str| std::path::Path::new(p).exists())),
|
||||
// Background Save and Export write from a worker thread.
|
||||
write_shared: Some(std::sync::Arc::new(write_file)),
|
||||
// Native saves stream into the file as they are encoded.
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<!-- @license lucide-static v1.49.0 - ISC -->
|
||||
<svg
|
||||
class="lucide lucide-graduation-cap"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="24"
|
||||
height="24"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
stroke-width="2"
|
||||
stroke-linecap="round"
|
||||
stroke-linejoin="round"
|
||||
>
|
||||
<path d="M21.42 10.922a1 1 0 0 0-.019-1.838L12.83 5.18a2 2 0 0 0-1.66 0L2.6 9.08a1 1 0 0 0 0 1.832l8.57 3.908a2 2 0 0 0 1.66 0z" />
|
||||
<path d="M22 10v6" />
|
||||
<path d="M6 12.5V16a6 3 0 0 0 12 0v-3.5" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 497 B |
@@ -3,7 +3,7 @@ name = "vectorcraft-cad"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
description = "VectorCraft CAD interchange: a hand-written ASCII DXF writer (R12 to 2018) and an HP-GL/2 plot file reader"
|
||||
description = "VectorCraft CAD interchange: a hand-written ASCII DXF writer (R12 to 2018) and an HP-GL/2 plot file reader and writer"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
@@ -16,11 +16,18 @@
|
||||
//! and the art of every page goes on one artboard; each comes back as a warning. Printer escape
|
||||
//! sequences and PJL lines around the instructions are skipped.
|
||||
//!
|
||||
//! [`export`] writes the visible art over a region as an HP-GL or HP-GL/2 plot, and
|
||||
//! [`export_regions`] one plot per region with one pen numbering: see [`write`].
|
||||
//!
|
||||
//! - `lex`: the bytes as instructions, numbers, labels and PE data.
|
||||
//! - `plot`: the instructions played on the pen, as shapes.
|
||||
//! - `write`: the writer, paths to pen moves.
|
||||
|
||||
mod lex;
|
||||
mod plot;
|
||||
pub mod write;
|
||||
|
||||
pub use write::{HpglOptions, HpglOutput, Origin, Version, export, export_regions};
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,265 @@
|
||||
//! Polylines cut by a region: each segment is split where it crosses the region's edges, and the
|
||||
//! pieces whose middle lies inside are kept, joined where they meet.
|
||||
|
||||
use vectorcraft_geom::{FillRule, Point, Rect};
|
||||
|
||||
/// A clipping region: closed rings (each closes implicitly) and the rule that decides inside.
|
||||
pub(super) struct Region {
|
||||
rings: Vec<Vec<Point>>,
|
||||
rule: FillRule,
|
||||
bounds: Rect,
|
||||
}
|
||||
|
||||
impl Region {
|
||||
/// The region of `rings` under `rule`; `None` when it has no ring of three points or more.
|
||||
pub fn new(rings: Vec<Vec<Point>>, rule: FillRule) -> Option<Self> {
|
||||
let rings: Vec<Vec<Point>> = rings.into_iter().filter(|r| r.len() >= 3).collect();
|
||||
let bounds = rings.iter().flatten().fold(None, |b: Option<Rect>, p| Some(b.map_or(Rect::from_points(*p, *p), |b| b.union_pt(*p))))?;
|
||||
Some(Self { rings, rule, bounds })
|
||||
}
|
||||
|
||||
/// The edges this region has, which [`Region::cut`] tests each segment against.
|
||||
fn edges(&self) -> u64 {
|
||||
self.rings.iter().map(|r| r.len() as u64).sum()
|
||||
}
|
||||
|
||||
/// Does `p` lie on one of the region's edges (within a millionth of a point)?
|
||||
fn on_edge(&self, p: Point) -> bool {
|
||||
self.rings.iter().any(|ring| {
|
||||
ring.iter().enumerate().any(|(i, &a)| {
|
||||
let b = ring[(i + 1) % ring.len()];
|
||||
let ab = b - a;
|
||||
let len2 = ab.hypot2();
|
||||
let t = if len2 > 0.0 { ((p - a).dot(ab) / len2).clamp(0.0, 1.0) } else { 0.0 };
|
||||
(a + ab * t).distance(p) <= 1e-6
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
/// Is `p` inside (non-zero winding or an odd number of crossings), or on an edge?
|
||||
fn contains(&self, p: Point) -> bool {
|
||||
if self.on_edge(p) {
|
||||
return true;
|
||||
}
|
||||
let mut winding = 0i64;
|
||||
for ring in &self.rings {
|
||||
for (i, &a) in ring.iter().enumerate() {
|
||||
let b = ring[(i + 1) % ring.len()];
|
||||
if a.y <= p.y {
|
||||
if b.y > p.y && cross(a, b, p) > 0.0 {
|
||||
winding += 1;
|
||||
}
|
||||
} else if b.y <= p.y && cross(a, b, p) < 0.0 {
|
||||
winding -= 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
match self.rule {
|
||||
FillRule::NonZero => winding != 0,
|
||||
FillRule::EvenOdd => winding % 2 != 0,
|
||||
}
|
||||
}
|
||||
|
||||
/// Where segment `a`–`b` crosses this region's edges, as fractions of its length strictly
|
||||
/// between 0 and 1, sorted.
|
||||
fn crossings(&self, a: Point, b: Point) -> Vec<f64> {
|
||||
let mut ts = vec![];
|
||||
for ring in &self.rings {
|
||||
for (i, &c) in ring.iter().enumerate() {
|
||||
let d = ring[(i + 1) % ring.len()];
|
||||
if let Some(t) = intersect(a, b, c, d)
|
||||
&& t > 1e-12
|
||||
&& t < 1.0 - 1e-12
|
||||
{
|
||||
ts.push(t);
|
||||
}
|
||||
}
|
||||
}
|
||||
ts.sort_by(f64::total_cmp);
|
||||
ts.dedup_by(|x, y| (*x - *y).abs() <= 1e-12);
|
||||
ts
|
||||
}
|
||||
|
||||
/// The parts of polyline `line` inside the region, each a polyline of two points or more.
|
||||
/// Every test of a point or a segment against an edge takes one from `budget`; `None` when
|
||||
/// the budget runs out first.
|
||||
pub fn cut(&self, line: &[Point], budget: &mut u64) -> Option<Vec<Vec<Point>>> {
|
||||
let edges = self.edges();
|
||||
let mut out: Vec<Vec<Point>> = vec![];
|
||||
let mut cur: Vec<Point> = vec![];
|
||||
for w in line.windows(2) {
|
||||
let (a, b) = (w[0], w[1]);
|
||||
// A segment wholly off the region's box lies outside it.
|
||||
let near = overlaps(Rect::from_points(a, b), self.bounds);
|
||||
let ts = if near {
|
||||
spend(budget, edges)?;
|
||||
self.crossings(a, b)
|
||||
} else {
|
||||
vec![]
|
||||
};
|
||||
let mut from = 0.0;
|
||||
for to in ts.into_iter().chain([1.0]) {
|
||||
let (p, q) = (a.lerp(b, from), a.lerp(b, to));
|
||||
// Each piece between crossings is tested on its own: its edge and winding tests.
|
||||
let inside = if near {
|
||||
spend(budget, edges.saturating_mul(2))?;
|
||||
self.contains(p.midpoint(q))
|
||||
} else {
|
||||
false
|
||||
};
|
||||
if inside {
|
||||
if cur.last().is_none_or(|l| l.distance(p) > 1e-9) {
|
||||
flush(&mut out, &mut cur);
|
||||
cur.push(p);
|
||||
}
|
||||
cur.push(q);
|
||||
} else {
|
||||
flush(&mut out, &mut cur);
|
||||
}
|
||||
from = to;
|
||||
}
|
||||
}
|
||||
flush(&mut out, &mut cur);
|
||||
// A closed line that leaves the region and comes back: its last piece ends where its
|
||||
// first starts, at the line's start, and the two are one piece.
|
||||
if line.len() > 2
|
||||
&& line.first() == line.last()
|
||||
&& out.len() >= 2
|
||||
&& let (Some(end), Some(start)) = (out.last().and_then(|l| l.last()), out.first().and_then(|l| l.first()))
|
||||
&& end.distance(*start) <= 1e-9
|
||||
{
|
||||
let first = out.remove(0);
|
||||
if let Some(last) = out.last_mut() {
|
||||
last.extend(first.into_iter().skip(1));
|
||||
}
|
||||
}
|
||||
Some(out)
|
||||
}
|
||||
}
|
||||
|
||||
/// Take `n` from `budget`; `None` when it holds less.
|
||||
fn spend(budget: &mut u64, n: u64) -> Option<()> {
|
||||
*budget = budget.checked_sub(n)?;
|
||||
Some(())
|
||||
}
|
||||
|
||||
fn flush(out: &mut Vec<Vec<Point>>, cur: &mut Vec<Point>) {
|
||||
let line = std::mem::take(cur);
|
||||
if line.len() >= 2 {
|
||||
out.push(line);
|
||||
}
|
||||
}
|
||||
|
||||
fn overlaps(a: Rect, b: Rect) -> bool {
|
||||
a.x0 <= b.x1 && b.x0 <= a.x1 && a.y0 <= b.y1 && b.y0 <= a.y1
|
||||
}
|
||||
|
||||
/// Which side of line `a`–`b` point `p` lies on (positive: left).
|
||||
fn cross(a: Point, b: Point, p: Point) -> f64 {
|
||||
(b.x - a.x) * (p.y - a.y) - (p.x - a.x) * (b.y - a.y)
|
||||
}
|
||||
|
||||
/// Where segment `a`–`b` crosses segment `c`–`d`, as a fraction of `a`–`b`; `None` when they
|
||||
/// are parallel or don't meet.
|
||||
fn intersect(a: Point, b: Point, c: Point, d: Point) -> Option<f64> {
|
||||
let (r, s) = (b - a, d - c);
|
||||
let den = r.x * s.y - r.y * s.x;
|
||||
if den.abs() <= f64::EPSILON * (r.hypot() * s.hypot()).max(f64::MIN_POSITIVE) {
|
||||
return None;
|
||||
}
|
||||
let ac = c - a;
|
||||
let t = (ac.x * s.y - ac.y * s.x) / den;
|
||||
let u = (ac.x * r.y - ac.y * r.x) / den;
|
||||
((0.0..=1.0).contains(&t) && (0.0..=1.0).contains(&u)).then_some(t)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn square(x0: f64, y0: f64, x1: f64, y1: f64) -> Vec<Point> {
|
||||
vec![Point::new(x0, y0), Point::new(x1, y0), Point::new(x1, y1), Point::new(x0, y1)]
|
||||
}
|
||||
|
||||
/// `line` cut by `r` with no limit on the work.
|
||||
fn cut(r: &Region, line: &[Point]) -> Vec<Vec<Point>> {
|
||||
let mut unlimited = u64::MAX;
|
||||
r.cut(line, &mut unlimited).unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_line_across_a_square_keeps_its_middle() {
|
||||
let r = Region::new(vec![square(0.0, 0.0, 10.0, 10.0)], FillRule::NonZero).unwrap();
|
||||
let pieces = cut(&r, &[Point::new(-5.0, 5.0), Point::new(15.0, 5.0)]);
|
||||
assert_eq!(pieces, vec![vec![Point::new(0.0, 5.0), Point::new(10.0, 5.0)]]);
|
||||
// Wholly outside, nothing; wholly inside, the line as it is.
|
||||
assert!(cut(&r, &[Point::new(20.0, 0.0), Point::new(30.0, 0.0)]).is_empty());
|
||||
let inside = vec![Point::new(1.0, 1.0), Point::new(9.0, 1.0), Point::new(9.0, 9.0)];
|
||||
assert_eq!(cut(&r, &inside), vec![inside]);
|
||||
}
|
||||
|
||||
/// Each piece between crossings costs a pass over the edges: a line through the teeth of a
|
||||
/// comb spends far more than its two points times the edges.
|
||||
#[test]
|
||||
fn every_piece_between_crossings_is_paid_for() {
|
||||
let mut ring = vec![];
|
||||
for i in 0..100 {
|
||||
let x = f64::from(i) * 4.0;
|
||||
ring.extend([Point::new(x, 0.0), Point::new(x + 2.0, 0.0), Point::new(x + 2.0, 10.0), Point::new(x + 4.0, 10.0)]);
|
||||
}
|
||||
ring.extend([Point::new(400.0, 20.0), Point::new(0.0, 20.0)]);
|
||||
let r = Region::new(vec![ring], FillRule::NonZero).unwrap();
|
||||
let line = [Point::new(-1.0, 5.0), Point::new(401.0, 5.0)];
|
||||
// 402 edges, 200 crossings, 201 pieces: 402 + 201 × 2 × 402 tests.
|
||||
let need = 402 + 201 * 2 * 402;
|
||||
let mut budget = need;
|
||||
assert_eq!(r.cut(&line, &mut budget).map(|p| p.len()), Some(100));
|
||||
assert_eq!(budget, 0);
|
||||
let mut short = need - 1;
|
||||
assert!(r.cut(&line, &mut short).is_none());
|
||||
// A segment off the region's box costs nothing.
|
||||
assert_eq!(r.cut(&[Point::new(0.0, 30.0), Point::new(9.0, 30.0)], &mut 0), Some(vec![]));
|
||||
}
|
||||
|
||||
/// A line along any of the region's edges is inside it.
|
||||
#[test]
|
||||
fn a_line_on_an_edge_is_kept() {
|
||||
let r = Region::new(vec![square(0.0, 0.0, 10.0, 10.0)], FillRule::NonZero).unwrap();
|
||||
for line in [
|
||||
[Point::new(0.0, 0.0), Point::new(10.0, 0.0)],
|
||||
[Point::new(10.0, 0.0), Point::new(10.0, 10.0)],
|
||||
[Point::new(10.0, 10.0), Point::new(0.0, 10.0)],
|
||||
[Point::new(0.0, 10.0), Point::new(0.0, 0.0)],
|
||||
] {
|
||||
assert_eq!(cut(&r, &line), vec![line.to_vec()], "{line:?}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_line_leaving_and_coming_back_is_two_pieces() {
|
||||
let r = Region::new(vec![square(0.0, 0.0, 10.0, 10.0)], FillRule::NonZero).unwrap();
|
||||
let line = [Point::new(5.0, 5.0), Point::new(15.0, 5.0), Point::new(15.0, 8.0), Point::new(5.0, 8.0)];
|
||||
assert_eq!(cut(&r, &line), vec![vec![Point::new(5.0, 5.0), Point::new(10.0, 5.0)], vec![Point::new(10.0, 8.0), Point::new(5.0, 8.0)]]);
|
||||
}
|
||||
|
||||
/// A closed line that starts inside, leaves and comes back is one piece: the part after it
|
||||
/// comes back runs on into the part before it left.
|
||||
#[test]
|
||||
fn a_closed_line_cut_once_stays_one_piece() {
|
||||
let r = Region::new(vec![square(0.0, 0.0, 10.0, 10.0)], FillRule::NonZero).unwrap();
|
||||
let line = [Point::new(5.0, 5.0), Point::new(15.0, 5.0), Point::new(15.0, 8.0), Point::new(5.0, 8.0), Point::new(5.0, 5.0)];
|
||||
assert_eq!(cut(&r, &line), vec![vec![Point::new(10.0, 8.0), Point::new(5.0, 8.0), Point::new(5.0, 5.0), Point::new(10.0, 5.0)]]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_fill_rule_decides_a_hole() {
|
||||
let rings = vec![square(0.0, 0.0, 10.0, 10.0), square(3.0, 3.0, 7.0, 7.0)];
|
||||
let line = [Point::new(-1.0, 5.0), Point::new(11.0, 5.0)];
|
||||
// Both rings wind the same way: even-odd cuts a hole, non-zero doesn't.
|
||||
let even_odd = cut(&Region::new(rings.clone(), FillRule::EvenOdd).unwrap(), &line);
|
||||
assert_eq!(even_odd, vec![vec![Point::new(0.0, 5.0), Point::new(3.0, 5.0)], vec![Point::new(7.0, 5.0), Point::new(10.0, 5.0)]]);
|
||||
let non_zero = cut(&Region::new(rings, FillRule::NonZero).unwrap(), &line);
|
||||
assert_eq!(non_zero.len(), 1);
|
||||
assert!(Region::new(vec![vec![Point::ZERO, Point::new(1.0, 1.0)]], FillRule::NonZero).is_none());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,357 @@
|
||||
//! Which of a pen's paths lie inside which of its closed paths, in plotter units, for drawing the
|
||||
//! inner paths first.
|
||||
|
||||
/// The box of `p`: `[x0, y0, x1, y1]`.
|
||||
pub(super) fn bounds(p: &[(i64, i64)]) -> [i64; 4] {
|
||||
p.iter().fold([i64::MAX, i64::MAX, i64::MIN, i64::MIN], |b, q| [b[0].min(q.0), b[1].min(q.1), b[2].max(q.0), b[3].max(q.1)])
|
||||
}
|
||||
|
||||
/// For each of `paths` (`boxes` are their [`bounds`]), the closed paths it lies inside: none of
|
||||
/// its segments crosses the closed path's line, each part of it between the points where it meets
|
||||
/// that line lies inside the closed path (by the even-odd rule) or on the line, and at least one
|
||||
/// part lies inside. A path touching the line of the one around it is inside it, a path crossing
|
||||
/// it is not, and copies of one outline are not inside each other. A path is tested only against
|
||||
/// closed paths larger than it (by the area of their box, then the area they enclose, then paint
|
||||
/// order), so no two paths are each inside the other, and only against the closed paths in the
|
||||
/// [`Grid`] cell of its box's first corner. `None` once `work` is spent: a grid cell filled and a
|
||||
/// box compared cost one each, and each segment tested costs the closed path's points for its
|
||||
/// crossings and again for each part of it.
|
||||
pub(super) fn outer(paths: &[Vec<(i64, i64)>], boxes: &[[i64; 4]], work: &mut u64) -> Option<Vec<Vec<usize>>> {
|
||||
let size: Vec<(i128, i128)> = paths
|
||||
.iter()
|
||||
.zip(boxes)
|
||||
.map(|(p, b)| {
|
||||
let box_area = (i128::from(b[2]) - i128::from(b[0])) * (i128::from(b[3]) - i128::from(b[1]));
|
||||
(box_area, if closed(p) { twice_area(p) } else { 0 })
|
||||
})
|
||||
.collect();
|
||||
let rings: Vec<usize> = (0..paths.len()).filter(|&i| paths.get(i).is_some_and(|p| closed(p))).collect();
|
||||
let mut out = vec![vec![]; paths.len()];
|
||||
if rings.is_empty() {
|
||||
return Some(out);
|
||||
}
|
||||
let grid = Grid::new(&rings, boxes, work)?;
|
||||
for (a, (p, ab)) in paths.iter().zip(boxes).enumerate() {
|
||||
for &r in grid.at(ab[0], ab[1]) {
|
||||
spend(work, 1)?;
|
||||
let (Some(rb), Some(ring)) = (boxes.get(r), paths.get(r)) else { continue };
|
||||
let smaller = (size.get(a), a) < (size.get(r), r);
|
||||
if !smaller || rb[0] > ab[0] || rb[1] > ab[1] || rb[2] < ab[2] || rb[3] < ab[3] {
|
||||
continue;
|
||||
}
|
||||
if inside(p, ring, work)?
|
||||
&& let Some(o) = out.get_mut(a)
|
||||
{
|
||||
o.push(r);
|
||||
}
|
||||
}
|
||||
}
|
||||
Some(out)
|
||||
}
|
||||
|
||||
/// The most cells along each side of a [`Grid`].
|
||||
const MAX_GRID_SIDE: usize = 512;
|
||||
/// The most cells of a [`Grid`] a closed path is listed in; one whose box covers more is listed
|
||||
/// once, among the wide ones. A closed path has 4 points or more, so the grid lists no more
|
||||
/// entries than the pen has points.
|
||||
const MAX_CELLS_PER_PATH: usize = 4;
|
||||
|
||||
/// A grid over the boxes of a pen's closed paths, about one cell for each, up to
|
||||
/// [`MAX_GRID_SIDE`] a side: each cell lists, in paint order, the closed paths whose box covers
|
||||
/// it, and the closed paths whose box covers more than [`MAX_CELLS_PER_PATH`] cells are listed
|
||||
/// apart. A closed path whose box holds a point is among the wide ones or in that point's cell.
|
||||
struct Grid {
|
||||
/// The first corner of the closed paths' boxes together.
|
||||
x0: i128,
|
||||
y0: i128,
|
||||
/// Their width and height, plus one.
|
||||
w: i128,
|
||||
h: i128,
|
||||
/// Cells along each side.
|
||||
side: usize,
|
||||
/// The cells row by row.
|
||||
cells: Vec<Vec<usize>>,
|
||||
/// The closed paths whose box covers more than [`MAX_CELLS_PER_PATH`] cells.
|
||||
wide: Vec<usize>,
|
||||
}
|
||||
|
||||
impl Grid {
|
||||
/// The grid of the closed paths `rings` (indices into `boxes`). `None` once `work` is spent.
|
||||
fn new(rings: &[usize], boxes: &[[i64; 4]], work: &mut u64) -> Option<Self> {
|
||||
let all = rings
|
||||
.iter()
|
||||
.filter_map(|&r| boxes.get(r))
|
||||
.fold([i64::MAX, i64::MAX, i64::MIN, i64::MIN], |e, b| [e[0].min(b[0]), e[1].min(b[1]), e[2].max(b[2]), e[3].max(b[3])]);
|
||||
let side = ((rings.len() as f64).sqrt().ceil() as usize).clamp(1, MAX_GRID_SIDE);
|
||||
let (x0, y0) = (i128::from(all[0]), i128::from(all[1]));
|
||||
let mut grid = Self {
|
||||
x0,
|
||||
y0,
|
||||
w: (i128::from(all[2]) - x0 + 1).max(1),
|
||||
h: (i128::from(all[3]) - y0 + 1).max(1),
|
||||
side,
|
||||
cells: vec![vec![]; side * side],
|
||||
wide: vec![],
|
||||
};
|
||||
for &r in rings {
|
||||
let Some(b) = boxes.get(r) else { continue };
|
||||
let (Some((cx0, cy0)), Some((cx1, cy1))) = (grid.cell(b[0], b[1]), grid.cell(b[2], b[3])) else { continue };
|
||||
let covered = (cx1 - cx0 + 1) * (cy1 - cy0 + 1);
|
||||
if covered > MAX_CELLS_PER_PATH {
|
||||
spend(work, 1)?;
|
||||
grid.wide.push(r);
|
||||
continue;
|
||||
}
|
||||
spend(work, covered as u64)?;
|
||||
for cy in cy0..=cy1 {
|
||||
for cell in grid.cells.get_mut(cy * side + cx0..=cy * side + cx1).into_iter().flatten() {
|
||||
cell.push(r);
|
||||
}
|
||||
}
|
||||
}
|
||||
Some(grid)
|
||||
}
|
||||
|
||||
/// The column and row of the cell holding `(x, y)`, `None` outside the grid.
|
||||
fn cell(&self, x: i64, y: i64) -> Option<(usize, usize)> {
|
||||
let (dx, dy) = (i128::from(x) - self.x0, i128::from(y) - self.y0);
|
||||
if dx < 0 || dy < 0 || dx >= self.w || dy >= self.h {
|
||||
return None;
|
||||
}
|
||||
let side = self.side as i128;
|
||||
Some(((dx * side / self.w) as usize, (dy * side / self.h) as usize))
|
||||
}
|
||||
|
||||
/// The wide closed paths, then those listed in the cell holding `(x, y)`.
|
||||
fn at(&self, x: i64, y: i64) -> impl Iterator<Item = &usize> {
|
||||
let cell = self.cell(x, y).and_then(|(cx, cy)| self.cells.get(cy * self.side + cx)).map_or(&[][..], Vec::as_slice);
|
||||
self.wide.iter().chain(cell)
|
||||
}
|
||||
}
|
||||
|
||||
/// Takes `n` from `work`; `None`, with `work` at 0, when it has less.
|
||||
fn spend(work: &mut u64, n: u64) -> Option<()> {
|
||||
let left = work.checked_sub(n);
|
||||
*work = left.unwrap_or(0);
|
||||
left.map(|_| ())
|
||||
}
|
||||
|
||||
/// Does `p` start and end at one point, with three other points or more?
|
||||
fn closed(p: &[(i64, i64)]) -> bool {
|
||||
p.len() > 3 && p.first() == p.last()
|
||||
}
|
||||
|
||||
/// Twice the area the closed path `p` encloses.
|
||||
fn twice_area(p: &[(i64, i64)]) -> i128 {
|
||||
let sum: i128 = p
|
||||
.windows(2)
|
||||
.map(|w| match w {
|
||||
[a, b] => i128::from(a.0) * i128::from(b.1) - i128::from(b.0) * i128::from(a.1),
|
||||
_ => 0,
|
||||
})
|
||||
.sum();
|
||||
sum.abs()
|
||||
}
|
||||
|
||||
/// Does `p` lie inside the closed path `ring`, as [`outer`] decides? `None` once `work` is spent.
|
||||
fn inside(p: &[(i64, i64)], ring: &[(i64, i64)], work: &mut u64) -> Option<bool> {
|
||||
let mut any = false;
|
||||
for w in p.windows(2) {
|
||||
let [s, e] = w else { continue };
|
||||
spend(work, ring.len() as u64)?;
|
||||
// Where the segment meets the line without crossing it: its ends and the ring's points on
|
||||
// it. Between two of these the segment is all inside or all outside.
|
||||
let mut stops = vec![*s, *e];
|
||||
for edge in ring.windows(2) {
|
||||
let [a, b] = edge else { continue };
|
||||
if crosses((*s, *e), (*a, *b)) {
|
||||
return Some(false);
|
||||
}
|
||||
if a != s && a != e && on((*s, *e), *a) {
|
||||
stops.push(*a);
|
||||
}
|
||||
}
|
||||
let along = |q: &(i64, i64)| {
|
||||
(i128::from(q.0) - i128::from(s.0)) * (i128::from(e.0) - i128::from(s.0))
|
||||
+ (i128::from(q.1) - i128::from(s.1)) * (i128::from(e.1) - i128::from(s.1))
|
||||
};
|
||||
stops.sort_by_key(along);
|
||||
stops.dedup();
|
||||
for part in stops.windows(2) {
|
||||
let [m, n] = part else { continue };
|
||||
spend(work, ring.len() as u64)?;
|
||||
// The part's middle, doubled so it is whole.
|
||||
match locate((i128::from(m.0) + i128::from(n.0), i128::from(m.1) + i128::from(n.1)), ring) {
|
||||
Some(false) => return Some(false),
|
||||
Some(true) => any = true,
|
||||
None => {}
|
||||
}
|
||||
}
|
||||
}
|
||||
Some(any)
|
||||
}
|
||||
|
||||
/// Which side of the line through `a` and `b` `c` is on: 1 left, -1 right, 0 on it.
|
||||
fn side(a: (i64, i64), b: (i64, i64), c: (i64, i64)) -> i128 {
|
||||
let d = (i128::from(b.0) - i128::from(a.0)) * (i128::from(c.1) - i128::from(a.1))
|
||||
- (i128::from(b.1) - i128::from(a.1)) * (i128::from(c.0) - i128::from(a.0));
|
||||
d.signum()
|
||||
}
|
||||
|
||||
/// Do segments `u` and `v` cross at a point inside both, each passing from one side of the other
|
||||
/// to the other side?
|
||||
fn crosses(u: ((i64, i64), (i64, i64)), v: ((i64, i64), (i64, i64))) -> bool {
|
||||
side(u.0, u.1, v.0) * side(u.0, u.1, v.1) < 0 && side(v.0, v.1, u.0) * side(v.0, v.1, u.1) < 0
|
||||
}
|
||||
|
||||
/// Does `q` lie on segment `u`?
|
||||
fn on(u: ((i64, i64), (i64, i64)), q: (i64, i64)) -> bool {
|
||||
let ((x0, y0), (x1, y1)) = u;
|
||||
side(u.0, u.1, q) == 0 && q.0 >= x0.min(x1) && q.0 <= x0.max(x1) && q.1 >= y0.min(y1) && q.1 <= y0.max(y1)
|
||||
}
|
||||
|
||||
/// Where the doubled point `q` lies against the closed path `ring`: `Some(true)` inside by the
|
||||
/// even-odd rule, `Some(false)` outside, `None` on its line.
|
||||
fn locate(q: (i128, i128), ring: &[(i64, i64)]) -> Option<bool> {
|
||||
let mut inside = false;
|
||||
for w in ring.windows(2) {
|
||||
let [a, b] = w else { continue };
|
||||
let (a, b) = ((2 * i128::from(a.0), 2 * i128::from(a.1)), (2 * i128::from(b.0), 2 * i128::from(b.1)));
|
||||
// Which side of the segment's line `q` is on, 0 on it.
|
||||
let side = (b.0 - a.0) * (q.1 - a.1) - (b.1 - a.1) * (q.0 - a.0);
|
||||
if side == 0 && q.0 >= a.0.min(b.0) && q.0 <= a.0.max(b.0) && q.1 >= a.1.min(b.1) && q.1 <= a.1.max(b.1) {
|
||||
return None;
|
||||
}
|
||||
// A segment crossing the level of `q` to its right.
|
||||
if (a.1 > q.1) != (b.1 > q.1) && (side > 0) == (b.1 > a.1) {
|
||||
inside = !inside;
|
||||
}
|
||||
}
|
||||
Some(inside)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn square(x0: i64, y0: i64, x1: i64, y1: i64) -> Vec<(i64, i64)> {
|
||||
vec![(x0, y0), (x1, y0), (x1, y1), (x0, y1), (x0, y0)]
|
||||
}
|
||||
|
||||
fn nest(paths: &[Vec<(i64, i64)>]) -> Option<Vec<Vec<usize>>> {
|
||||
let boxes: Vec<[i64; 4]> = paths.iter().map(|p| bounds(p)).collect();
|
||||
let mut work = u64::MAX;
|
||||
outer(paths, &boxes, &mut work)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn points_inside_outside_and_on_the_line() {
|
||||
let ring = square(0, 0, 10, 10);
|
||||
assert_eq!(locate((10, 10), &ring), Some(true));
|
||||
assert_eq!(locate((30, 10), &ring), Some(false));
|
||||
assert_eq!(locate((10, -2), &ring), Some(false));
|
||||
assert_eq!(locate((20, 10), &ring), None);
|
||||
assert_eq!(locate((0, 0), &ring), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_path_inside_another_lies_inside_it_and_not_the_other_way() {
|
||||
let paths = [square(0, 0, 100, 100), square(10, 10, 20, 20), vec![(30, 30), (40, 40)]];
|
||||
assert_eq!(nest(&paths), Some(vec![vec![], vec![0], vec![0]]));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn touching_counts_as_inside_and_crossing_does_not() {
|
||||
// A square with a corner on the outline's left edge, a triangle whose corners lie on the
|
||||
// outline's edges, and a square that crosses the outline.
|
||||
let paths = [square(0, 0, 100, 100), square(0, 40, 20, 60), vec![(0, 50), (50, 0), (100, 50), (0, 50)], square(90, 90, 120, 95)];
|
||||
assert_eq!(nest(&paths), Some(vec![vec![], vec![0], vec![0], vec![]]));
|
||||
}
|
||||
|
||||
/// Every point of a copy lies on the other's line, and none inside it.
|
||||
#[test]
|
||||
fn copies_of_one_outline_do_not_lie_inside_each_other() {
|
||||
let paths = [square(0, 0, 10, 10), square(0, 0, 10, 10), vec![(10, 10), (10, 0), (0, 0), (0, 10), (10, 10)]];
|
||||
assert_eq!(nest(&paths), Some(vec![vec![], vec![], vec![]]));
|
||||
}
|
||||
|
||||
/// A line whose ends and middle lie inside an outline but which crosses a slot cut into it.
|
||||
#[test]
|
||||
fn a_line_across_a_slot_is_not_inside() {
|
||||
let slotted = vec![(0, 0), (100, 0), (100, 100), (14, 100), (14, 40), (12, 40), (12, 100), (0, 100), (0, 0)];
|
||||
assert_eq!(nest(&[slotted, vec![(10, 50), (40, 50)]]), Some(vec![vec![], vec![]]));
|
||||
}
|
||||
|
||||
/// A line that leaves an outline and comes back through two of its corners, crossing none of
|
||||
/// its sides, and one that runs along the bottom of a slot.
|
||||
#[test]
|
||||
fn a_line_through_corners_is_inside_only_where_it_stays_inside() {
|
||||
let v_slot = vec![(0, 0), (100, 0), (100, 100), (20, 100), (20, 50), (15, 40), (10, 50), (10, 100), (0, 100), (0, 0)];
|
||||
assert_eq!(nest(&[v_slot, vec![(5, 50), (40, 50)]]), Some(vec![vec![], vec![]]));
|
||||
let slot = vec![(0, 0), (100, 0), (100, 100), (20, 100), (20, 50), (10, 50), (10, 100), (0, 100), (0, 0)];
|
||||
assert_eq!(nest(&[slot, vec![(5, 50), (40, 50)]]), Some(vec![vec![], vec![0]]));
|
||||
}
|
||||
|
||||
/// An outline that crosses itself encloses no area by its signed sum, yet a line in one of its
|
||||
/// lobes lies inside it.
|
||||
#[test]
|
||||
fn a_line_inside_a_lobe_of_a_crossed_outline_lies_inside_it() {
|
||||
let bow = vec![(0, 0), (100, 100), (0, 100), (100, 0), (0, 0)];
|
||||
assert_eq!(twice_area(&bow), 0);
|
||||
assert_eq!(nest(&[bow, vec![(40, 80), (60, 80)]]), Some(vec![vec![], vec![0]]));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_ring_inside_a_ring_inside_a_ring_lies_inside_both() {
|
||||
let paths = [square(20, 20, 80, 80), square(0, 0, 100, 100), square(40, 40, 60, 60)];
|
||||
assert_eq!(nest(&paths), Some(vec![vec![1], vec![], vec![0, 1]]));
|
||||
}
|
||||
|
||||
/// 10,000 parts in rows, each with a hole: each hole is tested against the few closed paths
|
||||
/// near it, not against every part.
|
||||
#[test]
|
||||
fn parts_in_rows_are_tested_only_against_the_closed_paths_near_them() {
|
||||
let mut paths = vec![];
|
||||
for row in 0..100 {
|
||||
for col in 0..100 {
|
||||
let (x, y) = (col * 30, row * 30);
|
||||
paths.push(square(x, y, x + 20, y + 20));
|
||||
paths.push(square(x + 5, y + 5, x + 15, y + 15));
|
||||
}
|
||||
}
|
||||
let boxes: Vec<[i64; 4]> = paths.iter().map(|p| bounds(p)).collect();
|
||||
let mut work = 5_000_000;
|
||||
let found = outer(&paths, &boxes, &mut work);
|
||||
let want: Vec<Vec<usize>> = (0..paths.len()).map(|i| if i % 2 == 1 { vec![i - 1] } else { vec![] }).collect();
|
||||
assert_eq!(found, Some(want));
|
||||
}
|
||||
|
||||
/// 400 closed paths that each cover most of the grid are listed once each, not in every cell
|
||||
/// they cover.
|
||||
#[test]
|
||||
fn closed_paths_covering_many_cells_are_listed_once() {
|
||||
let mut paths: Vec<Vec<(i64, i64)>> = (0..400).map(|i| square(i, i, 1000 + i, 1000 + i)).collect();
|
||||
paths.extend((0..400).map(|i| {
|
||||
let (x, y) = ((i % 20) * 50, (i / 20) * 50);
|
||||
square(x, y, x + 10, y + 10)
|
||||
}));
|
||||
let boxes: Vec<[i64; 4]> = paths.iter().map(|p| bounds(p)).collect();
|
||||
let rings: Vec<usize> = (0..paths.len()).collect();
|
||||
let mut work = u64::MAX;
|
||||
let Some(grid) = Grid::new(&rings, &boxes, &mut work) else { panic!("the budget ran out") };
|
||||
assert_eq!(grid.wide, (0..400).collect::<Vec<_>>());
|
||||
assert!(grid.cells.iter().map(Vec::len).sum::<usize>() <= 400 * MAX_CELLS_PER_PATH);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn finding_what_lies_inside_stops_at_its_budget() {
|
||||
let paths: Vec<Vec<(i64, i64)>> = (0..50).map(|i| square(-i, -i, 100 + i, 100 + i)).collect();
|
||||
let boxes: Vec<[i64; 4]> = paths.iter().map(|p| bounds(p)).collect();
|
||||
let mut work = 1_000;
|
||||
assert_eq!(outer(&paths, &boxes, &mut work), None);
|
||||
assert_eq!(work, 0);
|
||||
let mut work = u64::MAX;
|
||||
let found = outer(&paths, &boxes, &mut work);
|
||||
assert_eq!(found.map(|o| o.iter().map(Vec::len).sum::<usize>()), Some(50 * 49 / 2));
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,5 +1,5 @@
|
||||
//! CAD interchange: a hand-written ASCII DXF writer (versions R12 to 2018) and reader, and an
|
||||
//! HP-GL/2 plot file reader.
|
||||
//! HP-GL/2 plot file reader and writer.
|
||||
//!
|
||||
//! [`export`] writes the visible art of a document into one DXF drawing: each layer becomes a DXF
|
||||
//! layer (hidden ones switched off, locked ones locked, non-printing ones not plotted), paths
|
||||
@@ -12,13 +12,13 @@
|
||||
//! clipping) is approximated or left out, and each such loss comes back as a warning.
|
||||
//!
|
||||
//! [`import()`] reads an ASCII DXF drawing (any version) into a document: see [`import`].
|
||||
//! [`hpgl::import`] reads an HP-GL plotter file: see [`hpgl`].
|
||||
//! [`hpgl::import`] reads an HP-GL plotter file, and [`hpgl::export`] writes one: see [`hpgl`].
|
||||
//!
|
||||
//! - `aci`: the 256-colour index palette and the nearest index of a colour.
|
||||
//! - `writer`: group codes, handles and the file's sections, tables and objects.
|
||||
//! - `scene`: the document walk that turns objects into entities.
|
||||
//! - `import`: the reader, entities to art, blocks to symbols.
|
||||
//! - `hpgl`: the HP-GL reader, the pen's moves to paths.
|
||||
//! - `hpgl`: the HP-GL reader, the pen's moves to paths, and the writer, paths to pen moves.
|
||||
|
||||
mod aci;
|
||||
pub mod hpgl;
|
||||
|
||||
@@ -73,6 +73,7 @@ pub const GRADIENT_LIBRARIES: &[BuiltinLibrary] = &[
|
||||
lib!("sky-gradients", "Sky Gradients", sky_gradients),
|
||||
lib!("neutral-gradients", "Neutral Gradients", neutral_gradients),
|
||||
lib!("organic-fades", "Organic Fades", organic_fades),
|
||||
lib!("holographic", "Holographic", holographic),
|
||||
lib!("duotone-gradients", "Duotone Gradients", duotone_gradients),
|
||||
lib!("radial-glows", "Radial Glows", radial_glows),
|
||||
];
|
||||
@@ -531,6 +532,62 @@ fn organic_fades() -> (Vec<Swatch>, Vec<SwatchGroup>) {
|
||||
(s, vec![])
|
||||
}
|
||||
|
||||
/// The stops of a [`holographic`] look: offset, opacity and midpoint toward the next stop.
|
||||
type Bands = [(f32, f32, f32)];
|
||||
|
||||
/// Foil: six opaque linear bands, a narrow bright one among them, with off-center midpoints.
|
||||
const FOIL: &Bands = &[(0.0, 1.0, 0.37), (0.13, 1.0, 0.64), (0.34, 1.0, 0.28), (0.48, 1.0, 0.68), (0.71, 1.0, 0.42), (1.0, 1.0, 0.5)];
|
||||
|
||||
/// Glow: five radial rings from a bright center out to a clear edge.
|
||||
const GLOW: &Bands = &[(0.0, 0.95, 0.4), (0.12, 1.0, 0.58), (0.31, 0.72, 0.34), (0.58, 0.3, 0.62), (1.0, 0.0, 0.5)];
|
||||
|
||||
/// A [`holographic`] look: name, kind, stops and the OKLCH color of each stop in order.
|
||||
type Look = (&'static str, GradientKind, &'static Bands, Anchors);
|
||||
|
||||
/// Iridescent looks mixed perceptually: linear foils of narrow pastel and pearl bands, and radial
|
||||
/// glows that fade out to a clear edge. Each color is one stop of [`FOIL`] or [`GLOW`] in order.
|
||||
fn holographic() -> (Vec<Swatch>, Vec<SwatchGroup>) {
|
||||
use GradientKind::{Linear, Radial};
|
||||
// Pale pearl, pastel and deep-violet OKLCH `(l, c, h°)` anchors.
|
||||
const PEARL: (f64, f64, f64) = (0.97, 0.01, 90.0);
|
||||
const SILVER: (f64, f64, f64) = (0.86, 0.015, 255.0);
|
||||
const BLUSH: (f64, f64, f64) = (0.82, 0.055, 340.0);
|
||||
const VIOLET: (f64, f64, f64) = (0.72, 0.1, 310.0);
|
||||
const BLUE: (f64, f64, f64) = (0.73, 0.09, 255.0);
|
||||
const CYAN: (f64, f64, f64) = (0.79, 0.09, 210.0);
|
||||
const MINT: (f64, f64, f64) = (0.82, 0.08, 165.0);
|
||||
const LIME: (f64, f64, f64) = (0.86, 0.085, 125.0);
|
||||
const GOLD: (f64, f64, f64) = (0.89, 0.08, 85.0);
|
||||
const AMBER: (f64, f64, f64) = (0.82, 0.1, 55.0);
|
||||
const CORAL: (f64, f64, f64) = (0.78, 0.09, 25.0);
|
||||
const DEEP_VIOLET: (f64, f64, f64) = (0.42, 0.04, 275.0);
|
||||
let looks: [Look; 14] = [
|
||||
("Prism Veil", Linear, FOIL, &[SILVER, BLUSH, PEARL, CYAN, VIOLET, SILVER]),
|
||||
("Opal Ribbon", Linear, FOIL, &[PEARL, MINT, BLUSH, PEARL, BLUE, SILVER]),
|
||||
("Pearl Flash", Linear, FOIL, &[SILVER, VIOLET, PEARL, GOLD, CYAN, PEARL]),
|
||||
("Aurora Foil", Linear, FOIL, &[BLUE, MINT, PEARL, BLUSH, CYAN, SILVER]),
|
||||
("Iris Sheen", Linear, FOIL, &[BLUSH, VIOLET, PEARL, CYAN, MINT, SILVER]),
|
||||
("Frost Spectrum", Linear, FOIL, &[CYAN, BLUE, PEARL, MINT, BLUSH, SILVER]),
|
||||
("Silver Tide", Linear, FOIL, &[SILVER, CYAN, PEARL, VIOLET, BLUE, SILVER]),
|
||||
("Rose Quartz Gleam", Radial, GLOW, &[PEARL, BLUSH, CORAL, VIOLET, BLUSH]),
|
||||
("Moonstone Shift", Radial, GLOW, &[PEARL, CYAN, MINT, BLUE, SILVER]),
|
||||
("Violet Edge", Radial, GLOW, &[PEARL, VIOLET, BLUSH, BLUE, DEEP_VIOLET]),
|
||||
("Mint Halo", Radial, GLOW, &[PEARL, MINT, CYAN, LIME, MINT]),
|
||||
("Amber Corona", Radial, GLOW, &[PEARL, GOLD, AMBER, CORAL, AMBER]),
|
||||
("Polar Glint", Radial, GLOW, &[PEARL, CYAN, BLUE, VIOLET, BLUE]),
|
||||
("Pastel Orbit", Radial, GLOW, &[PEARL, BLUSH, MINT, CYAN, VIOLET]),
|
||||
];
|
||||
let s = looks
|
||||
.iter()
|
||||
.map(|&(name, kind, bands, colors)| {
|
||||
let stops: Vec<(f32, Color, f32, f32)> =
|
||||
bands.iter().zip(colors).map(|(&(at, opacity, mid), &(l, c, h))| (at, oklch(l, c, h), opacity, mid)).collect();
|
||||
gradient_with(name, kind, GradientMethod::Perceptual, &stops)
|
||||
})
|
||||
.collect();
|
||||
(s, vec![])
|
||||
}
|
||||
|
||||
/// The sequential scales of [`perceptual`]: name and anchors of rising lightness.
|
||||
const SEQUENTIAL: [(&str, Anchors); 5] = [
|
||||
("Ember", &[(0.22, 0.10, 300.0), (0.55, 0.18, 30.0), (0.93, 0.15, 100.0)]),
|
||||
@@ -708,9 +765,63 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn holographic_holds_seven_opaque_foils_and_seven_glows_to_a_clear_edge() {
|
||||
let lib = builtin_library("holographic").unwrap();
|
||||
let order: Vec<&str> = GRADIENT_LIBRARIES.iter().map(|b| b.name).collect();
|
||||
assert_eq!(order.iter().position(|n| *n == "Holographic"), Some(4), "after Organic Fades: {order:?}");
|
||||
assert!(lib.groups.is_empty());
|
||||
assert_eq!(lib.len(), 14);
|
||||
// No name another built-in gradient has, in any case.
|
||||
let mut others = std::collections::HashSet::new();
|
||||
for other in builtins().filter(|b| b.id != "holographic").map(|b| builtin_library(b.id).unwrap()) {
|
||||
others.extend(other.iter().filter(|s| matches!(s.paint, Paint::Gradient(_))).map(|s| s.name.to_lowercase()));
|
||||
}
|
||||
assert!(lib.iter().all(|s| !others.contains(&s.name.to_lowercase())), "a name another library has");
|
||||
let (mut foils, mut glows) = (0, 0);
|
||||
for s in lib.iter() {
|
||||
let Paint::Gradient(g) = &s.paint else { panic!("{} is a gradient", s.name) };
|
||||
let (g, n) = (&g.gradient, &s.name);
|
||||
assert_eq!(g.method, GradientMethod::Perceptual, "{n}");
|
||||
let bands = match &g.kind {
|
||||
GradientKind::Linear => {
|
||||
foils += 1;
|
||||
FOIL
|
||||
}
|
||||
GradientKind::Radial => {
|
||||
glows += 1;
|
||||
GLOW
|
||||
}
|
||||
kind => panic!("{n}: {kind:?}"),
|
||||
};
|
||||
// Every stop takes its band's offset, opacity and midpoint, and none is dropped.
|
||||
let shape: Vec<(f32, f32, f32)> = g.stops.iter().map(|st| (st.offset, st.opacity, st.midpoint)).collect();
|
||||
assert_eq!(shape, bands, "{n}");
|
||||
assert!(g.stops.iter().all(|st| matches!(st.color, Color::Rgb { .. })), "{n}");
|
||||
}
|
||||
assert_eq!((foils, glows), (7, 7));
|
||||
// Foils are opaque; a glow is clear at the edge.
|
||||
assert!(FOIL.iter().all(|&(_, opacity, _)| opacity == 1.0));
|
||||
assert_eq!(GLOW.last().map(|b| b.1), Some(0.0));
|
||||
// Every segment's midpoint is off center and within the Gradient panel's 13 to 87%.
|
||||
for bands in [FOIL, GLOW] {
|
||||
assert!(bands[..bands.len() - 1].iter().all(|&(_, _, m)| (m - 0.5).abs() > 0.02 && (0.13..=0.87).contains(&m)));
|
||||
assert!(bands.windows(2).all(|w| w[0].0 < w[1].0) && bands[0].0 == 0.0 && bands[bands.len() - 1].0 == 1.0);
|
||||
}
|
||||
// Sampled colors: Prism Veil's bright band is the pearl anchor, and Violet Edge ends in deep violet.
|
||||
let stop = |name: &str, i: usize| match &lib.swatch(name).unwrap().paint {
|
||||
Paint::Gradient(g) => g.gradient.stops[i].color,
|
||||
_ => panic!("{name} is a gradient"),
|
||||
};
|
||||
assert_eq!(stop("Prism Veil", 2), oklch(0.97, 0.01, 90.0));
|
||||
assert_eq!(stop("Violet Edge", 4), oklch(0.42, 0.04, 275.0));
|
||||
let [l, ..] = to_oklab(&stop("Violet Edge", 4));
|
||||
assert!(l < 0.5 && to_oklab(&stop("Prism Veil", 2))[0] > 0.95, "{l}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_other_libraries_keep_classic_mixing_and_centered_midpoints() {
|
||||
for b in builtins().filter(|b| b.id != "organic-fades") {
|
||||
for b in builtins().filter(|b| !["organic-fades", "holographic"].contains(&b.id)) {
|
||||
for s in builtin_library(b.id).unwrap().iter() {
|
||||
if let Paint::Gradient(g) = &s.paint {
|
||||
assert_eq!(g.gradient.method, GradientMethod::Classic, "{}", s.name);
|
||||
|
||||
+67
-8
@@ -1051,7 +1051,8 @@ fn pinned(spec: &BlendSpec, keys: usize, n: usize) -> Option<Vec<usize>> {
|
||||
/// - a pinned spine (`key_anchors`): the stored spine's first subpath with each key's anchor (and
|
||||
/// its handles) moved onto the key's centre, so moving a key moves its end of the spine;
|
||||
/// - a spine from Replace Spine: its first subpath, `None` for the anchors (the keys spread
|
||||
/// evenly along it by arc length).
|
||||
/// evenly along it by arc length) while the keys sit there; once one is moved off, pinned as
|
||||
/// above at the anchors where they were spread.
|
||||
///
|
||||
/// `None` for a blend made without a spine ([`BlendSpec::no_spine`]).
|
||||
pub fn blend_spine(keys: &[Arc<Node>], spec: &BlendSpec) -> Option<(PathData, Option<Vec<usize>>)> {
|
||||
@@ -1077,7 +1078,24 @@ fn layout_spine(keys: &[Arc<Node>], spec: &BlendSpec) -> Option<(PathData, Optio
|
||||
return Some((PathData::single(SubPath::polyline(¢ers, false)), Some((0..keys.len()).collect())));
|
||||
};
|
||||
let mut first = stored.subpaths.first()?.clone();
|
||||
let Some(ka) = pinned(spec, keys.len(), first.anchors.len()) else { return Some((PathData::single(first), None)) };
|
||||
let Some(ka) = pinned(spec, keys.len(), first.anchors.len()) else {
|
||||
let mut path = PathData::single(first);
|
||||
// A key moved off where Replace Spine spread it takes its point of the spine along, as
|
||||
// on a pinned spine; otherwise the steps would put it back on the spine (#6809).
|
||||
if Spine::new(&path).is_none_or(|sp| keys_spread_along(keys, &sp)) {
|
||||
return Some((path, None));
|
||||
}
|
||||
let Some(mut ka) = spread_anchors(&mut path, keys.len()) else { return Some((path, None)) };
|
||||
let mut first = path.subpaths.into_iter().next()?;
|
||||
open_at_start(&mut first, &mut ka);
|
||||
for (k, &ai) in keys.iter().zip(&ka) {
|
||||
if let Some(a) = first.anchors.get_mut(ai) {
|
||||
let d = center_of(k) - a.p;
|
||||
a.translate(d);
|
||||
}
|
||||
}
|
||||
return Some((PathData::single(first), Some(ka)));
|
||||
};
|
||||
for (k, &ai) in keys.iter().zip(&ka) {
|
||||
let c = center_of(k);
|
||||
if let Some(a) = first.anchors.get_mut(ai) {
|
||||
@@ -1091,21 +1109,62 @@ fn layout_spine(keys: &[Arc<Node>], spec: &BlendSpec) -> Option<(PathData, Optio
|
||||
/// [`blend_spine`] with every key on an anchor: a spine from Replace Spine gets anchors where its
|
||||
/// keys sit (by arc length), so editing it keeps them in place.
|
||||
pub fn pin_spine(keys: &[Arc<Node>], spec: &BlendSpec) -> Option<(PathData, Vec<usize>)> {
|
||||
let (mut path, anchors) = blend_spine(keys, spec)?;
|
||||
if let Some(a) = anchors {
|
||||
return Some((path, a));
|
||||
// A spine from Replace Spine is pinned as stored, even with a key moved off it (where
|
||||
// [`blend_spine`] moves that key's point along): the layout is the same.
|
||||
if keys.len() >= 2
|
||||
&& let Some(first) = stored_spine(spec).and_then(|s| s.subpaths.first())
|
||||
&& pinned(spec, keys.len(), first.anchors.len()).is_none()
|
||||
{
|
||||
let mut path = PathData::single(first.clone());
|
||||
let mut out = spread_anchors(&mut path, keys.len())?;
|
||||
// A closed spine's end keys get points of their own, so that once pinned each still
|
||||
// moves only its own end.
|
||||
let mut sp = path.subpaths.into_iter().next()?;
|
||||
open_at_start(&mut sp, &mut out);
|
||||
return Some((PathData::single(sp), out));
|
||||
}
|
||||
let (path, anchors) = blend_spine(keys, spec)?;
|
||||
Some((path, anchors?))
|
||||
}
|
||||
|
||||
/// Do `keys` sit where a spine from Replace Spine spreads them: evenly along `spine` by arc length
|
||||
/// (within a hundredth of a point, as [`anchor_at_length`] matches anchors)?
|
||||
fn keys_spread_along(keys: &[Arc<Node>], spine: &Spine) -> bool {
|
||||
let k = keys.len();
|
||||
let total = Spine::new(&path)?.length();
|
||||
keys.iter().enumerate().all(|(i, key)| {
|
||||
let f = if k > 1 { i as f64 / (k - 1) as f64 } else { 0.0 };
|
||||
center_of(key).distance(spine.at(f).0) < 0.01
|
||||
})
|
||||
}
|
||||
|
||||
/// Open closed spine `sp` at its first anchor when the last key sits there with the first (as
|
||||
/// [`spread_anchors`] puts them): a copy of that anchor at the end takes the closing segment and
|
||||
/// the last key, so the two end keys move their ends of the spine apart.
|
||||
fn open_at_start(sp: &mut SubPath, ka: &mut [usize]) {
|
||||
let Some(&start) = sp.anchors.first() else { return };
|
||||
if !sp.closed || ka.len() < 2 {
|
||||
return;
|
||||
}
|
||||
if let Some(last) = ka.last_mut().filter(|a| **a == 0) {
|
||||
*last = sp.anchors.len();
|
||||
sp.anchors.push(start);
|
||||
sp.closed = false;
|
||||
}
|
||||
}
|
||||
|
||||
/// The anchors of `path`'s first subpath that `k` keys spread evenly along it by arc length sit
|
||||
/// on, splitting segments where none is.
|
||||
fn spread_anchors(path: &mut PathData, k: usize) -> Option<Vec<usize>> {
|
||||
let total = Spine::new(path)?.length();
|
||||
let closed = path.subpaths.first().is_some_and(|s| s.closed);
|
||||
let mut out = vec![0usize];
|
||||
for i in 1..k.saturating_sub(1) {
|
||||
let s = total * i as f64 / (k - 1) as f64;
|
||||
out.push(anchor_at_length(&mut path, s)?);
|
||||
out.push(anchor_at_length(path, s)?);
|
||||
}
|
||||
let last = path.subpaths.first().map_or(0, |sp| if closed { 0 } else { sp.anchors.len().saturating_sub(1) });
|
||||
out.push(last);
|
||||
Some((path, out))
|
||||
Some(out)
|
||||
}
|
||||
|
||||
/// The anchor of the first subpath at arc length `s`: an existing one within a hundredth of a
|
||||
|
||||
@@ -52,7 +52,7 @@ pub struct TextObject {
|
||||
/// the object, so the runs (and their styles) stay the text itself.
|
||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||
pub ruby: Vec<RubySpan>,
|
||||
#[serde(default)]
|
||||
#[serde(default = "ParaStyle::omitted")]
|
||||
pub para: ParaStyle,
|
||||
/// Per-paragraph attributes (see the type's docs); empty = every paragraph uses `para`.
|
||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||
|
||||
@@ -28,6 +28,12 @@ pub struct CharStyle {
|
||||
/// Manual pair spacing in 1/1000 em, as [`Self::tracking`]; None uses the automatic mode.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub kerning: Option<f64>,
|
||||
/// Space before the character in 1/1000 em, as [`Self::kerning`], when it starts a line by
|
||||
/// itself: the first character of the text, of a paragraph, or after a forced line break. The
|
||||
/// Type tool's caret before such a character kerns with it (#5111), since there is no character
|
||||
/// before it whose [`Self::kerning`] could space it. Elsewhere it has no effect.
|
||||
#[serde(default, rename = "kerningBefore", skip_serializing_if = "crate::skip::is_default")]
|
||||
pub kerning_before: f64,
|
||||
/// Use glyph shapes for automatic pair spacing; false uses font metrics.
|
||||
#[serde(default, rename = "opticalKerning", skip_serializing_if = "crate::skip::is_default")]
|
||||
pub optical_kerning: bool,
|
||||
@@ -411,6 +417,7 @@ impl Default for CharStyle {
|
||||
leading: None,
|
||||
tracking: 0.0,
|
||||
kerning: None,
|
||||
kerning_before: 0.0,
|
||||
optical_kerning: false,
|
||||
baseline_shift: 0.0,
|
||||
h_scale: 100.0,
|
||||
|
||||
@@ -244,9 +244,21 @@ pub struct ParaStyle {
|
||||
/// Insert Kashidas (Paragraph panel): justified lines lengthen their Arabic words with
|
||||
/// kashidas before they widen their word spaces.
|
||||
pub kashida: Kashida,
|
||||
/// Korean Line Break Anywhere (Paragraph panel menu): a line may break between any two Hangul
|
||||
/// syllables. Off, a Korean word (the characters between spaces, when any of them is Hangul)
|
||||
/// breaks only at its spaces and punctuation, or where it is wider than the line. New type and
|
||||
/// imported text have it off; paragraphs saved before it existed open with it on, the line
|
||||
/// breaks they were laid out with.
|
||||
pub korean_line_break_anywhere: bool,
|
||||
}
|
||||
|
||||
impl ParaStyle {
|
||||
/// The attributes a text object saved without `para` reads with: the defaults, with Korean
|
||||
/// Line Break Anywhere on, as a saved paragraph without that field reads.
|
||||
pub(crate) fn omitted() -> Self {
|
||||
Self { korean_line_break_anywhere: true, ..Self::default() }
|
||||
}
|
||||
|
||||
/// Keeps the indents and the space before and after to -[`crate::MAX_COORD`] to
|
||||
/// [`crate::MAX_COORD`], and the tab stop positions to 0 to 100,000 pt, the range
|
||||
/// `text.tabs.set` takes. A value outside its range becomes the nearer end, and one that is
|
||||
@@ -330,6 +342,10 @@ struct ParaStyleFile {
|
||||
roman_hanging: bool,
|
||||
#[serde(default, skip_serializing_if = "crate::skip::is_default")]
|
||||
kashida: Kashida,
|
||||
/// Written only when off: a paragraph saved without it was laid out breaking between Hangul
|
||||
/// syllables.
|
||||
#[serde(default = "crate::yes", skip_serializing_if = "crate::skip::is_true")]
|
||||
korean_line_break_anywhere: bool,
|
||||
}
|
||||
|
||||
impl From<ParaStyle> for ParaStyleFile {
|
||||
@@ -361,6 +377,7 @@ impl From<ParaStyle> for ParaStyleFile {
|
||||
kinsoku_type,
|
||||
roman_hanging,
|
||||
kashida,
|
||||
korean_line_break_anywhere,
|
||||
..
|
||||
} = p;
|
||||
Self {
|
||||
@@ -386,6 +403,7 @@ impl From<ParaStyle> for ParaStyleFile {
|
||||
kinsoku_type,
|
||||
roman_hanging,
|
||||
kashida,
|
||||
korean_line_break_anywhere,
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -415,6 +433,7 @@ impl From<ParaStyleFile> for ParaStyle {
|
||||
kinsoku_type,
|
||||
roman_hanging,
|
||||
kashida,
|
||||
korean_line_break_anywhere,
|
||||
..
|
||||
} = f;
|
||||
Self {
|
||||
@@ -439,6 +458,7 @@ impl From<ParaStyleFile> for ParaStyle {
|
||||
kinsoku_type,
|
||||
roman_hanging,
|
||||
kashida,
|
||||
korean_line_break_anywhere,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -365,6 +365,7 @@ impl ParaList {
|
||||
position: CharPosition::Normal,
|
||||
tracking: 0.0,
|
||||
kerning: None,
|
||||
kerning_before: 0.0,
|
||||
optical_kerning: first.optical_kerning,
|
||||
tate_chu_yoko: false,
|
||||
underline: false,
|
||||
|
||||
@@ -184,6 +184,29 @@ fn justification_options_read_from_a_file_stay_in_range() {
|
||||
assert_eq!(same, d);
|
||||
}
|
||||
|
||||
/// Korean Line Break Anywhere is off for a new paragraph and saved only when off; a paragraph
|
||||
/// saved before it existed, or a text object saved without paragraph attributes, reads with it on,
|
||||
/// and both values read back as saved.
|
||||
#[test]
|
||||
fn korean_line_break_anywhere_is_saved_only_when_off() {
|
||||
let off = ParaStyle::default();
|
||||
assert!(!off.korean_line_break_anywhere);
|
||||
let saved = serde_json::to_value(&off).unwrap();
|
||||
assert_eq!(saved["korean_line_break_anywhere"], false);
|
||||
assert_eq!(serde_json::from_value::<ParaStyle>(saved).unwrap(), off);
|
||||
let on = ParaStyle { korean_line_break_anywhere: true, ..ParaStyle::default() };
|
||||
let saved = serde_json::to_value(&on).unwrap();
|
||||
assert!(saved.get("korean_line_break_anywhere").is_none());
|
||||
assert_eq!(serde_json::from_value::<ParaStyle>(saved).unwrap(), on);
|
||||
let old: ParaStyle = serde_json::from_str(r#"{"justify":"Left"}"#).unwrap();
|
||||
assert!(old.korean_line_break_anywhere);
|
||||
let mut saved = serde_json::to_value(TextObject::point(Point::ZERO, "가나", CharStyle::default())).unwrap();
|
||||
assert_eq!(saved["para"]["korean_line_break_anywhere"], false);
|
||||
saved.as_object_mut().unwrap().remove("para");
|
||||
let old: TextObject = serde_json::from_value(saved).unwrap();
|
||||
assert_eq!(old.para, ParaStyle { korean_line_break_anywhere: true, ..ParaStyle::default() });
|
||||
}
|
||||
|
||||
/// Numbered lists: each number style writes its numbers and rolls over (letters after Z,
|
||||
/// roman numerals in subtractive forms, zero-padded numbers past their digits), the marker adds
|
||||
/// a period, and the count runs through list paragraphs, skips empty and bulleted ones and
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
use super::{CLASSIC_EXTRUDE, CROP_MARKS, EXTRUDE, INFLATE, PATHFINDER_EFFECTS, RASTERIZE, REVOLVE, ROTATE, TRAP, Value, json, trap};
|
||||
use super::{
|
||||
CLASSIC_EXTRUDE, CLASSIC_REVOLVE, CLASSIC_ROTATE, CROP_MARKS, EXTRUDE, INFLATE, PATHFINDER_EFFECTS, RASTERIZE, REVOLVE, ROTATE, TRAP, Value,
|
||||
json, trap,
|
||||
};
|
||||
|
||||
/// Catalogue entry for one effect.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
@@ -81,6 +84,7 @@ fn lengths_of(id: &str) -> Lengths {
|
||||
"threeD.revolve" => always(&["offset"]),
|
||||
"threeD.extrude" => always(&["depth", "bevelWidth", "bevelHeight"]),
|
||||
"threeD.classicExtrude" => always(&["depth", "bevelHeight"]),
|
||||
"threeD.classicRevolve" => always(&["offset"]),
|
||||
"threeD.inflate" => always(&["depth"]),
|
||||
"path.outlineStroke" => always(&["width"]),
|
||||
"stylize.roundCorners" | "stylize.feather" | "blur.gaussian" | "blur.smart" | "sharpen.unsharpMask" => always(&["radius"]),
|
||||
@@ -207,6 +211,20 @@ pub fn effect_catalog() -> Vec<EffectInfo> {
|
||||
"{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), 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","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)}. 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"}),
|
||||
),
|
||||
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)}. 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"}),
|
||||
),
|
||||
g(
|
||||
"convertToShape.rectangle",
|
||||
"Rectangle…",
|
||||
|
||||
@@ -83,12 +83,14 @@ pub use reshape::{
|
||||
SYMBOL_ART_MAX_NODES, expand_outlined, gives_image_shape, has_gradient_copies, has_item_geometry, has_painted_effects, has_transform_art,
|
||||
has_transform_copies, has_transform_options, image_paint, needs_outline, outline_art, outline_text, reshape,
|
||||
};
|
||||
pub use revolve::{REVOLVE, has_revolve, revolve_art, revolve_art_in, revolve_options, validate_revolve, validate_revolve_in};
|
||||
pub use revolve::{
|
||||
CLASSIC_REVOLVE, REVOLVE, has_revolve, is_revolve, revolve_art, revolve_art_in, revolve_options, validate_revolve, validate_revolve_in,
|
||||
};
|
||||
pub use solids::{
|
||||
CLASSIC_EXTRUDE, EXTRUDE, INFLATE, ROTATE, ROTATION_PRESETS, SHADING_COLORS, SOLIDS, SolidMesh, THREE_D_TYPES, classic_extrude_options,
|
||||
classic_shading, extrude_options, has_solid, inflate_options, is_three_d, solid_art, solid_art_in, three_d_meshes, three_d_meshes_in,
|
||||
three_d_meshes_of, three_d_meshes_of_in, three_d_params_as, validate_solid, validate_solid_in, validate_three_d, validate_three_d_at,
|
||||
validate_three_d_at_in, validate_three_d_in, validate_three_d_params, view_options,
|
||||
CLASSIC_EXTRUDE, CLASSIC_ROTATE, EXTRUDE, INFLATE, ROTATE, ROTATE_SURFACES, ROTATION_PRESETS, SHADING_COLORS, SOLIDS, SolidMesh, THREE_D_TYPES,
|
||||
classic_extrude_options, classic_shading, extrude_options, has_solid, inflate_options, is_classic_three_d, is_three_d, solid_art, solid_art_in,
|
||||
three_d_meshes, three_d_meshes_in, three_d_meshes_of, three_d_meshes_of_in, three_d_params_as, validate_solid, validate_solid_in,
|
||||
validate_three_d, validate_three_d_at, validate_three_d_at_in, validate_three_d_in, validate_three_d_params, view_options,
|
||||
};
|
||||
pub use stylize::{ScribbleSetting, scribble_setting_id, scribble_settings};
|
||||
pub use svg_filter::SVG_FILTER;
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
//! Revolve as live, shaded vector art, shared by the canvas and every exporter.
|
||||
//! Revolve and Revolve (Classic) as live, shaded vector art, shared by the canvas and every
|
||||
//! exporter.
|
||||
use std::sync::Arc;
|
||||
|
||||
use serde_json::Value;
|
||||
@@ -13,6 +14,14 @@ use crate::{GeomContext, apply_geometry_with, is_geometry, merged_params};
|
||||
|
||||
pub const REVOLVE: &str = "threeD.revolve";
|
||||
|
||||
mod classic;
|
||||
pub use classic::CLASSIC_REVOLVE;
|
||||
|
||||
/// Is `id` Revolve or Revolve (Classic), the effects this module draws?
|
||||
pub fn is_revolve(id: &str) -> bool {
|
||||
id == REVOLVE || id == CLASSIC_REVOLVE
|
||||
}
|
||||
|
||||
/// Most bytes the copies of the object's paint in the faces may take together. Each face and the
|
||||
/// seam stroke around it gets a copy of the paint, so a gradient of many stops times tens of
|
||||
/// thousands of faces took gigabytes; past this the source path is drawn.
|
||||
@@ -55,7 +64,7 @@ pub(crate) fn paint_copies_add(used: &mut usize, copies: usize, paint: &Paint) -
|
||||
}
|
||||
|
||||
fn visible(fx: &[Effect]) -> bool {
|
||||
fx.iter().any(|e| e.visible && e.id == REVOLVE)
|
||||
fx.iter().any(|e| e.visible && is_revolve(&e.id))
|
||||
}
|
||||
|
||||
pub fn has_revolve(n: &Node) -> bool {
|
||||
@@ -88,6 +97,17 @@ pub fn revolve_options(p: &Value) -> Revolve {
|
||||
}
|
||||
}
|
||||
|
||||
/// The options Revolve (`id` [`REVOLVE`]) or Revolve (Classic) ([`CLASSIC_REVOLVE`]) with
|
||||
/// parameters `p` sweeps its surface with.
|
||||
fn options_of(id: &str, p: &Value) -> Revolve {
|
||||
if id == CLASSIC_REVOLVE { classic::options(p) } else { revolve_options(p) }
|
||||
}
|
||||
|
||||
/// The options effect `fx`, a Revolve or a Revolve (Classic), sweeps its surface with.
|
||||
fn fx_options(fx: &Effect) -> Revolve {
|
||||
options_of(&fx.id, &merged_params(&fx.id, &fx.params))
|
||||
}
|
||||
|
||||
/// Validate before a command mutates the document. Loading external files is still bounded
|
||||
/// by the evaluator; unsupported source kinds remain unchanged when rendered.
|
||||
pub fn validate_revolve(n: &Node, p: &Value) -> Result<(), String> {
|
||||
@@ -97,11 +117,16 @@ pub fn validate_revolve(n: &Node, p: &Value) -> Result<(), String> {
|
||||
/// [`validate_revolve`] with the symbols of `doc`: a symbol instance, a blend and a clipping group
|
||||
/// revolve the art they show ([`resolve_for`]), cut for Revolve whatever 3D effect `n` carries now.
|
||||
pub fn validate_revolve_in(doc: Option<&Document>, n: &Node, p: &Value) -> Result<(), String> {
|
||||
validate_revolve_params(p)?;
|
||||
validate_in(doc, n, REVOLVE, p)
|
||||
}
|
||||
|
||||
/// [`validate_revolve_in`] for Revolve or Revolve (Classic), `id`.
|
||||
pub(crate) fn validate_in(doc: Option<&Document>, n: &Node, id: &str, p: &Value) -> Result<(), String> {
|
||||
validate_params_of(id, p)?;
|
||||
let n = &*resolve_for(doc, n, "Revolve", false)?;
|
||||
let effects = &n.appearance.effects;
|
||||
// The profile is measured before the object's one Revolve, hidden or shown.
|
||||
let before = effects.iter().position(|e| e.id == REVOLVE).and_then(|i| effects.get(..i)).unwrap_or(effects);
|
||||
let before = effects.iter().position(|e| is_revolve(&e.id)).and_then(|i| effects.get(..i)).unwrap_or(effects);
|
||||
if is_container(n) {
|
||||
const EMPTY: &str = "Revolve requires a group holding a shape with at least two anchors";
|
||||
let mut shapes = members(n, "Revolve")?;
|
||||
@@ -110,7 +135,7 @@ pub fn validate_revolve_in(doc: Option<&Document>, n: &Node, p: &Value) -> Resul
|
||||
}
|
||||
reshape_members(n, before, &mut shapes);
|
||||
let b = union_bounds(&shapes).ok_or(EMPTY)?;
|
||||
let options = shared_options(&shapes, revolve_options(p))?;
|
||||
let options = shared_options(&shapes, options_of(id, p))?;
|
||||
let mut copies = 0;
|
||||
shapes.iter().try_for_each(|s| check_surface(&s.path, b, options, surface_item(&s.items), &mut copies))?;
|
||||
let casting = shapes.iter().filter(|s| surface_item(&s.items).is_some_and(|i| paint_of(i).1 * s.opacity > 0.0));
|
||||
@@ -123,8 +148,8 @@ pub fn validate_revolve_in(doc: Option<&Document>, n: &Node, p: &Value) -> Resul
|
||||
let path = geometry(&path, before, &GeomContext::of(n));
|
||||
let b = path.bounds().ok_or("Revolve requires a shape with at least two anchors")?;
|
||||
let paints = solid_paints(n);
|
||||
check_surface(&path, b, revolve_options(p), surface_item(&paints), &mut 0)?;
|
||||
check_shadow(p, [&path], b, revolve_options(p))
|
||||
check_surface(&path, b, options_of(id, p), surface_item(&paints), &mut 0)?;
|
||||
check_shadow(p, [&path], b, options_of(id, p))
|
||||
}
|
||||
|
||||
/// With the shadow of Revolve parameters `p` on, an error when the surfaces of `paths` it is cast
|
||||
@@ -138,14 +163,21 @@ fn check_shadow<'a>(p: &Value, paths: impl IntoIterator<Item = &'a PathData>, b:
|
||||
}
|
||||
|
||||
/// [`validate_revolve`] for a Revolve with parameters `p` at index `index` of the effects of
|
||||
/// appearance item `target` of `n`. The surfaces of every fill and stroke that carries a Revolve,
|
||||
/// `target`'s included, share one budget of paint copies, as in [`art`]. A visible object-level
|
||||
/// Revolve draws in place of those surfaces.
|
||||
/// appearance item `target` of `n` ([`validate_item_of`]).
|
||||
#[cfg(test)]
|
||||
pub(crate) fn validate_item_revolve(n: &Node, p: &Value, target: usize, index: usize) -> Result<(), String> {
|
||||
validate_item_of(n, REVOLVE, p, target, index)
|
||||
}
|
||||
|
||||
/// [`validate_revolve`] for a Revolve or Revolve (Classic), `id`, with parameters `p` at index
|
||||
/// `index` of the effects of appearance item `target` of `n`. The surfaces of every fill and stroke
|
||||
/// that carries one, `target`'s included, share one budget of paint copies, as in [`art`]. A visible
|
||||
/// object-level Revolve draws in place of those surfaces.
|
||||
pub(crate) fn validate_item_of(n: &Node, id: &str, p: &Value, target: usize, index: usize) -> Result<(), String> {
|
||||
if is_container(n) || visible(&n.appearance.effects) || target >= n.appearance.items.len() {
|
||||
return validate_revolve(n, p);
|
||||
return validate_in(None, n, id, p);
|
||||
}
|
||||
validate_revolve_params(p)?;
|
||||
validate_params_of(id, p)?;
|
||||
const EMPTY: &str = "Revolve requires a shape with at least two anchors";
|
||||
let (path, _) = object_profile(n, "Revolve")?;
|
||||
if !has_two_anchors(&path) {
|
||||
@@ -156,13 +188,13 @@ pub(crate) fn validate_item_revolve(n: &Node, p: &Value, target: usize, index: u
|
||||
let mut copies = 0;
|
||||
for (i, item) in n.appearance.items.iter().enumerate() {
|
||||
let effects = item.effects();
|
||||
let at = if i == target { Some(index) } else { effects.iter().position(|e| e.visible && e.id == REVOLVE) };
|
||||
let params = match at.and_then(|at| effects.get(at)) {
|
||||
_ if i == target => p.clone(),
|
||||
Some(fx) if crate::paints(item) => merged_params(REVOLVE, &fx.params),
|
||||
let at = if i == target { Some(index) } else { effects.iter().position(|e| e.visible && is_revolve(&e.id)) };
|
||||
let (kind, params) = match at.and_then(|at| effects.get(at)) {
|
||||
_ if i == target => (id, p.clone()),
|
||||
Some(fx) if crate::paints(item) => (fx.id.as_str(), merged_params(&fx.id, &fx.params)),
|
||||
_ => continue,
|
||||
};
|
||||
let options = revolve_options(¶ms);
|
||||
let options = options_of(kind, ¶ms);
|
||||
let path = geometry(&path, at.and_then(|at| effects.get(..at)).unwrap_or(effects), &ctx.item(item));
|
||||
let b = path.bounds().ok_or(EMPTY)?;
|
||||
check_surface(&path, b, options, crate::paints(item).then_some(item), &mut copies)?;
|
||||
@@ -217,6 +249,16 @@ pub(crate) fn validate_revolve_params(p: &Value) -> Result<(), String> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// [`validate_revolve_params`] for Revolve or Revolve (Classic), `id`; Revolve (Classic) also takes
|
||||
/// only its own parameters, each in its range.
|
||||
pub(crate) fn validate_params_of(id: &str, p: &Value) -> Result<(), String> {
|
||||
validate_revolve_params(p)?;
|
||||
if id == CLASSIC_REVOLVE {
|
||||
classic::validate(p)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn geometry(path: &PathData, fx: &[Effect], ctx: &GeomContext) -> PathData {
|
||||
apply_geometry_with(fx, path, path.bounds().unwrap_or(Rect::ZERO), ctx)
|
||||
}
|
||||
@@ -226,7 +268,7 @@ fn geometry(path: &PathData, fx: &[Effect], ctx: &GeomContext) -> PathData {
|
||||
/// the shadow off, when `item` is fully transparent or when it casts nothing, and an error when
|
||||
/// the surface it is cast from is past the limits.
|
||||
fn shadow_of(id: NodeId, fx: &Effect, path: &PathData, item: &AppearanceItem, b: Rect, options: Revolve) -> Result<Option<Node>, String> {
|
||||
let Some(settings) = crate::solids::shadow::options(&merged_params(REVOLVE, &fx.params)) else { return Ok(None) };
|
||||
let Some(settings) = crate::solids::shadow::options(&merged_params(&fx.id, &fx.params)) else { return Ok(None) };
|
||||
let (_, opacity, blend) = paint_of(item);
|
||||
if opacity <= 0.0 {
|
||||
return Ok(None);
|
||||
@@ -242,7 +284,7 @@ fn shadow_of(id: NodeId, fx: &Effect, path: &PathData, item: &AppearanceItem, b:
|
||||
/// ([`crate::solids::shadow::scoped_art`]). An error when the surfaces it is cast from are past the
|
||||
/// limits.
|
||||
fn group_shadow(id: NodeId, fx: &Effect, shapes: &[Profile], b: Rect, options: Revolve) -> Result<Vec<Arc<Node>>, String> {
|
||||
let Some(settings) = crate::solids::shadow::options(&merged_params(REVOLVE, &fx.params)) else { return Ok(vec![]) };
|
||||
let Some(settings) = crate::solids::shadow::options(&merged_params(&fx.id, &fx.params)) else { return Ok(vec![]) };
|
||||
let mut caster = vectorcraft_three_d::ShadowCaster::new();
|
||||
let mut cast = vec![];
|
||||
for s in shapes {
|
||||
@@ -259,7 +301,8 @@ fn group_shadow(id: NodeId, fx: &Effect, shapes: &[Profile], b: Rect, options: R
|
||||
}
|
||||
|
||||
/// One object's surface of revolution about the axis of `b`, and each face's depth. `copies` counts
|
||||
/// the bytes of the paint copies of every surface of the object.
|
||||
/// the bytes of the paint copies of every surface of the object. Revolve (Classic) draws every face
|
||||
/// with its classic surface, as Extrude & Bevel (Classic) does.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn surface(
|
||||
n: &Node,
|
||||
@@ -275,6 +318,16 @@ fn surface(
|
||||
) -> Option<(Vec<f64>, Node)> {
|
||||
// A loaded file or a profile edited past the limits keeps drawing its source path instead
|
||||
// of crashing the frame. Commands validate the same evaluator and report its errors.
|
||||
if fx.id == CLASSIC_REVOLVE {
|
||||
let facets = vectorcraft_three_d::revolve_facets(path, b, options).ok()?;
|
||||
*copies = copies.saturating_add(paint_copies(facets.len(), &paint));
|
||||
if *copies > MAX_PAINT_COPIES {
|
||||
return None;
|
||||
}
|
||||
let depths = facets.iter().map(|f| f.depth).collect();
|
||||
let p = merged_params(&fx.id, &fx.params);
|
||||
return Some((depths, crate::solids::classic::surface(n, facets, &paint, opacity, blend, &p)));
|
||||
}
|
||||
let colored = options.light_color != [1.0; 3] || options.lights.is_some();
|
||||
let faces = vectorcraft_three_d::revolve(path, b, options).ok()?;
|
||||
*copies = copies.saturating_add(paint_copies(faces.len(), &paint));
|
||||
@@ -371,8 +424,7 @@ fn surface(
|
||||
fn object_surface(n: &Node, path: &PathData, fx: &Effect, item: &AppearanceItem, expand: bool, copies: &mut usize) -> Option<Node> {
|
||||
let b = path.bounds()?;
|
||||
let (paint, opacity, blend) = paint_of(item);
|
||||
let options = revolve_options(&merged_params(REVOLVE, &fx.params));
|
||||
surface(n, path, b, options, fx, paint, opacity, blend, expand, copies).map(|(_, art)| art)
|
||||
surface(n, path, b, fx_options(fx), fx, paint, opacity, blend, expand, copies).map(|(_, art)| art)
|
||||
}
|
||||
|
||||
fn shading_paint(g: vectorcraft_three_d::ShadeGradient, color: impl Fn(f64) -> Color, opacity: impl Fn(f64) -> f32) -> Paint {
|
||||
@@ -429,10 +481,10 @@ pub(crate) fn revolve_meshes(n: &Node, total: &mut usize, limit: usize) -> Resul
|
||||
let mesh = |path: &PathData, fx: &Effect, item: &AppearanceItem| -> Result<crate::SolidMesh, String> {
|
||||
let b = path.bounds().ok_or("Revolve requires a shape with at least two anchors")?;
|
||||
let (paint, opacity, _) = paint_of(item);
|
||||
let mesh = vectorcraft_three_d::revolve_mesh(path, rule, b, revolve_options(&merged_params(REVOLVE, &fx.params)))?;
|
||||
let mesh = vectorcraft_three_d::revolve_mesh(path, rule, b, fx_options(fx))?;
|
||||
Ok(crate::SolidMesh { mesh, color: crate::solids::mesh_color(&paint, opacity) })
|
||||
};
|
||||
if let Some(index) = n.appearance.effects.iter().position(|e| e.visible && e.id == REVOLVE) {
|
||||
if let Some(index) = n.appearance.effects.iter().position(|e| e.visible && is_revolve(&e.id)) {
|
||||
let before = n.appearance.effects.get(..index).unwrap_or_default();
|
||||
let Some(fx) = n.appearance.effects.get(index) else { return Ok(vec![]) };
|
||||
let path = geometry(&path, before, &ctx);
|
||||
@@ -445,7 +497,7 @@ pub(crate) fn revolve_meshes(n: &Node, total: &mut usize, limit: usize) -> Resul
|
||||
let path = geometry(&path, &n.appearance.effects, &ctx);
|
||||
let mut out = vec![];
|
||||
for item in n.appearance.items.iter().filter(|i| crate::paints(i)) {
|
||||
if let Some(index) = item.effects().iter().position(|e| e.visible && e.id == REVOLVE)
|
||||
if let Some(index) = item.effects().iter().position(|e| e.visible && is_revolve(&e.id))
|
||||
&& let Some(fx) = item.effects().get(index)
|
||||
{
|
||||
let p = geometry(&path, item.effects().get(..index).unwrap_or_default(), &ctx.item(item));
|
||||
@@ -461,13 +513,13 @@ fn group_meshes(n: &Node, total: &mut usize, limit: usize) -> Result<Vec<crate::
|
||||
.appearance
|
||||
.effects
|
||||
.iter()
|
||||
.position(|e| e.visible && e.id == REVOLVE)
|
||||
.position(|e| e.visible && is_revolve(&e.id))
|
||||
.ok_or("a 3D effect on a group's fill or stroke draws nothing to export")?;
|
||||
let Some(fx) = n.appearance.effects.get(index) else { return Ok(vec![]) };
|
||||
let mut shapes = members(n, "Revolve")?;
|
||||
reshape_members(n, n.appearance.effects.get(..index).unwrap_or_default(), &mut shapes);
|
||||
let b = union_bounds(&shapes).ok_or("Revolve requires a group holding a shape with at least two anchors")?;
|
||||
let options = shared_options(&shapes, revolve_options(&merged_params(REVOLVE, &fx.params)))?;
|
||||
let options = shared_options(&shapes, fx_options(fx))?;
|
||||
let mut out = vec![];
|
||||
for s in &shapes {
|
||||
let Some(item) = surface_item(&s.items) else { continue };
|
||||
@@ -491,7 +543,7 @@ fn art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
|
||||
let mut children = vec![];
|
||||
let mut copies = 0;
|
||||
let mut remaining = n.appearance.effects.clone();
|
||||
if let Some(index) = n.appearance.effects.iter().position(|e| e.visible && e.id == REVOLVE) {
|
||||
if let Some(index) = n.appearance.effects.iter().position(|e| e.visible && is_revolve(&e.id)) {
|
||||
let fx = n.appearance.effects.get(index)?;
|
||||
let path = geometry(&path, n.appearance.effects.get(..index)?, &ctx);
|
||||
// An object's surface uses its top visible fill, falling back to its stroke.
|
||||
@@ -500,7 +552,7 @@ fn art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
|
||||
let expand = expand && !n.appearance.effects.iter().skip(index + 1).any(|e| e.visible && is_geometry(&e.id));
|
||||
let surface = object_surface(n, &path, fx, item, expand, &mut copies)?;
|
||||
if let Some(b) = path.bounds()
|
||||
&& let Some(shadow) = shadow_of(n.id, fx, &path, item, b, revolve_options(&merged_params(REVOLVE, &fx.params))).ok()?
|
||||
&& let Some(shadow) = shadow_of(n.id, fx, &path, item, b, fx_options(fx)).ok()?
|
||||
{
|
||||
children.push(Arc::new(shadow));
|
||||
}
|
||||
@@ -511,7 +563,7 @@ fn art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
|
||||
.effects
|
||||
.iter()
|
||||
.enumerate()
|
||||
.filter(|(i, e)| e.id != REVOLVE && (!is_geometry(&e.id) || *i > index))
|
||||
.filter(|(i, e)| !is_revolve(&e.id) && (!is_geometry(&e.id) || *i > index))
|
||||
.map(|(_, e)| e.clone())
|
||||
.collect();
|
||||
} else {
|
||||
@@ -520,14 +572,14 @@ fn art(doc: Option<&Document>, n: &Node, expand: bool) -> Option<Node> {
|
||||
// Every item's shadow goes behind every item's art.
|
||||
let mut shadows = vec![];
|
||||
for item in n.appearance.items.iter().filter(|i| crate::paints(i)) {
|
||||
if let Some(index) = item.effects().iter().position(|e| e.visible && e.id == REVOLVE) {
|
||||
if let Some(index) = item.effects().iter().position(|e| e.visible && is_revolve(&e.id)) {
|
||||
let fx = item.effects().get(index)?;
|
||||
let p = geometry(&path, item.effects().get(..index)?, &ctx.item(item));
|
||||
let expand = expand && !item.effects().iter().skip(index + 1).any(|e| e.visible && is_geometry(&e.id));
|
||||
let mut art = object_surface(n, &p, fx, item, expand, &mut copies)?;
|
||||
art.appearance.effects = item.effects().iter().skip(index + 1).filter(|e| e.id != REVOLVE).cloned().collect();
|
||||
art.appearance.effects = item.effects().iter().skip(index + 1).filter(|e| !is_revolve(&e.id)).cloned().collect();
|
||||
if let Some(b) = p.bounds()
|
||||
&& let Some(mut shadow) = shadow_of(n.id, fx, &p, item, b, revolve_options(&merged_params(REVOLVE, &fx.params))).ok()?
|
||||
&& let Some(mut shadow) = shadow_of(n.id, fx, &p, item, b, fx_options(fx)).ok()?
|
||||
{
|
||||
shadow.appearance.effects = art.appearance.effects.clone();
|
||||
shadows.push(Arc::new(shadow));
|
||||
@@ -666,12 +718,12 @@ fn overlaps(a: Rect, b: Rect) -> bool {
|
||||
/// each in its own paint. Every member's faces are drawn in one back-to-front order. `None` when
|
||||
/// the effect is only on the group's own fills or strokes or when its members can't be revolved.
|
||||
fn group_art(n: &Node, expand: bool) -> Option<Node> {
|
||||
let index = n.appearance.effects.iter().position(|e| e.visible && e.id == REVOLVE)?;
|
||||
let index = n.appearance.effects.iter().position(|e| e.visible && is_revolve(&e.id))?;
|
||||
let fx = n.appearance.effects.get(index)?;
|
||||
let mut shapes = members(n, "").ok()?;
|
||||
reshape_members(n, n.appearance.effects.get(..index)?, &mut shapes);
|
||||
let b = union_bounds(&shapes)?;
|
||||
let options = shared_options(&shapes, revolve_options(&merged_params(REVOLVE, &fx.params))).ok()?;
|
||||
let options = shared_options(&shapes, fx_options(fx)).ok()?;
|
||||
let expand = expand && !n.appearance.effects.iter().skip(index + 1).any(|e| e.visible && is_geometry(&e.id));
|
||||
let mut copies = 0;
|
||||
let mut surfaces = vec![];
|
||||
@@ -690,6 +742,10 @@ fn group_art(n: &Node, expand: bool) -> Option<Node> {
|
||||
return None;
|
||||
}
|
||||
let plain = surfaces.iter().all(|(depths, s, _)| matches!(&s.kind, NodeKind::Group { children, clip: false } if children.len() == depths.len()));
|
||||
// A classic surface whose gradient has transparent stops carries an opacity mask: its faces go
|
||||
// in runs, as a transparent member's do, and each run carries the mask.
|
||||
let masks: Vec<Option<Box<vectorcraft_doc::OpacityMask>>> = surfaces.iter().map(|(_, s, _)| s.extras().mask.clone()).collect();
|
||||
let opaque = opaque && masks.iter().all(Option::is_none);
|
||||
let children = if !plain {
|
||||
scoped(n.id, surfaces.into_iter().map(|(_, s, scopes)| (scopes, Arc::new(s))).collect(), 0)
|
||||
} else {
|
||||
@@ -731,7 +787,8 @@ fn group_art(n: &Node, expand: bool) -> Option<Node> {
|
||||
runs.push(Run { member: None, scopes, bounds: Rect::ZERO, faces: vec![face], cover: vec![], opacity, blend });
|
||||
continue;
|
||||
};
|
||||
if opacity >= 1.0 && blend == Default::default() && scopes.is_empty() {
|
||||
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 });
|
||||
continue;
|
||||
}
|
||||
@@ -767,6 +824,9 @@ fn group_art(n: &Node, expand: bool) -> Option<Node> {
|
||||
let mut group = 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)
|
||||
|
||||
@@ -0,0 +1,220 @@
|
||||
//! Revolve (Classic): the surface Revolve sweeps from a path, drawn with the classic surfaces of
|
||||
//! Extrude & Bevel (Classic) (Wireframe, No Shading, Diffuse and Plastic), their highlight, blend
|
||||
//! steps and shading color.
|
||||
use serde_json::Value;
|
||||
use vectorcraft_three_d::Revolve;
|
||||
|
||||
pub const CLASSIC_REVOLVE: &str = "threeD.classicRevolve";
|
||||
|
||||
/// The numeric parameters: (key, lowest, highest, whole numbers only).
|
||||
const RANGES: [(&str, f64, f64, bool); 13] = [
|
||||
("angle", 0.0, 360.0, false),
|
||||
("offset", 0.0, 1000.0, false),
|
||||
("rotationX", -180.0, 180.0, false),
|
||||
("rotationY", -180.0, 180.0, false),
|
||||
("rotationZ", -180.0, 180.0, false),
|
||||
("perspectiveAngle", 0.0, 160.0, false),
|
||||
("lightRotation", -180.0, 180.0, false),
|
||||
("lightHeight", 0.0, 90.0, false),
|
||||
("lightIntensity", 0.0, 100.0, false),
|
||||
("ambient", 0.0, 100.0, false),
|
||||
("highlightIntensity", 0.0, 100.0, false),
|
||||
("highlightSize", 0.0, 100.0, false),
|
||||
("blendSteps", 1.0, 256.0, true),
|
||||
];
|
||||
|
||||
const FLAGS: [&str; 2] = ["cap", "lightBehind"];
|
||||
|
||||
/// The surface Revolve (Classic)'s parameters `p` sweep: Revolve's angle, cap, offset, edge,
|
||||
/// rotation and perspective, built unshaded, since the classic surfaces light its faces.
|
||||
pub(crate) fn options(p: &Value) -> Revolve {
|
||||
Revolve { shade: false, smooth_shading: false, lights: None, light_color: [1.0; 3], ..super::revolve_options(p) }
|
||||
}
|
||||
|
||||
/// Check Revolve (Classic)'s parameters `p` (its defaults filled in) beyond the checks it shares
|
||||
/// with Revolve: every key is one of its parameters, numbers are in range, flags are true or false,
|
||||
/// and the surface and shading color are named.
|
||||
pub(crate) fn validate(p: &Value) -> Result<(), String> {
|
||||
crate::solids::classic::validate_classic(CLASSIC_REVOLVE, p, &RANGES, &FLAGS)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use serde_json::json;
|
||||
use vectorcraft_doc::color::{Color, Paint};
|
||||
use vectorcraft_doc::{Appearance, AppearanceItem, Node, NodeId};
|
||||
use vectorcraft_geom::{BezPath, PathData};
|
||||
|
||||
use super::*;
|
||||
|
||||
const BLUE: Color = Color::Rgb { r: 0.2, g: 0.4, b: 0.8 };
|
||||
|
||||
/// Half a vase's profile, open, filled blue.
|
||||
fn profile() -> Node {
|
||||
let mut b = BezPath::new();
|
||||
b.move_to((100.0, 40.0));
|
||||
b.line_to((130.0, 60.0));
|
||||
b.line_to((130.0, 140.0));
|
||||
b.line_to((100.0, 160.0));
|
||||
Node::path(NodeId(1), PathData::from_bezpath(&b), Appearance::basic(Paint::solid(BLUE), Paint::None, 0.0))
|
||||
}
|
||||
|
||||
fn revolved(params: Value) -> Node {
|
||||
let mut n = profile();
|
||||
n.appearance.effects.push(crate::new_effect(CLASSIC_REVOLVE, ¶ms).unwrap());
|
||||
crate::revolve_art(&n).unwrap()
|
||||
}
|
||||
|
||||
/// The faces of the surface of `art`, back to front.
|
||||
fn faces(art: &Node) -> Vec<&Node> {
|
||||
art.children().unwrap().iter().flat_map(|s| s.children().unwrap().iter().map(|f| &**f)).collect()
|
||||
}
|
||||
|
||||
fn fill(face: &Node) -> Option<Color> {
|
||||
face.appearance.items.iter().find_map(|i| match i {
|
||||
AppearanceItem::Fill(f) => f.paint.color(),
|
||||
AppearanceItem::Stroke(_) => None,
|
||||
})
|
||||
}
|
||||
|
||||
fn facets(params: &Value) -> usize {
|
||||
let n = profile();
|
||||
let path = n.path_data().unwrap();
|
||||
let p = crate::merged_params(CLASSIC_REVOLVE, params);
|
||||
vectorcraft_three_d::revolve_facets(path, path.bounds().unwrap(), options(&p)).unwrap().len()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn plastic_shades_every_face_of_the_swept_surface_in_the_fill() {
|
||||
let art = revolved(json!({}));
|
||||
let drawn = faces(&art);
|
||||
assert_eq!(drawn.len(), facets(&json!({})), "one face for each facet of the surface");
|
||||
let colors: Vec<[f32; 3]> = drawn.iter().map(|f| fill(f).unwrap().to_rgb()).collect();
|
||||
// Lit from one side, the faces take more than one tone, and none is another hue: a face is
|
||||
// the blue darkened toward black, lightened toward white, or both.
|
||||
let distinct = colors.iter().filter(|c| colors.iter().any(|d| (c[0] - d[0]).abs() > 0.02)).count();
|
||||
assert!(distinct > 0, "{colors:?}");
|
||||
// Diffuse has no highlight, so every face is the blue darkened toward black.
|
||||
let art = revolved(json!({"surface": "diffuse"}));
|
||||
for face in faces(&art) {
|
||||
let [r, g, b] = fill(face).unwrap().to_rgb();
|
||||
assert!(b <= 0.8 + 1e-6 && (g * 2.0 - b).abs() < 1e-4 && (r * 4.0 - b).abs() < 1e-4, "{r} {g} {b}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn wireframe_strokes_the_edges_of_every_face_and_no_shading_keeps_the_paint() {
|
||||
let art = revolved(json!({"surface": "wireframe"}));
|
||||
let faces_drawn = faces(&art);
|
||||
assert_eq!(faces_drawn.len(), facets(&json!({"surface": "wireframe"})));
|
||||
for face in faces_drawn {
|
||||
match face.appearance.items.as_slice() {
|
||||
[AppearanceItem::Stroke(s)] => assert_eq!((s.paint.color(), s.width), (Some(BLUE), 0.5)),
|
||||
items => panic!("a wireframe face is one stroke: {items:?}"),
|
||||
}
|
||||
}
|
||||
for face in faces(&revolved(json!({"surface": "none"}))) {
|
||||
assert_eq!(fill(face), Some(BLUE));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn angle_offset_edge_and_cap_shape_the_surface() {
|
||||
let full = revolved(json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0})).visual_bounds().unwrap();
|
||||
// Seen from the front, the full turn is twice the profile's width across, about its left edge.
|
||||
assert!((full.width() - 60.0).abs() < 2.0, "{full:?}");
|
||||
let ring = revolved(json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0, "offset": 20})).visual_bounds().unwrap();
|
||||
assert!((ring.width() - 100.0).abs() < 2.0, "{ring:?}");
|
||||
// About its right edge the axis is at x 130, so the surface reaches x 160.
|
||||
let right = revolved(json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0, "edge": "right"})).visual_bounds().unwrap();
|
||||
assert!((right.x1 - 160.0).abs() < 2.0, "{right:?}");
|
||||
assert!(facets(&json!({"angle": 90})) < facets(&json!({})));
|
||||
// The profile's ends lie on the axis, so they close nothing until an offset moves them off it.
|
||||
assert!(facets(&json!({"cap": false, "offset": 10})) < facets(&json!({"offset": 10})), "hollow leaves out the end caps");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_group_revolves_its_members_about_one_shared_axis() {
|
||||
let mut b = BezPath::new();
|
||||
b.move_to((150.0, 60.0));
|
||||
b.line_to((170.0, 60.0));
|
||||
b.line_to((170.0, 140.0));
|
||||
let outer = Node::path(NodeId(2), PathData::from_bezpath(&b), Appearance::basic(Paint::solid(Color::BLACK), Paint::None, 0.0));
|
||||
let mut g = Node::group(NodeId(3), vec![std::sync::Arc::new(profile()), std::sync::Arc::new(outer)]);
|
||||
g.appearance.effects.push(crate::new_effect(CLASSIC_REVOLVE, &json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0})).unwrap());
|
||||
let art = crate::revolve_art(&g).unwrap();
|
||||
// The axis is at the left edge of both members together, x 100, so the outer one reaches 70
|
||||
// out on either side of it.
|
||||
let bounds = art.visual_bounds().unwrap();
|
||||
assert!((bounds.x0 - 30.0).abs() < 2.0 && (bounds.x1 - 170.0).abs() < 2.0, "{bounds:?}");
|
||||
let mut colors = vec![];
|
||||
art.walk(&mut |n| colors.extend(fill(n).map(|c| c.to_rgb())));
|
||||
assert!(colors.iter().any(|c| c[2] > c[0]) && colors.iter().any(|c| c[0] == c[2]), "both members' paints are drawn");
|
||||
}
|
||||
|
||||
/// A group member in a gradient with transparent stops keeps the shared back-to-front order of
|
||||
/// every member's faces: its faces go in runs that carry its opacity mask, and the other
|
||||
/// member's faces are drawn between them where they are in front of some and behind others.
|
||||
#[test]
|
||||
fn a_member_in_a_transparent_gradient_keeps_the_shared_face_order() {
|
||||
use vectorcraft_doc::color::{Gradient, GradientKind, GradientPaint, GradientStop};
|
||||
let art = |end_opacity: f32| {
|
||||
let mut end = GradientStop::new(1.0, Color::BLACK);
|
||||
end.opacity = end_opacity;
|
||||
let gradient =
|
||||
Paint::Gradient(Box::new(GradientPaint::new(Gradient::new(GradientKind::Linear, vec![GradientStop::new(0.0, BLUE), end]))));
|
||||
let mut b = BezPath::new();
|
||||
b.move_to((150.0, 60.0));
|
||||
b.line_to((170.0, 60.0));
|
||||
b.line_to((170.0, 140.0));
|
||||
let outer = Node::path(NodeId(2), PathData::from_bezpath(&b), Appearance::basic(gradient, Paint::None, 0.0));
|
||||
let mut g = Node::group(NodeId(3), vec![std::sync::Arc::new(outer), std::sync::Arc::new(profile())]);
|
||||
g.appearance.effects.push(crate::new_effect(CLASSIC_REVOLVE, &json!({})).unwrap());
|
||||
crate::revolve_art(&g).unwrap()
|
||||
};
|
||||
// The drawing order: `M` for a group with an opacity mask, `F` for a face outside one.
|
||||
fn visit(n: &Node, order: &mut String) {
|
||||
if n.extras().mask.is_some() {
|
||||
order.push('M');
|
||||
return;
|
||||
}
|
||||
if n.path_data().is_some() {
|
||||
order.push('F');
|
||||
}
|
||||
for c in n.children().into_iter().flatten() {
|
||||
visit(c, order);
|
||||
}
|
||||
}
|
||||
let order = |art: &Node| {
|
||||
let mut order = String::new();
|
||||
visit(art, &mut order);
|
||||
order
|
||||
};
|
||||
assert!(!order(&art(1.0)).contains('M'), "an opaque gradient needs no mask");
|
||||
let masked = order(&art(0.5));
|
||||
let (first, last) = (masked.find('M').unwrap(), masked.rfind('M').unwrap());
|
||||
assert!(masked.get(first..last).is_some_and(|between| between.contains('F')), "faces between the member's runs: {masked}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bad_parameters_are_refused() {
|
||||
let check = |p: Value| crate::validate_three_d(&profile(), CLASSIC_REVOLVE, &crate::merged_params(CLASSIC_REVOLVE, &p));
|
||||
assert_eq!(check(json!({})), Ok(()));
|
||||
for (p, error) in [
|
||||
(json!({"segments": 32}), "unknown parameter `segments`"),
|
||||
(json!({"angle": 400}), "`angle` must be between 0 and 360"),
|
||||
(json!({"offset": 1001}), "`offset` must be between 0 and 1000"),
|
||||
(json!({"rotationY": -181}), "`rotationY` must be between -180 and 180"),
|
||||
(json!({"blendSteps": 2.5}), "`blendSteps` must be a whole number"),
|
||||
(json!({"lightBehind": 1}), "`lightBehind` must be true or false"),
|
||||
(json!({"surface": "glossy"}), "`surface` must be one of"),
|
||||
(json!({"shadingColor": "white"}), "`shadingColor` must be one of"),
|
||||
(json!({"shadingCustom": "red"}), "`shadingCustom` must be a #rrggbb color"),
|
||||
(json!({"edge": "middle"}), "Revolve edge must be left or right"),
|
||||
(json!({"cap": "yes"}), "Revolve cap must be a boolean"),
|
||||
] {
|
||||
let e = check(p.clone()).unwrap_err();
|
||||
assert!(e.contains(error), "{p}: {e}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
//! Extrude & Bevel, Inflate, Rotate and Extrude & Bevel (Classic) as live, shaded vector art,
|
||||
//! Extrude & Bevel, Inflate, Rotate, Extrude & Bevel (Classic) and Rotate (Classic) as live, shaded vector art,
|
||||
//! shared by the canvas and every exporter. Like Revolve, the source path stays editable and the effect draws its 3D faces.
|
||||
use std::sync::Arc;
|
||||
|
||||
@@ -14,8 +14,8 @@ use vectorcraft_doc::color::Color;
|
||||
use crate::util::{flag, num, text};
|
||||
use crate::{GeomContext, apply_geometry_with, is_geometry};
|
||||
|
||||
mod classic;
|
||||
pub use classic::{CLASSIC_EXTRUDE, SHADING_COLORS, classic_extrude_options, classic_shading};
|
||||
pub(crate) mod classic;
|
||||
pub use classic::{CLASSIC_EXTRUDE, CLASSIC_ROTATE, ROTATE_SURFACES, SHADING_COLORS, classic_extrude_options, classic_shading};
|
||||
|
||||
mod source;
|
||||
pub(crate) use source::{resolve, resolve_for};
|
||||
@@ -26,11 +26,22 @@ pub const EXTRUDE: &str = "threeD.extrude";
|
||||
pub const INFLATE: &str = "threeD.inflate";
|
||||
pub const ROTATE: &str = "threeD.rotate";
|
||||
/// The 3D effects this module draws (Revolve has its own).
|
||||
pub const SOLIDS: [&str; 4] = [EXTRUDE, INFLATE, ROTATE, CLASSIC_EXTRUDE];
|
||||
pub const SOLIDS: [&str; 5] = [EXTRUDE, INFLATE, ROTATE, CLASSIC_EXTRUDE, CLASSIC_ROTATE];
|
||||
|
||||
/// Is `id` one of the 3D and Materials effects (Revolve included)?
|
||||
/// Is `id` one of the 3D and Materials effects (Revolve and Revolve (Classic) included)?
|
||||
pub fn is_three_d(id: &str) -> bool {
|
||||
id == crate::REVOLVE || SOLIDS.contains(&id)
|
||||
crate::revolve::is_revolve(id) || SOLIDS.contains(&id)
|
||||
}
|
||||
|
||||
/// Is `id` one of the 3D (Classic) effects: Extrude & Bevel (Classic), Revolve (Classic) or Rotate
|
||||
/// (Classic)?
|
||||
pub fn is_classic_three_d(id: &str) -> bool {
|
||||
id == CLASSIC_EXTRUDE || id == crate::CLASSIC_REVOLVE || id == CLASSIC_ROTATE
|
||||
}
|
||||
|
||||
/// Does 3D effect `id` turn the art as a flat plane: Rotate or Rotate (Classic)?
|
||||
fn is_plane(id: &str) -> bool {
|
||||
id == ROTATE || id == CLASSIC_ROTATE
|
||||
}
|
||||
|
||||
/// The 3D and Materials panel's object types and the effect that draws each: (type, effect id).
|
||||
@@ -193,6 +204,9 @@ fn validate_solid_params(id: &str, p: &Value) -> Result<(), String> {
|
||||
if id == CLASSIC_EXTRUDE {
|
||||
classic::validate(p)?;
|
||||
}
|
||||
if id == CLASSIC_ROTATE {
|
||||
classic::validate_rotate(p)?;
|
||||
}
|
||||
crate::lighting::validate(p)?;
|
||||
shadow::validate(p)?;
|
||||
if let Some(v) = p.get("bevel")
|
||||
@@ -225,7 +239,7 @@ pub fn validate_solid_in(doc: Option<&Document>, n: &Node, id: &str, p: &Value)
|
||||
fn validate_solid_for(doc: Option<&Document>, n: &Node, id: &str, p: &Value, item: Option<usize>) -> Result<(), String> {
|
||||
validate_solid_params(id, p)?;
|
||||
let label = label_of(id);
|
||||
let n = &*source::resolve_for(doc, n, label, id == ROTATE)?;
|
||||
let n = &*source::resolve_for(doc, n, label, is_plane(id))?;
|
||||
if is_container(n) {
|
||||
let shapes = members(n, label)?;
|
||||
let b = union_bounds(&shapes).ok_or_else(|| format!("{label} requires a group holding a shape with at least two anchors"))?;
|
||||
@@ -417,7 +431,7 @@ pub fn validate_three_d(n: &Node, id: &str, p: &Value) -> Result<(), String> {
|
||||
|
||||
/// [`validate_three_d`] with the symbols of `doc` ([`validate_solid_in`]).
|
||||
pub fn validate_three_d_in(doc: Option<&Document>, n: &Node, id: &str, p: &Value) -> Result<(), String> {
|
||||
if id == crate::REVOLVE { crate::revolve::validate_revolve_in(doc, n, p) } else { validate_solid_in(doc, n, id, p) }
|
||||
if crate::revolve::is_revolve(id) { crate::revolve::validate_in(doc, n, id, p) } else { validate_solid_in(doc, n, id, p) }
|
||||
}
|
||||
|
||||
/// [`validate_three_d`] for an effect at `(item, index)`, index `index` of the effects of
|
||||
@@ -436,7 +450,7 @@ pub fn validate_three_d_at_in(doc: Option<&Document>, n: &Node, id: &str, p: &Va
|
||||
Some(_) if is_container(n) || source::resolves(n) => {
|
||||
Err("A 3D effect on a group or layer goes on the group itself, not on its fill or stroke".into())
|
||||
}
|
||||
Some((item, index)) if id == crate::REVOLVE => crate::revolve::validate_item_revolve(n, p, item, index),
|
||||
Some((item, index)) if crate::revolve::is_revolve(id) => crate::revolve::validate_item_of(n, id, p, item, index),
|
||||
Some((item, _)) => validate_solid_for(doc, n, id, p, Some(item)),
|
||||
None => validate_three_d_in(doc, n, id, p),
|
||||
}
|
||||
@@ -446,7 +460,7 @@ pub fn validate_three_d_at_in(doc: Option<&Document>, n: &Node, id: &str, p: &Va
|
||||
/// build the art, for an edit that hides the effect: hidden, it draws nothing, so its object does
|
||||
/// not need to fit.
|
||||
pub fn validate_three_d_params(id: &str, p: &Value) -> Result<(), String> {
|
||||
if id == crate::REVOLVE { crate::revolve::validate_revolve_params(p) } else { validate_solid_params(id, p) }
|
||||
if crate::revolve::is_revolve(id) { crate::revolve::validate_params_of(id, p) } else { validate_solid_params(id, p) }
|
||||
}
|
||||
|
||||
/// One surface: each facet a path shaded from `paint`, as a group with the paint's opacity and
|
||||
@@ -708,12 +722,12 @@ fn art_for(n: &Node, fx: &Effect, shapes: &[Profile]) -> Option<ShadowAndSurface
|
||||
/// What the shadow of the solids [`surfaces_for`] builds for effect `id` with parameters `p` on
|
||||
/// `shapes` is cast from, on one plane: the faces of every solid, the shadow's settings and the
|
||||
/// faces of each solid of visible art with its member's scopes and ink. `None` with the shadow
|
||||
/// off, for Extrude & Bevel (Classic) or with no shapes. A stroke's solid that is not built (past
|
||||
/// off, for Extrude & Bevel (Classic) and Rotate (Classic) or with no shapes. A stroke's solid that is not built (past
|
||||
/// the limits) casts nothing, as it draws nothing; any other solid that is not built is an error.
|
||||
/// When a member's opacity mask or blending mode applies to its solids ([`masked`]), it applies to
|
||||
/// the part of the shadow they cast too ([`shadow::scoped_art`]).
|
||||
fn cast_shadow<'a>(id: &str, p: &Value, shapes: &'a [Profile]) -> Result<Option<Cast<'a>>, String> {
|
||||
if id == CLASSIC_EXTRUDE {
|
||||
if id == CLASSIC_EXTRUDE || id == CLASSIC_ROTATE {
|
||||
return Ok(None);
|
||||
}
|
||||
let (Some(settings), Some(b)) = (shadow::options(p), union_bounds(shapes)) else { return Ok(None) };
|
||||
@@ -775,12 +789,12 @@ type Cast<'a> = (vectorcraft_three_d::ShadowCaster, vectorcraft_three_d::Shadow,
|
||||
fn surfaces_for(n: &Node, fx: &Effect, shapes: &[Profile]) -> Option<Vec<Arc<Node>>> {
|
||||
let b = union_bounds(shapes)?;
|
||||
let p = crate::merged_params(&fx.id, &fx.params);
|
||||
let classic = fx.id == CLASSIC_EXTRUDE;
|
||||
let classic = fx.id == CLASSIC_EXTRUDE || fx.id == CLASSIC_ROTATE;
|
||||
let colored = !classic && view_options(&p).has_colored_lights();
|
||||
let masks = has_masks(shapes);
|
||||
// The paint copies of every solid together: past the allowance the source path is drawn.
|
||||
let mut paint_bytes = 0usize;
|
||||
if fx.id == ROTATE {
|
||||
if is_plane(&fx.id) {
|
||||
// Every part turns about the centre of the object's own bounds (a group's members about
|
||||
// the centre of theirs), so they stay together.
|
||||
let mut out = vec![];
|
||||
@@ -792,7 +806,8 @@ fn surfaces_for(n: &Node, fx: &Effect, shapes: &[Profile]) -> Option<Vec<Arc<Nod
|
||||
if !crate::revolve::paint_copies_add(&mut paint_bytes, facet_copies(&f, &paint, colored), &paint) {
|
||||
return None;
|
||||
}
|
||||
out.push((s.scopes.as_slice(), Arc::new(surface(n, f, &paint, opacity, blend, colored))));
|
||||
let art = if classic { classic::surface(n, f, &paint, opacity, blend, &p) } else { surface(n, f, &paint, opacity, blend, colored) };
|
||||
out.push((s.scopes.as_slice(), Arc::new(art)));
|
||||
}
|
||||
}
|
||||
return Some(if masks { masked(n.id, out) } else { out.into_iter().map(|(_, s)| s).collect() });
|
||||
@@ -1001,7 +1016,7 @@ fn meshes_for(fx: &Effect, shapes: &[Profile], total: &mut usize, limit: usize)
|
||||
let view = view_options(&p);
|
||||
let mut out = vec![];
|
||||
let mut keep = |out: &mut Vec<SolidMesh>, mesh: Mesh, color: [f32; 4]| keep_mesh(out, total, SolidMesh { mesh, color }, limit);
|
||||
if fx.id == ROTATE {
|
||||
if is_plane(&fx.id) {
|
||||
for s in shapes {
|
||||
for item in &s.items {
|
||||
let (paint, opacity, _) = paint_of(item, s.opacity);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//! Extrude & Bevel (Classic): the solid Extrude & Bevel builds from a path, drawn with the classic
|
||||
//! surfaces (Wireframe, No Shading, Diffuse and Plastic), their highlight, blend steps and shading
|
||||
//! color.
|
||||
//! color. Rotate (Classic): the plane Rotate turns, drawn with the No Shading and Diffuse surfaces.
|
||||
use std::sync::Arc;
|
||||
|
||||
use serde_json::Value;
|
||||
@@ -12,6 +12,10 @@ use vectorcraft_three_d::{Bevel, BevelShape, ClassicShading, ClassicSurface, Ext
|
||||
use crate::util::{flag, num, text};
|
||||
|
||||
pub const CLASSIC_EXTRUDE: &str = "threeD.classicExtrude";
|
||||
pub const CLASSIC_ROTATE: &str = "threeD.classicRotate";
|
||||
|
||||
/// The surfaces Rotate (Classic) takes: No Shading and Diffuse.
|
||||
pub const ROTATE_SURFACES: [&str; 2] = ["none", "diffuse"];
|
||||
|
||||
/// The width of a Wireframe edge, in points.
|
||||
const WIRE: f64 = 0.5;
|
||||
@@ -104,8 +108,39 @@ const FLAGS: [&str; 4] = ["cap", "bevelInside", "lightBehind", "drawHiddenFaces"
|
||||
/// its parameters, numbers are in range, flags are true or false, and `surface`, `shadingColor` and
|
||||
/// `shadingCustom` name a surface, a shading color and a #rrggbb color.
|
||||
pub fn validate(p: &Value) -> Result<(), String> {
|
||||
validate_classic(CLASSIC_EXTRUDE, p, &RANGES, &FLAGS)
|
||||
}
|
||||
|
||||
/// Rotate (Classic)'s numeric parameters: (key, lowest, highest, whole numbers only).
|
||||
const ROTATE_RANGES: [(&str, f64, f64, bool); 9] = [
|
||||
("rotationX", -180.0, 180.0, false),
|
||||
("rotationY", -180.0, 180.0, false),
|
||||
("rotationZ", -180.0, 180.0, false),
|
||||
("perspectiveAngle", 0.0, 160.0, false),
|
||||
("lightRotation", -180.0, 180.0, false),
|
||||
("lightHeight", 0.0, 90.0, false),
|
||||
("lightIntensity", 0.0, 100.0, false),
|
||||
("ambient", 0.0, 100.0, false),
|
||||
("blendSteps", 1.0, 256.0, true),
|
||||
];
|
||||
|
||||
/// Check Rotate (Classic)'s parameters `p` (its defaults filled in) as [`validate`] checks Extrude &
|
||||
/// Bevel (Classic)'s, with `surface` No Shading or Diffuse only.
|
||||
pub fn validate_rotate(p: &Value) -> Result<(), String> {
|
||||
validate_classic(CLASSIC_ROTATE, p, &ROTATE_RANGES, &["lightBehind"])?;
|
||||
if p.get("surface").is_some_and(|v| !v.as_str().is_some_and(|s| ROTATE_SURFACES.contains(&s))) {
|
||||
return Err(format!("`surface` must be one of {}", ROTATE_SURFACES.join(", ")));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Check the parameters `p` of classic 3D effect `id` (its defaults filled in): every key is one of
|
||||
/// its parameters, the numbers `ranges` lists, as (key, lowest, highest, whole numbers only), are in
|
||||
/// range, the `flags` are true or false, and `surface`, `shadingColor` and `shadingCustom` name a
|
||||
/// surface, a shading color and a #rrggbb color.
|
||||
pub(crate) fn validate_classic(id: &str, p: &Value, ranges: &[(&str, f64, f64, bool)], flags: &[&str]) -> Result<(), String> {
|
||||
let Some(map) = p.as_object() else { return Ok(()) };
|
||||
let defaults = crate::default_params(CLASSIC_EXTRUDE).unwrap_or(Value::Null);
|
||||
let defaults = crate::default_params(id).unwrap_or(Value::Null);
|
||||
let known: Vec<&str> = defaults.as_object().map(|m| m.keys().map(String::as_str).collect()).unwrap_or_default();
|
||||
for key in map.keys() {
|
||||
if !known.contains(&key.as_str()) {
|
||||
@@ -113,7 +148,7 @@ pub fn validate(p: &Value) -> Result<(), String> {
|
||||
return Err(format!("unknown parameter `{key}`; the command takes: {keys}"));
|
||||
}
|
||||
}
|
||||
for (key, min, max, whole) in RANGES {
|
||||
for &(key, min, max, whole) in ranges {
|
||||
let Some(v) = map.get(key) else { continue };
|
||||
let Some(x) = v.as_f64() else { return Err(format!("`{key}` must be a number")) };
|
||||
if whole && (x.fract() != 0.0 || !(min..=max).contains(&x)) {
|
||||
@@ -123,7 +158,7 @@ pub fn validate(p: &Value) -> Result<(), String> {
|
||||
return Err(format!("`{key}` must be between {min} and {max} (got {x})"));
|
||||
}
|
||||
}
|
||||
for key in FLAGS {
|
||||
for &key in flags {
|
||||
if map.get(key).is_some_and(|v| !v.is_boolean()) {
|
||||
return Err(format!("`{key}` must be true or false"));
|
||||
}
|
||||
@@ -161,7 +196,7 @@ fn shaded(c: Color, tone: f64, spec: f64, shade: Option<Color>) -> Color {
|
||||
/// for each facet: the edges of the faces on Wireframe, else each face filled in its paint shaded by
|
||||
/// its tone and highlight. A gradient with transparent stops is shaded opaque and then masked by
|
||||
/// its own transparency, so the shading follows the gradient's coverage.
|
||||
pub(super) fn surface(n: &Node, facets: Vec<Facet>, source: &Paint, opacity: f32, blend: BlendMode, p: &Value) -> Node {
|
||||
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);
|
||||
|
||||
@@ -55,7 +55,7 @@ fn needs(n: &Node) -> bool {
|
||||
/// a clipping path too complex to cut the art with. `label` is the effect's name. The art is cut
|
||||
/// for the solid effect `n` carries ([`resolve_for`]).
|
||||
pub(crate) fn resolve<'a>(doc: Option<&Document>, n: &'a Node, label: &str) -> Result<Cow<'a, Node>, String> {
|
||||
let every_fill = super::solid(&n.appearance.effects).is_some_and(|(_, fx)| fx.id == super::ROTATE);
|
||||
let every_fill = super::solid(&n.appearance.effects).is_some_and(|(_, fx)| super::is_plane(&fx.id));
|
||||
resolve_for(doc, n, label, every_fill)
|
||||
}
|
||||
|
||||
|
||||
@@ -889,3 +889,80 @@ fn classic_parameters_are_checked() {
|
||||
assert!(err.starts_with(says), "{p}: {err}");
|
||||
}
|
||||
}
|
||||
|
||||
/// The red square, stroked black, with Rotate (Classic) and `params`: its surfaces, the fill's
|
||||
/// plane first, then the stroke's outline.
|
||||
fn classic_rotate(params: Value) -> Vec<Node> {
|
||||
let mut n = square_node();
|
||||
n.appearance.effects.push(fx(CLASSIC_ROTATE, params));
|
||||
solid_art(&n).unwrap().children().unwrap().iter().map(|s| (**s).clone()).collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classic_rotate_turns_every_fill_and_stroke_as_one_plane() {
|
||||
let front = json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0});
|
||||
let surfaces = classic_rotate(front.clone());
|
||||
assert_eq!(surfaces.len(), 2, "the fill's plane and the stroke's outline");
|
||||
assert!(surfaces.iter().all(|s| s.children().unwrap().len() == 1), "each is one flat face");
|
||||
let fill = surfaces[0].visual_bounds().unwrap();
|
||||
assert!((fill.width() - 100.0).abs() < 1.0 && (fill.height() - 100.0).abs() < 1.0, "{fill:?}");
|
||||
// Turned 60° about the vertical axis, the square shows half its width and all its height,
|
||||
// about the center of its bounds.
|
||||
let turned = classic_rotate(json!({"rotationX": 0, "rotationY": 60, "rotationZ": 0}))[0].visual_bounds().unwrap();
|
||||
assert!((turned.width() - 50.0).abs() < 1.0 && (turned.height() - 100.0).abs() < 1.0, "{turned:?}");
|
||||
assert!((turned.center().x - 150.0).abs() < 1.0, "{turned:?}");
|
||||
// Turned past 90°, the back of the plane is drawn.
|
||||
let back = classic_rotate(json!({"rotationX": 0, "rotationY": 150, "rotationZ": 0}));
|
||||
assert!(back[0].visual_bounds().is_some_and(|b| (b.width() - 100.0 * 30f64.to_radians().cos()).abs() < 1.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classic_rotate_shades_with_no_shading_or_diffuse() {
|
||||
let rgb = |p: Value| fill_rgb(&classic_rotate(p)[0].children().unwrap()[0]);
|
||||
// No Shading keeps the paint, the color itself kept.
|
||||
let mut n = square_node();
|
||||
n.appearance.effects.push(fx(CLASSIC_ROTATE, json!({"surface": "none"})));
|
||||
let art = solid_art(&n).unwrap();
|
||||
let AppearanceItem::Fill(f) = &faces(&art)[0].appearance.items[0] else { panic!("a fill first") };
|
||||
assert_eq!(f.paint, Paint::solid(RED));
|
||||
// Diffuse: straight on with the light in front, the face is fully lit; turned away from the
|
||||
// light, it is the red darkened toward black.
|
||||
let lit = json!({"rotationX": 0, "rotationY": 0, "rotationZ": 0, "lightHeight": 90});
|
||||
assert!(close3(rgb(lit), RED.to_rgb()));
|
||||
let [r, g, b] = rgb(json!({"rotationX": 0, "rotationY": 70, "rotationZ": 0, "lightHeight": 90}));
|
||||
assert!(r < 0.8 - 0.05 && (g * 4.0 - r).abs() < 1e-4 && (b * 8.0 - r).abs() < 1e-4, "{r} {g} {b}");
|
||||
// No light: the ambient share of the red. A custom shading color darkens toward that color;
|
||||
// None keeps the paint.
|
||||
let dark = rgb(json!({"lightIntensity": 0, "ambient": 20, "blendSteps": 256}));
|
||||
assert!((dark[0] - 0.8 * 0.2).abs() < 0.01, "{dark:?}");
|
||||
let blue = rgb(json!({"lightIntensity": 0, "ambient": 20, "shadingColor": "custom", "shadingCustom": "#0000ff"}));
|
||||
assert!(blue[2] > blue[0] / 8.0 + 0.01, "{blue:?}");
|
||||
assert!(close3(rgb(json!({"lightIntensity": 0, "shadingColor": "none"})), RED.to_rgb()));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classic_rotate_parameters_are_checked() {
|
||||
let n = square_node();
|
||||
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());
|
||||
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!({"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)"),
|
||||
(json!({"lightIntensity": 101}), "`lightIntensity` must be between 0 and 100 (got 101)"),
|
||||
(json!({"blendSteps": 0}), "`blendSteps` must be a whole number between 1 and 256 (got 0)"),
|
||||
(json!({"lightBehind": 1}), "`lightBehind` must be true or false"),
|
||||
(json!({"highlightSize": 50}), "unknown parameter `highlightSize`"),
|
||||
(json!({"drawHiddenFaces": true}), "unknown parameter `drawHiddenFaces`"),
|
||||
(json!({"shadow": true}), "unknown parameter `shadow`"),
|
||||
(json!({"lights": []}), "lights must contain one to ten lights"),
|
||||
] {
|
||||
let err = check(p.clone()).unwrap_err();
|
||||
assert!(err.starts_with(says), "{p}: {err}");
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ mod arrange;
|
||||
mod cleanup;
|
||||
mod color;
|
||||
mod contour;
|
||||
mod cutting;
|
||||
mod document;
|
||||
mod image;
|
||||
mod pathtools;
|
||||
@@ -23,6 +24,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
v.extend(cleanup::specs());
|
||||
v.extend(color::specs());
|
||||
v.extend(contour::specs());
|
||||
v.extend(cutting::specs());
|
||||
v.extend(document::specs());
|
||||
v.extend(image::specs());
|
||||
v.extend(pathtools::specs());
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
//! Cutting Tools (`addon.cutting.*`), a built-in add-on that prepares art for cutting. Stencil
|
||||
//! Bridges cuts bridges out of the selected art so that a stencil cut from it holds together
|
||||
//! ([`stencil`]). Its submenu (Object › Plug-ins › Cutting Tools) and dialog are the UI's.
|
||||
|
||||
mod stencil;
|
||||
|
||||
use super::super::CommandSpec;
|
||||
|
||||
pub fn specs() -> Vec<CommandSpec> {
|
||||
stencil::specs()
|
||||
}
|
||||
@@ -0,0 +1,167 @@
|
||||
//! Stencil Bridges (`addon.cutting.bridges`), a command of the built-in Cutting Tools add-on: it
|
||||
//! cuts bridges out of the selected art so that a stencil cut from it holds together. Each island
|
||||
//! of the stencil sheet (the inside of an O, a hole in a shape) stays joined to the sheet by strips
|
||||
//! of a set width across the art (<https://en.wikipedia.org/wiki/Stencil> describes islands and
|
||||
//! bridges). The art becomes one compound path with the gaps cut, and type is measured by its
|
||||
//! glyph outlines. The original goes to a new hidden layer or is replaced. The geometry is
|
||||
//! `vectorcraft_pathops::addons::stencil`.
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
use serde_json::{Value, json};
|
||||
use vectorcraft_doc::{Document, Node, NodeId, NodeKind};
|
||||
use vectorcraft_geom::{FillRule, PathData};
|
||||
use vectorcraft_pathops::addons::stencil::{BRIDGE_WIDTH_RANGE, BridgeDirection, BridgeSpec, MAX_BRIDGES_PER_ISLAND, stencil_bridges};
|
||||
|
||||
use super::super::super::edit::selected_roots;
|
||||
use super::super::super::object::choice;
|
||||
use super::super::super::pathops::{length_given, node_path, pf_leaves, shape_node, style_of};
|
||||
use super::super::super::{CommandSpec, bad, cmd, has_selection, number_or, switch_or};
|
||||
use crate::{EngineError, Result, Session};
|
||||
|
||||
/// Stencil Bridges' command (the id in [`specs`]).
|
||||
pub const BRIDGES: &str = "addon.cutting.bridges";
|
||||
/// The ways bridges run, as `direction` takes them.
|
||||
pub const DIRECTIONS: [&str; 3] = ["vertical", "horizontal", "shortest"];
|
||||
/// A bridge's width when none is given, in points.
|
||||
pub const DEFAULT_WIDTH: f64 = 2.0;
|
||||
/// The name of the hidden layer the original art goes to (numbered when it is taken).
|
||||
const ORIGINAL_LAYER: &str = "Stencil Original";
|
||||
|
||||
pub fn specs() -> Vec<CommandSpec> {
|
||||
vec![cmd!(
|
||||
"addon.cutting.bridges",
|
||||
"Stencil Bridges…",
|
||||
["Object", "Plug-ins", "Cutting Tools"],
|
||||
None,
|
||||
"{width?: pt 0.01..1000 (2), count?: whole number 1..16 of bridges each island gets (1; fewer where it has no room and more where other islands are joined to the sheet through it), direction?: \"vertical\" | \"horizontal\" | \"shortest\" (the shortest crossing among 12 directions 15° apart) (\"vertical\"), keepOriginal?: true (the selected objects that make up the art go to a new hidden layer named \"Stencil Original\"; false: they are replaced)} cut bridges out of the selected art so that a stencil cut from it holds together: every island (an area the art encloses, such as the inside of an O or a hole in a shape) is joined to the area around the art by strips `width` wide across the art, the shortest crossings first, then spread around the island. The art is measured by the area its outlines enclose, whatever their paint (open paths closed as a fill closes them; type by its glyph outlines; groups by their members; hidden objects left out) and becomes one compound path with the gaps cut, painted as the topmost selected shape, in the place of the topmost selected object that has outlines. Selected objects with no outlines in the art stay where they are. Art with no islands, or none a bridge of the width fits, is left as it is, with a warning and no undo step; islands the cut result still encloses are counted in `unbridged`, with a warning. Art that reaches more than 10000000 pt from the origin, has more than 200000 anchors, whose combined area has more than 4000 outlines, whose outlines need more than 200000 straight segments, or that takes more work to measure than a fixed budget allows is refused. One undo step; the new path is selected → {id, islands, bridges, unbridged, original (the hidden layer's id, or null), warning?}",
|
||||
has_selection,
|
||||
bridges
|
||||
)]
|
||||
}
|
||||
|
||||
fn bridges(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = BRIDGES;
|
||||
let width = length_given(p, "width", C)?.unwrap_or(DEFAULT_WIDTH);
|
||||
let (lo, hi) = BRIDGE_WIDTH_RANGE;
|
||||
if !(lo..=hi).contains(&width) {
|
||||
return Err(bad(C, format!("`width` must be from {lo} to {hi} pt")));
|
||||
}
|
||||
let count = number_or(p, "count", 1.0, C)?;
|
||||
if count.fract() != 0.0 || !(1.0..=MAX_BRIDGES_PER_ISLAND as f64).contains(&count) {
|
||||
return Err(bad(C, format!("`count` must be a whole number from 1 to {MAX_BRIDGES_PER_ISLAND}")));
|
||||
}
|
||||
let direction = match choice(p, C, "direction", &DIRECTIONS)?.unwrap_or("vertical") {
|
||||
"horizontal" => BridgeDirection::Horizontal,
|
||||
"shortest" => BridgeDirection::Shortest,
|
||||
_ => BridgeDirection::Vertical,
|
||||
};
|
||||
let keep = switch_or(p, "keepOriginal", true, C)?;
|
||||
let selected = selected_roots(s)?;
|
||||
let (bridged, style, roots) = {
|
||||
let d = &s.doc()?.doc;
|
||||
// The art's outlines, the selected objects they come from, and the topmost object that
|
||||
// has some, whose paint the result takes.
|
||||
let mut parts: Vec<(PathData, FillRule)> = vec![];
|
||||
let mut roots = vec![];
|
||||
let mut top = None;
|
||||
for id in selected {
|
||||
let n = d.node(id).ok_or(EngineError::NoNode(id))?;
|
||||
let mut leaves = vec![];
|
||||
shown_leaves(d, n, &mut leaves);
|
||||
let before = parts.len();
|
||||
for leaf in leaves {
|
||||
if let Some(part) = node_path(&leaf).filter(|(p, _)| !p.is_empty()) {
|
||||
parts.push(part);
|
||||
top = Some(leaf);
|
||||
}
|
||||
}
|
||||
if parts.len() > before {
|
||||
roots.push(id);
|
||||
}
|
||||
}
|
||||
let Some(top) = top else {
|
||||
let label = "Stencil Bridges";
|
||||
return Err(EngineError::Other(format!("{label}: select paths, compound paths, groups or text")));
|
||||
};
|
||||
let refs: Vec<(&PathData, FillRule)> = parts.iter().map(|(p, r)| (p, *r)).collect();
|
||||
let spec = BridgeSpec { width, count: count as usize, direction };
|
||||
let bridged = stencil_bridges(&refs, spec).map_err(|e| EngineError::Other(e.to_string()))?;
|
||||
(bridged, style_of(&top), roots)
|
||||
};
|
||||
let summary = |id: Option<NodeId>, original: Option<NodeId>| {
|
||||
json!({
|
||||
"id": id.map(|i| i.0), "islands": bridged.islands, "bridges": bridged.bridges, "unbridged": bridged.unbridged,
|
||||
"original": original.map(|i| i.0),
|
||||
})
|
||||
};
|
||||
if bridged.islands == 0 {
|
||||
let mut r = summary(None, None);
|
||||
// The warnings are written as `EngineError::Other` so that the i18n message scan
|
||||
// (`untranslated_report`) finds them.
|
||||
r["warning"] = json!(EngineError::Other("The selected art has no islands to bridge".into()).to_string());
|
||||
return Ok(r);
|
||||
}
|
||||
if bridged.bridges == 0 {
|
||||
let mut r = summary(None, None);
|
||||
r["warning"] = json!(EngineError::Other("No bridge of this width fits across the selected art".into()).to_string());
|
||||
return Ok(r);
|
||||
}
|
||||
let path = bridged.path.clone();
|
||||
let (id, original) = s.edit("Stencil Bridges", |d, sel| {
|
||||
let mut made = shape_node(d, path, None);
|
||||
style.apply(&mut made);
|
||||
let mut taken = vec![];
|
||||
let id = d.wrap(&roots, |nodes| {
|
||||
taken = nodes;
|
||||
made
|
||||
})?;
|
||||
let original = if keep { Some(hide_originals(d, taken)?) } else { None };
|
||||
sel.set([id]);
|
||||
Ok((id, original))
|
||||
})?;
|
||||
let mut r = summary(Some(id), original);
|
||||
if bridged.unbridged > 0 {
|
||||
r["warning"] = json!(EngineError::Other("Some islands could not be joined to the area around the art".into()).to_string());
|
||||
}
|
||||
Ok(r)
|
||||
}
|
||||
|
||||
/// The leaf shapes of `n` as [`pf_leaves`] gives them, leaving out hidden objects and the members
|
||||
/// of hidden groups.
|
||||
fn shown_leaves(d: &Document, n: &Node, out: &mut Vec<Node>) {
|
||||
if !n.visible {
|
||||
return;
|
||||
}
|
||||
match &n.kind {
|
||||
NodeKind::Group { children, .. } | NodeKind::Layer { children, .. } if !n.is_compound_shape() => {
|
||||
for c in children {
|
||||
shown_leaves(d, c, out);
|
||||
}
|
||||
}
|
||||
_ => pf_leaves(d, n, out),
|
||||
}
|
||||
}
|
||||
|
||||
/// Put `nodes` in a new hidden layer above the others, in their order, and return its id.
|
||||
fn hide_originals(d: &mut Document, nodes: Vec<Arc<Node>>) -> Result<NodeId> {
|
||||
let mut taken = std::collections::HashSet::new();
|
||||
d.walk(|n| {
|
||||
if n.is_layer() {
|
||||
taken.extend(n.name.clone());
|
||||
}
|
||||
});
|
||||
let name = std::iter::once(ORIGINAL_LAYER.to_string())
|
||||
.chain((2..).map(|i| format!("{ORIGINAL_LAYER} {i}")))
|
||||
.find(|name| !taken.contains(name))
|
||||
.unwrap_or_else(|| ORIGINAL_LAYER.to_string());
|
||||
let layer = d.add_layer(Some(&name));
|
||||
for (i, n) in nodes.into_iter().enumerate() {
|
||||
d.insert(Some(layer), i, Arc::unwrap_or_clone(n))?;
|
||||
}
|
||||
d.node_mut(layer).ok_or(EngineError::NoNode(layer))?.visible = false;
|
||||
Ok(layer)
|
||||
}
|
||||
@@ -0,0 +1,328 @@
|
||||
//! Tests for `addon.cutting.bridges`: bridges cut out of the selected art keep a stencil's islands
|
||||
//! attached.
|
||||
|
||||
use kurbo::Shape;
|
||||
use serde_json::{Value, json};
|
||||
use vectorcraft_doc::NodeKind;
|
||||
|
||||
use super::super::super::super::pathops::node_path;
|
||||
use crate::*;
|
||||
|
||||
fn session() -> Session {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({"width": 800, "height": 600})).unwrap();
|
||||
s
|
||||
}
|
||||
|
||||
fn rect(s: &mut Session, x: f64, y: f64, w: f64, h: f64) -> NodeId {
|
||||
let r = s.execute("shape.rectangle", &json!({"x": x, "y": y, "width": w, "height": h})).unwrap();
|
||||
NodeId(r["id"].as_u64().unwrap())
|
||||
}
|
||||
|
||||
fn select(s: &mut Session, ids: &[NodeId]) {
|
||||
s.execute("select.set", &json!({"ids": ids.iter().map(|i| i.0).collect::<Vec<_>>()})).unwrap();
|
||||
}
|
||||
|
||||
/// `outer` less each of `holes` (x, y, width, height), as one compound path, selected.
|
||||
fn shape_with_holes(s: &mut Session, outer: (f64, f64, f64, f64), holes: &[(f64, f64, f64, f64)]) -> NodeId {
|
||||
let mut ids = vec![rect(s, outer.0, outer.1, outer.2, outer.3)];
|
||||
for h in holes {
|
||||
ids.push(rect(s, h.0, h.1, h.2, h.3));
|
||||
}
|
||||
select(s, &ids);
|
||||
let r = s.execute("object.pathfinder.minusFront", &json!({})).unwrap();
|
||||
let id = NodeId(r["ids"][0].as_u64().unwrap());
|
||||
select(s, &[id]);
|
||||
id
|
||||
}
|
||||
|
||||
/// A square O: 100 pt across at (100, 100), with bars 20 pt thick.
|
||||
fn letter_o(s: &mut Session) -> NodeId {
|
||||
shape_with_holes(s, (100.0, 100.0, 100.0, 100.0), &[(120.0, 120.0, 60.0, 60.0)])
|
||||
}
|
||||
|
||||
fn id_of(r: &Value) -> NodeId {
|
||||
NodeId(r["id"].as_u64().unwrap())
|
||||
}
|
||||
|
||||
fn node(s: &Session, id: NodeId) -> vectorcraft_doc::Node {
|
||||
s.doc().unwrap().doc.node(id).cloned().unwrap()
|
||||
}
|
||||
|
||||
/// Is `(x, y)` inside the area object `id` fills?
|
||||
fn fills(s: &Session, id: NodeId, x: f64, y: f64) -> bool {
|
||||
let (path, rule) = node_path(&node(s, id)).unwrap();
|
||||
let w = path.to_bezpath().winding(kurbo::Point::new(x, y));
|
||||
match rule {
|
||||
vectorcraft_geom::FillRule::EvenOdd => w % 2 != 0,
|
||||
vectorcraft_geom::FillRule::NonZero => w != 0,
|
||||
}
|
||||
}
|
||||
|
||||
fn undo_steps(s: &Session) -> usize {
|
||||
s.doc().unwrap().history.undo.len()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_o_gets_a_bridge_and_the_original_goes_to_a_hidden_layer() {
|
||||
let mut s = session();
|
||||
let o = letter_o(&mut s);
|
||||
let fill = node(&s, o).appearance.fill_paint();
|
||||
let steps = undo_steps(&s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone(), r["unbridged"].clone()), (json!(1), json!(1), json!(0)));
|
||||
assert!(r.get("warning").is_none(), "{r}");
|
||||
let made = id_of(&r);
|
||||
assert_eq!(s.doc().unwrap().selection.objects, vec![made]);
|
||||
assert_eq!(undo_steps(&s), steps + 1, "one undo step");
|
||||
// The bridge crosses the top bar in the middle; the rest of the O stays, painted as it was.
|
||||
assert!(!fills(&s, made, 150.0, 110.0));
|
||||
assert!(fills(&s, made, 130.0, 110.0) && fills(&s, made, 150.0, 190.0) && fills(&s, made, 110.0, 150.0));
|
||||
assert_eq!(node(&s, made).appearance.fill_paint(), fill);
|
||||
// The original, unchanged, is on a new hidden layer.
|
||||
let layer = NodeId(r["original"].as_u64().unwrap());
|
||||
let l = node(&s, layer);
|
||||
assert_eq!((l.name.as_deref(), l.visible), (Some("Stencil Original"), false));
|
||||
let held = s.doc().unwrap().doc.children(Some(layer)).map(|c| c.iter().map(|n| n.id).collect::<Vec<_>>());
|
||||
assert_eq!(held, Some(vec![o]));
|
||||
// The island is joined to the sheet: the result has none left.
|
||||
let again = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
assert_eq!(again["islands"], json!(0));
|
||||
assert!(again["warning"].as_str().is_some_and(|w| w.contains("no islands")), "{again}");
|
||||
assert_eq!(undo_steps(&s), steps + 1, "no islands: no undo step");
|
||||
// Undo puts the O back where it was and takes the layer away.
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
let d = &s.doc().unwrap().doc;
|
||||
assert!(d.node(layer).is_none() && d.node(made).is_none() && d.node(o).is_some_and(|n| n.visible));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn keep_original_off_replaces_the_art() {
|
||||
let mut s = session();
|
||||
let o = letter_o(&mut s);
|
||||
let layers = s.doc().unwrap().doc.layers.len();
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4, "keepOriginal": false})).unwrap();
|
||||
assert_eq!(r["original"], Value::Null);
|
||||
let d = &s.doc().unwrap().doc;
|
||||
assert!(d.node(o).is_none() && d.node(id_of(&r)).is_some());
|
||||
assert_eq!(d.layers.len(), layers);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_bridge_is_as_wide_as_asked() {
|
||||
for width in [2.0, 8.0] {
|
||||
let mut s = session();
|
||||
letter_o(&mut s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": width})).unwrap();
|
||||
let made = id_of(&r);
|
||||
let half = width / 2.0;
|
||||
assert!(!fills(&s, made, 150.0 - half * 0.9, 110.0) && !fills(&s, made, 150.0 + half * 0.9, 110.0), "{width}");
|
||||
assert!(fills(&s, made, 150.0 - half * 1.2, 110.0) && fills(&s, made, 150.0 + half * 1.2, 110.0), "{width}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_width_takes_units() {
|
||||
let mut s = session();
|
||||
letter_o(&mut s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": "2 mm"})).unwrap();
|
||||
let made = id_of(&r);
|
||||
// 2 mm is about 5.67 pt.
|
||||
assert!(!fills(&s, made, 152.5, 110.0) && fills(&s, made, 154.0, 110.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_shortest_crossing_takes_the_thinnest_bar() {
|
||||
let mut s = session();
|
||||
// The left bar is 5 pt thick, the others 20.
|
||||
shape_with_holes(&mut s, (100.0, 100.0, 100.0, 100.0), &[(105.0, 120.0, 75.0, 60.0)]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4, "direction": "shortest"})).unwrap();
|
||||
let made = id_of(&r);
|
||||
assert!(!fills(&s, made, 102.5, 150.0), "the bridge crosses the thin bar");
|
||||
assert!(fills(&s, made, 150.0, 110.0) && fills(&s, made, 190.0, 150.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn horizontal_bridges_cross_the_sides() {
|
||||
let mut s = session();
|
||||
letter_o(&mut s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4, "direction": "horizontal"})).unwrap();
|
||||
let made = id_of(&r);
|
||||
assert!(!fills(&s, made, 110.0, 150.0) || !fills(&s, made, 190.0, 150.0));
|
||||
assert!(fills(&s, made, 150.0, 110.0) && fills(&s, made, 150.0, 190.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_shape_with_two_holes_gets_a_bridge_for_each() {
|
||||
let mut s = session();
|
||||
shape_with_holes(&mut s, (100.0, 100.0, 100.0, 50.0), &[(110.0, 110.0, 30.0, 30.0), (160.0, 110.0, 30.0, 30.0)]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 3, "count": 2})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone(), r["unbridged"].clone()), (json!(2), json!(4), json!(0)));
|
||||
let made = id_of(&r);
|
||||
for x in [125.0, 175.0] {
|
||||
assert!(!fills(&s, made, x, 105.0) && !fills(&s, made, x, 145.0), "{x}: a bridge above and below each hole");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn type_is_bridged_by_its_glyph_outlines_and_stays_type() {
|
||||
let mut s = session();
|
||||
let t = NodeId(s.execute("text.create", &json!({"x": 100, "y": 300, "text": "O", "size": 144})).unwrap()["id"].as_u64().unwrap());
|
||||
select(&mut s, &[t]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 3})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone(), r["unbridged"].clone()), (json!(1), json!(1), json!(0)), "{r}");
|
||||
assert!(matches!(node(&s, id_of(&r)).kind, NodeKind::Path { .. } | NodeKind::Compound { .. }));
|
||||
// The type itself is not converted: it is on the hidden layer, still type.
|
||||
assert!(matches!(node(&s, t).kind, NodeKind::Text(_)));
|
||||
assert!(!node(&s, NodeId(r["original"].as_u64().unwrap())).visible);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_result_is_painted_as_the_topmost_object_with_outlines() {
|
||||
let mut s = session();
|
||||
let o = letter_o(&mut s);
|
||||
// Type holding only a space draws no outlines, so it does not set the paint, though it is on top.
|
||||
let t = NodeId(s.execute("text.create", &json!({"x": 100, "y": 300, "text": " ", "size": 24})).unwrap()["id"].as_u64().unwrap());
|
||||
select(&mut s, &[o]);
|
||||
s.execute("paint.setFill", &json!({"color": "#ff0000"})).unwrap();
|
||||
let red = node(&s, o).appearance.fill_paint();
|
||||
select(&mut s, &[o, t]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
assert_eq!(node(&s, id_of(&r)).appearance.fill_paint(), red);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hidden_members_of_a_group_are_left_out() {
|
||||
let mut s = session();
|
||||
let o = letter_o(&mut s);
|
||||
// A hidden square that would fill the O's hole, grouped with it.
|
||||
let cover = rect(&mut s, 120.0, 120.0, 60.0, 60.0);
|
||||
select(&mut s, &[o, cover]);
|
||||
let g = NodeId(s.execute("object.group", &json!({})).unwrap()["id"].as_u64().unwrap());
|
||||
select(&mut s, &[cover]);
|
||||
s.execute("object.hide", &json!({})).unwrap();
|
||||
select(&mut s, &[g]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone()), (json!(1), json!(1)), "{r}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn art_without_islands_changes_nothing() {
|
||||
let mut s = session();
|
||||
let a = rect(&mut s, 100.0, 100.0, 50.0, 50.0);
|
||||
select(&mut s, &[a]);
|
||||
let (steps, count) = (undo_steps(&s), s.doc().unwrap().doc.node_count());
|
||||
let r = s.execute("addon.cutting.bridges", &json!({})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone(), r["id"].clone()), (json!(0), json!(0), Value::Null));
|
||||
assert!(r["warning"].as_str().is_some(), "{r}");
|
||||
assert_eq!((undo_steps(&s), s.doc().unwrap().doc.node_count()), (steps, count));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_island_too_narrow_for_the_width_is_reported() {
|
||||
let mut s = session();
|
||||
shape_with_holes(&mut s, (100.0, 100.0, 100.0, 100.0), &[(149.0, 120.0, 2.0, 60.0)]);
|
||||
let steps = undo_steps(&s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone(), r["unbridged"].clone()), (json!(1), json!(0), json!(1)));
|
||||
assert!(r["warning"].as_str().is_some_and(|w| w.contains("No bridge")), "{r}");
|
||||
assert_eq!(undo_steps(&s), steps);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn islands_left_without_a_bridge_are_reported_beside_the_ones_bridged() {
|
||||
let mut s = session();
|
||||
// A wide hole on the left and a 2 pt slot on the right.
|
||||
shape_with_holes(&mut s, (100.0, 100.0, 200.0, 100.0), &[(120.0, 120.0, 60.0, 60.0), (249.0, 120.0, 2.0, 60.0)]);
|
||||
let steps = undo_steps(&s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
assert_eq!((r["islands"].clone(), r["bridges"].clone(), r["unbridged"].clone()), (json!(2), json!(1), json!(1)));
|
||||
assert!(r["warning"].as_str().is_some_and(|w| w.contains("could not be joined")), "{r}");
|
||||
assert_eq!(undo_steps(&s), steps + 1);
|
||||
assert!(!fills(&s, id_of(&r), 150.0, 110.0), "the wide hole is bridged");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn each_run_keeps_its_original_on_a_layer_of_its_own() {
|
||||
let mut s = session();
|
||||
letter_o(&mut s);
|
||||
let first = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
shape_with_holes(&mut s, (300.0, 100.0, 100.0, 100.0), &[(320.0, 120.0, 60.0, 60.0)]);
|
||||
let second = s.execute("addon.cutting.bridges", &json!({"width": 4})).unwrap();
|
||||
let name = |r: &Value| node(&s, NodeId(r["original"].as_u64().unwrap())).name;
|
||||
assert_eq!((name(&first).as_deref(), name(&second).as_deref()), (Some("Stencil Original"), Some("Stencil Original 2")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bad_params_are_refused() {
|
||||
let mut s = session();
|
||||
letter_o(&mut s);
|
||||
let steps = undo_steps(&s);
|
||||
for (key, p) in [
|
||||
("width", json!({"width": 0})),
|
||||
("width", json!({"width": 5000})),
|
||||
("width", json!({"width": "wide"})),
|
||||
("count", json!({"count": 0})),
|
||||
("count", json!({"count": 1.5})),
|
||||
("count", json!({"count": 17})),
|
||||
("count", json!({"count": "two"})),
|
||||
("direction", json!({"direction": "diagonal"})),
|
||||
("direction", json!({"direction": 90})),
|
||||
("keepOriginal", json!({"keepOriginal": "yes"})),
|
||||
] {
|
||||
let e = s.execute("addon.cutting.bridges", &p).unwrap_err().to_string();
|
||||
assert!(e.contains(key), "{p}: {e}");
|
||||
}
|
||||
assert_eq!(undo_steps(&s), steps);
|
||||
assert!(s.execute("addon.cutting.bridges", &json!({"width": 4})).is_ok(), "good params run");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn selected_objects_without_outlines_stay_where_they_are() {
|
||||
for keep in [true, false] {
|
||||
let mut s = session();
|
||||
let o = letter_o(&mut s);
|
||||
// Type holding only a space has no outlines.
|
||||
let t = NodeId(s.execute("text.create", &json!({"x": 100, "y": 300, "text": " ", "size": 24})).unwrap()["id"].as_u64().unwrap());
|
||||
let layer = |s: &Session, id: NodeId| s.doc().unwrap().doc.layer_of(id);
|
||||
let before = layer(&s, t);
|
||||
select(&mut s, &[o, t]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4, "keepOriginal": keep})).unwrap();
|
||||
assert_eq!(r["bridges"], json!(1), "{r}");
|
||||
assert!(node(&s, t).visible && layer(&s, t) == before, "keep {keep}: the type stays where it was");
|
||||
if keep {
|
||||
let held =
|
||||
s.doc().unwrap().doc.children(Some(NodeId(r["original"].as_u64().unwrap()))).map(|c| c.iter().map(|n| n.id).collect::<Vec<_>>());
|
||||
assert_eq!(held, Some(vec![o]));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_result_takes_the_place_of_the_topmost_selected_object() {
|
||||
let mut s = session();
|
||||
let o = letter_o(&mut s);
|
||||
let between = rect(&mut s, 400.0, 100.0, 50.0, 50.0);
|
||||
let o2 = shape_with_holes(&mut s, (500.0, 100.0, 100.0, 100.0), &[(520.0, 120.0, 60.0, 60.0)]);
|
||||
let above = rect(&mut s, 400.0, 300.0, 50.0, 50.0);
|
||||
select(&mut s, &[o, o2]);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4, "keepOriginal": false})).unwrap();
|
||||
let made = id_of(&r);
|
||||
let d = &s.doc().unwrap().doc;
|
||||
let order: Vec<NodeId> = d.children(d.layer_of(made)).unwrap().iter().map(|n| n.id).collect();
|
||||
let at = |id: NodeId| order.iter().position(|i| *i == id).unwrap();
|
||||
assert!(at(between) < at(made) && at(made) < at(above), "{order:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_result_is_one_path_when_one_outline_is_left() {
|
||||
for (count, plain) in [(1, true), (2, false)] {
|
||||
let mut s = session();
|
||||
letter_o(&mut s);
|
||||
let r = s.execute("addon.cutting.bridges", &json!({"width": 4, "count": count})).unwrap();
|
||||
let kind = node(&s, id_of(&r)).kind;
|
||||
// One bridge leaves a C, one outline; two leave two pieces.
|
||||
assert_eq!(matches!(kind, NodeKind::Path { .. }), plain, "count {count}");
|
||||
assert_eq!(matches!(kind, NodeKind::Compound { .. }), !plain, "count {count}");
|
||||
}
|
||||
}
|
||||
@@ -21,7 +21,7 @@ use super::super::menucmds::whole_or;
|
||||
use super::super::object::choice;
|
||||
use super::super::textedit::{CharChange, text_mut, text_ref, type_ranges};
|
||||
use super::super::typecmd::refresh_bounds;
|
||||
use super::super::typemenu::text_ids;
|
||||
use super::super::typemenu::{bake_dynamic_text, text_ids};
|
||||
use super::super::{CommandSpec, bad, cmd, has_selection, number_or, switch_or, targets};
|
||||
use crate::{EngineError, Result, Session};
|
||||
|
||||
@@ -61,7 +61,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Release Type on a Path…",
|
||||
["Object", "Plug-ins", "Type Tools"],
|
||||
None,
|
||||
"{mode?: \"both\" (point type and the path) | \"path\" (the path only) | \"text\" (point type only) (\"both\"), keepOriginal?: false (true: the type on a path stays and the released objects go just above it), ids?: [id…], id? (instead of ids; neither: the selection)} split each type on a path among the objects (inside groups too) into point type and the path it was set on. The point type holds the same text with the same character and paragraph attributes, on one straight line whose baseline starts where the first character sat on the path; Type on a Path Options (effect, align to path, spacing, flip, brackets) don't apply to point type and are dropped. The path keeps its exact shape (open or closed, anchors and handles, the object's transform) and comes out with no fill and no stroke, in the type's layer and place in the stacking order. Other objects are left alone, and with no type on a path among them nothing changes and no undo step is made. One undo step; the released objects are selected → {ids (released, bottom to top), paths, texts}",
|
||||
"{mode?: \"both\" (point type and the path) | \"path\" (the path only) | \"text\" (point type only) (\"both\"), keepOriginal?: false (true: the type on a path stays and the released objects go just above it), ids?: [id…], id? (instead of ids; neither: the selection)} split each type on a path among the objects (inside groups too) into point type and the path it was set on. The point type holds the same text with the same character and paragraph attributes, on one straight line whose baseline starts where the first character sat on the path; Type on a Path Options (effect, align to path, spacing, flip, brackets) don't apply to point type and are dropped; type with Dynamic Text on (type.dynamicText) comes out with it off, at the sizes it was drawn at. The path keeps its exact shape (open or closed, anchors and handles, the object's transform) and comes out with no fill and no stroke, in the type's layer and place in the stacking order. Other objects are left alone, and with no type on a path among them nothing changes and no undo step is made. One undo step; the released objects are selected → {ids (released, bottom to top), paths, texts}",
|
||||
has_selection,
|
||||
release_path
|
||||
),
|
||||
@@ -230,8 +230,9 @@ fn first_pen(lay: &vectorcraft_text::TextLayout) -> Option<Point> {
|
||||
|
||||
/// `t`, type on a path, as point type on one straight line: the same runs and character and
|
||||
/// paragraph attributes, its baseline starting where its first character sat on the path (in the
|
||||
/// object's own text space, so its transform stays). Type on a Path Options are dropped. None for
|
||||
/// other type, or when it can't be placed.
|
||||
/// object's own text space, so its transform stays). Type on a Path Options are dropped, and
|
||||
/// Dynamic Text is turned off at the sizes it draws the text at. None for other type, or when it
|
||||
/// can't be placed.
|
||||
fn released_text(t: &TextObject) -> Option<TextObject> {
|
||||
let TextKind::OnPath { path, .. } = &t.kind else { return None };
|
||||
let db = vectorcraft_text::FontDb::global();
|
||||
@@ -244,6 +245,8 @@ fn released_text(t: &TextObject) -> Option<TextObject> {
|
||||
(p.x.is_finite() && p.y.is_finite()).then_some(p)
|
||||
})?;
|
||||
let mut out = t.clone();
|
||||
// Point type has no brackets to fit: it keeps the sizes the path drew it at.
|
||||
bake_dynamic_text(&mut out);
|
||||
out.kind = TextKind::Point;
|
||||
out.path_effect = Default::default();
|
||||
out.path_align = Default::default();
|
||||
|
||||
@@ -32,8 +32,8 @@ use super::opacitymask::percent;
|
||||
use super::paint::paint_from;
|
||||
use super::{AppearanceAttrs, EyedropperAttrs, FillAttrs, StrokeAttrs};
|
||||
use super::{
|
||||
CommandSpec, NodeId, Result, Session, bad, check_numbers, check_switches, cmd, has_doc, has_selection, id_param, ids_param, index, leaf_targets,
|
||||
ok, paint_targets, str_param, switch_or, targets,
|
||||
CommandSpec, NodeId, Result, Session, bad, check_numbers, check_switches, cmd, has_doc, has_selection, ids_param, index, leaf_targets,
|
||||
object_param, ok, paint_targets, str_param, switch_or, targets,
|
||||
};
|
||||
use crate::EngineError;
|
||||
|
||||
@@ -726,8 +726,8 @@ fn clear(n: &mut Node) {
|
||||
|
||||
fn transfer(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "appearance.transfer";
|
||||
let source = id_param(p, "source").ok_or_else(|| bad(C, "missing `source` id"))?;
|
||||
let target = id_param(p, "target").ok_or_else(|| bad(C, "missing `target` id"))?;
|
||||
let source = object_param(p, "source", C)?.ok_or_else(|| bad(C, "missing `source` id"))?;
|
||||
let target = object_param(p, "target", C)?.ok_or_else(|| bad(C, "missing `target` id"))?;
|
||||
if source == target {
|
||||
return Err(bad(C, "`source` and `target` are the same object"));
|
||||
}
|
||||
@@ -1201,7 +1201,7 @@ fn target_contents(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
/// Sample enabled attributes with transform-aware character dimensions and atomic validation.
|
||||
fn copy_from(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "appearance.copyFrom";
|
||||
let clicked = id_param(p, "source").ok_or_else(|| bad(C, "missing `source` id"))?;
|
||||
let clicked = object_param(p, "source", C)?.ok_or_else(|| bad(C, "missing `source` id"))?;
|
||||
let (reverse, append) = (switch_or(p, "reverse", false, C)?, switch_or(p, "append", false, C)?);
|
||||
let defaults_only = switch_or(p, "defaultsOnly", false, C)?;
|
||||
if defaults_only && (reverse || append || p.get("ids").is_some()) {
|
||||
@@ -1512,6 +1512,9 @@ impl Picked {
|
||||
stroke_width: st.stroke_width,
|
||||
overprint_fill: st.overprint_fill,
|
||||
overprint_stroke: st.overprint_stroke,
|
||||
// The space before a line's first character belongs to where the character is,
|
||||
// not to how it looks: a sample from one doesn't move the target's (#5111).
|
||||
kerning_before: st.kerning_before,
|
||||
..cs.clone()
|
||||
};
|
||||
}
|
||||
|
||||
@@ -11,7 +11,9 @@ use std::collections::HashSet;
|
||||
use std::sync::{Arc, LazyLock};
|
||||
|
||||
use serde_json::{Value, json};
|
||||
use vectorcraft_brush::{self as brush, ArtBrush, Brush, BrushKind, Calligraphic, Colorization, PatternBrush, PatternFit, Scatter, Variation};
|
||||
use vectorcraft_brush::{
|
||||
self as brush, ArtBrush, Bristle, BristleShape, Brush, BrushKind, Calligraphic, Colorization, PatternBrush, PatternFit, Scatter, Variation,
|
||||
};
|
||||
use vectorcraft_color::{Color, Paint};
|
||||
use vectorcraft_doc::{Appearance, AppearanceItem, Document, FillLayer, Node, NodeId, NodeKind, PatternDef, Symbol};
|
||||
use vectorcraft_geom::{Affine, FillRule, PathData, Point, Rect, SubPath, shapes};
|
||||
@@ -169,6 +171,7 @@ pub struct BuiltinBrushLibrary {
|
||||
pub const BUILTIN: &[BuiltinBrushLibrary] = &[
|
||||
BuiltinBrushLibrary { id: "art-ribbons", name: "Art Ribbons", make: art_ribbons },
|
||||
BuiltinBrushLibrary { id: "calligraphic-nibs", name: "Calligraphic Nibs", make: calligraphic_nibs },
|
||||
BuiltinBrushLibrary { id: "bristle-brushes", name: "Bristle Brushes", make: bristle_brushes },
|
||||
BuiltinBrushLibrary { id: "pattern-borders", name: "Pattern Borders", make: pattern_borders },
|
||||
BuiltinBrushLibrary { id: "scatter-shapes", name: "Scatter Shapes", make: scatter_shapes },
|
||||
BuiltinBrushLibrary { id: "game-trails", name: "Game Trails", make: game_trails },
|
||||
@@ -291,6 +294,31 @@ fn calligraphic_nibs() -> BrushLibrary {
|
||||
built("Calligraphic Nibs", Document::new(100.0, 100.0), brushes)
|
||||
}
|
||||
|
||||
/// A bristle brush: `shape`, then size (pt), bristle length, density, thickness, paint opacity
|
||||
/// and stiffness (%).
|
||||
fn bristle(name: &str, shape: BristleShape, [size, length, density, thickness, opacity, stiffness]: [f64; 6]) -> Brush {
|
||||
Brush { name: name.into(), kind: BrushKind::Bristle(Bristle { shape, size, length, density, thickness, opacity, stiffness }) }
|
||||
}
|
||||
|
||||
/// Bristle Brushes: one bristle brush for each tip shape, from a fine liner to wide fans for
|
||||
/// blending and texture.
|
||||
fn bristle_brushes() -> BrushLibrary {
|
||||
use BristleShape::*;
|
||||
let brushes = vec![
|
||||
bristle("Fine Liner", RoundPoint, [2.0, 140.0, 30.0, 30.0, 90.0, 75.0]),
|
||||
bristle("Pointed Flat", FlatPoint, [5.0, 120.0, 55.0, 35.0, 80.0, 60.0]),
|
||||
bristle("Stubby Round", RoundBlunt, [8.0, 60.0, 70.0, 50.0, 85.0, 80.0]),
|
||||
bristle("Dry Scrub", FlatBlunt, [10.0, 40.0, 25.0, 60.0, 60.0, 95.0]),
|
||||
bristle("Soft Dome", RoundCurve, [12.0, 160.0, 85.0, 20.0, 45.0, 25.0]),
|
||||
bristle("Filbert", FlatCurve, [9.0, 110.0, 65.0, 40.0, 70.0, 45.0]),
|
||||
bristle("Angled Round", RoundAngle, [7.0, 130.0, 50.0, 35.0, 75.0, 55.0]),
|
||||
bristle("Angled Flat", FlatAngle, [11.0, 100.0, 60.0, 45.0, 80.0, 65.0]),
|
||||
bristle("Fan Blender", RoundFan, [16.0, 220.0, 40.0, 15.0, 35.0, 20.0]),
|
||||
bristle("Grass Fan", FlatFan, [20.0, 260.0, 15.0, 25.0, 65.0, 35.0]),
|
||||
];
|
||||
built("Bristle Brushes", Document::new(100.0, 100.0), brushes)
|
||||
}
|
||||
|
||||
fn border(name: &str, side: Node, corner: Option<Node>, fit: PatternFit) -> Brush {
|
||||
let kind = BrushKind::Pattern(PatternBrush { side, outer_corner: corner.clone(), inner_corner: corner, fit, ..Default::default() });
|
||||
Brush { name: name.into(), kind }
|
||||
|
||||
@@ -34,9 +34,9 @@ mod symbols;
|
||||
pub(crate) use brushes::{apply_brush, brush_targets, stroke_paint};
|
||||
use brushes::{
|
||||
brush_apply, brush_delete, brush_duplicate, brush_freehand, brush_get, brush_list, brush_move, brush_new, brush_options, brush_place_art,
|
||||
brush_remove, brush_selection_art, brush_set_current, brush_unused, expand_brush,
|
||||
brush_remove, brush_replace_art, brush_selection_art, brush_set_current, brush_unused, expand_brush,
|
||||
};
|
||||
pub(crate) use dynamic::{edit_part, part_only, selected_part};
|
||||
pub(crate) use dynamic::{edit_part, fit_parts, part_only, selected_part};
|
||||
use dynamic::{symbol_instance_reset, symbol_instance_select_part, symbol_instance_set_appearance};
|
||||
use symbols::selected_instances;
|
||||
pub(crate) use symbols::{
|
||||
@@ -76,6 +76,15 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
has_doc,
|
||||
brush_place_art
|
||||
),
|
||||
cmd!(
|
||||
"brush.replaceArt",
|
||||
"Replace Brush Art",
|
||||
[],
|
||||
None,
|
||||
"{name, ids?|id?, applyToStrokes?: true} make the selected art (several objects become one group, as in brush.new) the art of a scatter, art or pattern brush, keeping its other options, as Alt-dragging (Option-dragging on macOS) art onto the brush in the Brushes panel does; a pattern brush takes a group named for one of its tiles, or a group of such groups (as brush.placeArt places them), tile by tile (of two named for one tile, the frontmost), each with the repeat frame an unpainted rectangle at its back marks (other tiles stay as they are), and other art as its side tile; when strokes use the brush and applyToStrokes is false, the brush and its strokes stay as they were and a copy of the brush with the new art, named `<name> copy`, goes after it and becomes the current brush; otherwise the strokes redraw with the new art; one undo step; refused for a calligraphic or bristle brush, with nothing selected, and for art (or a tile) with no width → {name: the brush that has the new art}",
|
||||
has_doc,
|
||||
brush_replace_art
|
||||
),
|
||||
cmd!(
|
||||
"brush.apply",
|
||||
"Apply Brush",
|
||||
|
||||
@@ -239,7 +239,7 @@ pub(super) fn brush_new(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
&& v.get(k).is_none()
|
||||
{
|
||||
let art = selection_art(s, p)?.ok_or_else(|| bad(C, format!("{ty} brushes need selected art (or params.{k})")))?;
|
||||
if art.geometric_bounds().is_none_or(|b| b.width() <= 1e-6) {
|
||||
if !has_width(&art, &s.doc()?.doc.symbol_boxes()) {
|
||||
return Err(bad(C, "the selected art has no width"));
|
||||
}
|
||||
v[k] = serde_json::to_value(&art).unwrap_or_default();
|
||||
@@ -249,6 +249,12 @@ pub(super) fn brush_new(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
Ok(json!({ "name": name }))
|
||||
}
|
||||
|
||||
/// Whether art `n` has width for a brush to be made of, with symbol instances measured by their
|
||||
/// symbols' art in `symbols`.
|
||||
fn has_width(n: &Node, symbols: &vectorcraft_doc::SymbolBoxes) -> bool {
|
||||
n.geometric_bounds_with(symbols).is_some_and(|b| b.width() > 1e-6)
|
||||
}
|
||||
|
||||
/// Refuses `name` for a bristle brush when it has more than [`Bristle::MAX_NAME_CHARS`] characters.
|
||||
fn bristle_name_fits(cmd: &str, name: &str) -> Result<()> {
|
||||
let (count, max) = (name.chars().count(), Bristle::MAX_NAME_CHARS);
|
||||
@@ -367,6 +373,12 @@ fn art_brushes(n: &Node, out: &mut Vec<String>) {
|
||||
pub(super) fn brush_unused(s: &mut Session, _: &Value) -> Result<Value> {
|
||||
let d = &s.doc()?.doc;
|
||||
let lib = brush::library(d);
|
||||
let names = brush_unused_in(d, &lib);
|
||||
Ok(json!({ "names": names }))
|
||||
}
|
||||
|
||||
/// The brushes of `lib` no stroke in `d` paints with, in library order ([`brush_unused`]).
|
||||
fn brush_unused_in(d: &Document, lib: &[Brush]) -> Vec<String> {
|
||||
let mut todo = vec![];
|
||||
let trees = d.layers.iter().chain(d.symbols.iter().map(|s| &s.art)).chain(d.graph_designs.iter().map(|g| &g.art));
|
||||
let patterns = d.patterns.iter().chain(d.pattern_edit.iter().filter_map(|pe| pe.original.as_ref()));
|
||||
@@ -379,8 +391,7 @@ pub(super) fn brush_unused(s: &mut Session, _: &Value) -> Result<Value> {
|
||||
used.insert(name);
|
||||
}
|
||||
}
|
||||
let names: Vec<&str> = lib.iter().map(|b| b.name.as_str()).filter(|n| !used.contains(*n)).collect();
|
||||
Ok(json!({ "names": names }))
|
||||
lib.iter().map(|b| b.name.clone()).filter(|n| !used.contains(n)).collect()
|
||||
}
|
||||
|
||||
pub(super) fn brush_options(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
@@ -484,7 +495,7 @@ pub(super) fn brush_options(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
}
|
||||
|
||||
/// The name `brush.placeArt` gives each pattern brush tile it places, by tile, in the order it
|
||||
/// places them.
|
||||
/// places them; `brush.replaceArt` reads a group of that name as that tile.
|
||||
const TILE_NAMES: [&str; 5] = ["Side Tile", "Outer Corner Tile", "Inner Corner Tile", "Start Tile", "End Tile"];
|
||||
|
||||
/// The space between the pattern brush tiles `brush.placeArt` places, in points.
|
||||
@@ -506,6 +517,18 @@ fn tile(p: &brush::PatternBrush, i: usize) -> Option<(&Node, Option<vectorcraft_
|
||||
}
|
||||
}
|
||||
|
||||
/// Gives tile `i` of `p` ([`TILE_NAMES`] order) the art `art` and the repeat frame `frame`. The tile
|
||||
/// no longer comes from a pattern swatch, and a corner draws its own art.
|
||||
fn set_tile(p: &mut brush::PatternBrush, i: usize, art: Node, frame: Option<vectorcraft_geom::Rect>) {
|
||||
match i {
|
||||
0 => (p.side, p.side_frame, p.side_swatch) = (art, frame, None),
|
||||
1 => (p.outer_corner, p.outer_corner_frame, p.outer_corner_swatch, p.outer_source) = (Some(art), frame, None, None),
|
||||
2 => (p.inner_corner, p.inner_corner_frame, p.inner_corner_swatch, p.inner_source) = (Some(art), frame, None, None),
|
||||
3 => (p.start, p.start_frame, p.start_swatch) = (Some(art), frame, None),
|
||||
_ => (p.end, p.end_frame, p.end_swatch) = (Some(art), frame, None),
|
||||
}
|
||||
}
|
||||
|
||||
/// The art `brush.placeArt` places for brush `b`, in the brush's own coordinates: a scatter or art
|
||||
/// brush's art, or a pattern brush's tiles in a row, each in a group named for its tile
|
||||
/// ([`TILE_NAMES`]), with an unpainted rectangle at the back of a tile that has a repeat frame
|
||||
@@ -570,6 +593,118 @@ pub(super) fn brush_place_art(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
Ok(json!({ "id": id.0 }))
|
||||
}
|
||||
|
||||
/// The repeat frame an unpainted rectangle at the back of a tile group marks ([`placed_art`]): the
|
||||
/// rectangle's bounds, when `n` is a path of one closed subpath through the four corners of its
|
||||
/// bounds, without curves, whose fills and strokes paint nothing and that has no other appearance.
|
||||
fn frame_marker(n: &Node) -> Option<vectorcraft_geom::Rect> {
|
||||
let NodeKind::Path { path, guide: false, clipping: false, .. } = &n.kind else { return None };
|
||||
let unpainted = n.appearance.effects.is_empty()
|
||||
&& n.appearance.items.iter().all(|i| match i {
|
||||
AppearanceItem::Fill(f) => f.paint.is_none(),
|
||||
AppearanceItem::Stroke(st) => st.paint.is_none(),
|
||||
});
|
||||
let [sp] = path.subpaths.as_slice() else { return None };
|
||||
let r = n.geometric_bounds()?;
|
||||
let corners = [(r.x0, r.y0), (r.x1, r.y0), (r.x1, r.y1), (r.x0, r.y1)];
|
||||
let at_corners = sp.anchors.len() == 4
|
||||
&& sp.anchors.iter().all(|a| a.h_in == a.p && a.h_out == a.p)
|
||||
&& corners.iter().all(|c| sp.anchors.iter().any(|a| (a.p.x, a.p.y) == *c));
|
||||
(unpainted && sp.closed && at_corners && r.width() > 1e-9 && r.height() > 1e-9).then_some(r)
|
||||
}
|
||||
|
||||
/// The tiles in `art` for a pattern brush, by tile ([`TILE_NAMES`] order), with their repeat frames:
|
||||
/// a group named for a tile, as `brush.placeArt` places them, is the art of its tile (an unpainted
|
||||
/// rectangle at its back marks the tile's frame, [`frame_marker`], and is left out of the art; a
|
||||
/// group left with one member gives that member), and so is each member of a group whose members
|
||||
/// are all such groups; any other art is the side tile.
|
||||
fn tiles_of(art: Node) -> Vec<(usize, Node, Option<vectorcraft_geom::Rect>)> {
|
||||
let named = |c: &Node| matches!(c.kind, NodeKind::Group { clip: false, .. }) && c.name.as_deref().is_some_and(|n| TILE_NAMES.contains(&n));
|
||||
let tiles = match &art.kind {
|
||||
_ if named(&art) => vec![Arc::new(art)],
|
||||
NodeKind::Group { children, clip: false } if !children.is_empty() && children.iter().all(|c| named(c)) => children.clone(),
|
||||
_ => return vec![(0, art, None)],
|
||||
};
|
||||
let mut out: Vec<(usize, Node, Option<vectorcraft_geom::Rect>)> = vec![];
|
||||
for t in tiles {
|
||||
let Some(i) = t.name.as_deref().and_then(|n| TILE_NAMES.iter().position(|x| *x == n)) else { continue };
|
||||
let mut g = (*t).clone();
|
||||
let mut frame = None;
|
||||
if let NodeKind::Group { children, .. } = &mut g.kind
|
||||
&& let Some(f) = children.first().and_then(|c| frame_marker(c))
|
||||
{
|
||||
frame = Some(f);
|
||||
children.remove(0);
|
||||
}
|
||||
g.name = None;
|
||||
// The group `brush.placeArt` put around the tile's art: the art itself goes back, so a
|
||||
// tile does not gain a group each time it goes out and back.
|
||||
if let NodeKind::Group { children, clip: false } = &g.kind
|
||||
&& let [only] = children.as_slice()
|
||||
&& g == Node::group(g.id, children.clone())
|
||||
{
|
||||
g = (**only).clone();
|
||||
}
|
||||
// A tile named twice: the frontmost one counts.
|
||||
out.retain(|(j, ..)| *j != i);
|
||||
out.push((i, g, frame));
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// `brush.replaceArt`: the selected art (or `ids`/`id`; several objects become one group, as in
|
||||
/// `brush.new`) becomes the art of scatter, art or pattern brush `name`, keeping its other options,
|
||||
/// as one undo step. A pattern brush takes the tiles `brush.placeArt` places by their names
|
||||
/// ([`tiles_of`]) and other art as its side tile. When strokes use the brush and `applyToStrokes` is
|
||||
/// false, the brush and its strokes stay as they were and a copy of the brush with the new art is
|
||||
/// added after it and becomes the current brush; otherwise the strokes redraw with the new art.
|
||||
pub(super) fn brush_replace_art(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "brush.replaceArt";
|
||||
let name = name_param(p, C)?.to_string();
|
||||
let apply = super::switch_or(p, "applyToStrokes", true, C)?;
|
||||
let mut lib = brush::library(&s.doc()?.doc);
|
||||
let i = lib.iter().position(|b| b.name == name).ok_or_else(|| bad(C, format!("no brush named `{name}`")))?;
|
||||
if lib[i].art().is_empty() {
|
||||
return Err(bad(C, no_art(&name)));
|
||||
}
|
||||
let art = selection_art(s, p)?.ok_or_else(|| bad(C, "nothing selected"))?;
|
||||
let d = &s.doc()?.doc;
|
||||
let symbols = d.symbol_boxes();
|
||||
let check = |n: &Node| if has_width(n, &symbols) { Ok(()) } else { Err(bad(C, "the selected art has no width")) };
|
||||
let mut b = lib[i].clone();
|
||||
match &mut b.kind {
|
||||
BrushKind::Scatter(sc) => {
|
||||
check(&art)?;
|
||||
sc.art = art;
|
||||
}
|
||||
BrushKind::Art(a) => {
|
||||
check(&art)?;
|
||||
a.art = art;
|
||||
}
|
||||
BrushKind::Pattern(pb) => {
|
||||
for (t, art, frame) in tiles_of(art) {
|
||||
check(&art)?;
|
||||
set_tile(pb, t, art, frame);
|
||||
}
|
||||
}
|
||||
BrushKind::Calligraphic(_) | BrushKind::Bristle(_) => return Err(bad(C, no_art(&name))),
|
||||
}
|
||||
let used = !brush_unused_in(d, &lib).contains(&name);
|
||||
if apply || !used {
|
||||
lib[i] = b;
|
||||
save_library(s, "Replace Brush Art", lib, &[])?;
|
||||
return Ok(json!({ "name": name }));
|
||||
}
|
||||
b.name = brush::unique_name(&lib, &format!("{} copy", name.trim()));
|
||||
let copy = b.name.clone();
|
||||
lib.insert(i + 1, b);
|
||||
s.edit("Replace Brush Art", |d, _| {
|
||||
d.unknown.insert(brush::CURRENT_KEY.into(), json!(copy));
|
||||
brush::store(d, &lib);
|
||||
Ok(())
|
||||
})?;
|
||||
Ok(json!({ "name": copy }))
|
||||
}
|
||||
|
||||
pub(super) fn expand_brush(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let ids = brush_targets(&s.doc()?.doc, &roots(s, p)?);
|
||||
let ids: Vec<NodeId> = ids.into_iter().filter(|id| s.doc().ok().and_then(|st| st.doc.node(*id)).is_some_and(brush::has_brush)).collect();
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//! appearance of objects in the symbol's art and stays linked to the symbol
|
||||
//! (`symbol.instance.setAppearance`, `symbol.instance.reset`). The changes live on the instance
|
||||
//! ([`vectorcraft_doc::symbol_overrides`]); editing the symbol keeps those whose object is still
|
||||
//! there ([`fit_overrides`]).
|
||||
//! there and draws them ([`fit_overrides`]).
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
@@ -27,7 +27,7 @@ pub(super) fn type_id(dynamic: bool) -> &'static str {
|
||||
}
|
||||
|
||||
/// Fit the appearance changes of instances `ids` to their symbols: an instance of a static (or
|
||||
/// missing) symbol keeps none, an instance of a dynamic one those naming an object of its art.
|
||||
/// missing) symbol keeps none, an instance of a dynamic one those its art still draws ([`fit_parts`]).
|
||||
pub(super) fn fit_overrides(d: &mut Document, ids: &[NodeId]) {
|
||||
for id in ids {
|
||||
let art = match d.node(*id) {
|
||||
@@ -40,7 +40,7 @@ pub(super) fn fit_overrides(d: &mut Document, ids: &[NodeId]) {
|
||||
let Some(n) = d.node_mut(*id) else { continue };
|
||||
let mut e = n.extras_mut();
|
||||
match art {
|
||||
Some(art) => symbol_overrides::retain_parts(&mut e.symbol_overrides, &art),
|
||||
Some(art) => fit_parts(&mut e.symbol_overrides, &art),
|
||||
None => e.symbol_overrides.clear(),
|
||||
}
|
||||
}
|
||||
@@ -177,17 +177,42 @@ fn check_paint_kinds(p: &Value, art: &Node, path: &[u32], cmd: &str) -> Result<(
|
||||
fn solid_fill_check(p: &Value, art: &Node, path: &[u32], fill: Option<&vectorcraft_color::Paint>, cmd: &str) -> Result<()> {
|
||||
let asked = p.get("fill").is_some_and(|v| !v.is_null());
|
||||
let is_instance = symbol_overrides::part(art, path).is_some_and(|n| matches!(n.kind, NodeKind::SymbolInstance { .. }));
|
||||
let draws_nothing = |f: &vectorcraft_color::Paint| match f {
|
||||
vectorcraft_color::Paint::Gradient(_) => true,
|
||||
vectorcraft_color::Paint::Pattern { .. } => true,
|
||||
vectorcraft_color::Paint::None | vectorcraft_color::Paint::Solid { .. } => false,
|
||||
};
|
||||
if asked && is_instance && fill.is_some_and(draws_nothing) {
|
||||
if asked && is_instance && fill.is_some_and(|f| !stains(f)) {
|
||||
return Err(bad(cmd, "fill on a symbol instance must be a solid color or none"));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Can a symbol instance's fill be `f`? An instance stains its art with a solid fill only.
|
||||
fn stains(f: &vectorcraft_color::Paint) -> bool {
|
||||
match f {
|
||||
vectorcraft_color::Paint::Gradient(_) => false,
|
||||
vectorcraft_color::Paint::Pattern { .. } => false,
|
||||
vectorcraft_color::Paint::None | vectorcraft_color::Paint::Solid { .. } => true,
|
||||
}
|
||||
}
|
||||
|
||||
/// Keep the appearance changes `overrides` that name an object of `art` (a symbol's new art), each
|
||||
/// without a fill or stroke that object does not draw ([`paint_refusal`], [`stains`]); a change
|
||||
/// left with nothing in it is dropped.
|
||||
pub(crate) fn fit_parts(overrides: &mut Vec<SymbolOverride>, art: &Node) {
|
||||
symbol_overrides::retain_parts(overrides, art);
|
||||
for o in overrides.iter_mut() {
|
||||
let Some(n) = symbol_overrides::part(art, &o.path) else { continue };
|
||||
let instance = matches!(n.kind, NodeKind::SymbolInstance { .. });
|
||||
if paint_refusal(n, "fill", FIT).is_some() || (instance && o.fill.as_ref().is_some_and(|f| !stains(f))) {
|
||||
o.fill = None;
|
||||
}
|
||||
if paint_refusal(n, "stroke", FIT).is_some() {
|
||||
o.stroke = None;
|
||||
}
|
||||
}
|
||||
overrides.retain(|o| !o.is_empty());
|
||||
}
|
||||
|
||||
/// The command name [`fit_parts`] gives [`paint_refusal`], whose refusal it does not show.
|
||||
const FIT: &str = "symbol.update";
|
||||
|
||||
/// `fill` or `stroke` of `p` for override `o`: absent leaves it, null clears it, a colour string or
|
||||
/// an object of `paint.setFill`'s paint params sets it.
|
||||
fn paint_change(s: &Session, p: &Value, key: &str, cmd: &str) -> Result<Option<Option<vectorcraft_color::Paint>>> {
|
||||
|
||||
@@ -29,8 +29,8 @@ use super::edit::{outermost, selected_roots};
|
||||
use super::paint::paint_from;
|
||||
use super::pathops::{Beside, shape_node};
|
||||
use super::{
|
||||
CommandSpec, EngineError, Result, Session, always, bad, check_numbers, cmd, color_value, f64_or, finite_numbers, has_doc, id_param, named_ids,
|
||||
number_or, point_param, str_param, switch_or,
|
||||
CommandSpec, EngineError, Result, Session, always, bad, check_numbers, cmd, color_value, f64_or, finite_numbers, has_doc, named_ids, number_or,
|
||||
object_param, point_param, str_param, switch_or,
|
||||
};
|
||||
|
||||
mod live_paint;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
use super::{
|
||||
Appearance, Arc, Beside, Document, EDGE_NAME, EngineError, FACE_NAME, GapOptions, GapSize, LIVE_PAINT_NAME, Node, NodeId, Paint, PathData, Point,
|
||||
Rect, Result, SOURCES_NAME, Selection, Session, SubPath, Value, b, bad, build_children, edge_near, face_at, finite, id_param, ids_json,
|
||||
is_live_paint, json, number_or, paint_from, po, point_param, repaint_from, replace_roots, root_ids, source_nodes, source_shapes, switch_or,
|
||||
Rect, Result, SOURCES_NAME, Selection, Session, SubPath, Value, b, bad, build_children, edge_near, face_at, finite, ids_json, is_live_paint,
|
||||
json, number_or, object_param, paint_from, po, point_param, repaint_from, replace_roots, root_ids, source_nodes, source_shapes, switch_or,
|
||||
};
|
||||
|
||||
/// `options` as stored on a Live Paint group: none for the defaults.
|
||||
@@ -303,7 +303,7 @@ pub(super) fn lp_fill(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
};
|
||||
crate::cmd::paint::check_keep_model(p, C)?;
|
||||
let paint = paint_from(s, p)?.unwrap_or_else(|| s.paint.fill.clone());
|
||||
let group = id_param(p, "group");
|
||||
let group = object_param(p, "group", C)?;
|
||||
let roots = if group.is_none() { root_ids(s, p)? } else { vec![] };
|
||||
let (g, face) = s.edit("Live Paint Bucket", |d, sel| {
|
||||
let gid = match group {
|
||||
@@ -367,7 +367,7 @@ pub(super) fn lp_fill(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
pub(super) fn lp_stroke_edge(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "livePaint.strokeEdge";
|
||||
let pt = point_param(p, "point").filter(|q| finite(*q)).ok_or_else(|| bad(C, "missing point [x,y]"))?;
|
||||
let g = id_param(p, "group").ok_or_else(|| bad(C, "missing group"))?;
|
||||
let g = object_param(p, "group", C)?.ok_or_else(|| bad(C, "missing group"))?;
|
||||
crate::cmd::paint::check_keep_model(p, C)?;
|
||||
let paint = paint_from(s, p)?.unwrap_or_else(|| s.paint.stroke.clone());
|
||||
let width = number_or(p, "width", s.paint.stroke_width.max(0.0), C)?;
|
||||
@@ -390,7 +390,10 @@ pub(super) fn lp_stroke_edge(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
}
|
||||
|
||||
pub(super) fn lp_info(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let g = id_param(p, "group").or_else(|| id_param(p, "id")).ok_or_else(|| bad("livePaint.info", "missing group"))?;
|
||||
let g = match object_param(p, "group", "livePaint.info")? {
|
||||
Some(g) => g,
|
||||
None => object_param(p, "id", "livePaint.info")?.ok_or_else(|| bad("livePaint.info", "missing group"))?,
|
||||
};
|
||||
let d = &s.doc()?.doc;
|
||||
let n = d.node(g).filter(|n| is_live_paint(n)).ok_or_else(|| bad("livePaint.info", format!("{g} is not a Live Paint group")))?;
|
||||
let faces: Vec<Value> = b::faces(n)
|
||||
|
||||
@@ -783,12 +783,14 @@ fn text_create(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
/// The paragraph attributes new type gets (the Type tools, `text.create`): aligned to the start of
|
||||
/// each paragraph's direction (left, right for Hebrew and Arabic), Japanese punctuation composed
|
||||
/// with Line-end Punctuation Half Width and Standard burasagari. Imported text keeps its own.
|
||||
/// with Line-end Punctuation Half Width and Standard burasagari, and Korean words kept whole
|
||||
/// (Korean Line Break Anywhere off). Imported text keeps its own.
|
||||
pub(crate) fn new_type_para() -> vectorcraft_doc::ParaStyle {
|
||||
vectorcraft_doc::ParaStyle {
|
||||
justify: vectorcraft_doc::Justify::Auto,
|
||||
mojikumi: vectorcraft_doc::Mojikumi::LineEndHalf,
|
||||
burasagari: vectorcraft_doc::Burasagari::Standard,
|
||||
korean_line_break_anywhere: false,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,8 +15,8 @@ use vectorcraft_tools::distort::{PinSet, arap, collect_points, mesh_for, project
|
||||
|
||||
use super::edit::{duplicate_in, outermost, refuse_symbol_part, selected_roots};
|
||||
use super::{
|
||||
CommandSpec, Result, Session, bad, check_numbers, check_switches, cmd, f64_or, f64_req, finite_numbers, has_doc, has_selection, id_param,
|
||||
matrix_param, named_id, named_ids, number_or, ok, point_indices, point_param, str_param, switch_or, targets,
|
||||
CommandSpec, Result, Session, bad, check_numbers, check_switches, cmd, f64_or, f64_req, finite_numbers, has_doc, has_selection, matrix_param,
|
||||
named_id, named_ids, number_or, object_param, ok, point_indices, point_param, str_param, switch_or, targets,
|
||||
};
|
||||
use crate::EngineError;
|
||||
|
||||
@@ -305,7 +305,7 @@ fn same_points(a: Option<&WidthProfile>, b: Option<&WidthProfile>) -> bool {
|
||||
|
||||
fn width_point_set(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "stroke.widthPoint.set";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let t = f64_req(p, "t", C)?.clamp(0.0, 1.0);
|
||||
let (left, right) = (f64_req(p, "left", C)?, f64_req(p, "right", C)?);
|
||||
if !(left.is_finite() && right.is_finite()) || left < 0.0 || right < 0.0 || left.max(right) > 1.0e5 {
|
||||
@@ -362,7 +362,7 @@ fn width_point_set(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn width_point_copy(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "stroke.widthPoint.copy";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let t = f64_req(p, "t", C)?.clamp(0.0, 1.0);
|
||||
// When the profile comes out as it was (the copy replaces a side of a discontinuous point that has
|
||||
// its widths already), the document and its undo history stay as they are.
|
||||
@@ -382,7 +382,7 @@ fn width_point_copy(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn width_point_remove(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "stroke.widthPoint.remove";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let indices = match (p.get("indices"), p.get("index")) {
|
||||
(Some(a), _) => point_indices(a),
|
||||
(None, Some(i)) => point_indices(&json!([i])),
|
||||
|
||||
@@ -18,8 +18,8 @@ use super::create::{add_look, insert_look};
|
||||
use super::newart::NewArt;
|
||||
use super::pathops::{Beside, remove_each};
|
||||
use super::{
|
||||
CommandSpec, Result, Session, bad, check_numbers, cmd, f64_or, has_anchors, has_doc, has_selection, id_param, index, number_or, ok, str_param,
|
||||
switch_or,
|
||||
CommandSpec, Result, Session, bad, check_numbers, cmd, f64_or, has_anchors, has_doc, has_selection, index, number_or, object_param, ok,
|
||||
str_param, switch_or,
|
||||
};
|
||||
use crate::EngineError;
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
use super::common::{MAX_INPUT, path_kind, path_mut, point_entry, usize_opt, usize_req, within_input_bound};
|
||||
use super::{
|
||||
Anchor, BTreeSet, Beside, Color, Document, EngineError, Node, NodeId, NodeKind, Paint, PathData, Point, Result, Selection, Session, Value, Vec2,
|
||||
add_look, bad, check_numbers, f64_or, id_param, json, number_or, ok, po, str_param, switch_or,
|
||||
add_look, bad, check_numbers, f64_or, json, number_or, object_param, ok, po, str_param, switch_or,
|
||||
};
|
||||
|
||||
// ---------- Curvature ----------
|
||||
@@ -41,7 +41,7 @@ enum CurvatureOp {
|
||||
pub(super) fn curvature_edit(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
use vectorcraft_tools::draw2::{EndCurve, curvature_close, curvature_extend, curvature_insert, curvature_move};
|
||||
const C: &str = "path.curvatureEdit";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", C)?.unwrap_or(0);
|
||||
check_numbers(p, &["x", "y", "t"], C)?;
|
||||
let at = match (p.get("x").and_then(Value::as_f64), p.get("y").and_then(Value::as_f64)) {
|
||||
@@ -106,7 +106,7 @@ pub(super) fn curvature_edit(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
pub(super) fn remove_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "path.removeAnchor";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", C)?.unwrap_or(0);
|
||||
let ai = usize_req(p, "anchor", C)?;
|
||||
let curvature = switch_or(p, "curvature", false, C)?;
|
||||
@@ -220,7 +220,7 @@ fn remove_anchors_of(
|
||||
|
||||
pub(super) fn convert_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "path.convertAnchor";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", C)?.unwrap_or(0);
|
||||
let ai = usize_req(p, "anchor", C)?;
|
||||
let smooth = str_param(p, "to") == Some("smooth");
|
||||
@@ -257,7 +257,7 @@ pub(super) fn convert_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
pub(super) fn reshape_segment(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "path.reshapeSegment";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", C)?.unwrap_or(0);
|
||||
let seg = usize_req(p, "segment", C)?;
|
||||
let t = number_or(p, "t", 0.5, C)?.clamp(0.05, 0.95);
|
||||
|
||||
@@ -4,7 +4,7 @@ use super::common::{
|
||||
};
|
||||
use super::{
|
||||
Anchor, AnchorKind, Beside, BezPath, BoolOp, Cap, EngineError, FillRule, Join, NodeId, ParamCurve, PathData, Point, Result, Session, SubPath,
|
||||
Value, bad, eraser_area, eraser_tip, f64_or, fill_contains, id_param, json, number_or, po,
|
||||
Value, bad, eraser_area, eraser_tip, f64_or, fill_contains, json, number_or, object_param, po,
|
||||
};
|
||||
|
||||
/// Split a filled path into connected pieces (each outer contour with its holes).
|
||||
@@ -170,7 +170,7 @@ pub(in super::super) fn erase_outline(pd: &PathData, step: f64, remove: &dyn Fn(
|
||||
|
||||
pub(super) fn split(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "path.split";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", C)?.unwrap_or(0);
|
||||
let anchor = usize_opt(p, "anchor", C)?;
|
||||
let seg = usize_opt(p, "segment", C)?;
|
||||
|
||||
@@ -4,7 +4,8 @@ use super::common::{
|
||||
};
|
||||
use super::{
|
||||
Anchor, Appearance, BTreeSet, BoolOp, Cap, Color, Document, EngineError, FillRule, Join, NewArt, Node, NodeId, NodeKind, Paint, PathData, Point,
|
||||
Result, Selection, Session, SimplifyOptions, SubPath, Value, bad, id_param, insert_look, json, number_or, po, remove_each, str_param, switch_or,
|
||||
Result, Selection, Session, SimplifyOptions, SubPath, Value, bad, insert_look, json, number_or, object_param, po, remove_each, str_param,
|
||||
switch_or,
|
||||
};
|
||||
|
||||
// ---------- Pencil / Paintbrush ----------
|
||||
@@ -158,7 +159,7 @@ pub(super) fn freehand(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let keep_selected = switch_or(p, "keepSelected", true, C)?;
|
||||
let filled = switch_or(p, "fill", false, C)?;
|
||||
if let Some(ext) = p.get("extend").filter(|v| !v.is_null()) {
|
||||
let id = id_param(ext, "id").ok_or_else(|| bad(C, "extend needs id"))?;
|
||||
let id = object_param(ext, "id", C)?.ok_or_else(|| bad(C, "extend needs id"))?;
|
||||
let at_start = str_param(ext, "end") == Some("start");
|
||||
let (pd, _) = path_of(&s.doc()?.doc, id)?;
|
||||
let si = pd.subpaths.iter().rposition(|s| !s.closed && !s.anchors.is_empty()).ok_or_else(|| bad(C, "path has no open end"))?;
|
||||
@@ -179,7 +180,7 @@ pub(super) fn freehand(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
// open subpath, that subpath starting at the end the stroke ends on, it ends at its end).
|
||||
let connect = match p.get("connect").filter(|v| !v.is_null()) {
|
||||
Some(cn) => {
|
||||
let other = id_param(cn, "id").ok_or_else(|| bad(C, "connect needs id"))?;
|
||||
let other = object_param(cn, "id", C)?.ok_or_else(|| bad(C, "connect needs id"))?;
|
||||
if other == id {
|
||||
return Err(bad(C, "connect needs a path other than the one extended"));
|
||||
}
|
||||
@@ -299,7 +300,7 @@ pub(super) fn freehand(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
return Ok(json!({ "id": id.0 }));
|
||||
}
|
||||
if let Some(rd) = p.get("redraw").filter(|v| !v.is_null()) {
|
||||
let id = id_param(rd, "id").ok_or_else(|| bad(C, "redraw needs id"))?;
|
||||
let id = object_param(rd, "id", C)?.ok_or_else(|| bad(C, "redraw needs id"))?;
|
||||
let within = number_or(rd, "within", 12.0, C)?;
|
||||
if !within.is_finite() || within < 0.0 {
|
||||
return Err(bad(C, "redraw within must be a finite distance of 0 or more"));
|
||||
|
||||
@@ -10,8 +10,8 @@ use vectorcraft_geom::{Affine, Point, Vec2};
|
||||
use super::clipboard::SwatchChoices;
|
||||
use super::{
|
||||
CommandSpec, Result, Session, always, bad, can_clear_history, can_redo, can_undo, check_numbers, checked_ids_param, clock_date, cmd, date_param,
|
||||
f64_req, finite_numbers, has_clipboard, has_doc, has_selection, has_selection_guides_or_artboard_tool, has_selection_or_guides, id_param, index,
|
||||
number_or, ok, point_param, str_param, switch_or,
|
||||
f64_req, finite_numbers, has_clipboard, has_doc, has_selection, has_selection_guides_or_artboard_tool, has_selection_or_guides, index, number_or,
|
||||
object_param, ok, point_param, str_param, switch_or,
|
||||
};
|
||||
use crate::{Clipboard, EngineError, inspect};
|
||||
|
||||
@@ -267,7 +267,7 @@ fn doc_move(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
}
|
||||
|
||||
fn doc_node(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("document.node", "missing id"))?;
|
||||
let id = object_param(p, "id", "document.node")?.ok_or_else(|| bad("document.node", "missing id"))?;
|
||||
let mut opts = slice_opts(p, "document.node")?;
|
||||
let summary = switch_or(p, "summary", false, "document.node")?;
|
||||
if !summary && (opts.depth.is_some() || opts.child_limit.is_some()) {
|
||||
|
||||
@@ -78,7 +78,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"3D Lighting Preset",
|
||||
[],
|
||||
None,
|
||||
"{index: int, preset: standard|diffuse|topLeft|right, item?: appearance item index|null (omitted: the active item, else the object's), ids?|id?: [..], target?: object|contents, aligned?: bool (index and item are rows of the first target's stack: each other target edits its equal one, as the Appearance panel does for a mixed selection)} replace an applied 3D effect's light rig and ambient with an original lighting preset; preserve shading, geometry and view; all targets must have a 3D effect at index other than Extrude & Bevel (Classic), which has no lighting presets; one undo step → {ids}",
|
||||
"{index: int, preset: standard|diffuse|topLeft|right, item?: appearance item index|null (omitted: the active item, else the object's), ids?|id?: [..], target?: object|contents, aligned?: bool (index and item are rows of the first target's stack: each other target edits its equal one, as the Appearance panel does for a mixed selection)} replace an applied 3D effect's light rig and ambient with an original lighting preset; preserve shading, geometry and view; all targets must have a 3D effect at index other than Extrude & Bevel (Classic), Revolve (Classic) or Rotate (Classic), which have no lighting presets; one undo step → {ids}",
|
||||
has_doc,
|
||||
lighting_preset
|
||||
),
|
||||
@@ -676,12 +676,10 @@ fn lighting_preset(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
if !effect.is_some_and(|e| effects::is_three_d(&e.id)) {
|
||||
return Err(bad(C, format!("object {} needs a 3D effect at index {index}", id.0)));
|
||||
}
|
||||
// Extrude & Bevel (Classic) has no lighting presets; its lights are set in its own options.
|
||||
if effect.is_some_and(|e| e.id == effects::CLASSIC_EXTRUDE) {
|
||||
return Err(bad(
|
||||
C,
|
||||
format!("object {}: Extrude & Bevel (Classic) at index {index} has no lighting presets; set its lights with effect.setParams", id.0),
|
||||
));
|
||||
// The classic 3D effects have no lighting presets; their lights are set in their own options.
|
||||
if let Some(e) = effect.filter(|e| effects::is_classic_three_d(&e.id)) {
|
||||
let name = effects::effect_info(&e.id).map_or("This effect", |info| info.label.trim_end_matches('…'));
|
||||
return Err(bad(C, format!("object {}: {name} at index {index} has no lighting presets; set its lights with effect.setParams", id.0)));
|
||||
}
|
||||
}
|
||||
let mut options = p.clone();
|
||||
|
||||
@@ -115,3 +115,32 @@ fn lighting_presets_refuse_extrude_and_bevel_classic_and_leave_a_mixed_selection
|
||||
let params = &s.doc().unwrap().doc.node(NodeId(classic)).unwrap().appearance.effects[0].params;
|
||||
assert_eq!((params["lightRotation"].as_f64(), params["lightHeight"].as_f64()), (Some(135.0), Some(45.0)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lighting_presets_refuse_revolve_classic() {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({})).unwrap();
|
||||
let id = s.execute("path.create", &json!({"d":"M100 40 L130 60 L130 140 L100 160"})).unwrap()["id"].as_u64().unwrap();
|
||||
s.execute("paint.setFill", &json!({"color":"#3366cc"})).unwrap();
|
||||
s.execute("effect.apply", &json!({"effect":"threeD.classicRevolve","item":null,"params":{"surface":"diffuse"}})).unwrap();
|
||||
s.doc_mut().unwrap().mark_saved();
|
||||
let before = s.doc().unwrap().doc.clone();
|
||||
let err = s.execute("effect.lightingPreset", &json!({"ids":[id],"index":0,"item":null,"preset":"topLeft"})).unwrap_err().to_string();
|
||||
assert!(err.contains(&format!("object {id}: Revolve (Classic) at index 0 has no lighting presets")), "{err}");
|
||||
assert_eq!(s.doc().unwrap().doc, before);
|
||||
assert!(!s.doc().unwrap().is_dirty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lighting_presets_refuse_rotate_classic() {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({})).unwrap();
|
||||
let id = s.execute("shape.rectangle", &json!({"x":100,"y":100,"width":80,"height":60})).unwrap()["id"].as_u64().unwrap();
|
||||
s.execute("effect.apply", &json!({"effect":"threeD.classicRotate","item":null,"params":{"lightRotation":40}})).unwrap();
|
||||
s.doc_mut().unwrap().mark_saved();
|
||||
let before = s.doc().unwrap().doc.clone();
|
||||
let err = s.execute("effect.lightingPreset", &json!({"ids":[id],"index":0,"item":null,"preset":"diffuse"})).unwrap_err().to_string();
|
||||
assert!(err.contains(&format!("object {id}: Rotate (Classic) at index 0 has no lighting presets")), "{err}");
|
||||
assert_eq!(s.doc().unwrap().doc, before);
|
||||
assert!(!s.doc().unwrap().is_dirty());
|
||||
}
|
||||
@@ -4,7 +4,7 @@ use vectorcraft_doc::{NodeId, NodeKind};
|
||||
|
||||
use crate::Session;
|
||||
|
||||
const TYPES: [&str; 5] = ["threeD.extrude", "threeD.classicExtrude", "threeD.inflate", "threeD.rotate", "threeD.revolve"];
|
||||
const TYPES: [&str; 6] = ["threeD.extrude", "threeD.classicExtrude", "threeD.inflate", "threeD.rotate", "threeD.classicRotate", "threeD.revolve"];
|
||||
|
||||
fn id_of(v: &Value) -> NodeId {
|
||||
NodeId(v["id"].as_u64().unwrap())
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
//! - `eps`: EPS export options (flattened transparency, previews, the embedded document), `document.exportEps`.
|
||||
//! - `dxfimport`: the DXF options `document.open` and Place read, `document.dxfInfo`.
|
||||
//! - `metafile`: EMF and WMF export, open and place.
|
||||
//! - `hpgl`: HP-GL export options and plots.
|
||||
//! - `importer`: files that importer plug-ins open (`document.open {importer}`, and extensions no
|
||||
//! built-in format reads).
|
||||
//! - `mesh3d`: 3D assets as OBJ, glTF, USDA and USDZ mesh files (`assets.export3D`).
|
||||
@@ -40,6 +41,7 @@ mod load;
|
||||
mod mesh3d;
|
||||
pub(crate) use load::{MAX_RASTER_ALLOC, size_note};
|
||||
mod heifread;
|
||||
mod hpgl;
|
||||
mod jp2read;
|
||||
mod metafile;
|
||||
mod naming;
|
||||
|
||||
@@ -536,6 +536,7 @@ fn dataset_output_extensions(run: &Run<'_>, doc: &vectorcraft_doc::Document, def
|
||||
| "dxf"
|
||||
| "emf"
|
||||
| "wmf"
|
||||
| "hpgl"
|
||||
| "ai"
|
||||
)
|
||||
};
|
||||
|
||||
@@ -27,7 +27,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Serialize Document",
|
||||
[],
|
||||
None,
|
||||
"{format?: vectorcraft (default)|template|svg|svgz|pdf|ai|png|jpg|webp|gif|png8|txt|dxf|eps|emf|wmf|tiff|bmp|tga|psd (ait, a .ait template, is written by file.saveAsTemplate), …the format's options (see document.formats; SVG ones also as svg: {…}), selectedOnly?: false (the selected objects alone, in the layers and groups that hold them; an object of a blend, envelope, repeat or intertwine on its own)} → {text, warnings} for svg (plus dataBase64, the file, when its encoding isn't UTF-8), else {dataBase64, warnings}; an SVG of several artboards also gives files: [{name, text}], linked images linked: [{name, dataBase64}]. A key no format takes, and an unknown key inside a PDF or EPS option's object, are refused; a key only another format takes is ignored",
|
||||
"{format?: vectorcraft (default)|template|svg|svgz|pdf|ai|png|jpg|webp|gif|png8|txt|dxf|eps|emf|wmf|hpgl|tiff|bmp|tga|psd (ait, a .ait template, is written by file.saveAsTemplate), …the format's options (see document.formats; SVG ones also as svg: {…}), selectedOnly?: false (the selected objects alone, in the layers and groups that hold them; an object of a blend, envelope, repeat or intertwine on its own)} → {text, warnings} for svg (plus dataBase64, the file, when its encoding isn't UTF-8), else {dataBase64, warnings}; an SVG of several artboards also gives files: [{name, text}], linked images linked: [{name, dataBase64}]. A key no format takes, and an unknown key inside a PDF or EPS option's object, are refused; a key only another format takes is ignored",
|
||||
has_doc,
|
||||
export::serialize
|
||||
),
|
||||
@@ -36,7 +36,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Export Document",
|
||||
[],
|
||||
None,
|
||||
"{path?, format?: svg|svgz|pdf|ai|png|jpg|webp|gif|png8|txt|dxf|eps|emf|wmf|tiff|bmp|tga|psd|vectorcraft|template (default: from the path's extension, else png; png8 writes an indexed .png; ait, a .ait template, is written by file.saveAsTemplate; an exporter plug-in's format is plugin.<plug-in id>, which an extension only it lists picks too), params?: {…} (an exporter plug-in's parameters; missing ones take their defaults, see plugin.info), selectedOnly?: false (the selected objects alone, in the layers and groups that hold them; an object of a blend, envelope, repeat or intertwine on its own), includeArtboardFill?: true (raster, PDF, SVG and EPS draw each exported artboard's background color behind its art, a transparent background too; false leaves it out), artboard?: 0, artboards?: [i…], rect?: [x, y, width, height] (raster formats: that area of the page in points, y down, instead of an artboard; not with artboard, artboards, range or useArtboards), range?: \"1-3, 5\" | \"all\" (1-based; PDF and .ai write one page per artboard, default all; SVG writes one file per artboard, {stem}-{artboard}.svg; raster formats write one artboard), useArtboards?: true (raster: one file per chosen artboard, default all, {stem}-{artboard}.{ext}; pdf/ai: every page) | false (pdf/ai/raster: the bounds of the visible art; SVG has it as an SVG option), ppi?: number (raster formats: pixels per inch, stored in the file; wins over scale; without either, the document's raster effects resolution), scale?: number (pixels per point), background?: transparent|white|black|\"#rrggbb\" (jpg: white when transparent; #rrggbbaa and #rgba are refused here and in matte), antiAlias?: none|art (default)|type (text snapped to pixels), interlaced?: false (png, Adam7), embedIcc?: true (png: an sRGB chunk marks the colours as sRGB), quality?: 90 (jpg: 0–100), colorModel?: rgb|cmyk|gray (jpg), method?: baseline|optimized|progressive, scans?: 3 (3–5, progressive), embedIcc?: true, imageMap?: none|client|server (an HTML or NCSA map of the objects with a URL, written as <stem>.html / <stem>.map), colors?: 256 (gif/png8: 2–256), reduction?: perceptual|selective (default)|adaptive|web|blackWhite|gray, dither?: none|diffusion (default)|pattern|noise, ditherAmount?: 100, transparency?: true, matte?: white|\"#rrggbb\"|none, interlaced?, lossless?: true (webp: lossy WebP isn't available yet: written lossless, with a warning), encoding?: utf8|utf16 (txt: the stories in stacking order, back to front, a thread once; utf16 with a byte order mark), lineEndings?: lf|crlf, selectionOnly?: false, svg?: {styling, outlineText, images, objectIds, decimals, minify, responsive, useArtboards, preserveEditing, metadata, fewerTspans, hiddenLayers, encoding, profile, embedFonts} (see document.formats), …the SVG options given flat instead, …the PDF options of document.exportPdf, …the DXF options of document.exportDxf (useArtboards: one drawing per artboard), …the EPS options of document.exportEps (useArtboards: one file per artboard, {stem}_{artboard}.eps, after a central {stem}.eps of the whole document when there are two or more and art shows; else the visible art), …emf and wmf write one picture of the artboard (useArtboards: true one file per chosen artboard, false the bounds of the visible art; EMF keeps curves, clipping, transparent images and gradients as images clipped to their shape; WMF flattens curves into polygons behind a placeable header; what a format leaves out comes back in warnings), colorModel?: rgb|cmyk|gray (tiff: rgb keeps transparency as an alpha channel), lzw?: true, byteOrder?: little|big, embedIcc?: true, colorModel?: rgb|gray (bmp), depth?: 24 (bmp: 1 black and white, 4|8 a palette by reduction and dither, 16, 24, 32 with alpha), fileFormat?: windows|os2 (1, 4, 8 or 24 bits), rle?: false (4 and 8 bits, windows), flipRows?: false (top-down rows), depth?: 24 (tga: 16 one-bit alpha, 24, 32 with alpha), colorModel?: rgb|cmyk|gray (psd), layers?: true (each top-level layer a pixel layer with its opacity and blend mode; a background colour is a Background layer; false: one flat image, on white), maxEditability?: false (layers and sublayers become groups, each object a layer named as in the Layers panel, text by its text; clipping, masked or knockout layers stay one layer), hiddenLayers?: false (hidden layers and objects written hidden instead of left out), embedIcc?: true (at most 30000 pixels a side; formats without alpha are flattened on white)} → {path, format, bytes, warnings, files?: [path…] (several), linked?: [path…] (linked images, image maps)}; no path → {dataBase64, format, bytes, warnings, files?: [{name, dataBase64}], linked?: [{name, dataBase64}]}. A key no format takes, and an unknown key inside a PDF or EPS option's object, are refused; a key only another format takes is ignored. Never changes the document's path",
|
||||
"{path?, format?: svg|svgz|pdf|ai|png|jpg|webp|gif|png8|txt|dxf|eps|emf|wmf|hpgl|tiff|bmp|tga|psd|vectorcraft|template (default: from the path's extension, else png; png8 writes an indexed .png; ait, a .ait template, is written by file.saveAsTemplate; an exporter plug-in's format is plugin.<plug-in id>, which an extension only it lists picks too), params?: {…} (an exporter plug-in's parameters; missing ones take their defaults, see plugin.info), selectedOnly?: false (the selected objects alone, in the layers and groups that hold them; an object of a blend, envelope, repeat or intertwine on its own), includeArtboardFill?: true (raster, PDF, SVG and EPS draw each exported artboard's background color behind its art, a transparent background too; false leaves it out), artboard?: 0, artboards?: [i…], rect?: [x, y, width, height] (raster formats: that area of the page in points, y down, instead of an artboard; not with artboard, artboards, range or useArtboards), range?: \"1-3, 5\" | \"all\" (1-based; PDF and .ai write one page per artboard, default all; SVG writes one file per artboard, {stem}-{artboard}.svg; raster formats write one artboard), useArtboards?: true (raster: one file per chosen artboard, default all, {stem}-{artboard}.{ext}; pdf/ai: every page) | false (pdf/ai/raster: the bounds of the visible art; SVG has it as an SVG option), ppi?: number (raster formats: pixels per inch, stored in the file; wins over scale; without either, the document's raster effects resolution), scale?: number (pixels per point), background?: transparent|white|black|\"#rrggbb\" (jpg: white when transparent; #rrggbbaa and #rgba are refused here and in matte), antiAlias?: none|art (default)|type (text snapped to pixels), interlaced?: false (png, Adam7), embedIcc?: true (png: an sRGB chunk marks the colours as sRGB), quality?: 90 (jpg: 0–100), colorModel?: rgb|cmyk|gray (jpg), method?: baseline|optimized|progressive, scans?: 3 (3–5, progressive), embedIcc?: true, imageMap?: none|client|server (an HTML or NCSA map of the objects with a URL, written as <stem>.html / <stem>.map), colors?: 256 (gif/png8: 2–256), reduction?: perceptual|selective (default)|adaptive|web|blackWhite|gray, dither?: none|diffusion (default)|pattern|noise, ditherAmount?: 100, transparency?: true, matte?: white|\"#rrggbb\"|none, interlaced?, lossless?: true (webp: lossy WebP isn't available yet: written lossless, with a warning), encoding?: utf8|utf16 (txt: the stories in stacking order, back to front, a thread once; utf16 with a byte order mark), lineEndings?: lf|crlf, selectionOnly?: false, svg?: {styling, outlineText, images, objectIds, decimals, minify, responsive, useArtboards, preserveEditing, metadata, fewerTspans, hiddenLayers, encoding, profile, embedFonts} (see document.formats), …the SVG options given flat instead, …the PDF options of document.exportPdf, …the DXF options of document.exportDxf (useArtboards: one drawing per artboard), …the EPS options of document.exportEps (useArtboards: one file per artboard, {stem}_{artboard}.eps, after a central {stem}.eps of the whole document when there are two or more and art shows; else the visible art), …emf and wmf write one picture of the artboard (useArtboards: true one file per chosen artboard, false the bounds of the visible art; EMF keeps curves, clipping, transparent images and gradients as images clipped to their shape; WMF flattens curves into polygons behind a placeable header; what a format leaves out comes back in warnings), …hpgl writes a plot of the artboard as pen moves for plotters and cutters (each visible path once along its line in plotter units; useArtboards: true one file per chosen artboard, false the bounds of the visible art), hpglVersion?: hpgl (default: IN, SP, PU, PD) | hpgl2 (also NP and PC pen colors, each pen's paths as one encoded polyline PE), curveTolerance?: 0.1 (points, 0.01 to 10), pens?: [\"#rrggbb\"…] (pen 1 first, up to 255; each path takes the nearest; default a pen per color in the order the art first draws in it, numbered alike in every file), origin?: bottomLeft (default) | center, sortPaths?: false (each pen's next path the nearest), insideFirst?: false (a path after the pen's paths that lie inside it), colorModel?: rgb|cmyk|gray (tiff: rgb keeps transparency as an alpha channel), lzw?: true, byteOrder?: little|big, embedIcc?: true, colorModel?: rgb|gray (bmp), depth?: 24 (bmp: 1 black and white, 4|8 a palette by reduction and dither, 16, 24, 32 with alpha), fileFormat?: windows|os2 (1, 4, 8 or 24 bits), rle?: false (4 and 8 bits, windows), flipRows?: false (top-down rows), depth?: 24 (tga: 16 one-bit alpha, 24, 32 with alpha), colorModel?: rgb|cmyk|gray (psd), layers?: true (each top-level layer a pixel layer with its opacity and blend mode; a background colour is a Background layer; false: one flat image, on white), maxEditability?: false (layers and sublayers become groups, each object a layer named as in the Layers panel,
Line truncated
|
||||
has_doc,
|
||||
export::export
|
||||
),
|
||||
@@ -45,7 +45,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Export Selection…",
|
||||
["File"],
|
||||
None,
|
||||
"{path?, format?: png|jpg|webp|svg|svgz|pdf|ai|gif|png8|tiff|bmp|tga|psd|txt|dxf|eps|emf|wmf|vectorcraft|template (default: from the extension, else png), ppi?: number (raster formats: pixels per inch, stored in the file; wins over scale; without either, the document's raster effects resolution), scale?: number (pixels per point), …the format's options} the selected objects (template layers left out), each in the layers and groups that hold it, whose clipping paths, opacity masks, effects, opacity and blend modes apply as on the canvas (an object of a blend, envelope, repeat or intertwine on its own; txt: the selected type alone), cropped to the bounds the renderer measures for that art (a clip group by its clip) → {path, format, bytes, warnings, bounds} (no path → {dataBase64, format, bytes, warnings, bounds}); warnings say what the format approximated or left out, as for document.export. A key no format takes, and an unknown key inside a PDF or EPS option's object, are refused; a key only another format takes is ignored",
|
||||
"{path?, format?: png|jpg|webp|svg|svgz|pdf|ai|gif|png8|tiff|bmp|tga|psd|txt|dxf|eps|emf|wmf|hpgl|vectorcraft|template (default: from the extension, else png), ppi?: number (raster formats: pixels per inch, stored in the file; wins over scale; without either, the document's raster effects resolution), scale?: number (pixels per point), …the format's options} the selected objects (template layers left out), each in the layers and groups that hold it, whose clipping paths, opacity masks, effects, opacity and blend modes apply as on the canvas (an object of a blend, envelope, repeat or intertwine on its own; txt: the selected type alone), cropped to the bounds the renderer measures for that art (a clip group by its clip) → {path, format, bytes, warnings, bounds} (no path → {dataBase64, format, bytes, warnings, bounds}); warnings say what the format approximated or left out, as for document.export. A key no format takes, and an unknown key inside a PDF or EPS option's object, are refused; a key only another format takes is ignored",
|
||||
has_selection,
|
||||
export::export_selection
|
||||
),
|
||||
|
||||
@@ -464,7 +464,7 @@ fn encode_all_of(doc: &Document, format: &str, p: &Value) -> Result<Encoded> {
|
||||
}
|
||||
// Formats that draw type: missing fonts come out in the fallback font (PDF and SVG say so
|
||||
// themselves: SVG only when it outlines or embeds fonts).
|
||||
if (f.raster || matches!(f.id, "eps" | "emf" | "wmf"))
|
||||
if (f.raster || matches!(f.id, "eps" | "emf" | "wmf" | "hpgl"))
|
||||
&& let Some(w) = crate::cmd::fonts::substitution_warning(doc)
|
||||
{
|
||||
enc.warnings.push(w);
|
||||
@@ -503,7 +503,7 @@ fn encode_files(doc: &Document, f: &Format, p: &Value) -> Result<Encoded> {
|
||||
let doc = &*doc.without_edit_modes();
|
||||
let n = doc.artboards.len();
|
||||
// SVG reads its own `useArtboards` (an SVG option).
|
||||
let use_artboards = if f.raster || matches!(f.id, "pdf" | "ai" | "dxf" | "emf" | "wmf") { use_artboards(p)? } else { None };
|
||||
let use_artboards = if f.raster || matches!(f.id, "pdf" | "ai" | "dxf" | "emf" | "wmf" | "hpgl") { use_artboards(p)? } else { None };
|
||||
// `rect`: that area of the page, as if it were the only artboard (the document is not changed).
|
||||
if let Some(rect) = page_rect(f, p)? {
|
||||
let mut q = super::export::without_artboards(p);
|
||||
@@ -536,6 +536,7 @@ fn encode_files(doc: &Document, f: &Format, p: &Value) -> Result<Encoded> {
|
||||
"eps" => return super::eps::encode(doc, p),
|
||||
"emf" => return super::metafile::encode(doc, p, use_artboards, vectorcraft_metafile::Kind::Emf),
|
||||
"wmf" => return super::metafile::encode(doc, p, use_artboards, vectorcraft_metafile::Kind::Wmf),
|
||||
"hpgl" => return super::hpgl::encode(doc, p, use_artboards),
|
||||
"ai" => return super::save::encode_ai(C, f, doc, p),
|
||||
"pdf" => {
|
||||
let (bytes, warnings) = super::pdf::encode(C, doc, p)?;
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
use super::super::unique_name;
|
||||
use super::{
|
||||
Result, Session, TEMPLATE_FORMATS, UNSUPPORTED, Unsupported, Value, bad, dxf, eps, json, metafile, native, pdf, screens, svg, text, unsupported,
|
||||
Result, Session, TEMPLATE_FORMATS, UNSUPPORTED, Unsupported, Value, bad, dxf, eps, hpgl, json, metafile, native, pdf, screens, svg, text,
|
||||
unsupported,
|
||||
};
|
||||
|
||||
/// One option a format's encoder reads from the export params.
|
||||
@@ -479,8 +480,17 @@ pub const FORMATS: &[Format] = &[
|
||||
},
|
||||
Format { id: "emf", label: "EMF", extensions: &["emf"], mime: "image/emf", read: true, write: true, raster: false, options: metafile::OPTIONS },
|
||||
Format { id: "wmf", label: "WMF", extensions: &["wmf"], mime: "image/wmf", read: true, write: true, raster: false, options: metafile::OPTIONS },
|
||||
// HP-GL/2 plot files, read by `vectorcraft_cad::hpgl` into paths; exports don't write them.
|
||||
reader("hpgl", "HP-GL", &["plt", "hpgl", "hgl", "hpg"], "application/vnd.hp-hpgl", false),
|
||||
// HP-GL/2 plot files, read by `vectorcraft_cad::hpgl` into paths and written as pen moves.
|
||||
Format {
|
||||
id: "hpgl",
|
||||
label: "HP-GL",
|
||||
extensions: &["plt", "hpgl", "hgl", "hpg"],
|
||||
mime: "application/vnd.hp-hpgl",
|
||||
read: true,
|
||||
write: true,
|
||||
raster: false,
|
||||
options: hpgl::OPTIONS,
|
||||
},
|
||||
Format {
|
||||
id: "tga",
|
||||
label: "Targa",
|
||||
|
||||
@@ -0,0 +1,126 @@
|
||||
//! HP-GL for every path that writes plot files (`vectorcraft_cad::hpgl`): `document.export {format:
|
||||
//! hpgl}` and Export As (one plot of an artboard, or one per artboard with Use Artboards), with the
|
||||
//! options parsed from the params.
|
||||
|
||||
use serde_json::Value;
|
||||
use vectorcraft_cad::hpgl::write::{DEFAULT_TOLERANCE, MAX_PENS, TOLERANCE_RANGE};
|
||||
use vectorcraft_cad::hpgl::{HpglOptions, Origin, Version};
|
||||
use vectorcraft_doc::Document;
|
||||
|
||||
use super::super::{Result, bad, number_or, switch_or, text_param};
|
||||
use super::{ArtboardPick, Encoded, FormatOption};
|
||||
|
||||
const C: &str = "document.export";
|
||||
|
||||
/// The options `document.formats` lists for HP-GL.
|
||||
pub(super) const OPTIONS: &[FormatOption] = &[
|
||||
super::ARTBOARD,
|
||||
super::ARTBOARDS,
|
||||
super::RANGE,
|
||||
super::USE_ARTBOARDS,
|
||||
FormatOption {
|
||||
name: "hpglVersion",
|
||||
ty: "string",
|
||||
default: "\"hpgl\"",
|
||||
description: "hpgl (IN, SP, PU and PD only; a coordinate outside -32,768 to 32,767 gets a warning) or hpgl2 (also the pens' colors, NP and PC, and each pen's paths as one encoded polyline, PE)",
|
||||
},
|
||||
FormatOption {
|
||||
name: "curveTolerance",
|
||||
ty: "number",
|
||||
default: "0.1",
|
||||
description: "how far the straight moves a curve becomes may lie from it, in points (0.01 to 10)",
|
||||
},
|
||||
FormatOption {
|
||||
name: "pens",
|
||||
ty: "array",
|
||||
default: "null",
|
||||
description: "the pen table, pen 1's color first: up to 255 \"#rrggbb\" colors, each path drawn with the pen of the nearest color; null: a pen for each color in the order the art first draws in it, numbered alike in every file of one export",
|
||||
},
|
||||
FormatOption {
|
||||
name: "origin",
|
||||
ty: "string",
|
||||
default: "\"bottomLeft\"",
|
||||
description: "bottomLeft or center: where (0, 0) lies on the artboard (or the art's bounds)",
|
||||
},
|
||||
FormatOption {
|
||||
name: "sortPaths",
|
||||
ty: "boolean",
|
||||
default: "false",
|
||||
description: "draw each pen's next path from the end nearest where the pen stopped, instead of in paint order",
|
||||
},
|
||||
FormatOption {
|
||||
name: "insideFirst",
|
||||
ty: "boolean",
|
||||
default: "false",
|
||||
description: "draw a path only after the pen's paths that lie inside it (a letter's counter before the letter, a hole before the part), the paths otherwise in paint order; with sortPaths, the nearest of the paths free to draw comes next",
|
||||
},
|
||||
];
|
||||
|
||||
/// The HP-GL options in `p` (the region is set per plot).
|
||||
fn parse(p: &Value) -> Result<HpglOptions> {
|
||||
let mut o = HpglOptions::default();
|
||||
if let Some(s) = text_param(p, "hpglVersion", C)? {
|
||||
let key = "hpglVersion";
|
||||
o.version = Version::from_id(s).ok_or_else(|| bad(C, format!("`{key}` must be one of {}", Version::ALL.map(Version::id).join(", "))))?;
|
||||
}
|
||||
let x = number_or(p, "curveTolerance", DEFAULT_TOLERANCE, C)?;
|
||||
if !TOLERANCE_RANGE.contains(&x) {
|
||||
let (key, min, max) = ("curveTolerance", TOLERANCE_RANGE.start(), TOLERANCE_RANGE.end());
|
||||
return Err(bad(C, format!("`{key}` must be between {min} and {max} (got {x})")));
|
||||
}
|
||||
o.tolerance = x;
|
||||
match p.get("pens") {
|
||||
None | Some(Value::Null) => {}
|
||||
Some(v) => {
|
||||
let colors: Option<Vec<[u8; 3]>> = v.as_array().filter(|a| (1..=MAX_PENS).contains(&a.len())).and_then(|a| a.iter().map(hex).collect());
|
||||
o.pens = colors.ok_or_else(|| bad(C, "`pens` must be an array of 1 to 255 #rrggbb colors"))?;
|
||||
}
|
||||
}
|
||||
if let Some(s) = text_param(p, "origin", C)? {
|
||||
let key = "origin";
|
||||
o.origin = Origin::from_id(s).ok_or_else(|| bad(C, format!("`{key}` must be one of {}", Origin::ALL.map(Origin::id).join(", "))))?;
|
||||
}
|
||||
o.sort = switch_or(p, "sortPaths", false, C)?;
|
||||
o.inside_first = switch_or(p, "insideFirst", false, C)?;
|
||||
Ok(o)
|
||||
}
|
||||
|
||||
/// A `#rrggbb` color.
|
||||
fn hex(v: &Value) -> Option<[u8; 3]> {
|
||||
let s = v.as_str()?.strip_prefix('#').filter(|s| s.len() == 6 && s.bytes().all(|b| b.is_ascii_hexdigit()))?;
|
||||
let byte = |i: usize| s.get(i..i + 2).and_then(|h| u8::from_str_radix(h, 16).ok());
|
||||
Some([byte(0)?, byte(2)?, byte(4)?])
|
||||
}
|
||||
|
||||
/// Encode `doc` as HP-GL: a plot of the chosen artboard (default the first), or with
|
||||
/// `use_artboards` one plot per chosen artboard (default all), with one pen numbering for them all.
|
||||
pub(super) fn encode(doc: &Document, p: &Value, use_artboards: Option<bool>) -> Result<Encoded> {
|
||||
let opts = parse(p)?;
|
||||
let f = super::format("hpgl").ok_or_else(|| bad(C, "no HP-GL format"))?;
|
||||
let pick: ArtboardPick = super::encode::options(f, p)?;
|
||||
let n = doc.artboards.len();
|
||||
let boards = match use_artboards {
|
||||
Some(true) => pick.resolve(n).map_err(|e| bad(C, e))?.unwrap_or_else(|| (0..n).collect()),
|
||||
_ => vec![pick.one(n).map_err(|e| bad(C, e))?],
|
||||
};
|
||||
let regions = boards
|
||||
.iter()
|
||||
.map(|&b| doc.artboards.get(b).map(|a| a.rect).ok_or_else(|| bad(C, format!("no artboard {}", b + 1))))
|
||||
.collect::<Result<Vec<_>>>()?;
|
||||
let plots = vectorcraft_cad::hpgl::export_regions(doc, &opts, ®ions).map_err(|e| bad(C, e))?;
|
||||
let mut enc = Encoded::default();
|
||||
for (b, out) in boards.into_iter().zip(plots) {
|
||||
enc.files.push((Some(b), out.bytes));
|
||||
for w in out.warnings {
|
||||
if !enc.warnings.contains(&w) {
|
||||
enc.warnings.push(w);
|
||||
}
|
||||
}
|
||||
}
|
||||
if enc.files.is_empty() {
|
||||
return Err(bad(C, "the document has no artboard"));
|
||||
}
|
||||
let regions: Vec<vectorcraft_geom::Rect> = enc.files.iter().filter_map(|(b, _)| b.and_then(|b| doc.artboards.get(b))).map(|a| a.rect).collect();
|
||||
enc.warnings.extend(crate::cmd::fonts::export_overflow_warning(doc, &doc.layers, Some(®ions)));
|
||||
Ok(enc)
|
||||
}
|
||||
@@ -885,7 +885,13 @@ impl SaveJob {
|
||||
/// folder?, warnings, files?: [{name, dataBase64}] (every file, when there are several),
|
||||
/// linked?: [{name, dataBase64}]}`; with one → `{path, format, bytes, warnings, files?:
|
||||
/// [path…], linked?: [path…]}`.
|
||||
pub fn write(&self, mut write: impl FnMut(&str, &[u8]) -> Result<()>) -> Result<Value> {
|
||||
pub fn write(&self, write: impl FnMut(&str, &[u8]) -> Result<()>) -> Result<Value> {
|
||||
self.write_unless(|_| None, write)
|
||||
}
|
||||
|
||||
/// [`SaveJob::write`], once `stop` has seen the paths of every file it writes to a path, in
|
||||
/// order: when `stop` returns a value, nothing is written and that value is returned.
|
||||
pub fn write_unless(&self, stop: impl FnOnce(&[&str]) -> Option<Value>, mut write: impl FnMut(&str, &[u8]) -> Result<()>) -> Result<Value> {
|
||||
let (plan, doc) = (&self.plan, &*self.doc);
|
||||
let mut enc = self.encode()?;
|
||||
let warnings = std::mem::take(&mut enc.warnings);
|
||||
@@ -899,6 +905,9 @@ impl SaveJob {
|
||||
return Ok(out);
|
||||
};
|
||||
let files = enc.named(doc, path);
|
||||
if let Some(stopped) = stop(&files.iter().map(|(p, _)| p.as_str()).collect::<Vec<_>>()) {
|
||||
return Ok(stopped);
|
||||
}
|
||||
for (p, bytes) in &files {
|
||||
write(p, bytes)?;
|
||||
}
|
||||
|
||||
@@ -196,7 +196,7 @@ pub(super) fn name_without_device(name: &str) -> String {
|
||||
pub(crate) const ROW_KEYS: [&str; 7] = ["format", "scale", "ppi", "width", "height", "suffix", "folder"];
|
||||
|
||||
/// The writable formats a format row can't name.
|
||||
pub(crate) const UNWRITTEN_FORMATS: [&str; 5] = ["template", "txt", "dxf", "emf", "wmf"];
|
||||
pub(crate) const UNWRITTEN_FORMATS: [&str; 6] = ["template", "txt", "dxf", "emf", "wmf", "hpgl"];
|
||||
|
||||
/// One format row: what to write, at which size, with which suffix, into which sub-folder.
|
||||
struct Row {
|
||||
|
||||
@@ -431,6 +431,7 @@ fn export_extensions_name_every_writable_format() {
|
||||
"eps",
|
||||
"emf",
|
||||
"wmf",
|
||||
"plt",
|
||||
"tga",
|
||||
"psd"
|
||||
]
|
||||
@@ -466,6 +467,7 @@ fn formats_query_lists_readers_writers_and_options() {
|
||||
"eps",
|
||||
"emf",
|
||||
"wmf",
|
||||
"hpgl",
|
||||
"tga",
|
||||
"psd"
|
||||
]
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
//! HP-GL plotter files through the commands: `document.open` by extension or by content, File ›
|
||||
//! Place as one group of paths, the dialogs' filters and the format list, and files that aren't
|
||||
//! HP-GL refused with a message.
|
||||
//! Place as one group of paths, the dialogs' filters and the format list, files that aren't
|
||||
//! HP-GL refused with a message, and `document.export` of one artboard, each or the art, with its
|
||||
//! options checked.
|
||||
|
||||
use serde_json::json;
|
||||
use serde_json::{Value, json};
|
||||
use vectorcraft_doc::NodeKind;
|
||||
|
||||
use super::*;
|
||||
@@ -100,5 +101,131 @@ fn the_dialogs_and_the_format_list_name_hpgl() {
|
||||
assert!(open_filters().any(|f| f == filter) && place_filters().any(|f| f == filter));
|
||||
let r = Session::new().execute("document.formats", &json!({})).unwrap();
|
||||
let f = r["formats"].as_array().unwrap().iter().find(|f| f["id"] == "hpgl").unwrap().clone();
|
||||
assert_eq!((f["read"].as_bool(), f["write"].as_bool(), f["raster"].as_bool()), (Some(true), Some(false), Some(false)));
|
||||
assert_eq!((f["read"].as_bool(), f["write"].as_bool(), f["raster"].as_bool()), (Some(true), Some(true), Some(false)));
|
||||
for o in ["useArtboards", "hpglVersion", "curveTolerance", "pens", "origin", "sortPaths", "insideFirst"] {
|
||||
assert!(f["options"].get(o).is_some(), "{o}: {f}");
|
||||
}
|
||||
assert_eq!(writable_format(None, Some("x/part.plt")).unwrap().id, "hpgl");
|
||||
assert_eq!(writable_format(None, Some("x/part.hpgl")).unwrap().id, "hpgl");
|
||||
}
|
||||
|
||||
fn bytes(v: &Value) -> Vec<u8> {
|
||||
vectorcraft_format::base64_decode(v["dataBase64"].as_str().expect("dataBase64")).unwrap()
|
||||
}
|
||||
|
||||
/// Two 100 pt artboards side by side, a 30 pt square on each, the second one red.
|
||||
fn two_boards() -> Session {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({"width": 100, "height": 100, "artboards": 2})).unwrap();
|
||||
let second = s.doc().unwrap().doc.artboards[1].rect.x0;
|
||||
s.execute("paint.setFill", &json!({"none": true})).unwrap();
|
||||
s.execute("paint.setStroke", &json!({"color": "#000000"})).unwrap();
|
||||
s.execute("shape.rectangle", &json!({"x": 10, "y": 10, "width": 30, "height": 30})).unwrap();
|
||||
let red = s.execute("shape.rectangle", &json!({"x": second + 10.0, "y": 10, "width": 30, "height": 30})).unwrap()["id"].clone();
|
||||
s.execute("paint.setStroke", &json!({"ids": [red], "color": "#ff0000"})).unwrap();
|
||||
s
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn export_writes_a_plot_of_one_artboard_or_each() {
|
||||
let mut s = two_boards();
|
||||
let r = s.execute("document.export", &json!({"format": "hpgl"})).unwrap();
|
||||
assert_eq!(r["format"], "hpgl");
|
||||
// The first artboard's square, 1016 units to the inch from its bottom-left corner.
|
||||
assert_eq!(String::from_utf8(bytes(&r)).unwrap(), "IN;PU;SP1;PU141,1270;PD564,1270,564,847,141,847,141,1270;PU;SP0;");
|
||||
let second = String::from_utf8(bytes(&s.execute("document.export", &json!({"format": "hpgl", "artboard": 1})).unwrap())).unwrap();
|
||||
assert_eq!(second, "IN;PU;SP1;PU141,1270;PD564,1270,564,847,141,847,141,1270;PU;SP0;", "its own square, its own pen 1");
|
||||
assert_eq!(bytes(&s.execute("document.serialize", &json!({"format": "hpgl"})).unwrap()), bytes(&r));
|
||||
let r = s.execute("document.export", &json!({"format": "hpgl", "useArtboards": true})).unwrap();
|
||||
let files = r["files"].as_array().unwrap();
|
||||
assert_eq!(files.len(), 2);
|
||||
assert!(files[1]["name"].as_str().unwrap().ends_with("-Artboard-2.plt"), "{files:?}");
|
||||
// One pen numbering for every file: the red square is pen 2 in the second.
|
||||
assert_eq!(String::from_utf8(bytes(&files[1])).unwrap(), "IN;PU;SP2;PU141,1270;PD564,1270,564,847,141,847,141,1270;PU;SP0;");
|
||||
// The bounds of the art: both squares, the second pen red, read back as two paths.
|
||||
let art = bytes(&s.execute("document.export", &json!({"format": "hpgl", "useArtboards": false, "hpglVersion": "hpgl2"})).unwrap());
|
||||
assert!(art.starts_with(b"IN;NP4;PC1,0,0,0;PC2,255,0,0;"), "{:?}", String::from_utf8_lossy(&art));
|
||||
let back = Session::new().execute("document.open", &json!({"name": "art.plt", "dataBase64": b64(&art)})).unwrap();
|
||||
assert_eq!(back["format"], "hpgl", "{back}");
|
||||
// One file holds one artboard.
|
||||
assert!(s.execute("document.export", &json!({"format": "hpgl", "artboards": [0, 1]})).is_err());
|
||||
}
|
||||
|
||||
/// A plot read back opens with the same squares: as wide as the art drew them, a point at most
|
||||
/// apart from the 30 pt sides plus the 0.35 mm pen.
|
||||
#[test]
|
||||
fn a_plot_reads_back_as_its_art() {
|
||||
let mut s = two_boards();
|
||||
let plot = bytes(&s.execute("document.export", &json!({"format": "hpgl", "useArtboards": false})).unwrap());
|
||||
let mut back = Session::new();
|
||||
back.execute("document.open", &json!({"name": "art.plt", "dataBase64": b64(&plot)})).unwrap();
|
||||
let doc = &back.doc().unwrap().doc;
|
||||
let mut paths = 0;
|
||||
doc.walk(|n| paths += usize::from(matches!(n.kind, NodeKind::Path { .. })));
|
||||
assert_eq!(paths, 2);
|
||||
let board = doc.artboards[0].rect;
|
||||
let second = s.doc().unwrap().doc.artboards[1].rect.x0;
|
||||
let pen = 0.35 * 72.0 / 25.4;
|
||||
assert!((board.width() - (second + 30.0 + pen)).abs() < 0.1, "{board:?}");
|
||||
assert!((board.height() - (30.0 + pen)).abs() < 0.1, "{board:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn export_options_are_checked() {
|
||||
let mut s = two_boards();
|
||||
let refused = |s: &mut Session, p: Value| s.execute("document.export", &p).expect_err("refused").to_string();
|
||||
let cases = [
|
||||
(json!({"format": "hpgl", "hpglVersion": "hpgl3"}), "`hpglVersion` must be one of hpgl, hpgl2"),
|
||||
(json!({"format": "hpgl", "hpglVersion": 2}), "`hpglVersion` must be a string"),
|
||||
(json!({"format": "hpgl", "curveTolerance": 0}), "`curveTolerance` must be between 0.01 and 10 (got 0)"),
|
||||
(json!({"format": "hpgl", "curveTolerance": "fine"}), "`curveTolerance` must be a number"),
|
||||
(json!({"format": "hpgl", "pens": []}), "`pens` must be an array of 1 to 255 #rrggbb colors"),
|
||||
(json!({"format": "hpgl", "pens": ["#ff0000", "red"]}), "`pens` must be an array of 1 to 255 #rrggbb colors"),
|
||||
(json!({"format": "hpgl", "pens": "#ff0000"}), "`pens` must be an array of 1 to 255 #rrggbb colors"),
|
||||
(json!({"format": "hpgl", "origin": "top"}), "`origin` must be one of bottomLeft, center"),
|
||||
(json!({"format": "hpgl", "sortPaths": "yes"}), "`sortPaths` must be true or false"),
|
||||
(json!({"format": "hpgl", "insideFirst": 1}), "`insideFirst` must be true or false"),
|
||||
];
|
||||
for (p, want) in cases {
|
||||
let e = refused(&mut s, p.clone());
|
||||
assert!(e.contains(want), "{p}: {e}");
|
||||
}
|
||||
let many: Vec<String> = (0..256).map(|i| format!("#{:02x}0000", i % 256)).collect();
|
||||
assert!(refused(&mut s, json!({"format": "hpgl", "pens": many})).contains("`pens`"));
|
||||
// Given options take effect: the center as the origin, a pen table (black is pen 2), and the
|
||||
// square starting at its corner nearest the origin.
|
||||
let p = json!({"format": "hpgl", "origin": "CENTER", "pens": ["#ff0000", "#000000"], "curveTolerance": 10, "sortPaths": true});
|
||||
let plot = String::from_utf8(bytes(&s.execute("document.export", &p).unwrap())).unwrap();
|
||||
assert_eq!(plot, "IN;PU;SP2;PU-141,141;PD-564,141,-564,564,-141,564,-141,141;PU;SP0;");
|
||||
}
|
||||
|
||||
/// `insideFirst` draws the square inside the other one first, though it was made last.
|
||||
#[test]
|
||||
fn inside_first_draws_the_inner_square_first() {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({"width": 100, "height": 100})).unwrap();
|
||||
s.execute("paint.setFill", &json!({"none": true})).unwrap();
|
||||
s.execute("paint.setStroke", &json!({"color": "#000000"})).unwrap();
|
||||
s.execute("shape.rectangle", &json!({"x": 10, "y": 10, "width": 80, "height": 80})).unwrap();
|
||||
s.execute("shape.rectangle", &json!({"x": 30, "y": 30, "width": 20, "height": 20})).unwrap();
|
||||
let starts = |s: &mut Session, p: Value| {
|
||||
let plot = String::from_utf8(bytes(&s.execute("document.export", &p).unwrap())).unwrap();
|
||||
(plot.find("PU141,1270;").unwrap(), plot.find("PU423,988;").unwrap())
|
||||
};
|
||||
let (outer, inner) = starts(&mut s, json!({"format": "hpgl"}));
|
||||
assert!(outer < inner);
|
||||
let (outer, inner) = starts(&mut s, json!({"format": "hpgl", "insideFirst": true}));
|
||||
assert!(inner < outer);
|
||||
}
|
||||
|
||||
/// Export Selection plots the selected square alone (the red one, made last), from the
|
||||
/// bottom-left corner of its bounds.
|
||||
#[test]
|
||||
fn export_selection_writes_a_plot_of_the_selection() {
|
||||
let mut s = two_boards();
|
||||
let r = s.execute("document.exportSelection", &json!({"format": "hpgl"})).unwrap();
|
||||
assert_eq!(r["format"], "hpgl");
|
||||
let plot = String::from_utf8(bytes(&r)).unwrap();
|
||||
assert_eq!(plot.matches("PD").count(), 1, "{plot}");
|
||||
assert!(plot.starts_with("IN;PU;SP1;PU7,430;PD"), "{plot}");
|
||||
}
|
||||
@@ -15,7 +15,7 @@ use vectorcraft_geom::{Affine, Rect};
|
||||
|
||||
use super::{
|
||||
CommandSpec, Result, Session, bad, bool_or, check_numbers, check_switches, checked_id, checked_ids_param, cmd, color_value, f64_or, has_doc,
|
||||
has_selection, id_param, ids_param, index, ok, str_param, switch_or,
|
||||
has_selection, ids_param, index, object_param, ok, str_param, switch_or,
|
||||
};
|
||||
use crate::EngineError;
|
||||
|
||||
@@ -426,7 +426,7 @@ fn paste_remembers_layers(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
/// The Layers panel's target circle.
|
||||
fn target(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "layer.target";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let st = s.doc()?;
|
||||
let n = st.doc.node(id).ok_or(EngineError::NoNode(id))?;
|
||||
if !st.doc.is_editable(id) {
|
||||
@@ -594,7 +594,7 @@ fn duplicate_rows(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn set_current(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "layer.setCurrent";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let st = s.doc_mut()?;
|
||||
let layer = st.doc.layer_containing(id).ok_or(EngineError::NoNode(id))?;
|
||||
st.active_layer = Some(layer);
|
||||
@@ -700,7 +700,7 @@ fn in_isolation(doc: &Document, isolation: Option<NodeId>, id: NodeId) -> bool {
|
||||
/// The selection column: select a row's art.
|
||||
fn select_art(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "layer.selectAll";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let add = switch_or(p, "add", false, C)?;
|
||||
let st = s.doc()?;
|
||||
let n = st.doc.node(id).ok_or(EngineError::NoNode(id))?;
|
||||
@@ -747,9 +747,12 @@ enum Place {
|
||||
/// Drag rows in the Layers panel.
|
||||
fn move_rows(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "layer.move";
|
||||
let mut ids = ids_param(p, "ids", C)?.or_else(|| id_param(p, "id").map(|i| vec![i])).ok_or_else(|| bad(C, "missing ids"))?;
|
||||
let mut ids = match ids_param(p, "ids", C)? {
|
||||
Some(ids) => ids,
|
||||
None => vec![object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing ids"))?],
|
||||
};
|
||||
ids.truncate(MAX_ROWS);
|
||||
let target = id_param(p, "target").ok_or_else(|| bad(C, "missing target"))?;
|
||||
let target = object_param(p, "target", C)?.ok_or_else(|| bad(C, "missing target"))?;
|
||||
let place = match str_param(p, "place").unwrap_or("inside") {
|
||||
"above" => Place::Above,
|
||||
"below" => Place::Below,
|
||||
@@ -831,8 +834,8 @@ fn move_rows(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn move_node(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "node.move";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let parent = id_param(p, "parent");
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let parent = object_param(p, "parent", C)?;
|
||||
let index = p.get("index").and_then(Value::as_u64).map_or(usize::MAX, index);
|
||||
let d = &s.doc()?.doc;
|
||||
let n = d.node(id).ok_or(EngineError::NoNode(id))?;
|
||||
|
||||
@@ -21,7 +21,7 @@ use super::expand::gradient_sampler;
|
||||
use super::pathops::Beside;
|
||||
use super::{
|
||||
CommandSpec, EngineError, Result, Session, always, bad, check_numbers, cmd, color_param, f64_or, f64_req, finite_numbers, has_doc, has_multi,
|
||||
has_selection, id_param, named_ids, number_or, ok, str_param, switch_or, text_param,
|
||||
has_selection, named_ids, number_or, object_param, ok, str_param, switch_or, text_param,
|
||||
};
|
||||
|
||||
mod blend;
|
||||
|
||||
@@ -324,7 +324,11 @@ pub(super) fn spine_remove_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
if anchors.contains(&index) {
|
||||
return Err(bad(C, "a key object sits on that point"));
|
||||
}
|
||||
if sp.anchors.len() <= 2 {
|
||||
// A closed spine pinned open keeps a copy of its first point at its end (#6809), so the
|
||||
// points left must be two apart, not only two in number.
|
||||
let mut rest = sp.anchors.iter().enumerate().filter(|(i, _)| *i != index).map(|(_, a)| a.p);
|
||||
let first = rest.next();
|
||||
if sp.anchors.len() <= 2 || first.is_none_or(|f| rest.all(|q| q.distance(f) < 0.01)) {
|
||||
return Err(bad(C, "a spine keeps at least two points"));
|
||||
}
|
||||
sp.anchors.remove(index);
|
||||
|
||||
@@ -3,7 +3,7 @@ use super::common::{fix_ids, ids_json, is_envelope, roots_param, selected_of, wr
|
||||
use super::mesh::{handle_param, index_param, whole};
|
||||
use super::{
|
||||
Affine, Appearance, Arc, Beside, Color, Document, EngineError, EnvelopeKind, EnvelopeMap, EnvelopeOptions, Node, NodeId, NodeKind, Paint,
|
||||
PathData, Point, PreserveShape, Result, Session, Value, bad, check_numbers, f64_or, f64_req, id_param, json, live, ok, switch_or, text_param,
|
||||
PathData, Point, PreserveShape, Result, Session, Value, bad, check_numbers, f64_or, f64_req, json, live, object_param, ok, switch_or, text_param,
|
||||
};
|
||||
|
||||
// ---------- Envelope ----------
|
||||
@@ -419,7 +419,7 @@ pub(super) fn env_edit_contents(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
pub(super) fn env_set_mesh_point(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "object.envelope.setMeshPoint";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let index = index_param(p, "index", C)?;
|
||||
let q = Point::new(f64_req(p, "x", C)?, f64_req(p, "y", C)?);
|
||||
let handle = handle_param(p, C)?;
|
||||
|
||||
@@ -4,7 +4,7 @@ use super::common::{fix_ids, ids_json, is_mesh, replace_with, roots_param, selec
|
||||
use super::envelope::{outline_of, rows_cols};
|
||||
use super::{
|
||||
Color, Document, EngineError, EnvelopeKind, GradientMesh, MeshAppearance, Node, NodeId, NodeKind, Paint, Point, Result, Session, Value, bad,
|
||||
check_numbers, color_param, f64_or, f64_req, finite_numbers, gradient_sampler, id_param, json, live, ok, str_param,
|
||||
check_numbers, color_param, f64_or, f64_req, finite_numbers, gradient_sampler, json, live, object_param, ok, str_param,
|
||||
};
|
||||
|
||||
// ---------- Gradient mesh ----------
|
||||
@@ -115,7 +115,7 @@ fn image_mesh(d: &Document, im: &vectorcraft_doc::ImageObject, rows: u32, cols:
|
||||
/// Run `f` on the gradient mesh `p.id` (one undo step `label`); with `envelopes`, a mesh
|
||||
/// envelope's grid too (see [`edit_grid`]).
|
||||
fn with_mesh<T>(s: &mut Session, p: &Value, cmd: &str, label: &str, envelopes: bool, f: impl FnOnce(&mut GradientMesh) -> Result<T>) -> Result<T> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(cmd, "missing `id`"))?;
|
||||
let id = object_param(p, "id", cmd)?.ok_or_else(|| bad(cmd, "missing `id`"))?;
|
||||
s.edit(label, move |d, _| edit_grid(d, id, cmd, envelopes, f))
|
||||
}
|
||||
|
||||
@@ -147,7 +147,7 @@ const MAX_POINTS: usize = 1 << 20;
|
||||
/// points}…]}`. Each mesh comes once, with its points in order and without repeats.
|
||||
fn point_items(p: &Value, cmd: &str) -> Result<Vec<(NodeId, BTreeSet<usize>)>> {
|
||||
let one = |q: &Value| -> Result<(NodeId, BTreeSet<usize>)> {
|
||||
let id = id_param(q, "id").ok_or_else(|| bad(cmd, "missing `id`"))?;
|
||||
let id = object_param(q, "id", cmd)?.ok_or_else(|| bad(cmd, "missing `id`"))?;
|
||||
let points = match q.get("points") {
|
||||
None | Some(Value::Null) => BTreeSet::from([index_param(q, "index", cmd)?]),
|
||||
Some(Value::Array(v)) if v.len() <= MAX_POINTS => v
|
||||
|
||||
@@ -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\"|\"lineEndHalf\" (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 tenth of an em each, pushOutFirst does so only when moving the character before them to the next line would leave
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\"|\"lineEndHalf\" (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 tenth of an em each, pushOutFirst does so only when moving the character before them to the next line would leave
Line truncated
|
||||
has_doc,
|
||||
set_format
|
||||
),
|
||||
@@ -482,6 +482,7 @@ fn set_format(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
"hyphenate",
|
||||
"hyphenateCapitalized",
|
||||
"romanHangingPunctuation",
|
||||
"koreanLineBreakAnywhere",
|
||||
],
|
||||
C,
|
||||
)?;
|
||||
@@ -552,6 +553,7 @@ fn set_format(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
"fontAxes",
|
||||
"burasagari",
|
||||
"romanHangingPunctuation",
|
||||
"koreanLineBreakAnywhere",
|
||||
"kashida",
|
||||
"composer",
|
||||
];
|
||||
@@ -879,6 +881,9 @@ fn set_format(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
if let Some(v) = flag("romanHangingPunctuation") {
|
||||
para.roman_hanging = v;
|
||||
}
|
||||
if let Some(v) = flag("koreanLineBreakAnywhere") {
|
||||
para.korean_line_break_anywhere = v;
|
||||
}
|
||||
if let Some(v) = kashida {
|
||||
para.kashida = v;
|
||||
}
|
||||
|
||||
@@ -12,7 +12,7 @@ use super::draw2::usize_opt;
|
||||
use super::pathops::Beside;
|
||||
use super::{
|
||||
CommandSpec, Result, Session, bad, check_numbers, check_switches, cmd, f64_or, f64_req, finite_numbers, has_anchors, has_doc, has_selected_path,
|
||||
has_selection, id_param, ids_param, index, number_or, ok, str_param, switch_or, targets,
|
||||
has_selection, ids_param, index, number_or, object_param, ok, str_param, switch_or, targets,
|
||||
};
|
||||
use crate::EngineError;
|
||||
|
||||
@@ -168,7 +168,7 @@ pub(super) fn path_mut(d: &mut vectorcraft_doc::Document, id: NodeId) -> Result<
|
||||
}
|
||||
|
||||
fn append_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.appendAnchor", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.appendAnchor")?.ok_or_else(|| bad("path.appendAnchor", "missing id"))?;
|
||||
let a = anchor_from_json(p, "path.appendAnchor")?;
|
||||
let subpath = p.get("subpath").and_then(Value::as_u64).map(|u| u as usize);
|
||||
s.edit("Pen", |d, sel| {
|
||||
@@ -206,7 +206,7 @@ fn append_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
/// incoming handle moves as Move Direction Handle moves it: the outgoing handle turns with it only
|
||||
/// on a smooth anchor, so the first segment of a path that starts at a corner keeps its shape.
|
||||
fn close(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.close", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.close")?.ok_or_else(|| bad("path.close", "missing id"))?;
|
||||
let subpath = p.get("subpath").and_then(Value::as_u64).map(|u| u as usize);
|
||||
let handle = |key: &str| match p.get(key).filter(|h| !h.is_null()) {
|
||||
None => Ok(None),
|
||||
@@ -303,7 +303,7 @@ pub(crate) fn transform_anchors(s: &mut Session, label: &str, xf: vectorcraft_ge
|
||||
}
|
||||
|
||||
fn set_handle(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.setHandle", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.setHandle")?.ok_or_else(|| bad("path.setHandle", "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", "path.setHandle")?.unwrap_or(0);
|
||||
let ai = p.get("anchor").and_then(Value::as_u64).map(index).ok_or_else(|| bad("path.setHandle", "missing anchor"))?;
|
||||
let out = str_param(p, "which") != Some("in");
|
||||
@@ -321,7 +321,7 @@ fn set_handle(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
/// `path.moveAnchor`: one anchor to (x, y), its handles keeping their offsets (the Anchor Point
|
||||
/// tool's Shift-drag).
|
||||
fn move_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.moveAnchor", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.moveAnchor")?.ok_or_else(|| bad("path.moveAnchor", "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", "path.moveAnchor")?.unwrap_or(0);
|
||||
let ai = p.get("anchor").and_then(Value::as_u64).map(index).ok_or_else(|| bad("path.moveAnchor", "missing anchor"))?;
|
||||
let pos = Point::new(f64_req(p, "x", "path.moveAnchor")?, f64_req(p, "y", "path.moveAnchor")?);
|
||||
@@ -341,7 +341,7 @@ fn move_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
}
|
||||
|
||||
fn set_anchors(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.setAnchors", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.setAnchors")?.ok_or_else(|| bad("path.setAnchors", "missing id"))?;
|
||||
let subs = p.get("subpaths").and_then(Value::as_array).ok_or_else(|| bad("path.setAnchors", "missing subpaths"))?;
|
||||
let data = PathData::new(
|
||||
subs.iter()
|
||||
@@ -1562,7 +1562,7 @@ fn renumber_after_insert(sel: &mut Selection, id: NodeId, si: usize, added: usiz
|
||||
}
|
||||
|
||||
fn reshape(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.reshape", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.reshape")?.ok_or_else(|| bad("path.reshape", "missing id"))?;
|
||||
let at = Point::new(f64_req(p, "x", "path.reshape")?, f64_req(p, "y", "path.reshape")?);
|
||||
check_numbers(p, &["dx", "dy", "tol", "radius"], "path.reshape")?;
|
||||
let delta = Vec2::new(f64_or(p, "dx", 0.0), f64_or(p, "dy", 0.0));
|
||||
@@ -1684,7 +1684,7 @@ fn reshape(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
}
|
||||
|
||||
fn insert_anchor(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("path.insertAnchor", "missing id"))?;
|
||||
let id = object_param(p, "id", "path.insertAnchor")?.ok_or_else(|| bad("path.insertAnchor", "missing id"))?;
|
||||
let si = usize_opt(p, "subpath", "path.insertAnchor")?.unwrap_or(0);
|
||||
let seg = p.get("segment").and_then(Value::as_u64).map(index).ok_or_else(|| bad("path.insertAnchor", "missing segment"))?;
|
||||
let t = number_or(p, "t", 0.5, "path.insertAnchor")?.clamp(0.0, 1.0);
|
||||
|
||||
@@ -32,6 +32,7 @@ pub(super) const ALLOWED: &[&str] = &[
|
||||
"addon.color.strokeToFill",
|
||||
"addon.color.swatchLegend",
|
||||
"addon.contour.set",
|
||||
"addon.cutting.bridges",
|
||||
"addon.image.removeBackground",
|
||||
"addon.pathtools.addPoints",
|
||||
"addon.pathtools.close",
|
||||
@@ -110,6 +111,7 @@ pub(super) const ALLOWED: &[&str] = &[
|
||||
"brush.options",
|
||||
"brush.placeArt",
|
||||
"brush.remove",
|
||||
"brush.replaceArt",
|
||||
"brush.selectionArt",
|
||||
"brush.setCurrent",
|
||||
"brush.unused",
|
||||
|
||||
@@ -19,7 +19,9 @@
|
||||
//! while their copies are restored or discarded the area is held, so two apps launched together
|
||||
//! never both take it. An area's lock file or folder can be removed while its app runs, so each
|
||||
//! recovery save and heartbeat checks that the lock still holds the area, and locks it again or
|
||||
//! takes a new area.
|
||||
//! takes a new area. The copies it had in the old area stay there until it has written them again
|
||||
//! in the new one, and an entry `<new area>/keeps-<old area>` ([`mark_left`]) tells other apps
|
||||
//! that those copies belong to a running app, so none of them offers or discards them meanwhile.
|
||||
//!
|
||||
//! A heartbeat alone can't tell a gone app from one whose timers stopped (a background tab), so
|
||||
//! when unsure an area counts as held, and its app repairs what another app did meanwhile: each
|
||||
@@ -61,6 +63,9 @@ const BLOB_EXT: &str = ".blob";
|
||||
/// The heartbeat entry of an area in a store without locks: when its app last said it runs (Unix
|
||||
/// seconds, as text).
|
||||
const BEAT: &str = "heartbeat";
|
||||
/// The start of an entry `<area>/keeps-<left area>`: the app holding `<area>` still keeps the copies
|
||||
/// it left in `<left area>` ([`mark_left`]).
|
||||
const KEEPS: &str = "keeps-";
|
||||
/// The least time without a heartbeat after which an area's app counts as gone (seconds); else
|
||||
/// three Data Recovery intervals.
|
||||
const MIN_STALE: i64 = 180;
|
||||
@@ -535,6 +540,8 @@ pub struct Recovery {
|
||||
/// store: each stays until its document has a copy in the new area, or needs none. They are
|
||||
/// still this session's: never offered or discarded as a crash's here.
|
||||
left: BTreeMap<u64, (Arc<dyn RecoveryStore>, String)>,
|
||||
/// The `<own area>/keeps-<left area>` entries this session wrote in its area ([`mark_left`]).
|
||||
marked: BTreeSet<String>,
|
||||
}
|
||||
|
||||
impl Recovery {
|
||||
@@ -609,6 +616,15 @@ fn beating(store: &dyn RecoveryStore, area: &str, stale: i64, mine: Option<i64>)
|
||||
/// beat only lets another app offer the copies once three intervals have passed.
|
||||
pub fn heartbeat(s: &mut Session) -> Vec<u64> {
|
||||
let mut lost = keep_hold(s);
|
||||
// An entry that couldn't be written before, or that was removed since (by the user, a
|
||||
// cleaner), is written now.
|
||||
if let Some(own) = &s.recovery.own
|
||||
&& !s.recovery.marked.is_empty()
|
||||
&& let Ok(names) = own.store.list()
|
||||
{
|
||||
s.recovery.marked.retain(|n| names.contains(n));
|
||||
}
|
||||
mark_left(s);
|
||||
if let Some(own) = s.recovery.own.as_ref().filter(|o| o.beats) {
|
||||
let _ = beat(own.store.as_ref(), &own.area);
|
||||
}
|
||||
@@ -678,6 +694,36 @@ fn drop_left(s: &mut Session, uid: u64) {
|
||||
let meta = store.remove(&format!("{file}{META_EXT}"));
|
||||
if doc.is_ok() && meta.is_ok() {
|
||||
s.recovery.left.remove(&uid);
|
||||
mark_left(s);
|
||||
}
|
||||
}
|
||||
|
||||
/// Record in this session's area each area it left that still holds copies of its documents: an
|
||||
/// entry `<own area>/keeps-<left area>`, so another app leaves those copies alone while this one
|
||||
/// runs ([`keeper`]). The entries of areas that hold none of its copies any more go. Best effort:
|
||||
/// an entry not written or removed now is written or removed at the next heartbeat.
|
||||
fn mark_left(s: &mut Session) {
|
||||
let Some(own) = &s.recovery.own else { return };
|
||||
let (store, area) = (own.store.clone(), own.area.clone());
|
||||
let want: BTreeSet<String> = s
|
||||
.recovery
|
||||
.left
|
||||
.values()
|
||||
.filter(|(st, _)| st.location() == store.location())
|
||||
.filter_map(|(_, f)| f.split_once('/').map(|(a, _)| a))
|
||||
.filter(|a| *a != area)
|
||||
.map(|a| format!("{area}/{KEEPS}{a}"))
|
||||
.collect();
|
||||
let gone: Vec<String> = s.recovery.marked.difference(&want).cloned().collect();
|
||||
for n in gone {
|
||||
if store.remove(&n).is_ok() {
|
||||
s.recovery.marked.remove(&n);
|
||||
}
|
||||
}
|
||||
for n in want {
|
||||
if !s.recovery.marked.contains(&n) && store.write(&n, b"").is_ok() {
|
||||
s.recovery.marked.insert(n);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -726,6 +772,9 @@ pub fn claim(s: &mut Session, store: &Arc<dyn RecoveryStore>) -> Result<String>
|
||||
}
|
||||
};
|
||||
s.recovery.own = Some(Own { store: store.clone(), area: area.clone(), hold, beats });
|
||||
// The entries written before are in the area this session had (released or left).
|
||||
s.recovery.marked.clear();
|
||||
mark_left(s);
|
||||
return Ok(area);
|
||||
}
|
||||
Err(EngineError::Other("no free recovery area".into()))
|
||||
@@ -742,6 +791,8 @@ pub fn release(s: &mut Session) {
|
||||
drop_left(s, uid);
|
||||
}
|
||||
let Some(Own { store, area, hold, .. }) = s.recovery.own.take() else { return };
|
||||
// Its `keeps-` entries go with the area's other entries.
|
||||
s.recovery.marked.clear();
|
||||
let mine = |n: &String| n.split_once('/').is_some_and(|(a, _)| a == area);
|
||||
for name in store.list().unwrap_or_default().iter().filter(|n| mine(n)) {
|
||||
let _ = store.remove(name);
|
||||
@@ -987,6 +1038,7 @@ impl RecoveryJob {
|
||||
let _ = store.remove(&format!("{file}{DOC_EXT}"));
|
||||
let _ = store.remove(&format!("{file}{META_EXT}"));
|
||||
}
|
||||
mark_left(s);
|
||||
}
|
||||
// Best effort, as in `remove_copy`.
|
||||
_ => {
|
||||
@@ -1208,6 +1260,10 @@ fn owner(s: &mut Session, store: &dyn RecoveryStore, area: &str, hold: &mut Vec<
|
||||
}
|
||||
match store.lock(area) {
|
||||
Ok(Lock::Held(h)) => {
|
||||
// Copies an app left here when it had to leave the area stay its own while it runs.
|
||||
if let Some(who) = keeper(s, store, area) {
|
||||
return who;
|
||||
}
|
||||
hold.push(h);
|
||||
Owner::Gone
|
||||
}
|
||||
@@ -1216,6 +1272,9 @@ fn owner(s: &mut Session, store: &dyn RecoveryStore, area: &str, hold: &mut Vec<
|
||||
if store.announced(area).unwrap_or(false) || beating(store, area, stale_after(s), s.recovery.adopted.get(area).copied()) {
|
||||
return Owner::Running;
|
||||
}
|
||||
if let Some(who) = keeper(s, store, area) {
|
||||
return who;
|
||||
}
|
||||
// Best effort: without it another app might offer the copies too, which loses nothing.
|
||||
if take && let Ok(t) = beat(store, area) {
|
||||
s.recovery.adopted.insert(area.to_string(), t);
|
||||
@@ -1225,6 +1284,42 @@ fn owner(s: &mut Session, store: &dyn RecoveryStore, area: &str, hold: &mut Vec<
|
||||
}
|
||||
}
|
||||
|
||||
/// Who keeps the copies left in `area` by an app that had to leave it, from the entries
|
||||
/// `<its area>/keeps-<area>` ([`mark_left`]): this session, or another app that is running. `None`:
|
||||
/// no app that runs keeps them. An entry counts only in an area this account can lock or tell is
|
||||
/// held ([`holder`]), so an entry in a folder of another account, or in one whose lock can't be
|
||||
/// checked, keeps nothing. A store that can't be listed now keeps them (a copy kept loses nothing).
|
||||
fn keeper(s: &Session, store: &dyn RecoveryStore, area: &str) -> Option<Owner> {
|
||||
let Ok(names) = store.list() else { return Some(Owner::Running) };
|
||||
let mark = format!("/{KEEPS}{area}");
|
||||
let mut who = None;
|
||||
for k in names.iter().filter_map(|n| n.strip_suffix(mark.as_str())).filter(|k| *k != area) {
|
||||
match holder(s, store, k) {
|
||||
Owner::Mine => return Some(Owner::Mine),
|
||||
Owner::Running => who = Some(Owner::Running),
|
||||
Owner::Gone => {}
|
||||
}
|
||||
}
|
||||
who
|
||||
}
|
||||
|
||||
/// Whose area `area` is, without taking it over: this session's, a running app's, or nobody's (a
|
||||
/// lock taken to tell goes at once). An area whose lock fails (not a recovery area of this
|
||||
/// account, a lock file that can't be opened) is nobody's.
|
||||
fn holder(s: &Session, store: &dyn RecoveryStore, area: &str) -> Owner {
|
||||
if s.recovery.own.as_ref().is_some_and(|o| o.area == area && o.store.location() == store.location()) {
|
||||
return Owner::Mine;
|
||||
}
|
||||
match store.lock(area) {
|
||||
Ok(Lock::Held(_)) | Err(_) => Owner::Gone,
|
||||
Ok(Lock::Busy) => Owner::Running,
|
||||
Ok(Lock::Unsupported) => {
|
||||
let runs = store.announced(area).unwrap_or(false) || beating(store, area, stale_after(s), s.recovery.adopted.get(area).copied());
|
||||
if runs { Owner::Running } else { Owner::Gone }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Tidy away a gone app's area `area` once no copies are left in it, then let it go (`hold`). The
|
||||
/// area is removed while it is still held, so an app taking a new area of that name meanwhile
|
||||
/// finds it held or gone and takes the next name.
|
||||
|
||||
@@ -32,7 +32,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Run Script",
|
||||
[],
|
||||
None,
|
||||
"{path?: a .js or .jsx file | source?: the script's text (exactly one of the two), name?: the name errors and the report use (default: the script's #script line, else the path's file name, or \"script\"), args?: {…} (at most 1 MiB as JSON; vc.args in the script), answers?: [{kind: alert|confirm|prompt, value: \"ok\" (alert) | true or false (confirm) | text or null (prompt)}] (for a run with nobody to ask: the answers to its dialogs, in order; at most 10000 and 1 MiB as JSON; refused in the app, where the person answers; an empty object is an empty list), maxFuel?: whole number from 1 to 100000000000 (instructions in all; default 1000000000)} run a JavaScript file against the open documents, through the vc object: vc.run(id, params) runs a command and returns its result, a failed command throws an error the script can catch and puts back the documents and the session state it changed, while any file it wrote stays written and is named; vc.document is a snapshot of the active document or null; vc.commands lists the commands a script may run; vc.log(value) adds to the report and the Script Console (script.console); $.write(...values) writes the values to the Script Console as String(value) gives them, and $.writeln(...values) does the same and ends the line; $.evalFile(path, timeout?) runs a file with the same globals and returns its last value (timeout, in milliseconds from 0, is taken and not waited on), $.fileName is the file being run (empty for text), $.includePath the #includepath list and $.engineName the engine's name (VectorCraft without #targetengine); alert(message[, title, errorIcon]), confirm(message[, noAsDflt, title]) and prompt(message, preset[, title]) open a dialog with a Stop button (default title \"Script Alert\"; message and preset as String(value) gives them; errorIcon and noAsDflt as Boolean(value) gives them; No is the default with noAsDflt): alert returns undefined, confirm true for Yes and false for No, prompt the field's text for OK and null for Cancel; in the app the run waits at the call for the person's answer and Stop ends it as script.stop does, a dialog cannot open inside a callback of a built-in, a getter, a conversion or a file $.evalFile runs and throws there (an #include file's code is the script's own and can), and a run with nobody to ask takes the next of answers, and ends when none is left or the next is for another kind of dialog, or when the script ends with answers unused; vc.args is args. Before anything runs, the script's preprocessor lines (# or //@ at the start of a line, outside strings and comments) are read: #include \"file\" and //@include put that file's text in place of the line, looked for beside the file that includes it, then in each #includepath folder in turn (separated by ;, relative to that file's folder; a later #includepath replaces the list), then in each JSINCLUDE folder; #script names the run; #target takes any value and changes nothing; #strict on makes an assignment to a read-only or getter-only property, or a new property on an object that is not extensible (preventExtensions, seal, freeze, vc, $), throw a TypeError, without the rest of ES5 strict mode, and #strict off turns that off (the last #strict line of the script and its includes sets the run; off without one; a $.evalFile file's own line holds for its code); #targetengine name runs the script in the named engine, whose globals and functions stay for the next run that names it until script.engine.drop drops it or the session ends (script.engines lists them; a name of letters, digits and _ not starting with a digit, or a quoted one of 1 to 64 bytes without control characters, matched as written; only in the script itself, once, before its code and #include lines; main, and a script without the line, get a new engine each run; a session keeps 8 named engines, a ninth name is refused, each has 64 MiB of heap, and an uncaught error, a limit or script.stop keeps the globals the run set while the documents go back; host functions kept in a global act for the run that calls them; not on the web); #engine is refused as unsupported, any other #name as unknown, and another //@name is a comment. A script run from a file reads its includes and $.evalFile's files only in that file's folder and the folders below it, refusing a path with a .. name or a link that leads out (a JSINCLUDE folder outside is passed over); a script given as text reads none. File(path) and Folder(path) name files and folders and read them in the same folders, and inside the automation read roots when they are set: exists, length, created, modified, getFiles(mask or function; at most 2048 entries), resolve, and open('r') with read, readln, readch, seek, tell and close; a path outside, a network or device path and a link that leads out give false or null with error \"Script file access denied\", a file is read whole at most 8 MiB (checked from its size first) and a run reads at most 32 MiB, and writing, the file
Line truncated
|
||||
"{path?: a .js or .jsx file | source?: the script's text (exactly one of the two), name?: the name errors and the report use (default: the script's #script line, else the path's file name, or \"script\"), args?: {…} (at most 1 MiB as JSON; vc.args in the script), answers?: [{kind: alert|confirm|prompt, value: \"ok\" (alert) | true or false (confirm) | text or null (prompt)}] (for a run with nobody to ask: the answers to its dialogs, in order; at most 10000 and 1 MiB as JSON; refused in the app, where the person answers; an empty object is an empty list), maxFuel?: whole number from 1 to 100000000000 (instructions in all; default 1000000000)} run a JavaScript file against the open documents, through the vc object: vc.run(id, params) runs a command and returns its result, a failed command throws an error the script can catch and puts back the documents and the session state it changed, while any file it wrote stays written and is named; vc.document is a snapshot of the active document or null; vc.commands lists the commands a script may run; vc.log(value) adds to the report and the Script Console (script.console); $.write(...values) writes the values to the Script Console as String(value) gives them, and $.writeln(...values) does the same and ends the line; $.evalFile(path, timeout?) runs a file with the same globals and returns its last value (timeout, in milliseconds from 0, is taken and not waited on), $.fileName is the file being run (empty for text), $.includePath the #includepath list and $.engineName the engine's name (VectorCraft without #targetengine); alert(message[, title, errorIcon]), confirm(message[, noAsDflt, title]) and prompt(message, preset[, title]) open a dialog with a Stop button (default title \"Script Alert\"; message and preset as String(value) gives them; errorIcon and noAsDflt as Boolean(value) gives them; No is the default with noAsDflt): alert returns undefined, confirm true for Yes and false for No, prompt the field's text for OK and null for Cancel; in the app the run waits at the call for the person's answer and Stop ends it as script.stop does, a dialog cannot open inside a callback of a built-in, a getter, a conversion or a file $.evalFile runs and throws there (an #include file's code is the script's own and can), and a run with nobody to ask takes the next of answers, and ends when none is left or the next is for another kind of dialog, or when the script ends with answers unused; vc.args is args. Before anything runs, the script's preprocessor lines (# or //@ at the start of a line, outside strings and comments) are read: #include \"file\" and //@include put that file's text in place of the line, looked for beside the file that includes it, then in each #includepath folder in turn (separated by ;, relative to that file's folder; a later #includepath replaces the list), then in each JSINCLUDE folder; #script names the run; #target takes any value and changes nothing; #strict on makes an assignment to a read-only or getter-only property, or a new property on an object that is not extensible (preventExtensions, seal, freeze, vc, $), throw a TypeError, without the rest of ES5 strict mode, and #strict off turns that off (the last #strict line of the script and its includes sets the run; off without one; a $.evalFile file's own line holds for its code); #targetengine name runs the script in the named engine, whose globals and functions stay for the next run that names it until script.engine.drop drops it or the session ends (script.engines lists them; a name of letters, digits and _ not starting with a digit, or a quoted one of 1 to 64 bytes without control characters, matched as written; only in the script itself, once, before its code and #include lines; main, and a script without the line, get a new engine each run; a session keeps 8 named engines, a ninth name is refused, each has 64 MiB of heap, and an uncaught error, a limit or script.stop keeps the globals the run set while the documents go back; host functions kept in a global act for the run that calls them; an error in code an earlier run compiled is at that run's file, line and column, within 8 MiB of source maps kept for each engine, the oldest going first; not on the web); #engine is refused as unsupported, any other #name as unknown, and another //@name is a comment. A script run from a file reads its includes and $.evalFile's files only in that file's folder and the folders below it, refusing a path with a .. name or a link that leads out (a JSINCLUDE folder outside is passed over); a script given as text reads none. File(path) and Folder(path) name files and folders and read them in the same folders, and inside the automation read roots when they are set: exists, length, created, modified, getFiles(mask or function; at most 2048 entries), resolve, and open('r') with read, readln, readch, seek, tell and close; a path outside, a network or device path and a link that leads out give false or null with
Line truncated
|
||||
always,
|
||||
run
|
||||
),
|
||||
|
||||
@@ -13,8 +13,8 @@ use vectorcraft_doc::{Appearance, CellAlign, CellVAlign, Document, Node, NodeKin
|
||||
use vectorcraft_geom::{Rect, shapes};
|
||||
|
||||
use super::{
|
||||
CommandSpec, EngineError, NodeId, Result, Session, bad, cmd, f64_req, has_doc, has_selection, id_param, ids_param, index, number_or, switch_or,
|
||||
targets,
|
||||
CommandSpec, EngineError, NodeId, Result, Session, bad, cmd, f64_req, has_doc, has_selection, ids_param, index, number_or, object_param,
|
||||
switch_or, targets,
|
||||
};
|
||||
|
||||
/// The most slices one Divide Slices makes.
|
||||
@@ -680,7 +680,7 @@ fn create(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn set_rect(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "object.slice.setRect";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let r = rect_param(p, C)?;
|
||||
let d = &s.doc()?.doc;
|
||||
if d.slice(id).is_none() {
|
||||
|
||||
@@ -206,11 +206,31 @@ fn no_targets(ids: &[vectorcraft_doc::NodeId], p: &Value) -> bool {
|
||||
ids.is_empty() && p.get("ids").is_none() && p.get("id").is_none()
|
||||
}
|
||||
|
||||
/// The objects `stroke.set` edits with no `item`: a selected group or layer with a stroke row of
|
||||
/// its own edits that row, as the Stroke panel does with the group targeted (#6739); the other
|
||||
/// targets reach their painted leaves, as before.
|
||||
fn own_stroke_or_leaves(s: &Session, p: &Value) -> Result<Vec<vectorcraft_doc::NodeId>> {
|
||||
let picked = super::targets(s, p)?;
|
||||
let d = &s.doc()?.doc;
|
||||
let own = |id: &vectorcraft_doc::NodeId| {
|
||||
d.node(*id).is_some_and(|n| {
|
||||
matches!(n.kind, NodeKind::Group { .. } | NodeKind::Layer { .. }) && !n.is_compound_shape() && n.appearance.stroke().is_some()
|
||||
})
|
||||
};
|
||||
let (mut out, rest): (Vec<_>, Vec<_>) = picked.into_iter().partition(own);
|
||||
for id in super::leaf_targets(s, &rest)? {
|
||||
if !out.contains(&id) {
|
||||
out.push(id);
|
||||
}
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
fn stroke_set(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "stroke.set";
|
||||
let change = StrokeChange::parse(p, C)?;
|
||||
let item = item_target(s, p, C)?.of_kind(s, false);
|
||||
let mut ids = item.targets(s, p)?;
|
||||
let mut ids = if item == ItemTarget::Top { own_stroke_or_leaves(s, p)? } else { item.targets(s, p)? };
|
||||
let new_art = no_targets(&ids, p);
|
||||
if item == ItemTarget::Top {
|
||||
// Images and symbol instances take no stroke from the panel.
|
||||
@@ -261,7 +281,11 @@ fn stroke_set(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
return Ok(());
|
||||
}
|
||||
if index.is_none() && n.appearance.stroke().is_none() {
|
||||
n.appearance.set_stroke(Paint::solid(Color::BLACK));
|
||||
// Options alone (cap, join, miter limit, dashes, alignment) don't make a stroke
|
||||
// visible: the row made for them has no paint. A weight, an arrowhead or a profile
|
||||
// still gives the object the black stroke the panel draws (#6739).
|
||||
let visible = change.weight.is_some() || sa.is_some() || ea.is_some() || profile.is_some();
|
||||
n.appearance.set_stroke(if visible { Paint::solid(Color::BLACK) } else { Paint::None });
|
||||
}
|
||||
if let Some(st) = n.appearance.stroke_at_mut(index) {
|
||||
set(st);
|
||||
|
||||
@@ -19,7 +19,7 @@ use vectorcraft_doc::symbol_overrides::SymbolOverride;
|
||||
use vectorcraft_doc::{Document, Node, NodeId, NodeKind, Selection, SymbolEdit, SymbolRegistration};
|
||||
use vectorcraft_geom::{Affine, Point};
|
||||
|
||||
use super::brushsym::{natural_size, place_xf};
|
||||
use super::brushsym::{fit_parts, natural_size, place_xf};
|
||||
use super::{EngineError, Result, Session, bad, number_or, object_param, ok, str_param};
|
||||
|
||||
/// The name of the undo step that enters symbol editing mode.
|
||||
@@ -425,8 +425,8 @@ fn each_changed_instance(n: &mut Node, name: &str, f: &mut dyn FnMut(&mut Vec<Sy
|
||||
}
|
||||
|
||||
/// Each instance's appearance changes to objects of symbol `name`'s art follow those objects
|
||||
/// through an edit of the editing layer (see [`follow_paths`]), and keep only the changes to
|
||||
/// objects the art still has. That covers the instances on the layers and in the art of the
|
||||
/// through an edit of the editing layer (see [`follow_paths`]), and keep only the changes the art
|
||||
/// still draws ([`fit_parts`]). That covers the instances on the layers and in the art of the
|
||||
/// document's other symbols, graph designs, pattern tiles (the tiles pattern editing's Cancel puts
|
||||
/// back included) and brushes, opacity-mask art included. The editing layer holds no instance of
|
||||
/// the symbol, since [`sync`] refuses one.
|
||||
@@ -435,7 +435,7 @@ fn follow_objects(d: &mut Document, name: &str, old: (&[Arc<Node>], bool), new:
|
||||
let mut follow = |o: &mut Vec<SymbolOverride>| {
|
||||
follow_paths(o, old, new);
|
||||
match &art {
|
||||
Some(art) => vectorcraft_doc::symbol_overrides::retain_parts(o, art),
|
||||
Some(art) => fit_parts(o, art),
|
||||
None => o.clear(),
|
||||
}
|
||||
};
|
||||
|
||||
@@ -13,7 +13,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Set Tab Stops",
|
||||
["Window", "Tabs"],
|
||||
None,
|
||||
"{stops: [{position: pt, align?: left|center|right|decimal, leader?: \". \", alignOn?: \".\"}], ids?|id?, start?: byte, end?: byte} replace the tab stops of the selected text (with a range: of the paragraphs it touches); at most 256 stops, positions 0..=100000 pt; supplied align, leader and alignOn must be strings, a leader has at most 8 characters and alignOn exactly one; stops are sorted by position, and of stops at one position the first given is kept",
|
||||
"{stops: [{position: pt, align?: left|center|right|decimal, leader?: \". \", alignOn?: \".\"}], ids?|id?, start?: byte, end?: byte} replace the tab stops of the selected text (with a range: of the paragraphs it touches); at most 256 stops, or no more than each targeted paragraph already holds, positions 0..=100000 pt; supplied align, leader and alignOn must be strings, a leader has at most 8 characters and alignOn exactly one; stops are sorted by position, and of stops at one position the first given is kept",
|
||||
has_selection,
|
||||
set
|
||||
),
|
||||
@@ -38,10 +38,6 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
fn parse_stops(p: &Value) -> Result<Vec<TabStop>> {
|
||||
const C: &str = "text.tabs.set";
|
||||
let arr = p.get("stops").and_then(Value::as_array).ok_or_else(|| bad(C, "missing stops"))?;
|
||||
let max = TabStop::MAX_STOPS;
|
||||
if arr.len() > max {
|
||||
return Err(bad(C, format!("at most {max} tab stops")));
|
||||
}
|
||||
let mut stops = vec![];
|
||||
for s in arr {
|
||||
let position = s.get("position").and_then(Value::as_f64).ok_or_else(|| bad(C, "each stop needs a position"))?;
|
||||
@@ -90,10 +86,39 @@ fn parse_stops(p: &Value) -> Result<Vec<TabStop>> {
|
||||
}
|
||||
|
||||
fn set(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
// More than the limit is taken only when every targeted paragraph already holds at least as
|
||||
// many stops, so a paragraph that holds more can still lose them one at a time. The supplied
|
||||
// list is counted before it is read.
|
||||
let max = TabStop::MAX_STOPS;
|
||||
let supplied = p.get("stops").and_then(Value::as_array).map_or(0, Vec::len);
|
||||
if supplied > max && supplied > fewest_held(s, p)? {
|
||||
return Err(bad("text.tabs.set", format!("at most {max} tab stops")));
|
||||
}
|
||||
let stops = parse_stops(p)?;
|
||||
apply(s, p, stops, "Tab Stops")
|
||||
}
|
||||
|
||||
/// The fewest tab stops a paragraph that `text.tabs.set` with `p` targets holds (0 with none).
|
||||
fn fewest_held(s: &Session, p: &Value) -> Result<usize> {
|
||||
let ids = text_targets(s, p, "text.tabs.set")?;
|
||||
let range = TextRange::parse(p, "text.tabs.set")?;
|
||||
let doc = &s.doc()?.doc;
|
||||
let mut fewest: Option<usize> = None;
|
||||
for id in &ids {
|
||||
if let Some(NodeKind::Text(t)) = doc.node(*id).map(|node| &node.kind) {
|
||||
let held = match para_span(range, t) {
|
||||
None => t.para_styles().map(|pa| pa.tabs.len()).min(),
|
||||
Some(r) => r.map(|i| t.para_at(i).tabs.len()).min(),
|
||||
};
|
||||
fewest = match (fewest, held) {
|
||||
(Some(a), Some(b)) => Some(a.min(b)),
|
||||
(a, b) => a.or(b),
|
||||
};
|
||||
}
|
||||
}
|
||||
Ok(fewest.unwrap_or(0))
|
||||
}
|
||||
|
||||
fn apply(s: &mut Session, p: &Value, stops: Vec<TabStop>, label: &str) -> Result<Value> {
|
||||
let ids = text_targets(s, p, "text.tabs.set")?;
|
||||
let range = TextRange::parse(p, "text.tabs.set")?;
|
||||
@@ -159,14 +184,52 @@ mod tests {
|
||||
let err = |stops: Value| super::parse_stops(&json!({ "stops": stops })).unwrap_err().to_string();
|
||||
assert!(err(json!([{"position": 40, "leader": "123456789"}])).contains("`leader` must be at most 8 characters"));
|
||||
assert!(err(json!([{"position": 40, "alignOn": ",."}])).contains("`alignOn` must be one character"));
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({})).unwrap();
|
||||
s.execute("text.create", &json!({"x": 10, "y": 20, "text": "a\tb"})).unwrap();
|
||||
let many: Vec<Value> = (0..257).map(|i| json!({"position": i})).collect();
|
||||
assert!(err(Value::from(many.clone())).contains("at most 256 tab stops"));
|
||||
let ok = super::parse_stops(&json!({ "stops": &many[..256] })).unwrap();
|
||||
assert_eq!(ok.len(), 256);
|
||||
let e = s.execute("text.tabs.set", &json!({ "stops": many.clone() })).unwrap_err().to_string();
|
||||
assert!(e.contains("at most 256 tab stops"), "{e}");
|
||||
// The supplied list is counted, not the stops left once those at one position merge.
|
||||
let same: Vec<Value> = (0..257).map(|_| json!({"position": 5})).collect();
|
||||
assert!(s.execute("text.tabs.set", &json!({ "stops": same })).unwrap_err().to_string().contains("at most 256 tab stops"));
|
||||
assert_eq!(s.execute("text.tabs.set", &json!({ "stops": &many[..256] })).unwrap()["stops"], json!(256));
|
||||
let ok = super::parse_stops(&json!({"stops": [{"position": 0, "leader": "12345678", "alignOn": "€"}]})).unwrap();
|
||||
assert_eq!((ok[0].leader.as_str(), ok[0].align_on), ("12345678", '€'));
|
||||
}
|
||||
|
||||
/// A paragraph that already holds more than 256 stops (from a file) can lose them one at a
|
||||
/// time: a list no longer than every targeted paragraph's own is taken, a longer one is not, and
|
||||
/// a paragraph with fewer stops targeted beside it keeps the limit.
|
||||
#[test]
|
||||
fn stops_can_be_removed_from_a_paragraph_holding_more_than_the_limit() {
|
||||
use vectorcraft_doc::{NodeId, NodeKind, TabAlign, TabStop};
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({})).unwrap();
|
||||
let id = NodeId(s.execute("text.create", &json!({"x": 10, "y": 20, "text": "a\tb\nc\td"})).unwrap()["id"].as_u64().unwrap());
|
||||
let held: Vec<TabStop> =
|
||||
(0..300).map(|i| TabStop { position: f64::from(i), align: TabAlign::Left, leader: String::new(), align_on: '.' }).collect();
|
||||
s.edit("Load", |d, _| {
|
||||
if let Some(NodeKind::Text(t)) = d.node_mut(id).map(|n| &mut n.kind) {
|
||||
t.edit_paras(None, |pa| pa.tabs = held.clone());
|
||||
}
|
||||
Ok(())
|
||||
})
|
||||
.unwrap();
|
||||
let list = |n: i32| json!({ "stops": (0..n).map(|i| json!({"position": i})).collect::<Vec<_>>() });
|
||||
assert!(s.execute("text.tabs.set", &list(301)).unwrap_err().to_string().contains("at most 256 tab stops"));
|
||||
assert_eq!(s.execute("text.tabs.set", &list(299)).unwrap()["stops"], json!(299));
|
||||
assert_eq!(s.execute("text.tabs.get", &json!({})).unwrap()["stops"].as_array().unwrap().len(), 299);
|
||||
// The second paragraph (bytes 4 on) now holds 2 stops: 298 for both paragraphs is refused,
|
||||
// and 298 for the first alone is taken.
|
||||
s.execute("text.tabs.set", &json!({"stops": [{"position": 1}, {"position": 2}], "start": 4, "end": 4})).unwrap();
|
||||
let mut both = list(298);
|
||||
assert!(s.execute("text.tabs.set", &both).is_err());
|
||||
both["start"] = json!(0);
|
||||
both["end"] = json!(0);
|
||||
assert_eq!(s.execute("text.tabs.set", &both).unwrap()["stops"], json!(298));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn set_get_clear_tabs() {
|
||||
let mut s = Session::new();
|
||||
|
||||
@@ -11,8 +11,8 @@ use super::menucmds::whole_or;
|
||||
use super::stroke::StrokeChange;
|
||||
use super::typecmd::refresh_bounds;
|
||||
use super::{
|
||||
CommandSpec, EngineError, Result, Session, bad, bool_or, check_numbers, check_switches, cmd, color_value, has_doc, has_selection, id_param,
|
||||
index, number_or, point_param, str_param, switch_or, targets, text_param,
|
||||
CommandSpec, EngineError, Result, Session, bad, bool_or, check_numbers, check_switches, cmd, color_value, has_doc, has_selection, index,
|
||||
number_or, object_param, point_param, str_param, switch_or, targets, text_param,
|
||||
};
|
||||
|
||||
pub fn specs() -> Vec<CommandSpec> {
|
||||
@@ -40,7 +40,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Character",
|
||||
[],
|
||||
None,
|
||||
"{id? (default: the one selected type object), start?: byte, end?: byte (default: all text), story?: bool = false (all the text of every frame of the threaded story `id` is a frame of, in one undo step; no `start` or `end`), font?, style?, size?: pt, leading?: pt|\"auto\", tracking?, kerning?: 1/1000 em|\"auto\"|\"optical\", baselineShift?: pt, hScale?: %, vScale?: %, rotation?: deg counter-clockwise (0: upright), fill?: colour|\"none\", stroke?: colour|\"none\" (#rrggbbaa and #rgba are refused in both), keepModel?: bool (fill and stroke, as paint.setFill), strokeWidth?: pt, strokeOptions?: {weight?, cap?, join?, miterLimit?, align?, dash?, dashOffset?, alignDashes?} (as stroke.set: the character stroke), underline?, strikethrough?, allCaps?: bool, smallCaps?: bool, position?: \"normal\"|\"superscript\"|\"subscript\" (sizes from Document Setup), features?: [\"dlig\", \"-liga\", …], featureChanges?: [\"tnum\", \"-onum\", …] (OpenType features turned on, or with - off, on top of each character's own; its other features are kept), charAlign?: \"romanBaseline\"|\"emBoxTop\"|\"emBoxCenter\"|\"emBoxBottom\"|\"icfTop\"|\"icfBottom\", proportionalMetrics?: bool (full-width glyphs on the font's proportional widths: `palt` in horizontal type, `vpal` in vertical type), tateChuYoko?: bool (Character panel menu › Tate-chu-yoko, with Show East Asian Options: in vertical type those characters stand side by side across one em of the column; kept on the characters and ignored in horizontal type), tcyUpDown?, tcyLeftRight?: pt -1296..1296 (Character panel menu › Tate-chu-yoko Settings: in vertical type a block of tate-chu-yoko characters moves up by a positive Up/Down and down by a negative one, right by a positive Left/Right and left by a negative one, as one piece with the values of its first character; on a vertical path a positive Up/Down moves it toward the path's start and a positive Left/Right to the path's left; 0 by default; automatic digit blocks and horizontal type do not move; neither turns tateChuYoko on), standardVerticalRoman?: bool (Character panel menu › Standard Vertical Roman Alignment, with Show East Asian Options: in vertical type those half-width characters, such as Latin letters and digits, stand upright one below the other instead of being rotated; spaces and tate-chu-yoko blocks are not changed; kept on the characters and ignored in horizontal type; off by default), noBreak?: bool (Character panel menu › No Break: these characters stay on one line, including across a space inside the run), kashidas?: bool (Character panel menu › Kashidas: selected characters allow insertion only when both joined neighbors have it on; on by default), charDirection?: \"default\"|\"leftToRight\"|\"rightToLeft\" (Character panel menu › Character Direction: the characters are set left to right or right to left inside their paragraph, as a Unicode bidi embedding; default: as the bidi algorithm sets them), digits?: \"default\"|\"arabic\"|\"hindi\"|\"farsi\"|\"devanagari\"|\"bengali\"|\"gurmukhi\"|\"gujarati\"|\"odia\"|\"tamil\"|\"telugu\"|\"kannada\"|\"malayalam\" (Character panel menu › Digits: the numeral system every digit is drawn in, whatever was typed: Western, Arabic-Indic (hindi), Eastern Arabic-Indic (farsi) or an Indic script's own digits), fontHeightReference?: \"emBox\"|\"capHeight\"|\"xHeight\"|\"icfBox\" (Character panel › Set Font Height Reference: the height of the font that size measures, the em box by default; with a font that has no such height, or one outside 0.1 to 2 em, the em box), language?: name|tag (Character panel › Language: one of Document Setup's languages by name or BCP 47 tag, case-insensitive, such as \"Turkish\" or \"tr\"; the characters are shaped in it, so the font uses that language's forms (OpenType `locl`); saved as the tag, English: USA, the default, as none; new type takes the document's language), fontAxes?: {\"wght\": 650, …} (Character panel › Variable Font: the setting of each variation axis named, in the axis's units and clamped to its range; null: back to the style's own setting; other axes keep theirs; tags the font has no axis for are left out; a font or style change clears them; text.fontList {family, style} lists the axes)} style a character range (size/leading/baselineShift are document points and hScale includes the object transform; runs are split at the range ends) → {id, runs, warning?: text (the font or style set isn't available: its type is drawn in the fallback font or the family's closest style)}",
|
||||
"{id? (default: the one selected type object), start?: byte, end?: byte (default: all text), story?: bool = false (all the text of every frame of the threaded story `id` is a frame of, in one undo step; no `start` or `end`), font?, style?, size?: pt, leading?: pt|\"auto\", tracking?, kerning?: 1/1000 em|\"auto\"|\"optical\" (the space after each character), kerningBefore?: 1/1000 em -1000..10000 (the space before a character that starts a line by itself: the first character of the text, of a paragraph or after a forced line break; no effect elsewhere; 0 by default), baselineShift?: pt, hScale?: %, vScale?: %, rotation?: deg counter-clockwise (0: upright), fill?: colour|\"none\", stroke?: colour|\"none\" (#rrggbbaa and #rgba are refused in both), keepModel?: bool (fill and stroke, as paint.setFill), strokeWidth?: pt, strokeOptions?: {weight?, cap?, join?, miterLimit?, align?, dash?, dashOffset?, alignDashes?} (as stroke.set: the character stroke), underline?, strikethrough?, allCaps?: bool, smallCaps?: bool, position?: \"normal\"|\"superscript\"|\"subscript\" (sizes from Document Setup), features?: [\"dlig\", \"-liga\", …], featureChanges?: [\"tnum\", \"-onum\", …] (OpenType features turned on, or with - off, on top of each character's own; its other features are kept), charAlign?: \"romanBaseline\"|\"emBoxTop\"|\"emBoxCenter\"|\"emBoxBottom\"|\"icfTop\"|\"icfBottom\", proportionalMetrics?: bool (full-width glyphs on the font's proportional widths: `palt` in horizontal type, `vpal` in vertical type), tateChuYoko?: bool (Character panel menu › Tate-chu-yoko, with Show East Asian Options: in vertical type those characters stand side by side across one em of the column; kept on the characters and ignored in horizontal type), tcyUpDown?, tcyLeftRight?: pt -1296..1296 (Character panel menu › Tate-chu-yoko Settings: in vertical type a block of tate-chu-yoko characters moves up by a positive Up/Down and down by a negative one, right by a positive Left/Right and left by a negative one, as one piece with the values of its first character; on a vertical path a positive Up/Down moves it toward the path's start and a positive Left/Right to the path's left; 0 by default; automatic digit blocks and horizontal type do not move; neither turns tateChuYoko on), standardVerticalRoman?: bool (Character panel menu › Standard Vertical Roman Alignment, with Show East Asian Options: in vertical type those half-width characters, such as Latin letters and digits, stand upright one below the other instead of being rotated; spaces and tate-chu-yoko blocks are not changed; kept on the characters and ignored in horizontal type; off by default), noBreak?: bool (Character panel menu › No Break: these characters stay on one line, including across a space inside the run), kashidas?: bool (Character panel menu › Kashidas: selected characters allow insertion only when both joined neighbors have it on; on by default), charDirection?: \"default\"|\"leftToRight\"|\"rightToLeft\" (Character panel menu › Character Direction: the characters are set left to right or right to left inside their paragraph, as a Unicode bidi embedding; default: as the bidi algorithm sets them), digits?: \"default\"|\"arabic\"|\"hindi\"|\"farsi\"|\"devanagari\"|\"bengali\"|\"gurmukhi\"|\"gujarati\"|\"odia\"|\"tamil\"|\"telugu\"|\"kannada\"|\"malayalam\" (Character panel menu › Digits: the numeral system every digit is drawn in, whatever was typed: Western, Arabic-Indic (hindi), Eastern Arabic-Indic (farsi) or an Indic script's own digits), fontHeightReference?: \"emBox\"|\"capHeight\"|\"xHeight\"|\"icfBox\" (Character panel › Set Font Height Reference: the height of the font that size measures, the em box by default; with a font that has no such height, or one outside 0.1 to 2 em, the em box), language?: name|tag (Character panel › Language: one of Document Setup's languages by name or BCP 47 tag, case-insensitive, such as \"Turkish\" or \"tr\"; the characters are shaped in it, so the font uses that language's forms (OpenType `locl`); saved as the tag, English: USA, the default, as none; new type takes the document's language), fontAxes?: {\"wght\": 650, …} (Character panel › Variable Font: the setting of each variation axis named, in the axis's units and clamped to its range; null: back to the style's own setting; other axes keep theirs; tags the font has no axis for are left out; a font or style change clears them; text.fontList {family, style} lists the axes)} style a character range (size/leading/baselineShift are document points and hScale includes the object transform; runs are split at the range ends) → {id, runs, warning?: text (the font or style set isn't available: its type is drawn in the fallback font or the family's closest style)}",
|
||||
has_doc,
|
||||
set_range_style
|
||||
),
|
||||
@@ -103,7 +103,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Step Type",
|
||||
[],
|
||||
None,
|
||||
"{attribute: \"size\"|\"leading\"|\"tracking\"|\"kerning\"|\"baselineShift\", by?: steps (1; negative steps down), id?, start?: byte, end?: byte, ids?: [id…] (instead of id)} step type by the Preferences › Type increments (size and leading: typeSizeIncrement, pt; tracking and kerning: trackingIncrement, 1/1000 em; baseline shift: baselineShiftIncrement, pt), what the Type tool's Alt+arrows do (Cmd/Ctrl too: five steps; horizontal: ←/→ kerning at the caret or tracking of the selection, ↑/↓ leading, Shift+↑/↓ baseline shift; vertical: ↓/↑ with or without Shift kerning or tracking, ←/→ leading, Shift+→/← baseline shift; mixed selected text objects use the horizontal mapping). The range of `id`, else the type objects in `ids`, else the text the Type tool has selected (at a caret: kerning steps the character before it, leading its paragraph), else every selected type object → {ids}",
|
||||
"{attribute: \"size\"|\"leading\"|\"tracking\"|\"kerning\"|\"baselineShift\", by?: steps (1; negative steps down), id?, start?: byte, end?: byte, ids?: [id…] (instead of id)} step type by the Preferences › Type increments (size and leading: typeSizeIncrement, pt; tracking and kerning: trackingIncrement, 1/1000 em; baseline shift: baselineShiftIncrement, pt), what the Type tool's Alt+arrows do (Cmd/Ctrl too: five steps; horizontal: ←/→ kerning at the caret or tracking of the selection, ↑/↓ leading, Shift+↑/↓ baseline shift; vertical: ↓/↑ with or without Shift kerning or tracking, ←/→ leading, Shift+→/← baseline shift; mixed selected text objects use the horizontal mapping). The range of `id`, else the type objects in `ids`, else the text the Type tool has selected (at a caret: kerning steps the space after the character before it, or at the start of a line (of the text, a paragraph, or after a forced line break) the space before the character after it (kerningBefore, as text.setRangeStyle), and nothing at an empty line's start; leading its paragraph), else every selected type object → {ids}",
|
||||
has_doc,
|
||||
type_step
|
||||
),
|
||||
@@ -148,7 +148,7 @@ pub fn specs() -> Vec<CommandSpec> {
|
||||
"Reset Tracking and Kerning",
|
||||
[],
|
||||
Some("Cmd+Alt+Q"),
|
||||
"{ids?: [id…]} set tracking to 0 and clear manual kerning without changing the automatic method in all the text of the type objects in `ids`, else in the text the Type tool has selected (at a caret: only the kerning of the character before it), else in every selected type object, as one undo step → {ids}",
|
||||
"{ids?: [id…]} set tracking to 0 and clear manual kerning (kerning and kerningBefore) without changing the automatic method in all the text of the type objects in `ids`, else in the text the Type tool has selected (at a caret: only the kerning there, as type.step steps it), else in every selected type object, as one undo step → {ids}",
|
||||
has_selection,
|
||||
reset_tracking
|
||||
),
|
||||
@@ -272,7 +272,7 @@ fn range_of(p: &Value, len: usize, cmd: &str) -> Result<(usize, usize)> {
|
||||
|
||||
fn edit_range(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.editRange";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let t = text_ref(s, id)?;
|
||||
let len = edit::runs_len(&t.runs);
|
||||
let (a, b) = range_of(p, len, C)?;
|
||||
@@ -337,7 +337,7 @@ fn clear_param(s: &Session, p: &Value, id: NodeId, c: &str) -> Result<Vec<NodeId
|
||||
|
||||
fn start_list(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.startList";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let t = text_ref(s, id)?;
|
||||
let len = edit::runs_len(&t.runs);
|
||||
let at = offset_or(p, "at", len, C)?.min(len);
|
||||
@@ -365,7 +365,7 @@ fn start_list(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
}
|
||||
|
||||
fn get_range(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("text.getRange", "missing `id`"))?;
|
||||
let id = object_param(p, "id", "text.getRange")?.ok_or_else(|| bad("text.getRange", "missing `id`"))?;
|
||||
if switch_or(p, "story", false, "text.getRange")? {
|
||||
return get_story(s, p, id);
|
||||
}
|
||||
@@ -430,6 +430,8 @@ pub(crate) struct CharChange {
|
||||
leading: Option<Option<f64>>,
|
||||
tracking: Option<f64>,
|
||||
kerning: Option<Option<f64>>,
|
||||
/// The space before a character that starts a line by itself (`kerningBefore`).
|
||||
kerning_before: Option<f64>,
|
||||
optical_kerning: Option<bool>,
|
||||
baseline_shift: Option<f64>,
|
||||
h_scale: Option<f64>,
|
||||
@@ -691,7 +693,7 @@ fn auto_or_num(p: &Value, k: &str, cmd: &str) -> Result<Option<Option<f64>>> {
|
||||
impl CharChange {
|
||||
/// `setup` gives the superscript, subscript and small caps proportions.
|
||||
pub(crate) fn parse(p: &Value, cmd: &str, setup: &vectorcraft_doc::DocSetup) -> Result<Self> {
|
||||
check_numbers(p, &["size", "tracking", "baselineShift", "hScale", "vScale", "rotation", "strokeWidth"], cmd)?;
|
||||
check_numbers(p, &["size", "tracking", "kerningBefore", "baselineShift", "hScale", "vScale", "rotation", "strokeWidth"], cmd)?;
|
||||
check_switches(
|
||||
p,
|
||||
&["underline", "strikethrough", "allCaps", "proportionalMetrics", "tateChuYoko", "standardVerticalRoman", "noBreak", "kashidas"],
|
||||
@@ -720,6 +722,7 @@ impl CharChange {
|
||||
Some(Value::String(v)) if v.eq_ignore_ascii_case("optical") || v.eq_ignore_ascii_case("auto") => Some(None),
|
||||
Some(v) => Some(Some(v.as_f64().ok_or_else(|| bad(cmd, "kerning must be a number, \"auto\", or \"optical\""))?)),
|
||||
},
|
||||
kerning_before: num("kerningBefore"),
|
||||
optical_kerning: match p.get("kerning") {
|
||||
Some(Value::String(v)) if v.eq_ignore_ascii_case("optical") => Some(true),
|
||||
Some(Value::String(v)) if v.eq_ignore_ascii_case("auto") => Some(false),
|
||||
@@ -777,6 +780,7 @@ impl CharChange {
|
||||
&& self.leading.is_none()
|
||||
&& self.tracking.is_none()
|
||||
&& self.kerning.is_none()
|
||||
&& self.kerning_before.is_none()
|
||||
&& self.optical_kerning.is_none()
|
||||
&& self.baseline_shift.is_none()
|
||||
&& self.h_scale.is_none()
|
||||
@@ -883,6 +887,9 @@ impl CharChange {
|
||||
if let Some(v) = self.kerning {
|
||||
st.kerning = v.map(|k| k.clamp(-1000.0, 10000.0));
|
||||
}
|
||||
if let Some(v) = self.kerning_before {
|
||||
st.kerning_before = v.clamp(-1000.0, 10000.0);
|
||||
}
|
||||
if let Some(v) = self.optical_kerning {
|
||||
st.optical_kerning = v;
|
||||
}
|
||||
@@ -1254,7 +1261,7 @@ fn drawn_glyph(
|
||||
|
||||
fn set_glyph_alternate(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.setGlyphAlternate";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let gid = match p.get("gid") {
|
||||
None => return Err(bad(C, "missing `gid` (a glyph id, or null for the default glyph)")),
|
||||
Some(Value::Null) => None,
|
||||
@@ -1344,7 +1351,7 @@ fn set_glyph_alternate(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn glyph_alternates(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.glyphAlternates";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let t = text_ref(s, id)?;
|
||||
let (ch, bytes, face) = glyph_target(&t, p, C)?;
|
||||
let default = face.glyph_for(ch);
|
||||
@@ -1359,7 +1366,7 @@ fn glyph_alternates(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn touch_type(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.touchType";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
check_numbers(p, &["start"], C)?;
|
||||
let start = byte_param(p, "start").ok_or_else(|| bad(C, "missing `start` (the byte offset of a character)"))?;
|
||||
if !["dx", "dy", "hScale", "vScale", "rotation"].iter().any(|k| p.get(*k).is_some_and(|v| !v.is_null())) {
|
||||
@@ -1585,7 +1592,7 @@ fn touch_type(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn create_in_path(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.createInPath";
|
||||
let pid = id_param(p, "path").ok_or_else(|| bad(C, "missing `path` (a path object id)"))?;
|
||||
let pid = object_param(p, "path", C)?.ok_or_else(|| bad(C, "missing `path` (a path object id)"))?;
|
||||
let on_path = match str_param(p, "mode").unwrap_or("area") {
|
||||
"area" => false,
|
||||
"onPath" | "path" => true,
|
||||
@@ -1694,17 +1701,16 @@ pub(crate) fn editing_story(s: &Session) -> Vec<NodeId> {
|
||||
s.active().map(|st| super::threads::story_of(&st.doc, id)).unwrap_or_default()
|
||||
}
|
||||
|
||||
/// A text range a type shortcut changes: its type object, its bytes, and the caret's byte when it
|
||||
/// came from a caret ([`type_ranges`]).
|
||||
pub(crate) type TypeRange = (NodeId, usize, usize, Option<usize>);
|
||||
|
||||
/// The text ranges a type shortcut changes: the range of `id`, else all the text of the type
|
||||
/// objects in `ids`, else the text the Type tool has selected (all the text of every frame of the
|
||||
/// story after Select All in threaded text, [`editing_story`]), else all the text of every selected
|
||||
/// type object. At a caret, `at_caret` gives the range from the plain text and the caret's byte
|
||||
/// (None: nothing changes there). Each range comes with whether it came from a caret.
|
||||
pub(crate) fn type_ranges(
|
||||
s: &mut Session,
|
||||
p: &Value,
|
||||
c: &str,
|
||||
at_caret: impl Fn(&str, usize) -> Option<(usize, usize)>,
|
||||
) -> Result<Vec<(NodeId, usize, usize, bool)>> {
|
||||
/// (None: nothing changes there). Each range comes with the caret's byte when it came from a caret.
|
||||
pub(crate) fn type_ranges(s: &mut Session, p: &Value, c: &str, at_caret: impl Fn(&str, usize) -> Option<(usize, usize)>) -> Result<Vec<TypeRange>> {
|
||||
// (text, its range; None: all of it).
|
||||
let targets: Vec<(NodeId, Option<(usize, usize)>)> = match super::object_param(p, "id", c)? {
|
||||
// An object that isn't type is refused as `ids` of it is.
|
||||
@@ -1728,10 +1734,10 @@ pub(crate) fn type_ranges(
|
||||
let text = text_ref(s, id)?.plain_text();
|
||||
let (a, b) = range.map_or((0, text.len()), |(a, b)| (a.min(text.len()), b.min(text.len())));
|
||||
let (a, b, caret) = if a < b {
|
||||
(a, b, false)
|
||||
(a, b, None)
|
||||
} else {
|
||||
match at_caret(&text, a) {
|
||||
Some((a, b)) => (a, b, true),
|
||||
Some((x, y)) => (x, y, Some(a)),
|
||||
None => continue,
|
||||
}
|
||||
};
|
||||
@@ -1763,24 +1769,31 @@ fn type_step(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
Step::Tracking | Step::Kerning => prefs.tracking_increment,
|
||||
Step::BaselineShift => prefs.baseline_shift_increment,
|
||||
};
|
||||
// The ranges stepped. At a caret: kerning is the space after the character before it, leading
|
||||
// the paragraph's; the rest wait for a selection.
|
||||
// The ranges stepped. At a caret: kerning is the space after the character before it, or at
|
||||
// the start of a line the space before the character after it (#5111), leading the
|
||||
// paragraph's; the rest wait for a selection.
|
||||
let ranges = type_ranges(s, p, C, |text, a| match step {
|
||||
Step::Kerning => Some((edit::prev_char(text, a), a)),
|
||||
Step::Kerning => edit::caret_kerning_target(text, a).map(|(r, _)| (r.start, r.end)),
|
||||
Step::Leading => {
|
||||
let para = edit::paragraph_at(text, a);
|
||||
Some((para.start, para.end))
|
||||
}
|
||||
_ => None,
|
||||
})?;
|
||||
// At a caret, the kerning stepped: (whether it is the space before the character, its value).
|
||||
let mut caret_kerning = Vec::with_capacity(ranges.len());
|
||||
for &(id, a, b, caret) in &ranges {
|
||||
let value = if matches!(step, Step::Kerning) && caret {
|
||||
let t = text_ref(s, id)?;
|
||||
let lay = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t);
|
||||
Some(effective_kerning(vectorcraft_text::FontDb::global(), &t, &lay, a, b))
|
||||
} else {
|
||||
None
|
||||
let value = match caret {
|
||||
Some(c) if matches!(step, Step::Kerning) => {
|
||||
let t = text_ref(s, id)?;
|
||||
if edit::caret_kerning_target(&t.plain_text(), c).is_some_and(|(_, before)| before) {
|
||||
Some((true, edit::style_at(&t.runs, a + 1).kerning_before))
|
||||
} else {
|
||||
let lay = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t);
|
||||
Some((false, effective_kerning(vectorcraft_text::FontDb::global(), &t, &lay, a, b)))
|
||||
}
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
caret_kerning.push(value);
|
||||
}
|
||||
@@ -1829,10 +1842,13 @@ fn type_step(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
st.leading = Some(super::typecmd::local_type_value(t, leading * points + inc, (0.1, 5000.0), false, C)?);
|
||||
}
|
||||
Step::Tracking => st.tracking = (st.tracking + inc).clamp(-1000.0, 10000.0),
|
||||
Step::Kerning => {
|
||||
let current = caret_kerning.get(range_index).copied().flatten().unwrap_or_else(|| st.kerning.unwrap_or(0.0));
|
||||
st.kerning = Some((current + inc).clamp(-1000.0, 10000.0));
|
||||
}
|
||||
Step::Kerning => match caret_kerning.get(range_index).copied().flatten() {
|
||||
Some((true, current)) => st.kerning_before = (current + inc).clamp(-1000.0, 10000.0),
|
||||
caret => {
|
||||
let current = caret.map_or_else(|| st.kerning.unwrap_or(0.0), |(_, v)| v);
|
||||
st.kerning = Some((current + inc).clamp(-1000.0, 10000.0));
|
||||
}
|
||||
},
|
||||
Step::BaselineShift => {
|
||||
st.baseline_shift = super::typecmd::local_type_value(t, st.baseline_shift * points + inc, (-1296.0, 1296.0), false, C)?;
|
||||
}
|
||||
@@ -1849,17 +1865,22 @@ fn type_step(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
/// Cmd/Ctrl+Alt+Q: tracking 0 and manual kerning cleared in the type objects in
|
||||
/// `ids`, else in the Type tool's selected text, else in every selected type object. At a caret,
|
||||
/// only the kerning of the character before it changes, as Alt+←/→ in horizontal type or Alt+↓/↑ in vertical type kerns there.
|
||||
/// The automatic method remains selected.
|
||||
/// only the kerning there changes, as Alt+←/→ in horizontal type or Alt+↓/↑ in vertical type kerns
|
||||
/// there: of the character before it, or at the start of a line the space before the character
|
||||
/// after it ([`edit::caret_kerning_target`]). The automatic method remains selected.
|
||||
fn reset_tracking(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let ranges = type_ranges(s, p, "type.resetTracking", |text, a| Some((edit::prev_char(text, a), a)))?;
|
||||
let ranges = type_ranges(s, p, "type.resetTracking", |text, a| edit::caret_kerning_target(text, a).map(|(r, _)| (r.start, r.end)))?;
|
||||
if !ranges.is_empty() {
|
||||
s.edit("Reset Tracking and Kerning", |d, _| {
|
||||
for &(id, a, b, caret) in &ranges {
|
||||
let t = text_mut(d, id).ok_or(EngineError::NoNode(id))?;
|
||||
edit::style_range(&mut t.runs, a, b, |st| {
|
||||
st.kerning = None;
|
||||
if !caret {
|
||||
let before = caret.and_then(|c| edit::caret_kerning_target(&t.plain_text(), c)).map(|(_, before)| before);
|
||||
edit::style_range(&mut t.runs, a, b, |st| match before {
|
||||
Some(true) => st.kerning_before = 0.0,
|
||||
Some(false) => st.kerning = None,
|
||||
None => {
|
||||
st.kerning = None;
|
||||
st.kerning_before = 0.0;
|
||||
st.tracking = 0.0;
|
||||
}
|
||||
});
|
||||
@@ -1975,7 +1996,7 @@ fn fit_headline(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn discard_empty(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.discardEmpty";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing `id`"))?;
|
||||
if edit::runs_len(&text_ref(s, id)?.runs) > 0 {
|
||||
return Ok(json!({"removed": false}));
|
||||
}
|
||||
|
||||
@@ -188,8 +188,10 @@ fn to_attrs<T: Serialize>(v: &T) -> Map<String, Value> {
|
||||
/// from a style instead leaves the text's own value alone.
|
||||
pub fn char_attrs(v: &CharStyle) -> Map<String, Value> {
|
||||
let mut m = to_attrs(v);
|
||||
// A chosen glyph belongs to one character, not to a reusable character style.
|
||||
// A chosen glyph belongs to one character, and the space before a line's first character to
|
||||
// where it stands (#5111), not to a reusable character style.
|
||||
m.remove("glyphAlternate");
|
||||
m.remove("kerningBefore");
|
||||
for (k, x) in [
|
||||
("font_version", json!(v.font_version)),
|
||||
("fontAxes", json!(v.font_axes)),
|
||||
@@ -243,6 +245,7 @@ pub fn para_attrs(v: &ParaStyle) -> Map<String, Value> {
|
||||
("kinsoku_type", json!(v.kinsoku_type)),
|
||||
("roman_hanging", json!(v.roman_hanging)),
|
||||
("kashida", json!(v.kashida)),
|
||||
("korean_line_break_anywhere", json!(v.korean_line_break_anywhere)),
|
||||
] {
|
||||
m.insert(k.into(), x);
|
||||
}
|
||||
@@ -530,6 +533,12 @@ fn attrs_param(d: &Document, p: &Value, kind: Kind, verb: &str, kept: Option<&Ma
|
||||
if m.contains_key("glyphAlternate") {
|
||||
return Err(bad(&c, "`glyphAlternate` belongs to one character, not to a character style (text.setGlyphAlternate sets it)"));
|
||||
}
|
||||
if m.contains_key("kerningBefore") {
|
||||
return Err(bad(
|
||||
&c,
|
||||
"`kerningBefore` belongs to a line's first character, not to a character style (text.setRangeStyle sets it)",
|
||||
));
|
||||
}
|
||||
let mut st = with_attrs(&CharStyle::default(), m, &c)?;
|
||||
let changed = |key: &str| m.contains_key(key) && kept.and_then(|k| k.get(key)) != m.get(key);
|
||||
for (key, value, lo, hi) in
|
||||
|
||||
@@ -1336,7 +1336,8 @@ fn para_style_redefined_to_the_defaults_updates_its_paragraphs() {
|
||||
|
||||
/// The same for character styles: Auto kerning and the Roman baseline alignment, which the
|
||||
/// run's JSON leaves out, are captured and reach the style's users. A glyph choice belongs to
|
||||
/// one character, so it is not a reusable style attribute.
|
||||
/// one character, and the space before a line's first character to where it stands (#5111), so
|
||||
/// neither is a reusable style attribute.
|
||||
#[test]
|
||||
fn char_style_redefined_to_the_defaults_updates_its_text() {
|
||||
use vectorcraft_doc::CharAlign;
|
||||
@@ -1356,6 +1357,7 @@ fn char_style_redefined_to_the_defaults_updates_its_text() {
|
||||
assert_eq!((kerning(&s), aligns(&s)), ([None, None, Some(60.0)], [CharAlign::RomanBaseline; 3]));
|
||||
let mut reusable = settable::<CharStyle>();
|
||||
reusable.remove("glyphAlternate");
|
||||
reusable.remove("kerningBefore");
|
||||
assert_eq!(defined(&s, 0), reusable, "Redefine captures every reusable attribute");
|
||||
s.execute("charStyle.new", &json!({"name": "Copy", "id": local})).unwrap();
|
||||
assert_eq!(defined(&s, 1), reusable, "New captures every reusable attribute");
|
||||
|
||||
@@ -10,8 +10,8 @@ use vectorcraft_geom::{Affine, PathData, Vec2};
|
||||
use super::edit::selected_roots;
|
||||
use super::pathops::{length_given, number_given, shape_node};
|
||||
use super::{
|
||||
CommandSpec, EngineError, Result, Session, bad, check_numbers, cmd, color_value, f64_req, has_doc, has_selection, id_param, index, number_or, ok,
|
||||
str_param, switch_or, targets, text_param,
|
||||
CommandSpec, EngineError, Result, Session, bad, check_numbers, cmd, color_value, f64_req, has_doc, has_selection, index, number_or, object_param,
|
||||
ok, str_param, switch_or, targets, text_param,
|
||||
};
|
||||
|
||||
pub fn specs() -> Vec<CommandSpec> {
|
||||
@@ -1273,7 +1273,7 @@ fn reshape_area(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
};
|
||||
let mut items = Vec::with_capacity(raw.len());
|
||||
for it in raw {
|
||||
let id = id_param(it, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(it, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let mut refs = super::select::checked_refs(it.get("anchors"), C)?;
|
||||
refs.sort_unstable();
|
||||
refs.dedup();
|
||||
@@ -1304,7 +1304,7 @@ fn reshape_area(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn reshape_path(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.reshapePath";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let mut refs = super::select::checked_refs(p.get("anchors"), C)?;
|
||||
refs.sort_unstable();
|
||||
refs.dedup();
|
||||
@@ -1335,7 +1335,7 @@ fn reshape_path(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
|
||||
fn set_path_handle(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
const C: &str = "text.setPathHandle";
|
||||
let id = id_param(p, "id").ok_or_else(|| bad(C, "missing id"))?;
|
||||
let id = object_param(p, "id", C)?.ok_or_else(|| bad(C, "missing id"))?;
|
||||
let si = super::draw2::usize_opt(p, "subpath", C)?.unwrap_or(0);
|
||||
let ai = p.get("anchor").and_then(Value::as_u64).map(index).ok_or_else(|| bad(C, "missing anchor"))?;
|
||||
let out = super::object::choice(p, C, "which", &["in", "out"])? != Some("in");
|
||||
|
||||
@@ -397,6 +397,49 @@ fn roman_hanging_punctuation_is_set_per_paragraph_and_saved_only_when_on() {
|
||||
assert!(text(&s).para_at(1).roman_hanging);
|
||||
}
|
||||
|
||||
/// Paragraph panel menu › Korean Line Break Anywhere: new type has it off and saves that;
|
||||
/// `text.setFormat {koreanLineBreakAnywhere}` sets it per paragraph in one undo step and refuses a
|
||||
/// value that is not true or false, a paragraph saved before the option opens with it on, and
|
||||
/// paragraph styles carry it. `text.setRangeStyle`, a character command, does not take it.
|
||||
#[test]
|
||||
fn korean_line_break_anywhere_is_set_per_paragraph_and_saved_only_when_off() {
|
||||
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).korean_line_break_anywhere, "new type has it off");
|
||||
assert_eq!(serde_json::to_value(text(&s).para_at(0)).unwrap()["korean_line_break_anywhere"], false);
|
||||
s.execute("select.set", &json!({"ids": [id]})).unwrap();
|
||||
let steps = s.doc().unwrap().history.undo.len();
|
||||
// Only the first paragraph (the caret's range).
|
||||
s.execute("text.setFormat", &json!({"koreanLineBreakAnywhere": true, "start": 0, "end": 0})).unwrap();
|
||||
assert!(text(&s).para_at(0).korean_line_break_anywhere && !text(&s).para_at(1).korean_line_break_anywhere);
|
||||
assert_eq!(s.doc().unwrap().history.undo.len(), steps + 1);
|
||||
assert!(serde_json::to_value(text(&s).para_at(0)).unwrap().get("korean_line_break_anywhere").is_none());
|
||||
let back: vectorcraft_doc::ParaStyle = serde_json::from_value(serde_json::to_value(text(&s).para_at(0)).unwrap()).unwrap();
|
||||
assert!(back.korean_line_break_anywhere);
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
assert!(!text(&s).para_at(0).korean_line_break_anywhere);
|
||||
s.execute("edit.redo", &json!({})).unwrap();
|
||||
assert!(text(&s).para_at(0).korean_line_break_anywhere);
|
||||
// Saved before the option: on, the line breaks it was laid out with.
|
||||
let old: vectorcraft_doc::ParaStyle = serde_json::from_value(json!({"justify": "Left"})).unwrap();
|
||||
assert!(old.korean_line_break_anywhere);
|
||||
assert!(s.execute("text.setFormat", &json!({"ids": [id], "koreanLineBreakAnywhere": "yes"})).is_err());
|
||||
assert!(s.execute("text.setRangeStyle", &json!({"id": id, "koreanLineBreakAnywhere": false})).is_err());
|
||||
assert!(text(&s).para_at(0).korean_line_break_anywhere, "a refused call changes nothing");
|
||||
// A paragraph style carries it.
|
||||
s.execute("paraStyle.new", &json!({"name": "Anywhere", "attrs": {"korean_line_break_anywhere": true}})).unwrap();
|
||||
s.execute("paraStyle.apply", &json!({"name": "Anywhere", "id": id})).unwrap();
|
||||
assert!(text(&s).para_at(1).korean_line_break_anywhere);
|
||||
s.execute("paraStyle.new", &json!({"name": "Words", "attrs": {"korean_line_break_anywhere": false}})).unwrap();
|
||||
s.execute("paraStyle.apply", &json!({"name": "Words", "id": id})).unwrap();
|
||||
assert!(!text(&s).para_at(0).korean_line_break_anywhere && !text(&s).para_at(1).korean_line_break_anywhere);
|
||||
}
|
||||
|
||||
/// 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.
|
||||
|
||||
@@ -311,7 +311,10 @@ fn to_area(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
continue;
|
||||
}
|
||||
let lay = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), t);
|
||||
let mut b = if lay.bounds.area() > 0.0 { lay.bounds } else { t.estimate_bounds() };
|
||||
// The frame is worked out in line space, where the lines are; vertical type turns it
|
||||
// into text space with the lines.
|
||||
let text_bounds = if lay.bounds.area() > 0.0 { lay.bounds } else { t.estimate_bounds() };
|
||||
let mut b = lay.line_xf.inverse().transform_rect_bbox(text_bounds);
|
||||
// Across, the frame spans the lines as they are aligned: from their starts to their ends
|
||||
// without the tracking after their last characters (`LineInfo::trailing`), not to the
|
||||
// ink, which tracking can pull past an advance. Area type aligns them alike.
|
||||
@@ -332,7 +335,7 @@ fn to_area(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
Justify::Auto if lay.lines.first().is_some_and(|l| l.rtl) => (slack, 0.0),
|
||||
_ => (0.0, slack),
|
||||
};
|
||||
let frame = Rect::new(b.x0 - sl, top, b.x1 + sr, b.y1.max(top + 1.0));
|
||||
let frame = lay.line_xf.transform_rect_bbox(Rect::new(b.x0 - sl, top, b.x1 + sr, b.y1.max(top + 1.0)));
|
||||
t.kind = TextKind::Area { frame: shapes::rectangle(frame) };
|
||||
refresh_bounds(t);
|
||||
}
|
||||
@@ -368,6 +371,8 @@ fn to_point(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
// Point type is in no thread: its first paragraph starts in it.
|
||||
t.first_para_continues = false;
|
||||
let lay = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), t);
|
||||
// The lines are in line space; the frame's bounds are taken there too.
|
||||
let fb = lay.line_xf.inverse().transform_rect_bbox(fb);
|
||||
let plain = t.plain_text();
|
||||
let baseline = lay.lines.first().map(|l| l.baseline).unwrap_or(fb.y0 + t.first_style().size * 0.8);
|
||||
// Soft wraps → explicit breaks (replace the space before the wrap when there is one).
|
||||
@@ -414,7 +419,10 @@ fn to_point(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
// converting back to area type does not turn it on again.
|
||||
t.dynamic_text = false;
|
||||
t.kind = TextKind::Point;
|
||||
t.xf *= Affine::translate((ox, baseline));
|
||||
// The origin is in the area type's line space; point type's line space puts its own
|
||||
// origin there (vertical point type turns its lines about a different point).
|
||||
let point_xf = if lay.vertical { vectorcraft_text::layout(vectorcraft_text::FontDb::global(), t).line_xf } else { Affine::IDENTITY };
|
||||
t.xf *= lay.line_xf * Affine::translate((ox, baseline)) * point_xf.inverse();
|
||||
refresh_bounds(t);
|
||||
}
|
||||
Ok(())
|
||||
|
||||
@@ -8,7 +8,7 @@ use vectorcraft_color::Paint;
|
||||
use vectorcraft_doc::{Document, Node, NodeId, NodeKind};
|
||||
|
||||
use super::select::selectable_ids;
|
||||
use super::{CommandSpec, EngineError, Result, Session, always, bad, bool_or, cmd, has_doc, id_param, str_param};
|
||||
use super::{CommandSpec, EngineError, Result, Session, always, bad, bool_or, cmd, has_doc, object_param, str_param};
|
||||
|
||||
/// Magic Wand panel settings. Tolerances: colours as 0–255 RGB distance, stroke weight in
|
||||
/// points, opacity in percent.
|
||||
@@ -152,7 +152,7 @@ fn paintable(doc: &Document) -> Vec<NodeId> {
|
||||
}
|
||||
|
||||
fn magic_wand(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let id = id_param(p, "id").ok_or_else(|| bad("select.magicWand", "missing id"))?;
|
||||
let id = object_param(p, "id", "select.magicWand")?.ok_or_else(|| bad("select.magicWand", "missing id"))?;
|
||||
let st = s.doc()?;
|
||||
let reference = st.doc.node(id).ok_or(EngineError::NoNode(id))?.clone();
|
||||
let w = s.menu.wand.clone();
|
||||
|
||||
@@ -88,6 +88,13 @@ impl SourceMap {
|
||||
let name = self.files.get(seg.file).cloned().unwrap_or_else(|| Arc::from(""));
|
||||
(seg.file, name, seg.line.saturating_add(line - seg.out_line), column)
|
||||
}
|
||||
|
||||
/// The memory the map holds, in bytes: its lists and its file names, each name counted in full
|
||||
/// even when another map shares it.
|
||||
pub(crate) fn bytes(&self) -> usize {
|
||||
let names: usize = self.files.iter().map(|f| f.len() + 2 * size_of::<usize>()).sum();
|
||||
self.files.capacity() * size_of::<Arc<str>>() + self.segments.capacity() * size_of::<Segment>() + names
|
||||
}
|
||||
}
|
||||
|
||||
/// How a preprocessor failure ends the run.
|
||||
|
||||
+145
-28
@@ -221,12 +221,69 @@ fn current(link: &Link) -> std::result::Result<Rc<Host>, HostError> {
|
||||
}
|
||||
|
||||
/// A named engine: its interpreter, with the globals its runs left (`None` while a run has it),
|
||||
/// the link its host functions use, and its heap after its last run.
|
||||
/// the link its host functions use, its heap after its last run, and the source maps of the code
|
||||
/// its earlier runs compiled.
|
||||
struct Engine {
|
||||
name: String,
|
||||
realm: Option<Realm>,
|
||||
link: Link,
|
||||
heap: usize,
|
||||
maps: Rc<RefCell<KeptMaps>>,
|
||||
}
|
||||
|
||||
/// A named engine taken for a run: its realm (`None` for an engine made now), its link and its
|
||||
/// kept source maps.
|
||||
type TakenEngine = (Option<Realm>, Link, Rc<RefCell<KeptMaps>>);
|
||||
|
||||
/// The most bytes of source maps ([`include::SourceMap::bytes`]) a named engine keeps from its
|
||||
/// earlier runs.
|
||||
pub const KEPT_MAP_BYTES: usize = 8 << 20;
|
||||
|
||||
/// A source map an engine kept from an earlier run: the realm's tag for the source
|
||||
/// ([`Realm::error_tag`]), the map, and for the run's own script, that run's name, which stands for
|
||||
/// a script given as text.
|
||||
struct KeptMap {
|
||||
tag: u32,
|
||||
map: include::SourceMap,
|
||||
script: Option<Arc<str>>,
|
||||
bytes: usize,
|
||||
}
|
||||
|
||||
/// The source maps a named engine kept from its earlier runs, by tag, oldest first, in at most
|
||||
/// [`KEPT_MAP_BYTES`]: the oldest go first to make room, and a map larger than that is not kept.
|
||||
#[derive(Default)]
|
||||
struct KeptMaps {
|
||||
maps: std::collections::VecDeque<KeptMap>,
|
||||
bytes: usize,
|
||||
}
|
||||
|
||||
impl KeptMaps {
|
||||
fn keep(&mut self, tag: u32, map: include::SourceMap, script: Option<Arc<str>>) {
|
||||
let bytes = map.bytes() + script.as_ref().map_or(0, |s| s.len());
|
||||
let limit = kept_map_bytes();
|
||||
if bytes > limit || self.maps.back().is_some_and(|m| m.tag >= tag) {
|
||||
return;
|
||||
}
|
||||
while self.bytes + bytes > limit {
|
||||
let Some(old) = self.maps.pop_front() else { break };
|
||||
self.bytes -= old.bytes;
|
||||
}
|
||||
self.bytes += bytes;
|
||||
self.maps.push_back(KeptMap { tag, map, script, bytes });
|
||||
}
|
||||
|
||||
fn get(&self, tag: u32) -> Option<&KeptMap> {
|
||||
self.maps.binary_search_by_key(&tag, |m| m.tag).ok().and_then(|i| self.maps.get(i))
|
||||
}
|
||||
}
|
||||
|
||||
/// The bytes of source maps a named engine keeps.
|
||||
fn kept_map_bytes() -> usize {
|
||||
#[cfg(test)]
|
||||
if let Some(n) = TEST_KEPT_MAP_BYTES.with(Cell::get) {
|
||||
return n;
|
||||
}
|
||||
KEPT_MAP_BYTES
|
||||
}
|
||||
|
||||
/// The named engines of one thread's sessions, by their key, each in the order they were made.
|
||||
@@ -665,6 +722,14 @@ struct Host {
|
||||
/// The file, line and column of each error `$.evalFile` raised for a file it could not run, in
|
||||
/// order: the error's mark ([`HostError::Marked`]) is its index.
|
||||
eval_failures: RefCell<Vec<(Arc<str>, u32, u32)>>,
|
||||
/// The realm's tag for the script ([`Realm::script_tag`]) once the run has started it, and
|
||||
/// [`vectorcraft_js::UNKNOWN_SOURCE`] before.
|
||||
script_tag: Cell<u32>,
|
||||
/// The run's name as its report gives it, which [`Host::name`] shortens for console lines.
|
||||
report_name: Arc<str>,
|
||||
/// The source maps the named engine of the run kept from its earlier runs; `None` for a run
|
||||
/// without one.
|
||||
kept_maps: Option<Rc<RefCell<KeptMaps>>>,
|
||||
/// When the run started, where the platform has a clock.
|
||||
started: Option<std::time::Instant>,
|
||||
/// The time since [`Host::started`] at which a `$.sleep` ends.
|
||||
@@ -740,6 +805,23 @@ pub(crate) fn slowest(times: &HashMap<&'static str, (u64, u128, u128)>) -> Vec<c
|
||||
}
|
||||
|
||||
impl Host {
|
||||
/// Gives the named engine of the run the source maps of the code the run compiled: its script
|
||||
/// and each file `$.evalFile` gave. A run that never started its script compiled nothing.
|
||||
fn keep_maps(&self) {
|
||||
let (Some(kept), tag) = (&self.kept_maps, self.script_tag.get()) else { return };
|
||||
if tag == vectorcraft_js::UNKNOWN_SOURCE {
|
||||
return;
|
||||
}
|
||||
let mut kept = kept.borrow_mut();
|
||||
kept.keep(tag, std::mem::take(&mut *self.script_map.borrow_mut()), Some(self.report_name.clone()));
|
||||
for (n, map) in std::mem::take(&mut *self.eval_maps.borrow_mut()).into_iter().enumerate() {
|
||||
match u32::try_from(n + 1).ok().and_then(|n| tag.checked_add(n)).filter(|t| *t != vectorcraft_js::UNKNOWN_SOURCE) {
|
||||
Some(t) => kept.keep(t, map, None),
|
||||
None => break,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Adds a line to the run's console and, during a slice, to the session's.
|
||||
fn line(&self, entry: console::Entry, cut: bool) {
|
||||
let line = console::ConsoleLine { run: self.run, name: self.name.clone(), entry };
|
||||
@@ -1358,34 +1440,55 @@ fn preprocessor_error(f: include::Failure) -> (RunError, Option<Arc<str>>) {
|
||||
(RunError { kind, message, line: f.line, column: f.column }, file)
|
||||
}
|
||||
|
||||
/// `e`, which the realm raised in source `tag` ([`Realm::error_source`]) with host error mark `mark`
|
||||
/// ([`Realm::error_mark`]), at the line and column of the file it is in, with that file's name
|
||||
/// unless it is the script's own.
|
||||
fn located(host: &Host, tag: u32, mark: Option<u32>, e: &RunError) -> (RunError, Option<Arc<str>>) {
|
||||
let map = |m: &include::SourceMap, own: bool| {
|
||||
/// `e`, the error `realm` raised in the run of `host`, at the line and column of the file it is in,
|
||||
/// with that file's name unless it is the run's own script.
|
||||
fn located(host: &Host, realm: &Realm, e: &RunError) -> (RunError, Option<Arc<str>>) {
|
||||
let map = |m: &include::SourceMap| {
|
||||
let (index, file, line, column) = m.locate(e.line, e.column);
|
||||
let message = if e.kind == RunErrorKind::Syntax { relocated(&e.message, e.line, e.column, line, column) } else { e.message.clone() };
|
||||
(RunError { kind: e.kind.clone(), message, line, column }, (!own || index > 0).then_some(file))
|
||||
(RunError { kind: e.kind.clone(), message, line, column }, index, file)
|
||||
};
|
||||
// An error `$.evalFile` raised for a file it could not run, and no script caught, is at that
|
||||
// file's place.
|
||||
if let Some((file, line, column)) = mark.and_then(|m| host.eval_failures.borrow().get(m as usize).cloned()) {
|
||||
if let Some((file, line, column)) = realm.error_mark().and_then(|m| host.eval_failures.borrow().get(m as usize).cloned()) {
|
||||
let message = if e.kind == RunErrorKind::Syntax { relocated(&e.message, e.line, e.column, line, column) } else { e.message.clone() };
|
||||
return (RunError { kind: e.kind.clone(), message, line, column }, Some(file));
|
||||
}
|
||||
if e.line == 0 {
|
||||
return (e.clone(), None);
|
||||
}
|
||||
// An error in code from another source, such as a function an earlier run of a named engine
|
||||
// defined, has no place in this run's files, so it is given without one.
|
||||
// An error in code from a source whose map is not at hand, such as code that `eval` compiled,
|
||||
// is given without a place.
|
||||
let unplaced = || (RunError { kind: e.kind.clone(), message: e.message.clone(), line: 0, column: 0 }, None);
|
||||
match tag {
|
||||
0 => map(&host.script_map.borrow(), true),
|
||||
match realm.error_source() {
|
||||
0 => {
|
||||
let (e, index, file) = map(&host.script_map.borrow());
|
||||
(e, (index > 0).then_some(file))
|
||||
}
|
||||
n if n != vectorcraft_js::UNKNOWN_SOURCE => match host.eval_maps.borrow().get(n as usize - 1) {
|
||||
Some(m) => map(m, false),
|
||||
Some(m) => {
|
||||
let (e, _, file) = map(m);
|
||||
(e, Some(file))
|
||||
}
|
||||
None => unplaced(),
|
||||
},
|
||||
_ => unplaced(),
|
||||
// Code an earlier run of the named engine compiled, such as a function it defined, is at
|
||||
// its place in that run's files: the run's script, a file it included, or a file
|
||||
// `$.evalFile` gave. A script given as text is named by that run's name.
|
||||
_ => {
|
||||
let kept = host.kept_maps.as_ref().map(|k| k.borrow());
|
||||
match kept.as_ref().and_then(|k| k.get(realm.error_tag())) {
|
||||
Some(kept) => {
|
||||
let (e, index, file) = map(&kept.map);
|
||||
let file = match &kept.script {
|
||||
Some(name) if index == 0 && file.is_empty() => name.clone(),
|
||||
_ => file,
|
||||
};
|
||||
(e, Some(file))
|
||||
}
|
||||
None => unplaced(),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1438,17 +1541,17 @@ impl Session {
|
||||
}
|
||||
}
|
||||
|
||||
/// The realm of the named engine `name` for a run, with the link its host functions use: the
|
||||
/// realm its last run left, or `None` for an engine made now. → the kind and text of the
|
||||
/// failure when the engine cannot be had.
|
||||
fn take_engine(&mut self, name: &str) -> std::result::Result<(Option<Realm>, Link), (include::FailKind, String)> {
|
||||
/// The realm of the named engine `name` for a run, with the link its host functions use and the
|
||||
/// source maps it kept: the realm its last run left, or `None` for an engine made now. → the
|
||||
/// kind and text of the failure when the engine cannot be had.
|
||||
fn take_engine(&mut self, name: &str) -> std::result::Result<TakenEngine, (include::FailKind, String)> {
|
||||
if cfg!(target_arch = "wasm32") {
|
||||
return Err((include::FailKind::Error, NO_ENGINES_ON_WEB.to_string()));
|
||||
}
|
||||
with_engines(&self.script_engines, |engines| {
|
||||
if let Some(e) = engines.iter_mut().find(|e| e.name == name) {
|
||||
let realm = e.realm.take().ok_or((include::FailKind::Error, ENGINE_BUSY.to_string()))?;
|
||||
return Ok((Some(realm), e.link.clone()));
|
||||
return Ok((Some(realm), e.link.clone(), e.maps.clone()));
|
||||
}
|
||||
if engines.len() >= MAX_ENGINES {
|
||||
return Err((
|
||||
@@ -1457,15 +1560,20 @@ impl Session {
|
||||
));
|
||||
}
|
||||
let link: Link = Rc::new(RefCell::new(None));
|
||||
engines.push(Engine { name: name.to_string(), realm: None, link: link.clone(), heap: 0 });
|
||||
Ok((None, link))
|
||||
let maps = Rc::new(RefCell::new(KeptMaps::default()));
|
||||
engines.push(Engine { name: name.to_string(), realm: None, link: link.clone(), heap: 0, maps: maps.clone() });
|
||||
Ok((None, link, maps))
|
||||
})
|
||||
}
|
||||
|
||||
/// The end of a run in engine `engine` (`None` for a realm that is not kept): the link no longer
|
||||
/// holds the run, and the engine keeps `realm`, or is dropped without one.
|
||||
/// holds the run, and the engine keeps `realm`, with the source maps of the code the run
|
||||
/// compiled, or is dropped without one.
|
||||
fn return_engine(&self, engine: Option<&str>, link: &Link, realm: Option<Realm>) {
|
||||
let host = link.borrow_mut().take();
|
||||
if let (Some(h), Some(_)) = (&host, &realm) {
|
||||
h.keep_maps();
|
||||
}
|
||||
drop(host);
|
||||
let Some(name) = engine else { return };
|
||||
let mut realm = realm;
|
||||
@@ -1668,9 +1776,9 @@ impl Session {
|
||||
};
|
||||
let heap_bytes = if kept.is_some() { engine_heap() } else { HEAP_BYTES };
|
||||
let limits = Limits { fuel: request.fuel, heap_bytes, ..Limits::default() };
|
||||
let (engine, realm, link) = match kept {
|
||||
None => (None, None, Rc::new(RefCell::new(None))),
|
||||
Some((engine, (realm, link))) => (Some(engine), realm, link),
|
||||
let (engine, realm, link, kept_maps) = match kept {
|
||||
None => (None, None, Rc::new(RefCell::new(None)), None),
|
||||
Some((engine, (realm, link, maps))) => (Some(engine), realm, link, Some(maps)),
|
||||
};
|
||||
// A realm made here gets the script extensions, `$` and the dialogs; a kept one has them
|
||||
// from its first run, and they act for the run that calls them.
|
||||
@@ -1716,6 +1824,9 @@ impl Session {
|
||||
script_map: RefCell::default(),
|
||||
eval_maps: RefCell::default(),
|
||||
eval_failures: RefCell::default(),
|
||||
script_tag: Cell::new(vectorcraft_js::UNKNOWN_SOURCE),
|
||||
report_name: Arc::from(name.as_str()),
|
||||
kept_maps,
|
||||
started: clock(),
|
||||
wake_at: Cell::new(None),
|
||||
can_wait: realm.wait_flag(),
|
||||
@@ -1752,8 +1863,12 @@ impl Session {
|
||||
.and_then(|()| if fresh { realm.define_host_object("$", dollar_object(&link, info, &localization)) } else { Ok(()) })
|
||||
.and_then(|()| if fresh { dialogs::install(&mut realm, &link) } else { Ok(()) })
|
||||
.and_then(|()| if fresh { files::install(&mut realm, &link) } else { realm.reset_folder_current() })
|
||||
.and_then(|()| realm.start(&expanded.source))
|
||||
.map_err(|e| located(&host, realm.error_source(), realm.error_mark(), &e))
|
||||
.and_then(|()| {
|
||||
let r = realm.start(&expanded.source);
|
||||
host.script_tag.set(realm.script_tag());
|
||||
r
|
||||
})
|
||||
.map_err(|e| located(&host, &realm, &e))
|
||||
}
|
||||
};
|
||||
if let Err((e, file)) = started {
|
||||
@@ -1832,7 +1947,7 @@ impl Session {
|
||||
fn script_failed(&mut self, job: Job, e: &RunError) -> Result<Value> {
|
||||
job.host.dialogs.stopped();
|
||||
let fuel_left = job.realm.fuel_left();
|
||||
let (e, file) = located(&job.host, job.realm.error_source(), job.realm.error_mark(), e);
|
||||
let (e, file) = located(&job.host, &job.realm, e);
|
||||
let mut report = failure_report(&job.name, &e, file.as_deref(), &job.host, fuel_left, job.realm.limits().fuel.saturating_sub(fuel_left));
|
||||
close_run(self, &job.host, &mut report, ending(&e.kind));
|
||||
self.end_job(job, e.kind == RunErrorKind::Internal);
|
||||
@@ -2127,6 +2242,8 @@ thread_local! {
|
||||
pub(crate) static TEST_GROWTH: Cell<Option<u64>> = const { Cell::new(None) };
|
||||
/// Tests: the heap of a named engine in place of [`ENGINE_HEAP_BYTES`].
|
||||
pub(crate) static TEST_ENGINE_HEAP: Cell<Option<usize>> = const { Cell::new(None) };
|
||||
/// Tests: the bytes of source maps a named engine keeps, in place of [`KEPT_MAP_BYTES`].
|
||||
pub(crate) static TEST_KEPT_MAP_BYTES: Cell<Option<usize>> = const { Cell::new(None) };
|
||||
/// Tests: the `JSINCLUDE` folders in place of the environment's.
|
||||
pub(crate) static TEST_JSINCLUDE: RefCell<Option<Vec<std::path::PathBuf>>> = const { RefCell::new(None) };
|
||||
/// Tests: the time since a run started, in place of its clock's.
|
||||
|
||||
@@ -20,6 +20,7 @@ mod brushlib;
|
||||
mod brushsym;
|
||||
mod build;
|
||||
mod cancel;
|
||||
mod caret_kerning;
|
||||
mod charstroke;
|
||||
pub(super) mod clip;
|
||||
mod clipboard;
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
use serde_json::{Value, json};
|
||||
use vectorcraft_color::{BlendMode, Color, GradientKind, Paint};
|
||||
use vectorcraft_doc::{AppearanceItem, FillLayer, Node};
|
||||
use vectorcraft_doc::{AppearanceItem, FillLayer, LineJoin, Node};
|
||||
|
||||
use crate::*;
|
||||
|
||||
@@ -185,6 +185,48 @@ fn group_rows_are_the_groups_own_stack() {
|
||||
assert_eq!(fill_paint(&node(&s, b), 0).color().unwrap().to_hex(), "#00ff00");
|
||||
}
|
||||
|
||||
/// #6739: `stroke.set` without an item on a group with a stroke row of its own edits that row;
|
||||
/// its members, which have no stroke (as paths a PDF import brings in), are left alone instead of
|
||||
/// each getting a black 1 pt stroke. Options alone never make a stroke visible: a row created for
|
||||
/// a join has no paint, while a weight still gives the usual black stroke.
|
||||
#[test]
|
||||
fn stroke_options_on_a_group_with_its_own_stroke_edit_that_stroke() {
|
||||
let mut s = session();
|
||||
let (a, b) = (rect(&mut s, 100.0), rect(&mut s, 250.0));
|
||||
for id in [a, b] {
|
||||
run(&mut s, "appearance.removeItem", json!({"ids": [id.0], "index": 1}));
|
||||
assert!(node(&s, id).appearance.stroke().is_none(), "the member has no stroke row");
|
||||
}
|
||||
let g = NodeId(run(&mut s, "object.group", json!({"ids": [a.0, b.0]}))["id"].as_u64().unwrap());
|
||||
run(&mut s, "appearance.addStroke", json!({"ids": [g.0]}));
|
||||
run(&mut s, "appearance.setItem", json!({"ids": [g.0], "index": 0, "color": "#ffffff", "weight": 2}));
|
||||
let r = run(&mut s, "stroke.set", json!({"ids": [g.0], "join": "round"}));
|
||||
assert_eq!(r["objects"], 1, "{r}");
|
||||
let gs = node(&s, g).appearance.stroke().unwrap().clone();
|
||||
assert_eq!((gs.join, gs.width, gs.paint.color().map(|c| c.to_hex())), (LineJoin::Round, 2.0, Some("#ffffff".to_string())));
|
||||
for id in [a, b] {
|
||||
assert!(node(&s, id).appearance.stroke().is_none(), "a member keeps no stroke");
|
||||
}
|
||||
// A group without a stroke of its own still reaches its members; for a join alone the row
|
||||
// made on each has no paint, so nothing becomes visible.
|
||||
let (c, d) = (rect(&mut s, 400.0), rect(&mut s, 550.0));
|
||||
for id in [c, d] {
|
||||
run(&mut s, "appearance.removeItem", json!({"ids": [id.0], "index": 1}));
|
||||
}
|
||||
let h = NodeId(run(&mut s, "object.group", json!({"ids": [c.0, d.0]}))["id"].as_u64().unwrap());
|
||||
run(&mut s, "stroke.set", json!({"ids": [h.0], "join": "bevel"}));
|
||||
for id in [c, d] {
|
||||
let st = node(&s, id).appearance.stroke().cloned().expect("a stroke row for the join");
|
||||
assert_eq!((st.paint, st.join), (Paint::None, LineJoin::Bevel), "no paint for a join alone");
|
||||
}
|
||||
// A weight is a visible stroke: an object without one gets the black stroke, as before.
|
||||
let e = rect(&mut s, 700.0);
|
||||
run(&mut s, "appearance.removeItem", json!({"ids": [e.0], "index": 1}));
|
||||
run(&mut s, "stroke.set", json!({"ids": [e.0], "weight": 3}));
|
||||
let st = node(&s, e).appearance.stroke().cloned().unwrap();
|
||||
assert_eq!((st.paint, st.width), (Paint::solid(Color::BLACK), 3.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn text_items_take_item_paint() {
|
||||
let mut s = session();
|
||||
|
||||
@@ -485,7 +485,7 @@ fn making_and_restyling_type_reports_its_overflow() {
|
||||
}
|
||||
|
||||
/// The formats whose exports draw type.
|
||||
const DRAWING_FORMATS: [&str; 8] = ["pdf", "eps", "svg", "png", "jpg", "tiff", "emf", "wmf"];
|
||||
const DRAWING_FORMATS: [&str; 9] = ["pdf", "eps", "svg", "png", "jpg", "tiff", "emf", "wmf", "hpgl"];
|
||||
|
||||
/// The warnings of `document.export {format, …options}` about type that doesn't fit its frame.
|
||||
fn export_overflow(s: &mut Session, format: &str, options: Value) -> Vec<String> {
|
||||
|
||||
@@ -104,7 +104,10 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
|
||||
let list = run(&mut s, "brush.libraries", json!({}));
|
||||
let libs = list["libraries"].as_array().unwrap();
|
||||
let ids: Vec<&str> = libs.iter().map(|l| l["id"].as_str().unwrap()).collect();
|
||||
assert_eq!(ids, ["art-ribbons", "calligraphic-nibs", "pattern-borders", "scatter-shapes", "game-trails", "energy-beams", "dry-media"]);
|
||||
assert_eq!(
|
||||
ids,
|
||||
["art-ribbons", "calligraphic-nibs", "bristle-brushes", "pattern-borders", "scatter-shapes", "game-trails", "energy-beams", "dry-media"]
|
||||
);
|
||||
assert!(libs.iter().all(|l| l["category"] == "builtIn"));
|
||||
let lib = run(&mut s, "brush.library", json!({"library": "art ribbons"}));
|
||||
assert_eq!(
|
||||
@@ -117,19 +120,19 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
|
||||
trails["brushes"].as_array().unwrap().iter().map(|b| b["name"].as_str().unwrap()).collect::<Vec<_>>(),
|
||||
["Speed Line", "Dash Trail", "Burst Ray", "Zigzag"]
|
||||
);
|
||||
assert_eq!(libs[4]["count"].as_u64(), Some(4));
|
||||
assert_eq!(libs[5]["count"].as_u64(), Some(4));
|
||||
let beams = run(&mut s, "brush.library", json!({"library": "energy-beams"}));
|
||||
assert_eq!(
|
||||
beams["brushes"].as_array().unwrap().iter().map(|b| b["name"].as_str().unwrap()).collect::<Vec<_>>(),
|
||||
["Laser Bolt", "Plasma Arc", "Charge Wave", "Spark Trail"]
|
||||
);
|
||||
assert_eq!(libs[5]["count"].as_u64(), Some(4));
|
||||
assert_eq!(libs[6]["count"].as_u64(), Some(4));
|
||||
let dry = run(&mut s, "brush.library", json!({"library": "Dry Media"}));
|
||||
assert_eq!(
|
||||
dry["brushes"].as_array().unwrap().iter().map(|b| (b["name"].as_str().unwrap(), b["type"].as_str().unwrap())).collect::<Vec<_>>(),
|
||||
[("Chalk Grain", "art"), ("Graphite Pencil", "art"), ("Wax Crayon", "art"), ("Charcoal Dust", "art")]
|
||||
);
|
||||
assert_eq!((libs[6]["name"].as_str(), libs[6]["count"].as_u64()), (Some("Dry Media"), Some(4)));
|
||||
assert_eq!((libs[7]["name"].as_str(), libs[7]["count"].as_u64()), (Some("Dry Media"), Some(4)));
|
||||
run(&mut s, "file.new", json!({"width": 200, "height": 200}));
|
||||
let id = run(&mut s, "shape.rectangle", json!({"x": 10, "y": 20, "width": 40, "height": 8}))["id"].as_u64().unwrap();
|
||||
let added = run(&mut s, "brush.addFromLibrary", json!({"library": "energy-beams", "name": "Laser Bolt", "apply": true, "ids": [id]}));
|
||||
@@ -138,6 +141,7 @@ fn the_builtin_libraries_are_original_brushes_generated_in_code() {
|
||||
for (id, kind) in [
|
||||
("art-ribbons", "art"),
|
||||
("calligraphic-nibs", "calligraphic"),
|
||||
("bristle-brushes", "bristle"),
|
||||
("pattern-borders", "pattern"),
|
||||
("scatter-shapes", "scatter"),
|
||||
("game-trails", "art"),
|
||||
@@ -303,6 +307,77 @@ fn the_dry_media_library_holds_grainy_art_brushes_with_bounded_art() {
|
||||
}
|
||||
}
|
||||
|
||||
/// Bristle Brushes: one brush per tip shape, every value inside the range the brush keeps (a value
|
||||
/// outside would be clamped without notice), names no other library or default brush uses; added
|
||||
/// in one step, not twice, and saved as a library they reopen unchanged.
|
||||
#[test]
|
||||
fn the_bristle_brushes_library_covers_every_tip_shape_within_the_bristle_ranges() {
|
||||
use vectorcraft_brush::{Bristle, BristleShape};
|
||||
let mut s = session();
|
||||
let (_, lib) = cmd::brushlib::library(&s, "bristle-brushes").unwrap();
|
||||
assert_eq!(lib.name, "Bristle Brushes");
|
||||
let names: Vec<String> = lib.brushes.iter().map(|b| b.name.clone()).collect();
|
||||
assert!((8..=10).contains(&names.len()), "{names:?}");
|
||||
let within = |v: f64, (lo, hi): (f64, f64)| (lo..=hi).contains(&v);
|
||||
let mut shapes = vec![];
|
||||
for b in &lib.brushes {
|
||||
let BrushKind::Bristle(x) = &b.kind else { panic!("{} is not a bristle brush", b.name) };
|
||||
assert!(within(x.size, Bristle::SIZE_RANGE) && within(x.length, Bristle::LENGTH_RANGE), "{}", b.name);
|
||||
for v in [x.density, x.thickness, x.opacity, x.stiffness] {
|
||||
assert!(within(v, Bristle::PERCENT_RANGE), "{}: {v}", b.name);
|
||||
}
|
||||
let mut kept = b.clone();
|
||||
kept.sanitize();
|
||||
assert_eq!(&kept, b, "sanitizing changes {}", b.name);
|
||||
assert!(b.name.chars().count() <= Bristle::MAX_NAME_CHARS, "{}", b.name);
|
||||
if !shapes.contains(&x.shape) {
|
||||
shapes.push(x.shape);
|
||||
}
|
||||
}
|
||||
let every = [
|
||||
BristleShape::RoundPoint,
|
||||
BristleShape::FlatPoint,
|
||||
BristleShape::RoundBlunt,
|
||||
BristleShape::FlatBlunt,
|
||||
BristleShape::RoundCurve,
|
||||
BristleShape::FlatCurve,
|
||||
BristleShape::RoundAngle,
|
||||
BristleShape::FlatAngle,
|
||||
BristleShape::RoundFan,
|
||||
BristleShape::FlatFan,
|
||||
];
|
||||
assert!(every.iter().all(|x| shapes.contains(x)), "{shapes:?}");
|
||||
// Names of its own: no default brush's, no other built-in library's, none twice.
|
||||
let defaults: Vec<&str> = vectorcraft_brush::defaults().iter().map(|b| b.name.as_str()).collect();
|
||||
let others: Vec<String> = cmd::brushlib::BUILTIN
|
||||
.iter()
|
||||
.filter(|b| b.id != "bristle-brushes")
|
||||
.flat_map(|b| cmd::brushlib::library(&s, b.id).unwrap().1.brushes.iter().map(|x| x.name.clone()).collect::<Vec<_>>())
|
||||
.collect();
|
||||
for (i, n) in names.iter().enumerate() {
|
||||
assert!(!defaults.contains(&n.as_str()) && !others.contains(n) && !names[..i].contains(n), "{n}");
|
||||
}
|
||||
|
||||
// Added to a document in one undo step; adding them again adds nothing.
|
||||
let before = (undo_len(&s), brushes(&s));
|
||||
let r = run(&mut s, "brush.addFromLibrary", json!({"library": "Bristle Brushes"}));
|
||||
assert_eq!(strs(&r["added"]), names.iter().map(String::as_str).collect::<Vec<_>>());
|
||||
assert_eq!(undo_len(&s), before.0 + 1);
|
||||
assert_eq!(brushes(&s), [before.1.clone(), names.clone()].concat());
|
||||
for b in &lib.brushes {
|
||||
assert_eq!(&brush(&s, &b.name), b);
|
||||
}
|
||||
let again = undo_len(&s);
|
||||
let r = run(&mut s, "brush.addFromLibrary", json!({"library": "bristle-brushes"}));
|
||||
assert_eq!((strs(&r["added"]).len(), strs(&r["existing"]).len(), undo_len(&s)), (0, names.len(), again));
|
||||
// Saved as a library and loaded back: the same brushes, in the same order.
|
||||
let saved = run(&mut s, "brush.saveLibrary", json!({ "names": names, "name": "Bristles" }));
|
||||
let b64 = saved["dataBase64"].as_str().unwrap().to_string();
|
||||
let r = run(&mut s, "brush.loadLibrary", json!({"dataBase64": b64, "name": "Bristles.vectorcraft"}));
|
||||
let (_, reopened) = cmd::brushlib::library(&s, r["library"].as_str().unwrap()).unwrap();
|
||||
assert_eq!(reopened.brushes, lib.brushes);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_saved_library_reopens_and_its_brushes_join_another_document_in_one_step() {
|
||||
let dir = folder("user");
|
||||
|
||||
@@ -365,6 +365,255 @@ fn pattern_brushes_place_their_tiles_in_a_row() {
|
||||
assert_eq!(tiles[1].children().unwrap().len(), 1, "no frame, no rectangle");
|
||||
}
|
||||
|
||||
/// `brush.replaceArt` reads the tiles `brush.placeArt` places back tile by tile, frames included:
|
||||
/// every tile and the frame keep their sizes, and the frame keeps its place around the art.
|
||||
#[test]
|
||||
fn placed_pattern_tiles_go_back_into_the_brush_tile_by_tile() {
|
||||
let mut s = session();
|
||||
let name = framed_pattern_brush(&mut s);
|
||||
let before = s.execute("brush.get", &json!({"name": name})).unwrap();
|
||||
let id = NodeId(s.execute("brush.placeArt", &json!({"name": name, "x": 200, "y": 150})).unwrap()["id"].as_u64().unwrap());
|
||||
let steps = undo_steps(&s);
|
||||
s.execute("brush.replaceArt", &json!({"name": name, "ids": [id.0]})).unwrap();
|
||||
assert_eq!(undo_steps(&s), steps + 1);
|
||||
let after = s.execute("brush.get", &json!({"name": name})).unwrap();
|
||||
let size = |v: &Value| {
|
||||
let n: Node = serde_json::from_value(v.clone()).unwrap();
|
||||
let b = n.geometric_bounds().unwrap();
|
||||
(b.width(), b.height())
|
||||
};
|
||||
for key in ["side", "outer_corner", "start"] {
|
||||
let (a, b) = (size(&before[key]), size(&after[key]));
|
||||
assert!((a.0 - b.0).abs() < 1e-6 && (a.1 - b.1).abs() < 1e-6, "{key}: {a:?} → {b:?}");
|
||||
}
|
||||
assert!(after.get("end").is_none_or(Value::is_null) && after.get("inner_corner").is_none_or(Value::is_null));
|
||||
let frame: Rect = serde_json::from_value(after["side_frame"].clone()).unwrap();
|
||||
let art: Node = serde_json::from_value(after["side"].clone()).unwrap();
|
||||
let art = art.geometric_bounds().unwrap();
|
||||
assert!((frame.width() - 24.0).abs() < 1e-6 && (art.x0 - frame.x0 - 2.0).abs() < 1e-6, "{frame:?} around {art:?}");
|
||||
assert!(after["outer_corner_frame"].is_null() || after.get("outer_corner_frame").is_none());
|
||||
}
|
||||
|
||||
/// Art that is not the tiles `brush.placeArt` places becomes a pattern brush's side tile, and the
|
||||
/// other tiles stay; one tile group alone replaces only that tile.
|
||||
#[test]
|
||||
fn other_art_replaces_the_side_tile_of_a_pattern_brush() {
|
||||
let mut s = session();
|
||||
let name = framed_pattern_brush(&mut s);
|
||||
let before = s.execute("brush.get", &json!({"name": name})).unwrap();
|
||||
let r = rect(&mut s, 100.0, 100.0, 30.0, 12.0);
|
||||
s.execute("brush.replaceArt", &json!({"name": name, "ids": [r.0]})).unwrap();
|
||||
let after = s.execute("brush.get", &json!({"name": name})).unwrap();
|
||||
let side: Node = serde_json::from_value(after["side"].clone()).unwrap();
|
||||
assert!(close(side.geometric_bounds().unwrap(), Rect::new(100.0, 100.0, 130.0, 112.0), 1e-6));
|
||||
assert!(after.get("side_frame").is_none_or(Value::is_null), "the old frame goes with the old art");
|
||||
assert_eq!((&after["outer_corner"], &after["start"]), (&before["outer_corner"], &before["start"]));
|
||||
// One placed tile, its group dragged back alone: only the start tile changes.
|
||||
let id = NodeId(s.execute("brush.placeArt", &json!({"name": name})).unwrap()["id"].as_u64().unwrap());
|
||||
let start = node(&s, id).children().unwrap()[2].clone();
|
||||
assert_eq!(start.name.as_deref(), Some("Start Tile"));
|
||||
s.execute("brush.replaceArt", &json!({"name": name, "ids": [start.id.0]})).unwrap();
|
||||
let last = s.execute("brush.get", &json!({"name": name})).unwrap();
|
||||
assert_eq!((&last["side"], &last["outer_corner"]), (&after["side"], &after["outer_corner"]));
|
||||
let art: Node = serde_json::from_value(last["start"].clone()).unwrap();
|
||||
assert!(close(art.geometric_bounds().unwrap(), start.geometric_bounds().unwrap(), 1e-6), "the start tile is the placed one");
|
||||
assert!(art.name.is_none(), "the tile's name stays on the canvas");
|
||||
}
|
||||
|
||||
/// `brush.replaceArt` gives a brush new art in one undo step: strokes that use it redraw with it,
|
||||
/// or with `applyToStrokes: false` keep the brush as it was while a copy with the new art becomes
|
||||
/// the current brush. A brush no stroke uses changes in place either way.
|
||||
#[test]
|
||||
fn replace_art_applies_to_strokes_or_leaves_them_on_the_old_brush() {
|
||||
let mut s = session();
|
||||
let r = rect(&mut s, 10.0, 200.0, 40.0, 8.0);
|
||||
s.execute("brush.new", &json!({"type": "art", "name": "Bar", "ids": [r.0]})).unwrap();
|
||||
let path = line(&mut s);
|
||||
s.execute("brush.apply", &json!({"name": "Bar", "ids": [path.0]})).unwrap();
|
||||
let thin = brushed_bounds(&s, path).height();
|
||||
// A path painted with a brush made from the taller art: what the stroke should draw.
|
||||
let tall = rect(&mut s, 10.0, 220.0, 40.0, 20.0);
|
||||
s.execute("brush.new", &json!({"type": "art", "name": "Tall", "ids": [tall.0]})).unwrap();
|
||||
let reference = line(&mut s);
|
||||
s.execute("brush.apply", &json!({"name": "Tall", "ids": [reference.0]})).unwrap();
|
||||
let want = brushed_bounds(&s, reference).height();
|
||||
assert!(want > thin * 2.0, "{want} against {thin}");
|
||||
// Apply to Strokes: the stroke redraws with the taller art.
|
||||
let steps = undo_steps(&s);
|
||||
let r = s.execute("brush.replaceArt", &json!({"name": "Bar", "ids": [tall.0]})).unwrap();
|
||||
assert_eq!(r["name"], "Bar");
|
||||
assert_eq!(undo_steps(&s), steps + 1);
|
||||
assert!((brushed_bounds(&s, path).height() - want).abs() < 1e-6);
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
assert!((brushed_bounds(&s, path).height() - thin).abs() < 1e-9, "undo puts the old art back");
|
||||
s.execute("edit.redo", &json!({})).unwrap();
|
||||
// Leave Strokes: the stroke keeps Bar as it was; Bar copy has the new art, after Bar, current.
|
||||
let short = rect(&mut s, 10.0, 260.0, 40.0, 4.0);
|
||||
let bar = s.execute("brush.get", &json!({"name": "Bar"})).unwrap();
|
||||
let r = s.execute("brush.replaceArt", &json!({"name": "Bar", "ids": [short.0], "applyToStrokes": false})).unwrap();
|
||||
assert_eq!(r["name"], "Bar copy");
|
||||
assert_eq!(brush_of(&s, path).as_deref(), Some("Bar"));
|
||||
assert_eq!(s.execute("brush.get", &json!({"name": "Bar"})).unwrap(), bar);
|
||||
assert!((brushed_bounds(&s, path).height() - want).abs() < 1e-6);
|
||||
let copy: Node = serde_json::from_value(s.execute("brush.get", &json!({"name": "Bar copy"})).unwrap()["art"].clone()).unwrap();
|
||||
assert!((copy.geometric_bounds().unwrap().height() - 4.0).abs() < 1e-6);
|
||||
let list = s.execute("brush.list", &json!({})).unwrap();
|
||||
assert_eq!(list["current"], "Bar copy");
|
||||
let names: Vec<&str> = list["brushes"].as_array().unwrap().iter().map(|b| b["name"].as_str().unwrap()).collect();
|
||||
let at = names.iter().position(|n| *n == "Bar").unwrap();
|
||||
assert_eq!(names.get(at + 1), Some(&"Bar copy"));
|
||||
// No stroke uses Bar copy: its art changes in place, with or without applying.
|
||||
s.execute("brush.replaceArt", &json!({"name": "Bar copy", "ids": [tall.0], "applyToStrokes": false})).unwrap();
|
||||
assert!(s.execute("brush.get", &json!({"name": "Bar copy 2"})).is_err());
|
||||
}
|
||||
|
||||
/// `brush.replaceArt` refuses a brush without art, an unknown brush, an empty selection, art with no
|
||||
/// width and an `applyToStrokes` that is not a boolean, and changes nothing then.
|
||||
#[test]
|
||||
fn replace_art_refuses_what_it_cannot_take() {
|
||||
let mut s = session();
|
||||
let r = rect(&mut s, 10.0, 20.0, 40.0, 8.0);
|
||||
let flat = s.execute("shape.line", &json!({"x1": 50, "y1": 100, "x2": 50, "y2": 160})).unwrap()["id"].as_u64().unwrap();
|
||||
let lib = s.execute("brush.list", &json!({})).unwrap();
|
||||
let steps = undo_steps(&s);
|
||||
for (p, msg) in [
|
||||
(json!({"name": "3 pt. Round", "ids": [r.0]}), "`3 pt. Round` has no art (only scatter, art and pattern brushes do)"),
|
||||
(json!({"name": "Bristle Round", "ids": [r.0]}), "`Bristle Round` has no art (only scatter, art and pattern brushes do)"),
|
||||
(json!({"name": "Nope", "ids": [r.0]}), "no brush named `Nope`"),
|
||||
(json!({"name": "Arrow", "ids": [flat]}), "the selected art has no width"),
|
||||
(json!({"name": "Chain", "ids": [flat]}), "the selected art has no width"),
|
||||
(json!({"name": "Arrow", "ids": [r.0], "applyToStrokes": "no"}), "`applyToStrokes` must be true or false"),
|
||||
] {
|
||||
let e = s.execute("brush.replaceArt", &p).unwrap_err();
|
||||
assert!(e.to_string().contains(msg), "{p}: {e}");
|
||||
}
|
||||
s.select(|_, sel| sel.clear()).unwrap();
|
||||
let e = s.execute("brush.replaceArt", &json!({"name": "Arrow"})).unwrap_err();
|
||||
assert!(e.to_string().contains("nothing selected"), "{e}");
|
||||
assert_eq!(undo_steps(&s), steps);
|
||||
assert_eq!(s.execute("brush.list", &json!({})).unwrap(), lib);
|
||||
}
|
||||
|
||||
/// An instance of a symbol whose art has no width is art with no width for `brush.new` and
|
||||
/// `brush.replaceArt`, although an instance's box without its document has width.
|
||||
#[test]
|
||||
fn a_symbol_whose_art_has_no_width_makes_no_brush_art() {
|
||||
let mut s = session();
|
||||
let flat = NodeId(s.execute("shape.line", &json!({"x1": 50, "y1": 100, "x2": 50, "y2": 160})).unwrap()["id"].as_u64().unwrap());
|
||||
let art = node(&s, flat);
|
||||
s.execute("edit.clear", &json!({"ids": [flat.0]})).unwrap();
|
||||
let st = s.doc_mut().unwrap();
|
||||
let d = std::sync::Arc::make_mut(&mut st.doc);
|
||||
d.symbols.push(vectorcraft_doc::Symbol { dynamic: false, name: "Flat".into(), art: std::sync::Arc::new(art) });
|
||||
let layer = d.layers[0].id;
|
||||
let inst = d.alloc_id();
|
||||
d.insert(Some(layer), usize::MAX, Node::new(inst, NodeKind::SymbolInstance { symbol: "Flat".into(), xf: vectorcraft_geom::Affine::IDENTITY }))
|
||||
.unwrap();
|
||||
assert!(node(&s, inst).geometric_bounds().is_some_and(|b| b.width() > 1.0), "the box an instance has without its document");
|
||||
for (cmd, p) in [("brush.new", json!({"type": "art", "ids": [inst.0]})), ("brush.replaceArt", json!({"name": "Arrow", "ids": [inst.0]}))] {
|
||||
let e = s.execute(cmd, &p).unwrap_err();
|
||||
assert!(e.to_string().contains("the selected art has no width"), "{cmd}: {e}");
|
||||
}
|
||||
}
|
||||
|
||||
/// `brush.replaceArt` checks only the art it is given: a tile the pattern brush already has that
|
||||
/// has no width does not stop another tile from being replaced.
|
||||
#[test]
|
||||
fn replace_art_checks_only_the_tiles_it_is_given() {
|
||||
let mut s = session();
|
||||
let flat = NodeId(s.execute("shape.line", &json!({"x1": 50, "y1": 100, "x2": 50, "y2": 160})).unwrap()["id"].as_u64().unwrap());
|
||||
let end = art_json(&mut s, flat);
|
||||
s.execute("brush.options", &json!({"name": "Chain", "params": {"end": end}})).unwrap();
|
||||
let r = rect(&mut s, 10.0, 20.0, 40.0, 8.0);
|
||||
s.execute("brush.replaceArt", &json!({"name": "Chain", "ids": [r.0]})).unwrap();
|
||||
let side: Node = serde_json::from_value(s.execute("brush.get", &json!({"name": "Chain"})).unwrap()["side"].clone()).unwrap();
|
||||
assert!(close(side.geometric_bounds().unwrap(), bounds(&s, r), 1e-6));
|
||||
}
|
||||
|
||||
/// Tile `key` (`side`, `start`…) of pattern brush `name`.
|
||||
fn tile_art(s: &mut Session, name: &str, key: &str) -> Node {
|
||||
serde_json::from_value(s.execute("brush.get", &json!({"name": name})).unwrap()[key].clone()).unwrap()
|
||||
}
|
||||
|
||||
/// A pattern brush tile placed with `brush.placeArt` and given back with `brush.replaceArt` is the
|
||||
/// art it was, not that art inside the tile's group, however many times it goes out and back.
|
||||
#[test]
|
||||
fn pattern_tiles_go_out_and_back_without_gaining_a_group() {
|
||||
let mut s = session();
|
||||
let name = framed_pattern_brush(&mut s);
|
||||
let size = |n: &Node| {
|
||||
let b = n.geometric_bounds().unwrap();
|
||||
(b.width(), b.height())
|
||||
};
|
||||
let first = tile_art(&mut s, &name, "side");
|
||||
assert!(matches!(first.kind, NodeKind::Path { .. }), "{:?}", first.kind);
|
||||
for round in 1..=2 {
|
||||
let id = s.execute("brush.placeArt", &json!({"name": name})).unwrap()["id"].as_u64().unwrap();
|
||||
s.execute("brush.replaceArt", &json!({"name": name, "ids": [id]})).unwrap();
|
||||
let side = tile_art(&mut s, &name, "side");
|
||||
assert!(matches!(side.kind, NodeKind::Path { .. }), "round {round}: {:?}", side.kind);
|
||||
let (a, b) = (size(&first), size(&side));
|
||||
assert!((a.0 - b.0).abs() < 1e-6 && (a.1 - b.1).abs() < 1e-6, "round {round}: {a:?} → {b:?}");
|
||||
}
|
||||
}
|
||||
|
||||
/// A tile group whose art was deleted, leaving only the rectangle that marks its frame, is art with
|
||||
/// no width: the brush keeps its tile.
|
||||
#[test]
|
||||
fn a_tile_group_holding_only_its_frame_is_refused() {
|
||||
let mut s = session();
|
||||
let name = framed_pattern_brush(&mut s);
|
||||
let before = s.execute("brush.get", &json!({"name": name})).unwrap();
|
||||
let id = NodeId(s.execute("brush.placeArt", &json!({"name": name})).unwrap()["id"].as_u64().unwrap());
|
||||
let side = node(&s, id).children().unwrap()[0].clone();
|
||||
assert_eq!(side.name.as_deref(), Some("Side Tile"));
|
||||
let art = side.children().unwrap()[1].id;
|
||||
s.execute("edit.clear", &json!({"ids": [art.0]})).unwrap();
|
||||
let steps = undo_steps(&s);
|
||||
let e = s.execute("brush.replaceArt", &json!({"name": name, "ids": [side.id.0]})).unwrap_err();
|
||||
assert!(e.to_string().contains("the selected art has no width"), "{e}");
|
||||
assert_eq!(undo_steps(&s), steps);
|
||||
assert_eq!(s.execute("brush.get", &json!({"name": name})).unwrap(), before);
|
||||
}
|
||||
|
||||
/// Two groups named for the same tile: the frontmost one is the tile's art.
|
||||
#[test]
|
||||
fn the_frontmost_group_named_for_a_tile_is_that_tile() {
|
||||
let mut s = session();
|
||||
let name = framed_pattern_brush(&mut s);
|
||||
let back = rect(&mut s, 10.0, 10.0, 20.0, 10.0);
|
||||
let front = rect(&mut s, 10.0, 40.0, 30.0, 10.0);
|
||||
let (back, front) = (node(&s, back), node(&s, front));
|
||||
s.execute("edit.clear", &json!({"ids": [back.id.0, front.id.0]})).unwrap();
|
||||
let st = s.doc_mut().unwrap();
|
||||
let d = std::sync::Arc::make_mut(&mut st.doc);
|
||||
let tile = |d: &mut Document, n: Node| {
|
||||
let mut g = Node::group(d.alloc_id(), vec![std::sync::Arc::new(n)]);
|
||||
g.name = Some("Start Tile".into());
|
||||
std::sync::Arc::new(g)
|
||||
};
|
||||
let tiles = vec![tile(d, back), tile(d, front)];
|
||||
let both = Node::group(d.alloc_id(), tiles);
|
||||
let both_id = both.id;
|
||||
let layer = d.layers[0].id;
|
||||
d.insert(Some(layer), usize::MAX, both).unwrap();
|
||||
s.execute("brush.replaceArt", &json!({"name": name, "ids": [both_id.0]})).unwrap();
|
||||
let start = tile_art(&mut s, &name, "start");
|
||||
assert!((start.geometric_bounds().unwrap().width() - 30.0).abs() < 1e-6, "{:?}", start.geometric_bounds());
|
||||
}
|
||||
|
||||
/// Type is art for `brush.replaceArt` as it is for `brush.new`: taken as it is.
|
||||
#[test]
|
||||
fn replace_art_takes_type_as_brush_new_does() {
|
||||
let mut s = session();
|
||||
let t = s.execute("text.create", &json!({"x": 20, "y": 60, "text": "Hi", "size": 24})).unwrap()["id"].as_u64().unwrap();
|
||||
let want = art_json(&mut s, NodeId(t));
|
||||
s.execute("brush.replaceArt", &json!({"name": "Arrow", "ids": [t]})).unwrap();
|
||||
assert_eq!(s.execute("brush.get", &json!({"name": "Arrow"})).unwrap()["art"], want);
|
||||
let made = s.execute("brush.new", &json!({"type": "art", "ids": [t]})).unwrap()["name"].as_str().unwrap().to_string();
|
||||
assert_eq!(s.execute("brush.get", &json!({"name": made})).unwrap()["art"], want);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn brush_options_rename_duplicate_and_delete_update_strokes() {
|
||||
let mut s = session();
|
||||
|
||||
@@ -0,0 +1,183 @@
|
||||
//! Kerning at the Type tool's caret at the start of a line (#5111): with no character on the line
|
||||
//! before the caret, `type.step`, `type.resetTracking` and the Kerning field set the space before
|
||||
//! the character after it (`kerningBefore`), as one undo step, and the character moves.
|
||||
|
||||
use serde_json::json;
|
||||
use vectorcraft_doc::{CharStyle, NodeId, NodeKind, TextObject};
|
||||
use vectorcraft_tools::{Mods, PointerEvent, PointerKind, ToolKey};
|
||||
|
||||
use crate::*;
|
||||
|
||||
fn session() -> Session {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({"width": 400, "height": 400})).unwrap();
|
||||
s
|
||||
}
|
||||
|
||||
fn text(s: &mut Session, t: &str) -> NodeId {
|
||||
NodeId(s.execute("text.create", &json!({"x": 100, "y": 100, "text": t, "size": 20})).unwrap()["id"].as_u64().unwrap())
|
||||
}
|
||||
|
||||
fn obj(s: &Session, id: NodeId) -> TextObject {
|
||||
let Some(NodeKind::Text(t)) = s.doc().unwrap().doc.node(id).map(|n| &n.kind) else { panic!("not text") };
|
||||
(**t).clone()
|
||||
}
|
||||
|
||||
fn style_at(s: &Session, id: NodeId, byte: usize) -> CharStyle {
|
||||
vectorcraft_text::edit::style_at(&obj(s, id).runs, byte + 1)
|
||||
}
|
||||
|
||||
/// Where glyph `byte` is drawn along its line, in text space.
|
||||
fn drawn_x(s: &Session, id: NodeId, byte: usize) -> f64 {
|
||||
let l = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &obj(s, id));
|
||||
l.glyphs.iter().find(|g| g.byte == byte).unwrap().xf.as_coeffs()[4]
|
||||
}
|
||||
|
||||
/// The Type tool editing `id` (made by [`text`]) with its caret at byte `caret`.
|
||||
fn caret_in(s: &mut Session, id: NodeId, caret: usize) -> ViewInfo {
|
||||
let v = ViewInfo::default();
|
||||
s.select_tool("type", v).unwrap();
|
||||
for k in [PointerKind::Down, PointerKind::Up] {
|
||||
s.pointer(&PointerEvent::new(k, 102.0, 95.0), v).unwrap();
|
||||
}
|
||||
assert_eq!(s.tool_options()["editing"], json!(id.0), "editing the text");
|
||||
s.set_tool_option("select", &json!({"start": caret, "end": caret}));
|
||||
v
|
||||
}
|
||||
|
||||
fn step_at(s: &mut Session, id: NodeId, caret: usize, by: i32) -> serde_json::Value {
|
||||
s.execute("type.step", &json!({"id": id.0, "start": caret, "end": caret, "attribute": "kerning", "by": by})).unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_step_at_the_start_of_the_text_moves_the_first_character() {
|
||||
let mut s = session();
|
||||
let id = text(&mut s, "AV");
|
||||
let inc = s.prefs.tracking_increment;
|
||||
let (a, v) = (drawn_x(&s, id, 0), drawn_x(&s, id, 1));
|
||||
assert_eq!(step_at(&mut s, id, 0, 1)["ids"], json!([id.0]));
|
||||
let st = style_at(&s, id, 0);
|
||||
assert_eq!((st.kerning_before, st.kerning), (inc, None), "the space before A, not after it");
|
||||
// A step of `inc` thousandths of the 20 pt em moves both letters along the line.
|
||||
let moved = inc / 1000.0 * 20.0;
|
||||
assert!((drawn_x(&s, id, 0) - a - moved).abs() < 1e-6 && (drawn_x(&s, id, 1) - v - moved).abs() < 1e-6);
|
||||
// A negative step goes back towards the line's start, past it.
|
||||
step_at(&mut s, id, 0, -3);
|
||||
assert_eq!(style_at(&s, id, 0).kerning_before, -2.0 * inc);
|
||||
assert!((drawn_x(&s, id, 0) - a + 2.0 * moved).abs() < 1e-6);
|
||||
// One undo step each.
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
assert_eq!(style_at(&s, id, 0).kerning_before, inc);
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
assert_eq!(style_at(&s, id, 0).kerning_before, 0.0);
|
||||
assert!((drawn_x(&s, id, 0) - a).abs() < 1e-6);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inside_a_line_a_step_still_kerns_the_character_before_the_caret() {
|
||||
let mut s = session();
|
||||
let id = text(&mut s, "AV");
|
||||
step_at(&mut s, id, 1, 1);
|
||||
let (a, v) = (style_at(&s, id, 0), style_at(&s, id, 1));
|
||||
assert_eq!((a.kerning_before, v.kerning_before, v.kerning), (0.0, 0.0, None));
|
||||
assert!(a.kerning.is_some(), "the pair after A");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_start_of_a_paragraph_or_after_a_forced_line_break_kerns_the_character_after_it() {
|
||||
let mut s = session();
|
||||
let inc = s.prefs.tracking_increment;
|
||||
let id = text(&mut s, "One\nTwo");
|
||||
let t = drawn_x(&s, id, 4);
|
||||
step_at(&mut s, id, 4, 1);
|
||||
assert_eq!((style_at(&s, id, 3).kerning, style_at(&s, id, 4).kerning_before), (None, inc), "not the line break's kerning");
|
||||
assert!(drawn_x(&s, id, 4) > t, "T moves");
|
||||
let forced = text(&mut s, "One\u{2028}Two");
|
||||
let after = "One\u{2028}".len();
|
||||
step_at(&mut s, forced, after, 1);
|
||||
assert_eq!((style_at(&s, forced, 3).kerning, style_at(&s, forced, after).kerning_before), (None, inc));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_empty_line_has_nothing_to_kern() {
|
||||
let mut s = session();
|
||||
let id = text(&mut s, "One\n\nTwo");
|
||||
let before = obj(&s, id).runs;
|
||||
assert_eq!(step_at(&mut s, id, 4, 1)["ids"], json!([]));
|
||||
assert_eq!(obj(&s, id).runs, before);
|
||||
// Nor does the end of text after a line break.
|
||||
let end = text(&mut s, "One\n");
|
||||
assert_eq!(step_at(&mut s, end, 4, 1)["ids"], json!([]));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reset_at_the_start_of_a_line_clears_the_space_before_and_a_full_reset_clears_it_too() {
|
||||
let mut s = session();
|
||||
let id = text(&mut s, "AV");
|
||||
s.execute("text.setRangeStyle", &json!({"id": id.0, "kerning": -40, "tracking": 100})).unwrap();
|
||||
step_at(&mut s, id, 0, 2);
|
||||
assert_ne!(style_at(&s, id, 0).kerning_before, 0.0);
|
||||
// At the caret before A only the space before A goes; A keeps its kerning after it.
|
||||
caret_in(&mut s, id, 0);
|
||||
s.execute("type.resetTracking", &json!({})).unwrap();
|
||||
let st = style_at(&s, id, 0);
|
||||
assert_eq!((st.kerning_before, st.kerning, st.tracking), (0.0, Some(-40.0), 100.0));
|
||||
step_at(&mut s, id, 0, 2);
|
||||
s.execute("type.resetTracking", &json!({"ids": [id.0]})).unwrap();
|
||||
let st = style_at(&s, id, 0);
|
||||
assert_eq!((st.kerning_before, st.kerning, st.tracking), (0.0, None, 0.0), "all manual kerning");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn set_range_style_sets_the_space_before() {
|
||||
let mut s = session();
|
||||
let id = text(&mut s, "AV");
|
||||
s.execute("text.setRangeStyle", &json!({"id": id.0, "start": 0, "end": 1, "kerningBefore": 50})).unwrap();
|
||||
assert_eq!(style_at(&s, id, 0).kerning_before, 50.0);
|
||||
s.execute("text.setRangeStyle", &json!({"id": id.0, "start": 0, "end": 1, "kerningBefore": 20000})).unwrap();
|
||||
assert_eq!(style_at(&s, id, 0).kerning_before, 10000.0, "kerning's limits");
|
||||
assert!(s.execute("text.setRangeStyle", &json!({"id": id.0, "kerningBefore": "auto"})).is_err());
|
||||
}
|
||||
|
||||
/// The Type tool: Alt+← at the caret before the first character kerns it, and Alt+→ back.
|
||||
#[test]
|
||||
fn alt_arrows_at_the_caret_before_the_first_character_kern_it() {
|
||||
let mut s = session();
|
||||
let inc = s.prefs.tracking_increment;
|
||||
let id = text(&mut s, "Hello");
|
||||
let v = caret_in(&mut s, id, 0);
|
||||
let alt = Mods { alt: true, ..Mods::default() };
|
||||
s.tool_key(ToolKey::Left, alt, v).unwrap();
|
||||
assert_eq!((style_at(&s, id, 0).kerning_before, style_at(&s, id, 0).kerning), (-inc, None));
|
||||
s.tool_key(ToolKey::Right, alt, v).unwrap();
|
||||
s.tool_key(ToolKey::Right, alt, v).unwrap();
|
||||
assert_eq!(style_at(&s, id, 0).kerning_before, inc);
|
||||
}
|
||||
|
||||
/// The Eyedropper copies how type looks, not where a line starts: a sample from a first character
|
||||
/// with a space before it leaves the target's first character where it was.
|
||||
#[test]
|
||||
fn the_eyedropper_keeps_the_targets_space_before() {
|
||||
let mut s = session();
|
||||
let src = text(&mut s, "Source");
|
||||
s.execute("text.setRangeStyle", &json!({"id": src.0, "start": 0, "end": 1, "kerningBefore": 300, "tracking": 50})).unwrap();
|
||||
let dst = text(&mut s, "Target");
|
||||
s.execute("appearance.copyFrom", &json!({"source": src.0})).unwrap();
|
||||
let st = style_at(&s, dst, 0);
|
||||
assert_eq!((st.tracking, st.kerning_before), (50.0, 0.0), "the tracking goes, the space before doesn't");
|
||||
}
|
||||
|
||||
/// A character style captured from a line's first character leaves its space before out, and a
|
||||
/// style can't be given one: it would space the first character of every paragraph set in it.
|
||||
#[test]
|
||||
fn a_character_style_leaves_the_space_before_out() {
|
||||
let mut s = session();
|
||||
let id = text(&mut s, "Source");
|
||||
s.execute("text.setRangeStyle", &json!({"id": id.0, "kerningBefore": 300, "tracking": 50})).unwrap();
|
||||
s.execute("charStyle.new", &json!({"name": "Body", "id": id.0})).unwrap();
|
||||
let attrs = s.doc().unwrap().doc.char_styles[0].attrs.clone();
|
||||
assert_eq!(attrs.get("tracking"), Some(&json!(50.0)));
|
||||
assert!(!attrs.contains_key("kerningBefore"), "{attrs:?}");
|
||||
let err = s.execute("charStyle.new", &json!({"name": "Spaced", "attrs": {"kerningBefore": 100}})).unwrap_err();
|
||||
assert!(err.to_string().contains("kerningBefore"), "{err}");
|
||||
}
|
||||
@@ -432,6 +432,30 @@ fn redefining_the_symbol_keeps_the_changes_whose_objects_remain() {
|
||||
assert_eq!(overrides(&s, inst), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn redefining_the_symbol_drops_paints_its_new_objects_do_not_draw() {
|
||||
let mut s = session();
|
||||
let inst = pair(&mut s, "dynamic");
|
||||
let p = json!({"id": inst.0, "path": [1], "fill": "#ff0000", "stroke": "#ff0000", "opacity": 50});
|
||||
s.execute("symbol.instance.setAppearance", &p).unwrap();
|
||||
// The second object is now an image, which draws no fill or stroke of its own.
|
||||
let a = square(&mut s, 10.0);
|
||||
place_image(&mut s);
|
||||
let image = top(&s);
|
||||
s.execute("symbol.update", &json!({"name": "Pair", "ids": [a.0, image.0]})).unwrap();
|
||||
let o = node(&s, inst).extras().symbol_overrides.clone();
|
||||
assert_eq!(o.len(), 1, "the opacity change stays: {o:?}");
|
||||
assert_eq!((&o[0].fill, &o[0].stroke, o[0].opacity), (&None, &None, Some(0.5)));
|
||||
// A change of paint alone goes with its paint: the first object is now a blend.
|
||||
s.execute("symbol.instance.setAppearance", &json!({"id": inst.0, "path": [0], "stroke": "#ff0000"})).unwrap();
|
||||
let (b, c) = (square(&mut s, 10.0), square(&mut s, 60.0));
|
||||
let blend = id(&s.execute("object.blend.make", &json!({"ids": [b.0, c.0], "steps": 1})).unwrap());
|
||||
let d = square(&mut s, 120.0);
|
||||
s.execute("symbol.update", &json!({"name": "Pair", "ids": [blend.0, d.0]})).unwrap();
|
||||
let o = node(&s, inst).extras().symbol_overrides.clone();
|
||||
assert_eq!(o.iter().map(|o| o.path.clone()).collect::<Vec<_>>(), [vec![1]], "{o:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn replace_symbol_drops_the_changes_made_for_the_old_symbol() {
|
||||
let mut s = session();
|
||||
|
||||
@@ -234,6 +234,26 @@ fn svg_export_writes_the_drawn_size() {
|
||||
assert!(!sizes.iter().any(|v| (v - 12.0).abs() < 1e-3), "the stored size is not written: {sizes:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn release_type_on_a_path_keeps_the_drawn_size() {
|
||||
let mut s = session();
|
||||
let id = on_line(&mut s, "Release");
|
||||
s.execute("type.dynamicText", &json!({"on": true})).unwrap();
|
||||
let size = 12.0 * fit(&s, id);
|
||||
assert!(size > 24.0, "the text grows on the long line: {size}");
|
||||
let r = s.execute("addon.type.releasePath", &json!({"ids": [id.0], "mode": "text"})).unwrap();
|
||||
let released = NodeId(r["texts"][0].as_u64().unwrap());
|
||||
let t = text(&s, released);
|
||||
assert!(!t.dynamic_text, "point type does not keep Dynamic Text");
|
||||
assert!((t.runs[0].style.size - size).abs() < 1e-9, "{} vs the drawn {size}", t.runs[0].style.size);
|
||||
assert_eq!(fit(&s, released), 1.0);
|
||||
// Type on a path without Dynamic Text keeps its stored size.
|
||||
let plain = on_line(&mut s, "Plain");
|
||||
let r = s.execute("addon.type.releasePath", &json!({"ids": [plain.0], "mode": "text"})).unwrap();
|
||||
let t = text(&s, NodeId(r["texts"][0].as_u64().unwrap()));
|
||||
assert!(!t.dynamic_text && t.runs[0].style.size == 12.0);
|
||||
}
|
||||
|
||||
/// 12 pt point type at (100, 100), selected, with its layout bounds.
|
||||
fn point(s: &mut Session, content: &str) -> (NodeId, vectorcraft_geom::Rect) {
|
||||
let r = s.execute("text.create", &json!({"x": 100, "y": 100, "text": content, "size": 12})).unwrap();
|
||||
|
||||
@@ -40,7 +40,16 @@ fn built_in_presets_are_the_gradient_libraries_by_theme_with_unique_names() {
|
||||
libraries.dedup();
|
||||
assert_eq!(
|
||||
libraries,
|
||||
["Spectrum Gradients", "Sky Gradients", "Neutral Gradients", "Organic Fades", "Duotone Gradients", "Radial Glows", "Metallic Gradients"]
|
||||
[
|
||||
"Spectrum Gradients",
|
||||
"Sky Gradients",
|
||||
"Neutral Gradients",
|
||||
"Organic Fades",
|
||||
"Holographic",
|
||||
"Duotone Gradients",
|
||||
"Radial Glows",
|
||||
"Metallic Gradients"
|
||||
]
|
||||
);
|
||||
let mut seen = std::collections::HashSet::new();
|
||||
assert!(names(&list).iter().all(|n| seen.insert(n.to_lowercase())), "a name names one preset");
|
||||
@@ -82,6 +91,42 @@ fn an_organic_fade_applies_with_its_method_midpoints_and_opacities() {
|
||||
assert_eq!(row["gradient"]["method"], "perceptual");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_holographic_foil_applies_in_place_as_one_undo_step() {
|
||||
let (mut s, id) = session_with(json!({"gradient": {"angle": 30}}));
|
||||
let before = paint(&s, id, false);
|
||||
let undo = s.doc().unwrap().history.undo.len();
|
||||
let veil = s.gradient_preset("prism veil").unwrap();
|
||||
assert_eq!((veil.library, veil.gradient.method), (Some("Holographic"), GradientMethod::Perceptual));
|
||||
let r = s.execute("gradient.presets.apply", &json!({"name": "prism veil"})).unwrap();
|
||||
assert_eq!(r["name"].as_str(), Some("Prism Veil"));
|
||||
let g = paint(&s, id, false);
|
||||
assert_eq!((g.gradient.kind, g.gradient.method, &g.gradient.stops), (GradientKind::Linear, GradientMethod::Perceptual, &veil.gradient.stops));
|
||||
assert_eq!(g.gradient.stops.len(), 6);
|
||||
assert_eq!(g.angle, before.angle, "the placement stays");
|
||||
assert_eq!(s.doc().unwrap().history.undo.len(), undo + 1, "one undo step");
|
||||
assert_eq!(s.gradient_preset_name(&g.gradient).as_deref(), Some("Prism Veil"));
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
assert_eq!(paint(&s, id, false), before);
|
||||
}
|
||||
|
||||
/// A preset saved as "Mint Halo" before Holographic existed stays listed under a free name.
|
||||
#[test]
|
||||
fn a_saved_preset_named_like_a_holographic_glow_gets_a_free_name() {
|
||||
let (mut s, id) = session_with(json!({"gradient": {"kind": "radial"}}));
|
||||
let halo = s.gradient_preset("Mint Halo").unwrap().gradient;
|
||||
let mut own = paint(&s, id, false).gradient;
|
||||
own.dither = true;
|
||||
let mut prefs = s.prefs.clone();
|
||||
prefs.gradient_presets = vec![crate::cmd::GradientPreset { name: "MINT HALO".into(), gradient: own.clone() }];
|
||||
s.apply_prefs(prefs);
|
||||
assert_eq!(s.prefs.gradient_presets.iter().map(|p| p.name.as_str()).collect::<Vec<_>>(), ["MINT HALO 2"]);
|
||||
s.execute("gradient.presets.apply", &json!({"name": "mint halo 2"})).unwrap();
|
||||
assert_eq!(paint(&s, id, false).gradient, own);
|
||||
s.execute("gradient.presets.apply", &json!({"name": "Mint Halo"})).unwrap();
|
||||
assert_eq!(paint(&s, id, false).gradient.stops, halo.stops);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_preset_applies_to_the_stroke_and_to_a_solid_paint() {
|
||||
let (mut s, id) = session_with(json!({"color": "#336699"}));
|
||||
|
||||
@@ -94,10 +94,49 @@ fn run_fresh(
|
||||
params: &serde_json::Value,
|
||||
) -> (std::result::Result<serde_json::Value, String>, Option<std::sync::Arc<vectorcraft_doc::Document>>) {
|
||||
let (mut s, ..) = doc_with_type();
|
||||
let r = s.execute(cmd, params).map_err(|e| e.to_string());
|
||||
let r = s.execute(cmd, params).map(|v| without_plugin_effects(cmd, v)).map_err(|e| e.to_string());
|
||||
(r, s.doc().ok().map(|d| d.doc.clone()))
|
||||
}
|
||||
|
||||
/// `cmd`'s result with the plug-in effects (`plugin.<id>`) taken out of `effect.list`'s catalog.
|
||||
/// The plug-in tests install and remove plug-ins in the process-wide registry while these
|
||||
/// comparisons run, so two runs of `effect.list` can list different plug-ins.
|
||||
fn without_plugin_effects(cmd: &str, mut r: serde_json::Value) -> serde_json::Value {
|
||||
if cmd == "effect.list"
|
||||
&& let Some(catalog) = r.get_mut("catalog").and_then(serde_json::Value::as_array_mut)
|
||||
{
|
||||
catalog.retain(|e| !e["id"].as_str().is_some_and(|id| id.starts_with(vectorcraft_plugins::PREFIX)));
|
||||
}
|
||||
r
|
||||
}
|
||||
|
||||
/// Whether two results of `cmd` are the same, apart from the plug-in effects in `effect.list`'s
|
||||
/// catalog ([`without_plugin_effects`]).
|
||||
fn same_without_plugin_effects(cmd: &str, x: &serde_json::Value, y: &serde_json::Value) -> bool {
|
||||
if cmd == "effect.list" { without_plugin_effects(cmd, x.clone()) == without_plugin_effects(cmd, y.clone()) } else { x == y }
|
||||
}
|
||||
|
||||
/// Two `effect.list` results that differ only in a plug-in effect in the catalog compare the same;
|
||||
/// a difference in a built-in effect, in `applied` or in `activeItem`, or in another command's
|
||||
/// result, does not.
|
||||
#[test]
|
||||
fn plugin_effects_are_left_out_of_the_effect_list_comparison() {
|
||||
let list = |catalog: &[&str], applied: serde_json::Value, active: serde_json::Value| {
|
||||
let catalog: Vec<_> = catalog.iter().map(|id| json!({"id": id, "label": id})).collect();
|
||||
json!({"catalog": catalog, "applied": applied, "activeItem": active})
|
||||
};
|
||||
let base = list(&["stylize.dropShadow"], json!([]), json!(null));
|
||||
let with_plugin = list(&["stylize.dropShadow", "plugin.test.glow"], json!([]), json!(null));
|
||||
assert!(same_without_plugin_effects("effect.list", &base, &with_plugin));
|
||||
assert!(same_without_plugin_effects("effect.list", &with_plugin, &base));
|
||||
assert_eq!(without_plugin_effects("effect.list", with_plugin.clone()), base);
|
||||
assert!(!same_without_plugin_effects("effect.list", &base, &list(&[], json!([]), json!(null))), "a built-in effect");
|
||||
assert!(!same_without_plugin_effects("effect.list", &base, &list(&["stylize.dropShadow"], json!([{"id": 3}]), json!(null))), "applied");
|
||||
assert!(!same_without_plugin_effects("effect.list", &base, &list(&["stylize.dropShadow"], json!([]), json!(0))), "activeItem");
|
||||
assert!(!same_without_plugin_effects("object.transform", &base, &with_plugin), "another command");
|
||||
assert_eq!(without_plugin_effects("object.transform", with_plugin.clone()), with_plugin);
|
||||
}
|
||||
|
||||
/// Every command whose params description names both `id` and `ids` (`{ids?|id?}`, `{id?, ids?:
|
||||
/// … (instead of id)}`), with nothing selected: `id` does what `ids` of that one object does (the
|
||||
/// same result or the same error, and the same document), for objects of the document and for an
|
||||
@@ -265,7 +304,7 @@ fn ids_and_selection(cmd: &str, picks: &[usize]) -> std::result::Result<bool, St
|
||||
with_ids["ids"] = json!(list);
|
||||
let (a, b) = (given.execute(cmd, &with_ids), selected.execute(cmd, ¶ms));
|
||||
let same_result = match (&a, &b) {
|
||||
(Ok(x), Ok(y)) => x == y,
|
||||
(Ok(x), Ok(y)) => same_without_plugin_effects(cmd, x, y),
|
||||
(Err(x), Err(y)) => x.to_string() == y.to_string(),
|
||||
_ => false,
|
||||
};
|
||||
|
||||
@@ -424,6 +424,93 @@ fn blend_replace_spine_follows_path() {
|
||||
assert!(first.distance(Point::new(100.0, 300.0)) < 1.0, "{first:?}");
|
||||
}
|
||||
|
||||
/// #6809: after Replace Spine, moving a key object moves the drawn key and its end of the spine,
|
||||
/// not only the key's selection outline.
|
||||
#[test]
|
||||
fn moving_a_key_of_a_replaced_spine_blend_moves_what_is_drawn() {
|
||||
let mut s = session();
|
||||
let (a, _, g) = blend(&mut s, json!({"steps": 5}));
|
||||
let arc = id_of(&s.execute("path.create", &json!({"d": "M100 300 C100 245 145 200 200 200 C255 200 300 245 300 300"})).unwrap());
|
||||
sel(&mut s, &[g, arc]);
|
||||
s.execute("object.blend.replaceSpine", &json!({})).unwrap();
|
||||
let center = |n: &Node| n.geometric_bounds().unwrap().center();
|
||||
let before = steps_of(&s, g);
|
||||
assert!(center(&before[0]).distance(Point::new(100.0, 300.0)) < 1e-6);
|
||||
// Direct Selection picks the key inside the blend; the drag moves it.
|
||||
sel(&mut s, &[a]);
|
||||
s.execute("object.move", &json!({"dx": -50, "dy": 40})).unwrap();
|
||||
let key = center(&node(&s, a));
|
||||
assert!(key.distance(Point::new(50.0, 340.0)) < 1e-6, "{key:?}");
|
||||
let after = steps_of(&s, g);
|
||||
assert_eq!(after.len(), before.len());
|
||||
let drawn = center(&after[0]);
|
||||
assert!(drawn.distance(key) < 1e-6, "the key is drawn where it was moved to: {drawn:?}, outline at {key:?}");
|
||||
assert!(center(&after[1]).distance(center(&before[1])) > 1.0, "the first step follows the moved key");
|
||||
let last = center(&after[after.len() - 1]);
|
||||
assert!(last.distance(Point::new(300.0, 300.0)) < 1e-6, "the other key stays put: {last:?}");
|
||||
// Undo puts the key back on the spine as Replace Spine left it.
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
let back = steps_of(&s, g);
|
||||
assert!(center(&back[0]).distance(Point::new(100.0, 300.0)) < 1e-6);
|
||||
assert!(center(&back[1]).distance(center(&before[1])) < 1e-6);
|
||||
}
|
||||
|
||||
/// #6809 on a closed spine, where both end keys start on its first point: moving the first key
|
||||
/// moves its end of the spine without dragging the last key's end along.
|
||||
#[test]
|
||||
fn moving_the_first_key_of_a_closed_replaced_spine_blend_moves_what_is_drawn() {
|
||||
let mut s = session();
|
||||
let (a, _, g) = blend(&mut s, json!({"steps": 5}));
|
||||
let square = id_of(&s.execute("path.create", &json!({"d": "M100 100 L300 100 L300 300 L100 300 Z"})).unwrap());
|
||||
sel(&mut s, &[g, square]);
|
||||
s.execute("object.blend.replaceSpine", &json!({})).unwrap();
|
||||
let center = |n: &Node| n.geometric_bounds().unwrap().center();
|
||||
let before = steps_of(&s, g);
|
||||
assert!(center(&before[0]).distance(Point::new(100.0, 100.0)) < 1e-6);
|
||||
sel(&mut s, &[a]);
|
||||
s.execute("object.move", &json!({"dx": -50, "dy": -40})).unwrap();
|
||||
let key = center(&node(&s, a));
|
||||
assert!(key.distance(Point::new(50.0, 60.0)) < 1e-6, "{key:?}");
|
||||
let after = steps_of(&s, g);
|
||||
assert_eq!(after.len(), before.len());
|
||||
let drawn = center(&after[0]);
|
||||
assert!(drawn.distance(key) < 1e-6, "the key is drawn where it was moved to: {drawn:?}, outline at {key:?}");
|
||||
assert!(center(&after[1]).distance(center(&before[1])) > 1.0, "the first step follows the moved key");
|
||||
let last = center(&after[after.len() - 1]);
|
||||
assert!(last.distance(Point::new(100.0, 100.0)) < 1e-6, "the other key stays put: {last:?}");
|
||||
s.execute("edit.undo", &json!({})).unwrap();
|
||||
let back = steps_of(&s, g);
|
||||
assert!(center(&back[0]).distance(Point::new(100.0, 100.0)) < 1e-6);
|
||||
assert!(center(&back[1]).distance(center(&before[1])) < 1e-6);
|
||||
}
|
||||
|
||||
/// #6809 on a closed spine pinned by a spine edit: the end keys get points of their own, so
|
||||
/// moving the first key afterwards still moves only its end.
|
||||
#[test]
|
||||
fn moving_the_first_key_of_a_pinned_closed_spine_blend_moves_what_is_drawn() {
|
||||
let mut s = session();
|
||||
let (a, _, g) = blend(&mut s, json!({"steps": 5}));
|
||||
let square = id_of(&s.execute("path.create", &json!({"d": "M100 100 L300 100 L300 300 L100 300 Z"})).unwrap());
|
||||
sel(&mut s, &[g, square]);
|
||||
s.execute("object.blend.replaceSpine", &json!({})).unwrap();
|
||||
// Dragging a corner away from the keys pins the spine to them.
|
||||
s.execute("object.blend.spine.moveAnchor", &json!({"id": g.0, "anchor": 2, "x": 320, "y": 320})).unwrap();
|
||||
let NodeKind::Blend { spec, .. } = node(&s, g).kind else { panic!() };
|
||||
assert_eq!(spec.key_anchors.len(), 2, "{:?}", spec.key_anchors);
|
||||
let center = |n: &Node| n.geometric_bounds().unwrap().center();
|
||||
let before = steps_of(&s, g);
|
||||
sel(&mut s, &[a]);
|
||||
s.execute("object.move", &json!({"dx": -50, "dy": -40})).unwrap();
|
||||
let key = center(&node(&s, a));
|
||||
assert!(key.distance(Point::new(50.0, 60.0)) < 1e-6, "{key:?}");
|
||||
let after = steps_of(&s, g);
|
||||
assert_eq!(after.len(), before.len());
|
||||
let drawn = center(&after[0]);
|
||||
assert!(drawn.distance(key) < 1e-6, "the key is drawn where it was moved to: {drawn:?}, outline at {key:?}");
|
||||
let last = center(&after[after.len() - 1]);
|
||||
assert!(last.distance(Point::new(100.0, 100.0)) < 1e-6, "the other key stays put: {last:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn blend_align_to_path_rotates_steps() {
|
||||
let mut s = session();
|
||||
|
||||
@@ -400,6 +400,90 @@ fn stroke_set_refuses_an_unknown_key() {
|
||||
}
|
||||
}
|
||||
|
||||
/// An object id given as something other than a whole number (`"5"`, `-1`) is refused as such,
|
||||
/// naming its key, not as a missing id; an id left out is still a missing one.
|
||||
#[test]
|
||||
fn a_malformed_object_id_is_not_reported_as_missing() {
|
||||
let mut s = Session::new();
|
||||
s.execute("file.new", &json!({})).unwrap();
|
||||
s.execute("shape.rectangle", &json!({"x": 10, "y": 10, "width": 50, "height": 40})).unwrap();
|
||||
let undo = |s: &Session| s.doc().unwrap().history.undo.len();
|
||||
let before = undo(&s);
|
||||
let points = json!([[0, 0], [10, 10], [20, 0]]);
|
||||
for bad in [json!("5"), json!(-1)] {
|
||||
let id = || json!({ "id": bad });
|
||||
let with = |extra: serde_json::Value| {
|
||||
let mut p = id();
|
||||
p.as_object_mut().unwrap().extend(extra.as_object().unwrap().clone());
|
||||
p
|
||||
};
|
||||
for (cmd, p, key) in [
|
||||
("stroke.widthPoint.set", id(), "id"),
|
||||
("stroke.widthPoint.copy", id(), "id"),
|
||||
("stroke.widthPoint.remove", id(), "id"),
|
||||
("path.curvatureEdit", id(), "id"),
|
||||
("path.removeAnchor", id(), "id"),
|
||||
("path.convertAnchor", id(), "id"),
|
||||
("path.reshapeSegment", id(), "id"),
|
||||
("path.split", id(), "id"),
|
||||
("path.appendAnchor", id(), "id"),
|
||||
("path.close", id(), "id"),
|
||||
("path.setHandle", id(), "id"),
|
||||
("path.moveAnchor", id(), "id"),
|
||||
("path.setAnchors", id(), "id"),
|
||||
("path.reshape", id(), "id"),
|
||||
("path.insertAnchor", id(), "id"),
|
||||
("path.freehand", json!({"points": points, "extend": {"id": bad}}), "id"),
|
||||
("path.freehand", json!({"points": points, "redraw": {"id": bad}}), "id"),
|
||||
("document.node", id(), "id"),
|
||||
("layer.target", id(), "id"),
|
||||
("layer.setCurrent", id(), "id"),
|
||||
("layer.selectAll", id(), "id"),
|
||||
("layer.move", with(json!({"target": 1})), "id"),
|
||||
("layer.move", json!({"ids": [1], "target": bad}), "target"),
|
||||
("node.move", id(), "id"),
|
||||
("node.move", json!({"id": 1, "parent": bad}), "parent"),
|
||||
("text.reshapeArea", with(json!({"anchors": []})), "id"),
|
||||
("text.reshapeArea", json!({"items": [{"id": bad, "anchors": []}]}), "id"),
|
||||
("text.reshapePath", id(), "id"),
|
||||
("text.setPathHandle", id(), "id"),
|
||||
("text.editRange", id(), "id"),
|
||||
("text.startList", id(), "id"),
|
||||
("text.getRange", id(), "id"),
|
||||
("text.setGlyphAlternate", id(), "id"),
|
||||
("text.glyphAlternates", id(), "id"),
|
||||
("text.touchType", id(), "id"),
|
||||
("text.discardEmpty", id(), "id"),
|
||||
("text.createInPath", json!({"path": bad}), "path"),
|
||||
("object.envelope.setMeshPoint", id(), "id"),
|
||||
("object.mesh.setPointColor", with(json!({"index": 0})), "id"),
|
||||
("object.mesh.movePoint", with(json!({"index": 0, "x": 0, "y": 0})), "id"),
|
||||
("object.mesh.movePoints", json!({"items": [{"id": bad, "index": 0}]}), "id"),
|
||||
("object.mesh.addLine", with(json!({"x": 0, "y": 0})), "id"),
|
||||
("object.mesh.deletePoint", with(json!({"index": 0})), "id"),
|
||||
("object.slice.setRect", id(), "id"),
|
||||
("appearance.transfer", json!({"source": bad, "target": 1}), "source"),
|
||||
("appearance.transfer", json!({"source": 1, "target": bad}), "target"),
|
||||
("appearance.copyFrom", json!({"source": bad}), "source"),
|
||||
("livePaint.strokeEdge", json!({"point": [0, 0], "group": bad}), "group"),
|
||||
("livePaint.fill", json!({"point": [0, 0], "group": bad}), "group"),
|
||||
("livePaint.info", json!({"group": bad}), "group"),
|
||||
("livePaint.info", id(), "id"),
|
||||
("select.magicWand", id(), "id"),
|
||||
] {
|
||||
let e = s.execute(cmd, &p).unwrap_err().to_string();
|
||||
// `layer.move` checks an `id` that stands in for `ids` before it runs.
|
||||
let named = e.contains(&format!("`{key}` must be a whole number")) || (cmd == "layer.move" && e.contains("invalid object id"));
|
||||
assert!(named, "{cmd} {p}: {e}");
|
||||
}
|
||||
}
|
||||
for cmd in ["path.close", "layer.target", "text.reshapePath", "object.mesh.movePoint", "select.magicWand"] {
|
||||
let e = s.execute(cmd, &json!({})).unwrap_err().to_string();
|
||||
assert!(e.contains("missing"), "{cmd}: {e}");
|
||||
}
|
||||
assert_eq!(undo(&s), before);
|
||||
}
|
||||
|
||||
/// A command that takes the keys of one that isn't checked yet isn't checked either.
|
||||
#[test]
|
||||
fn a_reference_to_an_unchecked_command_is_unchecked() {
|
||||
|
||||
@@ -1057,6 +1057,142 @@ fn a_copy_left_behind_is_not_offered_by_its_own_app() {
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
/// A copy left in an area the session had to leave is not another app's to offer, restore or
|
||||
/// discard while the session runs, even after the app that locked that area let it go: an entry in
|
||||
/// the session's new area says it keeps it. Once the copy is written again in the new area, the
|
||||
/// entry goes; after a crash before that, the copy is offered.
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn a_copy_left_behind_is_not_offered_by_another_app_while_its_app_runs() {
|
||||
use cmd::recovery::Lock;
|
||||
let dir = std::env::temp_dir().join(format!("vc-recovery-leftother-{}", std::process::id()));
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
let left_behind = |area: &str| dir.join(area).join("Untitled-1-1.vectorcraft");
|
||||
let leave = |a: &mut Session, area: &str| {
|
||||
std::fs::remove_file(dir.join(area).join(".lock")).unwrap();
|
||||
let Ok(Lock::Held(other)) = FolderStore::new(&dir).lock(area) else { panic!("the other app locks the area") };
|
||||
cmd::recovery::heartbeat(a);
|
||||
drop(other);
|
||||
a.recovery.own_area().unwrap().to_string()
|
||||
};
|
||||
let (mut a, area) = saved_in(&dir);
|
||||
let mine = leave(&mut a, &area);
|
||||
assert_ne!(mine, area);
|
||||
assert!(dir.join(&mine).join(format!("keeps-{area}")).is_file());
|
||||
// Removed meanwhile: the next heartbeat writes it again.
|
||||
std::fs::remove_file(dir.join(&mine).join(format!("keeps-{area}"))).unwrap();
|
||||
cmd::recovery::heartbeat(&mut a);
|
||||
assert!(dir.join(&mine).join(format!("keeps-{area}")).is_file());
|
||||
let mut b = other_app(&dir);
|
||||
assert!(offered(&mut b).is_empty());
|
||||
assert_eq!(restored(b.execute("file.recovery.restore", &json!({})).unwrap()), 0);
|
||||
assert!(b.execute("file.recovery.discard", &json!({})).unwrap()["discarded"].as_array().unwrap().is_empty());
|
||||
assert!(b.execute("file.recovery.discard", &json!({"file": format!("{area}/Untitled-1-1")})).is_err());
|
||||
assert!(left_behind(&area).is_file());
|
||||
// Written again in the new area: the copy left behind and the entry go.
|
||||
a.execute("file.recovery.save", &json!({})).unwrap();
|
||||
assert!(!left_behind(&area).exists());
|
||||
assert!(!dir.join(&mine).join(format!("keeps-{area}")).exists());
|
||||
assert!(offered(&mut b).is_empty());
|
||||
drop(a);
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
// A crash before the copy is written again: the copy left behind is offered.
|
||||
let (mut a, area) = saved_in(&dir);
|
||||
leave(&mut a, &area);
|
||||
drop(a);
|
||||
assert_eq!(offered(&mut other_app(&dir)).len(), 1);
|
||||
assert!(left_behind(&area).is_file());
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
/// A store in memory whose areas named `foreign-…` can't be locked by this account (as another
|
||||
/// account's folder in a shared recovery folder).
|
||||
#[derive(Default)]
|
||||
struct ForeignAreas(MemoryStore);
|
||||
|
||||
impl RecoveryStore for ForeignAreas {
|
||||
fn list(&self) -> std::result::Result<Vec<String>, String> {
|
||||
self.0.list()
|
||||
}
|
||||
fn read(&self, name: &str) -> std::result::Result<Vec<u8>, String> {
|
||||
self.0.read(name)
|
||||
}
|
||||
fn write(&self, name: &str, bytes: &[u8]) -> std::result::Result<(), String> {
|
||||
self.0.write(name, bytes)
|
||||
}
|
||||
fn remove(&self, name: &str) -> std::result::Result<(), String> {
|
||||
self.0.remove(name)
|
||||
}
|
||||
fn location(&self) -> String {
|
||||
self.0.location()
|
||||
}
|
||||
fn lock(&self, area: &str) -> std::result::Result<cmd::recovery::Lock, String> {
|
||||
if area.starts_with("foreign-") {
|
||||
return Err(format!("{area}: belongs to another account"));
|
||||
}
|
||||
self.0.lock(area)
|
||||
}
|
||||
fn now(&self) -> Option<i64> {
|
||||
self.0.now()
|
||||
}
|
||||
}
|
||||
|
||||
/// An entry `<area>/keeps-<left area>` in an area this account can't lock keeps nothing: a crashed
|
||||
/// app's copies in the left area are still offered.
|
||||
#[test]
|
||||
fn a_keeps_entry_in_an_area_that_cannot_be_locked_keeps_nothing() {
|
||||
let store = Arc::new(ForeignAreas::default());
|
||||
let app = || {
|
||||
let mut s = Session::new();
|
||||
s.recovery.set_store(store.clone());
|
||||
s
|
||||
};
|
||||
let mut a = app();
|
||||
a.execute("file.new", &json!({"width": 50, "height": 50})).unwrap();
|
||||
a.execute("shape.rectangle", &json!({"x": 0, "y": 0, "width": 5, "height": 5})).unwrap();
|
||||
a.execute("file.recovery.save", &json!({})).unwrap();
|
||||
let area = a.recovery.own_area().unwrap().to_string();
|
||||
drop(a);
|
||||
store.write(&format!("foreign-1/keeps-{area}"), b"").unwrap();
|
||||
let mut b = app();
|
||||
assert_eq!(offered(&mut b).len(), 1);
|
||||
assert_eq!(restored(b.execute("file.recovery.restore", &json!({})).unwrap()), 1);
|
||||
}
|
||||
|
||||
/// An entry `<area>/keeps-<left area>` in a running app's area keeps a crashed app's copies in the
|
||||
/// left area until that app is gone too.
|
||||
#[test]
|
||||
fn a_keeps_entry_in_a_running_apps_area_keeps_the_copies() {
|
||||
let store = Arc::new(MemoryStore::default());
|
||||
let mut a = session_in(&store);
|
||||
a.execute("file.recovery.save", &json!({})).unwrap();
|
||||
let area = a.recovery.own_area().unwrap().to_string();
|
||||
drop(a);
|
||||
let mut c = session_in(&store);
|
||||
c.execute("file.recovery.save", &json!({})).unwrap();
|
||||
let keeper = c.recovery.own_area().unwrap().to_string();
|
||||
store.write(&format!("{keeper}/keeps-{area}"), b"").unwrap();
|
||||
let mut b = relaunch(&store);
|
||||
assert!(offered(&mut b).is_empty());
|
||||
assert_eq!(restored(b.execute("file.recovery.restore", &json!({})).unwrap()), 0);
|
||||
drop(c);
|
||||
assert_eq!(offered(&mut b).len(), 2);
|
||||
}
|
||||
|
||||
/// An entry `<area>/keeps-<left area>` in a folder whose lock file can't be opened keeps nothing.
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn a_keeps_entry_in_a_folder_whose_lock_cannot_be_checked_keeps_nothing() {
|
||||
let dir = std::env::temp_dir().join(format!("vc-recovery-keepsunlocked-{}", std::process::id()));
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
let (a, area) = saved_in(&dir);
|
||||
drop(a);
|
||||
std::fs::create_dir_all(dir.join("keeper").join(".lock")).unwrap();
|
||||
std::fs::write(dir.join("keeper").join(format!("keeps-{area}")), b"").unwrap();
|
||||
assert_eq!(offered(&mut other_app(&dir)).len(), 1);
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
/// A complex document (Data Recovery off for those) gets no new copy after the session left its
|
||||
/// area: it keeps the copy it left there, and the heartbeat asks for it only once.
|
||||
#[cfg(unix)]
|
||||
|
||||
@@ -6,7 +6,7 @@ use std::sync::Arc;
|
||||
|
||||
use serde_json::{Value, json};
|
||||
|
||||
use crate::script::{PANIC_IN_SLICE, TEST_ENGINE_HEAP, engines_on_this_thread, releases_kept_for};
|
||||
use crate::script::{PANIC_IN_SLICE, TEST_ENGINE_HEAP, TEST_KEPT_MAP_BYTES, engines_on_this_thread, releases_kept_for};
|
||||
use crate::*;
|
||||
|
||||
fn run(s: &mut Session, source: &str) -> Result<Value> {
|
||||
@@ -119,11 +119,115 @@ fn only_the_script_itself_names_its_engine() {
|
||||
assert_eq!(report["line"], 2, "{report}");
|
||||
assert_eq!(names(&mut s), ["e"]);
|
||||
let _ = std::fs::remove_dir_all(base);
|
||||
// An error in a function an earlier run defined has no place in the run that calls it.
|
||||
// An error in a function an earlier run defined is at that run's line; a script given as text
|
||||
// is named by its run's name.
|
||||
run(&mut s, "#targetengine e\n\n\n\nfunction bad() { throw new Error('kept'); }").unwrap();
|
||||
assert!(run(&mut s, "#targetengine e\nbad();").is_err());
|
||||
let e = run(&mut s, "#targetengine e\nbad();").unwrap_err().to_string();
|
||||
let report = s.script_report().unwrap().clone();
|
||||
assert!(report["line"].as_u64().is_none_or(|l| l == 0), "{report}");
|
||||
assert_eq!((report["name"].as_str(), report["file"].as_str(), report["line"].as_u64()), (Some("t.js"), Some("t.js"), Some(5)), "{report}");
|
||||
let column = report["column"].as_u64().unwrap();
|
||||
assert_eq!(error_lines(&report), [format!("t.js: t.js:5:{column}: Error: kept")]);
|
||||
assert!(e.contains(&format!("line 5, column {column} of t.js")), "{e}");
|
||||
}
|
||||
|
||||
/// The console error lines of a run's report.
|
||||
fn error_lines(report: &Value) -> Vec<String> {
|
||||
let lines = report["console"]["lines"].as_array().unwrap();
|
||||
lines.iter().filter_map(Value::as_str).filter(|l| l.contains("Error: ")).map(str::to_string).collect()
|
||||
}
|
||||
|
||||
/// The file, line and column of the last run's error.
|
||||
fn place(s: &Session) -> (Option<String>, u64, u64) {
|
||||
let r = s.script_report().unwrap();
|
||||
(r["file"].as_str().map(str::to_string), r["line"].as_u64().unwrap(), r["column"].as_u64().unwrap())
|
||||
}
|
||||
|
||||
/// An error in code an earlier run of a named engine compiled is at the place of that code: in that
|
||||
/// run's script, a file it included or a file `$.evalFile` gave, while the report and the console
|
||||
/// line keep the calling run's name.
|
||||
#[test]
|
||||
fn an_error_in_code_an_earlier_run_kept_is_at_that_runs_file_and_line() {
|
||||
let base: PathBuf = std::env::temp_dir().join(format!("vc-script-engines-places-{}", std::process::id()));
|
||||
let _ = std::fs::remove_dir_all(&base);
|
||||
std::fs::create_dir_all(&base).unwrap();
|
||||
std::fs::write(base.join("inc.jsxinc"), "\nfunction fromInclude() { throw new Error('inc'); }").unwrap();
|
||||
std::fs::write(base.join("ev.jsxinc"), "\n\n\nfunction fromEval() { throw new Error('ev'); }").unwrap();
|
||||
let def = base.join("def.jsx");
|
||||
let text = "#targetengine e\n#include \"inc.jsxinc\"\n$.evalFile('ev.jsxinc');\nfunction fromMain() {\n throw new Error('main');\n}\n\
|
||||
function spin() {\n while (true) {}\n}\nfunction badEval() {\n eval('var = 1');\n}";
|
||||
std::fs::write(&def, text).unwrap();
|
||||
let mut s = Session::new();
|
||||
s.execute("script.run", &json!({"path": def.to_string_lossy()})).unwrap();
|
||||
let call = |s: &mut Session, code: &str| {
|
||||
let e = s.execute("script.run", &json!({"source": format!("#targetengine e\n\n{code}"), "name": "caller.js"}));
|
||||
assert!(e.is_err(), "{code}");
|
||||
};
|
||||
let shown = def.to_string_lossy().to_string();
|
||||
let ends = |p: &(Option<String>, u64, u64), file: &str, line: u64| p.0.as_deref().is_some_and(|f| f.ends_with(file)) && p.1 == line && p.2 > 0;
|
||||
call(&mut s, "fromMain();");
|
||||
let p = place(&s);
|
||||
assert!(ends(&p, "def.jsx", 5), "{p:?}");
|
||||
let report = s.script_report().unwrap().clone();
|
||||
assert_eq!(report["name"], "caller.js");
|
||||
assert_eq!(error_lines(&report), [format!("caller.js: {}:5:{}: Error: main", p.0.as_deref().unwrap(), p.2)]);
|
||||
call(&mut s, "fromInclude();");
|
||||
assert!(ends(&place(&s), "inc.jsxinc", 2), "{:?}", place(&s));
|
||||
call(&mut s, "fromEval();");
|
||||
assert!(ends(&place(&s), "ev.jsxinc", 4), "{:?}", place(&s));
|
||||
call(&mut s, "badEval();");
|
||||
assert!(ends(&place(&s), "def.jsx", 11), "a syntax error eval raises is at its call: {:?}", place(&s));
|
||||
let e = s.execute("script.run", &json!({"source": "#targetengine e\nspin();", "name": "caller.js", "maxFuel": 100_000}));
|
||||
assert!(e.is_err());
|
||||
assert_eq!(s.script_report().unwrap()["kind"], "limit");
|
||||
assert!(ends(&place(&s), "def.jsx", 8), "the fuel ran out in spin: {:?}", place(&s));
|
||||
// A caught error thrown again is where that throw is, in the calling run.
|
||||
call(&mut s, "try { fromMain(); } catch (x) {\n throw x;\n}");
|
||||
assert_eq!(place(&s), (None, 4, 3));
|
||||
// A run that fails before it starts compiles nothing, and the kept places stay.
|
||||
assert!(run(&mut s, "#targetengine e\n#include \"missing.jsxinc\"").is_err());
|
||||
call(&mut s, "fromMain();");
|
||||
assert!(ends(&place(&s), "def.jsx", 5), "{:?}", place(&s));
|
||||
assert!(place(&s).0.is_some_and(|f| f == shown));
|
||||
// A dropped engine takes its places with it: the new one has its own.
|
||||
s.execute("script.engine.drop", &json!({"name": "e"})).unwrap();
|
||||
run(&mut s, "#targetengine e\nfunction fromMain() { throw new Error('new'); }").unwrap();
|
||||
call(&mut s, "fromMain();");
|
||||
assert_eq!(place(&s).0.as_deref(), Some("t.js"));
|
||||
assert_eq!(place(&s).1, 2);
|
||||
// The name stands for the earlier script as that run's report gave it, not as console lines
|
||||
// show it.
|
||||
s.execute("script.run", &json!({"source": "#targetengine e\nfunction named() { throw 1; }", "name": "a\u{1}b.js"})).unwrap();
|
||||
call(&mut s, "named();");
|
||||
assert_eq!(place(&s).0.as_deref(), Some("a\u{1}b.js"));
|
||||
let _ = std::fs::remove_dir_all(base);
|
||||
}
|
||||
|
||||
/// A named engine keeps the places of its earlier runs' code within its budget, the oldest going
|
||||
/// first, and the code still runs once its place is gone.
|
||||
#[test]
|
||||
fn an_engine_keeps_the_newest_places_within_its_budget() {
|
||||
let mut s = Session::new();
|
||||
run(&mut s, "#targetengine e\nfunction a() { throw new Error('a'); }").unwrap();
|
||||
TEST_KEPT_MAP_BYTES.with(|b| b.set(Some(300)));
|
||||
run(&mut s, "#targetengine e\n\nfunction b() { throw new Error('b'); }").unwrap();
|
||||
for _ in 0..20 {
|
||||
run(&mut s, "#targetengine e\nvar x = 1;").unwrap();
|
||||
}
|
||||
run(&mut s, "#targetengine e\n\n\nfunction c() { throw new Error('c'); }").unwrap();
|
||||
// Each run's own map takes the room of the one before, so c is called first.
|
||||
assert!(run(&mut s, "#targetengine e\nc();").is_err());
|
||||
let c_place = place(&s);
|
||||
let a = run(&mut s, "#targetengine e\na();").map(drop);
|
||||
let a_place = place(&s);
|
||||
TEST_KEPT_MAP_BYTES.with(|b| b.set(Some(1)));
|
||||
run(&mut s, "#targetengine e\n\n\n\nfunction d() { throw new Error('d'); }").unwrap();
|
||||
assert!(run(&mut s, "#targetengine e\nd();").is_err());
|
||||
let d_place = place(&s);
|
||||
TEST_KEPT_MAP_BYTES.with(|b| b.set(None));
|
||||
assert!(a.is_err());
|
||||
assert_eq!((a_place.0, a_place.1, a_place.2), (None, 0, 0), "a's place went to make room");
|
||||
assert_eq!((c_place.0.as_deref(), c_place.1), (Some("t.js"), 4));
|
||||
assert_eq!((d_place.0, d_place.1, d_place.2), (None, 0, 0), "a map larger than the budget is not kept");
|
||||
}
|
||||
|
||||
/// A `$.evalFile` an earlier run kept reads files the way the run that calls it does: relative to
|
||||
|
||||
@@ -671,6 +671,44 @@ fn organic_fades_add_with_their_method_midpoints_and_opacities_in_rgb_and_cmyk()
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn holographic_glows_add_whole_in_rgb_and_cmyk_as_one_undo_step() {
|
||||
let lib = vectorcraft_color::libraries::builtin_library("holographic").unwrap();
|
||||
let Paint::Gradient(want) = &lib.swatch("Mint Halo").unwrap().paint else { panic!("Mint Halo is a gradient") };
|
||||
for mode in ["rgb", "cmyk"] {
|
||||
let mut s = Session::new();
|
||||
run(&mut s, "file.new", json!({"width": 100, "height": 100, "colorMode": mode}));
|
||||
let list = run(&mut s, "swatch.library.list", json!({}));
|
||||
let row = list["libraries"].as_array().unwrap().iter().find(|l| l["id"] == "holographic").unwrap().clone();
|
||||
assert_eq!((row["name"].as_str(), row["category"].as_str(), row["count"].as_u64()), (Some("Holographic"), Some("gradients"), Some(14)));
|
||||
let got = run(&mut s, "swatch.library.get", json!({"library": "holographic"}));
|
||||
assert!(got.to_string().contains("Mint Halo"), "{mode}: get lists Mint Halo");
|
||||
let id = run(&mut s, "shape.rectangle", json!({"x": 0, "y": 0, "width": 50, "height": 50}))["id"].clone();
|
||||
let node = vectorcraft_doc::NodeId(id.as_u64().unwrap());
|
||||
let before = undo_len(&s);
|
||||
let r = run(&mut s, "swatch.library.add", json!({"library": "holographic", "names": ["Mint Halo"], "apply": "fill"}));
|
||||
assert_eq!((r["added"].clone(), r["applied"].clone()), (json!(["Mint Halo"]), json!("Mint Halo")), "{mode}");
|
||||
assert_eq!(undo_len(&s), before + 1, "{mode}: added and applied as one step");
|
||||
// The swatch comes as the library has it: kind, stops (RGB colors, opacities, midpoints) and method.
|
||||
let Paint::Gradient(added) = &doc(&s).swatch("Mint Halo").unwrap().paint else { panic!("{mode}: a gradient swatch") };
|
||||
assert_eq!(added.gradient, want.gradient, "{mode}");
|
||||
assert!(added.gradient.stops.iter().all(|st| matches!(st.color, Color::Rgb { .. })), "{mode}: the stops stay RGB");
|
||||
assert_eq!(added.gradient.stops.last().map(|st| st.opacity), Some(0.0), "{mode}: clear at the edge");
|
||||
let Paint::Gradient(fill) = doc(&s).node(node).unwrap().appearance.fill_paint() else { panic!("{mode}: a gradient fill") };
|
||||
assert_eq!((fill.gradient.kind, fill.gradient.method), (want.gradient.kind, want.gradient.method), "{mode}");
|
||||
assert_eq!(fill.gradient.stops, want.gradient.stops, "{mode}");
|
||||
run(&mut s, "edit.undo", json!({}));
|
||||
assert!(doc(&s).swatch("Mint Halo").is_none(), "{mode}: undo removes the add");
|
||||
assert!(!matches!(doc(&s).node(node).unwrap().appearance.fill_paint(), Paint::Gradient(_)), "{mode}: and the fill");
|
||||
// A document swatch already named Mint Halo stays; the glow comes in under a number.
|
||||
run(&mut s, "swatch.new", json!({"name": "Mint Halo", "color": "#123456"}));
|
||||
let r = run(&mut s, "swatch.library.add", json!({"library": "holographic", "names": ["Mint Halo"]}));
|
||||
assert_eq!(r["added"], json!(["Mint Halo 2"]), "{mode}");
|
||||
assert!(doc(&s).swatch("Mint Halo").unwrap().paint.color().is_some(), "{mode}: the document's swatch is kept");
|
||||
assert!(matches!(&doc(&s).swatch("Mint Halo 2").unwrap().paint, Paint::Gradient(g) if g.gradient == want.gradient));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_libraries_bring_their_patterns_and_add_each_once() {
|
||||
let mut s = session();
|
||||
|
||||
@@ -475,6 +475,7 @@ fn type_commands_refuse_a_number_or_boolean_given_as_text() {
|
||||
("text.setFormat", json!({"ids": [id.0], "hyphenate": "false"}), "hyphenate"),
|
||||
("text.setFormat", json!({"ids": [id.0], "hyphenateCapitalized": 0}), "hyphenateCapitalized"),
|
||||
("text.setFormat", json!({"ids": [id.0], "romanHangingPunctuation": "true"}), "romanHangingPunctuation"),
|
||||
("text.setFormat", json!({"ids": [id.0], "koreanLineBreakAnywhere": 1}), "koreanLineBreakAnywhere"),
|
||||
("text.getRange", json!({"id": id.0, "effective": "true"}), "effective"),
|
||||
("type.opticalMarginAlignment", json!({"on": "true"}), "on"),
|
||||
("type.systemLayout", json!({"on": "true"}), "on"),
|
||||
@@ -2523,6 +2524,68 @@ fn converting_tracked_type_between_point_and_area_keeps_it_in_place() {
|
||||
}
|
||||
}
|
||||
|
||||
/// Horizontal and vertical type keep every line where it is when converted from point to area
|
||||
/// type and back, and from area to point type and back, however the lines are aligned. Vertical
|
||||
/// lines run down their columns, and each next column sits to the left of the one before it.
|
||||
#[test]
|
||||
fn converting_vertical_type_between_point_and_area_keeps_it_in_place() {
|
||||
for vertical in [false, true] {
|
||||
for j in ["left", "center", "right"] {
|
||||
for text in ["Wave", "Wave\nWaves"] {
|
||||
let mut s = session();
|
||||
let r = s.execute("text.create", &json!({"x": 300, "y": 40, "text": text, "size": 12, "vertical": vertical})).unwrap();
|
||||
let id = NodeId(r["id"].as_u64().unwrap());
|
||||
s.execute("text.setStyle", &json!({"ids": [id.0], "justify": j})).unwrap();
|
||||
let before = line_starts_doc(&obj(&s, id));
|
||||
assert_eq!(before.len(), text.lines().count());
|
||||
if vertical && before.len() > 1 {
|
||||
assert!(before[1].x < before[0].x, "{j}: the second column is to the left: {before:?}");
|
||||
}
|
||||
for round in 0..2 {
|
||||
s.execute("type.convertToAreaType", &json!({"ids": [id.0]})).unwrap();
|
||||
let t = obj(&s, id);
|
||||
assert!(matches!(t.kind, TextKind::Area { .. }));
|
||||
let area = line_starts_doc(&t);
|
||||
assert_eq!(area.len(), before.len(), "vertical {vertical}, {j}, {text:?}: no rewrap");
|
||||
for (a, b) in area.iter().zip(&before) {
|
||||
assert!((*a - *b).hypot() < 0.01, "vertical {vertical}, {j}, {text:?}, round {round}, area: {before:?} → {area:?}");
|
||||
}
|
||||
s.execute("type.convertToPointType", &json!({"ids": [id.0]})).unwrap();
|
||||
let t = obj(&s, id);
|
||||
assert!(matches!(t.kind, TextKind::Point));
|
||||
let point = line_starts_doc(&t);
|
||||
for (a, b) in point.iter().zip(&before) {
|
||||
assert!((*a - *b).hypot() < 0.01, "vertical {vertical}, {j}, {text:?}, round {round}, point: {before:?} → {point:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
// Area type to point type and back.
|
||||
let mut s = session();
|
||||
let r = s
|
||||
.execute(
|
||||
"text.create",
|
||||
&json!({"x": 300, "y": 40, "text": "Wave\nWaves", "size": 12, "vertical": vertical, "area": {"width": 120, "height": 120}}),
|
||||
)
|
||||
.unwrap();
|
||||
let id = NodeId(r["id"].as_u64().unwrap());
|
||||
s.execute("text.setStyle", &json!({"ids": [id.0], "justify": j})).unwrap();
|
||||
let before = line_starts_doc(&obj(&s, id));
|
||||
assert_eq!(before.len(), 2);
|
||||
s.execute("type.convertToPointType", &json!({"ids": [id.0]})).unwrap();
|
||||
let point = line_starts_doc(&obj(&s, id));
|
||||
for (a, b) in point.iter().zip(&before) {
|
||||
assert!((*a - *b).hypot() < 0.01, "vertical {vertical}, {j}, from area, point: {before:?} → {point:?}");
|
||||
}
|
||||
s.execute("type.convertToAreaType", &json!({"ids": [id.0]})).unwrap();
|
||||
let area = line_starts_doc(&obj(&s, id));
|
||||
assert_eq!(area.len(), 2);
|
||||
for (a, b) in area.iter().zip(&before) {
|
||||
assert!((*a - *b).hypot() < 0.01, "vertical {vertical}, {j}, from area, area again: {before:?} → {area:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn convert_area_to_point_keeps_a_deeper_list_item_in_place() {
|
||||
let mut s = session();
|
||||
|
||||
@@ -809,6 +809,12 @@ fn structured_junk() {
|
||||
("addon.type.releasePath", json!({"mode": "text", "keepOriginal": false, "id": 2})),
|
||||
("addon.type.releasePath", json!({"mode": ["both"], "keepOriginal": "no", "ids": "all", "id": -1})),
|
||||
("addon.type.releasePath", json!({"mode": "nope", "keepOriginal": 1e308, "ids": [1.5, null, "x"]})),
|
||||
// Cutting Tools add-on: Stencil Bridges.
|
||||
("addon.cutting.bridges", json!({"width": 0.01, "count": 16, "direction": "shortest", "keepOriginal": true})),
|
||||
("addon.cutting.bridges", json!({"width": 1000, "count": 1, "direction": "horizontal", "keepOriginal": false})),
|
||||
("addon.cutting.bridges", json!({"width": "3 mm", "direction": "vertical"})),
|
||||
("addon.cutting.bridges", json!({"width": f64::MAX, "count": 1e308, "direction": ["vertical"], "keepOriginal": "no"})),
|
||||
("addon.cutting.bridges", json!({"width": -1, "count": -3, "direction": "diagonal", "keepOriginal": 1e308})),
|
||||
("addon.cleanup.breakText", json!({"by": "glyphs", "ids": [0, 1, 2, 3, 4, 5, 6, 7, 8, u64::MAX]})),
|
||||
("addon.cleanup.breakText", json!({"by": ["lines"]})),
|
||||
("addon.cleanup.breakText", json!({"by": "paragraphs"})),
|
||||
|
||||
@@ -3785,6 +3785,34 @@ fn an_unstroked_run_with_a_stroke_style_loses_nothing() {
|
||||
}
|
||||
}
|
||||
|
||||
/// The text document has no Korean Line Break Anywhere: a paragraph with it on and Hangul in it
|
||||
/// is reported as left out, and comes back off; with it off, or with no Hangul, nothing is
|
||||
/// reported.
|
||||
#[test]
|
||||
fn korean_line_break_anywhere_is_reported_only_for_korean_paragraphs() {
|
||||
use vectorcraft_doc::TextObject;
|
||||
for (text, on, reported) in [("가나다 라마", true, true), ("가나다 라마", false, false), ("Plain", true, false)] {
|
||||
let mut t = TextObject::point(vectorcraft_geom::Point::new(20.0, 40.0), text, style(14.0, Color::BLACK));
|
||||
t.para.korean_line_break_anywhere = on;
|
||||
let mut doc = Document::new(200.0, 200.0);
|
||||
let layer = doc.layers[0].id;
|
||||
let n = text_node(&mut doc, t);
|
||||
doc.insert(Some(layer), usize::MAX, n).unwrap();
|
||||
let out = export_ai_editing(&doc, &opts()).unwrap();
|
||||
assert_eq!(!out.warnings.is_empty(), reported, "{text} {on}: {:?}", out.warnings);
|
||||
let mut all = vec![];
|
||||
paths(&read_back(&doc).layers, &mut all);
|
||||
let paras: Vec<bool> = all
|
||||
.iter()
|
||||
.filter_map(|n| match &n.kind {
|
||||
NodeKind::Text(t) => Some(t.para_at(0).korean_line_break_anywhere),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
assert_eq!(paras, [false], "{text} {on}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn type_is_written_again_as_the_same_bytes() {
|
||||
let doc = typed();
|
||||
@@ -4366,6 +4394,19 @@ fn dynamic_text_is_written_at_its_drawn_sizes() {
|
||||
assert!(!texts[0].dynamic_text);
|
||||
let k = texts[0].xf.as_coeffs()[0];
|
||||
assert_eq!(r3(texts[0].runs[0].style.size * k), r3(drawn));
|
||||
// Type written as outlines (here on an open path whose ends meet) loses the setting too, and
|
||||
// says so.
|
||||
let mut doc = Document::new(600.0, 300.0);
|
||||
let layer = doc.layers[0].id;
|
||||
let mut t = TextObject::point(vectorcraft_geom::Point::ZERO, "Grow", style(12.0, Color::BLACK));
|
||||
let ends_meet = [(50.0, 200.0).into(), (550.0, 200.0).into(), (300.0, 50.0).into(), (50.0, 200.0).into()];
|
||||
t.kind = TextKind::OnPath { path: PathData::new(vec![vectorcraft_geom::SubPath::polyline(&ends_meet, false)]), start: 0.0, end: None };
|
||||
t.xf = Affine::IDENTITY;
|
||||
t.dynamic_text = true;
|
||||
let node = text_node(&mut doc, t);
|
||||
doc.insert(Some(layer), usize::MAX, node).unwrap();
|
||||
let out = export_ai_editing(&doc, &opts()).unwrap();
|
||||
assert!(out.warnings.iter().any(|w| w == writer::TYPE) && out.warnings.iter().any(|w| w == writer::DYNAMIC_TEXT), "{:?}", out.warnings);
|
||||
}
|
||||
|
||||
/// See-through type with the knockout shape flag comes back with the flag and writes no warning.
|
||||
|
||||
@@ -1257,6 +1257,10 @@ impl<'a> Writer<'a> {
|
||||
return;
|
||||
}
|
||||
self.warn(TYPE);
|
||||
// The outlines keep the sizes Dynamic Text draws the type at, but not the setting.
|
||||
if matches!(&n.kind, NodeKind::Text(t) if t.dynamic_text) {
|
||||
self.warn(DYNAMIC_TEXT);
|
||||
}
|
||||
let doc = self.doc;
|
||||
let resolved = match &n.kind {
|
||||
NodeKind::Text(t) => Some(doc.inline_resolved(t).into_owned()),
|
||||
|
||||
Loaded 100 of 224 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user