martensite-text 0.10.0

HarfBuzz shaping, BiDi, font fallback, and sub-pixel IME projection via cosmic-text.
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

//! Typography and text layout for Martensite.
//!
//! This crate provides:
//! - [`font`]: font system abstraction, system font discovery via
//!   `fontdb`, and custom font asset loading.
//! - [`shaping`]: complex text shaping with BiDi, line breaking, and
//!   font fallback via cosmic-text.
//! - [`cache`]: two-tier text measurement and glyph shaping cache
//!   (Tier 1 inline in `ColdNode`, Tier 2 global LRU with 16 MB budget).
//! - [`ime`]: velocity-damped kinetic IME candidate positioning that
//!   tracks the caret during active scrolling.
//!
//! ## IME candidate projection
//!
//! The `compute_ime_bounds` function computes IME candidate window
//! bounds from the cursor position and line height. For scrolling
//! containers, prefer the [`ime`] module's [`ImePositioner`], which
//! applies velocity-damped projection and viewport clamping.
#![forbid(unsafe_code)]
#![deny(missing_docs)]

/// Two-tier text cache: `TextShapeCache`, `ShapeCacheKey`.
pub mod cache;
/// Font system abstraction: `FontManager`, `FontId`, `FontSource`.
pub mod font;
/// Velocity-damped kinetic IME candidate positioning.
pub mod ime;
/// Complex text shaping: `Shaper`, `TextMetrics`, `ShapedLine`.
pub mod shaping;

pub use cache::{
    CachedShape, FontSizeBits, LineHeightBits, MaxWidthBits, ShapeCacheKey, TextHash,
    TextShapeCache, DEFAULT_MEMORY_BUDGET,
};
pub use cosmic_text::{Attrs, Buffer, Family, FontSystem, Metrics, Shaping};
pub use font::{FontFaceInfo, FontId, FontManager, FontSource, FontStyle};
pub use ime::{ImePositioner, ScrollKinematics, Viewport};
pub use shaping::{
    measure_text, measure_text_with_attrs, shape_text, ShapedGlyph, ShapedLine, Shaper, TextMetrics,
};

#[cfg(test)]
use winit::dpi::{LogicalPosition, LogicalSize};

/// Computes the IME candidate window bounds from the cursor position and line height.
///
/// Returns a logical position and size describing where the IME candidate window
/// should be anchored relative to the text being composed.
///
/// # Limitation
///
/// The width is a minimal placeholder (`2.0` logical pixels) because the
/// actual IME candidate window width depends on platform-specific IME
/// APIs and the composing text content, which are not available at the
/// text-shaping layer. A future milestone will integrate platform IME
/// APIs to compute the real candidate window width. The position and
/// height are accurate.
///
/// For scrolling containers, prefer [`ImePositioner::compute_bounds`],
/// which applies velocity-damped projection and viewport clamping.
#[deprecated(
    since = "0.5.0",
    note = "use `ImePositioner::compute_bounds` for velocity-damped, viewport-clamped IME bounds"
)]
#[cfg(test)]
fn compute_ime_bounds(x: f64, y: f64, height: f64) -> (LogicalPosition<f64>, LogicalSize<f64>) {
    (LogicalPosition::new(x, y), LogicalSize::new(2.0, height))
}

#[cfg(test)]
mod tests {
    #![allow(deprecated)]
    use super::compute_ime_bounds;

    #[test]
    fn returns_correct_position_and_size() {
        let (pos, size) = compute_ime_bounds(10.0, 20.0, 30.0);
        assert_eq!(pos.x, 10.0);
        assert_eq!(pos.y, 20.0);
        assert_eq!(size.width, 2.0);
        assert_eq!(size.height, 30.0);
    }

    #[test]
    fn zero_height() {
        let (pos, size) = compute_ime_bounds(5.0, 5.0, 0.0);
        assert_eq!(pos.x, 5.0);
        assert_eq!(pos.y, 5.0);
        assert_eq!(size.width, 2.0);
        assert_eq!(size.height, 0.0);
    }

    #[test]
    fn negative_coordinates() {
        let (pos, size) = compute_ime_bounds(-10.0, -20.0, 30.0);
        assert_eq!(pos.x, -10.0);
        assert_eq!(pos.y, -20.0);
        assert_eq!(size.width, 2.0);
        assert_eq!(size.height, 30.0);
    }
}