Widow and orphan prevention

This commit is contained in:
Laurenz 2022-11-28 17:57:16 +01:00
parent 989d170dc7
commit 836692e73c
15 changed files with 243 additions and 170 deletions

View File

@ -71,6 +71,9 @@ impl BlockNode {
/// The spacing between this and the following block. /// The spacing between this and the following block.
#[property(skip)] #[property(skip)]
pub const BELOW: VNode = VNode::block_spacing(Em::new(1.2).into()); pub const BELOW: VNode = VNode::block_spacing(Em::new(1.2).into());
/// Whether this block must stick to the following one.
#[property(skip)]
pub const STICKY: bool = false;
fn construct(_: &Vm, args: &mut Args) -> SourceResult<Content> { fn construct(_: &Vm, args: &mut Args) -> SourceResult<Content> {
Ok(Self(args.eat()?.unwrap_or_default()).pack()) Ok(Self(args.eat()?.unwrap_or_default()).pack())

View File

@ -1,6 +1,6 @@
use typst::model::{Property, Style}; use typst::model::Style;
use super::{AlignNode, ColbreakNode, PlaceNode, Spacing, VNode}; use super::{AlignNode, BlockNode, ColbreakNode, PlaceNode, Spacing, VNode};
use crate::prelude::*; use crate::prelude::*;
use crate::text::ParNode; use crate::text::ParNode;
@ -9,10 +9,14 @@ use crate::text::ParNode;
/// This node is reponsible for layouting both the top-level content flow and /// This node is reponsible for layouting both the top-level content flow and
/// the contents of boxes. /// the contents of boxes.
#[derive(Hash)] #[derive(Hash)]
pub struct FlowNode(pub StyleVec<Content>); pub struct FlowNode(pub StyleVec<Content>, pub bool);
#[node(Layout)] #[node(Layout)]
impl FlowNode {} impl FlowNode {
fn construct(_: &Vm, args: &mut Args) -> SourceResult<Content> {
Ok(BlockNode(args.expect("body")?).pack())
}
}
impl Layout for FlowNode { impl Layout for FlowNode {
fn layout( fn layout(
@ -21,16 +25,20 @@ impl Layout for FlowNode {
styles: StyleChain, styles: StyleChain,
regions: &Regions, regions: &Regions,
) -> SourceResult<Fragment> { ) -> SourceResult<Fragment> {
let mut layouter = FlowLayouter::new(regions); let mut layouter = FlowLayouter::new(regions, self.1);
for (child, map) in self.0.iter() { for (child, map) in self.0.iter() {
let styles = styles.chain(&map); let styles = styles.chain(&map);
if let Some(&node) = child.to::<VNode>() { if let Some(&node) = child.to::<VNode>() {
layouter.layout_spacing(node.amount, styles); layouter.layout_spacing(node.amount, styles);
} else if let Some(node) = child.to::<ParNode>() {
let barrier = Style::Barrier(child.id());
let styles = styles.chain_one(&barrier);
layouter.layout_par(world, node, styles)?;
} else if child.has::<dyn Layout>() { } else if child.has::<dyn Layout>() {
layouter.layout_block(world, child, styles)?; layouter.layout_block(world, child, styles)?;
} else if child.is::<ColbreakNode>() { } else if child.is::<ColbreakNode>() {
layouter.finish_region(); layouter.finish_region(false);
} else { } else {
panic!("unexpected flow child: {child:?}"); panic!("unexpected flow child: {child:?}");
} }
@ -49,6 +57,8 @@ impl Debug for FlowNode {
/// Performs flow layout. /// Performs flow layout.
struct FlowLayouter { struct FlowLayouter {
/// Whether this is a root page-level flow.
root: bool,
/// The regions to layout children into. /// The regions to layout children into.
regions: Regions, regions: Regions,
/// Whether the flow should expand to fill the region. /// Whether the flow should expand to fill the region.
@ -56,12 +66,8 @@ struct FlowLayouter {
/// The full size of `regions.size` that was available before we started /// The full size of `regions.size` that was available before we started
/// subtracting. /// subtracting.
full: Size, full: Size,
/// The size used by the frames for the current region.
used: Size,
/// The sum of fractions in the current region.
fr: Fr,
/// Whether the last block was a paragraph. /// Whether the last block was a paragraph.
last_block_was_par: bool, last_was_par: bool,
/// Spacing and layouted blocks. /// Spacing and layouted blocks.
items: Vec<FlowItem>, items: Vec<FlowItem>,
/// Finished frames for previous regions. /// Finished frames for previous regions.
@ -69,20 +75,23 @@ struct FlowLayouter {
} }
/// A prepared item in a flow layout. /// A prepared item in a flow layout.
#[derive(Debug)]
enum FlowItem { enum FlowItem {
/// Absolute spacing between other items. /// Absolute spacing between other items.
Absolute(Abs), Absolute(Abs),
/// Leading between paragraph lines.
Leading(Abs),
/// Fractional spacing between other items. /// Fractional spacing between other items.
Fractional(Fr), Fractional(Fr),
/// A frame for a layouted block and how to align it. /// A frame for a layouted block and how to align it.
Frame(Frame, Axes<Align>), Frame(Frame, Axes<Align>, bool),
/// An absolutely placed frame. /// An absolutely placed frame.
Placed(Frame), Placed(Frame),
} }
impl FlowLayouter { impl FlowLayouter {
/// Create a new flow layouter. /// Create a new flow layouter.
fn new(regions: &Regions) -> Self { fn new(regions: &Regions, root: bool) -> Self {
let expand = regions.expand; let expand = regions.expand;
let full = regions.first; let full = regions.first;
@ -91,33 +100,53 @@ impl FlowLayouter {
regions.expand.y = false; regions.expand.y = false;
Self { Self {
root,
regions, regions,
expand, expand,
full, full,
used: Size::zero(), last_was_par: false,
fr: Fr::zero(),
last_block_was_par: false,
items: vec![], items: vec![],
finished: vec![], finished: vec![],
} }
} }
/// Actually layout the spacing. /// Layout vertical spacing.
fn layout_spacing(&mut self, spacing: Spacing, styles: StyleChain) { fn layout_spacing(&mut self, spacing: Spacing, styles: StyleChain) {
match spacing { self.layout_item(match spacing {
Spacing::Relative(v) => { Spacing::Relative(v) => {
// Resolve the spacing and limit it to the remaining space. FlowItem::Absolute(v.resolve(styles).relative_to(self.full.y))
let resolved = v.resolve(styles).relative_to(self.full.y);
let limited = resolved.min(self.regions.first.y);
self.regions.first.y -= limited;
self.used.y += limited;
self.items.push(FlowItem::Absolute(resolved));
} }
Spacing::Fractional(v) => { Spacing::Fractional(v) => FlowItem::Fractional(v),
self.items.push(FlowItem::Fractional(v)); });
self.fr += v; }
/// Layout a paragraph.
fn layout_par(
&mut self,
world: Tracked<dyn World>,
par: &ParNode,
styles: StyleChain,
) -> SourceResult<()> {
let aligns = Axes::new(styles.get(ParNode::ALIGN), Align::Top);
let leading = styles.get(ParNode::LEADING);
let consecutive = self.last_was_par;
let fragment = par.layout(world, styles, &self.regions, consecutive)?;
let len = fragment.len();
for (i, frame) in fragment.into_iter().enumerate() {
if i > 0 {
self.layout_item(FlowItem::Leading(leading));
} }
// Prevent widows and orphans.
let border = (i == 0 && len >= 2) || i + 2 == len;
let sticky = self.root && !frame.is_empty() && border;
self.layout_item(FlowItem::Frame(frame, aligns, sticky));
} }
self.last_was_par = true;
Ok(())
} }
/// Layout a block. /// Layout a block.
@ -127,17 +156,12 @@ impl FlowLayouter {
block: &Content, block: &Content,
styles: StyleChain, styles: StyleChain,
) -> SourceResult<()> { ) -> SourceResult<()> {
// Don't even try layouting into a full region.
if self.regions.is_full() {
self.finish_region();
}
// Placed nodes that are out of flow produce placed items which aren't // Placed nodes that are out of flow produce placed items which aren't
// aligned later. // aligned later.
if let Some(placed) = block.to::<PlaceNode>() { if let Some(placed) = block.to::<PlaceNode>() {
if placed.out_of_flow() { if placed.out_of_flow() {
let frame = block.layout(world, styles, &self.regions)?.into_frame(); let frame = block.layout(world, styles, &self.regions)?.into_frame();
self.items.push(FlowItem::Placed(frame)); self.layout_item(FlowItem::Placed(frame));
return Ok(()); return Ok(());
} }
} }
@ -155,47 +179,87 @@ impl FlowLayouter {
.unwrap_or(Align::Top), .unwrap_or(Align::Top),
); );
// Disable paragraph indent if this is not a consecutive paragraph.
let reset;
let is_par = block.is::<ParNode>();
let mut chained = styles;
if !self.last_block_was_par && is_par && !styles.get(ParNode::INDENT).is_zero() {
let property = Property::new(ParNode::INDENT, Length::zero());
reset = Style::Property(property);
chained = styles.chain_one(&reset);
}
// Layout the block itself. // Layout the block itself.
let fragment = block.layout(world, chained, &self.regions)?; let sticky = styles.get(BlockNode::STICKY);
let len = fragment.len(); let fragment = block.layout(world, styles, &self.regions)?;
for (i, frame) in fragment.into_iter().enumerate() { for frame in fragment {
// Grow our size, shrink the region and save the frame for later. self.layout_item(FlowItem::Frame(frame, aligns, sticky));
let size = frame.size();
self.used.y += size.y;
self.used.x.set_max(size.x);
self.regions.first.y -= size.y;
self.items.push(FlowItem::Frame(frame, aligns));
if i + 1 < len {
self.finish_region();
}
} }
self.last_block_was_par = is_par; self.last_was_par = false;
Ok(()) Ok(())
} }
/// Layout a finished frame.
fn layout_item(&mut self, item: FlowItem) {
match item {
FlowItem::Absolute(v) | FlowItem::Leading(v) => self.regions.first.y -= v,
FlowItem::Fractional(_) => {}
FlowItem::Frame(ref frame, ..) => {
let size = frame.size();
if !self.regions.first.y.fits(size.y)
&& !self.regions.in_last()
&& self.items.iter().any(|item| !matches!(item, FlowItem::Leading(_)))
{
self.finish_region(true);
}
self.regions.first.y -= size.y;
}
FlowItem::Placed(_) => {}
}
self.items.push(item);
}
/// Finish the frame for one region. /// Finish the frame for one region.
fn finish_region(&mut self) { fn finish_region(&mut self, something_follows: bool) {
let mut end = self.items.len();
if something_follows {
for (i, item) in self.items.iter().enumerate().rev() {
match *item {
FlowItem::Absolute(_)
| FlowItem::Leading(_)
| FlowItem::Fractional(_) => {}
FlowItem::Frame(.., true) => end = i,
_ => break,
}
}
if end == 0 {
return;
}
}
let carry: Vec<_> = self.items.drain(end..).collect();
while let Some(FlowItem::Leading(_)) = self.items.last() {
self.items.pop();
}
let mut fr = Fr::zero();
let mut used = Size::zero();
for item in &self.items {
match *item {
FlowItem::Absolute(v) | FlowItem::Leading(v) => used.y += v,
FlowItem::Fractional(v) => fr += v,
FlowItem::Frame(ref frame, ..) => {
let size = frame.size();
used.y += size.y;
used.x.set_max(size.x);
}
FlowItem::Placed(_) => {}
}
}
// Determine the size of the flow in this region dependening on whether // Determine the size of the flow in this region dependening on whether
// the region expands. // the region expands.
let mut size = self.expand.select(self.full, self.used); let mut size = self.expand.select(self.full, used);
// Account for fractional spacing in the size calculation. // Account for fractional spacing in the size calculation.
let remaining = self.full.y - self.used.y; let remaining = self.full.y - used.y;
if self.fr.get() > 0.0 && self.full.y.is_finite() { if fr.get() > 0.0 && self.full.y.is_finite() {
self.used.y = self.full.y; used.y = self.full.y;
size.y = self.full.y; size.y = self.full.y;
} }
@ -206,16 +270,16 @@ impl FlowLayouter {
// Place all frames. // Place all frames.
for item in self.items.drain(..) { for item in self.items.drain(..) {
match item { match item {
FlowItem::Absolute(v) => { FlowItem::Absolute(v) | FlowItem::Leading(v) => {
offset += v; offset += v;
} }
FlowItem::Fractional(v) => { FlowItem::Fractional(v) => {
offset += v.share(self.fr, remaining); offset += v.share(fr, remaining);
} }
FlowItem::Frame(frame, aligns) => { FlowItem::Frame(frame, aligns, _) => {
ruler = ruler.max(aligns.y); ruler = ruler.max(aligns.y);
let x = aligns.x.position(size.x - frame.width()); let x = aligns.x.position(size.x - frame.width());
let y = offset + ruler.position(size.y - self.used.y); let y = offset + ruler.position(size.y - used.y);
let pos = Point::new(x, y); let pos = Point::new(x, y);
offset += frame.height(); offset += frame.height();
output.push_frame(pos, frame); output.push_frame(pos, frame);
@ -227,22 +291,24 @@ impl FlowLayouter {
} }
// Advance to the next region. // Advance to the next region.
self.finished.push(output);
self.regions.next(); self.regions.next();
self.full = self.regions.first; self.full = self.regions.first;
self.used = Size::zero();
self.fr = Fr::zero(); for item in carry {
self.finished.push(output); self.layout_item(item);
}
} }
/// Finish layouting and return the resulting fragment. /// Finish layouting and return the resulting fragment.
fn finish(mut self) -> Fragment { fn finish(mut self) -> Fragment {
if self.expand.y { if self.expand.y {
while !self.regions.backlog.is_empty() { while !self.regions.backlog.is_empty() {
self.finish_region(); self.finish_region(false);
} }
} }
self.finish_region(); self.finish_region(false);
Fragment::frames(self.finished) Fragment::frames(self.finished)
} }
} }

View File

@ -227,7 +227,7 @@ fn realize_block<'a>(
builder.accept(content, styles)?; builder.accept(content, styles)?;
builder.interrupt_par()?; builder.interrupt_par()?;
let (children, shared) = builder.flow.0.finish(); let (children, shared) = builder.flow.0.finish();
Ok((FlowNode(children).pack(), shared)) Ok((FlowNode(children, false).pack(), shared))
} }
/// Builds a document or a flow node from content. /// Builds a document or a flow node from content.
@ -400,10 +400,10 @@ impl<'a> Builder<'a> {
self.interrupt_par()?; self.interrupt_par()?;
let Some(doc) = &mut self.doc else { return Ok(()) }; let Some(doc) = &mut self.doc else { return Ok(()) };
if !self.flow.0.is_empty() || (doc.keep_next && styles.is_some()) { if !self.flow.0.is_empty() || (doc.keep_next && styles.is_some()) {
let (flow, shared) = mem::take(&mut self.flow).finish(); let (flow, shared) = mem::take(&mut self.flow).0.finish();
let styles = let styles =
if shared == StyleChain::default() { styles.unwrap() } else { shared }; if shared == StyleChain::default() { styles.unwrap() } else { shared };
let page = PageNode(flow).pack(); let page = PageNode(FlowNode(flow, true).pack()).pack();
let stored = self.scratch.content.alloc(page); let stored = self.scratch.content.alloc(page);
self.accept(stored, styles)?; self.accept(stored, styles)?;
} }
@ -461,7 +461,7 @@ impl<'a> FlowBuilder<'a> {
return true; return true;
} }
if content.has::<dyn Layout>() { if content.has::<dyn Layout>() || content.is::<ParNode>() {
let is_tight_list = if let Some(node) = content.to::<ListNode>() { let is_tight_list = if let Some(node) = content.to::<ListNode>() {
node.tight node.tight
} else if let Some(node) = content.to::<EnumNode>() { } else if let Some(node) = content.to::<EnumNode>() {
@ -488,11 +488,6 @@ impl<'a> FlowBuilder<'a> {
false false
} }
fn finish(self) -> (Content, StyleChain<'a>) {
let (flow, shared) = self.0.finish();
(FlowNode(flow).pack(), shared)
}
} }
/// Accepts paragraph content. /// Accepts paragraph content.

View File

@ -56,6 +56,7 @@ impl Finalize for HeadingNode {
map.set(TextNode::WEIGHT, FontWeight::BOLD); map.set(TextNode::WEIGHT, FontWeight::BOLD);
map.set(BlockNode::ABOVE, VNode::block_around(above.into())); map.set(BlockNode::ABOVE, VNode::block_around(above.into()));
map.set(BlockNode::BELOW, VNode::block_around(below.into())); map.set(BlockNode::BELOW, VNode::block_around(below.into()));
map.set(BlockNode::STICKY, true);
realized.styled_with_map(map) realized.styled_with_map(map)
} }
} }

View File

@ -15,7 +15,7 @@ use crate::prelude::*;
#[derive(Hash)] #[derive(Hash)]
pub struct ParNode(pub StyleVec<Content>); pub struct ParNode(pub StyleVec<Content>);
#[node(Layout)] #[node]
impl ParNode { impl ParNode {
/// The indent the first line of a consecutive paragraph should have. /// The indent the first line of a consecutive paragraph should have.
#[property(resolve)] #[property(resolve)]
@ -33,7 +33,7 @@ impl ParNode {
fn construct(_: &Vm, args: &mut Args) -> SourceResult<Content> { fn construct(_: &Vm, args: &mut Args) -> SourceResult<Content> {
// The paragraph constructor is special: It doesn't create a paragraph // The paragraph constructor is special: It doesn't create a paragraph
// node. Instead, it just ensures that the passed content lives is in a // node. Instead, it just ensures that the passed content lives in a
// separate paragraph and styles it. // separate paragraph and styles it.
Ok(Content::sequence(vec![ Ok(Content::sequence(vec![
ParbreakNode.pack(), ParbreakNode.pack(),
@ -43,15 +43,18 @@ impl ParNode {
} }
} }
impl Layout for ParNode { impl ParNode {
fn layout( /// Layout the paragraph into a collection of lines.
#[comemo::memoize]
pub fn layout(
&self, &self,
world: Tracked<dyn World>, world: Tracked<dyn World>,
styles: StyleChain, styles: StyleChain,
regions: &Regions, regions: &Regions,
consecutive: bool,
) -> SourceResult<Fragment> { ) -> SourceResult<Fragment> {
// Collect all text into one string for BiDi analysis. // Collect all text into one string for BiDi analysis.
let (text, segments) = collect(self, &styles); let (text, segments) = collect(self, &styles, consecutive);
// Perform BiDi analysis and then prepare paragraph layout by building a // Perform BiDi analysis and then prepare paragraph layout by building a
// representation on which we can do line breaking without layouting // representation on which we can do line breaking without layouting
@ -62,7 +65,7 @@ impl Layout for ParNode {
let lines = linebreak(&p, regions.first.x); let lines = linebreak(&p, regions.first.x);
// Stack the lines into one frame per region. // Stack the lines into one frame per region.
stack(&p, &lines, regions) finalize(&p, &lines, regions)
} }
} }
@ -177,8 +180,6 @@ struct Preparation<'a> {
hyphenate: Option<bool>, hyphenate: Option<bool>,
/// The text language if it's the same for all children. /// The text language if it's the same for all children.
lang: Option<Lang>, lang: Option<Lang>,
/// The resolved leading between lines.
leading: Abs,
/// The paragraph's resolved alignment. /// The paragraph's resolved alignment.
align: Align, align: Align,
/// Whether to justify the paragraph. /// Whether to justify the paragraph.
@ -393,30 +394,33 @@ impl<'a> Line<'a> {
fn collect<'a>( fn collect<'a>(
par: &'a ParNode, par: &'a ParNode,
styles: &'a StyleChain<'a>, styles: &'a StyleChain<'a>,
consecutive: bool,
) -> (String, Vec<(Segment<'a>, StyleChain<'a>)>) { ) -> (String, Vec<(Segment<'a>, StyleChain<'a>)>) {
let mut full = String::new(); let mut full = String::new();
let mut quoter = Quoter::new(); let mut quoter = Quoter::new();
let mut segments = vec![]; let mut segments = vec![];
let mut iter = par.0.iter().peekable(); let mut iter = par.0.iter().peekable();
let indent = styles.get(ParNode::INDENT); if consecutive {
if !indent.is_zero() let indent = styles.get(ParNode::INDENT);
&& par if !indent.is_zero()
.0 && par
.items() .0
.find_map(|child| { .items()
if child.is::<TextNode>() || child.is::<SmartQuoteNode>() { .find_map(|child| {
Some(true) if child.is::<TextNode>() || child.is::<SmartQuoteNode>() {
} else if child.has::<dyn Inline>() { Some(true)
Some(false) } else if child.has::<dyn Inline>() {
} else { Some(false)
None } else {
} None
}) }
.unwrap_or_default() })
{ .unwrap_or_default()
full.push(SPACING_REPLACE); {
segments.push((Segment::Spacing(indent.into()), *styles)); full.push(SPACING_REPLACE);
segments.push((Segment::Spacing(indent.into()), *styles));
}
} }
while let Some((child, map)) = iter.next() { while let Some((child, map)) = iter.next() {
@ -549,7 +553,6 @@ fn prepare<'a>(
styles, styles,
hyphenate: shared_get(styles, &par.0, TextNode::HYPHENATE), hyphenate: shared_get(styles, &par.0, TextNode::HYPHENATE),
lang: shared_get(styles, &par.0, TextNode::LANG), lang: shared_get(styles, &par.0, TextNode::LANG),
leading: styles.get(ParNode::LEADING),
align: styles.get(ParNode::ALIGN), align: styles.get(ParNode::ALIGN),
justify: styles.get(ParNode::JUSTIFY), justify: styles.get(ParNode::JUSTIFY),
}) })
@ -1013,7 +1016,11 @@ fn line<'a>(
} }
/// Combine layouted lines into one frame per region. /// Combine layouted lines into one frame per region.
fn stack(p: &Preparation, lines: &[Line], regions: &Regions) -> SourceResult<Fragment> { fn finalize(
p: &Preparation,
lines: &[Line],
regions: &Regions,
) -> SourceResult<Fragment> {
// Determine the paragraph's width: Full width of the region if we // Determine the paragraph's width: Full width of the region if we
// should expand or there's fractional spacing, fit-to-width otherwise. // should expand or there's fractional spacing, fit-to-width otherwise.
let mut width = regions.first.x; let mut width = regions.first.x;
@ -1021,47 +1028,16 @@ fn stack(p: &Preparation, lines: &[Line], regions: &Regions) -> SourceResult<Fra
width = lines.iter().map(|line| line.width).max().unwrap_or_default(); width = lines.iter().map(|line| line.width).max().unwrap_or_default();
} }
// State for final frame building.
let mut regions = regions.clone();
let mut finished = vec![];
let mut first = true;
let mut output = Frame::new(Size::with_x(width));
// Stack the lines into one frame per region. // Stack the lines into one frame per region.
for line in lines { lines
let frame = commit(p, line, &regions, width)?; .iter()
let height = frame.size().y; .map(|line| commit(p, line, regions.base, width))
.collect::<SourceResult<_>>()
while !regions.first.y.fits(height) && !regions.in_last() { .map(Fragment::frames)
finished.push(output);
output = Frame::new(Size::with_x(width));
regions.next();
first = true;
}
if !first {
output.size_mut().y += p.leading;
}
let pos = Point::with_y(output.height());
output.size_mut().y += height;
output.push_frame(pos, frame);
regions.first.y -= height + p.leading;
first = false;
}
finished.push(output);
Ok(Fragment::frames(finished))
} }
/// Commit to a line and build its frame. /// Commit to a line and build its frame.
fn commit( fn commit(p: &Preparation, line: &Line, base: Size, width: Abs) -> SourceResult<Frame> {
p: &Preparation,
line: &Line,
regions: &Regions,
width: Abs,
) -> SourceResult<Frame> {
let mut remaining = width - line.width; let mut remaining = width - line.width;
let mut offset = Abs::zero(); let mut offset = Abs::zero();
@ -1137,8 +1113,8 @@ fn commit(
Item::Repeat(repeat, styles) => { Item::Repeat(repeat, styles) => {
let before = offset; let before = offset;
let fill = Fr::one().share(fr, remaining); let fill = Fr::one().share(fr, remaining);
let size = Size::new(fill, regions.base.y); let size = Size::new(fill, base.y);
let pod = Regions::one(size, regions.base, Axes::new(false, false)); let pod = Regions::one(size, base, Axes::new(false, false));
let frame = repeat.layout(p.world, *styles, &pod)?.into_frame(); let frame = repeat.layout(p.world, *styles, &pod)?.into_frame();
let width = frame.width(); let width = frame.width();
let count = (fill / width).floor(); let count = (fill / width).floor();

View File

@ -32,7 +32,7 @@ pub struct Metadata {
} }
/// A partial layout result. /// A partial layout result.
#[derive(Debug, Clone, Eq, PartialEq)] #[derive(Clone, Eq, PartialEq)]
pub struct Fragment(Vec<Frame>); pub struct Fragment(Vec<Frame>);
impl Fragment { impl Fragment {
@ -60,6 +60,11 @@ impl Fragment {
self.0.into_iter().next().unwrap() self.0.into_iter().next().unwrap()
} }
/// Extract the frames.
pub fn into_frames(self) -> Vec<Frame> {
self.0
}
/// Iterate over the contained frames. /// Iterate over the contained frames.
pub fn iter(&self) -> std::slice::Iter<Frame> { pub fn iter(&self) -> std::slice::Iter<Frame> {
self.0.iter() self.0.iter()
@ -71,6 +76,15 @@ impl Fragment {
} }
} }
impl Debug for Fragment {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
match self.0.as_slice() {
[frame] => frame.fmt(f),
frames => frames.fmt(f),
}
}
}
impl IntoIterator for Fragment { impl IntoIterator for Fragment {
type Item = Frame; type Item = Frame;
type IntoIter = std::vec::IntoIter<Frame>; type IntoIter = std::vec::IntoIter<Frame>;
@ -121,6 +135,11 @@ impl Frame {
Self { size, baseline: None, elements: Arc::new(vec![]) } Self { size, baseline: None, elements: Arc::new(vec![]) }
} }
/// Whether the frame contains no elements.
pub fn is_empty(&self) -> bool {
self.elements.is_empty()
}
/// The size of the frame. /// The size of the frame.
pub fn size(&self) -> Size { pub fn size(&self) -> Size {
self.size self.size

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

View File

@ -38,7 +38,7 @@
--- ---
// Does not fit to remaining height of page. // Does not fit to remaining height of page.
#set page(height: 60pt) #set page(height: 60pt)
Stuff \ Stuff #parbreak()
Stuff Stuff
#image("/res/rhino.png") #image("/res/rhino.png")

View File

@ -36,7 +36,7 @@
--- ---
// Test square that is overflowing due to its aspect ratio. // Test square that is overflowing due to its aspect ratio.
#set page(width: 40pt, height: 20pt, margin: 5pt) #set page(width: 40pt, height: 20pt, margin: 5pt)
#square(width: 100%) #square(width: 100%) #parbreak()
#square(width: 100%)[Hello] #square(width: 100%)[Hello]
--- ---

View File

@ -52,8 +52,8 @@ a page for a test but it does get the job done.
#set page(height: 3.25cm, width: 7.05cm, columns: 3) #set page(height: 3.25cm, width: 7.05cm, columns: 3)
#set columns(gutter: 30pt) #set columns(gutter: 30pt)
#rect(width: 100%, height: 2.5cm, fill: conifer) #rect(width: 100%, height: 2.5cm, fill: conifer) #parbreak()
#rect(width: 100%, height: 2cm, fill: eastern) #rect(width: 100%, height: 2cm, fill: eastern) #parbreak()
#circle(fill: eastern) #circle(fill: eastern)
--- ---

View File

@ -59,21 +59,3 @@
[rofl], [rofl],
[E\ ]*4, [E\ ]*4,
) )
---
// Test partition of `fr` units before and after multi-region layout.
#set page(width: 5cm, height: 4cm)
#grid(
columns: 2 * (1fr,),
rows: (1fr, 2fr, auto, 1fr, 1cm),
row-gutter: 10pt,
rect(fill: rgb("ff0000"))[No height],
[foo],
rect(fill: rgb("fc0030"))[Still no height],
[bar],
[The nature of being itself is in question. Am I One? What is being alive?],
[baz],
[The answer],
[42],
[Other text of interest],
)

View File

@ -0,0 +1,8 @@
// Test that a heading doesn't become an orphan.
---
#set page(height: 100pt)
#lorem(12)
= Introduction
This is the start and it goes on.

View File

@ -0,0 +1,23 @@
// Test widow and orphan prevention.
---
#set page("a8", height: 150pt)
#set text(weight: 700)
// Fits fully onto the first page.
#set text(blue)
#lorem(27)
// The first line would fit, but is moved to the second page.
#lorem(20)
// The second-to-last line is moved to the third page so that the last is isn't
// as lonely.
#set text(maroon)
#lorem(11)
#lorem(13)
// All three lines go to the next page.
#set text(olive)
#lorem(10)