futhark-bindgen 0.2.8

Futhark binding generator
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

use crate::*;

mod ocaml;
mod rust;

pub use ocaml::OCaml;
pub use rust::Rust;

pub(crate) fn first_uppercase(s: &str) -> String {
    let mut s = s.to_string();
    if let Some(r) = s.get_mut(0..1) {
        r.make_ascii_uppercase();
    }
    s
}

pub(crate) fn convert_struct_name(s: &str) -> &str {
    s.strip_prefix("struct")
        .unwrap()
        .strip_suffix('*')
        .unwrap()
        .strip_prefix(|x: char| x.is_ascii_whitespace())
        .unwrap()
        .strip_suffix(|x: char| x.is_ascii_whitespace())
        .unwrap()
}

/// Code generation config
pub struct Config {
    /// Output file
    pub output_path: std::path::PathBuf,

    /// Path to output file
    pub output_file: std::fs::File,
}

impl Config {
    /// Create a new config using the provided output file path
    pub fn new(output: impl AsRef<std::path::Path>) -> Result<Config, Error> {
        Ok(Config {
            output_path: output.as_ref().to_path_buf(),
            output_file: std::fs::File::create(output)?,
        })
    }
}

pub trait Generate {
    /// Iterates through the manifest and generates code
    fn generate(&mut self, pkg: &Package, config: &mut Config) -> Result<(), Error> {
        self.bindings(pkg, config)?;
        for (name, ty) in &pkg.manifest.types {
            match ty {
                manifest::Type::Array(ty) => {
                    self.array_type(pkg, config, name, ty)?;
                }
                manifest::Type::Opaque(ty) => {
                    self.opaque_type(pkg, config, name, ty)?;
                }
            }
        }

        for (name, entry) in &pkg.manifest.entry_points {
            self.entry(pkg, config, name, entry)?;
        }
        self.format(&config.output_path)?;
        Ok(())
    }

    /// Step 1: generate any setup code or low-level bindings
    fn bindings(&mut self, _pkg: &Package, _config: &mut Config) -> Result<(), Error>;

    /// Step 2: generate code for array types
    fn array_type(
        &mut self,
        pkg: &Package,
        config: &mut Config,
        name: &str,
        ty: &manifest::ArrayType,
    ) -> Result<(), Error>;

    /// Step 3: generate code for opaque types
    fn opaque_type(
        &mut self,
        pkg: &Package,
        config: &mut Config,
        name: &str,
        ty: &manifest::OpaqueType,
    ) -> Result<(), Error>;

    /// Step 4: generate code for entry points
    fn entry(
        &mut self,
        pkg: &Package,
        config: &mut Config,
        name: &str,
        entry: &manifest::Entry,
    ) -> Result<(), Error>;

    /// Step 5: Optionally, run any formatting program or post-processing on the output file
    fn format(&mut self, _output: &std::path::Path) -> Result<(), Error> {
        Ok(())
    }
}

fn rust() -> Box<impl Generate> {
    Box::<Rust>::default()
}

fn ocaml(config: &Config) -> Box<impl Generate> {
    Box::new(OCaml::new(config).unwrap())
}

impl Config {
    /// Automatically detect output language
    pub fn detect(&self) -> Option<Box<dyn Generate>> {
        match self
            .output_path
            .extension()
            .map(|x| x.to_str().expect("Invalid extension"))
        {
            Some("rs") => Some(rust()),
            Some("ml") => Some(ocaml(self)),
            _ => None,
        }
    }
}