highlighter-target-html 0.1.1-alpha

An HTML target for Highlighter.
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

use highlighter_core::Token;

fn html_escape(str: String) -> String {
    let mut new_str = String::new();

    for char in str.chars() {
        match char {
            '>' => new_str.push_str(">"),
            '<' => new_str.push_str("&lt;"),
            '&' => new_str.push_str("&amp;"),
            '\'' => new_str.push_str("&#39;"),
            '"' => new_str.push_str("&quot;"),
            _ => new_str.push(char),
        }
    }

    new_str
}

/// An HTML target for Highlighter.
/// 
/// TODO: add a beautify option.
#[derive(Clone, Debug, PartialEq)]
pub struct HighlighterTargetHtml {
    /// The prefix to use for outputted HTML.  Defaults to "".
    html_prefix: String,

    /// The prefix to use for outputted HTML.  Defaults to "".
    html_suffix: String,

    /// The prefix used for CSS class names.
    /// 
    /// Defaults to `scope-`.
    class_prefix: String,
}

impl HighlighterTargetHtml {
    /// Creates a new, default HTML target.
    pub fn new() -> Self {
        Self { html_prefix: String::new(), html_suffix: String::new(), class_prefix: "scope-".to_owned() }
    }

    /// Returns this HTML target, with the provided HTML prefix.
    pub fn with_html_prefix<Str: Into<String>>(mut self, html_prefix: Str) -> Self {
        self.html_prefix = html_prefix.into();
        self
    }

    /// Returns this HTML target, with the provided HTML suffix.
    pub fn with_html_suffix<Str: Into<String>>(mut self, html_suffix: Str) -> Self {
        self.html_suffix = html_suffix.into();
        self
    }

    /// Returns this HTML target, with the provided class prefix.
    pub fn with_class_prefix<Str: Into<String>>(mut self, class_prefix: Str) -> Self {
        self.class_prefix = class_prefix.into();
        self
    }

    /// Builds the given tokens into a string of HTML.
    pub fn build(&self, tokens: Vec<Token>) -> String {
        let mut str = String::new();

        for token in tokens {
            str.push_str(&format!("<span class=\"{}{}\">{}</span>", self.class_prefix, token.scope.kebab_case(), html_escape(token.value)));
        }

        str
    }
}