html_editor 0.7.0

Pure and simple HTML parser and editor.
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233

use super::Selector;
use crate::{Element, Node};

/// Query the specific element(s) by [`Selector`].
pub trait Queryable {
    /// Query the node in `self` for the given selector.
    ///
    /// ```
    /// use html_editor::{parse, Element};
    /// use html_editor::operation::*;
    ///
    /// let html = r#"
    ///     <!DOCTYPE html>
    ///     <html lang="en">
    ///     <head>
    ///         <meta charset="UTF-8">
    ///         <title>App</title>
    ///     </head>
    ///     <body>
    ///         <div id="app"></div>
    ///     </body>
    ///     </html>"#;
    ///
    /// let selector: Selector = Selector::from("#app");
    /// let app: &Element = parse(html).unwrap().query(&selector).unwrap();
    /// ```
    fn query(&self, selector: &Selector) -> Option<&Element>;

    /// Query all the nodes in `self` for the given selector.
    ///
    /// ```
    /// use html_editor::{parse, Element};
    /// use html_editor::operation::*;
    ///
    /// let html = r#"
    ///     <!DOCTYPE html>
    ///     <html lang="en">
    ///     <head>
    ///         <meta charset="UTF-8">
    ///         <title>App</title>
    ///     </head>
    ///     <body>
    ///         <span class="btn">Ok</span>
    ///         <span class="btn">Cancel</span>
    ///         <span class="btn">Remind Me Later</span>
    ///     </body>
    ///     </html>"#;
    ///
    /// let selector: Selector = Selector::from(".btn");
    /// let buttons: Vec<&Element> = parse(html).unwrap().query_all(&selector);
    /// ```
    fn query_all(&self, selector: &Selector) -> Vec<&Element>;

    /// Query the node in `self` as mutable for the given selector.
    ///
    /// ```
    /// use html_editor::{parse, Element};
    /// use html_editor::operation::*;
    ///
    /// let html = r#"
    ///     <!DOCTYPE html>
    ///     <html lang="en">
    ///     <head>
    ///         <meta charset="UTF-8">
    ///         <title>App</title>
    ///     </head>
    ///     <body>
    ///         <div id="app"></div>
    ///     </body>
    ///     </html>"#;
    ///
    /// let selector: Selector = Selector::from("#app");
    /// let app: &mut Element = parse(html).unwrap().query_mut(&selector).unwrap();
    /// ```
    fn query_mut(&mut self, selector: &Selector) -> Option<&mut Element>;

    /// Executes a given function for the node in `self` for the given selector.
    ///
    /// ```
    /// use html_editor::{parse, Element, Node};
    /// use html_editor::operation::*;
    ///
    /// let html = r#"
    ///    <!DOCTYPE html>
    ///    <html lang="en">
    ///        <head>
    ///           <meta charset="UTF-8">
    ///           <title>App</title>
    ///        </head>
    ///        <body>
    ///           <input type="text" />
    ///           <input type="text" />
    ///           <input type="text" />
    ///        </body>
    ///    </html>"#;
    ///
    /// // Add a class to all the input elements
    /// let selector: Selector = Selector::from("input");
    /// let mut doc: Vec<Node> = parse(html).unwrap();
    /// doc.execute_for(&selector, |elem| {
    ///    elem.attrs.push(("class".to_string(), "input".to_string()));
    /// });
    /// ```
    fn execute_for(&mut self, selector: &Selector, f: impl FnMut(&mut Element));
}

// We meed this function to allow the trait interface to use `impl FnMut(&mut Element)` instead of `&mut impl FnMut(&mut Element)`
fn nodes_execute_for_internal(
    nodes: &mut Vec<Node>,
    selector: &Selector,
    f: &mut impl FnMut(&mut Element),
) {
    for node in nodes {
        if let Some(element) = node.as_element_mut() {
            // Recursively traverse the descendants nodes
            element_execute_for_internal(element, selector, f);
        }
    }
}

// We meed this function to allow the trait interface to use `impl FnMut(&mut Element)` instead of `&mut impl FnMut(&mut Element)`
fn element_execute_for_internal(
    element: &mut Element,
    selector: &Selector,
    f: &mut impl FnMut(&mut Element),
) {
    if selector.matches(element) {
        f(element);
    }
    nodes_execute_for_internal(&mut element.children, selector, f);
}

impl Queryable for Vec<Node> {
    fn query(&self, selector: &Selector) -> Option<&Element> {
        for node in self {
            if let Some(element) = node.as_element() {
                if let Some(elem) = element.query(selector) {
                    return Some(elem);
                }
            }
        }
        None
    }

    fn query_all(&self, selector: &Selector) -> Vec<&Element> {
        let mut elements = Vec::new();
        for node in self {
            if let Some(element) = node.as_element() {
                // Recursively traverse the descendants nodes
                let sub_elements = element.query_all(selector);
                elements.extend(sub_elements);
            }
        }
        elements
    }

    fn query_mut(&mut self, selector: &Selector) -> Option<&mut Element> {
        for node in self {
            if let Some(element) = node.as_element_mut() {
                if let Some(elem) = element.query_mut(selector) {
                    return Some(elem);
                }
            }
        }
        None
    }

    fn execute_for(&mut self, selector: &Selector, mut f: impl FnMut(&mut Element)) {
        nodes_execute_for_internal(self, selector, &mut f);
    }
}

impl Queryable for Element {
    fn query(&self, selector: &Selector) -> Option<&Element> {
        if selector.matches(self) {
            Some(self)
        } else {
            self.children.query(selector)
        }
    }

    fn query_all(&self, selector: &Selector) -> Vec<&Element> {
        let mut elements = self.children.query_all(selector);
        if selector.matches(self) {
            elements.push(self);
        }
        elements
    }

    fn query_mut(&mut self, selector: &Selector) -> Option<&mut Element> {
        if selector.matches(self) {
            Some(self)
        } else {
            self.children.query_mut(selector)
        }
    }

    fn execute_for(&mut self, selector: &Selector, mut f: impl FnMut(&mut Element)) {
        element_execute_for_internal(self, selector, &mut f);
    }
}

impl Queryable for Node {
    fn query(&self, selector: &Selector) -> Option<&Element> {
        if let Some(element) = self.as_element() {
            element.query(selector)
        } else {
            None
        }
    }

    fn query_all(&self, selector: &Selector) -> Vec<&Element> {
        if let Some(element) = self.as_element() {
            element.query_all(selector)
        } else {
            Vec::new()
        }
    }

    fn query_mut(&mut self, selector: &Selector) -> Option<&mut Element> {
        if let Some(element) = self.as_element_mut() {
            element.query_mut(selector)
        } else {
            None
        }
    }

    fn execute_for(&mut self, selector: &Selector, f: impl FnMut(&mut Element)) {
        if let Some(element) = self.as_element_mut() {
            element.execute_for(selector, f);
        }
    }
}