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
// Copyright 2018-2022 Parity Technologies (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::traits::{
    impls::{
        forward_allocate_packed,
        forward_clear_packed,
        forward_pull_packed,
        forward_push_packed,
    },
    KeyPtr,
    PackedAllocate,
    PackedLayout,
    SpreadAllocate,
    SpreadLayout,
};
use ink_prelude::{
    collections::{
        BTreeMap as StdBTreeMap,
        BTreeSet as StdBTreeSet,
        BinaryHeap as StdBinaryHeap,
        LinkedList as StdLinkedList,
        VecDeque as StdVecDeque,
    },
    vec::Vec,
};
use ink_primitives::Key;

impl<K, V> SpreadLayout for StdBTreeMap<K, V>
where
    K: PackedLayout + Ord,
    V: PackedLayout,
{
    const FOOTPRINT: u64 = 1;
    const REQUIRES_DEEP_CLEAN_UP: bool = <V as SpreadLayout>::REQUIRES_DEEP_CLEAN_UP;

    #[inline]
    fn pull_spread(ptr: &mut KeyPtr) -> Self {
        forward_pull_packed::<Self>(ptr)
    }

    #[inline]
    fn push_spread(&self, ptr: &mut KeyPtr) {
        forward_push_packed::<Self>(self, ptr)
    }

    #[inline]
    fn clear_spread(&self, ptr: &mut KeyPtr) {
        forward_clear_packed::<Self>(self, ptr)
    }
}

impl<K, V> SpreadAllocate for StdBTreeMap<K, V>
where
    K: PackedAllocate + Ord,
    V: PackedAllocate,
{
    #[inline]
    fn allocate_spread(ptr: &mut KeyPtr) -> Self {
        forward_allocate_packed::<Self>(ptr)
    }
}

impl<K, V> PackedLayout for StdBTreeMap<K, V>
where
    K: PackedLayout + Ord,
    V: PackedLayout,
{
    fn push_packed(&self, at: &Key) {
        for (key, val) in self {
            <K as PackedLayout>::push_packed(key, at);
            <V as PackedLayout>::push_packed(val, at);
        }
    }

    fn clear_packed(&self, at: &Key) {
        for (key, val) in self {
            <K as PackedLayout>::clear_packed(key, at);
            <V as PackedLayout>::clear_packed(val, at);
        }
    }

    fn pull_packed(&mut self, at: &Key) {
        // We cannot mutate keys in a map so we can forward pull signals
        // only to the values of a map.
        for val in self.values_mut() {
            <V as PackedLayout>::pull_packed(val, at);
        }
    }
}

impl<K, V> PackedAllocate for StdBTreeMap<K, V>
where
    K: PackedAllocate + Ord,
    V: PackedAllocate,
{
    fn allocate_packed(&mut self, at: &Key) {
        // We cannot mutate keys in a map so we can forward allocate signals
        // only to the values of a map.
        for val in self.values_mut() {
            <V as PackedAllocate>::allocate_packed(val, at);
        }
    }
}

impl<T> SpreadLayout for StdBTreeSet<T>
where
    T: PackedLayout + Ord,
{
    const FOOTPRINT: u64 = 1;
    const REQUIRES_DEEP_CLEAN_UP: bool = <T as SpreadLayout>::REQUIRES_DEEP_CLEAN_UP;

    #[inline]
    fn pull_spread(ptr: &mut KeyPtr) -> Self {
        forward_pull_packed::<Self>(ptr)
    }

    #[inline]
    fn push_spread(&self, ptr: &mut KeyPtr) {
        forward_push_packed::<Self>(self, ptr)
    }

    #[inline]
    fn clear_spread(&self, ptr: &mut KeyPtr) {
        forward_clear_packed::<Self>(self, ptr)
    }
}

impl<T> SpreadAllocate for StdBTreeSet<T>
where
    T: PackedAllocate + Ord,
{
    #[inline]
    fn allocate_spread(ptr: &mut KeyPtr) -> Self {
        forward_allocate_packed::<Self>(ptr)
    }
}

impl<T> PackedLayout for StdBTreeSet<T>
where
    T: PackedLayout + Ord,
{
    fn push_packed(&self, at: &Key) {
        for key in self {
            <T as PackedLayout>::push_packed(key, at);
        }
    }

    fn clear_packed(&self, at: &Key) {
        for key in self {
            <T as PackedLayout>::clear_packed(key, at);
        }
    }

    #[inline]
    fn pull_packed(&mut self, _at: &Key) {
        // We cannot mutate keys in a set so we cannot forward pull signals.
    }
}

impl<T> PackedAllocate for StdBTreeSet<T>
where
    T: PackedAllocate + Ord,
{
    #[inline]
    fn allocate_packed(&mut self, _at: &Key) {
        // We cannot mutate keys in a set so we cannot forward pull signals.
    }
}

impl<T> SpreadLayout for StdBinaryHeap<T>
where
    T: PackedLayout + Ord,
{
    const FOOTPRINT: u64 = 1;
    const REQUIRES_DEEP_CLEAN_UP: bool = <T as SpreadLayout>::REQUIRES_DEEP_CLEAN_UP;

    #[inline]
    fn pull_spread(ptr: &mut KeyPtr) -> Self {
        forward_pull_packed::<Self>(ptr)
    }

    #[inline]
    fn push_spread(&self, ptr: &mut KeyPtr) {
        forward_push_packed::<Self>(self, ptr)
    }

    #[inline]
    fn clear_spread(&self, ptr: &mut KeyPtr) {
        forward_clear_packed::<Self>(self, ptr)
    }
}

impl<T> SpreadAllocate for StdBinaryHeap<T>
where
    T: PackedAllocate + Ord,
{
    #[inline]
    fn allocate_spread(ptr: &mut KeyPtr) -> Self {
        forward_allocate_packed::<Self>(ptr)
    }
}

impl<T> PackedLayout for StdBinaryHeap<T>
where
    T: PackedLayout + Ord,
{
    fn push_packed(&self, at: &Key) {
        for value in self {
            <T as PackedLayout>::push_packed(value, at);
        }
    }

    fn clear_packed(&self, at: &Key) {
        for value in self {
            <T as PackedLayout>::clear_packed(value, at);
        }
    }

    #[inline]
    fn pull_packed(&mut self, _at: &Key) {
        // We cannot mutate keys in a heap so we cannot forward pull signals.
    }
}

impl<T> PackedAllocate for StdBinaryHeap<T>
where
    T: PackedAllocate + Ord,
{
    #[inline]
    fn allocate_packed(&mut self, _at: &Key) {
        // We cannot mutate keys in a heap so we cannot forward pull signals.
    }
}

macro_rules! impl_push_at_for_collection {
    ( $($collection:ident),* $(,)? ) => {
        $(
            impl_always_packed_layout!($collection<T>, deep: <T as SpreadLayout>::REQUIRES_DEEP_CLEAN_UP);

            impl<T> PackedLayout for $collection<T>
            where
                T: PackedLayout,
            {
                fn push_packed(&self, at: &Key) {
                    for elem in self {
                        <T as PackedLayout>::push_packed(elem, at)
                    }
                }

                fn clear_packed(&self, at: &Key) {
                    for elem in self {
                        <T as PackedLayout>::clear_packed(elem, at)
                    }
                }

                fn pull_packed(&mut self, at: &Key) {
                    for elem in self {
                        <T as PackedLayout>::pull_packed(elem, at)
                    }
                }
            }

            impl<T> PackedAllocate for $collection<T>
            where
                T: PackedAllocate,
            {
                fn allocate_packed(&mut self, at: &Key) {
                    for elem in self {
                        <T as PackedAllocate>::allocate_packed(elem, at)
                    }
                }
            }
        )*
    };
}
impl_push_at_for_collection!(Vec, StdLinkedList, StdVecDeque,);