spimdisasm 2.0.0-alpha.1

MIPS disassembler
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

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

use core::{error, fmt};

use crate::addresses::{Size, Vram};

#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
enum AddIgnoredAddressRangeErrorVariant {
    Overlap,
    Duplicated,
}

#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
pub struct AddIgnoredAddressRangeError {
    vram: Vram,
    size: Size,

    other_vram: Vram,
    other_size: Size,

    variant: AddIgnoredAddressRangeErrorVariant,
}
impl AddIgnoredAddressRangeError {
    fn new(
        vram: Vram,
        size: Size,
        other_vram: Vram,
        other_size: Size,
        variant: AddIgnoredAddressRangeErrorVariant,
    ) -> Self {
        Self {
            vram,
            size,
            other_vram,
            other_size,
            variant,
        }
    }

    pub(crate) fn new_overlap(vram: Vram, size: Size, other_vram: Vram, other_size: Size) -> Self {
        Self::new(
            vram,
            size,
            other_vram,
            other_size,
            AddIgnoredAddressRangeErrorVariant::Overlap,
        )
    }

    pub(crate) fn new_duplicated(
        vram: Vram,
        size: Size,
        other_vram: Vram,
        other_size: Size,
    ) -> Self {
        Self::new(
            vram,
            size,
            other_vram,
            other_size,
            AddIgnoredAddressRangeErrorVariant::Duplicated,
        )
    }
}

impl fmt::Display for AddIgnoredAddressRangeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Error while trying to add an ignored address \"{:?} {:?}\" to the user segment: ",
            self.vram, self.size
        )?;

        match self.variant {
            AddIgnoredAddressRangeErrorVariant::Overlap => {
                write!(f, "This address overlaps with the previously added address")?
            }
            AddIgnoredAddressRangeErrorVariant::Duplicated => {
                write!(f, "It has the same Vram as the previously added address")?
            }
        }

        write!(f, " \"{:?} {:?}\"", self.other_vram, self.other_size)
    }
}
impl error::Error for AddIgnoredAddressRangeError {}

#[cfg(feature = "pyo3")]
pub(crate) mod python_bindings {
    use pyo3::exceptions::PyRuntimeError;
    use pyo3::prelude::*;

    // TODO: make a generic spimdisasm exception and make every other error to inherit from it

    pyo3::create_exception!(spimdisasm, AddIgnoredAddressRangeError, PyRuntimeError);

    impl std::convert::From<super::AddIgnoredAddressRangeError> for PyErr {
        fn from(err: super::AddIgnoredAddressRangeError) -> PyErr {
            AddIgnoredAddressRangeError::new_err(err.to_string())
        }
    }
}