trixy 0.4.0

A rust crate used to generate multi-language apis for your application
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
130
131
132
133
134
135

/*
* Copyright (C) 2023 - 2024:
* The Trinitrix Project <soispha@vhack.eu, antifallobst@systemausfall.org>
* SPDX-License-Identifier: GPL-3.0-or-later
*
* This file is part of the Trixy crate for Trinitrix.
*
* Trixy is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU General Public License along with this program.
* If not, see <https://www.gnu.org/licenses/>.
*/

use std::{
    fs,
    path::{Path, PathBuf},
};

use crate::parser::parse_trixy_lang;
use crate::types::C_TYPE_HEADER;
use config::{
    file_tree::{FileTree, GeneratedFile},
    trixy::Language,
};

use self::config::trixy::TrixyConfig;

pub mod config;
mod generate;

const VIM_LINE_RUST: &'static str = "// vim: filetype=rust\n";
const VIM_LINE_C: &'static str = "// vim: filetype=c\n";

impl TrixyConfig {
    /// This is the heart of the trixy crate.
    /// It's main purpose is to generate, what you have asked for in the [`TrixyConfig`] and to
    /// return this generated code as a [`FileTree`].
    ///
    /// # Panic
    ///
    /// Beware that this function will panic on errors, as it is written with the expectation that
    /// it's run from a `build.rs` file. If you want to avoid that, usage of the raw generation
    /// functions is guaranteed to never panic.
    ///
    /// # Examples
    ///
    /// ```
    /// use crate::macros::TrixyConfig;
    ///
    /// let trixy_config = TrixyConfig::new("some_callback_function")
    ///                         .trixy_path("./path/to/api/file.tri")
    ///                         /* other config settings */;
    /// trixy_config.generate();
    /// ```
    #[must_use]
    pub fn generate(&self) -> FileTree {
        let mut file_tree = FileTree::new();

        let source_code = fs::read_to_string(&self.trixy_path).unwrap_or_else(|err| {
            panic! {"Can't read file at path: '{}'. The Error was: '{}'", self.trixy_path.display(), err};
        });

        let trixy_code = parse_trixy_lang(&source_code).unwrap_or_else(|err| {
            panic! {"Parsing of the trixy file failed: \n{}", err}
        });

        // host code
        if self.generate_host {
            let host_code = generate::host::generate(&trixy_code, &self);
            file_tree.add_host_file(GeneratedFile::new_in_out_dir(
                self.host_code_name.clone(),
                host_code,
                Language::Rust,
                &self.out_dir_path,
            ));
        }

        // auxiliary code
        if self.generate_auxiliary {
            let c_header = generate::auxiliary::generate(&trixy_code, &self);
            if let Some(dist_dir) = &self.dist_dir_path {
                let c_header_dist =
                    PathBuf::from(format!("{}/{}", dist_dir.display(), &self.c_header_name));
                file_tree.add_auxiliary_file(GeneratedFile::new(
                    c_header_dist,
                    c_header,
                    Language::C,
                ));

                // // TODO(@soispha): Is this even necessary? <2024-03-25>
                // let (interface_name, interface_content) = {
                //     let interface_header = format!(
                //         "\
                //     /* This file is automatcially generated by Trixy */ \n\
                //     #ifndef TRIXY_INTERFACE_H \n\
                //     #define TRIXY_INTERFACE_H \n\
                //     #include \"{}\" \n\
                //     #endif // TRIXY_INTERFACE_H \n\
                //      ",
                //         &self.c_header_name
                //     );
                //     ("interface.h", interface_header)
                // };

                if self.add_c_headers {
                    C_TYPE_HEADER
                        .iter()
                        // .chain(iter::once(&(interface_name, &interface_content[..])))
                        .for_each(|(name, content)| {
                            let path: &Path = &Path::new(name);

                            let header_path =
                                PathBuf::from(format!("{}/{}", dist_dir.display(), path.display()));
                            file_tree.add_auxiliary_file(GeneratedFile::new(
                                header_path,
                                content.to_string(),
                                Language::C,
                            ));
                        });
                }
            }
        }

        file_tree
    }
}