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

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

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

#[cfg(feature = "pyo3")]
use pyo3::prelude::*;

#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
enum AddPrioritisedOverlayErrorInner {
    SameNameAsCurrentOverlay,
    DuplicatedPrioritised,
}

#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
#[cfg_attr(feature = "pyo3", pyclass(module = "spimdisasm"))]
pub struct AddPrioritisedOverlayError {
    segment_name: Option<Arc<str>>,
    overlay_name: Arc<str>,
    inner: AddPrioritisedOverlayErrorInner,
}

impl AddPrioritisedOverlayError {
    pub(crate) const fn new_self_name(
        segment_name: Option<Arc<str>>,
        overlay_name: Arc<str>,
    ) -> Self {
        Self {
            segment_name,
            overlay_name,
            inner: AddPrioritisedOverlayErrorInner::SameNameAsCurrentOverlay,
        }
    }

    pub(crate) const fn new_duplicated(
        segment_name: Option<Arc<str>>,
        overlay_name: Arc<str>,
    ) -> Self {
        Self {
            segment_name,
            overlay_name,
            inner: AddPrioritisedOverlayErrorInner::DuplicatedPrioritised,
        }
    }
}
impl fmt::Display for AddPrioritisedOverlayError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Error while trying to add a prioritised overlay to a segment: "
        )?;
        match &self.inner {
            AddPrioritisedOverlayErrorInner::SameNameAsCurrentOverlay => write!(
                f,
                "Trying to add a prioritised overlay to itself (segment {}).",
                self.overlay_name
            ),
            AddPrioritisedOverlayErrorInner::DuplicatedPrioritised => {
                write!(
                    f,
                    "Trying to add duplicated prioritised overlay name '{}' to ",
                    self.overlay_name
                )?;
                if let Some(name) = &self.segment_name {
                    write!(f, "overlay segment '{name}'")
                } else {
                    write!(f, "the global segment")
                }
            }
        }
    }
}
impl error::Error for AddPrioritisedOverlayError {}

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

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