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
use crate::*;
/// CustomOps duplicates `sys::custom::custom_operations` to provide a slightly nicer experience in
/// Rust
///
/// This should rarely be constructed manually, `custom!` simplifies the process of creating custom
/// types.
///
/// See [the struct
/// custom_operations](https://caml.inria.fr/pub/docs/manual-ocaml/intfc.html#ss:c-custom-ops)
/// section in the OCaml manual for more information about each field
#[derive(Clone)]
#[repr(C)]
#[allow(missing_docs)]
pub struct CustomOps {
pub identifier: *const ocaml_sys::Char,
pub finalize: Option<unsafe extern "C" fn(v: Raw)>,
pub compare: Option<unsafe extern "C" fn(v1: Raw, v2: Raw) -> i32>,
pub hash: Option<unsafe extern "C" fn(v: Raw) -> Int>,
pub serialize: Option<unsafe extern "C" fn(v: Raw, bsize_32: *mut Uint, bsize_64: *mut Uint)>,
pub deserialize: Option<unsafe extern "C" fn(dst: *mut core::ffi::c_void) -> Uint>,
pub compare_ext: Option<unsafe extern "C" fn(v1: Raw, v2: Raw) -> i32>,
pub fixed_length: *const sys::custom_fixed_length,
}
impl Default for CustomOps {
fn default() -> CustomOps {
DEFAULT_CUSTOM_OPS
}
}
/// `Custom` is used to define OCaml types that wrap existing Rust types, but are owned by the
/// garbage collector
///
/// A custom type can only be converted to a `Value` using `IntoValue`, but can't be converted from a
/// value. Once the Rust value is owned by OCaml it should be accessed using `ocaml::Pointer` to
/// avoid reallocating the same value
///
/// ```rust
/// struct Example(ocaml::Int);
///
/// ocaml::custom! (Example);
///
/// #[cfg(feature = "derive")]
/// #[ocaml::func]
/// pub unsafe fn example() -> Example {
/// Example(123)
/// }
///
/// #[cfg(feature = "derive")]
/// #[ocaml::func]
/// pub unsafe fn example_value(x: ocaml::Pointer<Example>) -> ocaml::Int {
/// x.as_ref().0
/// }
/// ```
pub trait Custom {
/// Custom type name
const NAME: &'static str;
/// Custom type fixed length
const FIXED_LENGTH: Option<sys::custom_fixed_length> = None;
/// Custom operations
const OPS: CustomOps;
/// `used` parameter to `alloc_custom`. This helps determine the frequency of garbage
/// collection related to this custom type.
const USED: usize = 0;
/// `max` parameter to `alloc_custom`. This helps determine the frequency of garbage collection
/// related to this custom type
const MAX: usize = 1;
/// Get a static reference the this type's `CustomOps` implementation
fn ops() -> &'static CustomOps {
&Self::OPS
}
}
unsafe impl<T: 'static + Custom> IntoValue for T {
fn into_value(self, rt: &Runtime) -> Value {
let val: crate::Pointer<T> = Pointer::alloc_custom(self);
val.into_value(rt)
}
}
/// Create a custom OCaml type from an existing Rust type
///
/// See [the struct
/// custom_operations](https://caml.inria.fr/pub/docs/manual-ocaml/intfc.html#ss:c-custom-ops)
/// section in the OCaml manual for more information about each field
///
/// ```rust
/// struct MyType {
/// s: String,
/// i: i32,
/// }
///
/// extern "C" fn mytype_finalizer(_: ocaml::Raw) {
/// println!("This runs when the value gets garbage collected");
/// }
///
/// unsafe extern "C" fn mytype_compare(a: ocaml::Raw, b: ocaml::Raw) -> i32 {
/// let a = a.as_pointer::<MyType>();
/// let b = b.as_pointer::<MyType>();
///
/// let a_i = a.as_ref().i;
/// let b_i = b.as_ref().i;
///
/// if a_i == b_i {
/// return 0
/// }
///
/// if a_i < b_i {
/// return -1;
/// }
///
/// 1
/// }
///
/// ocaml::custom!(MyType {
/// finalize: mytype_finalizer,
/// compare: mytype_compare,
/// });
///
/// // This is equivalent to
/// struct MyType2 {
/// s: String,
/// i: i32,
/// }
///
/// impl ocaml::Custom for MyType2 {
/// const NAME: &'static str = "rust.MyType\0";
///
/// const OPS: ocaml::custom::CustomOps = ocaml::custom::CustomOps {
/// identifier: Self::NAME.as_ptr() as *mut ocaml::sys::Char,
/// finalize: Some(mytype_finalizer),
/// compare: Some(mytype_compare),
/// .. ocaml::custom::DEFAULT_CUSTOM_OPS
/// };
/// }
/// ```
///
/// Additionally, `custom` can be used inside the `impl` block:
///
/// ```rust
/// extern "C" fn implexample_finalizer(_: ocaml::Raw) {
/// println!("This runs when the value gets garbage collected");
/// }
///
/// struct ImplExample<'a>(&'a str);
///
/// impl<'a> ocaml::Custom for ImplExample<'a> {
/// ocaml::custom! {
/// name: "rust.ImplExample",
/// finalize: implexample_finalizer
/// }
/// }
///
/// // This is equivalent to:
///
/// struct ImplExample2<'a>(&'a str);
///
/// ocaml::custom!(ImplExample2<'a> {
/// finalize: implexample_finalizer,
/// });
/// ```
#[macro_export]
macro_rules! custom {
($name:ident $(<$t:tt>)? $({$($k:ident : $v:expr),* $(,)? })?) => {
impl $(<$t>)? $crate::Custom for $name $(<$t>)? {
$crate::custom! {
name: concat!("rust.", stringify!($name))
$(, $($k: $v),*)?
}
}
};
{name : $name:expr $(, fixed_length: $fl:expr)? $(, $($k:ident : $v:expr),*)? $(,)? } => {
const NAME: &'static str = concat!($name, "\0");
const OPS: $crate::custom::CustomOps = $crate::custom::CustomOps {
identifier: Self::NAME.as_ptr() as *const $crate::sys::Char,
$($($k: Some($v),)*)?
.. $crate::custom::DEFAULT_CUSTOM_OPS
};
};
}
/// Derives `Custom` with the given finalizer for a type
///
/// ```rust,no_run
/// use ocaml::FromValue;
///
/// struct MyType {
/// name: String
/// }
///
/// unsafe extern "C" fn mytype_finalizer(v: ocaml::Raw) {
/// let p = v.as_pointer::<MyType>();
/// p.drop_in_place()
/// }
///
/// ocaml::custom_finalize!(MyType, mytype_finalizer);
///
/// // Which is a shortcut for:
///
/// struct MyType2 {
/// name: String
/// }
///
/// ocaml::custom!(MyType2 {
/// finalize: mytype_finalizer
/// });
/// ```
#[macro_export]
macro_rules! custom_finalize {
($name:ident $(<$t:tt>)?, $f:path) => {
$crate::custom!($name { finalize: $f });
};
}
/// Default CustomOps
pub const DEFAULT_CUSTOM_OPS: CustomOps = CustomOps {
identifier: core::ptr::null(),
fixed_length: core::ptr::null_mut(),
compare: None,
compare_ext: None,
deserialize: None,
finalize: None,
hash: None,
serialize: None,
};