text-document-common 1.7.0

Shared entities, database, events, and undo/redo infrastructure for text-document
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

//! Per-feature selection for djot import/export.
//!
//! The djot importer and exporter round-trip a set of *optional* block-level
//! attributes — paragraph alignment, line height, text direction, non-breakable
//! lines and background color — through djot's native `{key=value}` block
//! attribute syntax (e.g. `{alignment=center}` on the line before a paragraph).
//! These two option structs let a caller choose which of those attributes are
//! carried. Everything else (headings, lists, tables, blockquotes, code blocks
//! and all inline formatting) is always imported/exported and is not gated.
//!
//! Both structs default to **all enabled** — the fully lossless round-trip. Use
//! [`DjotImportOptions::none`] / [`DjotExportOptions::none`] to restrict the
//! round-trip to the core structural and inline feature set only.
//!
//! The attribute keys used on the wire are the model field names:
//! `alignment`, `line_height`, `direction`, `non_breakable_lines`,
//! `background_color`. Block attributes are only emitted/read for standalone
//! paragraphs and headings; list items, code blocks and table cells normalise
//! their block styling away (the same boundary the other targets observe).

use serde::{Deserialize, Serialize};

/// Selects which optional block attributes the djot **importer** applies to the
/// document model. An attribute present in the source but disabled here is
/// parsed and discarded, exactly like an unrepresentable construct.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct DjotImportOptions {
    /// Apply paragraph alignment from `{alignment=left|right|center|justify}`.
    pub alignment: bool,
    /// Apply line height from `{line_height=<int>}`.
    pub line_height: bool,
    /// Apply text direction from `{direction=ltr|rtl}`.
    pub direction: bool,
    /// Apply non-breakable lines from `{non_breakable_lines=true|false}`.
    pub non_breakable_lines: bool,
    /// Apply block background color from `{background_color="<value>"}`.
    pub background_color: bool,
}

impl DjotImportOptions {
    /// Every optional block attribute enabled — the lossless default.
    pub const fn all() -> Self {
        Self {
            alignment: true,
            line_height: true,
            direction: true,
            non_breakable_lines: true,
            background_color: true,
        }
    }

    /// No optional block attributes — import only the core structural and
    /// inline feature set, discarding any block-attribute styling.
    pub const fn none() -> Self {
        Self {
            alignment: false,
            line_height: false,
            direction: false,
            non_breakable_lines: false,
            background_color: false,
        }
    }
}

impl Default for DjotImportOptions {
    fn default() -> Self {
        Self::all()
    }
}

/// Selects which optional block attributes the djot **exporter** emits as
/// `{key=value}` block attributes. A disabled attribute is omitted from the
/// output even when the model carries a value for it.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct DjotExportOptions {
    /// Emit paragraph alignment as `{alignment=…}`.
    pub alignment: bool,
    /// Emit line height as `{line_height=…}`.
    pub line_height: bool,
    /// Emit text direction as `{direction=…}`.
    pub direction: bool,
    /// Emit non-breakable lines as `{non_breakable_lines=…}`.
    pub non_breakable_lines: bool,
    /// Emit block background color as `{background_color=…}`.
    pub background_color: bool,
}

impl DjotExportOptions {
    /// Every optional block attribute emitted — the lossless default.
    pub const fn all() -> Self {
        Self {
            alignment: true,
            line_height: true,
            direction: true,
            non_breakable_lines: true,
            background_color: true,
        }
    }

    /// No optional block attributes — emit only the core structural and inline
    /// feature set, dropping any block-attribute styling.
    pub const fn none() -> Self {
        Self {
            alignment: false,
            line_height: false,
            direction: false,
            non_breakable_lines: false,
            background_color: false,
        }
    }
}

impl Default for DjotExportOptions {
    fn default() -> Self {
        Self::all()
    }
}