// Take a look at the license at the top of the repository in the LICENSE file. // rustdoc-stripper-ignore-next //! `IMPL` Boxed wrapper implementation. use std::{ cmp, fmt, hash::{Hash, Hasher}, marker::PhantomData, ops::{Deref, DerefMut}, ptr, }; use crate::translate::*; // rustdoc-stripper-ignore-next /// Wrapper implementations for Boxed types. See `wrapper!`. #[macro_export] macro_rules! glib_boxed_wrapper { ([$($attr:meta)*] $visibility:vis $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)?, $ffi_name:ty, @copy $copy_arg:ident $copy_expr:expr, @free $free_arg:ident $free_expr:expr $(, @type_ $get_type_expr:expr)?) => { $crate::glib_boxed_wrapper!(@generic_impl [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name); $crate::glib_boxed_wrapper!( @memory_manager_impl $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name, @copy $copy_arg $copy_expr, @free $free_arg $free_expr ); $crate::glib_boxed_wrapper!(@value_impl $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name $(, @type_ $get_type_expr)?); }; (@generic_impl [$($attr:meta)*] $visibility:vis $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)?, $ffi_name:ty) => { $(#[$attr])* #[repr(transparent)] $visibility struct $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? { inner: $crate::boxed::Boxed<$ffi_name, Self>, } impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $name $(<$($generic),+>)? { #[doc = "Return the inner pointer to the underlying C value."] #[inline] pub fn as_ptr(&self) -> *mut $ffi_name { unsafe { *(self as *const Self as *const *const $ffi_name) as *mut $ffi_name } } #[doc = "Borrows the underlying C value."] #[inline] pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const *const $ffi_name) -> &'a Self { &*(ptr as *const Self) } #[doc = "Borrows the underlying C value mutably."] #[inline] pub unsafe fn from_glib_ptr_borrow_mut<'a>(ptr: *mut *mut $ffi_name) -> &'a mut Self { &mut *(ptr as *mut Self) } } impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? std::clone::Clone for $name $(<$($generic),+>)? { #[inline] fn clone(&self) -> Self { Self { inner: std::clone::Clone::clone(&self.inner), } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::GlibPtrDefault for $name $(<$($generic),+>)? { type GlibType = *mut $ffi_name; } #[doc(hidden)] unsafe impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::TransparentPtrType for $name $(<$($generic),+>)? {} #[doc(hidden)] impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::translate::ToGlibPtr<'a, *const $ffi_name> for $name $(<$($generic),+>)? { type Storage = std::marker::PhantomData<&'a $crate::boxed::Boxed<$ffi_name, Self>>; #[inline] fn to_glib_none(&'a self) -> $crate::translate::Stash<'a, *const $ffi_name, Self> { let stash = $crate::translate::ToGlibPtr::to_glib_none(&self.inner); $crate::translate::Stash(stash.0, stash.1) } #[inline] fn to_glib_full(&self) -> *const $ffi_name { $crate::translate::ToGlibPtr::to_glib_full(&self.inner) } } #[doc(hidden)] impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::translate::ToGlibPtr<'a, *mut $ffi_name> for $name $(<$($generic),+>)? { type Storage = std::marker::PhantomData<&'a $crate::boxed::Boxed<$ffi_name, Self>>; #[inline] fn to_glib_none(&'a self) -> $crate::translate::Stash<'a, *mut $ffi_name, Self> { let stash = $crate::translate::ToGlibPtr::to_glib_none(&self.inner); $crate::translate::Stash(stash.0 as *mut _, stash.1) } #[inline] fn to_glib_full(&self) -> *mut $ffi_name { $crate::translate::ToGlibPtr::to_glib_full(&self.inner) as *mut _ } } #[doc(hidden)] impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::translate::ToGlibPtrMut<'a, *mut $ffi_name> for $name $(<$($generic),+>)? { type Storage = std::marker::PhantomData<&'a mut $crate::boxed::Boxed<$ffi_name, Self>>; #[inline] fn to_glib_none_mut(&'a mut self) -> $crate::translate::StashMut<'a, *mut $ffi_name, Self> { let stash = $crate::translate::ToGlibPtrMut::to_glib_none_mut(&mut self.inner); $crate::translate::StashMut(stash.0, stash.1) } } #[doc(hidden)] impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::translate::ToGlibContainerFromSlice<'a, *mut *const $ffi_name> for $name $(<$($generic),+>)? { type Storage = (std::marker::PhantomData<&'a [Self]>, Option>); fn to_glib_none_from_slice(t: &'a [Self]) -> (*mut *const $ffi_name, Self::Storage) { let mut v_ptr = Vec::with_capacity(t.len() + 1); unsafe { let ptr = v_ptr.as_mut_ptr(); std::ptr::copy_nonoverlapping(t.as_ptr() as *mut *const $ffi_name, ptr, t.len()); std::ptr::write(ptr.add(t.len()), std::ptr::null_mut()); v_ptr.set_len(t.len() + 1); } (v_ptr.as_ptr() as *mut *const $ffi_name, (std::marker::PhantomData, Some(v_ptr))) } fn to_glib_container_from_slice(t: &'a [Self]) -> (*mut *const $ffi_name, Self::Storage) { let v_ptr = unsafe { let v_ptr = $crate::ffi::g_malloc(std::mem::size_of::<*const $ffi_name>() * (t.len() + 1)) as *mut *const $ffi_name; std::ptr::copy_nonoverlapping(t.as_ptr() as *mut *const $ffi_name, v_ptr, t.len()); std::ptr::write(v_ptr.add(t.len()), std::ptr::null_mut()); v_ptr }; (v_ptr, (std::marker::PhantomData, None)) } fn to_glib_full_from_slice(t: &[Self]) -> *mut *const $ffi_name { unsafe { let v_ptr = $crate::ffi::g_malloc(std::mem::size_of::<*const $ffi_name>() * (t.len() + 1)) as *mut *const $ffi_name; for (i, s) in t.iter().enumerate() { std::ptr::write(v_ptr.add(i), $crate::translate::ToGlibPtr::to_glib_full(s)); } std::ptr::write(v_ptr.add(t.len()), std::ptr::null_mut()); v_ptr } } } #[doc(hidden)] impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::translate::ToGlibContainerFromSlice<'a, *const *const $ffi_name> for $name $(<$($generic),+>)? { type Storage = (std::marker::PhantomData<&'a [Self]>, Option>); fn to_glib_none_from_slice(t: &'a [Self]) -> (*const *const $ffi_name, Self::Storage) { let (ptr, stash) = $crate::translate::ToGlibContainerFromSlice::<'a, *mut *const $ffi_name>::to_glib_none_from_slice(t); (ptr as *const *const $ffi_name, stash) } fn to_glib_container_from_slice(_: &'a [Self]) -> (*const *const $ffi_name, Self::Storage) { // Can't have consumer free a *const pointer unimplemented!() } fn to_glib_full_from_slice(_: &[Self]) -> *const *const $ffi_name { // Can't have consumer free a *const pointer unimplemented!() } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrNone<*mut $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn from_glib_none(ptr: *mut $ffi_name) -> Self { Self { inner: $crate::translate::from_glib_none(ptr), } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrNone<*const $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn from_glib_none(ptr: *const $ffi_name) -> Self { Self { inner: $crate::translate::from_glib_none(ptr), } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrFull<*mut $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn from_glib_full(ptr: *mut $ffi_name) -> Self { Self { inner: $crate::translate::from_glib_full(ptr), } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrFull<*const $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn from_glib_full(ptr: *const $ffi_name) -> Self { Self { inner: $crate::translate::from_glib_full(ptr), } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrBorrow<*mut $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn from_glib_borrow(ptr: *mut $ffi_name) -> $crate::translate::Borrowed { $crate::translate::Borrowed::new( Self { inner: $crate::translate::from_glib_borrow::<_, $crate::boxed::Boxed<_, _>>(ptr).into_inner(), } ) } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrBorrow<*const $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn from_glib_borrow(ptr: *const $ffi_name) -> $crate::translate::Borrowed { $crate::translate::from_glib_borrow::<_, Self>(ptr as *mut $ffi_name) } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibContainerAsVec<*mut $ffi_name, *mut *mut $ffi_name> for $name $(<$($generic),+>)? { unsafe fn from_glib_none_num_as_vec(ptr: *mut *mut $ffi_name, num: usize) -> Vec { if num == 0 || ptr.is_null() { return Vec::new(); } let mut res = Vec::::with_capacity(num); let res_ptr = res.as_mut_ptr(); for i in 0..num { ::std::ptr::write(res_ptr.add(i), $crate::translate::from_glib_none(std::ptr::read(ptr.add(i)))); } res.set_len(num); res } unsafe fn from_glib_container_num_as_vec(ptr: *mut *mut $ffi_name, num: usize) -> Vec { let res = $crate::translate::FromGlibContainerAsVec::from_glib_none_num_as_vec(ptr, num); $crate::ffi::g_free(ptr as *mut _); res } unsafe fn from_glib_full_num_as_vec(ptr: *mut *mut $ffi_name, num: usize) -> Vec { if num == 0 || ptr.is_null() { $crate::ffi::g_free(ptr as *mut _); return Vec::new(); } let mut res = Vec::with_capacity(num); let res_ptr = res.as_mut_ptr(); ::std::ptr::copy_nonoverlapping(ptr as *mut Self, res_ptr, num); res.set_len(num); $crate::ffi::g_free(ptr as *mut _); res } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::FromGlibPtrArrayContainerAsVec<*mut $ffi_name, *mut *mut $ffi_name> for $name $(<$($generic),+>)? { unsafe fn from_glib_none_as_vec(ptr: *mut *mut $ffi_name) -> Vec { $crate::translate::FromGlibContainerAsVec::from_glib_none_num_as_vec(ptr, $crate::translate::c_ptr_array_len(ptr)) } unsafe fn from_glib_container_as_vec(ptr: *mut *mut $ffi_name) -> Vec { $crate::translate::FromGlibContainerAsVec::from_glib_container_num_as_vec(ptr, $crate::translate::c_ptr_array_len(ptr)) } unsafe fn from_glib_full_as_vec(ptr: *mut *mut $ffi_name) -> Vec { $crate::translate::FromGlibContainerAsVec::from_glib_full_num_as_vec(ptr, $crate::translate::c_ptr_array_len(ptr)) } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::IntoGlibPtr<*mut $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn into_glib_ptr(self) -> *mut $ffi_name { let s = std::mem::ManuallyDrop::new(self); $crate::translate::ToGlibPtr::<*const $ffi_name>::to_glib_none(&*s).0 as *mut _ } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::translate::IntoGlibPtr<*const $ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn into_glib_ptr(self) -> *const $ffi_name { let s = std::mem::ManuallyDrop::new(self); $crate::translate::ToGlibPtr::<*const $ffi_name>::to_glib_none(&*s).0 as *const _ } } }; (@value_impl $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)?, $ffi_name:ty) => { }; (@value_impl $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)?, $ffi_name:ty, @type_ $get_type_expr:expr) => { impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::types::StaticType for $name $(<$($generic),+>)? { #[inline] fn static_type() -> $crate::types::Type { #[allow(unused_unsafe)] unsafe { $crate::translate::from_glib($get_type_expr) } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::value::ValueType for $name $(<$($generic),+>)? { type Type = Self; } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::value::ValueTypeOptional for $name $(<$($generic),+>)? { } #[doc(hidden)] unsafe impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::value::FromValue<'a> for $name $(<$($generic),+>)? { type Checker = $crate::value::GenericValueTypeOrNoneChecker; #[inline] unsafe fn from_value(value: &'a $crate::Value) -> Self { let ptr = $crate::gobject_ffi::g_value_dup_boxed($crate::translate::ToGlibPtr::to_glib_none(value).0); debug_assert!(!ptr.is_null()); >::from_glib_full(ptr as *mut $ffi_name) } } #[doc(hidden)] unsafe impl<'a $(, $($generic $(: $bound $(+ $bound2)*)?),+)?> $crate::value::FromValue<'a> for &'a $name $(<$($generic),+>)? { type Checker = $crate::value::GenericValueTypeOrNoneChecker; #[inline] unsafe fn from_value(value: &'a $crate::Value) -> Self { debug_assert_eq!(std::mem::size_of::(), std::mem::size_of::<$crate::ffi::gpointer>()); let value = &*(value as *const $crate::Value as *const $crate::gobject_ffi::GValue); debug_assert!(!value.data[0].v_pointer.is_null()); <$name $(<$($generic),+>)?>::from_glib_ptr_borrow(&value.data[0].v_pointer as *const $crate::ffi::gpointer as *const *const $ffi_name) } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::value::ToValue for $name $(<$($generic),+>)? { #[inline] fn to_value(&self) -> $crate::Value { unsafe { let mut value = $crate::Value::from_type_unchecked(::static_type()); $crate::gobject_ffi::g_value_take_boxed( $crate::translate::ToGlibPtrMut::to_glib_none_mut(&mut value).0, $crate::translate::ToGlibPtr::<*const $ffi_name>::to_glib_full(self) as *mut _, ); value } } #[inline] fn value_type(&self) -> $crate::Type { ::static_type() } } impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? std::convert::From<$name $(<$($generic),+>)?> for $crate::Value { #[inline] fn from(o: $name $(<$($generic),+>)?) -> Self { unsafe { let mut value = $crate::Value::from_type_unchecked(<$name $(<$($generic),+>)? as $crate::StaticType>::static_type()); $crate::gobject_ffi::g_value_take_boxed( $crate::translate::ToGlibPtrMut::to_glib_none_mut(&mut value).0, $crate::translate::IntoGlibPtr::<*mut $ffi_name>::into_glib_ptr(o) as *mut _, ); value } } } #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::value::ToValueOptional for $name $(<$($generic),+>)? { #[inline] fn to_value_optional(s: Option<&Self>) -> $crate::Value { let mut value = $crate::Value::for_value_type::(); unsafe { $crate::gobject_ffi::g_value_take_boxed( $crate::translate::ToGlibPtrMut::to_glib_none_mut(&mut value).0, $crate::translate::ToGlibPtr::<*const $ffi_name>::to_glib_full(&s) as *mut _, ); } value } } impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::HasParamSpec for $name $(<$($generic),+>)? { type ParamSpec = $crate::ParamSpecBoxed; type SetValue = Self; type BuilderFn = fn(&str) -> $crate::ParamSpecBoxedBuilder; fn param_spec_builder() -> Self::BuilderFn { |name| Self::ParamSpec::builder(name) } } }; (@memory_manager_impl $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)?, $ffi_name:ty, @copy $copy_arg:ident $copy_expr:expr, @free $free_arg:ident $free_expr:expr) => { #[doc(hidden)] impl $(<$($generic $(: $bound $(+ $bound2)*)?),+>)? $crate::boxed::BoxedMemoryManager<$ffi_name> for $name $(<$($generic),+>)? { #[inline] unsafe fn copy($copy_arg: *const $ffi_name) -> *mut $ffi_name { $copy_expr } #[inline] #[allow(clippy::no_effect)] unsafe fn free($free_arg: *mut $ffi_name) { $free_expr; } } }; } // The safety docs really belong in the wrapper!() macro for Boxed /// Memory management functions for a boxed type. pub trait BoxedMemoryManager: 'static { /// Makes a copy. unsafe fn copy(ptr: *const T) -> *mut T; /// Frees the object. unsafe fn free(ptr: *mut T); } /// Encapsulates memory management logic for boxed types. #[repr(transparent)] pub struct Boxed> { inner: ptr::NonNull, _dummy: PhantomData<*mut MM>, } impl<'a, T: 'static, MM: BoxedMemoryManager> ToGlibPtr<'a, *const T> for Boxed { type Storage = PhantomData<&'a Self>; #[inline] fn to_glib_none(&'a self) -> Stash<'a, *const T, Self> { let ptr = self.inner.as_ptr(); Stash(ptr, PhantomData) } #[inline] fn to_glib_full(&self) -> *const T { let ptr = self.inner.as_ptr(); unsafe { MM::copy(ptr) } } } impl<'a, T: 'static, MM: BoxedMemoryManager> ToGlibPtrMut<'a, *mut T> for Boxed { type Storage = PhantomData<&'a mut Self>; #[inline] fn to_glib_none_mut(&'a mut self) -> StashMut<'a, *mut T, Self> { let ptr = self.inner.as_ptr(); StashMut(ptr, PhantomData) } } impl> FromGlibPtrNone<*mut T> for Boxed { #[inline] unsafe fn from_glib_none(ptr: *mut T) -> Self { debug_assert!(!ptr.is_null()); let ptr = MM::copy(ptr); from_glib_full(ptr) } } impl> FromGlibPtrNone<*const T> for Boxed { #[inline] unsafe fn from_glib_none(ptr: *const T) -> Self { debug_assert!(!ptr.is_null()); let ptr = MM::copy(ptr); from_glib_full(ptr) } } impl> FromGlibPtrFull<*mut T> for Boxed { #[inline] unsafe fn from_glib_full(ptr: *mut T) -> Self { debug_assert!(!ptr.is_null()); Self { inner: ptr::NonNull::new_unchecked(ptr), _dummy: PhantomData, } } } impl> FromGlibPtrFull<*const T> for Boxed { #[inline] unsafe fn from_glib_full(ptr: *const T) -> Self { debug_assert!(!ptr.is_null()); Self { inner: ptr::NonNull::new_unchecked(ptr as *mut T), _dummy: PhantomData, } } } impl> FromGlibPtrBorrow<*mut T> for Boxed { #[inline] unsafe fn from_glib_borrow(ptr: *mut T) -> Borrowed { debug_assert!(!ptr.is_null()); Borrowed::new(Self { inner: ptr::NonNull::new_unchecked(ptr), _dummy: PhantomData, }) } } impl> Drop for Boxed { #[inline] fn drop(&mut self) { unsafe { MM::free(self.inner.as_ptr()); } } } impl> fmt::Debug for Boxed { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_struct("Boxed").field("inner", &self.inner).finish() } } impl> PartialOrd for Boxed { #[inline] fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } impl> Ord for Boxed { #[inline] fn cmp(&self, other: &Self) -> cmp::Ordering { self.to_glib_none().0.cmp(&other.to_glib_none().0) } } impl> PartialEq for Boxed { #[inline] fn eq(&self, other: &Self) -> bool { self.to_glib_none().0 == other.to_glib_none().0 } } impl> Eq for Boxed {} impl> Hash for Boxed { #[inline] fn hash(&self, state: &mut H) where H: Hasher, { self.to_glib_none().0.hash(state) } } impl> Clone for Boxed { #[inline] fn clone(&self) -> Self { unsafe { from_glib_none(self.to_glib_none().0 as *mut T) } } } impl> Deref for Boxed { type Target = T; #[inline] fn deref(&self) -> &T { unsafe { // This is safe because the pointer will remain valid while self is borrowed &*self.to_glib_none().0 } } } impl> DerefMut for Boxed { #[inline] fn deref_mut(&mut self) -> &mut T { unsafe { // This is safe because the pointer will remain valid while self is borrowed &mut *self.to_glib_none_mut().0 } } }