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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/// Implements iteration over a tree
use crate::{entry::Entry, id::NodeId, node::Node, tree::Tree};

impl<T> Tree<T> {
    #[must_use]
    pub fn iter(&self) -> Iter<T> {
        Iter {
            current: self.first_node,
            nodes: &self.nodes,
        }
    }

    #[must_use]
    pub fn iter_from(&self, id: &NodeId) -> Iter<T> {
        Iter {
            current: self.index(id),
            nodes: &self.nodes,
        }
    }

    #[must_use]
    pub fn iter_mut(&mut self) -> IterMut<T> {
        IterMut {
            current: self.first_node,
            nodes: self
                .nodes
                .iter_mut()
                .filter_map(|entry| match entry {
                    Entry::Free { .. } => None,
                    Entry::Occupied(node) => Some(Node {
                        value: Some(&mut node.value),
                        parent: node.parent,
                        first_child: node.first_child,
                        last_child: node.last_child,
                        next_sibling: node.next_sibling,
                        prev_sibling: node.prev_sibling,
                    }),
                })
                .collect(),
        }
    }

    #[must_use]
    pub fn into_iterator(self) -> IntoIter<T> {
        IntoIter {
            current: self.first_node,
            nodes: self
                .nodes
                .into_iter()
                .filter_map(|entry| match entry {
                    Entry::Free { .. } => None,
                    Entry::Occupied(node) => Some(Node {
                        value: Some(node.value),
                        parent: node.parent,
                        first_child: node.first_child,
                        last_child: node.last_child,
                        next_sibling: node.next_sibling,
                        prev_sibling: node.prev_sibling,
                    }),
                })
                .collect(),
        }
    }
}

impl<'a, T> IntoIterator for &'a Tree<T> {
    type Item = &'a T;

    type IntoIter = Iter<'a, T>;

    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}

impl<T> IntoIterator for Tree<T> {
    type Item = T;

    type IntoIter = IntoIter<T>;

    fn into_iter(self) -> Self::IntoIter {
        self.into_iterator()
    }
}

#[derive(Debug)]
pub struct Iter<'a, T> {
    current: Option<usize>,
    nodes: &'a [Entry<T>],
}

impl<'a, T> Iterator for Iter<'a, T> {
    type Item = &'a T;

    fn next(&mut self) -> Option<Self::Item> {
        self.current.take().map(|current| {
            let node = &self.nodes[current];

            if let Some(child) = node.unwrap_ref().first_child {
                self.current = Some(child);
            } else if let Some(sibling) = node.unwrap_ref().next_sibling {
                self.current = Some(sibling);
            } else {
                // Start from the current node
                let mut next = node.unwrap_ref();
                // Cycle to the parent to search for the next sibling or go up the tree
                while let Some(parent_index) = next.parent {
                    next = self.nodes[parent_index].unwrap_ref();
                    if next.next_sibling.is_some() {
                        break;
                    }
                }
                // If next.sibling is Some we have the next node, otherwise both next.parent is None
                // and next.next_sibling is None
                self.current = next.next_sibling;
            }

            &node.unwrap_ref().value
        })
    }
}

#[derive(Debug)]
pub struct IterMut<'a, T> {
    current: Option<usize>,
    nodes: Vec<Node<Option<&'a mut T>>>,
}

impl<'a, T> Iterator for IterMut<'a, T> {
    type Item = &'a mut T;

    fn next(&mut self) -> Option<Self::Item> {
        self.current.take().and_then(|current| {
            // TODO: this could done more safely
            let node = &self.nodes[current];

            if let Some(child) = node.first_child {
                self.current = Some(child);
            } else if let Some(sibling) = node.next_sibling {
                self.current = Some(sibling);
            } else {
                // Start from the current node
                let mut next = node;
                // Cycle to the parent to search for the next sibling or go up the tree
                while let Some(parent_index) = next.parent {
                    next = &self.nodes[parent_index];
                    if next.next_sibling.is_some() {
                        break;
                    }
                }
                // If next.sibling is Some we have the next node, otherwise both next.parent is None
                // and next.next_sibling is None
                self.current = next.next_sibling;
            }

            self.nodes[current].value.take()
        })
    }
}

#[derive(Debug)]
pub struct IntoIter<T> {
    current: Option<usize>,
    nodes: Vec<Node<Option<T>>>,
}

impl<T> Iterator for IntoIter<T> {
    type Item = T;

    fn next(&mut self) -> Option<Self::Item> {
        self.current.take().and_then(|current| {
            let node = &self.nodes[current];

            if let Some(child) = node.first_child {
                self.current = Some(child);
            } else if let Some(sibling) = node.next_sibling {
                self.current = Some(sibling);
            } else {
                // Start from the current node
                let mut next = node;
                // Cycle to the parent to search for the next sibling or go up the tree
                while let Some(parent_index) = next.parent {
                    next = &self.nodes[parent_index];
                    if next.next_sibling.is_some() {
                        break;
                    }
                }
                // If next.sibling is Some we have the next node, otherwise both next.parent is None
                // and next.next_sibling is None
                self.current = next.next_sibling;
            }

            self.nodes[current].value.take()
        })
    }
}

#[cfg(test)]
mod test {
    use crate::tree::Tree;
    use pretty_assertions::assert_eq;

    #[test]
    fn should_return_none_on_empty() {
        let tree = Tree::<i32>::new();

        assert_eq!(None, tree.iter().next());
    }

    #[test]
    fn should_iter_children() {
        let mut tree = Tree::<i32>::new();

        tree.append_child(1);
        tree.append_child(2);

        let mut iter = tree.iter();

        assert_eq!(1, *iter.next().unwrap());
        assert_eq!(2, *iter.next().unwrap());
    }

    #[test]
    fn should_iter_siblings() {
        let mut tree = Tree::<i32>::new();

        tree.append_sibling(1);
        tree.append_sibling(2);

        dbg!(&tree);

        let mut iter = tree.iter();

        assert_eq!(1, *iter.next().unwrap());
        assert_eq!(2, *iter.next().unwrap());
    }

    #[test]
    fn mut_should_return_none_on_empty() {
        let mut tree = Tree::<i32>::new();

        assert_eq!(None, tree.iter_mut().next());
    }

    #[test]
    fn mut_should_iter_children() {
        let mut tree = Tree::<i32>::new();

        tree.append_child(1);
        tree.append_child(2);

        let mut iter = tree.iter_mut();

        assert_eq!(1, *iter.next().unwrap());
        assert_eq!(2, *iter.next().unwrap());
    }

    #[test]
    fn mut_should_iter_siblings() {
        let mut tree = Tree::<i32>::new();

        tree.append_sibling(1);
        tree.append_sibling(2);

        dbg!(&tree);

        let mut iter = tree.iter_mut();

        assert_eq!(1, *iter.next().unwrap());
        assert_eq!(2, *iter.next().unwrap());
    }

    #[test]
    fn into_should_return_none_on_empty() {
        let tree = Tree::<i32>::new();

        assert_eq!(None, tree.into_iterator().next());
    }

    #[test]
    fn into_should_iter_children() {
        let mut tree = Tree::<i32>::new();

        tree.append_child(1);
        tree.append_child(2);

        let mut iter = tree.into_iterator();

        assert_eq!(1, iter.next().unwrap());
        assert_eq!(2, iter.next().unwrap());
    }

    #[test]
    fn into_should_iter_siblings() {
        let mut tree = Tree::<i32>::new();

        tree.append_sibling(1);
        tree.append_sibling(2);

        dbg!(&tree);

        let mut iter = tree.into_iterator();

        assert_eq!(1, iter.next().unwrap());
        assert_eq!(2, iter.next().unwrap());
    }
}