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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
//! Templates registry.

pub mod helpers;

use crate::{
    devices::Device,
    probe::{Log, Probe},
    utils::{ser_to_string, temp_dir},
};
use anyhow::Result;
use drone_config::Config;
use handlebars::Handlebars;
use serde_json::json;
use std::{collections::BTreeSet, error::Error, fs::File, io::Write, path::Path};
use tempfile::NamedTempFile;

/// Templates registry.
pub struct Registry<'reg>(Handlebars<'reg>);

impl Registry<'_> {
    /// Creates a new templates registry.
    pub fn new() -> Result<Self> {
        let mut handlebars = Handlebars::new();
        macro_rules! template {
            ($path:expr) => {
                handlebars.register_template_string($path, include_str!(concat!($path, ".hbs")))
            };
        }

        template!("layout.ld")?;
        template!("new/src/bin/name.rs")?;
        template!("new/src/lib.rs")?;
        template!("new/src/thr.rs")?;
        template!("new/src/tasks/mod.rs")?;
        template!("new/src/tasks/root.rs")?;
        template!("new/Cargo.toml")?;
        template!("new/Drone.toml")?;
        template!("new/Justfile")?;
        template!("new/rust-toolchain")?;
        template!("new/_cargo/config")?;
        template!("new/_gitignore")?;
        template!("bmp/flash.gdb")?;
        template!("bmp/gdb.gdb")?;
        template!("bmp/reset.gdb")?;
        template!("bmp/swo.gdb")?;
        template!("bmp/target.gdb")?;
        template!("bmp/target/cortexm.gdb")?;
        template!("bmp/target/stm32.gdb")?;
        template!("jlink/reset.jlink")?;
        template!("jlink/flash.jlink")?;
        template!("jlink/gdb.gdb")?;
        template!("jlink/dso.gdb")?;
        template!("openocd/flash.openocd")?;
        template!("openocd/gdb.gdb")?;
        template!("openocd/gdb.openocd")?;
        template!("openocd/reset.openocd")?;
        template!("openocd/swo.gdb")?;

        helpers::register(&mut handlebars);
        Ok(Self(handlebars))
    }

    /// Renders linker script.
    pub fn layout_ld<W: Write>(&self, config: &Config, stage_two: bool, writer: W) -> Result<()> {
        let data = json!({ "config": config, "stage_two": stage_two });
        helpers::clear_vars();
        Ok(self.0.render_to_write("layout.ld", &data, writer)?)
    }

    /// Renders cortexm `src/bin/name.rs`.
    pub fn new_src_bin_name_rs(&self, device: &Device, crate_name: &str) -> Result<String> {
        let data = json!({
            "crate_name": crate_name,
            "platform_name": device.platform_crate.krate.name(),
            "platform_features": device.platform_crate.features,
        });
        helpers::clear_vars();
        Ok(self.0.render("new/src/bin/name.rs", &data)?)
    }

    /// Renders cortexm `src/lib.rs`.
    pub fn new_src_lib_rs(&self, device: &Device, log: Log) -> Result<String> {
        const IDENT: usize = 8;
        const LENGTH: usize = 100;
        let dso_regs = device.log_dso.as_ref().map(|x| {
            x.krate
                .used_regs()
                .iter()
                .map(|reg| format!("{},", reg))
                .fold::<Vec<(usize, Vec<_>)>, _>(Vec::new(), |mut acc, x| {
                    if let Some((len, line)) = acc.last_mut() {
                        if *len + x.len() < LENGTH - IDENT {
                            *len += x.len() + 1;
                            line.push(x);
                            return acc;
                        }
                    }
                    acc.push((x.len(), vec![x]));
                    acc
                })
                .iter()
                .map(|(_, line)| format!("{:ident$}{}", line.join(" "), "", ident = IDENT))
                .collect::<Vec<_>>()
                .join("\n")
        });
        let data = json!({
            "platform_name": device.platform_crate.krate.name(),
            "bindings_name": device.bindings_crate.krate.name(),
            "log_ident": ser_to_string(log),
            "dso_name": device.log_dso.as_ref().map(|x| x.krate.name()),
            "dso_regs": dso_regs,
        });
        helpers::clear_vars();
        Ok(self.0.render("new/src/lib.rs", &data)?)
    }

    /// Renders cortexm `src/thr.rs`.
    pub fn new_src_thr_rs(&self, device: &Device) -> Result<String> {
        let data = json!({
            "platform_name": device.platform_crate.krate.name(),
            "bindings_name": device.bindings_crate.krate.name(),
        });
        helpers::clear_vars();
        Ok(self.0.render("new/src/thr.rs", &data)?)
    }

    /// Renders cortexm `src/tasks/mod.rs`.
    pub fn new_src_tasks_mod_rs(&self) -> Result<String> {
        helpers::clear_vars();
        Ok(self.0.render("new/src/tasks/mod.rs", &())?)
    }

    /// Renders cortexm `src/tasks/root.rs`.
    pub fn new_src_tasks_root_rs(&self, device: &Device) -> Result<String> {
        let data = json!({ "platform_name": device.platform_crate.krate.name() });
        helpers::clear_vars();
        Ok(self.0.render("new/src/tasks/root.rs", &data)?)
    }

    /// Renders `Cargo.toml`.
    pub fn new_cargo_toml(
        &self,
        device: &Device,
        crate_name: &str,
        contents: &str,
    ) -> Result<String> {
        let data = json!({
            "contents": contents,
            "crate_name": crate_name,
            "platform_name": device.platform_crate.krate.name(),
            "bindings_name": device.bindings_crate.krate.name(),
            "platform_features": device.platform_crate.features,
            "bindings_features": device.bindings_crate.features,
            "dso_name": device.log_dso.as_ref().map(|x| x.krate.name()),
            "dso_features": device.log_dso.as_ref().map(|x| x.features),
        });
        helpers::clear_vars();
        Ok(self.0.render("new/Cargo.toml", &data)?)
    }

    /// Renders `Drone.toml`.
    pub fn new_drone_toml(
        &self,
        device: &Device,
        flash_size: u32,
        ram_size: u32,
        heap: &str,
        probe: Probe,
        log: Log,
    ) -> Result<String> {
        let data = json!({
            "device_flash_size": flash_size,
            "device_flash_origin": device.flash_origin,
            "device_ram_size": ram_size,
            "device_ram_origin": device.ram_origin,
            "heap": heap.trim_end(),
            "linker_platform": device.platform_crate.linker_platform(),
            "probe_ident": ser_to_string(probe),
            "probe_bmp_device": device.probe_bmp.as_ref().map(|x| x.device),
            "probe_openocd_arguments": device.probe_openocd.as_ref().map(|x| x.arguments),
            "probe_jlink_device": device.probe_jlink.as_ref().map(|x| x.device),
            "probe_jlink_interface": device.probe_jlink.as_ref().map(|x| x.interface),
            "log_ident": ser_to_string(log),
            "log_swo_reset_freq": device.log_swo.as_ref().map(|x| x.reset_freq),
        });
        helpers::clear_vars();
        Ok(self.0.render("new/Drone.toml", &data)?)
    }

    /// Renders `Justfile`.
    pub fn new_justfile(&self) -> Result<String> {
        helpers::clear_vars();
        Ok(self.0.render("new/Justfile", &())?)
    }

    /// Renders `rust-toolchain`.
    pub fn new_rust_toolchain(&self, toolchain: &str) -> Result<String> {
        let data = json!({ "toolchain": toolchain });
        helpers::clear_vars();
        Ok(self.0.render("new/rust-toolchain", &data)?)
    }

    /// Renders `.cargo/config`.
    pub fn new_cargo_config(&self, device: &Device) -> Result<String> {
        let data = json!({
            "device_target": device.target,
            "platform_flag_name": device.platform_crate.krate.flag_name(),
            "bindings_flag_name": device.bindings_crate.krate.flag_name(),
            "platform_flag": device.platform_crate.flag,
            "bindings_flag": device.bindings_crate.flag,
        });
        helpers::clear_vars();
        Ok(self.0.render("new/_cargo/config", &data)?)
    }

    /// Renders `.gitignore`.
    pub fn new_gitignore(&self, contents: &str) -> Result<String> {
        let data = json!({ "contents": contents });
        helpers::clear_vars();
        Ok(self.0.render("new/_gitignore", &data)?)
    }

    /// Renders BMP `reset` command script.
    pub fn bmp_reset(&self, config: &Config) -> Result<NamedTempFile> {
        let data = json!({ "config": config });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("bmp/reset.gdb", &data, file))
    }

    /// Renders BMP `flash` command script.
    pub fn bmp_flash(&self, config: &Config) -> Result<NamedTempFile> {
        let data = json!({ "config": config });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("bmp/flash.gdb", &data, file))
    }

    /// Renders BMP `gdb` command script.
    pub fn bmp_gdb(
        &self,
        config: &Config,
        reset: bool,
        rustc_substitute_path: &str,
    ) -> Result<NamedTempFile> {
        let data = json!({
            "config": config,
            "reset": reset,
            "rustc-substitute-path": rustc_substitute_path,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("bmp/gdb.gdb", &data, file))
    }

    /// Renders BMP `swo` command script.
    pub fn bmp_swo(
        &self,
        config: &Config,
        ports: &BTreeSet<u32>,
        reset: bool,
        pipe: &Path,
    ) -> Result<NamedTempFile> {
        let data = json!({
            "config": config,
            "ports": ports,
            "reset": reset,
            "pipe": pipe,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("bmp/swo.gdb", &data, file))
    }

    /// Renders J-Link `reset` command script.
    pub fn jlink_reset(&self) -> Result<NamedTempFile> {
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("jlink/reset.jlink", &(), file))
    }

    /// Renders J-Link `flash` command script.
    pub fn jlink_flash(&self, firmware: &Path, address: u32) -> Result<NamedTempFile> {
        let data = json!({
            "firmware": firmware,
            "address": address,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("jlink/flash.jlink", &data, file))
    }

    /// Renders J-Link `gdb` command script.
    pub fn jlink_gdb(
        &self,
        config: &Config,
        reset: bool,
        rustc_substitute_path: &str,
    ) -> Result<NamedTempFile> {
        let data = json!({
            "config": config,
            "reset": reset,
            "rustc-substitute-path": rustc_substitute_path,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("jlink/gdb.gdb", &data, file))
    }

    /// Renders J-Link `dso` command script.
    pub fn jlink_dso(
        &self,
        config: &Config,
        ports: &BTreeSet<u32>,
        reset: bool,
        pipe: &Path,
    ) -> Result<NamedTempFile> {
        let data = json!({
            "config": config,
            "ports": ports,
            "reset": reset,
            "pipe": pipe,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("jlink/dso.gdb", &data, file))
    }

    /// Renders OpenOCD `reset` command script.
    pub fn openocd_reset(&self) -> Result<String> {
        helpers::clear_vars();
        Ok(self.0.render("openocd/reset.openocd", &())?)
    }

    /// Renders OpenOCD `flash` command script.
    pub fn openocd_flash(&self, firmware: &Path) -> Result<String> {
        let data = json!({ "firmware": firmware });
        helpers::clear_vars();
        Ok(self.0.render("openocd/flash.openocd", &data)?)
    }

    /// Renders OpenOCD `gdb` command GDB script.
    pub fn openocd_gdb_gdb(
        &self,
        config: &Config,
        reset: bool,
        rustc_substitute_path: &str,
    ) -> Result<NamedTempFile> {
        let data = json!({
            "config": config,
            "reset": reset,
            "rustc-substitute-path": rustc_substitute_path,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("openocd/gdb.gdb", &data, file))
    }

    /// Renders OpenOCD `gdb` command OpenOCD script.
    pub fn openocd_gdb_openocd(&self, config: &Config) -> Result<String> {
        let data = json!({ "config": config });
        helpers::clear_vars();
        Ok(self.0.render("openocd/gdb.openocd", &data)?)
    }

    /// Renders OpenOCD `swo` command script.
    pub fn openocd_swo(
        &self,
        config: &Config,
        ports: &BTreeSet<u32>,
        reset: bool,
        pipe: &Path,
        output: Option<&Path>,
    ) -> Result<NamedTempFile> {
        let data = json!({
            "config": config,
            "ports": ports,
            "reset": reset,
            "pipe": pipe,
            "output": output,
        });
        helpers::clear_vars();
        named_temp_file(|file| self.0.render_to_write("openocd/swo.gdb", &data, file))
    }
}

fn named_temp_file<F, E>(f: F) -> Result<NamedTempFile>
where
    F: FnOnce(&File) -> Result<(), E>,
    E: Error + Send + Sync + 'static,
{
    let temp_file = NamedTempFile::new_in(temp_dir())?;
    f(temp_file.as_file())?;
    Ok(temp_file)
}