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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
use anyhow::{bail, Result};
use std::{
    collections::HashMap,
    ops::{Deref, DerefMut},
    path::{Path, PathBuf},
};

#[cfg_attr(feature = "serde", derive(serde::Deserialize), serde(default))]
#[derive(Clone, PartialEq, Eq, Debug, Default)]
#[non_exhaustive]
pub struct Config {
    pub target: Target,
    pub atomics: bool,
    pub atomics_feature: Option<String>,
    pub generic_mod: bool,
    pub make_mod: bool,
    pub skip_crate_attributes: bool,
    pub ignore_groups: bool,
    pub keep_list: bool,
    pub strict: bool,
    pub feature_group: bool,
    pub feature_peripheral: bool,
    pub max_cluster_size: bool,
    pub impl_debug: bool,
    pub impl_debug_feature: Option<String>,
    pub impl_defmt: Option<String>,
    pub output_dir: Option<PathBuf>,
    pub input: Option<PathBuf>,
    pub source_type: SourceType,
    pub log_level: Option<String>,
    pub interrupt_link_section: Option<String>,
    pub reexport_core_peripherals: bool,
    pub reexport_interrupt: bool,
    pub ident_formats: IdentFormats,
    pub ident_formats_theme: Option<IdentFormatsTheme>,
    pub field_names_for_enums: bool,
    pub base_address_shift: u64,
    pub html_url: Option<url::Url>,
}

#[allow(clippy::upper_case_acronyms)]
#[allow(non_camel_case_types)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[derive(Clone, Copy, PartialEq, Eq, Debug, Default)]
pub enum Target {
    #[cfg_attr(feature = "serde", serde(rename = "cortex-m"))]
    #[default]
    CortexM,
    #[cfg_attr(feature = "serde", serde(rename = "msp430"))]
    Msp430,
    #[cfg_attr(feature = "serde", serde(rename = "riscv"))]
    RISCV,
    #[cfg_attr(feature = "serde", serde(rename = "xtensa-lx"))]
    XtensaLX,
    #[cfg_attr(feature = "serde", serde(rename = "mips"))]
    Mips,
    #[cfg_attr(feature = "serde", serde(rename = "none"))]
    None,
}

impl std::fmt::Display for Target {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(match self {
            Target::CortexM => "cortex-m",
            Target::Msp430 => "msp430",
            Target::RISCV => "riscv",
            Target::XtensaLX => "xtensa-lx",
            Target::Mips => "mips",
            Target::None => "none",
        })
    }
}

impl Target {
    pub fn parse(s: &str) -> Result<Self> {
        Ok(match s {
            "cortex-m" => Target::CortexM,
            "msp430" => Target::Msp430,
            "riscv" => Target::RISCV,
            "xtensa-lx" => Target::XtensaLX,
            "mips" => Target::Mips,
            "none" => Target::None,
            _ => bail!("unknown target {}", s),
        })
    }

    pub const fn all() -> &'static [Target] {
        use self::Target::*;
        &[CortexM, Msp430, RISCV, XtensaLX, Mips]
    }
}

#[cfg_attr(
    feature = "serde",
    derive(serde::Deserialize),
    serde(rename_all = "lowercase")
)]
#[derive(Clone, Copy, PartialEq, Eq, Debug, Default)]
pub enum SourceType {
    #[default]
    Xml,
    #[cfg(feature = "yaml")]
    Yaml,
    #[cfg(feature = "json")]
    Json,
}

impl SourceType {
    /// Make a new [`SourceType`] from a given extension.
    pub fn from_extension(s: &str) -> Option<Self> {
        match s {
            "svd" | "xml" => Some(Self::Xml),
            #[cfg(feature = "yaml")]
            "yml" | "yaml" => Some(Self::Yaml),
            #[cfg(feature = "json")]
            "json" => Some(Self::Json),
            _ => None,
        }
    }
    pub fn from_path(path: &Path) -> Self {
        path.extension()
            .and_then(|e| e.to_str())
            .and_then(Self::from_extension)
            .unwrap_or_default()
    }
}

#[cfg_attr(
    feature = "serde",
    derive(serde::Deserialize),
    serde(rename_all = "lowercase")
)]
#[derive(Clone, Debug, PartialEq, Eq, Default)]
#[non_exhaustive]
pub enum Case {
    #[default]
    Constant,
    Pascal,
    Snake,
}

impl Case {
    pub fn parse(c: &str) -> Result<Option<Self>, IdentFormatError> {
        Ok(match c {
            "" | "unchanged" | "svd" => None,
            "p" | "pascal" | "type" => Some(Case::Pascal),
            "s" | "snake" | "lower" => Some(Case::Snake),
            "c" | "constant" | "upper" => Some(Case::Constant),
            _ => {
                return Err(IdentFormatError::UnknownCase(c.into()));
            }
        })
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum IdentFormatError {
    UnknownCase(String),
    Other,
}

#[derive(Clone, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize), serde(default))]
pub struct IdentFormat {
    // Ident case. `None` means don't change
    pub case: Option<Case>,
    pub prefix: String,
    pub suffix: String,
}

impl IdentFormat {
    pub fn case(mut self, case: Case) -> Self {
        self.case = Some(case);
        self
    }
    pub fn constant_case(mut self) -> Self {
        self.case = Some(Case::Constant);
        self
    }
    pub fn pascal_case(mut self) -> Self {
        self.case = Some(Case::Pascal);
        self
    }
    pub fn snake_case(mut self) -> Self {
        self.case = Some(Case::Snake);
        self
    }
    pub fn prefix(mut self, prefix: &str) -> Self {
        self.prefix = prefix.into();
        self
    }
    pub fn suffix(mut self, suffix: &str) -> Self {
        self.suffix = suffix.into();
        self
    }
    pub fn parse(s: &str) -> Result<Self, IdentFormatError> {
        let mut f = s.split(':');
        match (f.next(), f.next(), f.next()) {
            (Some(p), Some(c), Some(s)) => {
                let case = Case::parse(c)?;
                Ok(Self {
                    case,
                    prefix: p.into(),
                    suffix: s.into(),
                })
            }
            (Some(p), Some(c), None) => {
                let case = Case::parse(c)?;
                Ok(Self {
                    case,
                    prefix: p.into(),
                    suffix: "".into(),
                })
            }
            (Some(c), None, None) => {
                let case = Case::parse(c)?;
                Ok(Self {
                    case,
                    prefix: "".into(),
                    suffix: "".into(),
                })
            }
            _ => Err(IdentFormatError::Other),
        }
    }
}

#[derive(Clone, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize), serde(default))]
pub struct IdentFormats(HashMap<String, IdentFormat>);

impl IdentFormats {
    fn common() -> Self {
        let snake = IdentFormat::default().snake_case();
        Self(HashMap::from([
            ("field_accessor".into(), snake.clone()),
            ("register_accessor".into(), snake.clone()),
            ("enum_value_accessor".into(), snake.clone()),
            ("cluster_accessor".into(), snake.clone()),
            ("register_mod".into(), snake.clone()),
            ("cluster_mod".into(), snake.clone()),
            ("peripheral_mod".into(), snake.clone()),
            ("peripheral_feature".into(), snake),
        ]))
    }

    pub fn default_theme() -> Self {
        let mut map = Self::common();

        let pascal = IdentFormat::default().pascal_case();
        map.extend([
            ("field_reader".into(), pascal.clone().suffix("R")),
            ("field_writer".into(), pascal.clone().suffix("W")),
            ("enum_name".into(), pascal.clone()),
            ("enum_read_name".into(), pascal.clone()),
            ("enum_write_name".into(), pascal.clone().suffix("WO")),
            ("enum_value".into(), pascal.clone()),
            ("interrupt".into(), IdentFormat::default()),
            ("register".into(), pascal.clone()),
            ("cluster".into(), pascal.clone()),
            ("register_spec".into(), pascal.clone().suffix("Spec")),
            ("peripheral".into(), pascal),
            (
                "peripheral_singleton".into(),
                IdentFormat::default().snake_case(),
            ),
        ]);

        map
    }
    pub fn legacy_theme() -> Self {
        let mut map = Self::common();

        let constant = IdentFormat::default().constant_case();
        map.extend([
            ("field_reader".into(), constant.clone().suffix("_R")),
            ("field_writer".into(), constant.clone().suffix("_W")),
            ("enum_name".into(), constant.clone().suffix("_A")),
            ("enum_read_name".into(), constant.clone().suffix("_A")),
            ("enum_write_name".into(), constant.clone().suffix("_AW")),
            ("enum_value".into(), constant.clone()),
            ("interrupt".into(), constant.clone()),
            ("cluster".into(), constant.clone()),
            ("register".into(), constant.clone()),
            ("register_spec".into(), constant.clone().suffix("_SPEC")),
            ("peripheral".into(), constant.clone()),
            ("peripheral_singleton".into(), constant),
        ]);

        map
    }
}

impl Deref for IdentFormats {
    type Target = HashMap<String, IdentFormat>;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl DerefMut for IdentFormats {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

#[cfg_attr(
    feature = "serde",
    derive(serde::Deserialize),
    serde(rename_all = "lowercase")
)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum IdentFormatsTheme {
    Legacy,
}