artichoke_backend/
method.rs

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
use std::borrow::Cow;
use std::ffi::{CStr, CString};
use std::hash::{Hash, Hasher};

use crate::def::{ConstantNameError, Method, NotDefinedError};
use crate::sys;
use crate::Artichoke;

#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub enum Type {
    Class,
    Global,
    Instance,
    Module,
}

#[derive(Debug, Clone)]
pub struct Spec {
    name: Cow<'static, str>,
    cstring: Box<CStr>,
    method_type: Type,
    method: Method,
    args: sys::mrb_aspec,
}

impl Spec {
    pub fn new<T>(
        method_type: Type,
        method_name: T,
        method: Method,
        args: sys::mrb_aspec,
    ) -> Result<Self, ConstantNameError>
    where
        T: Into<Cow<'static, str>>,
    {
        let name = method_name.into();
        if let Ok(cstring) = CString::new(name.as_ref()) {
            Ok(Self {
                name,
                cstring: cstring.into_boxed_c_str(),
                method_type,
                method,
                args,
            })
        } else {
            Err(name.into())
        }
    }

    #[must_use]
    pub const fn method_type(&self) -> &Type {
        &self.method_type
    }

    #[must_use]
    pub fn method(&self) -> Method {
        self.method
    }

    #[must_use]
    pub fn name(&self) -> Cow<'static, str> {
        match &self.name {
            Cow::Borrowed(name) => Cow::Borrowed(name),
            Cow::Owned(name) => name.clone().into(),
        }
    }

    #[must_use]
    pub fn name_c_str(&self) -> &CStr {
        self.cstring.as_ref()
    }

    /// Define this method on the class-like pointed to by `into`.
    ///
    /// # Safety
    ///
    /// This method requires that `into` is non-null and points to a valid
    /// [`sys::RClass`].
    ///
    /// This method requires that the [`sys::mrb_state`] has a valid `top_self`
    /// object.
    pub unsafe fn define(&self, interp: &mut Artichoke, into: &mut sys::RClass) -> Result<(), NotDefinedError> {
        interp
            .with_ffi_boundary(|mrb| match self.method_type {
                Type::Class => {
                    sys::mrb_define_class_method(mrb, into, self.name_c_str().as_ptr(), Some(self.method), self.args);
                }
                Type::Global => {
                    sys::mrb_define_singleton_method(
                        mrb,
                        (*mrb).top_self,
                        self.name_c_str().as_ptr(),
                        Some(self.method),
                        self.args,
                    );
                }
                Type::Instance => {
                    sys::mrb_define_method(mrb, into, self.name_c_str().as_ptr(), Some(self.method), self.args);
                }
                Type::Module => {
                    sys::mrb_define_module_function(
                        mrb,
                        into,
                        self.name_c_str().as_ptr(),
                        Some(self.method),
                        self.args,
                    );
                }
            })
            .map_err(|_| NotDefinedError::method(self.name()))
    }
}

impl Eq for Spec {}

impl PartialEq for Spec {
    fn eq(&self, other: &Self) -> bool {
        self.method_type == other.method_type && self.name == other.name
    }
}

impl Hash for Spec {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.name.hash(state);
        self.method_type.hash(state);
    }
}