ddoc 0.17.0

doc site generator
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use crate::*;

#[derive(Debug, Clone)]
pub struct Element {
    pub classes: Vec<ClassName>,
    pub content: ElementContent,
}

#[derive(Debug, Clone)]
pub enum ElementContent {
    DomLeaf {
        tag: String,
        text: Option<Text>,
        raw_html: Option<String>,
        attributes: Attributes,
        // TODO support markdown ?
    },
    DomTree {
        tag: String,
        children: Vec<Element>,
    },
    Link(NavLink),
    Menu(Menu),
    Toc(Toc),
    Main,
    PageTitle, // this one is quite obsolete now with --current-page-title
}

impl Element {
    pub fn try_merge(
        &mut self,
        other: &Element,
    ) -> bool {
        match (&mut self.content, &other.content) {
            (
                ElementContent::DomTree {
                    children: children1,
                    ..
                },
                ElementContent::DomTree {
                    children: children2,
                    ..
                },
            ) => {
                for element in children2 {
                    let mut merged = false;
                    let selector2 = element.selector();
                    for element1 in children1.iter_mut() {
                        if element1.selector() == selector2 {
                            merged |= element1.try_merge(element);
                            break;
                        }
                    }
                    if !merged {
                        children1.push(element.clone());
                    }
                }
                true
            }
            _ => false,
        }
    }
    /// The pseudo-tag of this element, as used in configuration
    pub fn tag(&self) -> &str {
        match &self.content {
            ElementContent::DomLeaf { tag, .. } => tag,
            ElementContent::DomTree { tag, .. } => tag,
            ElementContent::Link(_) => "ddoc-link",
            ElementContent::Menu(_) => "ddoc-menu",
            ElementContent::Toc(_) => "ddoc-toc",
            ElementContent::Main => "ddoc-main",
            ElementContent::PageTitle => "ddoc-page-title",
        }
    }
    pub fn children(&self) -> Option<&Vec<Element>> {
        match &self.content {
            ElementContent::DomTree { children, .. } => Some(children),
            _ => None,
        }
    }
    pub fn new_composite(
        key: &str, // tag.class1.class2
        children: Vec<Element>,
    ) -> Self {
        let mut tokens = key.split('.');
        let tag = tokens.next().unwrap_or("div").to_string();
        let classes = tokens.map(|s| s.to_string()).collect();
        Self {
            classes,
            content: ElementContent::DomTree { tag, children },
        }
    }
    pub fn visit<F>(
        &self,
        f: &mut F,
    ) where
        F: FnMut(&Element),
    {
        f(self);
        if let Some(children) = self.children() {
            for child in children {
                child.visit(f);
            }
        }
    }
    pub fn has<F>(
        &self,
        f: &mut F,
    ) -> bool
    where
        F: FnMut(&Element) -> bool,
    {
        if f(self) {
            return true;
        }
        if let Some(children) = self.children() {
            for child in children {
                if child.has(f) {
                    return true;
                }
            }
        }
        false
    }
    pub fn selector(&self) -> String {
        let mut selector = self.tag().to_string();
        for class in &self.classes {
            selector.push('.');
            selector.push_str(class.as_str());
        }
        selector
    }
}

impl From<ElementContent> for Element {
    fn from(content: ElementContent) -> Self {
        Self {
            classes: vec![],
            content,
        }
    }
}