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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

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

use alloc::sync::Arc;
use core::{error, fmt};

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

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

#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
pub struct AddUserSegmentSymbolError {
    vram: Vram,
    name: Option<Arc<str>>,
    size: Size,

    other_sym_vram: Vram,
    other_sym_name: Option<Arc<str>>,
    other_sym_size: Size,

    variant: AddUserSegmentSymbolErrorVariant,
}
impl AddUserSegmentSymbolError {
    fn new(
        vram: Vram,
        name: Option<Arc<str>>,
        size: Size,
        other_sym_vram: Vram,
        other_sym_name: Option<Arc<str>>,
        other_sym_size: Size,
        variant: AddUserSegmentSymbolErrorVariant,
    ) -> Self {
        Self {
            vram,
            name,
            size,
            other_sym_vram,
            other_sym_name,
            other_sym_size,
            variant,
        }
    }

    pub(crate) fn new_overlap(
        vram: Vram,
        name: Option<Arc<str>>,
        size: Size,
        other_sym_vram: Vram,
        other_sym_name: Option<Arc<str>>,
        other_sym_size: Size,
    ) -> Self {
        Self::new(
            vram,
            name,
            size,
            other_sym_vram,
            other_sym_name,
            other_sym_size,
            AddUserSegmentSymbolErrorVariant::Overlap,
        )
    }

    pub(crate) fn new_duplicated(
        vram: Vram,
        name: Option<Arc<str>>,
        size: Size,
        other_sym_vram: Vram,
        other_sym_name: Option<Arc<str>>,
        other_sym_size: Size,
    ) -> Self {
        Self::new(
            vram,
            name,
            size,
            other_sym_vram,
            other_sym_name,
            other_sym_size,
            AddUserSegmentSymbolErrorVariant::Duplicated,
        )
    }
}

impl fmt::Display for AddUserSegmentSymbolError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Error while trying to add a symbol \"")?;
        if let Some(name) = &self.name {
            write!(f, "'{name}' ")?;
        }
        write!(f, "{:?} {:?}\" to the user segment: ", self.vram, self.size)?;

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

        write!(f, " \"")?;
        if let Some(name) = &self.other_sym_name {
            write!(f, "'{name}' ")?;
        }
        write!(f, "{:?} {:?}\"", self.other_sym_vram, self.other_sym_size)
    }
}
impl error::Error for AddUserSegmentSymbolError {}

#[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, AddUserSegmentSymbolError, PyRuntimeError);

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