hicc-std 0.2.4

Based on hicc's ability to provide rust with the ability to call c++ standard container class interfaces
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
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use hicc::AbiType;
use std::iter::Iterator;
use std::marker::PhantomData;

hicc::cpp! {
    #include <deque>
    #include <algorithm>
}

hicc::import_class! {
    #[cpp(class = "template<class T, class Allocator> std::deque<T, Allocator>")]
    pub class deque<T> {
        /// ```
        /// use hicc_std::DequeInt;
        /// let deque = DequeInt::new();
        /// assert!(deque.is_empty());
        /// ```
        #[cpp(method = "bool empty() const")]
        pub fn is_empty(&self) -> bool;

        /// ```
        /// use hicc_std::DequeInt;
        /// let deque = DequeInt::new();
        /// assert_eq!(deque.size(), 0);
        /// ```
        #[cpp(method = "size_t size() const")]
        pub fn size(&self) -> usize;

        /// ```
        /// use hicc_std::DequeInt;
        /// let deque = DequeInt::new();
        /// println!("deque.max_size = {}", deque.max_size());
        /// ```
        #[cpp(method = "size_t max_size() const")]
        pub fn max_size(&self) -> usize;

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.push_back(&1);
        /// deque.clear();
        /// assert!(deque.is_empty());
        /// ```
        #[cpp(method = "void clear()")]
        pub fn clear(&mut self);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.resize(10, &1);
        /// deque.push_front(&2);
        /// // ...
        /// deque.shrink_to_fit();
        /// ```
        #[cpp(method = "void shrink_to_fit()")]
        pub fn shrink_to_fit(&mut self);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.resize(10, &1);
        /// assert_eq!(deque.size(), 10);
        /// assert_eq!(deque.back(), Some(&1));
        /// assert_eq!(deque.front(), Some(&1));
        /// assert_eq!(deque.get(5), Some(&1));
        /// ```
        #[cpp(method = "void resize(size_t, const T&)")]
        pub fn resize(&mut self, n: usize, val: &T);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.get(0), None);
        /// deque.push_front(&1);
        /// assert_eq!(deque.get(0), Some(&1));
        /// ```
        pub fn get(&self, pos: usize) -> Option<T::OutputRef<'_>> {
            if pos < self.size() {
                return unsafe { Some(self._at(pos)) };
            }
            None
        }
        #[cpp(method = "const T& at(size_t) const")]
        unsafe fn _at(&self, pos: usize) -> &T;

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.get(0), None);
        /// deque.push_front(&1);
        /// *deque.get_mut(0).unwrap() += 1;
        /// assert_eq!(deque.get(0), Some(&2));
        /// ```
        pub fn get_mut(&mut self, pos: usize) -> Option<T::OutputRefMut<'_>> {
            if pos < self.size() {
                return unsafe { Some(self._at_mut(pos)) };
            }
            None
        }
        #[cpp(method = "T& at(size_t)")]
        unsafe fn _at_mut(&mut self, pos: usize) -> &mut T;

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.back(), None);
        /// deque.push_back(&1);
        /// assert_eq!(deque.back(), Some(&1));
        /// ```
        pub fn back(&self) -> Option<T::OutputRef<'_>> {
            if !self.is_empty() {
                return unsafe { Some(self._back()) };
            }
            None
        }
        #[cpp(method = "const T& back() const")]
        unsafe fn _back(&self) -> &T;

        /// 1. 如果是`hicc::Pod<T>`,可通过`*back_mut() = <new value>`改为.
        /// 1. 如果是`c++ class`, 则必须通过`hicc::AbiClass::write`改写.
        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.back_mut(), None);
        /// deque.push_back(&1);
        /// *deque.back_mut().unwrap() += 1;
        /// assert_eq!(deque.back(), Some(&2));
        ///
        /// use hicc_std::{string, DequeString};
        /// use hicc::AbiClass;
        /// let mut deque = DequeString::new();
        /// deque.push_back(&string::from(hicc::cstr!("hello")));
        /// assert_eq!(deque.back(), Some(string::from(hicc::cstr!("hello")).into_ref()));
        /// deque.back_mut().unwrap().write(string::from(hicc::cstr!("world")));
        /// assert_eq!(deque.back(), Some(string::from(hicc::cstr!("world")).into_ref()));
        /// ```
        pub fn back_mut(&mut self) -> Option<T::OutputRefMut<'_>> {
            if !self.is_empty() {
                return unsafe { Some(self._back_mut()) };
            }
            None
        }
        #[cpp(method = "T& back()")]
        unsafe fn _back_mut(&mut self) -> &mut T;

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.front(), None);
        /// deque.push_back(&1);
        /// assert_eq!(deque.front(), Some(&1));
        /// ```
        pub fn front(&self) -> Option<T::OutputRef<'_>> {
            if !self.is_empty() {
                return unsafe { Some(self._front()) };
            }
            None
        }
        #[cpp(method = "const T& front() const")]
        unsafe fn _front(&self) -> &T;

        /// 1. 如果是`hicc::Pod<T>`,可通过`*back_mut() = <new value>`改为.
        /// 1. 如果是`c++ class`, 则必须通过`hicc::AbiClass::write`改写.
        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.front_mut(), None);
        /// deque.push_back(&1);
        /// *deque.front_mut().unwrap() += 1;
        /// assert_eq!(deque.front_mut(), Some(&mut 2));
        ///
        /// use hicc_std::{string, DequeString};
        /// use hicc::AbiClass;
        /// let mut deque = DequeString::new();
        /// deque.push_back(&string::from(hicc::cstr!("hello")));
        /// assert_eq!(deque.front(), Some(string::from(hicc::cstr!("hello")).into_ref()));
        /// deque.front_mut().unwrap().write(string::from(hicc::cstr!("world")));
        /// assert_eq!(deque.front(), Some(string::from(hicc::cstr!("world")).into_ref()));
        /// ```
        pub fn front_mut(&mut self) -> Option<T::OutputRefMut<'_>> {
            if !self.is_empty() {
                return unsafe { Some(self._front_mut()) };
            }
            None
        }
        #[cpp(method = "T& front()")]
        unsafe fn _front_mut(&mut self) -> &mut T;

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.assign(10, &1);
        /// assert_eq!(deque.size(), 10);
        /// ```
        #[cpp(method = "void assign(size_t, const T&)")]
        pub fn assign(&mut self, n: usize, val: &T);

        /// 如果为空不做任何改变.
        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.pop_back();
        /// deque.push_back(&1);
        /// deque.pop_back();
        /// assert!(deque.is_empty());
        /// ```
        pub fn pop_back(&mut self) {
            if !self.is_empty() {
                unsafe { self._pop_back(); }
            }
        }
        #[cpp(method = "void pop_back()")]
        unsafe fn _pop_back(&mut self);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// assert_eq!(deque.front(), None);
        /// deque.push_back(&1);
        /// assert_eq!(deque.front(), Some(&1));
        /// ```
        #[cpp(method = "void push_back(const T&)")]
        pub fn push_back(&mut self, val: &T);

        /// 如果为空不做任何改变.
        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.pop_front();
        /// deque.push_front(&1);
        /// deque.pop_front();
        /// assert!(deque.is_empty());
        /// ```
        pub fn pop_front(&mut self) {
            if !self.is_empty() {
                unsafe { self._pop_front(); }
            }
        }
        #[cpp(method = "void pop_front()")]
        unsafe fn _pop_front(&mut self);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.push_front(&1);
        /// assert_eq!(deque.front(), Some(&1));
        /// ```
        #[cpp(method = "void push_front(const T&)")]
        pub fn push_front(&mut self, val: &T);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.push_back(&1);
        /// deque.swap(&mut DequeInt::new());
        /// assert!(deque.is_empty());
        /// ```
        #[cpp(method = "void swap(Self&)")]
        pub fn swap(&mut self, other: &mut Self);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.insert(2, 10, &2);
        /// assert_eq!(deque.size(), 10);
        /// ```
        hicc::cpp! {
            static void insert(Self& self, size_t pos, size_t count, const T& val) {
                self.insert(self.begin() + std::min(pos, self.size()), count, val);
            }
        }
        #[cpp(func = "void SelfMethods::insert(Self&, size_t, size_t, const T&)")]
        pub fn insert(&mut self, pos: usize, count: usize, val: &T);

        /// ```
        /// use hicc_std::DequeInt;
        /// let mut deque = DequeInt::new();
        /// deque.erase(1, 9);
        /// deque.insert(0, 10, &2);
        /// deque.erase(1, 9);
        /// assert_eq!(deque.size(), 1);
        /// ```
        hicc::cpp! {
            static void erase(Self& self, size_t pos, size_t count) {
                pos = std::min(pos, self.size());
                count = std::min(count, self.size() - pos);
                self.erase(self.begin() + pos, self.begin() + pos + count);
            }
        }
        #[cpp(func = "void SelfMethods::erase(Self&, size_t, size_t)")]
        pub fn erase(&mut self, pos: usize, count: usize);
    }
}

unsafe impl<T: AbiType + Sync> Send for deque<T> {}
unsafe impl<T: AbiType + Sync> Sync for deque<T> {}

impl<T: AbiType> deque<T> {
    /// ```
    /// use hicc_std::DequeInt;
    /// let mut deque = DequeInt::new();
    /// deque.push_front(&1);
    /// deque.push_front(&2);
    /// let mut it = deque.iter();
    /// assert_eq!(it.next(), Some(&2));
    /// assert_eq!(it.next(), Some(&1));
    /// assert_eq!(it.next(), None);
    /// ```
    pub fn iter(&self) -> impl Iterator<Item = T::OutputRef<'_>> {
        DequeIter {
            deque: self,
            pos: 0,
            _mark: PhantomData,
        }
    }

    /// ```
    /// use hicc_std::DequeInt;
    /// let mut deque = DequeInt::new();
    /// deque.push_front(&1);
    /// deque.push_front(&3);
    /// deque.iter_mut().for_each(|v| *v += 1);
    /// let mut it = deque.iter();
    /// assert_eq!(it.next(), Some(&4));
    /// assert_eq!(it.next(), Some(&2));
    /// assert_eq!(it.next(), None);
    /// ```
    pub fn iter_mut(&mut self) -> impl Iterator<Item = T::OutputRefMut<'_>> {
        DequeIterMut {
            deque: self,
            pos: 0,
            _mark: PhantomData,
        }
    }

    /// ```
    /// use hicc_std::DequeInt;
    /// let mut deque = DequeInt::new();
    /// deque.push_front(&1);
    /// deque.push_front(&2);
    /// let mut it = deque.rev_iter();
    /// assert_eq!(it.next(), Some(&1));
    /// assert_eq!(it.next(), Some(&2));
    /// assert_eq!(it.next(), None);
    /// ```
    pub fn rev_iter(&self) -> impl Iterator<Item = T::OutputRef<'_>> {
        DequeRevIter {
            deque: self,
            pos: self.size(),
            _mark: PhantomData,
        }
    }

    /// ```
    /// use hicc_std::DequeInt;
    /// let mut deque = DequeInt::new();
    /// deque.push_front(&1);
    /// deque.push_front(&3);
    /// deque.rev_iter_mut().for_each(|v| *v += 1);
    /// let mut it = deque.rev_iter();
    /// assert_eq!(it.next(), Some(&2));
    /// assert_eq!(it.next(), Some(&4));
    /// assert_eq!(it.next(), None);
    /// ```
    pub fn rev_iter_mut(&mut self) -> impl Iterator<Item = T::OutputRefMut<'_>> {
        DequeRevIterMut {
            deque: self,
            pos: self.size(),
            _mark: PhantomData,
        }
    }
}

/// 对应`std::deque<T>::const_iterator`
struct DequeIter<'a, T: AbiType + 'static> {
    deque: *const deque<T>,
    pos: usize,
    _mark: PhantomData<&'a deque<T>>,
}

impl<'a, T: AbiType + 'static> Iterator for DequeIter<'a, T> {
    type Item = T::OutputRef<'a>;
    fn next(&mut self) -> Option<Self::Item> {
        let deque = unsafe { &*self.deque };
        if self.pos < deque.size() {
            self.pos += 1;
            return unsafe { Some(deque._at(self.pos - 1)) };
        }
        None
    }
}

/// 对应`std::deque<T>::iterator`
struct DequeIterMut<'a, T: AbiType + 'static> {
    deque: *mut deque<T>,
    pos: usize,
    _mark: PhantomData<&'a mut deque<T>>,
}

impl<'a, T: AbiType + 'static> Iterator for DequeIterMut<'a, T> {
    type Item = T::OutputRefMut<'a>;
    fn next(&mut self) -> Option<Self::Item> {
        let deque = unsafe { &mut *self.deque };
        if self.pos < deque.size() {
            self.pos += 1;
            return unsafe { Some(deque._at_mut(self.pos - 1)) };
        }
        None
    }
}

/// 对应`std::deque<T>::const_iterator`
struct DequeRevIter<'a, T: AbiType + 'static> {
    deque: *const deque<T>,
    pos: usize,
    _mark: PhantomData<&'a deque<T>>,
}

impl<'a, T: AbiType + 'static> Iterator for DequeRevIter<'a, T> {
    type Item = T::OutputRef<'a>;
    fn next(&mut self) -> Option<Self::Item> {
        let deque = unsafe { &*self.deque };
        if self.pos > 0 {
            self.pos -= 1;
            return unsafe { Some(deque._at(self.pos)) };
        }
        None
    }
}

/// 对应`std::deque<T>::iterator`
struct DequeRevIterMut<'a, T: AbiType + 'static> {
    deque: *mut deque<T>,
    pos: usize,
    _mark: PhantomData<&'a mut deque<T>>,
}

impl<'a, T: AbiType + 'static> Iterator for DequeRevIterMut<'a, T> {
    type Item = T::OutputRefMut<'a>;
    fn next(&mut self) -> Option<Self::Item> {
        let deque = unsafe { &mut *self.deque };
        if self.pos > 0 {
            self.pos -= 1;
            return unsafe { Some(deque._at_mut(self.pos)) };
        }
        None
    }
}