luars 0.26.3

A library for lua 5.5 runtime implementation in Rust
Documentation
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
use std::marker::PhantomData;

use crate::{
    Chunk, FromLua, FromLuaMulti, IntoLua, LuaError, LuaFunction, LuaResult, LuaState, LuaTable,
    LuaUserdata, RefAliveToken, UserDataTrait, Value,
};

use crate::lua_api::{Lua, LuaApi};

fn typed_scope_arg<T: FromLua>(state: &mut LuaState, index: usize) -> LuaResult<T> {
    let value = state.get_arg(index).unwrap_or_default();
    T::from_lua(value, state).map_err(|msg| state.error(msg))
}

#[doc(hidden)]
pub trait ScopedLuaCallback<Args, R> {
    fn invoke_typed(&self, state: &mut LuaState) -> LuaResult<usize>;
}

#[doc(hidden)]
pub trait ScopedLuaCallbackWith<Data, Args, R> {
    fn invoke_typed_with(&self, data: &Data, state: &mut LuaState) -> LuaResult<usize>;
}

#[doc(hidden)]
pub trait ScopedLuaCallbackMutWith<Data, Args, R> {
    fn invoke_typed_with_mut(&self, data: &mut Data, state: &mut LuaState) -> LuaResult<usize>;
}

struct CallbackResource<'scope> {
    ptr: *mut (),
    drop_fn: unsafe fn(*mut ()),
    _marker: PhantomData<&'scope ()>,
}

impl<'scope> CallbackResource<'scope> {
    fn new<T: 'scope>(callback: Box<T>) -> Self {
        unsafe fn drop_box<T>(ptr: *mut ()) {
            drop(unsafe { Box::from_raw(ptr.cast::<T>()) });
        }

        CallbackResource {
            ptr: Box::into_raw(callback).cast::<()>(),
            drop_fn: drop_box::<T>,
            _marker: PhantomData,
        }
    }
}

impl Drop for CallbackResource<'_> {
    fn drop(&mut self) {
        unsafe { (self.drop_fn)(self.ptr) };
    }
}

impl<Func, R> ScopedLuaCallback<(), R> for Func
where
    Func: Fn() -> R,
    R: IntoLua,
{
    fn invoke_typed(&self, state: &mut LuaState) -> LuaResult<usize> {
        match (self)().into_lua(state) {
            Ok(count) => Ok(count),
            Err(msg) => Err(state.error(msg)),
        }
    }
}

impl<Data, Func, R> ScopedLuaCallbackWith<Data, (), R> for Func
where
    Func: Fn(&Data) -> R,
    R: IntoLua,
{
    fn invoke_typed_with(&self, data: &Data, state: &mut LuaState) -> LuaResult<usize> {
        match (self)(data).into_lua(state) {
            Ok(count) => Ok(count),
            Err(msg) => Err(state.error(msg)),
        }
    }
}

impl<Data, Func, R> ScopedLuaCallbackMutWith<Data, (), R> for Func
where
    Func: Fn(&mut Data) -> R,
    R: IntoLua,
{
    fn invoke_typed_with_mut(&self, data: &mut Data, state: &mut LuaState) -> LuaResult<usize> {
        match (self)(data).into_lua(state) {
            Ok(count) => Ok(count),
            Err(msg) => Err(state.error(msg)),
        }
    }
}

macro_rules! impl_scoped_lua_callback {
    ($(($(($ty:ident, $value:ident) => $index:literal),+)),* $(,)?) => {
        $(
            impl<Func, R, $($ty),+> ScopedLuaCallback<($($ty,)+), R> for Func
            where
                Func: Fn($($ty),+) -> R,
                R: IntoLua,
                $($ty: FromLua),+
            {
                fn invoke_typed(&self, state: &mut LuaState) -> LuaResult<usize> {
                    $(
                        let $value = typed_scope_arg::<$ty>(state, $index)?;
                    )+

                    match (self)($($value),+).into_lua(state) {
                        Ok(count) => Ok(count),
                        Err(msg) => Err(state.error(msg)),
                    }
                }
            }
        )*
    };
}

impl_scoped_lua_callback!(
    ((A, a) => 1),
    ((A, a) => 1, (B, b) => 2),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6, (T7, t7) => 7),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6, (T7, t7) => 7, (T8, t8) => 8)
);

macro_rules! impl_scoped_lua_callback_with {
    ($(($(($ty:ident, $value:ident) => $index:literal),+)),* $(,)?) => {
        $(
            impl<Data, Func, R, $($ty),+> ScopedLuaCallbackWith<Data, ($($ty,)+), R> for Func
            where
                Func: Fn(&Data, $($ty),+) -> R,
                R: IntoLua,
                $($ty: FromLua),+
            {
                fn invoke_typed_with(&self, data: &Data, state: &mut LuaState) -> LuaResult<usize> {
                    $(
                        let $value = typed_scope_arg::<$ty>(state, $index)?;
                    )+

                    match (self)(data, $($value),+).into_lua(state) {
                        Ok(count) => Ok(count),
                        Err(msg) => Err(state.error(msg)),
                    }
                }
            }
        )*
    };
}

impl_scoped_lua_callback_with!(
    ((A, a) => 1),
    ((A, a) => 1, (B, b) => 2),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6, (T7, t7) => 7),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6, (T7, t7) => 7, (T8, t8) => 8)
);

macro_rules! impl_scoped_lua_callback_mut_with {
    ($(($(($ty:ident, $value:ident) => $index:literal),+)),* $(,)?) => {
        $(
            impl<Data, Func, R, $($ty),+> ScopedLuaCallbackMutWith<Data, ($($ty,)+), R> for Func
            where
                Func: Fn(&mut Data, $($ty),+) -> R,
                R: IntoLua,
                $($ty: FromLua),+
            {
                fn invoke_typed_with_mut(&self, data: &mut Data, state: &mut LuaState) -> LuaResult<usize> {
                    $(
                        let $value = typed_scope_arg::<$ty>(state, $index)?;
                    )+

                    match (self)(data, $($value),+).into_lua(state) {
                        Ok(count) => Ok(count),
                        Err(msg) => Err(state.error(msg)),
                    }
                }
            }
        )*
    };
}

impl_scoped_lua_callback_mut_with!(
    ((A, a) => 1),
    ((A, a) => 1, (B, b) => 2),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6, (T7, t7) => 7),
    ((A, a) => 1, (B, b) => 2, (C, c) => 3, (D, d) => 4, (E, e) => 5, (T6, t6) => 6, (T7, t7) => 7, (T8, t8) => 8)
);

fn scoped_expired_error() -> &'static str {
    "scoped value is no longer available"
}

/// Lexical scope for non-`'static` Lua values.
pub struct Scope<'scope, 'lua> {
    lua: &'scope mut Lua,
    ref_token: RefAliveToken,
    callbacks: Vec<CallbackResource<'scope>>,
    _lua: PhantomData<&'lua mut Lua>,
}

impl<'scope, 'lua> Scope<'scope, 'lua> {
    pub(crate) fn new(lua: &'scope mut Lua) -> Self {
        Scope {
            lua,
            ref_token: RefAliveToken::default(),
            callbacks: Vec::new(),
            _lua: PhantomData,
        }
    }

    /// Access the underlying high-level Lua runtime within this scope.
    pub fn lua(&mut self) -> &mut Lua {
        self.lua
    }

    /// Return a handle to the global environment table.
    pub fn globals(&mut self) -> LuaTable {
        self.lua.globals()
    }

    /// Return a chunk builder bound to this scope's Lua borrow.
    pub fn load<'a>(&'a mut self, source: &str) -> Chunk<'a> {
        self.lua.load(source)
    }

    /// Create a scoped Lua function from a `'static` Rust callback.
    pub fn create_function<F, Args, R>(
        &mut self,
        f: F,
    ) -> LuaResult<ScopedFunction<'scope, 'static>>
    where
        F: ScopedLuaCallback<Args, R> + 'static,
    {
        let callback = CallbackResource::new(Box::new(f));
        let callback_ptr = callback.ptr as usize;
        self.callbacks.push(callback);

        let active = self.ref_token.clone();
        let function = self.lua.create_raw_function(move |state| {
            if !active.is_alive() {
                return Err(state.error(scoped_expired_error().to_owned()));
            }

            let callback = unsafe { &*(callback_ptr as *const F) };
            callback.invoke_typed(state)
        })?;

        Ok(ScopedFunction::new(function))
    }

    /// Create a scoped Lua function that borrows Rust data from this lexical scope.
    pub fn create_function_with<'data, Data, F, Args, R>(
        &mut self,
        data: &'data Data,
        f: F,
    ) -> LuaResult<ScopedFunction<'scope, 'data>>
    where
        F: ScopedLuaCallbackWith<Data, Args, R> + 'static,
    {
        let callback = CallbackResource::new(Box::new(f));
        let callback_ptr = callback.ptr as usize;
        let data_ptr = (data as *const Data).cast::<()>() as usize;
        self.callbacks.push(callback);

        let active = self.ref_token.clone();
        let function = self.lua.create_raw_function(move |state| {
            if !active.is_alive() {
                return Err(state.error(scoped_expired_error().to_owned()));
            }

            let callback = unsafe { &*(callback_ptr as *const F) };
            let data = unsafe { &*(data_ptr as *const Data) };
            callback.invoke_typed_with(data, state)
        })?;

        Ok(ScopedFunction::new(function))
    }

    /// Create a scoped Lua function that mutably borrows Rust data from this lexical scope.
    pub fn create_function_mut_with<'data, Data, F, Args, R>(
        &mut self,
        data: &'data mut Data,
        f: F,
    ) -> LuaResult<ScopedFunction<'scope, 'data>>
    where
        F: ScopedLuaCallbackMutWith<Data, Args, R> + 'static,
    {
        let callback = CallbackResource::new(Box::new(f));
        let callback_ptr = callback.ptr as usize;
        let data_ptr = (data as *mut Data).cast::<()>() as usize;
        self.callbacks.push(callback);

        let active = self.ref_token.clone();
        let function = self.lua.create_raw_function(move |state| {
            if !active.is_alive() {
                return Err(state.error(scoped_expired_error().to_owned()));
            }

            let callback = unsafe { &*(callback_ptr as *const F) };
            let data = unsafe { &mut *(data_ptr as *mut Data) };
            callback.invoke_typed_with_mut(data, state)
        })?;

        Ok(ScopedFunction::new(function))
    }

    /// Create borrowed userdata tied to this lexical scope.
    ///
    /// Uses `LuaUserdata::from_ref` internally — the scope's liveness token
    /// is shared with the userdata. When the scope drops, the token expires
    /// and all accesses return errors.
    pub fn create_userdata_ref<T: UserDataTrait>(
        &mut self,
        reference: &mut T,
    ) -> LuaResult<ScopedUserData<'scope, T>> {
        let token = self.ref_token.clone();
        let ptr = reference as *mut T;
        let ud = LuaUserdata::from_ref(reference, token.clone());
        let value = self.lua.global_state_mut().create_userdata(ud)?;
        let userdata_value = Value::new(self.lua.global_state_mut().to_ref(value));
        Ok(ScopedUserData::new(userdata_value, ptr, token))
    }
}

impl Drop for Scope<'_, '_> {
    fn drop(&mut self) {
        self.ref_token.set(false);
    }
}

/// A Lua function handle tied to a lexical scope.
#[derive(Debug)]
pub struct ScopedFunction<'scope, 'data> {
    inner: LuaFunction,
    _marker: PhantomData<(&'scope mut (), &'data ())>,
}

impl<'scope, 'data> ScopedFunction<'scope, 'data> {
    fn new(inner: LuaFunction) -> Self {
        ScopedFunction {
            inner,
            _marker: PhantomData,
        }
    }

    #[inline]
    pub fn call<A: IntoLua, R: FromLuaMulti>(&self, args: A) -> LuaResult<R> {
        self.inner.call(args)
    }

    #[inline]
    pub fn call1<A: IntoLua, R: FromLua>(&self, args: A) -> LuaResult<R> {
        self.inner.call1(args)
    }
}

impl IntoLua for ScopedFunction<'_, '_> {
    fn into_lua(self, state: &mut LuaState) -> Result<usize, String> {
        self.inner.into_lua(state)
    }
}

impl IntoLua for &ScopedFunction<'_, '_> {
    fn into_lua(self, state: &mut LuaState) -> Result<usize, String> {
        (&self.inner).into_lua(state)
    }
}

/// Borrowed userdata handle tied to a lexical scope.
#[derive(Debug)]
pub struct ScopedUserData<'scope, T: UserDataTrait> {
    inner: Value,
    ptr: *mut T,
    alive_token: RefAliveToken,
    _marker: PhantomData<&'scope mut T>,
}

impl<'scope, T: UserDataTrait> ScopedUserData<'scope, T> {
    fn new(inner: Value, ptr: *mut T, alive_token: RefAliveToken) -> Self {
        ScopedUserData {
            inner,
            ptr,
            alive_token,
            _marker: PhantomData,
        }
    }

    pub fn get(&self) -> LuaResult<&T> {
        if !self.alive_token.is_alive() {
            return Err(LuaError::RuntimeError);
        }
        Ok(unsafe { &*self.ptr })
    }

    pub fn get_mut(&mut self) -> LuaResult<&mut T> {
        if !self.alive_token.is_alive() {
            return Err(LuaError::RuntimeError);
        }
        Ok(unsafe { &mut *self.ptr })
    }

    pub fn type_name(&self) -> LuaResult<&'static str> {
        self.get().map(UserDataTrait::type_name)
    }
}

impl<T: UserDataTrait> IntoLua for ScopedUserData<'_, T> {
    fn into_lua(self, state: &mut LuaState) -> Result<usize, String> {
        self.inner.into_lua(state)
    }
}

impl<T: UserDataTrait> IntoLua for &ScopedUserData<'_, T> {
    fn into_lua(self, state: &mut LuaState) -> Result<usize, String> {
        (&self.inner).into_lua(state)
    }
}