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
use std::os::raw::{c_int, c_void}; use std::sync::{Arc, Mutex}; use std::{fmt, mem, ptr}; use crate::context::Context; use crate::error::Result; use crate::ffi; use crate::value::MultiValue; /// Type of Lua integer numbers. pub type Integer = ffi::lua_Integer; /// Type of Lua floating point numbers. pub type Number = ffi::lua_Number; /// A "light" userdata value. Equivalent to an unmanaged raw pointer. #[derive(Debug, Copy, Clone, Eq, PartialEq)] pub struct LightUserData(pub *mut c_void); pub(crate) type Callback<'lua, 'a> = Box<Fn(Context<'lua>, MultiValue<'lua>) -> Result<MultiValue<'lua>> + 'a>; /// An auto generated key into the Lua registry. /// /// This is a handle to a value stored inside the Lua registry. Unlike the `Table` or `Function` /// handle types, this handle is `Send + Sync + 'static` and can be returned outside of a call to /// `Lua::context`. Also, rather than calling methods directly on it, you must instead retrieve the /// value first by calling [`Context::registry_value`] inside a call to `Lua::context`. /// /// It is not automatically garbage collected on Drop, but it can be removed with /// [`Context::remove_registry_value`], and instances not manually removed can be garbage collected /// with [`Context::expire_registry_values`]. /// /// Be warned, If you place this into Lua via a `UserData` type or a rust callback, it is *very /// easy* to accidentally cause reference cycles that the Lua garbage collector cannot resolve. /// Instead of placing a `RegistryKey` into a `UserData` type, prefer instead to use /// [`UserData::set_user_value`] / [`UserData::get_user_value`], and instead of moving a RegistryKey /// into a callback, prefer [`Context::scope`]. /// /// [`Context::registry_value`]: struct.Context.html#method.registry_value /// [`Context::remove_registry_value`]: struct.Context.html#method.remove_registry_value /// [`Context::expire_registry_values`]: struct.Context.html#method.expire_registry_values /// [`Context::scope`]: struct.Context.html#method.scope /// [`UserData::set_user_value`]: struct.UserData.html#method.set_user_value /// [`UserData::get_user_value`]: struct.UserData.html#method.get_user_value pub struct RegistryKey { pub(crate) registry_id: c_int, pub(crate) unref_list: Arc<Mutex<Option<Vec<c_int>>>>, } impl fmt::Debug for RegistryKey { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "RegistryKey({})", self.registry_id) } } impl Drop for RegistryKey { fn drop(&mut self) { if let Some(list) = rlua_expect!(self.unref_list.lock(), "unref_list poisoned").as_mut() { list.push(self.registry_id); } } } impl RegistryKey { // Destroys the RegistryKey without adding to the drop list pub(crate) fn take(self) -> c_int { let registry_id = self.registry_id; unsafe { ptr::read(&self.unref_list); mem::forget(self); } registry_id } } pub(crate) struct LuaRef<'lua> { pub(crate) lua: Context<'lua>, pub(crate) index: c_int, } impl<'lua> fmt::Debug for LuaRef<'lua> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "Ref({})", self.index) } } impl<'lua> Clone for LuaRef<'lua> { fn clone(&self) -> Self { self.lua.clone_ref(self) } } impl<'lua> Drop for LuaRef<'lua> { fn drop(&mut self) { self.lua.drop_ref(self) } }