VectorCraft: An open-source, vector art tool written by scratch in pure Rust
//! The text of an Illustrator editing copy.
//!
//! The editing copy of a file keeps the characters of its text objects, with their fonts, sizes,
//! colours and where they sit, in one text document of its own: between `%AI11_BeginTextDocument`
//! and `%AI11_EndTextDocument`, ASCII85 of nested dictionaries with numbers for keys. A text object
//! in a layer is only a stub naming its story in it (`/StoryIndex`).
//!
//! The format isn't documented. What is read here was worked out from the files of the project's
//! users, used locally and never committed, by comparing it with the type their pages draw: the
//! meaning of each key below was checked against the page's own type in more than a thousand text
//! objects, and it is only used for the keys that matched. Point type, area type and type on a path
//! are read; a story in a frame of any other kind is left alone: it has no text, and the importer
//! says so.
//!
//! Where type sits: a story lays its lines out round a point `F` (the anchor: the start of a line of
//! left-aligned type, the middle of a centred one, the end of a right-aligned one), each line with an
//! offset from it. A right-to-left paragraph (key `33` of its attributes) swaps the two: its
//! "left"-aligned lines end at the anchor and its "right"-aligned ones start there. The frame of the
//! story gives a matrix that carries that layout onto the canvas of the app, which is 16383 points a
//! side; the canvas's centre, 8191.5, is the centre of the file's `%AI3_TemplateBox`. See
//! [`Story::place`].
use std::collections::BTreeMap;
use kurbo::{BezPath, CubicBez, ParamCurve, ParamCurveArclen};
use vectorcraft_color::{Color, Paint};
use vectorcraft_doc::{CharStyle, Justify, Node, NodeId, NodeKind, ParaDirection, ParaStyle, TextKind, TextObject, TextRun};
use vectorcraft_geom::{Affine, PathData, Point, Rect};
/// Longest story read (bytes).
const MAX_STORY: usize = 1 << 20;
/// Biggest text document read (bytes, decoded).
const MAX_BYTES: usize = 64 << 20;
/// Deepest nesting read.
const MAX_DEPTH: usize = 64;
/// Most values read.
const MAX_VALUES: usize = 4_000_000;
/// The centre of the app's canvas, in the units of its text document.
pub(super) const CANVAS_CENTRE: f64 = 8191.5;
/// A value of the text document.
#[derive(Debug, Clone, PartialEq)]
pub(super) enum Val {
Num(f64),
Str(String),
Name(String),
Bool(bool),
List(Vec<Val>),
Dict(BTreeMap<String, Val>),
}
impl Val {
fn get(&self, key: &str) -> Option<&Val> {
match self {
Val::Dict(d) => d.get(key),
_ => None,
}
}
fn num(&self) -> Option<f64> {
match self {
Val::Num(n) if n.is_finite() => Some(*n),
_ => None,
}
}
fn str(&self) -> Option<&str> {
match self {
Val::Str(s) => Some(s),
_ => None,
}
}
fn list(&self) -> &[Val] {
match self {
Val::List(l) => l,
_ => &[],
}
}
fn nums(&self) -> Option<Vec<f64>> {
self.list().iter().map(Val::num).collect()
}
/// The `name` entry of a dictionary that is a typed node (`/99 /name`).
fn is_node(&self, name: &str) -> bool {
matches!(self.get("99"), Some(Val::Name(n)) if n == name)
}
}
struct Reader<'a> {
b: &'a [u8],
at: usize,
budget: usize,
}
impl Reader<'_> {
fn skip_space(&mut self) {
while self.b.get(self.at).is_some_and(u8::is_ascii_whitespace) {
self.at += 1;
}
}
fn value(&mut self, depth: usize) -> Option<Val> {
self.skip_space();
self.budget = self.budget.checked_sub(1)?;
let c = *self.b.get(self.at)?;
match c {
b'<' if self.b.get(self.at + 1) == Some(&b'<') => {
if depth > MAX_DEPTH {
return None;
}
self.at += 2;
let mut d = BTreeMap::new();
loop {
self.skip_space();
if self.b.get(self.at..self.at + 2) == Some(b">>") {
self.at += 2;
return Some(Val::Dict(d));
}
let key = self.key()?;
let v = self.value(depth + 1)?;
d.insert(key, v);
}
}
b'[' => {
if depth > MAX_DEPTH {
return None;
}
self.at += 1;
let mut l = vec![];
loop {
self.skip_space();
if self.b.get(self.at) == Some(&b']') {
self.at += 1;
return Some(Val::List(l));
}
l.push(self.value(depth + 1)?);
}
}
b'(' => self.string(),
b'/' => Some(Val::Name(self.key()?)),
_ => {
let start = self.at;
while self.b.get(self.at).is_some_and(|c| !c.is_ascii_whitespace() && !matches!(c, b'<' | b'>' | b'[' | b']' | b'(' | b')' | b'/')) {
self.at += 1;
}
let word = std::str::from_utf8(self.b.get(start..self.at)?).ok()?;
match word {
"true" => Some(Val::Bool(true)),
"false" => Some(Val::Bool(false)),
"" => None,
w => Some(Val::Num(w.parse().ok()?)),
}
}
}
}
/// A `/name`, without its slash.
fn key(&mut self) -> Option<String> {
self.skip_space();
if self.b.get(self.at) != Some(&b'/') {
return None;
}
self.at += 1;
let start = self.at;
while self.b.get(self.at).is_some_and(|c| !c.is_ascii_whitespace() && !matches!(c, b'<' | b'>' | b'[' | b']' | b'(' | b')' | b'/')) {
self.at += 1;
}
Some(String::from_utf8_lossy(self.b.get(start..self.at)?).into_owned())
}
/// A string: up to the first `)` that isn't escaped; UTF-16 when it starts with a byte order mark.
fn string(&mut self) -> Option<Val> {
self.at += 1;
let mut bytes = vec![];
loop {
let c = *self.b.get(self.at)?;
self.at += 1;
match c {
b')' => break,
b'\\' => {
let e = *self.b.get(self.at)?;
self.at += 1;
bytes.push(match e {
b'n' => b'\n',
b'r' => b'\r',
b't' => b'\t',
b'b' => 8,
b'f' => 12,
b'0'..=b'7' => {
let mut v = u32::from(e - b'0');
for _ in 0..2 {
match self.b.get(self.at) {
Some(d @ b'0'..=b'7') => {
v = v * 8 + u32::from(d - b'0');
self.at += 1;
}
_ => break,
}
}
(v & 0xff) as u8
}
other => other,
});
}
c => bytes.push(c),
}
if bytes.len() > MAX_BYTES {
return None;
}
}
Some(Val::Str(match bytes.strip_prefix(&[0xfe, 0xff]) {
Some(rest) => {
let units: Vec<u16> = rest.as_chunks::<2>().0.iter().map(|p| u16::from_be_bytes(*p)).collect();
String::from_utf16_lossy(&units)
}
None => bytes.iter().map(|b| char::from(*b)).collect(),
}))
}
}
/// The values of a text document: its top-level `/key value` pairs.
fn read(bytes: &[u8]) -> Option<Val> {
let mut r = Reader { b: bytes, at: 0, budget: MAX_VALUES };
let mut d = BTreeMap::new();
loop {
r.skip_space();
if r.at >= bytes.len() {
return Some(Val::Dict(d));
}
let key = r.key()?;
let v = r.value(0)?;
d.insert(key, v);
}
}
/// Most character styles read of a text document, and most styles a run's style is followed
/// through to the ones they are based on.
const MAX_SHEETS: usize = 4096;
const MAX_SHEETS_BASED_ON: usize = 16;
/// Most frames read of one story, and most path segments of a frame.
const MAX_FRAMES: usize = 4096;
const MAX_SEGMENTS: usize = 1 << 16;
/// Where a frame puts its story's text.
#[derive(Debug, Clone, PartialEq)]
enum FrameKind {
/// Point type: the matrix carries the layout (its anchor at the origin of its lines) onto the
/// canvas.
Point([f64; 6]),
/// Area type flowed inside a path: its cubic segments on the canvas, four points each, and the
/// Area Type Options the frame keeps.
Area(Vec<[f64; 8]>, AreaFrame),
/// Type on a path, from `start` to `end` (segment index and the place in that segment).
OnPath { segments: Vec<[f64; 8]>, start: f64, end: f64 },
}
/// The Area Type Options an area frame keeps, in the units of the text document: each `None`
/// where the frame leaves the key out or keeps a value that can't be read, so the option stays as
/// it was.
#[derive(Debug, Clone, Default, PartialEq)]
struct AreaFrame {
/// Key 3, the rows.
rows: Option<usize>,
/// Key 4, the columns.
columns: Option<usize>,
/// Key 7, the gutter between rows.
row_gutter: Option<f64>,
/// Key 8, the gutter between columns.
column_gutter: Option<f64>,
/// Key 10, the first baseline (`0` its kind, `1` its minimum). Without it the first baseline
/// is Ascent.
first_baseline: Option<(vectorcraft_doc::FirstBaseline, f64)>,
}
/// Longest gutter or first-baseline minimum, as `text.areaOptions` caps them: read in the units of
/// the text document, and again in document points once scaled.
const MAX_AREA_LENGTH: f64 = 10_000.0;
impl AreaFrame {
/// The options frame data `carries` keeps.
fn read(carries: &Val) -> AreaFrame {
// A whole number, at most `max`.
let whole = |v: &Val, max: f64| v.num().filter(|n| n.fract() == 0.0 && *n >= 0.0).map(|n| n.min(max) as usize);
let max = vectorcraft_doc::AreaOptions::MAX_ROWS_COLUMNS;
let count = |k: &str| carries.get(k).and_then(|v| whole(v, max as f64)).filter(|n| *n >= 1);
let length = |v: Option<&Val>| v.and_then(Val::num).filter(|n| *n >= 0.0).map(|n| n.min(MAX_AREA_LENGTH));
let first_baseline = carries.get("10").and_then(|b| {
use vectorcraft_doc::FirstBaseline as F;
let kind = match whole(b.get("0")?, 99.0)? {
0 => F::Fixed,
2 => F::CapHeight,
3 => F::Leading,
4 => F::XHeight,
// Em Box Height (5) and Legacy (6) have no first baseline of their own here: the
// first baseline stays as it was.
_ => return None,
};
Some((kind, length(b.get("1")).unwrap_or(0.0)))
});
AreaFrame {
rows: count("3"),
columns: count("4"),
row_gutter: length(carries.get("7")),
column_gutter: length(carries.get("8")),
first_baseline,
}
}
/// Sets the options it keeps on `area`, its lengths at `scale` (document points to a unit).
fn apply(&self, area: &mut vectorcraft_doc::AreaOptions, scale: f64) {
if let Some(n) = self.rows {
area.rows = n;
}
if let Some(n) = self.columns {
area.columns = n;
}
// A gutter the frame leaves out stays as it was.
let (row, column) = (area.row_gutter.unwrap_or(area.gutter), area.gutter);
let scaled = |g: f64| (g * scale).min(MAX_AREA_LENGTH);
let row = self.row_gutter.map_or(row, scaled);
area.gutter = self.column_gutter.map_or(column, scaled);
area.row_gutter = (row != area.gutter).then_some(row);
if let Some((kind, min)) = self.first_baseline {
area.first_baseline = kind;
area.first_baseline_min = scaled(min);
}
}
}
/// A paragraph's attributes, as the text document keeps them.
#[derive(Clone, Debug, Default, PartialEq)]
struct Para {
justify: u8,
/// A right-to-left paragraph: its left and right alignments are each other's (the line of
/// "left"-aligned type ends at its anchor).
rtl: bool,
first_indent: f64,
left_indent: f64,
right_indent: f64,
space_before: f64,
space_after: f64,
hyphenate: bool,
}
/// The text of one story, in the units of the text document.
#[derive(Debug)]
pub(super) struct Story {
/// The characters, with `\r` ending paragraphs and `\x03` ending lines.
text: String,
/// The anchor of the first frame's layout.
anchor: (f64, f64),
/// Where each of the first frame's lines starts, from the anchor.
lines: Vec<(f64, f64)>,
/// The frames the story flows through, in order.
frames: Vec<FrameKind>,
/// `(characters, paragraph)` in order.
paras: Vec<(usize, Para)>,
/// `(characters, style)` in order.
runs: Vec<(usize, Style)>,
/// Type on a path: the spacing its first frame's layout implies ([`path_spacing`]).
path_spacing: f64,
/// Vertical type (Type › Type Orientation › Vertical): its lines are columns, from right to
/// left. Its layout's lines run down from the anchor, each column further left.
vertical: bool,
}
#[derive(Clone, Debug)]
struct Style {
font: Option<String>,
size: f64,
/// `None`: auto.
leading: Option<f64>,
tracking: f64,
baseline_shift: f64,
h_scale: f64,
v_scale: f64,
fill: Option<Color>,
stroke: Option<Color>,
stroke_width: f64,
/// Key 12, the case: 1 Small Caps, 2 All Caps.
caps: u8,
/// Key 35 at 3: Tate-chu-yoko, the characters set across the column as one block.
tate_chu_yoko: bool,
}
/// The text document of an editing copy.
pub(super) struct Texts {
stories: Vec<Val>,
fonts: Vec<String>,
/// The character and paragraph styles a story starts from.
defaults: Val,
para_defaults: Val,
/// The document's character styles (`[Normal Character Style]` first), each a name, the
/// character style it is based on (key 5, an index into these) and its attributes (key 6).
char_sheets: Vec<Val>,
frames: Vec<Val>,
}
impl Texts {
/// The text document in the editing copy `data`, if it has one that can be read.
pub(super) fn read(data: &[u8]) -> Option<Texts> {
fn find(h: &[u8], n: &[u8], from: usize) -> Option<usize> {
h.get(from..)?.windows(n.len()).position(|w| w == n).map(|p| p + from)
}
let start = find(data, b"%AI11_BeginTextDocument", 0)?;
let from = find(data, b"/ASCII85Decode", start)? + b"/ASCII85Decode".len();
let end = find(data, b"~>", from)? + 2;
// Each line after the first starts with a `%`.
// ASCII85 makes at most four bytes of a character (`z`): more than this would be over `MAX_BYTES`.
if end - from > MAX_BYTES / 4 {
return None;
}
let packed: String = String::from_utf8_lossy(data.get(from..end)?)
.split(['\r', '\n'])
.enumerate()
.map(|(i, l)| if i > 0 { l.strip_prefix('%').unwrap_or(l) } else { l })
.collect::<String>()
.trim_start_matches([' ', ','])
.to_string();
let bytes = crate::ps::ascii85_decode(&packed)?;
if bytes.len() > MAX_BYTES {
return None;
}
let doc = read(&bytes)?;
let fonts = doc
.get("0")?
.get("1")?
.get("0")?
.list()
.iter()
.map(|f| f.get("0").and_then(|f| f.get("0")).and_then(|f| f.get("0")).and_then(Val::str).unwrap_or_default().to_string())
.collect();
let main = doc.get("1")?;
Some(Texts {
stories: main.get("1")?.list().to_vec(),
fonts,
defaults: main.get("2")?.clone(),
para_defaults: main.get("3").cloned().unwrap_or(Val::Dict(BTreeMap::new())),
char_sheets: doc
.get("0")?
.get("5")
.and_then(|s| s.get("0"))
.map(Val::list)
.unwrap_or_default()
.iter()
.take(MAX_SHEETS)
.map(|s| s.get("0").cloned().unwrap_or(Val::Dict(BTreeMap::new())))
.collect(),
frames: doc.get("0")?.get("8")?.get("0")?.list().to_vec(),
})
}
/// Frame `i` of the document, if it is of a kind this reads.
fn frame(&self, i: usize) -> Option<FrameKind> {
let f = self.frames.get(i)?.get("0")?;
let carries = f.get("2")?;
let segments = || -> Option<Vec<[f64; 8]>> {
let n = f.get("1")?.get("0")?.nums()?;
let (chunks, rest) = n.as_chunks::<8>();
(rest.is_empty() && !chunks.is_empty() && chunks.len() <= MAX_SEGMENTS).then(|| chunks.to_vec())
};
match carries.get("0").and_then(Val::num).unwrap_or(0.0) as i64 {
// Point type that is neither turned nor scaled has no matrix (Illustrator 24 leaves it out):
// its layout is already where it goes on the canvas.
0 => Some(FrameKind::Point(match carries.get("2") {
None => [1.0, 0.0, 0.0, 1.0, 0.0, 0.0],
Some(m) => m.nums()?.try_into().ok()?,
})),
1 => Some(FrameKind::Area(segments()?, AreaFrame::read(carries))),
2 => {
let range = carries.get("6").and_then(Val::nums).unwrap_or_default();
let segments = segments()?;
let n = segments.len() as f64;
let finite = |v: Option<&f64>| v.copied().filter(|v| v.is_finite());
let (start, end) = if closed(&segments) {
// Round a closed path the end is written unwrapped (the start plus the run, so
// past the last segment), or wrapped the other way: both brackets are places on
// the loop.
let start = finite(range.first()).unwrap_or(0.0).rem_euclid(n);
(start, finite(range.get(1)).map_or(start, |e| e.rem_euclid(n)))
} else {
let start = finite(range.first()).unwrap_or(0.0).clamp(0.0, n);
(start, finite(range.get(1)).unwrap_or(n).clamp(start, n))
};
Some(FrameKind::OnPath { segments, start, end })
}
_ => None,
}
}
/// Is frame `i` vertical type? Key 1 of what it carries: 2 vertical, 0 or none horizontal. Any
/// other value is ignored: horizontal.
fn frame_vertical(&self, i: usize) -> bool {
let orientation = self.frames.get(i).and_then(|f| f.get("0")).and_then(|f| f.get("2")).and_then(|c| c.get("1"));
orientation.and_then(Val::num) == Some(2.0)
}
/// Story `i`, if its frames are of kinds this reads.
pub(super) fn story(&self, i: usize) -> Option<Story> {
let s = self.stories.get(i)?;
let text = s.get("0")?.get("0")?.str().filter(|t| t.len() <= MAX_STORY)?.to_string();
let view = s.get("1")?;
let indices: Vec<usize> =
view.get("0")?.list().iter().take(MAX_FRAMES).map(|f| f.get("0").and_then(Val::num).map(|n| n as usize)).collect::<Option<_>>()?;
let frames: Vec<FrameKind> = indices.iter().map(|n| self.frame(*n)).collect::<Option<_>>()?;
if frames.is_empty() {
return None;
}
// Threaded frames share one orientation: frames that differ aren't read.
let vertical = indices.first().is_some_and(|n| self.frame_vertical(*n));
if indices.iter().any(|n| self.frame_vertical(*n) != vertical) {
return None;
}
// The first frame's layout, when the file keeps one: where its lines start.
let (mut anchor, mut lines, mut path_spacing) = ((0.0, 0.0), vec![], 0.0);
if let Some(f) = view.get("2").and_then(|l| find_node(l, "F")) {
// Vertical type on a path turns its glyphs across the path: their matrices don't give
// the spacing.
if matches!(frames.first(), Some(FrameKind::OnPath { .. })) && !vertical {
path_spacing = self::path_spacing(f);
}
if let Some(a) = f.get("0").and_then(|a| a.get("0")).and_then(Val::nums)
&& let [x, y, ..] = a.as_slice()
{
anchor = (*x, *y);
}
let mut found = vec![];
find_nodes(f, "L", &mut found);
for l in found {
let off = l.get("0").and_then(|o| o.get("0")).and_then(Val::nums).unwrap_or_else(|| vec![0.0, 0.0]);
let Some(seg) = l.get("6").map(Val::list).and_then(|c| c.iter().find(|c| c.is_node("S"))) else { continue };
let so = seg.get("0").and_then(|o| o.get("0")).and_then(Val::nums).unwrap_or_else(|| vec![0.0, 0.0]);
if let (Some(ox), Some(oy), Some(sx)) = (off.first(), off.get(1), so.first()) {
lines.push((ox + sx, *oy));
}
}
}
let mut paras = vec![];
for run in s.get("0")?.get("5").map(|p| p.get("0").map(Val::list).unwrap_or_default()).unwrap_or_default() {
let n = run.get("1").and_then(Val::num)? as usize;
let props = run.get("0").and_then(|r| r.get("0")).and_then(|r| r.get("5"));
paras.push((n, self.para(props)));
}
let mut runs = vec![];
for run in s.get("0")?.get("6").map(|p| p.get("0").map(Val::list).unwrap_or_default()).unwrap_or_default() {
let n = run.get("1").and_then(Val::num)? as usize;
runs.push((n, self.style(run.get("0").and_then(|r| r.get("0")))));
}
if runs.is_empty() {
runs.push((text.chars().count(), self.style(None)));
}
Some(Story { text, anchor, lines, frames, paras, runs, path_spacing, vertical })
}
/// A paragraph's attributes: its own keys, else the document's.
fn para(&self, p: Option<&Val>) -> Para {
let pick = |k: &str| p.and_then(|p| p.get(k)).or_else(|| self.para_defaults.get(k));
let num = |k: &str| pick(k).and_then(Val::num).filter(|v| v.abs() < 1e5).unwrap_or(0.0);
Para {
justify: pick("0").and_then(Val::num).map_or(0, |v| v.clamp(0.0, 6.0) as u8),
rtl: pick("33").and_then(Val::num) == Some(1.0),
first_indent: num("1"),
left_indent: num("2"),
right_indent: num("3"),
space_before: num("4"),
space_after: num("5"),
hyphenate: !matches!(pick("9"), Some(Val::Bool(false))),
}
}
/// A run's character style (`run`: its attributes, key 6, and the character style it is based
/// on, key 5): its own keys, else those of its character style and the ones that is based on,
/// else the document's.
fn style(&self, run: Option<&Val>) -> Style {
// The run's attributes, then its character style's, then the styles each is based on.
let mut chain = vec![];
let mut at = run;
for _ in 0..=MAX_SHEETS_BASED_ON {
let Some(style) = at else { break };
chain.extend(style.get("6"));
at = style.get("5").and_then(Val::num).filter(|i| i.is_finite() && *i >= 0.0).and_then(|i| self.char_sheets.get(i as usize));
}
let pick = |k: &str| chain.iter().find_map(|s| s.get(k)).or_else(|| self.defaults.get(k));
let num = |k: &str| pick(k).and_then(Val::num);
let on = |k: &str| !matches!(pick(k), Some(Val::Bool(false)));
let font = num("0").and_then(|i| self.fonts.get(i as usize)).filter(|f| !f.is_empty()).cloned();
let size = num("1").filter(|v| *v > 0.0 && *v < 1e5).unwrap_or(12.0);
Style {
font,
size,
leading: if on("4") { None } else { num("5").filter(|v| *v > 0.0 && *v < 1e5) },
tracking: num("8").filter(|v| v.abs() < 1e5).unwrap_or(0.0),
baseline_shift: num("9").filter(|v| v.abs() < 1e5).unwrap_or(0.0),
h_scale: num("6").filter(|v| *v > 0.0 && *v < 100.0).unwrap_or(1.0),
v_scale: num("7").filter(|v| *v > 0.0 && *v < 100.0).unwrap_or(1.0),
fill: if on("56") { Some(pick("53").and_then(paint).unwrap_or(Color::BLACK)) } else { None },
stroke: if matches!(pick("57"), Some(Val::Bool(true))) { pick("54").and_then(paint) } else { None },
stroke_width: num("63").filter(|v| *v >= 0.0 && *v < 1e4).unwrap_or(1.0),
caps: num("12").filter(|v| *v == 1.0 || *v == 2.0).map_or(0, |v| v as u8),
tate_chu_yoko: num("35") == Some(3.0),
}
}
}
/// The colour of a paint of the text document: kind 0 grey (`[alpha, level]`, 1 is white), 1 RGB
/// (`[alpha, r, g, b]`), 2 CMYK (`[alpha, c, m, y, k]`).
fn paint(p: &Val) -> Option<Color> {
let p = p.get("0")?;
let v = p.get("1")?.nums()?;
let unit = |i: usize| v.get(i).map(|c| c.clamp(0.0, 1.0) as f32);
match p.get("0")?.num()? as i64 {
0 => Some(Color::gray(1.0 - unit(1)?)),
1 => Some(Color::rgb(unit(1)?, unit(2)?, unit(3)?)),
2 => Some(Color::cmyk(unit(1)?, unit(2)?, unit(3)?, unit(4)?)),
_ => None,
}
}
fn find_node<'a>(v: &'a Val, name: &str) -> Option<&'a Val> {
let mut out = vec![];
find_nodes(v, name, &mut out);
out.into_iter().next()
}
/// The typed nodes called `name` in `v`, in order, outermost first.
fn find_nodes<'a>(v: &'a Val, name: &str, out: &mut Vec<&'a Val>) {
match v {
Val::Dict(d) => {
if v.is_node(name) {
out.push(v);
}
for x in d.values() {
find_nodes(x, name, out);
}
}
Val::List(l) => {
for x in l {
find_nodes(x, name, out);
}
}
_ => {}
}
}
/// A point of the canvas (y down) in the units of the art (y up), given the centre `template` of
/// the file's template box.
fn to_art((x, y): (f64, f64), template: (f64, f64)) -> (f64, f64) {
(x - CANVAS_CENTRE + template.0, CANVAS_CENTRE + template.1 - y)
}
/// Segments of the canvas as a path of the document.
fn path_of(segments: &[[f64; 8]], template: (f64, f64), to_doc: Affine) -> PathData {
let at = |x: f64, y: f64| {
let (x, y) = to_art((x, y), template);
to_doc * Point::new(x, y)
};
let mut bp = BezPath::new();
for (i, [x0, y0, x1, y1, x2, y2, x3, y3]) in segments.iter().enumerate() {
if i == 0 {
bp.move_to(at(*x0, *y0));
}
bp.curve_to(at(*x1, *y1), at(*x2, *y2), at(*x3, *y3));
}
let closed = closed(segments);
if closed {
bp.close_path();
}
PathData::from_bezpath(&bp)
}
/// Do `segments` end where they start (a closed path)?
fn closed(segments: &[[f64; 8]]) -> bool {
matches!((segments.first(), segments.last()), (Some(f), Some(l)) if (f[0] - l[6]).abs() < 1e-3 && (f[1] - l[7]).abs() < 1e-3)
}
/// Where on `segments` the place `t` (segment index and the place in it) is, as a fraction of their
/// length.
fn length_fraction(segments: &[[f64; 8]], t: f64) -> f64 {
let cubic = |s: &[f64; 8]| CubicBez::new((s[0], s[1]), (s[2], s[3]), (s[4], s[5]), (s[6], s[7]));
let lengths: Vec<f64> = segments.iter().map(|s| cubic(s).arclen(0.01)).collect();
let total: f64 = lengths.iter().sum();
if !total.is_finite() || total <= 1e-9 {
return 0.0;
}
let whole = t.floor().max(0.0) as usize;
let before: f64 = lengths.iter().take(whole).sum();
let within = match segments.get(whole) {
Some(s) => cubic(s).subsegment(0.0..t.fract().clamp(0.0, 1.0)).arclen(0.01),
None => 0.0,
};
((before + within) / total).clamp(0.0, 1.0)
}
/// The spacing (Type on a Path Options › Spacing) that the layout `f` of type on a path implies.
/// The file closes its glyphs up round the outside of a curve and opens them up round the inside,
/// even where its frame keeps no spacing; the text engine spaces glyphs that way by the spacing
/// (`vectorcraft_text`'s `path_steps`): between two glyphs' centres, the path's length `s`, their
/// advances' mean `a` and how far it turns `t` (away from their tops) make `s + t × spacing = a`.
/// Fitted over every pair of the layout's glyphs; none where the path doesn't turn under them.
fn path_spacing(f: &Val) -> f64 {
let mut found = vec![];
find_nodes(f, "G", &mut found);
let (mut sum, mut turns) = (0.0, 0.0);
for g in found {
// Each glyph's origin, its matrix (along its baseline, then towards its foot) and where it
// ends along the line; the lists end with where the line ends.
let Some(at) = g.get("21") else { continue };
let list = |k: &str| at.get(k).and_then(Val::nums).unwrap_or_default();
let (xs, ys, matrices, ends) = (list("1"), list("2"), list("3"), list("4"));
let glyphs: Vec<(Point, f64, kurbo::Vec2, kurbo::Vec2)> = xs
.iter()
.zip(&ys)
.zip(matrices.as_chunks::<6>().0)
.zip(ends.windows(2))
.map(|(((x, y), [a, b, c, d, ..]), e)| {
let advance = e.get(1).zip(e.first()).map_or(0.0, |(e1, e0)| e1 - e0);
let along = kurbo::Vec2::new(*a, *b);
(Point::new(*x, *y) + along * (advance * 0.5), advance, along, kurbo::Vec2::new(*c, *d))
})
.collect();
for w in glyphs.windows(2) {
let [(p, a0, along, foot), (q, a1, next, _)] = w else { continue };
let turn = next.dot(*foot).atan2(next.dot(*along));
// The length of the arc between the centres (the path is taken to be round there). A
// corner (a turn of more than a radian between two glyphs) isn't round: left out.
let half = turn.abs() * 0.5;
let length = if half > 1e-9 { (*q - *p).hypot() * half / half.sin() } else { (*q - *p).hypot() };
if turn.abs() <= 1.0 && length.is_finite() && a0.is_finite() && a1.is_finite() {
sum += ((a0 + a1) * 0.5 - length) * turn;
turns += turn * turn;
}
}
}
let spacing = sum / turns;
if turns > 1e-6 && spacing.is_finite() { spacing.clamp(-1000.0, 1000.0) } else { 0.0 }
}
impl Story {
/// How many bytes of text the story has.
pub(super) fn len(&self) -> usize {
self.text.len()
}
/// The point frame's matrix (the first frame's, when it is one), else the identity.
fn matrix(&self) -> [f64; 6] {
match self.frames.first() {
Some(FrameKind::Point(m)) => *m,
_ => [1.0, 0.0, 0.0, 1.0, 0.0, 0.0],
}
}
/// The anchor of the story on the file's canvas: `(x, y)` in the units of the art, y up, given
/// the centre `(tx, ty)` of the file's template box.
pub(super) fn place(&self, template: (f64, f64)) -> (f64, f64) {
let [a, b, c, d, e, f] = self.matrix();
to_art((a * self.anchor.0 + c * self.anchor.1 + e, b * self.anchor.0 + d * self.anchor.1 + f), template)
}
/// Each line's characters and where it starts (in the units of the art, y up): where the page
/// draws the line when the type is shown.
pub(super) fn line_starts(&self, template: (f64, f64)) -> Vec<(String, (f64, f64))> {
let [a, b, c, d, e, f] = self.matrix();
let text: Vec<&str> = self.text.split(['\r', '\x03']).collect();
self.lines
.iter()
.enumerate()
.map(|(i, (lx, ly))| {
// A vertical layout's lines run down the canvas, and each next one is further left.
let (x, y) = if self.vertical { (self.anchor.0 - ly, self.anchor.1 + lx) } else { (self.anchor.0 + lx, self.anchor.1 + ly) };
(text.get(i).copied().unwrap_or_default().to_string(), to_art((a * x + c * y + e, b * x + d * y + f), template))
})
.collect()
}
/// Roughly where the story's type lies on the document: its frame's box, or round its lines
/// for point type (what the page draws of it lies there).
pub(super) fn region(&self, template: (f64, f64), to_doc: Affine) -> Option<Rect> {
let size = self.runs.iter().map(|(_, s)| s.size).fold(0.0, f64::max) * art_scale(to_doc);
let bounds = |segments: &[[f64; 8]]| path_of(segments, template, to_doc).bounds();
let r = match self.frames.first()? {
FrameKind::Area(s, _) => bounds(s)?,
FrameKind::OnPath { segments, .. } => bounds(segments)?.inflate(size * 1.5, size * 1.5),
FrameKind::Point(m) => {
let longest = self.text.split(['\r', '\x03']).map(|l| l.chars().count()).max().unwrap_or(0) as f64;
let reach = longest * size + size;
let points: Vec<Point> = self.line_starts(template).into_iter().map(|(_, (x, y))| to_doc * Point::new(x, y)).collect();
let first = points.first().copied().unwrap_or_else(|| {
let (x, y) = self.place(template);
to_doc * Point::new(x, y)
});
// Along the baseline as far as a line reaches, across it a line and a half: turned
// with the type (a dimension's label turned a quarter runs down the page).
// (The canvas is y down, the art y up: see [`to_art`].)
let along = to_doc * Point::new(m[0], -m[1]) - to_doc * Point::ZERO;
let along = if along.hypot() > 1e-9 && along.is_finite() { along / along.hypot() } else { kurbo::Vec2::new(1.0, 0.0) };
let across = kurbo::Vec2::new(-along.y, along.x);
// Vertical type: its lines run down the page, a quarter turn from the baseline.
let (along, across) = if self.vertical { (across, along) } else { (along, across) };
let mut r = Rect::from_points(first, first);
for p in points.iter().chain([&first]) {
for (t, n) in [(-reach, -1.5), (-reach, 1.5), (reach, -1.5), (reach, 1.5)] {
r = r.union_pt(*p + along * t + across * (n * size));
}
}
r
}
};
r.is_finite().then_some(r)
}
/// The story as the text object of its frame `frame` (`to_doc` takes the art's units onto the
/// document), or `None` for type that is mirrored, has no size, or a frame past the first of
/// threaded type (the first frame holds the whole story).
pub(super) fn node(&self, id: NodeId, frame: usize, template: (f64, f64), to_doc: Affine) -> Option<Node> {
let kind = self.frames.get(frame)?;
let threaded = frame > 0;
let (scale, xf, kind) = match kind {
FrameKind::Point(m) => {
let [a, b, c, d, ..] = *m;
let scale = (a * d - b * c).abs().sqrt();
if !(scale.is_finite() && scale > 1e-6 && a * d - b * c > 0.0) || threaded {
return None;
}
let (x, y) = self.place(template);
let at = to_doc * Point::new(x, y);
(scale, Affine::new([a / scale, b / scale, c / scale, d / scale, at.x, at.y]), TextKind::Point)
}
FrameKind::Area(s, _) => (1.0, Affine::IDENTITY, TextKind::Area { frame: path_of(s, template, to_doc) }),
FrameKind::OnPath { segments, start, end } => {
let n = segments.len() as f64;
// A closed path keeps its end bracket wherever it is (the same place as the start: a
// full turn, see `TextKind::path_span`); an open one's end at its end is none.
let end = (closed(segments) || *end < n - 0.02).then(|| length_fraction(segments, *end));
(1.0, Affine::IDENTITY, TextKind::OnPath { path: path_of(segments, template, to_doc), start: length_fraction(segments, *start), end })
}
};
// A `\x03` ends a line inside its paragraph: a forced line break (U+2028), which the
// paragraph's style runs over.
let text: String = if threaded {
String::new()
} else {
self.text
.trim_end_matches('\r')
.chars()
.map(|c| match c {
'\r' => '\n',
'\x03' => '\u{2028}',
c => c,
})
.collect()
};
if text.trim().is_empty() && !threaded {
return None;
}
// The text document measures in the art's units too: the document's scale carries its
// sizes and spacings onto the page (a Large Canvas copy is written at 1:10; #2031).
let scale = scale * art_scale(to_doc);
let leading = self.line_leading(scale);
let chars: Vec<char> = text.chars().collect();
let mut runs = vec![];
let mut from = 0usize;
for (n, st) in &self.runs {
let to = from.saturating_add(*n).min(chars.len());
let piece: String = chars.get(from..to).unwrap_or_default().iter().collect();
from = to;
if piece.is_empty() {
continue;
}
runs.push(TextRun::new(piece, char_style(st, scale, leading)));
}
if from < chars.len() {
let last = self.runs.last().map(|r| &r.1)?;
runs.push(TextRun::new(chars.get(from..).unwrap_or_default().iter().collect::<String>(), char_style(last, scale, leading)));
}
let first = self.runs.first().map(|r| char_style(&r.1, scale, leading))?;
let mut t = TextObject::point(Point::ZERO, "", first);
if !runs.is_empty() {
t.runs = runs;
}
let paras: Vec<ParaStyle> = self.paragraph_styles(&text, scale);
t.para = paras.first().cloned().unwrap_or_default();
if paras.len() > 1 && paras.iter().any(|p| *p != t.para) {
t.paras = paras;
}
if matches!(kind, TextKind::OnPath { .. }) && !threaded {
t.path_spacing = self.path_spacing * scale;
}
// Each frame of a thread keeps its own options.
if let Some(FrameKind::Area(_, options)) = self.frames.get(frame) {
options.apply(&mut t.area, scale);
}
t.vertical = self.vertical;
t.kind = kind;
t.xf = xf;
Some(Node::new(id, NodeKind::Text(Box::new(t))))
}
/// Area type that the file lays lines out in, in a frame too short for its first line as it is
/// laid out here: a font that isn't available shows in the fallback font, whose lines may be
/// taller, and type that doesn't fit its frame isn't drawn. The frame is made taller, from its
/// top, by what the first line needs (`vectorcraft_text::fit_first_line`). Whether it was.
pub(super) fn fit_first_line(&self, t: &mut TextObject) -> bool {
!self.lines.is_empty() && vectorcraft_text::fit_first_line(vectorcraft_text::FontDb::global(), t)
}
/// Area type (`node`, the story's first frame as [`Self::node`] makes it with `template` and
/// `to_doc`) whose first line the file lays out higher or lower than it is laid out here, as its
/// page draws it: its first baseline is fixed where the file has it. The font's ascent below the
/// frame's top, the first baseline here, isn't where the app that wrote the file puts it for
/// every font. A first baseline its frame `frame` keeps (other than Ascent) stays as it is.
/// Whether it was.
pub(super) fn place_first_line(&self, node: &mut Node, frame: usize, template: (f64, f64), to_doc: Affine) -> bool {
// Closer than this (points of the document) and the line is where the file has it.
const SAME: f64 = 0.5;
if matches!(self.frames.get(frame), Some(FrameKind::Area(_, AreaFrame { first_baseline: Some(_), .. }))) {
return false;
}
let NodeKind::Text(t) = &mut node.kind else { return false };
if !matches!(t.kind, TextKind::Area { .. }) || t.area.vertical_align != vectorcraft_doc::VerticalAlign::Top {
return false;
}
let Some((_, (x, y))) = self.line_starts(template).into_iter().next() else { return false };
let at = to_doc * Point::new(x, y);
let db = vectorcraft_text::FontDb::global();
// A frame too short for the line lays nothing out: as the line needs it (see `fit_first_line`).
let mut probe = TextObject::clone(t);
vectorcraft_text::fit_first_line(db, &mut probe);
let laid = vectorcraft_text::layout(db, &probe);
let Some(first) = laid.lines.first().filter(|l| l.region == 0) else { return false };
// Where the first baseline goes in the layout's line space. Vertical type's line space is a
// quarter turn from the document (a line's height is how far left of the frame's right edge
// its column is), and the file's line is the column's centre line, the middle of the line
// (as `TextLayout::baselines` has it): the baseline is that far from it.
let want = if t.vertical { -at.x - (first.descent - first.ascent) / 2.0 } else { at.y };
let min = first.first_baseline + (want - first.baseline);
if (want - first.baseline).abs() <= SAME || !min.is_finite() || min <= 0.0 {
return false;
}
t.area.first_baseline = vectorcraft_doc::FirstBaseline::Fixed;
t.area.first_baseline_min = min;
true
}
/// The leading the file's own line positions imply: the distance from one line to the next, less
/// the space between paragraphs that is part of it (a paragraph's space after and the next one's
/// space before; a layout's lines are where that space has put them, and the text object adds it
/// again).
fn line_leading(&self, scale: f64) -> Option<f64> {
let para_at = |c: usize| {
let mut end = 0usize;
for (n, p) in &self.paras {
end = end.saturating_add(*n);
if c < end {
return Some(p);
}
}
self.paras.last().map(|(_, p)| p)
};
let chars: Vec<char> = self.text.chars().collect();
let breaks: Vec<usize> = chars.iter().enumerate().filter(|(_, c)| matches!(c, '\r' | '\x03')).map(|(i, _)| i).collect();
// More lines than breaks: area type wraps, and which break ends which line is unknown.
let wraps = self.lines.len() > breaks.len() + 1;
self.lines.windows(2).enumerate().find_map(|(i, w)| {
let pitch = w[1].1 - w[0].1;
let between = match breaks.get(i) {
Some(&at) if !wraps && chars.get(at) == Some(&'\r') => {
para_at(at).map_or(0.0, |p| p.space_after) + para_at(at + 1).map_or(0.0, |p| p.space_before)
}
_ => 0.0,
};
let l = (pitch - between) * scale;
(l.is_finite() && l > 0.0).then_some(l)
})
}
/// The style of each paragraph of `text` (paragraphs split at `\n`).
fn paragraph_styles(&self, text: &str, scale: f64) -> Vec<ParaStyle> {
let count = text.split('\n').count();
let mut out = Vec::with_capacity(count);
let mut runs = self.paras.iter();
let mut current = runs.next();
let mut left = current.map_or(usize::MAX, |r| r.0);
for p in text.split('\n') {
let para = current.map(|r| r.1.clone()).unwrap_or_default();
out.push(para_style(¶, scale));
// Each paragraph and its ending `\r` count.
let mut used = p.chars().count() + 1;
while used > 0 {
if left > used {
left -= used;
used = 0;
} else {
used -= left;
current = runs.next();
left = current.map_or(usize::MAX, |r| r.0);
if current.is_none() {
break;
}
}
}
}
out
}
}
fn para_style(p: &Para, scale: f64) -> ParaStyle {
ParaStyle {
justify: match p.justify {
0 if p.rtl => Justify::Right,
1 if p.rtl => Justify::Left,
1 => Justify::Right,
2 => Justify::Center,
3 => Justify::JustifyLeft,
4 => Justify::JustifyRight,
5 => Justify::JustifyCenter,
6 => Justify::JustifyAll,
_ => Justify::Left,
},
left_indent: p.left_indent * scale,
right_indent: p.right_indent * scale,
first_line_indent: p.first_indent * scale,
space_before: p.space_before * scale,
space_after: p.space_after * scale,
hyphenate: p.hyphenate,
// A right-to-left paragraph lays its text out from the right whatever letters it has
// (" 120.5 mm " reads "mm 120.5"); without the key, from its first strong letter.
direction: p.rtl.then_some(ParaDirection::RightToLeft),
..ParaStyle::default()
}
}
fn char_style(s: &Style, scale: f64, leading: Option<f64>) -> CharStyle {
let (family, style) = s.font.as_deref().map_or_else(|| (CharStyle::default().font_family, "Regular".to_string()), crate::family_style);
let family = vectorcraft_text::FontDb::global().find_family(&family).unwrap_or(family);
CharStyle {
font_family: family,
font_style: style,
size: s.size * scale,
leading: s.leading.map(|l| l * scale).or(leading),
tracking: s.tracking,
baseline_shift: s.baseline_shift * scale,
h_scale: s.h_scale * 100.0,
v_scale: s.v_scale * 100.0,
fill: s.fill.map_or(Paint::None, Paint::solid),
stroke: s.stroke.map_or(Paint::None, Paint::solid),
stroke_width: if s.stroke.is_some() { s.stroke_width * scale } else { 0.0 },
all_caps: s.caps == 2,
// At the default Small Caps size of Document Setup: the file's own isn't read.
small_caps: (s.caps == 1).then(|| vectorcraft_doc::DocSetup::default().small_caps_size),
tate_chu_yoko: s.tate_chu_yoko,
..CharStyle::default()
}
}
/// How many document points one unit of the art is: `to_doc`'s scale, which carries the art's
/// lengths onto the document (10 for a Large Canvas copy written at 1:10; see `ai::read`).
fn art_scale(to_doc: Affine) -> f64 {
let [a, b, ..] = to_doc.as_coeffs();
(a * a + b * b).sqrt().max(1e-9)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn right_to_left_paragraphs_swap_left_and_right_alignment() {
let texts = Texts {
stories: vec![],
fonts: vec![],
defaults: Val::Dict(BTreeMap::new()),
para_defaults: read(b"/33 1").unwrap(),
char_sheets: vec![],
frames: vec![],
};
let justify = |own: &[u8]| para_style(&texts.para(Some(&read(own).unwrap())), 1.0).justify;
// Right to left from the document's defaults, or the paragraph's own.
assert_eq!(justify(b"/0 0"), Justify::Right);
assert_eq!(justify(b"/0 1 /33 1"), Justify::Left);
assert_eq!(justify(b"/0 2"), Justify::Center);
// Left to right keeps them.
assert_eq!(justify(b"/0 0 /33 0"), Justify::Left);
assert_eq!(justify(b"/0 1 /33 0"), Justify::Right);
}
/// Where point type lies runs along its baseline: a label turned a quarter (as a vertical
/// dimension's is) lies in a tall box, not a wide one.
#[test]
fn point_type_lies_along_its_baseline() {
let para = Texts {
stories: vec![],
fonts: vec![],
defaults: Val::Dict(BTreeMap::new()),
para_defaults: Val::Dict(BTreeMap::new()),
char_sheets: vec![],
frames: vec![],
}
.para(None);
let mut s = story(" 80 mm ", &[0.0], ¶);
let size = |s: &Story| s.region((0.0, 0.0), Affine::IDENTITY).map(|r| (r.width(), r.height())).unwrap();
let (w, h) = size(&s);
assert!(w > 3.0 * h, "level: {w} × {h}");
// Turned −90° on the canvas (y down): the baseline runs down the page.
s.frames = vec![FrameKind::Point([0.0, 1.0, -1.0, 0.0, 0.0, 0.0])];
let (w, h) = size(&s);
assert!(h > 3.0 * w, "turned: {w} × {h}");
// Vertical type lies down the page without a turn.
s.frames = vec![FrameKind::Point([1.0, 0.0, 0.0, 1.0, 0.0, 0.0])];
s.vertical = true;
let (w, h) = size(&s);
assert!(h > 3.0 * w, "vertical: {w} × {h}");
}
/// A vertical layout's lines run down the canvas from the anchor, each next one further left:
/// the second column starts one line pitch left of the first, and a centred column (its start
/// before the anchor) starts higher up.
#[test]
fn vertical_lines_start_down_the_canvas_each_further_left() {
let mut s = story("ab\rc\rde\r", &[0.0, 14.4, 28.8], &Para::default());
s.vertical = true;
s.lines[2].0 = -12.0;
s.anchor = (CANVAS_CENTRE + 100.0, CANVAS_CENTRE - 50.0);
let starts: Vec<(f64, f64)> = s.line_starts((0.0, 0.0)).into_iter().map(|(_, p)| p).collect();
let [a, b, c] = starts.as_slice() else { panic!("{starts:?}") };
assert!((a.0 - 100.0).abs() < 1e-9 && (a.1 - 50.0).abs() < 1e-9, "the first column at the anchor: {a:?}");
assert!((b.0 - 85.6).abs() < 1e-9 && (b.1 - 50.0).abs() < 1e-9, "the next one to the left: {b:?}");
assert!((c.0 - 71.2).abs() < 1e-9 && (c.1 - 62.0).abs() < 1e-9, "a centred one higher (the art is y up): {c:?}");
}
/// Key 1 of what a frame carries is its orientation: 2 vertical; 0, none or any other value
/// horizontal.
#[test]
fn a_frame_is_vertical_only_at_orientation_two() {
let frame = |carries: &str| read(format!("/0 << /2 << /0 0 {carries} >> >>").as_bytes()).unwrap();
let cases = ["/1 2", "/1 0", "", "/1 1", "/1 2.5", "/1 -2", "/1 (2)", "/1 1e300", "/1 true", "/1 [ 2 ]"];
let texts = Texts {
stories: vec![],
fonts: vec![],
defaults: Val::Dict(BTreeMap::new()),
para_defaults: Val::Dict(BTreeMap::new()),
char_sheets: vec![],
frames: cases.iter().map(|c| frame(c)).collect(),
};
let vertical: Vec<bool> = (0..cases.len() + 1).map(|i| texts.frame_vertical(i)).collect();
assert_eq!(vertical, [true, false, false, false, false, false, false, false, false, false, false]);
}
/// Key 35 of a character style at 3 is Tate-chu-yoko; its other values (1 and 2, how half-width
/// characters stand in a column) and values that aren't that number aren't.
#[test]
fn baseline_direction_three_is_tate_chu_yoko() {
let texts = Texts {
stories: vec![],
fonts: vec![],
defaults: read(b"/35 1").unwrap(),
para_defaults: Val::Dict(BTreeMap::new()),
char_sheets: vec![read(b"/0 (Block) /6 << /35 3 >>").unwrap()],
frames: vec![],
};
let tcy = |run: &[u8]| texts.style(Some(&read(run).unwrap())).tate_chu_yoko;
assert!(tcy(b"/6 << /35 3 >>"), "the run's own");
assert!(tcy(b"/5 0 /6 << >>"), "its character style's");
assert!(!tcy(b"/5 0 /6 << /35 1 >>"), "the run's own wins");
for other in [&b"/6 << >>"[..], b"/6 << /35 2 >>", b"/6 << /35 3.5 >>", b"/6 << /35 (3) >>", b"/6 << /35 -3 >>", b"/6 << /35 1e308 >>"] {
assert!(!tcy(other), "{}", String::from_utf8_lossy(other));
}
}
/// A right-to-left paragraph is laid out right to left even when it has no right-to-left
/// letters (a dimension's label " 120.5 mm " reads "mm 120.5"); a left-to-right one, or one
/// that doesn't say, goes by its letters.
#[test]
fn right_to_left_paragraphs_set_their_direction() {
let texts = Texts {
stories: vec![],
fonts: vec![],
defaults: Val::Dict(BTreeMap::new()),
para_defaults: read(b"/33 1").unwrap(),
char_sheets: vec![],
frames: vec![],
};
let direction = |own: &[u8]| para_style(&texts.para(Some(&read(own).unwrap())), 1.0).direction;
assert_eq!(direction(b"/0 2"), Some(ParaDirection::RightToLeft), "from the document's defaults");
assert_eq!(direction(b"/0 2 /33 0"), None, "the paragraph's own");
let plain = Texts { para_defaults: Val::Dict(BTreeMap::new()), ..texts };
assert_eq!(para_style(&plain.para(None), 1.0).direction, None);
}
#[test]
fn values_read_nested_dictionaries_lists_and_utf16_strings() {
let v = read(b" /1 << /0 [ 1 2.5 -3 ] /2 (\xfe\xff\x00h\x00i) /3 true /99 /Name >> /0 (a\\)b\\n)").unwrap();
let one = v.get("1").unwrap();
assert_eq!(one.get("0").unwrap().nums(), Some(vec![1.0, 2.5, -3.0]));
assert_eq!(one.get("2").unwrap().str(), Some("hi"));
assert_eq!(one.get("3"), Some(&Val::Bool(true)));
assert!(one.is_node("Name"));
assert_eq!(v.get("0").unwrap().str(), Some("a)b\n"));
}
#[test]
fn damaged_documents_are_not_read() {
for bad in [&b"/0 << /1"[..], b"/0 [ 1 2", b"/0 (abc", b"/0 nope", b"0 1"] {
assert!(read(bad).is_none(), "{}", String::from_utf8_lossy(bad));
}
let deep = format!("/0 {}", "[".repeat(200));
assert!(read(deep.as_bytes()).is_none());
}
/// A text document's frame on a path of `segments` (each `x0 y0 x1 y1 x2 y2 x3 y3`) with the
/// range `range`, written by hand.
fn on_path_frame(segments: &[[f64; 8]], range: [f64; 2]) -> Option<FrameKind> {
let nums = |v: &[f64]| v.iter().map(|n| format!("{n}")).collect::<Vec<_>>().join(" ");
let all: Vec<f64> = segments.iter().flatten().copied().collect();
let doc = format!("/0 << /1 << /0 [ {} ] >> /2 << /0 2 /6 [ {} ] >> >>", nums(&all), nums(&range));
let texts = Texts {
stories: vec![],
fonts: vec![],
defaults: Val::Dict(BTreeMap::new()),
para_defaults: Val::Dict(BTreeMap::new()),
char_sheets: vec![],
frames: vec![read(doc.as_bytes()).unwrap()],
};
texts.frame(0)
}
/// A circle of radius 100 round the origin in four cubics, from its right, closed.
fn circle() -> Vec<[f64; 8]> {
let k = 55.228475;
vec![
[100.0, 0.0, 100.0, k, k, 100.0, 0.0, 100.0],
[0.0, 100.0, -k, 100.0, -100.0, k, -100.0, 0.0],
[-100.0, 0.0, -100.0, -k, -k, -100.0, 0.0, -100.0],
[0.0, -100.0, k, -100.0, 100.0, -k, 100.0, 0.0],
]
}
/// The text object of type `text` on `frame`, and how much of its path its brackets span.
fn on_path(text: &str, frame: FrameKind) -> (TextObject, f64) {
let mut st = story(text, &[0.0], &Para::default());
st.frames = vec![frame];
let node = st.node(NodeId(1), 0, (0.0, 0.0), Affine::IDENTITY).unwrap();
let NodeKind::Text(t) = node.kind else { panic!("not type") };
let (a, b) = t.kind.path_span().unwrap();
(*t, b - a)
}
/// Round a closed path the file writes the end bracket unwrapped, past the last segment (the
/// start plus the run): the type keeps that run, nearly the whole circle here, not the bit
/// from the start to the path's end.
#[test]
fn type_on_a_closed_path_keeps_its_unwrapped_end() {
let Some(FrameKind::OnPath { start, end, .. }) = on_path_frame(&circle(), [3.86426, 7.85426]) else { panic!("on a path") };
assert!((start - 3.86426).abs() < 1e-9 && (end - 3.85426).abs() < 1e-9, "{start} {end}");
let (t, span) = on_path("type", on_path_frame(&circle(), [3.86426, 7.85426]).unwrap());
assert!((span - 0.9975).abs() < 1e-3, "{span}");
assert_eq!(t.plain_text(), "type");
// Wrapped the other way, or below zero, the brackets are the same places.
for range in [[3.86426, 3.85426], [-0.13574, 3.85426]] {
let (_, other) = on_path("type", on_path_frame(&circle(), range).unwrap());
assert!((other - span).abs() < 1e-6, "{range:?}: {other}");
}
// Values that aren't numbers fall back to the start of the path, a full turn.
let Some(FrameKind::OnPath { start, end, .. }) = on_path_frame(&circle(), [f64::NAN, f64::INFINITY]) else { panic!("on a path") };
assert!(start.is_finite() && end.is_finite());
}
/// A range inside the loop is kept as it is, and a run of exactly the loop is a full turn,
/// where a short line of type doesn't overflow.
#[test]
fn type_on_a_closed_path_keeps_a_range_inside_it_and_a_full_turn() {
let (_, half) = on_path("type", on_path_frame(&circle(), [0.5, 2.5]).unwrap());
assert!((half - 0.5).abs() < 1e-3, "{half}");
let (t, full) = on_path("type", on_path_frame(&circle(), [1.0, 5.0]).unwrap());
assert!((full - 1.0).abs() < 1e-9, "{full}");
assert!(!vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t).overflow, "a short line fits a full turn");
}
/// An open path keeps clamping: a range past its end stops at it.
#[test]
fn type_on_an_open_path_clamps_its_range() {
let open: Vec<[f64; 8]> = circle().into_iter().take(2).collect();
let Some(FrameKind::OnPath { start, end, .. }) = on_path_frame(&open, [0.5, 7.0]) else { panic!("on a path") };
assert_eq!((start, end), (0.5, 2.0));
let (_, span) = on_path("type", on_path_frame(&open, [0.5, 7.0]).unwrap());
assert!((span - 0.75).abs() < 1e-3, "{span}");
}
/// A point-type story of `text` whose lines start at the heights `ys` (the layout's own: where
/// the paragraph spacing has put them), every paragraph styled `para`.
fn story(text: &str, ys: &[f64], para: &Para) -> Story {
let size = 13.0;
let paras = text.split_inclusive('\r').map(|p| (p.chars().count(), para.clone())).collect();
Story {
text: text.to_string(),
anchor: (0.0, 0.0),
lines: ys.iter().map(|y| (0.0, *y)).collect(),
frames: vec![FrameKind::Point([1.0, 0.0, 0.0, 1.0, 0.0, 0.0])],
paras,
runs: vec![(
text.chars().count(),
Style {
font: None,
size,
leading: None,
tracking: 0.0,
baseline_shift: 0.0,
h_scale: 1.0,
v_scale: 1.0,
fill: Some(Color::BLACK),
stroke: None,
stroke_width: 1.0,
caps: 0,
tate_chu_yoko: false,
},
)],
path_spacing: 0.0,
vertical: false,
}
}
/// A layout of glyphs `advances` wide round a circle of radius `radius` (y down), from its left,
/// outside it (their feet towards its centre) or inside it, the length of the circle between
/// their centres `fraction` of their advances' mean.
fn round_layout(advances: &[f64], radius: f64, outside: bool, fraction: f64) -> Val {
let sign = if outside { 1.0 } else { -1.0 };
let (mut xs, mut ys, mut matrices, mut ends) = (vec![], vec![], vec![], vec![0.0]);
let mut angle = std::f64::consts::PI;
for (i, a) in advances.iter().enumerate() {
if i > 0 {
angle += sign * (advances[i - 1] + a) * 0.5 * fraction / radius;
}
// Outside, clockwise on the page (y down); inside, the other way round.
let along = (-angle.sin() * sign, angle.cos() * sign);
let centre = (radius * angle.cos(), radius * angle.sin());
xs.push(centre.0 - along.0 * a * 0.5);
ys.push(centre.1 - along.1 * a * 0.5);
matrices.extend([along.0, along.1, -along.1, along.0, 0.0, 0.0]);
ends.push(ends[i] + a);
}
let nums = |v: &[f64]| v.iter().map(|n| format!("{n}")).collect::<Vec<_>>().join(" ");
let doc = format!(
"/0 << /99 /F /6 [ << /99 /L /6 [ << /99 /S /6 [ << /99 /G /21 << /1 [ {} ] /2 [ {} ] /3 [ {} ] /4 [ {} ] >> >> ] >> ] >> ] >>",
nums(&xs),
nums(&ys),
nums(&matrices),
nums(&ends)
);
read(doc.as_bytes()).unwrap().get("0").unwrap().clone()
}
/// The file lays type on a path out closer round the outside of a curve and further apart round
/// the inside: the spacing that does that is read from its layout, as the text engine's model
/// has it (length + turn × spacing = advance).
#[test]
fn the_layout_of_type_on_a_path_gives_its_spacing() {
let advances = [20.0, 30.0, 10.0, 25.0, 20.0];
// Outside a circle of radius 100, 10 above the path: the centres are 100/110 of the advances apart.
let spacing = path_spacing(&round_layout(&advances, 100.0, true, 100.0 / 110.0));
assert!((spacing - 10.0).abs() < 1e-6, "{spacing}");
// Inside it, 20 above the path: 100/80 of them.
let spacing = path_spacing(&round_layout(&advances, 100.0, false, 100.0 / 80.0));
assert!((spacing - 20.0).abs() < 1e-6, "{spacing}");
// At their advances: none.
assert!(path_spacing(&round_layout(&advances, 100.0, true, 1.0)).abs() < 1e-6);
// Corners (here a turn of about four radians from glyph to glyph) aren't taken for a curve.
assert_eq!(path_spacing(&round_layout(&advances, 5.0, true, 1.0)), 0.0);
// A straight line turns nowhere, and a layout without glyphs says nothing.
assert_eq!(path_spacing(&round_layout(&advances, 1e12, true, 0.9)), 0.0);
assert_eq!(path_spacing(&read(b"/99 /F").unwrap()), 0.0);
}
/// The leading of the text object a story comes in as.
fn leading_of(story: &Story) -> Option<f64> {
let node = story.node(NodeId(1), 0, (0.0, 0.0), Affine::IDENTITY)?;
match &node.kind {
NodeKind::Text(t) => t.runs.first().and_then(|r| r.style.leading),
_ => None,
}
}
#[test]
fn leading_leaves_out_the_space_between_paragraphs_that_the_lines_already_have() {
// Lines 10.6 apart that are three paragraphs with 5 less after each: auto leading (15.6) less 5.
let para = Para { space_after: -5.0, ..Para::default() };
let s = story("one\rtwo\rthree\r", &[0.0, 10.6, 21.2], ¶);
assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9);
assert!((leading_of(&s).unwrap() - 15.6).abs() < 1e-9);
// Space after and space before both count; the scale of the frame carries onto the leading.
let para = Para { space_after: 4.0, space_before: 2.0, ..Para::default() };
let s = story("one\rtwo\r", &[0.0, 20.0], ¶);
assert!((s.line_leading(1.0).unwrap() - 14.0).abs() < 1e-9);
assert!((s.line_leading(0.5).unwrap() - 7.0).abs() < 1e-9);
}
/// #2031: a Large Canvas editing copy measures its text document in its art's units, a tenth
/// of the page's: the story's size and leading reach the page through `to_doc`'s scale.
#[test]
fn a_story_in_a_scaled_art_space_keeps_its_size_and_leading() {
let s = story("one\rtwo\r", &[0.0, 20.0], &Para::default());
// A copy written at 1:10 (see `ai::read::ensure_space`): its art's units reach the
// document, 100 points to the page, through `to_doc`'s scale.
let to_doc = Affine::scale(10.0) * Affine::new([1.0, 0.0, 0.0, -1.0, 0.0, 100.0]);
let t = match s.node(NodeId(1), 0, (0.0, 0.0), to_doc).unwrap().kind {
NodeKind::Text(t) => t,
_ => panic!("not text"),
};
assert_eq!(t.runs[0].style.size, 130.0, "13 pt at the page's scale");
assert_eq!(t.runs[0].style.leading, Some(200.0), "a 20-unit line pitch at the page's scale");
}
#[test]
fn leading_between_lines_of_a_paragraph_is_their_distance() {
// A line break inside a paragraph has no paragraph spacing between its lines.
let para = Para { space_after: -5.0, space_before: 3.0, ..Para::default() };
let s = story("one\x03two\x03three\r", &[0.0, 15.6, 31.2], ¶);
assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9);
// Paragraphs without spacing: the distance as it was.
let s = story("one\rtwo\r", &[0.0, 15.6], &Para::default());
assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9);
// Area type whose paragraph wraps: lines and breaks don't pair up, so nothing is taken off.
let para = Para { space_after: -5.0, ..Para::default() };
let s = story("one two three\rfour\r", &[0.0, 15.6, 31.2, 41.8], ¶);
assert!((s.line_leading(1.0).unwrap() - 15.6).abs() < 1e-9);
// One line has no distance to read.
assert_eq!(story("one\r", &[0.0], &Para::default()).line_leading(1.0), None);
}
/// A `\x03` ends a line inside its paragraph: it comes in as a forced line break, and the
/// paragraph's style runs over it to the paragraph's end.
#[test]
fn a_soft_return_is_a_line_break_in_its_paragraph() {
let para = Para { space_before: 4.0, space_after: 2.0, first_indent: 6.0, ..Para::default() };
let mut s = story("A\x03B\rC\r", &[0.0, 15.6, 31.2], ¶);
s.paras[1].1 = Para { left_indent: 3.0, ..para.clone() };
let node = s.node(NodeId(1), 0, (0.0, 0.0), Affine::IDENTITY).unwrap();
let NodeKind::Text(t) = &node.kind else { panic!("not text") };
assert_eq!(t.plain_text(), "A\u{2028}B\nC");
assert_eq!(t.paras.len(), 2, "{:?}", t.paras);
assert_eq!((t.paras[0].first_line_indent, t.paras[0].left_indent, t.paras[0].space_before), (6.0, 0.0, 4.0));
assert_eq!((t.paras[1].first_line_indent, t.paras[1].left_indent), (6.0, 3.0));
}
#[test]
fn a_frame_too_short_for_its_first_line_is_made_taller() {
// A heading in a frame as tall as its size: a line of the font it shows in here is taller.
let s = story("Heading\r", &[0.0], &Para::default());
let area = |height: f64| {
let mut t = TextObject::point(Point::ZERO, "Heading", CharStyle { size: 13.0, ..CharStyle::default() });
t.kind = TextKind::Area { frame: vectorcraft_geom::shapes::rectangle(Rect::new(10.0, 20.0, 210.0, 20.0 + height)) };
t
};
let height =
|t: &TextObject| if let TextKind::Area { frame } = &t.kind { frame.bounds().map(|b| (b.x0, b.y0, b.x1, b.height())) } else { None };
let lines = |t: &TextObject| vectorcraft_text::layout(vectorcraft_text::FontDb::global(), t).lines.len();
let mut t = area(13.0);
assert_eq!(lines(&t), 0, "nothing of it shows");
assert!(s.fit_first_line(&mut t));
let (x0, y0, x1, h) = height(&t).unwrap();
assert!((x0, y0, x1) == (10.0, 20.0, 210.0) && h > 13.0 && h < 26.0, "taller from its top: {h}");
assert_eq!(lines(&t), 1);
// A frame that holds the line stays as it is; so does one the file lays no line out in
// (its type is overset in the file too).
let mut t = area(40.0);
assert!(!s.fit_first_line(&mut t) && height(&t).unwrap().3 == 40.0);
let mut t = area(13.0);
assert!(!story("Heading\r", &[], &Para::default()).fit_first_line(&mut t) && height(&t).unwrap().3 == 13.0);
}
#[test]
fn area_type_s_first_line_goes_where_the_file_lays_it_out() {
// GUARDS: area type's first baseline was the font's ascent below the frame's top, where the
// file's own layout (and its page) can have it higher: a heading came in lower than the page's.
let line = |a: (f64, f64), b: (f64, f64)| [a.0, a.1, a.0, a.1, b.0, b.1, b.0, b.1];
let frame = vec![
line((10.0, 20.0), (210.0, 20.0)),
line((210.0, 20.0), (210.0, 120.0)),
line((210.0, 120.0), (10.0, 120.0)),
line((10.0, 120.0), (10.0, 20.0)),
];
// The canvas is the document here: the art's y up, the document's down.
let (template, to_doc) = ((CANVAS_CENTRE, -CANVAS_CENTRE), Affine::new([1.0, 0.0, 0.0, -1.0, 0.0, 0.0]));
let first = |s: &Story| {
let mut node = s.node(NodeId(0), 0, template, to_doc).unwrap();
let placed = s.place_first_line(&mut node, 0, template, to_doc);
let NodeKind::Text(t) = node.kind else { panic!("area type") };
let l = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t);
(placed, l.lines.first().map(|l| l.baseline), t.area.first_baseline)
};
let mut s = story("Heading\r", &[], &Para::default());
s.frames = vec![FrameKind::Area(frame, AreaFrame::default())];
// Where this lays the line out on its own: the file agrees, and nothing changes.
s.lines = vec![(10.0, 20.0)];
let (_, Some(own), _) = first(&s) else { panic!("a line") };
s.lines = vec![(10.0, own)];
assert_eq!(first(&s), (false, Some(own), vectorcraft_doc::FirstBaseline::Ascent));
// Higher in the file: there.
s.lines = vec![(10.0, own - 3.0)];
let (placed, at, fb) = first(&s);
assert!(placed && fb == vectorcraft_doc::FirstBaseline::Fixed, "{fb:?}");
assert!(at.is_some_and(|y| (y - (own - 3.0)).abs() < 1e-6), "{at:?} for {}", own - 3.0);
}
/// A text document's area frame, the rectangle 10, 20 to 210, 120 of the canvas, whose frame
/// data has `options` besides its kind, written by hand.
fn area_frame(options: &str) -> FrameKind {
let line = |a: (f64, f64), b: (f64, f64)| format!("{} {} {} {} {} {} {} {}", a.0, a.1, a.0, a.1, b.0, b.1, b.0, b.1);
let segments = [
line((10.0, 20.0), (210.0, 20.0)),
line((210.0, 20.0), (210.0, 120.0)),
line((210.0, 120.0), (10.0, 120.0)),
line((10.0, 120.0), (10.0, 20.0)),
];
let doc = format!("/0 << /1 << /0 [ {} ] >> /2 << /0 1 {options} >> >>", segments.join(" "));
let texts = Texts {
stories: vec![],
fonts: vec![],
defaults: Val::Dict(BTreeMap::new()),
para_defaults: Val::Dict(BTreeMap::new()),
char_sheets: vec![],
frames: vec![read(doc.as_bytes()).unwrap()],
};
texts.frame(0).unwrap()
}
/// The area options of the text object a story of `frames` comes in as at frame `frame`, the
/// art's units `scale` document points each.
fn area_of(frames: Vec<FrameKind>, frame: usize, scale: f64) -> vectorcraft_doc::AreaOptions {
let mut s = story("Some area type\r", &[], &Para::default());
s.frames = frames;
let to_doc = Affine::scale(scale) * Affine::new([1.0, 0.0, 0.0, -1.0, 0.0, 0.0]);
let NodeKind::Text(t) = s.node(NodeId(0), frame, (CANVAS_CENTRE, -CANVAS_CENTRE), to_doc).unwrap().kind else { panic!("area type") };
t.area
}
#[test]
fn area_frame_options_are_read() {
// GUARDS: area type came in with one row, one column and the 18 pt gutter whatever its frame kept.
let a = area_of(vec![area_frame("/3 2 /4 3 /7 20 /8 24")], 0, 1.0);
assert_eq!((a.rows, a.columns, a.gutter, a.row_gutter), (2, 3, 24.0, Some(20.0)));
// The same gutter between rows and columns is one gutter.
let a = area_of(vec![area_frame("/3 2 /4 3 /7 20 /8 20")], 0, 1.0);
assert_eq!((a.gutter, a.row_gutter), (20.0, None));
// Lengths scale with the art's units (a Large Canvas copy measures in tenths of the page).
let a = area_of(vec![area_frame("/7 2 /8 2.4 /10 << /0 3 /1 3 >>")], 0, 10.0);
assert!((a.gutter - 24.0).abs() < 1e-9 && a.row_gutter == Some(20.0), "{a:?}");
assert!((a.first_baseline_min - 30.0).abs() < 1e-9, "{a:?}");
}
#[test]
fn area_frame_first_baseline_kinds_and_minimum_are_read() {
use vectorcraft_doc::FirstBaseline as F;
for (code, kind) in [(0, F::Fixed), (2, F::CapHeight), (3, F::Leading), (4, F::XHeight)] {
let a = area_of(vec![area_frame(&format!("/10 << /0 {code} /1 30 >>"))], 0, 2.0);
assert_eq!((a.first_baseline, a.first_baseline_min), (kind, 60.0), "code {code}");
}
// A kind without its own first baseline here, or none known, leaves Ascent.
for code in ["1", "5", "6", "7", "-1", "2.5", "(x)"] {
let a = area_of(vec![area_frame(&format!("/10 << /0 {code} /1 30 >>"))], 0, 1.0);
assert_eq!((a.first_baseline, a.first_baseline_min), (F::Ascent, 0.0), "code {code}");
}
// A minimum that can't be read is none.
let a = area_of(vec![area_frame("/10 << /0 3 /1 -4 >>")], 0, 1.0);
assert_eq!((a.first_baseline, a.first_baseline_min), (F::Leading, 0.0));
}
/// A first baseline the frame keeps stays as it is: the first line isn't moved to where the
/// file lays it out.
#[test]
fn a_first_baseline_the_frame_keeps_is_not_moved() {
let (template, to_doc) = ((CANVAS_CENTRE, -CANVAS_CENTRE), Affine::new([1.0, 0.0, 0.0, -1.0, 0.0, 0.0]));
// Where this lays the first line out on its own.
let mut s = story("Heading\r", &[], &Para::default());
s.frames = vec![area_frame("")];
let NodeKind::Text(t) = s.node(NodeId(0), 0, template, to_doc).unwrap().kind else { panic!("area type") };
let own = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t).lines.first().map(|l| l.baseline).unwrap();
let placed_in = |frames: &[&str]| {
let mut s = story("Heading\r", &[], &Para::default());
s.frames = frames.iter().map(|o| area_frame(o)).collect();
// Higher in the file.
s.lines = vec![(10.0, own - 3.0)];
let mut node = s.node(NodeId(0), 0, template, to_doc).unwrap();
let placed = s.place_first_line(&mut node, 0, template, to_doc);
let NodeKind::Text(t) = node.kind else { panic!("area type") };
(placed, t.area.first_baseline)
};
let placed = |options: &str| placed_in(&[options]);
assert_eq!(placed("/10 << /0 2 /1 0 >>"), (false, vectorcraft_doc::FirstBaseline::CapHeight));
// Without one (Ascent), or with one that isn't read, the line goes where the file has it.
assert_eq!(placed(""), (true, vectorcraft_doc::FirstBaseline::Fixed));
assert_eq!(placed("/10 << /0 5 /1 0 >>"), (true, vectorcraft_doc::FirstBaseline::Fixed));
// Another frame of the thread keeping one doesn't count for the first.
assert_eq!(placed_in(&["", "/10 << /0 2 /1 0 >>"]), (true, vectorcraft_doc::FirstBaseline::Fixed));
}
#[test]
fn area_frame_options_that_cannot_be_read_keep_their_defaults() {
let defaults = vectorcraft_doc::AreaOptions::default();
let bad = [
"/3 0 /4 2.5 /7 -1 /8 (x)",
"/3 NaN /4 inf /7 NaN /8 -inf /10 [ 1 2 ]",
"/3 (2) /4 [ 3 ] /7 << /0 1 >> /8 true /10 3",
"/10 << /1 30 >>",
];
for options in bad {
assert_eq!(area_of(vec![area_frame(options)], 0, 1.0), defaults, "{options}");
}
// Too many rows and columns, and too long gutters, are capped.
let a = area_of(vec![area_frame("/3 1e9 /4 101 /7 1e300 /8 5e4")], 0, 1.0);
assert_eq!((a.rows, a.columns, a.gutter, a.row_gutter), (100, 100, MAX_AREA_LENGTH, None));
// The cap holds after the lengths scale with the art's units.
let a = area_of(vec![area_frame("/7 1e4 /8 2e3 /10 << /0 0 /1 1e4 >>")], 0, 10.0);
assert_eq!((a.gutter, a.row_gutter, a.first_baseline_min), (MAX_AREA_LENGTH, None, MAX_AREA_LENGTH));
// One that can be read is read beside one that can't.
let a = area_of(vec![area_frame("/3 2 /4 -3 /8 12 /7 NaN")], 0, 1.0);
assert_eq!((a.rows, a.columns, a.gutter, a.row_gutter), (2, 1, 12.0, Some(18.0)));
}
#[test]
fn area_frame_without_options_comes_in_as_before() {
assert_eq!(area_of(vec![area_frame("")], 0, 1.0), vectorcraft_doc::AreaOptions::default());
assert_eq!(area_frame(""), FrameKind::Area(area_segments(), AreaFrame::default()));
}
/// The segments [`area_frame`] writes.
fn area_segments() -> Vec<[f64; 8]> {
let line = |a: (f64, f64), b: (f64, f64)| [a.0, a.1, a.0, a.1, b.0, b.1, b.0, b.1];
vec![
line((10.0, 20.0), (210.0, 20.0)),
line((210.0, 20.0), (210.0, 120.0)),
line((210.0, 120.0), (10.0, 120.0)),
line((10.0, 120.0), (10.0, 20.0)),
]
}
#[test]
fn each_frame_of_a_thread_keeps_its_own_options() {
let frames = vec![area_frame("/3 2 /7 10 /8 10 /10 << /0 0 /1 12 >>"), area_frame("/4 3 /7 6 /8 8")];
let (first, second) = (area_of(frames.clone(), 0, 1.0), area_of(frames, 1, 1.0));
assert_eq!((first.rows, first.columns, first.gutter, first.row_gutter), (2, 1, 10.0, None));
assert_eq!((first.first_baseline, first.first_baseline_min), (vectorcraft_doc::FirstBaseline::Fixed, 12.0));
assert_eq!((second.rows, second.columns, second.gutter, second.row_gutter), (1, 3, 8.0, Some(6.0)));
assert_eq!(second.first_baseline, vectorcraft_doc::FirstBaseline::Ascent);
}
/// Vertical area type: the file's first line is its first column's centre line, so far left of
/// the frame's right edge; the column goes there.
#[test]
fn vertical_area_type_s_first_column_goes_where_the_file_lays_it_out() {
let line = |a: (f64, f64), b: (f64, f64)| [a.0, a.1, a.0, a.1, b.0, b.1, b.0, b.1];
let frame = vec![
line((10.0, 20.0), (210.0, 20.0)),
line((210.0, 20.0), (210.0, 120.0)),
line((210.0, 120.0), (10.0, 120.0)),
line((10.0, 120.0), (10.0, 20.0)),
];
let (template, to_doc) = ((CANVAS_CENTRE, -CANVAS_CENTRE), Affine::new([1.0, 0.0, 0.0, -1.0, 0.0, 0.0]));
// Whether the first line was placed, the first column's centre line (its x on the document)
// and the first baseline setting.
let first = |s: &Story, place: bool| {
let mut node = s.node(NodeId(0), 0, template, to_doc).unwrap();
let placed = place && s.place_first_line(&mut node, 0, template, to_doc);
let NodeKind::Text(t) = node.kind else { panic!("area type") };
assert!(t.vertical);
let l = vectorcraft_text::layout(vectorcraft_text::FontDb::global(), &t);
(placed, l.baselines().first().map(|b| b.0.x), t.area.first_baseline)
};
let mut s = story("§§\r", &[], &Para::default());
s.frames = vec![FrameKind::Area(frame, AreaFrame::default())];
s.vertical = true;
s.anchor = (210.0, 20.0);
s.lines = vec![(0.0, 0.0)];
let (_, Some(own), _) = first(&s, false) else { panic!("a column") };
assert!(own < 210.0 && own > 190.0, "near the right edge: {own}");
// The file's column where this lays it out on its own (so far left of the anchor, the
// frame's top right): nothing changes.
s.lines = vec![(0.0, 210.0 - own)];
assert_eq!(first(&s, true), (false, Some(own), vectorcraft_doc::FirstBaseline::Ascent));
// Further right in the file: there.
s.lines = vec![(0.0, 210.0 - own - 3.0)];
let (placed, at, fb) = first(&s, true);
assert!(placed && fb == vectorcraft_doc::FirstBaseline::Fixed, "{fb:?}");
assert!(at.is_some_and(|x| (x - (own + 3.0)).abs() < 1e-6), "{at:?} for {}", own + 3.0);
// Scaled characters (a column of another width) go there too.
s.runs[0].1.v_scale = 2.0;
s.runs[0].1.h_scale = 2.0;
s.lines = vec![(0.0, 0.0)];
let (_, Some(own), _) = first(&s, false) else { panic!("a column") };
s.lines = vec![(0.0, 210.0 - own - 3.0)];
let (placed, at, _) = first(&s, true);
assert!(placed && at.is_some_and(|x| (x - (own + 3.0)).abs() < 1e-6), "{at:?} for {}", own + 3.0);
}
}