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

use std::mem;
use std::ops::{Deref, DerefMut};

/// Manually managed Godot classes implementing `free`.
pub trait Free {
    unsafe fn godot_free(self);
}

/// Manually managed Godot classes implementing `queue_free`.
pub trait QueueFree {
    unsafe fn godot_queue_free(&mut self);
}

/// A wrapper that automatically frees the object when dropped.
pub struct FreeOnDrop<T: Free + Clone> {
    ptr: T,
}

impl<T> FreeOnDrop<T>
where
    T: Free + Clone,
{
    pub unsafe fn new(ptr: T) -> Self {
        FreeOnDrop { ptr }
    }

    pub fn forget(self) -> T {
        let ptr = self.ptr.clone();
        mem::forget(self);

        ptr
    }
}

impl<T> Drop for FreeOnDrop<T>
where
    T: Free + Clone,
{
    fn drop(&mut self) {
        unsafe {
            self.ptr.clone().godot_free();
        }
    }
}

impl<T> Deref for FreeOnDrop<T>
where
    T: Free + Clone,
{
    type Target = T;
    fn deref(&self) -> &T {
        &self.ptr
    }
}

impl<T> DerefMut for FreeOnDrop<T>
where
    T: Free + Clone,
{
    fn deref_mut(&mut self) -> &mut T {
        &mut self.ptr
    }
}

/// A wrapper that automatically enqueues the object for deletion when dropped.
pub struct QueueFreeOnDrop<T: QueueFree + Clone> {
    ptr: T,
}

impl<T> QueueFreeOnDrop<T>
where
    T: QueueFree + Clone,
{
    pub unsafe fn new(ptr: T) -> Self {
        QueueFreeOnDrop { ptr }
    }

    pub fn forget(self) -> T {
        let ptr = self.ptr.clone();
        mem::forget(self);

        ptr
    }
}

impl<T> Drop for QueueFreeOnDrop<T>
where
    T: QueueFree + Clone,
{
    fn drop(&mut self) {
        unsafe {
            self.ptr.godot_queue_free();
        }
    }
}

impl<T> Deref for QueueFreeOnDrop<T>
where
    T: QueueFree + Clone,
{
    type Target = T;
    fn deref(&self) -> &T {
        &self.ptr
    }
}

impl<T> DerefMut for QueueFreeOnDrop<T>
where
    T: QueueFree + Clone,
{
    fn deref_mut(&mut self) -> &mut T {
        &mut self.ptr
    }
}