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

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

use core::{error, fmt};

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

use crate::context::OwnedSegmentNotFoundError;

#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
#[cfg_attr(feature = "pyo3", pyclass(module = "spimdisasm"))]
pub enum SymDisplayError {
    OwnedSegmentNotFound(OwnedSegmentNotFoundError),
    SelfSymNotFound(),

    #[cfg(feature = "pyo3")]
    NotPostProcessedYet {
        name: String,
        vram_start: Vram,
        vram_end: Vram,
    },
}

impl fmt::Display for SymDisplayError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SymDisplayError::OwnedSegmentNotFound(x) => write!(f, "{x}"),
            SymDisplayError::SelfSymNotFound() => {
                // TODO: more info
                write!(f, "Can't find symbol")
            }
            #[cfg(feature = "pyo3")]
            SymDisplayError::NotPostProcessedYet {
                name,
                vram_start,
                vram_end,
            } => write!(
                f,
                "Section {} ({:?} {:?}) has not been processed yet.",
                name, vram_start, vram_end
            ),
        }
    }
}
impl error::Error for SymDisplayError {}

impl From<OwnedSegmentNotFoundError> for SymDisplayError {
    fn from(value: OwnedSegmentNotFoundError) -> Self {
        SymDisplayError::OwnedSegmentNotFound(value)
    }
}

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

    pyo3::create_exception!(spimdisasm, OwnedSegmentNotFound, SymDisplayError);
    pyo3::create_exception!(spimdisasm, SelfSymNotFound, SymDisplayError);
    pyo3::create_exception!(spimdisasm, NotPostProcessedYet, SymDisplayError);

    impl std::convert::From<super::SymDisplayError> for PyErr {
        fn from(err: super::SymDisplayError) -> PyErr {
            match err {
                super::SymDisplayError::OwnedSegmentNotFound(..) => {
                    OwnedSegmentNotFound::new_err(err.to_string())
                }
                super::SymDisplayError::SelfSymNotFound(..) => {
                    SelfSymNotFound::new_err(err.to_string())
                }
                super::SymDisplayError::NotPostProcessedYet { .. } => {
                    NotPostProcessedYet::new_err(err.to_string())
                }
            }
        }
    }
}