xqvm 0.1.0

X-Quadratic Virtual Machine — bytecode interpreter for the XQuad Toolchain
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

// Copyright (C) 2026 Postquant Labs Incorporated
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: AGPL-3.0-or-later

/// An 8-bit register slot identifier (`r0`--`r255`).
///
/// A register can hold a value of runtime type `int`, `vec`, or `xqmx`.
/// Only `int` registers exchange values with the stack via `LOAD`/`STOW`.
///
/// # Examples
///
/// ```rust
/// use xqvm::Register;
///
/// let r = Register(0);
/// assert_eq!(r.slot(), 0);
///
/// let max = Register(255);
/// assert_eq!(max.slot(), 255);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct Register(pub u8);

impl Register {
    /// Return the underlying 8-bit slot index.
    pub fn slot(self) -> u8 {
        self.0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn register_slot_accessor() {
        assert_eq!(Register(0).slot(), 0);
        assert_eq!(Register(255).slot(), 255);
    }

    #[test]
    fn register_default_is_slot_zero() {
        assert_eq!(Register::default(), Register(0));
    }
}