mapfile_parser 2.3.7

Map file parser library focusing decompilation projects
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: © 2023-2024 Decompollaborate */
/* SPDX-License-Identifier: MIT */

use crate::{file, symbol};
use std::fmt::Write;

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

#[derive(Debug, Clone)]
#[cfg_attr(feature = "python_bindings", pyclass(module = "mapfile_parser"))]
pub struct FoundSymbolInfo {
    pub file: file::File,

    pub symbol: symbol::Symbol,

    pub offset: i64,
}

impl FoundSymbolInfo {
    pub fn new(file: file::File, symbol: symbol::Symbol, offset: i64) -> Self {
        Self {
            file,
            symbol,
            offset,
        }
    }

    pub fn new_default(file: file::File, symbol: symbol::Symbol) -> Self {
        Self {
            file,
            symbol,
            offset: 0,
        }
    }

    pub fn get_as_str(&self) -> String {
        format!(
            "'{0}' (VRAM: {1}, VROM: {2}, SIZE: {3}, {4})",
            self.symbol.name,
            self.symbol.get_vram_str(),
            self.symbol.get_vrom_str(),
            self.symbol.get_size_str(),
            self.file.filepath.to_string_lossy()
        )
    }

    pub fn get_as_str_plus_offset(&self, sym_name: Option<String>) -> String {
        let mut message;

        if self.offset != 0 {
            if let Some(name) = sym_name {
                message = name;
            } else {
                message = format!("0x{0:X}", self.symbol.vram as i64 + self.offset);
            }
            write!(message, " is at 0x{0:X} bytes inside", self.offset).unwrap();
        } else {
            message = "Symbol".to_string();
        }

        format!("{0} {1}", message, self.get_as_str())
    }
}

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

    use crate::{file, symbol};

    #[pymethods]
    impl super::FoundSymbolInfo {
        #[new]
        #[pyo3(signature=(file, symbol, offset=0))]
        pub fn py_new(file: file::File, symbol: symbol::Symbol, offset: i64) -> Self {
            Self::new(file, symbol, offset)
        }

        /* Getters and setters */

        #[getter]
        fn get_file(&self) -> PyResult<file::File> {
            Ok(self.file.clone())
        }

        #[setter]
        fn set_file(&mut self, value: file::File) -> PyResult<()> {
            self.file = value;
            Ok(())
        }

        #[getter]
        fn get_symbol(&self) -> PyResult<symbol::Symbol> {
            Ok(self.symbol.clone())
        }

        #[setter]
        fn set_symbol(&mut self, value: symbol::Symbol) -> PyResult<()> {
            self.symbol = value;
            Ok(())
        }

        #[getter]
        fn get_offset(&self) -> PyResult<i64> {
            Ok(self.offset)
        }

        #[setter]
        fn set_offset(&mut self, value: i64) -> PyResult<()> {
            self.offset = value;
            Ok(())
        }

        /* Methods */

        #[pyo3(name = "getAsStr")]
        pub fn getAsStr(&self) -> String {
            self.get_as_str()
        }

        #[pyo3(name = "getAsStrPlusOffset")]
        pub fn getAsStrPlusOffset(&self, sym_name: Option<String>) -> String {
            self.get_as_str_plus_offset(sym_name)
        }
    }
}