Packages

Print-quality PDF from Markdown + Elixir, powered by Typst

Current section

Files

Jump to
folio vendor typst crates typst-layout src math fragment.rs
Raw

vendor/typst/crates/typst-layout/src/math/fragment.rs

use std::fmt::{self, Debug, Formatter};
use comemo::Tracked;
use ttf_parser::GlyphId;
use ttf_parser::math::{GlyphAssembly, GlyphConstruction, GlyphPart};
use typst_library::World;
use typst_library::diag::warning;
use typst_library::engine::Engine;
use typst_library::foundations::StyleChain;
use typst_library::introspection::Tag;
use typst_library::layout::{
Abs, Axes, Axis, Corner, Em, Frame, FrameItem, Point, Size, VAlignment,
};
use typst_library::math::ir::MathProperties;
use typst_library::math::{EquationElem, MathSize, families};
use typst_library::text::{Font, Glyph, TextElem, TextItem, features, language, variant};
use typst_library::visualize::{FixedStroke, Paint};
use typst_syntax::Span;
use typst_utils::{Get, default_math_class};
use unicode_math_class::MathClass;
use super::MathContext;
use super::shaping::shape;
use crate::modifiers::{FrameModifiers, FrameModify};
/// Maximum number of times extenders can be repeated.
const MAX_REPEATS: usize = 1024;
#[derive(Debug, Clone)]
pub enum MathFragment {
Glyph(GlyphFragment),
Frame(FrameFragment),
Space(Abs),
Tag(Tag),
}
impl MathFragment {
pub fn size(&self) -> Size {
match self {
Self::Glyph(glyph) => glyph.size,
Self::Frame(fragment) => fragment.frame.size(),
Self::Space(amount) => Size::with_x(*amount),
_ => Size::zero(),
}
}
pub fn width(&self) -> Abs {
match self {
Self::Glyph(glyph) => glyph.size.x,
Self::Frame(fragment) => fragment.frame.width(),
Self::Space(amount) => *amount,
_ => Abs::zero(),
}
}
pub fn height(&self) -> Abs {
match self {
Self::Glyph(glyph) => glyph.size.y,
Self::Frame(fragment) => fragment.frame.height(),
_ => Abs::zero(),
}
}
pub fn ascent(&self) -> Abs {
match self {
Self::Glyph(glyph) => glyph.ascent(),
Self::Frame(fragment) => fragment.frame.ascent(),
_ => Abs::zero(),
}
}
pub fn descent(&self) -> Abs {
match self {
Self::Glyph(glyph) => glyph.descent(),
Self::Frame(fragment) => fragment.frame.descent(),
_ => Abs::zero(),
}
}
pub fn stroke(&self) -> Option<FixedStroke> {
match self {
Self::Glyph(glyph) => glyph.item.stroke.clone(),
_ => None,
}
}
pub fn base_ascent(&self) -> Abs {
match self {
Self::Frame(fragment) => fragment.base_ascent,
_ => self.ascent(),
}
}
pub fn base_descent(&self) -> Abs {
match self {
Self::Frame(fragment) => fragment.base_descent,
_ => self.descent(),
}
}
pub fn class(&self) -> MathClass {
match self {
Self::Glyph(glyph) => glyph.class,
Self::Frame(fragment) => fragment.class,
Self::Space(_) => MathClass::Space,
Self::Tag(_) => MathClass::Special,
}
}
pub fn math_size(&self) -> Option<MathSize> {
match self {
Self::Glyph(glyph) => Some(glyph.math_size),
Self::Frame(fragment) => Some(fragment.math_size),
_ => None,
}
}
#[inline]
pub fn font(&self, ctx: &MathContext, styles: StyleChain) -> (Font, Abs) {
(
match self {
Self::Glyph(glyph) => glyph.item.font.clone(),
_ => ctx.font().clone(),
},
self.font_size().unwrap_or_else(|| styles.resolve(TextElem::size)),
)
}
fn font_size(&self) -> Option<Abs> {
match self {
Self::Glyph(glyph) => Some(glyph.item.size),
Self::Frame(fragment) => Some(fragment.font_size),
_ => None,
}
}
pub fn is_text_like(&self) -> bool {
match self {
Self::Glyph(glyph) => !glyph.extended_shape,
MathFragment::Frame(frame) => frame.text_like,
_ => false,
}
}
pub fn italics_correction(&self) -> Abs {
match self {
Self::Glyph(glyph) => glyph.italics_correction,
Self::Frame(fragment) => fragment.italics_correction,
_ => Abs::zero(),
}
}
pub fn accent_attach(&self) -> (Abs, Abs) {
match self {
Self::Glyph(glyph) => glyph.accent_attach,
Self::Frame(fragment) => fragment.accent_attach,
_ => (self.width() / 2.0, self.width() / 2.0),
}
}
pub fn into_frame(self) -> Frame {
match self {
Self::Glyph(glyph) => glyph.into_frame(),
Self::Frame(fragment) => fragment.frame,
Self::Tag(tag) => {
let mut frame = Frame::soft(Size::zero());
frame.push(Point::zero(), FrameItem::Tag(tag));
frame
}
_ => Frame::soft(self.size()),
}
}
pub fn fill(&self) -> Option<Paint> {
match self {
Self::Glyph(glyph) => Some(glyph.item.fill.clone()),
_ => None,
}
}
/// If no kern table is provided for a corner, a kerning amount of zero is
/// assumed.
pub fn kern_at_height(&self, corner: Corner, height: Abs) -> Abs {
match self {
Self::Glyph(glyph) => {
// For glyph assemblies we pick either the start or end glyph
// depending on the corner.
let is_vertical =
glyph.item.glyphs.iter().all(|glyph| glyph.y_advance != Em::zero());
let glyph_index = match (is_vertical, corner) {
(true, Corner::TopLeft | Corner::TopRight) => {
glyph.item.glyphs.len() - 1
}
(false, Corner::TopRight | Corner::BottomRight) => {
glyph.item.glyphs.len() - 1
}
_ => 0,
};
kern_at_height(
&glyph.item.font,
GlyphId(glyph.item.glyphs[glyph_index].id),
corner,
Em::from_abs(height, glyph.item.size),
)
.unwrap_or_default()
.at(glyph.item.size)
}
_ => Abs::zero(),
}
}
}
impl From<GlyphFragment> for MathFragment {
fn from(glyph: GlyphFragment) -> Self {
Self::Glyph(glyph)
}
}
impl From<FrameFragment> for MathFragment {
fn from(fragment: FrameFragment) -> Self {
Self::Frame(fragment)
}
}
#[derive(Clone)]
pub struct GlyphFragment {
// Text stuff.
pub item: TextItem,
// Math stuff.
pub size: Size,
baseline: Option<Abs>,
italics_correction: Abs,
accent_attach: (Abs, Abs),
math_size: MathSize,
pub class: MathClass,
extended_shape: bool,
// External frame stuff.
modifiers: FrameModifiers,
shift: Abs,
align: Abs,
}
impl GlyphFragment {
/// Calls `new` with the given character.
pub fn new_char(
ctx: &MathContext,
styles: StyleChain,
c: char,
span: Span,
) -> Option<Self> {
Self::new(ctx.engine.world, styles, c.encode_utf8(&mut [0; 4]), span)
}
/// Selects a font to use and then shapes text.
#[comemo::memoize]
pub fn new(
world: Tracked<dyn World + '_>,
styles: StyleChain,
text: &str,
span: Span,
) -> Option<GlyphFragment> {
let (font, mut glyphs) = shape(
world,
variant(styles),
features(styles),
language(styles),
styles.get(TextElem::fallback),
text,
families(styles).collect(),
)?;
for glyph in &mut glyphs {
glyph.span = (span, 0);
}
let item = TextItem {
text: text.into(),
font,
size: styles.resolve(TextElem::size),
fill: styles.get_ref(TextElem::fill).as_decoration(),
stroke: styles.resolve(TextElem::stroke).map(|s| s.unwrap_or_default()),
lang: styles.get(TextElem::lang),
region: styles.get(TextElem::region),
glyphs,
};
let c = text.chars().next().unwrap();
let class = styles
.get(EquationElem::class)
.or_else(|| default_math_class(c))
.unwrap_or(MathClass::Normal);
let mut fragment = Self {
item,
// Math
math_size: styles.get(EquationElem::size),
class,
// Math in need of updating.
extended_shape: false,
italics_correction: Abs::zero(),
accent_attach: (Abs::zero(), Abs::zero()),
size: Size::zero(),
baseline: None,
// Misc
align: Abs::zero(),
shift: styles.resolve(TextElem::baseline),
modifiers: FrameModifiers::get_in(styles),
};
fragment.update_glyph();
Some(fragment)
}
/// Sets element id and boxes in appropriate way without changing other
/// styles. This is used to replace the glyph with a stretch variant.
fn update_glyph(&mut self) {
let id = GlyphId(self.item.glyphs[0].id);
let extended_shape = is_extended_shape(&self.item.font, id);
let italics = italics_correction(&self.item.font, id).unwrap_or_default();
let width = self.item.width();
if !extended_shape {
self.item.glyphs[0].x_advance += italics;
}
let italics = italics.at(self.item.size);
let (ascent, descent) =
ascent_descent(&self.item.font, id).unwrap_or((Em::zero(), Em::zero()));
// The fallback for accents is half the width plus or minus the italics
// correction. This is similar to how top and bottom attachments are
// shifted. For bottom accents we do not use the accent attach of the
// base as it is meant for top acccents.
let top_accent_attach = accent_attach(&self.item.font, id)
.map(|x| x.at(self.item.size))
.unwrap_or((width + italics) / 2.0);
let bottom_accent_attach = (width - italics) / 2.0;
self.baseline = Some(ascent.at(self.item.size));
self.size = Size::new(
self.item.width(),
ascent.at(self.item.size) + descent.at(self.item.size),
);
self.italics_correction = italics;
self.accent_attach = (top_accent_attach, bottom_accent_attach);
self.extended_shape = extended_shape;
}
fn baseline(&self) -> Abs {
self.ascent()
}
/// The distance from the baseline to the top of the frame.
pub fn ascent(&self) -> Abs {
self.baseline.unwrap_or(self.size.y)
}
/// The distance from the baseline to the bottom of the frame.
pub fn descent(&self) -> Abs {
self.size.y - self.ascent()
}
fn into_frame(self) -> Frame {
let mut frame = Frame::soft(self.size);
frame.set_baseline(self.baseline());
frame.push(
Point::with_y(self.ascent() + self.shift + self.align),
FrameItem::Text(self.item),
);
frame.modify(&self.modifiers);
frame
}
pub fn stretch_axis(&self, engine: &mut Engine) -> Option<Axis> {
// Return if we attempt to stretch along an axis which isn't stretchable,
// so that the original fragment isn't modified.
let axes = stretch_axes(&self.item.font, self.item.glyphs[0].id);
match (axes.x, axes.y) {
(true, false) => Some(Axis::X),
(false, true) => Some(Axis::Y),
(false, false) => None,
(true, true) => {
// As far as we know, there aren't any glyphs that have both
// vertical and horizontal constructions. So for the time being, we
// will assume that a glyph cannot have both.
engine.sink.warn(warning!(
self.item.glyphs[0].span.0,
"glyph has both vertical and horizontal constructions";
hint: "this is probably a font bug";
hint: "please file an issue at https://github.com/typst/typst/issues";
));
None
}
}
}
/// Try to stretch a glyph to a desired width or height.
///
/// The resulting frame may not have the exact desired width or height.
pub fn stretch(
&mut self,
engine: &mut Engine,
target: Abs,
short_fall: Abs,
axis: Axis,
) {
// If the base glyph is good enough, use it.
let mut advance = self.size.get(axis);
if axis == Axis::X && !self.extended_shape {
// For consistency, we subtract the italics correction from the
// glyph's width if it was added in `update_glyph`.
advance -= self.italics_correction;
}
let short_target = target - short_fall;
if short_target <= advance {
return;
}
let id = GlyphId(self.item.glyphs[0].id);
let font = self.item.font.clone();
let Some(construction) = glyph_construction(&font, id, axis) else { return };
// Search for a pre-made variant with a good advance.
let mut best_id = id;
let mut best_advance = advance;
for variant in construction.variants {
best_id = variant.variant_glyph;
best_advance =
self.item.font.to_em(variant.advance_measurement).at(self.item.size);
if short_target <= best_advance {
break;
}
}
// This is either good or the best we've got.
if short_target <= best_advance || construction.assembly.is_none() {
self.item.glyphs = vec![Glyph {
id: best_id.0,
x_advance: self.item.font.x_advance(best_id.0).unwrap_or_default(),
x_offset: Em::zero(),
y_advance: self.item.font.y_advance(best_id.0).unwrap_or_default(),
y_offset: Em::zero(),
range: self.item.glyphs[0].range.clone(),
span: self.item.glyphs[0].span,
}];
self.update_glyph();
return;
}
// Assemble from parts.
let assembly = construction.assembly.unwrap();
let min_overlap = min_connector_overlap(&self.item.font)
.unwrap_or_default()
.at(self.item.size);
assemble(engine, self, assembly, min_overlap, target, axis);
}
/// Vertically adjust the fragment's frame so that it is centered
/// on the axis.
pub fn center_on_axis(&mut self) {
self.align_on_axis(VAlignment::Horizon);
}
/// Vertically adjust the fragment's frame so that it is aligned
/// to the given alignment on the axis.
fn align_on_axis(&mut self, align: VAlignment) {
let h = self.size.y;
let axis = self.item.font.math().axis_height.at(self.item.size);
self.align += self.baseline();
self.baseline = Some(align.inv().position(h + axis * 2.0));
self.align -= self.baseline();
}
}
impl Debug for GlyphFragment {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "GlyphFragment({:?})", self.item.text)
}
}
#[derive(Debug, Clone)]
pub struct FrameFragment {
frame: Frame,
font_size: Abs,
class: MathClass,
math_size: MathSize,
base_ascent: Abs,
base_descent: Abs,
italics_correction: Abs,
accent_attach: (Abs, Abs),
text_like: bool,
}
impl FrameFragment {
pub fn new(props: &MathProperties, styles: StyleChain, frame: Frame) -> Self {
let base_ascent = frame.ascent();
let base_descent = frame.descent();
let accent_attach = frame.width() / 2.0;
let modifiers = FrameModifiers::get_in(styles);
Self {
frame: frame.modified(&modifiers),
font_size: styles.resolve(TextElem::size),
class: props.class,
math_size: props.size,
base_ascent,
base_descent,
italics_correction: Abs::zero(),
accent_attach: (accent_attach, accent_attach),
text_like: false,
}
}
pub fn with_base_ascent(self, base_ascent: Abs) -> Self {
Self { base_ascent, ..self }
}
pub fn with_base_descent(self, base_descent: Abs) -> Self {
Self { base_descent, ..self }
}
pub fn with_italics_correction(self, italics_correction: Abs) -> Self {
Self { italics_correction, ..self }
}
pub fn with_accent_attach(self, accent_attach: (Abs, Abs)) -> Self {
Self { accent_attach, ..self }
}
pub fn with_text_like(self, text_like: bool) -> Self {
Self { text_like, ..self }
}
}
fn ascent_descent(font: &Font, id: GlyphId) -> Option<(Em, Em)> {
let bbox = font.ttf().glyph_bounding_box(id)?;
Some((font.to_em(bbox.y_max), -font.to_em(bbox.y_min)))
}
/// Look up the italics correction for a glyph.
fn italics_correction(font: &Font, id: GlyphId) -> Option<Em> {
font.ttf()
.tables()
.math?
.glyph_info?
.italic_corrections?
.get(id)
.map(|value| font.to_em(value.value))
}
/// Loop up the top accent attachment position for a glyph.
fn accent_attach(font: &Font, id: GlyphId) -> Option<Em> {
font.ttf()
.tables()
.math?
.glyph_info?
.top_accent_attachments?
.get(id)
.map(|value| font.to_em(value.value))
}
/// Look up whether a glyph is an extended shape.
fn is_extended_shape(font: &Font, id: GlyphId) -> bool {
font.ttf()
.tables()
.math
.and_then(|math| math.glyph_info)
.and_then(|glyph_info| glyph_info.extended_shapes)
.and_then(|coverage| coverage.get(id))
.is_some()
}
/// Look up a kerning value at a specific corner and height.
fn kern_at_height(font: &Font, id: GlyphId, corner: Corner, height: Em) -> Option<Em> {
let kerns = font.ttf().tables().math?.glyph_info?.kern_infos?.get(id)?;
let kern = match corner {
Corner::TopLeft => kerns.top_left,
Corner::TopRight => kerns.top_right,
Corner::BottomRight => kerns.bottom_right,
Corner::BottomLeft => kerns.bottom_left,
}?;
let mut i = 0;
while i < kern.count() && height > font.to_em(kern.height(i)?.value) {
i += 1;
}
Some(font.to_em(kern.kern(i)?.value))
}
fn stretch_axes(font: &Font, id: u16) -> Axes<bool> {
let id = GlyphId(id);
let horizontal = font
.ttf()
.tables()
.math
.and_then(|math| math.variants)
.and_then(|variants| variants.horizontal_constructions.get(id))
.is_some();
let vertical = font
.ttf()
.tables()
.math
.and_then(|math| math.variants)
.and_then(|variants| variants.vertical_constructions.get(id))
.is_some();
Axes::new(horizontal, vertical)
}
fn min_connector_overlap(font: &Font) -> Option<Em> {
font.ttf()
.tables()
.math?
.variants
.map(|variants| font.to_em(variants.min_connector_overlap))
}
fn glyph_construction(
font: &Font,
id: GlyphId,
axis: Axis,
) -> Option<GlyphConstruction<'_>> {
font.ttf()
.tables()
.math?
.variants
.map(|variants| match axis {
Axis::X => variants.horizontal_constructions,
Axis::Y => variants.vertical_constructions,
})?
.get(id)
}
/// Assemble a glyph from parts.
fn assemble(
engine: &mut Engine,
base: &mut GlyphFragment,
assembly: GlyphAssembly,
min_overlap: Abs,
target: Abs,
axis: Axis,
) {
// Determine the number of times the extenders need to be repeated as well
// as a ratio specifying how much to spread the parts apart
// (0 = maximal overlap, 1 = minimal overlap).
let mut full;
let mut ratio;
let mut repeat = 0;
loop {
full = Abs::zero();
ratio = 0.0;
let mut parts = parts(assembly, repeat).peekable();
let mut growable = Abs::zero();
while let Some(part) = parts.next() {
let mut advance = base.item.font.to_em(part.full_advance).at(base.item.size);
if let Some(next) = parts.peek() {
let max_overlap = base
.item
.font
.to_em(part.end_connector_length.min(next.start_connector_length))
.at(base.item.size);
if max_overlap < min_overlap {
// This condition happening is indicative of a bug in the
// font.
engine.sink.warn(warning!(
base.item.glyphs[0].span.0,
"glyph has assembly parts with overlap less than minConnectorOverlap";
hint: "its rendering may appear broken - this is probably a font bug";
hint: "please file an issue at https://github.com/typst/typst/issues";
));
}
advance -= max_overlap;
// In case we have that max_overlap < min_overlap, ensure we
// don't decrease the value of growable.
growable += (max_overlap - min_overlap).max(Abs::zero());
}
full += advance;
}
if full < target {
let delta = target - full;
ratio = (delta / growable).min(1.0);
full += ratio * growable;
}
if target <= full || repeat >= MAX_REPEATS {
break;
}
repeat += 1;
}
let mut glyphs = vec![];
let mut parts = parts(assembly, repeat).peekable();
while let Some(part) = parts.next() {
let mut advance = base.item.font.to_em(part.full_advance).at(base.item.size);
if let Some(next) = parts.peek() {
let max_overlap = base
.item
.font
.to_em(part.end_connector_length.min(next.start_connector_length))
.at(base.item.size);
advance -= max_overlap;
advance += ratio * (max_overlap - min_overlap);
}
let (x_advance, y_advance, y_offset) = match axis {
Axis::X => (Em::from_abs(advance, base.item.size), Em::zero(), Em::zero()),
Axis::Y => (
Em::zero(),
Em::from_abs(advance, base.item.size),
// Glyph parts used in vertical assemblies are typically aligned
// at the vertical origin. This way, they combine properly when
// drawn consecutively, as required by the MATH table spec.
//
// However, in some fonts, they aren't. To still have them align
// properly, we are vertically offsetting such glyphs by their
// bounding-box computed descent. (Positive descent means that
// a glyph extends below the baseline and then we must move it
// up for it to align properly. `y_advance` is Y-up, so that
// matches up.)
ascent_descent(&base.item.font, part.glyph_id)
.map(|x| x.1)
.unwrap_or_default(),
),
};
glyphs.push(Glyph {
id: part.glyph_id.0,
x_advance,
x_offset: Em::zero(),
y_advance,
y_offset,
range: base.item.glyphs[0].range.clone(),
span: base.item.glyphs[0].span,
});
}
match axis {
Axis::X => {
base.size.x = full;
let (ascent, descent) = glyphs
.iter()
.filter_map(|glyph| ascent_descent(&base.item.font, GlyphId(glyph.id)))
.reduce(|(ma, md), (a, d)| (ma.max(a), md.max(d)))
.unwrap_or((Em::zero(), Em::zero()));
base.baseline = Some(ascent.at(base.item.size));
base.size.y = (ascent + descent).at(base.item.size);
}
Axis::Y => {
base.baseline = None;
base.size.y = full;
base.size.x = glyphs
.iter()
.map(|glyph| base.item.font.x_advance(glyph.id).unwrap_or_default())
.max()
.unwrap_or_default()
.at(base.item.size);
}
}
base.item.glyphs = glyphs;
base.italics_correction = base
.item
.font
.to_em(assembly.italics_correction.value)
.at(base.item.size);
if axis == Axis::X {
base.accent_attach = (full / 2.0, full / 2.0);
}
base.extended_shape = true;
}
/// Return an iterator over the assembly's parts with extenders repeated the
/// specified number of times.
fn parts(
assembly: GlyphAssembly<'_>,
repeat: usize,
) -> impl Iterator<Item = GlyphPart> + '_ {
assembly.parts.into_iter().flat_map(move |part| {
let count = if part.part_flags.extender() { repeat } else { 1 };
std::iter::repeat_n(part, count)
})
}