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
use core::ptr;

use super::node::{marker, ForceResult::*, Handle, NodeRef};
use super::unwrap_unchecked;

macro_rules! def_next {
    { unsafe fn $name:ident : $next_kv:ident $next_edge:ident $initial_leaf_edge:ident } => {
        /// Given a leaf edge handle into an immutable tree, returns a handle to the next
        /// leaf edge and references to the key and value between these edges.
        /// Unsafe because the caller must ensure that the given leaf edge has a successor.
        unsafe fn $name <'a, K: 'a, V: 'a>(
            leaf_edge: Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge>,
        ) -> (Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge>, &'a K, &'a V) {
            let mut cur_handle = match leaf_edge.$next_kv() {
                Ok(leaf_kv) => {
                    let (k, v) = leaf_kv.into_kv();
                    let next_leaf_edge = leaf_kv.$next_edge();
                    return (next_leaf_edge, k, v);
                }
                Err(last_edge) => {
                    let next_level = last_edge.into_node().ascend().ok();
                    unwrap_unchecked(next_level)
                }
            };

            loop {
                cur_handle = match cur_handle.$next_kv() {
                    Ok(internal_kv) => {
                        let (k, v) = internal_kv.into_kv();
                        let next_internal_edge = internal_kv.$next_edge();
                        let next_leaf_edge = next_internal_edge.descend().$initial_leaf_edge();
                        return (next_leaf_edge, k, v);
                    }
                    Err(last_edge) => {
                        let next_level = last_edge.into_node().ascend().ok();
                        unwrap_unchecked(next_level)
                    }
                }
            }
        }
    };
}

macro_rules! def_next_mut {
    { unsafe fn $name:ident : $next_kv:ident $next_edge:ident $initial_leaf_edge:ident } => {
        /// Given a leaf edge handle into a mutable tree, returns handles to the next
        /// leaf edge and to the KV between these edges.
        /// Unsafe for two reasons:
        /// - the caller must ensure that the given leaf edge has a successor;
        /// - both returned handles represent mutable references into the same tree
        ///   that can easily invalidate each other, even on immutable use.
        unsafe fn $name <'a, K: 'a, V: 'a>(
            leaf_edge: Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>,
        ) -> (Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>,
              Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>) {
            let mut cur_handle = match leaf_edge.$next_kv() {
                Ok(leaf_kv) => {
                    let next_leaf_edge = ptr::read(&leaf_kv).$next_edge();
                    return (next_leaf_edge, leaf_kv.forget_node_type());
                }
                Err(last_edge) => {
                    let next_level = last_edge.into_node().ascend().ok();
                    unwrap_unchecked(next_level)
                }
            };

            loop {
                cur_handle = match cur_handle.$next_kv() {
                    Ok(internal_kv) => {
                        let next_internal_edge = ptr::read(&internal_kv).$next_edge();
                        let next_leaf_edge = next_internal_edge.descend().$initial_leaf_edge();
                        return (next_leaf_edge, internal_kv.forget_node_type());
                    }
                    Err(last_edge) => {
                        let next_level = last_edge.into_node().ascend().ok();
                        unwrap_unchecked(next_level)
                    }
                }
            }
        }
    };
}

macro_rules! def_next_dealloc {
    { unsafe fn $name:ident : $next_kv:ident $next_edge:ident $initial_leaf_edge:ident } => {
        /// Given a leaf edge handle into an owned tree, returns a handle to the next
        /// leaf edge and the key and value between these edges, while deallocating
        /// any node left behind.
        /// Unsafe for two reasons:
        /// - the caller must ensure that the given leaf edge has a successor;
        /// - the node pointed at by the given handle, and its ancestors, may be deallocated,
        ///   while the reference to those nodes in the surviving ancestors is left dangling;
        ///   thus using the returned handle is dangerous.
        unsafe fn $name <K, V>(
            leaf_edge: Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge>,
        ) -> (Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge>, K, V) {
            let mut cur_handle = match leaf_edge.$next_kv() {
                Ok(leaf_kv) => {
                    let k = ptr::read(leaf_kv.reborrow().into_kv().0);
                    let v = ptr::read(leaf_kv.reborrow().into_kv().1);
                    let next_leaf_edge = leaf_kv.$next_edge();
                    return (next_leaf_edge, k, v);
                }
                Err(last_edge) => {
                    unwrap_unchecked(last_edge.into_node().deallocate_and_ascend())
                }
            };

            loop {
                cur_handle = match cur_handle.$next_kv() {
                    Ok(internal_kv) => {
                        let k = ptr::read(internal_kv.reborrow().into_kv().0);
                        let v = ptr::read(internal_kv.reborrow().into_kv().1);
                        let next_internal_edge = internal_kv.$next_edge();
                        let next_leaf_edge = next_internal_edge.descend().$initial_leaf_edge();
                        return (next_leaf_edge, k, v);
                    }
                    Err(last_edge) => {
                        unwrap_unchecked(last_edge.into_node().deallocate_and_ascend())
                    }
                }
            }
        }
    };
}

def_next! {unsafe fn next_unchecked: right_kv right_edge first_leaf_edge}
def_next! {unsafe fn next_back_unchecked: left_kv left_edge last_leaf_edge}
def_next_mut! {unsafe fn next_unchecked_mut: right_kv right_edge first_leaf_edge}
def_next_mut! {unsafe fn next_back_unchecked_mut: left_kv left_edge last_leaf_edge}
def_next_dealloc! {unsafe fn next_unchecked_deallocating: right_kv right_edge first_leaf_edge}
def_next_dealloc! {unsafe fn next_back_unchecked_deallocating: left_kv left_edge last_leaf_edge}

impl<'a, K, V> Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge> {
    /// Moves the leaf edge handle to the next leaf edge and returns references to the
    /// key and value in between.
    /// Unsafe because the caller must ensure that the leaf edge is not the last one in the tree.
    pub unsafe fn next_unchecked(&mut self) -> (&'a K, &'a V) {
        let (next_edge, k, v) = next_unchecked(*self);
        *self = next_edge;
        (k, v)
    }

    /// Moves the leaf edge handle to the previous leaf edge and returns references to the
    /// key and value in between.
    /// Unsafe because the caller must ensure that the leaf edge is not the first one in the tree.
    pub unsafe fn next_back_unchecked(&mut self) -> (&'a K, &'a V) {
        let (next_edge, k, v) = next_back_unchecked(*self);
        *self = next_edge;
        (k, v)
    }
}

impl<'a, K, V> Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge> {
    /// Moves the leaf edge handle to the next leaf edge and returns references to the
    /// key and value in between.
    /// Unsafe for two reasons:
    /// - The caller must ensure that the leaf edge is not the last one in the tree.
    /// - Using the updated handle may well invalidate the returned references.
    pub unsafe fn next_unchecked(&mut self) -> (&'a mut K, &'a mut V) {
        let (next_edge, kv) = next_unchecked_mut(ptr::read(self));
        *self = next_edge;
        // Doing the descend (and perhaps another move) invalidates the references
        // returned by `into_kv_mut`, so we have to do this last.
        kv.into_kv_mut()
    }

    /// Moves the leaf edge handle to the previous leaf and returns references to the
    /// key and value in between.
    /// Unsafe for two reasons:
    /// - The caller must ensure that the leaf edge is not the first one in the tree.
    /// - Using the updated handle may well invalidate the returned references.
    pub unsafe fn next_back_unchecked(&mut self) -> (&'a mut K, &'a mut V) {
        let (next_edge, kv) = next_back_unchecked_mut(ptr::read(self));
        *self = next_edge;
        // Doing the descend (and perhaps another move) invalidates the references
        // returned by `into_kv_mut`, so we have to do this last.
        kv.into_kv_mut()
    }
}

impl<K, V> Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge> {
    /// Moves the leaf edge handle to the next leaf edge and returns the key and value
    /// in between, while deallocating any node left behind.
    /// Unsafe for three reasons:
    /// - The caller must ensure that the leaf edge is not the last one in the tree
    ///   and is not a handle previously resulting from counterpart `next_back_unchecked`.
    /// - If the leaf edge is the last edge of a node, that node and possibly ancestors
    ///   will be deallocated, while the reference to those nodes in the surviving ancestor
    ///   is left dangling; thus further use of the leaf edge handle is dangerous.
    ///   It is, however, safe to call this method again on the updated handle.
    ///   if the two preconditions above hold.
    /// - Using the updated handle may well invalidate the returned references.
    pub unsafe fn next_unchecked(&mut self) -> (K, V) {
        let (next_edge, k, v) = next_unchecked_deallocating(ptr::read(self));
        *self = next_edge;
        (k, v)
    }

    /// Moves the leaf edge handle to the previous leaf edge and returns the key
    /// and value in between, while deallocating any node left behind.
    /// Unsafe for three reasons:
    /// - The caller must ensure that the leaf edge is not the first one in the tree
    ///   and is not a handle previously resulting from counterpart `next_unchecked`.
    /// - If the lead edge is the first edge of a node, that node and possibly ancestors
    ///   will be deallocated, while the reference to those nodes in the surviving ancestor
    ///   is left dangling; thus further use of the leaf edge handle is dangerous.
    ///   It is, however, safe to call this method again on the updated handle.
    ///   if the two preconditions above hold.
    /// - Using the updated handle may well invalidate the returned references.
    pub unsafe fn next_back_unchecked(&mut self) -> (K, V) {
        let (next_edge, k, v) = next_back_unchecked_deallocating(ptr::read(self));
        *self = next_edge;
        (k, v)
    }
}

impl<BorrowType, K, V> NodeRef<BorrowType, K, V, marker::LeafOrInternal> {
    /// Returns the leftmost leaf edge in or underneath a node - in other words, the edge
    /// you need first when navigating forward (or last when navigating backward).
    #[inline]
    pub fn first_leaf_edge(self) -> Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge> {
        let mut node = self;
        loop {
            match node.force() {
                Leaf(leaf) => return leaf.first_edge(),
                Internal(internal) => node = internal.first_edge().descend(),
            }
        }
    }

    /// Returns the rightmost leaf edge in or underneath a node - in other words, the edge
    /// you need last when navigating forward (or first when navigating backward).
    #[inline]
    pub fn last_leaf_edge(self) -> Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge> {
        let mut node = self;
        loop {
            match node.force() {
                Leaf(leaf) => return leaf.last_edge(),
                Internal(internal) => node = internal.last_edge().descend(),
            }
        }
    }
}