rabbitizer 2.0.0-alpha.9

MIPS instruction decoder
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

/* SPDX-FileCopyrightText: © 2024-2025 Decompollaborate */
/* SPDX-License-Identifier: MIT */

use core::ops::Index;

use crate::encoded_field_mask::EncodedFieldMask;
use crate::operands::Operand;

/// Describes properties of a given [`Operand`].
///
/// [`Operand`]: crate::operands::Operand
#[derive(Debug, PartialEq, Eq, Copy, Clone, Ord, PartialOrd, Hash, Default)]
#[allow(clippy::struct_excessive_bools)]
pub struct OperandDescriptor {
    pub(crate) name: &'static str,
    pub(crate) mask: EncodedFieldMask,
}

impl OperandDescriptor {
    pub(crate) const fn default() -> Self {
        Self {
            name: "",
            mask: EncodedFieldMask::default(),
        }
    }

    pub(crate) const fn new(name: &'static str, mask: EncodedFieldMask) -> Self {
        Self { name, mask }
    }

    #[cfg(test)]
    pub(crate) const fn check_valid_entry(&self) {
        assert!(
            !self.name.is_empty(),
            "An operand must not have an empty name"
        );
    }
}

impl OperandDescriptor {
    #[must_use]
    pub const fn name(&self) -> &'static str {
        self.name
    }

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

impl Index<Operand> for [OperandDescriptor] {
    type Output = OperandDescriptor;

    fn index(&self, index: Operand) -> &Self::Output {
        &self[index as usize]
    }
}