Skip to main content

mirascript_vm/value/types/
module.rs

1use std::any::Any;
2
3use indexmap::IndexMap;
4
5use crate::{
6    MiraError, Result, Runtime, RuntimeErrorKind,
7    value::{MiraHandle, MiraManageable},
8};
9
10use super::{MiraValue, MiraValueKind};
11
12impl MiraValue {
13    /// Create a `MiraValue` representing a module value.
14    #[inline]
15    pub fn module<T: MiraModule + ?Sized>(value: MiraHandle<T>) -> Self {
16        Self::from_module_handle(value.erase_module())
17    }
18
19    /// Check whether this value is a module value.
20    #[inline]
21    pub fn is_module(&self) -> bool {
22        matches!(self.kind(), MiraValueKind::Module(_))
23    }
24
25    /// Return the module handle, or `None` for another value type.
26    #[inline]
27    pub fn as_module(&self) -> Option<MiraHandle<dyn MiraModule>> {
28        match self.kind() {
29            MiraValueKind::Module(value) => Some(value),
30            _ => None,
31        }
32    }
33}
34
35/// A named collection of MiraScript-visible values.
36pub trait MiraModule: Any {
37    /// Return the module name shown in diagnostics.
38    fn name(&self) -> &str;
39
40    /// Return the number of exports.
41    fn len(&self) -> usize;
42
43    /// Find an export's iteration index.
44    fn index_of(&self, key: &str) -> Option<usize>;
45
46    /// Read an export name by index.
47    fn key(&self, index: usize) -> Result<&str>;
48
49    /// Read an export value by index.
50    fn get(
51        &self,
52        self_handle: MiraHandle<dyn MiraModule>,
53        runtime: &Runtime,
54        index: usize,
55    ) -> Result<MiraManageable>;
56
57    /// Return whether this module has no exports.
58    fn is_empty(&self) -> bool {
59        self.len() == 0
60    }
61}
62
63pub(crate) struct MiraMapModule {
64    name: String,
65    values: IndexMap<String, MiraValue>,
66}
67
68impl MiraMapModule {
69    pub(crate) fn new(name: impl Into<String>, values: IndexMap<String, MiraValue>) -> Self {
70        Self {
71            name: name.into(),
72            values,
73        }
74    }
75}
76
77impl MiraModule for MiraMapModule {
78    fn name(&self) -> &str {
79        &self.name
80    }
81
82    fn len(&self) -> usize {
83        self.values.len()
84    }
85
86    fn index_of(&self, key: &str) -> Option<usize> {
87        self.values.get_index_of(key)
88    }
89
90    fn key(&self, index: usize) -> Result<&str> {
91        self.values
92            .get_index(index)
93            .map(|(key, _)| key.as_str())
94            .ok_or_else(|| MiraError::runtime(RuntimeErrorKind::MissingIndexOrField))
95    }
96
97    fn get(
98        &self,
99        _self_handle: MiraHandle<dyn MiraModule>,
100        _runtime: &Runtime,
101        index: usize,
102    ) -> Result<MiraManageable> {
103        self.values
104            .get_index(index)
105            .map(|(_, value)| (*value).into())
106            .ok_or_else(|| MiraError::runtime(RuntimeErrorKind::MissingIndexOrField))
107    }
108}
109
110pub(crate) fn map_module(
111    name: impl Into<String>,
112    values: IndexMap<String, MiraValue>,
113) -> MiraManageable {
114    MiraManageable::from_module(MiraMapModule::new(name, values))
115}