slinky 0.5.0

Linker script generator for decompilation and modding 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
129

/* SPDX-FileCopyrightText: © 2024-2026 decompals */
/* SPDX-License-Identifier: MIT */

use serde::Deserialize;

use crate::utils;

#[derive(Deserialize, PartialEq, Debug)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum LinkerSymbolsStyle {
    Splat,
    Makerom,
}

impl LinkerSymbolsStyle {
    pub fn segment_rom_start(&self, seg_name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_ROM_START", seg_name),
            LinkerSymbolsStyle::Makerom => format!("_{}SegmentRomStart", seg_name),
        }
    }

    pub fn segment_rom_end(&self, seg_name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_ROM_END", seg_name),
            LinkerSymbolsStyle::Makerom => format!("_{}SegmentRomEnd", seg_name),
        }
    }

    pub fn segment_rom_size(&self, seg_name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_ROM_SIZE", seg_name),
            LinkerSymbolsStyle::Makerom => format!("_{}SegmentRomSize", seg_name),
        }
    }

    pub fn segment_vram_start(&self, seg_name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_VRAM", seg_name),
            LinkerSymbolsStyle::Makerom => format!("_{}SegmentStart", seg_name),
        }
    }

    pub fn segment_vram_end(&self, seg_name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_VRAM_END", seg_name),
            LinkerSymbolsStyle::Makerom => format!("_{}SegmentEnd", seg_name),
        }
    }

    pub fn segment_vram_size(&self, seg_name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_VRAM_SIZE", seg_name),
            LinkerSymbolsStyle::Makerom => format!("_{}SegmentSize", seg_name),
        }
    }

    fn convert_section_name_to_linker_format(&self, section_type: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => section_type.replace('.', "_").to_uppercase(),
            LinkerSymbolsStyle::Makerom => {
                // TODO: yeet RoData?
                if section_type == ".rodata" {
                    "RoData".to_string()
                } else if section_type.chars().nth(0) == Some('.') {
                    utils::capitalize(&section_type[1..])
                } else {
                    utils::capitalize(section_type)
                }
            }
        }
    }

    pub fn segment_section_start(&self, seg_name: &str, section_type: &str) -> String {
        let sec = self.convert_section_name_to_linker_format(section_type);

        match self {
            LinkerSymbolsStyle::Splat => format!("{}{}_START", seg_name, sec),
            LinkerSymbolsStyle::Makerom => format!("_{}Segment{}Start", seg_name, sec),
        }
    }

    pub fn segment_section_end(&self, seg_name: &str, section_type: &str) -> String {
        let sec = self.convert_section_name_to_linker_format(section_type);

        match self {
            LinkerSymbolsStyle::Splat => format!("{}{}_END", seg_name, sec),
            LinkerSymbolsStyle::Makerom => format!("_{}Segment{}End", seg_name, sec),
        }
    }

    pub fn segment_section_size(&self, seg_name: &str, section_type: &str) -> String {
        let sec = self.convert_section_name_to_linker_format(section_type);

        match self {
            LinkerSymbolsStyle::Splat => format!("{}{}_SIZE", seg_name, sec),
            LinkerSymbolsStyle::Makerom => format!("_{}Segment{}Size", seg_name, sec),
        }
    }

    pub fn linker_offset(&self, name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_OFFSET", name),
            LinkerSymbolsStyle::Makerom => format!("_{}Offset", name),
        }
    }

    pub fn vram_class_start(&self, name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_VRAM_CLASS_START", name),
            LinkerSymbolsStyle::Makerom => format!("_{}VramClassStart", name),
        }
    }

    pub fn vram_class_end(&self, name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_VRAM_CLASS_END", name),
            LinkerSymbolsStyle::Makerom => format!("_{}VramClassEnd", name),
        }
    }

    pub fn vram_class_size(&self, name: &str) -> String {
        match self {
            LinkerSymbolsStyle::Splat => format!("{}_VRAM_CLASS_SIZE", name),
            LinkerSymbolsStyle::Makerom => format!("_{}VramClassSize", name),
        }
    }
}