gmodx 0.4.4

A swiss army knife for creating binary modules for Garry's Mod 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

use crate::lua::{self, ffi};

pub struct StackGuard {
    state: *mut ffi::lua_State,
    top: i32,
}

impl StackGuard {
    // Creates a StackGuard instance with record of the stack size, and on Drop will check the
    // stack size and drop any extra elements. If the stack size at the end is *smaller* than at
    // the beginning, this is considered a fatal logic error and will result in a panic.
    #[inline]
    pub fn new(state: *mut ffi::lua_State) -> StackGuard {
        StackGuard {
            state,
            top: ffi::lua_gettop(state),
        }
    }

    // Same as `new()`, but allows specifying the expected stack size at the end of the scope.
    #[inline]
    pub fn with_top(state: *mut ffi::lua_State, top: i32) -> StackGuard {
        StackGuard { state, top }
    }

    #[inline]
    pub fn keep(&mut self, n: i32) {
        self.top += n;
    }
}

impl lua::State {
    pub fn stack_guard(&self) -> StackGuard {
        StackGuard::new(self.0)
    }
}

impl Drop for StackGuard {
    #[track_caller]
    fn drop(&mut self) {
        let top = ffi::lua_gettop(self.state);
        if top < self.top {
            gmodx_panic!("{} too many stack values popped", self.top - top)
        }
        if top > self.top {
            ffi::lua_settop(self.state, self.top);
        }
    }
}