nova_vm 1.0.0

Nova Virtual Machine
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use crate::{
    ecmascript::{
        Agent, ArgumentsList, BUILTIN_STRING_MEMORY, Behaviour, BigInt, Builtin,
        BuiltinIntrinsicConstructor, ExceptionType, Function, InstantRecord, JsResult, Object,
        Realm, String, Value, builders::BuiltinFunctionBuilder, create_temporal_instant,
        temporal_err_to_js_err, to_big_int, to_temporal_instant,
    },
    engine::{Bindable, GcScope, NoGcScope, Scopable},
    heap::{CreateHeapData, IntrinsicConstructorIndexes},
};

/// Constructor function object for %Temporal.Instant%.
pub(crate) struct TemporalInstantConstructor;

impl Builtin for TemporalInstantConstructor {
    const NAME: String<'static> = BUILTIN_STRING_MEMORY.Instant;
    const LENGTH: u8 = 1;
    const BEHAVIOUR: Behaviour = Behaviour::Constructor(TemporalInstantConstructor::constructor);
}
impl BuiltinIntrinsicConstructor for TemporalInstantConstructor {
    const INDEX: IntrinsicConstructorIndexes = IntrinsicConstructorIndexes::TemporalInstant;
}

struct TemporalInstantFrom;
impl Builtin for TemporalInstantFrom {
    const NAME: String<'static> = BUILTIN_STRING_MEMORY.from;
    const LENGTH: u8 = 1;
    const BEHAVIOUR: Behaviour = Behaviour::Regular(TemporalInstantConstructor::from);
}

struct TemporalInstantFromEpochMilliseconds;
impl Builtin for TemporalInstantFromEpochMilliseconds {
    const NAME: String<'static> = BUILTIN_STRING_MEMORY.fromEpochMilliseconds;
    const LENGTH: u8 = 1;
    const BEHAVIOUR: Behaviour =
        Behaviour::Regular(TemporalInstantConstructor::from_epoch_milliseconds);
}

struct TemporalInstantFromEpochNanoseconds;
impl Builtin for TemporalInstantFromEpochNanoseconds {
    const NAME: String<'static> = BUILTIN_STRING_MEMORY.fromEpochNanoseconds;
    const LENGTH: u8 = 1;
    const BEHAVIOUR: Behaviour =
        Behaviour::Regular(TemporalInstantConstructor::from_epoch_nanoseconds);
}

struct TemporalInstantCompare;
impl Builtin for TemporalInstantCompare {
    const NAME: String<'static> = BUILTIN_STRING_MEMORY.compare;
    const LENGTH: u8 = 2;
    const BEHAVIOUR: Behaviour = Behaviour::Regular(TemporalInstantConstructor::compare);
}

impl TemporalInstantConstructor {
    /// ### [8.1.1 Temporal.Instant ( epochNanoseconds )](https://tc39.es/proposal-temporal/#sec-temporal.instant)
    fn constructor<'gc>(
        agent: &mut Agent,
        _: Value,
        args: ArgumentsList,
        new_target: Option<Object>,
        mut gc: GcScope<'gc, '_>,
    ) -> JsResult<'gc, Value<'gc>> {
        let epoch_nanoseconds = args.get(0).bind(gc.nogc());
        let new_target = new_target.bind(gc.nogc());
        // 1. If NewTarget is undefined, throw a TypeError exception.
        let Some(new_target) = new_target else {
            return Err(agent.throw_exception_with_static_message(
                ExceptionType::TypeError,
                "calling a builtin Temporal.Instant constructor without new is forbidden",
                gc.into_nogc(),
            ));
        };
        let Ok(mut new_target) = Function::try_from(new_target) else {
            unreachable!()
        };
        // 2. Let epochNanoseconds be ? ToBigInt(epochNanoseconds).
        let epoch_nanoseconds = if let Ok(epoch_nanoseconds) = BigInt::try_from(epoch_nanoseconds) {
            epoch_nanoseconds
        } else {
            let scoped_new_target = new_target.scope(agent, gc.nogc());
            let epoch_nanoseconds = to_big_int(agent, epoch_nanoseconds.unbind(), gc.reborrow())
                .unbind()?
                .bind(gc.nogc());
            // SAFETY: not shared.
            new_target = unsafe { scoped_new_target.take(agent) }.bind(gc.nogc());
            epoch_nanoseconds
        };
        // 3. If IsValidEpochNanoseconds(epochNanoseconds) is false, throw a RangeError exception.
        let epoch_nanoseconds = temporal_rs::Instant::try_new(
            epoch_nanoseconds.try_into_i128(agent).unwrap_or(i128::MAX),
        )
        .map_err(|err| temporal_err_to_js_err(agent, err, gc.nogc()))
        .unbind()?;
        // 4. Return ? CreateTemporalInstant(epochNanoseconds, NewTarget).
        create_temporal_instant(agent, epoch_nanoseconds, Some(new_target.unbind()), gc)
            .map(|instant| instant.into())
    }

    /// ### [8.2.2 Temporal.Instant.from ( item )](https://tc39.es/proposal-temporal/#sec-temporal.instant.from)
    fn from<'gc>(
        agent: &mut Agent,
        _: Value,
        args: ArgumentsList,
        gc: GcScope<'gc, '_>,
    ) -> JsResult<'gc, Value<'gc>> {
        let item = args.get(0).bind(gc.nogc());
        // 1. Return ? ToTemporalInstant(item).
        let instant = to_temporal_instant(agent, item.unbind(), gc)?;
        let instant = agent.heap.create(InstantRecord {
            object_index: None,
            instant,
        });
        Ok(instant.into())
    }

    /// ### [8.2.3 Temporal.Instant.fromEpochMilliseconds ( epochMilliseconds )](https://tc39.es/proposal-temporal/#sec-temporal.instant.fromepochmilliseconds)
    fn from_epoch_milliseconds<'gc>(
        agent: &mut Agent,
        _: Value,
        args: ArgumentsList,
        mut gc: GcScope<'gc, '_>,
    ) -> JsResult<'gc, Value<'gc>> {
        let epoch_ms = args.get(0).bind(gc.nogc());
        // 1. Set epochMilliseconds to ? ToNumber(epochMilliseconds).
        let epoch_ms_number = epoch_ms
            .unbind()
            .to_number(agent, gc.reborrow())
            .unbind()?
            .bind(gc.nogc());
        // 2. Set epochMilliseconds to ? NumberToBigInt(epochMilliseconds).
        if !epoch_ms_number.is_integer(agent) {
            return Err(agent.throw_exception_with_static_message(
                ExceptionType::RangeError,
                "Can't convert number to BigInt because it isn't an integer",
                gc.into_nogc(),
            ));
        }
        // 3. Let epochNanoseconds be epochMilliseconds × ℤ(10**6).
        // 4. If IsValidEpochNanoseconds(epochNanoseconds) is false, throw a RangeError exception.
        let epoch_ns =
            temporal_rs::Instant::from_epoch_milliseconds(epoch_ms_number.into_i64(agent))
                .map_err(|err| temporal_err_to_js_err(agent, err, gc.nogc()))
                .unbind()?;

        // 5. Return ! CreateTemporalInstant(epochNanoseconds).
        Ok(create_temporal_instant(agent, epoch_ns, None, gc)
            .unwrap()
            .into())
    }

    /// ### [8.2.4 Temporal.Instant.fromEpochNanoseconds ( epochNanoseconds )] (https://tc39.es/proposal-temporal/#sec-temporal.instant.fromepochnanoseconds)
    fn from_epoch_nanoseconds<'gc>(
        agent: &mut Agent,
        _: Value,
        arguments: ArgumentsList,
        mut gc: GcScope<'gc, '_>,
    ) -> JsResult<'gc, Value<'gc>> {
        let epoch_nanoseconds = arguments.get(0).bind(gc.nogc());
        // 1. Set epochNanoseconds to ? ToBigInt(epochNanoseconds).
        let epoch_nanoseconds = if let Ok(epoch_nanoseconds) = BigInt::try_from(epoch_nanoseconds) {
            epoch_nanoseconds
        } else {
            to_big_int(agent, epoch_nanoseconds.unbind(), gc.reborrow())
                .unbind()?
                .bind(gc.nogc())
        };
        // 2. If IsValidEpochNanoseconds(epochNanoseconds) is false, throw a RangeError exception.
        let epoch_nanoseconds = temporal_rs::Instant::try_new(
            epoch_nanoseconds.try_into_i128(agent).unwrap_or(i128::MAX),
        )
        .map_err(|err| temporal_err_to_js_err(agent, err, gc.nogc()))
        .unbind()?;
        // 3. Return ! CreateTemporalInstant(epochNanoseconds).
        Ok(create_temporal_instant(agent, epoch_nanoseconds, None, gc)
            .unwrap()
            .into())
    }

    /// ### [8.2.5 Temporal.Instant.compare ( one, two )](https://tc39.es/proposal-temporal/#sec-temporal.instant.compare)
    fn compare<'gc>(
        agent: &mut Agent,
        _: Value,
        args: ArgumentsList,
        mut gc: GcScope<'gc, '_>,
    ) -> JsResult<'gc, Value<'gc>> {
        let one = args.get(0).bind(gc.nogc());
        let two = args.get(1).bind(gc.nogc());

        let res = if let (Value::Instant(one), Value::Instant(two)) = (one, two) {
            one.inner_instant(agent).cmp(two.inner_instant(agent))
        } else {
            // TODO(jesper): in the case of one being an instant and not the other, only create one temporal_rs::Instant
            let two = two.scope(agent, gc.nogc());
            // 1. Set one to ? ToTemporalInstant(one).
            let one_instant = to_temporal_instant(agent, one.unbind(), gc.reborrow()).unbind()?;
            // 2. Set two to ? ToTemporalInstant(two).
            let two_value = two.get(agent).bind(gc.nogc());
            let two_instant = to_temporal_instant(agent, two_value.unbind(), gc)?;

            one_instant.cmp(&two_instant)
        };

        // 3. Return 𝔽(CompareEpochNanoseconds(one.[[EpochNanoseconds]], two.[[EpochNanoseconds]])).
        Ok((res as i8).into())
    }

    pub(crate) fn create_intrinsic(agent: &mut Agent, realm: Realm<'static>, _gc: NoGcScope) {
        let intrinsics = agent.get_realm_record_by_id(realm).intrinsics();
        let instant_prototype = intrinsics.temporal_instant_prototype();

        BuiltinFunctionBuilder::new_intrinsic_constructor::<TemporalInstantConstructor>(
            agent, realm,
        )
        .with_property_capacity(5)
        .with_prototype_property(instant_prototype.into())
        .with_builtin_function_property::<TemporalInstantFrom>()
        .with_builtin_function_property::<TemporalInstantFromEpochMilliseconds>()
        .with_builtin_function_property::<TemporalInstantFromEpochNanoseconds>()
        .with_builtin_function_property::<TemporalInstantCompare>()
        .build();
    }
}