skrifa 0.44.0

Metadata reader and glyph scaler for OpenType fonts.
Documentation 
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

use crate::outline::autohint::topo::{BlueProvenance, Dimension};
use alloc::vec::Vec;

/// Hinting action for a point.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub enum PointAction {
    IpBefore,
    IpAfter,
    IpOn,
    IpBetween,
}

/// Hinting action for an edge.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub enum EdgeAction {
    Blue,
    BlueAnchor,
    Anchor,
    Adjust,
    Link,
    Stem,
    Serif,
    SerifAnchor,
    SerifLink1,
    SerifLink2,
    Bound,
}

/// Hinting information for a point.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub struct PointHint {
    pub action: PointAction,
    pub dimension: Dimension,
    pub point_index: u16,
    pub edge_index: Option<u16>,
    pub edge2_index: Option<u16>,
}

/// Hinting information for an edge.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub struct EdgeHint {
    pub action: EdgeAction,
    pub dimension: Dimension,
    pub edge_index: u16,
    pub edge2_index: Option<u16>,
    pub edge3_index: Option<u16>,
    pub lower_bound_index: Option<u16>,
    pub upper_bound_index: Option<u16>,
    pub blue: Option<BlueProvenance>,
}

/// Hinting action for a point or an edge.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub enum HintAction {
    Point(PointHint),
    Edge(EdgeHint),
}

#[derive(Clone, Default, PartialEq, Eq, Debug)]
pub struct HintsRecorder {
    pub actions: Vec<HintAction>,
}

impl HintsRecorder {
    pub fn record_ip_before(&mut self, dim: Dimension, point_ix: usize) {
        self.actions.push(HintAction::Point(PointHint {
            action: PointAction::IpBefore,
            dimension: dim,
            point_index: narrow(point_ix),
            edge_index: None,
            edge2_index: None,
        }));
    }

    pub fn record_ip_after(&mut self, dim: Dimension, point_ix: usize) {
        self.actions.push(HintAction::Point(PointHint {
            action: PointAction::IpAfter,
            dimension: dim,
            point_index: narrow(point_ix),
            edge_index: None,
            edge2_index: None,
        }));
    }

    pub fn record_ip_on(&mut self, dim: Dimension, point_ix: usize, edge_ix: usize) {
        self.actions.push(HintAction::Point(PointHint {
            action: PointAction::IpOn,
            dimension: dim,
            point_index: narrow(point_ix),
            edge_index: Some(narrow(edge_ix)),
            edge2_index: None,
        }));
    }

    pub fn record_ip_between(
        &mut self,
        dim: Dimension,
        point_ix: usize,
        before_edge_ix: usize,
        after_edge_ix: usize,
    ) {
        self.actions.push(HintAction::Point(PointHint {
            action: PointAction::IpBetween,
            dimension: dim,
            point_index: narrow(point_ix),
            edge_index: Some(narrow(before_edge_ix)),
            edge2_index: Some(narrow(after_edge_ix)),
        }));
    }

    #[allow(clippy::too_many_arguments)]
    pub fn record_edge(
        &mut self,
        dim: Dimension,
        action: EdgeAction,
        edge_ix: usize,
        edge2_ix: Option<usize>,
        edge3_ix: Option<usize>,
        lower_bound_ix: Option<usize>,
        upper_bound_ix: Option<usize>,
        blue: Option<BlueProvenance>,
    ) {
        self.actions.push(HintAction::Edge(EdgeHint {
            action,
            dimension: dim,
            edge_index: narrow(edge_ix),
            edge2_index: edge2_ix.map(narrow),
            edge3_index: edge3_ix.map(narrow),
            lower_bound_index: lower_bound_ix.map(narrow),
            upper_bound_index: upper_bound_ix.map(narrow),
            blue,
        }));
    }
}

fn narrow(ix: usize) -> u16 {
    debug_assert!(ix <= u16::MAX as usize);
    ix as u16
}