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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
use std::convert::TryFrom;
use std::fmt;
use std::iter::{Extend, FromIterator};
use gdnative_impl_proc_macros as macros;
use crate::core_types::access::{Aligned, MaybeUnaligned};
use crate::core_types::{
Color, GodotString, VariantArray, Vector2, Vector2Godot, Vector3, Vector3Godot,
};
use crate::private::get_api;
use crate::NewRef;
pub struct TypedArray<T: Element> {
inner: T::SysArray,
}
pub type Read<'a, T> = Aligned<ReadGuard<'a, T>>;
pub type Write<'a, T> = Aligned<WriteGuard<'a, T>>;
impl<T: Element> Drop for TypedArray<T> {
#[inline]
fn drop(&mut self) {
unsafe {
(T::destroy_fn(get_api()))(self.sys_mut());
}
}
}
impl<T: Element> Default for TypedArray<T> {
#[inline]
fn default() -> Self {
TypedArray::new()
}
}
impl<T: Element + fmt::Debug> fmt::Debug for TypedArray<T> {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_list().entries(self.read().iter()).finish()
}
}
impl<T: Element> Clone for TypedArray<T> {
#[inline]
fn clone(&self) -> Self {
self.new_ref()
}
}
impl<T: Element> NewRef for TypedArray<T> {
#[inline]
fn new_ref(&self) -> Self {
unsafe {
let mut inner = T::SysArray::default();
(T::new_copy_fn(get_api()))(&mut inner, self.sys());
TypedArray { inner }
}
}
}
impl<T: Element> TypedArray<T> {
#[inline]
pub fn new() -> Self {
unsafe {
let mut inner = T::SysArray::default();
(T::new_fn(get_api()))(&mut inner);
TypedArray { inner }
}
}
#[inline]
pub fn from_variant_array(array: &VariantArray) -> Self {
unsafe {
let mut inner = T::SysArray::default();
(T::new_with_array_fn(get_api()))(&mut inner, array.sys());
TypedArray { inner }
}
}
#[inline]
pub fn from_vec(mut src: Vec<T>) -> Self {
let mut arr = Self::new();
arr.append_vec(&mut src);
arr
}
#[inline]
pub fn push(&mut self, val: T) {
self.push_ref(&val)
}
#[inline]
pub fn push_ref(&mut self, val: &T) {
unsafe {
(T::append_fn(get_api()))(self.sys_mut(), T::element_to_sys_ref(val));
}
}
#[inline]
pub fn append(&mut self, src: &Self) {
unsafe {
(T::append_array_fn(get_api()))(self.sys_mut(), src.sys());
}
}
#[inline]
pub fn append_vec(&mut self, src: &mut Vec<T>) {
let start = self.len() as usize;
let new_len = start + src.len();
self.resize(i32::try_from(new_len).expect("new length should fit in i32"));
let mut write = self.write();
let mut drain = src.drain(..);
for dst in &mut write[start..] {
*dst = drain.next().unwrap();
}
assert!(drain.next().is_none());
}
#[inline]
pub fn insert(&mut self, offset: i32, val: T) -> bool {
self.insert_ref(offset, &val)
}
#[inline]
pub fn insert_ref(&mut self, offset: i32, val: &T) -> bool {
unsafe {
let status =
(T::insert_fn(get_api()))(self.sys_mut(), offset, T::element_to_sys_ref(val));
status != sys::godot_error_GODOT_OK
}
}
#[inline]
pub fn invert(&mut self) {
unsafe { (T::invert_fn(get_api()))(self.sys_mut()) }
}
#[inline]
pub fn remove(&mut self, idx: i32) {
unsafe {
(T::remove_fn(get_api()))(self.sys_mut(), idx);
}
}
#[inline]
pub fn resize(&mut self, size: i32) {
unsafe {
(T::resize_fn(get_api()))(self.sys_mut(), size);
}
}
#[inline]
pub fn get(&self, idx: i32) -> T {
unsafe { T::element_from_sys(T::get_fn(get_api())(self.sys(), idx)) }
}
#[inline]
pub fn set(&mut self, idx: i32, val: T) {
self.set_ref(idx, &val)
}
#[inline]
pub fn set_ref(&mut self, idx: i32, val: &T) {
unsafe {
(T::set_fn(get_api()))(self.sys_mut(), idx, T::element_to_sys_ref(val));
}
}
#[inline]
pub fn len(&self) -> i32 {
unsafe { (T::size_fn(get_api()))(self.sys()) }
}
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
#[inline]
pub fn read(&self) -> Read<'_, T> {
unsafe {
MaybeUnaligned::new(ReadGuard::new(self.sys()))
.try_into_aligned()
.expect("Pool array access should be aligned. This indicates a bug in Godot")
}
}
#[inline]
pub fn write(&mut self) -> Write<'_, T> {
unsafe {
MaybeUnaligned::new(WriteGuard::new(self.sys() as *mut _))
.try_into_aligned()
.expect("Pool array access should be aligned. This indicates a bug in Godot")
}
}
#[doc(hidden)]
#[inline]
pub fn sys(&self) -> *const T::SysArray {
&self.inner
}
#[doc(hidden)]
#[inline]
pub fn sys_mut(&mut self) -> *mut T::SysArray {
&mut self.inner
}
#[doc(hidden)]
#[inline]
pub fn from_sys(sys: T::SysArray) -> Self {
TypedArray { inner: sys }
}
}
impl<T: Element + Copy> TypedArray<T> {
#[inline]
pub fn from_slice(src: &[T]) -> Self {
let mut arr = Self::new();
arr.append_slice(src);
arr
}
#[inline]
pub fn append_slice(&mut self, src: &[T]) {
let start = self.len() as usize;
let new_len = start + src.len();
self.resize(i32::try_from(new_len).expect("new length should fit in i32"));
let mut write = self.write();
write[start..].copy_from_slice(src)
}
}
impl<T: Element> FromIterator<T> for TypedArray<T> {
#[inline]
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
let vec = iter.into_iter().collect::<Vec<_>>();
Self::from_vec(vec)
}
}
impl<T: Element> Extend<T> for TypedArray<T> {
#[inline]
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
let mut vec = iter.into_iter().collect::<Vec<_>>();
self.append_vec(&mut vec);
}
}
impl<T: Element + PartialEq> PartialEq for TypedArray<T> {
#[inline]
fn eq(&self, other: &Self) -> bool {
if self.len() != other.len() {
return false;
}
let left = self.read();
let right = other.read();
left.as_slice() == right.as_slice()
}
}
impl<T: Element + Eq> Eq for TypedArray<T> {}
pub struct ReadGuard<'a, T: Element> {
access: *mut T::SysReadAccess,
len: usize,
_marker: std::marker::PhantomData<&'a T>,
}
impl<'a, T: Element> ReadGuard<'a, T> {
#[inline]
unsafe fn new(arr: *const T::SysArray) -> Self {
let len = (T::size_fn(get_api()))(arr) as usize;
let access = (T::read_fn(get_api()))(arr);
Self {
access,
len,
_marker: std::marker::PhantomData,
}
}
}
unsafe impl<'a, T: Element> crate::core_types::access::Guard for ReadGuard<'a, T> {
type Target = T;
#[inline]
fn len(&self) -> usize {
self.len
}
#[inline]
fn read_ptr(&self) -> *const Self::Target {
unsafe {
let orig_ptr: *const T::SysTy = (T::read_access_ptr_fn(get_api()))(self.access);
orig_ptr as *const Self::Target
}
}
}
impl<'a, T: Element> Drop for ReadGuard<'a, T> {
#[inline]
fn drop(&mut self) {
unsafe {
(T::read_access_destroy_fn(get_api()))(self.access);
}
}
}
impl<'a, T: Element> Clone for ReadGuard<'a, T> {
#[inline]
fn clone(&self) -> Self {
let access = unsafe { (T::read_access_copy_fn(get_api()))(self.access) };
Self {
access,
len: self.len,
_marker: std::marker::PhantomData,
}
}
}
pub struct WriteGuard<'a, T: Element> {
access: *mut T::SysWriteAccess,
len: usize,
_marker: std::marker::PhantomData<&'a T>,
}
impl<'a, T: Element> WriteGuard<'a, T> {
#[inline]
unsafe fn new(arr: *mut T::SysArray) -> Self {
let len = (T::size_fn(get_api()))(arr) as usize;
let access = (T::write_fn(get_api()))(arr);
Self {
access,
len,
_marker: std::marker::PhantomData,
}
}
}
unsafe impl<'a, T: Element> crate::core_types::access::Guard for WriteGuard<'a, T> {
type Target = T;
#[inline]
fn len(&self) -> usize {
self.len
}
#[inline]
fn read_ptr(&self) -> *const Self::Target {
unsafe {
let orig_ptr: *const T::SysTy = (T::write_access_ptr_fn(get_api()))(self.access);
orig_ptr as *const Self::Target
}
}
}
unsafe impl<'a, T: Element> crate::core_types::access::WritePtr for WriteGuard<'a, T> {}
impl<'a, T: Element> Drop for WriteGuard<'a, T> {
#[inline]
fn drop(&mut self) {
unsafe {
(T::write_access_destroy_fn(get_api()))(self.access);
}
}
}
macros::decl_typed_array_element! {
pub trait Element: private::Sealed { .. }
}
macros::impl_typed_array_element! {
impl Element for u8 => byte { .. }
}
macros::impl_typed_array_element! {
impl Element for i32 => int { .. }
}
macros::impl_typed_array_element! {
impl Element for f32 => real { .. }
}
macros::impl_typed_array_element! {
impl Element for GodotString
as sys::godot_string
ref *const sys::godot_string
=> string
{ .. }
}
macros::impl_typed_array_element! {
impl Element for Vector2
as sys::godot_vector2
ref *const sys::godot_vector2
=> vector2
{ .. }
}
macros::impl_typed_array_element! {
impl Element for Vector3
as sys::godot_vector3
ref *const sys::godot_vector3
=> vector3
{ .. }
}
macros::impl_typed_array_element! {
impl Element for Color
as sys::godot_color
ref *const sys::godot_color
=> color
{ .. }
}
mod private {
pub trait Sealed {}
}