summaryrefslogtreecommitdiff
path: root/src/layout/spacing.rs
blob: 1ba3b54a27cab0c20c15e58e921436db2099991e (plain) (blame)
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
use std::fmt::{self, Debug, Formatter};

use super::*;

/// A  spacing node.
#[derive(Copy, Clone, PartialEq)]
pub struct Spacing {
    /// The amount of spacing to insert.
    pub amount: Length,
    /// Spacing interaction, see [`Softness`]'s documentation for more
    /// information.
    pub softness: Softness,
}

impl Layout for Spacing {
    fn layout(&self, _: &mut LayoutContext, _: &Areas) -> Layouted {
        Layouted::Spacing(self.amount)
    }
}

impl Debug for Spacing {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self.softness {
            Softness::Soft => write!(f, "Soft({})", self.amount),
            Softness::Hard => write!(f, "Hard({})", self.amount),
        }
    }
}

impl From<Spacing> for LayoutNode {
    fn from(spacing: Spacing) -> Self {
        Self::Spacing(spacing)
    }
}

/// Defines how spacing interacts with surrounding spacing.
///
/// Hard spacing assures that a fixed amount of spacing will always be inserted.
/// Soft spacing will be consumed by previous soft spacing or neighbouring hard
/// spacing and can be used to insert overridable spacing, e.g. between words or
/// paragraphs.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub enum Softness {
    /// Soft spacing is not laid out if it directly follows other soft spacing
    /// or if it touches hard spacing.
    Soft,
    /// Hard spacing is always laid out and consumes surrounding soft spacing.
    Hard,
}