lightweight-pdf-layout 0.3.0

Layoutable trait, pagination and text wrapping for lightweight-pdf
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

//! `plan/05-overflow-and-robustness.md` Grundprinzip 8: diagnostics instead
//! of silent clipping. Collected during the layout pass and returned
//! alongside the finished PDF bytes by the facade's
//! `render_with_diagnostics()`, never separately (InDesign "Overset Text"
//! anti-pattern).

use lightweight_pdf_core::FontKey;

#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub enum LayoutWarningKind {
    /// Text was cut off because its box was too small (`Overflow::Clip`).
    TextClipped,
    /// A container's content overflowed its box and was clipped.
    ContentOverflow,
    /// An atomic element bigger than a whole page was forced onto its own
    /// page and clipped there (Grundprinzip 7).
    ForcedPageBreak,
    /// Header/Footer content was taller than its reserved band and got
    /// clipped (band size is fixed, never grows, ADR-011).
    HeaderFooterOverflow,
    /// A character has no glyph in the resolved font and rendered as
    /// `.notdef` (an empty box) instead. Deduplicated per (`ch`, `font`),
    /// not per occurrence.
    MissingGlyph { ch: char, font: FontKey },
    /// A table row had more cells than the table declares columns — the
    /// extra cells were dropped rather than rendered.
    TableRowOverflow,
    /// `Document::pdf_ua()` is set and an `Image` has no `.alt(...)` text
    /// (issue #27) — it still renders (and still gets a `/Figure` tag),
    /// just with an empty `/Alt`.
    MissingAltText,
}

#[derive(Clone, Debug)]
pub struct LayoutWarning {
    pub kind: LayoutWarningKind,
    pub page: usize,
    pub element_hint: String,
}