emacs 0.21.0

Rust library for creating Emacs's dynamic modules
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

use std::cell::{RefCell, Ref, RefMut};
use std::cmp::PartialEq;

use emacs_module::emacs_value;

use crate::{subr, Env, Result, FromLisp, Transfer};

/// A type that represents Lisp values.
/// Values of this type can be copied around, but are lifetime-bound to the [`Env`] they come from.
///
/// They are also "proxy values" that are only useful when converted to Rust values, or used as
/// arguments when calling back into the Lisp runtime.
///
/// [`Env`]: struct.Env.html
#[derive(Debug, Clone, Copy)]
pub struct Value<'e> {
    pub(crate) raw: emacs_value,
    pub env: &'e Env,
}

impl<'e> Value<'e> {
    /// Constructs a new `Value`. Module code should not call this directly. It is public only for
    /// some internal macros to use.
    ///
    /// # Safety
    ///
    /// The raw value must be valid for as long as the returned `Value` is used. This usually means
    /// "as long as [`Env`] is alive", but can be shorter, depending on how the returned `Value` is
    /// used at call site.
    ///
    /// [`Env`]: struct.Env.html
    #[doc(hidden)]
    pub unsafe fn new(raw: emacs_value, env: &'e Env) -> Self {
        Self { raw, env }
    }

    /// Protects this value by registering with its [`Env`], effectively "rooting" the underlying
    /// Lisp object during the lifetime of the [`Env`].
    ///
    /// Module code should not call this directly. It is public only for certain internal macros and
    /// functions to work around Emacs GC's [bug #31238], which caused [issue #2].
    ///
    /// [`Env`]: struct.Env.html
    /// [bug #31238]: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=31238
    /// [issue #2]: https://github.com/ubolonton/emacs-module-rs/issues/2
    #[doc(hidden)]
    #[inline]
    pub fn protect(self) -> Self {
        let Self { env, raw } = self;
        if let Some(protected) = &env.protected {
            protected.borrow_mut().push(unsafe_raw_call_no_exit!(env, make_global_ref, raw));
        }
        self
    }

    pub fn is_not_nil(&self) -> bool {
        let env = self.env;
        unsafe_raw_call_no_exit!(env, is_not_nil, self.raw)
    }

    #[deprecated(since = "0.20.0", note = "Please use `==` instead")]
    #[allow(clippy::should_implement_trait)]
    pub fn eq(&self, other: Value<'e>) -> bool {
        let env = self.env;
        // Safety: `other` has the same lifetime.
        unsafe_raw_call_no_exit!(env, eq, self.raw, other.raw)
    }

    /// Converts this value into a Rust value of the given type.
    #[inline(always)]
    pub fn into_rust<T: FromLisp<'e>>(self) -> Result<T> {
        FromLisp::from_lisp(self)
    }

    #[inline]
    pub fn into_ref<T: 'static>(self) -> Result<Ref<'e, T>> {
        let container: &RefCell<T> = self.into_rust()?;
        // TODO: Use .borrow(), we want panics.
        Ok(container.try_borrow()?)
    }

    #[inline]
    pub fn into_ref_mut<T: 'static>(self) -> Result<RefMut<'e, T>> {
        let container: &RefCell<T> = self.into_rust()?;
        // TODO: Use .borrow_mut(), we want panics.
        Ok(container.try_borrow_mut()?)
    }

    /// Returns a mutable reference to the underlying Rust data wrapped by this value.
    ///
    /// # Safety
    ///
    /// There are several ways this can go wrong:
    ///
    /// - Lisp code can pass the same object through 2 different values in an argument list.
    /// - Rust code earlier in the call chain may have copied this value.
    /// - Rust code later in the call chain may receive a copy of this value.
    ///
    /// In general, it is better to wrap Rust data in `RefCell`, `Mutex`, or `RwLock` guards, before
    /// moving them to Lisp, and then only access them through these guards (which can be obtained
    /// back through [`into_rust`]). This method is for squeezing out the last bit of performance in
    /// very rare situations.
    ///
    /// [`into_rust`]: #method.into_rust
    pub unsafe fn get_mut<T: Transfer>(&mut self) -> Result<&mut T> {
        self.get_raw_pointer().map(|r| &mut *r)
    }

    pub fn car<T: FromLisp<'e>>(self) -> Result<T> {
        self.env.call(subr::car, (self,))?.into_rust()
    }

    pub fn cdr<T: FromLisp<'e>>(self) -> Result<T> {
        self.env.call(subr::cdr, (self,))?.into_rust()
    }
}

impl<'e> PartialEq for Value<'e> {
    fn eq(&self, other: &Self) -> bool {
        unsafe_raw_call_no_exit!(self.env, eq, self.raw, other.raw)
    }
}