1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
// Copyright 2021 the Parley Authors
// SPDX-License-Identifier: Apache-2.0 OR MIT
//! Layout types.
mod cluster;
mod line;
mod run;
pub(crate) mod data;
pub mod cursor;
use super::style::Brush;
use crate::Font;
use core::ops::Range;
use data::*;
use swash::text::cluster::{Boundary, ClusterInfo};
use swash::{GlyphId, NormalizedCoord, Synthesis};
pub use cursor::Cursor;
pub use line::greedy::BreakLines;
pub use line::{GlyphRun, LineMetrics};
pub use run::RunMetrics;
/// Alignment of a layout.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
#[repr(u8)]
pub enum Alignment {
Start,
Middle,
End,
Justified,
}
impl Default for Alignment {
fn default() -> Self {
Self::Start
}
}
/// Text layout.
#[derive(Clone)]
pub struct Layout<B: Brush> {
pub(crate) data: LayoutData<B>,
}
impl<B: Brush> Layout<B> {
/// Creates an empty layout.
pub fn new() -> Self {
Self::default()
}
/// Returns the scale factor provided when creating the layout.
pub fn scale(&self) -> f32 {
self.data.scale
}
/// Returns the style collection for the layout.
pub fn styles(&self) -> &[Style<B>] {
&self.data.styles
}
/// Returns the width of the layout.
pub fn width(&self) -> f32 {
self.data.width
}
/// Returns the width of the layout, including the width of any trailing
/// whitespace.
pub fn full_width(&self) -> f32 {
self.data.full_width
}
/// Returns the height of the layout.
pub fn height(&self) -> f32 {
self.data.height
}
/// Returns the number of lines in the layout.
pub fn len(&self) -> usize {
self.data.lines.len()
}
/// Returns true if the layout is empty.
pub fn is_empty(&self) -> bool {
self.data.lines.is_empty()
}
/// Returns the line at the specified index.
pub fn get(&self, index: usize) -> Option<Line<B>> {
Some(Line {
layout: &self.data,
data: self.data.lines.get(index)?,
})
}
/// Returns an iterator over the lines in the layout.
pub fn lines(&self) -> impl Iterator<Item = Line<B>> + '_ + Clone {
self.data.lines.iter().map(move |data| Line {
layout: &self.data,
data,
})
}
/// Returns line breaker to compute lines for the layout.
pub fn break_lines(&mut self) -> BreakLines<B> {
BreakLines::new(&mut self.data)
}
/// Breaks all lines with the specified maximum advance and alignment.
pub fn break_all_lines(&mut self, max_advance: Option<f32>, alignment: Alignment) {
self.break_lines()
.break_remaining(max_advance.unwrap_or(f32::MAX), alignment);
}
/// Returns an iterator over the runs in the layout.
pub fn runs(&self) -> impl Iterator<Item = Run<B>> + '_ + Clone {
self.data.runs.iter().map(move |data| Run {
layout: &self.data,
data,
line_data: None,
})
}
}
impl<B: Brush> Default for Layout<B> {
fn default() -> Self {
Self {
data: Default::default(),
}
}
}
/// Sequence of clusters with a single font and style.
#[derive(Copy, Clone)]
pub struct Run<'a, B: Brush> {
layout: &'a LayoutData<B>,
data: &'a RunData,
line_data: Option<&'a LineRunData>,
}
/// Atomic unit of text.
#[derive(Copy, Clone)]
pub struct Cluster<'a, B: Brush> {
run: Run<'a, B>,
data: &'a ClusterData,
}
/// Glyph with an offset and advance.
#[derive(Copy, Clone, Default, Debug)]
pub struct Glyph {
pub id: GlyphId,
pub style_index: u16,
pub x: f32,
pub y: f32,
pub advance: f32,
}
impl Glyph {
/// Returns the index into the layout style collection.
pub fn style_index(&self) -> usize {
self.style_index as usize
}
}
/// Line in a text layout.
#[derive(Copy, Clone)]
pub struct Line<'a, B: Brush> {
layout: &'a LayoutData<B>,
data: &'a LineData,
}
/// Style properties.
#[derive(Clone, Debug)]
pub struct Style<B: Brush> {
/// Brush for drawing glyphs.
pub brush: B,
/// Underline decoration.
pub underline: Option<Decoration<B>>,
/// Strikethrough decoration.
pub strikethrough: Option<Decoration<B>>,
/// Multiplicative line height factor.
pub(crate) line_height: f32,
}
/// Underline or strikethrough decoration.
#[derive(Clone, Debug)]
pub struct Decoration<B: Brush> {
/// Brush used to draw the decoration.
pub brush: B,
/// Offset of the decoration from the baseline. If `None`, use the metrics
/// of the containing run.
pub offset: Option<f32>,
/// Thickness of the decoration. If `None`, use the metrics of the
/// containing run.
pub size: Option<f32>,
}