crowbook 0.17.1

Render a Markdown book in HTML, PDF or Epub
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

// Copyright (C) 2016-2020 Élisabeth HENRY.
//
// This file is part of Crowbook.
//
// Crowbook is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// Crowbook is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Crowbook.  If not, see <http://www.gnu.org/licenses/>.

//! This module contains the `Cleaner` traits and various implementations of it.

use crowbook_text_processing::clean;
use crowbook_text_processing::FrenchFormatter;
use std::borrow::Cow;

/// Contains cleaning parameters
pub struct CleanerParams {
    pub smart_quotes: bool,
    pub ligature_guillemets: bool,
    pub ligature_dashes: bool,
}

/// Trait for cleaning a string.
///
/// This trait must be called for text that is e.g. in a paragraph, a title,
/// NOT for code blocks, hyperlinks and so on!
pub trait Cleaner: Sync {
    /// Cleans a string. The default implementation is to remove multiple consecutive whitespaces
    ///
    /// # Arguments
    ///
    /// * `str`: the string that must be cleaned
    fn clean<'a>(&self, str: Cow<'a, str>) -> Cow<'a, str> {
        str
    }
}

/// Cleaner implementation that does nothing
pub struct Off;
impl Cleaner for Off {}

/// Default implementation of cleaner trait.
///
/// Only removes unnecessary whitespaces.
pub struct Default {
    params: CleanerParams,
}

impl Default {
    /// New Default cleaner
    pub fn new(params: CleanerParams) -> Default {
        Default { params }
    }
}

impl Cleaner for Default {
    /// Remove unnecessary whitespaces
    fn clean<'a>(&self, input: Cow<'a, str>) -> Cow<'a, str> {
        let mut s = clean::whitespaces(input);
        if self.params.smart_quotes {
            s = clean::quotes(s);
        }
        if self.params.ligature_dashes {
            s = clean::dashes(s);
        }
        if self.params.ligature_guillemets {
            s = clean::guillemets(s);
        }
        s
    }
}

/// Implementation for french 'cleaning'
///
/// This implementation replaces spaces before some characters (e.g. `?` or `;`)
/// with non-breaking spaces
pub struct French {
    formatter: FrenchFormatter,
    params: CleanerParams,
}

impl French {
    /// Creates a new french cleaner
    pub fn new(params: CleanerParams) -> French {
        let mut this = French {
            formatter: FrenchFormatter::new(),
            params,
        };
        this.formatter.typographic_quotes(this.params.smart_quotes);
        this.formatter.ligature_dashes(this.params.ligature_dashes);
        this.formatter
            .ligature_guillemets(this.params.ligature_guillemets);
        this
    }
}

impl Cleaner for French {
    /// Puts non breaking spaces before/after `:`, `;`, `?`, `!`, `«`, `»`, `—`
    fn clean<'a>(&self, s: Cow<'a, str>) -> Cow<'a, str> {
        self.formatter.format(s)
    }
}