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

//! # FFI opaque pointers.
//! 
//! FFI to use Rust objects from C as opaque pointer.

#![allow(unsafe_code)]
#![warn(missing_docs)]
#![warn(clippy::pedantic)]
#![deny(clippy::complexity)]
#![deny(clippy::cognitive_complexity)]
#![allow(clippy::needless_return)] // To avoid surprise in devs more familiar where return is always explicit

#![no_std]

#[cfg(all(feature = "alloc", not(feature = "std")))]
extern crate alloc;
#[cfg(all(feature = "alloc", not(feature = "std")))]
use alloc::boxed::Box;

#[cfg(feature = "std")]
extern crate std;
#[cfg(feature = "std")]
use std::boxed::Box;

#[cfg(all(feature = "std", feature = "c-types"))]
pub mod c;

#[cfg(any(feature = "panic-if-null", debug_assertions))]
#[inline]
fn panic_if_null<T>(pointer: *const T) {
    if pointer.is_null() {
        log::error!("Trying to use a NULL pointer as a opaque pointer to Rust data");
        unreachable!("Trying to use a NULL pointer as a opaque pointer to Rust data");
    }
}

/// Convert type to raw pointer ready to be used as opaque pointer.
#[cfg(any(feature = "alloc", feature = "std"))]
#[inline]
pub fn raw<T>(data: T) -> *mut T {
    return Box::into_raw(Box::new(data));
}

/// Free memory of a previous type converted to raw pointer.
/// 
/// # Safety
/// 
/// The pointer must be a valid reference and never call it twice or behavior is undefined.
/// 
/// That could produce a HEAP error that produce a crash.
#[cfg(any(feature = "alloc", feature = "std"))]
#[inline]
pub unsafe fn free<T>(pointer: *mut T) {
    #[cfg(any(feature = "panic-if-null", debug_assertions))]
    panic_if_null(pointer);
    // TODO: decide if remove this try to avoid crash when free a null pointer
    #[cfg(not(any(feature = "panic-if-null", debug_assertions)))]
    if pointer.is_null() {
        log::warn!("Trying to free a NULL pointer was ignored");
        return;
    }
    // CAUTION: this is unsafe
    Box::from_raw(pointer);
    // We let drop the boxed data.
}

/// Own back from a raw pointer to use Rust ownership as usually.
/// 
/// # Safety
/// 
/// The pointer must be a valid reference and never call it twice or behavior is undefined.
/// 
/// That could produce a HEAP error that produce a crash.
#[cfg(any(feature = "alloc", feature = "std"))]
#[inline]
pub unsafe fn own_back<T>(pointer: *mut T) -> T {
    #[cfg(any(feature = "panic-if-null", debug_assertions))]
    panic_if_null(pointer);
    // CAUTION: this is unsafe
    let boxed = Box::from_raw(pointer);
    return *boxed;
}

/// Convert raw pointer to type to type reference but without back to own it.
/// 
/// That's the main difference with `own_back<T>`, it does not back to use ownership
/// and values will not be dropped.
/// 
/// # Safety
/// 
/// The pointer must be a valid reference and never call it twice or behavior is undefined.
/// 
/// That could produce a HEAP error that produce a crash.
#[inline]
pub unsafe fn object<'a, T>(pointer: *const T) -> &'a T {
    #[cfg(any(feature = "panic-if-null", debug_assertions))]
    panic_if_null(pointer);
    // CAUTION: this is unsafe
    return &*pointer;
}

/// Convert raw pointer to type into type mutable reference but without back to own it.
/// 
/// That's the main difference with `own_back<T>`, it does not back to use ownership
/// and values will not be dropped.
/// 
/// # Safety
/// 
/// The pointer must be a valid reference and never call it twice or behavior is undefined.
/// 
/// That could produce a HEAP error that produce a crash.
#[inline]
pub unsafe fn mut_object<'a, T>(pointer: *mut T) -> &'a mut T {
    #[cfg(any(feature = "panic-if-null", debug_assertions))]
    panic_if_null(pointer);
    // CAUTION: this is unsafe
    return &mut *pointer;
}