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
use parking_lot::{Once, OnceState};
use std::error::Error;
use std::fmt::{Debug, Display, Formatter};
use std::ops::{Deref, DerefMut};


static INITIALIZED: Once = Once::new();


pub fn initialize() {
    INITIALIZED.call_once(|| {
        crate::os::initialize();
    });
}

pub fn initialized() -> bool {
    INITIALIZED.state() != OnceState::New
}



// keep `x`, preventing llvm from optimizing it away as an unused variable.
pub fn keep<T>(x: T) -> T {
    unsafe { asm!["" : : "r"(&x)] }
    x
}



// asserts (at compile time) that some object is `Sync` or `Send`.
pub fn assert_send(_: impl Send) {
}
pub fn assert_sync(_: impl Sync) {
}
pub fn assert_send_sync(_: impl Send + Sync) {
}



// a trait that encompasses all types.
pub trait Any {}

impl<T> Any for T {
}



// an opaque error that be converted from any other error type.
#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct BlackHole;

impl<T> Into<Result<T, BlackHole>> for BlackHole {
    fn into(self) -> Result<T, BlackHole> {
        Err(BlackHole)
    }
}

// we cannot (yet) `impl std::error::Error`, or we'd run into orphan rule conflicts. wait until impl specialization is
// available.
//
//     impl Error for BlackHole {
//         fn description(&self) -> &str {
//             d!["BlackHole"]
//         }
//
//         fn cause(&self) -> Option<&Error> {
//             None
//         }
//     }

impl Display for BlackHole {
    fn fmt(&self, formatter: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
        match cfg!(debug) {
            true => writeln!(formatter, "BlackHole"),
            false => Ok(()),
        }
    }
}

impl<T> From<T> for BlackHole
where
    T: Error,
{
    fn from(_: T) -> BlackHole {
        BlackHole
    }
}



// // an type that can be converted from `BlackHole` and implements `std::error::Error`.
// //
// // this type exists because `BlackHole` cannot implement `Error` (due to conflicting implementations of From<> in
// // libcore`.
// #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
// pub struct BlackHoleError;
//
// impl Display for BlackHoleError {
//     fn fmt(&self, _: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
//         Ok(())
//     }
// }
//
// impl Error for BlackHoleError {
//     fn description(&self) -> &str {
//         d!["BlackHoleError"]
//     }
//
//     fn cause(&self) -> Option<&Error> {
//         None
//     }
// }
//
// impl From<BlackHole> for BlackHoleError {
//     fn from(_: BlackHole) -> BlackHoleError {
//         BlackHoleError
//     }
// }



// // a struct that wraps another type and marks it as `Sync`.
// #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
// pub struct SyncSafe<T> {
//     pub value: T,
// }
//
// impl<T> SyncSafe<T> {
//     pub fn into(self) -> T {
//         self.value
//     }
// }
//
// unsafe impl<T> Sync for SyncSafe<T> {
// }
//
// impl<T> Deref for SyncSafe<T> {
//     type Target = T;
//
//     fn deref(&self) -> &T {
//         &self.value
//     }
// }
//
// impl<T> DerefMut for SyncSafe<T> {
//     fn deref_mut(&mut self) -> &mut T {
//         &mut self.value
//     }
// }



// a wrapper type that ensures its wrapped item implements debug.
pub struct DefaultDebug<T>(pub T);

impl<T> Debug for DefaultDebug<T> {
    default fn fmt(&self, formatter: &mut Formatter) -> Result<(), std::fmt::Error> {
        if cfg!(debug) {
            write!(formatter, "{}", unsafe { std::intrinsics::type_name::<T>() })
        } else {
            Ok(())
        }
    }
}

impl<T> Debug for DefaultDebug<T>
where
    T: Debug,
{
    fn fmt(&self, formatter: &mut Formatter) -> Result<(), std::fmt::Error> {
        self.0.fmt(formatter)
    }
}

impl<T> Deref for DefaultDebug<T> {
    type Target = T;

    fn deref(&self) -> &T {
        &self.0
    }
}

impl<T> DerefMut for DefaultDebug<T> {
    fn deref_mut(&mut self) -> &mut T {
        &mut self.0
    }
}



// returns a slice as an array, if `byte_length(array) == byte_length(slice)`. this function is unsafe because `T` may
// not be a blittable type.
pub unsafe fn slice_as_array<T, TArray>(data: &[T]) -> Option<&TArray>
where
    TArray: AsRef<[T]>,
{
    let a = std::mem::size_of::<TArray>();
    let b = std::mem::size_of::<T>() * data.len();

    match a == b {
        true => Some(&*(data.as_ptr() as *const TArray)),
        false => None,
    }
}



// convert a singular `T` into a single element slice of `T`.
pub fn as_slice<T>(item: &T) -> &[T] {
    // safe: the memory layout of a singular `T` is always the same as an array of one `T`.
    unsafe { std::slice::from_raw_parts(item, 1) }
}

// convert a singular `T` into a single element slice of `T`.
pub fn as_slice_mut<T>(item: &mut T) -> &mut [T] {
    // safe: the memory layout of a singular `T` is always the same as an array of one `T`.
    unsafe { std::slice::from_raw_parts_mut(item, 1) }
}

// convert an `Option<T>` into a zero or single element slice of `T`.
pub fn option_as_slice<T>(value: &Option<T>) -> &[T] {
    match value {
        Some(x) => as_slice(x),
        None => &[],
    }
}

// convert an `Option<T>` into a zero or single element slice of `T`.
pub fn option_as_slice_mut<T>(value: &mut Option<T>) -> &mut [T] {
    match value {
        Some(x) => as_slice_mut(x),
        None => &mut [],
    }
}



// /// turns a generator into an `Iterator`.
// pub fn generate<TSource, TItem>(source: TSource) -> impl Iterator<Item = TItem>
//     where TSource: Generator<Return = (), Yield = TItem> {

//     return GeneratorObject { source, done: false };


//     struct GeneratorObject<TSource> {
//         done:   bool,
//         source: TSource,
//     }

//     impl<TSource> Iterator for GeneratorObject<TSource> where TSource: Generator<Return = ()> {
//         type Item = TSource::Yield;

//         fn next(&mut self) -> Option<TSource::Yield> {
//             if self.done {
//                 return None;
//             }

//             match unsafe { self.source.resume() } {
//                 GeneratorState::Yielded(x) => {
//                     Some(x)
//                 },
//                 GeneratorState::Complete(()) => {
//                     self.done = true;
//                     None
//                 }
//             }
//         }
//     }
// }



// a bitfield.
#[repr(C)]
#[derive(Debug, Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct BitField<TStorage, TAlignment>
where
    TStorage: AsRef<[u8]> + AsMut<[u8]>,
{
    storage:   TStorage,
    alignment: [TAlignment; 0],
}

impl<TStorage, TAlignment> BitField<TStorage, TAlignment>
where
    TStorage: AsRef<[u8]> + AsMut<[u8]>,
{
    #[inline]
    pub fn new(storage: TStorage) -> Self {
        BitField { storage, alignment: [] }
    }

    #[inline]
    pub fn get(&self, index: usize) -> bool {
        let storage = self.storage.as_ref();

        debug_assert![storage.len() >= index / 8];

        let byte = storage[index / 8];
        let shift = if cfg!(target_endian = "little") {
            index % 8
        } else {
            7 - (index % 8)
        };
        let mask = 1 << shift;

        byte & mask != 0
    }

    #[inline]
    pub fn set(&mut self, index: usize, value: bool) {
        let storage = self.storage.as_mut();

        debug_assert![storage.len() >= index / 8];

        let byte = &mut storage[index / 8];
        let shift = if cfg!(target_endian = "little") {
            index % 8
        } else {
            7 - (index % 8)
        };
        let mask = 1 << shift;

        match value {
            true => *byte |= mask,
            false => *byte &= !mask,
        }
    }

    #[inline]
    pub fn get_value<T>(&self, offset: usize, width: usize) -> T
    where
        T: From<u64>,
    {
        let storage = self.storage.as_ref();

        debug_assert![width <= 64];
        debug_assert![storage.len() > (offset + width) / 8];

        let mut value = 0u64;

        for i in 0..width {
            if self.get(offset + i) {
                let shift = if cfg!(target_endian = "big") { width - i - 1 } else { i };

                value |= 1 << shift;
            }
        }

        value.into()
    }

    #[inline]
    pub fn set_value<T>(&mut self, offset: usize, width: usize, value: T)
    where
        T: Into<u64>,
    {
        let storage = self.storage.as_ref();
        let value = Into::<u64>::into(value);

        debug_assert![width <= 64];
        debug_assert![storage.len() > (offset + width) / 8];

        for i in 0..width {
            let index = if cfg!(target_endian = "big") { width - i - 1 } else { i };
            let mask = 1 << i;

            self.set(index + offset, value & mask != 0);
        }
    }
}



// extensions to `std::vec::Vec`.
pub trait VecExt {
    /// clears this `vec<t>`. if `t` is copy, this method optimizes the clear by truncating the vec's length to zero,
    /// unlike `vec::<t>::clear()`.
    fn clear_vec(&mut self);
}

impl<T> VecExt for Vec<T> {
    default fn clear_vec(&mut self) {
        self.clear();
    }
}


impl<T> VecExt for Vec<T>
where
    T: Copy,
{
    fn clear_vec(&mut self) {
        // safe: `T` is copy.
        unsafe {
            self.set_len(0);
        }
    }
}



// extensions to `bool`.
pub trait BoolExt {
    fn as_option(&self) -> Option<()>;
}

impl BoolExt for bool {
    fn as_option(&self) -> Option<()> {
        match self {
            true => Some(()),
            false => None,
        }
    }
}