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
// Copyright © 2017-2018 Mozilla Foundation
//
// This program is made available under an ISC-style license.  See the
// accompanying file LICENSE for details.

use std::cell::UnsafeCell;
pub struct Opaque(UnsafeCell<()>);

/// Generate a newtype wrapper `$owned` and reference wrapper
/// `$borrowed` around a POD FFI type that lives on the heap.
macro_rules! ffi_type_heap {
    (
        $(#[$impl_attr:meta])*
        type CType = $ctype:ty;
        $(fn drop = $drop:expr;)*
        $(fn clone = $clone:expr;)*
        $(#[$owned_attr:meta])*
        pub struct $owned:ident;
        $(#[$borrowed_attr:meta])*
        pub struct $borrowed:ident;
    ) => {
        $(#[$owned_attr])*
        pub struct $owned(*mut $ctype);

        impl $owned {
            #[inline]
            pub unsafe fn from_ptr(ptr: *mut $ctype) -> $owned {
                $owned(ptr)
            }

            #[inline]
            pub fn as_ptr(&self) -> *mut $ctype {
                self.0
            }
        }

        $(
            impl Drop for $owned {
                #[inline]
                fn drop(&mut self) {
                    unsafe { $drop(self.0) }
                }
            }
        )*

        $(
            impl Clone for $owned {
                #[inline]
                fn clone(&self) -> $owned {
                    unsafe {
                        let handle: *mut $ctype = $clone(self.0);
                        $owned::from_ptr(handle)
                    }
                }
            }

            impl ::std::borrow::ToOwned for $borrowed {
                type Owned = $owned;
                #[inline]
                fn to_owned(&self) -> $owned {
                    unsafe {
                        let handle: *mut $ctype = $clone(self.as_ptr());
                        $owned::from_ptr(handle)
                    }
                }
            }
        )*

        impl ::std::ops::Deref for $owned {
            type Target = $borrowed;

            #[inline]
            fn deref(&self) -> &$borrowed {
                unsafe { $borrowed::from_ptr(self.0) }
            }
        }

        impl ::std::ops::DerefMut for $owned {
            #[inline]
            fn deref_mut(&mut self) -> &mut $borrowed {
                unsafe { $borrowed::from_ptr_mut(self.0) }
            }
        }

        impl ::std::borrow::Borrow<$borrowed> for $owned {
            #[inline]
            fn borrow(&self) -> &$borrowed {
                &**self
            }
        }

        impl ::std::convert::AsRef<$borrowed> for $owned {
            #[inline]
            fn as_ref(&self) -> &$borrowed {
                &**self
            }
        }

        $(#[$borrowed_attr])*
        pub struct $borrowed($crate::ffi_types::Opaque);

        impl $borrowed {
            #[inline]
            pub unsafe fn from_ptr<'a>(ptr: *mut $ctype) -> &'a Self {
                &*(ptr as *mut _)
            }

            #[inline]
            pub unsafe fn from_ptr_mut<'a>(ptr: *mut $ctype) -> &'a mut Self {
                &mut *(ptr as *mut _)
            }

            #[inline]
            pub fn as_ptr(&self) -> *mut $ctype {
                self as *const _ as *mut _
            }
        }

        impl ::std::fmt::Debug for $borrowed {
            fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
                let ptr = self as *const $borrowed as usize;
                f.debug_tuple(stringify!($borrowed))
                    .field(&ptr)
                    .finish()
            }
        }
    }
}

/// Generate a newtype wrapper `$owned` and reference wrapper
/// `$borrowed` around a POD FFI type that lives on the stack.
macro_rules! ffi_type_stack {
    ($(#[$impl_attr:meta])*
     type CType = $ctype:ty;
     $(#[$owned_attr:meta])*
     pub struct $owned:ident;
     $(#[$borrowed_attr:meta])*
     pub struct $borrowed:ident;
    ) => {
        $(#[$owned_attr])*
        pub struct $owned($ctype);

        impl $owned {
            pub fn as_ptr(&self) -> *mut $ctype {
                &self.0 as *const $ctype as *mut $ctype
            }
        }

        impl Default for $owned {
            fn default() -> $owned {
                $owned(Default::default())
            }
        }

        impl From<$ctype> for $owned {
            fn from(x: $ctype) -> $owned {
                $owned(x)
            }
        }

        impl ::std::ops::Deref for $owned {
            type Target = $borrowed;

            #[inline]
            fn deref(&self) -> &$borrowed {
                let ptr = &self.0 as *const $ctype as *mut $ctype;
                unsafe { $borrowed::from_ptr(ptr) }
            }
        }

        impl ::std::ops::DerefMut for $owned {
            #[inline]
            fn deref_mut(&mut self) -> &mut $borrowed {
                let ptr = &self.0 as *const $ctype as *mut $ctype;
                unsafe { $borrowed::from_ptr_mut(ptr) }
            }
        }

        impl ::std::borrow::Borrow<$borrowed> for $owned {
            #[inline]
            fn borrow(&self) -> &$borrowed {
                &**self
            }
        }

        impl ::std::convert::AsRef<$borrowed> for $owned {
            #[inline]
            fn as_ref(&self) -> &$borrowed {
                &**self
            }
        }

        $(#[$borrowed_attr])*
        pub struct $borrowed($crate::ffi_types::Opaque);

        impl $borrowed {
            #[inline]
            pub unsafe fn from_ptr<'a>(ptr: *mut $ctype) -> &'a Self {
                &*(ptr as *mut _)
            }

            #[inline]
            pub unsafe fn from_ptr_mut<'a>(ptr: *mut $ctype) -> &'a mut Self {
                &mut *(ptr as *mut _)
            }

            #[inline]
            pub fn as_ptr(&self) -> *mut $ctype {
                self as *const _ as *mut _
            }
        }

        impl ::std::fmt::Debug for $borrowed {
            fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
                let ptr = self as *const $borrowed as usize;
                f.debug_tuple(stringify!($borrowed))
                    .field(&ptr)
                    .finish()
            }
        }
    }
}